org-agenda.el 398 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353
  1. ;;; org-agenda.el --- Dynamic task and appointment lists for Org
  2. ;; Copyright (C) 2004-2019 Free Software Foundation, Inc.
  3. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; Homepage: https://orgmode.org
  6. ;;
  7. ;; This file is part of GNU Emacs.
  8. ;;
  9. ;; GNU Emacs is free software: you can redistribute it and/or modify
  10. ;; it under the terms of the GNU General Public License as published by
  11. ;; the Free Software Foundation, either version 3 of the License, or
  12. ;; (at your option) any later version.
  13. ;; GNU Emacs is distributed in the hope that it will be useful,
  14. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. ;; GNU General Public License for more details.
  17. ;; You should have received a copy of the GNU General Public License
  18. ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
  19. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  20. ;;
  21. ;;; Commentary:
  22. ;; This file contains the code for creating and using the Agenda for Org.
  23. ;;
  24. ;; The functions `org-batch-agenda', `org-batch-agenda-csv', and
  25. ;; `org-batch-store-agenda-views' are implemented as macros to provide
  26. ;; a convenient way for extracting agenda information from the command
  27. ;; line. The Lisp does not evaluate parameters of a macro call; thus
  28. ;; it is not necessary to quote the parameters passed to one of those
  29. ;; functions. E.g. you can write:
  30. ;;
  31. ;; emacs -batch -l ~/.emacs -eval '(org-batch-agenda "a" org-agenda-span 7)'
  32. ;;
  33. ;; To export an agenda spanning 7 days. If `org-batch-agenda' would
  34. ;; have been implemented as a regular function you'd have to quote the
  35. ;; symbol org-agenda-span. Moreover: To use a symbol as parameter
  36. ;; value you would have to double quote the symbol.
  37. ;;
  38. ;; This is a hack, but it works even when running Org byte-compiled.
  39. ;;
  40. ;;; Code:
  41. (require 'cl-lib)
  42. (require 'ol)
  43. (require 'org)
  44. (require 'org-macs)
  45. (declare-function diary-add-to-list "diary-lib"
  46. (date string specifier &optional marker globcolor literal))
  47. (declare-function calendar-iso-to-absolute "cal-iso" (date))
  48. (declare-function calendar-astro-date-string "cal-julian" (&optional date))
  49. (declare-function calendar-bahai-date-string "cal-bahai" (&optional date))
  50. (declare-function calendar-chinese-date-string "cal-china" (&optional date))
  51. (declare-function calendar-coptic-date-string "cal-coptic" (&optional date))
  52. (declare-function calendar-ethiopic-date-string "cal-coptic" (&optional date))
  53. (declare-function calendar-french-date-string "cal-french" (&optional date))
  54. (declare-function calendar-goto-date "cal-move" (date))
  55. (declare-function calendar-hebrew-date-string "cal-hebrew" (&optional date))
  56. (declare-function calendar-islamic-date-string "cal-islam" (&optional date))
  57. (declare-function calendar-iso-date-string "cal-iso" (&optional date))
  58. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  59. (declare-function calendar-julian-date-string "cal-julian" (&optional date))
  60. (declare-function calendar-mayan-date-string "cal-mayan" (&optional date))
  61. (declare-function calendar-persian-date-string "cal-persia" (&optional date))
  62. (declare-function calendar-check-holidays "holidays" (date))
  63. (declare-function org-columns-remove-overlays "org-colview" ())
  64. (declare-function org-datetree-find-date-create "org-datetree"
  65. (date &optional keep-restriction))
  66. (declare-function org-columns-quit "org-colview" ())
  67. (declare-function diary-date-display-form "diary-lib" (&optional type))
  68. (declare-function org-mobile-write-agenda-for-mobile "org-mobile" (file))
  69. (declare-function org-habit-insert-consistency-graphs
  70. "org-habit" (&optional line))
  71. (declare-function org-is-habit-p "org-habit" (&optional pom))
  72. (declare-function org-habit-parse-todo "org-habit" (&optional pom))
  73. (declare-function org-habit-get-priority "org-habit" (habit &optional moment))
  74. (declare-function org-agenda-columns "org-colview" ())
  75. (declare-function org-add-archive-files "org-archive" (files))
  76. (declare-function org-capture "org-capture" (&optional goto keys))
  77. (defvar calendar-mode-map)
  78. (defvar org-clock-current-task)
  79. (defvar org-current-tag-alist)
  80. (defvar org-mobile-force-id-on-agenda-items)
  81. (defvar org-habit-show-habits)
  82. (defvar org-habit-show-habits-only-for-today)
  83. (defvar org-habit-show-all-today)
  84. (defvar org-habit-scheduled-past-days)
  85. ;; Defined somewhere in this file, but used before definition.
  86. (defvar org-agenda-buffer-name "*Org Agenda*")
  87. (defvar org-agenda-overriding-header nil)
  88. (defvar org-agenda-title-append nil)
  89. (with-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  90. (with-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  91. (defvar original-date) ; dynamically scoped, calendar.el does scope this
  92. (defvar org-agenda-undo-list nil
  93. "List of undoable operations in the agenda since last refresh.")
  94. (defvar org-agenda-pending-undo-list nil
  95. "In a series of undo commands, this is the list of remaining undo items.")
  96. (defcustom org-agenda-confirm-kill 1
  97. "When set, remote killing from the agenda buffer needs confirmation.
  98. When t, a confirmation is always needed. When a number N, confirmation is
  99. only needed when the text to be killed contains more than N non-white lines."
  100. :group 'org-agenda
  101. :type '(choice
  102. (const :tag "Never" nil)
  103. (const :tag "Always" t)
  104. (integer :tag "When more than N lines")))
  105. (defcustom org-agenda-compact-blocks nil
  106. "Non-nil means make the block agenda more compact.
  107. This is done globally by leaving out lines like the agenda span
  108. name and week number or the separator lines."
  109. :group 'org-agenda
  110. :type 'boolean)
  111. (defcustom org-agenda-block-separator ?=
  112. "The separator between blocks in the agenda.
  113. If this is a string, it will be used as the separator, with a newline added.
  114. If it is a character, it will be repeated to fill the window width.
  115. If nil the separator is disabled. In `org-agenda-custom-commands' this
  116. addresses the separator between the current and the previous block."
  117. :group 'org-agenda
  118. :type '(choice
  119. (const :tag "Disabled" nil)
  120. (character)
  121. (string)))
  122. (defgroup org-agenda-export nil
  123. "Options concerning exporting agenda views in Org mode."
  124. :tag "Org Agenda Export"
  125. :group 'org-agenda)
  126. (defcustom org-agenda-with-colors t
  127. "Non-nil means use colors in agenda views."
  128. :group 'org-agenda-export
  129. :type 'boolean)
  130. (defcustom org-agenda-exporter-settings nil
  131. "Alist of variable/value pairs that should be active during agenda export.
  132. This is a good place to set options for ps-print and for htmlize.
  133. Note that the way this is implemented, the values will be evaluated
  134. before assigned to the variables. So make sure to quote values you do
  135. *not* want evaluated, for example
  136. (setq org-agenda-exporter-settings
  137. \\='((ps-print-color-p \\='black-white)))"
  138. :group 'org-agenda-export
  139. :type '(repeat
  140. (list
  141. (variable)
  142. (sexp :tag "Value"))))
  143. (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
  144. "Hook run in a temporary buffer before writing the agenda to an export file.
  145. A useful function for this hook is `org-agenda-add-entry-text'."
  146. :group 'org-agenda-export
  147. :type 'hook
  148. :options '(org-agenda-add-entry-text))
  149. (defcustom org-agenda-add-entry-text-maxlines 0
  150. "Maximum number of entry text lines to be added to agenda.
  151. This is only relevant when `org-agenda-add-entry-text' is part of
  152. `org-agenda-before-write-hook', which is the default.
  153. When this is 0, nothing will happen. When it is greater than 0, it
  154. specifies the maximum number of lines that will be added for each entry
  155. that is listed in the agenda view.
  156. Note that this variable is not used during display, only when exporting
  157. the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
  158. and `org-agenda-entry-text-maxlines'."
  159. :group 'org-agenda
  160. :type 'integer)
  161. (defcustom org-agenda-add-entry-text-descriptive-links t
  162. "Non-nil means export org-links as descriptive links in agenda added text.
  163. This variable applies to the text added to the agenda when
  164. `org-agenda-add-entry-text-maxlines' is larger than 0.
  165. When this variable nil, the URL will (also) be shown."
  166. :group 'org-agenda
  167. :type 'boolean)
  168. (defcustom org-agenda-export-html-style nil
  169. "The style specification for exported HTML Agenda files.
  170. If this variable contains a string, it will replace the default <style>
  171. section as produced by `htmlize'.
  172. Since there are different ways of setting style information, this variable
  173. needs to contain the full HTML structure to provide a style, including the
  174. surrounding HTML tags. The style specifications should include definitions
  175. the fonts used by the agenda, here is an example:
  176. <style type=\"text/css\">
  177. p { font-weight: normal; color: gray; }
  178. .org-agenda-structure {
  179. font-size: 110%;
  180. color: #003399;
  181. font-weight: 600;
  182. }
  183. .org-todo {
  184. color: #cc6666;
  185. font-weight: bold;
  186. }
  187. .org-agenda-done {
  188. color: #339933;
  189. }
  190. .org-done {
  191. color: #339933;
  192. }
  193. .title { text-align: center; }
  194. .todo, .deadline { color: red; }
  195. .done { color: green; }
  196. </style>
  197. or, if you want to keep the style in a file,
  198. <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
  199. As the value of this option simply gets inserted into the HTML <head> header,
  200. you can \"misuse\" it to also add other text to the header."
  201. :group 'org-agenda-export
  202. :group 'org-export-html
  203. :type '(choice
  204. (const nil)
  205. (string)))
  206. (defcustom org-agenda-persistent-filter nil
  207. "When set, keep filters from one agenda view to the next."
  208. :group 'org-agenda
  209. :type 'boolean)
  210. (defgroup org-agenda-custom-commands nil
  211. "Options concerning agenda views in Org mode."
  212. :tag "Org Agenda Custom Commands"
  213. :group 'org-agenda)
  214. (defconst org-sorting-choice
  215. '(choice
  216. (const time-up) (const time-down)
  217. (const timestamp-up) (const timestamp-down)
  218. (const scheduled-up) (const scheduled-down)
  219. (const deadline-up) (const deadline-down)
  220. (const ts-up) (const ts-down)
  221. (const tsia-up) (const tsia-down)
  222. (const category-keep) (const category-up) (const category-down)
  223. (const tag-down) (const tag-up)
  224. (const priority-up) (const priority-down)
  225. (const todo-state-up) (const todo-state-down)
  226. (const effort-up) (const effort-down)
  227. (const habit-up) (const habit-down)
  228. (const alpha-up) (const alpha-down)
  229. (const user-defined-up) (const user-defined-down))
  230. "Sorting choices.")
  231. ;; Keep custom values for `org-agenda-filter-preset' compatible with
  232. ;; the new variable `org-agenda-tag-filter-preset'.
  233. (defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
  234. (defvaralias 'org-agenda-filter 'org-agenda-tag-filter)
  235. (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
  236. "List of types searched for when creating the daily/weekly agenda.
  237. This variable is a list of symbols that controls the types of
  238. items that appear in the daily/weekly agenda. Allowed symbols in this
  239. list are are
  240. :timestamp List items containing a date stamp or date range matching
  241. the selected date. This includes sexp entries in angular
  242. brackets.
  243. :sexp List entries resulting from plain diary-like sexps.
  244. :deadline List deadline due on that date. When the date is today,
  245. also list any deadlines past due, or due within
  246. `org-deadline-warning-days'.
  247. :deadline* Same as above, but only include the deadline if it has an
  248. hour specification as [h]h:mm.
  249. :scheduled List all items which are scheduled for the given date.
  250. The diary for *today* also contains items which were
  251. scheduled earlier and are not yet marked DONE.
  252. :scheduled* Same as above, but only include the scheduled item if it
  253. has an hour specification as [h]h:mm.
  254. By default, all four non-starred types are turned on.
  255. When :scheduled* or :deadline* are included, :schedule or :deadline
  256. will be ignored.
  257. Never set this variable globally using `setq', because then it
  258. will apply to all future agenda commands. Instead, bind it with
  259. `let' to scope it dynamically into the agenda-constructing
  260. command. A good way to set it is through options in
  261. `org-agenda-custom-commands'. For a more flexible (though
  262. somewhat less efficient) way of determining what is included in
  263. the daily/weekly agenda, see `org-agenda-skip-function'.")
  264. (defconst org-agenda-custom-commands-local-options
  265. `(repeat :tag "Local settings for this command. Remember to quote values"
  266. (choice :tag "Setting"
  267. (list :tag "Heading for this block"
  268. (const org-agenda-overriding-header)
  269. (string :tag "Headline"))
  270. (list :tag "Files to be searched"
  271. (const org-agenda-files)
  272. (list
  273. (const :format "" quote)
  274. (repeat (file))))
  275. (list :tag "Sorting strategy"
  276. (const org-agenda-sorting-strategy)
  277. (list
  278. (const :format "" quote)
  279. (repeat
  280. ,org-sorting-choice)))
  281. (list :tag "Prefix format"
  282. (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
  283. (string))
  284. (list :tag "Number of days in agenda"
  285. (const org-agenda-span)
  286. (list
  287. (const :format "" quote)
  288. (choice (const :tag "Day" day)
  289. (const :tag "Week" week)
  290. (const :tag "Fortnight" fortnight)
  291. (const :tag "Month" month)
  292. (const :tag "Year" year)
  293. (integer :tag "Custom"))))
  294. (list :tag "Fixed starting date"
  295. (const org-agenda-start-day)
  296. (string :value "2007-11-01"))
  297. (list :tag "Start on day of week"
  298. (const org-agenda-start-on-weekday)
  299. (choice :value 1
  300. (const :tag "Today" nil)
  301. (integer :tag "Weekday No.")))
  302. (list :tag "Include data from diary"
  303. (const org-agenda-include-diary)
  304. (boolean))
  305. (list :tag "Deadline Warning days"
  306. (const org-deadline-warning-days)
  307. (integer :value 1))
  308. (list :tag "Category filter preset"
  309. (const org-agenda-category-filter-preset)
  310. (list
  311. (const :format "" quote)
  312. (repeat
  313. (string :tag "+category or -category"))))
  314. (list :tag "Tags filter preset"
  315. (const org-agenda-tag-filter-preset)
  316. (list
  317. (const :format "" quote)
  318. (repeat
  319. (string :tag "+tag or -tag"))))
  320. (list :tag "Effort filter preset"
  321. (const org-agenda-effort-filter-preset)
  322. (list
  323. (const :format "" quote)
  324. (repeat
  325. (string :tag "+=10 or -=10 or +<10 or ->10"))))
  326. (list :tag "Regexp filter preset"
  327. (const org-agenda-regexp-filter-preset)
  328. (list
  329. (const :format "" quote)
  330. (repeat
  331. (string :tag "+regexp or -regexp"))))
  332. (list :tag "Set daily/weekly entry types"
  333. (const org-agenda-entry-types)
  334. (list
  335. (const :format "" quote)
  336. (set :greedy t :value ,org-agenda-entry-types
  337. (const :deadline)
  338. (const :scheduled)
  339. (const :deadline*)
  340. (const :scheduled*)
  341. (const :timestamp)
  342. (const :sexp))))
  343. (list :tag "Columns format"
  344. (const org-overriding-columns-format)
  345. (string :tag "Format"))
  346. (list :tag "Standard skipping condition"
  347. :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
  348. (const org-agenda-skip-function)
  349. (list
  350. (const :format "" quote)
  351. (list
  352. (choice
  353. :tag "Skipping range"
  354. (const :tag "Skip entry" org-agenda-skip-entry-if)
  355. (const :tag "Skip subtree" org-agenda-skip-subtree-if))
  356. (repeat :inline t :tag "Conditions for skipping"
  357. (choice
  358. :tag "Condition type"
  359. (list :tag "Regexp matches" :inline t
  360. (const :format "" regexp)
  361. (regexp))
  362. (list :tag "Regexp does not match" :inline t
  363. (const :format "" notregexp)
  364. (regexp))
  365. (list :tag "TODO state is" :inline t
  366. (const todo)
  367. (choice
  368. (const :tag "Any not-done state" todo)
  369. (const :tag "Any done state" done)
  370. (const :tag "Any state" any)
  371. (list :tag "Keyword list"
  372. (const :format "" quote)
  373. (repeat (string :tag "Keyword")))))
  374. (list :tag "TODO state is not" :inline t
  375. (const nottodo)
  376. (choice
  377. (const :tag "Any not-done state" todo)
  378. (const :tag "Any done state" done)
  379. (const :tag "Any state" any)
  380. (list :tag "Keyword list"
  381. (const :format "" quote)
  382. (repeat (string :tag "Keyword")))))
  383. (const :tag "scheduled" scheduled)
  384. (const :tag "not scheduled" notscheduled)
  385. (const :tag "deadline" deadline)
  386. (const :tag "no deadline" notdeadline)
  387. (const :tag "timestamp" timestamp)
  388. (const :tag "no timestamp" nottimestamp))))))
  389. (list :tag "Non-standard skipping condition"
  390. :value (org-agenda-skip-function)
  391. (const org-agenda-skip-function)
  392. (sexp :tag "Function or form (quoted!)"))
  393. (list :tag "Any variable"
  394. (variable :tag "Variable")
  395. (sexp :tag "Value (sexp)"))))
  396. "Selection of examples for agenda command settings.
  397. This will be spliced into the custom type of
  398. `org-agenda-custom-commands'.")
  399. (defcustom org-agenda-custom-commands
  400. '(("n" "Agenda and all TODOs" ((agenda "") (alltodo ""))))
  401. "Custom commands for the agenda.
  402. \\<org-mode-map>
  403. These commands will be offered on the splash screen displayed by the
  404. agenda dispatcher `\\[org-agenda]'. Each entry is a list like this:
  405. (key desc type match settings files)
  406. key The key (one or more characters as a string) to be associated
  407. with the command.
  408. desc A description of the command, when omitted or nil, a default
  409. description is built using MATCH.
  410. type The command type, any of the following symbols:
  411. agenda The daily/weekly agenda.
  412. todo Entries with a specific TODO keyword, in all agenda files.
  413. search Entries containing search words entry or headline.
  414. tags Tags/Property/TODO match in all agenda files.
  415. tags-todo Tags/P/T match in all agenda files, TODO entries only.
  416. todo-tree Sparse tree of specific TODO keyword in *current* file.
  417. tags-tree Sparse tree with all tags matches in *current* file.
  418. occur-tree Occur sparse tree for *current* file.
  419. ... A user-defined function.
  420. match What to search for:
  421. - a single keyword for TODO keyword searches
  422. - a tags match expression for tags searches
  423. - a word search expression for text searches.
  424. - a regular expression for occur searches
  425. For all other commands, this should be the empty string.
  426. settings A list of option settings, similar to that in a let form, so like
  427. this: ((opt1 val1) (opt2 val2) ...). The values will be
  428. evaluated at the moment of execution, so quote them when needed.
  429. files A list of files to write the produced agenda buffer to with
  430. the command `org-store-agenda-views'.
  431. If a file name ends in \".html\", an HTML version of the buffer
  432. is written out. If it ends in \".ps\", a postscript version is
  433. produced. Otherwise, only the plain text is written to the file.
  434. You can also define a set of commands, to create a composite agenda buffer.
  435. In this case, an entry looks like this:
  436. (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
  437. where
  438. desc A description string to be displayed in the dispatcher menu.
  439. cmd An agenda command, similar to the above. However, tree commands
  440. are not allowed, but instead you can get agenda and global todo list.
  441. So valid commands for a set are:
  442. (agenda \"\" settings)
  443. (alltodo \"\" settings)
  444. (stuck \"\" settings)
  445. (todo \"match\" settings files)
  446. (search \"match\" settings files)
  447. (tags \"match\" settings files)
  448. (tags-todo \"match\" settings files)
  449. Each command can carry a list of options, and another set of options can be
  450. given for the whole set of commands. Individual command options take
  451. precedence over the general options.
  452. When using several characters as key to a command, the first characters
  453. are prefix commands. For the dispatcher to display useful information, you
  454. should provide a description for the prefix, like
  455. (setq org-agenda-custom-commands
  456. \\='((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
  457. (\"hl\" tags \"+HOME+Lisa\")
  458. (\"hp\" tags \"+HOME+Peter\")
  459. (\"hk\" tags \"+HOME+Kim\")))"
  460. :group 'org-agenda-custom-commands
  461. :type `(repeat
  462. (choice :value ("x" "Describe command here" tags "" nil)
  463. (list :tag "Single command"
  464. (string :tag "Access Key(s) ")
  465. (option (string :tag "Description"))
  466. (choice
  467. (const :tag "Agenda" agenda)
  468. (const :tag "TODO list" alltodo)
  469. (const :tag "Search words" search)
  470. (const :tag "Stuck projects" stuck)
  471. (const :tag "Tags/Property match (all agenda files)" tags)
  472. (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
  473. (const :tag "TODO keyword search (all agenda files)" todo)
  474. (const :tag "Tags sparse tree (current buffer)" tags-tree)
  475. (const :tag "TODO keyword tree (current buffer)" todo-tree)
  476. (const :tag "Occur tree (current buffer)" occur-tree)
  477. (sexp :tag "Other, user-defined function"))
  478. (string :tag "Match (only for some commands)")
  479. ,org-agenda-custom-commands-local-options
  480. (option (repeat :tag "Export" (file :tag "Export to"))))
  481. (list :tag "Command series, all agenda files"
  482. (string :tag "Access Key(s)")
  483. (string :tag "Description ")
  484. (repeat :tag "Component"
  485. (choice
  486. (list :tag "Agenda"
  487. (const :format "" agenda)
  488. (const :tag "" :format "" "")
  489. ,org-agenda-custom-commands-local-options)
  490. (list :tag "TODO list (all keywords)"
  491. (const :format "" alltodo)
  492. (const :tag "" :format "" "")
  493. ,org-agenda-custom-commands-local-options)
  494. (list :tag "Search words"
  495. (const :format "" search)
  496. (string :tag "Match")
  497. ,org-agenda-custom-commands-local-options)
  498. (list :tag "Stuck projects"
  499. (const :format "" stuck)
  500. (const :tag "" :format "" "")
  501. ,org-agenda-custom-commands-local-options)
  502. (list :tag "Tags search"
  503. (const :format "" tags)
  504. (string :tag "Match")
  505. ,org-agenda-custom-commands-local-options)
  506. (list :tag "Tags search, TODO entries only"
  507. (const :format "" tags-todo)
  508. (string :tag "Match")
  509. ,org-agenda-custom-commands-local-options)
  510. (list :tag "TODO keyword search"
  511. (const :format "" todo)
  512. (string :tag "Match")
  513. ,org-agenda-custom-commands-local-options)
  514. (list :tag "Other, user-defined function"
  515. (symbol :tag "function")
  516. (string :tag "Match")
  517. ,org-agenda-custom-commands-local-options)))
  518. (repeat :tag "Settings for entire command set"
  519. (list (variable :tag "Any variable")
  520. (sexp :tag "Value")))
  521. (option (repeat :tag "Export" (file :tag "Export to"))))
  522. (cons :tag "Prefix key documentation"
  523. (string :tag "Access Key(s)")
  524. (string :tag "Description ")))))
  525. (defcustom org-agenda-query-register ?o
  526. "The register holding the current query string.
  527. The purpose of this is that if you construct a query string interactively,
  528. you can then use it to define a custom command."
  529. :group 'org-agenda-custom-commands
  530. :type 'character)
  531. (defcustom org-stuck-projects
  532. '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
  533. "How to identify stuck projects.
  534. This is a list of four items:
  535. 1. A tags/todo/property matcher string that is used to identify a project.
  536. See the manual for a description of tag and property searches.
  537. The entire tree below a headline matched by this is considered one project.
  538. 2. A list of TODO keywords identifying non-stuck projects.
  539. If the project subtree contains any headline with one of these todo
  540. keywords, the project is considered to be not stuck. If you specify
  541. \"*\" as a keyword, any TODO keyword will mark the project unstuck.
  542. 3. A list of tags identifying non-stuck projects.
  543. If the project subtree contains any headline with one of these tags,
  544. the project is considered to be not stuck. If you specify \"*\" as
  545. a tag, any tag will mark the project unstuck. Note that this is about
  546. the explicit presence of a tag somewhere in the subtree, inherited
  547. tags do not count here. If inherited tags make a project not stuck,
  548. use \"-TAG\" in the tags part of the matcher under (1.) above.
  549. 4. An arbitrary regular expression matching non-stuck projects.
  550. If the project turns out to be not stuck, search continues also in the
  551. subtree to see if any of the subtasks have project status.
  552. See also the variable `org-tags-match-list-sublevels' which applies
  553. to projects matched by this search as well.
  554. After defining this variable, you may use `org-agenda-list-stuck-projects'
  555. \(bound to `\\[org-agenda] #') to produce the list."
  556. :group 'org-agenda-custom-commands
  557. :type '(list
  558. (string :tag "Tags/TODO match to identify a project")
  559. (repeat :tag "Projects are *not* stuck if they have an entry with \
  560. TODO keyword any of" (string))
  561. (repeat :tag "Projects are *not* stuck if they have an entry with \
  562. TAG being any of" (string))
  563. (regexp :tag "Projects are *not* stuck if this regexp matches inside \
  564. the subtree")))
  565. (defgroup org-agenda-skip nil
  566. "Options concerning skipping parts of agenda files."
  567. :tag "Org Agenda Skip"
  568. :group 'org-agenda)
  569. (defcustom org-agenda-skip-function-global nil
  570. "Function to be called at each match during agenda construction.
  571. If this function returns nil, the current match should not be skipped.
  572. If the function decided to skip an agenda match, is must return the
  573. buffer position from which the search should be continued.
  574. This may also be a Lisp form, which will be evaluated.
  575. This variable will be applied to every agenda match, including
  576. tags/property searches and TODO lists. So try to make the test function
  577. do its checking as efficiently as possible. To implement a skipping
  578. condition just for specific agenda commands, use the variable
  579. `org-agenda-skip-function' which can be set in the options section
  580. of custom agenda commands."
  581. :group 'org-agenda-skip
  582. :type 'sexp)
  583. (defgroup org-agenda-daily/weekly nil
  584. "Options concerning the daily/weekly agenda."
  585. :tag "Org Agenda Daily/Weekly"
  586. :group 'org-agenda)
  587. (defgroup org-agenda-todo-list nil
  588. "Options concerning the global todo list agenda view."
  589. :tag "Org Agenda Todo List"
  590. :group 'org-agenda)
  591. (defgroup org-agenda-match-view nil
  592. "Options concerning the general tags/property/todo match agenda view."
  593. :tag "Org Agenda Match View"
  594. :group 'org-agenda)
  595. (defgroup org-agenda-search-view nil
  596. "Options concerning the search agenda view."
  597. :tag "Org Agenda Search View"
  598. :group 'org-agenda)
  599. (defvar org-agenda-archives-mode nil
  600. "Non-nil means the agenda will include archived items.
  601. If this is the symbol `trees', trees in the selected agenda scope
  602. that are marked with the ARCHIVE tag will be included anyway. When this is
  603. t, also all archive files associated with the current selection of agenda
  604. files will be included.")
  605. (defcustom org-agenda-restriction-lock-highlight-subtree t
  606. "Non-nil means highlight the whole subtree when restriction is active.
  607. Otherwise only highlight the headline. Highlighting the whole subtree is
  608. useful to ensure no edits happen beyond the restricted region."
  609. :group 'org-agenda
  610. :type 'boolean)
  611. (defcustom org-agenda-skip-comment-trees t
  612. "Non-nil means skip trees that start with the COMMENT keyword.
  613. When nil, these trees are also scanned by agenda commands."
  614. :group 'org-agenda-skip
  615. :type 'boolean)
  616. (defcustom org-agenda-todo-list-sublevels t
  617. "Non-nil means check also the sublevels of a TODO entry for TODO entries.
  618. When nil, the sublevels of a TODO entry are not checked, resulting in
  619. potentially much shorter TODO lists."
  620. :group 'org-agenda-skip
  621. :group 'org-agenda-todo-list
  622. :type 'boolean)
  623. (defcustom org-agenda-todo-ignore-with-date nil
  624. "Non-nil means don't show entries with a date in the global todo list.
  625. You can use this if you prefer to mark mere appointments with a TODO keyword,
  626. but don't want them to show up in the TODO list.
  627. When this is set, it also covers deadlines and scheduled items, the settings
  628. of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
  629. will be ignored.
  630. See also the variable `org-agenda-tags-todo-honor-ignore-options'."
  631. :group 'org-agenda-skip
  632. :group 'org-agenda-todo-list
  633. :type 'boolean)
  634. (defcustom org-agenda-todo-ignore-timestamp nil
  635. "Non-nil means don't show entries with a timestamp.
  636. This applies when creating the global todo list.
  637. Valid values are:
  638. past Don't show entries for today or in the past.
  639. future Don't show entries with a timestamp in the future.
  640. The idea behind this is that if it has a future
  641. timestamp, you don't want to think about it until the
  642. date.
  643. all Don't show any entries with a timestamp in the global todo list.
  644. The idea behind this is that by setting a timestamp, you
  645. have already \"taken care\" of this item.
  646. This variable can also have an integer as a value. If positive (N),
  647. todos with a timestamp N or more days in the future will be ignored. If
  648. negative (-N), todos with a timestamp N or more days in the past will be
  649. ignored. If 0, todos with a timestamp either today or in the future will
  650. be ignored. For example, a value of -1 will exclude todos with a
  651. timestamp in the past (yesterday or earlier), while a value of 7 will
  652. exclude todos with a timestamp a week or more in the future.
  653. See also `org-agenda-todo-ignore-with-date'.
  654. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  655. to make his option also apply to the tags-todo list."
  656. :group 'org-agenda-skip
  657. :group 'org-agenda-todo-list
  658. :version "24.1"
  659. :type '(choice
  660. (const :tag "Ignore future timestamp todos" future)
  661. (const :tag "Ignore past or present timestamp todos" past)
  662. (const :tag "Ignore all timestamp todos" all)
  663. (const :tag "Show timestamp todos" nil)
  664. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  665. (defcustom org-agenda-todo-ignore-scheduled nil
  666. "Non-nil means, ignore some scheduled TODO items when making TODO list.
  667. This applies when creating the global todo list.
  668. Valid values are:
  669. past Don't show entries scheduled today or in the past.
  670. future Don't show entries scheduled in the future.
  671. The idea behind this is that by scheduling it, you don't want to
  672. think about it until the scheduled date.
  673. all Don't show any scheduled entries in the global todo list.
  674. The idea behind this is that by scheduling it, you have already
  675. \"taken care\" of this item.
  676. t Same as `all', for backward compatibility.
  677. This variable can also have an integer as a value. See
  678. `org-agenda-todo-ignore-timestamp' for more details.
  679. See also `org-agenda-todo-ignore-with-date'.
  680. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  681. to make his option also apply to the tags-todo list."
  682. :group 'org-agenda-skip
  683. :group 'org-agenda-todo-list
  684. :type '(choice
  685. (const :tag "Ignore future-scheduled todos" future)
  686. (const :tag "Ignore past- or present-scheduled todos" past)
  687. (const :tag "Ignore all scheduled todos" all)
  688. (const :tag "Ignore all scheduled todos (compatibility)" t)
  689. (const :tag "Show scheduled todos" nil)
  690. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  691. (defcustom org-agenda-todo-ignore-deadlines nil
  692. "Non-nil means ignore some deadline TODO items when making TODO list.
  693. There are different motivations for using different values, please think
  694. carefully when configuring this variable.
  695. This applies when creating the global TODO list.
  696. Valid values are:
  697. near Don't show near deadline entries. A deadline is near when it is
  698. closer than `org-deadline-warning-days' days. The idea behind this
  699. is that such items will appear in the agenda anyway.
  700. far Don't show TODO entries where a deadline has been defined, but
  701. is not going to happen anytime soon. This is useful if you want to use
  702. the TODO list to figure out what to do now.
  703. past Don't show entries with a deadline timestamp for today or in the past.
  704. future Don't show entries with a deadline timestamp in the future, not even
  705. when they become `near' ones. Use it with caution.
  706. all Ignore all TODO entries that do have a deadline.
  707. t Same as `near', for backward compatibility.
  708. This variable can also have an integer as a value. See
  709. `org-agenda-todo-ignore-timestamp' for more details.
  710. See also `org-agenda-todo-ignore-with-date'.
  711. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  712. to make his option also apply to the tags-todo list."
  713. :group 'org-agenda-skip
  714. :group 'org-agenda-todo-list
  715. :type '(choice
  716. (const :tag "Ignore near deadlines" near)
  717. (const :tag "Ignore near deadlines (compatibility)" t)
  718. (const :tag "Ignore far deadlines" far)
  719. (const :tag "Ignore all TODOs with a deadlines" all)
  720. (const :tag "Show all TODOs, even if they have a deadline" nil)
  721. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  722. (defcustom org-agenda-todo-ignore-time-comparison-use-seconds nil
  723. "Time unit to use when possibly ignoring an agenda item.
  724. See the docstring of various `org-agenda-todo-ignore-*' options.
  725. The default is to compare time stamps using days. An item is thus
  726. considered to be in the future if it is at least one day after today.
  727. Non-nil means to compare time stamps using seconds. An item is then
  728. considered future if it has a time value later than current time."
  729. :group 'org-agenda-skip
  730. :group 'org-agenda-todo-list
  731. :version "24.4"
  732. :package-version '(Org . "8.0")
  733. :type '(choice
  734. (const :tag "Compare time with days" nil)
  735. (const :tag "Compare time with seconds" t)))
  736. (defcustom org-agenda-tags-todo-honor-ignore-options nil
  737. "Non-nil means honor todo-list ignores options also in tags-todo search.
  738. The variables
  739. `org-agenda-todo-ignore-with-date',
  740. `org-agenda-todo-ignore-timestamp',
  741. `org-agenda-todo-ignore-scheduled',
  742. `org-agenda-todo-ignore-deadlines'
  743. make the global TODO list skip entries that have time stamps of certain
  744. kinds. If this option is set, the same options will also apply for the
  745. tags-todo search, which is the general tags/property matcher
  746. restricted to unfinished TODO entries only."
  747. :group 'org-agenda-skip
  748. :group 'org-agenda-todo-list
  749. :group 'org-agenda-match-view
  750. :type 'boolean)
  751. (defcustom org-agenda-skip-scheduled-if-done nil
  752. "Non-nil means don't show scheduled items in agenda when they are done.
  753. This is relevant for the daily/weekly agenda, not for the TODO list. It
  754. applies only to the actual date of the scheduling. Warnings about an item
  755. with a past scheduling dates are always turned off when the item is DONE."
  756. :group 'org-agenda-skip
  757. :group 'org-agenda-daily/weekly
  758. :type 'boolean)
  759. (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
  760. "Non-nil means skip scheduling line if same entry shows because of deadline.
  761. In the agenda of today, an entry can show up multiple times
  762. because it is both scheduled and has a nearby deadline, and maybe
  763. a plain time stamp as well.
  764. When this variable is nil, the entry will be shown several times.
  765. When set to t, then only the deadline is shown and the fact that
  766. the entry is scheduled today or was scheduled previously is not
  767. shown.
  768. When set to the symbol `not-today', skip scheduled previously,
  769. but not scheduled today.
  770. When set to the symbol `repeated-after-deadline', skip scheduled
  771. items if they are repeated beyond the current deadline."
  772. :group 'org-agenda-skip
  773. :group 'org-agenda-daily/weekly
  774. :type '(choice
  775. (const :tag "Never" nil)
  776. (const :tag "Always" t)
  777. (const :tag "Not when scheduled today" not-today)
  778. (const :tag "When repeated past deadline" repeated-after-deadline)))
  779. (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
  780. "Non-nil means skip timestamp line if same entry shows because of deadline.
  781. In the agenda of today, an entry can show up multiple times
  782. because it has both a plain timestamp and has a nearby deadline.
  783. When this variable is t, then only the deadline is shown and the
  784. fact that the entry has a timestamp for or including today is not
  785. shown. When this variable is nil, the entry will be shown
  786. several times."
  787. :group 'org-agenda-skip
  788. :group 'org-agenda-daily/weekly
  789. :version "24.1"
  790. :type '(choice
  791. (const :tag "Never" nil)
  792. (const :tag "Always" t)))
  793. (defcustom org-agenda-skip-deadline-if-done nil
  794. "Non-nil means don't show deadlines when the corresponding item is done.
  795. When nil, the deadline is still shown and should give you a happy feeling.
  796. This is relevant for the daily/weekly agenda. It applies only to the
  797. actual date of the deadline. Warnings about approaching and past-due
  798. deadlines are always turned off when the item is DONE."
  799. :group 'org-agenda-skip
  800. :group 'org-agenda-daily/weekly
  801. :type 'boolean)
  802. (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
  803. "Non-nil means skip deadline prewarning when entry is also scheduled.
  804. This will apply on all days where a prewarning for the deadline would
  805. be shown, but not at the day when the entry is actually due. On that day,
  806. the deadline will be shown anyway.
  807. This variable may be set to nil, t, the symbol `pre-scheduled',
  808. or a number which will then give the number of days before the actual
  809. deadline when the prewarnings should resume. The symbol `pre-scheduled'
  810. eliminates the deadline prewarning only prior to the scheduled date.
  811. This can be used in a workflow where the first showing of the deadline will
  812. trigger you to schedule it, and then you don't want to be reminded of it
  813. because you will take care of it on the day when scheduled."
  814. :group 'org-agenda-skip
  815. :group 'org-agenda-daily/weekly
  816. :version "24.1"
  817. :type '(choice
  818. (const :tag "Always show prewarning" nil)
  819. (const :tag "Remove prewarning prior to scheduled date" pre-scheduled)
  820. (const :tag "Remove prewarning if entry is scheduled" t)
  821. (integer :tag "Restart prewarning N days before deadline")))
  822. (defcustom org-agenda-skip-scheduled-delay-if-deadline nil
  823. "Non-nil means skip scheduled delay when entry also has a deadline.
  824. This variable may be set to nil, t, the symbol `post-deadline',
  825. or a number which will then give the number of days after the actual
  826. scheduled date when the delay should expire. The symbol `post-deadline'
  827. eliminates the schedule delay when the date is posterior to the deadline."
  828. :group 'org-agenda-skip
  829. :group 'org-agenda-daily/weekly
  830. :version "24.4"
  831. :package-version '(Org . "8.0")
  832. :type '(choice
  833. (const :tag "Always honor delay" nil)
  834. (const :tag "Ignore delay if posterior to the deadline" post-deadline)
  835. (const :tag "Ignore delay if entry has a deadline" t)
  836. (integer :tag "Honor delay up until N days after the scheduled date")))
  837. (defcustom org-agenda-skip-additional-timestamps-same-entry nil
  838. "When nil, multiple same-day timestamps in entry make multiple agenda lines.
  839. When non-nil, after the search for timestamps has matched once in an
  840. entry, the rest of the entry will not be searched."
  841. :group 'org-agenda-skip
  842. :type 'boolean)
  843. (defcustom org-agenda-skip-timestamp-if-done nil
  844. "Non-nil means don't select item by timestamp or -range if it is DONE."
  845. :group 'org-agenda-skip
  846. :group 'org-agenda-daily/weekly
  847. :type 'boolean)
  848. (defcustom org-agenda-dim-blocked-tasks t
  849. "Non-nil means dim blocked tasks in the agenda display.
  850. This causes some overhead during agenda construction, but if you
  851. have turned on `org-enforce-todo-dependencies',
  852. `org-enforce-todo-checkbox-dependencies', or any other blocking
  853. mechanism, this will create useful feedback in the agenda.
  854. Instead of t, this variable can also have the value `invisible'.
  855. Then blocked tasks will be invisible and only become visible when
  856. they become unblocked. An exemption to this behavior is when a task is
  857. blocked because of unchecked checkboxes below it. Since checkboxes do
  858. not show up in the agenda views, making this task invisible you remove any
  859. trace from agenda views that there is something to do. Therefore, a task
  860. that is blocked because of checkboxes will never be made invisible, it
  861. will only be dimmed."
  862. :group 'org-agenda-daily/weekly
  863. :group 'org-agenda-todo-list
  864. :version "24.3"
  865. :type '(choice
  866. (const :tag "Do not dim" nil)
  867. (const :tag "Dim to a gray face" t)
  868. (const :tag "Make invisible" invisible)))
  869. (defgroup org-agenda-startup nil
  870. "Options concerning initial settings in the Agenda in Org Mode."
  871. :tag "Org Agenda Startup"
  872. :group 'org-agenda)
  873. (defcustom org-agenda-menu-show-matcher t
  874. "Non-nil means show the match string in the agenda dispatcher menu.
  875. When nil, the matcher string is not shown, but is put into the help-echo
  876. property so than moving the mouse over the command shows it.
  877. Setting it to nil is good if matcher strings are very long and/or if
  878. you want to use two-columns display (see `org-agenda-menu-two-columns')."
  879. :group 'org-agenda
  880. :version "24.1"
  881. :type 'boolean)
  882. (defcustom org-agenda-menu-two-columns nil
  883. "Non-nil means, use two columns to show custom commands in the dispatcher.
  884. If you use this, you probably want to set `org-agenda-menu-show-matcher'
  885. to nil."
  886. :group 'org-agenda
  887. :version "24.1"
  888. :type 'boolean)
  889. (defcustom org-agenda-finalize-hook nil
  890. "Hook run just before displaying an agenda buffer.
  891. The buffer is still writable when the hook is called.
  892. You can modify some of the buffer substrings but you should be
  893. extra careful not to modify the text properties of the agenda
  894. headlines as the agenda display heavily relies on them."
  895. :group 'org-agenda-startup
  896. :type 'hook)
  897. (defcustom org-agenda-mouse-1-follows-link nil
  898. "Non-nil means mouse-1 on a link will follow the link in the agenda.
  899. A longer mouse click will still set point. Needs to be set
  900. before org.el is loaded."
  901. :group 'org-agenda-startup
  902. :type 'boolean)
  903. (defcustom org-agenda-start-with-follow-mode nil
  904. "The initial value of follow mode in a newly created agenda window."
  905. :group 'org-agenda-startup
  906. :type 'boolean)
  907. (defcustom org-agenda-follow-indirect nil
  908. "Non-nil means `org-agenda-follow-mode' displays only the
  909. current item's tree, in an indirect buffer."
  910. :group 'org-agenda
  911. :version "24.1"
  912. :type 'boolean)
  913. (defcustom org-agenda-show-outline-path t
  914. "Non-nil means show outline path in echo area after line motion."
  915. :group 'org-agenda-startup
  916. :type 'boolean)
  917. (defcustom org-agenda-start-with-entry-text-mode nil
  918. "The initial value of entry-text-mode in a newly created agenda window."
  919. :group 'org-agenda-startup
  920. :type 'boolean)
  921. (defcustom org-agenda-entry-text-maxlines 5
  922. "Number of text lines to be added when `E' is pressed in the agenda.
  923. Note that this variable only used during agenda display. To add entry text
  924. when exporting the agenda, configure the variable
  925. `org-agenda-add-entry-text-maxlines'."
  926. :group 'org-agenda
  927. :type 'integer)
  928. (defcustom org-agenda-entry-text-exclude-regexps nil
  929. "List of regular expressions to clean up entry text.
  930. The complete matches of all regular expressions in this list will be
  931. removed from entry text before it is shown in the agenda."
  932. :group 'org-agenda
  933. :type '(repeat (regexp)))
  934. (defcustom org-agenda-entry-text-leaders " > "
  935. "Text prepended to the entry text in agenda buffers."
  936. :version "24.4"
  937. :package-version '(Org . "8.0")
  938. :group 'org-agenda
  939. :type 'string)
  940. (defvar org-agenda-entry-text-cleanup-hook nil
  941. "Hook that is run after basic cleanup of entry text to be shown in agenda.
  942. This cleanup is done in a temporary buffer, so the function may inspect and
  943. change the entire buffer.
  944. Some default stuff like drawers and scheduling/deadline dates will already
  945. have been removed when this is called, as will any matches for regular
  946. expressions listed in `org-agenda-entry-text-exclude-regexps'.")
  947. (defvar org-agenda-include-inactive-timestamps nil
  948. "Non-nil means include inactive time stamps in agenda.
  949. Dynamically scoped.")
  950. (defgroup org-agenda-windows nil
  951. "Options concerning the windows used by the Agenda in Org Mode."
  952. :tag "Org Agenda Windows"
  953. :group 'org-agenda)
  954. (defcustom org-agenda-window-setup 'reorganize-frame
  955. "How the agenda buffer should be displayed.
  956. Possible values for this option are:
  957. current-window Show agenda in the current window, keeping all other windows.
  958. other-window Use `switch-to-buffer-other-window' to display agenda.
  959. only-window Show agenda, deleting all other windows.
  960. reorganize-frame Show only two windows on the current frame, the current
  961. window and the agenda.
  962. other-frame Use `switch-to-buffer-other-frame' to display agenda.
  963. Also, when exiting the agenda, kill that frame.
  964. See also the variable `org-agenda-restore-windows-after-quit'."
  965. :group 'org-agenda-windows
  966. :type '(choice
  967. (const current-window)
  968. (const other-frame)
  969. (const other-window)
  970. (const only-window)
  971. (const reorganize-frame)))
  972. (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
  973. "The min and max height of the agenda window as a fraction of frame height.
  974. The value of the variable is a cons cell with two numbers between 0 and 1.
  975. It only matters if `org-agenda-window-setup' is `reorganize-frame'."
  976. :group 'org-agenda-windows
  977. :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
  978. (defcustom org-agenda-restore-windows-after-quit nil
  979. "Non-nil means restore window configuration upon exiting agenda.
  980. Before the window configuration is changed for displaying the agenda,
  981. the current status is recorded. When the agenda is exited with
  982. `q' or `x' and this option is set, the old state is restored. If
  983. `org-agenda-window-setup' is `other-frame', the value of this
  984. option will be ignored."
  985. :group 'org-agenda-windows
  986. :type 'boolean)
  987. (defcustom org-agenda-span 'week
  988. "Number of days to include in overview display.
  989. Can be day, week, month, year, or any number of days.
  990. Custom commands can set this variable in the options section."
  991. :group 'org-agenda-daily/weekly
  992. :type '(choice (const :tag "Day" day)
  993. (const :tag "Week" week)
  994. (const :tag "Fortnight" fortnight)
  995. (const :tag "Month" month)
  996. (const :tag "Year" year)
  997. (integer :tag "Custom")))
  998. (defcustom org-agenda-start-on-weekday 1
  999. "Non-nil means start the overview always on the specified weekday.
  1000. 0 denotes Sunday, 1 denotes Monday, etc.
  1001. When nil, always start on the current day.
  1002. Custom commands can set this variable in the options section."
  1003. :group 'org-agenda-daily/weekly
  1004. :type '(choice (const :tag "Today" nil)
  1005. (integer :tag "Weekday No.")))
  1006. (defcustom org-agenda-show-all-dates t
  1007. "Non-nil means `org-agenda' shows every day in the selected range.
  1008. When nil, only the days which actually have entries are shown."
  1009. :group 'org-agenda-daily/weekly
  1010. :type 'boolean)
  1011. (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
  1012. "Format string for displaying dates in the agenda.
  1013. Used by the daily/weekly agenda. This should be a format string
  1014. understood by `format-time-string', or a function returning the
  1015. formatted date as a string. The function must take a single
  1016. argument, a calendar-style date list like (month day year)."
  1017. :group 'org-agenda-daily/weekly
  1018. :type '(choice
  1019. (string :tag "Format string")
  1020. (function :tag "Function")))
  1021. (defun org-agenda-format-date-aligned (date)
  1022. "Format a DATE string for display in the daily/weekly agenda.
  1023. This function makes sure that dates are aligned for easy reading."
  1024. (require 'cal-iso)
  1025. (let* ((dayname (calendar-day-name date))
  1026. (day (cadr date))
  1027. (day-of-week (calendar-day-of-week date))
  1028. (month (car date))
  1029. (monthname (calendar-month-name month))
  1030. (year (nth 2 date))
  1031. (iso-week (org-days-to-iso-week
  1032. (calendar-absolute-from-gregorian date)))
  1033. (weekyear (cond ((and (= month 1) (>= iso-week 52))
  1034. (1- year))
  1035. ((and (= month 12) (<= iso-week 1))
  1036. (1+ year))
  1037. (t year)))
  1038. (weekstring (if (= day-of-week 1)
  1039. (format " W%02d" iso-week)
  1040. "")))
  1041. (format "%-10s %2d %s %4d%s"
  1042. dayname day monthname year weekstring)))
  1043. (defcustom org-agenda-time-leading-zero nil
  1044. "Non-nil means use leading zero for military times in agenda.
  1045. For example, 9:30am would become 09:30 rather than 9:30."
  1046. :group 'org-agenda-daily/weekly
  1047. :version "24.1"
  1048. :type 'boolean)
  1049. (defcustom org-agenda-timegrid-use-ampm nil
  1050. "When set, show AM/PM style timestamps on the timegrid."
  1051. :group 'org-agenda
  1052. :version "24.1"
  1053. :type 'boolean)
  1054. (defun org-agenda-time-of-day-to-ampm (time)
  1055. "Convert TIME of a string like \"13:45\" to an AM/PM style time string."
  1056. (let* ((hour-number (string-to-number (substring time 0 -3)))
  1057. (minute (substring time -2))
  1058. (ampm "am"))
  1059. (cond
  1060. ((equal hour-number 12)
  1061. (setq ampm "pm"))
  1062. ((> hour-number 12)
  1063. (setq ampm "pm")
  1064. (setq hour-number (- hour-number 12))))
  1065. (concat
  1066. (if org-agenda-time-leading-zero
  1067. (format "%02d" hour-number)
  1068. (format "%02s" (number-to-string hour-number)))
  1069. ":" minute ampm)))
  1070. (defun org-agenda-time-of-day-to-ampm-maybe (time)
  1071. "Conditionally convert TIME to AM/PM format based on `org-agenda-timegrid-use-ampm'."
  1072. (if org-agenda-timegrid-use-ampm
  1073. (org-agenda-time-of-day-to-ampm time)
  1074. time))
  1075. (defcustom org-agenda-weekend-days '(6 0)
  1076. "Which days are weekend?
  1077. These days get the special face `org-agenda-date-weekend' in the agenda."
  1078. :group 'org-agenda-daily/weekly
  1079. :type '(set :greedy t
  1080. (const :tag "Monday" 1)
  1081. (const :tag "Tuesday" 2)
  1082. (const :tag "Wednesday" 3)
  1083. (const :tag "Thursday" 4)
  1084. (const :tag "Friday" 5)
  1085. (const :tag "Saturday" 6)
  1086. (const :tag "Sunday" 0)))
  1087. (defcustom org-agenda-move-date-from-past-immediately-to-today t
  1088. "Non-nil means jump to today when moving a past date forward in time.
  1089. When using S-right in the agenda to move a a date forward, and the date
  1090. stamp currently points to the past, the first key press will move it
  1091. to today. When nil, just move one day forward even if the date stays
  1092. in the past."
  1093. :group 'org-agenda-daily/weekly
  1094. :version "24.1"
  1095. :type 'boolean)
  1096. (defcustom org-agenda-include-diary nil
  1097. "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
  1098. Custom commands can set this variable in the options section."
  1099. :group 'org-agenda-daily/weekly
  1100. :type 'boolean)
  1101. (defcustom org-agenda-include-deadlines t
  1102. "If non-nil, include entries within their deadline warning period.
  1103. Custom commands can set this variable in the options section."
  1104. :group 'org-agenda-daily/weekly
  1105. :version "24.1"
  1106. :type 'boolean)
  1107. (defcustom org-agenda-show-future-repeats t
  1108. "Non-nil shows repeated entries in the future part of the agenda.
  1109. When set to the symbol `next' only the first future repeat is shown."
  1110. :group 'org-agenda-daily/weekly
  1111. :type '(choice
  1112. (const :tag "Show all repeated entries" t)
  1113. (const :tag "Show next repeated entry" next)
  1114. (const :tag "Do not show repeated entries" nil))
  1115. :version "26.1"
  1116. :package-version '(Org . "9.1")
  1117. :safe #'symbolp)
  1118. (defcustom org-agenda-prefer-last-repeat nil
  1119. "Non-nil sets date for repeated entries to their last repeat.
  1120. When nil, display SCHEDULED and DEADLINE dates at their base
  1121. date, and in today's agenda, as a reminder. Display plain
  1122. time-stamps, on the other hand, at every repeat date in the past
  1123. in addition to the base date.
  1124. When non-nil, show a repeated entry at its latest repeat date,
  1125. possibly being today even if it wasn't marked as done. This
  1126. setting is useful if you do not always mark repeated entries as
  1127. done and, yet, consider that reaching repeat date starts the task
  1128. anew.
  1129. When set to a list of strings, prefer last repeats only for
  1130. entries with these TODO keywords."
  1131. :group 'org-agenda-daily/weekly
  1132. :type '(choice
  1133. (const :tag "Prefer last repeat" t)
  1134. (const :tag "Prefer base date" nil)
  1135. (repeat :tag "Prefer last repeat for entries with these TODO keywords"
  1136. (string :tag "TODO keyword")))
  1137. :version "26.1"
  1138. :package-version '(Org . "9.1")
  1139. :safe (lambda (x) (or (booleanp x) (consp x))))
  1140. (defcustom org-scheduled-past-days 10000
  1141. "Number of days to continue listing scheduled items not marked DONE.
  1142. When an item is scheduled on a date, it shows up in the agenda on
  1143. this day and will be listed until it is marked done or for the
  1144. number of days given here."
  1145. :group 'org-agenda-daily/weekly
  1146. :type 'integer
  1147. :safe 'integerp)
  1148. (defcustom org-deadline-past-days 10000
  1149. "Number of days to warn about missed deadlines.
  1150. When an item has deadline on a date, it shows up in the agenda on
  1151. this day and will appear as a reminder until it is marked DONE or
  1152. for the number of days given here."
  1153. :group 'org-agenda-daily/weekly
  1154. :type 'integer
  1155. :version "26.1"
  1156. :package-version '(Org . "9.1")
  1157. :safe 'integerp)
  1158. (defcustom org-agenda-log-mode-items '(closed clock)
  1159. "List of items that should be shown in agenda log mode.
  1160. \\<org-agenda-mode-map>\
  1161. This list may contain the following symbols:
  1162. closed Show entries that have been closed on that day.
  1163. clock Show entries that have received clocked time on that day.
  1164. state Show all logged state changes.
  1165. Note that instead of changing this variable, you can also press \
  1166. `\\[universal-argument] \\[org-agenda-log-mode]' in
  1167. the agenda to display all available LOG items temporarily."
  1168. :group 'org-agenda-daily/weekly
  1169. :type '(set :greedy t (const closed) (const clock) (const state)))
  1170. (defcustom org-agenda-clock-consistency-checks
  1171. '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
  1172. :gap-ok-around ("4:00")
  1173. :default-face ((:background "DarkRed") (:foreground "white"))
  1174. :overlap-face nil :gap-face nil :no-end-time-face nil
  1175. :long-face nil :short-face nil)
  1176. "This is a property list, with the following keys:
  1177. :max-duration Mark clocking chunks that are longer than this time.
  1178. This is a time string like \"HH:MM\", or the number
  1179. of minutes as an integer.
  1180. :min-duration Mark clocking chunks that are shorter that this.
  1181. This is a time string like \"HH:MM\", or the number
  1182. of minutes as an integer.
  1183. :max-gap Mark gaps between clocking chunks that are longer than
  1184. this duration. A number of minutes, or a string
  1185. like \"HH:MM\".
  1186. :gap-ok-around List of times during the day which are usually not working
  1187. times. When a gap is detected, but the gap contains any
  1188. of these times, the gap is *not* reported. For example,
  1189. if this is (\"4:00\" \"13:00\") then gaps that contain
  1190. 4:00 in the morning (i.e. the night) and 13:00
  1191. (i.e. a typical lunch time) do not cause a warning.
  1192. You should have at least one time during the night in this
  1193. list, or otherwise the first task each morning will trigger
  1194. a warning because it follows a long gap.
  1195. Furthermore, the following properties can be used to define faces for
  1196. issue display.
  1197. :default-face the default face, if the specific face is undefined
  1198. :overlap-face face for overlapping clocks
  1199. :gap-face face for gaps between clocks
  1200. :no-end-time-face face for incomplete clocks
  1201. :long-face face for clock intervals that are too long
  1202. :short-face face for clock intervals that are too short"
  1203. :group 'org-agenda-daily/weekly
  1204. :group 'org-clock
  1205. :version "24.1"
  1206. :type 'plist)
  1207. (defcustom org-agenda-log-mode-add-notes t
  1208. "Non-nil means add first line of notes to log entries in agenda views.
  1209. If a log item like a state change or a clock entry is associated with
  1210. notes, the first line of these notes will be added to the entry in the
  1211. agenda display."
  1212. :group 'org-agenda-daily/weekly
  1213. :type 'boolean)
  1214. (defcustom org-agenda-start-with-log-mode nil
  1215. "The initial value of log-mode in a newly created agenda window.
  1216. See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
  1217. explanations on the possible values."
  1218. :group 'org-agenda-startup
  1219. :group 'org-agenda-daily/weekly
  1220. :type '(choice (const :tag "Don't show log items" nil)
  1221. (const :tag "Show only log items" only)
  1222. (const :tag "Show all possible log items" clockcheck)
  1223. (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
  1224. (choice (const :tag "Show closed log items" closed)
  1225. (const :tag "Show clocked log items" clock)
  1226. (const :tag "Show all logged state changes" state)))))
  1227. (defcustom org-agenda-start-with-clockreport-mode nil
  1228. "The initial value of clockreport-mode in a newly created agenda window."
  1229. :group 'org-agenda-startup
  1230. :group 'org-agenda-daily/weekly
  1231. :type 'boolean)
  1232. (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
  1233. "Property list with parameters for the clocktable in clockreport mode.
  1234. This is the display mode that shows a clock table in the daily/weekly
  1235. agenda, the properties for this dynamic block can be set here.
  1236. The usual clocktable parameters are allowed here, but you cannot set
  1237. the properties :name, :tstart, :tend, :block, and :scope - these will
  1238. be overwritten to make sure the content accurately reflects the
  1239. current display in the agenda."
  1240. :group 'org-agenda-daily/weekly
  1241. :type 'plist)
  1242. (defvaralias 'org-agenda-search-view-search-words-only
  1243. 'org-agenda-search-view-always-boolean)
  1244. (defcustom org-agenda-search-view-always-boolean nil
  1245. "Non-nil means the search string is interpreted as individual parts.
  1246. The search string for search view can either be interpreted as a phrase,
  1247. or as a list of snippets that define a boolean search for a number of
  1248. strings.
  1249. When this is non-nil, the string will be split on whitespace, and each
  1250. snippet will be searched individually, and all must match in order to
  1251. select an entry. A snippet is then a single string of non-white
  1252. characters, or a string in double quotes, or a regexp in {} braces.
  1253. If a snippet is preceded by \"-\", the snippet must *not* match.
  1254. \"+\" is syntactic sugar for positive selection. Each snippet may
  1255. be found as a full word or a partial word, but see the variable
  1256. `org-agenda-search-view-force-full-words'.
  1257. When this is nil, search will look for the entire search phrase as one,
  1258. with each space character matching any amount of whitespace, including
  1259. line breaks.
  1260. Even when this is nil, you can still switch to Boolean search dynamically
  1261. by preceding the first snippet with \"+\" or \"-\". If the first snippet
  1262. is a regexp marked with braces like \"{abc}\", this will also switch to
  1263. boolean search."
  1264. :group 'org-agenda-search-view
  1265. :version "24.1"
  1266. :type 'boolean)
  1267. (defcustom org-agenda-search-view-force-full-words nil
  1268. "Non-nil means, search words must be matches as complete words.
  1269. When nil, they may also match part of a word."
  1270. :group 'org-agenda-search-view
  1271. :version "24.1"
  1272. :type 'boolean)
  1273. (defcustom org-agenda-search-view-max-outline-level 0
  1274. "Maximum outline level to display in search view.
  1275. E.g. when this is set to 1, the search view will only
  1276. show headlines of level 1. When set to 0, the default
  1277. value, don't limit agenda view by outline level."
  1278. :group 'org-agenda-search-view
  1279. :version "26.1"
  1280. :package-version '(Org . "8.3")
  1281. :type 'integer)
  1282. (defgroup org-agenda-time-grid nil
  1283. "Options concerning the time grid in the Org Agenda."
  1284. :tag "Org Agenda Time Grid"
  1285. :group 'org-agenda)
  1286. (defcustom org-agenda-search-headline-for-time t
  1287. "Non-nil means search headline for a time-of-day.
  1288. If the headline contains a time-of-day in one format or another, it will
  1289. be used to sort the entry into the time sequence of items for a day.
  1290. Some people have time stamps in the headline that refer to the creation
  1291. time or so, and then this produces an unwanted side effect. If this is
  1292. the case for your, use this variable to turn off searching the headline
  1293. for a time."
  1294. :group 'org-agenda-time-grid
  1295. :type 'boolean)
  1296. (defcustom org-agenda-use-time-grid t
  1297. "Non-nil means show a time grid in the agenda schedule.
  1298. A time grid is a set of lines for specific times (like every two hours between
  1299. 8:00 and 20:00). The items scheduled for a day at specific times are
  1300. sorted in between these lines.
  1301. For details about when the grid will be shown, and what it will look like, see
  1302. the variable `org-agenda-time-grid'."
  1303. :group 'org-agenda-time-grid
  1304. :type 'boolean)
  1305. (defcustom org-agenda-time-grid
  1306. '((daily today require-timed)
  1307. (800 1000 1200 1400 1600 1800 2000)
  1308. "......"
  1309. "----------------")
  1310. "The settings for time grid for agenda display.
  1311. This is a list of four items. The first item is again a list. It contains
  1312. symbols specifying conditions when the grid should be displayed:
  1313. daily if the agenda shows a single day
  1314. weekly if the agenda shows an entire week
  1315. today show grid on current date, independent of daily/weekly display
  1316. require-timed show grid only if at least one item has a time specification
  1317. remove-match skip grid times already present in an entry
  1318. The second item is a list of integers, indicating the times that
  1319. should have a grid line.
  1320. The third item is a string which will be placed right after the
  1321. times that have a grid line.
  1322. The fourth item is a string placed after the grid times. This
  1323. will align with agenda items"
  1324. :group 'org-agenda-time-grid
  1325. :type
  1326. '(list
  1327. (set :greedy t :tag "Grid Display Options"
  1328. (const :tag "Show grid in single day agenda display" daily)
  1329. (const :tag "Show grid in weekly agenda display" weekly)
  1330. (const :tag "Always show grid for today" today)
  1331. (const :tag "Show grid only if any timed entries are present"
  1332. require-timed)
  1333. (const :tag "Skip grid times already present in an entry"
  1334. remove-match))
  1335. (repeat :tag "Grid Times" (integer :tag "Time"))
  1336. (string :tag "Grid String (after agenda times)")
  1337. (string :tag "Grid String (aligns with agenda items)")))
  1338. (defcustom org-agenda-show-current-time-in-grid t
  1339. "Non-nil means show the current time in the time grid."
  1340. :group 'org-agenda-time-grid
  1341. :version "24.1"
  1342. :type 'boolean)
  1343. (defcustom org-agenda-current-time-string
  1344. "now - - - - - - - - - - - - - - - - - - - - - - - - -"
  1345. "The string for the current time marker in the agenda."
  1346. :group 'org-agenda-time-grid
  1347. :version "24.1"
  1348. :type 'string)
  1349. (defgroup org-agenda-sorting nil
  1350. "Options concerning sorting in the Org Agenda."
  1351. :tag "Org Agenda Sorting"
  1352. :group 'org-agenda)
  1353. (defcustom org-agenda-sorting-strategy
  1354. '((agenda habit-down time-up priority-down category-keep)
  1355. (todo priority-down category-keep)
  1356. (tags priority-down category-keep)
  1357. (search category-keep))
  1358. "Sorting structure for the agenda items of a single day.
  1359. This is a list of symbols which will be used in sequence to determine
  1360. if an entry should be listed before another entry. The following
  1361. symbols are recognized:
  1362. time-up Put entries with time-of-day indications first, early first
  1363. time-down Put entries with time-of-day indications first, late first
  1364. timestamp-up Sort by any timestamp, early first
  1365. timestamp-down Sort by any timestamp, late first
  1366. scheduled-up Sort by scheduled timestamp, early first
  1367. scheduled-down Sort by scheduled timestamp, late first
  1368. deadline-up Sort by deadline timestamp, early first
  1369. deadline-down Sort by deadline timestamp, late first
  1370. ts-up Sort by active timestamp, early first
  1371. ts-down Sort by active timestamp, late first
  1372. tsia-up Sort by inactive timestamp, early first
  1373. tsia-down Sort by inactive timestamp, late first
  1374. category-keep Keep the default order of categories, corresponding to the
  1375. sequence in `org-agenda-files'.
  1376. category-up Sort alphabetically by category, A-Z.
  1377. category-down Sort alphabetically by category, Z-A.
  1378. tag-up Sort alphabetically by last tag, A-Z.
  1379. tag-down Sort alphabetically by last tag, Z-A.
  1380. priority-up Sort numerically by priority, high priority last.
  1381. priority-down Sort numerically by priority, high priority first.
  1382. todo-state-up Sort by todo state, tasks that are done last.
  1383. todo-state-down Sort by todo state, tasks that are done first.
  1384. effort-up Sort numerically by estimated effort, high effort last.
  1385. effort-down Sort numerically by estimated effort, high effort first.
  1386. user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
  1387. user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
  1388. habit-up Put entries that are habits first
  1389. habit-down Put entries that are habits last
  1390. alpha-up Sort headlines alphabetically
  1391. alpha-down Sort headlines alphabetically, reversed
  1392. The different possibilities will be tried in sequence, and testing stops
  1393. if one comparison returns a \"not-equal\". For example, the default
  1394. '(time-up category-keep priority-down)
  1395. means: Pull out all entries having a specified time of day and sort them,
  1396. in order to make a time schedule for the current day the first thing in the
  1397. agenda listing for the day. Of the entries without a time indication, keep
  1398. the grouped in categories, don't sort the categories, but keep them in
  1399. the sequence given in `org-agenda-files'. Within each category sort by
  1400. priority.
  1401. Leaving out `category-keep' would mean that items will be sorted across
  1402. categories by priority.
  1403. Instead of a single list, this can also be a set of list for specific
  1404. contents, with a context symbol in the car of the list, any of
  1405. `agenda', `todo', `tags', `search' for the corresponding agenda views.
  1406. Custom commands can bind this variable in the options section."
  1407. :group 'org-agenda-sorting
  1408. :type `(choice
  1409. (repeat :tag "General" ,org-sorting-choice)
  1410. (list :tag "Individually"
  1411. (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
  1412. (repeat ,org-sorting-choice))
  1413. (cons (const :tag "Strategy for TODO lists" todo)
  1414. (repeat ,org-sorting-choice))
  1415. (cons (const :tag "Strategy for Tags matches" tags)
  1416. (repeat ,org-sorting-choice))
  1417. (cons (const :tag "Strategy for search matches" search)
  1418. (repeat ,org-sorting-choice)))))
  1419. (defcustom org-agenda-cmp-user-defined nil
  1420. "A function to define the comparison `user-defined'.
  1421. This function must receive two arguments, agenda entry a and b.
  1422. If a>b, return +1. If a<b, return -1. If they are equal as seen by
  1423. the user comparison, return nil.
  1424. When this is defined, you can make `user-defined-up' and `user-defined-down'
  1425. part of an agenda sorting strategy."
  1426. :group 'org-agenda-sorting
  1427. :type 'symbol)
  1428. (defcustom org-sort-agenda-notime-is-late t
  1429. "Non-nil means items without time are considered late.
  1430. This is only relevant for sorting. When t, items which have no explicit
  1431. time like 15:30 will be considered as 99:01, i.e. later than any items which
  1432. do have a time. When nil, the default time is before 0:00. You can use this
  1433. option to decide if the schedule for today should come before or after timeless
  1434. agenda entries."
  1435. :group 'org-agenda-sorting
  1436. :type 'boolean)
  1437. (defcustom org-sort-agenda-noeffort-is-high t
  1438. "Non-nil means items without effort estimate are sorted as high effort.
  1439. This also applies when filtering an agenda view with respect to the
  1440. < or > effort operator. Then, tasks with no effort defined will be treated
  1441. as tasks with high effort.
  1442. When nil, such items are sorted as 0 minutes effort."
  1443. :group 'org-agenda-sorting
  1444. :type 'boolean)
  1445. (defgroup org-agenda-line-format nil
  1446. "Options concerning the entry prefix in the Org agenda display."
  1447. :tag "Org Agenda Line Format"
  1448. :group 'org-agenda)
  1449. (defcustom org-agenda-prefix-format
  1450. '((agenda . " %i %-12:c%?-12t% s")
  1451. (todo . " %i %-12:c")
  1452. (tags . " %i %-12:c")
  1453. (search . " %i %-12:c"))
  1454. "Format specifications for the prefix of items in the agenda views.
  1455. An alist with one entry per agenda type. The keys of the
  1456. sublists are `agenda', `todo', `search' and `tags'. The values
  1457. are format strings.
  1458. This format works similar to a printf format, with the following meaning:
  1459. %c the category of the item, \"Diary\" for entries from the diary,
  1460. or as given by the CATEGORY keyword or derived from the file name
  1461. %e the effort required by the item
  1462. %l the level of the item (insert X space(s) if item is of level X)
  1463. %i the icon category of the item, see `org-agenda-category-icon-alist'
  1464. %T the last tag of the item (ignore inherited tags, which come first)
  1465. %t the HH:MM time-of-day specification if one applies to the entry
  1466. %s Scheduling/Deadline information, a short string
  1467. %b show breadcrumbs, i.e., the names of the higher levels
  1468. %(expression) Eval EXPRESSION and replace the control string
  1469. by the result
  1470. All specifiers work basically like the standard `%s' of printf, but may
  1471. contain two additional characters: a question mark just after the `%'
  1472. and a whitespace/punctuation character just before the final letter.
  1473. If the first character after `%' is a question mark, the entire field
  1474. will only be included if the corresponding value applies to the current
  1475. entry. This is useful for fields which should have fixed width when
  1476. present, but zero width when absent. For example, \"%?-12t\" will
  1477. result in a 12 character time field if a time of the day is specified,
  1478. but will completely disappear in entries which do not contain a time.
  1479. If there is punctuation or whitespace character just before the
  1480. final format letter, this character will be appended to the field
  1481. value if the value is not empty. For example, the format
  1482. \"%-12:c\" leads to \"Diary: \" if the category is \"Diary\". If
  1483. the category is empty, no additional colon is inserted.
  1484. The default value for the agenda sublist is \" %-12:c%?-12t% s\",
  1485. which means:
  1486. - Indent the line with two space characters
  1487. - Give the category a 12 chars wide field, padded with whitespace on
  1488. the right (because of `-'). Append a colon if there is a category
  1489. (because of `:').
  1490. - If there is a time-of-day, put it into a 12 chars wide field. If no
  1491. time, don't put in an empty field, just skip it (because of '?').
  1492. - Finally, put the scheduling information.
  1493. See also the variables `org-agenda-remove-times-when-in-prefix' and
  1494. `org-agenda-remove-tags'.
  1495. Custom commands can set this variable in the options section."
  1496. :type '(choice
  1497. (string :tag "General format")
  1498. (list :greedy t :tag "View dependent"
  1499. (cons (const agenda) (string :tag "Format"))
  1500. (cons (const todo) (string :tag "Format"))
  1501. (cons (const tags) (string :tag "Format"))
  1502. (cons (const search) (string :tag "Format"))))
  1503. :group 'org-agenda-line-format
  1504. :version "26.1"
  1505. :package-version '(Org . "9.1"))
  1506. (defcustom org-agenda-breadcrumbs-separator "->"
  1507. "The separator of breadcrumbs in agenda lines."
  1508. :group 'org-agenda-line-format
  1509. :package-version '(Org . "9.3")
  1510. :type 'string
  1511. :safe #'stringp)
  1512. (defvar org-prefix-format-compiled nil
  1513. "The compiled prefix format and associated variables.
  1514. This is a list where first element is a list of variable bindings, and second
  1515. element is the compiled format expression. See the variable
  1516. `org-agenda-prefix-format'.")
  1517. (defcustom org-agenda-todo-keyword-format "%-1s"
  1518. "Format for the TODO keyword in agenda lines.
  1519. Set this to something like \"%-12s\" if you want all TODO keywords
  1520. to occupy a fixed space in the agenda display."
  1521. :group 'org-agenda-line-format
  1522. :type 'string)
  1523. (defcustom org-agenda-diary-sexp-prefix nil
  1524. "A regexp that matches part of a diary sexp entry
  1525. which should be treated as scheduling/deadline information in
  1526. `org-agenda'.
  1527. For example, you can use this to extract the `diary-remind-message' from
  1528. `diary-remind' entries."
  1529. :group 'org-agenda-line-format
  1530. :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
  1531. (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
  1532. "Text preceding timerange entries in the agenda view.
  1533. This is a list with two strings. The first applies when the range
  1534. is entirely on one day. The second applies if the range spans several days.
  1535. The strings may have two \"%d\" format specifiers which will be filled
  1536. with the sequence number of the days, and the total number of days in the
  1537. range, respectively."
  1538. :group 'org-agenda-line-format
  1539. :type '(list
  1540. (string :tag "Deadline today ")
  1541. (choice :tag "Deadline relative"
  1542. (string :tag "Format string")
  1543. (function))))
  1544. (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
  1545. "Text preceding scheduled items in the agenda view.
  1546. This is a list with two strings. The first applies when the item is
  1547. scheduled on the current day. The second applies when it has been scheduled
  1548. previously, it may contain a %d indicating that this is the nth time that
  1549. this item is scheduled, due to automatic rescheduling of unfinished items
  1550. for the following day. So this number is one larger than the number of days
  1551. that passed since this item was scheduled first."
  1552. :group 'org-agenda-line-format
  1553. :version "24.4"
  1554. :package-version '(Org . "8.0")
  1555. :type '(list
  1556. (string :tag "Scheduled today ")
  1557. (string :tag "Scheduled previously")))
  1558. (defcustom org-agenda-inactive-leader "["
  1559. "Text preceding item pulled into the agenda by inactive time stamps.
  1560. These entries are added to the agenda when pressing \"[\"."
  1561. :group 'org-agenda-line-format
  1562. :version "24.1"
  1563. :type 'string)
  1564. (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: " "%2d d. ago: ")
  1565. "Text preceding deadline items in the agenda view.
  1566. This is a list with three strings. The first applies when the item has its
  1567. deadline on the current day. The second applies when the deadline is in the
  1568. future, the third one when it is in the past. The strings may contain %d
  1569. to capture the number of days."
  1570. :group 'org-agenda-line-format
  1571. :version "24.4"
  1572. :package-version '(Org . "8.0")
  1573. :type '(list
  1574. (string :tag "Deadline today ")
  1575. (string :tag "Deadline in the future ")
  1576. (string :tag "Deadline in the past ")))
  1577. (defcustom org-agenda-remove-times-when-in-prefix t
  1578. "Non-nil means remove duplicate time specifications in agenda items.
  1579. When the format `org-agenda-prefix-format' contains a `%t' specifier, a
  1580. time-of-day specification in a headline or diary entry is extracted and
  1581. placed into the prefix. If this option is non-nil, the original specification
  1582. \(a timestamp or -range, or just a plain time(range) specification like
  1583. 11:30-4pm) will be removed for agenda display. This makes the agenda less
  1584. cluttered.
  1585. The option can be t or nil. It may also be the symbol `beg', indicating
  1586. that the time should only be removed when it is located at the beginning of
  1587. the headline/diary entry."
  1588. :group 'org-agenda-line-format
  1589. :type '(choice
  1590. (const :tag "Always" t)
  1591. (const :tag "Never" nil)
  1592. (const :tag "When at beginning of entry" beg)))
  1593. (defcustom org-agenda-remove-timeranges-from-blocks nil
  1594. "Non-nil means remove time ranges specifications in agenda
  1595. items that span on several days."
  1596. :group 'org-agenda-line-format
  1597. :version "24.1"
  1598. :type 'boolean)
  1599. (defcustom org-agenda-default-appointment-duration nil
  1600. "Default duration for appointments that only have a starting time.
  1601. When nil, no duration is specified in such cases.
  1602. When non-nil, this must be the number of minutes, e.g. 60 for one hour."
  1603. :group 'org-agenda-line-format
  1604. :type '(choice
  1605. (integer :tag "Minutes")
  1606. (const :tag "No default duration")))
  1607. (defcustom org-agenda-show-inherited-tags t
  1608. "Non-nil means show inherited tags in each agenda line.
  1609. When this option is set to `always', it takes precedence over
  1610. `org-agenda-use-tag-inheritance' and inherited tags are shown
  1611. in every agenda.
  1612. When this option is set to t (the default), inherited tags are
  1613. shown when they are available, i.e. when the value of
  1614. `org-agenda-use-tag-inheritance' enables tag inheritance for the
  1615. given agenda type.
  1616. This can be set to a list of agenda types in which the agenda
  1617. must display the inherited tags. Available types are `todo',
  1618. `agenda' and `search'.
  1619. When set to nil, never show inherited tags in agenda lines."
  1620. :group 'org-agenda-line-format
  1621. :group 'org-agenda
  1622. :version "24.3"
  1623. :type '(choice
  1624. (const :tag "Show inherited tags when available" t)
  1625. (const :tag "Always show inherited tags" always)
  1626. (repeat :tag "Show inherited tags only in selected agenda types"
  1627. (symbol :tag "Agenda type"))))
  1628. (defcustom org-agenda-use-tag-inheritance '(todo search agenda)
  1629. "List of agenda view types where to use tag inheritance.
  1630. In tags/tags-todo/tags-tree agenda views, tag inheritance is
  1631. controlled by `org-use-tag-inheritance'. In other agenda types,
  1632. `org-use-tag-inheritance' is not used for the selection of the
  1633. agenda entries. Still, you may want the agenda to be aware of
  1634. the inherited tags anyway, e.g. for later tag filtering.
  1635. Allowed value are `todo', `search' and `agenda'.
  1636. This variable has no effect if `org-agenda-show-inherited-tags'
  1637. is set to `always'. In that case, the agenda is aware of those
  1638. tags.
  1639. The default value sets tags in every agenda type. Setting this
  1640. option to nil will speed up non-tags agenda view a lot."
  1641. :group 'org-agenda
  1642. :version "26.1"
  1643. :package-version '(Org . "9.1")
  1644. :type '(choice
  1645. (const :tag "Use tag inheritance in all agenda types" t)
  1646. (repeat :tag "Use tag inheritance in selected agenda types"
  1647. (symbol :tag "Agenda type"))))
  1648. (defcustom org-agenda-hide-tags-regexp nil
  1649. "Regular expression used to filter away specific tags in agenda views.
  1650. This means that these tags will be present, but not be shown in the agenda
  1651. line. Secondary filtering will still work on the hidden tags.
  1652. Nil means don't hide any tags."
  1653. :group 'org-agenda-line-format
  1654. :type '(choice
  1655. (const :tag "Hide none" nil)
  1656. (string :tag "Regexp ")))
  1657. (defvaralias 'org-agenda-remove-tags-when-in-prefix
  1658. 'org-agenda-remove-tags)
  1659. (defcustom org-agenda-remove-tags nil
  1660. "Non-nil means remove the tags from the headline copy in the agenda.
  1661. When this is the symbol `prefix', only remove tags when
  1662. `org-agenda-prefix-format' contains a `%T' specifier."
  1663. :group 'org-agenda-line-format
  1664. :type '(choice
  1665. (const :tag "Always" t)
  1666. (const :tag "Never" nil)
  1667. (const :tag "When prefix format contains %T" prefix)))
  1668. (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column)
  1669. (defcustom org-agenda-tags-column 'auto
  1670. "Shift tags in agenda items to this column.
  1671. If set to `auto', tags will be automatically aligned to the right
  1672. edge of the window.
  1673. If set to a positive number, tags will be left-aligned to that
  1674. column. If set to a negative number, tags will be right-aligned
  1675. to that column. For example, -80 works well for a normal 80
  1676. character screen."
  1677. :group 'org-agenda-line-format
  1678. :type '(choice
  1679. (const :tag "Automatically align to right edge of window" auto)
  1680. (integer :tag "Specific column" -80))
  1681. :package-version '(Org . "9.1")
  1682. :version "26.1")
  1683. (defcustom org-agenda-fontify-priorities 'cookies
  1684. "Non-nil means highlight low and high priorities in agenda.
  1685. When t, the highest priority entries are bold, lowest priority italic.
  1686. However, settings in `org-priority-faces' will overrule these faces.
  1687. When this variable is the symbol `cookies', only fontify the
  1688. cookies, not the entire task.
  1689. This may also be an association list of priority faces, whose
  1690. keys are the character values of `org-highest-priority',
  1691. `org-default-priority', and `org-lowest-priority' (the default values
  1692. are ?A, ?B, and ?C, respectively). The face may be a named face, a
  1693. color as a string, or a list like `(:background \"Red\")'.
  1694. If it is a color, the variable `org-faces-easy-properties'
  1695. determines if it is a foreground or a background color."
  1696. :group 'org-agenda-line-format
  1697. :type '(choice
  1698. (const :tag "Never" nil)
  1699. (const :tag "Defaults" t)
  1700. (const :tag "Cookies only" cookies)
  1701. (repeat :tag "Specify"
  1702. (list (character :tag "Priority" :value ?A)
  1703. (choice :tag "Face "
  1704. (string :tag "Color")
  1705. (sexp :tag "Face"))))))
  1706. (defcustom org-agenda-day-face-function nil
  1707. "Function called to determine what face should be used to display a day.
  1708. The only argument passed to that function is the day. It should
  1709. returns a face, or nil if does not want to specify a face and let
  1710. the normal rules apply."
  1711. :group 'org-agenda-line-format
  1712. :version "24.1"
  1713. :type '(choice (const nil) (function)))
  1714. (defcustom org-agenda-category-icon-alist nil
  1715. "Alist of category icon to be displayed in agenda views.
  1716. Each entry should have the following format:
  1717. (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
  1718. Where CATEGORY-REGEXP is a regexp matching the categories where
  1719. the icon should be displayed.
  1720. FILE-OR-DATA either a file path or a string containing image data.
  1721. The other fields can be omitted safely if not needed:
  1722. TYPE indicates the image type.
  1723. DATA-P is a boolean indicating whether the FILE-OR-DATA string is
  1724. image data.
  1725. PROPS are additional image attributes to assign to the image,
  1726. like, e.g. `:ascent center'.
  1727. (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
  1728. If you want to set the display properties yourself, just put a
  1729. list as second element:
  1730. (CATEGORY-REGEXP (MY PROPERTY LIST))
  1731. For example, to display a 16px horizontal space for Emacs
  1732. category, you can use:
  1733. (\"Emacs\" \\='(space . (:width (16))))"
  1734. :group 'org-agenda-line-format
  1735. :version "24.1"
  1736. :type '(alist :key-type (string :tag "Regexp matching category")
  1737. :value-type (choice (list :tag "Icon"
  1738. (string :tag "File or data")
  1739. (symbol :tag "Type")
  1740. (boolean :tag "Data?")
  1741. (repeat :tag "Extra image properties" :inline t symbol))
  1742. (list :tag "Display properties" sexp))))
  1743. (defgroup org-agenda-column-view nil
  1744. "Options concerning column view in the agenda."
  1745. :tag "Org Agenda Column View"
  1746. :group 'org-agenda)
  1747. (defcustom org-agenda-view-columns-initially nil
  1748. "When non-nil, switch to columns view right after creating the agenda."
  1749. :group 'org-agenda-column-view
  1750. :type 'boolean
  1751. :version "26.1"
  1752. :package-version '(Org . "9.0")
  1753. :safe #'booleanp)
  1754. (defcustom org-agenda-columns-show-summaries t
  1755. "Non-nil means show summaries for columns displayed in the agenda view."
  1756. :group 'org-agenda-column-view
  1757. :type 'boolean)
  1758. (defcustom org-agenda-columns-compute-summary-properties t
  1759. "Non-nil means recompute all summary properties before column view.
  1760. When column view in the agenda is listing properties that have a summary
  1761. operator, it can go to all relevant buffers and recompute the summaries
  1762. there. This can mean overhead for the agenda column view, but is necessary
  1763. to have thing up to date.
  1764. As a special case, a CLOCKSUM property also makes sure that the clock
  1765. computations are current."
  1766. :group 'org-agenda-column-view
  1767. :type 'boolean)
  1768. (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
  1769. "Non-nil means the duration of an appointment will add to day effort.
  1770. The property to which appointment durations will be added is the one given
  1771. in the option `org-effort-property'. If an appointment does not have
  1772. an end time, `org-agenda-default-appointment-duration' will be used. If that
  1773. is not set, an appointment without end time will not contribute to the time
  1774. estimate."
  1775. :group 'org-agenda-column-view
  1776. :type 'boolean)
  1777. (defcustom org-agenda-auto-exclude-function nil
  1778. "A function called with a tag to decide if it is filtered on \
  1779. \\<org-agenda-mode-map>`\\[org-agenda-filter-by-tag] RET'.
  1780. The sole argument to the function, which is called once for each
  1781. possible tag, is a string giving the name of the tag. The
  1782. function should return either nil if the tag should be included
  1783. as normal, or \"-<TAG>\" to exclude the tag.
  1784. Note that for the purpose of tag filtering, only the lower-case version of
  1785. all tags will be considered, so that this function will only ever see
  1786. the lower-case version of all tags."
  1787. :group 'org-agenda
  1788. :type '(choice (const nil) (function)))
  1789. (defcustom org-agenda-bulk-custom-functions nil
  1790. "Alist of characters and custom functions for bulk actions.
  1791. For example, this value makes those two functions available:
  1792. \\='((?R set-category)
  1793. (?C bulk-cut))
  1794. With selected entries in an agenda buffer, `B R' will call
  1795. the custom function `set-category' on the selected entries.
  1796. Note that functions in this alist don't need to be quoted."
  1797. :type '(alist :key-type character :value-type (group function))
  1798. :version "24.1"
  1799. :group 'org-agenda)
  1800. (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
  1801. "Execute BODY with point at location given by `org-hd-marker' property.
  1802. If STRING is non-nil, the text property will be fetched from position 0
  1803. in that string. If STRING is nil, it will be fetched from the beginning
  1804. of the current line."
  1805. (org-with-gensyms (marker)
  1806. `(let ((,marker (get-text-property (if ,string 0 (point-at-bol))
  1807. 'org-hd-marker ,string)))
  1808. (with-current-buffer (marker-buffer ,marker)
  1809. (save-excursion
  1810. (goto-char ,marker)
  1811. ,@body)))))
  1812. (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
  1813. (defun org-add-agenda-custom-command (entry)
  1814. "Replace or add a command in `org-agenda-custom-commands'.
  1815. This is mostly for hacking and trying a new command - once the command
  1816. works you probably want to add it to `org-agenda-custom-commands' for good."
  1817. (let ((ass (assoc (car entry) org-agenda-custom-commands)))
  1818. (if ass
  1819. (setcdr ass (cdr entry))
  1820. (push entry org-agenda-custom-commands))))
  1821. (defmacro org-agenda--insert-overriding-header (default)
  1822. "Insert header into agenda view.
  1823. The inserted header depends on `org-agenda-overriding-header'.
  1824. If the empty string, don't insert a header. If any other string,
  1825. insert it as a header. If nil, insert DEFAULT, which should
  1826. evaluate to a string."
  1827. (declare (debug (form)) (indent defun))
  1828. `(cond
  1829. ((not org-agenda-overriding-header) (insert ,default))
  1830. ((equal org-agenda-overriding-header "") nil)
  1831. ((stringp org-agenda-overriding-header)
  1832. (insert (propertize org-agenda-overriding-header
  1833. 'face 'org-agenda-structure)
  1834. "\n"))
  1835. (t (user-error "Invalid value for `org-agenda-overriding-header': %S"
  1836. org-agenda-overriding-header))))
  1837. ;;; Define the org-agenda-mode
  1838. (defvaralias 'org-agenda-keymap 'org-agenda-mode-map)
  1839. (defvar org-agenda-mode-map (make-sparse-keymap)
  1840. "Keymap for `org-agenda-mode'.")
  1841. (defvar org-agenda-menu) ; defined later in this file.
  1842. (defvar org-agenda-restrict nil) ; defined later in this file.
  1843. (defvar org-agenda-follow-mode nil)
  1844. (defvar org-agenda-entry-text-mode nil)
  1845. (defvar org-agenda-clockreport-mode nil)
  1846. (defvar org-agenda-show-log nil
  1847. "When non-nil, show the log in the agenda.
  1848. Do not set this directly; instead use
  1849. `org-agenda-start-with-log-mode', which see.")
  1850. (defvar org-agenda-redo-command nil)
  1851. (defvar org-agenda-query-string nil)
  1852. (defvar org-agenda-mode-hook nil
  1853. "Hook run after `org-agenda-mode' is turned on.
  1854. The buffer is still writable when this hook is called.")
  1855. (defvar org-agenda-type nil)
  1856. (defvar org-agenda-force-single-file nil)
  1857. (defvar org-agenda-bulk-marked-entries nil
  1858. "List of markers that refer to marked entries in the agenda.")
  1859. (defvar org-agenda-current-date nil
  1860. "Active date when building the agenda.")
  1861. ;;; Multiple agenda buffers support
  1862. (defcustom org-agenda-sticky nil
  1863. "Non-nil means agenda q key will bury agenda buffers.
  1864. Agenda commands will then show existing buffer instead of generating new ones.
  1865. When nil, `q' will kill the single agenda buffer."
  1866. :group 'org-agenda
  1867. :version "24.3"
  1868. :type 'boolean)
  1869. ;;;###autoload
  1870. (defun org-toggle-sticky-agenda (&optional arg)
  1871. "Toggle `org-agenda-sticky'."
  1872. (interactive "P")
  1873. (let ((new-value (if arg
  1874. (> (prefix-numeric-value arg) 0)
  1875. (not org-agenda-sticky))))
  1876. (if (equal new-value org-agenda-sticky)
  1877. (and (called-interactively-p 'interactive)
  1878. (message "Sticky agenda was already %s"
  1879. (if org-agenda-sticky "enabled" "disabled")))
  1880. (setq org-agenda-sticky new-value)
  1881. (org-agenda-kill-all-agenda-buffers)
  1882. (and (called-interactively-p 'interactive)
  1883. (message "Sticky agenda %s"
  1884. (if org-agenda-sticky "enabled" "disabled"))))))
  1885. (defvar org-agenda-buffer nil
  1886. "Agenda buffer currently being generated.")
  1887. (defvar org-agenda-last-prefix-arg nil)
  1888. (defvar org-agenda-this-buffer-name nil)
  1889. (defvar org-agenda-doing-sticky-redo nil)
  1890. (defvar org-agenda-this-buffer-is-sticky nil)
  1891. (defvar org-agenda-last-indirect-buffer nil
  1892. "Last buffer loaded by `org-agenda-tree-to-indirect-buffer'.")
  1893. (defconst org-agenda-local-vars
  1894. '(org-agenda-this-buffer-name
  1895. org-agenda-undo-list
  1896. org-agenda-pending-undo-list
  1897. org-agenda-follow-mode
  1898. org-agenda-entry-text-mode
  1899. org-agenda-clockreport-mode
  1900. org-agenda-show-log
  1901. org-agenda-redo-command
  1902. org-agenda-query-string
  1903. org-agenda-type
  1904. org-agenda-bulk-marked-entries
  1905. org-agenda-undo-has-started-in
  1906. org-agenda-info
  1907. org-agenda-pre-window-conf
  1908. org-agenda-columns-active
  1909. org-agenda-tag-filter
  1910. org-agenda-category-filter
  1911. org-agenda-top-headline-filter
  1912. org-agenda-regexp-filter
  1913. org-agenda-effort-filter
  1914. org-agenda-markers
  1915. org-agenda-last-search-view-search-was-boolean
  1916. org-agenda-last-indirect-buffer
  1917. org-agenda-filtered-by-category
  1918. org-agenda-filter-form
  1919. org-agenda-cycle-counter
  1920. org-agenda-last-prefix-arg)
  1921. "Variables that must be local in agenda buffers to allow multiple buffers.")
  1922. (defun org-agenda-mode ()
  1923. "Mode for time-sorted view on action items in Org files.
  1924. The following commands are available:
  1925. \\{org-agenda-mode-map}"
  1926. (interactive)
  1927. (let ((agenda-local-vars-to-keep
  1928. '(text-scale-mode-amount
  1929. text-scale-mode
  1930. text-scale-mode-lighter
  1931. face-remapping-alist))
  1932. (save (buffer-local-variables)))
  1933. (kill-all-local-variables)
  1934. (cl-flet ((reset-saved (var-set)
  1935. "Reset variables in VAR-SET to possibly stored value in SAVE."
  1936. (dolist (elem save)
  1937. (pcase elem
  1938. (`(,var . ,val) ;ignore unbound variables
  1939. (when (and val (memq var var-set))
  1940. (set var val)))))))
  1941. (cond (org-agenda-doing-sticky-redo
  1942. ;; Refreshing sticky agenda-buffer
  1943. ;;
  1944. ;; Preserve the value of `org-agenda-local-vars' variables.
  1945. (mapc #'make-local-variable org-agenda-local-vars)
  1946. (reset-saved org-agenda-local-vars)
  1947. (setq-local org-agenda-this-buffer-is-sticky t))
  1948. (org-agenda-sticky
  1949. ;; Creating a sticky Agenda buffer for the first time
  1950. (mapc 'make-local-variable org-agenda-local-vars)
  1951. (setq-local org-agenda-this-buffer-is-sticky t))
  1952. (t
  1953. ;; Creating a non-sticky agenda buffer
  1954. (setq-local org-agenda-this-buffer-is-sticky nil)))
  1955. (mapc #'make-local-variable agenda-local-vars-to-keep)
  1956. (reset-saved agenda-local-vars-to-keep)))
  1957. (setq org-agenda-undo-list nil
  1958. org-agenda-pending-undo-list nil
  1959. org-agenda-bulk-marked-entries nil)
  1960. (setq major-mode 'org-agenda-mode)
  1961. ;; Keep global-font-lock-mode from turning on font-lock-mode
  1962. (setq-local font-lock-global-modes (list 'not major-mode))
  1963. (setq mode-name "Org-Agenda")
  1964. (setq indent-tabs-mode nil)
  1965. (use-local-map org-agenda-mode-map)
  1966. (easy-menu-add org-agenda-menu)
  1967. (when org-startup-truncated (setq truncate-lines t))
  1968. (setq-local line-move-visual nil)
  1969. (add-hook 'post-command-hook 'org-agenda-update-agenda-type nil 'local)
  1970. (add-hook 'pre-command-hook 'org-unhighlight nil 'local)
  1971. ;; Make sure properties are removed when copying text
  1972. (if (boundp 'filter-buffer-substring-functions)
  1973. (add-hook 'filter-buffer-substring-functions
  1974. (lambda (fun start end delete)
  1975. (substring-no-properties (funcall fun start end delete)))
  1976. nil t)
  1977. ;; Emacs >= 24.4.
  1978. (add-function :filter-return (local 'filter-buffer-substring-function)
  1979. #'substring-no-properties))
  1980. (unless org-agenda-keep-modes
  1981. (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
  1982. org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
  1983. org-agenda-show-log org-agenda-start-with-log-mode
  1984. org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode))
  1985. (add-to-invisibility-spec '(org-filtered))
  1986. (add-to-invisibility-spec '(org-link))
  1987. (easy-menu-change
  1988. '("Agenda") "Agenda Files"
  1989. (append
  1990. (list
  1991. (vector
  1992. (if (get 'org-agenda-files 'org-restrict)
  1993. "Restricted to single file"
  1994. "Edit File List")
  1995. '(org-edit-agenda-file-list)
  1996. (not (get 'org-agenda-files 'org-restrict)))
  1997. "--")
  1998. (mapcar 'org-file-menu-entry (org-agenda-files))))
  1999. (org-agenda-set-mode-name)
  2000. (apply
  2001. (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
  2002. (list 'org-agenda-mode-hook)))
  2003. (substitute-key-definition 'undo 'org-agenda-undo
  2004. org-agenda-mode-map global-map)
  2005. (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
  2006. (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
  2007. (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
  2008. (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
  2009. (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
  2010. (org-defkey org-agenda-mode-map [(meta down)] 'org-agenda-drag-line-forward)
  2011. (org-defkey org-agenda-mode-map [(meta up)] 'org-agenda-drag-line-backward)
  2012. (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
  2013. (org-defkey org-agenda-mode-map "\M-m" 'org-agenda-bulk-toggle)
  2014. (org-defkey org-agenda-mode-map "*" 'org-agenda-bulk-mark-all)
  2015. (org-defkey org-agenda-mode-map "\M-*" 'org-agenda-bulk-toggle-all)
  2016. (org-defkey org-agenda-mode-map "#" 'org-agenda-dim-blocked-tasks)
  2017. (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
  2018. (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
  2019. (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-unmark-all)
  2020. (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
  2021. (org-defkey org-agenda-mode-map "k" 'org-agenda-capture)
  2022. (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
  2023. (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
  2024. (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
  2025. (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
  2026. (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
  2027. (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
  2028. (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
  2029. (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
  2030. (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
  2031. (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
  2032. (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
  2033. (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
  2034. (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
  2035. (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
  2036. (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
  2037. (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
  2038. (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
  2039. (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
  2040. (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
  2041. (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
  2042. (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
  2043. (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
  2044. (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
  2045. (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
  2046. (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
  2047. (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
  2048. (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
  2049. (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
  2050. (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
  2051. (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
  2052. (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
  2053. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
  2054. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
  2055. (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
  2056. (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
  2057. (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
  2058. (let ((l '(1 2 3 4 5 6 7 8 9 0)))
  2059. (while l (org-defkey org-agenda-mode-map
  2060. (int-to-string (pop l)) 'digit-argument)))
  2061. (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
  2062. (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
  2063. (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
  2064. (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
  2065. (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
  2066. (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
  2067. (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
  2068. (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
  2069. (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
  2070. (org-defkey org-agenda-mode-map "g" 'org-agenda-redo-all)
  2071. (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
  2072. (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
  2073. (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
  2074. 'org-clock-modify-effort-estimate)
  2075. (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
  2076. (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
  2077. (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
  2078. (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
  2079. (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
  2080. (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
  2081. (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
  2082. (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
  2083. (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
  2084. (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
  2085. (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
  2086. (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
  2087. (substitute-key-definition 'next-line 'org-agenda-next-line
  2088. org-agenda-mode-map global-map)
  2089. (substitute-key-definition 'previous-line 'org-agenda-previous-line
  2090. org-agenda-mode-map global-map)
  2091. (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
  2092. (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
  2093. (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
  2094. (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
  2095. (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
  2096. (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
  2097. (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
  2098. (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
  2099. (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
  2100. (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
  2101. (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
  2102. (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
  2103. (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
  2104. (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
  2105. (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
  2106. (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
  2107. (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
  2108. (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
  2109. (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  2110. (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
  2111. (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
  2112. (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
  2113. (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
  2114. (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
  2115. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
  2116. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
  2117. (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
  2118. (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
  2119. (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
  2120. (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  2121. (org-defkey org-agenda-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock-from-agenda)
  2122. (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
  2123. (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
  2124. (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
  2125. (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
  2126. (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
  2127. (org-defkey org-agenda-mode-map "_" 'org-agenda-filter-by-effort)
  2128. (org-defkey org-agenda-mode-map "=" 'org-agenda-filter-by-regexp)
  2129. (org-defkey org-agenda-mode-map "|" 'org-agenda-filter-remove-all)
  2130. (org-defkey org-agenda-mode-map "~" 'org-agenda-limit-interactively)
  2131. (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
  2132. (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-headline)
  2133. (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
  2134. (org-defkey org-agenda-mode-map "\C-c\C-x_" 'org-timer-stop)
  2135. (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
  2136. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  2137. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  2138. (org-defkey org-agenda-mode-map "\C-c\C-xI" 'org-info-find-node)
  2139. (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
  2140. (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
  2141. (define-key org-agenda-mode-map [remap forward-paragraph] 'org-agenda-forward-block)
  2142. (define-key org-agenda-mode-map [remap backward-paragraph] 'org-agenda-backward-block)
  2143. (when org-agenda-mouse-1-follows-link
  2144. (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
  2145. (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
  2146. '("Agenda"
  2147. ("Agenda Files")
  2148. "--"
  2149. ("Agenda Dates"
  2150. ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda)]
  2151. ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
  2152. ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
  2153. ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
  2154. "--"
  2155. ("View"
  2156. ["Day View" org-agenda-day-view
  2157. :active (org-agenda-check-type nil 'agenda)
  2158. :style radio :selected (eq org-agenda-current-span 'day)
  2159. :keys "v d (or just d)"]
  2160. ["Week View" org-agenda-week-view
  2161. :active (org-agenda-check-type nil 'agenda)
  2162. :style radio :selected (eq org-agenda-current-span 'week)
  2163. :keys "v w"]
  2164. ["Fortnight View" org-agenda-fortnight-view
  2165. :active (org-agenda-check-type nil 'agenda)
  2166. :style radio :selected (eq org-agenda-current-span 'fortnight)
  2167. :keys "v t"]
  2168. ["Month View" org-agenda-month-view
  2169. :active (org-agenda-check-type nil 'agenda)
  2170. :style radio :selected (eq org-agenda-current-span 'month)
  2171. :keys "v m"]
  2172. ["Year View" org-agenda-year-view
  2173. :active (org-agenda-check-type nil 'agenda)
  2174. :style radio :selected (eq org-agenda-current-span 'year)
  2175. :keys "v y"]
  2176. "--"
  2177. ["Include Diary" org-agenda-toggle-diary
  2178. :style toggle :selected org-agenda-include-diary
  2179. :active (org-agenda-check-type nil 'agenda)]
  2180. ["Include Deadlines" org-agenda-toggle-deadlines
  2181. :style toggle :selected org-agenda-include-deadlines
  2182. :active (org-agenda-check-type nil 'agenda)]
  2183. ["Use Time Grid" org-agenda-toggle-time-grid
  2184. :style toggle :selected org-agenda-use-time-grid
  2185. :active (org-agenda-check-type nil 'agenda)]
  2186. "--"
  2187. ["Show clock report" org-agenda-clockreport-mode
  2188. :style toggle :selected org-agenda-clockreport-mode
  2189. :active (org-agenda-check-type nil 'agenda)]
  2190. ["Show some entry text" org-agenda-entry-text-mode
  2191. :style toggle :selected org-agenda-entry-text-mode
  2192. :active t]
  2193. "--"
  2194. ["Show Logbook entries" org-agenda-log-mode
  2195. :style toggle :selected org-agenda-show-log
  2196. :active (org-agenda-check-type nil 'agenda)
  2197. :keys "v l (or just l)"]
  2198. ["Include archived trees" org-agenda-archives-mode
  2199. :style toggle :selected org-agenda-archives-mode :active t
  2200. :keys "v a"]
  2201. ["Include archive files" (org-agenda-archives-mode t)
  2202. :style toggle :selected (eq org-agenda-archives-mode t) :active t
  2203. :keys "v A"]
  2204. "--"
  2205. ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
  2206. ("Filter current view"
  2207. ["by category at cursor" org-agenda-filter-by-category t]
  2208. ["by tag" org-agenda-filter-by-tag t]
  2209. ["by effort" org-agenda-filter-by-effort t]
  2210. ["by regexp" org-agenda-filter-by-regexp t]
  2211. ["by top-level headline" org-agenda-filter-by-top-headline t]
  2212. "--"
  2213. ["Remove all filtering" org-agenda-filter-remove-all t]
  2214. "--"
  2215. ["limit" org-agenda-limit-interactively t])
  2216. ["Rebuild buffer" org-agenda-redo t]
  2217. ["Write view to file" org-agenda-write t]
  2218. ["Save all Org buffers" org-save-all-org-buffers t]
  2219. "--"
  2220. ["Show original entry" org-agenda-show t]
  2221. ["Go To (other window)" org-agenda-goto t]
  2222. ["Go To (this window)" org-agenda-switch-to t]
  2223. ["Capture with cursor date" org-agenda-capture t]
  2224. ["Follow Mode" org-agenda-follow-mode
  2225. :style toggle :selected org-agenda-follow-mode :active t]
  2226. ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
  2227. "--"
  2228. ("TODO"
  2229. ["Cycle TODO" org-agenda-todo t]
  2230. ["Next TODO set" org-agenda-todo-nextset t]
  2231. ["Previous TODO set" org-agenda-todo-previousset t]
  2232. ["Add note" org-agenda-add-note t])
  2233. ("Archive/Refile/Delete"
  2234. ["Archive default" org-agenda-archive-default t]
  2235. ["Archive default" org-agenda-archive-default-with-confirmation t]
  2236. ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
  2237. ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
  2238. ["Archive subtree" org-agenda-archive t]
  2239. "--"
  2240. ["Refile" org-agenda-refile t]
  2241. "--"
  2242. ["Delete subtree" org-agenda-kill t])
  2243. ("Bulk action"
  2244. ["Mark entry" org-agenda-bulk-mark t]
  2245. ["Mark all" org-agenda-bulk-mark-all t]
  2246. ["Unmark entry" org-agenda-bulk-unmark t]
  2247. ["Unmark all" org-agenda-bulk-unmark-all :active t :keys "U"]
  2248. ["Toggle mark" org-agenda-bulk-toggle t]
  2249. ["Toggle all" org-agenda-bulk-toggle-all t]
  2250. ["Mark regexp" org-agenda-bulk-mark-regexp t])
  2251. ["Act on all marked" org-agenda-bulk-action t]
  2252. "--"
  2253. ("Tags and Properties"
  2254. ["Show all Tags" org-agenda-show-tags t]
  2255. ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
  2256. ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
  2257. "--"
  2258. ["Column View" org-columns t])
  2259. ("Deadline/Schedule"
  2260. ["Schedule" org-agenda-schedule t]
  2261. ["Set Deadline" org-agenda-deadline t]
  2262. "--"
  2263. ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda)]
  2264. ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda)]
  2265. ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda) :keys "C-u S-right"]
  2266. ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda) :keys "C-u S-left"]
  2267. ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda) :keys "C-u C-u S-right"]
  2268. ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda) :keys "C-u C-u S-left"]
  2269. ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda)])
  2270. ("Clock and Effort"
  2271. ["Clock in" org-agenda-clock-in t]
  2272. ["Clock out" org-agenda-clock-out t]
  2273. ["Clock cancel" org-agenda-clock-cancel t]
  2274. ["Goto running clock" org-clock-goto t]
  2275. "--"
  2276. ["Set Effort" org-agenda-set-effort t]
  2277. ["Change clocked effort" org-clock-modify-effort-estimate
  2278. (org-clock-is-active)])
  2279. ("Priority"
  2280. ["Set Priority" org-agenda-priority t]
  2281. ["Increase Priority" org-agenda-priority-up t]
  2282. ["Decrease Priority" org-agenda-priority-down t]
  2283. ["Show Priority" org-show-priority t])
  2284. ("Calendar/Diary"
  2285. ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda)]
  2286. ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda)]
  2287. ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda)]
  2288. ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda)]
  2289. ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda)]
  2290. ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda)]
  2291. "--"
  2292. ["Create iCalendar File" org-icalendar-combine-agenda-files t])
  2293. "--"
  2294. ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
  2295. "--"
  2296. ("MobileOrg"
  2297. ["Push Files and Views" org-mobile-push t]
  2298. ["Get Captured and Flagged" org-mobile-pull t]
  2299. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "\\[org-agenda] ?"]
  2300. ["Show note / unflag" org-agenda-show-the-flagging-note t]
  2301. "--"
  2302. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  2303. "--"
  2304. ["Quit" org-agenda-quit t]
  2305. ["Exit and Release Buffers" org-agenda-exit t]
  2306. ))
  2307. ;;; Agenda undo
  2308. (defvar org-agenda-allow-remote-undo t
  2309. "Non-nil means allow remote undo from the agenda buffer.")
  2310. (defvar org-agenda-undo-has-started-in nil
  2311. "Buffers that have already seen `undo-start' in the current undo sequence.")
  2312. (defun org-agenda-undo ()
  2313. "Undo a remote editing step in the agenda.
  2314. This undoes changes both in the agenda buffer and in the remote buffer
  2315. that have been changed along."
  2316. (interactive)
  2317. (or org-agenda-allow-remote-undo
  2318. (user-error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
  2319. (when (not (eq this-command last-command))
  2320. (setq org-agenda-undo-has-started-in nil
  2321. org-agenda-pending-undo-list org-agenda-undo-list))
  2322. (when (not org-agenda-pending-undo-list)
  2323. (user-error "No further undo information"))
  2324. (let* ((entry (pop org-agenda-pending-undo-list))
  2325. buf line cmd rembuf)
  2326. (setq cmd (pop entry) line (pop entry))
  2327. (setq rembuf (nth 2 entry))
  2328. (org-with-remote-undo rembuf
  2329. (while (bufferp (setq buf (pop entry)))
  2330. (when (pop entry)
  2331. (with-current-buffer buf
  2332. (let ((last-undo-buffer buf)
  2333. (inhibit-read-only t))
  2334. (unless (memq buf org-agenda-undo-has-started-in)
  2335. (push buf org-agenda-undo-has-started-in)
  2336. (make-local-variable 'pending-undo-list)
  2337. (undo-start))
  2338. (while (and pending-undo-list
  2339. (listp pending-undo-list)
  2340. (not (car pending-undo-list)))
  2341. (pop pending-undo-list))
  2342. (undo-more 1))))))
  2343. (org-goto-line line)
  2344. (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
  2345. (defun org-verify-change-for-undo (l1 l2)
  2346. "Verify that a real change occurred between the undo lists L1 and L2."
  2347. (while (and l1 (listp l1) (null (car l1))) (pop l1))
  2348. (while (and l2 (listp l2) (null (car l2))) (pop l2))
  2349. (not (eq l1 l2)))
  2350. ;;; Agenda dispatch
  2351. (defvar org-agenda-restrict-begin (make-marker))
  2352. (defvar org-agenda-restrict-end (make-marker))
  2353. (defvar org-agenda-last-dispatch-buffer nil)
  2354. (defvar org-agenda-overriding-restriction nil)
  2355. (defcustom org-agenda-custom-commands-contexts nil
  2356. "Alist of custom agenda keys and contextual rules.
  2357. For example, if you have a custom agenda command \"p\" and you
  2358. want this command to be accessible only from plain text files,
  2359. use this:
  2360. \\='((\"p\" ((in-file . \"\\\\.txt\\\\'\"))))
  2361. Here are the available contexts definitions:
  2362. in-file: command displayed only in matching files
  2363. in-mode: command displayed only in matching modes
  2364. not-in-file: command not displayed in matching files
  2365. not-in-mode: command not displayed in matching modes
  2366. in-buffer: command displayed only in matching buffers
  2367. not-in-buffer: command not displayed in matching buffers
  2368. [function]: a custom function taking no argument
  2369. If you define several checks, the agenda command will be
  2370. accessible if there is at least one valid check.
  2371. You can also bind a key to another agenda custom command
  2372. depending on contextual rules.
  2373. \\='((\"p\" \"q\" ((in-file . \"\\\\.txt\\\\'\"))))
  2374. Here it means: in .txt files, use \"p\" as the key for the
  2375. agenda command otherwise associated with \"q\". (The command
  2376. originally associated with \"q\" is not displayed to avoid
  2377. duplicates.)"
  2378. :version "24.3"
  2379. :group 'org-agenda-custom-commands
  2380. :type '(repeat (list :tag "Rule"
  2381. (string :tag " Agenda key")
  2382. (string :tag "Replace by command")
  2383. (repeat :tag "Available when"
  2384. (choice
  2385. (cons :tag "Condition"
  2386. (choice
  2387. (const :tag "In file" in-file)
  2388. (const :tag "Not in file" not-in-file)
  2389. (const :tag "In buffer" in-buffer)
  2390. (const :tag "Not in buffer" not-in-buffer)
  2391. (const :tag "In mode" in-mode)
  2392. (const :tag "Not in mode" not-in-mode))
  2393. (regexp))
  2394. (function :tag "Custom function"))))))
  2395. (defcustom org-agenda-max-entries nil
  2396. "Maximum number of entries to display in an agenda.
  2397. This can be nil (no limit) or an integer or an alist of agenda
  2398. types with an associated number of entries to display in this
  2399. type."
  2400. :version "24.4"
  2401. :package-version '(Org . "8.0")
  2402. :group 'org-agenda-custom-commands
  2403. :type '(choice (symbol :tag "No limit" nil)
  2404. (integer :tag "Max number of entries")
  2405. (repeat
  2406. (cons (choice :tag "Agenda type"
  2407. (const agenda)
  2408. (const todo)
  2409. (const tags)
  2410. (const search))
  2411. (integer :tag "Max number of entries")))))
  2412. (defcustom org-agenda-max-todos nil
  2413. "Maximum number of TODOs to display in an agenda.
  2414. This can be nil (no limit) or an integer or an alist of agenda
  2415. types with an associated number of entries to display in this
  2416. type."
  2417. :version "24.4"
  2418. :package-version '(Org . "8.0")
  2419. :group 'org-agenda-custom-commands
  2420. :type '(choice (symbol :tag "No limit" nil)
  2421. (integer :tag "Max number of TODOs")
  2422. (repeat
  2423. (cons (choice :tag "Agenda type"
  2424. (const agenda)
  2425. (const todo)
  2426. (const tags)
  2427. (const search))
  2428. (integer :tag "Max number of TODOs")))))
  2429. (defcustom org-agenda-max-tags nil
  2430. "Maximum number of tagged entries to display in an agenda.
  2431. This can be nil (no limit) or an integer or an alist of agenda
  2432. types with an associated number of entries to display in this
  2433. type."
  2434. :version "24.4"
  2435. :package-version '(Org . "8.0")
  2436. :group 'org-agenda-custom-commands
  2437. :type '(choice (symbol :tag "No limit" nil)
  2438. (integer :tag "Max number of tagged entries")
  2439. (repeat
  2440. (cons (choice :tag "Agenda type"
  2441. (const agenda)
  2442. (const todo)
  2443. (const tags)
  2444. (const search))
  2445. (integer :tag "Max number of tagged entries")))))
  2446. (defcustom org-agenda-max-effort nil
  2447. "Maximum cumulated effort duration for the agenda.
  2448. This can be nil (no limit) or a number of minutes (as an integer)
  2449. or an alist of agenda types with an associated number of minutes
  2450. to limit entries to in this type."
  2451. :version "24.4"
  2452. :package-version '(Org . "8.0")
  2453. :group 'org-agenda-custom-commands
  2454. :type '(choice (symbol :tag "No limit" nil)
  2455. (integer :tag "Max number of minutes")
  2456. (repeat
  2457. (cons (choice :tag "Agenda type"
  2458. (const agenda)
  2459. (const todo)
  2460. (const tags)
  2461. (const search))
  2462. (integer :tag "Max number of minutes")))))
  2463. (defvar org-agenda-keep-restricted-file-list nil)
  2464. (defvar org-keys nil)
  2465. (defvar org-match nil)
  2466. ;;;###autoload
  2467. (defun org-agenda (&optional arg org-keys restriction)
  2468. "Dispatch agenda commands to collect entries to the agenda buffer.
  2469. Prompts for a command to execute. Any prefix arg will be passed
  2470. on to the selected command. The default selections are:
  2471. a Call `org-agenda-list' to display the agenda for current day or week.
  2472. t Call `org-todo-list' to display the global todo list.
  2473. T Call `org-todo-list' to display the global todo list, select only
  2474. entries with a specific TODO keyword (the user gets a prompt).
  2475. m Call `org-tags-view' to display headlines with tags matching
  2476. a condition (the user is prompted for the condition).
  2477. M Like `m', but select only TODO entries, no ordinary headlines.
  2478. e Export views to associated files.
  2479. s Search entries for keywords.
  2480. S Search entries for keywords, only with TODO keywords.
  2481. / Multi occur across all agenda files and also files listed
  2482. in `org-agenda-text-search-extra-files'.
  2483. < Restrict agenda commands to buffer, subtree, or region.
  2484. Press several times to get the desired effect.
  2485. > Remove a previous restriction.
  2486. # List \"stuck\" projects.
  2487. ! Configure what \"stuck\" means.
  2488. C Configure custom agenda commands.
  2489. More commands can be added by configuring the variable
  2490. `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
  2491. searches can be pre-defined in this way.
  2492. If the current buffer is in Org mode and visiting a file, you can also
  2493. first press `<' once to indicate that the agenda should be temporarily
  2494. \(until the next use of `\\[org-agenda]') restricted to the current file.
  2495. Pressing `<' twice means to restrict to the current subtree or region
  2496. \(if active)."
  2497. (interactive "P")
  2498. (catch 'exit
  2499. (let* ((prefix-descriptions nil)
  2500. (org-agenda-buffer-name org-agenda-buffer-name)
  2501. (org-agenda-window-setup (if (equal (buffer-name)
  2502. org-agenda-buffer-name)
  2503. 'current-window
  2504. org-agenda-window-setup))
  2505. (org-agenda-custom-commands-orig org-agenda-custom-commands)
  2506. (org-agenda-custom-commands
  2507. ;; normalize different versions
  2508. (delq nil
  2509. (mapcar
  2510. (lambda (x)
  2511. (cond ((stringp (cdr x))
  2512. (push x prefix-descriptions)
  2513. nil)
  2514. ((stringp (nth 1 x)) x)
  2515. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2516. (t (cons (car x) (cons "" (cdr x))))))
  2517. org-agenda-custom-commands)))
  2518. (org-agenda-custom-commands
  2519. (org-contextualize-keys
  2520. org-agenda-custom-commands org-agenda-custom-commands-contexts))
  2521. (buf (current-buffer))
  2522. (bfn (buffer-file-name (buffer-base-buffer)))
  2523. entry key type org-match lprops ans)
  2524. ;; Turn off restriction unless there is an overriding one,
  2525. (unless org-agenda-overriding-restriction
  2526. (unless org-agenda-keep-restricted-file-list
  2527. ;; There is a request to keep the file list in place
  2528. (put 'org-agenda-files 'org-restrict nil))
  2529. (setq org-agenda-restrict nil)
  2530. (move-marker org-agenda-restrict-begin nil)
  2531. (move-marker org-agenda-restrict-end nil))
  2532. ;; Delete old local properties
  2533. (put 'org-agenda-redo-command 'org-lprops nil)
  2534. ;; Delete previously set last-arguments
  2535. (put 'org-agenda-redo-command 'last-args nil)
  2536. ;; Remember where this call originated
  2537. (setq org-agenda-last-dispatch-buffer (current-buffer))
  2538. (unless org-keys
  2539. (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
  2540. org-keys (car ans)
  2541. restriction (cdr ans)))
  2542. ;; If we have sticky agenda buffers, set a name for the buffer,
  2543. ;; depending on the invoking keys. The user may still set this
  2544. ;; as a command option, which will overwrite what we do here.
  2545. (when org-agenda-sticky
  2546. (setq org-agenda-buffer-name
  2547. (format "*Org Agenda(%s)*" org-keys)))
  2548. ;; Establish the restriction, if any
  2549. (when (and (not org-agenda-overriding-restriction) restriction)
  2550. (put 'org-agenda-files 'org-restrict (list bfn))
  2551. (cond
  2552. ((eq restriction 'region)
  2553. (setq org-agenda-restrict (current-buffer))
  2554. (move-marker org-agenda-restrict-begin (region-beginning))
  2555. (move-marker org-agenda-restrict-end (region-end)))
  2556. ((eq restriction 'subtree)
  2557. (save-excursion
  2558. (setq org-agenda-restrict (current-buffer))
  2559. (org-back-to-heading t)
  2560. (move-marker org-agenda-restrict-begin (point))
  2561. (move-marker org-agenda-restrict-end
  2562. (progn (org-end-of-subtree t)))))
  2563. ((and (eq restriction 'buffer)
  2564. (or (< 1 (point-min))
  2565. (< (point-max) (1+ (buffer-size)))))
  2566. (setq org-agenda-restrict (current-buffer))
  2567. (move-marker org-agenda-restrict-begin (point-min))
  2568. (move-marker org-agenda-restrict-end (point-max)))))
  2569. ;; For example the todo list should not need it (but does...)
  2570. (cond
  2571. ((setq entry (assoc org-keys org-agenda-custom-commands))
  2572. (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
  2573. (progn
  2574. (setq type (nth 2 entry) org-match (eval (nth 3 entry))
  2575. lprops (nth 4 entry))
  2576. (when org-agenda-sticky
  2577. (setq org-agenda-buffer-name
  2578. (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
  2579. (format "*Org Agenda(%s)*" org-keys))))
  2580. (put 'org-agenda-redo-command 'org-lprops lprops)
  2581. (cond
  2582. ((eq type 'agenda)
  2583. (org-let lprops '(org-agenda-list current-prefix-arg)))
  2584. ((eq type 'agenda*)
  2585. (org-let lprops '(org-agenda-list current-prefix-arg nil nil t)))
  2586. ((eq type 'alltodo)
  2587. (org-let lprops '(org-todo-list current-prefix-arg)))
  2588. ((eq type 'search)
  2589. (org-let lprops '(org-search-view current-prefix-arg org-match nil)))
  2590. ((eq type 'stuck)
  2591. (org-let lprops '(org-agenda-list-stuck-projects
  2592. current-prefix-arg)))
  2593. ((eq type 'tags)
  2594. (org-let lprops '(org-tags-view current-prefix-arg org-match)))
  2595. ((eq type 'tags-todo)
  2596. (org-let lprops '(org-tags-view '(4) org-match)))
  2597. ((eq type 'todo)
  2598. (org-let lprops '(org-todo-list org-match)))
  2599. ((eq type 'tags-tree)
  2600. (org-check-for-org-mode)
  2601. (org-let lprops '(org-match-sparse-tree current-prefix-arg org-match)))
  2602. ((eq type 'todo-tree)
  2603. (org-check-for-org-mode)
  2604. (org-let lprops
  2605. '(org-occur (concat "^" org-outline-regexp "[ \t]*"
  2606. (regexp-quote org-match) "\\>"))))
  2607. ((eq type 'occur-tree)
  2608. (org-check-for-org-mode)
  2609. (org-let lprops '(org-occur org-match)))
  2610. ((functionp type)
  2611. (org-let lprops '(funcall type org-match)))
  2612. ((fboundp type)
  2613. (org-let lprops '(funcall type org-match)))
  2614. (t (user-error "Invalid custom agenda command type %s" type))))
  2615. (org-agenda-run-series (nth 1 entry) (cddr entry))))
  2616. ((equal org-keys "C")
  2617. (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
  2618. (customize-variable 'org-agenda-custom-commands))
  2619. ((equal org-keys "a") (call-interactively 'org-agenda-list))
  2620. ((equal org-keys "s") (call-interactively 'org-search-view))
  2621. ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
  2622. ((equal org-keys "t") (call-interactively 'org-todo-list))
  2623. ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
  2624. ((equal org-keys "m") (call-interactively 'org-tags-view))
  2625. ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
  2626. ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
  2627. ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
  2628. (add-hook
  2629. 'post-command-hook
  2630. (lambda ()
  2631. (unless (current-message)
  2632. (let* ((m (org-agenda-get-any-marker))
  2633. (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
  2634. (when note
  2635. (message "FLAGGING-NOTE ([?] for more info): %s"
  2636. (org-add-props
  2637. (replace-regexp-in-string
  2638. "\\\\n" "//"
  2639. (copy-sequence note))
  2640. nil 'face 'org-warning))))))
  2641. t t))
  2642. ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
  2643. ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
  2644. ((equal org-keys "!") (customize-variable 'org-stuck-projects))
  2645. (t (user-error "Invalid agenda key"))))))
  2646. (defvar org-agenda-multi)
  2647. (defun org-agenda-append-agenda ()
  2648. "Append another agenda view to the current one.
  2649. This function allows interactive building of block agendas.
  2650. Agenda views are separated by `org-agenda-block-separator'."
  2651. (interactive)
  2652. (unless (derived-mode-p 'org-agenda-mode)
  2653. (user-error "Can only append from within agenda buffer"))
  2654. (let ((org-agenda-multi t))
  2655. (org-agenda)
  2656. (widen)
  2657. (org-agenda-finalize)
  2658. (setq buffer-read-only t)
  2659. (org-agenda-fit-window-to-buffer)))
  2660. (defun org-agenda-normalize-custom-commands (cmds)
  2661. "Normalize custom commands CMDS."
  2662. (delq nil
  2663. (mapcar
  2664. (lambda (x)
  2665. (cond ((stringp (cdr x)) nil)
  2666. ((stringp (nth 1 x)) x)
  2667. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2668. (t (cons (car x) (cons "" (cdr x))))))
  2669. cmds)))
  2670. (defun org-agenda-get-restriction-and-command (prefix-descriptions)
  2671. "The user interface for selecting an agenda command."
  2672. (catch 'exit
  2673. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  2674. (restrict-ok (and bfn (derived-mode-p 'org-mode)))
  2675. (region-p (org-region-active-p))
  2676. (custom org-agenda-custom-commands)
  2677. (selstring "")
  2678. restriction second-time
  2679. c entry key type match prefixes rmheader header-end custom1 desc
  2680. line lines left right n n1)
  2681. (save-window-excursion
  2682. (delete-other-windows)
  2683. (org-switch-to-buffer-other-window " *Agenda Commands*")
  2684. (erase-buffer)
  2685. (insert (eval-when-compile
  2686. (let ((header
  2687. "Press key for an agenda command:
  2688. -------------------------------- < Buffer, subtree/region restriction
  2689. a Agenda for current week or day > Remove restriction
  2690. t List of all TODO entries e Export agenda views
  2691. m Match a TAGS/PROP/TODO query T Entries with special TODO kwd
  2692. s Search for keywords M Like m, but only TODO entries
  2693. / Multi-occur S Like s, but only TODO entries
  2694. ? Find :FLAGGED: entries C Configure custom agenda commands
  2695. * Toggle sticky agenda views # List stuck projects (!=configure)
  2696. ")
  2697. (start 0))
  2698. (while (string-match
  2699. "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
  2700. header start)
  2701. (setq start (match-end 0))
  2702. (add-text-properties (match-beginning 2) (match-end 2)
  2703. '(face bold) header))
  2704. header)))
  2705. (setq header-end (point-marker))
  2706. (while t
  2707. (setq custom1 custom)
  2708. (when (eq rmheader t)
  2709. (org-goto-line 1)
  2710. (re-search-forward ":" nil t)
  2711. (delete-region (match-end 0) (point-at-eol))
  2712. (forward-char 1)
  2713. (looking-at "-+")
  2714. (delete-region (match-end 0) (point-at-eol))
  2715. (move-marker header-end (match-end 0)))
  2716. (goto-char header-end)
  2717. (delete-region (point) (point-max))
  2718. ;; Produce all the lines that describe custom commands and prefixes
  2719. (setq lines nil)
  2720. (while (setq entry (pop custom1))
  2721. (setq key (car entry) desc (nth 1 entry)
  2722. type (nth 2 entry)
  2723. match (nth 3 entry))
  2724. (if (> (length key) 1)
  2725. (cl-pushnew (string-to-char key) prefixes :test #'equal)
  2726. (setq line
  2727. (format
  2728. "%-4s%-14s"
  2729. (org-add-props (copy-sequence key)
  2730. '(face bold))
  2731. (cond
  2732. ((string-match "\\S-" desc) desc)
  2733. ((eq type 'agenda) "Agenda for current week or day")
  2734. ((eq type 'agenda*) "Appointments for current week or day")
  2735. ((eq type 'alltodo) "List of all TODO entries")
  2736. ((eq type 'search) "Word search")
  2737. ((eq type 'stuck) "List of stuck projects")
  2738. ((eq type 'todo) "TODO keyword")
  2739. ((eq type 'tags) "Tags query")
  2740. ((eq type 'tags-todo) "Tags (TODO)")
  2741. ((eq type 'tags-tree) "Tags tree")
  2742. ((eq type 'todo-tree) "TODO kwd tree")
  2743. ((eq type 'occur-tree) "Occur tree")
  2744. ((functionp type) (if (symbolp type)
  2745. (symbol-name type)
  2746. "Lambda expression"))
  2747. (t "???"))))
  2748. (cond
  2749. ((not (org-string-nw-p match)) nil)
  2750. (org-agenda-menu-show-matcher
  2751. (setq line
  2752. (concat line ": "
  2753. (cond
  2754. ((stringp match)
  2755. (propertize match 'face 'org-warning))
  2756. ((listp type)
  2757. (format "set of %d commands" (length type)))))))
  2758. (t
  2759. (org-add-props line nil 'help-echo (concat "Matcher: " match))))
  2760. (push line lines)))
  2761. (setq lines (nreverse lines))
  2762. (when prefixes
  2763. (mapc (lambda (x)
  2764. (push
  2765. (format "%s %s"
  2766. (org-add-props (char-to-string x)
  2767. nil 'face 'bold)
  2768. (or (cdr (assoc (concat selstring
  2769. (char-to-string x))
  2770. prefix-descriptions))
  2771. "Prefix key"))
  2772. lines))
  2773. prefixes))
  2774. ;; Check if we should display in two columns
  2775. (if org-agenda-menu-two-columns
  2776. (progn
  2777. (setq n (length lines)
  2778. n1 (+ (/ n 2) (mod n 2))
  2779. right (nthcdr n1 lines)
  2780. left (copy-sequence lines))
  2781. (setcdr (nthcdr (1- n1) left) nil))
  2782. (setq left lines right nil))
  2783. (while left
  2784. (insert "\n" (pop left))
  2785. (when right
  2786. (if (< (current-column) 40)
  2787. (move-to-column 40 t)
  2788. (insert " "))
  2789. (insert (pop right))))
  2790. ;; Make the window the right size
  2791. (goto-char (point-min))
  2792. (if second-time
  2793. (when (not (pos-visible-in-window-p (point-max)))
  2794. (org-fit-window-to-buffer))
  2795. (setq second-time t)
  2796. (org-fit-window-to-buffer))
  2797. ;; Ask for selection
  2798. (message "Press key for agenda command%s:"
  2799. (if (or restrict-ok org-agenda-overriding-restriction)
  2800. (if org-agenda-overriding-restriction
  2801. " (restriction lock active)"
  2802. (if restriction
  2803. (format " (restricted to %s)" restriction)
  2804. " (unrestricted)"))
  2805. ""))
  2806. (setq c (read-char-exclusive))
  2807. (message "")
  2808. (cond
  2809. ((assoc (char-to-string c) custom)
  2810. (setq selstring (concat selstring (char-to-string c)))
  2811. (throw 'exit (cons selstring restriction)))
  2812. ((memq c prefixes)
  2813. (setq selstring (concat selstring (char-to-string c))
  2814. prefixes nil
  2815. rmheader (or rmheader t)
  2816. custom (delq nil (mapcar
  2817. (lambda (x)
  2818. (if (or (= (length (car x)) 1)
  2819. (/= (string-to-char (car x)) c))
  2820. nil
  2821. (cons (substring (car x) 1) (cdr x))))
  2822. custom))))
  2823. ((eq c ?*)
  2824. (call-interactively 'org-toggle-sticky-agenda)
  2825. (sit-for 2))
  2826. ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
  2827. (message "Restriction is only possible in Org buffers")
  2828. (ding) (sit-for 1))
  2829. ((eq c ?1)
  2830. (org-agenda-remove-restriction-lock 'noupdate)
  2831. (setq restriction 'buffer))
  2832. ((eq c ?0)
  2833. (org-agenda-remove-restriction-lock 'noupdate)
  2834. (setq restriction (if region-p 'region 'subtree)))
  2835. ((eq c ?<)
  2836. (org-agenda-remove-restriction-lock 'noupdate)
  2837. (setq restriction
  2838. (cond
  2839. ((eq restriction 'buffer)
  2840. (if region-p 'region 'subtree))
  2841. ((memq restriction '(subtree region))
  2842. nil)
  2843. (t 'buffer))))
  2844. ((eq c ?>)
  2845. (org-agenda-remove-restriction-lock 'noupdate)
  2846. (setq restriction nil))
  2847. ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
  2848. (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
  2849. ((and (> (length selstring) 0) (eq c ?\d))
  2850. (delete-window)
  2851. (org-agenda-get-restriction-and-command prefix-descriptions))
  2852. ((equal c ?q) (error "Abort"))
  2853. (t (user-error "Invalid key %c" c))))))))
  2854. (defun org-agenda-fit-window-to-buffer ()
  2855. "Fit the window to the buffer size."
  2856. (and (memq org-agenda-window-setup '(reorganize-frame))
  2857. (fboundp 'fit-window-to-buffer)
  2858. (if (and (= (cdr org-agenda-window-frame-fractions) 1.0)
  2859. (= (car org-agenda-window-frame-fractions) 1.0))
  2860. (delete-other-windows)
  2861. (org-fit-window-to-buffer
  2862. nil
  2863. (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
  2864. (floor (* (frame-height) (car org-agenda-window-frame-fractions)))))))
  2865. (defvar org-cmd nil)
  2866. (defvar org-agenda-overriding-cmd nil)
  2867. (defvar org-agenda-overriding-arguments nil)
  2868. (defvar org-agenda-overriding-cmd-arguments nil)
  2869. (defun org-agenda-run-series (name series)
  2870. "Run agenda NAME as a SERIES of agenda commands."
  2871. (org-let (nth 1 series) '(org-agenda-prepare name))
  2872. ;; We need to reset agenda markers here, because when constructing a
  2873. ;; block agenda, the individual blocks do not do that.
  2874. (org-agenda-reset-markers)
  2875. (let* ((org-agenda-multi t)
  2876. (redo (list 'org-agenda-run-series name (list 'quote series)))
  2877. (cmds (car series))
  2878. (gprops (nth 1 series))
  2879. match ;; The byte compiler incorrectly complains about this. Keep it!
  2880. org-cmd type lprops)
  2881. (while (setq org-cmd (pop cmds))
  2882. (setq type (car org-cmd))
  2883. (setq match (eval (nth 1 org-cmd)))
  2884. (setq lprops (nth 2 org-cmd))
  2885. (let ((org-agenda-overriding-arguments
  2886. (if (eq org-agenda-overriding-cmd org-cmd)
  2887. (or org-agenda-overriding-arguments
  2888. org-agenda-overriding-cmd-arguments))))
  2889. (cond
  2890. ((eq type 'agenda)
  2891. (org-let2 gprops lprops
  2892. '(call-interactively 'org-agenda-list)))
  2893. ((eq type 'agenda*)
  2894. (org-let2 gprops lprops
  2895. '(funcall 'org-agenda-list nil nil t)))
  2896. ((eq type 'alltodo)
  2897. (org-let2 gprops lprops
  2898. '(call-interactively 'org-todo-list)))
  2899. ((eq type 'search)
  2900. (org-let2 gprops lprops
  2901. '(org-search-view current-prefix-arg match nil)))
  2902. ((eq type 'stuck)
  2903. (org-let2 gprops lprops
  2904. '(call-interactively 'org-agenda-list-stuck-projects)))
  2905. ((eq type 'tags)
  2906. (org-let2 gprops lprops
  2907. '(org-tags-view current-prefix-arg match)))
  2908. ((eq type 'tags-todo)
  2909. (org-let2 gprops lprops
  2910. '(org-tags-view '(4) match)))
  2911. ((eq type 'todo)
  2912. (org-let2 gprops lprops
  2913. '(org-todo-list match)))
  2914. ((fboundp type)
  2915. (org-let2 gprops lprops
  2916. '(funcall type match)))
  2917. (t (error "Invalid type in command series")))))
  2918. (widen)
  2919. (let ((inhibit-read-only t))
  2920. (add-text-properties (point-min) (point-max)
  2921. `(org-series t org-series-redo-cmd ,redo)))
  2922. (setq org-agenda-redo-command redo)
  2923. (goto-char (point-min)))
  2924. (org-agenda-fit-window-to-buffer)
  2925. (org-let (nth 1 series) '(org-agenda-finalize)))
  2926. ;;;###autoload
  2927. (defmacro org-batch-agenda (cmd-key &rest parameters)
  2928. "Run an agenda command in batch mode and send the result to STDOUT.
  2929. If CMD-KEY is a string of length 1, it is used as a key in
  2930. `org-agenda-custom-commands' and triggers this command. If it is a
  2931. longer string it is used as a tags/todo match string.
  2932. Parameters are alternating variable names and values that will be bound
  2933. before running the agenda command."
  2934. (org-eval-in-environment (org-make-parameter-alist parameters)
  2935. (let (org-agenda-sticky)
  2936. (if (> (length cmd-key) 1)
  2937. (org-tags-view nil cmd-key)
  2938. (org-agenda nil cmd-key))))
  2939. (set-buffer org-agenda-buffer-name)
  2940. (princ (buffer-string)))
  2941. (defvar org-agenda-info nil)
  2942. ;;;###autoload
  2943. (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
  2944. "Run an agenda command in batch mode and send the result to STDOUT.
  2945. If CMD-KEY is a string of length 1, it is used as a key in
  2946. `org-agenda-custom-commands' and triggers this command. If it is a
  2947. longer string it is used as a tags/todo match string.
  2948. Parameters are alternating variable names and values that will be bound
  2949. before running the agenda command.
  2950. The output gives a line for each selected agenda item. Each
  2951. item is a list of comma-separated values, like this:
  2952. category,head,type,todo,tags,date,time,extra,priority-l,priority-n
  2953. category The category of the item
  2954. head The headline, without TODO kwd, TAGS and PRIORITY
  2955. type The type of the agenda entry, can be
  2956. todo selected in TODO match
  2957. tagsmatch selected in tags match
  2958. diary imported from diary
  2959. deadline a deadline on given date
  2960. scheduled scheduled on given date
  2961. timestamp entry has timestamp on given date
  2962. closed entry was closed on given date
  2963. upcoming-deadline warning about deadline
  2964. past-scheduled forwarded scheduled item
  2965. block entry has date block including g. date
  2966. todo The todo keyword, if any
  2967. tags All tags including inherited ones, separated by colons
  2968. date The relevant date, like 2007-2-14
  2969. time The time, like 15:00-16:50
  2970. extra Sting with extra planning info
  2971. priority-l The priority letter if any was given
  2972. priority-n The computed numerical priority
  2973. agenda-day The day in the agenda where this is listed"
  2974. (org-eval-in-environment (append '((org-agenda-remove-tags t))
  2975. (org-make-parameter-alist parameters))
  2976. (if (> (length cmd-key) 2)
  2977. (org-tags-view nil cmd-key)
  2978. (org-agenda nil cmd-key)))
  2979. (set-buffer org-agenda-buffer-name)
  2980. (let ((lines (org-split-string (buffer-string) "\n")))
  2981. (dolist (line lines)
  2982. (when (get-text-property 0 'org-category line)
  2983. (setq org-agenda-info
  2984. (org-fix-agenda-info (text-properties-at 0 line)))
  2985. (princ
  2986. (mapconcat 'org-agenda-export-csv-mapper
  2987. '(org-category txt type todo tags date time extra
  2988. priority-letter priority agenda-day)
  2989. ","))
  2990. (princ "\n")))))
  2991. (defun org-fix-agenda-info (props)
  2992. "Make sure all properties on an agenda item have a canonical form.
  2993. This ensures the export commands can easily use it."
  2994. (let (tmp re)
  2995. (when (setq tmp (plist-get props 'tags))
  2996. (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
  2997. (when (setq tmp (plist-get props 'date))
  2998. (when (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2999. (let ((calendar-date-display-form '(year "-" month "-" day)))
  3000. '((format "%4d, %9s %2s, %4s" dayname monthname day year))
  3001. (setq tmp (calendar-date-string tmp)))
  3002. (setq props (plist-put props 'date tmp)))
  3003. (when (setq tmp (plist-get props 'day))
  3004. (when (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  3005. (let ((calendar-date-display-form '(year "-" month "-" day)))
  3006. (setq tmp (calendar-date-string tmp)))
  3007. (setq props (plist-put props 'day tmp))
  3008. (setq props (plist-put props 'agenda-day tmp)))
  3009. (when (setq tmp (plist-get props 'txt))
  3010. (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
  3011. (plist-put props 'priority-letter (match-string 1 tmp))
  3012. (setq tmp (replace-match "" t t tmp)))
  3013. (when (and (setq re (plist-get props 'org-todo-regexp))
  3014. (setq re (concat "\\`\\.*" re " ?"))
  3015. (let ((case-fold-search nil)) (string-match re tmp)))
  3016. (plist-put props 'todo (match-string 1 tmp))
  3017. (setq tmp (replace-match "" t t tmp)))
  3018. (plist-put props 'txt tmp)))
  3019. props)
  3020. (defun org-agenda-export-csv-mapper (prop)
  3021. (let ((res (plist-get org-agenda-info prop)))
  3022. (setq res
  3023. (cond
  3024. ((not res) "")
  3025. ((stringp res) res)
  3026. (t (prin1-to-string res))))
  3027. (org-trim (replace-regexp-in-string "," ";" res nil t))))
  3028. ;;;###autoload
  3029. (defun org-store-agenda-views (&rest parameters)
  3030. "Store agenda views."
  3031. (interactive)
  3032. (eval (list 'org-batch-store-agenda-views)))
  3033. ;;;###autoload
  3034. (defmacro org-batch-store-agenda-views (&rest parameters)
  3035. "Run all custom agenda commands that have a file argument."
  3036. (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
  3037. (pop-up-frames nil)
  3038. (dir default-directory)
  3039. (pars (org-make-parameter-alist parameters))
  3040. cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
  3041. (save-window-excursion
  3042. (while cmds
  3043. (setq cmd (pop cmds)
  3044. thiscmdkey (car cmd)
  3045. thiscmdcmd (cdr cmd)
  3046. match (nth 2 thiscmdcmd)
  3047. bufname (if org-agenda-sticky
  3048. (or (and (stringp match)
  3049. (format "*Org Agenda(%s:%s)*" thiscmdkey match))
  3050. (format "*Org Agenda(%s)*" thiscmdkey))
  3051. org-agenda-buffer-name)
  3052. cmd-or-set (nth 2 cmd)
  3053. opts (nth (if (listp cmd-or-set) 3 4) cmd)
  3054. files (nth (if (listp cmd-or-set) 4 5) cmd))
  3055. (if (stringp files) (setq files (list files)))
  3056. (when files
  3057. (org-eval-in-environment (append org-agenda-exporter-settings
  3058. opts pars)
  3059. (org-agenda nil thiscmdkey))
  3060. (set-buffer bufname)
  3061. (while files
  3062. (org-eval-in-environment (append org-agenda-exporter-settings
  3063. opts pars)
  3064. (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
  3065. (and (get-buffer bufname)
  3066. (kill-buffer bufname)))))))
  3067. (defvar org-agenda-current-span nil
  3068. "The current span used in the agenda view.") ; local variable in the agenda buffer
  3069. (defun org-agenda-mark-header-line (pos)
  3070. "Mark the line at POS as an agenda structure header."
  3071. (save-excursion
  3072. (goto-char pos)
  3073. (put-text-property (point-at-bol) (point-at-eol)
  3074. 'org-agenda-structural-header t)
  3075. (when org-agenda-title-append
  3076. (put-text-property (point-at-bol) (point-at-eol)
  3077. 'org-agenda-title-append org-agenda-title-append))))
  3078. (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
  3079. (defvar org-agenda-write-buffer-name "Agenda View")
  3080. (defun org-agenda-write (file &optional open nosettings agenda-bufname)
  3081. "Write the current buffer (an agenda view) as a file.
  3082. Depending on the extension of the file name, plain text (.txt),
  3083. HTML (.html or .htm), PDF (.pdf) or Postscript (.ps) is produced.
  3084. If the extension is .ics, translate visible agenda into iCalendar
  3085. format. If the extension is .org, collect all subtrees
  3086. corresponding to the agenda entries and add them in an .org file.
  3087. With prefix argument OPEN, open the new file immediately. If
  3088. NOSETTINGS is given, do not scope the settings of
  3089. `org-agenda-exporter-settings' into the export commands. This is
  3090. used when the settings have already been scoped and we do not
  3091. wish to overrule other, higher priority settings. If
  3092. AGENDA-BUFFER-NAME is provided, use this as the buffer name for
  3093. the agenda to write."
  3094. (interactive "FWrite agenda to file: \nP")
  3095. (if (or (not (file-writable-p file))
  3096. (and (file-exists-p file)
  3097. (if (called-interactively-p 'any)
  3098. (not (y-or-n-p (format "Overwrite existing file %s? " file))))))
  3099. (user-error "Cannot write agenda to file %s" file))
  3100. (org-let (if nosettings nil org-agenda-exporter-settings)
  3101. '(save-excursion
  3102. (save-window-excursion
  3103. (let ((bs (copy-sequence (buffer-string)))
  3104. (extension (file-name-extension file))
  3105. (default-directory (file-name-directory file))
  3106. beg content)
  3107. (with-temp-buffer
  3108. (rename-buffer org-agenda-write-buffer-name t)
  3109. (set-buffer-modified-p nil)
  3110. (insert bs)
  3111. (org-agenda-remove-marked-text 'invisible 'org-filtered)
  3112. (run-hooks 'org-agenda-before-write-hook)
  3113. (cond
  3114. ((bound-and-true-p org-mobile-creating-agendas)
  3115. (org-mobile-write-agenda-for-mobile file))
  3116. ((string= "org" extension)
  3117. (let (content p m message-log-max)
  3118. (goto-char (point-min))
  3119. (while (setq p (next-single-property-change (point) 'org-hd-marker nil))
  3120. (goto-char p)
  3121. (setq m (get-text-property (point) 'org-hd-marker))
  3122. (when m
  3123. (push (save-excursion
  3124. (set-buffer (marker-buffer m))
  3125. (goto-char m)
  3126. (org-copy-subtree 1 nil t t)
  3127. org-subtree-clip)
  3128. content)))
  3129. (find-file file)
  3130. (erase-buffer)
  3131. (dolist (s content) (org-paste-subtree 1 s))
  3132. (write-file file)
  3133. (kill-buffer (current-buffer))
  3134. (message "Org file written to %s" file)))
  3135. ((member extension '("html" "htm"))
  3136. (or (require 'htmlize nil t)
  3137. (error "Please install htmlize from https://github.com/hniksic/emacs-htmlize"))
  3138. (set-buffer (htmlize-buffer (current-buffer)))
  3139. (when org-agenda-export-html-style
  3140. ;; replace <style> section with org-agenda-export-html-style
  3141. (goto-char (point-min))
  3142. (kill-region (- (search-forward "<style") 6)
  3143. (search-forward "</style>"))
  3144. (insert org-agenda-export-html-style))
  3145. (write-file file)
  3146. (kill-buffer (current-buffer))
  3147. (message "HTML written to %s" file))
  3148. ((string= "ps" extension)
  3149. (require 'ps-print)
  3150. (ps-print-buffer-with-faces file)
  3151. (message "Postscript written to %s" file))
  3152. ((string= "pdf" extension)
  3153. (require 'ps-print)
  3154. (ps-print-buffer-with-faces
  3155. (concat (file-name-sans-extension file) ".ps"))
  3156. (call-process "ps2pdf" nil nil nil
  3157. (expand-file-name
  3158. (concat (file-name-sans-extension file) ".ps"))
  3159. (expand-file-name file))
  3160. (delete-file (concat (file-name-sans-extension file) ".ps"))
  3161. (message "PDF written to %s" file))
  3162. ((string= "ics" extension)
  3163. (require 'ox-icalendar)
  3164. (org-icalendar-export-current-agenda (expand-file-name file)))
  3165. (t
  3166. (let ((bs (buffer-string)))
  3167. (find-file file)
  3168. (erase-buffer)
  3169. (insert bs)
  3170. (save-buffer 0)
  3171. (kill-buffer (current-buffer))
  3172. (message "Plain text written to %s" file))))))))
  3173. (set-buffer (or agenda-bufname
  3174. (and (called-interactively-p 'any) (buffer-name))
  3175. org-agenda-buffer-name)))
  3176. (when open (org-open-file file)))
  3177. (defun org-agenda-remove-marked-text (property &optional value)
  3178. "Delete all text marked with VALUE of PROPERTY.
  3179. VALUE defaults to t."
  3180. (let (beg)
  3181. (setq value (or value t))
  3182. (while (setq beg (text-property-any (point-min) (point-max)
  3183. property value))
  3184. (delete-region
  3185. beg (or (next-single-property-change beg property)
  3186. (point-max))))))
  3187. (defun org-agenda-add-entry-text ()
  3188. "Add entry text to agenda lines.
  3189. This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
  3190. entry text following headings shown in the agenda.
  3191. Drawers will be excluded, also the line with scheduling/deadline info."
  3192. (when (and (> org-agenda-add-entry-text-maxlines 0)
  3193. (not (bound-and-true-p org-mobile-creating-agendas)))
  3194. (let (m txt)
  3195. (goto-char (point-min))
  3196. (while (not (eobp))
  3197. (if (not (setq m (org-get-at-bol 'org-hd-marker)))
  3198. (beginning-of-line 2)
  3199. (setq txt (org-agenda-get-some-entry-text
  3200. m org-agenda-add-entry-text-maxlines " > "))
  3201. (end-of-line 1)
  3202. (if (string-match "\\S-" txt)
  3203. (insert "\n" txt)
  3204. (or (eobp) (forward-char 1))))))))
  3205. (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
  3206. &rest keep)
  3207. "Extract entry text from MARKER, at most N-LINES lines.
  3208. This will ignore drawers etc, just get the text.
  3209. If INDENT is given, prefix every line with this string. If KEEP is
  3210. given, it is a list of symbols, defining stuff that should not be
  3211. removed from the entry content. Currently only `planning' is allowed here."
  3212. (let (txt drawer-re kwd-time-re ind)
  3213. (save-excursion
  3214. (with-current-buffer (marker-buffer marker)
  3215. (if (not (derived-mode-p 'org-mode))
  3216. (setq txt "")
  3217. (org-with-wide-buffer
  3218. (goto-char marker)
  3219. (end-of-line 1)
  3220. (setq txt (buffer-substring
  3221. (min (1+ (point)) (point-max))
  3222. (progn (outline-next-heading) (point)))
  3223. drawer-re org-drawer-regexp
  3224. kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
  3225. ".*\n?"))
  3226. (with-temp-buffer
  3227. (insert txt)
  3228. (when org-agenda-add-entry-text-descriptive-links
  3229. (goto-char (point-min))
  3230. (while (org-activate-links (point-max))
  3231. (add-text-properties (match-beginning 0) (match-end 0)
  3232. '(face org-link))))
  3233. (goto-char (point-min))
  3234. (while (re-search-forward org-link-bracket-re (point-max) t)
  3235. (set-text-properties (match-beginning 0) (match-end 0)
  3236. nil))
  3237. (goto-char (point-min))
  3238. (while (re-search-forward drawer-re nil t)
  3239. (delete-region
  3240. (match-beginning 0)
  3241. (progn (re-search-forward
  3242. "^[ \t]*:END:.*\n?" nil 'move)
  3243. (point))))
  3244. (unless (member 'planning keep)
  3245. (goto-char (point-min))
  3246. (while (re-search-forward kwd-time-re nil t)
  3247. (replace-match "")))
  3248. (goto-char (point-min))
  3249. (when org-agenda-entry-text-exclude-regexps
  3250. (let ((re-list org-agenda-entry-text-exclude-regexps) re)
  3251. (while (setq re (pop re-list))
  3252. (goto-char (point-min))
  3253. (while (re-search-forward re nil t)
  3254. (replace-match "")))))
  3255. (goto-char (point-max))
  3256. (skip-chars-backward " \t\n")
  3257. (when (looking-at "[ \t\n]+\\'") (replace-match ""))
  3258. ;; find and remove min common indentation
  3259. (goto-char (point-min))
  3260. (untabify (point-min) (point-max))
  3261. (setq ind (current-indentation))
  3262. (while (not (eobp))
  3263. (unless (looking-at "[ \t]*$")
  3264. (setq ind (min ind (current-indentation))))
  3265. (beginning-of-line 2))
  3266. (goto-char (point-min))
  3267. (while (not (eobp))
  3268. (unless (looking-at "[ \t]*$")
  3269. (move-to-column ind)
  3270. (delete-region (point-at-bol) (point)))
  3271. (beginning-of-line 2))
  3272. (run-hooks 'org-agenda-entry-text-cleanup-hook)
  3273. (goto-char (point-min))
  3274. (when indent
  3275. (while (and (not (eobp)) (re-search-forward "^" nil t))
  3276. (replace-match indent t t)))
  3277. (goto-char (point-min))
  3278. (while (looking-at "[ \t]*\n") (replace-match ""))
  3279. (goto-char (point-max))
  3280. (when (> (org-current-line)
  3281. n-lines)
  3282. (org-goto-line (1+ n-lines))
  3283. (backward-char 1))
  3284. (setq txt (buffer-substring (point-min) (point))))))))
  3285. txt))
  3286. (defun org-check-for-org-mode ()
  3287. "Make sure current buffer is in Org mode. Error if not."
  3288. (or (derived-mode-p 'org-mode)
  3289. (error "Cannot execute Org agenda command on buffer in %s"
  3290. major-mode)))
  3291. ;;; Agenda prepare and finalize
  3292. (defvar org-agenda-multi nil) ; dynamically scoped
  3293. (defvar org-agenda-pre-window-conf nil)
  3294. (defvar org-agenda-columns-active nil)
  3295. (defvar org-agenda-name nil)
  3296. (defvar org-agenda-tag-filter nil)
  3297. (defvar org-agenda-category-filter nil)
  3298. (defvar org-agenda-regexp-filter nil)
  3299. (defvar org-agenda-effort-filter nil)
  3300. (defvar org-agenda-top-headline-filter nil)
  3301. (defvar org-agenda-tag-filter-preset nil
  3302. "A preset of the tags filter used for secondary agenda filtering.
  3303. This must be a list of strings, each string must be a single tag preceded
  3304. by \"+\" or \"-\".
  3305. This variable should not be set directly, but agenda custom commands can
  3306. bind it in the options section. The preset filter is a global property of
  3307. the entire agenda view. In a block agenda, it will not work reliably to
  3308. define a filter for one of the individual blocks. You need to set it in
  3309. the global options and expect it to be applied to the entire view.")
  3310. (defvar org-agenda-category-filter-preset nil
  3311. "A preset of the category filter used for secondary agenda filtering.
  3312. This must be a list of strings, each string must be a single category
  3313. preceded by \"+\" or \"-\".
  3314. This variable should not be set directly, but agenda custom commands can
  3315. bind it in the options section. The preset filter is a global property of
  3316. the entire agenda view. In a block agenda, it will not work reliably to
  3317. define a filter for one of the individual blocks. You need to set it in
  3318. the global options and expect it to be applied to the entire view.")
  3319. (defvar org-agenda-regexp-filter-preset nil
  3320. "A preset of the regexp filter used for secondary agenda filtering.
  3321. This must be a list of strings, each string must be a single regexp
  3322. preceded by \"+\" or \"-\".
  3323. This variable should not be set directly, but agenda custom commands can
  3324. bind it in the options section. The preset filter is a global property of
  3325. the entire agenda view. In a block agenda, it will not work reliably to
  3326. define a filter for one of the individual blocks. You need to set it in
  3327. the global options and expect it to be applied to the entire view.")
  3328. (defvar org-agenda-effort-filter-preset nil
  3329. "A preset of the effort condition used for secondary agenda filtering.
  3330. This must be a list of strings, each string must be a single regexp
  3331. preceded by \"+\" or \"-\".
  3332. This variable should not be set directly, but agenda custom commands can
  3333. bind it in the options section. The preset filter is a global property of
  3334. the entire agenda view. In a block agenda, it will not work reliably to
  3335. define a filter for one of the individual blocks. You need to set it in
  3336. the global options and expect it to be applied to the entire view.")
  3337. (defun org-agenda-use-sticky-p ()
  3338. "Return non-nil if an agenda buffer named
  3339. `org-agenda-buffer-name' exists and should be shown instead of
  3340. generating a new one."
  3341. (and
  3342. ;; turned off by user
  3343. org-agenda-sticky
  3344. ;; For multi-agenda buffer already exists
  3345. (not org-agenda-multi)
  3346. ;; buffer found
  3347. (get-buffer org-agenda-buffer-name)
  3348. ;; C-u parameter is same as last call
  3349. (with-current-buffer (get-buffer org-agenda-buffer-name)
  3350. (and
  3351. (equal current-prefix-arg
  3352. org-agenda-last-prefix-arg)
  3353. ;; In case user turned stickiness on, while having existing
  3354. ;; Agenda buffer active, don't reuse that buffer, because it
  3355. ;; does not have org variables local
  3356. org-agenda-this-buffer-is-sticky))))
  3357. (defun org-agenda-prepare-window (abuf filter-alist)
  3358. "Setup agenda buffer in the window.
  3359. ABUF is the buffer for the agenda window.
  3360. FILTER-ALIST is an alist of filters we need to apply when
  3361. `org-agenda-persistent-filter' is non-nil."
  3362. (let* ((awin (get-buffer-window abuf)) wconf)
  3363. (cond
  3364. ((equal (current-buffer) abuf) nil)
  3365. (awin (select-window awin))
  3366. ((not (setq wconf (current-window-configuration))))
  3367. ((eq org-agenda-window-setup 'current-window)
  3368. (pop-to-buffer-same-window abuf))
  3369. ((eq org-agenda-window-setup 'other-window)
  3370. (org-switch-to-buffer-other-window abuf))
  3371. ((eq org-agenda-window-setup 'other-frame)
  3372. (switch-to-buffer-other-frame abuf))
  3373. ((eq org-agenda-window-setup 'only-window)
  3374. (delete-other-windows)
  3375. (pop-to-buffer-same-window abuf))
  3376. ((eq org-agenda-window-setup 'reorganize-frame)
  3377. (delete-other-windows)
  3378. (org-switch-to-buffer-other-window abuf)))
  3379. (setq org-agenda-tag-filter (cdr (assq 'tag filter-alist)))
  3380. (setq org-agenda-category-filter (cdr (assq 'cat filter-alist)))
  3381. (setq org-agenda-effort-filter (cdr (assq 'effort filter-alist)))
  3382. (setq org-agenda-regexp-filter (cdr (assq 're filter-alist)))
  3383. ;; Additional test in case agenda is invoked from within agenda
  3384. ;; buffer via elisp link.
  3385. (unless (equal (current-buffer) abuf)
  3386. (pop-to-buffer-same-window abuf))
  3387. (setq org-agenda-pre-window-conf
  3388. (or wconf org-agenda-pre-window-conf))))
  3389. (defun org-agenda-prepare (&optional name)
  3390. (let ((filter-alist (when org-agenda-persistent-filter
  3391. (with-current-buffer
  3392. (get-buffer-create org-agenda-buffer-name)
  3393. `((tag . ,org-agenda-tag-filter)
  3394. (re . ,org-agenda-regexp-filter)
  3395. (effort . ,org-agenda-effort-filter)
  3396. (cat . ,org-agenda-category-filter))))))
  3397. (if (org-agenda-use-sticky-p)
  3398. (progn
  3399. (put 'org-agenda-tag-filter :preset-filter nil)
  3400. (put 'org-agenda-category-filter :preset-filter nil)
  3401. (put 'org-agenda-regexp-filter :preset-filter nil)
  3402. ;; Popup existing buffer
  3403. (org-agenda-prepare-window (get-buffer org-agenda-buffer-name)
  3404. filter-alist)
  3405. (message "Sticky Agenda buffer, use `r' to refresh")
  3406. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3407. (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
  3408. (setq org-todo-keywords-for-agenda nil)
  3409. (put 'org-agenda-tag-filter :preset-filter
  3410. org-agenda-tag-filter-preset)
  3411. (put 'org-agenda-category-filter :preset-filter
  3412. org-agenda-category-filter-preset)
  3413. (put 'org-agenda-regexp-filter :preset-filter
  3414. org-agenda-regexp-filter-preset)
  3415. (put 'org-agenda-effort-filter :preset-filter
  3416. org-agenda-effort-filter-preset)
  3417. (if org-agenda-multi
  3418. (progn
  3419. (setq buffer-read-only nil)
  3420. (goto-char (point-max))
  3421. (unless (or (bobp) org-agenda-compact-blocks
  3422. (not org-agenda-block-separator))
  3423. (insert "\n"
  3424. (if (stringp org-agenda-block-separator)
  3425. org-agenda-block-separator
  3426. (make-string (window-width) org-agenda-block-separator))
  3427. "\n"))
  3428. (narrow-to-region (point) (point-max)))
  3429. (setq org-done-keywords-for-agenda nil)
  3430. ;; Setting any org variables that are in org-agenda-local-vars
  3431. ;; list need to be done after the prepare call
  3432. (org-agenda-prepare-window
  3433. (get-buffer-create org-agenda-buffer-name) filter-alist)
  3434. (setq buffer-read-only nil)
  3435. (org-agenda-reset-markers)
  3436. (let ((inhibit-read-only t)) (erase-buffer))
  3437. (org-agenda-mode)
  3438. (setq org-agenda-buffer (current-buffer))
  3439. (setq org-agenda-contributing-files nil)
  3440. (setq org-agenda-columns-active nil)
  3441. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  3442. (setq org-todo-keywords-for-agenda
  3443. (org-uniquify org-todo-keywords-for-agenda))
  3444. (setq org-done-keywords-for-agenda
  3445. (org-uniquify org-done-keywords-for-agenda))
  3446. (setq org-agenda-last-prefix-arg current-prefix-arg)
  3447. (setq org-agenda-this-buffer-name org-agenda-buffer-name)
  3448. (and name (not org-agenda-name)
  3449. (setq-local org-agenda-name name)))
  3450. (setq buffer-read-only nil))))
  3451. (defvar org-overriding-columns-format)
  3452. (defvar org-local-columns-format)
  3453. (defun org-agenda-finalize ()
  3454. "Finishing touch for the agenda buffer, called just before displaying it."
  3455. (unless org-agenda-multi
  3456. (save-excursion
  3457. (let ((inhibit-read-only t))
  3458. (goto-char (point-min))
  3459. (save-excursion
  3460. (while (org-activate-links (point-max))
  3461. (add-text-properties (match-beginning 0) (match-end 0)
  3462. '(face org-link))))
  3463. (unless (eq org-agenda-remove-tags t)
  3464. (org-agenda-align-tags))
  3465. (unless org-agenda-with-colors
  3466. (remove-text-properties (point-min) (point-max) '(face nil)))
  3467. (when (bound-and-true-p org-overriding-columns-format)
  3468. (setq-local org-local-columns-format
  3469. org-overriding-columns-format))
  3470. (when org-agenda-view-columns-initially
  3471. (org-agenda-columns))
  3472. (when org-agenda-fontify-priorities
  3473. (org-agenda-fontify-priorities))
  3474. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  3475. (org-agenda-dim-blocked-tasks))
  3476. (org-agenda-mark-clocking-task)
  3477. (when org-agenda-entry-text-mode
  3478. (org-agenda-entry-text-hide)
  3479. (org-agenda-entry-text-show))
  3480. (when (and (featurep 'org-habit)
  3481. (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
  3482. (org-habit-insert-consistency-graphs))
  3483. (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
  3484. (unless (or (eq org-agenda-show-inherited-tags 'always)
  3485. (and (listp org-agenda-show-inherited-tags)
  3486. (memq org-agenda-type org-agenda-show-inherited-tags))
  3487. (and (eq org-agenda-show-inherited-tags t)
  3488. (or (eq org-agenda-use-tag-inheritance t)
  3489. (and (listp org-agenda-use-tag-inheritance)
  3490. (not (memq org-agenda-type
  3491. org-agenda-use-tag-inheritance))))))
  3492. (let (mrk)
  3493. (save-excursion
  3494. (goto-char (point-min))
  3495. (while (equal (forward-line) 0)
  3496. (when (setq mrk (get-text-property (point) 'org-hd-marker))
  3497. (put-text-property (point-at-bol) (point-at-eol)
  3498. 'tags
  3499. (org-with-point-at mrk
  3500. (mapcar #'downcase (org-get-tags)))))))))
  3501. (run-hooks 'org-agenda-finalize-hook)
  3502. (when org-agenda-top-headline-filter
  3503. (org-agenda-filter-top-headline-apply
  3504. org-agenda-top-headline-filter))
  3505. (when org-agenda-tag-filter
  3506. (org-agenda-filter-apply org-agenda-tag-filter 'tag t))
  3507. (when (get 'org-agenda-tag-filter :preset-filter)
  3508. (org-agenda-filter-apply
  3509. (get 'org-agenda-tag-filter :preset-filter) 'tag t))
  3510. (when org-agenda-category-filter
  3511. (org-agenda-filter-apply org-agenda-category-filter 'category))
  3512. (when (get 'org-agenda-category-filter :preset-filter)
  3513. (org-agenda-filter-apply
  3514. (get 'org-agenda-category-filter :preset-filter) 'category))
  3515. (when org-agenda-regexp-filter
  3516. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
  3517. (when (get 'org-agenda-regexp-filter :preset-filter)
  3518. (org-agenda-filter-apply
  3519. (get 'org-agenda-regexp-filter :preset-filter) 'regexp))
  3520. (when org-agenda-effort-filter
  3521. (org-agenda-filter-apply org-agenda-effort-filter 'effort))
  3522. (when (get 'org-agenda-effort-filter :preset-filter)
  3523. (org-agenda-filter-apply
  3524. (get 'org-agenda-effort-filter :preset-filter) 'effort))
  3525. (add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)))))
  3526. (defun org-agenda-mark-clocking-task ()
  3527. "Mark the current clock entry in the agenda if it is present."
  3528. ;; We need to widen when `org-agenda-finalize' is called from
  3529. ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in')
  3530. (when (bound-and-true-p org-clock-current-task)
  3531. (save-restriction
  3532. (widen)
  3533. (org-agenda-unmark-clocking-task)
  3534. (when (marker-buffer org-clock-hd-marker)
  3535. (save-excursion
  3536. (goto-char (point-min))
  3537. (let (s ov)
  3538. (while (setq s (next-single-property-change (point) 'org-hd-marker))
  3539. (goto-char s)
  3540. (when (equal (org-get-at-bol 'org-hd-marker)
  3541. org-clock-hd-marker)
  3542. (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
  3543. (overlay-put ov 'type 'org-agenda-clocking)
  3544. (overlay-put ov 'face 'org-agenda-clocking)
  3545. (overlay-put ov 'help-echo
  3546. "The clock is running in this item")))))))))
  3547. (defun org-agenda-unmark-clocking-task ()
  3548. "Unmark the current clocking task."
  3549. (mapc (lambda (o)
  3550. (when (eq (overlay-get o 'type) 'org-agenda-clocking)
  3551. (delete-overlay o)))
  3552. (overlays-in (point-min) (point-max))))
  3553. (defun org-agenda-fontify-priorities ()
  3554. "Make highest priority lines bold, and lowest italic."
  3555. (interactive)
  3556. (mapc (lambda (o) (when (eq (overlay-get o 'org-type) 'org-priority)
  3557. (delete-overlay o)))
  3558. (overlays-in (point-min) (point-max)))
  3559. (save-excursion
  3560. (let (b e p ov h l)
  3561. (goto-char (point-min))
  3562. (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
  3563. (setq h (or (get-char-property (point) 'org-highest-priority)
  3564. org-highest-priority)
  3565. l (or (get-char-property (point) 'org-lowest-priority)
  3566. org-lowest-priority)
  3567. p (string-to-char (match-string 1))
  3568. b (match-beginning 0)
  3569. e (if (eq org-agenda-fontify-priorities 'cookies)
  3570. (match-end 0)
  3571. (point-at-eol))
  3572. ov (make-overlay b e))
  3573. (overlay-put
  3574. ov 'face
  3575. (let ((special-face
  3576. (cond ((org-face-from-face-or-color
  3577. 'priority 'org-priority
  3578. (cdr (assoc p org-priority-faces))))
  3579. ((and (listp org-agenda-fontify-priorities)
  3580. (org-face-from-face-or-color
  3581. 'priority 'org-priority
  3582. (cdr (assoc p org-agenda-fontify-priorities)))))
  3583. ((equal p l) 'italic)
  3584. ((equal p h) 'bold))))
  3585. (if special-face (list special-face 'org-priority) 'org-priority)))
  3586. (overlay-put ov 'org-type 'org-priority)))))
  3587. (defvar org-depend-tag-blocked)
  3588. (defun org-agenda-dim-blocked-tasks (&optional invisible)
  3589. "Dim currently blocked TODOs in the agenda display.
  3590. When INVISIBLE is non-nil, hide currently blocked TODO instead of
  3591. dimming them."
  3592. (interactive "P")
  3593. (when (called-interactively-p 'interactive)
  3594. (message "Dim or hide blocked tasks..."))
  3595. (dolist (o (overlays-in (point-min) (point-max)))
  3596. (when (eq (overlay-get o 'org-type) 'org-blocked-todo)
  3597. (delete-overlay o)))
  3598. (save-excursion
  3599. (let ((inhibit-read-only t))
  3600. (goto-char (point-min))
  3601. (while (let ((pos (text-property-not-all
  3602. (point) (point-max) 'org-todo-blocked nil)))
  3603. (when pos (goto-char pos)))
  3604. (let* ((invisible (eq (org-get-at-bol 'org-todo-blocked) 'invisible))
  3605. (ov (make-overlay (if invisible
  3606. (line-end-position 0)
  3607. (line-beginning-position))
  3608. (line-end-position))))
  3609. (if invisible
  3610. (overlay-put ov 'invisible t)
  3611. (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
  3612. (overlay-put ov 'org-type 'org-blocked-todo))
  3613. (forward-line))))
  3614. (when (called-interactively-p 'interactive)
  3615. (message "Dim or hide blocked tasks...done")))
  3616. (defun org-agenda--mark-blocked-entry (entry)
  3617. "For ENTRY a string with the text property `org-hd-marker', if
  3618. the header at `org-hd-marker' is blocked according to
  3619. `org-entry-blocked-p', then if `org-agenda-dim-blocked-tasks' is
  3620. 'invisible and the header is not blocked by checkboxes, set the
  3621. text property `org-todo-blocked' to 'invisible, otherwise set it
  3622. to t."
  3623. (when (get-text-property 0 'todo-state entry)
  3624. (let ((entry-marker (get-text-property 0 'org-hd-marker entry))
  3625. (org-blocked-by-checkboxes nil)
  3626. ;; Necessary so that `org-entry-blocked-p' does not change
  3627. ;; the buffer.
  3628. (org-depend-tag-blocked nil))
  3629. (when entry-marker
  3630. (let ((blocked
  3631. (with-current-buffer (marker-buffer entry-marker)
  3632. (save-excursion
  3633. (goto-char entry-marker)
  3634. (org-entry-blocked-p)))))
  3635. (when blocked
  3636. (let ((really-invisible
  3637. (and (not org-blocked-by-checkboxes)
  3638. (eq org-agenda-dim-blocked-tasks 'invisible))))
  3639. (put-text-property
  3640. 0 (length entry) 'org-todo-blocked
  3641. (if really-invisible 'invisible t)
  3642. entry)))))))
  3643. entry)
  3644. (defvar org-agenda-skip-function nil
  3645. "Function to be called at each match during agenda construction.
  3646. If this function returns nil, the current match should not be skipped.
  3647. Otherwise, the function must return a position from where the search
  3648. should be continued.
  3649. This may also be a Lisp form, it will be evaluated.
  3650. Never set this variable using `setq' or so, because then it will apply
  3651. to all future agenda commands. If you do want a global skipping condition,
  3652. use the option `org-agenda-skip-function-global' instead.
  3653. The correct usage for `org-agenda-skip-function' is to bind it with
  3654. `let' to scope it dynamically into the agenda-constructing command.
  3655. A good way to set it is through options in `org-agenda-custom-commands'.")
  3656. (defun org-agenda-skip ()
  3657. "Throw to `:skip' in places that should be skipped.
  3658. Also moves point to the end of the skipped region, so that search can
  3659. continue from there."
  3660. (let ((p (point-at-bol)) to)
  3661. (when (or
  3662. (save-excursion (goto-char p) (looking-at comment-start-skip))
  3663. (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
  3664. (get-text-property p :org-archived)
  3665. (org-end-of-subtree t))
  3666. (and org-agenda-skip-comment-trees
  3667. (get-text-property p :org-comment)
  3668. (org-end-of-subtree t))
  3669. (and (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
  3670. (org-agenda-skip-eval org-agenda-skip-function)))
  3671. (goto-char to))
  3672. (org-in-src-block-p t))
  3673. (throw :skip t))))
  3674. (defun org-agenda-skip-eval (form)
  3675. "If FORM is a function or a list, call (or eval) it and return the result.
  3676. `save-excursion' and `save-match-data' are wrapped around the call, so point
  3677. and match data are returned to the previous state no matter what these
  3678. functions do."
  3679. (let (fp)
  3680. (and form
  3681. (or (setq fp (functionp form))
  3682. (consp form))
  3683. (save-excursion
  3684. (save-match-data
  3685. (if fp
  3686. (funcall form)
  3687. (eval form)))))))
  3688. (defvar org-agenda-markers nil
  3689. "List of all currently active markers created by `org-agenda'.")
  3690. (defvar org-agenda-last-marker-time (float-time)
  3691. "Creation time of the last agenda marker.")
  3692. (defun org-agenda-new-marker (&optional pos)
  3693. "Return a new agenda marker.
  3694. Maker is at point, or at POS if non-nil. Org mode keeps a list of
  3695. these markers and resets them when they are no longer in use."
  3696. (let ((m (copy-marker (or pos (point)) t)))
  3697. (setq org-agenda-last-marker-time (float-time))
  3698. (if org-agenda-buffer
  3699. (with-current-buffer org-agenda-buffer
  3700. (push m org-agenda-markers))
  3701. (push m org-agenda-markers))
  3702. m))
  3703. (defun org-agenda-reset-markers ()
  3704. "Reset markers created by `org-agenda'."
  3705. (while org-agenda-markers
  3706. (move-marker (pop org-agenda-markers) nil)))
  3707. (defun org-agenda-save-markers-for-cut-and-paste (beg end)
  3708. "Save relative positions of markers in region.
  3709. This check for agenda markers in all agenda buffers currently active."
  3710. (dolist (buf (buffer-list))
  3711. (with-current-buffer buf
  3712. (when (eq major-mode 'org-agenda-mode)
  3713. (mapc (lambda (m) (org-check-and-save-marker m beg end))
  3714. org-agenda-markers)))))
  3715. ;;; Entry text mode
  3716. (defun org-agenda-entry-text-show-here ()
  3717. "Add some text from the entry as context to the current line."
  3718. (let (m txt o)
  3719. (setq m (org-get-at-bol 'org-hd-marker))
  3720. (unless (marker-buffer m)
  3721. (error "No marker points to an entry here"))
  3722. (setq txt (concat "\n" (org-no-properties
  3723. (org-agenda-get-some-entry-text
  3724. m org-agenda-entry-text-maxlines
  3725. org-agenda-entry-text-leaders))))
  3726. (when (string-match "\\S-" txt)
  3727. (setq o (make-overlay (point-at-bol) (point-at-eol)))
  3728. (overlay-put o 'evaporate t)
  3729. (overlay-put o 'org-overlay-type 'agenda-entry-content)
  3730. (overlay-put o 'after-string txt))))
  3731. (defun org-agenda-entry-text-show ()
  3732. "Add entry context for all agenda lines."
  3733. (interactive)
  3734. (save-excursion
  3735. (goto-char (point-max))
  3736. (beginning-of-line 1)
  3737. (while (not (bobp))
  3738. (when (org-get-at-bol 'org-hd-marker)
  3739. (org-agenda-entry-text-show-here))
  3740. (beginning-of-line 0))))
  3741. (defun org-agenda-entry-text-hide ()
  3742. "Remove any shown entry context."
  3743. (mapc (lambda (o)
  3744. (when (eq (overlay-get o 'org-overlay-type)
  3745. 'agenda-entry-content)
  3746. (delete-overlay o)))
  3747. (overlays-in (point-min) (point-max))))
  3748. (defun org-agenda-get-day-face (date)
  3749. "Return the face DATE should be displayed with."
  3750. (cond ((and (functionp org-agenda-day-face-function)
  3751. (funcall org-agenda-day-face-function date)))
  3752. ((org-agenda-today-p date) 'org-agenda-date-today)
  3753. ((memq (calendar-day-of-week date) org-agenda-weekend-days)
  3754. 'org-agenda-date-weekend)
  3755. (t 'org-agenda-date)))
  3756. (defvar org-agenda-show-log-scoped)
  3757. ;;; Agenda Daily/Weekly
  3758. (defvar org-agenda-start-day nil ; dynamically scoped parameter
  3759. "Start day for the agenda view.
  3760. Custom commands can set this variable in the options section.
  3761. This is usually a string like \"2007-11-01\", \"+2d\" or any other
  3762. input allowed when reading a date through the Org calendar.
  3763. See the docstring of `org-read-date' for details.")
  3764. (defvar org-starting-day nil) ; local variable in the agenda buffer
  3765. (defvar org-arg-loc nil) ; local variable
  3766. (defvar org-agenda-buffer-tmp-name nil)
  3767. ;;;###autoload
  3768. (defun org-agenda-list (&optional arg start-day span with-hour)
  3769. "Produce a daily/weekly view from all files in variable `org-agenda-files'.
  3770. The view will be for the current day or week, but from the overview buffer
  3771. you will be able to go to other days/weeks.
  3772. With a numeric prefix argument in an interactive call, the agenda will
  3773. span ARG days. Lisp programs should instead specify SPAN to change
  3774. the number of days. SPAN defaults to `org-agenda-span'.
  3775. START-DAY defaults to TODAY, or to the most recent match for the weekday
  3776. given in `org-agenda-start-on-weekday'.
  3777. When WITH-HOUR is non-nil, only include scheduled and deadline
  3778. items if they have an hour specification like [h]h:mm."
  3779. (interactive "P")
  3780. (when org-agenda-overriding-arguments
  3781. (setq arg (car org-agenda-overriding-arguments)
  3782. start-day (nth 1 org-agenda-overriding-arguments)
  3783. span (nth 2 org-agenda-overriding-arguments)))
  3784. (when (and (integerp arg) (> arg 0))
  3785. (setq span arg arg nil))
  3786. (when (numberp span)
  3787. (unless (< 0 span)
  3788. (user-error "Agenda creation impossible for this span(=%d days)." span)))
  3789. (catch 'exit
  3790. (setq org-agenda-buffer-name
  3791. (or org-agenda-buffer-tmp-name
  3792. (and org-agenda-doing-sticky-redo org-agenda-buffer-name)
  3793. (when org-agenda-sticky
  3794. (cond ((and org-keys (stringp org-match))
  3795. (format "*Org Agenda(%s:%s)*" org-keys org-match))
  3796. (org-keys
  3797. (format "*Org Agenda(%s)*" org-keys))
  3798. (t "*Org Agenda(a)*")))
  3799. "*Org Agenda*"))
  3800. (org-agenda-prepare "Day/Week")
  3801. (setq start-day (or start-day org-agenda-start-day))
  3802. (when (stringp start-day)
  3803. ;; Convert to an absolute day number
  3804. (setq start-day (time-to-days (org-read-date nil t start-day))))
  3805. (org-compile-prefix-format 'agenda)
  3806. (org-set-sorting-strategy 'agenda)
  3807. (let* ((span (org-agenda-ndays-to-span (or span org-agenda-span)))
  3808. (today (org-today))
  3809. (sd (or start-day today))
  3810. (ndays (org-agenda-span-to-ndays span sd))
  3811. (org-agenda-start-on-weekday
  3812. (and (or (eq ndays 7) (eq ndays 14))
  3813. org-agenda-start-on-weekday))
  3814. (thefiles (org-agenda-files nil 'ifmode))
  3815. (files thefiles)
  3816. (start (if (or (null org-agenda-start-on-weekday)
  3817. (< ndays 7))
  3818. sd
  3819. (let* ((nt (calendar-day-of-week
  3820. (calendar-gregorian-from-absolute sd)))
  3821. (n1 org-agenda-start-on-weekday)
  3822. (d (- nt n1)))
  3823. (- sd (+ (if (< d 0) 7 0) d)))))
  3824. (day-numbers (list start))
  3825. (day-cnt 0)
  3826. (inhibit-redisplay (not debug-on-error))
  3827. (org-agenda-show-log-scoped org-agenda-show-log)
  3828. s e rtn rtnall file date d start-pos end-pos todayp
  3829. clocktable-start clocktable-end filter)
  3830. (setq org-agenda-redo-command
  3831. (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span) with-hour))
  3832. (dotimes (n (1- ndays))
  3833. (push (1+ (car day-numbers)) day-numbers))
  3834. (setq day-numbers (nreverse day-numbers))
  3835. (setq clocktable-start (car day-numbers)
  3836. clocktable-end (1+ (or (org-last day-numbers) 0)))
  3837. (setq-local org-starting-day (car day-numbers))
  3838. (setq-local org-arg-loc arg)
  3839. (setq-local org-agenda-current-span (org-agenda-ndays-to-span span))
  3840. (unless org-agenda-compact-blocks
  3841. (let* ((d1 (car day-numbers))
  3842. (d2 (org-last day-numbers))
  3843. (w1 (org-days-to-iso-week d1))
  3844. (w2 (org-days-to-iso-week d2)))
  3845. (setq s (point))
  3846. (org-agenda--insert-overriding-header
  3847. (concat (org-agenda-span-name span)
  3848. "-agenda"
  3849. (cond ((<= 350 (- d2 d1)) "")
  3850. ((= w1 w2) (format " (W%02d)" w1))
  3851. (t (format " (W%02d-W%02d)" w1 w2)))
  3852. ":\n")))
  3853. ;; Add properties if we actually inserted a header.
  3854. (when (> (point) s)
  3855. (add-text-properties s (1- (point))
  3856. (list 'face 'org-agenda-structure
  3857. 'org-date-line t))
  3858. (org-agenda-mark-header-line s)))
  3859. (while (setq d (pop day-numbers))
  3860. (setq date (calendar-gregorian-from-absolute d)
  3861. s (point))
  3862. (if (or (setq todayp (= d today))
  3863. (and (not start-pos) (= d sd)))
  3864. (setq start-pos (point))
  3865. (when (and start-pos (not end-pos))
  3866. (setq end-pos (point))))
  3867. (setq files thefiles
  3868. rtnall nil)
  3869. (while (setq file (pop files))
  3870. (catch 'nextfile
  3871. (org-check-agenda-file file)
  3872. (let ((org-agenda-entry-types org-agenda-entry-types))
  3873. ;; Starred types override non-starred equivalents
  3874. (when (member :deadline* org-agenda-entry-types)
  3875. (setq org-agenda-entry-types
  3876. (delq :deadline org-agenda-entry-types)))
  3877. (when (member :scheduled* org-agenda-entry-types)
  3878. (setq org-agenda-entry-types
  3879. (delq :scheduled org-agenda-entry-types)))
  3880. ;; Honor with-hour
  3881. (when with-hour
  3882. (when (member :deadline org-agenda-entry-types)
  3883. (setq org-agenda-entry-types
  3884. (delq :deadline org-agenda-entry-types))
  3885. (push :deadline* org-agenda-entry-types))
  3886. (when (member :scheduled org-agenda-entry-types)
  3887. (setq org-agenda-entry-types
  3888. (delq :scheduled org-agenda-entry-types))
  3889. (push :scheduled* org-agenda-entry-types)))
  3890. (unless org-agenda-include-deadlines
  3891. (setq org-agenda-entry-types
  3892. (delq :deadline* (delq :deadline org-agenda-entry-types))))
  3893. (cond
  3894. ((memq org-agenda-show-log-scoped '(only clockcheck))
  3895. (setq rtn (org-agenda-get-day-entries
  3896. file date :closed)))
  3897. (org-agenda-show-log-scoped
  3898. (setq rtn (apply 'org-agenda-get-day-entries
  3899. file date
  3900. (append '(:closed) org-agenda-entry-types))))
  3901. (t
  3902. (setq rtn (apply 'org-agenda-get-day-entries
  3903. file date
  3904. org-agenda-entry-types)))))
  3905. (setq rtnall (append rtnall rtn)))) ;; all entries
  3906. (when org-agenda-include-diary
  3907. (let ((org-agenda-search-headline-for-time t))
  3908. (require 'diary-lib)
  3909. (setq rtn (org-get-entries-from-diary date))
  3910. (setq rtnall (append rtnall rtn))))
  3911. (when (or rtnall org-agenda-show-all-dates)
  3912. (setq day-cnt (1+ day-cnt))
  3913. (insert
  3914. (if (stringp org-agenda-format-date)
  3915. (format-time-string org-agenda-format-date
  3916. (org-time-from-absolute date))
  3917. (funcall org-agenda-format-date date))
  3918. "\n")
  3919. (put-text-property s (1- (point)) 'face
  3920. (org-agenda-get-day-face date))
  3921. (put-text-property s (1- (point)) 'org-date-line t)
  3922. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3923. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
  3924. (when todayp
  3925. (put-text-property s (1- (point)) 'org-today t))
  3926. (setq rtnall
  3927. (org-agenda-add-time-grid-maybe rtnall ndays todayp))
  3928. (when rtnall (insert ;; all entries
  3929. (org-agenda-finalize-entries rtnall 'agenda)
  3930. "\n"))
  3931. (put-text-property s (1- (point)) 'day d)
  3932. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)))
  3933. (when (and org-agenda-clockreport-mode clocktable-start)
  3934. (let ((org-agenda-files (org-agenda-files nil 'ifmode))
  3935. ;; the above line is to ensure the restricted range!
  3936. (p (copy-sequence org-agenda-clockreport-parameter-plist))
  3937. tbl)
  3938. (setq p (org-plist-delete p :block))
  3939. (setq p (plist-put p :tstart clocktable-start))
  3940. (setq p (plist-put p :tend clocktable-end))
  3941. (setq p (plist-put p :scope 'agenda))
  3942. (setq tbl (apply 'org-clock-get-clocktable p))
  3943. (insert tbl)))
  3944. (goto-char (point-min))
  3945. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3946. (unless (or (not (get-buffer-window))
  3947. (and (pos-visible-in-window-p (point-min))
  3948. (pos-visible-in-window-p (point-max))))
  3949. (goto-char (1- (point-max)))
  3950. (recenter -1)
  3951. (when (not (pos-visible-in-window-p (or start-pos 1)))
  3952. (goto-char (or start-pos 1))
  3953. (recenter 1)))
  3954. (goto-char (or start-pos 1))
  3955. (add-text-properties (point-min) (point-max)
  3956. `(org-agenda-type agenda
  3957. org-last-args (,arg ,start-day ,span)
  3958. org-redo-cmd ,org-agenda-redo-command
  3959. org-series-cmd ,org-cmd))
  3960. (when (eq org-agenda-show-log-scoped 'clockcheck)
  3961. (org-agenda-show-clocking-issues))
  3962. (org-agenda-finalize)
  3963. (setq buffer-read-only t)
  3964. (message ""))))
  3965. (defun org-agenda-ndays-to-span (n)
  3966. "Return a span symbol for a span of N days, or N if none matches."
  3967. (cond ((symbolp n) n)
  3968. ((= n 1) 'day)
  3969. ((= n 7) 'week)
  3970. ((= n 14) 'fortnight)
  3971. (t n)))
  3972. (defun org-agenda-span-to-ndays (span &optional start-day)
  3973. "Return ndays from SPAN, possibly starting at START-DAY.
  3974. START-DAY is an absolute time value."
  3975. (cond ((numberp span) span)
  3976. ((eq span 'day) 1)
  3977. ((eq span 'week) 7)
  3978. ((eq span 'fortnight) 14)
  3979. ((eq span 'month)
  3980. (let ((date (calendar-gregorian-from-absolute start-day)))
  3981. (calendar-last-day-of-month (car date) (cl-caddr date))))
  3982. ((eq span 'year)
  3983. (let ((date (calendar-gregorian-from-absolute start-day)))
  3984. (if (calendar-leap-year-p (cl-caddr date)) 366 365)))))
  3985. (defun org-agenda-span-name (span)
  3986. "Return a SPAN name."
  3987. (if (null span)
  3988. ""
  3989. (if (symbolp span)
  3990. (capitalize (symbol-name span))
  3991. (format "%d days" span))))
  3992. ;;; Agenda word search
  3993. (defvar org-agenda-search-history nil)
  3994. (defvar org-search-syntax-table nil
  3995. "Special syntax table for Org search.
  3996. In this table, we have single quotes not as word constituents, to
  3997. that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
  3998. (defvar org-mode-syntax-table) ; From org.el
  3999. (defun org-search-syntax-table ()
  4000. (unless org-search-syntax-table
  4001. (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
  4002. (modify-syntax-entry ?' "." org-search-syntax-table)
  4003. (modify-syntax-entry ?` "." org-search-syntax-table))
  4004. org-search-syntax-table)
  4005. (defvar org-agenda-last-search-view-search-was-boolean nil)
  4006. ;;;###autoload
  4007. (defun org-search-view (&optional todo-only string edit-at)
  4008. "Show all entries that contain a phrase or words or regular expressions.
  4009. With optional prefix argument TODO-ONLY, only consider entries that are
  4010. TODO entries. The argument STRING can be used to pass a default search
  4011. string into this function. If EDIT-AT is non-nil, it means that the
  4012. user should get a chance to edit this string, with cursor at position
  4013. EDIT-AT.
  4014. The search string can be viewed either as a phrase that should be found as
  4015. is, or it can be broken into a number of snippets, each of which must match
  4016. in a Boolean way to select an entry. The default depends on the variable
  4017. `org-agenda-search-view-always-boolean'.
  4018. Even if this is turned off (the default) you can always switch to
  4019. Boolean search dynamically by preceding the first word with \"+\" or \"-\".
  4020. The default is a direct search of the whole phrase, where each space in
  4021. the search string can expand to an arbitrary amount of whitespace,
  4022. including newlines.
  4023. If using a Boolean search, the search string is split on whitespace and
  4024. each snippet is searched separately, with logical AND to select an entry.
  4025. Words prefixed with a minus must *not* occur in the entry. Words without
  4026. a prefix or prefixed with a plus must occur in the entry. Matching is
  4027. case-insensitive. Words are enclosed by word delimiters (i.e. they must
  4028. match whole words, not parts of a word) if
  4029. `org-agenda-search-view-force-full-words' is set (default is nil).
  4030. Boolean search snippets enclosed by curly braces are interpreted as
  4031. regular expressions that must or (when preceded with \"-\") must not
  4032. match in the entry. Snippets enclosed into double quotes will be taken
  4033. as a whole, to include whitespace.
  4034. - If the search string starts with an asterisk, search only in headlines.
  4035. - If (possibly after the leading star) the search string starts with an
  4036. exclamation mark, this also means to look at TODO entries only, an effect
  4037. that can also be achieved with a prefix argument.
  4038. - If (possibly after star and exclamation mark) the search string starts
  4039. with a colon, this will mean that the (non-regexp) snippets of the
  4040. Boolean search must match as full words.
  4041. This command searches the agenda files, and in addition the files
  4042. listed in `org-agenda-text-search-extra-files' unless a restriction lock
  4043. is active."
  4044. (interactive "P")
  4045. (when org-agenda-overriding-arguments
  4046. (setq todo-only (car org-agenda-overriding-arguments)
  4047. string (nth 1 org-agenda-overriding-arguments)
  4048. edit-at (nth 2 org-agenda-overriding-arguments)))
  4049. (let* ((props (list 'face nil
  4050. 'done-face 'org-agenda-done
  4051. 'org-not-done-regexp org-not-done-regexp
  4052. 'org-todo-regexp org-todo-regexp
  4053. 'org-complex-heading-regexp org-complex-heading-regexp
  4054. 'mouse-face 'highlight
  4055. 'help-echo (format "mouse-2 or RET jump to location")))
  4056. (full-words org-agenda-search-view-force-full-words)
  4057. (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
  4058. regexp rtn rtnall files file pos inherited-tags
  4059. marker category level tags c neg re boolean
  4060. ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
  4061. (unless (and (not edit-at)
  4062. (stringp string)
  4063. (string-match "\\S-" string))
  4064. (setq string (read-string
  4065. (if org-agenda-search-view-always-boolean
  4066. "[+-]Word/{Regexp} ...: "
  4067. "Phrase or [+-]Word/{Regexp} ...: ")
  4068. (cond
  4069. ((integerp edit-at) (cons string edit-at))
  4070. (edit-at string))
  4071. 'org-agenda-search-history)))
  4072. (catch 'exit
  4073. (when org-agenda-sticky
  4074. (setq org-agenda-buffer-name
  4075. (if (stringp string)
  4076. (format "*Org Agenda(%s:%s)*"
  4077. (or org-keys (or (and todo-only "S") "s")) string)
  4078. (format "*Org Agenda(%s)*" (or (and todo-only "S") "s")))))
  4079. (org-agenda-prepare "SEARCH")
  4080. (org-compile-prefix-format 'search)
  4081. (org-set-sorting-strategy 'search)
  4082. (setq org-agenda-redo-command
  4083. (list 'org-search-view (if todo-only t nil)
  4084. (list 'if 'current-prefix-arg nil string)))
  4085. (setq org-agenda-query-string string)
  4086. (if (equal (string-to-char string) ?*)
  4087. (setq hdl-only t
  4088. words (substring string 1))
  4089. (setq words string))
  4090. (when (equal (string-to-char words) ?!)
  4091. (setq todo-only t
  4092. words (substring words 1)))
  4093. (when (equal (string-to-char words) ?:)
  4094. (setq full-words t
  4095. words (substring words 1)))
  4096. (when (or org-agenda-search-view-always-boolean
  4097. (member (string-to-char words) '(?- ?+ ?\{)))
  4098. (setq boolean t))
  4099. (setq words (split-string words))
  4100. (let (www w)
  4101. (while (setq w (pop words))
  4102. (while (and (string-match "\\\\\\'" w) words)
  4103. (setq w (concat (substring w 0 -1) " " (pop words))))
  4104. (push w www))
  4105. (setq words (nreverse www) www nil)
  4106. (while (setq w (pop words))
  4107. (when (and (string-match "\\`[-+]?{" w)
  4108. (not (string-match "}\\'" w)))
  4109. (while (and words (not (string-match "}\\'" (car words))))
  4110. (setq w (concat w " " (pop words))))
  4111. (setq w (concat w " " (pop words))))
  4112. (push w www))
  4113. (setq words (nreverse www)))
  4114. (setq org-agenda-last-search-view-search-was-boolean boolean)
  4115. (when boolean
  4116. (let (wds w)
  4117. (while (setq w (pop words))
  4118. (when (or (equal (substring w 0 1) "\"")
  4119. (and (> (length w) 1)
  4120. (member (substring w 0 1) '("+" "-"))
  4121. (equal (substring w 1 2) "\"")))
  4122. (while (and words (not (equal (substring w -1) "\"")))
  4123. (setq w (concat w " " (pop words)))))
  4124. (and (string-match "\\`\\([-+]?\\)\"" w)
  4125. (setq w (replace-match "\\1" nil nil w)))
  4126. (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
  4127. (push w wds))
  4128. (setq words (nreverse wds))))
  4129. (if boolean
  4130. (mapc (lambda (w)
  4131. (setq c (string-to-char w))
  4132. (if (equal c ?-)
  4133. (setq neg t w (substring w 1))
  4134. (if (equal c ?+)
  4135. (setq neg nil w (substring w 1))
  4136. (setq neg nil)))
  4137. (if (string-match "\\`{.*}\\'" w)
  4138. (setq re (substring w 1 -1))
  4139. (if full-words
  4140. (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
  4141. (setq re (regexp-quote (downcase w)))))
  4142. (if neg (push re regexps-) (push re regexps+)))
  4143. words)
  4144. (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
  4145. regexps+))
  4146. (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
  4147. (if (not regexps+)
  4148. (setq regexp org-outline-regexp-bol)
  4149. (setq regexp (pop regexps+))
  4150. (when hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
  4151. regexp))))
  4152. (setq files (org-agenda-files nil 'ifmode))
  4153. ;; Add `org-agenda-text-search-extra-files' unless there is some
  4154. ;; restriction.
  4155. (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
  4156. (pop org-agenda-text-search-extra-files)
  4157. (unless (get 'org-agenda-files 'org-restrict)
  4158. (setq files (org-add-archive-files files))))
  4159. ;; Uniquify files. However, let `org-check-agenda-file' handle
  4160. ;; non-existent ones.
  4161. (setq files (cl-remove-duplicates
  4162. (append files org-agenda-text-search-extra-files)
  4163. :test (lambda (a b)
  4164. (and (file-exists-p a)
  4165. (file-exists-p b)
  4166. (file-equal-p a b))))
  4167. rtnall nil)
  4168. (while (setq file (pop files))
  4169. (setq ee nil)
  4170. (catch 'nextfile
  4171. (org-check-agenda-file file)
  4172. (setq buffer (if (file-exists-p file)
  4173. (org-get-agenda-file-buffer file)
  4174. (error "No such file %s" file)))
  4175. (unless buffer
  4176. ;; If file does not exist, make sure an error message is sent
  4177. (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
  4178. file))))
  4179. (with-current-buffer buffer
  4180. (with-syntax-table (org-search-syntax-table)
  4181. (unless (derived-mode-p 'org-mode)
  4182. (error "Agenda file %s is not in Org mode" file))
  4183. (let ((case-fold-search t))
  4184. (save-excursion
  4185. (save-restriction
  4186. (if (eq buffer org-agenda-restrict)
  4187. (narrow-to-region org-agenda-restrict-begin
  4188. org-agenda-restrict-end)
  4189. (widen))
  4190. (goto-char (point-min))
  4191. (unless (or (org-at-heading-p)
  4192. (outline-next-heading))
  4193. (throw 'nextfile t))
  4194. (goto-char (max (point-min) (1- (point))))
  4195. (while (re-search-forward regexp nil t)
  4196. (org-back-to-heading t)
  4197. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4198. (> (org-reduced-level (org-outline-level))
  4199. org-agenda-search-view-max-outline-level)
  4200. (forward-line -1)
  4201. (org-back-to-heading t)))
  4202. (skip-chars-forward "* ")
  4203. (setq beg (point-at-bol)
  4204. beg1 (point)
  4205. end (progn
  4206. (outline-next-heading)
  4207. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4208. (> (org-reduced-level (org-outline-level))
  4209. org-agenda-search-view-max-outline-level)
  4210. (forward-line 1)
  4211. (outline-next-heading)))
  4212. (point)))
  4213. (catch :skip
  4214. (goto-char beg)
  4215. (org-agenda-skip)
  4216. (setq str (buffer-substring-no-properties
  4217. (point-at-bol)
  4218. (if hdl-only (point-at-eol) end)))
  4219. (mapc (lambda (wr) (when (string-match wr str)
  4220. (goto-char (1- end))
  4221. (throw :skip t)))
  4222. regexps-)
  4223. (mapc (lambda (wr) (unless (string-match wr str)
  4224. (goto-char (1- end))
  4225. (throw :skip t)))
  4226. (if todo-only
  4227. (cons (concat "^\\*+[ \t]+"
  4228. org-not-done-regexp)
  4229. regexps+)
  4230. regexps+))
  4231. (goto-char beg)
  4232. (setq marker (org-agenda-new-marker (point))
  4233. category (org-get-category)
  4234. level (make-string (org-reduced-level (org-outline-level)) ? )
  4235. inherited-tags
  4236. (or (eq org-agenda-show-inherited-tags 'always)
  4237. (and (listp org-agenda-show-inherited-tags)
  4238. (memq 'todo org-agenda-show-inherited-tags))
  4239. (and (eq org-agenda-show-inherited-tags t)
  4240. (or (eq org-agenda-use-tag-inheritance t)
  4241. (memq 'todo org-agenda-use-tag-inheritance))))
  4242. tags (org-get-tags nil (not inherited-tags))
  4243. txt (org-agenda-format-item
  4244. ""
  4245. (buffer-substring-no-properties
  4246. beg1 (point-at-eol))
  4247. level category tags t))
  4248. (org-add-props txt props
  4249. 'org-marker marker 'org-hd-marker marker
  4250. 'org-todo-regexp org-todo-regexp
  4251. 'level level
  4252. 'org-complex-heading-regexp org-complex-heading-regexp
  4253. 'priority 1000
  4254. 'type "search")
  4255. (push txt ee)
  4256. (goto-char (1- end))))))))))
  4257. (setq rtn (nreverse ee))
  4258. (setq rtnall (append rtnall rtn)))
  4259. (org-agenda--insert-overriding-header
  4260. (with-temp-buffer
  4261. (insert "Search words: ")
  4262. (add-text-properties (point-min) (1- (point))
  4263. (list 'face 'org-agenda-structure))
  4264. (setq pos (point))
  4265. (insert string "\n")
  4266. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4267. (setq pos (point))
  4268. (unless org-agenda-multi
  4269. (insert (substitute-command-keys "\\<org-agenda-mode-map>\
  4270. Press `\\[org-agenda-manipulate-query-add]', \
  4271. `\\[org-agenda-manipulate-query-subtract]' to add/sub word, \
  4272. `\\[org-agenda-manipulate-query-add-re]', \
  4273. `\\[org-agenda-manipulate-query-subtract-re]' to add/sub regexp, \
  4274. `\\[universal-argument] \\[org-agenda-redo]' for a fresh search\n"))
  4275. (add-text-properties pos (1- (point))
  4276. (list 'face 'org-agenda-structure)))
  4277. (buffer-string)))
  4278. (org-agenda-mark-header-line (point-min))
  4279. (when rtnall
  4280. (insert (org-agenda-finalize-entries rtnall 'search) "\n"))
  4281. (goto-char (point-min))
  4282. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4283. (add-text-properties (point-min) (point-max)
  4284. `(org-agenda-type search
  4285. org-last-args (,todo-only ,string ,edit-at)
  4286. org-redo-cmd ,org-agenda-redo-command
  4287. org-series-cmd ,org-cmd))
  4288. (org-agenda-finalize)
  4289. (setq buffer-read-only t))))
  4290. ;;; Agenda TODO list
  4291. (defun org-agenda-propertize-selected-todo-keywords (keywords)
  4292. "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
  4293. (concat
  4294. (if (or (equal keywords "ALL") (not keywords))
  4295. (propertize "ALL" 'face 'warning)
  4296. (mapconcat
  4297. (lambda (kw)
  4298. (propertize kw 'face (org-get-todo-face kw)))
  4299. (org-split-string keywords "|")
  4300. "|"))
  4301. "\n"))
  4302. (defvar org-select-this-todo-keyword nil)
  4303. (defvar org-last-arg nil)
  4304. ;;;###autoload
  4305. (defun org-todo-list (&optional arg)
  4306. "Show all (not done) TODO entries from all agenda file in a single list.
  4307. The prefix arg can be used to select a specific TODO keyword and limit
  4308. the list to these. When using `\\[universal-argument]', you will be prompted
  4309. for a keyword. A numeric prefix directly selects the Nth keyword in
  4310. `org-todo-keywords-1'."
  4311. (interactive "P")
  4312. (when org-agenda-overriding-arguments
  4313. (setq arg org-agenda-overriding-arguments))
  4314. (when (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
  4315. (let* ((today (org-today))
  4316. (date (calendar-gregorian-from-absolute today))
  4317. (completion-ignore-case t)
  4318. kwds org-select-this-todo-keyword rtn rtnall files file pos)
  4319. (catch 'exit
  4320. (when org-agenda-sticky
  4321. (setq org-agenda-buffer-name
  4322. (if (stringp org-select-this-todo-keyword)
  4323. (format "*Org Agenda(%s:%s)*" (or org-keys "t")
  4324. org-select-this-todo-keyword)
  4325. (format "*Org Agenda(%s)*" (or org-keys "t")))))
  4326. (org-agenda-prepare "TODO")
  4327. (setq kwds org-todo-keywords-for-agenda
  4328. org-select-this-todo-keyword (if (stringp arg) arg
  4329. (and (integerp arg)
  4330. (> arg 0)
  4331. (nth (1- arg) kwds))))
  4332. (when (equal arg '(4))
  4333. (setq org-select-this-todo-keyword
  4334. (completing-read "Keyword (or KWD1|K2D2|...): "
  4335. (mapcar #'list kwds) nil nil)))
  4336. (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
  4337. (org-compile-prefix-format 'todo)
  4338. (org-set-sorting-strategy 'todo)
  4339. (setq org-agenda-redo-command
  4340. `(org-todo-list (or (and (numberp current-prefix-arg)
  4341. current-prefix-arg)
  4342. ,org-select-this-todo-keyword
  4343. current-prefix-arg ,arg)))
  4344. (setq files (org-agenda-files nil 'ifmode)
  4345. rtnall nil)
  4346. (while (setq file (pop files))
  4347. (catch 'nextfile
  4348. (org-check-agenda-file file)
  4349. (setq rtn (org-agenda-get-day-entries file date :todo))
  4350. (setq rtnall (append rtnall rtn))))
  4351. (org-agenda--insert-overriding-header
  4352. (with-temp-buffer
  4353. (insert "Global list of TODO items of type: ")
  4354. (add-text-properties (point-min) (1- (point))
  4355. (list 'face 'org-agenda-structure
  4356. 'short-heading
  4357. (concat "ToDo: "
  4358. (or org-select-this-todo-keyword "ALL"))))
  4359. (org-agenda-mark-header-line (point-min))
  4360. (insert (org-agenda-propertize-selected-todo-keywords
  4361. org-select-this-todo-keyword))
  4362. (setq pos (point))
  4363. (unless org-agenda-multi
  4364. (insert (substitute-command-keys "Press \
  4365. \\<org-agenda-mode-map>`N \\[org-agenda-redo]' (e.g. `0 \\[org-agenda-redo]') \
  4366. to search again: (0)[ALL]"))
  4367. (let ((n 0))
  4368. (dolist (k kwds)
  4369. (let ((s (format "(%d)%s" (cl-incf n) k)))
  4370. (when (> (+ (current-column) (string-width s) 1) (window-width))
  4371. (insert "\n "))
  4372. (insert " " s))))
  4373. (insert "\n"))
  4374. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure))
  4375. (buffer-string)))
  4376. (org-agenda-mark-header-line (point-min))
  4377. (when rtnall
  4378. (insert (org-agenda-finalize-entries rtnall 'todo) "\n"))
  4379. (goto-char (point-min))
  4380. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4381. (add-text-properties (point-min) (point-max)
  4382. `(org-agenda-type todo
  4383. org-last-args ,arg
  4384. org-redo-cmd ,org-agenda-redo-command
  4385. org-series-cmd ,org-cmd))
  4386. (org-agenda-finalize)
  4387. (setq buffer-read-only t))))
  4388. ;;; Agenda tags match
  4389. ;;;###autoload
  4390. (defun org-tags-view (&optional todo-only match)
  4391. "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
  4392. The prefix arg TODO-ONLY limits the search to TODO entries."
  4393. (interactive "P")
  4394. (when org-agenda-overriding-arguments
  4395. (setq todo-only (car org-agenda-overriding-arguments)
  4396. match (nth 1 org-agenda-overriding-arguments)))
  4397. (let* ((org-tags-match-list-sublevels
  4398. org-tags-match-list-sublevels)
  4399. (completion-ignore-case t)
  4400. (org--matcher-tags-todo-only todo-only)
  4401. rtn rtnall files file pos matcher
  4402. buffer)
  4403. (when (and (stringp match) (not (string-match "\\S-" match)))
  4404. (setq match nil))
  4405. (catch 'exit
  4406. ;; TODO: this code is repeated a lot...
  4407. (when org-agenda-sticky
  4408. (setq org-agenda-buffer-name
  4409. (if (stringp match)
  4410. (format "*Org Agenda(%s:%s)*"
  4411. (or org-keys (or (and todo-only "M") "m")) match)
  4412. (format "*Org Agenda(%s)*" (or (and todo-only "M") "m")))))
  4413. (setq matcher (org-make-tags-matcher match))
  4414. ;; Prepare agendas (and `org-tag-alist-for-agenda') before
  4415. ;; expanding tags within `org-make-tags-matcher'
  4416. (org-agenda-prepare (concat "TAGS " match))
  4417. (setq match (car matcher)
  4418. matcher (cdr matcher))
  4419. (org-compile-prefix-format 'tags)
  4420. (org-set-sorting-strategy 'tags)
  4421. (setq org-agenda-query-string match)
  4422. (setq org-agenda-redo-command
  4423. (list 'org-tags-view
  4424. `(quote ,org--matcher-tags-todo-only)
  4425. `(if current-prefix-arg nil ,org-agenda-query-string)))
  4426. (setq files (org-agenda-files nil 'ifmode)
  4427. rtnall nil)
  4428. (while (setq file (pop files))
  4429. (catch 'nextfile
  4430. (org-check-agenda-file file)
  4431. (setq buffer (if (file-exists-p file)
  4432. (org-get-agenda-file-buffer file)
  4433. (error "No such file %s" file)))
  4434. (if (not buffer)
  4435. ;; If file does not exist, error message to agenda
  4436. (setq rtn (list
  4437. (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4438. rtnall (append rtnall rtn))
  4439. (with-current-buffer buffer
  4440. (unless (derived-mode-p 'org-mode)
  4441. (error "Agenda file %s is not in Org mode" file))
  4442. (save-excursion
  4443. (save-restriction
  4444. (if (eq buffer org-agenda-restrict)
  4445. (narrow-to-region org-agenda-restrict-begin
  4446. org-agenda-restrict-end)
  4447. (widen))
  4448. (setq rtn (org-scan-tags 'agenda
  4449. matcher
  4450. org--matcher-tags-todo-only))
  4451. (setq rtnall (append rtnall rtn))))))))
  4452. (org-agenda--insert-overriding-header
  4453. (with-temp-buffer
  4454. (insert "Headlines with TAGS match: ")
  4455. (add-text-properties (point-min) (1- (point))
  4456. (list 'face 'org-agenda-structure
  4457. 'short-heading
  4458. (concat "Match: " match)))
  4459. (setq pos (point))
  4460. (insert match "\n")
  4461. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4462. (setq pos (point))
  4463. (unless org-agenda-multi
  4464. (insert (substitute-command-keys
  4465. "Press \
  4466. \\<org-agenda-mode-map>`\\[universal-argument] \\[org-agenda-redo]' \
  4467. to search again\n")))
  4468. (add-text-properties pos (1- (point))
  4469. (list 'face 'org-agenda-structure))
  4470. (buffer-string)))
  4471. (org-agenda-mark-header-line (point-min))
  4472. (when rtnall
  4473. (insert (org-agenda-finalize-entries rtnall 'tags) "\n"))
  4474. (goto-char (point-min))
  4475. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4476. (add-text-properties
  4477. (point-min) (point-max)
  4478. `(org-agenda-type tags
  4479. org-last-args (,org--matcher-tags-todo-only ,match)
  4480. org-redo-cmd ,org-agenda-redo-command
  4481. org-series-cmd ,org-cmd))
  4482. (org-agenda-finalize)
  4483. (setq buffer-read-only t))))
  4484. ;;; Agenda Finding stuck projects
  4485. (defvar org-agenda-skip-regexp nil
  4486. "Regular expression used in skipping subtrees for the agenda.
  4487. This is basically a temporary global variable that can be set and then
  4488. used by user-defined selections using `org-agenda-skip-function'.")
  4489. (defvar org-agenda-overriding-header nil
  4490. "When set during agenda, todo and tags searches it replaces the header.
  4491. If an empty string, no header will be inserted. If any other
  4492. string, it will be inserted as a header. If nil, a header will
  4493. be generated automatically according to the command. This
  4494. variable should not be set directly, but custom commands can bind
  4495. it in the options section.")
  4496. (defun org-agenda-skip-entry-if (&rest conditions)
  4497. "Skip entry if any of CONDITIONS is true.
  4498. See `org-agenda-skip-if' for details."
  4499. (org-agenda-skip-if nil conditions))
  4500. (defun org-agenda-skip-subtree-if (&rest conditions)
  4501. "Skip subtree if any of CONDITIONS is true.
  4502. See `org-agenda-skip-if' for details."
  4503. (org-agenda-skip-if t conditions))
  4504. (defun org-agenda-skip-if (subtree conditions)
  4505. "Checks current entity for CONDITIONS.
  4506. If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
  4507. the entry (i.e. the text before the next heading) is checked.
  4508. CONDITIONS is a list of symbols, boolean OR is used to combine the results
  4509. from different tests. Valid conditions are:
  4510. scheduled Check if there is a scheduled cookie
  4511. notscheduled Check if there is no scheduled cookie
  4512. deadline Check if there is a deadline
  4513. notdeadline Check if there is no deadline
  4514. timestamp Check if there is a timestamp (also deadline or scheduled)
  4515. nottimestamp Check if there is no timestamp (also deadline or scheduled)
  4516. regexp Check if regexp matches
  4517. notregexp Check if regexp does not match.
  4518. todo Check if TODO keyword matches
  4519. nottodo Check if TODO keyword does not match
  4520. The regexp is taken from the conditions list, it must come right after
  4521. the `regexp' or `notregexp' element.
  4522. `todo' and `nottodo' accept as an argument a list of todo
  4523. keywords, which may include \"*\" to match any todo keyword.
  4524. (org-agenda-skip-entry-if \\='todo \\='(\"TODO\" \"WAITING\"))
  4525. would skip all entries with \"TODO\" or \"WAITING\" keywords.
  4526. Instead of a list, a keyword class may be given. For example:
  4527. (org-agenda-skip-entry-if \\='nottodo \\='done)
  4528. would skip entries that haven't been marked with any of \"DONE\"
  4529. keywords. Possible classes are: `todo', `done', `any'.
  4530. If any of these conditions is met, this function returns the end point of
  4531. the entity, causing the search to continue from there. This is a function
  4532. that can be put into `org-agenda-skip-function' for the duration of a command."
  4533. (org-back-to-heading t)
  4534. (let* ((beg (point))
  4535. (end (if subtree (save-excursion (org-end-of-subtree t) (point))
  4536. (org-entry-end-position)))
  4537. (planning-end (if subtree end (line-end-position 2)))
  4538. m)
  4539. (and
  4540. (or (and (memq 'scheduled conditions)
  4541. (re-search-forward org-scheduled-time-regexp planning-end t))
  4542. (and (memq 'notscheduled conditions)
  4543. (not
  4544. (save-excursion
  4545. (re-search-forward org-scheduled-time-regexp planning-end t))))
  4546. (and (memq 'deadline conditions)
  4547. (re-search-forward org-deadline-time-regexp planning-end t))
  4548. (and (memq 'notdeadline conditions)
  4549. (not
  4550. (save-excursion
  4551. (re-search-forward org-deadline-time-regexp planning-end t))))
  4552. (and (memq 'timestamp conditions)
  4553. (re-search-forward org-ts-regexp end t))
  4554. (and (memq 'nottimestamp conditions)
  4555. (not (save-excursion (re-search-forward org-ts-regexp end t))))
  4556. (and (setq m (memq 'regexp conditions))
  4557. (stringp (nth 1 m))
  4558. (re-search-forward (nth 1 m) end t))
  4559. (and (setq m (memq 'notregexp conditions))
  4560. (stringp (nth 1 m))
  4561. (not (save-excursion (re-search-forward (nth 1 m) end t))))
  4562. (and (or
  4563. (setq m (memq 'nottodo conditions))
  4564. (setq m (memq 'todo-unblocked conditions))
  4565. (setq m (memq 'nottodo-unblocked conditions))
  4566. (setq m (memq 'todo conditions)))
  4567. (org-agenda-skip-if-todo m end)))
  4568. end)))
  4569. (defun org-agenda-skip-if-todo (args end)
  4570. "Helper function for `org-agenda-skip-if', do not use it directly.
  4571. ARGS is a list with first element either `todo', `nottodo',
  4572. `todo-unblocked' or `nottodo-unblocked'. The remainder is either
  4573. a list of TODO keywords, or a state symbol `todo' or `done' or
  4574. `any'."
  4575. (let ((todo-re
  4576. (concat "^\\*+[ \t]+"
  4577. (regexp-opt
  4578. (pcase args
  4579. (`(,_ todo)
  4580. (org-delete-all org-done-keywords
  4581. (copy-sequence org-todo-keywords-1)))
  4582. (`(,_ done) org-done-keywords)
  4583. (`(,_ any) org-todo-keywords-1)
  4584. (`(,_ ,(pred atom))
  4585. (error "Invalid TODO class or type: %S" args))
  4586. (`(,_ ,(pred (member "*"))) org-todo-keywords-1)
  4587. (`(,_ ,todo-list) todo-list))
  4588. 'words))))
  4589. (pcase args
  4590. (`(todo . ,_)
  4591. (let (case-fold-search) (re-search-forward todo-re end t)))
  4592. (`(nottodo . ,_)
  4593. (not (let (case-fold-search) (re-search-forward todo-re end t))))
  4594. (`(todo-unblocked . ,_)
  4595. (catch :unblocked
  4596. (while (let (case-fold-search) (re-search-forward todo-re end t))
  4597. (when (org-entry-blocked-p) (throw :unblocked t)))
  4598. nil))
  4599. (`(nottodo-unblocked . ,_)
  4600. (catch :unblocked
  4601. (while (let (case-fold-search) (re-search-forward todo-re end t))
  4602. (when (org-entry-blocked-p) (throw :unblocked nil)))
  4603. t))
  4604. (`(,type . ,_) (error "Unknown TODO skip type: %S" type)))))
  4605. ;;;###autoload
  4606. (defun org-agenda-list-stuck-projects (&rest ignore)
  4607. "Create agenda view for projects that are stuck.
  4608. Stuck projects are project that have no next actions. For the definitions
  4609. of what a project is and how to check if it stuck, customize the variable
  4610. `org-stuck-projects'."
  4611. (interactive)
  4612. (let* ((org-agenda-overriding-header
  4613. (or org-agenda-overriding-header "List of stuck projects: "))
  4614. (matcher (nth 0 org-stuck-projects))
  4615. (todo (nth 1 org-stuck-projects))
  4616. (tags (nth 2 org-stuck-projects))
  4617. (gen-re (org-string-nw-p (nth 3 org-stuck-projects)))
  4618. (todo-wds
  4619. (if (not (member "*" todo)) todo
  4620. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  4621. (org-delete-all org-done-keywords-for-agenda
  4622. (copy-sequence org-todo-keywords-for-agenda))))
  4623. (todo-re (and todo
  4624. (format "^\\*+[ \t]+\\(%s\\)\\>"
  4625. (mapconcat #'identity todo-wds "\\|"))))
  4626. (tags-re (cond ((null tags) nil)
  4627. ((member "*" tags) org-tag-line-re)
  4628. (tags
  4629. (let ((other-tags (format "\\(?:%s:\\)*" org-tag-re)))
  4630. (concat org-outline-regexp-bol
  4631. ".*?[ \t]:"
  4632. other-tags
  4633. (regexp-opt tags t)
  4634. ":" other-tags "[ \t]*$")))
  4635. (t nil)))
  4636. (re-list (delq nil (list todo-re tags-re gen-re)))
  4637. (skip-re
  4638. (if (null re-list)
  4639. (error "Missing information to identify unstuck projects")
  4640. (mapconcat #'identity re-list "\\|")))
  4641. (org-agenda-skip-function
  4642. ;; Skip entry if `org-agenda-skip-regexp' matches anywhere
  4643. ;; in the subtree.
  4644. `(lambda ()
  4645. (and (save-excursion
  4646. (let ((case-fold-search nil))
  4647. (re-search-forward
  4648. ,skip-re (save-excursion (org-end-of-subtree t)) t)))
  4649. (progn (outline-next-heading) (point))))))
  4650. (org-tags-view nil matcher)
  4651. (setq org-agenda-buffer-name (buffer-name))
  4652. (with-current-buffer org-agenda-buffer-name
  4653. (setq org-agenda-redo-command
  4654. `(org-agenda-list-stuck-projects ,current-prefix-arg))
  4655. (let ((inhibit-read-only t))
  4656. (add-text-properties
  4657. (point-min) (point-max)
  4658. `(org-redo-cmd ,org-agenda-redo-command))))))
  4659. ;;; Diary integration
  4660. (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
  4661. (defvar diary-list-entries-hook)
  4662. (defvar diary-time-regexp)
  4663. (defun org-get-entries-from-diary (date)
  4664. "Get the (Emacs Calendar) diary entries for DATE."
  4665. (require 'diary-lib)
  4666. (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
  4667. (diary-display-function 'diary-fancy-display)
  4668. (pop-up-frames nil)
  4669. (diary-list-entries-hook
  4670. (cons 'org-diary-default-entry diary-list-entries-hook))
  4671. (diary-file-name-prefix nil) ; turn this feature off
  4672. (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
  4673. entries
  4674. (org-disable-agenda-to-diary t))
  4675. (save-excursion
  4676. (save-window-excursion
  4677. (funcall (if (fboundp 'diary-list-entries)
  4678. 'diary-list-entries 'list-diary-entries)
  4679. date 1)))
  4680. (if (not (get-buffer diary-fancy-buffer))
  4681. (setq entries nil)
  4682. (with-current-buffer diary-fancy-buffer
  4683. (setq buffer-read-only nil)
  4684. (if (zerop (buffer-size))
  4685. ;; No entries
  4686. (setq entries nil)
  4687. ;; Omit the date and other unnecessary stuff
  4688. (org-agenda-cleanup-fancy-diary)
  4689. ;; Add prefix to each line and extend the text properties
  4690. (if (zerop (buffer-size))
  4691. (setq entries nil)
  4692. (setq entries (buffer-substring (point-min) (- (point-max) 1)))
  4693. (setq entries
  4694. (with-temp-buffer
  4695. (insert entries) (goto-char (point-min))
  4696. (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
  4697. (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
  4698. (replace-match (concat "; " (match-string 1)))))
  4699. (buffer-string)))))
  4700. (set-buffer-modified-p nil)
  4701. (kill-buffer diary-fancy-buffer)))
  4702. (when entries
  4703. (setq entries (org-split-string entries "\n"))
  4704. (setq entries
  4705. (mapcar
  4706. (lambda (x)
  4707. (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
  4708. ;; Extend the text properties to the beginning of the line
  4709. (org-add-props x (text-properties-at (1- (length x)) x)
  4710. 'type "diary" 'date date 'face 'org-agenda-diary))
  4711. entries)))))
  4712. (defvar org-agenda-cleanup-fancy-diary-hook nil
  4713. "Hook run when the fancy diary buffer is cleaned up.")
  4714. (defun org-agenda-cleanup-fancy-diary ()
  4715. "Remove unwanted stuff in buffer created by `fancy-diary-display'.
  4716. This gets rid of the date, the underline under the date, and the
  4717. dummy entry installed by Org mode to ensure non-empty diary for
  4718. each date. It also removes lines that contain only whitespace."
  4719. (goto-char (point-min))
  4720. (if (looking-at ".*?:[ \t]*")
  4721. (progn
  4722. (replace-match "")
  4723. (re-search-forward "\n=+$" nil t)
  4724. (replace-match "")
  4725. (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
  4726. (re-search-forward "\n=+$" nil t)
  4727. (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
  4728. (goto-char (point-min))
  4729. (while (re-search-forward "^ +\n" nil t)
  4730. (replace-match ""))
  4731. (goto-char (point-min))
  4732. (when (re-search-forward "^Org mode dummy\n?" nil t)
  4733. (replace-match ""))
  4734. (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
  4735. (defun org-modify-diary-entry-string (string)
  4736. "Add text properties to string, allowing Org to act on it."
  4737. (org-add-props string nil
  4738. 'mouse-face 'highlight
  4739. 'help-echo (if buffer-file-name
  4740. (format "mouse-2 or RET jump to diary file %s"
  4741. (abbreviate-file-name buffer-file-name))
  4742. "")
  4743. 'org-agenda-diary-link t
  4744. 'org-marker (org-agenda-new-marker (point-at-bol))))
  4745. (defun org-diary-default-entry ()
  4746. "Add a dummy entry to the diary.
  4747. Needed to avoid empty dates which mess up holiday display."
  4748. ;; Catch the error if dealing with the new add-to-diary-alist
  4749. (when org-disable-agenda-to-diary
  4750. (condition-case nil
  4751. (org-add-to-diary-list original-date "Org mode dummy" "")
  4752. (error
  4753. (org-add-to-diary-list original-date "Org mode dummy" "" nil)))))
  4754. (defun org-add-to-diary-list (&rest args)
  4755. (if (fboundp 'diary-add-to-list)
  4756. (apply 'diary-add-to-list args)
  4757. (apply 'add-to-diary-list args)))
  4758. (defvar org-diary-last-run-time nil)
  4759. ;;;###autoload
  4760. (defun org-diary (&rest args)
  4761. "Return diary information from org files.
  4762. This function can be used in a \"sexp\" diary entry in the Emacs calendar.
  4763. It accesses org files and extracts information from those files to be
  4764. listed in the diary. The function accepts arguments specifying what
  4765. items should be listed. For a list of arguments allowed here, see the
  4766. variable `org-agenda-entry-types'.
  4767. The call in the diary file should look like this:
  4768. &%%(org-diary) ~/path/to/some/orgfile.org
  4769. Use a separate line for each org file to check. Or, if you omit the file name,
  4770. all files listed in `org-agenda-files' will be checked automatically:
  4771. &%%(org-diary)
  4772. If you don't give any arguments (as in the example above), the default value
  4773. of `org-agenda-entry-types' is used: (:deadline :scheduled :timestamp :sexp).
  4774. So the example above may also be written as
  4775. &%%(org-diary :deadline :timestamp :sexp :scheduled)
  4776. The function expects the lisp variables `entry' and `date' to be provided
  4777. by the caller, because this is how the calendar works. Don't use this
  4778. function from a program - use `org-agenda-get-day-entries' instead."
  4779. (when (> (- (float-time)
  4780. org-agenda-last-marker-time)
  4781. 5)
  4782. ;; I am not sure if this works with sticky agendas, because the marker
  4783. ;; list is then no longer a global variable.
  4784. (org-agenda-reset-markers))
  4785. (org-compile-prefix-format 'agenda)
  4786. (org-set-sorting-strategy 'agenda)
  4787. (setq args (or args org-agenda-entry-types))
  4788. (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
  4789. (list entry)
  4790. (org-agenda-files t)))
  4791. (time (float-time))
  4792. file rtn results)
  4793. (when (or (not org-diary-last-run-time)
  4794. (> (- time
  4795. org-diary-last-run-time)
  4796. 3))
  4797. (org-agenda-prepare-buffers files))
  4798. (setq org-diary-last-run-time time)
  4799. ;; If this is called during org-agenda, don't return any entries to
  4800. ;; the calendar. Org Agenda will list these entries itself.
  4801. (when org-disable-agenda-to-diary (setq files nil))
  4802. (while (setq file (pop files))
  4803. (setq rtn (apply 'org-agenda-get-day-entries file date args))
  4804. (setq results (append results rtn)))
  4805. (when results
  4806. (setq results
  4807. (mapcar (lambda (i) (replace-regexp-in-string
  4808. org-link-bracket-re "\\2" i)) results))
  4809. (concat (org-agenda-finalize-entries results) "\n"))))
  4810. ;;; Agenda entry finders
  4811. (defun org-agenda--timestamp-to-absolute (&rest args)
  4812. "Call `org-time-string-to-absolute' with ARGS.
  4813. However, throw `:skip' whenever an error is raised."
  4814. (condition-case e
  4815. (apply #'org-time-string-to-absolute args)
  4816. (org-diary-sexp-no-match (throw :skip nil))
  4817. (error
  4818. (message "%s; Skipping entry" (error-message-string e))
  4819. (throw :skip nil))))
  4820. (defun org-agenda-get-day-entries (file date &rest args)
  4821. "Does the work for `org-diary' and `org-agenda'.
  4822. FILE is the path to a file to be checked for entries. DATE is date like
  4823. the one returned by `calendar-current-date'. ARGS are symbols indicating
  4824. which kind of entries should be extracted. For details about these, see
  4825. the documentation of `org-diary'."
  4826. (let* ((org-startup-folded nil)
  4827. (org-startup-align-all-tables nil)
  4828. (buffer (if (file-exists-p file) (org-get-agenda-file-buffer file)
  4829. (error "No such file %s" file))))
  4830. (if (not buffer)
  4831. ;; If file does not exist, signal it in diary nonetheless.
  4832. (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4833. (with-current-buffer buffer
  4834. (unless (derived-mode-p 'org-mode)
  4835. (error "Agenda file %s is not in Org mode" file))
  4836. (setq org-agenda-buffer (or org-agenda-buffer buffer))
  4837. (setf org-agenda-current-date date)
  4838. (save-excursion
  4839. (save-restriction
  4840. (if (eq buffer org-agenda-restrict)
  4841. (narrow-to-region org-agenda-restrict-begin
  4842. org-agenda-restrict-end)
  4843. (widen))
  4844. ;; Rationalize ARGS. Also make sure `:deadline' comes
  4845. ;; first in order to populate DEADLINES before passing it.
  4846. ;;
  4847. ;; We use `delq' since `org-uniquify' duplicates ARGS,
  4848. ;; guarding us from modifying `org-agenda-entry-types'.
  4849. (setf args (org-uniquify (or args org-agenda-entry-types)))
  4850. (when (and (memq :scheduled args) (memq :scheduled* args))
  4851. (setf args (delq :scheduled* args)))
  4852. (cond
  4853. ((memq :deadline args)
  4854. (setf args (cons :deadline
  4855. (delq :deadline (delq :deadline* args)))))
  4856. ((memq :deadline* args)
  4857. (setf args (cons :deadline* (delq :deadline* args)))))
  4858. ;; Collect list of headlines. Return them flattened.
  4859. (let ((case-fold-search nil) results deadlines)
  4860. (dolist (arg args (apply #'nconc (nreverse results)))
  4861. (pcase arg
  4862. ((and :todo (guard (org-agenda-today-p date)))
  4863. (push (org-agenda-get-todos) results))
  4864. (:timestamp
  4865. (push (org-agenda-get-blocks) results)
  4866. (push (org-agenda-get-timestamps deadlines) results))
  4867. (:sexp
  4868. (push (org-agenda-get-sexps) results))
  4869. (:scheduled
  4870. (push (org-agenda-get-scheduled deadlines) results))
  4871. (:scheduled*
  4872. (push (org-agenda-get-scheduled deadlines t) results))
  4873. (:closed
  4874. (push (org-agenda-get-progress) results))
  4875. (:deadline
  4876. (setf deadlines (org-agenda-get-deadlines))
  4877. (push deadlines results))
  4878. (:deadline*
  4879. (setf deadlines (org-agenda-get-deadlines t))
  4880. (push deadlines results)))))))))))
  4881. (defsubst org-em (x y list)
  4882. "Is X or Y a member of LIST?"
  4883. (or (memq x list) (memq y list)))
  4884. (defvar org-heading-keyword-regexp-format) ; defined in org.el
  4885. (defvar org-agenda-sorting-strategy-selected nil)
  4886. (defun org-agenda-entry-get-agenda-timestamp (pom)
  4887. "Retrieve timestamp information for sorting agenda views.
  4888. Given a point or marker POM, returns a cons cell of the timestamp
  4889. and the timestamp type relevant for the sorting strategy in
  4890. `org-agenda-sorting-strategy-selected'."
  4891. (let (ts ts-date-type)
  4892. (save-match-data
  4893. (cond ((org-em 'scheduled-up 'scheduled-down
  4894. org-agenda-sorting-strategy-selected)
  4895. (setq ts (org-entry-get pom "SCHEDULED")
  4896. ts-date-type " scheduled"))
  4897. ((org-em 'deadline-up 'deadline-down
  4898. org-agenda-sorting-strategy-selected)
  4899. (setq ts (org-entry-get pom "DEADLINE")
  4900. ts-date-type " deadline"))
  4901. ((org-em 'ts-up 'ts-down
  4902. org-agenda-sorting-strategy-selected)
  4903. (setq ts (org-entry-get pom "TIMESTAMP")
  4904. ts-date-type " timestamp"))
  4905. ((org-em 'tsia-up 'tsia-down
  4906. org-agenda-sorting-strategy-selected)
  4907. (setq ts (org-entry-get pom "TIMESTAMP_IA")
  4908. ts-date-type " timestamp_ia"))
  4909. ((org-em 'timestamp-up 'timestamp-down
  4910. org-agenda-sorting-strategy-selected)
  4911. (setq ts (or (org-entry-get pom "SCHEDULED")
  4912. (org-entry-get pom "DEADLINE")
  4913. (org-entry-get pom "TIMESTAMP")
  4914. (org-entry-get pom "TIMESTAMP_IA"))
  4915. ts-date-type ""))
  4916. (t (setq ts-date-type "")))
  4917. (cons (when ts (ignore-errors (org-time-string-to-absolute ts)))
  4918. ts-date-type))))
  4919. (defun org-agenda-get-todos ()
  4920. "Return the TODO information for agenda display."
  4921. (let* ((props (list 'face nil
  4922. 'done-face 'org-agenda-done
  4923. 'org-not-done-regexp org-not-done-regexp
  4924. 'org-todo-regexp org-todo-regexp
  4925. 'org-complex-heading-regexp org-complex-heading-regexp
  4926. 'mouse-face 'highlight
  4927. 'help-echo
  4928. (format "mouse-2 or RET jump to org file %s"
  4929. (abbreviate-file-name buffer-file-name))))
  4930. (case-fold-search nil)
  4931. (regexp (format org-heading-keyword-regexp-format
  4932. (cond
  4933. ((and org-select-this-todo-keyword
  4934. (equal org-select-this-todo-keyword "*"))
  4935. org-todo-regexp)
  4936. (org-select-this-todo-keyword
  4937. (concat "\\("
  4938. (mapconcat 'identity
  4939. (org-split-string
  4940. org-select-this-todo-keyword
  4941. "|")
  4942. "\\|") "\\)"))
  4943. (t org-not-done-regexp))))
  4944. marker priority category level tags todo-state
  4945. ts-date ts-date-type ts-date-pair
  4946. ee txt beg end inherited-tags todo-state-end-pos)
  4947. (goto-char (point-min))
  4948. (while (re-search-forward regexp nil t)
  4949. (catch :skip
  4950. (save-match-data
  4951. (beginning-of-line)
  4952. (org-agenda-skip)
  4953. (setq beg (point) end (save-excursion (outline-next-heading) (point)))
  4954. (unless (and (setq todo-state (org-get-todo-state))
  4955. (setq todo-state-end-pos (match-end 2)))
  4956. (goto-char end)
  4957. (throw :skip nil))
  4958. (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
  4959. (goto-char (1+ beg))
  4960. (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
  4961. (throw :skip nil)))
  4962. (goto-char (match-beginning 2))
  4963. (setq marker (org-agenda-new-marker (match-beginning 0))
  4964. category (org-get-category)
  4965. ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
  4966. ts-date (car ts-date-pair)
  4967. ts-date-type (cdr ts-date-pair)
  4968. txt (org-trim (buffer-substring (match-beginning 2) (match-end 0)))
  4969. inherited-tags
  4970. (or (eq org-agenda-show-inherited-tags 'always)
  4971. (and (listp org-agenda-show-inherited-tags)
  4972. (memq 'todo org-agenda-show-inherited-tags))
  4973. (and (eq org-agenda-show-inherited-tags t)
  4974. (or (eq org-agenda-use-tag-inheritance t)
  4975. (memq 'todo org-agenda-use-tag-inheritance))))
  4976. tags (org-get-tags nil (not inherited-tags))
  4977. level (make-string (org-reduced-level (org-outline-level)) ? )
  4978. txt (org-agenda-format-item "" txt level category tags t)
  4979. priority (1+ (org-get-priority txt)))
  4980. (org-add-props txt props
  4981. 'org-marker marker 'org-hd-marker marker
  4982. 'priority priority
  4983. 'level level
  4984. 'ts-date ts-date
  4985. 'type (concat "todo" ts-date-type) 'todo-state todo-state)
  4986. (push txt ee)
  4987. (if org-agenda-todo-list-sublevels
  4988. (goto-char todo-state-end-pos)
  4989. (org-end-of-subtree 'invisible))))
  4990. (nreverse ee)))
  4991. (defun org-agenda-todo-custom-ignore-p (time n)
  4992. "Check whether timestamp is farther away than n number of days.
  4993. This function is invoked if `org-agenda-todo-ignore-deadlines',
  4994. `org-agenda-todo-ignore-scheduled' or
  4995. `org-agenda-todo-ignore-timestamp' is set to an integer."
  4996. (let ((days (org-time-stamp-to-now
  4997. time org-agenda-todo-ignore-time-comparison-use-seconds)))
  4998. (if (>= n 0)
  4999. (>= days n)
  5000. (<= days n))))
  5001. ;;;###autoload
  5002. (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  5003. (&optional end)
  5004. "Do we have a reason to ignore this TODO entry because it has a time stamp?"
  5005. (when (or org-agenda-todo-ignore-with-date
  5006. org-agenda-todo-ignore-scheduled
  5007. org-agenda-todo-ignore-deadlines
  5008. org-agenda-todo-ignore-timestamp)
  5009. (setq end (or end (save-excursion (outline-next-heading) (point))))
  5010. (save-excursion
  5011. (or (and org-agenda-todo-ignore-with-date
  5012. (re-search-forward org-ts-regexp end t))
  5013. (and org-agenda-todo-ignore-scheduled
  5014. (re-search-forward org-scheduled-time-regexp end t)
  5015. (cond
  5016. ((eq org-agenda-todo-ignore-scheduled 'future)
  5017. (> (org-time-stamp-to-now
  5018. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5019. ((eq org-agenda-todo-ignore-scheduled 'past)
  5020. (<= (org-time-stamp-to-now
  5021. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5022. ((numberp org-agenda-todo-ignore-scheduled)
  5023. (org-agenda-todo-custom-ignore-p
  5024. (match-string 1) org-agenda-todo-ignore-scheduled))
  5025. (t)))
  5026. (and org-agenda-todo-ignore-deadlines
  5027. (re-search-forward org-deadline-time-regexp end t)
  5028. (cond
  5029. ((eq org-agenda-todo-ignore-deadlines 'all) t)
  5030. ((eq org-agenda-todo-ignore-deadlines 'far)
  5031. (not (org-deadline-close-p (match-string 1))))
  5032. ((eq org-agenda-todo-ignore-deadlines 'future)
  5033. (> (org-time-stamp-to-now
  5034. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5035. ((eq org-agenda-todo-ignore-deadlines 'past)
  5036. (<= (org-time-stamp-to-now
  5037. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5038. ((numberp org-agenda-todo-ignore-deadlines)
  5039. (org-agenda-todo-custom-ignore-p
  5040. (match-string 1) org-agenda-todo-ignore-deadlines))
  5041. (t (org-deadline-close-p (match-string 1)))))
  5042. (and org-agenda-todo-ignore-timestamp
  5043. (let ((buffer (current-buffer))
  5044. (regexp
  5045. (concat
  5046. org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
  5047. (start (point)))
  5048. ;; Copy current buffer into a temporary one
  5049. (with-temp-buffer
  5050. (insert-buffer-substring buffer start end)
  5051. (goto-char (point-min))
  5052. ;; Delete SCHEDULED and DEADLINE items
  5053. (while (re-search-forward regexp end t)
  5054. (delete-region (match-beginning 0) (match-end 0)))
  5055. (goto-char (point-min))
  5056. ;; No search for timestamp left
  5057. (when (re-search-forward org-ts-regexp nil t)
  5058. (cond
  5059. ((eq org-agenda-todo-ignore-timestamp 'future)
  5060. (> (org-time-stamp-to-now
  5061. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5062. ((eq org-agenda-todo-ignore-timestamp 'past)
  5063. (<= (org-time-stamp-to-now
  5064. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5065. ((numberp org-agenda-todo-ignore-timestamp)
  5066. (org-agenda-todo-custom-ignore-p
  5067. (match-string 1) org-agenda-todo-ignore-timestamp))
  5068. (t))))))))))
  5069. (defun org-agenda-get-timestamps (&optional deadlines)
  5070. "Return the date stamp information for agenda display.
  5071. Optional argument DEADLINES is a list of deadline items to be
  5072. displayed in agenda view."
  5073. (let* ((props (list 'face 'org-agenda-calendar-event
  5074. 'org-not-done-regexp org-not-done-regexp
  5075. 'org-todo-regexp org-todo-regexp
  5076. 'org-complex-heading-regexp org-complex-heading-regexp
  5077. 'mouse-face 'highlight
  5078. 'help-echo
  5079. (format "mouse-2 or RET jump to Org file %s"
  5080. (abbreviate-file-name buffer-file-name))))
  5081. (current (calendar-absolute-from-gregorian date))
  5082. (today (org-today))
  5083. (deadline-position-alist
  5084. (mapcar (lambda (d)
  5085. (let ((m (get-text-property 0 'org-hd-marker d)))
  5086. (and m (marker-position m))))
  5087. deadlines))
  5088. ;; Match time-stamps set to current date, time-stamps with
  5089. ;; a repeater, and S-exp time-stamps.
  5090. (regexp
  5091. (concat
  5092. (if org-agenda-include-inactive-timestamps "[[<]" "<")
  5093. (regexp-quote
  5094. (substring
  5095. (format-time-string
  5096. (car org-time-stamp-formats)
  5097. (encode-time ; DATE bound by calendar
  5098. 0 0 0 (nth 1 date) (car date) (nth 2 date)))
  5099. 1 11))
  5100. "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
  5101. "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
  5102. timestamp-items)
  5103. (goto-char (point-min))
  5104. (while (re-search-forward regexp nil t)
  5105. ;; Skip date ranges, scheduled and deadlines, which are handled
  5106. ;; specially. Also skip time-stamps before first headline as
  5107. ;; there would be no entry to add to the agenda. Eventually,
  5108. ;; ignore clock entries.
  5109. (catch :skip
  5110. (save-match-data
  5111. (when (or (org-at-date-range-p)
  5112. (org-at-planning-p)
  5113. (org-before-first-heading-p)
  5114. (and org-agenda-include-inactive-timestamps
  5115. (org-at-clock-log-p)))
  5116. (throw :skip nil))
  5117. (org-agenda-skip))
  5118. (let* ((pos (match-beginning 0))
  5119. (repeat (match-string 1))
  5120. (sexp-entry (match-string 3))
  5121. (time-stamp (if (or repeat sexp-entry) (match-string 0)
  5122. (save-excursion
  5123. (goto-char pos)
  5124. (looking-at org-ts-regexp-both)
  5125. (match-string 0))))
  5126. (todo-state (org-get-todo-state))
  5127. (warntime (get-text-property (point) 'org-appt-warntime))
  5128. (done? (member todo-state org-done-keywords)))
  5129. ;; Possibly skip done tasks.
  5130. (when (and done? org-agenda-skip-timestamp-if-done)
  5131. (throw :skip t))
  5132. ;; S-exp entry doesn't match current day: skip it.
  5133. (when (and sexp-entry (not (org-diary-sexp-entry sexp-entry "" date)))
  5134. (throw :skip nil))
  5135. (when repeat
  5136. (let* ((past
  5137. ;; A repeating time stamp is shown at its base
  5138. ;; date and every repeated date up to TODAY. If
  5139. ;; `org-agenda-prefer-last-repeat' is non-nil,
  5140. ;; however, only the last repeat before today
  5141. ;; (inclusive) is shown.
  5142. (org-agenda--timestamp-to-absolute
  5143. repeat
  5144. (if (or (> current today)
  5145. (eq org-agenda-prefer-last-repeat t)
  5146. (member todo-state org-agenda-prefer-last-repeat))
  5147. today
  5148. current)
  5149. 'past (current-buffer) pos))
  5150. (future
  5151. ;; Display every repeated date past TODAY
  5152. ;; (exclusive) unless
  5153. ;; `org-agenda-show-future-repeats' is nil. If
  5154. ;; this variable is set to `next', only display
  5155. ;; the first repeated date after TODAY
  5156. ;; (exclusive).
  5157. (cond
  5158. ((<= current today) past)
  5159. ((not org-agenda-show-future-repeats) past)
  5160. (t
  5161. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5162. (1+ today)
  5163. current)))
  5164. (org-agenda--timestamp-to-absolute
  5165. repeat base 'future (current-buffer) pos))))))
  5166. (when (and (/= current past) (/= current future))
  5167. (throw :skip nil))))
  5168. (save-excursion
  5169. (re-search-backward org-outline-regexp-bol nil t)
  5170. ;; Possibly skip time-stamp when a deadline is set.
  5171. (when (and org-agenda-skip-timestamp-if-deadline-is-shown
  5172. (assq (point) deadline-position-alist))
  5173. (throw :skip nil))
  5174. (let* ((category (org-get-category pos))
  5175. (inherited-tags
  5176. (or (eq org-agenda-show-inherited-tags 'always)
  5177. (and (consp org-agenda-show-inherited-tags)
  5178. (memq 'agenda org-agenda-show-inherited-tags))
  5179. (and (eq org-agenda-show-inherited-tags t)
  5180. (or (eq org-agenda-use-tag-inheritance t)
  5181. (memq 'agenda
  5182. org-agenda-use-tag-inheritance)))))
  5183. (tags (org-get-tags nil (not inherited-tags)))
  5184. (level (make-string (org-reduced-level (org-outline-level))
  5185. ?\s))
  5186. (head (and (looking-at "\\*+[ \t]+\\(.*\\)")
  5187. (match-string 1)))
  5188. (inactive? (= (char-after pos) ?\[))
  5189. (habit? (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  5190. (item
  5191. (org-agenda-format-item
  5192. (and inactive? org-agenda-inactive-leader)
  5193. head level category tags time-stamp org-ts-regexp habit?)))
  5194. (org-add-props item props
  5195. 'priority (if habit?
  5196. (org-habit-get-priority (org-habit-parse-todo))
  5197. (org-get-priority item))
  5198. 'org-marker (org-agenda-new-marker pos)
  5199. 'org-hd-marker (org-agenda-new-marker)
  5200. 'date date
  5201. 'level level
  5202. 'ts-date (if repeat (org-agenda--timestamp-to-absolute repeat)
  5203. current)
  5204. 'todo-state todo-state
  5205. 'warntime warntime
  5206. 'type "timestamp")
  5207. (push item timestamp-items))))
  5208. (when org-agenda-skip-additional-timestamps-same-entry
  5209. (outline-next-heading))))
  5210. (nreverse timestamp-items)))
  5211. (defun org-agenda-get-sexps ()
  5212. "Return the sexp information for agenda display."
  5213. (require 'diary-lib)
  5214. (let* ((props (list 'face 'org-agenda-calendar-sexp
  5215. 'mouse-face 'highlight
  5216. 'help-echo
  5217. (format "mouse-2 or RET jump to org file %s"
  5218. (abbreviate-file-name buffer-file-name))))
  5219. (regexp "^&?%%(")
  5220. marker category extra level ee txt tags entry
  5221. result beg b sexp sexp-entry todo-state warntime inherited-tags)
  5222. (goto-char (point-min))
  5223. (while (re-search-forward regexp nil t)
  5224. (catch :skip
  5225. (org-agenda-skip)
  5226. (setq beg (match-beginning 0))
  5227. (goto-char (1- (match-end 0)))
  5228. (setq b (point))
  5229. (forward-sexp 1)
  5230. (setq sexp (buffer-substring b (point)))
  5231. (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
  5232. (org-trim (match-string 1))
  5233. ""))
  5234. (setq result (org-diary-sexp-entry sexp sexp-entry date))
  5235. (when result
  5236. (setq marker (org-agenda-new-marker beg)
  5237. level (make-string (org-reduced-level (org-outline-level)) ? )
  5238. category (org-get-category beg)
  5239. inherited-tags
  5240. (or (eq org-agenda-show-inherited-tags 'always)
  5241. (and (listp org-agenda-show-inherited-tags)
  5242. (memq 'agenda org-agenda-show-inherited-tags))
  5243. (and (eq org-agenda-show-inherited-tags t)
  5244. (or (eq org-agenda-use-tag-inheritance t)
  5245. (memq 'agenda org-agenda-use-tag-inheritance))))
  5246. tags (org-get-tags nil (not inherited-tags))
  5247. todo-state (org-get-todo-state)
  5248. warntime (get-text-property (point) 'org-appt-warntime)
  5249. extra nil)
  5250. (dolist (r (if (stringp result)
  5251. (list result)
  5252. result)) ;; we expect a list here
  5253. (when (and org-agenda-diary-sexp-prefix
  5254. (string-match org-agenda-diary-sexp-prefix r))
  5255. (setq extra (match-string 0 r)
  5256. r (replace-match "" nil nil r)))
  5257. (if (string-match "\\S-" r)
  5258. (setq txt r)
  5259. (setq txt "SEXP entry returned empty string"))
  5260. (setq txt (org-agenda-format-item extra txt level category tags 'time))
  5261. (org-add-props txt props 'org-marker marker
  5262. 'date date 'todo-state todo-state
  5263. 'level level 'type "sexp" 'warntime warntime)
  5264. (push txt ee)))))
  5265. (nreverse ee)))
  5266. ;; Calendar sanity: define some functions that are independent of
  5267. ;; `calendar-date-style'.
  5268. (defun org-anniversary (year month day &optional mark)
  5269. "Like `diary-anniversary', but with fixed (ISO) order of arguments."
  5270. (with-no-warnings
  5271. (let ((calendar-date-style 'iso))
  5272. (diary-anniversary year month day mark))))
  5273. (defun org-cyclic (N year month day &optional mark)
  5274. "Like `diary-cyclic', but with fixed (ISO) order of arguments."
  5275. (with-no-warnings
  5276. (let ((calendar-date-style 'iso))
  5277. (diary-cyclic N year month day mark))))
  5278. (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
  5279. "Like `diary-block', but with fixed (ISO) order of arguments."
  5280. (with-no-warnings
  5281. (let ((calendar-date-style 'iso))
  5282. (diary-block Y1 M1 D1 Y2 M2 D2 mark))))
  5283. (defun org-date (year month day &optional mark)
  5284. "Like `diary-date', but with fixed (ISO) order of arguments."
  5285. (with-no-warnings
  5286. (let ((calendar-date-style 'iso))
  5287. (diary-date year month day mark))))
  5288. ;; Define the `org-class' function
  5289. (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
  5290. "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
  5291. DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
  5292. SKIP-WEEKS is any number of ISO weeks in the block period for which the
  5293. item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
  5294. `holidays', then any date that is known by the Emacs calendar to be a
  5295. holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
  5296. then those holidays will be skipped."
  5297. (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
  5298. (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
  5299. (d (calendar-absolute-from-gregorian date))
  5300. (h (when skip-weeks (calendar-check-holidays date))))
  5301. (and
  5302. (<= date1 d)
  5303. (<= d date2)
  5304. (= (calendar-day-of-week date) dayname)
  5305. (or (not skip-weeks)
  5306. (progn
  5307. (require 'cal-iso)
  5308. (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
  5309. (not (or (and h (memq 'holidays skip-weeks))
  5310. (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
  5311. entry)))
  5312. (defalias 'org-get-closed 'org-agenda-get-progress)
  5313. (defun org-agenda-get-progress ()
  5314. "Return the logged TODO entries for agenda display."
  5315. (let* ((props (list 'mouse-face 'highlight
  5316. 'org-not-done-regexp org-not-done-regexp
  5317. 'org-todo-regexp org-todo-regexp
  5318. 'org-complex-heading-regexp org-complex-heading-regexp
  5319. 'help-echo
  5320. (format "mouse-2 or RET jump to org file %s"
  5321. (abbreviate-file-name buffer-file-name))))
  5322. (items (if (consp org-agenda-show-log-scoped)
  5323. org-agenda-show-log-scoped
  5324. (if (eq org-agenda-show-log-scoped 'clockcheck)
  5325. '(clock)
  5326. org-agenda-log-mode-items)))
  5327. (parts
  5328. (delq nil
  5329. (list
  5330. (when (memq 'closed items) (concat "\\<" org-closed-string))
  5331. (when (memq 'clock items) (concat "\\<" org-clock-string))
  5332. (when (memq 'state items)
  5333. (format "- +State \"%s\".*?" org-todo-regexp)))))
  5334. (parts-re (if parts (mapconcat 'identity parts "\\|")
  5335. (error "`org-agenda-log-mode-items' is empty")))
  5336. (regexp (concat
  5337. "\\(" parts-re "\\)"
  5338. " *\\["
  5339. (regexp-quote
  5340. (substring
  5341. (format-time-string
  5342. (car org-time-stamp-formats)
  5343. (encode-time ; DATE bound by calendar
  5344. 0 0 0 (nth 1 date) (car date) (nth 2 date)))
  5345. 1 11))))
  5346. (org-agenda-search-headline-for-time nil)
  5347. marker hdmarker priority category level tags closedp type
  5348. statep clockp state ee txt extra timestr rest clocked inherited-tags)
  5349. (goto-char (point-min))
  5350. (while (re-search-forward regexp nil t)
  5351. (catch :skip
  5352. (org-agenda-skip)
  5353. (setq marker (org-agenda-new-marker (match-beginning 0))
  5354. closedp (equal (match-string 1) org-closed-string)
  5355. statep (equal (string-to-char (match-string 1)) ?-)
  5356. clockp (not (or closedp statep))
  5357. state (and statep (match-string 2))
  5358. category (org-get-category (match-beginning 0))
  5359. timestr (buffer-substring (match-beginning 0) (point-at-eol)))
  5360. (when (string-match "\\]" timestr)
  5361. ;; substring should only run to end of time stamp
  5362. (setq rest (substring timestr (match-end 0))
  5363. timestr (substring timestr 0 (match-end 0)))
  5364. (if (and (not closedp) (not statep)
  5365. (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
  5366. rest))
  5367. (progn (setq timestr (concat (substring timestr 0 -1)
  5368. "-" (match-string 1 rest) "]"))
  5369. (setq clocked (match-string 2 rest)))
  5370. (setq clocked "-")))
  5371. (save-excursion
  5372. (setq extra
  5373. (cond
  5374. ((not org-agenda-log-mode-add-notes) nil)
  5375. (statep
  5376. (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
  5377. (match-string 1)))
  5378. (clockp
  5379. (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
  5380. (match-string 1)))))
  5381. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5382. (throw :skip nil)
  5383. (goto-char (match-beginning 0))
  5384. (setq hdmarker (org-agenda-new-marker)
  5385. inherited-tags
  5386. (or (eq org-agenda-show-inherited-tags 'always)
  5387. (and (listp org-agenda-show-inherited-tags)
  5388. (memq 'todo org-agenda-show-inherited-tags))
  5389. (and (eq org-agenda-show-inherited-tags t)
  5390. (or (eq org-agenda-use-tag-inheritance t)
  5391. (memq 'todo org-agenda-use-tag-inheritance))))
  5392. tags (org-get-tags nil (not inherited-tags))
  5393. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5394. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5395. (setq txt (match-string 1))
  5396. (when extra
  5397. (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
  5398. (setq txt (concat (substring txt 0 (match-beginning 1))
  5399. " - " extra " " (match-string 2 txt)))
  5400. (setq txt (concat txt " - " extra))))
  5401. (setq txt (org-agenda-format-item
  5402. (cond
  5403. (closedp "Closed: ")
  5404. (statep (concat "State: (" state ")"))
  5405. (t (concat "Clocked: (" clocked ")")))
  5406. txt level category tags timestr)))
  5407. (setq type (cond (closedp "closed")
  5408. (statep "state")
  5409. (t "clock")))
  5410. (setq priority 100000)
  5411. (org-add-props txt props
  5412. 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
  5413. 'priority priority 'level level
  5414. 'type type 'date date
  5415. 'undone-face 'org-warning 'done-face 'org-agenda-done)
  5416. (push txt ee))
  5417. (goto-char (point-at-eol))))
  5418. (nreverse ee)))
  5419. (defun org-agenda-show-clocking-issues ()
  5420. "Add overlays, showing issues with clocking.
  5421. See also the user option `org-agenda-clock-consistency-checks'."
  5422. (interactive)
  5423. (let* ((pl org-agenda-clock-consistency-checks)
  5424. (re (concat "^[ \t]*"
  5425. org-clock-string
  5426. "[ \t]+"
  5427. "\\(\\[.*?\\]\\)" ; group 1 is first stamp
  5428. "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
  5429. (tlstart 0.)
  5430. (tlend 0.)
  5431. (maxtime (org-duration-to-minutes
  5432. (or (plist-get pl :max-duration) "24:00")))
  5433. (mintime (org-duration-to-minutes
  5434. (or (plist-get pl :min-duration) 0)))
  5435. (maxgap (org-duration-to-minutes
  5436. ;; default 30:00 means never complain
  5437. (or (plist-get pl :max-gap) "30:00")))
  5438. (gapok (mapcar #'org-duration-to-minutes
  5439. (plist-get pl :gap-ok-around)))
  5440. (def-face (or (plist-get pl :default-face)
  5441. '((:background "DarkRed") (:foreground "white"))))
  5442. issue face m te ts dt ov)
  5443. (goto-char (point-min))
  5444. (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
  5445. (setq issue nil face def-face)
  5446. (catch 'next
  5447. (setq m (org-get-at-bol 'org-marker)
  5448. te nil ts nil)
  5449. (unless (and m (markerp m))
  5450. (setq issue "No valid clock line") (throw 'next t))
  5451. (org-with-point-at m
  5452. (save-excursion
  5453. (goto-char (point-at-bol))
  5454. (unless (looking-at re)
  5455. (error "No valid Clock line")
  5456. (throw 'next t))
  5457. (unless (match-end 3)
  5458. (setq issue
  5459. (format
  5460. "No end time: (%s)"
  5461. (org-duration-from-minutes
  5462. (floor
  5463. (- (float-time (org-current-time))
  5464. (float-time (org-time-string-to-time (match-string 1))))
  5465. 60)))
  5466. face (or (plist-get pl :no-end-time-face) face))
  5467. (throw 'next t))
  5468. (setq ts (match-string 1)
  5469. te (match-string 3)
  5470. ts (float-time (org-time-string-to-time ts))
  5471. te (float-time (org-time-string-to-time te))
  5472. dt (- te ts))))
  5473. (cond
  5474. ((> dt (* 60 maxtime))
  5475. ;; a very long clocking chunk
  5476. (setq issue (format "Clocking interval is very long: %s"
  5477. (org-duration-from-minutes (floor dt 60)))
  5478. face (or (plist-get pl :long-face) face)))
  5479. ((< dt (* 60 mintime))
  5480. ;; a very short clocking chunk
  5481. (setq issue (format "Clocking interval is very short: %s"
  5482. (org-duration-from-minutes (floor dt 60)))
  5483. face (or (plist-get pl :short-face) face)))
  5484. ((and (> tlend 0) (< ts tlend))
  5485. ;; Two clock entries are overlapping
  5486. (setq issue (format "Clocking overlap: %d minutes"
  5487. (/ (- tlend ts) 60))
  5488. face (or (plist-get pl :overlap-face) face)))
  5489. ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
  5490. ;; There is a gap, lets see if we need to report it
  5491. (unless (org-agenda-check-clock-gap tlend ts gapok)
  5492. (setq issue (format "Clocking gap: %d minutes"
  5493. (/ (- ts tlend) 60))
  5494. face (or (plist-get pl :gap-face) face))))
  5495. (t nil)))
  5496. (setq tlend (or te tlend) tlstart (or ts tlstart))
  5497. (when issue
  5498. ;; OK, there was some issue, add an overlay to show the issue
  5499. (setq ov (make-overlay (point-at-bol) (point-at-eol)))
  5500. (overlay-put ov 'before-string
  5501. (concat
  5502. (org-add-props
  5503. (format "%-43s" (concat " " issue))
  5504. nil
  5505. 'face face)
  5506. "\n"))
  5507. (overlay-put ov 'evaporate t)))))
  5508. (defun org-agenda-check-clock-gap (t1 t2 ok-list)
  5509. "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
  5510. (catch 'exit
  5511. (unless ok-list
  5512. ;; there are no OK times for gaps...
  5513. (throw 'exit nil))
  5514. (when (> (- (/ t2 36000) (/ t1 36000)) 24)
  5515. ;; This is more than 24 hours, so it is OK.
  5516. ;; because we have at least one OK time, that must be in the
  5517. ;; 24 hour interval.
  5518. (throw 'exit t))
  5519. ;; We have a shorter gap.
  5520. ;; Now we have to get the minute of the day when these times are
  5521. (let* ((t1dec (org-decode-time t1))
  5522. (t2dec (org-decode-time t2))
  5523. ;; compute the minute on the day
  5524. (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
  5525. (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
  5526. (when (< min2 min1)
  5527. ;; if min2 is smaller than min1, this means it is on the next day.
  5528. ;; Wrap it to after midnight.
  5529. (setq min2 (+ min2 1440)))
  5530. ;; Now check if any of the OK times is in the gap
  5531. (mapc (lambda (x)
  5532. ;; Wrap the time to after midnight if necessary
  5533. (when (< x min1) (setq x (+ x 1440)))
  5534. ;; Check if in interval
  5535. (and (<= min1 x) (>= min2 x) (throw 'exit t)))
  5536. ok-list)
  5537. ;; Nope, this gap is not OK
  5538. nil)))
  5539. (defun org-agenda-get-deadlines (&optional with-hour)
  5540. "Return the deadline information for agenda display.
  5541. When WITH-HOUR is non-nil, only return deadlines with an hour
  5542. specification like [h]h:mm."
  5543. (let* ((props (list 'mouse-face 'highlight
  5544. 'org-not-done-regexp org-not-done-regexp
  5545. 'org-todo-regexp org-todo-regexp
  5546. 'org-complex-heading-regexp org-complex-heading-regexp
  5547. 'help-echo
  5548. (format "mouse-2 or RET jump to org file %s"
  5549. (abbreviate-file-name buffer-file-name))))
  5550. (regexp (if with-hour
  5551. org-deadline-time-hour-regexp
  5552. org-deadline-time-regexp))
  5553. (today (org-today))
  5554. (today? (org-agenda-today-p date)) ; DATE bound by calendar.
  5555. (current (calendar-absolute-from-gregorian date))
  5556. deadline-items)
  5557. (goto-char (point-min))
  5558. (while (re-search-forward regexp nil t)
  5559. (catch :skip
  5560. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5561. (org-agenda-skip)
  5562. (let* ((s (match-string 1))
  5563. (pos (1- (match-beginning 1)))
  5564. (todo-state (save-match-data (org-get-todo-state)))
  5565. (done? (member todo-state org-done-keywords))
  5566. (sexp? (string-prefix-p "%%" s))
  5567. ;; DEADLINE is the deadline date for the entry. It is
  5568. ;; either the base date or the last repeat, according
  5569. ;; to `org-agenda-prefer-last-repeat'.
  5570. (deadline
  5571. (cond
  5572. (sexp? (org-agenda--timestamp-to-absolute s current))
  5573. ((or (eq org-agenda-prefer-last-repeat t)
  5574. (member todo-state org-agenda-prefer-last-repeat))
  5575. (org-agenda--timestamp-to-absolute
  5576. s today 'past (current-buffer) pos))
  5577. (t (org-agenda--timestamp-to-absolute s))))
  5578. ;; REPEAT is the future repeat closest from CURRENT,
  5579. ;; according to `org-agenda-show-future-repeats'. If
  5580. ;; the latter is nil, or if the time stamp has no
  5581. ;; repeat part, default to DEADLINE.
  5582. (repeat
  5583. (cond
  5584. (sexp? deadline)
  5585. ((<= current today) deadline)
  5586. ((not org-agenda-show-future-repeats) deadline)
  5587. (t
  5588. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5589. (1+ today)
  5590. current)))
  5591. (org-agenda--timestamp-to-absolute
  5592. s base 'future (current-buffer) pos)))))
  5593. (diff (- deadline current))
  5594. (suppress-prewarning
  5595. (let ((scheduled
  5596. (and org-agenda-skip-deadline-prewarning-if-scheduled
  5597. (org-entry-get nil "SCHEDULED"))))
  5598. (cond
  5599. ((not scheduled) nil)
  5600. ;; The current item has a scheduled date, so
  5601. ;; evaluate its prewarning lead time.
  5602. ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
  5603. ;; Use global prewarning-restart lead time.
  5604. org-agenda-skip-deadline-prewarning-if-scheduled)
  5605. ((eq org-agenda-skip-deadline-prewarning-if-scheduled
  5606. 'pre-scheduled)
  5607. ;; Set pre-warning to no earlier than SCHEDULED.
  5608. (min (- deadline
  5609. (org-agenda--timestamp-to-absolute scheduled))
  5610. org-deadline-warning-days))
  5611. ;; Set pre-warning to deadline.
  5612. (t 0))))
  5613. (wdays (or suppress-prewarning (org-get-wdays s))))
  5614. (cond
  5615. ;; Only display deadlines at their base date, at future
  5616. ;; repeat occurrences or in today agenda.
  5617. ((= current deadline) nil)
  5618. ((= current repeat) nil)
  5619. ((not today?) (throw :skip nil))
  5620. ;; Upcoming deadline: display within warning period WDAYS.
  5621. ((> deadline current) (when (> diff wdays) (throw :skip nil)))
  5622. ;; Overdue deadline: warn about it for
  5623. ;; `org-deadline-past-days' duration.
  5624. (t (when (< org-deadline-past-days (- diff)) (throw :skip nil))))
  5625. ;; Possibly skip done tasks.
  5626. (when (and done?
  5627. (or org-agenda-skip-deadline-if-done
  5628. (/= deadline current)))
  5629. (throw :skip nil))
  5630. (save-excursion
  5631. (re-search-backward "^\\*+[ \t]+" nil t)
  5632. (goto-char (match-end 0))
  5633. (let* ((category (org-get-category))
  5634. (level (make-string (org-reduced-level (org-outline-level))
  5635. ?\s))
  5636. (head (buffer-substring (point) (line-end-position)))
  5637. (inherited-tags
  5638. (or (eq org-agenda-show-inherited-tags 'always)
  5639. (and (listp org-agenda-show-inherited-tags)
  5640. (memq 'agenda org-agenda-show-inherited-tags))
  5641. (and (eq org-agenda-show-inherited-tags t)
  5642. (or (eq org-agenda-use-tag-inheritance t)
  5643. (memq 'agenda
  5644. org-agenda-use-tag-inheritance)))))
  5645. (tags (org-get-tags nil (not inherited-tags)))
  5646. (time
  5647. (cond
  5648. ;; No time of day designation if it is only
  5649. ;; a reminder.
  5650. ((and (/= current deadline) (/= current repeat)) nil)
  5651. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5652. (concat (substring s (match-beginning 1)) " "))
  5653. (t 'time)))
  5654. (item
  5655. (org-agenda-format-item
  5656. ;; Insert appropriate suffixes before deadlines.
  5657. ;; Those only apply to today agenda.
  5658. (pcase-let ((`(,now ,future ,past)
  5659. org-agenda-deadline-leaders))
  5660. (cond
  5661. ((and today? (< deadline today)) (format past (- diff)))
  5662. ((and today? (> deadline today)) (format future diff))
  5663. (t now)))
  5664. head level category tags time))
  5665. (face (org-agenda-deadline-face
  5666. (- 1 (/ (float diff) (max wdays 1)))))
  5667. (upcoming? (and today? (> deadline today)))
  5668. (warntime (get-text-property (point) 'org-appt-warntime)))
  5669. (org-add-props item props
  5670. 'org-marker (org-agenda-new-marker pos)
  5671. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  5672. 'warntime warntime
  5673. 'level level
  5674. 'ts-date deadline
  5675. 'priority
  5676. ;; Adjust priority to today reminders about deadlines.
  5677. ;; Overdue deadlines get the highest priority
  5678. ;; increase, then imminent deadlines and eventually
  5679. ;; more distant deadlines.
  5680. (let ((adjust (if today? (- diff) 0)))
  5681. (+ adjust (org-get-priority item)))
  5682. 'todo-state todo-state
  5683. 'type (if upcoming? "upcoming-deadline" "deadline")
  5684. 'date (if upcoming? date deadline)
  5685. 'face (if done? 'org-agenda-done face)
  5686. 'undone-face face
  5687. 'done-face 'org-agenda-done)
  5688. (push item deadline-items))))))
  5689. (nreverse deadline-items)))
  5690. (defun org-agenda-deadline-face (fraction)
  5691. "Return the face to displaying a deadline item.
  5692. FRACTION is what fraction of the head-warning time has passed."
  5693. (assoc-default fraction org-agenda-deadline-faces #'<=))
  5694. (defun org-agenda-get-scheduled (&optional deadlines with-hour)
  5695. "Return the scheduled information for agenda display.
  5696. Optional argument DEADLINES is a list of deadline items to be
  5697. displayed in agenda view. When WITH-HOUR is non-nil, only return
  5698. scheduled items with an hour specification like [h]h:mm."
  5699. (let* ((props (list 'org-not-done-regexp org-not-done-regexp
  5700. 'org-todo-regexp org-todo-regexp
  5701. 'org-complex-heading-regexp org-complex-heading-regexp
  5702. 'done-face 'org-agenda-done
  5703. 'mouse-face 'highlight
  5704. 'help-echo
  5705. (format "mouse-2 or RET jump to Org file %s"
  5706. (abbreviate-file-name buffer-file-name))))
  5707. (regexp (if with-hour
  5708. org-scheduled-time-hour-regexp
  5709. org-scheduled-time-regexp))
  5710. (today (org-today))
  5711. (todayp (org-agenda-today-p date)) ; DATE bound by calendar.
  5712. (current (calendar-absolute-from-gregorian date))
  5713. (deadline-pos
  5714. (mapcar (lambda (d)
  5715. (let ((m (get-text-property 0 'org-hd-marker d)))
  5716. (and m (marker-position m))))
  5717. deadlines))
  5718. scheduled-items)
  5719. (goto-char (point-min))
  5720. (while (re-search-forward regexp nil t)
  5721. (catch :skip
  5722. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5723. (org-agenda-skip)
  5724. (let* ((s (match-string 1))
  5725. (pos (1- (match-beginning 1)))
  5726. (todo-state (save-match-data (org-get-todo-state)))
  5727. (donep (member todo-state org-done-keywords))
  5728. (sexp? (string-prefix-p "%%" s))
  5729. ;; SCHEDULE is the scheduled date for the entry. It is
  5730. ;; either the bare date or the last repeat, according
  5731. ;; to `org-agenda-prefer-last-repeat'.
  5732. (schedule
  5733. (cond
  5734. (sexp? (org-agenda--timestamp-to-absolute s current))
  5735. ((or (eq org-agenda-prefer-last-repeat t)
  5736. (member todo-state org-agenda-prefer-last-repeat))
  5737. (org-agenda--timestamp-to-absolute
  5738. s today 'past (current-buffer) pos))
  5739. (t (org-agenda--timestamp-to-absolute s))))
  5740. ;; REPEAT is the future repeat closest from CURRENT,
  5741. ;; according to `org-agenda-show-future-repeats'. If
  5742. ;; the latter is nil, or if the time stamp has no
  5743. ;; repeat part, default to SCHEDULE.
  5744. (repeat
  5745. (cond
  5746. (sexp? schedule)
  5747. ((<= current today) schedule)
  5748. ((not org-agenda-show-future-repeats) schedule)
  5749. (t
  5750. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5751. (1+ today)
  5752. current)))
  5753. (org-agenda--timestamp-to-absolute
  5754. s base 'future (current-buffer) pos)))))
  5755. (diff (- current schedule))
  5756. (warntime (get-text-property (point) 'org-appt-warntime))
  5757. (pastschedp (< schedule today))
  5758. (futureschedp (> schedule today))
  5759. (habitp (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  5760. (suppress-delay
  5761. (let ((deadline (and org-agenda-skip-scheduled-delay-if-deadline
  5762. (org-entry-get nil "DEADLINE"))))
  5763. (cond
  5764. ((not deadline) nil)
  5765. ;; The current item has a deadline date, so
  5766. ;; evaluate its delay time.
  5767. ((integerp org-agenda-skip-scheduled-delay-if-deadline)
  5768. ;; Use global delay time.
  5769. (- org-agenda-skip-scheduled-delay-if-deadline))
  5770. ((eq org-agenda-skip-scheduled-delay-if-deadline
  5771. 'post-deadline)
  5772. ;; Set delay to no later than DEADLINE.
  5773. (min (- schedule
  5774. (org-agenda--timestamp-to-absolute deadline))
  5775. org-scheduled-delay-days))
  5776. (t 0))))
  5777. (ddays
  5778. (cond
  5779. ;; Nullify delay when a repeater triggered already
  5780. ;; and the delay is of the form --Xd.
  5781. ((and (string-match-p "--[0-9]+[hdwmy]" s)
  5782. (> schedule (org-agenda--timestamp-to-absolute s)))
  5783. 0)
  5784. (suppress-delay
  5785. (let ((org-scheduled-delay-days suppress-delay))
  5786. (org-get-wdays s t t)))
  5787. (t (org-get-wdays s t)))))
  5788. ;; Display scheduled items at base date (SCHEDULE), today if
  5789. ;; scheduled before the current date, and at any repeat past
  5790. ;; today. However, skip delayed items and items that have
  5791. ;; been displayed for more than `org-scheduled-past-days'.
  5792. (unless (and todayp
  5793. habitp
  5794. (bound-and-true-p org-habit-show-all-today))
  5795. (when (or (and (> ddays 0) (< diff ddays))
  5796. (> diff (or (and habitp org-habit-scheduled-past-days)
  5797. org-scheduled-past-days))
  5798. (> schedule current)
  5799. (and (/= current schedule)
  5800. (/= current today)
  5801. (/= current repeat)))
  5802. (throw :skip nil)))
  5803. ;; Possibly skip done tasks.
  5804. (when (and donep
  5805. (or org-agenda-skip-scheduled-if-done
  5806. (/= schedule current)))
  5807. (throw :skip nil))
  5808. ;; Skip entry if it already appears as a deadline, per
  5809. ;; `org-agenda-skip-scheduled-if-deadline-is-shown'. This
  5810. ;; doesn't apply to habits.
  5811. (when (pcase org-agenda-skip-scheduled-if-deadline-is-shown
  5812. ((guard
  5813. (or (not (memq (line-beginning-position 0) deadline-pos))
  5814. habitp))
  5815. nil)
  5816. (`repeated-after-deadline
  5817. (let ((deadline (time-to-days
  5818. (org-get-deadline-time (point)))))
  5819. (and (<= schedule deadline) (> current deadline))))
  5820. (`not-today pastschedp)
  5821. (`t t)
  5822. (_ nil))
  5823. (throw :skip nil))
  5824. ;; Skip habits if `org-habit-show-habits' is nil, or if we
  5825. ;; only show them for today. Also skip done habits.
  5826. (when (and habitp
  5827. (or donep
  5828. (not (bound-and-true-p org-habit-show-habits))
  5829. (and (not todayp)
  5830. (bound-and-true-p
  5831. org-habit-show-habits-only-for-today))))
  5832. (throw :skip nil))
  5833. (save-excursion
  5834. (re-search-backward "^\\*+[ \t]+" nil t)
  5835. (goto-char (match-end 0))
  5836. (let* ((category (org-get-category))
  5837. (inherited-tags
  5838. (or (eq org-agenda-show-inherited-tags 'always)
  5839. (and (listp org-agenda-show-inherited-tags)
  5840. (memq 'agenda org-agenda-show-inherited-tags))
  5841. (and (eq org-agenda-show-inherited-tags t)
  5842. (or (eq org-agenda-use-tag-inheritance t)
  5843. (memq 'agenda
  5844. org-agenda-use-tag-inheritance)))))
  5845. (tags (org-get-tags nil (not inherited-tags)))
  5846. (level (make-string (org-reduced-level (org-outline-level))
  5847. ?\s))
  5848. (head (buffer-substring (point) (line-end-position)))
  5849. (time
  5850. (cond
  5851. ;; No time of day designation if it is only a
  5852. ;; reminder, except for habits, which always show
  5853. ;; the time of day. Habits are an exception
  5854. ;; because if there is a time of day, that is
  5855. ;; interpreted to mean they should usually happen
  5856. ;; then, even if doing the habit was missed.
  5857. ((and
  5858. (not habitp)
  5859. (/= current schedule)
  5860. (/= current repeat))
  5861. nil)
  5862. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5863. (concat (substring s (match-beginning 1)) " "))
  5864. (t 'time)))
  5865. (item
  5866. (org-agenda-format-item
  5867. (pcase-let ((`(,first ,past) org-agenda-scheduled-leaders))
  5868. ;; Show a reminder of a past scheduled today.
  5869. (if (and todayp pastschedp)
  5870. (format past diff)
  5871. first))
  5872. head level category tags time nil habitp))
  5873. (face (cond ((and (not habitp) pastschedp)
  5874. 'org-scheduled-previously)
  5875. ((and habitp futureschedp)
  5876. 'org-agenda-done)
  5877. (todayp 'org-scheduled-today)
  5878. (t 'org-scheduled)))
  5879. (habitp (and habitp (org-habit-parse-todo))))
  5880. (org-add-props item props
  5881. 'undone-face face
  5882. 'face (if donep 'org-agenda-done face)
  5883. 'org-marker (org-agenda-new-marker pos)
  5884. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  5885. 'type (if pastschedp "past-scheduled" "scheduled")
  5886. 'date (if pastschedp schedule date)
  5887. 'ts-date schedule
  5888. 'warntime warntime
  5889. 'level level
  5890. 'priority (if habitp (org-habit-get-priority habitp)
  5891. (+ 99 diff (org-get-priority item)))
  5892. 'org-habit-p habitp
  5893. 'todo-state todo-state)
  5894. (push item scheduled-items))))))
  5895. (nreverse scheduled-items)))
  5896. (defun org-agenda-get-blocks ()
  5897. "Return the date-range information for agenda display."
  5898. (let* ((props (list 'face nil
  5899. 'org-not-done-regexp org-not-done-regexp
  5900. 'org-todo-regexp org-todo-regexp
  5901. 'org-complex-heading-regexp org-complex-heading-regexp
  5902. 'mouse-face 'highlight
  5903. 'help-echo
  5904. (format "mouse-2 or RET jump to org file %s"
  5905. (abbreviate-file-name buffer-file-name))))
  5906. (regexp org-tr-regexp)
  5907. (d0 (calendar-absolute-from-gregorian date))
  5908. marker hdmarker ee txt d1 d2 s1 s2 category
  5909. level todo-state tags pos head donep inherited-tags)
  5910. (goto-char (point-min))
  5911. (while (re-search-forward regexp nil t)
  5912. (catch :skip
  5913. (org-agenda-skip)
  5914. (setq pos (point))
  5915. (let ((start-time (match-string 1))
  5916. (end-time (match-string 2)))
  5917. (setq s1 (match-string 1)
  5918. s2 (match-string 2)
  5919. d1 (time-to-days
  5920. (condition-case err
  5921. (org-time-string-to-time s1)
  5922. (error
  5923. (error
  5924. "Bad timestamp %S at %d in buffer %S\nError was: %s"
  5925. s1
  5926. pos
  5927. (current-buffer)
  5928. (error-message-string err)))))
  5929. d2 (time-to-days
  5930. (condition-case err
  5931. (org-time-string-to-time s2)
  5932. (error
  5933. (error
  5934. "Bad timestamp %S at %d in buffer %S\nError was: %s"
  5935. s2
  5936. pos
  5937. (current-buffer)
  5938. (error-message-string err))))))
  5939. (when (and (> (- d0 d1) -1) (> (- d2 d0) -1))
  5940. ;; Only allow days between the limits, because the normal
  5941. ;; date stamps will catch the limits.
  5942. (save-excursion
  5943. (setq todo-state (org-get-todo-state))
  5944. (setq donep (member todo-state org-done-keywords))
  5945. (when (and donep org-agenda-skip-timestamp-if-done)
  5946. (throw :skip t))
  5947. (setq marker (org-agenda-new-marker (point))
  5948. category (org-get-category))
  5949. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5950. (throw :skip nil)
  5951. (goto-char (match-beginning 0))
  5952. (setq hdmarker (org-agenda-new-marker (point))
  5953. inherited-tags
  5954. (or (eq org-agenda-show-inherited-tags 'always)
  5955. (and (listp org-agenda-show-inherited-tags)
  5956. (memq 'agenda org-agenda-show-inherited-tags))
  5957. (and (eq org-agenda-show-inherited-tags t)
  5958. (or (eq org-agenda-use-tag-inheritance t)
  5959. (memq 'agenda org-agenda-use-tag-inheritance))))
  5960. tags (org-get-tags nil (not inherited-tags)))
  5961. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  5962. (looking-at "\\*+[ \t]+\\(.*\\)")
  5963. (setq head (match-string 1))
  5964. (let ((remove-re
  5965. (if org-agenda-remove-timeranges-from-blocks
  5966. (concat
  5967. "<" (regexp-quote s1) ".*?>"
  5968. "--"
  5969. "<" (regexp-quote s2) ".*?>")
  5970. nil)))
  5971. (setq txt (org-agenda-format-item
  5972. (format
  5973. (nth (if (= d1 d2) 0 1)
  5974. org-agenda-timerange-leaders)
  5975. (1+ (- d0 d1)) (1+ (- d2 d1)))
  5976. head level category tags
  5977. (cond ((and (= d1 d0) (= d2 d0))
  5978. (concat "<" start-time ">--<" end-time ">"))
  5979. ((= d1 d0)
  5980. (concat "<" start-time ">"))
  5981. ((= d2 d0)
  5982. (concat "<" end-time ">")))
  5983. remove-re))))
  5984. (org-add-props txt props
  5985. 'org-marker marker 'org-hd-marker hdmarker
  5986. 'type "block" 'date date
  5987. 'level level
  5988. 'todo-state todo-state
  5989. 'priority (org-get-priority txt))
  5990. (push txt ee))))
  5991. (goto-char pos)))
  5992. ;; Sort the entries by expiration date.
  5993. (nreverse ee)))
  5994. ;;; Agenda presentation and sorting
  5995. (defvar org-prefix-has-time nil
  5996. "A flag, set by `org-compile-prefix-format'.
  5997. The flag is set if the currently compiled format contains a `%t'.")
  5998. (defvar org-prefix-has-tag nil
  5999. "A flag, set by `org-compile-prefix-format'.
  6000. The flag is set if the currently compiled format contains a `%T'.")
  6001. (defvar org-prefix-has-effort nil
  6002. "A flag, set by `org-compile-prefix-format'.
  6003. The flag is set if the currently compiled format contains a `%e'.")
  6004. (defvar org-prefix-has-breadcrumbs nil
  6005. "A flag, set by `org-compile-prefix-format'.
  6006. The flag is set if the currently compiled format contains a `%b'.")
  6007. (defvar org-prefix-category-length nil
  6008. "Used by `org-compile-prefix-format' to remember the category field width.")
  6009. (defvar org-prefix-category-max-length nil
  6010. "Used by `org-compile-prefix-format' to remember the category field width.")
  6011. (defun org-agenda-get-category-icon (category)
  6012. "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
  6013. (cl-dolist (entry org-agenda-category-icon-alist)
  6014. (when (string-match-p (car entry) category)
  6015. (if (listp (cadr entry))
  6016. (cl-return (cadr entry))
  6017. (cl-return (apply #'create-image (cdr entry)))))))
  6018. (defun org-agenda-format-item (extra txt &optional level category tags dotime
  6019. remove-re habitp)
  6020. "Format TXT to be inserted into the agenda buffer.
  6021. In particular, add the prefix and corresponding text properties.
  6022. EXTRA must be a string to replace the `%s' specifier in the prefix format.
  6023. LEVEL may be a string to replace the `%l' specifier.
  6024. CATEGORY (a string, a symbol or nil) may be used to overrule the default
  6025. category taken from local variable or file name. It will replace the `%c'
  6026. specifier in the format.
  6027. DOTIME, when non-nil, indicates that a time-of-day should be extracted from
  6028. TXT for sorting of this entry, and for the `%t' specifier in the format.
  6029. When DOTIME is a string, this string is searched for a time before TXT is.
  6030. TAGS can be the tags of the headline.
  6031. Any match of REMOVE-RE will be removed from TXT."
  6032. ;; We keep the org-prefix-* variable values along with a compiled
  6033. ;; formatter, so that multiple agendas existing at the same time do
  6034. ;; not step on each other toes.
  6035. ;;
  6036. ;; It was inconvenient to make these variables buffer local in
  6037. ;; Agenda buffers, because this function expects to be called with
  6038. ;; the buffer where item comes from being current, and not agenda
  6039. ;; buffer
  6040. (let* ((bindings (car org-prefix-format-compiled))
  6041. (formatter (cadr org-prefix-format-compiled)))
  6042. (cl-loop for (var value) in bindings
  6043. do (set var value))
  6044. (save-match-data
  6045. ;; Diary entries sometimes have extra whitespace at the beginning
  6046. (setq txt (org-trim txt))
  6047. ;; Fix the tags part in txt
  6048. (setq txt (org-agenda-fix-displayed-tags
  6049. txt tags
  6050. org-agenda-show-inherited-tags
  6051. org-agenda-hide-tags-regexp))
  6052. (let* ((category (or category
  6053. (if buffer-file-name
  6054. (file-name-sans-extension
  6055. (file-name-nondirectory buffer-file-name))
  6056. "")))
  6057. (category-icon (org-agenda-get-category-icon category))
  6058. (category-icon (if category-icon
  6059. (propertize " " 'display category-icon)
  6060. ""))
  6061. (effort (and (not (string= txt ""))
  6062. (get-text-property 1 'effort txt)))
  6063. ;; time, tag, effort are needed for the eval of the prefix format
  6064. (tag (if tags (nth (1- (length tags)) tags) ""))
  6065. (time-grid-trailing-characters (nth 2 org-agenda-time-grid))
  6066. time
  6067. (ts (when dotime (concat
  6068. (if (stringp dotime) dotime "")
  6069. (and org-agenda-search-headline-for-time txt))))
  6070. (time-of-day (and dotime (org-get-time-of-day ts)))
  6071. stamp plain s0 s1 s2 rtn srp l
  6072. duration breadcrumbs)
  6073. (and (derived-mode-p 'org-mode) buffer-file-name
  6074. (add-to-list 'org-agenda-contributing-files buffer-file-name))
  6075. (when (and dotime time-of-day)
  6076. ;; Extract starting and ending time and move them to prefix
  6077. (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
  6078. (setq plain (string-match org-plain-time-of-day-regexp ts)))
  6079. (setq s0 (match-string 0 ts)
  6080. srp (and stamp (match-end 3))
  6081. s1 (match-string (if plain 1 2) ts)
  6082. s2 (match-string (if plain 8 (if srp 4 6)) ts))
  6083. ;; If the times are in TXT (not in DOTIMES), and the prefix will list
  6084. ;; them, we might want to remove them there to avoid duplication.
  6085. ;; The user can turn this off with a variable.
  6086. (when (and org-prefix-has-time
  6087. org-agenda-remove-times-when-in-prefix (or stamp plain)
  6088. (string-match (concat (regexp-quote s0) " *") txt)
  6089. (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
  6090. (if (eq org-agenda-remove-times-when-in-prefix 'beg)
  6091. (= (match-beginning 0) 0)
  6092. t))
  6093. (setq txt (replace-match "" nil nil txt))))
  6094. ;; Normalize the time(s) to 24 hour
  6095. (when s1 (setq s1 (org-get-time-of-day s1 'string t)))
  6096. (when s2 (setq s2 (org-get-time-of-day s2 'string t)))
  6097. ;; Try to set s2 if s1 and
  6098. ;; `org-agenda-default-appointment-duration' are set
  6099. (when (and s1 (not s2) org-agenda-default-appointment-duration)
  6100. (setq s2
  6101. (org-duration-from-minutes
  6102. (+ (org-duration-to-minutes s1 t)
  6103. org-agenda-default-appointment-duration)
  6104. nil t)))
  6105. ;; Compute the duration
  6106. (when s2
  6107. (setq duration (- (org-duration-to-minutes s2)
  6108. (org-duration-to-minutes s1)))))
  6109. (when (string-match org-tag-group-re txt)
  6110. ;; Tags are in the string
  6111. (if (or (eq org-agenda-remove-tags t)
  6112. (and org-agenda-remove-tags
  6113. org-prefix-has-tag))
  6114. (setq txt (replace-match "" t t txt))
  6115. (setq txt (replace-match
  6116. (concat (make-string (max (- 50 (length txt)) 1) ?\ )
  6117. (match-string 1 txt))
  6118. t t txt))))
  6119. (when remove-re
  6120. (while (string-match remove-re txt)
  6121. (setq txt (replace-match "" t t txt))))
  6122. ;; Set org-heading property on `txt' to mark the start of the
  6123. ;; heading.
  6124. (add-text-properties 0 (length txt) '(org-heading t) txt)
  6125. ;; Prepare the variables needed in the eval of the compiled format
  6126. (when org-prefix-has-breadcrumbs
  6127. (setq breadcrumbs (org-with-point-at (org-get-at-bol 'org-marker)
  6128. (let ((s (org-format-outline-path (org-get-outline-path)
  6129. (1- (frame-width))
  6130. nil org-agenda-breadcrumbs-separator)))
  6131. (if (eq "" s) "" (concat s org-agenda-breadcrumbs-separator))))))
  6132. (setq time (cond (s2 (concat
  6133. (org-agenda-time-of-day-to-ampm-maybe s1)
  6134. "-" (org-agenda-time-of-day-to-ampm-maybe s2)
  6135. (when org-agenda-timegrid-use-ampm " ")))
  6136. (s1 (concat
  6137. (org-agenda-time-of-day-to-ampm-maybe s1)
  6138. (if org-agenda-timegrid-use-ampm
  6139. (concat time-grid-trailing-characters " ")
  6140. time-grid-trailing-characters)))
  6141. (t ""))
  6142. extra (or (and (not habitp) extra) "")
  6143. category (if (symbolp category) (symbol-name category) category)
  6144. level (or level ""))
  6145. (if (string-match org-link-bracket-re category)
  6146. (progn
  6147. (setq l (string-width (or (match-string 2) (match-string 1))))
  6148. (when (< l (or org-prefix-category-length 0))
  6149. (setq category (copy-sequence category))
  6150. (org-add-props category nil
  6151. 'extra-space (make-string
  6152. (- org-prefix-category-length l 1) ?\ ))))
  6153. (when (and org-prefix-category-max-length
  6154. (>= (length category) org-prefix-category-max-length))
  6155. (setq category (substring category 0 (1- org-prefix-category-max-length)))))
  6156. ;; Evaluate the compiled format
  6157. (setq rtn (concat (eval formatter) txt))
  6158. ;; And finally add the text properties
  6159. (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
  6160. (org-add-props rtn nil
  6161. 'org-category category
  6162. 'tags (mapcar 'org-downcase-keep-props tags)
  6163. 'org-highest-priority org-highest-priority
  6164. 'org-lowest-priority org-lowest-priority
  6165. 'time-of-day time-of-day
  6166. 'duration duration
  6167. 'breadcrumbs breadcrumbs
  6168. 'txt txt
  6169. 'level level
  6170. 'time time
  6171. 'extra extra
  6172. 'format org-prefix-format-compiled
  6173. 'dotime dotime)))))
  6174. (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
  6175. "Remove tags string from TXT, and add a modified list of tags.
  6176. The modified list may contain inherited tags, and tags matched by
  6177. `org-agenda-hide-tags-regexp' will be removed."
  6178. (when (or add-inherited hide-re)
  6179. (when (string-match org-tag-group-re txt)
  6180. (setq txt (substring txt 0 (match-beginning 0))))
  6181. (setq tags
  6182. (delq nil
  6183. (mapcar (lambda (tg)
  6184. (if (or (and hide-re (string-match hide-re tg))
  6185. (and (not add-inherited)
  6186. (get-text-property 0 'inherited tg)))
  6187. nil
  6188. tg))
  6189. tags)))
  6190. (when tags
  6191. (let ((have-i (get-text-property 0 'inherited (car tags)))
  6192. i)
  6193. (setq txt (concat txt " :"
  6194. (mapconcat
  6195. (lambda (x)
  6196. (setq i (get-text-property 0 'inherited x))
  6197. (if (and have-i (not i))
  6198. (progn
  6199. (setq have-i nil)
  6200. (concat ":" x))
  6201. x))
  6202. tags ":")
  6203. (if have-i "::" ":"))))))
  6204. txt)
  6205. (defun org-downcase-keep-props (s)
  6206. (let ((props (text-properties-at 0 s)))
  6207. (setq s (downcase s))
  6208. (add-text-properties 0 (length s) props s)
  6209. s))
  6210. (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
  6211. (defun org-agenda-add-time-grid-maybe (list ndays todayp)
  6212. "Add a time-grid for agenda items which need it.
  6213. LIST is the list of agenda items formatted by `org-agenda-list'.
  6214. NDAYS is the span of the current agenda view.
  6215. TODAYP is t when the current agenda view is on today."
  6216. (catch 'exit
  6217. (cond ((not org-agenda-use-time-grid) (throw 'exit list))
  6218. ((and todayp (member 'today (car org-agenda-time-grid))))
  6219. ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
  6220. ((member 'weekly (car org-agenda-time-grid)))
  6221. (t (throw 'exit list)))
  6222. (let* ((have (delq nil (mapcar
  6223. (lambda (x) (get-text-property 1 'time-of-day x))
  6224. list)))
  6225. (string (nth 3 org-agenda-time-grid))
  6226. (gridtimes (nth 1 org-agenda-time-grid))
  6227. (req (car org-agenda-time-grid))
  6228. (remove (member 'remove-match req))
  6229. new time)
  6230. (when (and (member 'require-timed req) (not have))
  6231. ;; don't show empty grid
  6232. (throw 'exit list))
  6233. (while (setq time (pop gridtimes))
  6234. (unless (and remove (member time have))
  6235. (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
  6236. (push (org-agenda-format-item
  6237. nil string nil "" nil
  6238. (concat (substring time 0 -2) ":" (substring time -2)))
  6239. new)
  6240. (put-text-property
  6241. 2 (length (car new)) 'face 'org-time-grid (car new))))
  6242. (when (and todayp org-agenda-show-current-time-in-grid)
  6243. (push (org-agenda-format-item
  6244. nil org-agenda-current-time-string nil "" nil
  6245. (format-time-string "%H:%M "))
  6246. new)
  6247. (put-text-property
  6248. 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
  6249. (if (member 'time-up org-agenda-sorting-strategy-selected)
  6250. (append new list)
  6251. (append list new)))))
  6252. (defun org-compile-prefix-format (key)
  6253. "Compile the prefix format into a Lisp form that can be evaluated.
  6254. The resulting form and associated variable bindings is returned
  6255. and stored in the variable `org-prefix-format-compiled'."
  6256. (setq org-prefix-has-time nil
  6257. org-prefix-has-tag nil
  6258. org-prefix-category-length nil
  6259. org-prefix-has-effort nil
  6260. org-prefix-has-breadcrumbs nil)
  6261. (let ((s (cond
  6262. ((stringp org-agenda-prefix-format)
  6263. org-agenda-prefix-format)
  6264. ((assq key org-agenda-prefix-format)
  6265. (cdr (assq key org-agenda-prefix-format)))
  6266. (t " %-12:c%?-12t% s")))
  6267. (start 0)
  6268. varform vars var e c f opt)
  6269. (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cltseib]\\|(.+)\\)"
  6270. s start)
  6271. (setq var (or (cdr (assoc (match-string 4 s)
  6272. '(("c" . category) ("t" . time) ("l" . level) ("s" . extra)
  6273. ("i" . category-icon) ("T" . tag) ("e" . effort) ("b" . breadcrumbs))))
  6274. 'eval)
  6275. c (or (match-string 3 s) "")
  6276. opt (match-beginning 1)
  6277. start (1+ (match-beginning 0)))
  6278. (cl-case var
  6279. (time (setq org-prefix-has-time t))
  6280. (tag (setq org-prefix-has-tag t))
  6281. (effort (setq org-prefix-has-effort t))
  6282. (breadcrumbs (setq org-prefix-has-breadcrumbs t)))
  6283. (setq f (concat "%" (match-string 2 s) "s"))
  6284. (when (eq var 'category)
  6285. (setq org-prefix-category-length
  6286. (floor (abs (string-to-number (match-string 2 s)))))
  6287. (setq org-prefix-category-max-length
  6288. (let ((x (match-string 2 s)))
  6289. (save-match-data
  6290. (and (string-match "\\.[0-9]+" x)
  6291. (string-to-number (substring (match-string 0 x) 1)))))))
  6292. (if (eq var 'eval)
  6293. (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
  6294. (if opt
  6295. (setq varform
  6296. `(if (or (equal "" ,var) (equal nil ,var))
  6297. ""
  6298. (format ,f (concat ,var ,c))))
  6299. (setq varform
  6300. `(format ,f (if (or (equal ,var "")
  6301. (equal ,var nil)) ""
  6302. (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
  6303. (setq s (replace-match "%s" t nil s))
  6304. (push varform vars))
  6305. (setq vars (nreverse vars))
  6306. (with-current-buffer (or org-agenda-buffer (current-buffer))
  6307. (setq org-prefix-format-compiled
  6308. (list
  6309. `((org-prefix-has-time ,org-prefix-has-time)
  6310. (org-prefix-has-tag ,org-prefix-has-tag)
  6311. (org-prefix-category-length ,org-prefix-category-length)
  6312. (org-prefix-has-effort ,org-prefix-has-effort)
  6313. (org-prefix-has-breadcrumbs ,org-prefix-has-breadcrumbs))
  6314. `(format ,s ,@vars))))))
  6315. (defun org-set-sorting-strategy (key)
  6316. (if (symbolp (car org-agenda-sorting-strategy))
  6317. ;; the old format
  6318. (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
  6319. (setq org-agenda-sorting-strategy-selected
  6320. (or (cdr (assq key org-agenda-sorting-strategy))
  6321. (cdr (assq 'agenda org-agenda-sorting-strategy))
  6322. '(time-up category-keep priority-down)))))
  6323. (defun org-get-time-of-day (s &optional string mod24)
  6324. "Check string S for a time of day.
  6325. If found, return it as a military time number between 0 and 2400.
  6326. If not found, return nil.
  6327. The optional STRING argument forces conversion into a 5 character wide string
  6328. HH:MM."
  6329. (save-match-data
  6330. (when
  6331. (and
  6332. (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
  6333. (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
  6334. (not (eq (get-text-property 1 'face s) 'org-link)))
  6335. (let* ((h (string-to-number (match-string 1 s)))
  6336. (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
  6337. (ampm (when (match-end 4) (downcase (match-string 4 s))))
  6338. (am-p (equal ampm "am"))
  6339. (h1 (cond ((not ampm) h)
  6340. ((= h 12) (if am-p 0 12))
  6341. (t (+ h (if am-p 0 12)))))
  6342. (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
  6343. (mod h1 24) h1))
  6344. (t0 (+ (* 100 h2) m))
  6345. (t1 (concat (if (>= h1 24) "+" " ")
  6346. (if (and org-agenda-time-leading-zero
  6347. (< t0 1000)) "0" "")
  6348. (if (< t0 100) "0" "")
  6349. (if (< t0 10) "0" "")
  6350. (int-to-string t0))))
  6351. (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
  6352. (defvar org-agenda-before-sorting-filter-function nil
  6353. "Function to be applied to agenda items prior to sorting.
  6354. Prior to sorting also means just before they are inserted into the agenda.
  6355. To aid sorting, you may revisit the original entries and add more text
  6356. properties which will later be used by the sorting functions.
  6357. The function should take a string argument, an agenda line.
  6358. It has access to the text properties in that line, which contain among
  6359. other things, the property `org-hd-marker' that points to the entry
  6360. where the line comes from. Note that not all lines going into the agenda
  6361. have this property, only most.
  6362. The function should return the modified string. It is probably best
  6363. to ONLY change text properties.
  6364. You can also use this function as a filter, by returning nil for lines
  6365. you don't want to have in the agenda at all. For this application, you
  6366. could bind the variable in the options section of a custom command.")
  6367. (defun org-agenda-finalize-entries (list &optional type)
  6368. "Sort, limit and concatenate the LIST of agenda items.
  6369. The optional argument TYPE tells the agenda type."
  6370. (let ((max-effort (cond ((listp org-agenda-max-effort)
  6371. (cdr (assoc type org-agenda-max-effort)))
  6372. (t org-agenda-max-effort)))
  6373. (max-todo (cond ((listp org-agenda-max-todos)
  6374. (cdr (assoc type org-agenda-max-todos)))
  6375. (t org-agenda-max-todos)))
  6376. (max-tags (cond ((listp org-agenda-max-tags)
  6377. (cdr (assoc type org-agenda-max-tags)))
  6378. (t org-agenda-max-tags)))
  6379. (max-entries (cond ((listp org-agenda-max-entries)
  6380. (cdr (assoc type org-agenda-max-entries)))
  6381. (t org-agenda-max-entries))))
  6382. (when org-agenda-before-sorting-filter-function
  6383. (setq list
  6384. (delq nil
  6385. (mapcar
  6386. org-agenda-before-sorting-filter-function list))))
  6387. (setq list (mapcar 'org-agenda-highlight-todo list)
  6388. list (mapcar 'identity (sort list 'org-entries-lessp)))
  6389. (when max-effort
  6390. (setq list (org-agenda-limit-entries
  6391. list 'effort-minutes max-effort
  6392. (lambda (e) (or e (if org-sort-agenda-noeffort-is-high
  6393. 32767 -1))))))
  6394. (when max-todo
  6395. (setq list (org-agenda-limit-entries list 'todo-state max-todo)))
  6396. (when max-tags
  6397. (setq list (org-agenda-limit-entries list 'tags max-tags)))
  6398. (when max-entries
  6399. (setq list (org-agenda-limit-entries list 'org-hd-marker max-entries)))
  6400. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  6401. (setq list (mapcar #'org-agenda--mark-blocked-entry list)))
  6402. (mapconcat 'identity list "\n")))
  6403. (defun org-agenda-limit-entries (list prop limit &optional fn)
  6404. "Limit the number of agenda entries."
  6405. (let ((include (and limit (< limit 0))))
  6406. (if limit
  6407. (let ((fun (or fn (lambda (p) (when p 1))))
  6408. (lim 0))
  6409. (delq nil
  6410. (mapcar
  6411. (lambda (e)
  6412. (let ((pval (funcall
  6413. fun (get-text-property (1- (length e))
  6414. prop e))))
  6415. (when pval (setq lim (+ lim pval)))
  6416. (cond ((and pval (<= lim (abs limit))) e)
  6417. ((and include (not pval)) e))))
  6418. list)))
  6419. list)))
  6420. (defun org-agenda-limit-interactively (remove)
  6421. "In agenda, interactively limit entries to various maximums."
  6422. (interactive "P")
  6423. (if remove
  6424. (progn (setq org-agenda-max-entries nil
  6425. org-agenda-max-todos nil
  6426. org-agenda-max-tags nil
  6427. org-agenda-max-effort nil)
  6428. (org-agenda-redo))
  6429. (let* ((max (read-char "Number of [e]ntries [t]odos [T]ags [E]ffort? "))
  6430. (msg (cond ((= max ?E) "How many minutes? ")
  6431. ((= max ?e) "How many entries? ")
  6432. ((= max ?t) "How many TODO entries? ")
  6433. ((= max ?T) "How many tagged entries? ")
  6434. (t (user-error "Wrong input"))))
  6435. (num (string-to-number (read-from-minibuffer msg))))
  6436. (cond ((equal max ?e)
  6437. (let ((org-agenda-max-entries num)) (org-agenda-redo)))
  6438. ((equal max ?t)
  6439. (let ((org-agenda-max-todos num)) (org-agenda-redo)))
  6440. ((equal max ?T)
  6441. (let ((org-agenda-max-tags num)) (org-agenda-redo)))
  6442. ((equal max ?E)
  6443. (let ((org-agenda-max-effort num)) (org-agenda-redo))))))
  6444. (org-agenda-fit-window-to-buffer))
  6445. (defun org-agenda-highlight-todo (x)
  6446. (let ((org-done-keywords org-done-keywords-for-agenda)
  6447. (case-fold-search nil)
  6448. re)
  6449. (if (eq x 'line)
  6450. (save-excursion
  6451. (beginning-of-line 1)
  6452. (setq re (org-get-at-bol 'org-todo-regexp))
  6453. (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
  6454. (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
  6455. (add-text-properties (match-beginning 0) (match-end 1)
  6456. (list 'face (org-get-todo-face 1)))
  6457. (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
  6458. (delete-region (match-beginning 1) (1- (match-end 0)))
  6459. (goto-char (match-beginning 1))
  6460. (insert (format org-agenda-todo-keyword-format s)))))
  6461. (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
  6462. (setq re (get-text-property 0 'org-todo-regexp x))
  6463. (when (and re
  6464. ;; Test `pl' because if there's no heading content,
  6465. ;; there's no point matching to highlight. Note
  6466. ;; that if we didn't test `pl' first, and there
  6467. ;; happened to be no keyword from `org-todo-regexp'
  6468. ;; on this heading line, then the `equal' comparison
  6469. ;; afterwards would spuriously succeed in the case
  6470. ;; where `pl' is nil -- causing an args-out-of-range
  6471. ;; error when we try to add text properties to text
  6472. ;; that isn't there.
  6473. pl
  6474. (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
  6475. x pl) pl))
  6476. (add-text-properties
  6477. (or (match-end 1) (match-end 0)) (match-end 0)
  6478. (list 'face (org-get-todo-face (match-string 2 x)))
  6479. x)
  6480. (when (match-end 1)
  6481. (setq x
  6482. (concat
  6483. (substring x 0 (match-end 1))
  6484. (format org-agenda-todo-keyword-format
  6485. (match-string 2 x))
  6486. ;; Remove `display' property as the icon could leak
  6487. ;; on the white space.
  6488. (org-add-props " " (org-plist-delete (text-properties-at 0 x)
  6489. 'display))
  6490. (substring x (match-end 3)))))))
  6491. x)))
  6492. (defsubst org-cmp-values (a b property)
  6493. "Compare the numeric value of text PROPERTY for string A and B."
  6494. (let ((pa (or (get-text-property (1- (length a)) property a) 0))
  6495. (pb (or (get-text-property (1- (length b)) property b) 0)))
  6496. (cond ((> pa pb) +1)
  6497. ((< pa pb) -1))))
  6498. (defsubst org-cmp-effort (a b)
  6499. "Compare the effort values of string A and B."
  6500. (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
  6501. ;; `effort-minutes' property is not directly accessible from
  6502. ;; the strings, but is stored as a property in `txt'.
  6503. (ea (or (get-text-property
  6504. 0 'effort-minutes (get-text-property 0 'txt a))
  6505. def))
  6506. (eb (or (get-text-property
  6507. 0 'effort-minutes (get-text-property 0 'txt b))
  6508. def)))
  6509. (cond ((> ea eb) +1)
  6510. ((< ea eb) -1))))
  6511. (defsubst org-cmp-category (a b)
  6512. "Compare the string values of categories of strings A and B."
  6513. (let ((ca (or (get-text-property (1- (length a)) 'org-category a) ""))
  6514. (cb (or (get-text-property (1- (length b)) 'org-category b) "")))
  6515. (cond ((string-lessp ca cb) -1)
  6516. ((string-lessp cb ca) +1))))
  6517. (defsubst org-cmp-todo-state (a b)
  6518. "Compare the todo states of strings A and B."
  6519. (let* ((ma (or (get-text-property 1 'org-marker a)
  6520. (get-text-property 1 'org-hd-marker a)))
  6521. (mb (or (get-text-property 1 'org-marker b)
  6522. (get-text-property 1 'org-hd-marker b)))
  6523. (fa (and ma (marker-buffer ma)))
  6524. (fb (and mb (marker-buffer mb)))
  6525. (todo-kwds
  6526. (or (and fa (with-current-buffer fa org-todo-keywords-1))
  6527. (and fb (with-current-buffer fb org-todo-keywords-1))))
  6528. (ta (or (get-text-property 1 'todo-state a) ""))
  6529. (tb (or (get-text-property 1 'todo-state b) ""))
  6530. (la (- (length (member ta todo-kwds))))
  6531. (lb (- (length (member tb todo-kwds))))
  6532. (donepa (member ta org-done-keywords-for-agenda))
  6533. (donepb (member tb org-done-keywords-for-agenda)))
  6534. (cond ((and donepa (not donepb)) -1)
  6535. ((and (not donepa) donepb) +1)
  6536. ((< la lb) -1)
  6537. ((< lb la) +1))))
  6538. (defsubst org-cmp-alpha (a b)
  6539. "Compare the headlines, alphabetically."
  6540. (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
  6541. (plb (text-property-any 0 (length b) 'org-heading t b))
  6542. (ta (and pla (substring a pla)))
  6543. (tb (and plb (substring b plb)))
  6544. (case-fold-search nil))
  6545. (when pla
  6546. (when (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
  6547. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
  6548. (setq ta (substring ta (match-end 0))))
  6549. (setq ta (downcase ta)))
  6550. (when plb
  6551. (when (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
  6552. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
  6553. (setq tb (substring tb (match-end 0))))
  6554. (setq tb (downcase tb)))
  6555. (cond ((not (or ta tb)) nil)
  6556. ((not ta) +1)
  6557. ((not tb) -1)
  6558. ((string-lessp ta tb) -1)
  6559. ((string-lessp tb ta) +1))))
  6560. (defsubst org-cmp-tag (a b)
  6561. "Compare the string values of the first tags of A and B."
  6562. (let ((ta (car (last (get-text-property 1 'tags a))))
  6563. (tb (car (last (get-text-property 1 'tags b)))))
  6564. (cond ((not (or ta tb)) nil)
  6565. ((not ta) +1)
  6566. ((not tb) -1)
  6567. ((string-lessp ta tb) -1)
  6568. ((string-lessp tb ta) +1))))
  6569. (defsubst org-cmp-time (a b)
  6570. "Compare the time-of-day values of strings A and B."
  6571. (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
  6572. (ta (or (get-text-property 1 'time-of-day a) def))
  6573. (tb (or (get-text-property 1 'time-of-day b) def)))
  6574. (cond ((< ta tb) -1)
  6575. ((< tb ta) +1))))
  6576. (defsubst org-cmp-ts (a b type)
  6577. "Compare the timestamps values of entries A and B.
  6578. When TYPE is \"scheduled\", \"deadline\", \"timestamp\" or
  6579. \"timestamp_ia\", compare within each of these type. When TYPE
  6580. is the empty string, compare all timestamps without respect of
  6581. their type."
  6582. (let* ((def (and (not org-sort-agenda-notime-is-late) -1))
  6583. (ta (or (and (string-match type (or (get-text-property 1 'type a) ""))
  6584. (get-text-property 1 'ts-date a))
  6585. def))
  6586. (tb (or (and (string-match type (or (get-text-property 1 'type b) ""))
  6587. (get-text-property 1 'ts-date b))
  6588. def)))
  6589. (cond ((if ta (and tb (< ta tb)) tb) -1)
  6590. ((if tb (and ta (< tb ta)) ta) +1))))
  6591. (defsubst org-cmp-habit-p (a b)
  6592. "Compare the todo states of strings A and B."
  6593. (let ((ha (get-text-property 1 'org-habit-p a))
  6594. (hb (get-text-property 1 'org-habit-p b)))
  6595. (cond ((and ha (not hb)) -1)
  6596. ((and (not ha) hb) +1))))
  6597. (defun org-entries-lessp (a b)
  6598. "Predicate for sorting agenda entries."
  6599. ;; The following variables will be used when the form is evaluated.
  6600. ;; So even though the compiler complains, keep them.
  6601. (let* ((ss org-agenda-sorting-strategy-selected)
  6602. (timestamp-up (and (org-em 'timestamp-up 'timestamp-down ss)
  6603. (org-cmp-ts a b "")))
  6604. (timestamp-down (if timestamp-up (- timestamp-up) nil))
  6605. (scheduled-up (and (org-em 'scheduled-up 'scheduled-down ss)
  6606. (org-cmp-ts a b "scheduled")))
  6607. (scheduled-down (if scheduled-up (- scheduled-up) nil))
  6608. (deadline-up (and (org-em 'deadline-up 'deadline-down ss)
  6609. (org-cmp-ts a b "deadline")))
  6610. (deadline-down (if deadline-up (- deadline-up) nil))
  6611. (tsia-up (and (org-em 'tsia-up 'tsia-down ss)
  6612. (org-cmp-ts a b "timestamp_ia")))
  6613. (tsia-down (if tsia-up (- tsia-up) nil))
  6614. (ts-up (and (org-em 'ts-up 'ts-down ss)
  6615. (org-cmp-ts a b "timestamp")))
  6616. (ts-down (if ts-up (- ts-up) nil))
  6617. (time-up (and (org-em 'time-up 'time-down ss)
  6618. (org-cmp-time a b)))
  6619. (time-down (if time-up (- time-up) nil))
  6620. (stats-up (and (org-em 'stats-up 'stats-down ss)
  6621. (org-cmp-values a b 'org-stats)))
  6622. (stats-down (if stats-up (- stats-up) nil))
  6623. (priority-up (and (org-em 'priority-up 'priority-down ss)
  6624. (org-cmp-values a b 'priority)))
  6625. (priority-down (if priority-up (- priority-up) nil))
  6626. (effort-up (and (org-em 'effort-up 'effort-down ss)
  6627. (org-cmp-effort a b)))
  6628. (effort-down (if effort-up (- effort-up) nil))
  6629. (category-up (and (or (org-em 'category-up 'category-down ss)
  6630. (memq 'category-keep ss))
  6631. (org-cmp-category a b)))
  6632. (category-down (if category-up (- category-up) nil))
  6633. (category-keep (if category-up +1 nil))
  6634. (tag-up (and (org-em 'tag-up 'tag-down ss)
  6635. (org-cmp-tag a b)))
  6636. (tag-down (if tag-up (- tag-up) nil))
  6637. (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
  6638. (org-cmp-todo-state a b)))
  6639. (todo-state-down (if todo-state-up (- todo-state-up) nil))
  6640. (habit-up (and (org-em 'habit-up 'habit-down ss)
  6641. (org-cmp-habit-p a b)))
  6642. (habit-down (if habit-up (- habit-up) nil))
  6643. (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
  6644. (org-cmp-alpha a b)))
  6645. (alpha-down (if alpha-up (- alpha-up) nil))
  6646. (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
  6647. user-defined-up user-defined-down)
  6648. (when (and need-user-cmp org-agenda-cmp-user-defined
  6649. (functionp org-agenda-cmp-user-defined))
  6650. (setq user-defined-up
  6651. (funcall org-agenda-cmp-user-defined a b)
  6652. user-defined-down (if user-defined-up (- user-defined-up) nil)))
  6653. (cdr (assoc
  6654. (eval (cons 'or org-agenda-sorting-strategy-selected))
  6655. '((-1 . t) (1 . nil) (nil . nil))))))
  6656. ;;; Agenda restriction lock
  6657. (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
  6658. "Overlay to mark the headline to which agenda commands are restricted.")
  6659. (overlay-put org-agenda-restriction-lock-overlay
  6660. 'face 'org-agenda-restriction-lock)
  6661. (overlay-put org-agenda-restriction-lock-overlay
  6662. 'help-echo "Agendas are currently limited to this subtree.")
  6663. (delete-overlay org-agenda-restriction-lock-overlay)
  6664. (defun org-agenda-set-restriction-lock-from-agenda (arg)
  6665. "Set the restriction lock to the agenda item at point from within the agenda.
  6666. When called with a `\\[universal-argument]' prefix, restrict to
  6667. the file which contains the item.
  6668. Argument ARG is the prefix argument."
  6669. (interactive "P")
  6670. (unless (derived-mode-p 'org-agenda-mode)
  6671. (user-error "Not in an Org agenda buffer"))
  6672. (let* ((marker (or (org-get-at-bol 'org-marker)
  6673. (org-agenda-error)))
  6674. (buffer (marker-buffer marker))
  6675. (pos (marker-position marker)))
  6676. (with-current-buffer buffer
  6677. (goto-char pos)
  6678. (org-agenda-set-restriction-lock arg))))
  6679. ;;;###autoload
  6680. (defun org-agenda-set-restriction-lock (&optional type)
  6681. "Set restriction lock for agenda to current subtree or file.
  6682. When in a restricted subtree, remove it.
  6683. The restriction will span over the entire file if TYPE is `file',
  6684. or if type is '(4), or if the cursor is before the first headline
  6685. in the file. Otherwise, only apply the restriction to the current
  6686. subtree."
  6687. (interactive "P")
  6688. (if (and org-agenda-overriding-restriction
  6689. (member org-agenda-restriction-lock-overlay
  6690. (overlays-at (point)))
  6691. (equal (overlay-start org-agenda-restriction-lock-overlay)
  6692. (point)))
  6693. (org-agenda-remove-restriction-lock 'noupdate)
  6694. (org-agenda-remove-restriction-lock 'noupdate)
  6695. (and (equal type '(4)) (setq type 'file))
  6696. (setq type (cond
  6697. (type type)
  6698. ((org-at-heading-p) 'subtree)
  6699. ((condition-case nil (org-back-to-heading t) (error nil))
  6700. 'subtree)
  6701. (t 'file)))
  6702. (if (eq type 'subtree)
  6703. (progn
  6704. (setq org-agenda-restrict (current-buffer))
  6705. (setq org-agenda-overriding-restriction 'subtree)
  6706. (put 'org-agenda-files 'org-restrict
  6707. (list (buffer-file-name (buffer-base-buffer))))
  6708. (org-back-to-heading t)
  6709. (move-overlay org-agenda-restriction-lock-overlay
  6710. (point)
  6711. (if org-agenda-restriction-lock-highlight-subtree
  6712. (save-excursion (org-end-of-subtree t t) (point))
  6713. (point-at-eol)))
  6714. (move-marker org-agenda-restrict-begin (point))
  6715. (move-marker org-agenda-restrict-end
  6716. (save-excursion (org-end-of-subtree t t)))
  6717. (message "Locking agenda restriction to subtree"))
  6718. (put 'org-agenda-files 'org-restrict
  6719. (list (buffer-file-name (buffer-base-buffer))))
  6720. (setq org-agenda-restrict nil)
  6721. (setq org-agenda-overriding-restriction 'file)
  6722. (move-marker org-agenda-restrict-begin nil)
  6723. (move-marker org-agenda-restrict-end nil)
  6724. (message "Locking agenda restriction to file"))
  6725. (setq current-prefix-arg nil))
  6726. (org-agenda-maybe-redo))
  6727. (defun org-agenda-remove-restriction-lock (&optional noupdate)
  6728. "Remove agenda restriction lock."
  6729. (interactive "P")
  6730. (if (not org-agenda-restrict)
  6731. (message "No agenda restriction to remove.")
  6732. (delete-overlay org-agenda-restriction-lock-overlay)
  6733. (delete-overlay org-speedbar-restriction-lock-overlay)
  6734. (setq org-agenda-overriding-restriction nil)
  6735. (setq org-agenda-restrict nil)
  6736. (put 'org-agenda-files 'org-restrict nil)
  6737. (move-marker org-agenda-restrict-begin nil)
  6738. (move-marker org-agenda-restrict-end nil)
  6739. (setq current-prefix-arg nil)
  6740. (message "Agenda restriction lock removed")
  6741. (or noupdate (org-agenda-maybe-redo))))
  6742. (defun org-agenda-maybe-redo ()
  6743. "If there is any window showing the agenda view, update it."
  6744. (let ((w (get-buffer-window (or org-agenda-this-buffer-name
  6745. org-agenda-buffer-name)
  6746. t))
  6747. (w0 (selected-window)))
  6748. (when w
  6749. (select-window w)
  6750. (org-agenda-redo)
  6751. (select-window w0)
  6752. (if org-agenda-overriding-restriction
  6753. (message "Agenda view shifted to new %s restriction"
  6754. org-agenda-overriding-restriction)
  6755. (message "Agenda restriction lock removed")))))
  6756. ;;; Agenda commands
  6757. (defun org-agenda-check-type (error &rest types)
  6758. "Check if agenda buffer is of allowed type.
  6759. If ERROR is non-nil, throw an error, otherwise just return nil.
  6760. Allowed types are `agenda' `todo' `tags' `search'."
  6761. (cond ((not org-agenda-type)
  6762. (error "No Org agenda currently displayed"))
  6763. ((memq org-agenda-type types) t)
  6764. (error
  6765. (error "Not allowed in %s-type agenda buffers" org-agenda-type))
  6766. (t nil)))
  6767. (defun org-agenda-Quit ()
  6768. "Exit the agenda, killing the agenda buffer.
  6769. Like `org-agenda-quit', but kill the buffer even when
  6770. `org-agenda-sticky' is non-nil."
  6771. (interactive)
  6772. (org-agenda--quit))
  6773. (defun org-agenda-quit ()
  6774. "Exit the agenda.
  6775. When `org-agenda-sticky' is non-nil, bury the agenda buffer
  6776. instead of killing it.
  6777. When `org-agenda-restore-windows-after-quit' is non-nil, restore
  6778. the pre-agenda window configuration.
  6779. When column view is active, exit column view instead of the
  6780. agenda."
  6781. (interactive)
  6782. (org-agenda--quit org-agenda-sticky))
  6783. (defun org-agenda--quit (&optional bury)
  6784. (if org-agenda-columns-active
  6785. (org-columns-quit)
  6786. (let ((wconf org-agenda-pre-window-conf)
  6787. (buf (current-buffer))
  6788. (org-agenda-last-indirect-window
  6789. (and (eq org-indirect-buffer-display 'other-window)
  6790. org-agenda-last-indirect-buffer
  6791. (get-buffer-window org-agenda-last-indirect-buffer))))
  6792. (cond
  6793. ((eq org-agenda-window-setup 'other-frame)
  6794. (delete-frame))
  6795. ((and org-agenda-restore-windows-after-quit
  6796. wconf)
  6797. ;; Maybe restore the pre-agenda window configuration. Reset
  6798. ;; `org-agenda-pre-window-conf' before running
  6799. ;; `set-window-configuration', which loses the current buffer.
  6800. (setq org-agenda-pre-window-conf nil)
  6801. (set-window-configuration wconf))
  6802. (t
  6803. (when org-agenda-last-indirect-window
  6804. (delete-window org-agenda-last-indirect-window))
  6805. (and (not (eq org-agenda-window-setup 'current-window))
  6806. (not (one-window-p))
  6807. (delete-window))))
  6808. (if bury
  6809. ;; Set the agenda buffer as the current buffer instead of
  6810. ;; passing it as an argument to `bury-buffer' so that
  6811. ;; `bury-buffer' removes it from the window.
  6812. (with-current-buffer buf
  6813. (bury-buffer))
  6814. (kill-buffer buf)
  6815. (setq org-agenda-archives-mode nil
  6816. org-agenda-buffer nil)))))
  6817. (defun org-agenda-exit ()
  6818. "Exit the agenda, killing Org buffers loaded by the agenda.
  6819. Like `org-agenda-Quit', but kill any buffers that were created by
  6820. the agenda. Org buffers visited directly by the user will not be
  6821. touched. Also, exit the agenda even if it is in column view."
  6822. (interactive)
  6823. (when org-agenda-columns-active
  6824. (org-columns-quit))
  6825. (org-release-buffers org-agenda-new-buffers)
  6826. (setq org-agenda-new-buffers nil)
  6827. (org-agenda-Quit))
  6828. (defun org-agenda-kill-all-agenda-buffers ()
  6829. "Kill all buffers in `org-agenda-mode'.
  6830. This is used when toggling sticky agendas."
  6831. (interactive)
  6832. (let (blist)
  6833. (dolist (buf (buffer-list))
  6834. (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
  6835. (push buf blist)))
  6836. (mapc 'kill-buffer blist)))
  6837. (defun org-agenda-execute (arg)
  6838. "Execute another agenda command, keeping same window.
  6839. So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
  6840. in the agenda."
  6841. (interactive "P")
  6842. (let ((org-agenda-window-setup 'current-window))
  6843. (org-agenda arg)))
  6844. (defun org-agenda-redo (&optional all)
  6845. "Rebuild possibly ALL agenda view(s) in the current buffer."
  6846. (interactive "P")
  6847. (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
  6848. (cpa (unless (eq all t) current-prefix-arg))
  6849. (org-agenda-doing-sticky-redo org-agenda-sticky)
  6850. (org-agenda-sticky nil)
  6851. (org-agenda-buffer-name (or org-agenda-this-buffer-name
  6852. org-agenda-buffer-name))
  6853. (org-agenda-keep-modes t)
  6854. (tag-filter org-agenda-tag-filter)
  6855. (tag-preset (get 'org-agenda-tag-filter :preset-filter))
  6856. (top-hl-filter org-agenda-top-headline-filter)
  6857. (cat-filter org-agenda-category-filter)
  6858. (cat-preset (get 'org-agenda-category-filter :preset-filter))
  6859. (re-filter org-agenda-regexp-filter)
  6860. (re-preset (get 'org-agenda-regexp-filter :preset-filter))
  6861. (effort-filter org-agenda-effort-filter)
  6862. (effort-preset (get 'org-agenda-effort-filter :preset-filter))
  6863. (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
  6864. (cols org-agenda-columns-active)
  6865. (line (org-current-line))
  6866. (window-line (- line (org-current-line (window-start))))
  6867. (lprops (get 'org-agenda-redo-command 'org-lprops))
  6868. (redo-cmd (get-text-property p 'org-redo-cmd))
  6869. (last-args (get-text-property p 'org-last-args))
  6870. (org-agenda-overriding-cmd (get-text-property p 'org-series-cmd))
  6871. (org-agenda-overriding-cmd-arguments
  6872. (unless (eq all t)
  6873. (cond ((listp last-args)
  6874. (cons (or cpa (car last-args)) (cdr last-args)))
  6875. ((stringp last-args)
  6876. last-args))))
  6877. (series-redo-cmd (get-text-property p 'org-series-redo-cmd)))
  6878. (put 'org-agenda-tag-filter :preset-filter nil)
  6879. (put 'org-agenda-category-filter :preset-filter nil)
  6880. (put 'org-agenda-regexp-filter :preset-filter nil)
  6881. (put 'org-agenda-effort-filter :preset-filter nil)
  6882. (and cols (org-columns-quit))
  6883. (message "Rebuilding agenda buffer...")
  6884. (if series-redo-cmd
  6885. (eval series-redo-cmd)
  6886. (org-let lprops redo-cmd))
  6887. (setq org-agenda-undo-list nil
  6888. org-agenda-pending-undo-list nil
  6889. org-agenda-tag-filter tag-filter
  6890. org-agenda-category-filter cat-filter
  6891. org-agenda-regexp-filter re-filter
  6892. org-agenda-effort-filter effort-filter
  6893. org-agenda-top-headline-filter top-hl-filter)
  6894. (message "Rebuilding agenda buffer...done")
  6895. (put 'org-agenda-tag-filter :preset-filter tag-preset)
  6896. (put 'org-agenda-category-filter :preset-filter cat-preset)
  6897. (put 'org-agenda-regexp-filter :preset-filter re-preset)
  6898. (put 'org-agenda-effort-filter :preset-filter effort-preset)
  6899. (let ((tag (or tag-filter tag-preset))
  6900. (cat (or cat-filter cat-preset))
  6901. (effort (or effort-filter effort-preset))
  6902. (re (or re-filter re-preset)))
  6903. (when tag (org-agenda-filter-apply tag 'tag t))
  6904. (when cat (org-agenda-filter-apply cat 'category))
  6905. (when effort (org-agenda-filter-apply effort 'effort))
  6906. (when re (org-agenda-filter-apply re 'regexp)))
  6907. (and top-hl-filter (org-agenda-filter-top-headline-apply top-hl-filter))
  6908. (and cols (called-interactively-p 'any) (org-agenda-columns))
  6909. (org-goto-line line)
  6910. (recenter window-line)))
  6911. (defun org-agenda-redo-all (&optional exhaustive)
  6912. "Rebuild all agenda views in the current buffer.
  6913. With a prefix argument, do so in all agenda buffers."
  6914. (interactive "P")
  6915. (if exhaustive
  6916. (dolist (buffer (buffer-list))
  6917. (with-current-buffer buffer
  6918. (when (derived-mode-p 'org-agenda-mode)
  6919. (org-agenda-redo t))))
  6920. (org-agenda-redo t)))
  6921. (defvar org-global-tags-completion-table nil)
  6922. (defvar org-agenda-filter-form nil)
  6923. (defvar org-agenda-filtered-by-category nil)
  6924. (defsubst org-agenda-get-category ()
  6925. "Return the category of the agenda line."
  6926. (org-get-at-bol 'org-category))
  6927. (defun org-agenda-all-categories ()
  6928. "Return a list of all categories used in this agenda buffer."
  6929. (let ((pos (point-min)) categories)
  6930. (while (and (< pos (point-max))
  6931. (setq pos (next-single-property-change
  6932. pos 'org-category nil (point-max))))
  6933. (push (get-text-property pos 'org-category) categories))
  6934. (nreverse (org-uniquify (delq nil categories)))))
  6935. (defun org-agenda-filter-by-category (strip)
  6936. "Filter lines in the agenda buffer that have a specific category.
  6937. The category is that of the current line.
  6938. Without prefix argument STRIP, keep only the lines of that category.
  6939. With a prefix argument, exclude the lines of that category."
  6940. (interactive "P")
  6941. (if (and org-agenda-filtered-by-category
  6942. org-agenda-category-filter)
  6943. (org-agenda-filter-show-all-cat)
  6944. (let* ((categories (org-agenda-all-categories))
  6945. (defcat (org-no-properties (or (org-agenda-get-category)
  6946. (car categories))))
  6947. (cat (completing-read (format "Category [%s]: " defcat)
  6948. (org-agenda-all-categories)
  6949. nil t nil nil defcat)))
  6950. (cond
  6951. ((and cat strip)
  6952. (org-agenda-filter-apply
  6953. (push (concat "-" cat) org-agenda-category-filter) 'category))
  6954. (cat
  6955. (org-agenda-filter-apply
  6956. (setq org-agenda-category-filter
  6957. (list (concat "+" cat))) 'category))
  6958. (t (error "No category at point"))))))
  6959. (defun org-find-top-headline (&optional pos)
  6960. "Find the topmost parent headline and return it.
  6961. POS when non-nil is the marker or buffer position to start the
  6962. search from."
  6963. (save-excursion
  6964. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  6965. (when pos (goto-char pos))
  6966. ;; Skip up to the topmost parent.
  6967. (while (org-up-heading-safe))
  6968. (ignore-errors (nth 4 (org-heading-components))))))
  6969. (defvar org-agenda-filtered-by-top-headline nil)
  6970. (defun org-agenda-filter-by-top-headline (strip)
  6971. "Keep only those lines that are descendants from the same top headline.
  6972. The top headline is that of the current line."
  6973. (interactive "P")
  6974. (if org-agenda-filtered-by-top-headline
  6975. (progn
  6976. (setq org-agenda-filtered-by-top-headline nil
  6977. org-agenda-top-headline-filter nil)
  6978. (org-agenda-filter-show-all-top-filter))
  6979. (let ((toph (org-find-top-headline (org-get-at-bol 'org-hd-marker))))
  6980. (if toph (org-agenda-filter-top-headline-apply toph strip)
  6981. (error "No top-level headline at point")))))
  6982. (defvar org-agenda-regexp-filter nil)
  6983. (defun org-agenda-filter-by-regexp (strip)
  6984. "Filter agenda entries by regular expressions.
  6985. With one prefix argument, filter out entries matching the regexp.
  6986. If there is already a regexp filter, remove it unless called with
  6987. two prefix arguments."
  6988. (interactive "P")
  6989. (cond
  6990. ((and org-agenda-regexp-filter (not (equal strip '(16))))
  6991. (org-agenda-filter-show-all-re)
  6992. (message "Regexp filter removed"))
  6993. (t (let ((flt (concat (if (equal strip '(4)) "-" "+")
  6994. (read-from-minibuffer
  6995. (if (equal strip '(4))
  6996. "Filter out entries matching regexp: "
  6997. "Narrow to entries matching regexp: ")))))
  6998. (push flt org-agenda-regexp-filter)
  6999. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp)))))
  7000. (defvar org-agenda-effort-filter nil)
  7001. (defun org-agenda-filter-by-effort (strip)
  7002. "Filter agenda entries by effort.
  7003. With no prefix argument, keep entries matching the effort condition.
  7004. With one prefix argument, filter out entries matching the condition.
  7005. With two prefix arguments, remove the effort filters."
  7006. (interactive "P")
  7007. (cond
  7008. ((member strip '(nil 4))
  7009. (let* ((efforts (split-string
  7010. (or (cdr (assoc (concat org-effort-property "_ALL")
  7011. org-global-properties))
  7012. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00")))
  7013. ;; XXX: the following handles only up to 10 different
  7014. ;; effort values.
  7015. (allowed-keys (if (null efforts) nil
  7016. (mapcar (lambda (n) (mod n 10)) ;turn 10 into 0
  7017. (number-sequence 1 (length efforts)))))
  7018. (op nil))
  7019. (while (not (memq op '(?< ?> ?= ?_)))
  7020. (setq op (read-char-exclusive "Effort operator? (> = or <) or press `_' again to remove filter")))
  7021. ;; Select appropriate duration. Ignore non-digit characters.
  7022. (if (eq op ?_)
  7023. (progn
  7024. (org-agenda-filter-show-all-effort)
  7025. (message "Effort filter removed"))
  7026. (let ((prompt
  7027. (apply #'format
  7028. (concat "Effort %c "
  7029. (mapconcat (lambda (s) (concat "[%d]" s))
  7030. efforts
  7031. " "))
  7032. op allowed-keys))
  7033. (eff -1))
  7034. (while (not (memq eff allowed-keys))
  7035. (message prompt)
  7036. (setq eff (- (read-char-exclusive) 48)))
  7037. (setq org-agenda-effort-filter
  7038. (list (concat (if strip "-" "+")
  7039. (char-to-string op)
  7040. ;; Numbering is 1 2 3 ... 9 0, but we want
  7041. ;; 0 1 2 ... 8 9.
  7042. (nth (mod (1- eff) 10) efforts)))))
  7043. (org-agenda-filter-apply org-agenda-effort-filter 'effort))))
  7044. (t (org-agenda-filter-show-all-effort)
  7045. (message "Effort filter removed"))))
  7046. (defun org-agenda-filter-remove-all ()
  7047. "Remove all filters from the current agenda buffer."
  7048. (interactive)
  7049. (when org-agenda-tag-filter
  7050. (org-agenda-filter-show-all-tag))
  7051. (when org-agenda-category-filter
  7052. (org-agenda-filter-show-all-cat))
  7053. (when org-agenda-regexp-filter
  7054. (org-agenda-filter-show-all-re))
  7055. (when org-agenda-top-headline-filter
  7056. (org-agenda-filter-show-all-top-filter))
  7057. (when org-agenda-effort-filter
  7058. (org-agenda-filter-show-all-effort))
  7059. (org-agenda-finalize))
  7060. (defun org-agenda-filter-by-tag (arg &optional char exclude)
  7061. "Keep only those lines in the agenda buffer that have a specific tag.
  7062. The tag is selected with its fast selection letter, as configured.
  7063. With a `\\[universal-argument]' prefix, exclude the agenda search.
  7064. With a `\\[universal-argument] \\[universal-argument]' prefix, filter the literal tag, \
  7065. i.e. don't
  7066. filter on all its group members.
  7067. A lisp caller can specify CHAR. EXCLUDE means that the new tag
  7068. should be used to exclude the search - the interactive user can
  7069. also press `-' or `+' to switch between filtering and excluding."
  7070. (interactive "P")
  7071. (let* ((alist org-tag-alist-for-agenda)
  7072. (seen-chars nil)
  7073. (tag-chars (mapconcat
  7074. (lambda (x) (if (and (not (symbolp (car x)))
  7075. (cdr x)
  7076. (not (member (cdr x) seen-chars)))
  7077. (progn
  7078. (push (cdr x) seen-chars)
  7079. (char-to-string (cdr x)))
  7080. ""))
  7081. org-tag-alist-for-agenda ""))
  7082. (valid-char-list (append '(?\t ?\r ?/ ?. ?\s ?q)
  7083. (string-to-list tag-chars)))
  7084. (exclude (or exclude (equal arg '(4))))
  7085. (expand (not (equal arg '(16))))
  7086. (inhibit-read-only t)
  7087. (current org-agenda-tag-filter)
  7088. a n tag)
  7089. (unless char
  7090. (while (not (memq char valid-char-list))
  7091. (org-unlogged-message
  7092. "%s by tag%s: [%s ]tag-char [TAB]tag %s[/]off [q]uit"
  7093. (if exclude "Exclude[+]" "Filter[-]")
  7094. (if expand "" " (no grouptag expand)")
  7095. tag-chars
  7096. (if org-agenda-auto-exclude-function "[RET] " ""))
  7097. (setq char (read-char-exclusive))
  7098. ;; Excluding or filtering down
  7099. (cond ((eq char ?-) (setq exclude t))
  7100. ((eq char ?+) (setq exclude nil)))))
  7101. (when (eq char ?\t)
  7102. (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
  7103. (setq-local org-global-tags-completion-table
  7104. (org-global-tags-completion-table)))
  7105. (let ((completion-ignore-case t))
  7106. (setq tag (completing-read
  7107. "Tag: " org-global-tags-completion-table nil t))))
  7108. (cond
  7109. ((eq char ?\r)
  7110. (org-agenda-filter-show-all-tag)
  7111. (when org-agenda-auto-exclude-function
  7112. (setq org-agenda-tag-filter nil)
  7113. (dolist (tag (org-agenda-get-represented-tags))
  7114. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  7115. (when modifier
  7116. (push modifier org-agenda-tag-filter))))
  7117. (unless (null org-agenda-tag-filter)
  7118. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))))
  7119. ((eq char ?/)
  7120. (org-agenda-filter-show-all-tag)
  7121. (when (get 'org-agenda-tag-filter :preset-filter)
  7122. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand)))
  7123. ((eq char ?.)
  7124. (setq org-agenda-tag-filter
  7125. (mapcar (lambda(tag) (concat "+" tag))
  7126. (org-get-at-bol 'tags)))
  7127. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  7128. ((eq char ?q)) ;If q, abort (even if there is a q-key for a tag...)
  7129. ((or (eq char ?\s)
  7130. (setq a (rassoc char alist))
  7131. (and tag (setq a (cons tag nil))))
  7132. (org-agenda-filter-show-all-tag)
  7133. (setq tag (car a))
  7134. (setq org-agenda-tag-filter
  7135. (cons (concat (if exclude "-" "+") tag)
  7136. current))
  7137. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  7138. (t (error "Invalid tag selection character %c" char)))))
  7139. (defun org-agenda-get-represented-tags ()
  7140. "Get a list of all tags currently represented in the agenda."
  7141. (let (p tags)
  7142. (save-excursion
  7143. (goto-char (point-min))
  7144. (while (setq p (next-single-property-change (point) 'tags))
  7145. (goto-char p)
  7146. (mapc (lambda (x) (add-to-list 'tags x))
  7147. (get-text-property (point) 'tags))))
  7148. tags))
  7149. (defun org-agenda-filter-make-matcher (filter type &optional expand)
  7150. "Create the form that tests a line for agenda filter. Optional
  7151. argument EXPAND can be used for the TYPE tag and will expand the
  7152. tags in the FILTER if any of the tags in FILTER are grouptags."
  7153. (let (f f1)
  7154. (cond
  7155. ;; Tag filter
  7156. ((eq type 'tag)
  7157. (setq filter
  7158. (delete-dups
  7159. (append (get 'org-agenda-tag-filter :preset-filter)
  7160. filter)))
  7161. (dolist (x filter)
  7162. (let ((op (string-to-char x)))
  7163. (if expand (setq x (org-agenda-filter-expand-tags (list x) t))
  7164. (setq x (list x)))
  7165. (setq f1 (org-agenda-filter-make-matcher-tag-exp x op))
  7166. (push f1 f))))
  7167. ;; Category filter
  7168. ((eq type 'category)
  7169. (setq filter
  7170. (delete-dups
  7171. (append (get 'org-agenda-category-filter :preset-filter)
  7172. filter)))
  7173. (dolist (x filter)
  7174. (if (equal "-" (substring x 0 1))
  7175. (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
  7176. (setq f1 (list 'equal (substring x 1) 'cat)))
  7177. (push f1 f)))
  7178. ;; Regexp filter
  7179. ((eq type 'regexp)
  7180. (setq filter
  7181. (delete-dups
  7182. (append (get 'org-agenda-regexp-filter :preset-filter)
  7183. filter)))
  7184. (dolist (x filter)
  7185. (if (equal "-" (substring x 0 1))
  7186. (setq f1 (list 'not (list 'string-match (substring x 1) 'txt)))
  7187. (setq f1 (list 'string-match (substring x 1) 'txt)))
  7188. (push f1 f)))
  7189. ;; Effort filter
  7190. ((eq type 'effort)
  7191. (setq filter
  7192. (delete-dups
  7193. (append (get 'org-agenda-effort-filter :preset-filter)
  7194. filter)))
  7195. (dolist (x filter)
  7196. (push (org-agenda-filter-effort-form x) f))))
  7197. (cons 'and (nreverse f))))
  7198. (defun org-agenda-filter-make-matcher-tag-exp (tags op)
  7199. "Return a form associated to tag-expression TAGS.
  7200. Build a form testing a line for agenda filter for
  7201. tag-expressions. OP is an operator of type CHAR that allows the
  7202. function to set the right switches in the returned form."
  7203. (let (form)
  7204. ;; Any of the expressions can match if OP is +, all must match if
  7205. ;; the operator is -.
  7206. (dolist (x tags (cons (if (eq op ?-) 'and 'or) form))
  7207. (let* ((tag (substring x 1))
  7208. (f (cond
  7209. ((string= "" tag) '(not tags))
  7210. ((and (string-match-p "\\`{" tag) (string-match-p "}\\'" tag))
  7211. ;; TAG is a regexp.
  7212. (list 'org-match-any-p (substring tag 1 -1) 'tags))
  7213. (t (list 'member (downcase tag) 'tags)))))
  7214. (push (if (eq op ?-) (list 'not f) f) form)))))
  7215. (defun org-agenda-filter-effort-form (e)
  7216. "Return the form to compare the effort of the current line with what E says.
  7217. E looks like \"+<2:25\"."
  7218. (let (op)
  7219. (setq e (substring e 1))
  7220. (setq op (string-to-char e) e (substring e 1))
  7221. (setq op (cond ((equal op ?<) '<=)
  7222. ((equal op ?>) '>=)
  7223. ((equal op ??) op)
  7224. (t '=)))
  7225. (list 'org-agenda-compare-effort (list 'quote op)
  7226. (org-duration-to-minutes e))))
  7227. (defun org-agenda-compare-effort (op value)
  7228. "Compare the effort of the current line with VALUE, using OP.
  7229. If the line does not have an effort defined, return nil."
  7230. ;; `effort-minutes' property cannot be extracted directly from
  7231. ;; current line but is stored as a property in `txt'.
  7232. (let ((effort (get-text-property 0 'effort-minutes (org-get-at-bol 'txt))))
  7233. (funcall op
  7234. (or effort (if org-sort-agenda-noeffort-is-high 32767 -1))
  7235. value)))
  7236. (defun org-agenda-filter-expand-tags (filter &optional no-operator)
  7237. "Expand group tags in FILTER for the agenda.
  7238. When NO-OPERATOR is non-nil, do not add the + operator to returned tags."
  7239. (if org-group-tags
  7240. (let ((case-fold-search t) rtn)
  7241. (mapc
  7242. (lambda (f)
  7243. (let (f0 dir)
  7244. (if (string-match "^\\([+-]\\)\\(.+\\)" f)
  7245. (setq dir (match-string 1 f) f0 (match-string 2 f))
  7246. (setq dir (if no-operator "" "+") f0 f))
  7247. (setq rtn (append (mapcar (lambda(f1) (concat dir f1))
  7248. (org-tags-expand f0 t t))
  7249. rtn))))
  7250. filter)
  7251. (reverse rtn))
  7252. filter))
  7253. (defun org-agenda-filter-apply (filter type &optional expand)
  7254. "Set FILTER as the new agenda filter and apply it. Optional
  7255. argument EXPAND can be used for the TYPE tag and will expand the
  7256. tags in the FILTER if any of the tags in FILTER are grouptags."
  7257. ;; Deactivate `org-agenda-entry-text-mode' when filtering
  7258. (when org-agenda-entry-text-mode (org-agenda-entry-text-mode))
  7259. (let (tags cat txt)
  7260. (setq org-agenda-filter-form (org-agenda-filter-make-matcher filter type expand))
  7261. ;; Only set `org-agenda-filtered-by-category' to t when a unique
  7262. ;; category is used as the filter:
  7263. (setq org-agenda-filtered-by-category
  7264. (and (eq type 'category)
  7265. (not (equal (substring (car filter) 0 1) "-"))))
  7266. (org-agenda-set-mode-name)
  7267. (save-excursion
  7268. (goto-char (point-min))
  7269. (while (not (eobp))
  7270. (if (org-get-at-bol 'org-marker)
  7271. (progn
  7272. (setq tags (org-get-at-bol 'tags)
  7273. cat (org-agenda-get-category)
  7274. txt (org-get-at-bol 'txt))
  7275. (unless (eval org-agenda-filter-form)
  7276. (org-agenda-filter-hide-line type))
  7277. (beginning-of-line 2))
  7278. (beginning-of-line 2))))
  7279. (when (get-char-property (point) 'invisible)
  7280. (ignore-errors (org-agenda-previous-line)))))
  7281. (defun org-agenda-filter-top-headline-apply (hl &optional negative)
  7282. "Filter by top headline HL."
  7283. (org-agenda-set-mode-name)
  7284. (save-excursion
  7285. (goto-char (point-min))
  7286. (while (not (eobp))
  7287. (let* ((pos (org-get-at-bol 'org-hd-marker))
  7288. (tophl (and pos (org-find-top-headline pos))))
  7289. (when (and tophl (funcall (if negative 'identity 'not)
  7290. (string= hl tophl)))
  7291. (org-agenda-filter-hide-line 'top-headline)))
  7292. (beginning-of-line 2)))
  7293. (when (get-char-property (point) 'invisible)
  7294. (org-agenda-previous-line))
  7295. (setq org-agenda-top-headline-filter hl
  7296. org-agenda-filtered-by-top-headline t))
  7297. (defun org-agenda-filter-hide-line (type)
  7298. "Hide lines with TYPE in the agenda buffer."
  7299. (let* ((b (max (point-min) (1- (point-at-bol))))
  7300. (e (point-at-eol)))
  7301. (let ((inhibit-read-only t))
  7302. (add-text-properties
  7303. b e `(invisible org-filtered org-filter-type ,type)))))
  7304. (defun org-agenda-remove-filter (type)
  7305. (interactive)
  7306. "Remove filter of type TYPE from the agenda buffer."
  7307. (save-excursion
  7308. (goto-char (point-min))
  7309. (let ((inhibit-read-only t) pos)
  7310. (while (setq pos (text-property-any (point) (point-max) 'org-filter-type type))
  7311. (goto-char pos)
  7312. (remove-text-properties
  7313. (point) (next-single-property-change (point) 'org-filter-type)
  7314. `(invisible org-filtered org-filter-type ,type))))
  7315. (set (intern (format "org-agenda-%s-filter" (intern-soft type))) nil)
  7316. (setq org-agenda-filter-form nil)
  7317. (org-agenda-set-mode-name)
  7318. (org-agenda-finalize)))
  7319. (defun org-agenda-filter-show-all-tag nil
  7320. (org-agenda-remove-filter 'tag))
  7321. (defun org-agenda-filter-show-all-re nil
  7322. (org-agenda-remove-filter 'regexp))
  7323. (defun org-agenda-filter-show-all-effort nil
  7324. (org-agenda-remove-filter 'effort))
  7325. (defun org-agenda-filter-show-all-cat nil
  7326. (org-agenda-remove-filter 'category))
  7327. (defun org-agenda-filter-show-all-top-filter nil
  7328. (org-agenda-remove-filter 'top-headline))
  7329. (defun org-agenda-manipulate-query-add ()
  7330. "Manipulate the query by adding a search term with positive selection.
  7331. Positive selection means the term must be matched for selection of an entry."
  7332. (interactive)
  7333. (org-agenda-manipulate-query ?\[))
  7334. (defun org-agenda-manipulate-query-subtract ()
  7335. "Manipulate the query by adding a search term with negative selection.
  7336. Negative selection means term must not be matched for selection of an entry."
  7337. (interactive)
  7338. (org-agenda-manipulate-query ?\]))
  7339. (defun org-agenda-manipulate-query-add-re ()
  7340. "Manipulate the query by adding a search regexp with positive selection.
  7341. Positive selection means the regexp must match for selection of an entry."
  7342. (interactive)
  7343. (org-agenda-manipulate-query ?\{))
  7344. (defun org-agenda-manipulate-query-subtract-re ()
  7345. "Manipulate the query by adding a search regexp with negative selection.
  7346. Negative selection means regexp must not match for selection of an entry."
  7347. (interactive)
  7348. (org-agenda-manipulate-query ?\}))
  7349. (defun org-agenda-manipulate-query (char)
  7350. (cond
  7351. ((eq org-agenda-type 'agenda)
  7352. (let ((org-agenda-include-inactive-timestamps t))
  7353. (org-agenda-redo))
  7354. (message "Display now includes inactive timestamps as well"))
  7355. ((eq org-agenda-type 'search)
  7356. (org-add-to-string
  7357. 'org-agenda-query-string
  7358. (if org-agenda-last-search-view-search-was-boolean
  7359. (cdr (assoc char '((?\[ . " +") (?\] . " -")
  7360. (?\{ . " +{}") (?\} . " -{}"))))
  7361. " "))
  7362. (setq org-agenda-redo-command
  7363. (list 'org-search-view
  7364. (car (get-text-property (min (1- (point-max)) (point))
  7365. 'org-last-args))
  7366. org-agenda-query-string
  7367. (+ (length org-agenda-query-string)
  7368. (if (member char '(?\{ ?\})) 0 1))))
  7369. (set-register org-agenda-query-register org-agenda-query-string)
  7370. (let ((org-agenda-overriding-arguments
  7371. (cdr org-agenda-redo-command)))
  7372. (org-agenda-redo)))
  7373. (t (error "Cannot manipulate query for %s-type agenda buffers"
  7374. org-agenda-type))))
  7375. (defun org-add-to-string (var string)
  7376. (set var (concat (symbol-value var) string)))
  7377. (defun org-agenda-goto-date (span)
  7378. "Jump to DATE in agenda."
  7379. (interactive "P")
  7380. (let* ((org-read-date-prefer-future
  7381. (eval org-agenda-jump-prefer-future))
  7382. (date (org-read-date))
  7383. (day (time-to-days (org-time-string-to-time date)))
  7384. (org-agenda-sticky-orig org-agenda-sticky)
  7385. (org-agenda-buffer-tmp-name (buffer-name))
  7386. (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7387. (0-arg (or current-prefix-arg (car args)))
  7388. (2-arg (nth 2 args))
  7389. (with-hour-p (nth 4 org-agenda-redo-command))
  7390. (newcmd (list 'org-agenda-list 0-arg date
  7391. (org-agenda-span-to-ndays
  7392. 2-arg (org-time-string-to-absolute date))
  7393. with-hour-p))
  7394. (newargs (cdr newcmd))
  7395. (inhibit-read-only t)
  7396. org-agenda-sticky)
  7397. (if (not (org-agenda-check-type t 'agenda))
  7398. (error "Not available in non-agenda views")
  7399. (add-text-properties (point-min) (point-max)
  7400. `(org-redo-cmd ,newcmd org-last-args ,newargs))
  7401. (org-agenda-redo)
  7402. (goto-char (point-min))
  7403. (while (not (or (= (or (get-text-property (point) 'day) 0) day)
  7404. (save-excursion (move-beginning-of-line 2) (eobp))))
  7405. (move-beginning-of-line 2))
  7406. (setq org-agenda-sticky org-agenda-sticky-orig
  7407. org-agenda-this-buffer-is-sticky org-agenda-sticky))))
  7408. (defun org-agenda-goto-today ()
  7409. "Go to today."
  7410. (interactive)
  7411. (org-agenda-check-type t 'agenda)
  7412. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7413. (curspan (nth 2 args))
  7414. (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
  7415. (cond
  7416. (tdpos (goto-char tdpos))
  7417. ((eq org-agenda-type 'agenda)
  7418. (let* ((sd (org-agenda-compute-starting-span
  7419. (org-today) (or curspan org-agenda-span)))
  7420. (org-agenda-overriding-arguments args))
  7421. (setf (nth 1 org-agenda-overriding-arguments) sd)
  7422. (org-agenda-redo)
  7423. (org-agenda-find-same-or-today-or-agenda)))
  7424. (t (error "Cannot find today")))))
  7425. (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
  7426. (goto-char
  7427. (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
  7428. (text-property-any (point-min) (point-max) 'org-today t)
  7429. (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
  7430. (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
  7431. (org-agenda-backward-block))
  7432. (point-min))))
  7433. (defun org-agenda-backward-block ()
  7434. "Move backward by one agenda block."
  7435. (interactive)
  7436. (org-agenda-forward-block 'backward))
  7437. (defun org-agenda-forward-block (&optional backward)
  7438. "Move forward by one agenda block.
  7439. When optional argument BACKWARD is set, go backward"
  7440. (interactive)
  7441. (cond ((not (derived-mode-p 'org-agenda-mode))
  7442. (user-error
  7443. "Cannot execute this command outside of org-agenda-mode buffers"))
  7444. ((looking-at (if backward "\\`" "\\'"))
  7445. (message "Already at the %s block" (if backward "first" "last")))
  7446. (t (let ((pos (prog1 (point)
  7447. (ignore-errors (if backward (backward-char 1)
  7448. (move-end-of-line 1)))))
  7449. (f (if backward
  7450. 'previous-single-property-change
  7451. 'next-single-property-change))
  7452. moved dest)
  7453. (while (and (setq dest (funcall
  7454. f (point) 'org-agenda-structural-header))
  7455. (not (get-text-property
  7456. (point) 'org-agenda-structural-header)))
  7457. (setq moved t)
  7458. (goto-char dest))
  7459. (if moved (move-beginning-of-line 1)
  7460. (goto-char (if backward (point-min) (point-max)))
  7461. (move-beginning-of-line 1)
  7462. (message "No %s block" (if backward "previous" "further")))))))
  7463. (defun org-agenda-later (arg)
  7464. "Go forward in time by the current span.
  7465. With prefix ARG, go forward that many times the current span."
  7466. (interactive "p")
  7467. (org-agenda-check-type t 'agenda)
  7468. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7469. (span (or (nth 2 args) org-agenda-current-span))
  7470. (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
  7471. (greg (calendar-gregorian-from-absolute sd))
  7472. (cnt (org-get-at-bol 'org-day-cnt))
  7473. greg2)
  7474. (cond
  7475. ((numberp span)
  7476. (setq sd (+ (* span arg) sd)))
  7477. ((eq span 'day)
  7478. (setq sd (+ arg sd)))
  7479. ((eq span 'week)
  7480. (setq sd (+ (* 7 arg) sd)))
  7481. ((eq span 'fortnight)
  7482. (setq sd (+ (* 14 arg) sd)))
  7483. ((eq span 'month)
  7484. (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
  7485. sd (calendar-absolute-from-gregorian greg2))
  7486. (setcar greg2 (1+ (car greg2))))
  7487. ((eq span 'year)
  7488. (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
  7489. sd (calendar-absolute-from-gregorian greg2))
  7490. (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
  7491. (t
  7492. (setq sd (+ (* span arg) sd))))
  7493. (let ((org-agenda-overriding-cmd
  7494. ;; `cmd' may have been set by `org-agenda-run-series' which
  7495. ;; uses `org-agenda-overriding-cmd' to decide whether
  7496. ;; overriding is allowed for `cmd'
  7497. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7498. (org-agenda-overriding-arguments
  7499. (list (car args) sd span)))
  7500. (org-agenda-redo)
  7501. (org-agenda-find-same-or-today-or-agenda cnt))))
  7502. (defun org-agenda-earlier (arg)
  7503. "Go backward in time by the current span.
  7504. With prefix ARG, go backward that many times the current span."
  7505. (interactive "p")
  7506. (org-agenda-later (- arg)))
  7507. (defun org-agenda-view-mode-dispatch ()
  7508. "Call one of the view mode commands."
  7509. (interactive)
  7510. (org-unlogged-message
  7511. "View: [d]ay [w]eek for[t]night [m]onth [y]ear [SPC]reset [q]uit/abort
  7512. time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
  7513. [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
  7514. (pcase (read-char-exclusive)
  7515. (?\ (call-interactively 'org-agenda-reset-view))
  7516. (?d (call-interactively 'org-agenda-day-view))
  7517. (?w (call-interactively 'org-agenda-week-view))
  7518. (?t (call-interactively 'org-agenda-fortnight-view))
  7519. (?m (call-interactively 'org-agenda-month-view))
  7520. (?y (call-interactively 'org-agenda-year-view))
  7521. (?l (call-interactively 'org-agenda-log-mode))
  7522. (?L (org-agenda-log-mode '(4)))
  7523. (?c (org-agenda-log-mode 'clockcheck))
  7524. ((or ?F ?f) (call-interactively 'org-agenda-follow-mode))
  7525. (?a (call-interactively 'org-agenda-archives-mode))
  7526. (?A (org-agenda-archives-mode 'files))
  7527. ((or ?R ?r) (call-interactively 'org-agenda-clockreport-mode))
  7528. ((or ?E ?e) (call-interactively 'org-agenda-entry-text-mode))
  7529. (?G (call-interactively 'org-agenda-toggle-time-grid))
  7530. (?D (call-interactively 'org-agenda-toggle-diary))
  7531. (?\! (call-interactively 'org-agenda-toggle-deadlines))
  7532. (?\[ (let ((org-agenda-include-inactive-timestamps t))
  7533. (org-agenda-check-type t 'agenda)
  7534. (org-agenda-redo))
  7535. (message "Display now includes inactive timestamps as well"))
  7536. (?q (message "Abort"))
  7537. (key (user-error "Invalid key: %s" key))))
  7538. (defun org-agenda-reset-view ()
  7539. "Switch to default view for agenda."
  7540. (interactive)
  7541. (org-agenda-change-time-span org-agenda-span))
  7542. (defun org-agenda-day-view (&optional day-of-month)
  7543. "Switch to daily view for agenda.
  7544. With argument DAY-OF-MONTH, switch to that day of the month."
  7545. (interactive "P")
  7546. (org-agenda-change-time-span 'day day-of-month))
  7547. (defun org-agenda-week-view (&optional iso-week)
  7548. "Switch to weekly view for agenda.
  7549. With argument ISO-WEEK, switch to the corresponding ISO week.
  7550. If ISO-WEEK has more then 2 digits, only the last two encode
  7551. the week. Any digits before this encode a year. So 200712
  7552. means week 12 of year 2007. Years ranging from 70 years ago
  7553. to 30 years in the future can also be written as 2-digit years."
  7554. (interactive "P")
  7555. (org-agenda-change-time-span 'week iso-week))
  7556. (defun org-agenda-fortnight-view (&optional iso-week)
  7557. "Switch to fortnightly view for agenda.
  7558. With argument ISO-WEEK, switch to the corresponding ISO week.
  7559. If ISO-WEEK has more then 2 digits, only the last two encode
  7560. the week. Any digits before this encode a year. So 200712
  7561. means week 12 of year 2007. Years ranging from 70 years ago
  7562. to 30 years in the future can also be written as 2-digit years."
  7563. (interactive "P")
  7564. (org-agenda-change-time-span 'fortnight iso-week))
  7565. (defun org-agenda-month-view (&optional month)
  7566. "Switch to monthly view for agenda.
  7567. With argument MONTH, switch to that month. If MONTH has more
  7568. then 2 digits, only the last two encode the month. Any digits
  7569. before this encode a year. So 200712 means December year 2007.
  7570. Years ranging from 70 years ago to 30 years in the future can
  7571. also be written as 2-digit years."
  7572. (interactive "P")
  7573. (org-agenda-change-time-span 'month month))
  7574. (defun org-agenda-year-view (&optional year)
  7575. "Switch to yearly view for agenda.
  7576. With argument YEAR, switch to that year. Years ranging from 70
  7577. years ago to 30 years in the future can also be written as
  7578. 2-digit years."
  7579. (interactive "P")
  7580. (when year
  7581. (setq year (org-small-year-to-year year)))
  7582. (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
  7583. (org-agenda-change-time-span 'year year)
  7584. (error "Abort")))
  7585. (defun org-agenda-change-time-span (span &optional n)
  7586. "Change the agenda view to SPAN.
  7587. SPAN may be `day', `week', `fortnight', `month', `year'."
  7588. (org-agenda-check-type t 'agenda)
  7589. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7590. (curspan (nth 2 args)))
  7591. (when (and (not n) (equal curspan span))
  7592. (error "Viewing span is already \"%s\"" span))
  7593. (let* ((sd (or (org-get-at-bol 'day)
  7594. (nth 1 args)
  7595. org-starting-day))
  7596. (sd (org-agenda-compute-starting-span sd span n))
  7597. (org-agenda-overriding-cmd
  7598. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7599. (org-agenda-overriding-arguments
  7600. (list (car args) sd span)))
  7601. (org-agenda-redo)
  7602. (org-agenda-find-same-or-today-or-agenda))
  7603. (org-agenda-set-mode-name)
  7604. (message "Switched to %s view" span)))
  7605. (defun org-agenda-compute-starting-span (sd span &optional n)
  7606. "Compute starting date for agenda.
  7607. SPAN may be `day', `week', `fortnight', `month', `year'. The return value
  7608. is a cons cell with the starting date and the number of days,
  7609. so that the date SD will be in that range."
  7610. (let* ((greg (calendar-gregorian-from-absolute sd))
  7611. (dg (nth 1 greg))
  7612. (mg (car greg))
  7613. (yg (nth 2 greg)))
  7614. (cond
  7615. ((eq span 'day)
  7616. (when n
  7617. (setq sd (+ (calendar-absolute-from-gregorian
  7618. (list mg 1 yg))
  7619. n -1))))
  7620. ((or (eq span 'week) (eq span 'fortnight))
  7621. (let* ((nt (calendar-day-of-week
  7622. (calendar-gregorian-from-absolute sd)))
  7623. (d (if org-agenda-start-on-weekday
  7624. (- nt org-agenda-start-on-weekday)
  7625. 0))
  7626. y1)
  7627. (setq sd (- sd (+ (if (< d 0) 7 0) d)))
  7628. (when n
  7629. (require 'cal-iso)
  7630. (when (> n 99)
  7631. (setq y1 (org-small-year-to-year (/ n 100))
  7632. n (mod n 100)))
  7633. (setq sd
  7634. (calendar-iso-to-absolute
  7635. (list n 1
  7636. (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
  7637. ((eq span 'month)
  7638. (let (y1)
  7639. (when (and n (> n 99))
  7640. (setq y1 (org-small-year-to-year (/ n 100))
  7641. n (mod n 100)))
  7642. (setq sd (calendar-absolute-from-gregorian
  7643. (list (or n mg) 1 (or y1 yg))))))
  7644. ((eq span 'year)
  7645. (setq sd (calendar-absolute-from-gregorian
  7646. (list 1 1 (or n yg))))))
  7647. sd))
  7648. (defun org-agenda-next-date-line (&optional arg)
  7649. "Jump to the next line indicating a date in agenda buffer."
  7650. (interactive "p")
  7651. (org-agenda-check-type t 'agenda)
  7652. (beginning-of-line 1)
  7653. ;; This does not work if user makes date format that starts with a blank
  7654. (when (looking-at-p "^\\S-") (forward-char 1))
  7655. (unless (re-search-forward "^\\S-" nil t arg)
  7656. (backward-char 1)
  7657. (error "No next date after this line in this buffer"))
  7658. (goto-char (match-beginning 0)))
  7659. (defun org-agenda-previous-date-line (&optional arg)
  7660. "Jump to the previous line indicating a date in agenda buffer."
  7661. (interactive "p")
  7662. (org-agenda-check-type t 'agenda)
  7663. (beginning-of-line 1)
  7664. (unless (re-search-backward "^\\S-" nil t arg)
  7665. (error "No previous date before this line in this buffer")))
  7666. ;; Initialize the highlight
  7667. (defvar org-hl (make-overlay 1 1))
  7668. (overlay-put org-hl 'face 'highlight)
  7669. (defun org-highlight (begin end &optional buffer)
  7670. "Highlight a region with overlay."
  7671. (move-overlay org-hl begin end (or buffer (current-buffer))))
  7672. (defun org-unhighlight ()
  7673. "Detach overlay INDEX."
  7674. (delete-overlay org-hl))
  7675. (defun org-unhighlight-once ()
  7676. "Remove the highlight from its position, and this function from the hook."
  7677. (remove-hook 'pre-command-hook 'org-unhighlight-once)
  7678. (org-unhighlight))
  7679. (defvar org-agenda-pre-follow-window-conf nil)
  7680. (defun org-agenda-follow-mode ()
  7681. "Toggle follow mode in an agenda buffer."
  7682. (interactive)
  7683. (unless org-agenda-follow-mode
  7684. (setq org-agenda-pre-follow-window-conf
  7685. (current-window-configuration)))
  7686. (setq org-agenda-follow-mode (not org-agenda-follow-mode))
  7687. (unless org-agenda-follow-mode
  7688. (set-window-configuration org-agenda-pre-follow-window-conf))
  7689. (org-agenda-set-mode-name)
  7690. (org-agenda-do-context-action)
  7691. (message "Follow mode is %s"
  7692. (if org-agenda-follow-mode "on" "off")))
  7693. (defun org-agenda-entry-text-mode (&optional arg)
  7694. "Toggle entry text mode in an agenda buffer."
  7695. (interactive "P")
  7696. (if (or org-agenda-tag-filter
  7697. org-agenda-category-filter
  7698. org-agenda-regexp-filter
  7699. org-agenda-top-headline-filter)
  7700. (user-error "Can't show entry text in filtered views")
  7701. (setq org-agenda-entry-text-mode (or (integerp arg)
  7702. (not org-agenda-entry-text-mode)))
  7703. (org-agenda-entry-text-hide)
  7704. (and org-agenda-entry-text-mode
  7705. (let ((org-agenda-entry-text-maxlines
  7706. (if (integerp arg) arg org-agenda-entry-text-maxlines)))
  7707. (org-agenda-entry-text-show)))
  7708. (org-agenda-set-mode-name)
  7709. (message "Entry text mode is %s%s"
  7710. (if org-agenda-entry-text-mode "on" "off")
  7711. (if (not org-agenda-entry-text-mode) ""
  7712. (format " (maximum number of lines is %d)"
  7713. (if (integerp arg) arg org-agenda-entry-text-maxlines))))))
  7714. (defun org-agenda-clockreport-mode ()
  7715. "Toggle clocktable mode in an agenda buffer."
  7716. (interactive)
  7717. (org-agenda-check-type t 'agenda)
  7718. (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode))
  7719. (org-agenda-set-mode-name)
  7720. (org-agenda-redo)
  7721. (message "Clocktable mode is %s"
  7722. (if org-agenda-clockreport-mode "on" "off")))
  7723. (defun org-agenda-log-mode (&optional special)
  7724. "Toggle log mode in an agenda buffer.
  7725. With argument SPECIAL, show all possible log items, not only the ones
  7726. configured in `org-agenda-log-mode-items'.
  7727. With a `\\[universal-argument] \\[universal-argument]' prefix, show *only* \
  7728. log items, nothing else."
  7729. (interactive "P")
  7730. (org-agenda-check-type t 'agenda)
  7731. (setq org-agenda-show-log
  7732. (cond
  7733. ((equal special '(16)) 'only)
  7734. ((eq special 'clockcheck)
  7735. (if (eq org-agenda-show-log 'clockcheck)
  7736. nil 'clockcheck))
  7737. (special '(closed clock state))
  7738. (t (not org-agenda-show-log))))
  7739. (org-agenda-set-mode-name)
  7740. (org-agenda-redo)
  7741. (message "Log mode is %s" (if org-agenda-show-log "on" "off")))
  7742. (defun org-agenda-archives-mode (&optional with-files)
  7743. "Toggle inclusion of items in trees marked with :ARCHIVE:.
  7744. When called with a prefix argument, include all archive files as well."
  7745. (interactive "P")
  7746. (setq org-agenda-archives-mode
  7747. (if with-files t (if org-agenda-archives-mode nil 'trees)))
  7748. (org-agenda-set-mode-name)
  7749. (org-agenda-redo)
  7750. (message
  7751. "%s"
  7752. (cond
  7753. ((eq org-agenda-archives-mode nil)
  7754. "No archives are included")
  7755. ((eq org-agenda-archives-mode 'trees)
  7756. (format "Trees with :%s: tag are included" org-archive-tag))
  7757. ((eq org-agenda-archives-mode t)
  7758. (format "Trees with :%s: tag and all active archive files are included"
  7759. org-archive-tag)))))
  7760. (defun org-agenda-toggle-diary ()
  7761. "Toggle diary inclusion in an agenda buffer."
  7762. (interactive)
  7763. (org-agenda-check-type t 'agenda)
  7764. (setq org-agenda-include-diary (not org-agenda-include-diary))
  7765. (org-agenda-redo)
  7766. (org-agenda-set-mode-name)
  7767. (message "Diary inclusion turned %s"
  7768. (if org-agenda-include-diary "on" "off")))
  7769. (defun org-agenda-toggle-deadlines ()
  7770. "Toggle inclusion of entries with a deadline in an agenda buffer."
  7771. (interactive)
  7772. (org-agenda-check-type t 'agenda)
  7773. (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
  7774. (org-agenda-redo)
  7775. (org-agenda-set-mode-name)
  7776. (message "Deadlines inclusion turned %s"
  7777. (if org-agenda-include-deadlines "on" "off")))
  7778. (defun org-agenda-toggle-time-grid ()
  7779. "Toggle time grid in an agenda buffer."
  7780. (interactive)
  7781. (org-agenda-check-type t 'agenda)
  7782. (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
  7783. (org-agenda-redo)
  7784. (org-agenda-set-mode-name)
  7785. (message "Time-grid turned %s"
  7786. (if org-agenda-use-time-grid "on" "off")))
  7787. (defun org-agenda-set-mode-name ()
  7788. "Set the mode name to indicate all the small mode settings."
  7789. (setq mode-name
  7790. (list "Org-Agenda"
  7791. (if (get 'org-agenda-files 'org-restrict) " []" "")
  7792. " "
  7793. '(:eval (org-agenda-span-name org-agenda-current-span))
  7794. (if org-agenda-follow-mode " Follow" "")
  7795. (if org-agenda-entry-text-mode " ETxt" "")
  7796. (if org-agenda-include-diary " Diary" "")
  7797. (if org-agenda-include-deadlines " Ddl" "")
  7798. (if org-agenda-use-time-grid " Grid" "")
  7799. (if (and (boundp 'org-habit-show-habits)
  7800. org-habit-show-habits) " Habit" "")
  7801. (cond
  7802. ((consp org-agenda-show-log) " LogAll")
  7803. ((eq org-agenda-show-log 'clockcheck) " ClkCk")
  7804. (org-agenda-show-log " Log")
  7805. (t ""))
  7806. (if (or org-agenda-category-filter
  7807. (get 'org-agenda-category-filter :preset-filter))
  7808. '(:eval (propertize
  7809. (concat " <"
  7810. (mapconcat
  7811. 'identity
  7812. (append
  7813. (get 'org-agenda-category-filter :preset-filter)
  7814. org-agenda-category-filter)
  7815. "")
  7816. ">")
  7817. 'face 'org-agenda-filter-category
  7818. 'help-echo "Category used in filtering")) "")
  7819. (if (or org-agenda-tag-filter
  7820. (get 'org-agenda-tag-filter :preset-filter))
  7821. '(:eval (propertize
  7822. (concat " {"
  7823. (mapconcat
  7824. 'identity
  7825. (append
  7826. (get 'org-agenda-tag-filter :preset-filter)
  7827. org-agenda-tag-filter)
  7828. "")
  7829. "}")
  7830. 'face 'org-agenda-filter-tags
  7831. 'help-echo "Tags used in filtering")) "")
  7832. (if (or org-agenda-effort-filter
  7833. (get 'org-agenda-effort-filter :preset-filter))
  7834. '(:eval (propertize
  7835. (concat " {"
  7836. (mapconcat
  7837. 'identity
  7838. (append
  7839. (get 'org-agenda-effort-filter :preset-filter)
  7840. org-agenda-effort-filter)
  7841. "")
  7842. "}")
  7843. 'face 'org-agenda-filter-effort
  7844. 'help-echo "Effort conditions used in filtering")) "")
  7845. (if (or org-agenda-regexp-filter
  7846. (get 'org-agenda-regexp-filter :preset-filter))
  7847. '(:eval (propertize
  7848. (concat " ["
  7849. (mapconcat
  7850. 'identity
  7851. (append
  7852. (get 'org-agenda-regexp-filter :preset-filter)
  7853. org-agenda-regexp-filter)
  7854. "")
  7855. "]")
  7856. 'face 'org-agenda-filter-regexp
  7857. 'help-echo "Regexp used in filtering")) "")
  7858. (if org-agenda-archives-mode
  7859. (if (eq org-agenda-archives-mode t)
  7860. " Archives"
  7861. (format " :%s:" org-archive-tag))
  7862. "")
  7863. (if org-agenda-clockreport-mode " Clock" "")))
  7864. (force-mode-line-update))
  7865. (defun org-agenda-update-agenda-type ()
  7866. "Update the agenda type after each command."
  7867. (setq org-agenda-type
  7868. (or (get-text-property (point) 'org-agenda-type)
  7869. (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
  7870. (defun org-agenda-next-line ()
  7871. "Move cursor to the next line, and show if follow mode is active."
  7872. (interactive)
  7873. (call-interactively 'next-line)
  7874. (org-agenda-do-context-action))
  7875. (defun org-agenda-previous-line ()
  7876. "Move cursor to the previous line, and show if follow-mode is active."
  7877. (interactive)
  7878. (call-interactively 'previous-line)
  7879. (org-agenda-do-context-action))
  7880. (defun org-agenda-next-item (n)
  7881. "Move cursor to next agenda item."
  7882. (interactive "p")
  7883. (let ((col (current-column)))
  7884. (dotimes (c n)
  7885. (when (next-single-property-change (point-at-eol) 'org-marker)
  7886. (move-end-of-line 1)
  7887. (goto-char (next-single-property-change (point) 'org-marker))))
  7888. (org-move-to-column col))
  7889. (org-agenda-do-context-action))
  7890. (defun org-agenda-previous-item (n)
  7891. "Move cursor to next agenda item."
  7892. (interactive "p")
  7893. (dotimes (c n)
  7894. (let ((col (current-column))
  7895. (goto (save-excursion
  7896. (move-end-of-line 0)
  7897. (previous-single-property-change (point) 'org-marker))))
  7898. (when goto (goto-char goto))
  7899. (org-move-to-column col)))
  7900. (org-agenda-do-context-action))
  7901. (defun org-agenda-do-context-action ()
  7902. "Show outline path and, maybe, follow mode window."
  7903. (let ((m (org-get-at-bol 'org-marker)))
  7904. (when (and (markerp m) (marker-buffer m))
  7905. (and org-agenda-follow-mode
  7906. (if org-agenda-follow-indirect
  7907. (org-agenda-tree-to-indirect-buffer nil)
  7908. (org-agenda-show)))
  7909. (and org-agenda-show-outline-path
  7910. (org-with-point-at m (org-display-outline-path t))))))
  7911. (defun org-agenda-show-tags ()
  7912. "Show the tags applicable to the current item."
  7913. (interactive)
  7914. (let* ((tags (org-get-at-bol 'tags)))
  7915. (if tags
  7916. (message "Tags are :%s:"
  7917. (org-no-properties (mapconcat 'identity tags ":")))
  7918. (message "No tags associated with this line"))))
  7919. (defun org-agenda-goto (&optional highlight)
  7920. "Go to the entry at point in the corresponding Org file."
  7921. (interactive)
  7922. (let* ((marker (or (org-get-at-bol 'org-marker)
  7923. (org-agenda-error)))
  7924. (buffer (marker-buffer marker))
  7925. (pos (marker-position marker)))
  7926. (switch-to-buffer-other-window buffer)
  7927. (widen)
  7928. (push-mark)
  7929. (goto-char pos)
  7930. (when (derived-mode-p 'org-mode)
  7931. (org-show-context 'agenda)
  7932. (recenter (/ (window-height) 2))
  7933. (org-back-to-heading t)
  7934. (let ((case-fold-search nil))
  7935. (when (re-search-forward org-complex-heading-regexp nil t)
  7936. (goto-char (match-beginning 4)))))
  7937. (run-hooks 'org-agenda-after-show-hook)
  7938. (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
  7939. (defvar org-agenda-after-show-hook nil
  7940. "Normal hook run after an item has been shown from the agenda.
  7941. Point is in the buffer where the item originated.")
  7942. (defun org-agenda-kill ()
  7943. "Kill the entry or subtree belonging to the current agenda entry."
  7944. (interactive)
  7945. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  7946. (let* ((bufname-orig (buffer-name))
  7947. (marker (or (org-get-at-bol 'org-marker)
  7948. (org-agenda-error)))
  7949. (buffer (marker-buffer marker))
  7950. (pos (marker-position marker))
  7951. (type (org-get-at-bol 'type))
  7952. dbeg dend (n 0))
  7953. (org-with-remote-undo buffer
  7954. (with-current-buffer buffer
  7955. (save-excursion
  7956. (goto-char pos)
  7957. (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
  7958. (setq dbeg (progn (org-back-to-heading t) (point))
  7959. dend (org-end-of-subtree t t))
  7960. (setq dbeg (point-at-bol)
  7961. dend (min (point-max) (1+ (point-at-eol)))))
  7962. (goto-char dbeg)
  7963. (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
  7964. (when (or (eq t org-agenda-confirm-kill)
  7965. (and (numberp org-agenda-confirm-kill)
  7966. (> n org-agenda-confirm-kill)))
  7967. (let ((win-conf (current-window-configuration)))
  7968. (unwind-protect
  7969. (and
  7970. (prog2
  7971. (org-agenda-tree-to-indirect-buffer nil)
  7972. (not (y-or-n-p
  7973. (format "Delete entry with %d lines in buffer \"%s\"? "
  7974. n (buffer-name buffer))))
  7975. (kill-buffer org-last-indirect-buffer))
  7976. (error "Abort"))
  7977. (set-window-configuration win-conf))))
  7978. (let ((org-agenda-buffer-name bufname-orig))
  7979. (org-remove-subtree-entries-from-agenda buffer dbeg dend))
  7980. (with-current-buffer buffer (delete-region dbeg dend))
  7981. (message "Agenda item and source killed"))))
  7982. (defvar org-archive-default-command) ; defined in org-archive.el
  7983. (defun org-agenda-archive-default ()
  7984. "Archive the entry or subtree belonging to the current agenda entry."
  7985. (interactive)
  7986. (require 'org-archive)
  7987. (org-agenda-archive-with org-archive-default-command))
  7988. (defun org-agenda-archive-default-with-confirmation ()
  7989. "Archive the entry or subtree belonging to the current agenda entry."
  7990. (interactive)
  7991. (require 'org-archive)
  7992. (org-agenda-archive-with org-archive-default-command 'confirm))
  7993. (defun org-agenda-archive ()
  7994. "Archive the entry or subtree belonging to the current agenda entry."
  7995. (interactive)
  7996. (org-agenda-archive-with 'org-archive-subtree))
  7997. (defun org-agenda-archive-to-archive-sibling ()
  7998. "Move the entry to the archive sibling."
  7999. (interactive)
  8000. (org-agenda-archive-with 'org-archive-to-archive-sibling))
  8001. (defun org-agenda-archive-with (cmd &optional confirm)
  8002. "Move the entry to the archive sibling."
  8003. (interactive)
  8004. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  8005. (let* ((bufname-orig (buffer-name))
  8006. (marker (or (org-get-at-bol 'org-marker)
  8007. (org-agenda-error)))
  8008. (buffer (marker-buffer marker))
  8009. (pos (marker-position marker)))
  8010. (org-with-remote-undo buffer
  8011. (with-current-buffer buffer
  8012. (if (derived-mode-p 'org-mode)
  8013. (if (and confirm
  8014. (not (y-or-n-p "Archive this subtree or entry? ")))
  8015. (error "Abort")
  8016. (save-window-excursion
  8017. (goto-char pos)
  8018. (let ((org-agenda-buffer-name bufname-orig))
  8019. (org-remove-subtree-entries-from-agenda))
  8020. (org-back-to-heading t)
  8021. (funcall cmd)))
  8022. (error "Archiving works only in Org files"))))))
  8023. (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
  8024. "Remove all lines in the agenda that correspond to a given subtree.
  8025. The subtree is the one in buffer BUF, starting at BEG and ending at END.
  8026. If this information is not given, the function uses the tree at point."
  8027. (let ((buf (or buf (current-buffer))) m p)
  8028. (save-excursion
  8029. (unless (and beg end)
  8030. (org-back-to-heading t)
  8031. (setq beg (point))
  8032. (org-end-of-subtree t)
  8033. (setq end (point)))
  8034. (set-buffer (get-buffer org-agenda-buffer-name))
  8035. (save-excursion
  8036. (goto-char (point-max))
  8037. (beginning-of-line 1)
  8038. (while (not (bobp))
  8039. (when (and (setq m (org-get-at-bol 'org-marker))
  8040. (equal buf (marker-buffer m))
  8041. (setq p (marker-position m))
  8042. (>= p beg)
  8043. (< p end))
  8044. (let ((inhibit-read-only t))
  8045. (delete-region (point-at-bol) (1+ (point-at-eol)))))
  8046. (beginning-of-line 0))))))
  8047. (defun org-agenda-refile (&optional goto rfloc no-update)
  8048. "Refile the item at point.
  8049. When called with `\\[universal-argument] \\[universal-argument]', \
  8050. go to the location of the last
  8051. refiled item.
  8052. When called with `\\[universal-argument] \\[universal-argument] \
  8053. \\[universal-argument]' prefix or when GOTO is 0, clear
  8054. the refile cache.
  8055. RFLOC can be a refile location obtained in a different way.
  8056. When NO-UPDATE is non-nil, don't redo the agenda buffer."
  8057. (interactive "P")
  8058. (cond
  8059. ((member goto '(0 (64)))
  8060. (org-refile-cache-clear))
  8061. ((equal goto '(16))
  8062. (org-refile-goto-last-stored))
  8063. (t
  8064. (let* ((buffer-orig (buffer-name))
  8065. (marker (or (org-get-at-bol 'org-hd-marker)
  8066. (org-agenda-error)))
  8067. (buffer (marker-buffer marker))
  8068. (pos (marker-position marker))
  8069. (rfloc (or rfloc
  8070. (org-refile-get-location
  8071. (if goto "Goto" "Refile to") buffer
  8072. org-refile-allow-creating-parent-nodes))))
  8073. (with-current-buffer buffer
  8074. (org-with-wide-buffer
  8075. (goto-char marker)
  8076. (let ((org-agenda-buffer-name buffer-orig))
  8077. (org-remove-subtree-entries-from-agenda))
  8078. (org-refile goto buffer rfloc))))
  8079. (unless no-update (org-agenda-redo)))))
  8080. (defun org-agenda-open-link (&optional arg)
  8081. "Open the link(s) in the current entry, if any.
  8082. This looks for a link in the displayed line in the agenda.
  8083. It also looks at the text of the entry itself."
  8084. (interactive "P")
  8085. (let* ((marker (or (org-get-at-bol 'org-hd-marker)
  8086. (org-get-at-bol 'org-marker)))
  8087. (buffer (and marker (marker-buffer marker)))
  8088. (prefix (buffer-substring (point-at-bol) (point-at-eol)))
  8089. (lkall (and buffer (org-offer-links-in-entry
  8090. buffer marker arg prefix)))
  8091. (lk0 (car lkall))
  8092. (lk (if (stringp lk0) (list lk0) lk0))
  8093. (lkend (cdr lkall))
  8094. trg)
  8095. (cond
  8096. ((and buffer lk)
  8097. (mapcar (lambda(l)
  8098. (with-current-buffer buffer
  8099. (setq trg (and (string-match org-link-bracket-re l)
  8100. (match-string 1 l)))
  8101. (if (or (not trg) (string-match org-link-any-re trg))
  8102. (org-with-wide-buffer
  8103. (goto-char marker)
  8104. (when (search-forward l nil lkend)
  8105. (goto-char (match-beginning 0))
  8106. (org-open-at-point)))
  8107. ;; This is an internal link, widen the buffer
  8108. (switch-to-buffer-other-window buffer)
  8109. (widen)
  8110. (goto-char marker)
  8111. (when (search-forward l nil lkend)
  8112. (goto-char (match-beginning 0))
  8113. (org-open-at-point)))))
  8114. lk))
  8115. ((or (org-in-regexp (concat "\\(" org-link-bracket-re "\\)"))
  8116. (save-excursion
  8117. (beginning-of-line 1)
  8118. (looking-at (concat ".*?\\(" org-link-bracket-re "\\)"))))
  8119. (org-link-open-from-string (match-string 1)))
  8120. (t (message "No link to open here")))))
  8121. (defun org-agenda-copy-local-variable (var)
  8122. "Get a variable from a referenced buffer and install it here."
  8123. (let ((m (org-get-at-bol 'org-marker)))
  8124. (when (and m (buffer-live-p (marker-buffer m)))
  8125. (set (make-local-variable var)
  8126. (with-current-buffer (marker-buffer m)
  8127. (symbol-value var))))))
  8128. (defun org-agenda-switch-to (&optional delete-other-windows)
  8129. "Go to the Org mode file which contains the item at point.
  8130. When optional argument DELETE-OTHER-WINDOWS is non-nil, the
  8131. displayed Org file fills the frame."
  8132. (interactive)
  8133. (if (and org-return-follows-link
  8134. (not (org-get-at-bol 'org-marker))
  8135. (org-in-regexp org-link-bracket-re))
  8136. (org-link-open-from-string (match-string 0))
  8137. (let* ((marker (or (org-get-at-bol 'org-marker)
  8138. (org-agenda-error)))
  8139. (buffer (marker-buffer marker))
  8140. (pos (marker-position marker)))
  8141. (unless buffer (user-error "Trying to switch to non-existent buffer"))
  8142. (pop-to-buffer-same-window buffer)
  8143. (when delete-other-windows (delete-other-windows))
  8144. (widen)
  8145. (goto-char pos)
  8146. (when (derived-mode-p 'org-mode)
  8147. (org-show-context 'agenda)
  8148. (run-hooks 'org-agenda-after-show-hook)))))
  8149. (defun org-agenda-goto-mouse (ev)
  8150. "Go to the Org file which contains the item at the mouse click."
  8151. (interactive "e")
  8152. (mouse-set-point ev)
  8153. (org-agenda-goto))
  8154. (defun org-agenda-show (&optional full-entry)
  8155. "Display the Org file which contains the item at point.
  8156. With prefix argument FULL-ENTRY, make the entire entry visible
  8157. if it was hidden in the outline."
  8158. (interactive "P")
  8159. (let ((win (selected-window)))
  8160. (org-agenda-goto t)
  8161. (when full-entry (org-show-entry))
  8162. (select-window win)))
  8163. (defvar org-agenda-show-window nil)
  8164. (defun org-agenda-show-and-scroll-up (&optional arg)
  8165. "Display the Org file which contains the item at point.
  8166. When called repeatedly, scroll the window that is displaying the buffer.
  8167. With a `\\[universal-argument]' prefix argument, display the item, but \
  8168. fold drawers."
  8169. (interactive "P")
  8170. (let ((win (selected-window)))
  8171. (if (and (window-live-p org-agenda-show-window)
  8172. (eq this-command last-command))
  8173. (progn
  8174. (select-window org-agenda-show-window)
  8175. (ignore-errors (scroll-up)))
  8176. (org-agenda-goto t)
  8177. (org-show-entry)
  8178. (if arg (org-cycle-hide-drawers 'children)
  8179. (org-with-wide-buffer
  8180. (narrow-to-region (org-entry-beginning-position)
  8181. (org-entry-end-position))
  8182. (org-show-all '(drawers))))
  8183. (when arg )
  8184. (setq org-agenda-show-window (selected-window)))
  8185. (select-window win)))
  8186. (defun org-agenda-show-scroll-down ()
  8187. "Scroll down the window showing the agenda."
  8188. (interactive)
  8189. (let ((win (selected-window)))
  8190. (when (window-live-p org-agenda-show-window)
  8191. (select-window org-agenda-show-window)
  8192. (ignore-errors (scroll-down))
  8193. (select-window win))))
  8194. (defun org-agenda-show-1 (&optional more)
  8195. "Display the Org file which contains the item at point.
  8196. The prefix arg selects the amount of information to display:
  8197. 0 hide the subtree
  8198. 1 just show the entry according to defaults.
  8199. 2 show the children view
  8200. 3 show the subtree view
  8201. 4 show the entire subtree and any LOGBOOK drawers
  8202. 5 show the entire subtree and any drawers
  8203. With prefix argument FULL-ENTRY, make the entire entry visible
  8204. if it was hidden in the outline."
  8205. (interactive "p")
  8206. (let ((win (selected-window)))
  8207. (org-agenda-goto t)
  8208. (org-back-to-heading)
  8209. (set-window-start (selected-window) (point-at-bol))
  8210. (cond
  8211. ((= more 0)
  8212. (org-flag-subtree t)
  8213. (save-excursion
  8214. (org-back-to-heading)
  8215. (run-hook-with-args 'org-cycle-hook 'folded))
  8216. (message "Remote: FOLDED"))
  8217. ((and (called-interactively-p 'any) (= more 1))
  8218. (message "Remote: show with default settings"))
  8219. ((= more 2)
  8220. (outline-show-entry)
  8221. (org-show-children)
  8222. (save-excursion
  8223. (org-back-to-heading)
  8224. (run-hook-with-args 'org-cycle-hook 'children))
  8225. (message "Remote: CHILDREN"))
  8226. ((= more 3)
  8227. (outline-show-subtree)
  8228. (save-excursion
  8229. (org-back-to-heading)
  8230. (run-hook-with-args 'org-cycle-hook 'subtree))
  8231. (message "Remote: SUBTREE"))
  8232. ((= more 4)
  8233. (outline-show-subtree)
  8234. (save-excursion
  8235. (org-back-to-heading)
  8236. (org-cycle-hide-drawers 'subtree '("LOGBOOK")))
  8237. (message "Remote: SUBTREE AND LOGBOOK"))
  8238. ((> more 4)
  8239. (outline-show-subtree)
  8240. (message "Remote: SUBTREE AND ALL DRAWERS")))
  8241. (select-window win)))
  8242. (defvar org-agenda-cycle-counter nil)
  8243. (defun org-agenda-cycle-show (&optional n)
  8244. "Show the current entry in another window, with default settings.
  8245. Default settings are taken from `org-show-context-detail'. When
  8246. use repeatedly in immediate succession, the remote entry will
  8247. cycle through visibility
  8248. children -> subtree -> folded
  8249. When called with a numeric prefix arg, that arg will be passed through to
  8250. `org-agenda-show-1'. For the interpretation of that argument, see the
  8251. docstring of `org-agenda-show-1'."
  8252. (interactive "P")
  8253. (if (integerp n)
  8254. (setq org-agenda-cycle-counter n)
  8255. (if (not (eq last-command this-command))
  8256. (setq org-agenda-cycle-counter 1)
  8257. (if (equal org-agenda-cycle-counter 0)
  8258. (setq org-agenda-cycle-counter 2)
  8259. (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
  8260. (when (> org-agenda-cycle-counter 3)
  8261. (setq org-agenda-cycle-counter 0)))))
  8262. (org-agenda-show-1 org-agenda-cycle-counter))
  8263. (defun org-agenda-recenter (arg)
  8264. "Display the Org file which contains the item at point and recenter."
  8265. (interactive "P")
  8266. (let ((win (selected-window)))
  8267. (org-agenda-goto t)
  8268. (recenter arg)
  8269. (select-window win)))
  8270. (defun org-agenda-show-mouse (ev)
  8271. "Display the Org file which contains the item at the mouse click."
  8272. (interactive "e")
  8273. (mouse-set-point ev)
  8274. (org-agenda-show))
  8275. (defun org-agenda-check-no-diary ()
  8276. "Check if the entry is a diary link and abort if yes."
  8277. (when (org-get-at-bol 'org-agenda-diary-link)
  8278. (org-agenda-error)))
  8279. (defun org-agenda-error ()
  8280. "Throw an error when a command is not allowed in the agenda."
  8281. (user-error "Command not allowed in this line"))
  8282. (defun org-agenda-tree-to-indirect-buffer (arg)
  8283. "Show the subtree corresponding to the current entry in an indirect buffer.
  8284. This calls the command `org-tree-to-indirect-buffer' from the original buffer.
  8285. With a numerical prefix ARG, go up to this level and then take that tree.
  8286. With a negative numeric ARG, go up by this number of levels.
  8287. With a `\\[universal-argument]' prefix, make a separate frame for this tree, \
  8288. i.e. don't use
  8289. the dedicated frame."
  8290. (interactive "P")
  8291. (if current-prefix-arg
  8292. (org-agenda-do-tree-to-indirect-buffer arg)
  8293. (let ((agenda-buffer (buffer-name))
  8294. (agenda-window (selected-window))
  8295. (indirect-window
  8296. (and org-last-indirect-buffer
  8297. (get-buffer-window org-last-indirect-buffer))))
  8298. (save-window-excursion (org-agenda-do-tree-to-indirect-buffer arg))
  8299. (unless (or (eq org-indirect-buffer-display 'new-frame)
  8300. (eq org-indirect-buffer-display 'dedicated-frame))
  8301. (unwind-protect
  8302. (unless (and indirect-window (window-live-p indirect-window))
  8303. (setq indirect-window (split-window agenda-window)))
  8304. (and indirect-window (select-window indirect-window))
  8305. (switch-to-buffer org-last-indirect-buffer :norecord)
  8306. (fit-window-to-buffer indirect-window)))
  8307. (select-window (get-buffer-window agenda-buffer))
  8308. (setq org-agenda-last-indirect-buffer org-last-indirect-buffer))))
  8309. (defun org-agenda-do-tree-to-indirect-buffer (arg)
  8310. "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
  8311. (org-agenda-check-no-diary)
  8312. (let* ((marker (or (org-get-at-bol 'org-marker)
  8313. (org-agenda-error)))
  8314. (buffer (marker-buffer marker))
  8315. (pos (marker-position marker)))
  8316. (with-current-buffer buffer
  8317. (save-excursion
  8318. (goto-char pos)
  8319. (org-tree-to-indirect-buffer arg)))))
  8320. (defvar org-last-heading-marker (make-marker)
  8321. "Marker pointing to the headline that last changed its TODO state
  8322. by a remote command from the agenda.")
  8323. (defun org-agenda-todo-nextset ()
  8324. "Switch TODO entry to next sequence."
  8325. (interactive)
  8326. (org-agenda-todo 'nextset))
  8327. (defun org-agenda-todo-previousset ()
  8328. "Switch TODO entry to previous sequence."
  8329. (interactive)
  8330. (org-agenda-todo 'previousset))
  8331. (defun org-agenda-todo (&optional arg)
  8332. "Cycle TODO state of line at point, also in Org file.
  8333. This changes the line at point, all other lines in the agenda referring to
  8334. the same tree node, and the headline of the tree node in the Org file."
  8335. (interactive "P")
  8336. (org-agenda-check-no-diary)
  8337. (let* ((col (current-column))
  8338. (marker (or (org-get-at-bol 'org-marker)
  8339. (org-agenda-error)))
  8340. (buffer (marker-buffer marker))
  8341. (pos (marker-position marker))
  8342. (hdmarker (org-get-at-bol 'org-hd-marker))
  8343. (todayp (org-agenda-today-p (org-get-at-bol 'day)))
  8344. (inhibit-read-only t)
  8345. org-agenda-headline-snapshot-before-repeat newhead just-one)
  8346. (org-with-remote-undo buffer
  8347. (with-current-buffer buffer
  8348. (widen)
  8349. (goto-char pos)
  8350. (org-show-context 'agenda)
  8351. (let ((current-prefix-arg arg))
  8352. (call-interactively 'org-todo))
  8353. (and (bolp) (forward-char 1))
  8354. (setq newhead (org-get-heading))
  8355. (when (and (bound-and-true-p
  8356. org-agenda-headline-snapshot-before-repeat)
  8357. (not (equal org-agenda-headline-snapshot-before-repeat
  8358. newhead))
  8359. todayp)
  8360. (setq newhead org-agenda-headline-snapshot-before-repeat
  8361. just-one t))
  8362. (save-excursion
  8363. (org-back-to-heading)
  8364. (move-marker org-last-heading-marker (point))))
  8365. (beginning-of-line 1)
  8366. (save-window-excursion
  8367. (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
  8368. (when (bound-and-true-p org-clock-out-when-done)
  8369. (string-match (concat "^" (regexp-opt org-done-keywords-for-agenda))
  8370. newhead)
  8371. (org-agenda-unmark-clocking-task))
  8372. (org-move-to-column col)
  8373. (org-agenda-mark-clocking-task))))
  8374. (defun org-agenda-add-note (&optional arg)
  8375. "Add a time-stamped note to the entry at point."
  8376. (interactive "P")
  8377. (org-agenda-check-no-diary)
  8378. (let* ((marker (or (org-get-at-bol 'org-marker)
  8379. (org-agenda-error)))
  8380. (buffer (marker-buffer marker))
  8381. (pos (marker-position marker))
  8382. (hdmarker (org-get-at-bol 'org-hd-marker))
  8383. (inhibit-read-only t))
  8384. (with-current-buffer buffer
  8385. (widen)
  8386. (goto-char pos)
  8387. (org-show-context 'agenda)
  8388. (org-add-note))))
  8389. (defun org-agenda-change-all-lines (newhead hdmarker
  8390. &optional fixface just-this)
  8391. "Change all lines in the agenda buffer which match HDMARKER.
  8392. The new content of the line will be NEWHEAD (as modified by
  8393. `org-agenda-format-item'). HDMARKER is checked with
  8394. `equal' against all `org-hd-marker' text properties in the file.
  8395. If FIXFACE is non-nil, the face of each item is modified according to
  8396. the new TODO state.
  8397. If JUST-THIS is non-nil, change just the current line, not all.
  8398. If FORCE-TAGS is non nil, the car of it returns the new tags."
  8399. (let* ((inhibit-read-only t)
  8400. (line (org-current-line))
  8401. (org-agenda-buffer (current-buffer))
  8402. (thetags (with-current-buffer (marker-buffer hdmarker)
  8403. (org-get-tags hdmarker)))
  8404. props m pl undone-face done-face finish new dotime level cat tags)
  8405. (save-excursion
  8406. (goto-char (point-max))
  8407. (beginning-of-line 1)
  8408. (while (not finish)
  8409. (setq finish (bobp))
  8410. (when (and (setq m (org-get-at-bol 'org-hd-marker))
  8411. (or (not just-this) (= (org-current-line) line))
  8412. (equal m hdmarker))
  8413. (setq props (text-properties-at (point))
  8414. dotime (org-get-at-bol 'dotime)
  8415. cat (org-agenda-get-category)
  8416. level (org-get-at-bol 'level)
  8417. tags thetags
  8418. new
  8419. (let ((org-prefix-format-compiled
  8420. (or (get-text-property (min (1- (point-max)) (point)) 'format)
  8421. org-prefix-format-compiled))
  8422. (extra (org-get-at-bol 'extra)))
  8423. (with-current-buffer (marker-buffer hdmarker)
  8424. (org-with-wide-buffer
  8425. (org-agenda-format-item extra newhead level cat tags dotime))))
  8426. pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
  8427. undone-face (org-get-at-bol 'undone-face)
  8428. done-face (org-get-at-bol 'done-face))
  8429. (beginning-of-line 1)
  8430. (cond
  8431. ((equal new "") (delete-region (point) (line-beginning-position 2)))
  8432. ((looking-at ".*")
  8433. ;; When replacing the whole line, preserve bulk mark
  8434. ;; overlay, if any.
  8435. (let ((mark (catch :overlay
  8436. (dolist (o (overlays-in (point) (+ 2 (point))))
  8437. (when (eq (overlay-get o 'type)
  8438. 'org-marked-entry-overlay)
  8439. (throw :overlay o))))))
  8440. (replace-match new t t)
  8441. (beginning-of-line)
  8442. (when mark (move-overlay mark (point) (+ 2 (point)))))
  8443. (add-text-properties (point-at-bol) (point-at-eol) props)
  8444. (when fixface
  8445. (add-text-properties
  8446. (point-at-bol) (point-at-eol)
  8447. (list 'face
  8448. (if org-last-todo-state-is-todo
  8449. undone-face done-face))))
  8450. (org-agenda-highlight-todo 'line)
  8451. (beginning-of-line 1))
  8452. (t (error "Line update did not work")))
  8453. (save-restriction
  8454. (narrow-to-region (point-at-bol) (point-at-eol))
  8455. (org-agenda-finalize)))
  8456. (beginning-of-line 0)))))
  8457. (defun org-agenda-align-tags (&optional line)
  8458. "Align all tags in agenda items to `org-agenda-tags-column'.
  8459. When optional argument LINE is non-nil, align tags only on the
  8460. current line."
  8461. (let ((inhibit-read-only t)
  8462. (org-agenda-tags-column (if (eq 'auto org-agenda-tags-column)
  8463. (- (window-text-width))
  8464. org-agenda-tags-column))
  8465. (end (and line (line-end-position)))
  8466. l c)
  8467. (save-excursion
  8468. (goto-char (if line (line-beginning-position) (point-min)))
  8469. (while (re-search-forward org-tag-group-re end t)
  8470. (add-text-properties
  8471. (match-beginning 1) (match-end 1)
  8472. (list 'face (delq nil (let ((prop (get-text-property
  8473. (match-beginning 1) 'face)))
  8474. (or (listp prop) (setq prop (list prop)))
  8475. (if (memq 'org-tag prop)
  8476. prop
  8477. (cons 'org-tag prop))))))
  8478. (setq l (string-width (match-string 1))
  8479. c (if (< org-agenda-tags-column 0)
  8480. (- (abs org-agenda-tags-column) l)
  8481. org-agenda-tags-column))
  8482. (goto-char (match-beginning 1))
  8483. (delete-region (save-excursion (skip-chars-backward " \t") (point))
  8484. (point))
  8485. (insert (org-add-props
  8486. (make-string (max 1 (- c (current-column))) ?\s)
  8487. (plist-put (copy-sequence (text-properties-at (point)))
  8488. 'face nil))))
  8489. (goto-char (point-min))
  8490. (org-font-lock-add-tag-faces (point-max)))))
  8491. (defun org-agenda-priority-up ()
  8492. "Increase the priority of line at point, also in Org file."
  8493. (interactive)
  8494. (org-agenda-priority 'up))
  8495. (defun org-agenda-priority-down ()
  8496. "Decrease the priority of line at point, also in Org file."
  8497. (interactive)
  8498. (org-agenda-priority 'down))
  8499. (defun org-agenda-priority (&optional force-direction)
  8500. "Set the priority of line at point, also in Org file.
  8501. This changes the line at point, all other lines in the agenda referring to
  8502. the same tree node, and the headline of the tree node in the Org file.
  8503. Called with a universal prefix arg, show the priority instead of setting it."
  8504. (interactive "P")
  8505. (if (equal force-direction '(4))
  8506. (org-show-priority)
  8507. (unless org-enable-priority-commands
  8508. (error "Priority commands are disabled"))
  8509. (org-agenda-check-no-diary)
  8510. (let* ((col (current-column))
  8511. (marker (or (org-get-at-bol 'org-marker)
  8512. (org-agenda-error)))
  8513. (hdmarker (org-get-at-bol 'org-hd-marker))
  8514. (buffer (marker-buffer hdmarker))
  8515. (pos (marker-position hdmarker))
  8516. (inhibit-read-only t)
  8517. newhead)
  8518. (org-with-remote-undo buffer
  8519. (with-current-buffer buffer
  8520. (widen)
  8521. (goto-char pos)
  8522. (org-show-context 'agenda)
  8523. (org-priority force-direction)
  8524. (end-of-line 1)
  8525. (setq newhead (org-get-heading)))
  8526. (org-agenda-change-all-lines newhead hdmarker)
  8527. (org-move-to-column col)))))
  8528. ;; FIXME: should fix the tags property of the agenda line.
  8529. (defun org-agenda-set-tags (&optional tag onoff)
  8530. "Set tags for the current headline."
  8531. (interactive)
  8532. (org-agenda-check-no-diary)
  8533. (if (and (org-region-active-p) (called-interactively-p 'any))
  8534. (call-interactively 'org-change-tag-in-region)
  8535. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8536. (org-agenda-error)))
  8537. (buffer (marker-buffer hdmarker))
  8538. (pos (marker-position hdmarker))
  8539. (inhibit-read-only t)
  8540. newhead)
  8541. (org-with-remote-undo buffer
  8542. (with-current-buffer buffer
  8543. (widen)
  8544. (goto-char pos)
  8545. (org-show-context 'agenda)
  8546. (if tag
  8547. (org-toggle-tag tag onoff)
  8548. (call-interactively #'org-set-tags-command))
  8549. (end-of-line 1)
  8550. (setq newhead (org-get-heading)))
  8551. (org-agenda-change-all-lines newhead hdmarker)
  8552. (beginning-of-line 1)))))
  8553. (defun org-agenda-set-property ()
  8554. "Set a property for the current headline."
  8555. (interactive)
  8556. (org-agenda-check-no-diary)
  8557. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8558. (org-agenda-error)))
  8559. (buffer (marker-buffer hdmarker))
  8560. (pos (marker-position hdmarker))
  8561. (inhibit-read-only t)
  8562. newhead)
  8563. (org-with-remote-undo buffer
  8564. (with-current-buffer buffer
  8565. (widen)
  8566. (goto-char pos)