org-agenda.el 391 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149
  1. ;;; org-agenda.el --- Dynamic task and appointment lists for Org
  2. ;; Copyright (C) 2004-2017 Free Software Foundation, Inc.
  3. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; Homepage: http://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 <http://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'. `:deadline' must appear before
  245. `:scheduled' if the setting of
  246. `org-agenda-skip-scheduled-if-deadline-is-shown' is to have
  247. any effect.
  248. :deadline* Same as above, but only include the deadline if it has an
  249. hour specification as [h]h:mm.
  250. :scheduled List all items which are scheduled for the given date.
  251. The diary for *today* also contains items which were
  252. scheduled earlier and are not yet marked DONE.
  253. :scheduled* Same as above, but only include the scheduled item if it
  254. has an hour specification as [h]h:mm.
  255. By default, all four non-starred types are turned on.
  256. When :scheduled* or :deadline* are included, :schedule or :deadline
  257. will be ignored.
  258. Never set this variable globally using `setq', because then it
  259. will apply to all future agenda commands. Instead, bind it with
  260. `let' to scope it dynamically into the agenda-constructing
  261. command. A good way to set it is through options in
  262. `org-agenda-custom-commands'. For a more flexible (though
  263. somewhat less efficient) way of determining what is included in
  264. the daily/weekly agenda, see `org-agenda-skip-function'.")
  265. (defconst org-agenda-custom-commands-local-options
  266. `(repeat :tag "Local settings for this command. Remember to quote values"
  267. (choice :tag "Setting"
  268. (list :tag "Heading for this block"
  269. (const org-agenda-overriding-header)
  270. (string :tag "Headline"))
  271. (list :tag "Files to be searched"
  272. (const org-agenda-files)
  273. (list
  274. (const :format "" quote)
  275. (repeat (file))))
  276. (list :tag "Sorting strategy"
  277. (const org-agenda-sorting-strategy)
  278. (list
  279. (const :format "" quote)
  280. (repeat
  281. ,org-sorting-choice)))
  282. (list :tag "Prefix format"
  283. (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
  284. (string))
  285. (list :tag "Number of days in agenda"
  286. (const org-agenda-span)
  287. (choice (const :tag "Day" day)
  288. (const :tag "Week" week)
  289. (const :tag "Fortnight" fortnight)
  290. (const :tag "Month" month)
  291. (const :tag "Year" year)
  292. (integer :tag "Custom")))
  293. (list :tag "Fixed starting date"
  294. (const org-agenda-start-day)
  295. (string :value "2007-11-01"))
  296. (list :tag "Start on day of week"
  297. (const org-agenda-start-on-weekday)
  298. (choice :value 1
  299. (const :tag "Today" nil)
  300. (integer :tag "Weekday No.")))
  301. (list :tag "Include data from diary"
  302. (const org-agenda-include-diary)
  303. (boolean))
  304. (list :tag "Deadline Warning days"
  305. (const org-deadline-warning-days)
  306. (integer :value 1))
  307. (list :tag "Category filter preset"
  308. (const org-agenda-category-filter-preset)
  309. (list
  310. (const :format "" quote)
  311. (repeat
  312. (string :tag "+category or -category"))))
  313. (list :tag "Tags filter preset"
  314. (const org-agenda-tag-filter-preset)
  315. (list
  316. (const :format "" quote)
  317. (repeat
  318. (string :tag "+tag or -tag"))))
  319. (list :tag "Effort filter preset"
  320. (const org-agenda-effort-filter-preset)
  321. (list
  322. (const :format "" quote)
  323. (repeat
  324. (string :tag "+=10 or -=10 or +<10 or ->10"))))
  325. (list :tag "Regexp filter preset"
  326. (const org-agenda-regexp-filter-preset)
  327. (list
  328. (const :format "" quote)
  329. (repeat
  330. (string :tag "+regexp or -regexp"))))
  331. (list :tag "Set daily/weekly entry types"
  332. (const org-agenda-entry-types)
  333. (list
  334. (const :format "" quote)
  335. (set :greedy t :value ,org-agenda-entry-types
  336. (const :deadline)
  337. (const :scheduled)
  338. (const :deadline*)
  339. (const :scheduled*)
  340. (const :timestamp)
  341. (const :sexp))))
  342. (list :tag "Standard skipping condition"
  343. :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
  344. (const org-agenda-skip-function)
  345. (list
  346. (const :format "" quote)
  347. (list
  348. (choice
  349. :tag "Skipping range"
  350. (const :tag "Skip entry" org-agenda-skip-entry-if)
  351. (const :tag "Skip subtree" org-agenda-skip-subtree-if))
  352. (repeat :inline t :tag "Conditions for skipping"
  353. (choice
  354. :tag "Condition type"
  355. (list :tag "Regexp matches" :inline t
  356. (const :format "" 'regexp)
  357. (regexp))
  358. (list :tag "Regexp does not match" :inline t
  359. (const :format "" 'notregexp)
  360. (regexp))
  361. (list :tag "TODO state is" :inline t
  362. (const 'todo)
  363. (choice
  364. (const :tag "Any not-done state" 'todo)
  365. (const :tag "Any done state" 'done)
  366. (const :tag "Any state" 'any)
  367. (list :tag "Keyword list"
  368. (const :format "" quote)
  369. (repeat (string :tag "Keyword")))))
  370. (list :tag "TODO state is not" :inline t
  371. (const 'nottodo)
  372. (choice
  373. (const :tag "Any not-done state" 'todo)
  374. (const :tag "Any done state" 'done)
  375. (const :tag "Any state" 'any)
  376. (list :tag "Keyword list"
  377. (const :format "" quote)
  378. (repeat (string :tag "Keyword")))))
  379. (const :tag "scheduled" 'scheduled)
  380. (const :tag "not scheduled" 'notscheduled)
  381. (const :tag "deadline" 'deadline)
  382. (const :tag "no deadline" 'notdeadline)
  383. (const :tag "timestamp" 'timestamp)
  384. (const :tag "no timestamp" 'nottimestamp))))))
  385. (list :tag "Non-standard skipping condition"
  386. :value (org-agenda-skip-function)
  387. (const org-agenda-skip-function)
  388. (sexp :tag "Function or form (quoted!)"))
  389. (list :tag "Any variable"
  390. (variable :tag "Variable")
  391. (sexp :tag "Value (sexp)"))))
  392. "Selection of examples for agenda command settings.
  393. This will be spliced into the custom type of
  394. `org-agenda-custom-commands'.")
  395. (defcustom org-agenda-custom-commands
  396. '(("n" "Agenda and all TODOs" ((agenda "") (alltodo ""))))
  397. "Custom commands for the agenda.
  398. \\<org-mode-map>
  399. These commands will be offered on the splash screen displayed by the
  400. agenda dispatcher `\\[org-agenda]'. Each entry is a list like this:
  401. (key desc type match settings files)
  402. key The key (one or more characters as a string) to be associated
  403. with the command.
  404. desc A description of the command, when omitted or nil, a default
  405. description is built using MATCH.
  406. type The command type, any of the following symbols:
  407. agenda The daily/weekly agenda.
  408. todo Entries with a specific TODO keyword, in all agenda files.
  409. search Entries containing search words entry or headline.
  410. tags Tags/Property/TODO match in all agenda files.
  411. tags-todo Tags/P/T match in all agenda files, TODO entries only.
  412. todo-tree Sparse tree of specific TODO keyword in *current* file.
  413. tags-tree Sparse tree with all tags matches in *current* file.
  414. occur-tree Occur sparse tree for *current* file.
  415. ... A user-defined function.
  416. match What to search for:
  417. - a single keyword for TODO keyword searches
  418. - a tags match expression for tags searches
  419. - a word search expression for text searches.
  420. - a regular expression for occur searches
  421. For all other commands, this should be the empty string.
  422. settings A list of option settings, similar to that in a let form, so like
  423. this: ((opt1 val1) (opt2 val2) ...). The values will be
  424. evaluated at the moment of execution, so quote them when needed.
  425. files A list of files to write the produced agenda buffer to with
  426. the command `org-store-agenda-views'.
  427. If a file name ends in \".html\", an HTML version of the buffer
  428. is written out. If it ends in \".ps\", a postscript version is
  429. produced. Otherwise, only the plain text is written to the file.
  430. You can also define a set of commands, to create a composite agenda buffer.
  431. In this case, an entry looks like this:
  432. (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
  433. where
  434. desc A description string to be displayed in the dispatcher menu.
  435. cmd An agenda command, similar to the above. However, tree commands
  436. are not allowed, but instead you can get agenda and global todo list.
  437. So valid commands for a set are:
  438. (agenda \"\" settings)
  439. (alltodo \"\" settings)
  440. (stuck \"\" settings)
  441. (todo \"match\" settings files)
  442. (search \"match\" settings files)
  443. (tags \"match\" settings files)
  444. (tags-todo \"match\" settings files)
  445. Each command can carry a list of options, and another set of options can be
  446. given for the whole set of commands. Individual command options take
  447. precedence over the general options.
  448. When using several characters as key to a command, the first characters
  449. are prefix commands. For the dispatcher to display useful information, you
  450. should provide a description for the prefix, like
  451. (setq org-agenda-custom-commands
  452. \\='((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
  453. (\"hl\" tags \"+HOME+Lisa\")
  454. (\"hp\" tags \"+HOME+Peter\")
  455. (\"hk\" tags \"+HOME+Kim\")))"
  456. :group 'org-agenda-custom-commands
  457. :type `(repeat
  458. (choice :value ("x" "Describe command here" tags "" nil)
  459. (list :tag "Single command"
  460. (string :tag "Access Key(s) ")
  461. (option (string :tag "Description"))
  462. (choice
  463. (const :tag "Agenda" agenda)
  464. (const :tag "TODO list" alltodo)
  465. (const :tag "Search words" search)
  466. (const :tag "Stuck projects" stuck)
  467. (const :tag "Tags/Property match (all agenda files)" tags)
  468. (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
  469. (const :tag "TODO keyword search (all agenda files)" todo)
  470. (const :tag "Tags sparse tree (current buffer)" tags-tree)
  471. (const :tag "TODO keyword tree (current buffer)" todo-tree)
  472. (const :tag "Occur tree (current buffer)" occur-tree)
  473. (sexp :tag "Other, user-defined function"))
  474. (string :tag "Match (only for some commands)")
  475. ,org-agenda-custom-commands-local-options
  476. (option (repeat :tag "Export" (file :tag "Export to"))))
  477. (list :tag "Command series, all agenda files"
  478. (string :tag "Access Key(s)")
  479. (string :tag "Description ")
  480. (repeat :tag "Component"
  481. (choice
  482. (list :tag "Agenda"
  483. (const :format "" agenda)
  484. (const :tag "" :format "" "")
  485. ,org-agenda-custom-commands-local-options)
  486. (list :tag "TODO list (all keywords)"
  487. (const :format "" alltodo)
  488. (const :tag "" :format "" "")
  489. ,org-agenda-custom-commands-local-options)
  490. (list :tag "Search words"
  491. (const :format "" search)
  492. (string :tag "Match")
  493. ,org-agenda-custom-commands-local-options)
  494. (list :tag "Stuck projects"
  495. (const :format "" stuck)
  496. (const :tag "" :format "" "")
  497. ,org-agenda-custom-commands-local-options)
  498. (list :tag "Tags search"
  499. (const :format "" tags)
  500. (string :tag "Match")
  501. ,org-agenda-custom-commands-local-options)
  502. (list :tag "Tags search, TODO entries only"
  503. (const :format "" tags-todo)
  504. (string :tag "Match")
  505. ,org-agenda-custom-commands-local-options)
  506. (list :tag "TODO keyword search"
  507. (const :format "" todo)
  508. (string :tag "Match")
  509. ,org-agenda-custom-commands-local-options)
  510. (list :tag "Other, user-defined function"
  511. (symbol :tag "function")
  512. (string :tag "Match")
  513. ,org-agenda-custom-commands-local-options)))
  514. (repeat :tag "Settings for entire command set"
  515. (list (variable :tag "Any variable")
  516. (sexp :tag "Value")))
  517. (option (repeat :tag "Export" (file :tag "Export to"))))
  518. (cons :tag "Prefix key documentation"
  519. (string :tag "Access Key(s)")
  520. (string :tag "Description ")))))
  521. (defcustom org-agenda-query-register ?o
  522. "The register holding the current query string.
  523. The purpose of this is that if you construct a query string interactively,
  524. you can then use it to define a custom command."
  525. :group 'org-agenda-custom-commands
  526. :type 'character)
  527. (defcustom org-stuck-projects
  528. '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
  529. "How to identify stuck projects.
  530. This is a list of four items:
  531. 1. A tags/todo/property matcher string that is used to identify a project.
  532. See the manual for a description of tag and property searches.
  533. The entire tree below a headline matched by this is considered one project.
  534. 2. A list of TODO keywords identifying non-stuck projects.
  535. If the project subtree contains any headline with one of these todo
  536. keywords, the project is considered to be not stuck. If you specify
  537. \"*\" as a keyword, any TODO keyword will mark the project unstuck.
  538. 3. A list of tags identifying non-stuck projects.
  539. If the project subtree contains any headline with one of these tags,
  540. the project is considered to be not stuck. If you specify \"*\" as
  541. a tag, any tag will mark the project unstuck. Note that this is about
  542. the explicit presence of a tag somewhere in the subtree, inherited
  543. tags do not count here. If inherited tags make a project not stuck,
  544. use \"-TAG\" in the tags part of the matcher under (1.) above.
  545. 4. An arbitrary regular expression matching non-stuck projects.
  546. If the project turns out to be not stuck, search continues also in the
  547. subtree to see if any of the subtasks have project status.
  548. See also the variable `org-tags-match-list-sublevels' which applies
  549. to projects matched by this search as well.
  550. After defining this variable, you may use `\\[org-agenda-list-stuck-projects]'
  551. \(bound to `C-c a #') to produce the list."
  552. :group 'org-agenda-custom-commands
  553. :type '(list
  554. (string :tag "Tags/TODO match to identify a project")
  555. (repeat :tag "Projects are *not* stuck if they have an entry with \
  556. TODO keyword any of" (string))
  557. (repeat :tag "Projects are *not* stuck if they have an entry with \
  558. TAG being any of" (string))
  559. (regexp :tag "Projects are *not* stuck if this regexp matches inside \
  560. the subtree")))
  561. (defgroup org-agenda-skip nil
  562. "Options concerning skipping parts of agenda files."
  563. :tag "Org Agenda Skip"
  564. :group 'org-agenda)
  565. (defcustom org-agenda-skip-function-global nil
  566. "Function to be called at each match during agenda construction.
  567. If this function returns nil, the current match should not be skipped.
  568. If the function decided to skip an agenda match, is must return the
  569. buffer position from which the search should be continued.
  570. This may also be a Lisp form, which will be evaluated.
  571. This variable will be applied to every agenda match, including
  572. tags/property searches and TODO lists. So try to make the test function
  573. do its checking as efficiently as possible. To implement a skipping
  574. condition just for specific agenda commands, use the variable
  575. `org-agenda-skip-function' which can be set in the options section
  576. of custom agenda commands."
  577. :group 'org-agenda-skip
  578. :type 'sexp)
  579. (defgroup org-agenda-daily/weekly nil
  580. "Options concerning the daily/weekly agenda."
  581. :tag "Org Agenda Daily/Weekly"
  582. :group 'org-agenda)
  583. (defgroup org-agenda-todo-list nil
  584. "Options concerning the global todo list agenda view."
  585. :tag "Org Agenda Todo List"
  586. :group 'org-agenda)
  587. (defgroup org-agenda-match-view nil
  588. "Options concerning the general tags/property/todo match agenda view."
  589. :tag "Org Agenda Match View"
  590. :group 'org-agenda)
  591. (defgroup org-agenda-search-view nil
  592. "Options concerning the search agenda view."
  593. :tag "Org Agenda Search View"
  594. :group 'org-agenda)
  595. (defvar org-agenda-archives-mode nil
  596. "Non-nil means the agenda will include archived items.
  597. If this is the symbol `trees', trees in the selected agenda scope
  598. that are marked with the ARCHIVE tag will be included anyway. When this is
  599. t, also all archive files associated with the current selection of agenda
  600. files will be included.")
  601. (defcustom org-agenda-restriction-lock-highlight-subtree t
  602. "Non-nil means highlight the whole subtree when restriction is active.
  603. Otherwise only highlight the headline. Highlighting the whole subtree is
  604. useful to ensure no edits happen beyond the restricted region."
  605. :group 'org-agenda
  606. :type 'boolean)
  607. (defcustom org-agenda-skip-comment-trees t
  608. "Non-nil means skip trees that start with the COMMENT keyword.
  609. When nil, these trees are also scanned by agenda commands."
  610. :group 'org-agenda-skip
  611. :type 'boolean)
  612. (defcustom org-agenda-todo-list-sublevels t
  613. "Non-nil means check also the sublevels of a TODO entry for TODO entries.
  614. When nil, the sublevels of a TODO entry are not checked, resulting in
  615. potentially much shorter TODO lists."
  616. :group 'org-agenda-skip
  617. :group 'org-agenda-todo-list
  618. :type 'boolean)
  619. (defcustom org-agenda-todo-ignore-with-date nil
  620. "Non-nil means don't show entries with a date in the global todo list.
  621. You can use this if you prefer to mark mere appointments with a TODO keyword,
  622. but don't want them to show up in the TODO list.
  623. When this is set, it also covers deadlines and scheduled items, the settings
  624. of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
  625. will be ignored.
  626. See also the variable `org-agenda-tags-todo-honor-ignore-options'."
  627. :group 'org-agenda-skip
  628. :group 'org-agenda-todo-list
  629. :type 'boolean)
  630. (defcustom org-agenda-todo-ignore-timestamp nil
  631. "Non-nil means don't show entries with a timestamp.
  632. This applies when creating the global todo list.
  633. Valid values are:
  634. past Don't show entries for today or in the past.
  635. future Don't show entries with a timestamp in the future.
  636. The idea behind this is that if it has a future
  637. timestamp, you don't want to think about it until the
  638. date.
  639. all Don't show any entries with a timestamp in the global todo list.
  640. The idea behind this is that by setting a timestamp, you
  641. have already \"taken care\" of this item.
  642. This variable can also have an integer as a value. If positive (N),
  643. todos with a timestamp N or more days in the future will be ignored. If
  644. negative (-N), todos with a timestamp N or more days in the past will be
  645. ignored. If 0, todos with a timestamp either today or in the future will
  646. be ignored. For example, a value of -1 will exclude todos with a
  647. timestamp in the past (yesterday or earlier), while a value of 7 will
  648. exclude todos with a timestamp a week or more in the future.
  649. See also `org-agenda-todo-ignore-with-date'.
  650. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  651. to make his option also apply to the tags-todo list."
  652. :group 'org-agenda-skip
  653. :group 'org-agenda-todo-list
  654. :version "24.1"
  655. :type '(choice
  656. (const :tag "Ignore future timestamp todos" future)
  657. (const :tag "Ignore past or present timestamp todos" past)
  658. (const :tag "Ignore all timestamp todos" all)
  659. (const :tag "Show timestamp todos" nil)
  660. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  661. (defcustom org-agenda-todo-ignore-scheduled nil
  662. "Non-nil means, ignore some scheduled TODO items when making TODO list.
  663. This applies when creating the global todo list.
  664. Valid values are:
  665. past Don't show entries scheduled today or in the past.
  666. future Don't show entries scheduled in the future.
  667. The idea behind this is that by scheduling it, you don't want to
  668. think about it until the scheduled date.
  669. all Don't show any scheduled entries in the global todo list.
  670. The idea behind this is that by scheduling it, you have already
  671. \"taken care\" of this item.
  672. t Same as `all', for backward compatibility.
  673. This variable can also have an integer as a value. See
  674. `org-agenda-todo-ignore-timestamp' for more details.
  675. See also `org-agenda-todo-ignore-with-date'.
  676. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  677. to make his option also apply to the tags-todo list."
  678. :group 'org-agenda-skip
  679. :group 'org-agenda-todo-list
  680. :type '(choice
  681. (const :tag "Ignore future-scheduled todos" future)
  682. (const :tag "Ignore past- or present-scheduled todos" past)
  683. (const :tag "Ignore all scheduled todos" all)
  684. (const :tag "Ignore all scheduled todos (compatibility)" t)
  685. (const :tag "Show scheduled todos" nil)
  686. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  687. (defcustom org-agenda-todo-ignore-deadlines nil
  688. "Non-nil means ignore some deadline TODO items when making TODO list.
  689. There are different motivations for using different values, please think
  690. carefully when configuring this variable.
  691. This applies when creating the global TODO list.
  692. Valid values are:
  693. near Don't show near deadline entries. A deadline is near when it is
  694. closer than `org-deadline-warning-days' days. The idea behind this
  695. is that such items will appear in the agenda anyway.
  696. far Don't show TODO entries where a deadline has been defined, but
  697. is not going to happen anytime soon. This is useful if you want to use
  698. the TODO list to figure out what to do now.
  699. past Don't show entries with a deadline timestamp for today or in the past.
  700. future Don't show entries with a deadline timestamp in the future, not even
  701. when they become `near' ones. Use it with caution.
  702. all Ignore all TODO entries that do have a deadline.
  703. t Same as `near', for backward compatibility.
  704. This variable can also have an integer as a value. See
  705. `org-agenda-todo-ignore-timestamp' for more details.
  706. See also `org-agenda-todo-ignore-with-date'.
  707. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  708. to make his option also apply to the tags-todo list."
  709. :group 'org-agenda-skip
  710. :group 'org-agenda-todo-list
  711. :type '(choice
  712. (const :tag "Ignore near deadlines" near)
  713. (const :tag "Ignore near deadlines (compatibility)" t)
  714. (const :tag "Ignore far deadlines" far)
  715. (const :tag "Ignore all TODOs with a deadlines" all)
  716. (const :tag "Show all TODOs, even if they have a deadline" nil)
  717. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  718. (defcustom org-agenda-todo-ignore-time-comparison-use-seconds nil
  719. "Time unit to use when possibly ignoring an agenda item.
  720. See the docstring of various `org-agenda-todo-ignore-*' options.
  721. The default is to compare time stamps using days. An item is thus
  722. considered to be in the future if it is at least one day after today.
  723. Non-nil means to compare time stamps using seconds. An item is then
  724. considered future if it has a time value later than current time."
  725. :group 'org-agenda-skip
  726. :group 'org-agenda-todo-list
  727. :version "24.4"
  728. :package-version '(Org . "8.0")
  729. :type '(choice
  730. (const :tag "Compare time with days" nil)
  731. (const :tag "Compare time with seconds" t)))
  732. (defcustom org-agenda-tags-todo-honor-ignore-options nil
  733. "Non-nil means honor todo-list ignores options also in tags-todo search.
  734. The variables
  735. `org-agenda-todo-ignore-with-date',
  736. `org-agenda-todo-ignore-timestamp',
  737. `org-agenda-todo-ignore-scheduled',
  738. `org-agenda-todo-ignore-deadlines'
  739. make the global TODO list skip entries that have time stamps of certain
  740. kinds. If this option is set, the same options will also apply for the
  741. tags-todo search, which is the general tags/property matcher
  742. restricted to unfinished TODO entries only."
  743. :group 'org-agenda-skip
  744. :group 'org-agenda-todo-list
  745. :group 'org-agenda-match-view
  746. :type 'boolean)
  747. (defcustom org-agenda-skip-scheduled-if-done nil
  748. "Non-nil means don't show scheduled items in agenda when they are done.
  749. This is relevant for the daily/weekly agenda, not for the TODO list. It
  750. applies only to the actual date of the scheduling. Warnings about an item
  751. with a past scheduling dates are always turned off when the item is DONE."
  752. :group 'org-agenda-skip
  753. :group 'org-agenda-daily/weekly
  754. :type 'boolean)
  755. (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
  756. "Non-nil means skip scheduling line if same entry shows because of deadline.
  757. In the agenda of today, an entry can show up multiple times
  758. because it is both scheduled and has a nearby deadline, and maybe
  759. a plain time stamp as well.
  760. When this variable is nil, the entry will be shown several times.
  761. When set to t, then only the deadline is shown and the fact that
  762. the entry is scheduled today or was scheduled previously is not
  763. shown.
  764. When set to the symbol `not-today', skip scheduled previously,
  765. but not scheduled today.
  766. When set to the symbol `repeated-after-deadline', skip scheduled
  767. items if they are repeated beyond the current deadline."
  768. :group 'org-agenda-skip
  769. :group 'org-agenda-daily/weekly
  770. :type '(choice
  771. (const :tag "Never" nil)
  772. (const :tag "Always" t)
  773. (const :tag "Not when scheduled today" not-today)
  774. (const :tag "When repeated past deadline" repeated-after-deadline)))
  775. (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
  776. "Non-nil means skip timestamp line if same entry shows because of deadline.
  777. In the agenda of today, an entry can show up multiple times
  778. because it has both a plain timestamp and has a nearby deadline.
  779. When this variable is t, then only the deadline is shown and the
  780. fact that the entry has a timestamp for or including today is not
  781. shown. When this variable is nil, the entry will be shown
  782. several times."
  783. :group 'org-agenda-skip
  784. :group 'org-agenda-daily/weekly
  785. :version "24.1"
  786. :type '(choice
  787. (const :tag "Never" nil)
  788. (const :tag "Always" t)))
  789. (defcustom org-agenda-skip-deadline-if-done nil
  790. "Non-nil means don't show deadlines when the corresponding item is done.
  791. When nil, the deadline is still shown and should give you a happy feeling.
  792. This is relevant for the daily/weekly agenda. It applies only to the
  793. actual date of the deadline. Warnings about approaching and past-due
  794. deadlines are always turned off when the item is DONE."
  795. :group 'org-agenda-skip
  796. :group 'org-agenda-daily/weekly
  797. :type 'boolean)
  798. (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
  799. "Non-nil means skip deadline prewarning when entry is also scheduled.
  800. This will apply on all days where a prewarning for the deadline would
  801. be shown, but not at the day when the entry is actually due. On that day,
  802. the deadline will be shown anyway.
  803. This variable may be set to nil, t, the symbol `pre-scheduled',
  804. or a number which will then give the number of days before the actual
  805. deadline when the prewarnings should resume. The symbol `pre-scheduled'
  806. eliminates the deadline prewarning only prior to the scheduled date.
  807. This can be used in a workflow where the first showing of the deadline will
  808. trigger you to schedule it, and then you don't want to be reminded of it
  809. because you will take care of it on the day when scheduled."
  810. :group 'org-agenda-skip
  811. :group 'org-agenda-daily/weekly
  812. :version "24.1"
  813. :type '(choice
  814. (const :tag "Always show prewarning" nil)
  815. (const :tag "Remove prewarning prior to scheduled date" pre-scheduled)
  816. (const :tag "Remove prewarning if entry is scheduled" t)
  817. (integer :tag "Restart prewarning N days before deadline")))
  818. (defcustom org-agenda-skip-scheduled-delay-if-deadline nil
  819. "Non-nil means skip scheduled delay when entry also has a deadline.
  820. This variable may be set to nil, t, the symbol `post-deadline',
  821. or a number which will then give the number of days after the actual
  822. scheduled date when the delay should expire. The symbol `post-deadline'
  823. eliminates the schedule delay when the date is posterior to the deadline."
  824. :group 'org-agenda-skip
  825. :group 'org-agenda-daily/weekly
  826. :version "24.4"
  827. :package-version '(Org . "8.0")
  828. :type '(choice
  829. (const :tag "Always honor delay" nil)
  830. (const :tag "Ignore delay if posterior to the deadline" post-deadline)
  831. (const :tag "Ignore delay if entry has a deadline" t)
  832. (integer :tag "Honor delay up until N days after the scheduled date")))
  833. (defcustom org-agenda-skip-additional-timestamps-same-entry nil
  834. "When nil, multiple same-day timestamps in entry make multiple agenda lines.
  835. When non-nil, after the search for timestamps has matched once in an
  836. entry, the rest of the entry will not be searched."
  837. :group 'org-agenda-skip
  838. :type 'boolean)
  839. (defcustom org-agenda-skip-timestamp-if-done nil
  840. "Non-nil means don't select item by timestamp or -range if it is DONE."
  841. :group 'org-agenda-skip
  842. :group 'org-agenda-daily/weekly
  843. :type 'boolean)
  844. (defcustom org-agenda-dim-blocked-tasks t
  845. "Non-nil means dim blocked tasks in the agenda display.
  846. This causes some overhead during agenda construction, but if you
  847. have turned on `org-enforce-todo-dependencies',
  848. `org-enforce-todo-checkbox-dependencies', or any other blocking
  849. mechanism, this will create useful feedback in the agenda.
  850. Instead of t, this variable can also have the value `invisible'.
  851. Then blocked tasks will be invisible and only become visible when
  852. they become unblocked. An exemption to this behavior is when a task is
  853. blocked because of unchecked checkboxes below it. Since checkboxes do
  854. not show up in the agenda views, making this task invisible you remove any
  855. trace from agenda views that there is something to do. Therefore, a task
  856. that is blocked because of checkboxes will never be made invisible, it
  857. will only be dimmed."
  858. :group 'org-agenda-daily/weekly
  859. :group 'org-agenda-todo-list
  860. :version "24.3"
  861. :type '(choice
  862. (const :tag "Do not dim" nil)
  863. (const :tag "Dim to a gray face" t)
  864. (const :tag "Make invisible" invisible)))
  865. (defgroup org-agenda-startup nil
  866. "Options concerning initial settings in the Agenda in Org Mode."
  867. :tag "Org Agenda Startup"
  868. :group 'org-agenda)
  869. (defcustom org-agenda-menu-show-matcher t
  870. "Non-nil means show the match string in the agenda dispatcher menu.
  871. When nil, the matcher string is not shown, but is put into the help-echo
  872. property so than moving the mouse over the command shows it.
  873. Setting it to nil is good if matcher strings are very long and/or if
  874. you want to use two-columns display (see `org-agenda-menu-two-columns')."
  875. :group 'org-agenda
  876. :version "24.1"
  877. :type 'boolean)
  878. (defcustom org-agenda-menu-two-columns nil
  879. "Non-nil means, use two columns to show custom commands in the dispatcher.
  880. If you use this, you probably want to set `org-agenda-menu-show-matcher'
  881. to nil."
  882. :group 'org-agenda
  883. :version "24.1"
  884. :type 'boolean)
  885. (defcustom org-agenda-finalize-hook nil
  886. "Hook run just before displaying an agenda buffer.
  887. The buffer is still writable when the hook is called.
  888. You can modify some of the buffer substrings but you should be
  889. extra careful not to modify the text properties of the agenda
  890. headlines as the agenda display heavily relies on them."
  891. :group 'org-agenda-startup
  892. :type 'hook)
  893. (defcustom org-agenda-mouse-1-follows-link nil
  894. "Non-nil means mouse-1 on a link will follow the link in the agenda.
  895. A longer mouse click will still set point. Needs to be set
  896. before org.el is loaded."
  897. :group 'org-agenda-startup
  898. :type 'boolean)
  899. (defcustom org-agenda-start-with-follow-mode nil
  900. "The initial value of follow mode in a newly created agenda window."
  901. :group 'org-agenda-startup
  902. :type 'boolean)
  903. (defcustom org-agenda-follow-indirect nil
  904. "Non-nil means `org-agenda-follow-mode' displays only the
  905. current item's tree, in an indirect buffer."
  906. :group 'org-agenda
  907. :version "24.1"
  908. :type 'boolean)
  909. (defcustom org-agenda-show-outline-path t
  910. "Non-nil means show outline path in echo area after line motion."
  911. :group 'org-agenda-startup
  912. :type 'boolean)
  913. (defcustom org-agenda-start-with-entry-text-mode nil
  914. "The initial value of entry-text-mode in a newly created agenda window."
  915. :group 'org-agenda-startup
  916. :type 'boolean)
  917. (defcustom org-agenda-entry-text-maxlines 5
  918. "Number of text lines to be added when `E' is pressed in the agenda.
  919. Note that this variable only used during agenda display. To add entry text
  920. when exporting the agenda, configure the variable
  921. `org-agenda-add-entry-text-maxlines'."
  922. :group 'org-agenda
  923. :type 'integer)
  924. (defcustom org-agenda-entry-text-exclude-regexps nil
  925. "List of regular expressions to clean up entry text.
  926. The complete matches of all regular expressions in this list will be
  927. removed from entry text before it is shown in the agenda."
  928. :group 'org-agenda
  929. :type '(repeat (regexp)))
  930. (defcustom org-agenda-entry-text-leaders " > "
  931. "Text prepended to the entry text in agenda buffers."
  932. :version "24.4"
  933. :package-version '(Org . "8.0")
  934. :group 'org-agenda
  935. :type 'string)
  936. (defvar org-agenda-entry-text-cleanup-hook nil
  937. "Hook that is run after basic cleanup of entry text to be shown in agenda.
  938. This cleanup is done in a temporary buffer, so the function may inspect and
  939. change the entire buffer.
  940. Some default stuff like drawers and scheduling/deadline dates will already
  941. have been removed when this is called, as will any matches for regular
  942. expressions listed in `org-agenda-entry-text-exclude-regexps'.")
  943. (defvar org-agenda-include-inactive-timestamps nil
  944. "Non-nil means include inactive time stamps in agenda and timeline.
  945. Dynamically scoped.")
  946. (defgroup org-agenda-windows nil
  947. "Options concerning the windows used by the Agenda in Org Mode."
  948. :tag "Org Agenda Windows"
  949. :group 'org-agenda)
  950. (defcustom org-agenda-window-setup 'reorganize-frame
  951. "How the agenda buffer should be displayed.
  952. Possible values for this option are:
  953. current-window Show agenda in the current window, keeping all other windows.
  954. other-window Use `switch-to-buffer-other-window' to display agenda.
  955. only-window Show agenda, deleting all other windows.
  956. reorganize-frame Show only two windows on the current frame, the current
  957. window and the agenda.
  958. other-frame Use `switch-to-buffer-other-frame' to display agenda.
  959. Also, when exiting the agenda, kill that frame.
  960. See also the variable `org-agenda-restore-windows-after-quit'."
  961. :group 'org-agenda-windows
  962. :type '(choice
  963. (const current-window)
  964. (const other-frame)
  965. (const other-window)
  966. (const only-window)
  967. (const reorganize-frame)))
  968. (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
  969. "The min and max height of the agenda window as a fraction of frame height.
  970. The value of the variable is a cons cell with two numbers between 0 and 1.
  971. It only matters if `org-agenda-window-setup' is `reorganize-frame'."
  972. :group 'org-agenda-windows
  973. :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
  974. (defcustom org-agenda-restore-windows-after-quit nil
  975. "Non-nil means restore window configuration upon exiting agenda.
  976. Before the window configuration is changed for displaying the agenda,
  977. the current status is recorded. When the agenda is exited with
  978. `q' or `x' and this option is set, the old state is restored. If
  979. `org-agenda-window-setup' is `other-frame', the value of this
  980. option will be ignored."
  981. :group 'org-agenda-windows
  982. :type 'boolean)
  983. (defcustom org-agenda-span 'week
  984. "Number of days to include in overview display.
  985. Can be day, week, month, year, or any number of days.
  986. Custom commands can set this variable in the options section."
  987. :group 'org-agenda-daily/weekly
  988. :type '(choice (const :tag "Day" day)
  989. (const :tag "Week" week)
  990. (const :tag "Fortnight" fortnight)
  991. (const :tag "Month" month)
  992. (const :tag "Year" year)
  993. (integer :tag "Custom")))
  994. (defcustom org-agenda-start-on-weekday 1
  995. "Non-nil means start the overview always on the specified weekday.
  996. 0 denotes Sunday, 1 denotes Monday, etc.
  997. When nil, always start on the current day.
  998. Custom commands can set this variable in the options section."
  999. :group 'org-agenda-daily/weekly
  1000. :type '(choice (const :tag "Today" nil)
  1001. (integer :tag "Weekday No.")))
  1002. (defcustom org-agenda-show-all-dates t
  1003. "Non-nil means `org-agenda' shows every day in the selected range.
  1004. When nil, only the days which actually have entries are shown."
  1005. :group 'org-agenda-daily/weekly
  1006. :type 'boolean)
  1007. (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
  1008. "Format string for displaying dates in the agenda.
  1009. Used by the daily/weekly agenda and by the timeline. This should be
  1010. a format string understood by `format-time-string', or a function returning
  1011. the formatted date as a string. The function must take a single argument,
  1012. a calendar-style date list like (month day year)."
  1013. :group 'org-agenda-daily/weekly
  1014. :type '(choice
  1015. (string :tag "Format string")
  1016. (function :tag "Function")))
  1017. (defun org-agenda-format-date-aligned (date)
  1018. "Format a DATE string for display in the daily/weekly agenda, or timeline.
  1019. This function makes sure that dates are aligned for easy reading."
  1020. (require 'cal-iso)
  1021. (let* ((dayname (calendar-day-name date))
  1022. (day (cadr date))
  1023. (day-of-week (calendar-day-of-week date))
  1024. (month (car date))
  1025. (monthname (calendar-month-name month))
  1026. (year (nth 2 date))
  1027. (iso-week (org-days-to-iso-week
  1028. (calendar-absolute-from-gregorian date)))
  1029. (weekyear (cond ((and (= month 1) (>= iso-week 52))
  1030. (1- year))
  1031. ((and (= month 12) (<= iso-week 1))
  1032. (1+ year))
  1033. (t year)))
  1034. (weekstring (if (= day-of-week 1)
  1035. (format " W%02d" iso-week)
  1036. "")))
  1037. (format "%-10s %2d %s %4d%s"
  1038. dayname day monthname year weekstring)))
  1039. (defcustom org-agenda-time-leading-zero nil
  1040. "Non-nil means use leading zero for military times in agenda.
  1041. For example, 9:30am would become 09:30 rather than 9:30."
  1042. :group 'org-agenda-daily/weekly
  1043. :version "24.1"
  1044. :type 'boolean)
  1045. (defcustom org-agenda-timegrid-use-ampm nil
  1046. "When set, show AM/PM style timestamps on the timegrid."
  1047. :group 'org-agenda
  1048. :version "24.1"
  1049. :type 'boolean)
  1050. (defun org-agenda-time-of-day-to-ampm (time)
  1051. "Convert TIME of a string like \"13:45\" to an AM/PM style time string."
  1052. (let* ((hour-number (string-to-number (substring time 0 -3)))
  1053. (minute (substring time -2))
  1054. (ampm "am"))
  1055. (cond
  1056. ((equal hour-number 12)
  1057. (setq ampm "pm"))
  1058. ((> hour-number 12)
  1059. (setq ampm "pm")
  1060. (setq hour-number (- hour-number 12))))
  1061. (concat
  1062. (if org-agenda-time-leading-zero
  1063. (format "%02d" hour-number)
  1064. (format "%02s" (number-to-string hour-number)))
  1065. ":" minute ampm)))
  1066. (defun org-agenda-time-of-day-to-ampm-maybe (time)
  1067. "Conditionally convert TIME to AM/PM format based on `org-agenda-timegrid-use-ampm'."
  1068. (if org-agenda-timegrid-use-ampm
  1069. (org-agenda-time-of-day-to-ampm time)
  1070. time))
  1071. (defcustom org-agenda-weekend-days '(6 0)
  1072. "Which days are weekend?
  1073. These days get the special face `org-agenda-date-weekend' in the agenda
  1074. and timeline buffers."
  1075. :group 'org-agenda-daily/weekly
  1076. :type '(set :greedy t
  1077. (const :tag "Monday" 1)
  1078. (const :tag "Tuesday" 2)
  1079. (const :tag "Wednesday" 3)
  1080. (const :tag "Thursday" 4)
  1081. (const :tag "Friday" 5)
  1082. (const :tag "Saturday" 6)
  1083. (const :tag "Sunday" 0)))
  1084. (defcustom org-agenda-move-date-from-past-immediately-to-today t
  1085. "Non-nil means jump to today when moving a past date forward in time.
  1086. When using S-right in the agenda to move a a date forward, and the date
  1087. stamp currently points to the past, the first key press will move it
  1088. to today. WHen nil, just move one day forward even if the date stays
  1089. in the past."
  1090. :group 'org-agenda-daily/weekly
  1091. :version "24.1"
  1092. :type 'boolean)
  1093. (defcustom org-agenda-include-diary nil
  1094. "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
  1095. Custom commands can set this variable in the options section."
  1096. :group 'org-agenda-daily/weekly
  1097. :type 'boolean)
  1098. (defcustom org-agenda-include-deadlines t
  1099. "If non-nil, include entries within their deadline warning period.
  1100. Custom commands can set this variable in the options section."
  1101. :group 'org-agenda-daily/weekly
  1102. :version "24.1"
  1103. :type 'boolean)
  1104. (defcustom org-agenda-show-future-repeats t
  1105. "Non-nil shows repeated entries in the future part of the agenda.
  1106. When set to the symbol `next' only the first future repeat is shown."
  1107. :group 'org-agenda-daily/weekly
  1108. :type '(choice
  1109. (const :tag "Show all repeated entries" t)
  1110. (const :tag "Show next repeated entry" next)
  1111. (const :tag "Do not show repeated entries" nil))
  1112. :version "26.1"
  1113. :package-version '(Org . "9.1")
  1114. :safe #'symbolp)
  1115. (defcustom org-agenda-prefer-last-repeat nil
  1116. "Non-nil sets date for repeated entries to their last repeat.
  1117. When nil, display SCHEDULED and DEADLINE dates at their base
  1118. date, and in today's agenda, as a reminder. Display plain
  1119. time-stamps, on the other hand, at every repeat date in the past
  1120. in addition to the base date.
  1121. When non-nil, show a repeated entry at its latest repeat date,
  1122. possibly being today even if it wasn't marked as done. This
  1123. setting is useful if you do not always mark repeated entries as
  1124. done and, yet, consider that reaching repeat date starts the task
  1125. anew.
  1126. When set to a list of strings, prefer last repeats only for
  1127. entries with these TODO keywords."
  1128. :group 'org-agenda-daily/weekly
  1129. :type '(choice
  1130. (const :tag "Prefer last repeat" t)
  1131. (const :tag "Prefer base date" nil)
  1132. (repeat :tag "Prefer last repeat for entries with these TODO keywords"
  1133. (string :tag "TODO keyword")))
  1134. :version "26.1"
  1135. :package-version '(Org . "9.1")
  1136. :safe (lambda (x) (or (booleanp x) (consp x))))
  1137. (defcustom org-scheduled-past-days 10000
  1138. "Number of days to continue listing scheduled items not marked DONE.
  1139. When an item is scheduled on a date, it shows up in the agenda on
  1140. this day and will be listed until it is marked done or for the
  1141. number of days given here."
  1142. :group 'org-agenda-daily/weekly
  1143. :type 'integer
  1144. :safe 'integerp)
  1145. (defcustom org-deadline-past-days 10000
  1146. "Number of days to warn about missed deadlines.
  1147. When an item has deadline on a date, it shows up in the agenda on
  1148. this day and will appear as a reminder until it is marked DONE or
  1149. for the number of days given here."
  1150. :group 'org-agenda-daily/weekly
  1151. :type 'integer
  1152. :version "26.1"
  1153. :package-version '(Org . "9.1")
  1154. :safe 'integerp)
  1155. (defcustom org-agenda-log-mode-items '(closed clock)
  1156. "List of items that should be shown in agenda log mode.
  1157. \\<org-agenda-mode-map>\
  1158. This list may contain the following symbols:
  1159. closed Show entries that have been closed on that day.
  1160. clock Show entries that have received clocked time on that day.
  1161. state Show all logged state changes.
  1162. Note that instead of changing this variable, you can also press \
  1163. `\\[universal-argument] \\[org-agenda-log-mode]' in
  1164. the agenda to display all available LOG items temporarily."
  1165. :group 'org-agenda-daily/weekly
  1166. :type '(set :greedy t (const closed) (const clock) (const state)))
  1167. (defcustom org-agenda-clock-consistency-checks
  1168. '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
  1169. :gap-ok-around ("4:00")
  1170. :default-face ((:background "DarkRed") (:foreground "white"))
  1171. :overlap-face nil :gap-face nil :no-end-time-face nil
  1172. :long-face nil :short-face nil)
  1173. "This is a property list, with the following keys:
  1174. :max-duration Mark clocking chunks that are longer than this time.
  1175. This is a time string like \"HH:MM\", or the number
  1176. of minutes as an integer.
  1177. :min-duration Mark clocking chunks that are shorter that this.
  1178. This is a time string like \"HH:MM\", or the number
  1179. of minutes as an integer.
  1180. :max-gap Mark gaps between clocking chunks that are longer than
  1181. this duration. A number of minutes, or a string
  1182. like \"HH:MM\".
  1183. :gap-ok-around List of times during the day which are usually not working
  1184. times. When a gap is detected, but the gap contains any
  1185. of these times, the gap is *not* reported. For example,
  1186. if this is (\"4:00\" \"13:00\") then gaps that contain
  1187. 4:00 in the morning (i.e. the night) and 13:00
  1188. (i.e. a typical lunch time) do not cause a warning.
  1189. You should have at least one time during the night in this
  1190. list, or otherwise the first task each morning will trigger
  1191. a warning because it follows a long gap.
  1192. Furthermore, the following properties can be used to define faces for
  1193. issue display.
  1194. :default-face the default face, if the specific face is undefined
  1195. :overlap-face face for overlapping clocks
  1196. :gap-face face for gaps between clocks
  1197. :no-end-time-face face for incomplete clocks
  1198. :long-face face for clock intervals that are too long
  1199. :short-face face for clock intervals that are too short"
  1200. :group 'org-agenda-daily/weekly
  1201. :group 'org-clock
  1202. :version "24.1"
  1203. :type 'plist)
  1204. (defcustom org-agenda-log-mode-add-notes t
  1205. "Non-nil means add first line of notes to log entries in agenda views.
  1206. If a log item like a state change or a clock entry is associated with
  1207. notes, the first line of these notes will be added to the entry in the
  1208. agenda display."
  1209. :group 'org-agenda-daily/weekly
  1210. :type 'boolean)
  1211. (defcustom org-agenda-start-with-log-mode nil
  1212. "The initial value of log-mode in a newly created agenda window.
  1213. See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
  1214. explanations on the possible values."
  1215. :group 'org-agenda-startup
  1216. :group 'org-agenda-daily/weekly
  1217. :type '(choice (const :tag "Don't show log items" nil)
  1218. (const :tag "Show only log items" only)
  1219. (const :tag "Show all possible log items" clockcheck)
  1220. (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
  1221. (choice (const :tag "Show closed log items" closed)
  1222. (const :tag "Show clocked log items" clock)
  1223. (const :tag "Show all logged state changes" state)))))
  1224. (defcustom org-agenda-start-with-clockreport-mode nil
  1225. "The initial value of clockreport-mode in a newly created agenda window."
  1226. :group 'org-agenda-startup
  1227. :group 'org-agenda-daily/weekly
  1228. :type 'boolean)
  1229. (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
  1230. "Property list with parameters for the clocktable in clockreport mode.
  1231. This is the display mode that shows a clock table in the daily/weekly
  1232. agenda, the properties for this dynamic block can be set here.
  1233. The usual clocktable parameters are allowed here, but you cannot set
  1234. the properties :name, :tstart, :tend, :block, and :scope - these will
  1235. be overwritten to make sure the content accurately reflects the
  1236. current display in the agenda."
  1237. :group 'org-agenda-daily/weekly
  1238. :type 'plist)
  1239. (defcustom org-agenda-search-view-always-boolean nil
  1240. "Non-nil means the search string is interpreted as individual parts.
  1241. The search string for search view can either be interpreted as a phrase,
  1242. or as a list of snippets that define a boolean search for a number of
  1243. strings.
  1244. When this is non-nil, the string will be split on whitespace, and each
  1245. snippet will be searched individually, and all must match in order to
  1246. select an entry. A snippet is then a single string of non-white
  1247. characters, or a string in double quotes, or a regexp in {} braces.
  1248. If a snippet is preceded by \"-\", the snippet must *not* match.
  1249. \"+\" is syntactic sugar for positive selection. Each snippet may
  1250. be found as a full word or a partial word, but see the variable
  1251. `org-agenda-search-view-force-full-words'.
  1252. When this is nil, search will look for the entire search phrase as one,
  1253. with each space character matching any amount of whitespace, including
  1254. line breaks.
  1255. Even when this is nil, you can still switch to Boolean search dynamically
  1256. by preceding the first snippet with \"+\" or \"-\". If the first snippet
  1257. is a regexp marked with braces like \"{abc}\", this will also switch to
  1258. boolean search."
  1259. :group 'org-agenda-search-view
  1260. :version "24.1"
  1261. :type 'boolean)
  1262. (defvaralias 'org-agenda-search-view-search-words-only
  1263. 'org-agenda-search-view-always-boolean)
  1264. (defcustom org-agenda-search-view-force-full-words nil
  1265. "Non-nil means, search words must be matches as complete words.
  1266. When nil, they may also match part of a word."
  1267. :group 'org-agenda-search-view
  1268. :version "24.1"
  1269. :type 'boolean)
  1270. (defcustom org-agenda-search-view-max-outline-level 0
  1271. "Maximum outline level to display in search view.
  1272. E.g. when this is set to 1, the search view will only
  1273. show headlines of level 1. When set to 0, the default
  1274. value, don't limit agenda view by outline level."
  1275. :group 'org-agenda-search-view
  1276. :version "24.4"
  1277. :package-version '(Org . "8.3")
  1278. :type 'integer)
  1279. (defgroup org-agenda-time-grid nil
  1280. "Options concerning the time grid in the Org Agenda."
  1281. :tag "Org Agenda Time Grid"
  1282. :group 'org-agenda)
  1283. (defcustom org-agenda-search-headline-for-time t
  1284. "Non-nil means search headline for a time-of-day.
  1285. If the headline contains a time-of-day in one format or another, it will
  1286. be used to sort the entry into the time sequence of items for a day.
  1287. Some people have time stamps in the headline that refer to the creation
  1288. time or so, and then this produces an unwanted side effect. If this is
  1289. the case for your, use this variable to turn off searching the headline
  1290. for a time."
  1291. :group 'org-agenda-time-grid
  1292. :type 'boolean)
  1293. (defcustom org-agenda-use-time-grid t
  1294. "Non-nil means show a time grid in the agenda schedule.
  1295. A time grid is a set of lines for specific times (like every two hours between
  1296. 8:00 and 20:00). The items scheduled for a day at specific times are
  1297. sorted in between these lines.
  1298. For details about when the grid will be shown, and what it will look like, see
  1299. the variable `org-agenda-time-grid'."
  1300. :group 'org-agenda-time-grid
  1301. :type 'boolean)
  1302. (defcustom org-agenda-time-grid
  1303. '((daily today require-timed)
  1304. "----------------"
  1305. (800 1000 1200 1400 1600 1800 2000))
  1306. "The settings for time grid for agenda display.
  1307. This is a list of three items. The first item is again a list. It contains
  1308. symbols specifying conditions when the grid should be displayed:
  1309. daily if the agenda shows a single day
  1310. weekly if the agenda shows an entire week
  1311. today show grid on current date, independent of daily/weekly display
  1312. require-timed show grid only if at least one item has a time specification
  1313. remove-match skip grid times already present in an entry
  1314. The second item is a string which will be placed behind the grid time.
  1315. The third item is a list of integers, indicating the times that should have
  1316. a grid line."
  1317. :group 'org-agenda-time-grid
  1318. :type
  1319. '(list
  1320. (set :greedy t :tag "Grid Display Options"
  1321. (const :tag "Show grid in single day agenda display" daily)
  1322. (const :tag "Show grid in weekly agenda display" weekly)
  1323. (const :tag "Always show grid for today" today)
  1324. (const :tag "Show grid only if any timed entries are present"
  1325. require-timed)
  1326. (const :tag "Skip grid times already present in an entry"
  1327. remove-match))
  1328. (string :tag "Grid String")
  1329. (repeat :tag "Grid Times" (integer :tag "Time"))))
  1330. (defcustom org-agenda-show-current-time-in-grid t
  1331. "Non-nil means show the current time in the time grid."
  1332. :group 'org-agenda-time-grid
  1333. :version "24.1"
  1334. :type 'boolean)
  1335. (defcustom org-agenda-current-time-string
  1336. "now - - - - - - - - - - - - - - - - - - - - - - - - -"
  1337. "The string for the current time marker in the agenda."
  1338. :group 'org-agenda-time-grid
  1339. :version "24.1"
  1340. :type 'string)
  1341. (defgroup org-agenda-sorting nil
  1342. "Options concerning sorting in the Org Agenda."
  1343. :tag "Org Agenda Sorting"
  1344. :group 'org-agenda)
  1345. (defcustom org-agenda-sorting-strategy
  1346. '((agenda habit-down time-up priority-down category-keep)
  1347. (todo priority-down category-keep)
  1348. (tags priority-down category-keep)
  1349. (search category-keep))
  1350. "Sorting structure for the agenda items of a single day.
  1351. This is a list of symbols which will be used in sequence to determine
  1352. if an entry should be listed before another entry. The following
  1353. symbols are recognized:
  1354. time-up Put entries with time-of-day indications first, early first
  1355. time-down Put entries with time-of-day indications first, late first
  1356. timestamp-up Sort by any timestamp, early first
  1357. timestamp-down Sort by any timestamp, late first
  1358. scheduled-up Sort by scheduled timestamp, early first
  1359. scheduled-down Sort by scheduled timestamp, late first
  1360. deadline-up Sort by deadline timestamp, early first
  1361. deadline-down Sort by deadline timestamp, late first
  1362. ts-up Sort by active timestamp, early first
  1363. ts-down Sort by active timestamp, late first
  1364. tsia-up Sort by inactive timestamp, early first
  1365. tsia-down Sort by inactive timestamp, late first
  1366. category-keep Keep the default order of categories, corresponding to the
  1367. sequence in `org-agenda-files'.
  1368. category-up Sort alphabetically by category, A-Z.
  1369. category-down Sort alphabetically by category, Z-A.
  1370. tag-up Sort alphabetically by last tag, A-Z.
  1371. tag-down Sort alphabetically by last tag, Z-A.
  1372. priority-up Sort numerically by priority, high priority last.
  1373. priority-down Sort numerically by priority, high priority first.
  1374. todo-state-up Sort by todo state, tasks that are done last.
  1375. todo-state-down Sort by todo state, tasks that are done first.
  1376. effort-up Sort numerically by estimated effort, high effort last.
  1377. effort-down Sort numerically by estimated effort, high effort first.
  1378. user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
  1379. user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
  1380. habit-up Put entries that are habits first
  1381. habit-down Put entries that are habits last
  1382. alpha-up Sort headlines alphabetically
  1383. alpha-down Sort headlines alphabetically, reversed
  1384. The different possibilities will be tried in sequence, and testing stops
  1385. if one comparison returns a \"not-equal\". For example, the default
  1386. '(time-up category-keep priority-down)
  1387. means: Pull out all entries having a specified time of day and sort them,
  1388. in order to make a time schedule for the current day the first thing in the
  1389. agenda listing for the day. Of the entries without a time indication, keep
  1390. the grouped in categories, don't sort the categories, but keep them in
  1391. the sequence given in `org-agenda-files'. Within each category sort by
  1392. priority.
  1393. Leaving out `category-keep' would mean that items will be sorted across
  1394. categories by priority.
  1395. Instead of a single list, this can also be a set of list for specific
  1396. contents, with a context symbol in the car of the list, any of
  1397. `agenda', `todo', `tags', `search' for the corresponding agenda views.
  1398. Custom commands can bind this variable in the options section."
  1399. :group 'org-agenda-sorting
  1400. :type `(choice
  1401. (repeat :tag "General" ,org-sorting-choice)
  1402. (list :tag "Individually"
  1403. (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
  1404. (repeat ,org-sorting-choice))
  1405. (cons (const :tag "Strategy for TODO lists" todo)
  1406. (repeat ,org-sorting-choice))
  1407. (cons (const :tag "Strategy for Tags matches" tags)
  1408. (repeat ,org-sorting-choice))
  1409. (cons (const :tag "Strategy for search matches" search)
  1410. (repeat ,org-sorting-choice)))))
  1411. (defcustom org-agenda-cmp-user-defined nil
  1412. "A function to define the comparison `user-defined'.
  1413. This function must receive two arguments, agenda entry a and b.
  1414. If a>b, return +1. If a<b, return -1. If they are equal as seen by
  1415. the user comparison, return nil.
  1416. When this is defined, you can make `user-defined-up' and `user-defined-down'
  1417. part of an agenda sorting strategy."
  1418. :group 'org-agenda-sorting
  1419. :type 'symbol)
  1420. (defcustom org-sort-agenda-notime-is-late t
  1421. "Non-nil means items without time are considered late.
  1422. This is only relevant for sorting. When t, items which have no explicit
  1423. time like 15:30 will be considered as 99:01, i.e. later than any items which
  1424. do have a time. When nil, the default time is before 0:00. You can use this
  1425. option to decide if the schedule for today should come before or after timeless
  1426. agenda entries."
  1427. :group 'org-agenda-sorting
  1428. :type 'boolean)
  1429. (defcustom org-sort-agenda-noeffort-is-high t
  1430. "Non-nil means items without effort estimate are sorted as high effort.
  1431. This also applies when filtering an agenda view with respect to the
  1432. < or > effort operator. Then, tasks with no effort defined will be treated
  1433. as tasks with high effort.
  1434. When nil, such items are sorted as 0 minutes effort."
  1435. :group 'org-agenda-sorting
  1436. :type 'boolean)
  1437. (defgroup org-agenda-line-format nil
  1438. "Options concerning the entry prefix in the Org agenda display."
  1439. :tag "Org Agenda Line Format"
  1440. :group 'org-agenda)
  1441. (defcustom org-agenda-prefix-format
  1442. '((agenda . " %i %-12:c%?-12t% s")
  1443. (timeline . " % s")
  1444. (todo . " %i %-12:c")
  1445. (tags . " %i %-12:c")
  1446. (search . " %i %-12:c"))
  1447. "Format specifications for the prefix of items in the agenda views.
  1448. An alist with five entries, each for the different agenda types. The
  1449. keys of the sublists are `agenda', `timeline', `todo', `search' and `tags'.
  1450. The values are format strings.
  1451. This format works similar to a printf format, with the following meaning:
  1452. %c the category of the item, \"Diary\" for entries from the diary,
  1453. or as given by the CATEGORY keyword or derived from the file name
  1454. %e the effort required by the item
  1455. %l the level of the item (insert X space(s) if item is of level X)
  1456. %i the icon category of the item, see `org-agenda-category-icon-alist'
  1457. %T the last tag of the item (ignore inherited tags, which come first)
  1458. %t the HH:MM time-of-day specification if one applies to the entry
  1459. %s Scheduling/Deadline information, a short string
  1460. %b show breadcrumbs, i.e., the names of the higher levels
  1461. %(expression) Eval EXPRESSION and replace the control string
  1462. by the result
  1463. All specifiers work basically like the standard `%s' of printf, but may
  1464. contain two additional characters: a question mark just after the `%'
  1465. and a whitespace/punctuation character just before the final letter.
  1466. If the first character after `%' is a question mark, the entire field
  1467. will only be included if the corresponding value applies to the current
  1468. entry. This is useful for fields which should have fixed width when
  1469. present, but zero width when absent. For example, \"%?-12t\" will
  1470. result in a 12 character time field if a time of the day is specified,
  1471. but will completely disappear in entries which do not contain a time.
  1472. If there is punctuation or whitespace character just before the
  1473. final format letter, this character will be appended to the field
  1474. value if the value is not empty. For example, the format
  1475. \"%-12:c\" leads to \"Diary: \" if the category is \"Diary\". If
  1476. the category is empty, no additional colon is inserted.
  1477. The default value for the agenda sublist is \" %-12:c%?-12t% s\",
  1478. which means:
  1479. - Indent the line with two space characters
  1480. - Give the category a 12 chars wide field, padded with whitespace on
  1481. the right (because of `-'). Append a colon if there is a category
  1482. (because of `:').
  1483. - If there is a time-of-day, put it into a 12 chars wide field. If no
  1484. time, don't put in an empty field, just skip it (because of '?').
  1485. - Finally, put the scheduling information.
  1486. See also the variables `org-agenda-remove-times-when-in-prefix' and
  1487. `org-agenda-remove-tags'.
  1488. Custom commands can set this variable in the options section."
  1489. :type '(choice
  1490. (string :tag "General format")
  1491. (list :greedy t :tag "View dependent"
  1492. (cons (const agenda) (string :tag "Format"))
  1493. (cons (const timeline) (string :tag "Format"))
  1494. (cons (const todo) (string :tag "Format"))
  1495. (cons (const tags) (string :tag "Format"))
  1496. (cons (const search) (string :tag "Format"))))
  1497. :group 'org-agenda-line-format)
  1498. (defvar org-prefix-format-compiled nil
  1499. "The compiled prefix format and associated variables.
  1500. This is a list where first element is a list of variable bindings, and second
  1501. element is the compiled format expression. See the variable
  1502. `org-agenda-prefix-format'.")
  1503. (defcustom org-agenda-todo-keyword-format "%-1s"
  1504. "Format for the TODO keyword in agenda lines.
  1505. Set this to something like \"%-12s\" if you want all TODO keywords
  1506. to occupy a fixed space in the agenda display."
  1507. :group 'org-agenda-line-format
  1508. :type 'string)
  1509. (defcustom org-agenda-diary-sexp-prefix nil
  1510. "A regexp that matches part of a diary sexp entry
  1511. which should be treated as scheduling/deadline information in
  1512. `org-agenda'.
  1513. For example, you can use this to extract the `diary-remind-message' from
  1514. `diary-remind' entries."
  1515. :group 'org-agenda-line-format
  1516. :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
  1517. (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
  1518. "Text preceding timerange entries in the agenda view.
  1519. This is a list with two strings. The first applies when the range
  1520. is entirely on one day. The second applies if the range spans several days.
  1521. The strings may have two \"%d\" format specifiers which will be filled
  1522. with the sequence number of the days, and the total number of days in the
  1523. range, respectively."
  1524. :group 'org-agenda-line-format
  1525. :type '(list
  1526. (string :tag "Deadline today ")
  1527. (choice :tag "Deadline relative"
  1528. (string :tag "Format string")
  1529. (function))))
  1530. (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
  1531. "Text preceding scheduled items in the agenda view.
  1532. This is a list with two strings. The first applies when the item is
  1533. scheduled on the current day. The second applies when it has been scheduled
  1534. previously, it may contain a %d indicating that this is the nth time that
  1535. this item is scheduled, due to automatic rescheduling of unfinished items
  1536. for the following day. So this number is one larger than the number of days
  1537. that passed since this item was scheduled first."
  1538. :group 'org-agenda-line-format
  1539. :version "24.4"
  1540. :package-version '(Org . "8.0")
  1541. :type '(list
  1542. (string :tag "Scheduled today ")
  1543. (string :tag "Scheduled previously")))
  1544. (defcustom org-agenda-inactive-leader "["
  1545. "Text preceding item pulled into the agenda by inactive time stamps.
  1546. These entries are added to the agenda when pressing \"[\"."
  1547. :group 'org-agenda-line-format
  1548. :version "24.1"
  1549. :type 'string)
  1550. (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: " "%2d d. ago: ")
  1551. "Text preceding deadline items in the agenda view.
  1552. This is a list with three strings. The first applies when the item has its
  1553. deadline on the current day. The second applies when the deadline is in the
  1554. future, the third one when it is in the past. The strings may contain %d
  1555. to capture the number of days."
  1556. :group 'org-agenda-line-format
  1557. :version "24.4"
  1558. :package-version '(Org . "8.0")
  1559. :type '(list
  1560. (string :tag "Deadline today ")
  1561. (string :tag "Deadline in the future ")
  1562. (string :tag "Deadline in the past ")))
  1563. (defcustom org-agenda-remove-times-when-in-prefix t
  1564. "Non-nil means remove duplicate time specifications in agenda items.
  1565. When the format `org-agenda-prefix-format' contains a `%t' specifier, a
  1566. time-of-day specification in a headline or diary entry is extracted and
  1567. placed into the prefix. If this option is non-nil, the original specification
  1568. \(a timestamp or -range, or just a plain time(range) specification like
  1569. 11:30-4pm) will be removed for agenda display. This makes the agenda less
  1570. cluttered.
  1571. The option can be t or nil. It may also be the symbol `beg', indicating
  1572. that the time should only be removed when it is located at the beginning of
  1573. the headline/diary entry."
  1574. :group 'org-agenda-line-format
  1575. :type '(choice
  1576. (const :tag "Always" t)
  1577. (const :tag "Never" nil)
  1578. (const :tag "When at beginning of entry" beg)))
  1579. (defcustom org-agenda-remove-timeranges-from-blocks nil
  1580. "Non-nil means remove time ranges specifications in agenda
  1581. items that span on several days."
  1582. :group 'org-agenda-line-format
  1583. :version "24.1"
  1584. :type 'boolean)
  1585. (defcustom org-agenda-default-appointment-duration nil
  1586. "Default duration for appointments that only have a starting time.
  1587. When nil, no duration is specified in such cases.
  1588. When non-nil, this must be the number of minutes, e.g. 60 for one hour."
  1589. :group 'org-agenda-line-format
  1590. :type '(choice
  1591. (integer :tag "Minutes")
  1592. (const :tag "No default duration")))
  1593. (defcustom org-agenda-show-inherited-tags t
  1594. "Non-nil means show inherited tags in each agenda line.
  1595. When this option is set to `always', it takes precedence over
  1596. `org-agenda-use-tag-inheritance' and inherited tags are shown
  1597. in every agenda.
  1598. When this option is set to t (the default), inherited tags are
  1599. shown when they are available, i.e. when the value of
  1600. `org-agenda-use-tag-inheritance' enables tag inheritance for the
  1601. given agenda type.
  1602. This can be set to a list of agenda types in which the agenda
  1603. must display the inherited tags. Available types are `todo',
  1604. `agenda', `search' and `timeline'.
  1605. When set to nil, never show inherited tags in agenda lines."
  1606. :group 'org-agenda-line-format
  1607. :group 'org-agenda
  1608. :version "24.3"
  1609. :type '(choice
  1610. (const :tag "Show inherited tags when available" t)
  1611. (const :tag "Always show inherited tags" always)
  1612. (repeat :tag "Show inherited tags only in selected agenda types"
  1613. (symbol :tag "Agenda type"))))
  1614. (defcustom org-agenda-use-tag-inheritance '(todo search timeline agenda)
  1615. "List of agenda view types where to use tag inheritance.
  1616. In tags/tags-todo/tags-tree agenda views, tag inheritance is
  1617. controlled by `org-use-tag-inheritance'. In other agenda types,
  1618. `org-use-tag-inheritance' is not used for the selection of the
  1619. agenda entries. Still, you may want the agenda to be aware of
  1620. the inherited tags anyway, e.g. for later tag filtering.
  1621. Allowed value are `todo', `search', `timeline' and `agenda'.
  1622. This variable has no effect if `org-agenda-show-inherited-tags'
  1623. is set to `always'. In that case, the agenda is aware of those
  1624. tags.
  1625. The default value sets tags in every agenda type. Setting this
  1626. option to nil will speed up non-tags agenda view a lot."
  1627. :group 'org-agenda
  1628. :version "24.3"
  1629. :type '(choice
  1630. (const :tag "Use tag inheritance in all agenda types" t)
  1631. (repeat :tag "Use tag inheritance in selected agenda types"
  1632. (symbol :tag "Agenda type"))))
  1633. (defcustom org-agenda-hide-tags-regexp nil
  1634. "Regular expression used to filter away specific tags in agenda views.
  1635. This means that these tags will be present, but not be shown in the agenda
  1636. line. Secondary filtering will still work on the hidden tags.
  1637. Nil means don't hide any tags."
  1638. :group 'org-agenda-line-format
  1639. :type '(choice
  1640. (const :tag "Hide none" nil)
  1641. (string :tag "Regexp ")))
  1642. (defcustom org-agenda-remove-tags nil
  1643. "Non-nil means remove the tags from the headline copy in the agenda.
  1644. When this is the symbol `prefix', only remove tags when
  1645. `org-agenda-prefix-format' contains a `%T' specifier."
  1646. :group 'org-agenda-line-format
  1647. :type '(choice
  1648. (const :tag "Always" t)
  1649. (const :tag "Never" nil)
  1650. (const :tag "When prefix format contains %T" prefix)))
  1651. (defvaralias 'org-agenda-remove-tags-when-in-prefix
  1652. 'org-agenda-remove-tags)
  1653. (defcustom org-agenda-tags-column -80
  1654. "Shift tags in agenda items to this column.
  1655. If this number is positive, it specifies the column. If it is negative,
  1656. it means that the tags should be flushright to that column. For example,
  1657. -80 works well for a normal 80 character screen."
  1658. :group 'org-agenda-line-format
  1659. :type 'integer)
  1660. (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column)
  1661. (defcustom org-agenda-fontify-priorities 'cookies
  1662. "Non-nil means highlight low and high priorities in agenda.
  1663. When t, the highest priority entries are bold, lowest priority italic.
  1664. However, settings in `org-priority-faces' will overrule these faces.
  1665. When this variable is the symbol `cookies', only fontify the
  1666. cookies, not the entire task.
  1667. This may also be an association list of priority faces, whose
  1668. keys are the character values of `org-highest-priority',
  1669. `org-default-priority', and `org-lowest-priority' (the default values
  1670. are ?A, ?B, and ?C, respectively). The face may be a named face, a
  1671. color as a string, or a list like `(:background \"Red\")'.
  1672. If it is a color, the variable `org-faces-easy-properties'
  1673. determines if it is a foreground or a background color."
  1674. :group 'org-agenda-line-format
  1675. :type '(choice
  1676. (const :tag "Never" nil)
  1677. (const :tag "Defaults" t)
  1678. (const :tag "Cookies only" cookies)
  1679. (repeat :tag "Specify"
  1680. (list (character :tag "Priority" :value ?A)
  1681. (choice :tag "Face "
  1682. (string :tag "Color")
  1683. (sexp :tag "Face"))))))
  1684. (defcustom org-agenda-day-face-function nil
  1685. "Function called to determine what face should be used to display a day.
  1686. The only argument passed to that function is the day. It should
  1687. returns a face, or nil if does not want to specify a face and let
  1688. the normal rules apply."
  1689. :group 'org-agenda-line-format
  1690. :version "24.1"
  1691. :type '(choice (const nil) (function)))
  1692. (defcustom org-agenda-category-icon-alist nil
  1693. "Alist of category icon to be displayed in agenda views.
  1694. Each entry should have the following format:
  1695. (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
  1696. Where CATEGORY-REGEXP is a regexp matching the categories where
  1697. the icon should be displayed.
  1698. FILE-OR-DATA either a file path or a string containing image data.
  1699. The other fields can be omitted safely if not needed:
  1700. TYPE indicates the image type.
  1701. DATA-P is a boolean indicating whether the FILE-OR-DATA string is
  1702. image data.
  1703. PROPS are additional image attributes to assign to the image,
  1704. like, e.g. `:ascent center'.
  1705. (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
  1706. If you want to set the display properties yourself, just put a
  1707. list as second element:
  1708. (CATEGORY-REGEXP (MY PROPERTY LIST))
  1709. For example, to display a 16px horizontal space for Emacs
  1710. category, you can use:
  1711. (\"Emacs\" \\='(space . (:width (16))))"
  1712. :group 'org-agenda-line-format
  1713. :version "24.1"
  1714. :type '(alist :key-type (string :tag "Regexp matching category")
  1715. :value-type (choice (list :tag "Icon"
  1716. (string :tag "File or data")
  1717. (symbol :tag "Type")
  1718. (boolean :tag "Data?")
  1719. (repeat :tag "Extra image properties" :inline t symbol))
  1720. (list :tag "Display properties" sexp))))
  1721. (defgroup org-agenda-column-view nil
  1722. "Options concerning column view in the agenda."
  1723. :tag "Org Agenda Column View"
  1724. :group 'org-agenda)
  1725. (defcustom org-agenda-view-columns-initially nil
  1726. "When non-nil, switch to columns view right after creating the agenda."
  1727. :group 'org-agenda-column-view
  1728. :type 'boolean
  1729. :version "26.1"
  1730. :package-version '(Org . "9.0")
  1731. :safe #'booleanp)
  1732. (defcustom org-agenda-columns-show-summaries t
  1733. "Non-nil means show summaries for columns displayed in the agenda view."
  1734. :group 'org-agenda-column-view
  1735. :type 'boolean)
  1736. (defcustom org-agenda-columns-compute-summary-properties t
  1737. "Non-nil means recompute all summary properties before column view.
  1738. When column view in the agenda is listing properties that have a summary
  1739. operator, it can go to all relevant buffers and recompute the summaries
  1740. there. This can mean overhead for the agenda column view, but is necessary
  1741. to have thing up to date.
  1742. As a special case, a CLOCKSUM property also makes sure that the clock
  1743. computations are current."
  1744. :group 'org-agenda-column-view
  1745. :type 'boolean)
  1746. (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
  1747. "Non-nil means the duration of an appointment will add to day effort.
  1748. The property to which appointment durations will be added is the one given
  1749. in the option `org-effort-property'. If an appointment does not have
  1750. an end time, `org-agenda-default-appointment-duration' will be used. If that
  1751. is not set, an appointment without end time will not contribute to the time
  1752. estimate."
  1753. :group 'org-agenda-column-view
  1754. :type 'boolean)
  1755. (defcustom org-agenda-auto-exclude-function nil
  1756. "A function called with a tag to decide if it is filtered on \
  1757. \\<org-agenda-mode-map>`\\[org-agenda-filter-by-tag] RET'.
  1758. The sole argument to the function, which is called once for each
  1759. possible tag, is a string giving the name of the tag. The
  1760. function should return either nil if the tag should be included
  1761. as normal, or \"-<TAG>\" to exclude the tag.
  1762. Note that for the purpose of tag filtering, only the lower-case version of
  1763. all tags will be considered, so that this function will only ever see
  1764. the lower-case version of all tags."
  1765. :group 'org-agenda
  1766. :type '(choice (const nil) (function)))
  1767. (defcustom org-agenda-bulk-custom-functions nil
  1768. "Alist of characters and custom functions for bulk actions.
  1769. For example, this value makes those two functions available:
  1770. \\='((?R set-category)
  1771. (?C bulk-cut))
  1772. With selected entries in an agenda buffer, `B R' will call
  1773. the custom function `set-category' on the selected entries.
  1774. Note that functions in this alist don't need to be quoted."
  1775. :type '(alist :key-type character :value-type (group function))
  1776. :version "24.1"
  1777. :group 'org-agenda)
  1778. (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
  1779. "Execute BODY with point at location given by `org-hd-marker' property.
  1780. If STRING is non-nil, the text property will be fetched from position 0
  1781. in that string. If STRING is nil, it will be fetched from the beginning
  1782. of the current line."
  1783. (org-with-gensyms (marker)
  1784. `(let ((,marker (get-text-property (if ,string 0 (point-at-bol))
  1785. 'org-hd-marker ,string)))
  1786. (with-current-buffer (marker-buffer ,marker)
  1787. (save-excursion
  1788. (goto-char ,marker)
  1789. ,@body)))))
  1790. (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
  1791. (defun org-add-agenda-custom-command (entry)
  1792. "Replace or add a command in `org-agenda-custom-commands'.
  1793. This is mostly for hacking and trying a new command - once the command
  1794. works you probably want to add it to `org-agenda-custom-commands' for good."
  1795. (let ((ass (assoc (car entry) org-agenda-custom-commands)))
  1796. (if ass
  1797. (setcdr ass (cdr entry))
  1798. (push entry org-agenda-custom-commands))))
  1799. ;;; Define the org-agenda-mode
  1800. (defvar org-agenda-mode-map (make-sparse-keymap)
  1801. "Keymap for `org-agenda-mode'.")
  1802. (defvaralias 'org-agenda-keymap 'org-agenda-mode-map)
  1803. (defvar org-agenda-menu) ; defined later in this file.
  1804. (defvar org-agenda-restrict nil) ; defined later in this file.
  1805. (defvar org-agenda-follow-mode nil)
  1806. (defvar org-agenda-entry-text-mode nil)
  1807. (defvar org-agenda-clockreport-mode nil)
  1808. (defvar org-agenda-show-log nil)
  1809. (defvar org-agenda-redo-command nil)
  1810. (defvar org-agenda-query-string nil)
  1811. (defvar org-agenda-mode-hook nil
  1812. "Hook run after `org-agenda-mode' is turned on.
  1813. The buffer is still writable when this hook is called.")
  1814. (defvar org-agenda-type nil)
  1815. (defvar org-agenda-force-single-file nil)
  1816. (defvar org-agenda-bulk-marked-entries nil
  1817. "List of markers that refer to marked entries in the agenda.")
  1818. (defvar org-agenda-current-date nil
  1819. "Active date when building the agenda.")
  1820. ;;; Multiple agenda buffers support
  1821. (defcustom org-agenda-sticky nil
  1822. "Non-nil means agenda q key will bury agenda buffers.
  1823. Agenda commands will then show existing buffer instead of generating new ones.
  1824. When nil, `q' will kill the single agenda buffer."
  1825. :group 'org-agenda
  1826. :version "24.3"
  1827. :type 'boolean)
  1828. ;;;###autoload
  1829. (defun org-toggle-sticky-agenda (&optional arg)
  1830. "Toggle `org-agenda-sticky'."
  1831. (interactive "P")
  1832. (let ((new-value (if arg
  1833. (> (prefix-numeric-value arg) 0)
  1834. (not org-agenda-sticky))))
  1835. (if (equal new-value org-agenda-sticky)
  1836. (and (called-interactively-p 'interactive)
  1837. (message "Sticky agenda was already %s"
  1838. (if org-agenda-sticky "enabled" "disabled")))
  1839. (setq org-agenda-sticky new-value)
  1840. (org-agenda-kill-all-agenda-buffers)
  1841. (and (called-interactively-p 'interactive)
  1842. (message "Sticky agenda %s"
  1843. (if org-agenda-sticky "enabled" "disabled"))))))
  1844. (defvar org-agenda-buffer nil
  1845. "Agenda buffer currently being generated.")
  1846. (defvar org-agenda-last-prefix-arg nil)
  1847. (defvar org-agenda-this-buffer-name nil)
  1848. (defvar org-agenda-doing-sticky-redo nil)
  1849. (defvar org-agenda-this-buffer-is-sticky nil)
  1850. (defvar org-agenda-last-indirect-buffer nil
  1851. "Last buffer loaded by `org-agenda-tree-to-indirect-buffer'.")
  1852. (defconst org-agenda-local-vars
  1853. '(org-agenda-this-buffer-name
  1854. org-agenda-undo-list
  1855. org-agenda-pending-undo-list
  1856. org-agenda-follow-mode
  1857. org-agenda-entry-text-mode
  1858. org-agenda-clockreport-mode
  1859. org-agenda-show-log
  1860. org-agenda-redo-command
  1861. org-agenda-query-string
  1862. org-agenda-type
  1863. org-agenda-bulk-marked-entries
  1864. org-agenda-undo-has-started-in
  1865. org-agenda-info
  1866. org-agenda-pre-window-conf
  1867. org-agenda-columns-active
  1868. org-agenda-tag-filter
  1869. org-agenda-category-filter
  1870. org-agenda-top-headline-filter
  1871. org-agenda-regexp-filter
  1872. org-agenda-effort-filter
  1873. org-agenda-markers
  1874. org-agenda-last-search-view-search-was-boolean
  1875. org-agenda-last-indirect-buffer
  1876. org-agenda-filtered-by-category
  1877. org-agenda-filter-form
  1878. org-agenda-cycle-counter
  1879. org-agenda-last-prefix-arg)
  1880. "Variables that must be local in agenda buffers to allow multiple buffers.")
  1881. (defun org-agenda-mode ()
  1882. "Mode for time-sorted view on action items in Org files.
  1883. The following commands are available:
  1884. \\{org-agenda-mode-map}"
  1885. (interactive)
  1886. (cond (org-agenda-doing-sticky-redo
  1887. ;; Refreshing sticky agenda-buffer
  1888. ;;
  1889. ;; Preserve the value of `org-agenda-local-vars' variables,
  1890. ;; while letting `kill-all-local-variables' kill the rest
  1891. (let ((save (buffer-local-variables)))
  1892. (kill-all-local-variables)
  1893. (mapc #'make-local-variable org-agenda-local-vars)
  1894. (dolist (elem save)
  1895. (pcase elem
  1896. (`(,var . ,val) ;ignore unbound variables
  1897. (when (and val (memq var org-agenda-local-vars))
  1898. (set var val))))))
  1899. (setq-local org-agenda-this-buffer-is-sticky t))
  1900. (org-agenda-sticky
  1901. ;; Creating a sticky Agenda buffer for the first time
  1902. (kill-all-local-variables)
  1903. (mapc 'make-local-variable org-agenda-local-vars)
  1904. (setq-local org-agenda-this-buffer-is-sticky t))
  1905. (t
  1906. ;; Creating a non-sticky agenda buffer
  1907. (kill-all-local-variables)
  1908. (setq-local org-agenda-this-buffer-is-sticky nil)))
  1909. (setq org-agenda-undo-list nil
  1910. org-agenda-pending-undo-list nil
  1911. org-agenda-bulk-marked-entries nil)
  1912. (setq major-mode 'org-agenda-mode)
  1913. ;; Keep global-font-lock-mode from turning on font-lock-mode
  1914. (setq-local font-lock-global-modes (list 'not major-mode))
  1915. (setq mode-name "Org-Agenda")
  1916. (setq indent-tabs-mode nil)
  1917. (use-local-map org-agenda-mode-map)
  1918. (easy-menu-add org-agenda-menu)
  1919. (if org-startup-truncated (setq truncate-lines t))
  1920. (setq-local line-move-visual nil)
  1921. (add-hook 'post-command-hook 'org-agenda-update-agenda-type nil 'local)
  1922. (add-hook 'pre-command-hook 'org-unhighlight nil 'local)
  1923. ;; Make sure properties are removed when copying text
  1924. (add-hook 'filter-buffer-substring-functions
  1925. (lambda (fun start end delete)
  1926. (substring-no-properties (funcall fun start end delete)))
  1927. nil t)
  1928. (unless org-agenda-keep-modes
  1929. (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
  1930. org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode))
  1931. (setq org-agenda-show-log org-agenda-start-with-log-mode)
  1932. (setq org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode)
  1933. (add-to-invisibility-spec '(org-filtered))
  1934. (add-to-invisibility-spec '(org-link))
  1935. (easy-menu-change
  1936. '("Agenda") "Agenda Files"
  1937. (append
  1938. (list
  1939. (vector
  1940. (if (get 'org-agenda-files 'org-restrict)
  1941. "Restricted to single file"
  1942. "Edit File List")
  1943. '(org-edit-agenda-file-list)
  1944. (not (get 'org-agenda-files 'org-restrict)))
  1945. "--")
  1946. (mapcar 'org-file-menu-entry (org-agenda-files))))
  1947. (org-agenda-set-mode-name)
  1948. (apply
  1949. (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
  1950. (list 'org-agenda-mode-hook)))
  1951. (substitute-key-definition 'undo 'org-agenda-undo
  1952. org-agenda-mode-map global-map)
  1953. (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
  1954. (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
  1955. (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
  1956. (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
  1957. (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
  1958. (org-defkey org-agenda-mode-map [(meta down)] 'org-agenda-drag-line-forward)
  1959. (org-defkey org-agenda-mode-map [(meta up)] 'org-agenda-drag-line-backward)
  1960. (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
  1961. (org-defkey org-agenda-mode-map "\M-m" 'org-agenda-bulk-toggle)
  1962. (org-defkey org-agenda-mode-map "*" 'org-agenda-bulk-mark-all)
  1963. (org-defkey org-agenda-mode-map "\M-*" 'org-agenda-bulk-toggle-all)
  1964. (org-defkey org-agenda-mode-map "#" 'org-agenda-dim-blocked-tasks)
  1965. (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
  1966. (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
  1967. (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-unmark-all)
  1968. (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
  1969. (org-defkey org-agenda-mode-map "k" 'org-agenda-capture)
  1970. (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
  1971. (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
  1972. (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
  1973. (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
  1974. (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
  1975. (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
  1976. (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
  1977. (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
  1978. (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
  1979. (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
  1980. (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
  1981. (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
  1982. (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
  1983. (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
  1984. (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
  1985. (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
  1986. (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
  1987. (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
  1988. (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
  1989. (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
  1990. (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
  1991. (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
  1992. (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
  1993. (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
  1994. (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
  1995. (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
  1996. (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
  1997. (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
  1998. (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
  1999. (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
  2000. (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
  2001. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
  2002. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
  2003. (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
  2004. (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
  2005. (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
  2006. (let ((l '(1 2 3 4 5 6 7 8 9 0)))
  2007. (while l (org-defkey org-agenda-mode-map
  2008. (int-to-string (pop l)) 'digit-argument)))
  2009. (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
  2010. (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
  2011. (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
  2012. (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
  2013. (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
  2014. (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
  2015. (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
  2016. (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
  2017. (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
  2018. (org-defkey org-agenda-mode-map "g" (lambda () (interactive) (org-agenda-redo t)))
  2019. (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
  2020. (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
  2021. (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
  2022. 'org-clock-modify-effort-estimate)
  2023. (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
  2024. (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
  2025. (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
  2026. (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
  2027. (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
  2028. (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
  2029. (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
  2030. (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
  2031. (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
  2032. (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
  2033. (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
  2034. (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
  2035. (substitute-key-definition 'next-line 'org-agenda-next-line
  2036. org-agenda-mode-map global-map)
  2037. (substitute-key-definition 'previous-line 'org-agenda-previous-line
  2038. org-agenda-mode-map global-map)
  2039. (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
  2040. (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
  2041. (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
  2042. (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
  2043. (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
  2044. (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
  2045. (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
  2046. (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
  2047. (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
  2048. (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
  2049. (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
  2050. (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
  2051. (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
  2052. (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
  2053. (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
  2054. (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
  2055. (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
  2056. (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
  2057. (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  2058. (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
  2059. (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
  2060. (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
  2061. (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
  2062. (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
  2063. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
  2064. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
  2065. (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
  2066. (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
  2067. (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
  2068. (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  2069. (org-defkey org-agenda-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock-from-agenda)
  2070. (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
  2071. (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
  2072. (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
  2073. (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
  2074. (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
  2075. (org-defkey org-agenda-mode-map "_" 'org-agenda-filter-by-effort)
  2076. (org-defkey org-agenda-mode-map "=" 'org-agenda-filter-by-regexp)
  2077. (org-defkey org-agenda-mode-map "|" 'org-agenda-filter-remove-all)
  2078. (org-defkey org-agenda-mode-map "~" 'org-agenda-limit-interactively)
  2079. (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
  2080. (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-headline)
  2081. (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
  2082. (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
  2083. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  2084. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  2085. (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
  2086. (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
  2087. (define-key org-agenda-mode-map [remap forward-paragraph] 'org-agenda-forward-block)
  2088. (define-key org-agenda-mode-map [remap backward-paragraph] 'org-agenda-backward-block)
  2089. (when org-agenda-mouse-1-follows-link
  2090. (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
  2091. (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
  2092. '("Agenda"
  2093. ("Agenda Files")
  2094. "--"
  2095. ("Agenda Dates"
  2096. ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
  2097. ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
  2098. ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
  2099. ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
  2100. "--"
  2101. ("View"
  2102. ["Day View" org-agenda-day-view
  2103. :active (org-agenda-check-type nil 'agenda)
  2104. :style radio :selected (eq org-agenda-current-span 'day)
  2105. :keys "v d (or just d)"]
  2106. ["Week View" org-agenda-week-view
  2107. :active (org-agenda-check-type nil 'agenda)
  2108. :style radio :selected (eq org-agenda-current-span 'week)
  2109. :keys "v w"]
  2110. ["Fortnight View" org-agenda-fortnight-view
  2111. :active (org-agenda-check-type nil 'agenda)
  2112. :style radio :selected (eq org-agenda-current-span 'fortnight)
  2113. :keys "v t"]
  2114. ["Month View" org-agenda-month-view
  2115. :active (org-agenda-check-type nil 'agenda)
  2116. :style radio :selected (eq org-agenda-current-span 'month)
  2117. :keys "v m"]
  2118. ["Year View" org-agenda-year-view
  2119. :active (org-agenda-check-type nil 'agenda)
  2120. :style radio :selected (eq org-agenda-current-span 'year)
  2121. :keys "v y"]
  2122. "--"
  2123. ["Include Diary" org-agenda-toggle-diary
  2124. :style toggle :selected org-agenda-include-diary
  2125. :active (org-agenda-check-type nil 'agenda)]
  2126. ["Include Deadlines" org-agenda-toggle-deadlines
  2127. :style toggle :selected org-agenda-include-deadlines
  2128. :active (org-agenda-check-type nil 'agenda)]
  2129. ["Use Time Grid" org-agenda-toggle-time-grid
  2130. :style toggle :selected org-agenda-use-time-grid
  2131. :active (org-agenda-check-type nil 'agenda)]
  2132. "--"
  2133. ["Show clock report" org-agenda-clockreport-mode
  2134. :style toggle :selected org-agenda-clockreport-mode
  2135. :active (org-agenda-check-type nil 'agenda)]
  2136. ["Show some entry text" org-agenda-entry-text-mode
  2137. :style toggle :selected org-agenda-entry-text-mode
  2138. :active t]
  2139. "--"
  2140. ["Show Logbook entries" org-agenda-log-mode
  2141. :style toggle :selected org-agenda-show-log
  2142. :active (org-agenda-check-type nil 'agenda 'timeline)
  2143. :keys "v l (or just l)"]
  2144. ["Include archived trees" org-agenda-archives-mode
  2145. :style toggle :selected org-agenda-archives-mode :active t
  2146. :keys "v a"]
  2147. ["Include archive files" (org-agenda-archives-mode t)
  2148. :style toggle :selected (eq org-agenda-archives-mode t) :active t
  2149. :keys "v A"]
  2150. "--"
  2151. ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
  2152. ["Write view to file" org-agenda-write t]
  2153. ["Rebuild buffer" org-agenda-redo t]
  2154. ["Save all Org buffers" org-save-all-org-buffers t]
  2155. "--"
  2156. ["Show original entry" org-agenda-show t]
  2157. ["Go To (other window)" org-agenda-goto t]
  2158. ["Go To (this window)" org-agenda-switch-to t]
  2159. ["Capture with cursor date" org-agenda-capture t]
  2160. ["Follow Mode" org-agenda-follow-mode
  2161. :style toggle :selected org-agenda-follow-mode :active t]
  2162. ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
  2163. "--"
  2164. ("TODO"
  2165. ["Cycle TODO" org-agenda-todo t]
  2166. ["Next TODO set" org-agenda-todo-nextset t]
  2167. ["Previous TODO set" org-agenda-todo-previousset t]
  2168. ["Add note" org-agenda-add-note t])
  2169. ("Archive/Refile/Delete"
  2170. ["Archive default" org-agenda-archive-default t]
  2171. ["Archive default" org-agenda-archive-default-with-confirmation t]
  2172. ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
  2173. ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
  2174. ["Archive subtree" org-agenda-archive t]
  2175. "--"
  2176. ["Refile" org-agenda-refile t]
  2177. "--"
  2178. ["Delete subtree" org-agenda-kill t])
  2179. ("Bulk action"
  2180. ["Mark entry" org-agenda-bulk-mark t]
  2181. ["Mark all" org-agenda-bulk-mark-all t]
  2182. ["Unmark entry" org-agenda-bulk-unmark t]
  2183. ["Unmark all" org-agenda-bulk-unmark-all :active t :keys "U"]
  2184. ["Toggle mark" org-agenda-bulk-toggle t]
  2185. ["Toggle all" org-agenda-bulk-toggle-all t]
  2186. ["Mark regexp" org-agenda-bulk-mark-regexp t])
  2187. ["Act on all marked" org-agenda-bulk-action t]
  2188. "--"
  2189. ("Tags and Properties"
  2190. ["Show all Tags" org-agenda-show-tags t]
  2191. ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
  2192. ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
  2193. "--"
  2194. ["Column View" org-columns t])
  2195. ("Deadline/Schedule"
  2196. ["Schedule" org-agenda-schedule t]
  2197. ["Set Deadline" org-agenda-deadline t]
  2198. "--"
  2199. ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
  2200. ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
  2201. ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
  2202. ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
  2203. ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
  2204. ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
  2205. ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
  2206. ("Clock and Effort"
  2207. ["Clock in" org-agenda-clock-in t]
  2208. ["Clock out" org-agenda-clock-out t]
  2209. ["Clock cancel" org-agenda-clock-cancel t]
  2210. ["Goto running clock" org-clock-goto t]
  2211. "--"
  2212. ["Set Effort" org-agenda-set-effort t]
  2213. ["Change clocked effort" org-clock-modify-effort-estimate
  2214. (org-clock-is-active)])
  2215. ("Priority"
  2216. ["Set Priority" org-agenda-priority t]
  2217. ["Increase Priority" org-agenda-priority-up t]
  2218. ["Decrease Priority" org-agenda-priority-down t]
  2219. ["Show Priority" org-show-priority t])
  2220. ("Calendar/Diary"
  2221. ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
  2222. ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
  2223. ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
  2224. ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
  2225. ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
  2226. ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
  2227. "--"
  2228. ["Create iCalendar File" org-icalendar-combine-agenda-files t])
  2229. "--"
  2230. ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
  2231. "--"
  2232. ("MobileOrg"
  2233. ["Push Files and Views" org-mobile-push t]
  2234. ["Get Captured and Flagged" org-mobile-pull t]
  2235. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
  2236. ["Show note / unflag" org-agenda-show-the-flagging-note t]
  2237. "--"
  2238. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  2239. "--"
  2240. ["Quit" org-agenda-quit t]
  2241. ["Exit and Release Buffers" org-agenda-exit t]
  2242. ))
  2243. ;;; Agenda undo
  2244. (defvar org-agenda-allow-remote-undo t
  2245. "Non-nil means allow remote undo from the agenda buffer.")
  2246. (defvar org-agenda-undo-has-started-in nil
  2247. "Buffers that have already seen `undo-start' in the current undo sequence.")
  2248. (defun org-agenda-undo ()
  2249. "Undo a remote editing step in the agenda.
  2250. This undoes changes both in the agenda buffer and in the remote buffer
  2251. that have been changed along."
  2252. (interactive)
  2253. (or org-agenda-allow-remote-undo
  2254. (user-error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
  2255. (if (not (eq this-command last-command))
  2256. (setq org-agenda-undo-has-started-in nil
  2257. org-agenda-pending-undo-list org-agenda-undo-list))
  2258. (if (not org-agenda-pending-undo-list)
  2259. (user-error "No further undo information"))
  2260. (let* ((entry (pop org-agenda-pending-undo-list))
  2261. buf line cmd rembuf)
  2262. (setq cmd (pop entry) line (pop entry))
  2263. (setq rembuf (nth 2 entry))
  2264. (org-with-remote-undo rembuf
  2265. (while (bufferp (setq buf (pop entry)))
  2266. (if (pop entry)
  2267. (with-current-buffer buf
  2268. (let ((last-undo-buffer buf)
  2269. (inhibit-read-only t))
  2270. (unless (memq buf org-agenda-undo-has-started-in)
  2271. (push buf org-agenda-undo-has-started-in)
  2272. (make-local-variable 'pending-undo-list)
  2273. (undo-start))
  2274. (while (and pending-undo-list
  2275. (listp pending-undo-list)
  2276. (not (car pending-undo-list)))
  2277. (pop pending-undo-list))
  2278. (undo-more 1))))))
  2279. (org-goto-line line)
  2280. (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
  2281. (defun org-verify-change-for-undo (l1 l2)
  2282. "Verify that a real change occurred between the undo lists L1 and L2."
  2283. (while (and l1 (listp l1) (null (car l1))) (pop l1))
  2284. (while (and l2 (listp l2) (null (car l2))) (pop l2))
  2285. (not (eq l1 l2)))
  2286. ;;; Agenda dispatch
  2287. (defvar org-agenda-restrict-begin (make-marker))
  2288. (defvar org-agenda-restrict-end (make-marker))
  2289. (defvar org-agenda-last-dispatch-buffer nil)
  2290. (defvar org-agenda-overriding-restriction nil)
  2291. (defcustom org-agenda-custom-commands-contexts nil
  2292. "Alist of custom agenda keys and contextual rules.
  2293. For example, if you have a custom agenda command \"p\" and you
  2294. want this command to be accessible only from plain text files,
  2295. use this:
  2296. \\='((\"p\" ((in-file . \"\\\\.txt\\\\'\"))))
  2297. Here are the available contexts definitions:
  2298. in-file: command displayed only in matching files
  2299. in-mode: command displayed only in matching modes
  2300. not-in-file: command not displayed in matching files
  2301. not-in-mode: command not displayed in matching modes
  2302. in-buffer: command displayed only in matching buffers
  2303. not-in-buffer: command not displayed in matching buffers
  2304. [function]: a custom function taking no argument
  2305. If you define several checks, the agenda command will be
  2306. accessible if there is at least one valid check.
  2307. You can also bind a key to another agenda custom command
  2308. depending on contextual rules.
  2309. \\='((\"p\" \"q\" ((in-file . \"\\\\.txt\\\\'\"))))
  2310. Here it means: in .txt files, use \"p\" as the key for the
  2311. agenda command otherwise associated with \"q\". (The command
  2312. originally associated with \"q\" is not displayed to avoid
  2313. duplicates.)"
  2314. :version "24.3"
  2315. :group 'org-agenda-custom-commands
  2316. :type '(repeat (list :tag "Rule"
  2317. (string :tag " Agenda key")
  2318. (string :tag "Replace by command")
  2319. (repeat :tag "Available when"
  2320. (choice
  2321. (cons :tag "Condition"
  2322. (choice
  2323. (const :tag "In file" in-file)
  2324. (const :tag "Not in file" not-in-file)
  2325. (const :tag "In buffer" in-buffer)
  2326. (const :tag "Not in buffer" not-in-buffer)
  2327. (const :tag "In mode" in-mode)
  2328. (const :tag "Not in mode" not-in-mode))
  2329. (regexp))
  2330. (function :tag "Custom function"))))))
  2331. (defcustom org-agenda-max-entries nil
  2332. "Maximum number of entries to display in an agenda.
  2333. This can be nil (no limit) or an integer or an alist of agenda
  2334. types with an associated number of entries to display in this
  2335. type."
  2336. :version "24.4"
  2337. :package-version '(Org . "8.0")
  2338. :group 'org-agenda-custom-commands
  2339. :type '(choice (symbol :tag "No limit" nil)
  2340. (integer :tag "Max number of entries")
  2341. (repeat
  2342. (cons (choice :tag "Agenda type"
  2343. (const agenda)
  2344. (const todo)
  2345. (const tags)
  2346. (const search)
  2347. (const timeline))
  2348. (integer :tag "Max number of entries")))))
  2349. (defcustom org-agenda-max-todos nil
  2350. "Maximum number of TODOs to display in an agenda.
  2351. This can be nil (no limit) or an integer or an alist of agenda
  2352. types with an associated number of entries to display in this
  2353. type."
  2354. :version "24.4"
  2355. :package-version '(Org . "8.0")
  2356. :group 'org-agenda-custom-commands
  2357. :type '(choice (symbol :tag "No limit" nil)
  2358. (integer :tag "Max number of TODOs")
  2359. (repeat
  2360. (cons (choice :tag "Agenda type"
  2361. (const agenda)
  2362. (const todo)
  2363. (const tags)
  2364. (const search)
  2365. (const timeline))
  2366. (integer :tag "Max number of TODOs")))))
  2367. (defcustom org-agenda-max-tags nil
  2368. "Maximum number of tagged entries to display in an agenda.
  2369. This can be nil (no limit) or an integer or an alist of agenda
  2370. types with an associated number of entries to display in this
  2371. type."
  2372. :version "24.4"
  2373. :package-version '(Org . "8.0")
  2374. :group 'org-agenda-custom-commands
  2375. :type '(choice (symbol :tag "No limit" nil)
  2376. (integer :tag "Max number of tagged entries")
  2377. (repeat
  2378. (cons (choice :tag "Agenda type"
  2379. (const agenda)
  2380. (const todo)
  2381. (const tags)
  2382. (const search)
  2383. (const timeline))
  2384. (integer :tag "Max number of tagged entries")))))
  2385. (defcustom org-agenda-max-effort nil
  2386. "Maximum cumulated effort duration for the agenda.
  2387. This can be nil (no limit) or a number of minutes (as an integer)
  2388. or an alist of agenda types with an associated number of minutes
  2389. to limit entries to in this type."
  2390. :version "24.4"
  2391. :package-version '(Org . "8.0")
  2392. :group 'org-agenda-custom-commands
  2393. :type '(choice (symbol :tag "No limit" nil)
  2394. (integer :tag "Max number of minutes")
  2395. (repeat
  2396. (cons (choice :tag "Agenda type"
  2397. (const agenda)
  2398. (const todo)
  2399. (const tags)
  2400. (const search)
  2401. (const timeline))
  2402. (integer :tag "Max number of minutes")))))
  2403. (defvar org-agenda-keep-restricted-file-list nil)
  2404. (defvar org-keys nil)
  2405. (defvar org-match nil)
  2406. ;;;###autoload
  2407. (defun org-agenda (&optional arg org-keys restriction)
  2408. "Dispatch agenda commands to collect entries to the agenda buffer.
  2409. Prompts for a command to execute. Any prefix arg will be passed
  2410. on to the selected command. The default selections are:
  2411. a Call `org-agenda-list' to display the agenda for current day or week.
  2412. t Call `org-todo-list' to display the global todo list.
  2413. T Call `org-todo-list' to display the global todo list, select only
  2414. entries with a specific TODO keyword (the user gets a prompt).
  2415. m Call `org-tags-view' to display headlines with tags matching
  2416. a condition (the user is prompted for the condition).
  2417. M Like `m', but select only TODO entries, no ordinary headlines.
  2418. e Export views to associated files.
  2419. s Search entries for keywords.
  2420. S Search entries for keywords, only with TODO keywords.
  2421. / Multi occur across all agenda files and also files listed
  2422. in `org-agenda-text-search-extra-files'.
  2423. < Restrict agenda commands to buffer, subtree, or region.
  2424. Press several times to get the desired effect.
  2425. > Remove a previous restriction.
  2426. # List \"stuck\" projects.
  2427. ! Configure what \"stuck\" means.
  2428. C Configure custom agenda commands.
  2429. More commands can be added by configuring the variable
  2430. `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
  2431. searches can be pre-defined in this way.
  2432. If the current buffer is in Org mode and visiting a file, you can also
  2433. first press `<' once to indicate that the agenda should be temporarily
  2434. \(until the next use of `\\[org-agenda]') restricted to the current file.
  2435. Pressing `<' twice means to restrict to the current subtree or region
  2436. \(if active)."
  2437. (interactive "P")
  2438. (catch 'exit
  2439. (let* ((prefix-descriptions nil)
  2440. (org-agenda-buffer-name org-agenda-buffer-name)
  2441. (org-agenda-window-setup (if (equal (buffer-name)
  2442. org-agenda-buffer-name)
  2443. 'current-window
  2444. org-agenda-window-setup))
  2445. (org-agenda-custom-commands-orig org-agenda-custom-commands)
  2446. (org-agenda-custom-commands
  2447. ;; normalize different versions
  2448. (delq nil
  2449. (mapcar
  2450. (lambda (x)
  2451. (cond ((stringp (cdr x))
  2452. (push x prefix-descriptions)
  2453. nil)
  2454. ((stringp (nth 1 x)) x)
  2455. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2456. (t (cons (car x) (cons "" (cdr x))))))
  2457. org-agenda-custom-commands)))
  2458. (org-agenda-custom-commands
  2459. (org-contextualize-keys
  2460. org-agenda-custom-commands org-agenda-custom-commands-contexts))
  2461. (buf (current-buffer))
  2462. (bfn (buffer-file-name (buffer-base-buffer)))
  2463. entry key type org-match lprops ans)
  2464. ;; Turn off restriction unless there is an overriding one,
  2465. (unless org-agenda-overriding-restriction
  2466. (unless org-agenda-keep-restricted-file-list
  2467. ;; There is a request to keep the file list in place
  2468. (put 'org-agenda-files 'org-restrict nil))
  2469. (setq org-agenda-restrict nil)
  2470. (move-marker org-agenda-restrict-begin nil)
  2471. (move-marker org-agenda-restrict-end nil))
  2472. ;; Delete old local properties
  2473. (put 'org-agenda-redo-command 'org-lprops nil)
  2474. ;; Delete previously set last-arguments
  2475. (put 'org-agenda-redo-command 'last-args nil)
  2476. ;; Remember where this call originated
  2477. (setq org-agenda-last-dispatch-buffer (current-buffer))
  2478. (unless org-keys
  2479. (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
  2480. org-keys (car ans)
  2481. restriction (cdr ans)))
  2482. ;; If we have sticky agenda buffers, set a name for the buffer,
  2483. ;; depending on the invoking keys. The user may still set this
  2484. ;; as a command option, which will overwrite what we do here.
  2485. (if org-agenda-sticky
  2486. (setq org-agenda-buffer-name
  2487. (format "*Org Agenda(%s)*" org-keys)))
  2488. ;; Establish the restriction, if any
  2489. (when (and (not org-agenda-overriding-restriction) restriction)
  2490. (put 'org-agenda-files 'org-restrict (list bfn))
  2491. (cond
  2492. ((eq restriction 'region)
  2493. (setq org-agenda-restrict (current-buffer))
  2494. (move-marker org-agenda-restrict-begin (region-beginning))
  2495. (move-marker org-agenda-restrict-end (region-end)))
  2496. ((eq restriction 'subtree)
  2497. (save-excursion
  2498. (setq org-agenda-restrict (current-buffer))
  2499. (org-back-to-heading t)
  2500. (move-marker org-agenda-restrict-begin (point))
  2501. (move-marker org-agenda-restrict-end
  2502. (progn (org-end-of-subtree t)))))))
  2503. ;; For example the todo list should not need it (but does...)
  2504. (cond
  2505. ((setq entry (assoc org-keys org-agenda-custom-commands))
  2506. (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
  2507. (progn
  2508. (setq type (nth 2 entry) org-match (eval (nth 3 entry))
  2509. lprops (nth 4 entry))
  2510. (if org-agenda-sticky
  2511. (setq org-agenda-buffer-name
  2512. (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
  2513. (format "*Org Agenda(%s)*" org-keys))))
  2514. (put 'org-agenda-redo-command 'org-lprops lprops)
  2515. (cond
  2516. ((eq type 'agenda)
  2517. (org-let lprops '(org-agenda-list current-prefix-arg)))
  2518. ((eq type 'agenda*)
  2519. (org-let lprops '(org-agenda-list current-prefix-arg nil nil t)))
  2520. ((eq type 'alltodo)
  2521. (org-let lprops '(org-todo-list current-prefix-arg)))
  2522. ((eq type 'search)
  2523. (org-let lprops '(org-search-view current-prefix-arg org-match nil)))
  2524. ((eq type 'stuck)
  2525. (org-let lprops '(org-agenda-list-stuck-projects
  2526. current-prefix-arg)))
  2527. ((eq type 'tags)
  2528. (org-let lprops '(org-tags-view current-prefix-arg org-match)))
  2529. ((eq type 'tags-todo)
  2530. (org-let lprops '(org-tags-view current-prefix-arg org-match)))
  2531. ((eq type 'todo)
  2532. (org-let lprops '(org-todo-list org-match)))
  2533. ((eq type 'tags-tree)
  2534. (org-check-for-org-mode)
  2535. (org-let lprops '(org-match-sparse-tree current-prefix-arg org-match)))
  2536. ((eq type 'todo-tree)
  2537. (org-check-for-org-mode)
  2538. (org-let lprops
  2539. '(org-occur (concat "^" org-outline-regexp "[ \t]*"
  2540. (regexp-quote org-match) "\\>"))))
  2541. ((eq type 'occur-tree)
  2542. (org-check-for-org-mode)
  2543. (org-let lprops '(org-occur org-match)))
  2544. ((functionp type)
  2545. (org-let lprops '(funcall type org-match)))
  2546. ((fboundp type)
  2547. (org-let lprops '(funcall type org-match)))
  2548. (t (user-error "Invalid custom agenda command type %s" type))))
  2549. (org-agenda-run-series (nth 1 entry) (cddr entry))))
  2550. ((equal org-keys "C")
  2551. (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
  2552. (customize-variable 'org-agenda-custom-commands))
  2553. ((equal org-keys "a") (call-interactively 'org-agenda-list))
  2554. ((equal org-keys "s") (call-interactively 'org-search-view))
  2555. ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
  2556. ((equal org-keys "t") (call-interactively 'org-todo-list))
  2557. ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
  2558. ((equal org-keys "m") (call-interactively 'org-tags-view))
  2559. ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
  2560. ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
  2561. ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
  2562. (add-hook
  2563. 'post-command-hook
  2564. (lambda ()
  2565. (unless (current-message)
  2566. (let* ((m (org-agenda-get-any-marker))
  2567. (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
  2568. (when note
  2569. (message (concat
  2570. "FLAGGING-NOTE ([?] for more info): "
  2571. (org-add-props
  2572. (replace-regexp-in-string
  2573. "\\\\n" "//"
  2574. (copy-sequence note))
  2575. nil 'face 'org-warning)))))))
  2576. t t))
  2577. ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
  2578. ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
  2579. ((equal org-keys "!") (customize-variable 'org-stuck-projects))
  2580. (t (user-error "Invalid agenda key"))))))
  2581. (defvar org-agenda-multi)
  2582. (defun org-agenda-append-agenda ()
  2583. "Append another agenda view to the current one.
  2584. This function allows interactive building of block agendas.
  2585. Agenda views are separated by `org-agenda-block-separator'."
  2586. (interactive)
  2587. (unless (derived-mode-p 'org-agenda-mode)
  2588. (user-error "Can only append from within agenda buffer"))
  2589. (let ((org-agenda-multi t))
  2590. (org-agenda)
  2591. (widen)
  2592. (org-agenda-finalize)
  2593. (setq buffer-read-only t)
  2594. (org-agenda-fit-window-to-buffer)))
  2595. (defun org-agenda-normalize-custom-commands (cmds)
  2596. "Normalize custom commands CMDS."
  2597. (delq nil
  2598. (mapcar
  2599. (lambda (x)
  2600. (cond ((stringp (cdr x)) nil)
  2601. ((stringp (nth 1 x)) x)
  2602. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2603. (t (cons (car x) (cons "" (cdr x))))))
  2604. cmds)))
  2605. (defun org-agenda-get-restriction-and-command (prefix-descriptions)
  2606. "The user interface for selecting an agenda command."
  2607. (catch 'exit
  2608. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  2609. (restrict-ok (and bfn (derived-mode-p 'org-mode)))
  2610. (region-p (org-region-active-p))
  2611. (custom org-agenda-custom-commands)
  2612. (selstring "")
  2613. restriction second-time
  2614. c entry key type match prefixes rmheader header-end custom1 desc
  2615. line lines left right n n1)
  2616. (save-window-excursion
  2617. (delete-other-windows)
  2618. (org-switch-to-buffer-other-window " *Agenda Commands*")
  2619. (erase-buffer)
  2620. (insert (eval-when-compile
  2621. (let ((header
  2622. "Press key for an agenda command:
  2623. -------------------------------- < Buffer, subtree/region restriction
  2624. a Agenda for current week or day > Remove restriction
  2625. t List of all TODO entries e Export agenda views
  2626. m Match a TAGS/PROP/TODO query T Entries with special TODO kwd
  2627. s Search for keywords M Like m, but only TODO entries
  2628. / Multi-occur S Like s, but only TODO entries
  2629. ? Find :FLAGGED: entries C Configure custom agenda commands
  2630. * Toggle sticky agenda views # List stuck projects (!=configure)
  2631. ")
  2632. (start 0))
  2633. (while (string-match
  2634. "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
  2635. header start)
  2636. (setq start (match-end 0))
  2637. (add-text-properties (match-beginning 2) (match-end 2)
  2638. '(face bold) header))
  2639. header)))
  2640. (setq header-end (point-marker))
  2641. (while t
  2642. (setq custom1 custom)
  2643. (when (eq rmheader t)
  2644. (org-goto-line 1)
  2645. (re-search-forward ":" nil t)
  2646. (delete-region (match-end 0) (point-at-eol))
  2647. (forward-char 1)
  2648. (looking-at "-+")
  2649. (delete-region (match-end 0) (point-at-eol))
  2650. (move-marker header-end (match-end 0)))
  2651. (goto-char header-end)
  2652. (delete-region (point) (point-max))
  2653. ;; Produce all the lines that describe custom commands and prefixes
  2654. (setq lines nil)
  2655. (while (setq entry (pop custom1))
  2656. (setq key (car entry) desc (nth 1 entry)
  2657. type (nth 2 entry)
  2658. match (nth 3 entry))
  2659. (if (> (length key) 1)
  2660. (cl-pushnew (string-to-char key) prefixes :test #'equal)
  2661. (setq line
  2662. (format
  2663. "%-4s%-14s"
  2664. (org-add-props (copy-sequence key)
  2665. '(face bold))
  2666. (cond
  2667. ((string-match "\\S-" desc) desc)
  2668. ((eq type 'agenda) "Agenda for current week or day")
  2669. ((eq type 'agenda*) "Appointments for current week or day")
  2670. ((eq type 'alltodo) "List of all TODO entries")
  2671. ((eq type 'search) "Word search")
  2672. ((eq type 'stuck) "List of stuck projects")
  2673. ((eq type 'todo) "TODO keyword")
  2674. ((eq type 'tags) "Tags query")
  2675. ((eq type 'tags-todo) "Tags (TODO)")
  2676. ((eq type 'tags-tree) "Tags tree")
  2677. ((eq type 'todo-tree) "TODO kwd tree")
  2678. ((eq type 'occur-tree) "Occur tree")
  2679. ((functionp type) (if (symbolp type)
  2680. (symbol-name type)
  2681. "Lambda expression"))
  2682. (t "???"))))
  2683. (if org-agenda-menu-show-matcher
  2684. (setq line
  2685. (concat line ": "
  2686. (cond
  2687. ((stringp match)
  2688. (setq match (copy-sequence match))
  2689. (org-add-props match nil 'face 'org-warning))
  2690. ((listp type)
  2691. (format "set of %d commands" (length type))))))
  2692. (if (org-string-nw-p match)
  2693. (add-text-properties
  2694. 0 (length line) (list 'help-echo
  2695. (concat "Matcher: " match)) line)))
  2696. (push line lines)))
  2697. (setq lines (nreverse lines))
  2698. (when prefixes
  2699. (mapc (lambda (x)
  2700. (push
  2701. (format "%s %s"
  2702. (org-add-props (char-to-string x)
  2703. nil 'face 'bold)
  2704. (or (cdr (assoc (concat selstring
  2705. (char-to-string x))
  2706. prefix-descriptions))
  2707. "Prefix key"))
  2708. lines))
  2709. prefixes))
  2710. ;; Check if we should display in two columns
  2711. (if org-agenda-menu-two-columns
  2712. (progn
  2713. (setq n (length lines)
  2714. n1 (+ (/ n 2) (mod n 2))
  2715. right (nthcdr n1 lines)
  2716. left (copy-sequence lines))
  2717. (setcdr (nthcdr (1- n1) left) nil))
  2718. (setq left lines right nil))
  2719. (while left
  2720. (insert "\n" (pop left))
  2721. (when right
  2722. (if (< (current-column) 40)
  2723. (move-to-column 40 t)
  2724. (insert " "))
  2725. (insert (pop right))))
  2726. ;; Make the window the right size
  2727. (goto-char (point-min))
  2728. (if second-time
  2729. (if (not (pos-visible-in-window-p (point-max)))
  2730. (org-fit-window-to-buffer))
  2731. (setq second-time t)
  2732. (org-fit-window-to-buffer))
  2733. ;; Ask for selection
  2734. (message "Press key for agenda command%s:"
  2735. (if (or restrict-ok org-agenda-overriding-restriction)
  2736. (if org-agenda-overriding-restriction
  2737. " (restriction lock active)"
  2738. (if restriction
  2739. (format " (restricted to %s)" restriction)
  2740. " (unrestricted)"))
  2741. ""))
  2742. (setq c (read-char-exclusive))
  2743. (message "")
  2744. (cond
  2745. ((assoc (char-to-string c) custom)
  2746. (setq selstring (concat selstring (char-to-string c)))
  2747. (throw 'exit (cons selstring restriction)))
  2748. ((memq c prefixes)
  2749. (setq selstring (concat selstring (char-to-string c))
  2750. prefixes nil
  2751. rmheader (or rmheader t)
  2752. custom (delq nil (mapcar
  2753. (lambda (x)
  2754. (if (or (= (length (car x)) 1)
  2755. (/= (string-to-char (car x)) c))
  2756. nil
  2757. (cons (substring (car x) 1) (cdr x))))
  2758. custom))))
  2759. ((eq c ?*)
  2760. (call-interactively 'org-toggle-sticky-agenda)
  2761. (sit-for 2))
  2762. ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
  2763. (message "Restriction is only possible in Org buffers")
  2764. (ding) (sit-for 1))
  2765. ((eq c ?1)
  2766. (org-agenda-remove-restriction-lock 'noupdate)
  2767. (setq restriction 'buffer))
  2768. ((eq c ?0)
  2769. (org-agenda-remove-restriction-lock 'noupdate)
  2770. (setq restriction (if region-p 'region 'subtree)))
  2771. ((eq c ?<)
  2772. (org-agenda-remove-restriction-lock 'noupdate)
  2773. (setq restriction
  2774. (cond
  2775. ((eq restriction 'buffer)
  2776. (if region-p 'region 'subtree))
  2777. ((memq restriction '(subtree region))
  2778. nil)
  2779. (t 'buffer))))
  2780. ((eq c ?>)
  2781. (org-agenda-remove-restriction-lock 'noupdate)
  2782. (setq restriction nil))
  2783. ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
  2784. (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
  2785. ((and (> (length selstring) 0) (eq c ?\d))
  2786. (delete-window)
  2787. (org-agenda-get-restriction-and-command prefix-descriptions))
  2788. ((equal c ?q) (error "Abort"))
  2789. (t (user-error "Invalid key %c" c))))))))
  2790. (defun org-agenda-fit-window-to-buffer ()
  2791. "Fit the window to the buffer size."
  2792. (and (memq org-agenda-window-setup '(reorganize-frame))
  2793. (fboundp 'fit-window-to-buffer)
  2794. (if (and (= (cdr org-agenda-window-frame-fractions) 1.0)
  2795. (= (car org-agenda-window-frame-fractions) 1.0))
  2796. (delete-other-windows)
  2797. (org-fit-window-to-buffer
  2798. nil
  2799. (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
  2800. (floor (* (frame-height) (car org-agenda-window-frame-fractions)))))))
  2801. (defvar org-cmd nil)
  2802. (defvar org-agenda-overriding-cmd nil)
  2803. (defvar org-agenda-overriding-arguments nil)
  2804. (defvar org-agenda-overriding-cmd-arguments nil)
  2805. (defun org-agenda-run-series (name series)
  2806. "Run agenda NAME as a SERIES of agenda commands."
  2807. (org-let (nth 1 series) '(org-agenda-prepare name))
  2808. ;; We need to reset agenda markers here, because when constructing a
  2809. ;; block agenda, the individual blocks do not do that.
  2810. (org-agenda-reset-markers)
  2811. (let* ((org-agenda-multi t)
  2812. (redo (list 'org-agenda-run-series name (list 'quote series)))
  2813. (cmds (car series))
  2814. (gprops (nth 1 series))
  2815. match ;; The byte compiler incorrectly complains about this. Keep it!
  2816. org-cmd type lprops)
  2817. (while (setq org-cmd (pop cmds))
  2818. (setq type (car org-cmd))
  2819. (setq match (eval (nth 1 org-cmd)))
  2820. (setq lprops (nth 2 org-cmd))
  2821. (let ((org-agenda-overriding-arguments
  2822. (if (eq org-agenda-overriding-cmd org-cmd)
  2823. (or org-agenda-overriding-arguments
  2824. org-agenda-overriding-cmd-arguments))))
  2825. (cond
  2826. ((eq type 'agenda)
  2827. (org-let2 gprops lprops
  2828. '(call-interactively 'org-agenda-list)))
  2829. ((eq type 'agenda*)
  2830. (org-let2 gprops lprops
  2831. '(funcall 'org-agenda-list nil nil t)))
  2832. ((eq type 'alltodo)
  2833. (org-let2 gprops lprops
  2834. '(call-interactively 'org-todo-list)))
  2835. ((eq type 'search)
  2836. (org-let2 gprops lprops
  2837. '(org-search-view current-prefix-arg match nil)))
  2838. ((eq type 'stuck)
  2839. (org-let2 gprops lprops
  2840. '(call-interactively 'org-agenda-list-stuck-projects)))
  2841. ((eq type 'tags)
  2842. (org-let2 gprops lprops
  2843. '(org-tags-view current-prefix-arg match)))
  2844. ((eq type 'tags-todo)
  2845. (org-let2 gprops lprops
  2846. '(org-tags-view current-prefix-arg match)))
  2847. ((eq type 'todo)
  2848. (org-let2 gprops lprops
  2849. '(org-todo-list match)))
  2850. ((fboundp type)
  2851. (org-let2 gprops lprops
  2852. '(funcall type match)))
  2853. (t (error "Invalid type in command series")))))
  2854. (widen)
  2855. (let ((inhibit-read-only t))
  2856. (add-text-properties (point-min) (point-max)
  2857. `(org-series t org-series-redo-cmd ,redo)))
  2858. (setq org-agenda-redo-command redo)
  2859. (goto-char (point-min)))
  2860. (org-agenda-fit-window-to-buffer)
  2861. (org-let (nth 1 series) '(org-agenda-finalize)))
  2862. ;;;###autoload
  2863. (defmacro org-batch-agenda (cmd-key &rest parameters)
  2864. "Run an agenda command in batch mode and send the result to STDOUT.
  2865. If CMD-KEY is a string of length 1, it is used as a key in
  2866. `org-agenda-custom-commands' and triggers this command. If it is a
  2867. longer string it is used as a tags/todo match string.
  2868. Parameters are alternating variable names and values that will be bound
  2869. before running the agenda command."
  2870. (org-eval-in-environment (org-make-parameter-alist parameters)
  2871. (let (org-agenda-sticky)
  2872. (if (> (length cmd-key) 1)
  2873. (org-tags-view nil cmd-key)
  2874. (org-agenda nil cmd-key))))
  2875. (set-buffer org-agenda-buffer-name)
  2876. (princ (buffer-string)))
  2877. (defvar org-agenda-info nil)
  2878. ;;;###autoload
  2879. (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
  2880. "Run an agenda command in batch mode and send the result to STDOUT.
  2881. If CMD-KEY is a string of length 1, it is used as a key in
  2882. `org-agenda-custom-commands' and triggers this command. If it is a
  2883. longer string it is used as a tags/todo match string.
  2884. Parameters are alternating variable names and values that will be bound
  2885. before running the agenda command.
  2886. The output gives a line for each selected agenda item. Each
  2887. item is a list of comma-separated values, like this:
  2888. category,head,type,todo,tags,date,time,extra,priority-l,priority-n
  2889. category The category of the item
  2890. head The headline, without TODO kwd, TAGS and PRIORITY
  2891. type The type of the agenda entry, can be
  2892. todo selected in TODO match
  2893. tagsmatch selected in tags match
  2894. diary imported from diary
  2895. deadline a deadline on given date
  2896. scheduled scheduled on given date
  2897. timestamp entry has timestamp on given date
  2898. closed entry was closed on given date
  2899. upcoming-deadline warning about deadline
  2900. past-scheduled forwarded scheduled item
  2901. block entry has date block including g. date
  2902. todo The todo keyword, if any
  2903. tags All tags including inherited ones, separated by colons
  2904. date The relevant date, like 2007-2-14
  2905. time The time, like 15:00-16:50
  2906. extra Sting with extra planning info
  2907. priority-l The priority letter if any was given
  2908. priority-n The computed numerical priority
  2909. agenda-day The day in the agenda where this is listed"
  2910. (org-eval-in-environment (append '((org-agenda-remove-tags t))
  2911. (org-make-parameter-alist parameters))
  2912. (if (> (length cmd-key) 2)
  2913. (org-tags-view nil cmd-key)
  2914. (org-agenda nil cmd-key)))
  2915. (set-buffer org-agenda-buffer-name)
  2916. (let* ((lines (org-split-string (buffer-string) "\n"))
  2917. line)
  2918. (while (setq line (pop lines))
  2919. (catch 'next
  2920. (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
  2921. (setq org-agenda-info
  2922. (org-fix-agenda-info (text-properties-at 0 line)))
  2923. (princ
  2924. (mapconcat 'org-agenda-export-csv-mapper
  2925. '(org-category txt type todo tags date time extra
  2926. priority-letter priority agenda-day)
  2927. ","))
  2928. (princ "\n")))))
  2929. (defun org-fix-agenda-info (props)
  2930. "Make sure all properties on an agenda item have a canonical form.
  2931. This ensures the export commands can easily use it."
  2932. (let (tmp re)
  2933. (when (setq tmp (plist-get props 'tags))
  2934. (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
  2935. (when (setq tmp (plist-get props 'date))
  2936. (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2937. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2938. '((format "%4d, %9s %2s, %4s" dayname monthname day year))
  2939. (setq tmp (calendar-date-string tmp)))
  2940. (setq props (plist-put props 'date tmp)))
  2941. (when (setq tmp (plist-get props 'day))
  2942. (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2943. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2944. (setq tmp (calendar-date-string tmp)))
  2945. (setq props (plist-put props 'day tmp))
  2946. (setq props (plist-put props 'agenda-day tmp)))
  2947. (when (setq tmp (plist-get props 'txt))
  2948. (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
  2949. (plist-put props 'priority-letter (match-string 1 tmp))
  2950. (setq tmp (replace-match "" t t tmp)))
  2951. (when (and (setq re (plist-get props 'org-todo-regexp))
  2952. (setq re (concat "\\`\\.*" re " ?"))
  2953. (let ((case-fold-search nil)) (string-match re tmp)))
  2954. (plist-put props 'todo (match-string 1 tmp))
  2955. (setq tmp (replace-match "" t t tmp)))
  2956. (plist-put props 'txt tmp)))
  2957. props)
  2958. (defun org-agenda-export-csv-mapper (prop)
  2959. (let ((res (plist-get org-agenda-info prop)))
  2960. (setq res
  2961. (cond
  2962. ((not res) "")
  2963. ((stringp res) res)
  2964. (t (prin1-to-string res))))
  2965. (org-trim (replace-regexp-in-string "," ";" res nil t))))
  2966. ;;;###autoload
  2967. (defun org-store-agenda-views (&rest parameters)
  2968. "Store agenda views."
  2969. (interactive)
  2970. (eval (list 'org-batch-store-agenda-views)))
  2971. ;;;###autoload
  2972. (defmacro org-batch-store-agenda-views (&rest parameters)
  2973. "Run all custom agenda commands that have a file argument."
  2974. (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
  2975. (pop-up-frames nil)
  2976. (dir default-directory)
  2977. (pars (org-make-parameter-alist parameters))
  2978. cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
  2979. (save-window-excursion
  2980. (while cmds
  2981. (setq cmd (pop cmds)
  2982. thiscmdkey (car cmd)
  2983. thiscmdcmd (cdr cmd)
  2984. match (nth 2 thiscmdcmd)
  2985. bufname (if org-agenda-sticky
  2986. (or (and (stringp match)
  2987. (format "*Org Agenda(%s:%s)*" thiscmdkey match))
  2988. (format "*Org Agenda(%s)*" thiscmdkey))
  2989. org-agenda-buffer-name)
  2990. cmd-or-set (nth 2 cmd)
  2991. opts (nth (if (listp cmd-or-set) 3 4) cmd)
  2992. files (nth (if (listp cmd-or-set) 4 5) cmd))
  2993. (if (stringp files) (setq files (list files)))
  2994. (when files
  2995. (org-eval-in-environment (append org-agenda-exporter-settings
  2996. opts pars)
  2997. (org-agenda nil thiscmdkey))
  2998. (set-buffer bufname)
  2999. (while files
  3000. (org-eval-in-environment (append org-agenda-exporter-settings
  3001. opts pars)
  3002. (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
  3003. (and (get-buffer bufname)
  3004. (kill-buffer bufname)))))))
  3005. (defvar org-agenda-current-span nil
  3006. "The current span used in the agenda view.") ; local variable in the agenda buffer
  3007. (defun org-agenda-mark-header-line (pos)
  3008. "Mark the line at POS as an agenda structure header."
  3009. (save-excursion
  3010. (goto-char pos)
  3011. (put-text-property (point-at-bol) (point-at-eol)
  3012. 'org-agenda-structural-header t)
  3013. (when org-agenda-title-append
  3014. (put-text-property (point-at-bol) (point-at-eol)
  3015. 'org-agenda-title-append org-agenda-title-append))))
  3016. (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
  3017. (defvar org-agenda-write-buffer-name "Agenda View")
  3018. (defun org-agenda-write (file &optional open nosettings agenda-bufname)
  3019. "Write the current buffer (an agenda view) as a file.
  3020. Depending on the extension of the file name, plain text (.txt),
  3021. HTML (.html or .htm), PDF (.pdf) or Postscript (.ps) is produced.
  3022. If the extension is .ics, translate visible agenda into iCalendar
  3023. format. If the extension is .org, collect all subtrees
  3024. corresponding to the agenda entries and add them in an .org file.
  3025. With prefix argument OPEN, open the new file immediately. If
  3026. NOSETTINGS is given, do not scope the settings of
  3027. `org-agenda-exporter-settings' into the export commands. This is
  3028. used when the settings have already been scoped and we do not
  3029. wish to overrule other, higher priority settings. If
  3030. AGENDA-BUFFER-NAME is provided, use this as the buffer name for
  3031. the agenda to write."
  3032. (interactive "FWrite agenda to file: \nP")
  3033. (if (or (not (file-writable-p file))
  3034. (and (file-exists-p file)
  3035. (if (called-interactively-p 'any)
  3036. (not (y-or-n-p (format "Overwrite existing file %s? " file))))))
  3037. (user-error "Cannot write agenda to file %s" file))
  3038. (org-let (if nosettings nil org-agenda-exporter-settings)
  3039. '(save-excursion
  3040. (save-window-excursion
  3041. (let ((bs (copy-sequence (buffer-string)))
  3042. (extension (file-name-extension file))
  3043. (default-directory (file-name-directory file))
  3044. beg content)
  3045. (with-temp-buffer
  3046. (rename-buffer org-agenda-write-buffer-name t)
  3047. (set-buffer-modified-p nil)
  3048. (insert bs)
  3049. (org-agenda-remove-marked-text 'invisible 'org-filtered)
  3050. (run-hooks 'org-agenda-before-write-hook)
  3051. (cond
  3052. ((bound-and-true-p org-mobile-creating-agendas)
  3053. (org-mobile-write-agenda-for-mobile file))
  3054. ((string= "org" extension)
  3055. (let (content p m message-log-max)
  3056. (goto-char (point-min))
  3057. (while (setq p (next-single-property-change (point) 'org-hd-marker nil))
  3058. (goto-char p)
  3059. (setq m (get-text-property (point) 'org-hd-marker))
  3060. (when m
  3061. (push (save-excursion
  3062. (set-buffer (marker-buffer m))
  3063. (goto-char m)
  3064. (org-copy-subtree 1 nil t t)
  3065. org-subtree-clip)
  3066. content)))
  3067. (find-file file)
  3068. (erase-buffer)
  3069. (dolist (s content) (org-paste-subtree 1 s))
  3070. (write-file file)
  3071. (kill-buffer (current-buffer))
  3072. (message "Org file written to %s" file)))
  3073. ((member extension '("html" "htm"))
  3074. (require 'htmlize)
  3075. (set-buffer (htmlize-buffer (current-buffer)))
  3076. (when org-agenda-export-html-style
  3077. ;; replace <style> section with org-agenda-export-html-style
  3078. (goto-char (point-min))
  3079. (kill-region (- (search-forward "<style") 6)
  3080. (search-forward "</style>"))
  3081. (insert org-agenda-export-html-style))
  3082. (write-file file)
  3083. (kill-buffer (current-buffer))
  3084. (message "HTML written to %s" file))
  3085. ((string= "ps" extension)
  3086. (require 'ps-print)
  3087. (ps-print-buffer-with-faces file)
  3088. (message "Postscript written to %s" file))
  3089. ((string= "pdf" extension)
  3090. (require 'ps-print)
  3091. (ps-print-buffer-with-faces
  3092. (concat (file-name-sans-extension file) ".ps"))
  3093. (call-process "ps2pdf" nil nil nil
  3094. (expand-file-name
  3095. (concat (file-name-sans-extension file) ".ps"))
  3096. (expand-file-name file))
  3097. (delete-file (concat (file-name-sans-extension file) ".ps"))
  3098. (message "PDF written to %s" file))
  3099. ((string= "ics" extension)
  3100. (require 'ox-icalendar)
  3101. (org-icalendar-export-current-agenda (expand-file-name file)))
  3102. (t
  3103. (let ((bs (buffer-string)))
  3104. (find-file file)
  3105. (erase-buffer)
  3106. (insert bs)
  3107. (save-buffer 0)
  3108. (kill-buffer (current-buffer))
  3109. (message "Plain text written to %s" file))))))))
  3110. (set-buffer (or agenda-bufname
  3111. (and (called-interactively-p 'any) (buffer-name))
  3112. org-agenda-buffer-name)))
  3113. (when open (org-open-file file)))
  3114. (defun org-agenda-remove-marked-text (property &optional value)
  3115. "Delete all text marked with VALUE of PROPERTY.
  3116. VALUE defaults to t."
  3117. (let (beg)
  3118. (setq value (or value t))
  3119. (while (setq beg (text-property-any (point-min) (point-max)
  3120. property value))
  3121. (delete-region
  3122. beg (or (next-single-property-change beg property)
  3123. (point-max))))))
  3124. (defun org-agenda-add-entry-text ()
  3125. "Add entry text to agenda lines.
  3126. This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
  3127. entry text following headings shown in the agenda.
  3128. Drawers will be excluded, also the line with scheduling/deadline info."
  3129. (when (and (> org-agenda-add-entry-text-maxlines 0)
  3130. (not (bound-and-true-p org-mobile-creating-agendas)))
  3131. (let (m txt)
  3132. (goto-char (point-min))
  3133. (while (not (eobp))
  3134. (if (not (setq m (org-get-at-bol 'org-hd-marker)))
  3135. (beginning-of-line 2)
  3136. (setq txt (org-agenda-get-some-entry-text
  3137. m org-agenda-add-entry-text-maxlines " > "))
  3138. (end-of-line 1)
  3139. (if (string-match "\\S-" txt)
  3140. (insert "\n" txt)
  3141. (or (eobp) (forward-char 1))))))))
  3142. (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
  3143. &rest keep)
  3144. "Extract entry text from MARKER, at most N-LINES lines.
  3145. This will ignore drawers etc, just get the text.
  3146. If INDENT is given, prefix every line with this string. If KEEP is
  3147. given, it is a list of symbols, defining stuff that should not be
  3148. removed from the entry content. Currently only `planning' is allowed here."
  3149. (let (txt drawer-re kwd-time-re ind)
  3150. (save-excursion
  3151. (with-current-buffer (marker-buffer marker)
  3152. (if (not (derived-mode-p 'org-mode))
  3153. (setq txt "")
  3154. (org-with-wide-buffer
  3155. (goto-char marker)
  3156. (end-of-line 1)
  3157. (setq txt (buffer-substring
  3158. (min (1+ (point)) (point-max))
  3159. (progn (outline-next-heading) (point)))
  3160. drawer-re org-drawer-regexp
  3161. kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
  3162. ".*\n?"))
  3163. (with-temp-buffer
  3164. (insert txt)
  3165. (when org-agenda-add-entry-text-descriptive-links
  3166. (goto-char (point-min))
  3167. (while (org-activate-links (point-max))
  3168. (add-text-properties (match-beginning 0) (match-end 0)
  3169. '(face org-link))))
  3170. (goto-char (point-min))
  3171. (while (re-search-forward org-bracket-link-regexp (point-max) t)
  3172. (set-text-properties (match-beginning 0) (match-end 0)
  3173. nil))
  3174. (goto-char (point-min))
  3175. (while (re-search-forward drawer-re nil t)
  3176. (delete-region
  3177. (match-beginning 0)
  3178. (progn (re-search-forward
  3179. "^[ \t]*:END:.*\n?" nil 'move)
  3180. (point))))
  3181. (unless (member 'planning keep)
  3182. (goto-char (point-min))
  3183. (while (re-search-forward kwd-time-re nil t)
  3184. (replace-match "")))
  3185. (goto-char (point-min))
  3186. (when org-agenda-entry-text-exclude-regexps
  3187. (let ((re-list org-agenda-entry-text-exclude-regexps) re)
  3188. (while (setq re (pop re-list))
  3189. (goto-char (point-min))
  3190. (while (re-search-forward re nil t)
  3191. (replace-match "")))))
  3192. (goto-char (point-max))
  3193. (skip-chars-backward " \t\n")
  3194. (if (looking-at "[ \t\n]+\\'") (replace-match ""))
  3195. ;; find and remove min common indentation
  3196. (goto-char (point-min))
  3197. (untabify (point-min) (point-max))
  3198. (setq ind (org-get-indentation))
  3199. (while (not (eobp))
  3200. (unless (looking-at "[ \t]*$")
  3201. (setq ind (min ind (org-get-indentation))))
  3202. (beginning-of-line 2))
  3203. (goto-char (point-min))
  3204. (while (not (eobp))
  3205. (unless (looking-at "[ \t]*$")
  3206. (move-to-column ind)
  3207. (delete-region (point-at-bol) (point)))
  3208. (beginning-of-line 2))
  3209. (run-hooks 'org-agenda-entry-text-cleanup-hook)
  3210. (goto-char (point-min))
  3211. (when indent
  3212. (while (and (not (eobp)) (re-search-forward "^" nil t))
  3213. (replace-match indent t t)))
  3214. (goto-char (point-min))
  3215. (while (looking-at "[ \t]*\n") (replace-match ""))
  3216. (goto-char (point-max))
  3217. (when (> (org-current-line)
  3218. n-lines)
  3219. (org-goto-line (1+ n-lines))
  3220. (backward-char 1))
  3221. (setq txt (buffer-substring (point-min) (point))))))))
  3222. txt))
  3223. (defun org-check-for-org-mode ()
  3224. "Make sure current buffer is in org-mode. Error if not."
  3225. (or (derived-mode-p 'org-mode)
  3226. (error "Cannot execute Org agenda command on buffer in %s"
  3227. major-mode)))
  3228. ;;; Agenda prepare and finalize
  3229. (defvar org-agenda-multi nil) ; dynamically scoped
  3230. (defvar org-agenda-pre-window-conf nil)
  3231. (defvar org-agenda-columns-active nil)
  3232. (defvar org-agenda-name nil)
  3233. (defvar org-agenda-tag-filter nil)
  3234. (defvar org-agenda-category-filter nil)
  3235. (defvar org-agenda-regexp-filter nil)
  3236. (defvar org-agenda-effort-filter nil)
  3237. (defvar org-agenda-top-headline-filter nil)
  3238. (defvar org-agenda-tag-filter-preset nil
  3239. "A preset of the tags filter used for secondary agenda filtering.
  3240. This must be a list of strings, each string must be a single tag preceded
  3241. by \"+\" or \"-\".
  3242. This variable should not be set directly, but agenda custom commands can
  3243. bind it in the options section. The preset filter is a global property of
  3244. the entire agenda view. In a block agenda, it will not work reliably to
  3245. define a filter for one of the individual blocks. You need to set it in
  3246. the global options and expect it to be applied to the entire view.")
  3247. (defvar org-agenda-category-filter-preset nil
  3248. "A preset of the category filter used for secondary agenda filtering.
  3249. This must be a list of strings, each string must be a single category
  3250. preceded by \"+\" or \"-\".
  3251. This variable should not be set directly, but agenda custom commands can
  3252. bind it in the options section. The preset filter is a global property of
  3253. the entire agenda view. In a block agenda, it will not work reliably to
  3254. define a filter for one of the individual blocks. You need to set it in
  3255. the global options and expect it to be applied to the entire view.")
  3256. (defvar org-agenda-regexp-filter-preset nil
  3257. "A preset of the regexp filter used for secondary agenda filtering.
  3258. This must be a list of strings, each string must be a single regexp
  3259. preceded by \"+\" or \"-\".
  3260. This variable should not be set directly, but agenda custom commands can
  3261. bind it in the options section. The preset filter is a global property of
  3262. the entire agenda view. In a block agenda, it will not work reliably to
  3263. define a filter for one of the individual blocks. You need to set it in
  3264. the global options and expect it to be applied to the entire view.")
  3265. (defvar org-agenda-effort-filter-preset nil
  3266. "A preset of the effort condition used for secondary agenda filtering.
  3267. This must be a list of strings, each string must be a single regexp
  3268. preceded by \"+\" or \"-\".
  3269. This variable should not be set directly, but agenda custom commands can
  3270. bind it in the options section. The preset filter is a global property of
  3271. the entire agenda view. In a block agenda, it will not work reliably to
  3272. define a filter for one of the individual blocks. You need to set it in
  3273. the global options and expect it to be applied to the entire view.")
  3274. (defun org-agenda-use-sticky-p ()
  3275. "Return non-nil if an agenda buffer named
  3276. `org-agenda-buffer-name' exists and should be shown instead of
  3277. generating a new one."
  3278. (and
  3279. ;; turned off by user
  3280. org-agenda-sticky
  3281. ;; For multi-agenda buffer already exists
  3282. (not org-agenda-multi)
  3283. ;; buffer found
  3284. (get-buffer org-agenda-buffer-name)
  3285. ;; C-u parameter is same as last call
  3286. (with-current-buffer (get-buffer org-agenda-buffer-name)
  3287. (and
  3288. (equal current-prefix-arg
  3289. org-agenda-last-prefix-arg)
  3290. ;; In case user turned stickiness on, while having existing
  3291. ;; Agenda buffer active, don't reuse that buffer, because it
  3292. ;; does not have org variables local
  3293. org-agenda-this-buffer-is-sticky))))
  3294. (defun org-agenda-prepare-window (abuf filter-alist)
  3295. "Setup agenda buffer in the window.
  3296. ABUF is the buffer for the agenda window.
  3297. FILTER-ALIST is an alist of filters we need to apply when
  3298. `org-agenda-persistent-filter' is non-nil."
  3299. (let* ((awin (get-buffer-window abuf)) wconf)
  3300. (cond
  3301. ((equal (current-buffer) abuf) nil)
  3302. (awin (select-window awin))
  3303. ((not (setq wconf (current-window-configuration))))
  3304. ((eq org-agenda-window-setup 'current-window)
  3305. (pop-to-buffer-same-window abuf))
  3306. ((eq org-agenda-window-setup 'other-window)
  3307. (org-switch-to-buffer-other-window abuf))
  3308. ((eq org-agenda-window-setup 'other-frame)
  3309. (switch-to-buffer-other-frame abuf))
  3310. ((eq org-agenda-window-setup 'only-window)
  3311. (delete-other-windows)
  3312. (pop-to-buffer-same-window abuf))
  3313. ((eq org-agenda-window-setup 'reorganize-frame)
  3314. (delete-other-windows)
  3315. (org-switch-to-buffer-other-window abuf)))
  3316. (setq org-agenda-tag-filter (cdr (assq 'tag filter-alist)))
  3317. (setq org-agenda-category-filter (cdr (assq 'cat filter-alist)))
  3318. (setq org-agenda-effort-filter (cdr (assq 'effort filter-alist)))
  3319. (setq org-agenda-regexp-filter (cdr (assq 're filter-alist)))
  3320. ;; Additional test in case agenda is invoked from within agenda
  3321. ;; buffer via elisp link.
  3322. (unless (equal (current-buffer) abuf)
  3323. (pop-to-buffer-same-window abuf))
  3324. (setq org-agenda-pre-window-conf
  3325. (or wconf org-agenda-pre-window-conf))))
  3326. (defun org-agenda-prepare (&optional name)
  3327. (let ((filter-alist (if org-agenda-persistent-filter
  3328. (with-current-buffer
  3329. (get-buffer-create org-agenda-buffer-name)
  3330. (list `(tag . ,org-agenda-tag-filter)
  3331. `(re . ,org-agenda-regexp-filter)
  3332. `(effort . ,org-agenda-effort-filter)
  3333. `(cat . ,org-agenda-category-filter))))))
  3334. (if (org-agenda-use-sticky-p)
  3335. (progn
  3336. (put 'org-agenda-tag-filter :preset-filter nil)
  3337. (put 'org-agenda-category-filter :preset-filter nil)
  3338. (put 'org-agenda-regexp-filter :preset-filter nil)
  3339. ;; Popup existing buffer
  3340. (org-agenda-prepare-window (get-buffer org-agenda-buffer-name)
  3341. filter-alist)
  3342. (message "Sticky Agenda buffer, use `r' to refresh")
  3343. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3344. (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
  3345. (setq org-todo-keywords-for-agenda nil)
  3346. (put 'org-agenda-tag-filter :preset-filter
  3347. org-agenda-tag-filter-preset)
  3348. (put 'org-agenda-category-filter :preset-filter
  3349. org-agenda-category-filter-preset)
  3350. (put 'org-agenda-regexp-filter :preset-filter
  3351. org-agenda-regexp-filter-preset)
  3352. (put 'org-agenda-effort-filter :preset-filter
  3353. org-agenda-effort-filter-preset)
  3354. (if org-agenda-multi
  3355. (progn
  3356. (setq buffer-read-only nil)
  3357. (goto-char (point-max))
  3358. (unless (or (bobp) org-agenda-compact-blocks
  3359. (not org-agenda-block-separator))
  3360. (insert "\n"
  3361. (if (stringp org-agenda-block-separator)
  3362. org-agenda-block-separator
  3363. (make-string (window-width) org-agenda-block-separator))
  3364. "\n"))
  3365. (narrow-to-region (point) (point-max)))
  3366. (setq org-done-keywords-for-agenda nil)
  3367. ;; Setting any org variables that are in org-agenda-local-vars
  3368. ;; list need to be done after the prepare call
  3369. (org-agenda-prepare-window
  3370. (get-buffer-create org-agenda-buffer-name) filter-alist)
  3371. (setq buffer-read-only nil)
  3372. (org-agenda-reset-markers)
  3373. (let ((inhibit-read-only t)) (erase-buffer))
  3374. (org-agenda-mode)
  3375. (setq org-agenda-buffer (current-buffer))
  3376. (setq org-agenda-contributing-files nil)
  3377. (setq org-agenda-columns-active nil)
  3378. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  3379. (setq org-todo-keywords-for-agenda
  3380. (org-uniquify org-todo-keywords-for-agenda))
  3381. (setq org-done-keywords-for-agenda
  3382. (org-uniquify org-done-keywords-for-agenda))
  3383. (setq org-agenda-last-prefix-arg current-prefix-arg)
  3384. (setq org-agenda-this-buffer-name org-agenda-buffer-name)
  3385. (and name (not org-agenda-name)
  3386. (setq-local org-agenda-name name)))
  3387. (setq buffer-read-only nil))))
  3388. (defvar org-agenda-overriding-columns-format) ; From org-colview.el
  3389. (defun org-agenda-finalize ()
  3390. "Finishing touch for the agenda buffer, called just before displaying it."
  3391. (unless org-agenda-multi
  3392. (save-excursion
  3393. (let ((inhibit-read-only t))
  3394. (goto-char (point-min))
  3395. (save-excursion
  3396. (while (org-activate-links (point-max))
  3397. (add-text-properties (match-beginning 0) (match-end 0)
  3398. '(face org-link))))
  3399. (unless (eq org-agenda-remove-tags t)
  3400. (org-agenda-align-tags))
  3401. (unless org-agenda-with-colors
  3402. (remove-text-properties (point-min) (point-max) '(face nil)))
  3403. (if (and (boundp 'org-agenda-overriding-columns-format)
  3404. org-agenda-overriding-columns-format)
  3405. (setq-local org-agenda-overriding-columns-format
  3406. org-agenda-overriding-columns-format))
  3407. (if (and (boundp 'org-agenda-view-columns-initially)
  3408. org-agenda-view-columns-initially)
  3409. (org-agenda-columns))
  3410. (when org-agenda-fontify-priorities
  3411. (org-agenda-fontify-priorities))
  3412. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  3413. (org-agenda-dim-blocked-tasks))
  3414. (org-agenda-mark-clocking-task)
  3415. (when org-agenda-entry-text-mode
  3416. (org-agenda-entry-text-hide)
  3417. (org-agenda-entry-text-show))
  3418. (if (and (functionp 'org-habit-insert-consistency-graphs)
  3419. (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
  3420. (org-habit-insert-consistency-graphs))
  3421. (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
  3422. (unless (or (eq org-agenda-show-inherited-tags 'always)
  3423. (and (listp org-agenda-show-inherited-tags)
  3424. (memq org-agenda-type org-agenda-show-inherited-tags))
  3425. (and (eq org-agenda-show-inherited-tags t)
  3426. (or (eq org-agenda-use-tag-inheritance t)
  3427. (and (listp org-agenda-use-tag-inheritance)
  3428. (not (memq org-agenda-type
  3429. org-agenda-use-tag-inheritance))))))
  3430. (let (mrk)
  3431. (save-excursion
  3432. (goto-char (point-min))
  3433. (while (equal (forward-line) 0)
  3434. (when (setq mrk (get-text-property (point) 'org-hd-marker))
  3435. (put-text-property (point-at-bol) (point-at-eol)
  3436. 'tags (org-with-point-at mrk
  3437. (delete-dups
  3438. (mapcar 'downcase (org-get-tags-at))))))))))
  3439. (run-hooks 'org-agenda-finalize-hook)
  3440. (when org-agenda-top-headline-filter
  3441. (org-agenda-filter-top-headline-apply
  3442. org-agenda-top-headline-filter))
  3443. (when org-agenda-tag-filter
  3444. (org-agenda-filter-apply org-agenda-tag-filter 'tag t))
  3445. (when (get 'org-agenda-tag-filter :preset-filter)
  3446. (org-agenda-filter-apply
  3447. (get 'org-agenda-tag-filter :preset-filter) 'tag t))
  3448. (when org-agenda-category-filter
  3449. (org-agenda-filter-apply org-agenda-category-filter 'category))
  3450. (when (get 'org-agenda-category-filter :preset-filter)
  3451. (org-agenda-filter-apply
  3452. (get 'org-agenda-category-filter :preset-filter) 'category))
  3453. (when org-agenda-regexp-filter
  3454. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
  3455. (when (get 'org-agenda-regexp-filter :preset-filter)
  3456. (org-agenda-filter-apply
  3457. (get 'org-agenda-regexp-filter :preset-filter) 'regexp))
  3458. (when org-agenda-effort-filter
  3459. (org-agenda-filter-apply org-agenda-effort-filter 'effort))
  3460. (when (get 'org-agenda-effort-filter :preset-filter)
  3461. (org-agenda-filter-apply
  3462. (get 'org-agenda-effort-filter :preset-filter) 'effort))
  3463. (add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)))))
  3464. (defun org-agenda-mark-clocking-task ()
  3465. "Mark the current clock entry in the agenda if it is present."
  3466. ;; We need to widen when `org-agenda-finalize' is called from
  3467. ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in')
  3468. (when (bound-and-true-p org-clock-current-task)
  3469. (save-restriction
  3470. (widen)
  3471. (org-agenda-unmark-clocking-task)
  3472. (when (marker-buffer org-clock-hd-marker)
  3473. (save-excursion
  3474. (goto-char (point-min))
  3475. (let (s ov)
  3476. (while (setq s (next-single-property-change (point) 'org-hd-marker))
  3477. (goto-char s)
  3478. (when (equal (org-get-at-bol 'org-hd-marker)
  3479. org-clock-hd-marker)
  3480. (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
  3481. (overlay-put ov 'type 'org-agenda-clocking)
  3482. (overlay-put ov 'face 'org-agenda-clocking)
  3483. (overlay-put ov 'help-echo
  3484. "The clock is running in this item")))))))))
  3485. (defun org-agenda-unmark-clocking-task ()
  3486. "Unmark the current clocking task."
  3487. (mapc (lambda (o)
  3488. (if (eq (overlay-get o 'type) 'org-agenda-clocking)
  3489. (delete-overlay o)))
  3490. (overlays-in (point-min) (point-max))))
  3491. (defun org-agenda-fontify-priorities ()
  3492. "Make highest priority lines bold, and lowest italic."
  3493. (interactive)
  3494. (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
  3495. (delete-overlay o)))
  3496. (overlays-in (point-min) (point-max)))
  3497. (save-excursion
  3498. (let (b e p ov h l)
  3499. (goto-char (point-min))
  3500. (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
  3501. (setq h (or (get-char-property (point) 'org-highest-priority)
  3502. org-highest-priority)
  3503. l (or (get-char-property (point) 'org-lowest-priority)
  3504. org-lowest-priority)
  3505. p (string-to-char (match-string 1))
  3506. b (match-beginning 0)
  3507. e (if (eq org-agenda-fontify-priorities 'cookies)
  3508. (match-end 0)
  3509. (point-at-eol))
  3510. ov (make-overlay b e))
  3511. (overlay-put
  3512. ov 'face
  3513. (let ((special-face
  3514. (cond ((org-face-from-face-or-color
  3515. 'priority 'org-priority
  3516. (cdr (assoc p org-priority-faces))))
  3517. ((and (listp org-agenda-fontify-priorities)
  3518. (org-face-from-face-or-color
  3519. 'priority 'org-priority
  3520. (cdr (assoc p org-agenda-fontify-priorities)))))
  3521. ((equal p l) 'italic)
  3522. ((equal p h) 'bold))))
  3523. (if special-face (list special-face 'org-priority) 'org-priority)))
  3524. (overlay-put ov 'org-type 'org-priority)))))
  3525. (defvar org-depend-tag-blocked)
  3526. (defun org-agenda-dim-blocked-tasks (&optional invisible)
  3527. "Dim currently blocked TODOs in the agenda display.
  3528. When INVISIBLE is non-nil, hide currently blocked TODO instead of
  3529. dimming them."
  3530. (interactive "P")
  3531. (when (called-interactively-p 'interactive)
  3532. (message "Dim or hide blocked tasks..."))
  3533. (dolist (o (overlays-in (point-min) (point-max)))
  3534. (when (eq (overlay-get o 'org-type) 'org-blocked-todo)
  3535. (delete-overlay o)))
  3536. (save-excursion
  3537. (let ((inhibit-read-only t)
  3538. (org-depend-tag-blocked nil)
  3539. org-blocked-by-checkboxes)
  3540. (goto-char (point-min))
  3541. (while (let ((pos (text-property-not-all
  3542. (point) (point-max) 'todo-state nil)))
  3543. (when pos (goto-char pos)))
  3544. (setq org-blocked-by-checkboxes nil)
  3545. (let ((marker (org-get-at-bol 'org-hd-marker)))
  3546. (when (and (markerp marker)
  3547. (with-current-buffer (marker-buffer marker)
  3548. (save-excursion (goto-char marker)
  3549. (org-entry-blocked-p))))
  3550. ;; Entries blocked by checkboxes cannot be made invisible.
  3551. ;; See `org-agenda-dim-blocked-tasks' for details.
  3552. (let* ((really-invisible
  3553. (and (not org-blocked-by-checkboxes)
  3554. (or invisible (eq org-agenda-dim-blocked-tasks
  3555. 'invisible))))
  3556. (ov (make-overlay (if really-invisible (line-end-position 0)
  3557. (line-beginning-position))
  3558. (line-end-position))))
  3559. (if really-invisible (overlay-put ov 'invisible t)
  3560. (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
  3561. (overlay-put ov 'org-type 'org-blocked-todo))))
  3562. (forward-line))))
  3563. (when (called-interactively-p 'interactive)
  3564. (message "Dim or hide blocked tasks...done")))
  3565. (defvar org-agenda-skip-function nil
  3566. "Function to be called at each match during agenda construction.
  3567. If this function returns nil, the current match should not be skipped.
  3568. Otherwise, the function must return a position from where the search
  3569. should be continued.
  3570. This may also be a Lisp form, it will be evaluated.
  3571. Never set this variable using `setq' or so, because then it will apply
  3572. to all future agenda commands. If you do want a global skipping condition,
  3573. use the option `org-agenda-skip-function-global' instead.
  3574. The correct usage for `org-agenda-skip-function' is to bind it with
  3575. `let' to scope it dynamically into the agenda-constructing command.
  3576. A good way to set it is through options in `org-agenda-custom-commands'.")
  3577. (defun org-agenda-skip ()
  3578. "Throw to `:skip' in places that should be skipped.
  3579. Also moves point to the end of the skipped region, so that search can
  3580. continue from there."
  3581. (let ((p (point-at-bol)) to)
  3582. (when (or
  3583. (save-excursion (goto-char p) (looking-at comment-start-skip))
  3584. (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
  3585. (get-text-property p :org-archived)
  3586. (org-end-of-subtree t))
  3587. (and org-agenda-skip-comment-trees
  3588. (get-text-property p :org-comment)
  3589. (org-end-of-subtree t))
  3590. (and (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
  3591. (org-agenda-skip-eval org-agenda-skip-function)))
  3592. (goto-char to))
  3593. (org-in-src-block-p t))
  3594. (throw :skip t))))
  3595. (defun org-agenda-skip-eval (form)
  3596. "If FORM is a function or a list, call (or eval) it and return the result.
  3597. `save-excursion' and `save-match-data' are wrapped around the call, so point
  3598. and match data are returned to the previous state no matter what these
  3599. functions do."
  3600. (let (fp)
  3601. (and form
  3602. (or (setq fp (functionp form))
  3603. (consp form))
  3604. (save-excursion
  3605. (save-match-data
  3606. (if fp
  3607. (funcall form)
  3608. (eval form)))))))
  3609. (defvar org-agenda-markers nil
  3610. "List of all currently active markers created by `org-agenda'.")
  3611. (defvar org-agenda-last-marker-time (float-time)
  3612. "Creation time of the last agenda marker.")
  3613. (defun org-agenda-new-marker (&optional pos)
  3614. "Return a new agenda marker.
  3615. Maker is at point, or at POS if non-nil. Org mode keeps a list of
  3616. these markers and resets them when they are no longer in use."
  3617. (let ((m (copy-marker (or pos (point)) t)))
  3618. (setq org-agenda-last-marker-time (float-time))
  3619. (if org-agenda-buffer
  3620. (with-current-buffer org-agenda-buffer
  3621. (push m org-agenda-markers))
  3622. (push m org-agenda-markers))
  3623. m))
  3624. (defun org-agenda-reset-markers ()
  3625. "Reset markers created by `org-agenda'."
  3626. (while org-agenda-markers
  3627. (move-marker (pop org-agenda-markers) nil)))
  3628. (defun org-agenda-save-markers-for-cut-and-paste (beg end)
  3629. "Save relative positions of markers in region.
  3630. This check for agenda markers in all agenda buffers currently active."
  3631. (dolist (buf (buffer-list))
  3632. (with-current-buffer buf
  3633. (when (eq major-mode 'org-agenda-mode)
  3634. (mapc (lambda (m) (org-check-and-save-marker m beg end))
  3635. org-agenda-markers)))))
  3636. ;;; Entry text mode
  3637. (defun org-agenda-entry-text-show-here ()
  3638. "Add some text from the entry as context to the current line."
  3639. (let (m txt o)
  3640. (setq m (org-get-at-bol 'org-hd-marker))
  3641. (unless (marker-buffer m)
  3642. (error "No marker points to an entry here"))
  3643. (setq txt (concat "\n" (org-no-properties
  3644. (org-agenda-get-some-entry-text
  3645. m org-agenda-entry-text-maxlines
  3646. org-agenda-entry-text-leaders))))
  3647. (when (string-match "\\S-" txt)
  3648. (setq o (make-overlay (point-at-bol) (point-at-eol)))
  3649. (overlay-put o 'evaporate t)
  3650. (overlay-put o 'org-overlay-type 'agenda-entry-content)
  3651. (overlay-put o 'after-string txt))))
  3652. (defun org-agenda-entry-text-show ()
  3653. "Add entry context for all agenda lines."
  3654. (interactive)
  3655. (save-excursion
  3656. (goto-char (point-max))
  3657. (beginning-of-line 1)
  3658. (while (not (bobp))
  3659. (when (org-get-at-bol 'org-hd-marker)
  3660. (org-agenda-entry-text-show-here))
  3661. (beginning-of-line 0))))
  3662. (defun org-agenda-entry-text-hide ()
  3663. "Remove any shown entry context."
  3664. (delq nil
  3665. (mapcar (lambda (o)
  3666. (if (eq (overlay-get o 'org-overlay-type)
  3667. 'agenda-entry-content)
  3668. (progn (delete-overlay o) t)))
  3669. (overlays-in (point-min) (point-max)))))
  3670. (defun org-agenda-get-day-face (date)
  3671. "Return the face DATE should be displayed with."
  3672. (cond ((and (functionp org-agenda-day-face-function)
  3673. (funcall org-agenda-day-face-function date)))
  3674. ((org-agenda-today-p date) 'org-agenda-date-today)
  3675. ((memq (calendar-day-of-week date) org-agenda-weekend-days)
  3676. 'org-agenda-date-weekend)
  3677. (t 'org-agenda-date)))
  3678. (defvar org-agenda-show-log-scoped)
  3679. ;;; Agenda Daily/Weekly
  3680. (defvar org-agenda-start-day nil ; dynamically scoped parameter
  3681. "Start day for the agenda view.
  3682. Custom commands can set this variable in the options section.
  3683. This is usually a string like \"2007-11-01\", \"+2d\" or any other
  3684. input allowed when reading a date through the Org calendar.
  3685. See the docstring of `org-read-date' for details.")
  3686. (defvar org-starting-day nil) ; local variable in the agenda buffer
  3687. (defvar org-arg-loc nil) ; local variable
  3688. (defvar org-agenda-buffer-tmp-name nil)
  3689. ;;;###autoload
  3690. (defun org-agenda-list (&optional arg start-day span with-hour)
  3691. "Produce a daily/weekly view from all files in variable `org-agenda-files'.
  3692. The view will be for the current day or week, but from the overview buffer
  3693. you will be able to go to other days/weeks.
  3694. With a numeric prefix argument in an interactive call, the agenda will
  3695. span ARG days. Lisp programs should instead specify SPAN to change
  3696. the number of days. SPAN defaults to `org-agenda-span'.
  3697. START-DAY defaults to TODAY, or to the most recent match for the weekday
  3698. given in `org-agenda-start-on-weekday'.
  3699. When WITH-HOUR is non-nil, only include scheduled and deadline
  3700. items if they have an hour specification like [h]h:mm."
  3701. (interactive "P")
  3702. (if org-agenda-overriding-arguments
  3703. (setq arg (car org-agenda-overriding-arguments)
  3704. start-day (nth 1 org-agenda-overriding-arguments)
  3705. span (nth 2 org-agenda-overriding-arguments)))
  3706. (if (and (integerp arg) (> arg 0))
  3707. (setq span arg arg nil))
  3708. (catch 'exit
  3709. (setq org-agenda-buffer-name
  3710. (or org-agenda-buffer-tmp-name
  3711. (and org-agenda-doing-sticky-redo org-agenda-buffer-name)
  3712. (if org-agenda-sticky
  3713. (cond ((and org-keys (stringp org-match))
  3714. (format "*Org Agenda(%s:%s)*" org-keys org-match))
  3715. (org-keys
  3716. (format "*Org Agenda(%s)*" org-keys))
  3717. (t "*Org Agenda(a)*")))
  3718. "*Org Agenda*"))
  3719. (org-agenda-prepare "Day/Week")
  3720. (setq start-day (or start-day org-agenda-start-day))
  3721. (if (stringp start-day)
  3722. ;; Convert to an absolute day number
  3723. (setq start-day (time-to-days (org-read-date nil t start-day))))
  3724. (org-compile-prefix-format 'agenda)
  3725. (org-set-sorting-strategy 'agenda)
  3726. (let* ((span (org-agenda-ndays-to-span (or span org-agenda-span)))
  3727. (today (org-today))
  3728. (sd (or start-day today))
  3729. (ndays (org-agenda-span-to-ndays span sd))
  3730. (org-agenda-start-on-weekday
  3731. (if (or (eq ndays 7) (eq ndays 14))
  3732. org-agenda-start-on-weekday))
  3733. (thefiles (org-agenda-files nil 'ifmode))
  3734. (files thefiles)
  3735. (start (if (or (null org-agenda-start-on-weekday)
  3736. (< ndays 7))
  3737. sd
  3738. (let* ((nt (calendar-day-of-week
  3739. (calendar-gregorian-from-absolute sd)))
  3740. (n1 org-agenda-start-on-weekday)
  3741. (d (- nt n1)))
  3742. (- sd (+ (if (< d 0) 7 0) d)))))
  3743. (day-numbers (list start))
  3744. (day-cnt 0)
  3745. (inhibit-redisplay (not debug-on-error))
  3746. (org-agenda-show-log-scoped org-agenda-show-log)
  3747. s e rtn rtnall file date d start-pos end-pos todayp
  3748. clocktable-start clocktable-end filter)
  3749. (setq org-agenda-redo-command
  3750. (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span) with-hour))
  3751. (dotimes (n (1- ndays))
  3752. (push (1+ (car day-numbers)) day-numbers))
  3753. (setq day-numbers (nreverse day-numbers))
  3754. (setq clocktable-start (car day-numbers)
  3755. clocktable-end (1+ (or (org-last day-numbers) 0)))
  3756. (setq-local org-starting-day (car day-numbers))
  3757. (setq-local org-arg-loc arg)
  3758. (setq-local org-agenda-current-span (org-agenda-ndays-to-span span))
  3759. (unless org-agenda-compact-blocks
  3760. (let* ((d1 (car day-numbers))
  3761. (d2 (org-last day-numbers))
  3762. (w1 (org-days-to-iso-week d1))
  3763. (w2 (org-days-to-iso-week d2)))
  3764. (setq s (point))
  3765. (if org-agenda-overriding-header
  3766. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  3767. nil 'face 'org-agenda-structure) "\n")
  3768. (insert (org-agenda-span-name span)
  3769. "-agenda"
  3770. (if (< (- d2 d1) 350)
  3771. (if (= w1 w2)
  3772. (format " (W%02d)" w1)
  3773. (format " (W%02d-W%02d)" w1 w2))
  3774. "")
  3775. ":\n")))
  3776. (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
  3777. 'org-date-line t))
  3778. (org-agenda-mark-header-line s))
  3779. (while (setq d (pop day-numbers))
  3780. (setq date (calendar-gregorian-from-absolute d)
  3781. s (point))
  3782. (if (or (setq todayp (= d today))
  3783. (and (not start-pos) (= d sd)))
  3784. (setq start-pos (point))
  3785. (if (and start-pos (not end-pos))
  3786. (setq end-pos (point))))
  3787. (setq files thefiles
  3788. rtnall nil)
  3789. (while (setq file (pop files))
  3790. (catch 'nextfile
  3791. (org-check-agenda-file file)
  3792. (let ((org-agenda-entry-types org-agenda-entry-types))
  3793. ;; Starred types override non-starred equivalents
  3794. (when (member :deadline* org-agenda-entry-types)
  3795. (setq org-agenda-entry-types
  3796. (delq :deadline org-agenda-entry-types)))
  3797. (when (member :scheduled* org-agenda-entry-types)
  3798. (setq org-agenda-entry-types
  3799. (delq :scheduled org-agenda-entry-types)))
  3800. ;; Honor with-hour
  3801. (when with-hour
  3802. (when (member :deadline org-agenda-entry-types)
  3803. (setq org-agenda-entry-types
  3804. (delq :deadline org-agenda-entry-types))
  3805. (push :deadline* org-agenda-entry-types))
  3806. (when (member :scheduled org-agenda-entry-types)
  3807. (setq org-agenda-entry-types
  3808. (delq :scheduled org-agenda-entry-types))
  3809. (push :scheduled* org-agenda-entry-types)))
  3810. (unless org-agenda-include-deadlines
  3811. (setq org-agenda-entry-types
  3812. (delq :deadline* (delq :deadline org-agenda-entry-types))))
  3813. (cond
  3814. ((memq org-agenda-show-log-scoped '(only clockcheck))
  3815. (setq rtn (org-agenda-get-day-entries
  3816. file date :closed)))
  3817. (org-agenda-show-log-scoped
  3818. (setq rtn (apply 'org-agenda-get-day-entries
  3819. file date
  3820. (append '(:closed) org-agenda-entry-types))))
  3821. (t
  3822. (setq rtn (apply 'org-agenda-get-day-entries
  3823. file date
  3824. org-agenda-entry-types)))))
  3825. (setq rtnall (append rtnall rtn)))) ;; all entries
  3826. (if org-agenda-include-diary
  3827. (let ((org-agenda-search-headline-for-time t))
  3828. (require 'diary-lib)
  3829. (setq rtn (org-get-entries-from-diary date))
  3830. (setq rtnall (append rtnall rtn))))
  3831. (if (or rtnall org-agenda-show-all-dates)
  3832. (progn
  3833. (setq day-cnt (1+ day-cnt))
  3834. (insert
  3835. (if (stringp org-agenda-format-date)
  3836. (format-time-string org-agenda-format-date
  3837. (org-time-from-absolute date))
  3838. (funcall org-agenda-format-date date))
  3839. "\n")
  3840. (put-text-property s (1- (point)) 'face
  3841. (org-agenda-get-day-face date))
  3842. (put-text-property s (1- (point)) 'org-date-line t)
  3843. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3844. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
  3845. (when todayp
  3846. (put-text-property s (1- (point)) 'org-today t))
  3847. (setq rtnall
  3848. (org-agenda-add-time-grid-maybe rtnall ndays todayp))
  3849. (if rtnall (insert ;; all entries
  3850. (org-agenda-finalize-entries rtnall 'agenda)
  3851. "\n"))
  3852. (put-text-property s (1- (point)) 'day d)
  3853. (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
  3854. (when (and org-agenda-clockreport-mode clocktable-start)
  3855. (let ((org-agenda-files (org-agenda-files nil 'ifmode))
  3856. ;; the above line is to ensure the restricted range!
  3857. (p (copy-sequence org-agenda-clockreport-parameter-plist))
  3858. tbl)
  3859. (setq p (org-plist-delete p :block))
  3860. (setq p (plist-put p :tstart clocktable-start))
  3861. (setq p (plist-put p :tend clocktable-end))
  3862. (setq p (plist-put p :scope 'agenda))
  3863. (setq tbl (apply 'org-clock-get-clocktable p))
  3864. (insert tbl)))
  3865. (goto-char (point-min))
  3866. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3867. (unless (and (pos-visible-in-window-p (point-min))
  3868. (pos-visible-in-window-p (point-max)))
  3869. (goto-char (1- (point-max)))
  3870. (recenter -1)
  3871. (if (not (pos-visible-in-window-p (or start-pos 1)))
  3872. (progn
  3873. (goto-char (or start-pos 1))
  3874. (recenter 1))))
  3875. (goto-char (or start-pos 1))
  3876. (add-text-properties (point-min) (point-max)
  3877. `(org-agenda-type agenda
  3878. org-last-args (,arg ,start-day ,span)
  3879. org-redo-cmd ,org-agenda-redo-command
  3880. org-series-cmd ,org-cmd))
  3881. (if (eq org-agenda-show-log-scoped 'clockcheck)
  3882. (org-agenda-show-clocking-issues))
  3883. (org-agenda-finalize)
  3884. (setq buffer-read-only t)
  3885. (message ""))))
  3886. (defun org-agenda-ndays-to-span (n)
  3887. "Return a span symbol for a span of N days, or N if none matches."
  3888. (cond ((symbolp n) n)
  3889. ((= n 1) 'day)
  3890. ((= n 7) 'week)
  3891. ((= n 14) 'fortnight)
  3892. (t n)))
  3893. (defun org-agenda-span-to-ndays (span &optional start-day)
  3894. "Return ndays from SPAN, possibly starting at START-DAY.
  3895. START-DAY is an absolute time value."
  3896. (cond ((numberp span) span)
  3897. ((eq span 'day) 1)
  3898. ((eq span 'week) 7)
  3899. ((eq span 'fortnight) 14)
  3900. ((eq span 'month)
  3901. (let ((date (calendar-gregorian-from-absolute start-day)))
  3902. (calendar-last-day-of-month (car date) (cl-caddr date))))
  3903. ((eq span 'year)
  3904. (let ((date (calendar-gregorian-from-absolute start-day)))
  3905. (if (calendar-leap-year-p (cl-caddr date)) 366 365)))))
  3906. (defun org-agenda-span-name (span)
  3907. "Return a SPAN name."
  3908. (if (null span)
  3909. ""
  3910. (if (symbolp span)
  3911. (capitalize (symbol-name span))
  3912. (format "%d days" span))))
  3913. ;;; Agenda word search
  3914. (defvar org-agenda-search-history nil)
  3915. (defvar org-search-syntax-table nil
  3916. "Special syntax table for Org search.
  3917. In this table, we have single quotes not as word constituents, to
  3918. that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
  3919. (defvar org-mode-syntax-table) ; From org.el
  3920. (defun org-search-syntax-table ()
  3921. (unless org-search-syntax-table
  3922. (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
  3923. (modify-syntax-entry ?' "." org-search-syntax-table)
  3924. (modify-syntax-entry ?` "." org-search-syntax-table))
  3925. org-search-syntax-table)
  3926. (defvar org-agenda-last-search-view-search-was-boolean nil)
  3927. ;;;###autoload
  3928. (defun org-search-view (&optional todo-only string edit-at)
  3929. "Show all entries that contain a phrase or words or regular expressions.
  3930. With optional prefix argument TODO-ONLY, only consider entries that are
  3931. TODO entries. The argument STRING can be used to pass a default search
  3932. string into this function. If EDIT-AT is non-nil, it means that the
  3933. user should get a chance to edit this string, with cursor at position
  3934. EDIT-AT.
  3935. The search string can be viewed either as a phrase that should be found as
  3936. is, or it can be broken into a number of snippets, each of which must match
  3937. in a Boolean way to select an entry. The default depends on the variable
  3938. `org-agenda-search-view-always-boolean'.
  3939. Even if this is turned off (the default) you can always switch to
  3940. Boolean search dynamically by preceding the first word with \"+\" or \"-\".
  3941. The default is a direct search of the whole phrase, where each space in
  3942. the search string can expand to an arbitrary amount of whitespace,
  3943. including newlines.
  3944. If using a Boolean search, the search string is split on whitespace and
  3945. each snippet is searched separately, with logical AND to select an entry.
  3946. Words prefixed with a minus must *not* occur in the entry. Words without
  3947. a prefix or prefixed with a plus must occur in the entry. Matching is
  3948. case-insensitive. Words are enclosed by word delimiters (i.e. they must
  3949. match whole words, not parts of a word) if
  3950. `org-agenda-search-view-force-full-words' is set (default is nil).
  3951. Boolean search snippets enclosed by curly braces are interpreted as
  3952. regular expressions that must or (when preceded with \"-\") must not
  3953. match in the entry. Snippets enclosed into double quotes will be taken
  3954. as a whole, to include whitespace.
  3955. - If the search string starts with an asterisk, search only in headlines.
  3956. - If (possibly after the leading star) the search string starts with an
  3957. exclamation mark, this also means to look at TODO entries only, an effect
  3958. that can also be achieved with a prefix argument.
  3959. - If (possibly after star and exclamation mark) the search string starts
  3960. with a colon, this will mean that the (non-regexp) snippets of the
  3961. Boolean search must match as full words.
  3962. This command searches the agenda files, and in addition the files listed
  3963. in `org-agenda-text-search-extra-files'."
  3964. (interactive "P")
  3965. (if org-agenda-overriding-arguments
  3966. (setq todo-only (car org-agenda-overriding-arguments)
  3967. string (nth 1 org-agenda-overriding-arguments)
  3968. edit-at (nth 2 org-agenda-overriding-arguments)))
  3969. (let* ((props (list 'face nil
  3970. 'done-face 'org-agenda-done
  3971. 'org-not-done-regexp org-not-done-regexp
  3972. 'org-todo-regexp org-todo-regexp
  3973. 'org-complex-heading-regexp org-complex-heading-regexp
  3974. 'mouse-face 'highlight
  3975. 'help-echo (format "mouse-2 or RET jump to location")))
  3976. (full-words org-agenda-search-view-force-full-words)
  3977. (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
  3978. regexp rtn rtnall files file pos inherited-tags
  3979. marker category level tags c neg re boolean
  3980. ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
  3981. (unless (and (not edit-at)
  3982. (stringp string)
  3983. (string-match "\\S-" string))
  3984. (setq string (read-string
  3985. (if org-agenda-search-view-always-boolean
  3986. "[+-]Word/{Regexp} ...: "
  3987. "Phrase or [+-]Word/{Regexp} ...: ")
  3988. (cond
  3989. ((integerp edit-at) (cons string edit-at))
  3990. (edit-at string))
  3991. 'org-agenda-search-history)))
  3992. (catch 'exit
  3993. (if org-agenda-sticky
  3994. (setq org-agenda-buffer-name
  3995. (if (stringp string)
  3996. (format "*Org Agenda(%s:%s)*"
  3997. (or org-keys (or (and todo-only "S") "s")) string)
  3998. (format "*Org Agenda(%s)*" (or (and todo-only "S") "s")))))
  3999. (org-agenda-prepare "SEARCH")
  4000. (org-compile-prefix-format 'search)
  4001. (org-set-sorting-strategy 'search)
  4002. (setq org-agenda-redo-command
  4003. (list 'org-search-view (if todo-only t nil)
  4004. (list 'if 'current-prefix-arg nil string)))
  4005. (setq org-agenda-query-string string)
  4006. (if (equal (string-to-char string) ?*)
  4007. (setq hdl-only t
  4008. words (substring string 1))
  4009. (setq words string))
  4010. (when (equal (string-to-char words) ?!)
  4011. (setq todo-only t
  4012. words (substring words 1)))
  4013. (when (equal (string-to-char words) ?:)
  4014. (setq full-words t
  4015. words (substring words 1)))
  4016. (if (or org-agenda-search-view-always-boolean
  4017. (member (string-to-char words) '(?- ?+ ?\{)))
  4018. (setq boolean t))
  4019. (setq words (org-split-string words))
  4020. (let (www w)
  4021. (while (setq w (pop words))
  4022. (while (and (string-match "\\\\\\'" w) words)
  4023. (setq w (concat (substring w 0 -1) " " (pop words))))
  4024. (push w www))
  4025. (setq words (nreverse www) www nil)
  4026. (while (setq w (pop words))
  4027. (when (and (string-match "\\`[-+]?{" w)
  4028. (not (string-match "}\\'" w)))
  4029. (while (and words (not (string-match "}\\'" (car words))))
  4030. (setq w (concat w " " (pop words))))
  4031. (setq w (concat w " " (pop words))))
  4032. (push w www))
  4033. (setq words (nreverse www)))
  4034. (setq org-agenda-last-search-view-search-was-boolean boolean)
  4035. (when boolean
  4036. (let (wds w)
  4037. (while (setq w (pop words))
  4038. (if (or (equal (substring w 0 1) "\"")
  4039. (and (> (length w) 1)
  4040. (member (substring w 0 1) '("+" "-"))
  4041. (equal (substring w 1 2) "\"")))
  4042. (while (and words (not (equal (substring w -1) "\"")))
  4043. (setq w (concat w " " (pop words)))))
  4044. (and (string-match "\\`\\([-+]?\\)\"" w)
  4045. (setq w (replace-match "\\1" nil nil w)))
  4046. (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
  4047. (push w wds))
  4048. (setq words (nreverse wds))))
  4049. (if boolean
  4050. (mapc (lambda (w)
  4051. (setq c (string-to-char w))
  4052. (if (equal c ?-)
  4053. (setq neg t w (substring w 1))
  4054. (if (equal c ?+)
  4055. (setq neg nil w (substring w 1))
  4056. (setq neg nil)))
  4057. (if (string-match "\\`{.*}\\'" w)
  4058. (setq re (substring w 1 -1))
  4059. (if full-words
  4060. (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
  4061. (setq re (regexp-quote (downcase w)))))
  4062. (if neg (push re regexps-) (push re regexps+)))
  4063. words)
  4064. (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
  4065. regexps+))
  4066. (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
  4067. (if (not regexps+)
  4068. (setq regexp org-outline-regexp-bol)
  4069. (setq regexp (pop regexps+))
  4070. (if hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
  4071. regexp))))
  4072. (setq files (org-agenda-files nil 'ifmode))
  4073. (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
  4074. (pop org-agenda-text-search-extra-files)
  4075. (setq files (org-add-archive-files files)))
  4076. (setq files (append files org-agenda-text-search-extra-files)
  4077. rtnall nil)
  4078. (while (setq file (pop files))
  4079. (setq ee nil)
  4080. (catch 'nextfile
  4081. (org-check-agenda-file file)
  4082. (setq buffer (if (file-exists-p file)
  4083. (org-get-agenda-file-buffer file)
  4084. (error "No such file %s" file)))
  4085. (if (not buffer)
  4086. ;; If file does not exist, make sure an error message is sent
  4087. (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
  4088. file))))
  4089. (with-current-buffer buffer
  4090. (with-syntax-table (org-search-syntax-table)
  4091. (unless (derived-mode-p 'org-mode)
  4092. (error "Agenda file %s is not in `org-mode'" file))
  4093. (let ((case-fold-search t))
  4094. (save-excursion
  4095. (save-restriction
  4096. (if (eq buffer org-agenda-restrict)
  4097. (narrow-to-region org-agenda-restrict-begin
  4098. org-agenda-restrict-end)
  4099. (widen))
  4100. (goto-char (point-min))
  4101. (unless (or (org-at-heading-p)
  4102. (outline-next-heading))
  4103. (throw 'nextfile t))
  4104. (goto-char (max (point-min) (1- (point))))
  4105. (while (re-search-forward regexp nil t)
  4106. (org-back-to-heading t)
  4107. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4108. (> (org-reduced-level (org-outline-level))
  4109. org-agenda-search-view-max-outline-level)
  4110. (forward-line -1)
  4111. (org-back-to-heading t)))
  4112. (skip-chars-forward "* ")
  4113. (setq beg (point-at-bol)
  4114. beg1 (point)
  4115. end (progn
  4116. (outline-next-heading)
  4117. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4118. (> (org-reduced-level (org-outline-level))
  4119. org-agenda-search-view-max-outline-level)
  4120. (forward-line 1)
  4121. (outline-next-heading)))
  4122. (point)))
  4123. (catch :skip
  4124. (goto-char beg)
  4125. (org-agenda-skip)
  4126. (setq str (buffer-substring-no-properties
  4127. (point-at-bol)
  4128. (if hdl-only (point-at-eol) end)))
  4129. (mapc (lambda (wr) (when (string-match wr str)
  4130. (goto-char (1- end))
  4131. (throw :skip t)))
  4132. regexps-)
  4133. (mapc (lambda (wr) (unless (string-match wr str)
  4134. (goto-char (1- end))
  4135. (throw :skip t)))
  4136. (if todo-only
  4137. (cons (concat "^\\*+[ \t]+"
  4138. org-not-done-regexp)
  4139. regexps+)
  4140. regexps+))
  4141. (goto-char beg)
  4142. (setq marker (org-agenda-new-marker (point))
  4143. category (org-get-category)
  4144. level (make-string (org-reduced-level (org-outline-level)) ? )
  4145. inherited-tags
  4146. (or (eq org-agenda-show-inherited-tags 'always)
  4147. (and (listp org-agenda-show-inherited-tags)
  4148. (memq 'todo org-agenda-show-inherited-tags))
  4149. (and (eq org-agenda-show-inherited-tags t)
  4150. (or (eq org-agenda-use-tag-inheritance t)
  4151. (memq 'todo org-agenda-use-tag-inheritance))))
  4152. tags (org-get-tags-at nil (not inherited-tags))
  4153. txt (org-agenda-format-item
  4154. ""
  4155. (buffer-substring-no-properties
  4156. beg1 (point-at-eol))
  4157. level category tags t))
  4158. (org-add-props txt props
  4159. 'org-marker marker 'org-hd-marker marker
  4160. 'org-todo-regexp org-todo-regexp
  4161. 'level level
  4162. 'org-complex-heading-regexp org-complex-heading-regexp
  4163. 'priority 1000
  4164. 'type "search")
  4165. (push txt ee)
  4166. (goto-char (1- end))))))))))
  4167. (setq rtn (nreverse ee))
  4168. (setq rtnall (append rtnall rtn)))
  4169. (if org-agenda-overriding-header
  4170. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4171. nil 'face 'org-agenda-structure) "\n")
  4172. (insert "Search words: ")
  4173. (add-text-properties (point-min) (1- (point))
  4174. (list 'face 'org-agenda-structure))
  4175. (setq pos (point))
  4176. (insert string "\n")
  4177. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4178. (setq pos (point))
  4179. (unless org-agenda-multi
  4180. (insert (substitute-command-keys "\
  4181. Press `\\[org-agenda-manipulate-query-add]', \
  4182. `\\[org-agenda-manipulate-query-subtract]' to add/sub word, \
  4183. `\\[org-agenda-manipulate-query-add-re]', \
  4184. `\\[org-agenda-manipulate-query-subtract-re]' to add/sub regexp, \
  4185. `\\[universal-argument] \\[org-agenda-redo]' to edit\n"))
  4186. (add-text-properties pos (1- (point))
  4187. (list 'face 'org-agenda-structure))))
  4188. (org-agenda-mark-header-line (point-min))
  4189. (when rtnall
  4190. (insert (org-agenda-finalize-entries rtnall 'search) "\n"))
  4191. (goto-char (point-min))
  4192. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4193. (add-text-properties (point-min) (point-max)
  4194. `(org-agenda-type search
  4195. org-last-args (,todo-only ,string ,edit-at)
  4196. org-redo-cmd ,org-agenda-redo-command
  4197. org-series-cmd ,org-cmd))
  4198. (org-agenda-finalize)
  4199. (setq buffer-read-only t))))
  4200. ;;; Agenda TODO list
  4201. (defun org-agenda-propertize-selected-todo-keywords (keywords)
  4202. "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
  4203. (concat
  4204. (if (or (equal keywords "ALL") (not keywords))
  4205. (propertize "ALL" 'face 'warning)
  4206. (mapconcat
  4207. (lambda (kw)
  4208. (propertize kw 'face (org-get-todo-face kw)))
  4209. (org-split-string keywords "|")
  4210. "|"))
  4211. "\n"))
  4212. (defvar org-select-this-todo-keyword nil)
  4213. (defvar org-last-arg nil)
  4214. ;;;###autoload
  4215. (defun org-todo-list (&optional arg)
  4216. "Show all (not done) TODO entries from all agenda file in a single list.
  4217. The prefix arg can be used to select a specific TODO keyword and limit
  4218. the list to these. When using `\\[universal-argument]', you will be prompted
  4219. for a keyword. A numeric prefix directly selects the Nth keyword in
  4220. `org-todo-keywords-1'."
  4221. (interactive "P")
  4222. (if org-agenda-overriding-arguments
  4223. (setq arg org-agenda-overriding-arguments))
  4224. (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
  4225. (let* ((today (org-today))
  4226. (date (calendar-gregorian-from-absolute today))
  4227. (kwds org-todo-keywords-for-agenda)
  4228. (completion-ignore-case t)
  4229. (org-select-this-todo-keyword
  4230. (if (stringp arg) arg
  4231. (and arg (integerp arg) (> arg 0)
  4232. (nth (1- arg) kwds))))
  4233. rtn rtnall files file pos)
  4234. (when (equal arg '(4))
  4235. (setq org-select-this-todo-keyword
  4236. (completing-read "Keyword (or KWD1|K2D2|...): "
  4237. (mapcar #'list kwds) nil nil)))
  4238. (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
  4239. (catch 'exit
  4240. (if org-agenda-sticky
  4241. (setq org-agenda-buffer-name
  4242. (if (stringp org-select-this-todo-keyword)
  4243. (format "*Org Agenda(%s:%s)*" (or org-keys "t")
  4244. org-select-this-todo-keyword)
  4245. (format "*Org Agenda(%s)*" (or org-keys "t")))))
  4246. (org-agenda-prepare "TODO")
  4247. (org-compile-prefix-format 'todo)
  4248. (org-set-sorting-strategy 'todo)
  4249. (setq org-agenda-redo-command
  4250. `(org-todo-list (or (and (numberp current-prefix-arg)
  4251. current-prefix-arg)
  4252. ,org-select-this-todo-keyword
  4253. current-prefix-arg ,arg)))
  4254. (setq files (org-agenda-files nil 'ifmode)
  4255. rtnall nil)
  4256. (while (setq file (pop files))
  4257. (catch 'nextfile
  4258. (org-check-agenda-file file)
  4259. (setq rtn (org-agenda-get-day-entries file date :todo))
  4260. (setq rtnall (append rtnall rtn))))
  4261. (if org-agenda-overriding-header
  4262. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4263. nil 'face 'org-agenda-structure) "\n")
  4264. (insert "Global list of TODO items of type: ")
  4265. (add-text-properties (point-min) (1- (point))
  4266. (list 'face 'org-agenda-structure
  4267. 'short-heading
  4268. (concat "ToDo: "
  4269. (or org-select-this-todo-keyword "ALL"))))
  4270. (org-agenda-mark-header-line (point-min))
  4271. (insert (org-agenda-propertize-selected-todo-keywords
  4272. org-select-this-todo-keyword))
  4273. (setq pos (point))
  4274. (unless org-agenda-multi
  4275. (insert (substitute-command-keys "Available with \
  4276. `N \\[org-agenda-redo]': (0)[ALL]"))
  4277. (let ((n 0) s)
  4278. (mapc (lambda (x)
  4279. (setq s (format "(%d)%s" (setq n (1+ n)) x))
  4280. (if (> (+ (current-column) (string-width s) 1) (frame-width))
  4281. (insert "\n "))
  4282. (insert " " s))
  4283. kwds))
  4284. (insert "\n"))
  4285. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
  4286. (org-agenda-mark-header-line (point-min))
  4287. (when rtnall
  4288. (insert (org-agenda-finalize-entries rtnall 'todo) "\n"))
  4289. (goto-char (point-min))
  4290. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4291. (add-text-properties (point-min) (point-max)
  4292. `(org-agenda-type todo
  4293. org-last-args ,arg
  4294. org-redo-cmd ,org-agenda-redo-command
  4295. org-series-cmd ,org-cmd))
  4296. (org-agenda-finalize)
  4297. (setq buffer-read-only t))))
  4298. ;;; Agenda tags match
  4299. ;;;###autoload
  4300. (defun org-tags-view (&optional todo-only match)
  4301. "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
  4302. The prefix arg TODO-ONLY limits the search to TODO entries."
  4303. (interactive "P")
  4304. (if org-agenda-overriding-arguments
  4305. (setq todo-only (car org-agenda-overriding-arguments)
  4306. match (nth 1 org-agenda-overriding-arguments)))
  4307. (let* ((org-tags-match-list-sublevels
  4308. org-tags-match-list-sublevels)
  4309. (completion-ignore-case t)
  4310. (org--matcher-tags-todo-only todo-only)
  4311. rtn rtnall files file pos matcher
  4312. buffer)
  4313. (when (and (stringp match) (not (string-match "\\S-" match)))
  4314. (setq match nil))
  4315. (catch 'exit
  4316. (if org-agenda-sticky
  4317. (setq org-agenda-buffer-name
  4318. (if (stringp match)
  4319. (format "*Org Agenda(%s:%s)*"
  4320. (or org-keys (or (and todo-only "M") "m")) match)
  4321. (format "*Org Agenda(%s)*" (or (and todo-only "M") "m")))))
  4322. ;; Prepare agendas (and `org-tag-alist-for-agenda') before
  4323. ;; expanding tags within `org-make-tags-matcher'
  4324. (org-agenda-prepare (concat "TAGS " match))
  4325. (setq matcher (org-make-tags-matcher match)
  4326. match (car matcher)
  4327. matcher (cdr matcher))
  4328. (org-compile-prefix-format 'tags)
  4329. (org-set-sorting-strategy 'tags)
  4330. (setq org-agenda-query-string match)
  4331. (setq org-agenda-redo-command
  4332. (list 'org-tags-view
  4333. `(quote ,org--matcher-tags-todo-only)
  4334. `(if current-prefix-arg nil ,org-agenda-query-string)))
  4335. (setq files (org-agenda-files nil 'ifmode)
  4336. rtnall nil)
  4337. (while (setq file (pop files))
  4338. (catch 'nextfile
  4339. (org-check-agenda-file file)
  4340. (setq buffer (if (file-exists-p file)
  4341. (org-get-agenda-file-buffer file)
  4342. (error "No such file %s" file)))
  4343. (if (not buffer)
  4344. ;; If file does not exist, error message to agenda
  4345. (setq rtn (list
  4346. (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4347. rtnall (append rtnall rtn))
  4348. (with-current-buffer buffer
  4349. (unless (derived-mode-p 'org-mode)
  4350. (error "Agenda file %s is not in `org-mode'" file))
  4351. (save-excursion
  4352. (save-restriction
  4353. (if (eq buffer org-agenda-restrict)
  4354. (narrow-to-region org-agenda-restrict-begin
  4355. org-agenda-restrict-end)
  4356. (widen))
  4357. (setq rtn (org-scan-tags 'agenda
  4358. matcher
  4359. org--matcher-tags-todo-only))
  4360. (setq rtnall (append rtnall rtn))))))))
  4361. (if org-agenda-overriding-header
  4362. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4363. nil 'face 'org-agenda-structure) "\n")
  4364. (insert "Headlines with TAGS match: ")
  4365. (add-text-properties (point-min) (1- (point))
  4366. (list 'face 'org-agenda-structure
  4367. 'short-heading
  4368. (concat "Match: " match)))
  4369. (setq pos (point))
  4370. (insert match "\n")
  4371. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4372. (setq pos (point))
  4373. (unless org-agenda-multi
  4374. (insert (substitute-command-keys
  4375. "Press `\\[universal-argument] \\[org-agenda-redo]' \
  4376. to search again with new search string\n")))
  4377. (add-text-properties pos (1- (point))
  4378. (list 'face 'org-agenda-structure)))
  4379. (org-agenda-mark-header-line (point-min))
  4380. (when rtnall
  4381. (insert (org-agenda-finalize-entries rtnall 'tags) "\n"))
  4382. (goto-char (point-min))
  4383. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4384. (add-text-properties
  4385. (point-min) (point-max)
  4386. `(org-agenda-type tags
  4387. org-last-args (,org--matcher-tags-todo-only ,match)
  4388. org-redo-cmd ,org-agenda-redo-command
  4389. org-series-cmd ,org-cmd))
  4390. (org-agenda-finalize)
  4391. (setq buffer-read-only t))))
  4392. ;;; Agenda Finding stuck projects
  4393. (defvar org-agenda-skip-regexp nil
  4394. "Regular expression used in skipping subtrees for the agenda.
  4395. This is basically a temporary global variable that can be set and then
  4396. used by user-defined selections using `org-agenda-skip-function'.")
  4397. (defvar org-agenda-overriding-header nil
  4398. "When set during agenda, todo and tags searches it replaces the header.
  4399. This variable should not be set directly, but custom commands can bind it
  4400. in the options section.")
  4401. (defun org-agenda-skip-entry-if (&rest conditions)
  4402. "Skip entry if any of CONDITIONS is true.
  4403. See `org-agenda-skip-if' for details."
  4404. (org-agenda-skip-if nil conditions))
  4405. (defun org-agenda-skip-subtree-if (&rest conditions)
  4406. "Skip subtree if any of CONDITIONS is true.
  4407. See `org-agenda-skip-if' for details."
  4408. (org-agenda-skip-if t conditions))
  4409. (defun org-agenda-skip-if (subtree conditions)
  4410. "Checks current entity for CONDITIONS.
  4411. If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
  4412. the entry (i.e. the text before the next heading) is checked.
  4413. CONDITIONS is a list of symbols, boolean OR is used to combine the results
  4414. from different tests. Valid conditions are:
  4415. scheduled Check if there is a scheduled cookie
  4416. notscheduled Check if there is no scheduled cookie
  4417. deadline Check if there is a deadline
  4418. notdeadline Check if there is no deadline
  4419. timestamp Check if there is a timestamp (also deadline or scheduled)
  4420. nottimestamp Check if there is no timestamp (also deadline or scheduled)
  4421. regexp Check if regexp matches
  4422. notregexp Check if regexp does not match.
  4423. todo Check if TODO keyword matches
  4424. nottodo Check if TODO keyword does not match
  4425. The regexp is taken from the conditions list, it must come right after
  4426. the `regexp' or `notregexp' element.
  4427. `todo' and `nottodo' accept as an argument a list of todo
  4428. keywords, which may include \"*\" to match any todo keyword.
  4429. (org-agenda-skip-entry-if \\='todo \\='(\"TODO\" \"WAITING\"))
  4430. would skip all entries with \"TODO\" or \"WAITING\" keywords.
  4431. Instead of a list, a keyword class may be given. For example:
  4432. (org-agenda-skip-entry-if \\='nottodo \\='done)
  4433. would skip entries that haven't been marked with any of \"DONE\"
  4434. keywords. Possible classes are: `todo', `done', `any'.
  4435. If any of these conditions is met, this function returns the end point of
  4436. the entity, causing the search to continue from there. This is a function
  4437. that can be put into `org-agenda-skip-function' for the duration of a command."
  4438. (let (beg end m)
  4439. (org-back-to-heading t)
  4440. (setq beg (point)
  4441. end (if subtree
  4442. (progn (org-end-of-subtree t) (point))
  4443. (progn (outline-next-heading) (1- (point)))))
  4444. (goto-char beg)
  4445. (and
  4446. (or
  4447. (and (memq 'scheduled conditions)
  4448. (re-search-forward org-scheduled-time-regexp end t))
  4449. (and (memq 'notscheduled conditions)
  4450. (not (re-search-forward org-scheduled-time-regexp end t)))
  4451. (and (memq 'deadline conditions)
  4452. (re-search-forward org-deadline-time-regexp end t))
  4453. (and (memq 'notdeadline conditions)
  4454. (not (re-search-forward org-deadline-time-regexp end t)))
  4455. (and (memq 'timestamp conditions)
  4456. (re-search-forward org-ts-regexp end t))
  4457. (and (memq 'nottimestamp conditions)
  4458. (not (re-search-forward org-ts-regexp end t)))
  4459. (and (setq m (memq 'regexp conditions))
  4460. (stringp (nth 1 m))
  4461. (re-search-forward (nth 1 m) end t))
  4462. (and (setq m (memq 'notregexp conditions))
  4463. (stringp (nth 1 m))
  4464. (not (re-search-forward (nth 1 m) end t)))
  4465. (and (or
  4466. (setq m (memq 'nottodo conditions))
  4467. (setq m (memq 'todo-unblocked conditions))
  4468. (setq m (memq 'nottodo-unblocked conditions))
  4469. (setq m (memq 'todo conditions)))
  4470. (org-agenda-skip-if-todo m end)))
  4471. end)))
  4472. (defun org-agenda-skip-if-todo (args end)
  4473. "Helper function for `org-agenda-skip-if', do not use it directly.
  4474. ARGS is a list with first element either `todo', `nottodo',
  4475. `todo-unblocked' or `nottodo-unblocked'. The remainder is either
  4476. a list of TODO keywords, or a state symbol `todo' or `done' or
  4477. `any'."
  4478. (let ((kw (car args))
  4479. (arg (cadr args))
  4480. todo-wds todo-re)
  4481. (setq todo-wds
  4482. (org-uniquify
  4483. (cond
  4484. ((listp arg) ;; list of keywords
  4485. (if (member "*" arg)
  4486. (mapcar 'substring-no-properties org-todo-keywords-1)
  4487. arg))
  4488. ((symbolp arg) ;; keyword class name
  4489. (cond
  4490. ((eq arg 'todo)
  4491. (org-delete-all org-done-keywords
  4492. (mapcar 'substring-no-properties
  4493. org-todo-keywords-1)))
  4494. ((eq arg 'done) org-done-keywords)
  4495. ((eq arg 'any)
  4496. (mapcar 'substring-no-properties org-todo-keywords-1)))))))
  4497. (setq todo-re
  4498. (concat "^\\*+[ \t]+\\<\\("
  4499. (mapconcat 'identity todo-wds "\\|")
  4500. "\\)\\>"))
  4501. (cond
  4502. ((eq kw 'todo) (re-search-forward todo-re end t))
  4503. ((eq kw 'nottodo) (not (re-search-forward todo-re end t)))
  4504. ((eq kw 'todo-unblocked)
  4505. (catch 'unblocked
  4506. (while (re-search-forward todo-re end t)
  4507. (or (org-entry-blocked-p) (throw 'unblocked t)))
  4508. nil))
  4509. ((eq kw 'nottodo-unblocked)
  4510. (catch 'unblocked
  4511. (while (re-search-forward todo-re end t)
  4512. (or (org-entry-blocked-p) (throw 'unblocked nil)))
  4513. t))
  4514. )))
  4515. ;;;###autoload
  4516. (defun org-agenda-list-stuck-projects (&rest ignore)
  4517. "Create agenda view for projects that are stuck.
  4518. Stuck projects are project that have no next actions. For the definitions
  4519. of what a project is and how to check if it stuck, customize the variable
  4520. `org-stuck-projects'."
  4521. (interactive)
  4522. (let* ((org-agenda-overriding-header
  4523. (or org-agenda-overriding-header "List of stuck projects: "))
  4524. (matcher (nth 0 org-stuck-projects))
  4525. (todo (nth 1 org-stuck-projects))
  4526. (tags (nth 2 org-stuck-projects))
  4527. (gen-re (org-string-nw-p (nth 3 org-stuck-projects)))
  4528. (todo-wds
  4529. (if (not (member "*" todo)) todo
  4530. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  4531. (org-delete-all org-done-keywords-for-agenda
  4532. (copy-sequence org-todo-keywords-for-agenda))))
  4533. (todo-re (and todo
  4534. (format "^\\*+[ \t]+\\(%s\\)\\>"
  4535. (mapconcat #'identity todo-wds "\\|"))))
  4536. (tags-re (cond ((null tags) nil)
  4537. ((member "*" tags)
  4538. (eval-when-compile
  4539. (concat org-outline-regexp-bol
  4540. ".*:[[:alnum:]_@#%]+:[ \t]*$")))
  4541. (tags (concat org-outline-regexp-bol
  4542. ".*:\\("
  4543. (mapconcat #'identity tags "\\|")
  4544. "\\):[[:alnum:]_@#%:]*[ \t]*$"))
  4545. (t nil)))
  4546. (re-list (delq nil (list todo-re tags-re gen-re)))
  4547. (skip-re
  4548. (if (null re-list)
  4549. (error "Missing information to identify unstuck projects")
  4550. (mapconcat #'identity re-list "\\|")))
  4551. (org-agenda-skip-function
  4552. ;; Skip entry if `org-agenda-skip-regexp' matches anywhere
  4553. ;; in the subtree.
  4554. `(lambda ()
  4555. (and (save-excursion
  4556. (let ((case-fold-search nil))
  4557. (re-search-forward
  4558. ,skip-re (save-excursion (org-end-of-subtree t)) t)))
  4559. (progn (outline-next-heading) (point))))))
  4560. (org-tags-view nil matcher)
  4561. (setq org-agenda-buffer-name (buffer-name))
  4562. (with-current-buffer org-agenda-buffer-name
  4563. (setq org-agenda-redo-command
  4564. `(org-agenda-list-stuck-projects ,current-prefix-arg))
  4565. (let ((inhibit-read-only t))
  4566. (add-text-properties
  4567. (point-min) (point-max)
  4568. `(org-redo-cmd ,org-agenda-redo-command))))))
  4569. ;;; Diary integration
  4570. (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
  4571. (defvar diary-list-entries-hook)
  4572. (defvar diary-time-regexp)
  4573. (defun org-get-entries-from-diary (date)
  4574. "Get the (Emacs Calendar) diary entries for DATE."
  4575. (require 'diary-lib)
  4576. (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
  4577. (diary-display-function 'diary-fancy-display)
  4578. (pop-up-frames nil)
  4579. (diary-list-entries-hook
  4580. (cons 'org-diary-default-entry diary-list-entries-hook))
  4581. (diary-file-name-prefix nil) ; turn this feature off
  4582. (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
  4583. entries
  4584. (org-disable-agenda-to-diary t))
  4585. (save-excursion
  4586. (save-window-excursion
  4587. (funcall (if (fboundp 'diary-list-entries)
  4588. 'diary-list-entries 'list-diary-entries)
  4589. date 1)))
  4590. (if (not (get-buffer diary-fancy-buffer))
  4591. (setq entries nil)
  4592. (with-current-buffer diary-fancy-buffer
  4593. (setq buffer-read-only nil)
  4594. (if (zerop (buffer-size))
  4595. ;; No entries
  4596. (setq entries nil)
  4597. ;; Omit the date and other unnecessary stuff
  4598. (org-agenda-cleanup-fancy-diary)
  4599. ;; Add prefix to each line and extend the text properties
  4600. (if (zerop (buffer-size))
  4601. (setq entries nil)
  4602. (setq entries (buffer-substring (point-min) (- (point-max) 1)))
  4603. (setq entries
  4604. (with-temp-buffer
  4605. (insert entries) (goto-char (point-min))
  4606. (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
  4607. (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
  4608. (replace-match (concat "; " (match-string 1)))))
  4609. (buffer-string)))))
  4610. (set-buffer-modified-p nil)
  4611. (kill-buffer diary-fancy-buffer)))
  4612. (when entries
  4613. (setq entries (org-split-string entries "\n"))
  4614. (setq entries
  4615. (mapcar
  4616. (lambda (x)
  4617. (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
  4618. ;; Extend the text properties to the beginning of the line
  4619. (org-add-props x (text-properties-at (1- (length x)) x)
  4620. 'type "diary" 'date date 'face 'org-agenda-diary))
  4621. entries)))))
  4622. (defvar org-agenda-cleanup-fancy-diary-hook nil
  4623. "Hook run when the fancy diary buffer is cleaned up.")
  4624. (defun org-agenda-cleanup-fancy-diary ()
  4625. "Remove unwanted stuff in buffer created by `fancy-diary-display'.
  4626. This gets rid of the date, the underline under the date, and
  4627. the dummy entry installed by `org-mode' to ensure non-empty diary for each
  4628. date. It also removes lines that contain only whitespace."
  4629. (goto-char (point-min))
  4630. (if (looking-at ".*?:[ \t]*")
  4631. (progn
  4632. (replace-match "")
  4633. (re-search-forward "\n=+$" nil t)
  4634. (replace-match "")
  4635. (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
  4636. (re-search-forward "\n=+$" nil t)
  4637. (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
  4638. (goto-char (point-min))
  4639. (while (re-search-forward "^ +\n" nil t)
  4640. (replace-match ""))
  4641. (goto-char (point-min))
  4642. (if (re-search-forward "^Org mode dummy\n?" nil t)
  4643. (replace-match ""))
  4644. (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
  4645. ;; Make sure entries from the diary have the right text properties.
  4646. (eval-after-load "diary-lib"
  4647. '(if (boundp 'diary-modify-entry-list-string-function)
  4648. ;; We can rely on the hook, nothing to do
  4649. nil
  4650. ;; Hook not available, must use advice to make this work
  4651. (defadvice add-to-diary-list (before org-mark-diary-entry activate)
  4652. "Make the position visible."
  4653. (if (and org-disable-agenda-to-diary ;; called from org-agenda
  4654. (stringp string)
  4655. buffer-file-name)
  4656. (setq string (org-modify-diary-entry-string string))))))
  4657. (defun org-modify-diary-entry-string (string)
  4658. "Add text properties to string, allowing Org to act on it."
  4659. (org-add-props string nil
  4660. 'mouse-face 'highlight
  4661. 'help-echo (if buffer-file-name
  4662. (format "mouse-2 or RET jump to diary file %s"
  4663. (abbreviate-file-name buffer-file-name))
  4664. "")
  4665. 'org-agenda-diary-link t
  4666. 'org-marker (org-agenda-new-marker (point-at-bol))))
  4667. (defun org-diary-default-entry ()
  4668. "Add a dummy entry to the diary.
  4669. Needed to avoid empty dates which mess up holiday display."
  4670. ;; Catch the error if dealing with the new add-to-diary-alist
  4671. (when org-disable-agenda-to-diary
  4672. (condition-case nil
  4673. (org-add-to-diary-list original-date "Org mode dummy" "")
  4674. (error
  4675. (org-add-to-diary-list original-date "Org mode dummy" "" nil)))))
  4676. (defun org-add-to-diary-list (&rest args)
  4677. (if (fboundp 'diary-add-to-list)
  4678. (apply 'diary-add-to-list args)
  4679. (apply 'add-to-diary-list args)))
  4680. (defvar org-diary-last-run-time nil)
  4681. ;;;###autoload
  4682. (defun org-diary (&rest args)
  4683. "Return diary information from org files.
  4684. This function can be used in a \"sexp\" diary entry in the Emacs calendar.
  4685. It accesses org files and extracts information from those files to be
  4686. listed in the diary. The function accepts arguments specifying what
  4687. items should be listed. For a list of arguments allowed here, see the
  4688. variable `org-agenda-entry-types'.
  4689. The call in the diary file should look like this:
  4690. &%%(org-diary) ~/path/to/some/orgfile.org
  4691. Use a separate line for each org file to check. Or, if you omit the file name,
  4692. all files listed in `org-agenda-files' will be checked automatically:
  4693. &%%(org-diary)
  4694. If you don't give any arguments (as in the example above), the default value
  4695. of `org-agenda-entry-types' is used: (:deadline :scheduled :timestamp :sexp).
  4696. So the example above may also be written as
  4697. &%%(org-diary :deadline :timestamp :sexp :scheduled)
  4698. The function expects the lisp variables `entry' and `date' to be provided
  4699. by the caller, because this is how the calendar works. Don't use this
  4700. function from a program - use `org-agenda-get-day-entries' instead."
  4701. (when (> (- (float-time)
  4702. org-agenda-last-marker-time)
  4703. 5)
  4704. ;; I am not sure if this works with sticky agendas, because the marker
  4705. ;; list is then no longer a global variable.
  4706. (org-agenda-reset-markers))
  4707. (org-compile-prefix-format 'agenda)
  4708. (org-set-sorting-strategy 'agenda)
  4709. (setq args (or args org-agenda-entry-types))
  4710. (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
  4711. (list entry)
  4712. (org-agenda-files t)))
  4713. (time (float-time))
  4714. file rtn results)
  4715. (when (or (not org-diary-last-run-time)
  4716. (> (- time
  4717. org-diary-last-run-time)
  4718. 3))
  4719. (org-agenda-prepare-buffers files))
  4720. (setq org-diary-last-run-time time)
  4721. ;; If this is called during org-agenda, don't return any entries to
  4722. ;; the calendar. Org Agenda will list these entries itself.
  4723. (if org-disable-agenda-to-diary (setq files nil))
  4724. (while (setq file (pop files))
  4725. (setq rtn (apply 'org-agenda-get-day-entries file date args))
  4726. (setq results (append results rtn)))
  4727. (when results
  4728. (setq results
  4729. (mapcar (lambda (i) (replace-regexp-in-string
  4730. org-bracket-link-regexp "\\3" i)) results))
  4731. (concat (org-agenda-finalize-entries results) "\n"))))
  4732. ;;; Agenda entry finders
  4733. (defun org-agenda--timestamp-to-absolute (&rest args)
  4734. "Call `org-time-string-to-absolute' with ARGS.
  4735. However, throw `:skip' whenever an error is raised."
  4736. (condition-case e
  4737. (apply #'org-time-string-to-absolute args)
  4738. (org-diary-sexp-no-match (throw :skip nil))
  4739. (error
  4740. (message "%s; Skipping entry" (error-message-string e))
  4741. (throw :skip nil))))
  4742. (defun org-agenda-get-day-entries (file date &rest args)
  4743. "Does the work for `org-diary' and `org-agenda'.
  4744. FILE is the path to a file to be checked for entries. DATE is date like
  4745. the one returned by `calendar-current-date'. ARGS are symbols indicating
  4746. which kind of entries should be extracted. For details about these, see
  4747. the documentation of `org-diary'."
  4748. (let* ((org-startup-folded nil)
  4749. (org-startup-align-all-tables nil)
  4750. (buffer (if (file-exists-p file) (org-get-agenda-file-buffer file)
  4751. (error "No such file %s" file))))
  4752. (if (not buffer)
  4753. ;; If file does not exist, signal it in diary nonetheless.
  4754. (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4755. (with-current-buffer buffer
  4756. (unless (derived-mode-p 'org-mode)
  4757. (error "Agenda file %s is not in `org-mode'" file))
  4758. (setq org-agenda-buffer (or org-agenda-buffer buffer))
  4759. (setf org-agenda-current-date date)
  4760. (save-excursion
  4761. (save-restriction
  4762. (if (eq buffer org-agenda-restrict)
  4763. (narrow-to-region org-agenda-restrict-begin
  4764. org-agenda-restrict-end)
  4765. (widen))
  4766. ;; Rationalize ARGS. Also make sure `:deadline' comes
  4767. ;; first in order to populate DEADLINES before passing it.
  4768. ;;
  4769. ;; We use `delq' since `org-uniquify' duplicates ARGS,
  4770. ;; guarding us from modifying `org-agenda-entry-types'.
  4771. (setf args (org-uniquify (or args org-agenda-entry-types)))
  4772. (when (and (memq :scheduled args) (memq :scheduled* args))
  4773. (setf args (delq :scheduled* args)))
  4774. (cond
  4775. ((memq :deadline args)
  4776. (setf args (cons :deadline
  4777. (delq :deadline (delq :deadline* args)))))
  4778. ((memq :deadline* args)
  4779. (setf args (cons :deadline* (delq :deadline* args)))))
  4780. ;; Collect list of headlines. Return them flattened.
  4781. (let ((case-fold-search nil) results deadlines)
  4782. (dolist (arg args (apply #'nconc (nreverse results)))
  4783. (pcase arg
  4784. ((and :todo (guard (org-agenda-today-p date)))
  4785. (push (org-agenda-get-todos) results))
  4786. (:timestamp
  4787. (push (org-agenda-get-blocks) results)
  4788. (push (org-agenda-get-timestamps deadlines) results))
  4789. (:sexp
  4790. (push (org-agenda-get-sexps) results))
  4791. (:scheduled
  4792. (push (org-agenda-get-scheduled deadlines) results))
  4793. (:scheduled*
  4794. (push (org-agenda-get-scheduled deadlines t) results))
  4795. (:closed
  4796. (push (org-agenda-get-progress) results))
  4797. (:deadline
  4798. (setf deadlines (org-agenda-get-deadlines))
  4799. (push deadlines results))
  4800. (:deadline*
  4801. (setf deadlines (org-agenda-get-deadlines t))
  4802. (push deadlines results)))))))))))
  4803. (defsubst org-em (x y list)
  4804. "Is X or Y a member of LIST?"
  4805. (or (memq x list) (memq y list)))
  4806. (defvar org-heading-keyword-regexp-format) ; defined in org.el
  4807. (defvar org-agenda-sorting-strategy-selected nil)
  4808. (defun org-agenda-entry-get-agenda-timestamp (pom)
  4809. "Retrieve timestamp information for sorting agenda views.
  4810. Given a point or marker POM, returns a cons cell of the timestamp
  4811. and the timestamp type relevant for the sorting strategy in
  4812. `org-agenda-sorting-strategy-selected'."
  4813. (let (ts ts-date-type)
  4814. (save-match-data
  4815. (cond ((org-em 'scheduled-up 'scheduled-down
  4816. org-agenda-sorting-strategy-selected)
  4817. (setq ts (org-entry-get pom "SCHEDULED")
  4818. ts-date-type " scheduled"))
  4819. ((org-em 'deadline-up 'deadline-down
  4820. org-agenda-sorting-strategy-selected)
  4821. (setq ts (org-entry-get pom "DEADLINE")
  4822. ts-date-type " deadline"))
  4823. ((org-em 'ts-up 'ts-down
  4824. org-agenda-sorting-strategy-selected)
  4825. (setq ts (org-entry-get pom "TIMESTAMP")
  4826. ts-date-type " timestamp"))
  4827. ((org-em 'tsia-up 'tsia-down
  4828. org-agenda-sorting-strategy-selected)
  4829. (setq ts (org-entry-get pom "TIMESTAMP_IA")
  4830. ts-date-type " timestamp_ia"))
  4831. ((org-em 'timestamp-up 'timestamp-down
  4832. org-agenda-sorting-strategy-selected)
  4833. (setq ts (or (org-entry-get pom "SCHEDULED")
  4834. (org-entry-get pom "DEADLINE")
  4835. (org-entry-get pom "TIMESTAMP")
  4836. (org-entry-get pom "TIMESTAMP_IA"))
  4837. ts-date-type ""))
  4838. (t (setq ts-date-type "")))
  4839. (cons (when ts (ignore-errors (org-time-string-to-absolute ts)))
  4840. ts-date-type))))
  4841. (defun org-agenda-get-todos ()
  4842. "Return the TODO information for agenda display."
  4843. (let* ((props (list 'face nil
  4844. 'done-face 'org-agenda-done
  4845. 'org-not-done-regexp org-not-done-regexp
  4846. 'org-todo-regexp org-todo-regexp
  4847. 'org-complex-heading-regexp org-complex-heading-regexp
  4848. 'mouse-face 'highlight
  4849. 'help-echo
  4850. (format "mouse-2 or RET jump to org file %s"
  4851. (abbreviate-file-name buffer-file-name))))
  4852. (case-fold-search nil)
  4853. (regexp (format org-heading-keyword-regexp-format
  4854. (cond
  4855. ((and org-select-this-todo-keyword
  4856. (equal org-select-this-todo-keyword "*"))
  4857. org-todo-regexp)
  4858. (org-select-this-todo-keyword
  4859. (concat "\\("
  4860. (mapconcat 'identity
  4861. (org-split-string
  4862. org-select-this-todo-keyword
  4863. "|")
  4864. "\\|") "\\)"))
  4865. (t org-not-done-regexp))))
  4866. marker priority category level tags todo-state
  4867. ts-date ts-date-type ts-date-pair
  4868. ee txt beg end inherited-tags todo-state-end-pos)
  4869. (goto-char (point-min))
  4870. (while (re-search-forward regexp nil t)
  4871. (catch :skip
  4872. (save-match-data
  4873. (beginning-of-line)
  4874. (org-agenda-skip)
  4875. (setq beg (point) end (save-excursion (outline-next-heading) (point)))
  4876. (unless (and (setq todo-state (org-get-todo-state))
  4877. (setq todo-state-end-pos (match-end 2)))
  4878. (goto-char end)
  4879. (throw :skip nil))
  4880. (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
  4881. (goto-char (1+ beg))
  4882. (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
  4883. (throw :skip nil)))
  4884. (goto-char (match-beginning 2))
  4885. (setq marker (org-agenda-new-marker (match-beginning 0))
  4886. category (org-get-category)
  4887. ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
  4888. ts-date (car ts-date-pair)
  4889. ts-date-type (cdr ts-date-pair)
  4890. txt (org-trim (buffer-substring (match-beginning 2) (match-end 0)))
  4891. inherited-tags
  4892. (or (eq org-agenda-show-inherited-tags 'always)
  4893. (and (listp org-agenda-show-inherited-tags)
  4894. (memq 'todo org-agenda-show-inherited-tags))
  4895. (and (eq org-agenda-show-inherited-tags t)
  4896. (or (eq org-agenda-use-tag-inheritance t)
  4897. (memq 'todo org-agenda-use-tag-inheritance))))
  4898. tags (org-get-tags-at nil (not inherited-tags))
  4899. level (make-string (org-reduced-level (org-outline-level)) ? )
  4900. txt (org-agenda-format-item "" txt level category tags t)
  4901. priority (1+ (org-get-priority txt)))
  4902. (org-add-props txt props
  4903. 'org-marker marker 'org-hd-marker marker
  4904. 'priority priority
  4905. 'level level
  4906. 'ts-date ts-date
  4907. 'type (concat "todo" ts-date-type) 'todo-state todo-state)
  4908. (push txt ee)
  4909. (if org-agenda-todo-list-sublevels
  4910. (goto-char todo-state-end-pos)
  4911. (org-end-of-subtree 'invisible))))
  4912. (nreverse ee)))
  4913. (defun org-agenda-todo-custom-ignore-p (time n)
  4914. "Check whether timestamp is farther away than n number of days.
  4915. This function is invoked if `org-agenda-todo-ignore-deadlines',
  4916. `org-agenda-todo-ignore-scheduled' or
  4917. `org-agenda-todo-ignore-timestamp' is set to an integer."
  4918. (let ((days (org-time-stamp-to-now
  4919. time org-agenda-todo-ignore-time-comparison-use-seconds)))
  4920. (if (>= n 0)
  4921. (>= days n)
  4922. (<= days n))))
  4923. ;;;###autoload
  4924. (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  4925. (&optional end)
  4926. "Do we have a reason to ignore this TODO entry because it has a time stamp?"
  4927. (when (or org-agenda-todo-ignore-with-date
  4928. org-agenda-todo-ignore-scheduled
  4929. org-agenda-todo-ignore-deadlines
  4930. org-agenda-todo-ignore-timestamp)
  4931. (setq end (or end (save-excursion (outline-next-heading) (point))))
  4932. (save-excursion
  4933. (or (and org-agenda-todo-ignore-with-date
  4934. (re-search-forward org-ts-regexp end t))
  4935. (and org-agenda-todo-ignore-scheduled
  4936. (re-search-forward org-scheduled-time-regexp end t)
  4937. (cond
  4938. ((eq org-agenda-todo-ignore-scheduled 'future)
  4939. (> (org-time-stamp-to-now
  4940. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4941. ((eq org-agenda-todo-ignore-scheduled 'past)
  4942. (<= (org-time-stamp-to-now
  4943. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4944. ((numberp org-agenda-todo-ignore-scheduled)
  4945. (org-agenda-todo-custom-ignore-p
  4946. (match-string 1) org-agenda-todo-ignore-scheduled))
  4947. (t)))
  4948. (and org-agenda-todo-ignore-deadlines
  4949. (re-search-forward org-deadline-time-regexp end t)
  4950. (cond
  4951. ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
  4952. ((eq org-agenda-todo-ignore-deadlines 'far)
  4953. (not (org-deadline-close-p (match-string 1))))
  4954. ((eq org-agenda-todo-ignore-deadlines 'future)
  4955. (> (org-time-stamp-to-now
  4956. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4957. ((eq org-agenda-todo-ignore-deadlines 'past)
  4958. (<= (org-time-stamp-to-now
  4959. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4960. ((numberp org-agenda-todo-ignore-deadlines)
  4961. (org-agenda-todo-custom-ignore-p
  4962. (match-string 1) org-agenda-todo-ignore-deadlines))
  4963. (t (org-deadline-close-p (match-string 1)))))
  4964. (and org-agenda-todo-ignore-timestamp
  4965. (let ((buffer (current-buffer))
  4966. (regexp
  4967. (concat
  4968. org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
  4969. (start (point)))
  4970. ;; Copy current buffer into a temporary one
  4971. (with-temp-buffer
  4972. (insert-buffer-substring buffer start end)
  4973. (goto-char (point-min))
  4974. ;; Delete SCHEDULED and DEADLINE items
  4975. (while (re-search-forward regexp end t)
  4976. (delete-region (match-beginning 0) (match-end 0)))
  4977. (goto-char (point-min))
  4978. ;; No search for timestamp left
  4979. (when (re-search-forward org-ts-regexp nil t)
  4980. (cond
  4981. ((eq org-agenda-todo-ignore-timestamp 'future)
  4982. (> (org-time-stamp-to-now
  4983. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4984. ((eq org-agenda-todo-ignore-timestamp 'past)
  4985. (<= (org-time-stamp-to-now
  4986. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4987. ((numberp org-agenda-todo-ignore-timestamp)
  4988. (org-agenda-todo-custom-ignore-p
  4989. (match-string 1) org-agenda-todo-ignore-timestamp))
  4990. (t))))))))))
  4991. (defun org-agenda-get-timestamps (&optional deadlines)
  4992. "Return the date stamp information for agenda display.
  4993. Optional argument DEADLINES is a list of deadline items to be
  4994. displayed in agenda view."
  4995. (let* ((props (list 'face 'org-agenda-calendar-event
  4996. 'org-not-done-regexp org-not-done-regexp
  4997. 'org-todo-regexp org-todo-regexp
  4998. 'org-complex-heading-regexp org-complex-heading-regexp
  4999. 'mouse-face 'highlight
  5000. 'help-echo
  5001. (format "mouse-2 or RET jump to Org file %s"
  5002. (abbreviate-file-name buffer-file-name))))
  5003. (current (calendar-absolute-from-gregorian date))
  5004. (today (org-today))
  5005. (deadline-position-alist
  5006. (mapcar (lambda (d)
  5007. (let ((m (get-text-property 0 'org-hd-marker d)))
  5008. (and m (marker-position m))))
  5009. deadlines))
  5010. ;; Match time-stamps set to current date, time-stamps with
  5011. ;; a repeater, and S-exp time-stamps.
  5012. (regexp
  5013. (concat
  5014. (if org-agenda-include-inactive-timestamps "[[<]" "<")
  5015. (regexp-quote
  5016. (substring
  5017. (format-time-string
  5018. (car org-time-stamp-formats)
  5019. (apply #'encode-time ; DATE bound by calendar
  5020. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  5021. 1 11))
  5022. "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
  5023. "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
  5024. timestamp-items)
  5025. (goto-char (point-min))
  5026. (while (re-search-forward regexp nil t)
  5027. ;; Skip date ranges, scheduled and deadlines, which are handled
  5028. ;; specially. Also skip time-stamps before first headline as
  5029. ;; there would be no entry to add to the agenda. Eventually,
  5030. ;; ignore clock entries.
  5031. (catch :skip
  5032. (save-match-data
  5033. (when (or (org-at-date-range-p)
  5034. (org-at-planning-p)
  5035. (org-before-first-heading-p)
  5036. (and org-agenda-include-inactive-timestamps
  5037. (org-at-clock-log-p)))
  5038. (throw :skip nil))
  5039. (org-agenda-skip))
  5040. (let* ((pos (match-beginning 0))
  5041. (repeat (match-string 1))
  5042. (sexp-entry (match-string 3))
  5043. (time-stamp (if (or repeat sexp-entry) (match-string 0)
  5044. (save-excursion
  5045. (goto-char pos)
  5046. (looking-at org-ts-regexp-both)
  5047. (match-string 0))))
  5048. (todo-state (org-get-todo-state))
  5049. (warntime (get-text-property (point) 'org-appt-warntime))
  5050. (done? (member todo-state org-done-keywords)))
  5051. ;; Possibly skip done tasks.
  5052. (when (and done? org-agenda-skip-timestamp-if-done)
  5053. (throw :skip t))
  5054. ;; S-exp entry doesn't match current day: skip it.
  5055. (when (and sexp-entry (not (org-diary-sexp-entry sexp-entry "" date)))
  5056. (throw :skip nil))
  5057. (when repeat
  5058. (let* ((past
  5059. ;; A repeating time stamp is shown at its base
  5060. ;; date and every repeated date up to TODAY. If
  5061. ;; `org-agenda-prefer-last-repeat' is non-nil,
  5062. ;; however, only the last repeat before today
  5063. ;; (inclusive) is shown.
  5064. (org-agenda--timestamp-to-absolute
  5065. repeat
  5066. (if (or (> current today)
  5067. (eq org-agenda-prefer-last-repeat t)
  5068. (member todo-state org-agenda-prefer-last-repeat))
  5069. today
  5070. current)
  5071. 'past (current-buffer) pos))
  5072. (future
  5073. ;; Display every repeated date past TODAY
  5074. ;; (exclusive) unless
  5075. ;; `org-agenda-show-future-repeats' is nil. If
  5076. ;; this variable is set to `next', only display
  5077. ;; the first repeated date after TODAY
  5078. ;; (exclusive).
  5079. (cond
  5080. ((<= current today) past)
  5081. ((not org-agenda-show-future-repeats) past)
  5082. (t
  5083. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5084. (1+ today)
  5085. current)))
  5086. (org-agenda--timestamp-to-absolute
  5087. repeat base 'future (current-buffer) pos))))))
  5088. (when (and (/= current past) (/= current future))
  5089. (throw :skip nil))))
  5090. (save-excursion
  5091. (re-search-backward org-outline-regexp-bol nil t)
  5092. ;; Possibly skip time-stamp when a deadline is set.
  5093. (when (and org-agenda-skip-timestamp-if-deadline-is-shown
  5094. (assq (point) deadline-position-alist))
  5095. (throw :skip nil))
  5096. (let* ((category (org-get-category pos))
  5097. (inherited-tags
  5098. (or (eq org-agenda-show-inherited-tags 'always)
  5099. (and (consp org-agenda-show-inherited-tags)
  5100. (memq 'agenda org-agenda-show-inherited-tags))
  5101. (and (eq org-agenda-show-inherited-tags t)
  5102. (or (eq org-agenda-use-tag-inheritance t)
  5103. (memq 'agenda
  5104. org-agenda-use-tag-inheritance)))))
  5105. (tags (org-get-tags-at nil (not inherited-tags)))
  5106. (level (make-string (org-reduced-level (org-outline-level))
  5107. ?\s))
  5108. (head (and (looking-at "\\*+[ \t]+\\(.*\\)")
  5109. (match-string 1)))
  5110. (inactive? (= (char-after pos) ?\[))
  5111. (habit? (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  5112. (item
  5113. (org-agenda-format-item
  5114. (and inactive? org-agenda-inactive-leader)
  5115. head level category tags time-stamp org-ts-regexp habit?)))
  5116. (org-add-props item props
  5117. 'priority (if habit?
  5118. (org-habit-get-priority (org-habit-parse-todo))
  5119. (org-get-priority item))
  5120. 'org-marker (org-agenda-new-marker pos)
  5121. 'org-hd-marker (org-agenda-new-marker)
  5122. 'date date
  5123. 'level level
  5124. 'ts-date (if repeat (org-agenda--timestamp-to-absolute repeat)
  5125. current)
  5126. 'todo-state todo-state
  5127. 'warntime warntime
  5128. 'type "timestamp")
  5129. (push item timestamp-items))))
  5130. (when org-agenda-skip-additional-timestamps-same-entry
  5131. (outline-next-heading))))
  5132. (nreverse timestamp-items)))
  5133. (defun org-agenda-get-sexps ()
  5134. "Return the sexp information for agenda display."
  5135. (require 'diary-lib)
  5136. (let* ((props (list 'face 'org-agenda-calendar-sexp
  5137. 'mouse-face 'highlight
  5138. 'help-echo
  5139. (format "mouse-2 or RET jump to org file %s"
  5140. (abbreviate-file-name buffer-file-name))))
  5141. (regexp "^&?%%(")
  5142. marker category extra level ee txt tags entry
  5143. result beg b sexp sexp-entry todo-state warntime inherited-tags)
  5144. (goto-char (point-min))
  5145. (while (re-search-forward regexp nil t)
  5146. (catch :skip
  5147. (org-agenda-skip)
  5148. (setq beg (match-beginning 0))
  5149. (goto-char (1- (match-end 0)))
  5150. (setq b (point))
  5151. (forward-sexp 1)
  5152. (setq sexp (buffer-substring b (point)))
  5153. (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
  5154. (org-trim (match-string 1))
  5155. ""))
  5156. (setq result (org-diary-sexp-entry sexp sexp-entry date))
  5157. (when result
  5158. (setq marker (org-agenda-new-marker beg)
  5159. level (make-string (org-reduced-level (org-outline-level)) ? )
  5160. category (org-get-category beg)
  5161. inherited-tags
  5162. (or (eq org-agenda-show-inherited-tags 'always)
  5163. (and (listp org-agenda-show-inherited-tags)
  5164. (memq 'agenda org-agenda-show-inherited-tags))
  5165. (and (eq org-agenda-show-inherited-tags t)
  5166. (or (eq org-agenda-use-tag-inheritance t)
  5167. (memq 'agenda org-agenda-use-tag-inheritance))))
  5168. tags (org-get-tags-at nil (not inherited-tags))
  5169. todo-state (org-get-todo-state)
  5170. warntime (get-text-property (point) 'org-appt-warntime)
  5171. extra nil)
  5172. (dolist (r (if (stringp result)
  5173. (list result)
  5174. result)) ;; we expect a list here
  5175. (when (and org-agenda-diary-sexp-prefix
  5176. (string-match org-agenda-diary-sexp-prefix r))
  5177. (setq extra (match-string 0 r)
  5178. r (replace-match "" nil nil r)))
  5179. (if (string-match "\\S-" r)
  5180. (setq txt r)
  5181. (setq txt "SEXP entry returned empty string"))
  5182. (setq txt (org-agenda-format-item extra txt level category tags 'time))
  5183. (org-add-props txt props 'org-marker marker
  5184. 'date date 'todo-state todo-state
  5185. 'level level 'type "sexp" 'warntime warntime)
  5186. (push txt ee)))))
  5187. (nreverse ee)))
  5188. ;; Calendar sanity: define some functions that are independent of
  5189. ;; `calendar-date-style'.
  5190. (defun org-anniversary (year month day &optional mark)
  5191. "Like `diary-anniversary', but with fixed (ISO) order of arguments."
  5192. (with-no-warnings
  5193. (let ((calendar-date-style 'iso))
  5194. (diary-anniversary year month day mark))))
  5195. (defun org-cyclic (N year month day &optional mark)
  5196. "Like `diary-cyclic', but with fixed (ISO) order of arguments."
  5197. (with-no-warnings
  5198. (let ((calendar-date-style 'iso))
  5199. (diary-cyclic N year month day mark))))
  5200. (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
  5201. "Like `diary-block', but with fixed (ISO) order of arguments."
  5202. (with-no-warnings
  5203. (let ((calendar-date-style 'iso))
  5204. (diary-block Y1 M1 D1 Y2 M2 D2 mark))))
  5205. (defun org-date (year month day &optional mark)
  5206. "Like `diary-date', but with fixed (ISO) order of arguments."
  5207. (with-no-warnings
  5208. (let ((calendar-date-style 'iso))
  5209. (diary-date year month day mark))))
  5210. ;; Define the `org-class' function
  5211. (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
  5212. "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
  5213. DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
  5214. SKIP-WEEKS is any number of ISO weeks in the block period for which the
  5215. item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
  5216. `holidays', then any date that is known by the Emacs calendar to be a
  5217. holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
  5218. then those holidays will be skipped."
  5219. (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
  5220. (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
  5221. (d (calendar-absolute-from-gregorian date))
  5222. (h (when skip-weeks (calendar-check-holidays date))))
  5223. (and
  5224. (<= date1 d)
  5225. (<= d date2)
  5226. (= (calendar-day-of-week date) dayname)
  5227. (or (not skip-weeks)
  5228. (progn
  5229. (require 'cal-iso)
  5230. (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
  5231. (not (or (and h (memq 'holidays skip-weeks))
  5232. (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
  5233. entry)))
  5234. (defalias 'org-get-closed 'org-agenda-get-progress)
  5235. (defun org-agenda-get-progress ()
  5236. "Return the logged TODO entries for agenda display."
  5237. (let* ((props (list 'mouse-face 'highlight
  5238. 'org-not-done-regexp org-not-done-regexp
  5239. 'org-todo-regexp org-todo-regexp
  5240. 'org-complex-heading-regexp org-complex-heading-regexp
  5241. 'help-echo
  5242. (format "mouse-2 or RET jump to org file %s"
  5243. (abbreviate-file-name buffer-file-name))))
  5244. (items (if (consp org-agenda-show-log-scoped)
  5245. org-agenda-show-log-scoped
  5246. (if (eq org-agenda-show-log-scoped 'clockcheck)
  5247. '(clock)
  5248. org-agenda-log-mode-items)))
  5249. (parts
  5250. (delq nil
  5251. (list
  5252. (if (memq 'closed items) (concat "\\<" org-closed-string))
  5253. (if (memq 'clock items) (concat "\\<" org-clock-string))
  5254. (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
  5255. (parts-re (if parts (mapconcat 'identity parts "\\|")
  5256. (error "`org-agenda-log-mode-items' is empty")))
  5257. (regexp (concat
  5258. "\\(" parts-re "\\)"
  5259. " *\\["
  5260. (regexp-quote
  5261. (substring
  5262. (format-time-string
  5263. (car org-time-stamp-formats)
  5264. (apply 'encode-time ; DATE bound by calendar
  5265. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  5266. 1 11))))
  5267. (org-agenda-search-headline-for-time nil)
  5268. marker hdmarker priority category level tags closedp
  5269. statep clockp state ee txt extra timestr rest clocked inherited-tags)
  5270. (goto-char (point-min))
  5271. (while (re-search-forward regexp nil t)
  5272. (catch :skip
  5273. (org-agenda-skip)
  5274. (setq marker (org-agenda-new-marker (match-beginning 0))
  5275. closedp (equal (match-string 1) org-closed-string)
  5276. statep (equal (string-to-char (match-string 1)) ?-)
  5277. clockp (not (or closedp statep))
  5278. state (and statep (match-string 2))
  5279. category (org-get-category (match-beginning 0))
  5280. timestr (buffer-substring (match-beginning 0) (point-at-eol)))
  5281. (when (string-match "\\]" timestr)
  5282. ;; substring should only run to end of time stamp
  5283. (setq rest (substring timestr (match-end 0))
  5284. timestr (substring timestr 0 (match-end 0)))
  5285. (if (and (not closedp) (not statep)
  5286. (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
  5287. rest))
  5288. (progn (setq timestr (concat (substring timestr 0 -1)
  5289. "-" (match-string 1 rest) "]"))
  5290. (setq clocked (match-string 2 rest)))
  5291. (setq clocked "-")))
  5292. (save-excursion
  5293. (setq extra
  5294. (cond
  5295. ((not org-agenda-log-mode-add-notes) nil)
  5296. (statep
  5297. (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
  5298. (match-string 1)))
  5299. (clockp
  5300. (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
  5301. (match-string 1)))))
  5302. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5303. (throw :skip nil)
  5304. (goto-char (match-beginning 0))
  5305. (setq hdmarker (org-agenda-new-marker)
  5306. inherited-tags
  5307. (or (eq org-agenda-show-inherited-tags 'always)
  5308. (and (listp org-agenda-show-inherited-tags)
  5309. (memq 'todo org-agenda-show-inherited-tags))
  5310. (and (eq org-agenda-show-inherited-tags t)
  5311. (or (eq org-agenda-use-tag-inheritance t)
  5312. (memq 'todo org-agenda-use-tag-inheritance))))
  5313. tags (org-get-tags-at nil (not inherited-tags))
  5314. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5315. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5316. (setq txt (match-string 1))
  5317. (when extra
  5318. (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
  5319. (setq txt (concat (substring txt 0 (match-beginning 1))
  5320. " - " extra " " (match-string 2 txt)))
  5321. (setq txt (concat txt " - " extra))))
  5322. (setq txt (org-agenda-format-item
  5323. (cond
  5324. (closedp "Closed: ")
  5325. (statep (concat "State: (" state ")"))
  5326. (t (concat "Clocked: (" clocked ")")))
  5327. txt level category tags timestr)))
  5328. (setq priority 100000)
  5329. (org-add-props txt props
  5330. 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
  5331. 'priority priority 'level level
  5332. 'type "closed" 'date date
  5333. 'undone-face 'org-warning 'done-face 'org-agenda-done)
  5334. (push txt ee))
  5335. (goto-char (point-at-eol))))
  5336. (nreverse ee)))
  5337. (defun org-agenda-show-clocking-issues ()
  5338. "Add overlays, showing issues with clocking.
  5339. See also the user option `org-agenda-clock-consistency-checks'."
  5340. (interactive)
  5341. (let* ((pl org-agenda-clock-consistency-checks)
  5342. (re (concat "^[ \t]*"
  5343. org-clock-string
  5344. "[ \t]+"
  5345. "\\(\\[.*?\\]\\)" ; group 1 is first stamp
  5346. "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
  5347. (tlstart 0.)
  5348. (tlend 0.)
  5349. (maxtime (org-duration-to-minutes
  5350. (or (plist-get pl :max-duration) "24:00")))
  5351. (mintime (org-duration-to-minutes
  5352. (or (plist-get pl :min-duration) 0)))
  5353. (maxgap (org-duration-to-minutes
  5354. ;; default 30:00 means never complain
  5355. (or (plist-get pl :max-gap) "30:00")))
  5356. (gapok (mapcar #'org-duration-to-minutes
  5357. (plist-get pl :gap-ok-around)))
  5358. (def-face (or (plist-get pl :default-face)
  5359. '((:background "DarkRed") (:foreground "white"))))
  5360. issue face m te ts dt ov)
  5361. (goto-char (point-min))
  5362. (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
  5363. (setq issue nil face def-face)
  5364. (catch 'next
  5365. (setq m (org-get-at-bol 'org-marker)
  5366. te nil ts nil)
  5367. (unless (and m (markerp m))
  5368. (setq issue "No valid clock line") (throw 'next t))
  5369. (org-with-point-at m
  5370. (save-excursion
  5371. (goto-char (point-at-bol))
  5372. (unless (looking-at re)
  5373. (error "No valid Clock line")
  5374. (throw 'next t))
  5375. (unless (match-end 3)
  5376. (setq issue "No end time"
  5377. face (or (plist-get pl :no-end-time-face) face))
  5378. (throw 'next t))
  5379. (setq ts (match-string 1)
  5380. te (match-string 3)
  5381. ts (float-time
  5382. (apply #'encode-time (org-parse-time-string ts)))
  5383. te (float-time
  5384. (apply #'encode-time (org-parse-time-string te)))
  5385. dt (- te ts))))
  5386. (cond
  5387. ((> dt (* 60 maxtime))
  5388. ;; a very long clocking chunk
  5389. (setq issue (format "Clocking interval is very long: %s"
  5390. (org-duration-from-minutes (floor (/ dt 60.))))
  5391. face (or (plist-get pl :long-face) face)))
  5392. ((< dt (* 60 mintime))
  5393. ;; a very short clocking chunk
  5394. (setq issue (format "Clocking interval is very short: %s"
  5395. (org-duration-from-minutes (floor (/ dt 60.))))
  5396. face (or (plist-get pl :short-face) face)))
  5397. ((and (> tlend 0) (< ts tlend))
  5398. ;; Two clock entries are overlapping
  5399. (setq issue (format "Clocking overlap: %d minutes"
  5400. (/ (- tlend ts) 60))
  5401. face (or (plist-get pl :overlap-face) face)))
  5402. ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
  5403. ;; There is a gap, lets see if we need to report it
  5404. (unless (org-agenda-check-clock-gap tlend ts gapok)
  5405. (setq issue (format "Clocking gap: %d minutes"
  5406. (/ (- ts tlend) 60))
  5407. face (or (plist-get pl :gap-face) face))))
  5408. (t nil)))
  5409. (setq tlend (or te tlend) tlstart (or ts tlstart))
  5410. (when issue
  5411. ;; OK, there was some issue, add an overlay to show the issue
  5412. (setq ov (make-overlay (point-at-bol) (point-at-eol)))
  5413. (overlay-put ov 'before-string
  5414. (concat
  5415. (org-add-props
  5416. (format "%-43s" (concat " " issue))
  5417. nil
  5418. 'face face)
  5419. "\n"))
  5420. (overlay-put ov 'evaporate t)))))
  5421. (defun org-agenda-check-clock-gap (t1 t2 ok-list)
  5422. "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
  5423. (catch 'exit
  5424. (unless ok-list
  5425. ;; there are no OK times for gaps...
  5426. (throw 'exit nil))
  5427. (if (> (- (/ t2 36000) (/ t1 36000)) 24)
  5428. ;; This is more than 24 hours, so it is OK.
  5429. ;; because we have at least one OK time, that must be in the
  5430. ;; 24 hour interval.
  5431. (throw 'exit t))
  5432. ;; We have a shorter gap.
  5433. ;; Now we have to get the minute of the day when these times are
  5434. (let* ((t1dec (decode-time (seconds-to-time t1)))
  5435. (t2dec (decode-time (seconds-to-time t2)))
  5436. ;; compute the minute on the day
  5437. (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
  5438. (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
  5439. (when (< min2 min1)
  5440. ;; if min2 is smaller than min1, this means it is on the next day.
  5441. ;; Wrap it to after midnight.
  5442. (setq min2 (+ min2 1440)))
  5443. ;; Now check if any of the OK times is in the gap
  5444. (mapc (lambda (x)
  5445. ;; Wrap the time to after midnight if necessary
  5446. (if (< x min1) (setq x (+ x 1440)))
  5447. ;; Check if in interval
  5448. (and (<= min1 x) (>= min2 x) (throw 'exit t)))
  5449. ok-list)
  5450. ;; Nope, this gap is not OK
  5451. nil)))
  5452. (defun org-agenda-get-deadlines (&optional with-hour)
  5453. "Return the deadline information for agenda display.
  5454. When WITH-HOUR is non-nil, only return deadlines with an hour
  5455. specification like [h]h:mm."
  5456. (let* ((props (list 'mouse-face 'highlight
  5457. 'org-not-done-regexp org-not-done-regexp
  5458. 'org-todo-regexp org-todo-regexp
  5459. 'org-complex-heading-regexp org-complex-heading-regexp
  5460. 'help-echo
  5461. (format "mouse-2 or RET jump to org file %s"
  5462. (abbreviate-file-name buffer-file-name))))
  5463. (regexp (if with-hour
  5464. org-deadline-time-hour-regexp
  5465. org-deadline-time-regexp))
  5466. (today (org-today))
  5467. (today? (org-agenda-today-p date)) ; DATE bound by calendar.
  5468. (current (calendar-absolute-from-gregorian date))
  5469. deadline-items)
  5470. (goto-char (point-min))
  5471. (while (re-search-forward regexp nil t)
  5472. (catch :skip
  5473. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5474. (org-agenda-skip)
  5475. (let* ((s (match-string 1))
  5476. (pos (1- (match-beginning 1)))
  5477. (todo-state (save-match-data (org-get-todo-state)))
  5478. (done? (member todo-state org-done-keywords))
  5479. (sexp? (string-prefix-p "%%" s))
  5480. ;; DEADLINE is the deadline date for the entry. It is
  5481. ;; either the base date or the last repeat, according
  5482. ;; to `org-agenda-prefer-last-repeat'.
  5483. (deadline
  5484. (cond
  5485. (sexp? (org-agenda--timestamp-to-absolute s current))
  5486. ((or (eq org-agenda-prefer-last-repeat t)
  5487. (member todo-state org-agenda-prefer-last-repeat))
  5488. (org-agenda--timestamp-to-absolute
  5489. s today 'past (current-buffer) pos))
  5490. (t (org-agenda--timestamp-to-absolute s))))
  5491. ;; REPEAT is the future repeat closest from CURRENT,
  5492. ;; according to `org-agenda-show-future-repeats'. If
  5493. ;; the latter is nil, or if the time stamp has no
  5494. ;; repeat part, default to DEADLINE.
  5495. (repeat
  5496. (cond
  5497. (sexp? deadline)
  5498. ((<= current today) deadline)
  5499. ((not org-agenda-show-future-repeats) deadline)
  5500. (t
  5501. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5502. (1+ today)
  5503. current)))
  5504. (org-agenda--timestamp-to-absolute
  5505. s base 'future (current-buffer) pos)))))
  5506. (diff (- deadline current))
  5507. (suppress-prewarning
  5508. (let ((scheduled
  5509. (and org-agenda-skip-deadline-prewarning-if-scheduled
  5510. (org-entry-get nil "SCHEDULED"))))
  5511. (cond
  5512. ((not scheduled) nil)
  5513. ;; The current item has a scheduled date, so
  5514. ;; evaluate its prewarning lead time.
  5515. ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
  5516. ;; Use global prewarning-restart lead time.
  5517. org-agenda-skip-deadline-prewarning-if-scheduled)
  5518. ((eq org-agenda-skip-deadline-prewarning-if-scheduled
  5519. 'pre-scheduled)
  5520. ;; Set pre-warning to no earlier than SCHEDULED.
  5521. (min (- deadline
  5522. (org-agenda--timestamp-to-absolute scheduled))
  5523. org-deadline-warning-days))
  5524. ;; Set pre-warning to deadline.
  5525. (t 0))))
  5526. (wdays (if suppress-prewarning
  5527. (let ((org-deadline-warning-days suppress-prewarning))
  5528. (org-get-wdays s))
  5529. (org-get-wdays s))))
  5530. (cond
  5531. ;; Only display deadlines at their base date, at future
  5532. ;; repeat occurrences or in today agenda.
  5533. ((= current deadline) nil)
  5534. ((= current repeat) nil)
  5535. ((not today?) (throw :skip nil))
  5536. ;; Upcoming deadline: display within warning period WDAYS.
  5537. ((> deadline current) (when (> diff wdays) (throw :skip nil)))
  5538. ;; Overdue deadline: warn about it for
  5539. ;; `org-deadline-past-days' duration.
  5540. (t (when (< org-deadline-past-days (- diff)) (throw :skip nil))))
  5541. ;; Possibly skip done tasks.
  5542. (when (and done?
  5543. (or org-agenda-skip-deadline-if-done
  5544. (/= deadline current)))
  5545. (throw :skip nil))
  5546. (save-excursion
  5547. (re-search-backward "^\\*+[ \t]+" nil t)
  5548. (goto-char (match-end 0))
  5549. (let* ((category (org-get-category))
  5550. (level (make-string (org-reduced-level (org-outline-level))
  5551. ?\s))
  5552. (head (buffer-substring (point) (line-end-position)))
  5553. (inherited-tags
  5554. (or (eq org-agenda-show-inherited-tags 'always)
  5555. (and (listp org-agenda-show-inherited-tags)
  5556. (memq 'agenda org-agenda-show-inherited-tags))
  5557. (and (eq org-agenda-show-inherited-tags t)
  5558. (or (eq org-agenda-use-tag-inheritance t)
  5559. (memq 'agenda
  5560. org-agenda-use-tag-inheritance)))))
  5561. (tags (org-get-tags-at nil (not inherited-tags)))
  5562. (time
  5563. (cond
  5564. ;; No time of day designation if it is only
  5565. ;; a reminder.
  5566. ((and (/= current deadline) (/= current repeat)) nil)
  5567. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5568. (concat (substring s (match-beginning 1)) " "))
  5569. (t 'time)))
  5570. (item
  5571. (org-agenda-format-item
  5572. ;; Insert appropriate suffixes before deadlines.
  5573. ;; Those only apply to today agenda.
  5574. (pcase-let ((`(,now ,future ,past)
  5575. org-agenda-deadline-leaders))
  5576. (cond
  5577. ((and today? (< deadline today)) (format past (- diff)))
  5578. ((and today? (> deadline today)) (format future diff))
  5579. (t now)))
  5580. head level category tags time))
  5581. (face (org-agenda-deadline-face
  5582. (- 1 (/ (float diff) (max wdays 1)))))
  5583. (upcoming? (and today? (> deadline today)))
  5584. (warntime (get-text-property (point) 'org-appt-warntime)))
  5585. (org-add-props item props
  5586. 'org-marker (org-agenda-new-marker pos)
  5587. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  5588. 'warntime warntime
  5589. 'level level
  5590. 'ts-date deadline
  5591. 'priority
  5592. ;; Adjust priority to today reminders about deadlines.
  5593. ;; Overdue deadlines get the highest priority
  5594. ;; increase, then imminent deadlines and eventually
  5595. ;; more distant deadlines.
  5596. (let ((adjust (if today? (- diff) 0)))
  5597. (+ adjust (org-get-priority item)))
  5598. 'todo-state todo-state
  5599. 'type (if upcoming? "upcoming-deadline" "deadline")
  5600. 'date (if upcoming? date deadline)
  5601. 'face (if done? 'org-agenda-done face)
  5602. 'undone-face face
  5603. 'done-face 'org-agenda-done)
  5604. (push item deadline-items))))))
  5605. (nreverse deadline-items)))
  5606. (defun org-agenda-deadline-face (fraction)
  5607. "Return the face to displaying a deadline item.
  5608. FRACTION is what fraction of the head-warning time has passed."
  5609. (assoc-default fraction org-agenda-deadline-faces #'<=))
  5610. (defun org-agenda-get-scheduled (&optional deadlines with-hour)
  5611. "Return the scheduled information for agenda display.
  5612. Optional argument DEADLINES is a list of deadline items to be
  5613. displayed in agenda view. When WITH-HOUR is non-nil, only return
  5614. scheduled items with an hour specification like [h]h:mm."
  5615. (let* ((props (list 'org-not-done-regexp org-not-done-regexp
  5616. 'org-todo-regexp org-todo-regexp
  5617. 'org-complex-heading-regexp org-complex-heading-regexp
  5618. 'done-face 'org-agenda-done
  5619. 'mouse-face 'highlight
  5620. 'help-echo
  5621. (format "mouse-2 or RET jump to Org file %s"
  5622. (abbreviate-file-name buffer-file-name))))
  5623. (regexp (if with-hour
  5624. org-scheduled-time-hour-regexp
  5625. org-scheduled-time-regexp))
  5626. (today (org-today))
  5627. (todayp (org-agenda-today-p date)) ; DATE bound by calendar.
  5628. (current (calendar-absolute-from-gregorian date))
  5629. (deadline-pos
  5630. (mapcar (lambda (d)
  5631. (let ((m (get-text-property 0 'org-hd-marker d)))
  5632. (and m (marker-position m))))
  5633. deadlines))
  5634. scheduled-items)
  5635. (goto-char (point-min))
  5636. (while (re-search-forward regexp nil t)
  5637. (catch :skip
  5638. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5639. (org-agenda-skip)
  5640. (let* ((s (match-string 1))
  5641. (pos (1- (match-beginning 1)))
  5642. (todo-state (save-match-data (org-get-todo-state)))
  5643. (donep (member todo-state org-done-keywords))
  5644. (sexp? (string-prefix-p "%%" s))
  5645. ;; SCHEDULE is the scheduled date for the entry. It is
  5646. ;; either the bare date or the last repeat, according
  5647. ;; to `org-agenda-prefer-last-repeat'.
  5648. (schedule
  5649. (cond
  5650. (sexp? (org-agenda--timestamp-to-absolute s current))
  5651. ((or (eq org-agenda-prefer-last-repeat t)
  5652. (member todo-state org-agenda-prefer-last-repeat))
  5653. (org-agenda--timestamp-to-absolute
  5654. s today 'past (current-buffer) pos))
  5655. (t (org-agenda--timestamp-to-absolute s))))
  5656. ;; REPEAT is the future repeat closest from CURRENT,
  5657. ;; according to `org-agenda-show-future-repeats'. If
  5658. ;; the latter is nil, or if the time stamp has no
  5659. ;; repeat part, default to SCHEDULE.
  5660. (repeat
  5661. (cond
  5662. (sexp? schedule)
  5663. ((<= current today) schedule)
  5664. ((not org-agenda-show-future-repeats) schedule)
  5665. (t
  5666. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5667. (1+ today)
  5668. current)))
  5669. (org-agenda--timestamp-to-absolute
  5670. s base 'future (current-buffer) pos)))))
  5671. (diff (- current schedule))
  5672. (warntime (get-text-property (point) 'org-appt-warntime))
  5673. (pastschedp (< schedule today))
  5674. (habitp (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  5675. (suppress-delay
  5676. (let ((deadline (and org-agenda-skip-scheduled-delay-if-deadline
  5677. (org-entry-get nil "DEADLINE"))))
  5678. (cond
  5679. ((not deadline) nil)
  5680. ;; The current item has a deadline date, so
  5681. ;; evaluate its delay time.
  5682. ((integerp org-agenda-skip-scheduled-delay-if-deadline)
  5683. ;; Use global delay time.
  5684. (- org-agenda-skip-scheduled-delay-if-deadline))
  5685. ((eq org-agenda-skip-scheduled-delay-if-deadline
  5686. 'post-deadline)
  5687. ;; Set delay to no later than DEADLINE.
  5688. (min (- schedule
  5689. (org-agenda--timestamp-to-absolute deadline))
  5690. org-scheduled-delay-days))
  5691. (t 0))))
  5692. (ddays
  5693. (cond
  5694. ;; Nullify delay when a repeater triggered already
  5695. ;; and the delay is of the form --Xd.
  5696. ((and (string-match-p "--[0-9]+[hdwmy]" s)
  5697. (> current schedule))
  5698. 0)
  5699. (suppress-delay
  5700. (let ((org-scheduled-delay-days suppress-delay))
  5701. (org-get-wdays s t t)))
  5702. (t (org-get-wdays s t)))))
  5703. ;; Display scheduled items at base date (SCHEDULE), today if
  5704. ;; scheduled before the current date, and at any repeat past
  5705. ;; today. However, skip delayed items and items that have
  5706. ;; been displayed for more than `org-scheduled-past-days'.
  5707. (unless (and todayp
  5708. habitp
  5709. (bound-and-true-p org-habit-show-all-today))
  5710. (when (or (and (> ddays 0) (< diff ddays))
  5711. (> diff org-scheduled-past-days)
  5712. (> schedule current)
  5713. (and (/= current schedule)
  5714. (/= current today)
  5715. (/= current repeat)))
  5716. (throw :skip nil)))
  5717. ;; Possibly skip done tasks.
  5718. (when (and donep
  5719. (or org-agenda-skip-scheduled-if-done
  5720. (/= schedule current)))
  5721. (throw :skip nil))
  5722. ;; Skip entry if it already appears as a deadline, per
  5723. ;; `org-agenda-skip-scheduled-if-deadline-is-shown'. This
  5724. ;; doesn't apply to habits.
  5725. (when (pcase org-agenda-skip-scheduled-if-deadline-is-shown
  5726. ((guard
  5727. (or (not (memq (line-beginning-position 0) deadline-pos))
  5728. habitp))
  5729. nil)
  5730. (`repeated-after-deadline
  5731. (let ((deadline (time-to-days
  5732. (org-get-deadline-time (point)))))
  5733. (and (<= schedule deadline) (> current deadline))))
  5734. (`not-today pastschedp)
  5735. (`t t)
  5736. (_ nil))
  5737. (throw :skip nil))
  5738. ;; Skip habits if `org-habit-show-habits' is nil, or if we
  5739. ;; only show them for today. Also skip done habits.
  5740. (when (and habitp
  5741. (or donep
  5742. (not (bound-and-true-p org-habit-show-habits))
  5743. (and (not todayp)
  5744. (bound-and-true-p
  5745. org-habit-show-habits-only-for-today))))
  5746. (throw :skip nil))
  5747. (save-excursion
  5748. (re-search-backward "^\\*+[ \t]+" nil t)
  5749. (goto-char (match-end 0))
  5750. (let* ((category (org-get-category))
  5751. (inherited-tags
  5752. (or (eq org-agenda-show-inherited-tags 'always)
  5753. (and (listp org-agenda-show-inherited-tags)
  5754. (memq 'agenda org-agenda-show-inherited-tags))
  5755. (and (eq org-agenda-show-inherited-tags t)
  5756. (or (eq org-agenda-use-tag-inheritance t)
  5757. (memq 'agenda
  5758. org-agenda-use-tag-inheritance)))))
  5759. (tags (org-get-tags-at nil (not inherited-tags)))
  5760. (level (make-string (org-reduced-level (org-outline-level))
  5761. ?\s))
  5762. (head (buffer-substring (point) (line-end-position)))
  5763. (time
  5764. (cond
  5765. ;; No time of day designation if it is only
  5766. ;; a reminder.
  5767. ((and (/= current schedule) (/= current repeat)) nil)
  5768. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5769. (concat (substring s (match-beginning 1)) " "))
  5770. (t 'time)))
  5771. (item
  5772. (org-agenda-format-item
  5773. (pcase-let ((`(,first ,past) org-agenda-scheduled-leaders))
  5774. ;; Show a reminder of a past scheduled today.
  5775. (if (and todayp pastschedp)
  5776. (format past diff)
  5777. first))
  5778. head level category tags time nil habitp))
  5779. (face (cond ((and (not habitp) pastschedp)
  5780. 'org-scheduled-previously)
  5781. (todayp 'org-scheduled-today)
  5782. (t 'org-scheduled)))
  5783. (habitp (and habitp (org-habit-parse-todo))))
  5784. (org-add-props item props
  5785. 'undone-face face
  5786. 'face (if donep 'org-agenda-done face)
  5787. 'org-marker (org-agenda-new-marker pos)
  5788. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  5789. 'type (if pastschedp "past-scheduled" "scheduled")
  5790. 'date (if pastschedp schedule date)
  5791. 'ts-date schedule
  5792. 'warntime warntime
  5793. 'level level
  5794. 'priority (if habitp (org-habit-get-priority habitp)
  5795. (+ 99 diff (org-get-priority item)))
  5796. 'org-habit-p habitp
  5797. 'todo-state todo-state)
  5798. (push item scheduled-items))))))
  5799. (nreverse scheduled-items)))
  5800. (defun org-agenda-get-blocks ()
  5801. "Return the date-range information for agenda display."
  5802. (let* ((props (list 'face nil
  5803. 'org-not-done-regexp org-not-done-regexp
  5804. 'org-todo-regexp org-todo-regexp
  5805. 'org-complex-heading-regexp org-complex-heading-regexp
  5806. 'mouse-face 'highlight
  5807. 'help-echo
  5808. (format "mouse-2 or RET jump to org file %s"
  5809. (abbreviate-file-name buffer-file-name))))
  5810. (regexp org-tr-regexp)
  5811. (d0 (calendar-absolute-from-gregorian date))
  5812. marker hdmarker ee txt d1 d2 s1 s2 category
  5813. level todo-state tags pos head donep inherited-tags)
  5814. (goto-char (point-min))
  5815. (while (re-search-forward regexp nil t)
  5816. (catch :skip
  5817. (org-agenda-skip)
  5818. (setq pos (point))
  5819. (let ((start-time (match-string 1))
  5820. (end-time (match-string 2)))
  5821. (setq s1 (match-string 1)
  5822. s2 (match-string 2)
  5823. d1 (time-to-days (org-time-string-to-time s1 (current-buffer) pos))
  5824. d2 (time-to-days (org-time-string-to-time s2 (current-buffer) pos)))
  5825. (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
  5826. ;; Only allow days between the limits, because the normal
  5827. ;; date stamps will catch the limits.
  5828. (save-excursion
  5829. (setq todo-state (org-get-todo-state))
  5830. (setq donep (member todo-state org-done-keywords))
  5831. (if (and donep org-agenda-skip-timestamp-if-done)
  5832. (throw :skip t))
  5833. (setq marker (org-agenda-new-marker (point))
  5834. category (org-get-category))
  5835. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5836. (throw :skip nil)
  5837. (goto-char (match-beginning 0))
  5838. (setq hdmarker (org-agenda-new-marker (point))
  5839. inherited-tags
  5840. (or (eq org-agenda-show-inherited-tags 'always)
  5841. (and (listp org-agenda-show-inherited-tags)
  5842. (memq 'agenda org-agenda-show-inherited-tags))
  5843. (and (eq org-agenda-show-inherited-tags t)
  5844. (or (eq org-agenda-use-tag-inheritance t)
  5845. (memq 'agenda org-agenda-use-tag-inheritance))))
  5846. tags (org-get-tags-at nil (not inherited-tags)))
  5847. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  5848. (looking-at "\\*+[ \t]+\\(.*\\)")
  5849. (setq head (match-string 1))
  5850. (let ((remove-re
  5851. (if org-agenda-remove-timeranges-from-blocks
  5852. (concat
  5853. "<" (regexp-quote s1) ".*?>"
  5854. "--"
  5855. "<" (regexp-quote s2) ".*?>")
  5856. nil)))
  5857. (setq txt (org-agenda-format-item
  5858. (format
  5859. (nth (if (= d1 d2) 0 1)
  5860. org-agenda-timerange-leaders)
  5861. (1+ (- d0 d1)) (1+ (- d2 d1)))
  5862. head level category tags
  5863. (cond ((and (= d1 d0) (= d2 d0))
  5864. (concat "<" start-time ">--<" end-time ">"))
  5865. ((= d1 d0)
  5866. (concat "<" start-time ">"))
  5867. ((= d2 d0)
  5868. (concat "<" end-time ">")))
  5869. remove-re))))
  5870. (org-add-props txt props
  5871. 'org-marker marker 'org-hd-marker hdmarker
  5872. 'type "block" 'date date
  5873. 'level level
  5874. 'todo-state todo-state
  5875. 'priority (org-get-priority txt))
  5876. (push txt ee))))
  5877. (goto-char pos)))
  5878. ;; Sort the entries by expiration date.
  5879. (nreverse ee)))
  5880. ;;; Agenda presentation and sorting
  5881. (defvar org-prefix-has-time nil
  5882. "A flag, set by `org-compile-prefix-format'.
  5883. The flag is set if the currently compiled format contains a `%t'.")
  5884. (defvar org-prefix-has-tag nil
  5885. "A flag, set by `org-compile-prefix-format'.
  5886. The flag is set if the currently compiled format contains a `%T'.")
  5887. (defvar org-prefix-has-effort nil
  5888. "A flag, set by `org-compile-prefix-format'.
  5889. The flag is set if the currently compiled format contains a `%e'.")
  5890. (defvar org-prefix-has-breadcrumbs nil
  5891. "A flag, set by `org-compile-prefix-format'.
  5892. The flag is set if the currently compiled format contains a `%b'.")
  5893. (defvar org-prefix-category-length nil
  5894. "Used by `org-compile-prefix-format' to remember the category field width.")
  5895. (defvar org-prefix-category-max-length nil
  5896. "Used by `org-compile-prefix-format' to remember the category field width.")
  5897. (defun org-agenda-get-category-icon (category)
  5898. "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
  5899. (cl-dolist (entry org-agenda-category-icon-alist)
  5900. (when (string-match-p (car entry) category)
  5901. (if (listp (cadr entry))
  5902. (cl-return (cadr entry))
  5903. (cl-return (apply #'create-image (cdr entry)))))))
  5904. (defun org-agenda-format-item (extra txt &optional level category tags dotime
  5905. remove-re habitp)
  5906. "Format TXT to be inserted into the agenda buffer.
  5907. In particular, add the prefix and corresponding text properties.
  5908. EXTRA must be a string to replace the `%s' specifier in the prefix format.
  5909. LEVEL may be a string to replace the `%l' specifier.
  5910. CATEGORY (a string, a symbol or nil) may be used to overrule the default
  5911. category taken from local variable or file name. It will replace the `%c'
  5912. specifier in the format.
  5913. DOTIME, when non-nil, indicates that a time-of-day should be extracted from
  5914. TXT for sorting of this entry, and for the `%t' specifier in the format.
  5915. When DOTIME is a string, this string is searched for a time before TXT is.
  5916. TAGS can be the tags of the headline.
  5917. Any match of REMOVE-RE will be removed from TXT."
  5918. ;; We keep the org-prefix-* variable values along with a compiled
  5919. ;; formatter, so that multiple agendas existing at the same time do
  5920. ;; not step on each other toes.
  5921. ;;
  5922. ;; It was inconvenient to make these variables buffer local in
  5923. ;; Agenda buffers, because this function expects to be called with
  5924. ;; the buffer where item comes from being current, and not agenda
  5925. ;; buffer
  5926. (let* ((bindings (car org-prefix-format-compiled))
  5927. (formatter (cadr org-prefix-format-compiled)))
  5928. (cl-loop for (var value) in bindings
  5929. do (set var value))
  5930. (save-match-data
  5931. ;; Diary entries sometimes have extra whitespace at the beginning
  5932. (setq txt (org-trim txt))
  5933. ;; Fix the tags part in txt
  5934. (setq txt (org-agenda-fix-displayed-tags
  5935. txt tags
  5936. org-agenda-show-inherited-tags
  5937. org-agenda-hide-tags-regexp))
  5938. (let* ((category (or category
  5939. (if buffer-file-name
  5940. (file-name-sans-extension
  5941. (file-name-nondirectory buffer-file-name))
  5942. "")))
  5943. (category-icon (org-agenda-get-category-icon category))
  5944. (category-icon (if category-icon
  5945. (propertize " " 'display category-icon)
  5946. ""))
  5947. (effort (and (not (string= txt ""))
  5948. (get-text-property 1 'effort txt)))
  5949. ;; time, tag, effort are needed for the eval of the prefix format
  5950. (tag (if tags (nth (1- (length tags)) tags) ""))
  5951. time
  5952. (ts (if dotime (concat
  5953. (if (stringp dotime) dotime "")
  5954. (and org-agenda-search-headline-for-time txt))))
  5955. (time-of-day (and dotime (org-get-time-of-day ts)))
  5956. stamp plain s0 s1 s2 rtn srp l
  5957. duration breadcrumbs)
  5958. (and (derived-mode-p 'org-mode) buffer-file-name
  5959. (add-to-list 'org-agenda-contributing-files buffer-file-name))
  5960. (when (and dotime time-of-day)
  5961. ;; Extract starting and ending time and move them to prefix
  5962. (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
  5963. (setq plain (string-match org-plain-time-of-day-regexp ts)))
  5964. (setq s0 (match-string 0 ts)
  5965. srp (and stamp (match-end 3))
  5966. s1 (match-string (if plain 1 2) ts)
  5967. s2 (match-string (if plain 8 (if srp 4 6)) ts))
  5968. ;; If the times are in TXT (not in DOTIMES), and the prefix will list
  5969. ;; them, we might want to remove them there to avoid duplication.
  5970. ;; The user can turn this off with a variable.
  5971. (if (and org-prefix-has-time
  5972. org-agenda-remove-times-when-in-prefix (or stamp plain)
  5973. (string-match (concat (regexp-quote s0) " *") txt)
  5974. (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
  5975. (if (eq org-agenda-remove-times-when-in-prefix 'beg)
  5976. (= (match-beginning 0) 0)
  5977. t))
  5978. (setq txt (replace-match "" nil nil txt))))
  5979. ;; Normalize the time(s) to 24 hour
  5980. (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
  5981. (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
  5982. ;; Try to set s2 if s1 and
  5983. ;; `org-agenda-default-appointment-duration' are set
  5984. (when (and s1 (not s2) org-agenda-default-appointment-duration)
  5985. (setq s2
  5986. (org-duration-from-minutes
  5987. (+ (org-duration-to-minutes s1 t)
  5988. org-agenda-default-appointment-duration)
  5989. nil t)))
  5990. ;; Compute the duration
  5991. (when s2
  5992. (setq duration (- (org-duration-to-minutes s2)
  5993. (org-duration-to-minutes s1)))))
  5994. (when (string-match "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$" txt)
  5995. ;; Tags are in the string
  5996. (if (or (eq org-agenda-remove-tags t)
  5997. (and org-agenda-remove-tags
  5998. org-prefix-has-tag))
  5999. (setq txt (replace-match "" t t txt))
  6000. (setq txt (replace-match
  6001. (concat (make-string (max (- 50 (length txt)) 1) ?\ )
  6002. (match-string 2 txt))
  6003. t t txt))))
  6004. (when remove-re
  6005. (while (string-match remove-re txt)
  6006. (setq txt (replace-match "" t t txt))))
  6007. ;; Set org-heading property on `txt' to mark the start of the
  6008. ;; heading.
  6009. (add-text-properties 0 (length txt) '(org-heading t) txt)
  6010. ;; Prepare the variables needed in the eval of the compiled format
  6011. (if org-prefix-has-breadcrumbs
  6012. (setq breadcrumbs (org-with-point-at (org-get-at-bol 'org-marker)
  6013. (let ((s (org-display-outline-path nil nil "->" t)))
  6014. (if (eq "" s) "" (concat s "->"))))))
  6015. (setq time (cond (s2 (concat
  6016. (org-agenda-time-of-day-to-ampm-maybe s1)
  6017. "-" (org-agenda-time-of-day-to-ampm-maybe s2)
  6018. (if org-agenda-timegrid-use-ampm " ")))
  6019. (s1 (concat
  6020. (org-agenda-time-of-day-to-ampm-maybe s1)
  6021. (if org-agenda-timegrid-use-ampm
  6022. "........ "
  6023. "......")))
  6024. (t ""))
  6025. extra (or (and (not habitp) extra) "")
  6026. category (if (symbolp category) (symbol-name category) category)
  6027. level (or level ""))
  6028. (if (string-match org-bracket-link-regexp category)
  6029. (progn
  6030. (setq l (if (match-end 3)
  6031. (- (match-end 3) (match-beginning 3))
  6032. (- (match-end 1) (match-beginning 1))))
  6033. (when (< l (or org-prefix-category-length 0))
  6034. (setq category (copy-sequence category))
  6035. (org-add-props category nil
  6036. 'extra-space (make-string
  6037. (- org-prefix-category-length l 1) ?\ ))))
  6038. (if (and org-prefix-category-max-length
  6039. (>= (length category) org-prefix-category-max-length))
  6040. (setq category (substring category 0 (1- org-prefix-category-max-length)))))
  6041. ;; Evaluate the compiled format
  6042. (setq rtn (concat (eval formatter) txt))
  6043. ;; And finally add the text properties
  6044. (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
  6045. (org-add-props rtn nil
  6046. 'org-category category
  6047. 'tags (mapcar 'org-downcase-keep-props tags)
  6048. 'org-highest-priority org-highest-priority
  6049. 'org-lowest-priority org-lowest-priority
  6050. 'time-of-day time-of-day
  6051. 'duration duration
  6052. 'breadcrumbs breadcrumbs
  6053. 'txt txt
  6054. 'level level
  6055. 'time time
  6056. 'extra extra
  6057. 'format org-prefix-format-compiled
  6058. 'dotime dotime)))))
  6059. (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
  6060. "Remove tags string from TXT, and add a modified list of tags.
  6061. The modified list may contain inherited tags, and tags matched by
  6062. `org-agenda-hide-tags-regexp' will be removed."
  6063. (when (or add-inherited hide-re)
  6064. (if (string-match "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$" txt)
  6065. (setq txt (substring txt 0 (match-beginning 0))))
  6066. (setq tags
  6067. (delq nil
  6068. (mapcar (lambda (tg)
  6069. (if (or (and hide-re (string-match hide-re tg))
  6070. (and (not add-inherited)
  6071. (get-text-property 0 'inherited tg)))
  6072. nil
  6073. tg))
  6074. tags)))
  6075. (when tags
  6076. (let ((have-i (get-text-property 0 'inherited (car tags)))
  6077. i)
  6078. (setq txt (concat txt " :"
  6079. (mapconcat
  6080. (lambda (x)
  6081. (setq i (get-text-property 0 'inherited x))
  6082. (if (and have-i (not i))
  6083. (progn
  6084. (setq have-i nil)
  6085. (concat ":" x))
  6086. x))
  6087. tags ":")
  6088. (if have-i "::" ":"))))))
  6089. txt)
  6090. (defun org-downcase-keep-props (s)
  6091. (let ((props (text-properties-at 0 s)))
  6092. (setq s (downcase s))
  6093. (add-text-properties 0 (length s) props s)
  6094. s))
  6095. (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
  6096. (defun org-agenda-add-time-grid-maybe (list ndays todayp)
  6097. "Add a time-grid for agenda items which need it.
  6098. LIST is the list of agenda items formatted by `org-agenda-list'.
  6099. NDAYS is the span of the current agenda view.
  6100. TODAYP is t when the current agenda view is on today."
  6101. (catch 'exit
  6102. (cond ((not org-agenda-use-time-grid) (throw 'exit list))
  6103. ((and todayp (member 'today (car org-agenda-time-grid))))
  6104. ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
  6105. ((member 'weekly (car org-agenda-time-grid)))
  6106. (t (throw 'exit list)))
  6107. (let* ((have (delq nil (mapcar
  6108. (lambda (x) (get-text-property 1 'time-of-day x))
  6109. list)))
  6110. (string (nth 1 org-agenda-time-grid))
  6111. (gridtimes (nth 2 org-agenda-time-grid))
  6112. (req (car org-agenda-time-grid))
  6113. (remove (member 'remove-match req))
  6114. new time)
  6115. (if (and (member 'require-timed req) (not have))
  6116. ;; don't show empty grid
  6117. (throw 'exit list))
  6118. (while (setq time (pop gridtimes))
  6119. (unless (and remove (member time have))
  6120. (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
  6121. (push (org-agenda-format-item
  6122. nil string nil "" nil
  6123. (concat (substring time 0 -2) ":" (substring time -2)))
  6124. new)
  6125. (put-text-property
  6126. 2 (length (car new)) 'face 'org-time-grid (car new))))
  6127. (when (and todayp org-agenda-show-current-time-in-grid)
  6128. (push (org-agenda-format-item
  6129. nil org-agenda-current-time-string nil "" nil
  6130. (format-time-string "%H:%M "))
  6131. new)
  6132. (put-text-property
  6133. 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
  6134. (if (member 'time-up org-agenda-sorting-strategy-selected)
  6135. (append new list)
  6136. (append list new)))))
  6137. (defun org-compile-prefix-format (key)
  6138. "Compile the prefix format into a Lisp form that can be evaluated.
  6139. The resulting form and associated variable bindings is returned
  6140. and stored in the variable `org-prefix-format-compiled'."
  6141. (setq org-prefix-has-time nil
  6142. org-prefix-has-tag nil
  6143. org-prefix-category-length nil
  6144. org-prefix-has-effort nil
  6145. org-prefix-has-breadcrumbs nil)
  6146. (let ((s (cond
  6147. ((stringp org-agenda-prefix-format)
  6148. org-agenda-prefix-format)
  6149. ((assq key org-agenda-prefix-format)
  6150. (cdr (assq key org-agenda-prefix-format)))
  6151. (t " %-12:c%?-12t% s")))
  6152. (start 0)
  6153. varform vars var e c f opt)
  6154. (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cltseib]\\|(.+)\\)"
  6155. s start)
  6156. (setq var (or (cdr (assoc (match-string 4 s)
  6157. '(("c" . category) ("t" . time) ("l" . level) ("s" . extra)
  6158. ("i" . category-icon) ("T" . tag) ("e" . effort) ("b" . breadcrumbs))))
  6159. 'eval)
  6160. c (or (match-string 3 s) "")
  6161. opt (match-beginning 1)
  6162. start (1+ (match-beginning 0)))
  6163. (if (eq var 'time) (setq org-prefix-has-time t))
  6164. (if (eq var 'tag) (setq org-prefix-has-tag t))
  6165. (if (eq var 'effort) (setq org-prefix-has-effort t))
  6166. (if (eq var 'breadcrumbs) (setq org-prefix-has-breadcrumbs t))
  6167. (setq f (concat "%" (match-string 2 s) "s"))
  6168. (when (eq var 'category)
  6169. (setq org-prefix-category-length
  6170. (floor (abs (string-to-number (match-string 2 s)))))
  6171. (setq org-prefix-category-max-length
  6172. (let ((x (match-string 2 s)))
  6173. (save-match-data
  6174. (if (string-match "\\.[0-9]+" x)
  6175. (string-to-number (substring (match-string 0 x) 1)))))))
  6176. (if (eq var 'eval)
  6177. (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
  6178. (if opt
  6179. (setq varform
  6180. `(if (or (equal "" ,var) (equal nil ,var))
  6181. ""
  6182. (format ,f (concat ,var ,c))))
  6183. (setq varform
  6184. `(format ,f (if (or (equal ,var "")
  6185. (equal ,var nil)) ""
  6186. (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
  6187. (setq s (replace-match "%s" t nil s))
  6188. (push varform vars))
  6189. (setq vars (nreverse vars))
  6190. (with-current-buffer (or org-agenda-buffer (current-buffer))
  6191. (setq org-prefix-format-compiled
  6192. (list
  6193. `((org-prefix-has-time ,org-prefix-has-time)
  6194. (org-prefix-has-tag ,org-prefix-has-tag)
  6195. (org-prefix-category-length ,org-prefix-category-length)
  6196. (org-prefix-has-effort ,org-prefix-has-effort)
  6197. (org-prefix-has-breadcrumbs ,org-prefix-has-breadcrumbs))
  6198. `(format ,s ,@vars))))))
  6199. (defun org-set-sorting-strategy (key)
  6200. (if (symbolp (car org-agenda-sorting-strategy))
  6201. ;; the old format
  6202. (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
  6203. (setq org-agenda-sorting-strategy-selected
  6204. (or (cdr (assq key org-agenda-sorting-strategy))
  6205. (cdr (assq 'agenda org-agenda-sorting-strategy))
  6206. '(time-up category-keep priority-down)))))
  6207. (defun org-get-time-of-day (s &optional string mod24)
  6208. "Check string S for a time of day.
  6209. If found, return it as a military time number between 0 and 2400.
  6210. If not found, return nil.
  6211. The optional STRING argument forces conversion into a 5 character wide string
  6212. HH:MM."
  6213. (save-match-data
  6214. (when
  6215. (and
  6216. (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
  6217. (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
  6218. (not (eq (get-text-property 1 'face s) 'org-link)))
  6219. (let* ((h (string-to-number (match-string 1 s)))
  6220. (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
  6221. (ampm (if (match-end 4) (downcase (match-string 4 s))))
  6222. (am-p (equal ampm "am"))
  6223. (h1 (cond ((not ampm) h)
  6224. ((= h 12) (if am-p 0 12))
  6225. (t (+ h (if am-p 0 12)))))
  6226. (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
  6227. (mod h1 24) h1))
  6228. (t0 (+ (* 100 h2) m))
  6229. (t1 (concat (if (>= h1 24) "+" " ")
  6230. (if (and org-agenda-time-leading-zero
  6231. (< t0 1000)) "0" "")
  6232. (if (< t0 100) "0" "")
  6233. (if (< t0 10) "0" "")
  6234. (int-to-string t0))))
  6235. (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
  6236. (defvar org-agenda-before-sorting-filter-function nil
  6237. "Function to be applied to agenda items prior to sorting.
  6238. Prior to sorting also means just before they are inserted into the agenda.
  6239. To aid sorting, you may revisit the original entries and add more text
  6240. properties which will later be used by the sorting functions.
  6241. The function should take a string argument, an agenda line.
  6242. It has access to the text properties in that line, which contain among
  6243. other things, the property `org-hd-marker' that points to the entry
  6244. where the line comes from. Note that not all lines going into the agenda
  6245. have this property, only most.
  6246. The function should return the modified string. It is probably best
  6247. to ONLY change text properties.
  6248. You can also use this function as a filter, by returning nil for lines
  6249. you don't want to have in the agenda at all. For this application, you
  6250. could bind the variable in the options section of a custom command.")
  6251. (defun org-agenda-finalize-entries (list &optional type)
  6252. "Sort, limit and concatenate the LIST of agenda items.
  6253. The optional argument TYPE tells the agenda type."
  6254. (let ((max-effort (cond ((listp org-agenda-max-effort)
  6255. (cdr (assoc type org-agenda-max-effort)))
  6256. (t org-agenda-max-effort)))
  6257. (max-todo (cond ((listp org-agenda-max-todos)
  6258. (cdr (assoc type org-agenda-max-todos)))
  6259. (t org-agenda-max-todos)))
  6260. (max-tags (cond ((listp org-agenda-max-tags)
  6261. (cdr (assoc type org-agenda-max-tags)))
  6262. (t org-agenda-max-tags)))
  6263. (max-entries (cond ((listp org-agenda-max-entries)
  6264. (cdr (assoc type org-agenda-max-entries)))
  6265. (t org-agenda-max-entries))))
  6266. (when org-agenda-before-sorting-filter-function
  6267. (setq list
  6268. (delq nil
  6269. (mapcar
  6270. org-agenda-before-sorting-filter-function list))))
  6271. (setq list (mapcar 'org-agenda-highlight-todo list)
  6272. list (mapcar 'identity (sort list 'org-entries-lessp)))
  6273. (when max-effort
  6274. (setq list (org-agenda-limit-entries
  6275. list 'effort-minutes max-effort
  6276. (lambda (e) (or e (if org-sort-agenda-noeffort-is-high
  6277. 32767 -1))))))
  6278. (when max-todo
  6279. (setq list (org-agenda-limit-entries list 'todo-state max-todo)))
  6280. (when max-tags
  6281. (setq list (org-agenda-limit-entries list 'tags max-tags)))
  6282. (when max-entries
  6283. (setq list (org-agenda-limit-entries list 'org-hd-marker max-entries)))
  6284. (mapconcat 'identity list "\n")))
  6285. (defun org-agenda-limit-entries (list prop limit &optional fn)
  6286. "Limit the number of agenda entries."
  6287. (let ((include (and limit (< limit 0))))
  6288. (if limit
  6289. (let ((fun (or fn (lambda (p) (if p 1))))
  6290. (lim 0))
  6291. (delq nil
  6292. (mapcar
  6293. (lambda (e)
  6294. (let ((pval (funcall
  6295. fun (get-text-property (1- (length e))
  6296. prop e))))
  6297. (if pval (setq lim (+ lim pval)))
  6298. (cond ((and pval (<= lim (abs limit))) e)
  6299. ((and include (not pval)) e))))
  6300. list)))
  6301. list)))
  6302. (defun org-agenda-limit-interactively (remove)
  6303. "In agenda, interactively limit entries to various maximums."
  6304. (interactive "P")
  6305. (if remove
  6306. (progn (setq org-agenda-max-entries nil
  6307. org-agenda-max-todos nil
  6308. org-agenda-max-tags nil
  6309. org-agenda-max-effort nil)
  6310. (org-agenda-redo))
  6311. (let* ((max (read-char "Number of [e]ntries [t]odos [T]ags [E]ffort? "))
  6312. (msg (cond ((= max ?E) "How many minutes? ")
  6313. ((= max ?e) "How many entries? ")
  6314. ((= max ?t) "How many TODO entries? ")
  6315. ((= max ?T) "How many tagged entries? ")
  6316. (t (user-error "Wrong input"))))
  6317. (num (string-to-number (read-from-minibuffer msg))))
  6318. (cond ((equal max ?e)
  6319. (let ((org-agenda-max-entries num)) (org-agenda-redo)))
  6320. ((equal max ?t)
  6321. (let ((org-agenda-max-todos num)) (org-agenda-redo)))
  6322. ((equal max ?T)
  6323. (let ((org-agenda-max-tags num)) (org-agenda-redo)))
  6324. ((equal max ?E)
  6325. (let ((org-agenda-max-effort num)) (org-agenda-redo))))))
  6326. (org-agenda-fit-window-to-buffer))
  6327. (defun org-agenda-highlight-todo (x)
  6328. (let ((org-done-keywords org-done-keywords-for-agenda)
  6329. (case-fold-search nil)
  6330. re)
  6331. (if (eq x 'line)
  6332. (save-excursion
  6333. (beginning-of-line 1)
  6334. (setq re (org-get-at-bol 'org-todo-regexp))
  6335. (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
  6336. (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
  6337. (add-text-properties (match-beginning 0) (match-end 1)
  6338. (list 'face (org-get-todo-face 1)))
  6339. (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
  6340. (delete-region (match-beginning 1) (1- (match-end 0)))
  6341. (goto-char (match-beginning 1))
  6342. (insert (format org-agenda-todo-keyword-format s)))))
  6343. (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
  6344. (setq re (get-text-property 0 'org-todo-regexp x))
  6345. (when (and re
  6346. ;; Test `pl' because if there's no heading content,
  6347. ;; there's no point matching to highlight. Note
  6348. ;; that if we didn't test `pl' first, and there
  6349. ;; happened to be no keyword from `org-todo-regexp'
  6350. ;; on this heading line, then the `equal' comparison
  6351. ;; afterwards would spuriously succeed in the case
  6352. ;; where `pl' is nil -- causing an args-out-of-range
  6353. ;; error when we try to add text properties to text
  6354. ;; that isn't there.
  6355. pl
  6356. (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
  6357. x pl) pl))
  6358. (add-text-properties
  6359. (or (match-end 1) (match-end 0)) (match-end 0)
  6360. (list 'face (org-get-todo-face (match-string 2 x)))
  6361. x)
  6362. (when (match-end 1)
  6363. (setq x (concat (substring x 0 (match-end 1))
  6364. (format org-agenda-todo-keyword-format
  6365. (match-string 2 x))
  6366. (org-add-props " " (text-properties-at 0 x))
  6367. (substring x (match-end 3)))))))
  6368. x)))
  6369. (defsubst org-cmp-values (a b property)
  6370. "Compare the numeric value of text PROPERTY for string A and B."
  6371. (let ((pa (or (get-text-property (1- (length a)) property a) 0))
  6372. (pb (or (get-text-property (1- (length b)) property b) 0)))
  6373. (cond ((> pa pb) +1)
  6374. ((< pa pb) -1))))
  6375. (defsubst org-cmp-effort (a b)
  6376. "Compare the effort values of string A and B."
  6377. (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
  6378. ;; `effort-minutes' property is not directly accessible from
  6379. ;; the strings, but is stored as a property in `txt'.
  6380. (ea (or (get-text-property
  6381. 0 'effort-minutes (get-text-property 0 'txt a))
  6382. def))
  6383. (eb (or (get-text-property
  6384. 0 'effort-minutes (get-text-property 0 'txt b))
  6385. def)))
  6386. (cond ((> ea eb) +1)
  6387. ((< ea eb) -1))))
  6388. (defsubst org-cmp-category (a b)
  6389. "Compare the string values of categories of strings A and B."
  6390. (let ((ca (or (get-text-property (1- (length a)) 'org-category a) ""))
  6391. (cb (or (get-text-property (1- (length b)) 'org-category b) "")))
  6392. (cond ((string-lessp ca cb) -1)
  6393. ((string-lessp cb ca) +1))))
  6394. (defsubst org-cmp-todo-state (a b)
  6395. "Compare the todo states of strings A and B."
  6396. (let* ((ma (or (get-text-property 1 'org-marker a)
  6397. (get-text-property 1 'org-hd-marker a)))
  6398. (mb (or (get-text-property 1 'org-marker b)
  6399. (get-text-property 1 'org-hd-marker b)))
  6400. (fa (and ma (marker-buffer ma)))
  6401. (fb (and mb (marker-buffer mb)))
  6402. (todo-kwds
  6403. (or (and fa (with-current-buffer fa org-todo-keywords-1))
  6404. (and fb (with-current-buffer fb org-todo-keywords-1))))
  6405. (ta (or (get-text-property 1 'todo-state a) ""))
  6406. (tb (or (get-text-property 1 'todo-state b) ""))
  6407. (la (- (length (member ta todo-kwds))))
  6408. (lb (- (length (member tb todo-kwds))))
  6409. (donepa (member ta org-done-keywords-for-agenda))
  6410. (donepb (member tb org-done-keywords-for-agenda)))
  6411. (cond ((and donepa (not donepb)) -1)
  6412. ((and (not donepa) donepb) +1)
  6413. ((< la lb) -1)
  6414. ((< lb la) +1))))
  6415. (defsubst org-cmp-alpha (a b)
  6416. "Compare the headlines, alphabetically."
  6417. (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
  6418. (plb (text-property-any 0 (length b) 'org-heading t b))
  6419. (ta (and pla (substring a pla)))
  6420. (tb (and plb (substring b plb)))
  6421. (case-fold-search nil))
  6422. (when pla
  6423. (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
  6424. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
  6425. (setq ta (substring ta (match-end 0))))
  6426. (setq ta (downcase ta)))
  6427. (when plb
  6428. (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
  6429. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
  6430. (setq tb (substring tb (match-end 0))))
  6431. (setq tb (downcase tb)))
  6432. (cond ((not ta) +1)
  6433. ((not tb) -1)
  6434. ((string-lessp ta tb) -1)
  6435. ((string-lessp tb ta) +1))))
  6436. (defsubst org-cmp-tag (a b)
  6437. "Compare the string values of the first tags of A and B."
  6438. (let ((ta (car (last (get-text-property 1 'tags a))))
  6439. (tb (car (last (get-text-property 1 'tags b)))))
  6440. (cond ((not ta) +1)
  6441. ((not tb) -1)
  6442. ((string-lessp ta tb) -1)
  6443. ((string-lessp tb ta) +1))))
  6444. (defsubst org-cmp-time (a b)
  6445. "Compare the time-of-day values of strings A and B."
  6446. (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
  6447. (ta (or (get-text-property 1 'time-of-day a) def))
  6448. (tb (or (get-text-property 1 'time-of-day b) def)))
  6449. (cond ((< ta tb) -1)
  6450. ((< tb ta) +1))))
  6451. (defsubst org-cmp-ts (a b type)
  6452. "Compare the timestamps values of entries A and B.
  6453. When TYPE is \"scheduled\", \"deadline\", \"timestamp\" or
  6454. \"timestamp_ia\", compare within each of these type. When TYPE
  6455. is the empty string, compare all timestamps without respect of
  6456. their type."
  6457. (let* ((def (if org-sort-agenda-notime-is-late most-positive-fixnum -1))
  6458. (ta (or (and (string-match type (or (get-text-property 1 'type a) ""))
  6459. (get-text-property 1 'ts-date a))
  6460. def))
  6461. (tb (or (and (string-match type (or (get-text-property 1 'type b) ""))
  6462. (get-text-property 1 'ts-date b))
  6463. def)))
  6464. (cond ((< ta tb) -1)
  6465. ((< tb ta) +1))))
  6466. (defsubst org-cmp-habit-p (a b)
  6467. "Compare the todo states of strings A and B."
  6468. (let ((ha (get-text-property 1 'org-habit-p a))
  6469. (hb (get-text-property 1 'org-habit-p b)))
  6470. (cond ((and ha (not hb)) -1)
  6471. ((and (not ha) hb) +1))))
  6472. (defun org-entries-lessp (a b)
  6473. "Predicate for sorting agenda entries."
  6474. ;; The following variables will be used when the form is evaluated.
  6475. ;; So even though the compiler complains, keep them.
  6476. (let* ((ss org-agenda-sorting-strategy-selected)
  6477. (timestamp-up (and (org-em 'timestamp-up 'timestamp-down ss)
  6478. (org-cmp-ts a b "")))
  6479. (timestamp-down (if timestamp-up (- timestamp-up) nil))
  6480. (scheduled-up (and (org-em 'scheduled-up 'scheduled-down ss)
  6481. (org-cmp-ts a b "scheduled")))
  6482. (scheduled-down (if scheduled-up (- scheduled-up) nil))
  6483. (deadline-up (and (org-em 'deadline-up 'deadline-down ss)
  6484. (org-cmp-ts a b "deadline")))
  6485. (deadline-down (if deadline-up (- deadline-up) nil))
  6486. (tsia-up (and (org-em 'tsia-up 'tsia-down ss)
  6487. (org-cmp-ts a b "timestamp_ia")))
  6488. (tsia-down (if tsia-up (- tsia-up) nil))
  6489. (ts-up (and (org-em 'ts-up 'ts-down ss)
  6490. (org-cmp-ts a b "timestamp")))
  6491. (ts-down (if ts-up (- ts-up) nil))
  6492. (time-up (and (org-em 'time-up 'time-down ss)
  6493. (org-cmp-time a b)))
  6494. (time-down (if time-up (- time-up) nil))
  6495. (stats-up (and (org-em 'stats-up 'stats-down ss)
  6496. (org-cmp-values a b 'org-stats)))
  6497. (stats-down (if stats-up (- stats-up) nil))
  6498. (priority-up (and (org-em 'priority-up 'priority-down ss)
  6499. (org-cmp-values a b 'priority)))
  6500. (priority-down (if priority-up (- priority-up) nil))
  6501. (effort-up (and (org-em 'effort-up 'effort-down ss)
  6502. (org-cmp-effort a b)))
  6503. (effort-down (if effort-up (- effort-up) nil))
  6504. (category-up (and (or (org-em 'category-up 'category-down ss)
  6505. (memq 'category-keep ss))
  6506. (org-cmp-category a b)))
  6507. (category-down (if category-up (- category-up) nil))
  6508. (category-keep (if category-up +1 nil))
  6509. (tag-up (and (org-em 'tag-up 'tag-down ss)
  6510. (org-cmp-tag a b)))
  6511. (tag-down (if tag-up (- tag-up) nil))
  6512. (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
  6513. (org-cmp-todo-state a b)))
  6514. (todo-state-down (if todo-state-up (- todo-state-up) nil))
  6515. (habit-up (and (org-em 'habit-up 'habit-down ss)
  6516. (org-cmp-habit-p a b)))
  6517. (habit-down (if habit-up (- habit-up) nil))
  6518. (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
  6519. (org-cmp-alpha a b)))
  6520. (alpha-down (if alpha-up (- alpha-up) nil))
  6521. (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
  6522. user-defined-up user-defined-down)
  6523. (if (and need-user-cmp org-agenda-cmp-user-defined
  6524. (functionp org-agenda-cmp-user-defined))
  6525. (setq user-defined-up
  6526. (funcall org-agenda-cmp-user-defined a b)
  6527. user-defined-down (if user-defined-up (- user-defined-up) nil)))
  6528. (cdr (assoc
  6529. (eval (cons 'or org-agenda-sorting-strategy-selected))
  6530. '((-1 . t) (1 . nil) (nil . nil))))))
  6531. ;;; Agenda restriction lock
  6532. (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
  6533. "Overlay to mark the headline to which agenda commands are restricted.")
  6534. (overlay-put org-agenda-restriction-lock-overlay
  6535. 'face 'org-agenda-restriction-lock)
  6536. (overlay-put org-agenda-restriction-lock-overlay
  6537. 'help-echo "Agendas are currently limited to this subtree.")
  6538. (delete-overlay org-agenda-restriction-lock-overlay)
  6539. (defun org-agenda-set-restriction-lock-from-agenda (arg)
  6540. "Set the restriction lock to the agenda item at point from within the agenda.
  6541. When called with a `\\[universal-argument]' prefix, restrict to
  6542. the file which contains the item.
  6543. Argument ARG is the prefix argument."
  6544. (interactive "P")
  6545. (unless (derived-mode-p 'org-agenda-mode)
  6546. (user-error "Not in an Org agenda buffer"))
  6547. (let* ((marker (or (org-get-at-bol 'org-marker)
  6548. (org-agenda-error)))
  6549. (buffer (marker-buffer marker))
  6550. (pos (marker-position marker)))
  6551. (with-current-buffer buffer
  6552. (goto-char pos)
  6553. (org-agenda-set-restriction-lock arg))))
  6554. ;;;###autoload
  6555. (defun org-agenda-set-restriction-lock (&optional type)
  6556. "Set restriction lock for agenda, to current subtree or file.
  6557. Restriction will be the file if TYPE is `file', or if type is the
  6558. universal prefix \\='(4), or if the cursor is before the first headline
  6559. in the file. Otherwise, restriction will be to the current subtree."
  6560. (interactive "P")
  6561. (org-agenda-remove-restriction-lock 'noupdate)
  6562. (and (equal type '(4)) (setq type 'file))
  6563. (setq type (cond
  6564. (type type)
  6565. ((org-at-heading-p) 'subtree)
  6566. ((condition-case nil (org-back-to-heading t) (error nil))
  6567. 'subtree)
  6568. (t 'file)))
  6569. (if (eq type 'subtree)
  6570. (progn
  6571. (setq org-agenda-restrict (current-buffer))
  6572. (setq org-agenda-overriding-restriction 'subtree)
  6573. (put 'org-agenda-files 'org-restrict
  6574. (list (buffer-file-name (buffer-base-buffer))))
  6575. (org-back-to-heading t)
  6576. (move-overlay org-agenda-restriction-lock-overlay
  6577. (point)
  6578. (if org-agenda-restriction-lock-highlight-subtree
  6579. (save-excursion (org-end-of-subtree t t) (point))
  6580. (point-at-eol)))
  6581. (move-marker org-agenda-restrict-begin (point))
  6582. (move-marker org-agenda-restrict-end
  6583. (save-excursion (org-end-of-subtree t t)))
  6584. (message "Locking agenda restriction to subtree"))
  6585. (put 'org-agenda-files 'org-restrict
  6586. (list (buffer-file-name (buffer-base-buffer))))
  6587. (setq org-agenda-restrict nil)
  6588. (setq org-agenda-overriding-restriction 'file)
  6589. (move-marker org-agenda-restrict-begin nil)
  6590. (move-marker org-agenda-restrict-end nil)
  6591. (message "Locking agenda restriction to file"))
  6592. (setq current-prefix-arg nil)
  6593. (org-agenda-maybe-redo))
  6594. (defun org-agenda-remove-restriction-lock (&optional noupdate)
  6595. "Remove the agenda restriction lock."
  6596. (interactive "P")
  6597. (delete-overlay org-agenda-restriction-lock-overlay)
  6598. (delete-overlay org-speedbar-restriction-lock-overlay)
  6599. (setq org-agenda-overriding-restriction nil)
  6600. (setq org-agenda-restrict nil)
  6601. (put 'org-agenda-files 'org-restrict nil)
  6602. (move-marker org-agenda-restrict-begin nil)
  6603. (move-marker org-agenda-restrict-end nil)
  6604. (setq current-prefix-arg nil)
  6605. (message "Agenda restriction lock removed")
  6606. (or noupdate (org-agenda-maybe-redo)))
  6607. (defun org-agenda-maybe-redo ()
  6608. "If there is any window showing the agenda view, update it."
  6609. (let ((w (get-buffer-window (or org-agenda-this-buffer-name
  6610. org-agenda-buffer-name)
  6611. t))
  6612. (w0 (selected-window)))
  6613. (when w
  6614. (select-window w)
  6615. (org-agenda-redo)
  6616. (select-window w0)
  6617. (if org-agenda-overriding-restriction
  6618. (message "Agenda view shifted to new %s restriction"
  6619. org-agenda-overriding-restriction)
  6620. (message "Agenda restriction lock removed")))))
  6621. ;;; Agenda commands
  6622. (defun org-agenda-check-type (error &rest types)
  6623. "Check if agenda buffer is of allowed type.
  6624. If ERROR is non-nil, throw an error, otherwise just return nil.
  6625. Allowed types are `agenda' `timeline' `todo' `tags' `search'."
  6626. (if (not org-agenda-type)
  6627. (error "No Org agenda currently displayed")
  6628. (if (memq org-agenda-type types)
  6629. t
  6630. (if error
  6631. (error "Not allowed in %s-type agenda buffers" org-agenda-type)
  6632. nil))))
  6633. (defun org-agenda-Quit ()
  6634. "Exit the agenda, killing the agenda buffer.
  6635. Like `org-agenda-quit', but kill the buffer even when
  6636. `org-agenda-sticky' is non-nil."
  6637. (interactive)
  6638. (org-agenda--quit))
  6639. (defun org-agenda-quit ()
  6640. "Exit the agenda.
  6641. When `org-agenda-sticky' is non-nil, bury the agenda buffer
  6642. instead of killing it.
  6643. When `org-agenda-restore-windows-after-quit' is non-nil, restore
  6644. the pre-agenda window configuration.
  6645. When column view is active, exit column view instead of the
  6646. agenda."
  6647. (interactive)
  6648. (org-agenda--quit org-agenda-sticky))
  6649. (defun org-agenda--quit (&optional bury)
  6650. (if org-agenda-columns-active
  6651. (org-columns-quit)
  6652. (let ((wconf org-agenda-pre-window-conf)
  6653. (buf (current-buffer))
  6654. (org-agenda-last-indirect-window
  6655. (and (eq org-indirect-buffer-display 'other-window)
  6656. org-agenda-last-indirect-buffer
  6657. (get-buffer-window org-agenda-last-indirect-buffer))))
  6658. (cond
  6659. ((eq org-agenda-window-setup 'other-frame)
  6660. (delete-frame))
  6661. ((and org-agenda-restore-windows-after-quit
  6662. wconf)
  6663. ;; Maybe restore the pre-agenda window configuration. Reset
  6664. ;; `org-agenda-pre-window-conf' before running
  6665. ;; `set-window-configuration', which loses the current buffer.
  6666. (setq org-agenda-pre-window-conf nil)
  6667. (set-window-configuration wconf))
  6668. (t
  6669. (when org-agenda-last-indirect-window
  6670. (delete-window org-agenda-last-indirect-window))
  6671. (and (not (eq org-agenda-window-setup 'current-window))
  6672. (not (one-window-p))
  6673. (delete-window))))
  6674. (if bury
  6675. ;; Set the agenda buffer as the current buffer instead of
  6676. ;; passing it as an argument to `bury-buffer' so that
  6677. ;; `bury-buffer' removes it from the window.
  6678. (with-current-buffer buf
  6679. (bury-buffer))
  6680. (kill-buffer buf)
  6681. (setq org-agenda-archives-mode nil
  6682. org-agenda-buffer nil)))))
  6683. (defun org-agenda-exit ()
  6684. "Exit the agenda, killing Org buffers loaded by the agenda.
  6685. Like `org-agenda-Quit', but kill any buffers that were created by
  6686. the agenda. Org buffers visited directly by the user will not be
  6687. touched. Also, exit the agenda even if it is in column view."
  6688. (interactive)
  6689. (when org-agenda-columns-active
  6690. (org-columns-quit))
  6691. (org-release-buffers org-agenda-new-buffers)
  6692. (setq org-agenda-new-buffers nil)
  6693. (org-agenda-Quit))
  6694. (defun org-agenda-kill-all-agenda-buffers ()
  6695. "Kill all buffers in `org-agenda-mode'.
  6696. This is used when toggling sticky agendas."
  6697. (interactive)
  6698. (let (blist)
  6699. (dolist (buf (buffer-list))
  6700. (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
  6701. (push buf blist)))
  6702. (mapc 'kill-buffer blist)))
  6703. (defun org-agenda-execute (arg)
  6704. "Execute another agenda command, keeping same window.
  6705. So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
  6706. in the agenda."
  6707. (interactive "P")
  6708. (let ((org-agenda-window-setup 'current-window))
  6709. (org-agenda arg)))
  6710. (defun org-agenda-redo (&optional all)
  6711. "Rebuild possibly ALL agenda view(s) in the current buffer."
  6712. (interactive "P")
  6713. (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
  6714. (cpa (unless (eq all t) current-prefix-arg))
  6715. (org-agenda-doing-sticky-redo org-agenda-sticky)
  6716. (org-agenda-sticky nil)
  6717. (org-agenda-buffer-name (or org-agenda-this-buffer-name
  6718. org-agenda-buffer-name))
  6719. (org-agenda-keep-modes t)
  6720. (tag-filter org-agenda-tag-filter)
  6721. (tag-preset (get 'org-agenda-tag-filter :preset-filter))
  6722. (top-hl-filter org-agenda-top-headline-filter)
  6723. (cat-filter org-agenda-category-filter)
  6724. (cat-preset (get 'org-agenda-category-filter :preset-filter))
  6725. (re-filter org-agenda-regexp-filter)
  6726. (re-preset (get 'org-agenda-regexp-filter :preset-filter))
  6727. (effort-filter org-agenda-effort-filter)
  6728. (effort-preset (get 'org-agenda-effort-filter :preset-filter))
  6729. (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
  6730. (cols org-agenda-columns-active)
  6731. (line (org-current-line))
  6732. (window-line (- line (org-current-line (window-start))))
  6733. (lprops (get 'org-agenda-redo-command 'org-lprops))
  6734. (redo-cmd (get-text-property p 'org-redo-cmd))
  6735. (last-args (get-text-property p 'org-last-args))
  6736. (org-agenda-overriding-cmd (get-text-property p 'org-series-cmd))
  6737. (org-agenda-overriding-cmd-arguments
  6738. (unless (eq all t)
  6739. (cond ((listp last-args)
  6740. (cons (or cpa (car last-args)) (cdr last-args)))
  6741. ((stringp last-args)
  6742. last-args))))
  6743. (series-redo-cmd (get-text-property p 'org-series-redo-cmd)))
  6744. (put 'org-agenda-tag-filter :preset-filter nil)
  6745. (put 'org-agenda-category-filter :preset-filter nil)
  6746. (put 'org-agenda-regexp-filter :preset-filter nil)
  6747. (put 'org-agenda-effort-filter :preset-filter nil)
  6748. (and cols (org-columns-quit))
  6749. (message "Rebuilding agenda buffer...")
  6750. (if series-redo-cmd
  6751. (eval series-redo-cmd)
  6752. (org-let lprops redo-cmd))
  6753. (setq org-agenda-undo-list nil
  6754. org-agenda-pending-undo-list nil
  6755. org-agenda-tag-filter tag-filter
  6756. org-agenda-category-filter cat-filter
  6757. org-agenda-regexp-filter re-filter
  6758. org-agenda-effort-filter effort-filter
  6759. org-agenda-top-headline-filter top-hl-filter)
  6760. (message "Rebuilding agenda buffer...done")
  6761. (put 'org-agenda-tag-filter :preset-filter tag-preset)
  6762. (put 'org-agenda-category-filter :preset-filter cat-preset)
  6763. (put 'org-agenda-regexp-filter :preset-filter re-preset)
  6764. (put 'org-agenda-effort-filter :preset-filter effort-preset)
  6765. (let ((tag (or tag-filter tag-preset))
  6766. (cat (or cat-filter cat-preset))
  6767. (effort (or effort-filter effort-preset))
  6768. (re (or re-filter re-preset)))
  6769. (when tag (org-agenda-filter-apply tag 'tag t))
  6770. (when cat (org-agenda-filter-apply cat 'category))
  6771. (when effort (org-agenda-filter-apply effort 'effort))
  6772. (when re (org-agenda-filter-apply re 'regexp)))
  6773. (and top-hl-filter (org-agenda-filter-top-headline-apply top-hl-filter))
  6774. (and cols (called-interactively-p 'any) (org-agenda-columns))
  6775. (org-goto-line line)
  6776. (recenter window-line)))
  6777. (defvar org-global-tags-completion-table nil)
  6778. (defvar org-agenda-filter-form nil)
  6779. (defvar org-agenda-filtered-by-category nil)
  6780. (defun org-agenda-filter-by-category (strip)
  6781. "Filter lines in the agenda buffer that have a specific category.
  6782. The category is that of the current line.
  6783. Without prefix argument, keep only the lines of that category.
  6784. With a prefix argument, exclude the lines of that category.
  6785. "
  6786. (interactive "P")
  6787. (if (and org-agenda-filtered-by-category
  6788. org-agenda-category-filter)
  6789. (org-agenda-filter-show-all-cat)
  6790. (let ((cat (org-no-properties (org-get-at-eol 'org-category 1))))
  6791. (cond
  6792. ((and cat strip)
  6793. (org-agenda-filter-apply
  6794. (push (concat "-" cat) org-agenda-category-filter) 'category))
  6795. (cat
  6796. (org-agenda-filter-apply
  6797. (setq org-agenda-category-filter
  6798. (list (concat "+" cat))) 'category))
  6799. (t (error "No category at point"))))))
  6800. (defun org-find-top-headline (&optional pos)
  6801. "Find the topmost parent headline and return it.
  6802. POS when non-nil is the marker or buffer position to start the
  6803. search from."
  6804. (save-excursion
  6805. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  6806. (when pos (goto-char pos))
  6807. ;; Skip up to the topmost parent.
  6808. (while (org-up-heading-safe))
  6809. (ignore-errors (nth 4 (org-heading-components))))))
  6810. (defvar org-agenda-filtered-by-top-headline nil)
  6811. (defun org-agenda-filter-by-top-headline (strip)
  6812. "Keep only those lines that are descendants from the same top headline.
  6813. The top headline is that of the current line."
  6814. (interactive "P")
  6815. (if org-agenda-filtered-by-top-headline
  6816. (progn
  6817. (setq org-agenda-filtered-by-top-headline nil
  6818. org-agenda-top-headline-filter nil)
  6819. (org-agenda-filter-show-all-top-filter))
  6820. (let ((toph (org-find-top-headline (org-get-at-bol 'org-hd-marker))))
  6821. (if toph (org-agenda-filter-top-headline-apply toph strip)
  6822. (error "No top-level headline at point")))))
  6823. (defvar org-agenda-regexp-filter nil)
  6824. (defun org-agenda-filter-by-regexp (strip)
  6825. "Filter agenda entries by a regular expression.
  6826. Regexp filters are cumulative.
  6827. With no prefix argument, keep entries matching the regexp.
  6828. With one prefix argument, filter out entries matching the regexp.
  6829. With two prefix arguments, remove the regexp filters."
  6830. (interactive "P")
  6831. (if (not (equal strip '(16)))
  6832. (let ((flt (concat (if (equal strip '(4)) "-" "+")
  6833. (read-from-minibuffer
  6834. (if (equal strip '(4))
  6835. "Filter out entries matching regexp: "
  6836. "Narrow to entries matching regexp: ")))))
  6837. (push flt org-agenda-regexp-filter)
  6838. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
  6839. (org-agenda-filter-show-all-re)
  6840. (message "Regexp filter removed")))
  6841. (defvar org-agenda-effort-filter nil)
  6842. (defun org-agenda-filter-by-effort (strip)
  6843. "Filter agenda entries by effort.
  6844. With no prefix argument, keep entries matching the effort condition.
  6845. With one prefix argument, filter out entries matching the condition.
  6846. With two prefix arguments, remove the effort filters."
  6847. (interactive "P")
  6848. (cond
  6849. ((member strip '(nil 4))
  6850. (let* ((efforts (split-string
  6851. (or (cdr (assoc (concat org-effort-property "_ALL")
  6852. org-global-properties))
  6853. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00")))
  6854. ;; XXX: the following handles only up to 10 different
  6855. ;; effort values.
  6856. (allowed-keys (if (null efforts) nil
  6857. (mapcar (lambda (n) (mod n 10)) ;turn 10 into 0
  6858. (number-sequence 1 (length efforts)))))
  6859. (op nil))
  6860. (while (not (memq op '(?< ?> ?=)))
  6861. (setq op (read-char-exclusive "Effort operator? (> = or <)")))
  6862. ;; Select appropriate duration. Ignore non-digit characters.
  6863. (let ((prompt
  6864. (apply #'format
  6865. (concat "Effort %c "
  6866. (mapconcat (lambda (s) (concat "[%d]" s))
  6867. efforts
  6868. " "))
  6869. op allowed-keys))
  6870. (eff -1))
  6871. (while (not (memq eff allowed-keys))
  6872. (message prompt)
  6873. (setq eff (- (read-char-exclusive) 48)))
  6874. (setq org-agenda-effort-filter
  6875. (list (concat (if strip "-" "+")
  6876. (char-to-string op)
  6877. ;; Numbering is 1 2 3 ... 9 0, but we want
  6878. ;; 0 1 2 ... 8 9.
  6879. (nth (mod (1- eff) 10) efforts)))))
  6880. (org-agenda-filter-apply org-agenda-effort-filter 'effort)))
  6881. (t (org-agenda-filter-show-all-effort)
  6882. (message "Effort filter removed"))))
  6883. (defun org-agenda-filter-remove-all ()
  6884. "Remove all filters from the current agenda buffer."
  6885. (interactive)
  6886. (when org-agenda-tag-filter
  6887. (org-agenda-filter-show-all-tag))
  6888. (when org-agenda-category-filter
  6889. (org-agenda-filter-show-all-cat))
  6890. (when org-agenda-regexp-filter
  6891. (org-agenda-filter-show-all-re))
  6892. (when org-agenda-top-headline-filter
  6893. (org-agenda-filter-show-all-top-filter))
  6894. (when org-agenda-effort-filter
  6895. (org-agenda-filter-show-all-effort))
  6896. (org-agenda-finalize))
  6897. (defun org-agenda-filter-by-tag (arg &optional char exclude)
  6898. "Keep only those lines in the agenda buffer that have a specific tag.
  6899. The tag is selected with its fast selection letter, as configured.
  6900. With a `\\[universal-argument]' prefix, exclude the agenda search.
  6901. With a `\\[universal-argument] \\[universal-argument]' prefix, filter the literal tag, \
  6902. i.e. don't
  6903. filter on all its group members.
  6904. A lisp caller can specify CHAR. EXCLUDE means that the new tag
  6905. should be used to exclude the search - the interactive user can
  6906. also press `-' or `+' to switch between filtering and excluding."
  6907. (interactive "P")
  6908. (let* ((alist org-tag-alist-for-agenda)
  6909. (tag-chars (mapconcat
  6910. (lambda (x) (if (and (not (symbolp (car x)))
  6911. (cdr x))
  6912. (char-to-string (cdr x))
  6913. ""))
  6914. org-tag-alist-for-agenda ""))
  6915. (valid-char-list (append '(?\t ?\r ?/ ?. ?\s ?q)
  6916. (string-to-list tag-chars)))
  6917. (exclude (or exclude (equal arg '(4))))
  6918. (expand (not (equal arg '(16))))
  6919. (inhibit-read-only t)
  6920. (current org-agenda-tag-filter)
  6921. a n tag)
  6922. (unless char
  6923. (while (not (memq char valid-char-list))
  6924. (message
  6925. "%s by tag [%s ]:tag-char, [TAB]:tag, %s[/]:off, [+/-]:filter/exclude%s, [q]:quit"
  6926. (if exclude "Exclude" "Filter")
  6927. tag-chars
  6928. (if org-agenda-auto-exclude-function "[RET], " "")
  6929. (if expand "" ", no grouptag expand"))
  6930. (setq char (read-char-exclusive))
  6931. ;; Excluding or filtering down
  6932. (cond ((eq char ?-) (setq exclude t))
  6933. ((eq char ?+) (setq exclude nil)))))
  6934. (when (eq char ?\t)
  6935. (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
  6936. (setq-local org-global-tags-completion-table
  6937. (org-global-tags-completion-table)))
  6938. (let ((completion-ignore-case t))
  6939. (setq tag (completing-read
  6940. "Tag: " org-global-tags-completion-table))))
  6941. (cond
  6942. ((eq char ?\r)
  6943. (org-agenda-filter-show-all-tag)
  6944. (when org-agenda-auto-exclude-function
  6945. (setq org-agenda-tag-filter nil)
  6946. (dolist (tag (org-agenda-get-represented-tags))
  6947. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  6948. (if modifier
  6949. (push modifier org-agenda-tag-filter))))
  6950. (if (not (null org-agenda-tag-filter))
  6951. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))))
  6952. ((eq char ?/)
  6953. (org-agenda-filter-show-all-tag)
  6954. (when (get 'org-agenda-tag-filter :preset-filter)
  6955. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand)))
  6956. ((eq char ?.)
  6957. (setq org-agenda-tag-filter
  6958. (mapcar (lambda(tag) (concat "+" tag))
  6959. (org-get-at-bol 'tags)))
  6960. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  6961. ((eq char ?q)) ;If q, abort (even if there is a q-key for a tag...)
  6962. ((or (eq char ?\s)
  6963. (setq a (rassoc char alist))
  6964. (and tag (setq a (cons tag nil))))
  6965. (org-agenda-filter-show-all-tag)
  6966. (setq tag (car a))
  6967. (setq org-agenda-tag-filter
  6968. (cons (concat (if exclude "-" "+") tag)
  6969. current))
  6970. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  6971. (t (error "Invalid tag selection character %c" char)))))
  6972. (defun org-agenda-get-represented-tags ()
  6973. "Get a list of all tags currently represented in the agenda."
  6974. (let (p tags)
  6975. (save-excursion
  6976. (goto-char (point-min))
  6977. (while (setq p (next-single-property-change (point) 'tags))
  6978. (goto-char p)
  6979. (mapc (lambda (x) (add-to-list 'tags x))
  6980. (get-text-property (point) 'tags))))
  6981. tags))
  6982. (defun org-agenda-filter-make-matcher (filter type &optional expand)
  6983. "Create the form that tests a line for agenda filter. Optional
  6984. argument EXPAND can be used for the TYPE tag and will expand the
  6985. tags in the FILTER if any of the tags in FILTER are grouptags."
  6986. (let (f f1)
  6987. (cond
  6988. ;; Tag filter
  6989. ((eq type 'tag)
  6990. (setq filter
  6991. (delete-dups
  6992. (append (get 'org-agenda-tag-filter :preset-filter)
  6993. filter)))
  6994. (dolist (x filter)
  6995. (let ((op (string-to-char x)))
  6996. (if expand (setq x (org-agenda-filter-expand-tags (list x) t))
  6997. (setq x (list x)))
  6998. (setq f1 (org-agenda-filter-make-matcher-tag-exp x op))
  6999. (push f1 f))))
  7000. ;; Category filter
  7001. ((eq type 'category)
  7002. (setq filter
  7003. (delete-dups
  7004. (append (get 'org-agenda-category-filter :preset-filter)
  7005. filter)))
  7006. (dolist (x filter)
  7007. (if (equal "-" (substring x 0 1))
  7008. (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
  7009. (setq f1 (list 'equal (substring x 1) 'cat)))
  7010. (push f1 f)))
  7011. ;; Regexp filter
  7012. ((eq type 'regexp)
  7013. (setq filter
  7014. (delete-dups
  7015. (append (get 'org-agenda-regexp-filter :preset-filter)
  7016. filter)))
  7017. (dolist (x filter)
  7018. (if (equal "-" (substring x 0 1))
  7019. (setq f1 (list 'not (list 'string-match (substring x 1) 'txt)))
  7020. (setq f1 (list 'string-match (substring x 1) 'txt)))
  7021. (push f1 f)))
  7022. ;; Effort filter
  7023. ((eq type 'effort)
  7024. (setq filter
  7025. (delete-dups
  7026. (append (get 'org-agenda-effort-filter :preset-filter)
  7027. filter)))
  7028. (dolist (x filter)
  7029. (push (org-agenda-filter-effort-form x) f))))
  7030. (cons 'and (nreverse f))))
  7031. (defun org-agenda-filter-make-matcher-tag-exp (tags op)
  7032. "Return a form associated to tag-expression TAGS.
  7033. Build a form testing a line for agenda filter for
  7034. tag-expressions. OP is an operator of type CHAR that allows the
  7035. function to set the right switches in the returned form."
  7036. (let (form)
  7037. ;; Any of the expressions can match if OP is +, all must match if
  7038. ;; the operator is -.
  7039. (dolist (x tags (cons (if (eq op ?-) 'and 'or) form))
  7040. (let* ((tag (substring x 1))
  7041. (f (cond
  7042. ((string= "" tag) '(not tags))
  7043. ((and (string-match-p "\\`{" tag) (string-match-p "}\\'" tag))
  7044. ;; TAG is a regexp.
  7045. (list 'org-match-any-p (substring tag 1 -1) 'tags))
  7046. (t (list 'member (downcase tag) 'tags)))))
  7047. (push (if (eq op ?-) (list 'not f) f) form)))))
  7048. (defun org-agenda-filter-effort-form (e)
  7049. "Return the form to compare the effort of the current line with what E says.
  7050. E looks like \"+<2:25\"."
  7051. (let (op)
  7052. (setq e (substring e 1))
  7053. (setq op (string-to-char e) e (substring e 1))
  7054. (setq op (cond ((equal op ?<) '<=)
  7055. ((equal op ?>) '>=)
  7056. ((equal op ??) op)
  7057. (t '=)))
  7058. (list 'org-agenda-compare-effort (list 'quote op)
  7059. (org-duration-to-minutes e))))
  7060. (defun org-agenda-compare-effort (op value)
  7061. "Compare the effort of the current line with VALUE, using OP.
  7062. If the line does not have an effort defined, return nil."
  7063. ;; `effort-minutes' property cannot be extracted directly from
  7064. ;; current line but is stored as a property in `txt'.
  7065. (let ((effort (get-text-property 0 'effort-minutes (org-get-at-bol 'txt))))
  7066. (funcall op
  7067. (or effort (if org-sort-agenda-noeffort-is-high 32767 -1))
  7068. value)))
  7069. (defun org-agenda-filter-expand-tags (filter &optional no-operator)
  7070. "Expand group tags in FILTER for the agenda.
  7071. When NO-OPERATOR is non-nil, do not add the + operator to returned tags."
  7072. (if org-group-tags
  7073. (let ((case-fold-search t) rtn)
  7074. (mapc
  7075. (lambda (f)
  7076. (let (f0 dir)
  7077. (if (string-match "^\\([+-]\\)\\(.+\\)" f)
  7078. (setq dir (match-string 1 f) f0 (match-string 2 f))
  7079. (setq dir (if no-operator "" "+") f0 f))
  7080. (setq rtn (append (mapcar (lambda(f1) (concat dir f1))
  7081. (org-tags-expand f0 t t))
  7082. rtn))))
  7083. filter)
  7084. (reverse rtn))
  7085. filter))
  7086. (defun org-agenda-filter-apply (filter type &optional expand)
  7087. "Set FILTER as the new agenda filter and apply it. Optional
  7088. argument EXPAND can be used for the TYPE tag and will expand the
  7089. tags in the FILTER if any of the tags in FILTER are grouptags."
  7090. ;; Deactivate `org-agenda-entry-text-mode' when filtering
  7091. (if org-agenda-entry-text-mode (org-agenda-entry-text-mode))
  7092. (let (tags cat txt)
  7093. (setq org-agenda-filter-form (org-agenda-filter-make-matcher filter type expand))
  7094. ;; Only set `org-agenda-filtered-by-category' to t when a unique
  7095. ;; category is used as the filter:
  7096. (setq org-agenda-filtered-by-category
  7097. (and (eq type 'category)
  7098. (not (equal (substring (car filter) 0 1) "-"))))
  7099. (org-agenda-set-mode-name)
  7100. (save-excursion
  7101. (goto-char (point-min))
  7102. (while (not (eobp))
  7103. (if (org-get-at-bol 'org-marker)
  7104. (progn
  7105. (setq tags (org-get-at-bol 'tags)
  7106. cat (org-get-at-eol 'org-category 1)
  7107. txt (org-get-at-bol 'txt))
  7108. (if (not (eval org-agenda-filter-form))
  7109. (org-agenda-filter-hide-line type))
  7110. (beginning-of-line 2))
  7111. (beginning-of-line 2))))
  7112. (if (get-char-property (point) 'invisible)
  7113. (ignore-errors (org-agenda-previous-line)))))
  7114. (defun org-agenda-filter-top-headline-apply (hl &optional negative)
  7115. "Filter by top headline HL."
  7116. (org-agenda-set-mode-name)
  7117. (save-excursion
  7118. (goto-char (point-min))
  7119. (while (not (eobp))
  7120. (let* ((pos (org-get-at-bol 'org-hd-marker))
  7121. (tophl (and pos (org-find-top-headline pos))))
  7122. (if (and tophl (funcall (if negative 'identity 'not)
  7123. (string= hl tophl)))
  7124. (org-agenda-filter-hide-line 'top-headline)))
  7125. (beginning-of-line 2)))
  7126. (if (get-char-property (point) 'invisible)
  7127. (org-agenda-previous-line))
  7128. (setq org-agenda-top-headline-filter hl
  7129. org-agenda-filtered-by-top-headline t))
  7130. (defun org-agenda-filter-hide-line (type)
  7131. "Hide lines with TYPE in the agenda buffer."
  7132. (let* ((b (max (point-min) (1- (point-at-bol))))
  7133. (e (point-at-eol)))
  7134. (let ((inhibit-read-only t))
  7135. (add-text-properties
  7136. b e `(invisible org-filtered org-filter-type ,type)))))
  7137. (defun org-agenda-remove-filter (type)
  7138. (interactive)
  7139. "Remove filter of type TYPE from the agenda buffer."
  7140. (save-excursion
  7141. (goto-char (point-min))
  7142. (let ((inhibit-read-only t) pos)
  7143. (while (setq pos (text-property-any (point) (point-max) 'org-filter-type type))
  7144. (goto-char pos)
  7145. (remove-text-properties
  7146. (point) (next-single-property-change (point) 'org-filter-type)
  7147. `(invisible org-filtered org-filter-type ,type))))
  7148. (set (intern (format "org-agenda-%s-filter" (intern-soft type))) nil)
  7149. (setq org-agenda-filter-form nil)
  7150. (org-agenda-set-mode-name)
  7151. (org-agenda-finalize)))
  7152. (defun org-agenda-filter-show-all-tag nil
  7153. (org-agenda-remove-filter 'tag))
  7154. (defun org-agenda-filter-show-all-re nil
  7155. (org-agenda-remove-filter 'regexp))
  7156. (defun org-agenda-filter-show-all-effort nil
  7157. (org-agenda-remove-filter 'effort))
  7158. (defun org-agenda-filter-show-all-cat nil
  7159. (org-agenda-remove-filter 'category))
  7160. (defun org-agenda-filter-show-all-top-filter nil
  7161. (org-agenda-remove-filter 'top-headline))
  7162. (defun org-agenda-manipulate-query-add ()
  7163. "Manipulate the query by adding a search term with positive selection.
  7164. Positive selection means the term must be matched for selection of an entry."
  7165. (interactive)
  7166. (org-agenda-manipulate-query ?\[))
  7167. (defun org-agenda-manipulate-query-subtract ()
  7168. "Manipulate the query by adding a search term with negative selection.
  7169. Negative selection means term must not be matched for selection of an entry."
  7170. (interactive)
  7171. (org-agenda-manipulate-query ?\]))
  7172. (defun org-agenda-manipulate-query-add-re ()
  7173. "Manipulate the query by adding a search regexp with positive selection.
  7174. Positive selection means the regexp must match for selection of an entry."
  7175. (interactive)
  7176. (org-agenda-manipulate-query ?\{))
  7177. (defun org-agenda-manipulate-query-subtract-re ()
  7178. "Manipulate the query by adding a search regexp with negative selection.
  7179. Negative selection means regexp must not match for selection of an entry."
  7180. (interactive)
  7181. (org-agenda-manipulate-query ?\}))
  7182. (defun org-agenda-manipulate-query (char)
  7183. (cond
  7184. ((memq org-agenda-type '(timeline agenda))
  7185. (let ((org-agenda-include-inactive-timestamps t))
  7186. (org-agenda-redo))
  7187. (message "Display now includes inactive timestamps as well"))
  7188. ((eq org-agenda-type 'search)
  7189. (org-add-to-string
  7190. 'org-agenda-query-string
  7191. (if org-agenda-last-search-view-search-was-boolean
  7192. (cdr (assoc char '((?\[ . " +") (?\] . " -")
  7193. (?\{ . " +{}") (?\} . " -{}"))))
  7194. " "))
  7195. (setq org-agenda-redo-command
  7196. (list 'org-search-view
  7197. (car (get-text-property (min (1- (point-max)) (point))
  7198. 'org-last-args))
  7199. org-agenda-query-string
  7200. (+ (length org-agenda-query-string)
  7201. (if (member char '(?\{ ?\})) 0 1))))
  7202. (set-register org-agenda-query-register org-agenda-query-string)
  7203. (let ((org-agenda-overriding-arguments
  7204. (cdr org-agenda-redo-command)))
  7205. (org-agenda-redo)))
  7206. (t (error "Cannot manipulate query for %s-type agenda buffers"
  7207. org-agenda-type))))
  7208. (defun org-add-to-string (var string)
  7209. (set var (concat (symbol-value var) string)))
  7210. (defun org-agenda-goto-date (span)
  7211. "Jump to DATE in agenda."
  7212. (interactive "P")
  7213. (let* ((org-read-date-prefer-future
  7214. (eval org-agenda-jump-prefer-future))
  7215. (date (org-read-date))
  7216. (day (time-to-days (org-time-string-to-time date)))
  7217. (org-agenda-sticky-orig org-agenda-sticky)
  7218. (org-agenda-buffer-tmp-name (buffer-name))
  7219. (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7220. (0-arg (or current-prefix-arg (car args)))
  7221. (2-arg (nth 2 args))
  7222. (with-hour-p (nth 4 org-agenda-redo-command))
  7223. (newcmd (list 'org-agenda-list 0-arg date
  7224. (org-agenda-span-to-ndays
  7225. 2-arg (org-time-string-to-absolute date))
  7226. with-hour-p))
  7227. (newargs (cdr newcmd))
  7228. (inhibit-read-only t)
  7229. org-agenda-sticky)
  7230. (if (not (org-agenda-check-type t 'agenda))
  7231. (error "Not available in non-agenda views")
  7232. (add-text-properties (point-min) (point-max)
  7233. `(org-redo-cmd ,newcmd org-last-args ,newargs))
  7234. (org-agenda-redo)
  7235. (goto-char (point-min))
  7236. (while (not (or (= (or (get-text-property (point) 'day) 0) day)
  7237. (save-excursion (move-beginning-of-line 2) (eobp))))
  7238. (move-beginning-of-line 2))
  7239. (setq org-agenda-sticky org-agenda-sticky-orig
  7240. org-agenda-this-buffer-is-sticky org-agenda-sticky))))
  7241. (defun org-agenda-goto-today ()
  7242. "Go to today."
  7243. (interactive)
  7244. (org-agenda-check-type t 'timeline 'agenda)
  7245. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7246. (curspan (nth 2 args))
  7247. (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
  7248. (cond
  7249. (tdpos (goto-char tdpos))
  7250. ((eq org-agenda-type 'agenda)
  7251. (let* ((sd (org-agenda-compute-starting-span
  7252. (org-today) (or curspan org-agenda-span)))
  7253. (org-agenda-overriding-arguments args))
  7254. (setf (nth 1 org-agenda-overriding-arguments) sd)
  7255. (org-agenda-redo)
  7256. (org-agenda-find-same-or-today-or-agenda)))
  7257. (t (error "Cannot find today")))))
  7258. (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
  7259. (goto-char
  7260. (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
  7261. (text-property-any (point-min) (point-max) 'org-today t)
  7262. (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
  7263. (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
  7264. (org-agenda-backward-block))
  7265. (point-min))))
  7266. (defun org-agenda-backward-block ()
  7267. "Move backward by one agenda block."
  7268. (interactive)
  7269. (org-agenda-forward-block 'backward))
  7270. (defun org-agenda-forward-block (&optional backward)
  7271. "Move forward by one agenda block.
  7272. When optional argument BACKWARD is set, go backward"
  7273. (interactive)
  7274. (cond ((not (derived-mode-p 'org-agenda-mode))
  7275. (user-error
  7276. "Cannot execute this command outside of org-agenda-mode buffers"))
  7277. ((looking-at (if backward "\\`" "\\'"))
  7278. (message "Already at the %s block" (if backward "first" "last")))
  7279. (t (let ((pos (prog1 (point)
  7280. (ignore-errors (if backward (backward-char 1)
  7281. (move-end-of-line 1)))))
  7282. (f (if backward
  7283. 'previous-single-property-change
  7284. 'next-single-property-change))
  7285. moved dest)
  7286. (while (and (setq dest (funcall
  7287. f (point) 'org-agenda-structural-header))
  7288. (not (get-text-property
  7289. (point) 'org-agenda-structural-header)))
  7290. (setq moved t)
  7291. (goto-char dest))
  7292. (if moved (move-beginning-of-line 1)
  7293. (goto-char (if backward (point-min) (point-max)))
  7294. (move-beginning-of-line 1)
  7295. (message "No %s block" (if backward "previous" "further")))))))
  7296. (defun org-agenda-later (arg)
  7297. "Go forward in time by the current span.
  7298. With prefix ARG, go forward that many times the current span."
  7299. (interactive "p")
  7300. (org-agenda-check-type t 'agenda)
  7301. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7302. (span (or (nth 2 args) org-agenda-current-span))
  7303. (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
  7304. (greg (calendar-gregorian-from-absolute sd))
  7305. (cnt (org-get-at-bol 'org-day-cnt))
  7306. greg2)
  7307. (cond
  7308. ((numberp span)
  7309. (setq sd (+ (* span arg) sd)))
  7310. ((eq span 'day)
  7311. (setq sd (+ arg sd)))
  7312. ((eq span 'week)
  7313. (setq sd (+ (* 7 arg) sd)))
  7314. ((eq span 'fortnight)
  7315. (setq sd (+ (* 14 arg) sd)))
  7316. ((eq span 'month)
  7317. (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
  7318. sd (calendar-absolute-from-gregorian greg2))
  7319. (setcar greg2 (1+ (car greg2))))
  7320. ((eq span 'year)
  7321. (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
  7322. sd (calendar-absolute-from-gregorian greg2))
  7323. (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
  7324. (t
  7325. (setq sd (+ (* span arg) sd))))
  7326. (let ((org-agenda-overriding-cmd
  7327. ;; `cmd' may have been set by `org-agenda-run-series' which
  7328. ;; uses `org-agenda-overriding-cmd' to decide whether
  7329. ;; overriding is allowed for `cmd'
  7330. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7331. (org-agenda-overriding-arguments
  7332. (list (car args) sd span)))
  7333. (org-agenda-redo)
  7334. (org-agenda-find-same-or-today-or-agenda cnt))))
  7335. (defun org-agenda-earlier (arg)
  7336. "Go backward in time by the current span.
  7337. With prefix ARG, go backward that many times the current span."
  7338. (interactive "p")
  7339. (org-agenda-later (- arg)))
  7340. (defun org-agenda-view-mode-dispatch ()
  7341. "Call one of the view mode commands."
  7342. (interactive)
  7343. (message "View: [d]ay [w]eek for[t]night [m]onth [y]ear [SPC]reset [q]uit/abort
  7344. time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
  7345. [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
  7346. (pcase (read-char-exclusive)
  7347. (?\ (call-interactively 'org-agenda-reset-view))
  7348. (?d (call-interactively 'org-agenda-day-view))
  7349. (?w (call-interactively 'org-agenda-week-view))
  7350. (?t (call-interactively 'org-agenda-fortnight-view))
  7351. (?m (call-interactively 'org-agenda-month-view))
  7352. (?y (call-interactively 'org-agenda-year-view))
  7353. (?l (call-interactively 'org-agenda-log-mode))
  7354. (?L (org-agenda-log-mode '(4)))
  7355. (?c (org-agenda-log-mode 'clockcheck))
  7356. ((or ?F ?f) (call-interactively 'org-agenda-follow-mode))
  7357. (?a (call-interactively 'org-agenda-archives-mode))
  7358. (?A (org-agenda-archives-mode 'files))
  7359. ((or ?R ?r) (call-interactively 'org-agenda-clockreport-mode))
  7360. ((or ?E ?e) (call-interactively 'org-agenda-entry-text-mode))
  7361. (?G (call-interactively 'org-agenda-toggle-time-grid))
  7362. (?D (call-interactively 'org-agenda-toggle-diary))
  7363. (?\! (call-interactively 'org-agenda-toggle-deadlines))
  7364. (?\[ (let ((org-agenda-include-inactive-timestamps t))
  7365. (org-agenda-check-type t 'timeline 'agenda)
  7366. (org-agenda-redo))
  7367. (message "Display now includes inactive timestamps as well"))
  7368. (?q (message "Abort"))
  7369. (key (user-error "Invalid key: %s" key))))
  7370. (defun org-agenda-reset-view ()
  7371. "Switch to default view for agenda."
  7372. (interactive)
  7373. (org-agenda-change-time-span org-agenda-span))
  7374. (defun org-agenda-day-view (&optional day-of-month)
  7375. "Switch to daily view for agenda.
  7376. With argument DAY-OF-MONTH, switch to that day of the month."
  7377. (interactive "P")
  7378. (org-agenda-change-time-span 'day day-of-month))
  7379. (defun org-agenda-week-view (&optional iso-week)
  7380. "Switch to weekly view for agenda.
  7381. With argument ISO-WEEK, switch to the corresponding ISO week.
  7382. If ISO-WEEK has more then 2 digits, only the last two encode
  7383. the week. Any digits before this encode a year. So 200712
  7384. means week 12 of year 2007. Years ranging from 70 years ago
  7385. to 30 years in the future can also be written as 2-digit years."
  7386. (interactive "P")
  7387. (org-agenda-change-time-span 'week iso-week))
  7388. (defun org-agenda-fortnight-view (&optional iso-week)
  7389. "Switch to fortnightly view for agenda.
  7390. With argument ISO-WEEK, switch to the corresponding ISO week.
  7391. If ISO-WEEK has more then 2 digits, only the last two encode
  7392. the week. Any digits before this encode a year. So 200712
  7393. means week 12 of year 2007. Years ranging from 70 years ago
  7394. to 30 years in the future can also be written as 2-digit years."
  7395. (interactive "P")
  7396. (org-agenda-change-time-span 'fortnight iso-week))
  7397. (defun org-agenda-month-view (&optional month)
  7398. "Switch to monthly view for agenda.
  7399. With argument MONTH, switch to that month. If MONTH has more
  7400. then 2 digits, only the last two encode the month. Any digits
  7401. before this encode a year. So 200712 means December year 2007.
  7402. Years ranging from 70 years ago to 30 years in the future can
  7403. also be written as 2-digit years."
  7404. (interactive "P")
  7405. (org-agenda-change-time-span 'month month))
  7406. (defun org-agenda-year-view (&optional year)
  7407. "Switch to yearly view for agenda.
  7408. With argument YEAR, switch to that year. Years ranging from 70
  7409. years ago to 30 years in the future can also be written as
  7410. 2-digit years."
  7411. (interactive "P")
  7412. (when year
  7413. (setq year (org-small-year-to-year year)))
  7414. (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
  7415. (org-agenda-change-time-span 'year year)
  7416. (error "Abort")))
  7417. (defun org-agenda-change-time-span (span &optional n)
  7418. "Change the agenda view to SPAN.
  7419. SPAN may be `day', `week', `fortnight', `month', `year'."
  7420. (org-agenda-check-type t 'agenda)
  7421. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7422. (curspan (nth 2 args)))
  7423. (if (and (not n) (equal curspan span))
  7424. (error "Viewing span is already \"%s\"" span))
  7425. (let* ((sd (or (org-get-at-bol 'day)
  7426. (nth 1 args)
  7427. org-starting-day))
  7428. (sd (org-agenda-compute-starting-span sd span n))
  7429. (org-agenda-overriding-cmd
  7430. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7431. (org-agenda-overriding-arguments
  7432. (list (car args) sd span)))
  7433. (org-agenda-redo)
  7434. (org-agenda-find-same-or-today-or-agenda))
  7435. (org-agenda-set-mode-name)
  7436. (message "Switched to %s view" span)))
  7437. (defun org-agenda-compute-starting-span (sd span &optional n)
  7438. "Compute starting date for agenda.
  7439. SPAN may be `day', `week', `fortnight', `month', `year'. The return value
  7440. is a cons cell with the starting date and the number of days,
  7441. so that the date SD will be in that range."
  7442. (let* ((greg (calendar-gregorian-from-absolute sd))
  7443. (dg (nth 1 greg))
  7444. (mg (car greg))
  7445. (yg (nth 2 greg)))
  7446. (cond
  7447. ((eq span 'day)
  7448. (when n
  7449. (setq sd (+ (calendar-absolute-from-gregorian
  7450. (list mg 1 yg))
  7451. n -1))))
  7452. ((or (eq span 'week) (eq span 'fortnight))
  7453. (let* ((nt (calendar-day-of-week
  7454. (calendar-gregorian-from-absolute sd)))
  7455. (d (if org-agenda-start-on-weekday
  7456. (- nt org-agenda-start-on-weekday)
  7457. 0))
  7458. y1)
  7459. (setq sd (- sd (+ (if (< d 0) 7 0) d)))
  7460. (when n
  7461. (require 'cal-iso)
  7462. (when (> n 99)
  7463. (setq y1 (org-small-year-to-year (/ n 100))
  7464. n (mod n 100)))
  7465. (setq sd
  7466. (calendar-iso-to-absolute
  7467. (list n 1
  7468. (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
  7469. ((eq span 'month)
  7470. (let (y1)
  7471. (when (and n (> n 99))
  7472. (setq y1 (org-small-year-to-year (/ n 100))
  7473. n (mod n 100)))
  7474. (setq sd (calendar-absolute-from-gregorian
  7475. (list (or n mg) 1 (or y1 yg))))))
  7476. ((eq span 'year)
  7477. (setq sd (calendar-absolute-from-gregorian
  7478. (list 1 1 (or n yg))))))
  7479. sd))
  7480. (defun org-agenda-next-date-line (&optional arg)
  7481. "Jump to the next line indicating a date in agenda buffer."
  7482. (interactive "p")
  7483. (org-agenda-check-type t 'agenda 'timeline)
  7484. (beginning-of-line 1)
  7485. ;; This does not work if user makes date format that starts with a blank
  7486. (if (looking-at "^\\S-") (forward-char 1))
  7487. (if (not (re-search-forward "^\\S-" nil t arg))
  7488. (progn
  7489. (backward-char 1)
  7490. (error "No next date after this line in this buffer")))
  7491. (goto-char (match-beginning 0)))
  7492. (defun org-agenda-previous-date-line (&optional arg)
  7493. "Jump to the previous line indicating a date in agenda buffer."
  7494. (interactive "p")
  7495. (org-agenda-check-type t 'agenda 'timeline)
  7496. (beginning-of-line 1)
  7497. (if (not (re-search-backward "^\\S-" nil t arg))
  7498. (error "No previous date before this line in this buffer")))
  7499. ;; Initialize the highlight
  7500. (defvar org-hl (make-overlay 1 1))
  7501. (overlay-put org-hl 'face 'highlight)
  7502. (defun org-highlight (begin end &optional buffer)
  7503. "Highlight a region with overlay."
  7504. (move-overlay org-hl begin end (or buffer (current-buffer))))
  7505. (defun org-unhighlight ()
  7506. "Detach overlay INDEX."
  7507. (delete-overlay org-hl))
  7508. (defun org-unhighlight-once ()
  7509. "Remove the highlight from its position, and this function from the hook."
  7510. (remove-hook 'pre-command-hook 'org-unhighlight-once)
  7511. (org-unhighlight))
  7512. (defvar org-agenda-pre-follow-window-conf nil)
  7513. (defun org-agenda-follow-mode ()
  7514. "Toggle follow mode in an agenda buffer."
  7515. (interactive)
  7516. (unless org-agenda-follow-mode
  7517. (setq org-agenda-pre-follow-window-conf
  7518. (current-window-configuration)))
  7519. (setq org-agenda-follow-mode (not org-agenda-follow-mode))
  7520. (unless org-agenda-follow-mode
  7521. (set-window-configuration org-agenda-pre-follow-window-conf))
  7522. (org-agenda-set-mode-name)
  7523. (org-agenda-do-context-action)
  7524. (message "Follow mode is %s"
  7525. (if org-agenda-follow-mode "on" "off")))
  7526. (defun org-agenda-entry-text-mode (&optional arg)
  7527. "Toggle entry text mode in an agenda buffer."
  7528. (interactive "P")
  7529. (if (or org-agenda-tag-filter
  7530. org-agenda-category-filter
  7531. org-agenda-regexp-filter
  7532. org-agenda-top-headline-filter)
  7533. (user-error "Can't show entry text in filtered views")
  7534. (setq org-agenda-entry-text-mode (or (integerp arg)
  7535. (not org-agenda-entry-text-mode)))
  7536. (org-agenda-entry-text-hide)
  7537. (and org-agenda-entry-text-mode
  7538. (let ((org-agenda-entry-text-maxlines
  7539. (if (integerp arg) arg org-agenda-entry-text-maxlines)))
  7540. (org-agenda-entry-text-show)))
  7541. (org-agenda-set-mode-name)
  7542. (message "Entry text mode is %s%s"
  7543. (if org-agenda-entry-text-mode "on" "off")
  7544. (if (not org-agenda-entry-text-mode) ""
  7545. (format " (maximum number of lines is %d)"
  7546. (if (integerp arg) arg org-agenda-entry-text-maxlines))))))
  7547. (defun org-agenda-clockreport-mode ()
  7548. "Toggle clocktable mode in an agenda buffer."
  7549. (interactive)
  7550. (org-agenda-check-type t 'agenda)
  7551. (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode))
  7552. (setq org-agenda-start-with-clockreport-mode org-agenda-clockreport-mode)
  7553. (org-agenda-set-mode-name)
  7554. (org-agenda-redo)
  7555. (message "Clocktable mode is %s"
  7556. (if org-agenda-clockreport-mode "on" "off")))
  7557. (defun org-agenda-log-mode (&optional special)
  7558. "Toggle log mode in an agenda buffer.
  7559. With argument SPECIAL, show all possible log items, not only the ones
  7560. configured in `org-agenda-log-mode-items'.
  7561. With a `\\[universal-argument] \\[universal-argument]' prefix, show *only* \
  7562. log items, nothing else."
  7563. (interactive "P")
  7564. (org-agenda-check-type t 'agenda 'timeline)
  7565. (setq org-agenda-show-log
  7566. (cond
  7567. ((equal special '(16)) 'only)
  7568. ((eq special 'clockcheck)
  7569. (if (eq org-agenda-show-log 'clockcheck)
  7570. nil 'clockcheck))
  7571. (special '(closed clock state))
  7572. (t (not org-agenda-show-log))))
  7573. (setq org-agenda-start-with-log-mode org-agenda-show-log)
  7574. (org-agenda-set-mode-name)
  7575. (org-agenda-redo)
  7576. (message "Log mode is %s" (if org-agenda-show-log "on" "off")))
  7577. (defun org-agenda-archives-mode (&optional with-files)
  7578. "Toggle inclusion of items in trees marked with :ARCHIVE:.
  7579. When called with a prefix argument, include all archive files as well."
  7580. (interactive "P")
  7581. (setq org-agenda-archives-mode
  7582. (if with-files t (if org-agenda-archives-mode nil 'trees)))
  7583. (org-agenda-set-mode-name)
  7584. (org-agenda-redo)
  7585. (message
  7586. "%s"
  7587. (cond
  7588. ((eq org-agenda-archives-mode nil)
  7589. "No archives are included")
  7590. ((eq org-agenda-archives-mode 'trees)
  7591. (format "Trees with :%s: tag are included" org-archive-tag))
  7592. ((eq org-agenda-archives-mode t)
  7593. (format "Trees with :%s: tag and all active archive files are included"
  7594. org-archive-tag)))))
  7595. (defun org-agenda-toggle-diary ()
  7596. "Toggle diary inclusion in an agenda buffer."
  7597. (interactive)
  7598. (org-agenda-check-type t 'agenda)
  7599. (setq org-agenda-include-diary (not org-agenda-include-diary))
  7600. (org-agenda-redo)
  7601. (org-agenda-set-mode-name)
  7602. (message "Diary inclusion turned %s"
  7603. (if org-agenda-include-diary "on" "off")))
  7604. (defun org-agenda-toggle-deadlines ()
  7605. "Toggle inclusion of entries with a deadline in an agenda buffer."
  7606. (interactive)
  7607. (org-agenda-check-type t 'agenda)
  7608. (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
  7609. (org-agenda-redo)
  7610. (org-agenda-set-mode-name)
  7611. (message "Deadlines inclusion turned %s"
  7612. (if org-agenda-include-deadlines "on" "off")))
  7613. (defun org-agenda-toggle-time-grid ()
  7614. "Toggle time grid in an agenda buffer."
  7615. (interactive)
  7616. (org-agenda-check-type t 'agenda)
  7617. (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
  7618. (org-agenda-redo)
  7619. (org-agenda-set-mode-name)
  7620. (message "Time-grid turned %s"
  7621. (if org-agenda-use-time-grid "on" "off")))
  7622. (defun org-agenda-set-mode-name ()
  7623. "Set the mode name to indicate all the small mode settings."
  7624. (setq mode-name
  7625. (list "Org-Agenda"
  7626. (if (get 'org-agenda-files 'org-restrict) " []" "")
  7627. " "
  7628. '(:eval (org-agenda-span-name org-agenda-current-span))
  7629. (if org-agenda-follow-mode " Follow" "")
  7630. (if org-agenda-entry-text-mode " ETxt" "")
  7631. (if org-agenda-include-diary " Diary" "")
  7632. (if org-agenda-include-deadlines " Ddl" "")
  7633. (if org-agenda-use-time-grid " Grid" "")
  7634. (if (and (boundp 'org-habit-show-habits)
  7635. org-habit-show-habits) " Habit" "")
  7636. (cond
  7637. ((consp org-agenda-show-log) " LogAll")
  7638. ((eq org-agenda-show-log 'clockcheck) " ClkCk")
  7639. (org-agenda-show-log " Log")
  7640. (t ""))
  7641. (if (or org-agenda-category-filter
  7642. (get 'org-agenda-category-filter :preset-filter))
  7643. '(:eval (propertize
  7644. (concat " <"
  7645. (mapconcat
  7646. 'identity
  7647. (append
  7648. (get 'org-agenda-category-filter :preset-filter)
  7649. org-agenda-category-filter)
  7650. "")
  7651. ">")
  7652. 'face 'org-agenda-filter-category
  7653. 'help-echo "Category used in filtering")) "")
  7654. (if (or org-agenda-tag-filter
  7655. (get 'org-agenda-tag-filter :preset-filter))
  7656. '(:eval (propertize
  7657. (concat " {"
  7658. (mapconcat
  7659. 'identity
  7660. (append
  7661. (get 'org-agenda-tag-filter :preset-filter)
  7662. org-agenda-tag-filter)
  7663. "")
  7664. "}")
  7665. 'face 'org-agenda-filter-tags
  7666. 'help-echo "Tags used in filtering")) "")
  7667. (if (or org-agenda-effort-filter
  7668. (get 'org-agenda-effort-filter :preset-filter))
  7669. '(:eval (propertize
  7670. (concat " {"
  7671. (mapconcat
  7672. 'identity
  7673. (append
  7674. (get 'org-agenda-effort-filter :preset-filter)
  7675. org-agenda-effort-filter)
  7676. "")
  7677. "}")
  7678. 'face 'org-agenda-filter-effort
  7679. 'help-echo "Effort conditions used in filtering")) "")
  7680. (if (or org-agenda-regexp-filter
  7681. (get 'org-agenda-regexp-filter :preset-filter))
  7682. '(:eval (propertize
  7683. (concat " ["
  7684. (mapconcat
  7685. 'identity
  7686. (append
  7687. (get 'org-agenda-regexp-filter :preset-filter)
  7688. org-agenda-regexp-filter)
  7689. "")
  7690. "]")
  7691. 'face 'org-agenda-filter-regexp
  7692. 'help-echo "Regexp used in filtering")) "")
  7693. (if org-agenda-archives-mode
  7694. (if (eq org-agenda-archives-mode t)
  7695. " Archives"
  7696. (format " :%s:" org-archive-tag))
  7697. "")
  7698. (if org-agenda-clockreport-mode " Clock" "")))
  7699. (force-mode-line-update))
  7700. (defun org-agenda-update-agenda-type ()
  7701. "Update the agenda type after each command."
  7702. (setq org-agenda-type
  7703. (or (get-text-property (point) 'org-agenda-type)
  7704. (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
  7705. (defun org-agenda-next-line ()
  7706. "Move cursor to the next line, and show if follow mode is active."
  7707. (interactive)
  7708. (call-interactively 'next-line)
  7709. (org-agenda-do-context-action))
  7710. (defun org-agenda-previous-line ()
  7711. "Move cursor to the previous line, and show if follow-mode is active."
  7712. (interactive)
  7713. (call-interactively 'previous-line)
  7714. (org-agenda-do-context-action))
  7715. (defun org-agenda-next-item (n)
  7716. "Move cursor to next agenda item."
  7717. (interactive "p")
  7718. (let ((col (current-column)))
  7719. (dotimes (c n)
  7720. (when (next-single-property-change (point-at-eol) 'org-marker)
  7721. (move-end-of-line 1)
  7722. (goto-char (next-single-property-change (point) 'org-marker))))
  7723. (org-move-to-column col))
  7724. (org-agenda-do-context-action))
  7725. (defun org-agenda-previous-item (n)
  7726. "Move cursor to next agenda item."
  7727. (interactive "p")
  7728. (dotimes (c n)
  7729. (let ((col (current-column))
  7730. (goto (save-excursion
  7731. (move-end-of-line 0)
  7732. (previous-single-property-change (point) 'org-marker))))
  7733. (if goto (goto-char goto))
  7734. (org-move-to-column col)))
  7735. (org-agenda-do-context-action))
  7736. (defun org-agenda-do-context-action ()
  7737. "Show outline path and, maybe, follow mode window."
  7738. (let ((m (org-get-at-bol 'org-marker)))
  7739. (when (and (markerp m) (marker-buffer m))
  7740. (and org-agenda-follow-mode
  7741. (if org-agenda-follow-indirect
  7742. (org-agenda-tree-to-indirect-buffer nil)
  7743. (org-agenda-show)))
  7744. (and org-agenda-show-outline-path
  7745. (org-with-point-at m (org-display-outline-path t))))))
  7746. (defun org-agenda-show-tags ()
  7747. "Show the tags applicable to the current item."
  7748. (interactive)
  7749. (let* ((tags (org-get-at-bol 'tags)))
  7750. (if tags
  7751. (message "Tags are :%s:"
  7752. (org-no-properties (mapconcat 'identity tags ":")))
  7753. (message "No tags associated with this line"))))
  7754. (defun org-agenda-goto (&optional highlight)
  7755. "Go to the entry at point in the corresponding Org file."
  7756. (interactive)
  7757. (let* ((marker (or (org-get-at-bol 'org-marker)
  7758. (org-agenda-error)))
  7759. (buffer (marker-buffer marker))
  7760. (pos (marker-position marker)))
  7761. (switch-to-buffer-other-window buffer)
  7762. (widen)
  7763. (push-mark)
  7764. (goto-char pos)
  7765. (when (derived-mode-p 'org-mode)
  7766. (org-show-context 'agenda)
  7767. (recenter (/ (window-height) 2))
  7768. (org-back-to-heading t)
  7769. (let ((case-fold-search nil))
  7770. (when (re-search-forward org-complex-heading-regexp nil t)
  7771. (goto-char (match-beginning 4)))))
  7772. (run-hooks 'org-agenda-after-show-hook)
  7773. (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
  7774. (defvar org-agenda-after-show-hook nil
  7775. "Normal hook run after an item has been shown from the agenda.
  7776. Point is in the buffer where the item originated.")
  7777. (defun org-agenda-kill ()
  7778. "Kill the entry or subtree belonging to the current agenda entry."
  7779. (interactive)
  7780. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  7781. (let* ((bufname-orig (buffer-name))
  7782. (marker (or (org-get-at-bol 'org-marker)
  7783. (org-agenda-error)))
  7784. (buffer (marker-buffer marker))
  7785. (pos (marker-position marker))
  7786. (type (org-get-at-bol 'type))
  7787. dbeg dend (n 0) conf)
  7788. (org-with-remote-undo buffer
  7789. (with-current-buffer buffer
  7790. (save-excursion
  7791. (goto-char pos)
  7792. (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
  7793. (setq dbeg (progn (org-back-to-heading t) (point))
  7794. dend (org-end-of-subtree t t))
  7795. (setq dbeg (point-at-bol)
  7796. dend (min (point-max) (1+ (point-at-eol)))))
  7797. (goto-char dbeg)
  7798. (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
  7799. (setq conf (or (eq t org-agenda-confirm-kill)
  7800. (and (numberp org-agenda-confirm-kill)
  7801. (> n org-agenda-confirm-kill))))
  7802. (and conf
  7803. (not (y-or-n-p
  7804. (format "Delete entry with %d lines in buffer \"%s\"? "
  7805. n (buffer-name buffer))))
  7806. (error "Abort"))
  7807. (let ((org-agenda-buffer-name bufname-orig))
  7808. (org-remove-subtree-entries-from-agenda buffer dbeg dend))
  7809. (with-current-buffer buffer (delete-region dbeg dend))
  7810. (message "Agenda item and source killed"))))
  7811. (defvar org-archive-default-command) ; defined in org-archive.el
  7812. (defun org-agenda-archive-default ()
  7813. "Archive the entry or subtree belonging to the current agenda entry."
  7814. (interactive)
  7815. (require 'org-archive)
  7816. (org-agenda-archive-with org-archive-default-command))
  7817. (defun org-agenda-archive-default-with-confirmation ()
  7818. "Archive the entry or subtree belonging to the current agenda entry."
  7819. (interactive)
  7820. (require 'org-archive)
  7821. (org-agenda-archive-with org-archive-default-command 'confirm))
  7822. (defun org-agenda-archive ()
  7823. "Archive the entry or subtree belonging to the current agenda entry."
  7824. (interactive)
  7825. (org-agenda-archive-with 'org-archive-subtree))
  7826. (defun org-agenda-archive-to-archive-sibling ()
  7827. "Move the entry to the archive sibling."
  7828. (interactive)
  7829. (org-agenda-archive-with 'org-archive-to-archive-sibling))
  7830. (defun org-agenda-archive-with (cmd &optional confirm)
  7831. "Move the entry to the archive sibling."
  7832. (interactive)
  7833. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  7834. (let* ((bufname-orig (buffer-name))
  7835. (marker (or (org-get-at-bol 'org-marker)
  7836. (org-agenda-error)))
  7837. (buffer (marker-buffer marker))
  7838. (pos (marker-position marker)))
  7839. (org-with-remote-undo buffer
  7840. (with-current-buffer buffer
  7841. (if (derived-mode-p 'org-mode)
  7842. (if (and confirm
  7843. (not (y-or-n-p "Archive this subtree or entry? ")))
  7844. (error "Abort")
  7845. (save-window-excursion
  7846. (goto-char pos)
  7847. (let ((org-agenda-buffer-name bufname-orig))
  7848. (org-remove-subtree-entries-from-agenda))
  7849. (org-back-to-heading t)
  7850. (funcall cmd)))
  7851. (error "Archiving works only in Org files"))))))
  7852. (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
  7853. "Remove all lines in the agenda that correspond to a given subtree.
  7854. The subtree is the one in buffer BUF, starting at BEG and ending at END.
  7855. If this information is not given, the function uses the tree at point."
  7856. (let ((buf (or buf (current-buffer))) m p)
  7857. (save-excursion
  7858. (unless (and beg end)
  7859. (org-back-to-heading t)
  7860. (setq beg (point))
  7861. (org-end-of-subtree t)
  7862. (setq end (point)))
  7863. (set-buffer (get-buffer org-agenda-buffer-name))
  7864. (save-excursion
  7865. (goto-char (point-max))
  7866. (beginning-of-line 1)
  7867. (while (not (bobp))
  7868. (when (and (setq m (org-get-at-bol 'org-marker))
  7869. (equal buf (marker-buffer m))
  7870. (setq p (marker-position m))
  7871. (>= p beg)
  7872. (< p end))
  7873. (let ((inhibit-read-only t))
  7874. (delete-region (point-at-bol) (1+ (point-at-eol)))))
  7875. (beginning-of-line 0))))))
  7876. (defun org-agenda-refile (&optional goto rfloc no-update)
  7877. "Refile the item at point.
  7878. When called with `\\[universal-argument] \\[universal-argument]', \
  7879. go to the location of the last
  7880. refiled item.
  7881. When called with `\\[universal-argument] \\[universal-argument] \
  7882. \\[universal-argument]' prefix or when GOTO is 0, clear
  7883. the refile cache.
  7884. RFLOC can be a refile location obtained in a different way.
  7885. When NO-UPDATE is non-nil, don't redo the agenda buffer."
  7886. (interactive "P")
  7887. (cond
  7888. ((member goto '(0 (64)))
  7889. (org-refile-cache-clear))
  7890. ((equal goto '(16))
  7891. (org-refile-goto-last-stored))
  7892. (t
  7893. (let* ((buffer-orig (buffer-name))
  7894. (marker (or (org-get-at-bol 'org-hd-marker)
  7895. (org-agenda-error)))
  7896. (buffer (marker-buffer marker))
  7897. (pos (marker-position marker))
  7898. (rfloc (or rfloc
  7899. (org-refile-get-location
  7900. (if goto "Goto" "Refile to") buffer
  7901. org-refile-allow-creating-parent-nodes))))
  7902. (with-current-buffer buffer
  7903. (org-with-wide-buffer
  7904. (goto-char marker)
  7905. (let ((org-agenda-buffer-name buffer-orig))
  7906. (org-remove-subtree-entries-from-agenda))
  7907. (org-refile goto buffer rfloc))))
  7908. (unless no-update (org-agenda-redo)))))
  7909. (defun org-agenda-open-link (&optional arg)
  7910. "Open the link(s) in the current entry, if any.
  7911. This looks for a link in the displayed line in the agenda.
  7912. It also looks at the text of the entry itself."
  7913. (interactive "P")
  7914. (let* ((marker (or (org-get-at-bol 'org-hd-marker)
  7915. (org-get-at-bol 'org-marker)))
  7916. (buffer (and marker (marker-buffer marker)))
  7917. (prefix (buffer-substring (point-at-bol) (point-at-eol)))
  7918. (lkall (and buffer (org-offer-links-in-entry
  7919. buffer marker arg prefix)))
  7920. (lk0 (car lkall))
  7921. (lk (if (stringp lk0) (list lk0) lk0))
  7922. (lkend (cdr lkall))
  7923. trg)
  7924. (cond
  7925. ((and buffer lk)
  7926. (mapcar (lambda(l)
  7927. (with-current-buffer buffer
  7928. (setq trg (and (string-match org-bracket-link-regexp l)
  7929. (match-string 1 l)))
  7930. (if (or (not trg) (string-match org-any-link-re trg))
  7931. (org-with-wide-buffer
  7932. (goto-char marker)
  7933. (when (search-forward l nil lkend)
  7934. (goto-char (match-beginning 0))
  7935. (org-open-at-point)))
  7936. ;; This is an internal link, widen the buffer
  7937. (switch-to-buffer-other-window buffer)
  7938. (widen)
  7939. (goto-char marker)
  7940. (when (search-forward l nil lkend)
  7941. (goto-char (match-beginning 0))
  7942. (org-open-at-point)))))
  7943. lk))
  7944. ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
  7945. (save-excursion
  7946. (beginning-of-line 1)
  7947. (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
  7948. (org-open-link-from-string (match-string 1)))
  7949. (t (message "No link to open here")))))
  7950. (defun org-agenda-copy-local-variable (var)
  7951. "Get a variable from a referenced buffer and install it here."
  7952. (let ((m (org-get-at-bol 'org-marker)))
  7953. (when (and m (buffer-live-p (marker-buffer m)))
  7954. (set (make-local-variable var)
  7955. (with-current-buffer (marker-buffer m)
  7956. (symbol-value var))))))
  7957. (defun org-agenda-switch-to (&optional delete-other-windows)
  7958. "Go to the Org mode file which contains the item at point.
  7959. When optional argument DELETE-OTHER-WINDOWS is non-nil, the
  7960. displayed Org file fills the frame."
  7961. (interactive)
  7962. (if (and org-return-follows-link
  7963. (not (org-get-at-bol 'org-marker))
  7964. (org-in-regexp org-bracket-link-regexp))
  7965. (org-open-link-from-string (match-string 0))
  7966. (let* ((marker (or (org-get-at-bol 'org-marker)
  7967. (org-agenda-error)))
  7968. (buffer (marker-buffer marker))
  7969. (pos (marker-position marker)))
  7970. (unless buffer (user-error "Trying to switch to non-existent buffer"))
  7971. (pop-to-buffer-same-window buffer)
  7972. (when delete-other-windows (delete-other-windows))
  7973. (widen)
  7974. (goto-char pos)
  7975. (when (derived-mode-p 'org-mode)
  7976. (org-show-context 'agenda)
  7977. (run-hooks 'org-agenda-after-show-hook)))))
  7978. (defun org-agenda-goto-mouse (ev)
  7979. "Go to the Org file which contains the item at the mouse click."
  7980. (interactive "e")
  7981. (mouse-set-point ev)
  7982. (org-agenda-goto))
  7983. (defun org-agenda-show (&optional full-entry)
  7984. "Display the Org file which contains the item at point.
  7985. With prefix argument FULL-ENTRY, make the entire entry visible
  7986. if it was hidden in the outline."
  7987. (interactive "P")
  7988. (let ((win (selected-window)))
  7989. (org-agenda-goto t)
  7990. (when full-entry (org-show-entry))
  7991. (select-window win)))
  7992. (defvar org-agenda-show-window nil)
  7993. (defun org-agenda-show-and-scroll-up (&optional arg)
  7994. "Display the Org file which contains the item at point.
  7995. When called repeatedly, scroll the window that is displaying the buffer.
  7996. With a `\\[universal-argument]' prefix, use `org-show-entry' instead of \
  7997. `outline-show-subtree'
  7998. to display the item, so that drawers and logbooks stay folded."
  7999. (interactive "P")
  8000. (let ((win (selected-window)))
  8001. (if (and (window-live-p org-agenda-show-window)
  8002. (eq this-command last-command))
  8003. (progn
  8004. (select-window org-agenda-show-window)
  8005. (ignore-errors (scroll-up)))
  8006. (org-agenda-goto t)
  8007. (if arg (org-show-entry) (outline-show-subtree))
  8008. (setq org-agenda-show-window (selected-window)))
  8009. (select-window win)))
  8010. (defun org-agenda-show-scroll-down ()
  8011. "Scroll down the window showing the agenda."
  8012. (interactive)
  8013. (let ((win (selected-window)))
  8014. (when (window-live-p org-agenda-show-window)
  8015. (select-window org-agenda-show-window)
  8016. (ignore-errors (scroll-down))
  8017. (select-window win))))
  8018. (defun org-agenda-show-1 (&optional more)
  8019. "Display the Org file which contains the item at point.
  8020. The prefix arg selects the amount of information to display:
  8021. 0 hide the subtree
  8022. 1 just show the entry according to defaults.
  8023. 2 show the children view
  8024. 3 show the subtree view
  8025. 4 show the entire subtree and any LOGBOOK drawers
  8026. 5 show the entire subtree and any drawers
  8027. With prefix argument FULL-ENTRY, make the entire entry visible
  8028. if it was hidden in the outline."
  8029. (interactive "p")
  8030. (let ((win (selected-window)))
  8031. (org-agenda-goto t)
  8032. (org-back-to-heading)
  8033. (set-window-start (selected-window) (point-at-bol))
  8034. (cond
  8035. ((= more 0)
  8036. (outline-hide-subtree)
  8037. (save-excursion
  8038. (org-back-to-heading)
  8039. (run-hook-with-args 'org-cycle-hook 'folded))
  8040. (message "Remote: FOLDED"))
  8041. ((and (called-interactively-p 'any) (= more 1))
  8042. (message "Remote: show with default settings"))
  8043. ((= more 2)
  8044. (outline-show-entry)
  8045. (org-show-children)
  8046. (save-excursion
  8047. (org-back-to-heading)
  8048. (run-hook-with-args 'org-cycle-hook 'children))
  8049. (message "Remote: CHILDREN"))
  8050. ((= more 3)
  8051. (outline-show-subtree)
  8052. (save-excursion
  8053. (org-back-to-heading)
  8054. (run-hook-with-args 'org-cycle-hook 'subtree))
  8055. (message "Remote: SUBTREE"))
  8056. ((= more 4)
  8057. (outline-show-subtree)
  8058. (save-excursion
  8059. (org-back-to-heading)
  8060. (org-cycle-hide-drawers 'subtree '("LOGBOOK")))
  8061. (message "Remote: SUBTREE AND LOGBOOK"))
  8062. ((> more 4)
  8063. (outline-show-subtree)
  8064. (message "Remote: SUBTREE AND ALL DRAWERS")))
  8065. (select-window win)))
  8066. (defvar org-agenda-cycle-counter nil)
  8067. (defun org-agenda-cycle-show (&optional n)
  8068. "Show the current entry in another window, with default settings.
  8069. Default settings are taken from `org-show-context-detail'. When
  8070. use repeatedly in immediate succession, the remote entry will
  8071. cycle through visibility
  8072. children -> subtree -> folded
  8073. When called with a numeric prefix arg, that arg will be passed through to
  8074. `org-agenda-show-1'. For the interpretation of that argument, see the
  8075. docstring of `org-agenda-show-1'."
  8076. (interactive "P")
  8077. (if (integerp n)
  8078. (setq org-agenda-cycle-counter n)
  8079. (if (not (eq last-command this-command))
  8080. (setq org-agenda-cycle-counter 1)
  8081. (if (equal org-agenda-cycle-counter 0)
  8082. (setq org-agenda-cycle-counter 2)
  8083. (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
  8084. (if (> org-agenda-cycle-counter 3)
  8085. (setq org-agenda-cycle-counter 0)))))
  8086. (org-agenda-show-1 org-agenda-cycle-counter))
  8087. (defun org-agenda-recenter (arg)
  8088. "Display the Org file which contains the item at point and recenter."
  8089. (interactive "P")
  8090. (let ((win (selected-window)))
  8091. (org-agenda-goto t)
  8092. (recenter arg)
  8093. (select-window win)))
  8094. (defun org-agenda-show-mouse (ev)
  8095. "Display the Org file which contains the item at the mouse click."
  8096. (interactive "e")
  8097. (mouse-set-point ev)
  8098. (org-agenda-show))
  8099. (defun org-agenda-check-no-diary ()
  8100. "Check if the entry is a diary link and abort if yes."
  8101. (if (org-get-at-bol 'org-agenda-diary-link)
  8102. (org-agenda-error)))
  8103. (defun org-agenda-error ()
  8104. "Throw an error when a command is not allowed in the agenda."
  8105. (user-error "Command not allowed in this line"))
  8106. (defun org-agenda-tree-to-indirect-buffer (arg)
  8107. "Show the subtree corresponding to the current entry in an indirect buffer.
  8108. This calls the command `org-tree-to-indirect-buffer' from the original buffer.
  8109. With a numerical prefix ARG, go up to this level and then take that tree.
  8110. With a negative numeric ARG, go up by this number of levels.
  8111. With a `\\[universal-argument]' prefix, make a separate frame for this tree, \
  8112. i.e. don't use
  8113. the dedicated frame."
  8114. (interactive "P")
  8115. (if current-prefix-arg
  8116. (org-agenda-do-tree-to-indirect-buffer arg)
  8117. (let ((agenda-buffer (buffer-name))
  8118. (agenda-window (selected-window))
  8119. (indirect-window
  8120. (and org-last-indirect-buffer
  8121. (get-buffer-window org-last-indirect-buffer))))
  8122. (save-window-excursion (org-agenda-do-tree-to-indirect-buffer arg))
  8123. (unless (or (eq org-indirect-buffer-display 'new-frame)
  8124. (eq org-indirect-buffer-display 'dedicated-frame))
  8125. (unwind-protect
  8126. (unless (and indirect-window (window-live-p indirect-window))
  8127. (setq indirect-window (split-window agenda-window)))
  8128. (and indirect-window (select-window indirect-window))
  8129. (switch-to-buffer org-last-indirect-buffer :norecord)
  8130. (fit-window-to-buffer indirect-window)))
  8131. (select-window (get-buffer-window agenda-buffer))
  8132. (setq org-agenda-last-indirect-buffer org-last-indirect-buffer))))
  8133. (defun org-agenda-do-tree-to-indirect-buffer (arg)
  8134. "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
  8135. (org-agenda-check-no-diary)
  8136. (let* ((marker (or (org-get-at-bol 'org-marker)
  8137. (org-agenda-error)))
  8138. (buffer (marker-buffer marker))
  8139. (pos (marker-position marker)))
  8140. (with-current-buffer buffer
  8141. (save-excursion
  8142. (goto-char pos)
  8143. (funcall 'org-tree-to-indirect-buffer arg)))))
  8144. (defvar org-last-heading-marker (make-marker)
  8145. "Marker pointing to the headline that last changed its TODO state
  8146. by a remote command from the agenda.")
  8147. (defun org-agenda-todo-nextset ()
  8148. "Switch TODO entry to next sequence."
  8149. (interactive)
  8150. (org-agenda-todo 'nextset))
  8151. (defun org-agenda-todo-previousset ()
  8152. "Switch TODO entry to previous sequence."
  8153. (interactive)
  8154. (org-agenda-todo 'previousset))
  8155. (defun org-agenda-todo (&optional arg)
  8156. "Cycle TODO state of line at point, also in Org file.
  8157. This changes the line at point, all other lines in the agenda referring to
  8158. the same tree node, and the headline of the tree node in the Org file."
  8159. (interactive "P")
  8160. (org-agenda-check-no-diary)
  8161. (let* ((col (current-column))
  8162. (marker (or (org-get-at-bol 'org-marker)
  8163. (org-agenda-error)))
  8164. (buffer (marker-buffer marker))
  8165. (pos (marker-position marker))
  8166. (hdmarker (org-get-at-bol 'org-hd-marker))
  8167. (todayp (org-agenda-today-p (org-get-at-bol 'day)))
  8168. (inhibit-read-only t)
  8169. org-agenda-headline-snapshot-before-repeat newhead just-one)
  8170. (org-with-remote-undo buffer
  8171. (with-current-buffer buffer
  8172. (widen)
  8173. (goto-char pos)
  8174. (org-show-context 'agenda)
  8175. (let ((current-prefix-arg arg))
  8176. (call-interactively 'org-todo))
  8177. (and (bolp) (forward-char 1))
  8178. (setq newhead (org-get-heading))
  8179. (when (and (bound-and-true-p
  8180. org-agenda-headline-snapshot-before-repeat)
  8181. (not (equal org-agenda-headline-snapshot-before-repeat
  8182. newhead))
  8183. todayp)
  8184. (setq newhead org-agenda-headline-snapshot-before-repeat
  8185. just-one t))
  8186. (save-excursion
  8187. (org-back-to-heading)
  8188. (move-marker org-last-heading-marker (point))))
  8189. (beginning-of-line 1)
  8190. (save-window-excursion
  8191. (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
  8192. (when (bound-and-true-p org-clock-out-when-done)
  8193. (string-match (concat "^" (regexp-opt org-done-keywords-for-agenda))
  8194. newhead)
  8195. (org-agenda-unmark-clocking-task))
  8196. (org-move-to-column col)
  8197. (org-agenda-mark-clocking-task))))
  8198. (defun org-agenda-add-note (&optional arg)
  8199. "Add a time-stamped note to the entry at point."
  8200. (interactive "P")
  8201. (org-agenda-check-no-diary)
  8202. (let* ((marker (or (org-get-at-bol 'org-marker)
  8203. (org-agenda-error)))
  8204. (buffer (marker-buffer marker))
  8205. (pos (marker-position marker))
  8206. (hdmarker (org-get-at-bol 'org-hd-marker))
  8207. (inhibit-read-only t))
  8208. (with-current-buffer buffer
  8209. (widen)
  8210. (goto-char pos)
  8211. (org-show-context 'agenda)
  8212. (org-add-note))))
  8213. (defun org-agenda-change-all-lines (newhead hdmarker
  8214. &optional fixface just-this)
  8215. "Change all lines in the agenda buffer which match HDMARKER.
  8216. The new content of the line will be NEWHEAD (as modified by
  8217. `org-agenda-format-item'). HDMARKER is checked with
  8218. `equal' against all `org-hd-marker' text properties in the file.
  8219. If FIXFACE is non-nil, the face of each item is modified according to
  8220. the new TODO state.
  8221. If JUST-THIS is non-nil, change just the current line, not all.
  8222. If FORCE-TAGS is non nil, the car of it returns the new tags."
  8223. (let* ((inhibit-read-only t)
  8224. (line (org-current-line))
  8225. (org-agenda-buffer (current-buffer))
  8226. (thetags (with-current-buffer (marker-buffer hdmarker)
  8227. (org-with-wide-buffer
  8228. (goto-char hdmarker)
  8229. (org-get-tags-at))))
  8230. props m pl undone-face done-face finish new dotime level cat tags)
  8231. (save-excursion
  8232. (goto-char (point-max))
  8233. (beginning-of-line 1)
  8234. (while (not finish)
  8235. (setq finish (bobp))
  8236. (when (and (setq m (org-get-at-bol 'org-hd-marker))
  8237. (or (not just-this) (= (org-current-line) line))
  8238. (equal m hdmarker))
  8239. (setq props (text-properties-at (point))
  8240. dotime (org-get-at-bol 'dotime)
  8241. cat (org-get-at-eol 'org-category 1)
  8242. level (org-get-at-bol 'level)
  8243. tags thetags
  8244. new
  8245. (let ((org-prefix-format-compiled
  8246. (or (get-text-property (min (1- (point-max)) (point)) 'format)
  8247. org-prefix-format-compiled))
  8248. (extra (org-get-at-bol 'extra)))
  8249. (with-current-buffer (marker-buffer hdmarker)
  8250. (org-with-wide-buffer
  8251. (org-agenda-format-item extra newhead level cat tags dotime))))
  8252. pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
  8253. undone-face (org-get-at-bol 'undone-face)
  8254. done-face (org-get-at-bol 'done-face))
  8255. (beginning-of-line 1)
  8256. (cond
  8257. ((equal new "") (delete-region (point) (line-beginning-position 2)))
  8258. ((looking-at ".*")
  8259. ;; When replacing the whole line, preserve bulk mark
  8260. ;; overlay, if any.
  8261. (let ((mark (catch :overlay
  8262. (dolist (o (overlays-in (point) (+ 2 (point))))
  8263. (when (eq (overlay-get o 'type)
  8264. 'org-marked-entry-overlay)
  8265. (throw :overlay o))))))
  8266. (replace-match new t t)
  8267. (beginning-of-line)
  8268. (when mark (move-overlay mark (point) (+ 2 (point)))))
  8269. (add-text-properties (point-at-bol) (point-at-eol) props)
  8270. (when fixface
  8271. (add-text-properties
  8272. (point-at-bol) (point-at-eol)
  8273. (list 'face
  8274. (if org-last-todo-state-is-todo
  8275. undone-face done-face))))
  8276. (org-agenda-highlight-todo 'line)
  8277. (beginning-of-line 1))
  8278. (t (error "Line update did not work")))
  8279. (save-restriction
  8280. (narrow-to-region (point-at-bol) (point-at-eol))
  8281. (org-agenda-finalize)))
  8282. (beginning-of-line 0)))))
  8283. (defun org-agenda-align-tags (&optional line)
  8284. "Align all tags in agenda items to `org-agenda-tags-column'."
  8285. (let ((inhibit-read-only t) l c)
  8286. (save-excursion
  8287. (goto-char (if line (point-at-bol) (point-min)))
  8288. (while (re-search-forward "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"
  8289. (if line (point-at-eol) nil) t)
  8290. (add-text-properties
  8291. (match-beginning 2) (match-end 2)
  8292. (list 'face (delq nil (let ((prop (get-text-property
  8293. (match-beginning 2) 'face)))
  8294. (or (listp prop) (setq prop (list prop)))
  8295. (if (memq 'org-tag prop)
  8296. prop
  8297. (cons 'org-tag prop))))))
  8298. (setq l (- (match-end 2) (match-beginning 2))
  8299. c (if (< org-agenda-tags-column 0)
  8300. (- (abs org-agenda-tags-column) l)
  8301. org-agenda-tags-column))
  8302. (delete-region (match-beginning 1) (match-end 1))
  8303. (goto-char (match-beginning 1))
  8304. (insert (org-add-props
  8305. (make-string (max 1 (- c (current-column))) ?\ )
  8306. (plist-put (copy-sequence (text-properties-at (point)))
  8307. 'face nil))))
  8308. (goto-char (point-min))
  8309. (org-font-lock-add-tag-faces (point-max)))))
  8310. (defun org-agenda-priority-up ()
  8311. "Increase the priority of line at point, also in Org file."
  8312. (interactive)
  8313. (org-agenda-priority 'up))
  8314. (defun org-agenda-priority-down ()
  8315. "Decrease the priority of line at point, also in Org file."
  8316. (interactive)
  8317. (org-agenda-priority 'down))
  8318. (defun org-agenda-priority (&optional force-direction)
  8319. "Set the priority of line at point, also in Org file.
  8320. This changes the line at point, all other lines in the agenda referring to
  8321. the same tree node, and the headline of the tree node in the Org file.
  8322. Called with a universal prefix arg, show the priority instead of setting it."
  8323. (interactive "P")
  8324. (if (equal force-direction '(4))
  8325. (org-show-priority)
  8326. (unless org-enable-priority-commands
  8327. (error "Priority commands are disabled"))
  8328. (org-agenda-check-no-diary)
  8329. (let* ((col (current-column))
  8330. (marker (or (org-get-at-bol 'org-marker)
  8331. (org-agenda-error)))
  8332. (hdmarker (org-get-at-bol 'org-hd-marker))
  8333. (buffer (marker-buffer hdmarker))
  8334. (pos (marker-position hdmarker))
  8335. (inhibit-read-only t)
  8336. newhead)
  8337. (org-with-remote-undo buffer
  8338. (with-current-buffer buffer
  8339. (widen)
  8340. (goto-char pos)
  8341. (org-show-context 'agenda)
  8342. (funcall 'org-priority force-direction)
  8343. (end-of-line 1)
  8344. (setq newhead (org-get-heading)))
  8345. (org-agenda-change-all-lines newhead hdmarker)
  8346. (org-move-to-column col)))))
  8347. ;; FIXME: should fix the tags property of the agenda line.
  8348. (defun org-agenda-set-tags (&optional tag onoff)
  8349. "Set tags for the current headline."
  8350. (interactive)
  8351. (org-agenda-check-no-diary)
  8352. (if (and (org-region-active-p) (called-interactively-p 'any))
  8353. (call-interactively 'org-change-tag-in-region)
  8354. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8355. (org-agenda-error)))
  8356. (buffer (marker-buffer hdmarker))
  8357. (pos (marker-position hdmarker))
  8358. (inhibit-read-only t)
  8359. newhead)
  8360. (org-with-remote-undo buffer
  8361. (with-current-buffer buffer
  8362. (widen)
  8363. (goto-char pos)
  8364. (org-show-context 'agenda)
  8365. (if tag
  8366. (org-toggle-tag tag onoff)
  8367. (call-interactively 'org-set-tags))
  8368. (end-of-line 1)
  8369. (setq newhead (org-get-heading)))
  8370. (org-agenda-change-all-lines newhead hdmarker)
  8371. (beginning-of-line 1)))))
  8372. (defun org-agenda-set-property ()
  8373. "Set a property for the current headline."
  8374. (interactive)
  8375. (org-agenda-check-no-diary)
  8376. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8377. (org-agenda-error)))
  8378. (buffer (marker-buffer hdmarker))
  8379. (pos (marker-position hdmarker))
  8380. (inhibit-read-only t)
  8381. newhead)
  8382. (org-with-remote-undo buffer
  8383. (with-current-buffer buffer
  8384. (widen)
  8385. (goto-char pos)
  8386. (org-show-context 'agenda)
  8387. (call-interactively 'org-set-property)))))
  8388. (defun org-agenda-set-effort ()
  8389. "Set the effort property for the current headline."
  8390. (interactive)
  8391. (org-agenda-check-no-diary)
  8392. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8393. (org-agenda-error)))
  8394. (buffer (marker-buffer hdmarker))
  8395. (pos (marker-position hdmarker))
  8396. (inhibit-read-only t)
  8397. newhead)
  8398. (org-with-remote-undo buffer
  8399. (with-current-buffer buffer
  8400. (widen)
  8401. (goto-char pos)
  8402. (org-show-context 'agenda)
  8403. (call-interactively 'org-set-effort)
  8404. (end-of-line 1)
  8405. (setq newhead (org-get-heading)))
  8406. (org-agenda-change-all-lines newhead hdmarker))))
  8407. (defun org-agenda-toggle-archive-tag ()
  8408. "Toggle the archive tag for the current entry."
  8409. (interactive)
  8410. (org-agenda-check-no-diary)
  8411. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8412. (org-agenda-error)))
  8413. (buffer (marker-buffer hdmarker))
  8414. (pos (marker-position hdmarker))
  8415. (inhibit-read-only t)
  8416. newhead)
  8417. (org-with-remote-undo buffer
  8418. (with-current-buffer buffer
  8419. (widen)
  8420. (goto-char pos)
  8421. (org-show-context 'agenda)
  8422. (call-interactively 'org-toggle-archive-tag)
  8423. (end-of-line 1)
  8424. (setq newhead (org-get-heading)))
  8425. (org-agenda-change-all-lines newhead hdmarker)
  8426. (beginning-of-line 1))))
  8427. (defun org-agenda-do-date-later (arg)
  8428. (interactive "P")
  8429. (cond
  8430. ((or (equal arg '(16))
  8431. (memq last-command
  8432. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  8433. (setq this-command 'org-agenda-date-later-minutes)
  8434. (org-agenda-date-later-minutes 1))
  8435. ((or (equal arg '(4))
  8436. (memq last-command
  8437. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  8438. (setq this-command 'org-agenda-date-later-hours)
  8439. (org-agenda-date-later-hours 1))
  8440. (t
  8441. (org-agenda-date-later (prefix-numeric-value arg)))))
  8442. (defun org-agenda-do-date-earlier (arg)
  8443. (interactive "P")
  8444. (cond
  8445. ((or (equal arg '(16))
  8446. (memq last-command
  8447. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  8448. (setq this-command 'org-agenda-date-earlier-minutes)
  8449. (org-agenda-date-earlier-minutes 1))
  8450. ((or (equal arg '(4))
  8451. (memq last-command
  8452. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  8453. (setq this-command 'org-agenda-date-earlier-hours)
  8454. (org-agenda-date-earlier-hours 1))
  8455. (t
  8456. (org-agenda-date-earlier (prefix-numeric-value arg)))))
  8457. (defun org-agenda-date-later (arg &optional what)
  8458. "Change the date of this item to ARG day(s) later."
  8459. (interactive "p")
  8460. (org-agenda-check-type t 'agenda 'timeline)
  8461. (org-agenda-check-no-diary)
  8462. (let* ((marker (or (org-get-at-bol 'org-marker)
  8463. (org-agenda-error)))
  8464. (buffer (marker-buffer marker))
  8465. (pos (marker-position marker))
  8466. cdate today)
  8467. (org-with-remote-undo buffer
  8468. (with-current-buffer buffer
  8469. (widen)
  8470. (goto-char pos)
  8471. (unless (org-at-timestamp-p 'lax) (error "Cannot find time stamp"))
  8472. (when (and org-agenda-move-date-from-past-immediately-to-today
  8473. (equal arg 1)
  8474. (or (not what) (eq what 'day))
  8475. (not (save-match-data (org-at-date-range-p))))
  8476. (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
  8477. cdate (calendar-absolute-from-gregorian
  8478. (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
  8479. today (org-today))
  8480. (if (> today cdate)
  8481. ;; immediately shift to today
  8482. (setq arg (- today cdate))))
  8483. (org-timestamp-change arg (or what 'day))
  8484. (when (and (org-at-date-range-p)
  8485. (re-search-backward org-tr-regexp-both (point-at-bol)))
  8486. (let ((end org-last-changed-timestamp))
  8487. (org-timestamp-change arg (or what 'day))
  8488. (setq org-last-changed-timestamp
  8489. (concat org-last-changed-timestamp "--" end)))))
  8490. (org-agenda-show-new-time marker org-last-changed-timestamp))
  8491. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  8492. (defun org-agenda-date-earlier (arg &optional what)
  8493. "Change the date of this item to ARG day(s) earlier."
  8494. (interactive "p")
  8495. (org-agenda-date-later (- arg) what))
  8496. (defun org-agenda-date-later-minutes (arg)
  8497. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  8498. (interactive "p")
  8499. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  8500. (org-agenda-date-later arg 'minute))
  8501. (defun org-agenda-date-earlier-minutes (arg)
  8502. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  8503. (interactive "p")
  8504. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  8505. (org-agenda-date-earlier arg 'minute))
  8506. (defun org-agenda-date-later-hours (arg)
  8507. "Change the time of this item, in hour steps."
  8508. (interactive "p")
  8509. (org-agenda-date-later arg 'hour))
  8510. (defun org-agenda-date-earlier-hours (arg)
  8511. "Change the time of this item, in hour steps."
  8512. (interactive "p")
  8513. (org-agenda-date-earlier arg 'hour))
  8514. (defun org-agenda-show-new-time (marker stamp &optional prefix)
  8515. "Show new date stamp via text properties."
  8516. ;; We use text properties to make this undoable
  8517. (let ((inhibit-read-only t))
  8518. (setq stamp (concat prefix " => " stamp " "))
  8519. (save-excursion
  8520. (goto-char (point-max))
  8521. (while (not (bobp))
  8522. (when (equal marker (org-get-at-bol 'org-marker))
  8523. (remove-text-properties (point-at-bol) (point-at-eol) '(display))
  8524. (org-move-to-column (- (window-width) (length stamp)) t)
  8525. (add-text-properties
  8526. (1- (point)) (point-at-eol)
  8527. (list 'display (org-add-props stamp nil
  8528. 'face '(secondary-selection default))))
  8529. (beginning-of-line 1))
  8530. (beginning-of-line 0)))))
  8531. (defun org-agenda-date-prompt (arg)
  8532. "Change the date of this item. Date is prompted for, with default today.
  8533. The prefix ARG is passed to the `org-time-stamp' command and can therefore
  8534. be used to request time specification in the time stamp."
  8535. (interactive "P")
  8536. (org-agenda-check-type t 'agenda 'timeline)
  8537. (org-agenda-check-no-diary)
  8538. (let* ((marker (or (org-get-at-bol 'org-marker)
  8539. (org-agenda-error)))
  8540. (buffer (marker-buffer marker))
  8541. (pos (marker-position marker)))
  8542. (org-with-remote-undo buffer
  8543. (with-current-buffer buffer
  8544. (widen)
  8545. (goto-char pos)
  8546. (unless (org-at-timestamp-p 'lax) (error "Cannot find time stamp"))
  8547. (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
  8548. (org-agenda-show-new-time marker org-last-changed-timestamp))
  8549. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  8550. (defun org-agenda-schedule (arg &optional time)
  8551. "Schedule the item at point.
  8552. ARG is passed through to `org-schedule'."
  8553. (interactive "P")
  8554. (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
  8555. (org-agenda-check-no-diary)
  8556. (let* ((marker (or (org-get-at-bol 'org-marker)
  8557. (org-agenda-error)))
  8558. (type (marker-insertion-type marker))
  8559. (buffer (marker-buffer marker))
  8560. (pos (marker-position marker))
  8561. ts)
  8562. (set-marker-insertion-type marker t)
  8563. (org-with-remote-undo buffer
  8564. (with-current-buffer buffer
  8565. (widen)
  8566. (goto-char pos)
  8567. (setq ts (org-schedule arg time)))
  8568. (org-agenda-show-new-time marker ts " S"))
  8569. (message "%s" ts)))
  8570. (defun org-agenda-deadline (arg &optional time)
  8571. "Schedule the item at point.
  8572. ARG is passed through to `org-deadline'."
  8573. (interactive "P")
  8574. (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
  8575. (org-agenda-check-no-diary)
  8576. (let* ((marker (or (org-get-at-bol 'org-marker)
  8577. (org-agenda-error)))
  8578. (buffer (marker-buffer marker))
  8579. (pos (marker-position marker))
  8580. ts)
  8581. (org-with-remote-undo buffer
  8582. (with-current-buffer buffer
  8583. (widen)
  8584. (goto-char pos)
  8585. (setq ts (org-deadline arg time)))
  8586. (org-agenda-show-new-time marker ts " D"))
  8587. (message "%s" ts)))
  8588. (defun org-agenda-clock-in (&optional arg)
  8589. "Start the clock on the currently selected item."
  8590. (interactive "P")
  8591. (org-agenda-check-no-diary)
  8592. (if (equal arg '(4))
  8593. (org-clock-in arg)
  8594. (let* ((marker (or (org-get-at-bol 'org-marker)
  8595. (org-agenda-error)))
  8596. (hdmarker (or (org-get-at-bol 'org-hd-marker) marker))
  8597. (pos (marker-position marker))
  8598. (col (current-column))
  8599. newhead)
  8600. (org-with-remote-undo (marker-buffer marker)
  8601. (with-current-buffer (marker-buffer marker)
  8602. (widen)
  8603. (goto-char pos)
  8604. (org-show-context 'agenda)
  8605. (org-cycle-hide-drawers 'children)
  8606. (org-clock-in arg)
  8607. (setq newhead (org-get-heading)))
  8608. (org-agenda-change-all-lines newhead hdmarker))
  8609. (org-move-to-column col))))
  8610. (defun org-agenda-clock-out ()
  8611. "Stop the currently running clock."
  8612. (interactive)
  8613. (unless (marker-buffer org-clock-marker)
  8614. (error "No running clock"))
  8615. (let ((marker (make-marker)) (col (current-column)) newhead)
  8616. (org-with-remote-undo (marker-buffer org-clock-marker)
  8617. (with-current-buffer (marker-buffer org-clock-marker)
  8618. (org-with-wide-buffer
  8619. (goto-char org-clock-marker)
  8620. (org-back-to-heading t)
  8621. (move-marker marker (point))
  8622. (org-clock-out)
  8623. (setq newhead (org-get-heading)))))
  8624. (org-agenda-change-all-lines newhead marker)
  8625. (move-marker marker nil)
  8626. (org-move-to-column col)
  8627. (org-agenda-unmark-clocking-task)))
  8628. (defun org-agenda-clock-cancel (&optional arg)
  8629. "Cancel the currently running clock."
  8630. (interactive "P")
  8631. (unless (marker-buffer org-clock-marker)
  8632. (user-error "No running clock"))
  8633. (org-with-remote-undo (marker-buffer org-clock-marker)
  8634. (org-clock-cancel)))
  8635. (defun org-agenda-clock-goto ()
  8636. "Jump to the currently clocked in task within the agenda.
  8637. If the currently clocked in task is not listed in the agenda
  8638. buffer, display it in another window."
  8639. (interactive)
  8640. (let (pos)
  8641. (mapc (lambda (o)
  8642. (if (eq (overlay-get o 'type) 'org-agenda-clocking)
  8643. (setq pos (overlay-start o))))
  8644. (overlays-in (point-min) (point-max)))
  8645. (cond (pos (goto-char pos))
  8646. ;; If the currently clocked entry is not in the agenda
  8647. ;; buffer, we visit it in another window:
  8648. ((bound-and-true-p org-clock-current-task)
  8649. (org-switch-to-buffer-other-window (org-clock-goto)))
  8650. (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
  8651. (defun org-agenda-diary-entry-in-org-file ()
  8652. "Make a diary entry in the file `org-agenda-diary-file'."
  8653. (let (d1 d2 char (text "") dp1 dp2)
  8654. (if (equal (buffer-name) "*Calendar*")
  8655. (setq d1 (calendar-cursor-to-date t)
  8656. d2 (car calendar-mark-ring))
  8657. (setq dp1 (get-text-property (point-at-bol) 'day))
  8658. (unless dp1 (user-error "No date defined in current line"))
  8659. (setq d1 (calendar-gregorian-from-absolute dp1)
  8660. d2 (and (ignore-errors (mark))
  8661. (save-excursion
  8662. (goto-char (mark))
  8663. (setq dp2 (get-text-property (point-at-bol) 'day)))
  8664. (calendar-gregorian-from-absolute dp2))))
  8665. (message "Diary entry: [d]ay [a]nniversary [b]lock [j]ump to date tree")
  8666. (setq char (read-char-exclusive))
  8667. (cond
  8668. ((equal char ?d)
  8669. (setq text (read-string "Day entry: "))
  8670. (org-agenda-add-entry-to-org-agenda-diary-file 'day text d1)
  8671. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  8672. ((equal char ?a)
  8673. (setq d1 (list (car d1) (nth 1 d1)
  8674. (read-number (format "Reference year [%d]: " (nth 2 d1))
  8675. (nth 2 d1))))
  8676. (setq text (read-string "Anniversary (use %d to show years): "))
  8677. (org-agenda-add-entry-to-org-agenda-diary-file 'anniversary text d1)
  8678. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  8679. ((equal char ?b)
  8680. (setq text (read-string "Block entry: "))
  8681. (unless (and d1 d2 (not (equal d1 d2)))
  8682. (user-error "No block of days selected"))
  8683. (org-agenda-add-entry-to-org-agenda-diary-file 'block text d1 d2)
  8684. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  8685. ((equal char ?j)
  8686. (org-switch-to-buffer-other-window
  8687. (find-file-noselect org-agenda-diary-file))
  8688. (require 'org-datetree)
  8689. (org-datetree-find-date-create d1)
  8690. (org-reveal t))
  8691. (t (user-error "Invalid selection character `%c'" char)))))
  8692. (defcustom org-agenda-insert-diary-strategy 'date-tree
  8693. "Where in `org-agenda-diary-file' should new entries be added?
  8694. Valid values:
  8695. date-tree in the date tree, as first child of the date
  8696. date-tree-last in the date tree, as last child of the date
  8697. top-level as top-level entries at the end of the file."
  8698. :group 'org-agenda
  8699. :type '(choice
  8700. (const :tag "first in a date tree" date-tree)
  8701. (const :tag "last in a date tree" date-tree-last)
  8702. (const :tag "as top level at end of file" top-level)))
  8703. (defcustom org-agenda-insert-diary-extract-time nil
  8704. "Non-nil means extract any time specification from the diary entry."
  8705. :group 'org-agenda
  8706. :version "24.1"
  8707. :type 'boolean)
  8708. (defcustom org-agenda-bulk-mark-char ">"
  8709. "A single-character string to be used as the bulk mark."
  8710. :group 'org-agenda
  8711. :version "24.1"
  8712. :type 'string)
  8713. (defun org-agenda-add-entry-to-org-agenda-diary-file (type text &optional d1 d2)
  8714. "Add a diary entry with TYPE to `org-agenda-diary-file'.
  8715. If TEXT is not empty, it will become the headline of the new entry, and
  8716. the resulting entry will not be shown. When TEXT is empty, switch to
  8717. `org-agenda-diary-file' and let the user finish the entry there."
  8718. (let ((cw (current-window-configuration)))
  8719. (org-switch-to-buffer-other-window
  8720. (find-file-noselect org-agenda-diary-file))
  8721. (widen)
  8722. (goto-char (point-min))
  8723. (cond
  8724. ((eq type 'anniversary)
  8725. (or (re-search-forward "^*[ \t]+Anniversaries" nil t)
  8726. (progn
  8727. (or (org-at-heading-p t)
  8728. (progn
  8729. (outline-next-heading)
  8730. (insert "* Anniversaries\n\n")
  8731. (beginning-of-line -1)))))
  8732. (outline-next-heading)
  8733. (org-back-over-empty-lines)
  8734. (backward-char 1)
  8735. (insert "\n")
  8736. (insert (format "%%%%(org-anniversary %d %2d %2d) %s"
  8737. (nth 2 d1) (car d1) (nth 1 d1) text)))
  8738. ((eq type 'day)
  8739. (let ((org-prefix-has-time t)
  8740. (org-agenda-time-leading-zero t)
  8741. fmt time time2)
  8742. (if org-agenda-insert-diary-extract-time
  8743. ;; Use org-agenda-format-item to parse text for a time-range and
  8744. ;; remove it. FIXME: This is a hack, we should refactor
  8745. ;; that function to make time extraction available separately
  8746. (setq fmt (org-agenda-format-item nil text nil nil nil t)
  8747. time (get-text-property 0 'time fmt)
  8748. time2 (if (> (length time) 0)
  8749. ;; split-string removes trailing ...... if
  8750. ;; no end time given. First space
  8751. ;; separates time from date.
  8752. (concat " " (car (split-string time "\\.")))
  8753. nil)
  8754. text (get-text-property 0 'txt fmt)))
  8755. (if (eq org-agenda-insert-diary-strategy 'top-level)
  8756. (org-agenda-insert-diary-as-top-level text)
  8757. (require 'org-datetree)
  8758. (org-datetree-find-date-create d1)
  8759. (org-agenda-insert-diary-make-new-entry text))
  8760. (org-insert-time-stamp (org-time-from-absolute
  8761. (calendar-absolute-from-gregorian d1))
  8762. nil nil nil nil time2))
  8763. (end-of-line 0))
  8764. ((eq type 'block)
  8765. (if (> (calendar-absolute-from-gregorian d1)
  8766. (calendar-absolute-from-gregorian d2))
  8767. (setq d1 (prog1 d2 (setq d2 d1))))
  8768. (if (eq org-agenda-insert-diary-strategy 'top-level)
  8769. (org-agenda-insert-diary-as-top-level text)
  8770. (require 'org-datetree)
  8771. (org-datetree-find-date-create d1)
  8772. (org-agenda-insert-diary-make-new-entry text))
  8773. (org-insert-time-stamp (org-time-from-absolute
  8774. (calendar-absolute-from-gregorian d1)))
  8775. (insert "--")
  8776. (org-insert-time-stamp (org-time-from-absolute
  8777. (calendar-absolute-from-gregorian d2)))
  8778. (end-of-line 0)))
  8779. (if (string-match "\\S-" text)
  8780. (progn
  8781. (set-window-configuration cw)
  8782. (message "%s entry added to %s"
  8783. (capitalize (symbol-name type))
  8784. (abbreviate-file-name org-agenda-diary-file)))
  8785. (org-reveal t)
  8786. (message "Please finish entry here"))))
  8787. (defun org-agenda-insert-diary-as-top-level (text)
  8788. "Make new entry as a top-level entry at the end of the file.
  8789. Add TEXT as headline, and position the cursor in the second line so that
  8790. a timestamp can be added there."
  8791. (widen)
  8792. (goto-char (point-max))
  8793. (unless (bolp) (insert "\n"))
  8794. (org-insert-heading nil t t)
  8795. (insert text)
  8796. (org-end-of-meta-data)
  8797. (unless (bolp) (insert "\n"))
  8798. (when org-adapt-indentation (indent-to-column 2)))
  8799. (defun org-agenda-insert-diary-make-new-entry (text)
  8800. "Make a new entry with TEXT as a child of the current subtree.
  8801. Position the point in the heading's first body line so that
  8802. a timestamp can be added there."
  8803. (cond
  8804. ((eq org-agenda-insert-diary-strategy 'date-tree-last)
  8805. (end-of-line)
  8806. (org-insert-heading '(4) t)
  8807. (org-do-demote))
  8808. (t
  8809. (outline-next-heading)
  8810. (org-back-over-empty-lines)
  8811. (unless (looking-at "[ \t]*$") (save-excursion (insert "\n")))
  8812. (org-insert-heading nil t)
  8813. (org-do-demote)))
  8814. (let ((col (current-column)))
  8815. (insert text)
  8816. (org-end-of-meta-data)
  8817. ;; Ensure point is left on a blank line, at proper indentation.
  8818. (unless (bolp) (insert "\n"))
  8819. (unless (looking-at-p "^[ \t]*$") (save-excursion (insert "\n")))
  8820. (when org-adapt-indentation (indent-to-column col)))
  8821. (org-show-set-visibility 'lineage))
  8822. (defun org-agenda-diary-entry ()
  8823. "Make a diary entry, like the `i' command from the calendar.
  8824. All the standard commands work: block, weekly etc.
  8825. When `org-agenda-diary-file' points to a file,
  8826. `org-agenda-diary-entry-in-org-file' is called instead to create
  8827. entries in that Org file."
  8828. (interactive)
  8829. (if (not (eq org-agenda-diary-file 'diary-file))
  8830. (org-agenda-diary-entry-in-org-file)
  8831. (require 'diary-lib)
  8832. (let* ((char (progn
  8833. (message "Diary entry: [d]ay [w]eekly [m]onthly [y]early [a]nniversary [b]lock [c]yclic")
  8834. (read-char-exclusive)))
  8835. (cmd (cdr (assoc char
  8836. '((?d . diary-insert-entry)
  8837. (?w . diary-insert-weekly-entry)
  8838. (?m . diary-insert-monthly-entry)
  8839. (?y . diary-insert-yearly-entry)
  8840. (?a . diary-insert-anniversary-entry)
  8841. (?b . diary-insert-block-entry)
  8842. (?c . diary-insert-cyclic-entry)))))
  8843. (oldf (symbol-function 'calendar-cursor-to-date))
  8844. ;; (buf (get-file-buffer (substitute-in-file-name diary-file)))
  8845. (point (point))
  8846. (mark (or (mark t) (point))))
  8847. (unless cmd
  8848. (user-error "No command associated with <%c>" char))
  8849. (unless (and (get-text-property point 'day)
  8850. (or (not (equal ?b char))
  8851. (get-text-property mark 'day)))
  8852. (user-error "Don't know which date to use for diary entry"))
  8853. ;; We implement this by hacking the `calendar-cursor-to-date' function
  8854. ;; and the `calendar-mark-ring' variable. Saves a lot of code.
  8855. (let ((calendar-mark-ring
  8856. (list (calendar-gregorian-from-absolute
  8857. (or (get-text-property mark 'day)
  8858. (get-text-property point 'day))))))
  8859. (unwind-protect
  8860. (progn
  8861. (fset 'calendar-cursor-to-date
  8862. (lambda (&optional error dummy)
  8863. (calendar-gregorian-from-absolute
  8864. (get-text-property point 'day))))
  8865. (call-interactively cmd))
  8866. (fset 'calendar-cursor-to-date oldf))))))
  8867. (defun org-agenda-execute-calendar-command (cmd)
  8868. "Execute a calendar command from the agenda with date from cursor."
  8869. (org-agenda-check-type t 'agenda 'timeline)
  8870. (require 'diary-lib)
  8871. (unless (get-text-property (min (1- (point-max)) (point)) 'day)
  8872. (user-error "Don't know which date to use for the calendar command"))
  8873. (let* ((oldf (symbol-function 'calendar-cursor-to-date))
  8874. (point (point))
  8875. (date (calendar-gregorian-from-absolute
  8876. (get-text-property point 'day)))
  8877. ;; the following 2 vars are needed in the calendar
  8878. (displayed-month (car date))
  8879. (displayed-year (nth 2 date)))
  8880. (unwind-protect
  8881. (progn
  8882. (fset 'calendar-cursor-to-date
  8883. (lambda (&optional error dummy)
  8884. (calendar-gregorian-from-absolute
  8885. (get-text-property point 'day))))
  8886. (call-interactively cmd))
  8887. (fset 'calendar-cursor-to-date oldf))))
  8888. (defun org-agenda-phases-of-moon ()
  8889. "Display the phases of the moon for the 3 months around the cursor date."
  8890. (interactive)
  8891. (org-agenda-execute-calendar-command 'calendar-lunar-phases))
  8892. (defun org-agenda-holidays ()
  8893. "Display the holidays for the 3 months around the cursor date."
  8894. (interactive)
  8895. (org-agenda-execute-calendar-command 'calendar-list-holidays))
  8896. (defvar calendar-longitude) ; defined in calendar.el
  8897. (defvar calendar-latitude) ; defined in calendar.el
  8898. (defvar calendar-location-name) ; defined in calendar.el
  8899. (defun org-agenda-sunrise-sunset (arg)
  8900. "Display sunrise and sunset for the cursor date.
  8901. Latitude and longitude can be specified with the variables
  8902. `calendar-latitude' and `calendar-longitude'. When called with prefix
  8903. argument, latitude and longitude will be prompted for."
  8904. (interactive "P")
  8905. (require 'solar)
  8906. (let ((calendar-longitude (if arg nil calendar-longitude))
  8907. (calendar-latitude (if arg nil calendar-latitude))
  8908. (calendar-location-name
  8909. (if arg "the given coordinates" calendar-location-name)))
  8910. (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
  8911. (defun org-agenda-goto-calendar ()
  8912. "Open the Emacs calendar with the date at the cursor."
  8913. (interactive)
  8914. (org-agenda-check-type t 'agenda 'timeline)
  8915. (let* ((day (or (get-text-property (min (1- (point-max)) (point)) 'day)
  8916. (user-error "Don't know which date to open in calendar")))
  8917. (date (calendar-gregorian-from-absolute day))
  8918. (calendar-move-hook nil)
  8919. (calendar-view-holidays-initially-flag nil)
  8920. (calendar-view-diary-initially-flag nil))
  8921. (calendar)
  8922. (calendar-goto-date date)))
  8923. ;;;###autoload
  8924. (defun org-calendar-goto-agenda ()
  8925. "Compute the Org agenda for the calendar date displayed at the cursor.
  8926. This is a command that has to be installed in `calendar-mode-map'."
  8927. (interactive)
  8928. ;; Temporarily disable sticky agenda since user clearly wants to
  8929. ;; refresh view anyway.
  8930. (let ((org-agenda-buffer-tmp-name "*Org Agenda(a)*")
  8931. (org-agenda-sticky nil))
  8932. (org-agenda-list nil (calendar-absolute-from-gregorian
  8933. (calendar-cursor-to-date))
  8934. nil)))
  8935. (defun org-agenda-convert-date ()
  8936. (interactive)
  8937. (org-agenda-check-type t 'agenda 'timeline)
  8938. (let ((day (get-text-property (min (1- (point-max)) (point)) 'day))
  8939. date s)
  8940. (unless day
  8941. (user-error "Don't know which date to convert"))
  8942. (setq date (calendar-gregorian-from-absolute day))
  8943. (setq s (concat
  8944. "Gregorian: " (calendar-date-string date) "\n"
  8945. "ISO: " (calendar-iso-date-string date) "\n"
  8946. "Day of Yr: " (calendar-day-of-year-string date) "\n"
  8947. "Julian: " (calendar-julian-date-string date) "\n"
  8948. "Astron. JD: " (calendar-astro-date-string date)
  8949. " (Julian date number at noon UTC)\n"
  8950. "Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
  8951. "Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
  8952. "French: " (calendar-french-date-string date) "\n"
  8953. "Bahá’í: " (calendar-bahai-date-string date) " (until sunset)\n"
  8954. "Mayan: " (calendar-mayan-date-string date) "\n"
  8955. "Coptic: " (calendar-coptic-date-string date) "\n"
  8956. "Ethiopic: " (calendar-ethiopic-date-string date) "\n"
  8957. "Persian: " (calendar-persian-date-string date) "\n"
  8958. "Chinese: " (calendar-chinese-date-string date) "\n"))
  8959. (with-output-to-temp-buffer "*Dates*"
  8960. (princ s))
  8961. (org-fit-window-to-buffer (get-buffer-window "*Dates*"))))
  8962. ;;; Bulk commands
  8963. (defun org-agenda-bulk-marked-p ()
  8964. "Non-nil when current entry is marked for bulk action."
  8965. (eq (get-char-property (point-at-bol) 'type)
  8966. 'org-marked-entry-overlay))
  8967. (defun org-agenda-bulk-mark (&optional arg)
  8968. "Mark the entry at point for future bulk action."
  8969. (interactive "p")
  8970. (dotimes (i (or arg 1))
  8971. (unless (org-get-at-bol 'org-agenda-diary-link)
  8972. (let* ((m (org-get-at-bol 'org-hd-marker))
  8973. ov)
  8974. (unless (org-agenda-bulk-marked-p)
  8975. (unless m (user-error "Nothing to mark at point"))
  8976. (push m org-agenda-bulk-marked-entries)
  8977. (setq ov (make-overlay (point-at-bol) (+ 2 (point-at-bol))))
  8978. (org-overlay-display ov (concat org-agenda-bulk-mark-char " ")
  8979. (org-get-todo-face "TODO")
  8980. 'evaporate)
  8981. (overlay-put ov 'type 'org-marked-entry-overlay))
  8982. (end-of-line 1)
  8983. (or (ignore-errors
  8984. (goto-char (next-single-property-change (point) 'org-hd-marker)))
  8985. (beginning-of-line 2))
  8986. (while (and (get-char-property (point) 'invisible) (not (eobp)))
  8987. (beginning-of-line 2))
  8988. (message "%d entries marked for bulk action"
  8989. (length org-agenda-bulk-marked-entries))))))
  8990. (defun org-agenda-bulk-mark-all ()
  8991. "Mark all entries for future agenda bulk action."
  8992. (interactive)
  8993. (org-agenda-bulk-mark-regexp "."))
  8994. (defun org-agenda-bulk-mark-regexp (regexp)
  8995. "Mark entries matching REGEXP for future agenda bulk action."
  8996. (interactive "sMark entries matching regexp: ")
  8997. (let ((entries-marked 0) txt-at-point)
  8998. (save-excursion
  8999. (goto-char (point-min))
  9000. (goto-char (next-single-property-change (point) 'org-hd-marker))
  9001. (while (and (re-search-forward regexp nil t)
  9002. (setq txt-at-point (get-text-property (point) 'txt)))
  9003. (if (get-char-property (point) 'invisible)
  9004. (beginning-of-line 2)
  9005. (when (string-match regexp txt-at-point)
  9006. (setq entries-marked (1+ entries-marked))
  9007. (call-interactively 'org-agenda-bulk-mark)))))
  9008. (if (not entries-marked)
  9009. (message "No entry matching this regexp."))))
  9010. (defun org-agenda-bulk-unmark (&optional arg)
  9011. "Unmark the entry at point for future bulk action."
  9012. (interactive "P")
  9013. (if arg
  9014. (org-agenda-bulk-unmark-all)
  9015. (cond ((org-agenda-bulk-marked-p)
  9016. (org-agenda-bulk-remove-overlays
  9017. (point-at-bol) (+ 2 (point-at-bol)))
  9018. (setq org-agenda-bulk-marked-entries
  9019. (delete (org-get-at-bol 'org-hd-marker)
  9020. org-agenda-bulk-marked-entries))
  9021. (end-of-line 1)
  9022. (or (ignore-errors
  9023. (goto-char (next-single-property-change (point) 'txt)))
  9024. (beginning-of-line 2))
  9025. (while (and (get-char-property (point) 'invisible) (not (eobp)))
  9026. (beginning-of-line 2))
  9027. (message "%d entries left marked for bulk action"
  9028. (length org-agenda-bulk-marked-entries)))
  9029. (t (message "No entry to unmark here")))))
  9030. (defun org-agenda-bulk-toggle-all ()
  9031. "Toggle all marks for bulk action."
  9032. (interactive)
  9033. (save-excursion
  9034. (goto-char (point-min))
  9035. (while (ignore-errors
  9036. (goto-char (next-single-property-change (point) 'org-hd-marker)))
  9037. (org-agenda-bulk-toggle))))
  9038. (defun org-agenda-bulk-toggle ()
  9039. "Toggle the mark at point for bulk action."
  9040. (interactive)
  9041. (if (org-agenda-bulk-marked-p)
  9042. (org-agenda-bulk-unmark)
  9043. (org-agenda-bulk-mark)))
  9044. (defun org-agenda-bulk-remove-overlays (&optional beg end)
  9045. "Remove the mark overlays between BEG and END in the agenda buffer.
  9046. BEG and END default to the buffer limits.
  9047. This only removes the overlays, it does not remove the markers
  9048. from the list in `org-agenda-bulk-marked-entries'."
  9049. (interactive)
  9050. (mapc (lambda (ov)
  9051. (and (eq (overlay-get ov 'type) 'org-marked-entry-overlay)
  9052. (delete-overlay ov)))
  9053. (overlays-in (or beg (point-min)) (or end (point-max)))))
  9054. (defun org-agenda-bulk-unmark-all ()
  9055. "Remove all marks in the agenda buffer.
  9056. This will remove the markers and the overlays."
  9057. (interactive)
  9058. (if (null org-agenda-bulk-marked-entries)
  9059. (message "No entry to unmark")
  9060. (setq org-agenda-bulk-marked-entries nil)
  9061. (org-agenda-bulk-remove-overlays (point-min) (point-max))))
  9062. (defcustom org-agenda-persistent-marks nil
  9063. "Non-nil means marked items will stay marked after a bulk action.
  9064. You can toggle this interactively by typing `p' when prompted for a
  9065. bulk action."
  9066. :group 'org-agenda
  9067. :version "24.1"
  9068. :type 'boolean)
  9069. (defun org-agenda-bulk-action (&optional arg)
  9070. "Execute an remote-editing action on all marked entries.
  9071. The prefix arg is passed through to the command if possible."
  9072. (interactive "P")
  9073. ;; Make sure we have markers, and only valid ones.
  9074. (unless org-agenda-bulk-marked-entries (user-error "No entries are marked"))
  9075. (dolist (m org-agenda-bulk-marked-entries)
  9076. (unless (and (markerp m)
  9077. (marker-buffer m)
  9078. (buffer-live-p (marker-buffer m))
  9079. (marker-position m))
  9080. (user-error "Marker %s for bulk command is invalid" m)))
  9081. ;; Prompt for the bulk command.
  9082. (message
  9083. (concat (if org-agenda-persistent-marks "Bulk (persistent): " "Bulk: ")
  9084. "[$]arch [A]rch->sib [t]odo [+/-]tag [s]chd [d]eadline [r]efile "
  9085. "[S]catter [f]unction "
  9086. (and org-agenda-bulk-custom-functions
  9087. (format " Custom: [%s]"
  9088. (mapconcat (lambda (f) (char-to-string (car f)))
  9089. org-agenda-bulk-custom-functions
  9090. "")))))
  9091. (catch 'exit
  9092. (let* ((org-log-refile (if org-log-refile 'time nil))
  9093. (entries (reverse org-agenda-bulk-marked-entries))
  9094. (org-overriding-default-time
  9095. (and (get-text-property (point) 'org-agenda-date-header)
  9096. (org-get-cursor-date)))
  9097. redo-at-end
  9098. cmd)
  9099. (pcase (read-char-exclusive)
  9100. (?p
  9101. (let ((org-agenda-persistent-marks
  9102. (not org-agenda-persistent-marks)))
  9103. (org-agenda-bulk-action)
  9104. (throw 'exit nil)))
  9105. (?$
  9106. (setq cmd #'org-agenda-archive))
  9107. (?A
  9108. (setq cmd #'org-agenda-archive-to-archive-sibling))
  9109. ((or ?r ?w)
  9110. (let ((refile-location
  9111. (org-refile-get-location
  9112. "Refile to"
  9113. (marker-buffer (car entries))
  9114. org-refile-allow-creating-parent-nodes)))
  9115. (when (nth 3 refile-location)
  9116. (setcar (nthcdr 3 refile-location)
  9117. (move-marker
  9118. (make-marker)
  9119. (nth 3 refile-location)
  9120. (or (get-file-buffer (nth 1 refile-location))
  9121. (find-buffer-visiting (nth 1 refile-location))
  9122. (error "This should not happen")))))
  9123. (setq cmd `(lambda () (org-agenda-refile nil ',refile-location t)))
  9124. (setq redo-at-end t)))
  9125. (?t
  9126. (let ((state (completing-read
  9127. "Todo state: "
  9128. (with-current-buffer (marker-buffer (car entries))
  9129. (mapcar #'list org-todo-keywords-1)))))
  9130. (setq cmd `(lambda ()
  9131. (let ((org-inhibit-blocking t)
  9132. (org-inhibit-logging 'note))
  9133. (org-agenda-todo ,state))))))
  9134. ((and (or ?- ?+) action)
  9135. (let ((tag (completing-read
  9136. (format "Tag to %s: " (if (eq action ?+) "add" "remove"))
  9137. (with-current-buffer (marker-buffer (car entries))
  9138. (delq nil
  9139. (mapcar (lambda (x) (and (stringp (car x)) x))
  9140. org-current-tag-alist))))))
  9141. (setq cmd
  9142. `(lambda ()
  9143. (org-agenda-set-tags ,tag
  9144. ,(if (eq action ?+) ''on ''off))))))
  9145. (?s
  9146. (let ((time
  9147. (or arg
  9148. (org-read-date nil nil nil "(Re)Schedule to"
  9149. org-overriding-default-time))))
  9150. ;; Make sure to not prompt for a note when bulk
  9151. ;; rescheduling as Org cannot cope with simultaneous notes.
  9152. ;; Besides, it could be annoying depending on the number of
  9153. ;; items re-scheduled.
  9154. (setq cmd
  9155. `(lambda ()
  9156. (let ((org-log-reschedule (and org-log-reschedule 'time)))
  9157. (org-agenda-schedule arg ,time))))))
  9158. (?d
  9159. (let ((time
  9160. (or arg
  9161. (org-read-date nil nil nil "(Re)Set Deadline to"
  9162. org-overriding-default-time))))
  9163. ;; Make sure to not prompt for a note when bulk
  9164. ;; rescheduling as Org cannot cope with simultaneous
  9165. ;; notes. Besides, it could be annoying depending on the
  9166. ;; number of items re-scheduled.
  9167. (setq cmd
  9168. `(lambda ()
  9169. (let ((org-log-redeadline (and org-log-redeadline 'time)))
  9170. (org-agenda-deadline arg ,time))))))
  9171. (?S
  9172. (unless (org-agenda-check-type nil 'agenda 'timeline 'todo)
  9173. (user-error "Can't scatter tasks in \"%s\" agenda view" org-agenda-type))
  9174. (let ((days (read-number
  9175. (format "Scatter tasks across how many %sdays: "
  9176. (if arg "week" ""))
  9177. 7)))
  9178. (setq cmd
  9179. `(lambda ()
  9180. (let ((distance (1+ (random ,days))))
  9181. (when arg
  9182. (let ((dist distance)
  9183. (day-of-week
  9184. (calendar-day-of-week
  9185. (calendar-gregorian-from-absolute (org-today)))))
  9186. (dotimes (i (1+ dist))
  9187. (while (member day-of-week org-agenda-weekend-days)
  9188. (cl-incf distance)
  9189. (cl-incf day-of-week)
  9190. (when (= day-of-week 7)
  9191. (setq day-of-week 0)))
  9192. (cl-incf day-of-week)
  9193. (when (= day-of-week 7)
  9194. (setq day-of-week 0)))))
  9195. ;; Silently fail when try to replan a sexp entry.
  9196. (ignore-errors
  9197. (let* ((date (calendar-gregorian-from-absolute
  9198. (+ (org-today) distance)))
  9199. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date)
  9200. (nth 2 date))))
  9201. (org-agenda-schedule nil time))))))))
  9202. (?f
  9203. (setq cmd
  9204. (intern
  9205. (completing-read "Function: " obarray #'fboundp t nil nil))))
  9206. (action
  9207. (pcase (assoc action org-agenda-bulk-custom-functions)
  9208. (`(,_ ,f) (setq cmd f) (setq redo-at-end t))
  9209. (_ (user-error "Invalid bulk action: %c" action)))))
  9210. ;; Sort the markers, to make sure that parents are handled
  9211. ;; before children.
  9212. (setq entries (sort entries
  9213. (lambda (a b)
  9214. (cond
  9215. ((eq (marker-buffer a) (marker-buffer b))
  9216. (< (marker-position a) (marker-position b)))
  9217. (t
  9218. (string< (buffer-name (marker-buffer a))
  9219. (buffer-name (marker-buffer b))))))))
  9220. ;; Now loop over all markers and apply CMD.
  9221. (let ((processed 0)
  9222. (skipped 0))
  9223. (dolist (e entries)
  9224. (let ((pos (text-property-any (point-min) (point-max) 'org-hd-marker e)))
  9225. (if (not pos)
  9226. (progn (message "Skipping removed entry at %s" e)
  9227. (cl-incf skipped))
  9228. (goto-char pos)
  9229. (let (org-loop-over-headlines-in-active-region) (funcall cmd))
  9230. ;; `post-command-hook' is not run yet. We make sure any
  9231. ;; pending log note is processed.
  9232. (when (or (memq 'org-add-log-note (default-value 'post-command-hook))
  9233. (memq 'org-add-log-note post-command-hook))
  9234. (org-add-log-note))
  9235. (cl-incf processed))))
  9236. (when redo-at-end (org-agenda-redo))
  9237. (unless org-agenda-persistent-marks (org-agenda-bulk-unmark-all))
  9238. (message "Acted on %d entries%s%s"
  9239. processed
  9240. (if (= skipped 0)
  9241. ""
  9242. (format ", skipped %d (disappeared before their turn)"
  9243. skipped))
  9244. (if (not org-agenda-persistent-marks) "" " (kept marked)"))))))
  9245. (defun org-agenda-capture (&optional with-time)
  9246. "Call `org-capture' with the date at point.
  9247. With a `C-1' prefix, use the HH:MM value at point (if any) or the
  9248. current HH:MM time."
  9249. (interactive "P")
  9250. (if (not (eq major-mode 'org-agenda-mode))
  9251. (user-error "You cannot do this outside of agenda buffers")
  9252. (let ((org-overriding-default-time
  9253. (org-get-cursor-date (equal with-time 1))))
  9254. (call-interactively 'org-capture))))
  9255. ;;; Dragging agenda lines forward/backward
  9256. (defun org-agenda-reapply-filters ()
  9257. "Re-apply all agenda filters."
  9258. (mapcar
  9259. (lambda(f) (when (car f) (org-agenda-filter-apply (car f) (cadr f) t)))
  9260. `((,org-agenda-tag-filter tag)
  9261. (,org-agenda-category-filter category)
  9262. (,org-agenda-regexp-filter regexp)
  9263. (,org-agenda-effort-filter effort)
  9264. (,(get 'org-agenda-tag-filter :preset-filter) tag)
  9265. (,(get 'org-agenda-category-filter :preset-filter) category)
  9266. (,(get 'org-agenda-effort-filter :preset-filter) effort)
  9267. (,(get 'org-agenda-regexp-filter :preset-filter) regexp))))
  9268. (defun org-agenda-drag-line-forward (arg &optional backward)
  9269. "Drag an agenda line forward by ARG lines.
  9270. When the optional argument `backward' is non-nil, move backward."
  9271. (interactive "p")
  9272. (let ((inhibit-read-only t) lst line)
  9273. (if (or (not (get-text-property (point) 'txt))
  9274. (save-excursion
  9275. (dotimes (n arg)
  9276. (move-beginning-of-line (if backward 0 2))
  9277. (push (not (get-text-property (point) 'txt)) lst))
  9278. (delq nil lst)))
  9279. (message "Cannot move line forward")
  9280. (let ((end (save-excursion (move-beginning-of-line 2) (point))))
  9281. (move-beginning-of-line 1)
  9282. (setq line (buffer-substring (point) end))
  9283. (delete-region (point) end)
  9284. (move-beginning-of-line (funcall (if backward '1- '1+) arg))
  9285. (insert line)
  9286. (org-agenda-reapply-filters)
  9287. (org-agenda-mark-clocking-task)
  9288. (move-beginning-of-line 0)))))
  9289. (defun org-agenda-drag-line-backward (arg)
  9290. "Drag an agenda line backward by ARG lines."
  9291. (interactive "p")
  9292. (org-agenda-drag-line-forward arg t))
  9293. ;;; Flagging notes
  9294. (defun org-agenda-show-the-flagging-note ()
  9295. "Display the flagging note in the other window.
  9296. When called a second time in direct sequence, offer to remove the FLAGGING
  9297. tag and (if present) the flagging note."
  9298. (interactive)
  9299. (let ((hdmarker (org-get-at-bol 'org-hd-marker))
  9300. (win (selected-window))
  9301. note heading newhead)
  9302. (unless hdmarker
  9303. (user-error "No linked entry at point"))
  9304. (if (and (eq this-command last-command)
  9305. (y-or-n-p "Unflag and remove any flagging note? "))
  9306. (progn
  9307. (org-agenda-remove-flag hdmarker)
  9308. (let ((win (get-buffer-window "*Flagging Note*")))
  9309. (and win (delete-window win)))
  9310. (message "Entry unflagged"))
  9311. (setq note (org-entry-get hdmarker "THEFLAGGINGNOTE"))
  9312. (unless note
  9313. (user-error "No flagging note"))
  9314. (org-kill-new note)
  9315. (org-switch-to-buffer-other-window "*Flagging Note*")
  9316. (erase-buffer)
  9317. (insert note)
  9318. (goto-char (point-min))
  9319. (while (re-search-forward "\\\\n" nil t)
  9320. (replace-match "\n" t t))
  9321. (goto-char (point-min))
  9322. (select-window win)
  9323. (message "%s" (substitute-command-keys "Flagging note pushed to \
  9324. kill ring. Press `\\[org-agenda-show-the-flagging-note]' again to remove \
  9325. tag and note")))))
  9326. (defun org-agenda-remove-flag (marker)
  9327. "Remove the FLAGGED tag and any flagging note in the entry."
  9328. (let (newhead)
  9329. (org-with-point-at marker
  9330. (org-toggle-tag "FLAGGED" 'off)
  9331. (org-entry-delete nil "THEFLAGGINGNOTE")
  9332. (setq newhead (org-get-heading)))
  9333. (org-agenda-change-all-lines newhead marker)
  9334. (message "Entry unflagged")))
  9335. (defun org-agenda-get-any-marker (&optional pos)
  9336. (or (get-text-property (or pos (point-at-bol)) 'org-hd-marker)
  9337. (get-text-property (or pos (point-at-bol)) 'org-marker)))
  9338. ;;; Appointment reminders
  9339. (defvar appt-time-msg-list) ; defined in appt.el
  9340. ;;;###autoload
  9341. (defun org-agenda-to-appt (&optional refresh filter &rest args)
  9342. "Activate appointments found in `org-agenda-files'.
  9343. With a `\\[universal-argument]' prefix, refresh the list of \
  9344. appointments.
  9345. If FILTER is t, interactively prompt the user for a regular
  9346. expression, and filter out entries that don't match it.
  9347. If FILTER is a string, use this string as a regular expression
  9348. for filtering entries out.
  9349. If FILTER is a function, filter out entries against which
  9350. calling the function returns nil. This function takes one
  9351. argument: an entry from `org-agenda-get-day-entries'.
  9352. FILTER can also be an alist with the car of each cell being
  9353. either `headline' or `category'. For example:
  9354. \\='((headline \"IMPORTANT\")
  9355. (category \"Work\"))
  9356. will only add headlines containing IMPORTANT or headlines
  9357. belonging to the \"Work\" category.
  9358. ARGS are symbols indicating what kind of entries to consider.
  9359. By default `org-agenda-to-appt' will use :deadline*, :scheduled*
  9360. \(i.e., deadlines and scheduled items with a hh:mm specification)
  9361. and :timestamp entries. See the docstring of `org-diary' for
  9362. details and examples.
  9363. If an entry has a APPT_WARNTIME property, its value will be used
  9364. to override `appt-message-warning-time'."
  9365. (interactive "P")
  9366. (if refresh (setq appt-time-msg-list nil))
  9367. (if (eq filter t)
  9368. (setq filter (read-from-minibuffer "Regexp filter: ")))
  9369. (let* ((cnt 0) ; count added events
  9370. (scope (or args '(:deadline* :scheduled* :timestamp)))
  9371. (org-agenda-new-buffers nil)
  9372. (org-deadline-warning-days 0)
  9373. ;; Do not use `org-today' here because appt only takes
  9374. ;; time and without date as argument, so it may pass wrong
  9375. ;; information otherwise
  9376. (today (org-date-to-gregorian
  9377. (time-to-days (current-time))))
  9378. (org-agenda-restrict nil)
  9379. (files (org-agenda-files 'unrestricted)) entries file
  9380. (org-agenda-buffer nil))
  9381. ;; Get all entries which may contain an appt
  9382. (org-agenda-prepare-buffers files)
  9383. (while (setq file (pop files))
  9384. (setq entries
  9385. (delq nil
  9386. (append entries
  9387. (apply 'org-agenda-get-day-entries
  9388. file today scope)))))
  9389. ;; Map thru entries and find if we should filter them out
  9390. (mapc
  9391. (lambda (x)
  9392. (let* ((evt (org-trim
  9393. (replace-regexp-in-string
  9394. org-bracket-link-regexp "\\3"
  9395. (or (get-text-property 1 'txt x) ""))))
  9396. (cat (get-text-property (1- (length x)) 'org-category x))
  9397. (tod (get-text-property 1 'time-of-day x))
  9398. (ok (or (null filter)
  9399. (and (stringp filter) (string-match filter evt))
  9400. (and (functionp filter) (funcall filter x))
  9401. (and (listp filter)
  9402. (let ((cat-filter (cadr (assq 'category filter)))
  9403. (evt-filter (cadr (assq 'headline filter))))
  9404. (or (and (stringp cat-filter)
  9405. (string-match cat-filter cat))
  9406. (and (stringp evt-filter)
  9407. (string-match evt-filter evt)))))))
  9408. (wrn (get-text-property 1 'warntime x)))
  9409. ;; FIXME: Shall we remove text-properties for the appt text?
  9410. ;; (setq evt (set-text-properties 0 (length evt) nil evt))
  9411. (when (and ok tod (not (string-match "\\`DONE\\|CANCELLED" evt)))
  9412. (setq tod (concat "00" (number-to-string tod)))
  9413. (setq tod (when (string-match
  9414. "\\([0-9]\\{1,2\\}\\)\\([0-9]\\{2\\}\\)\\'" tod)
  9415. (concat (match-string 1 tod) ":"
  9416. (match-string 2 tod))))
  9417. (when (if (version< emacs-version "23.3")
  9418. (appt-add tod evt)
  9419. (appt-add tod evt wrn))
  9420. (setq cnt (1+ cnt))))))
  9421. entries)
  9422. (org-release-buffers org-agenda-new-buffers)
  9423. (if (eq cnt 0)
  9424. (message "No event to add")
  9425. (message "Added %d event%s for today" cnt (if (> cnt 1) "s" "")))))
  9426. (defun org-agenda-today-p (date)
  9427. "Non nil when DATE means today.
  9428. DATE is either a list of the form (month day year) or a number of
  9429. days as returned by `calendar-absolute-from-gregorian' or
  9430. `org-today'. This function considers `org-extend-today-until'
  9431. when defining today."
  9432. (eq (org-today)
  9433. (if (consp date) (calendar-absolute-from-gregorian date) date)))
  9434. (defun org-agenda-todo-yesterday (&optional arg)
  9435. "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday."
  9436. (interactive "P")
  9437. (let* ((org-use-effective-time t)
  9438. (hour (nth 2 (decode-time (org-current-time))))
  9439. (org-extend-today-until (1+ hour)))
  9440. (org-agenda-todo arg)))
  9441. (provide 'org-agenda)
  9442. ;;; org-agenda.el ends here