org-agenda.el 391 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122
  1. ;;; org-agenda.el --- Dynamic task and appointment lists for Org
  2. ;; Copyright (C) 2004-2014 Free Software Foundation, Inc.
  3. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; Homepage: http://orgmode.org
  6. ;;
  7. ;; This file is part of GNU Emacs.
  8. ;;
  9. ;; GNU Emacs is free software: you can redistribute it and/or modify
  10. ;; it under the terms of the GNU General Public License as published by
  11. ;; the Free Software Foundation, either version 3 of the License, or
  12. ;; (at your option) any later version.
  13. ;; GNU Emacs is distributed in the hope that it will be useful,
  14. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. ;; GNU General Public License for more details.
  17. ;; You should have received a copy of the GNU General Public License
  18. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  19. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  20. ;;
  21. ;;; Commentary:
  22. ;; This file contains the code for creating and using the Agenda for Org-mode.
  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 'org)
  42. (require 'org-macs)
  43. (eval-when-compile
  44. (require 'cl))
  45. (declare-function diary-add-to-list "diary-lib"
  46. (date string specifier &optional marker globcolor literal))
  47. (declare-function calendar-absolute-from-iso "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-pop-to-buffer-same-window "org-compat"
  75. (&optional buffer-or-name norecord label))
  76. (declare-function org-agenda-columns "org-colview" ())
  77. (declare-function org-add-archive-files "org-archive" (files))
  78. (declare-function org-capture "org-capture" (&optional goto keys))
  79. (defvar calendar-mode-map) ; defined in calendar.el
  80. (defvar org-clock-current-task nil) ; defined in org-clock.el
  81. (defvar org-mobile-force-id-on-agenda-items) ; defined in org-mobile.el
  82. (defvar org-habit-show-habits) ; defined in org-habit.el
  83. (defvar org-habit-show-habits-only-for-today)
  84. (defvar org-habit-show-all-today)
  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. (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  90. (org-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. (org-defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
  234. (org-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'. `:deadline' must appear before
  247. `:scheduled' if the setting of
  248. `org-agenda-skip-scheduled-if-deadline-is-shown' is to have
  249. any effect.
  250. :deadline* Same as above, but only include the deadline if it has an
  251. hour specification as [h]h:mm.
  252. :scheduled List all items which are scheduled for the given date.
  253. The diary for *today* also contains items which were
  254. scheduled earlier and are not yet marked DONE.
  255. :scheduled* Same as above, but only include the scheduled item if it
  256. has an hour specification as [h]h:mm.
  257. By default, all four non-starred types are turned on.
  258. When :scheduled* or :deadline* are included, :schedule or :deadline
  259. will be ignored.
  260. Never set this variable globally using `setq', because then it
  261. will apply to all future agenda commands. Instead, bind it with
  262. `let' to scope it dynamically into the agenda-constructing
  263. command. A good way to set it is through options in
  264. `org-agenda-custom-commands'. For a more flexible (though
  265. somewhat less efficient) way of determining what is included in
  266. the daily/weekly agenda, see `org-agenda-skip-function'.")
  267. (defconst org-agenda-custom-commands-local-options
  268. `(repeat :tag "Local settings for this command. Remember to quote values"
  269. (choice :tag "Setting"
  270. (list :tag "Heading for this block"
  271. (const org-agenda-overriding-header)
  272. (string :tag "Headline"))
  273. (list :tag "Files to be searched"
  274. (const org-agenda-files)
  275. (list
  276. (const :format "" quote)
  277. (repeat (file))))
  278. (list :tag "Sorting strategy"
  279. (const org-agenda-sorting-strategy)
  280. (list
  281. (const :format "" quote)
  282. (repeat
  283. ,org-sorting-choice)))
  284. (list :tag "Prefix format"
  285. (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
  286. (string))
  287. (list :tag "Number of days in agenda"
  288. (const org-agenda-span)
  289. (choice (const :tag "Day" day)
  290. (const :tag "Week" week)
  291. (const :tag "Fortnight" fortnight)
  292. (const :tag "Month" month)
  293. (const :tag "Year" year)
  294. (integer :tag "Custom")))
  295. (list :tag "Fixed starting date"
  296. (const org-agenda-start-day)
  297. (string :value "2007-11-01"))
  298. (list :tag "Start on day of week"
  299. (const org-agenda-start-on-weekday)
  300. (choice :value 1
  301. (const :tag "Today" nil)
  302. (integer :tag "Weekday No.")))
  303. (list :tag "Include data from diary"
  304. (const org-agenda-include-diary)
  305. (boolean))
  306. (list :tag "Deadline Warning days"
  307. (const org-deadline-warning-days)
  308. (integer :value 1))
  309. (list :tag "Category filter preset"
  310. (const org-agenda-category-filter-preset)
  311. (list
  312. (const :format "" quote)
  313. (repeat
  314. (string :tag "+category or -category"))))
  315. (list :tag "Tags filter preset"
  316. (const org-agenda-tag-filter-preset)
  317. (list
  318. (const :format "" quote)
  319. (repeat
  320. (string :tag "+tag or -tag"))))
  321. (list :tag "Regexp filter preset"
  322. (const org-agenda-regexp-filter-preset)
  323. (list
  324. (const :format "" quote)
  325. (repeat
  326. (string :tag "+regexp or -regexp"))))
  327. (list :tag "Set daily/weekly entry types"
  328. (const org-agenda-entry-types)
  329. (list
  330. (const :format "" quote)
  331. (set :greedy t :value ,org-agenda-entry-types
  332. (const :deadline)
  333. (const :scheduled)
  334. (const :deadline*)
  335. (const :scheduled*)
  336. (const :timestamp)
  337. (const :sexp))))
  338. (list :tag "Standard skipping condition"
  339. :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
  340. (const org-agenda-skip-function)
  341. (list
  342. (const :format "" quote)
  343. (list
  344. (choice
  345. :tag "Skipping range"
  346. (const :tag "Skip entry" org-agenda-skip-entry-if)
  347. (const :tag "Skip subtree" org-agenda-skip-subtree-if))
  348. (repeat :inline t :tag "Conditions for skipping"
  349. (choice
  350. :tag "Condition type"
  351. (list :tag "Regexp matches" :inline t (const :format "" regexp) (regexp))
  352. (list :tag "Regexp does not match" :inline t (const :format "" notregexp) (regexp))
  353. (list :tag "TODO state is" :inline t
  354. (const todo)
  355. (choice
  356. (const :tag "any not-done state" todo)
  357. (const :tag "any done state" done)
  358. (const :tag "any state" any)
  359. (list :tag "Keyword list"
  360. (const :format "" quote)
  361. (repeat (string :tag "Keyword")))))
  362. (list :tag "TODO state is not" :inline t
  363. (const nottodo)
  364. (choice
  365. (const :tag "any not-done state" todo)
  366. (const :tag "any done state" done)
  367. (const :tag "any state" any)
  368. (list :tag "Keyword list"
  369. (const :format "" quote)
  370. (repeat (string :tag "Keyword")))))
  371. (const :tag "scheduled" scheduled)
  372. (const :tag "not scheduled" notscheduled)
  373. (const :tag "deadline" deadline)
  374. (const :tag "no deadline" notdeadline)
  375. (const :tag "timestamp" timestamp)
  376. (const :tag "no timestamp" nottimestamp))))))
  377. (list :tag "Non-standard skipping condition"
  378. :value (org-agenda-skip-function)
  379. (const org-agenda-skip-function)
  380. (sexp :tag "Function or form (quoted!)"))
  381. (list :tag "Any variable"
  382. (variable :tag "Variable")
  383. (sexp :tag "Value (sexp)"))))
  384. "Selection of examples for agenda command settings.
  385. This will be spliced into the custom type of
  386. `org-agenda-custom-commands'.")
  387. (defcustom org-agenda-custom-commands
  388. '(("n" "Agenda and all TODO's" ((agenda "") (alltodo ""))))
  389. "Custom commands for the agenda.
  390. These commands will be offered on the splash screen displayed by the
  391. agenda dispatcher \\[org-agenda]. Each entry is a list like this:
  392. (key desc type match settings files)
  393. key The key (one or more characters as a string) to be associated
  394. with the command.
  395. desc A description of the command, when omitted or nil, a default
  396. description is built using MATCH.
  397. type The command type, any of the following symbols:
  398. agenda The daily/weekly agenda.
  399. todo Entries with a specific TODO keyword, in all agenda files.
  400. search Entries containing search words entry or headline.
  401. tags Tags/Property/TODO match in all agenda files.
  402. tags-todo Tags/P/T match in all agenda files, TODO entries only.
  403. todo-tree Sparse tree of specific TODO keyword in *current* file.
  404. tags-tree Sparse tree with all tags matches in *current* file.
  405. occur-tree Occur sparse tree for *current* file.
  406. ... A user-defined function.
  407. match What to search for:
  408. - a single keyword for TODO keyword searches
  409. - a tags match expression for tags searches
  410. - a word search expression for text searches.
  411. - a regular expression for occur searches
  412. For all other commands, this should be the empty string.
  413. settings A list of option settings, similar to that in a let form, so like
  414. this: ((opt1 val1) (opt2 val2) ...). The values will be
  415. evaluated at the moment of execution, so quote them when needed.
  416. files A list of files file to write the produced agenda buffer to
  417. with the command `org-store-agenda-views'.
  418. If a file name ends in \".html\", an HTML version of the buffer
  419. is written out. If it ends in \".ps\", a postscript version is
  420. produced. Otherwise, only the plain text is written to the file.
  421. You can also define a set of commands, to create a composite agenda buffer.
  422. In this case, an entry looks like this:
  423. (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
  424. where
  425. desc A description string to be displayed in the dispatcher menu.
  426. cmd An agenda command, similar to the above. However, tree commands
  427. are not allowed, but instead you can get agenda and global todo list.
  428. So valid commands for a set are:
  429. (agenda \"\" settings)
  430. (alltodo \"\" settings)
  431. (stuck \"\" settings)
  432. (todo \"match\" settings files)
  433. (search \"match\" settings files)
  434. (tags \"match\" settings files)
  435. (tags-todo \"match\" settings files)
  436. Each command can carry a list of options, and another set of options can be
  437. given for the whole set of commands. Individual command options take
  438. precedence over the general options.
  439. When using several characters as key to a command, the first characters
  440. are prefix commands. For the dispatcher to display useful information, you
  441. should provide a description for the prefix, like
  442. (setq org-agenda-custom-commands
  443. '((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
  444. (\"hl\" tags \"+HOME+Lisa\")
  445. (\"hp\" tags \"+HOME+Peter\")
  446. (\"hk\" tags \"+HOME+Kim\")))"
  447. :group 'org-agenda-custom-commands
  448. :type `(repeat
  449. (choice :value ("x" "Describe command here" tags "" nil)
  450. (list :tag "Single command"
  451. (string :tag "Access Key(s) ")
  452. (option (string :tag "Description"))
  453. (choice
  454. (const :tag "Agenda" agenda)
  455. (const :tag "TODO list" alltodo)
  456. (const :tag "Search words" search)
  457. (const :tag "Stuck projects" stuck)
  458. (const :tag "Tags/Property match (all agenda files)" tags)
  459. (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
  460. (const :tag "TODO keyword search (all agenda files)" todo)
  461. (const :tag "Tags sparse tree (current buffer)" tags-tree)
  462. (const :tag "TODO keyword tree (current buffer)" todo-tree)
  463. (const :tag "Occur tree (current buffer)" occur-tree)
  464. (sexp :tag "Other, user-defined function"))
  465. (string :tag "Match (only for some commands)")
  466. ,org-agenda-custom-commands-local-options
  467. (option (repeat :tag "Export" (file :tag "Export to"))))
  468. (list :tag "Command series, all agenda files"
  469. (string :tag "Access Key(s)")
  470. (string :tag "Description ")
  471. (repeat :tag "Component"
  472. (choice
  473. (list :tag "Agenda"
  474. (const :format "" agenda)
  475. (const :tag "" :format "" "")
  476. ,org-agenda-custom-commands-local-options)
  477. (list :tag "TODO list (all keywords)"
  478. (const :format "" alltodo)
  479. (const :tag "" :format "" "")
  480. ,org-agenda-custom-commands-local-options)
  481. (list :tag "Search words"
  482. (const :format "" search)
  483. (string :tag "Match")
  484. ,org-agenda-custom-commands-local-options)
  485. (list :tag "Stuck projects"
  486. (const :format "" stuck)
  487. (const :tag "" :format "" "")
  488. ,org-agenda-custom-commands-local-options)
  489. (list :tag "Tags search"
  490. (const :format "" tags)
  491. (string :tag "Match")
  492. ,org-agenda-custom-commands-local-options)
  493. (list :tag "Tags search, TODO entries only"
  494. (const :format "" tags-todo)
  495. (string :tag "Match")
  496. ,org-agenda-custom-commands-local-options)
  497. (list :tag "TODO keyword search"
  498. (const :format "" todo)
  499. (string :tag "Match")
  500. ,org-agenda-custom-commands-local-options)
  501. (list :tag "Other, user-defined function"
  502. (symbol :tag "function")
  503. (string :tag "Match")
  504. ,org-agenda-custom-commands-local-options)))
  505. (repeat :tag "Settings for entire command set"
  506. (list (variable :tag "Any variable")
  507. (sexp :tag "Value")))
  508. (option (repeat :tag "Export" (file :tag "Export to"))))
  509. (cons :tag "Prefix key documentation"
  510. (string :tag "Access Key(s)")
  511. (string :tag "Description ")))))
  512. (defcustom org-agenda-query-register ?o
  513. "The register holding the current query string.
  514. The purpose of this is that if you construct a query string interactively,
  515. you can then use it to define a custom command."
  516. :group 'org-agenda-custom-commands
  517. :type 'character)
  518. (defcustom org-stuck-projects
  519. '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
  520. "How to identify stuck projects.
  521. This is a list of four items:
  522. 1. A tags/todo/property matcher string that is used to identify a project.
  523. See the manual for a description of tag and property searches.
  524. The entire tree below a headline matched by this is considered one project.
  525. 2. A list of TODO keywords identifying non-stuck projects.
  526. If the project subtree contains any headline with one of these todo
  527. keywords, the project is considered to be not stuck. If you specify
  528. \"*\" as a keyword, any TODO keyword will mark the project unstuck.
  529. 3. A list of tags identifying non-stuck projects.
  530. If the project subtree contains any headline with one of these tags,
  531. the project is considered to be not stuck. If you specify \"*\" as
  532. a tag, any tag will mark the project unstuck. Note that this is about
  533. the explicit presence of a tag somewhere in the subtree, inherited
  534. tags do not count here. If inherited tags make a project not stuck,
  535. use \"-TAG\" in the tags part of the matcher under (1.) above.
  536. 4. An arbitrary regular expression matching non-stuck projects.
  537. If the project turns out to be not stuck, search continues also in the
  538. subtree to see if any of the subtasks have project status.
  539. See also the variable `org-tags-match-list-sublevels' which applies
  540. to projects matched by this search as well.
  541. After defining this variable, you may use \\[org-agenda-list-stuck-projects]
  542. or `C-c a #' to produce the list."
  543. :group 'org-agenda-custom-commands
  544. :type '(list
  545. (string :tag "Tags/TODO match to identify a project")
  546. (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
  547. (repeat :tag "Projects are *not* stuck if they have an entry with TAG being any of" (string))
  548. (regexp :tag "Projects are *not* stuck if this regexp matches inside the subtree")))
  549. (defcustom org-agenda-filter-effort-default-operator "<"
  550. "The default operator for effort estimate filtering.
  551. If you select an effort estimate limit without first pressing an operator,
  552. this one will be used."
  553. :group 'org-agenda-custom-commands
  554. :type '(choice (const :tag "less or equal" "<")
  555. (const :tag "greater or equal"">")
  556. (const :tag "equal" "=")))
  557. (defgroup org-agenda-skip nil
  558. "Options concerning skipping parts of agenda files."
  559. :tag "Org Agenda Skip"
  560. :group 'org-agenda)
  561. (defcustom org-agenda-skip-function-global nil
  562. "Function to be called at each match during agenda construction.
  563. If this function returns nil, the current match should not be skipped.
  564. If the function decided to skip an agenda match, is must return the
  565. buffer position from which the search should be continued.
  566. This may also be a Lisp form, which will be evaluated.
  567. This variable will be applied to every agenda match, including
  568. tags/property searches and TODO lists. So try to make the test function
  569. do its checking as efficiently as possible. To implement a skipping
  570. condition just for specific agenda commands, use the variable
  571. `org-agenda-skip-function' which can be set in the options section
  572. of custom agenda commands."
  573. :group 'org-agenda-skip
  574. :type 'sexp)
  575. (defgroup org-agenda-daily/weekly nil
  576. "Options concerning the daily/weekly agenda."
  577. :tag "Org Agenda Daily/Weekly"
  578. :group 'org-agenda)
  579. (defgroup org-agenda-todo-list nil
  580. "Options concerning the global todo list agenda view."
  581. :tag "Org Agenda Todo List"
  582. :group 'org-agenda)
  583. (defgroup org-agenda-match-view nil
  584. "Options concerning the general tags/property/todo match agenda view."
  585. :tag "Org Agenda Match View"
  586. :group 'org-agenda)
  587. (defgroup org-agenda-search-view nil
  588. "Options concerning the general tags/property/todo match agenda view."
  589. :tag "Org Agenda Match View"
  590. :group 'org-agenda)
  591. (defvar org-agenda-archives-mode nil
  592. "Non-nil means the agenda will include archived items.
  593. If this is the symbol `trees', trees in the selected agenda scope
  594. that are marked with the ARCHIVE tag will be included anyway. When this is
  595. t, also all archive files associated with the current selection of agenda
  596. files will be included.")
  597. (defcustom org-agenda-restriction-lock-highlight-subtree t
  598. "Non-nil means highlight the whole subtree when restriction is active.
  599. Otherwise only highlight the headline. Highlighting the whole subtree is
  600. useful to ensure no edits happen beyond the restricted region."
  601. :group 'org-agenda
  602. :type 'boolean)
  603. (defcustom org-agenda-skip-comment-trees t
  604. "Non-nil means skip trees that start with the COMMENT keyword.
  605. When nil, these trees are also scanned by agenda commands."
  606. :group 'org-agenda-skip
  607. :type 'boolean)
  608. (defcustom org-agenda-todo-list-sublevels t
  609. "Non-nil means check also the sublevels of a TODO entry for TODO entries.
  610. When nil, the sublevels of a TODO entry are not checked, resulting in
  611. potentially much shorter TODO lists."
  612. :group 'org-agenda-skip
  613. :group 'org-agenda-todo-list
  614. :type 'boolean)
  615. (defcustom org-agenda-todo-ignore-with-date nil
  616. "Non-nil means don't show entries with a date in the global todo list.
  617. You can use this if you prefer to mark mere appointments with a TODO keyword,
  618. but don't want them to show up in the TODO list.
  619. When this is set, it also covers deadlines and scheduled items, the settings
  620. of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
  621. will be ignored.
  622. See also the variable `org-agenda-tags-todo-honor-ignore-options'."
  623. :group 'org-agenda-skip
  624. :group 'org-agenda-todo-list
  625. :type 'boolean)
  626. (defcustom org-agenda-todo-ignore-timestamp nil
  627. "Non-nil means don't show entries with a timestamp.
  628. This applies when creating the global todo list.
  629. Valid values are:
  630. past Don't show entries for today or in the past.
  631. future Don't show entries with a timestamp in the future.
  632. The idea behind this is that if it has a future
  633. timestamp, you don't want to think about it until the
  634. date.
  635. all Don't show any entries with a timestamp in the global todo list.
  636. The idea behind this is that by setting a timestamp, you
  637. have already \"taken care\" of this item.
  638. This variable can also have an integer as a value. If positive (N),
  639. todos with a timestamp N or more days in the future will be ignored. If
  640. negative (-N), todos with a timestamp N or more days in the past will be
  641. ignored. If 0, todos with a timestamp either today or in the future will
  642. be ignored. For example, a value of -1 will exclude todos with a
  643. timestamp in the past (yesterday or earlier), while a value of 7 will
  644. exclude todos with a timestamp a week or more in the future.
  645. See also `org-agenda-todo-ignore-with-date'.
  646. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  647. to make his option also apply to the tags-todo list."
  648. :group 'org-agenda-skip
  649. :group 'org-agenda-todo-list
  650. :version "24.1"
  651. :type '(choice
  652. (const :tag "Ignore future timestamp todos" future)
  653. (const :tag "Ignore past or present timestamp todos" past)
  654. (const :tag "Ignore all timestamp todos" all)
  655. (const :tag "Show timestamp todos" nil)
  656. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  657. (defcustom org-agenda-todo-ignore-scheduled nil
  658. "Non-nil means, ignore some scheduled TODO items when making TODO list.
  659. This applies when creating the global todo list.
  660. Valid values are:
  661. past Don't show entries scheduled today or in the past.
  662. future Don't show entries scheduled in the future.
  663. The idea behind this is that by scheduling it, you don't want to
  664. think about it until the scheduled date.
  665. all Don't show any scheduled entries in the global todo list.
  666. The idea behind this is that by scheduling it, you have already
  667. \"taken care\" of this item.
  668. t Same as `all', for backward compatibility.
  669. This variable can also have an integer as a value. See
  670. `org-agenda-todo-ignore-timestamp' for more details.
  671. See also `org-agenda-todo-ignore-with-date'.
  672. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  673. to make his option also apply to the tags-todo list."
  674. :group 'org-agenda-skip
  675. :group 'org-agenda-todo-list
  676. :type '(choice
  677. (const :tag "Ignore future-scheduled todos" future)
  678. (const :tag "Ignore past- or present-scheduled todos" past)
  679. (const :tag "Ignore all scheduled todos" all)
  680. (const :tag "Ignore all scheduled todos (compatibility)" t)
  681. (const :tag "Show scheduled todos" nil)
  682. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  683. (defcustom org-agenda-todo-ignore-deadlines nil
  684. "Non-nil means ignore some deadline TODO items when making TODO list.
  685. There are different motivations for using different values, please think
  686. carefully when configuring this variable.
  687. This applies when creating the global todo list.
  688. Valid values are:
  689. near Don't show near deadline entries. A deadline is near when it is
  690. closer than `org-deadline-warning-days' days. The idea behind this
  691. is that such items will appear in the agenda anyway.
  692. far Don't show TODO entries where a deadline has been defined, but
  693. the deadline is not near. This is useful if you don't want to
  694. use the todo list to figure out what to do now.
  695. past Don't show entries with a deadline timestamp for today or in the past.
  696. future Don't show entries with a deadline timestamp in the future, not even
  697. when they become `near' ones. Use it with caution.
  698. all Ignore all TODO entries that do have a deadline.
  699. t Same as `near', for backward compatibility.
  700. This variable can also have an integer as a value. See
  701. `org-agenda-todo-ignore-timestamp' for more details.
  702. See also `org-agenda-todo-ignore-with-date'.
  703. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  704. to make his option also apply to the tags-todo list."
  705. :group 'org-agenda-skip
  706. :group 'org-agenda-todo-list
  707. :type '(choice
  708. (const :tag "Ignore near deadlines" near)
  709. (const :tag "Ignore near deadlines (compatibility)" t)
  710. (const :tag "Ignore far deadlines" far)
  711. (const :tag "Ignore all TODOs with a deadlines" all)
  712. (const :tag "Show all TODOs, even if they have a deadline" nil)
  713. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  714. (defcustom org-agenda-todo-ignore-time-comparison-use-seconds nil
  715. "Time unit to use when possibly ignoring an agenda item.
  716. See the docstring of various `org-agenda-todo-ignore-*' options.
  717. The default is to compare time stamps using days. An item is thus
  718. considered to be in the future if it is at least one day after today.
  719. Non-nil means to compare time stamps using seconds. An item is then
  720. considered future if it has a time value later than current time."
  721. :group 'org-agenda-skip
  722. :group 'org-agenda-todo-list
  723. :version "24.4"
  724. :package-version '(Org . "8.0")
  725. :type '(choice
  726. (const :tag "Compare time with days" nil)
  727. (const :tag "Compare time with seconds" t)))
  728. (defcustom org-agenda-tags-todo-honor-ignore-options nil
  729. "Non-nil means honor todo-list ignores options also in tags-todo search.
  730. The variables
  731. `org-agenda-todo-ignore-with-date',
  732. `org-agenda-todo-ignore-timestamp',
  733. `org-agenda-todo-ignore-scheduled',
  734. `org-agenda-todo-ignore-deadlines'
  735. make the global TODO list skip entries that have time stamps of certain
  736. kinds. If this option is set, the same options will also apply for the
  737. tags-todo search, which is the general tags/property matcher
  738. restricted to unfinished TODO entries only."
  739. :group 'org-agenda-skip
  740. :group 'org-agenda-todo-list
  741. :group 'org-agenda-match-view
  742. :type 'boolean)
  743. (defcustom org-agenda-skip-scheduled-if-done nil
  744. "Non-nil means don't show scheduled items in agenda when they are done.
  745. This is relevant for the daily/weekly agenda, not for the TODO list. And
  746. it applies only to the actual date of the scheduling. Warnings about
  747. an item with a past scheduling dates are always turned off when the item
  748. is DONE."
  749. :group 'org-agenda-skip
  750. :group 'org-agenda-daily/weekly
  751. :type 'boolean)
  752. (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
  753. "Non-nil means skip scheduling line if same entry shows because of deadline.
  754. In the agenda of today, an entry can show up multiple times
  755. because it is both scheduled and has a nearby deadline, and maybe
  756. a plain time stamp as well.
  757. When this variable is nil, the entry will be shown several times.
  758. When set to t, then only the deadline is shown and the fact that
  759. the entry is scheduled today or was scheduled previously is not
  760. shown.
  761. When set to the symbol `not-today', skip scheduled previously,
  762. but not scheduled today.
  763. When set to the symbol `repeated-after-deadline', skip scheduled
  764. items if they are repeated beyond the current deadline."
  765. :group 'org-agenda-skip
  766. :group 'org-agenda-daily/weekly
  767. :type '(choice
  768. (const :tag "Never" nil)
  769. (const :tag "Always" t)
  770. (const :tag "Not when scheduled today" not-today)
  771. (const :tag "When repeated past deadline" repeated-after-deadline)))
  772. (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
  773. "Non-nil means skip timestamp line if same entry shows because of deadline.
  774. In the agenda of today, an entry can show up multiple times
  775. because it has both a plain timestamp and has a nearby deadline.
  776. When this variable is t, then only the deadline is shown and the
  777. fact that the entry has a timestamp for or including today is not
  778. shown. When this variable is nil, the entry will be shown
  779. several times."
  780. :group 'org-agenda-skip
  781. :group 'org-agenda-daily/weekly
  782. :version "24.1"
  783. :type '(choice
  784. (const :tag "Never" nil)
  785. (const :tag "Always" t)))
  786. (defcustom org-agenda-skip-deadline-if-done nil
  787. "Non-nil means don't show deadlines when the corresponding item is done.
  788. When nil, the deadline is still shown and should give you a happy feeling.
  789. This is relevant for the daily/weekly agenda. And it applied only to the
  790. actually date of the deadline. Warnings about approaching and past-due
  791. deadlines are always turned off when the item is DONE."
  792. :group 'org-agenda-skip
  793. :group 'org-agenda-daily/weekly
  794. :type 'boolean)
  795. (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
  796. "Non-nil means skip deadline prewarning when entry is also scheduled.
  797. This will apply on all days where a prewarning for the deadline would
  798. be shown, but not at the day when the entry is actually due. On that day,
  799. the deadline will be shown anyway.
  800. This variable may be set to nil, t, the symbol `pre-scheduled',
  801. or a number which will then give the number of days before the actual
  802. deadline when the prewarnings should resume. The symbol `pre-scheduled'
  803. eliminates the deadline prewarning only prior to the scheduled date.
  804. This can be used in a workflow where the first showing of the deadline will
  805. trigger you to schedule it, and then you don't want to be reminded of it
  806. because you will take care of it on the day when scheduled."
  807. :group 'org-agenda-skip
  808. :group 'org-agenda-daily/weekly
  809. :version "24.1"
  810. :type '(choice
  811. (const :tag "Always show prewarning" nil)
  812. (const :tag "Remove prewarning prior to scheduled date" pre-scheduled)
  813. (const :tag "Remove prewarning if entry is scheduled" t)
  814. (integer :tag "Restart prewarning N days before deadline")))
  815. (defcustom org-agenda-skip-scheduled-delay-if-deadline nil
  816. "Non-nil means skip scheduled delay when entry also has a deadline.
  817. This variable may be set to nil, t, the symbol `post-deadline',
  818. or a number which will then give the number of days after the actual
  819. scheduled date when the delay should expire. The symbol `post-deadline'
  820. eliminates the schedule delay when the date is posterior to the deadline."
  821. :group 'org-agenda-skip
  822. :group 'org-agenda-daily/weekly
  823. :version "24.4"
  824. :package-version '(Org . "8.0")
  825. :type '(choice
  826. (const :tag "Always honor delay" nil)
  827. (const :tag "Ignore delay if posterior to the deadline" post-deadline)
  828. (const :tag "Ignore delay if entry has a deadline" t)
  829. (integer :tag "Honor delay up until N days after the scheduled date")))
  830. (defcustom org-agenda-skip-additional-timestamps-same-entry nil
  831. "When nil, multiple same-day timestamps in entry make multiple agenda lines.
  832. When non-nil, after the search for timestamps has matched once in an
  833. entry, the rest of the entry will not be searched."
  834. :group 'org-agenda-skip
  835. :type 'boolean)
  836. (defcustom org-agenda-skip-timestamp-if-done nil
  837. "Non-nil means don't select item by timestamp or -range if it is DONE."
  838. :group 'org-agenda-skip
  839. :group 'org-agenda-daily/weekly
  840. :type 'boolean)
  841. (defcustom org-agenda-dim-blocked-tasks t
  842. "Non-nil means dim blocked tasks in the agenda display.
  843. This causes some overhead during agenda construction, but if you
  844. have turned on `org-enforce-todo-dependencies',
  845. `org-enforce-todo-checkbox-dependencies', or any other blocking
  846. mechanism, this will create useful feedback in the agenda.
  847. Instead of t, this variable can also have the value `invisible'.
  848. Then blocked tasks will be invisible and only become visible when
  849. they become unblocked. An exemption to this behavior is when a task is
  850. blocked because of unchecked checkboxes below it. Since checkboxes do
  851. not show up in the agenda views, making this task invisible you remove any
  852. trace from agenda views that there is something to do. Therefore, a task
  853. that is blocked because of checkboxes will never be made invisible, it
  854. will only be dimmed."
  855. :group 'org-agenda-daily/weekly
  856. :group 'org-agenda-todo-list
  857. :version "24.3"
  858. :type '(choice
  859. (const :tag "Do not dim" nil)
  860. (const :tag "Dim to a gray face" t)
  861. (const :tag "Make invisible" invisible)))
  862. (defcustom org-timeline-show-empty-dates 3
  863. "Non-nil means `org-timeline' also shows dates without an entry.
  864. When nil, only the days which actually have entries are shown.
  865. When t, all days between the first and the last date are shown.
  866. When an integer, show also empty dates, but if there is a gap of more than
  867. N days, just insert a special line indicating the size of the gap."
  868. :group 'org-agenda-skip
  869. :type '(choice
  870. (const :tag "None" nil)
  871. (const :tag "All" t)
  872. (integer :tag "at most")))
  873. (defgroup org-agenda-startup nil
  874. "Options concerning initial settings in the Agenda in Org Mode."
  875. :tag "Org Agenda Startup"
  876. :group 'org-agenda)
  877. (defcustom org-agenda-menu-show-matcher t
  878. "Non-nil means show the match string in the agenda dispatcher menu.
  879. When nil, the matcher string is not shown, but is put into the help-echo
  880. property so than moving the mouse over the command shows it.
  881. Setting it to nil is good if matcher strings are very long and/or if
  882. you want to use two-columns display (see `org-agenda-menu-two-columns')."
  883. :group 'org-agenda
  884. :version "24.1"
  885. :type 'boolean)
  886. (define-obsolete-variable-alias 'org-agenda-menu-two-column 'org-agenda-menu-two-columns "24.3")
  887. (defcustom org-agenda-menu-two-columns nil
  888. "Non-nil means, use two columns to show custom commands in the dispatcher.
  889. If you use this, you probably want to set `org-agenda-menu-show-matcher'
  890. to nil."
  891. :group 'org-agenda
  892. :version "24.1"
  893. :type 'boolean)
  894. (define-obsolete-variable-alias 'org-finalize-agenda-hook 'org-agenda-finalize-hook "24.3")
  895. (defcustom org-agenda-finalize-hook nil
  896. "Hook run just before displaying an agenda buffer.
  897. The buffer is still writable when the hook is called.
  898. You can modify some of the buffer substrings but you should be
  899. extra careful not to modify the text properties of the agenda
  900. headlines as the agenda display heavily relies on them."
  901. :group 'org-agenda-startup
  902. :type 'hook)
  903. (defcustom org-agenda-mouse-1-follows-link nil
  904. "Non-nil means mouse-1 on a link will follow the link in the agenda.
  905. A longer mouse click will still set point. Does not work on XEmacs.
  906. Needs to be set before org.el is loaded."
  907. :group 'org-agenda-startup
  908. :type 'boolean)
  909. (defcustom org-agenda-start-with-follow-mode nil
  910. "The initial value of follow mode in a newly created agenda window."
  911. :group 'org-agenda-startup
  912. :type 'boolean)
  913. (defcustom org-agenda-follow-indirect nil
  914. "Non-nil means `org-agenda-follow-mode' displays only the
  915. current item's tree, in an indirect buffer."
  916. :group 'org-agenda
  917. :version "24.1"
  918. :type 'boolean)
  919. (defcustom org-agenda-show-outline-path t
  920. "Non-nil means show outline path in echo area after line motion."
  921. :group 'org-agenda-startup
  922. :type 'boolean)
  923. (defcustom org-agenda-start-with-entry-text-mode nil
  924. "The initial value of entry-text-mode in a newly created agenda window."
  925. :group 'org-agenda-startup
  926. :type 'boolean)
  927. (defcustom org-agenda-entry-text-maxlines 5
  928. "Number of text lines to be added when `E' is pressed in the agenda.
  929. Note that this variable only used during agenda display. Add add entry text
  930. when exporting the agenda, configure the variable
  931. `org-agenda-add-entry-ext-maxlines'."
  932. :group 'org-agenda
  933. :type 'integer)
  934. (defcustom org-agenda-entry-text-exclude-regexps nil
  935. "List of regular expressions to clean up entry text.
  936. The complete matches of all regular expressions in this list will be
  937. removed from entry text before it is shown in the agenda."
  938. :group 'org-agenda
  939. :type '(repeat (regexp)))
  940. (defcustom org-agenda-entry-text-leaders " > "
  941. "Text prepended to the entry text in agenda buffers."
  942. :version "24.4"
  943. :package-version '(Org . "8.0")
  944. :group 'org-agenda
  945. :type 'string)
  946. (defvar org-agenda-entry-text-cleanup-hook nil
  947. "Hook that is run after basic cleanup of entry text to be shown in agenda.
  948. This cleanup is done in a temporary buffer, so the function may inspect and
  949. change the entire buffer.
  950. Some default stuff like drawers and scheduling/deadline dates will already
  951. have been removed when this is called, as will any matches for regular
  952. expressions listed in `org-agenda-entry-text-exclude-regexps'.")
  953. (defvar org-agenda-include-inactive-timestamps nil
  954. "Non-nil means include inactive time stamps in agenda and timeline.
  955. Dynamically scoped.")
  956. (defgroup org-agenda-windows nil
  957. "Options concerning the windows used by the Agenda in Org Mode."
  958. :tag "Org Agenda Windows"
  959. :group 'org-agenda)
  960. (defcustom org-agenda-window-setup 'reorganize-frame
  961. "How the agenda buffer should be displayed.
  962. Possible values for this option are:
  963. current-window Show agenda in the current window, keeping all other windows.
  964. other-window Use `switch-to-buffer-other-window' to display agenda.
  965. reorganize-frame Show only two windows on the current frame, the current
  966. window and the agenda.
  967. other-frame Use `switch-to-buffer-other-frame' to display agenda.
  968. Also, when exiting the agenda, kill that frame.
  969. See also the variable `org-agenda-restore-windows-after-quit'."
  970. :group 'org-agenda-windows
  971. :type '(choice
  972. (const current-window)
  973. (const other-frame)
  974. (const other-window)
  975. (const reorganize-frame)))
  976. (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
  977. "The min and max height of the agenda window as a fraction of frame height.
  978. The value of the variable is a cons cell with two numbers between 0 and 1.
  979. It only matters if `org-agenda-window-setup' is `reorganize-frame'."
  980. :group 'org-agenda-windows
  981. :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
  982. (defcustom org-agenda-restore-windows-after-quit nil
  983. "Non-nil means restore window configuration upon exiting agenda.
  984. Before the window configuration is changed for displaying the agenda,
  985. the current status is recorded. When the agenda is exited with
  986. `q' or `x' and this option is set, the old state is restored. If
  987. `org-agenda-window-setup' is `other-frame', the value of this
  988. option will be ignored."
  989. :group 'org-agenda-windows
  990. :type 'boolean)
  991. (defcustom org-agenda-ndays nil
  992. "Number of days to include in overview display.
  993. Should be 1 or 7.
  994. Obsolete, see `org-agenda-span'."
  995. :group 'org-agenda-daily/weekly
  996. :type '(choice (const nil)
  997. (integer)))
  998. (make-obsolete-variable 'org-agenda-ndays 'org-agenda-span "24.1")
  999. (defcustom org-agenda-span 'week
  1000. "Number of days to include in overview display.
  1001. Can be day, week, month, year, or any number of days.
  1002. Custom commands can set this variable in the options section."
  1003. :group 'org-agenda-daily/weekly
  1004. :type '(choice (const :tag "Day" day)
  1005. (const :tag "Week" week)
  1006. (const :tag "Fortnight" fortnight)
  1007. (const :tag "Month" month)
  1008. (const :tag "Year" year)
  1009. (integer :tag "Custom")))
  1010. (defcustom org-agenda-start-on-weekday 1
  1011. "Non-nil means start the overview always on the specified weekday.
  1012. 0 denotes Sunday, 1 denotes Monday, etc.
  1013. When nil, always start on the current day.
  1014. Custom commands can set this variable in the options section."
  1015. :group 'org-agenda-daily/weekly
  1016. :type '(choice (const :tag "Today" nil)
  1017. (integer :tag "Weekday No.")))
  1018. (defcustom org-agenda-show-all-dates t
  1019. "Non-nil means `org-agenda' shows every day in the selected range.
  1020. When nil, only the days which actually have entries are shown."
  1021. :group 'org-agenda-daily/weekly
  1022. :type 'boolean)
  1023. (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
  1024. "Format string for displaying dates in the agenda.
  1025. Used by the daily/weekly agenda and by the timeline. This should be
  1026. a format string understood by `format-time-string', or a function returning
  1027. the formatted date as a string. The function must take a single argument,
  1028. a calendar-style date list like (month day year)."
  1029. :group 'org-agenda-daily/weekly
  1030. :type '(choice
  1031. (string :tag "Format string")
  1032. (function :tag "Function")))
  1033. (defun org-agenda-format-date-aligned (date)
  1034. "Format a DATE string for display in the daily/weekly agenda, or timeline.
  1035. This function makes sure that dates are aligned for easy reading."
  1036. (require 'cal-iso)
  1037. (let* ((dayname (calendar-day-name date))
  1038. (day (cadr date))
  1039. (day-of-week (calendar-day-of-week date))
  1040. (month (car date))
  1041. (monthname (calendar-month-name month))
  1042. (year (nth 2 date))
  1043. (iso-week (org-days-to-iso-week
  1044. (calendar-absolute-from-gregorian date)))
  1045. (weekyear (cond ((and (= month 1) (>= iso-week 52))
  1046. (1- year))
  1047. ((and (= month 12) (<= iso-week 1))
  1048. (1+ year))
  1049. (t year)))
  1050. (weekstring (if (= day-of-week 1)
  1051. (format " W%02d" iso-week)
  1052. "")))
  1053. (format "%-10s %2d %s %4d%s"
  1054. dayname day monthname year weekstring)))
  1055. (defcustom org-agenda-time-leading-zero nil
  1056. "Non-nil means use leading zero for military times in agenda.
  1057. For example, 9:30am would become 09:30 rather than 9:30."
  1058. :group 'org-agenda-daily/weekly
  1059. :version "24.1"
  1060. :type 'boolean)
  1061. (defcustom org-agenda-timegrid-use-ampm nil
  1062. "When set, show AM/PM style timestamps on the timegrid."
  1063. :group 'org-agenda
  1064. :version "24.1"
  1065. :type 'boolean)
  1066. (defun org-agenda-time-of-day-to-ampm (time)
  1067. "Convert TIME of a string like '13:45' to an AM/PM style time string."
  1068. (let* ((hour-number (string-to-number (substring time 0 -3)))
  1069. (minute (substring time -2))
  1070. (ampm "am"))
  1071. (cond
  1072. ((equal hour-number 12)
  1073. (setq ampm "pm"))
  1074. ((> hour-number 12)
  1075. (setq ampm "pm")
  1076. (setq hour-number (- hour-number 12))))
  1077. (concat
  1078. (if org-agenda-time-leading-zero
  1079. (format "%02d" hour-number)
  1080. (format "%02s" (number-to-string hour-number)))
  1081. ":" minute ampm)))
  1082. (defun org-agenda-time-of-day-to-ampm-maybe (time)
  1083. "Conditionally convert TIME to AM/PM format based on `org-agenda-timegrid-use-ampm'."
  1084. (if org-agenda-timegrid-use-ampm
  1085. (org-agenda-time-of-day-to-ampm time)
  1086. time))
  1087. (defcustom org-agenda-weekend-days '(6 0)
  1088. "Which days are weekend?
  1089. These days get the special face `org-agenda-date-weekend' in the agenda
  1090. and timeline buffers."
  1091. :group 'org-agenda-daily/weekly
  1092. :type '(set :greedy t
  1093. (const :tag "Monday" 1)
  1094. (const :tag "Tuesday" 2)
  1095. (const :tag "Wednesday" 3)
  1096. (const :tag "Thursday" 4)
  1097. (const :tag "Friday" 5)
  1098. (const :tag "Saturday" 6)
  1099. (const :tag "Sunday" 0)))
  1100. (defcustom org-agenda-move-date-from-past-immediately-to-today t
  1101. "Non-nil means jump to today when moving a past date forward in time.
  1102. When using S-right in the agenda to move a a date forward, and the date
  1103. stamp currently points to the past, the first key press will move it
  1104. to today. WHen nil, just move one day forward even if the date stays
  1105. in the past."
  1106. :group 'org-agenda-daily/weekly
  1107. :version "24.1"
  1108. :type 'boolean)
  1109. (defcustom org-agenda-include-diary nil
  1110. "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
  1111. Custom commands can set this variable in the options section."
  1112. :group 'org-agenda-daily/weekly
  1113. :type 'boolean)
  1114. (defcustom org-agenda-include-deadlines t
  1115. "If non-nil, include entries within their deadline warning period.
  1116. Custom commands can set this variable in the options section."
  1117. :group 'org-agenda-daily/weekly
  1118. :version "24.1"
  1119. :type 'boolean)
  1120. (defcustom org-agenda-repeating-timestamp-show-all t
  1121. "Non-nil means show all occurrences of a repeating stamp in the agenda.
  1122. When set to a list of strings, only show occurrences of repeating
  1123. stamps for these TODO keywords. When nil, only one occurrence is
  1124. shown, either today or the nearest into the future."
  1125. :group 'org-agenda-daily/weekly
  1126. :type '(choice
  1127. (const :tag "Show repeating stamps" t)
  1128. (repeat :tag "Show repeating stamps for these TODO keywords"
  1129. (string :tag "TODO Keyword"))
  1130. (const :tag "Don't show repeating stamps" nil)))
  1131. (defcustom org-scheduled-past-days 10000
  1132. "Number of days to continue listing scheduled items not marked DONE.
  1133. When an item is scheduled on a date, it shows up in the agenda on this
  1134. day and will be listed until it is marked done for the number of days
  1135. given here."
  1136. :group 'org-agenda-daily/weekly
  1137. :type 'integer)
  1138. (defcustom org-agenda-log-mode-items '(closed clock)
  1139. "List of items that should be shown in agenda log mode.
  1140. This list may contain the following symbols:
  1141. closed Show entries that have been closed on that day.
  1142. clock Show entries that have received clocked time on that day.
  1143. state Show all logged state changes.
  1144. Note that instead of changing this variable, you can also press `C-u l' in
  1145. the agenda to display all available LOG items temporarily."
  1146. :group 'org-agenda-daily/weekly
  1147. :type '(set :greedy t (const closed) (const clock) (const state)))
  1148. (defcustom org-agenda-clock-consistency-checks
  1149. '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
  1150. :gap-ok-around ("4:00")
  1151. :default-face ((:background "DarkRed") (:foreground "white"))
  1152. :overlap-face nil :gap-face nil :no-end-time-face nil
  1153. :long-face nil :short-face nil)
  1154. "This is a property list, with the following keys:
  1155. :max-duration Mark clocking chunks that are longer than this time.
  1156. This is a time string like \"HH:MM\", or the number
  1157. of minutes as an integer.
  1158. :min-duration Mark clocking chunks that are shorter that this.
  1159. This is a time string like \"HH:MM\", or the number
  1160. of minutes as an integer.
  1161. :max-gap Mark gaps between clocking chunks that are longer than
  1162. this duration. A number of minutes, or a string
  1163. like \"HH:MM\".
  1164. :gap-ok-around List of times during the day which are usually not working
  1165. times. When a gap is detected, but the gap contains any
  1166. of these times, the gap is *not* reported. For example,
  1167. if this is (\"4:00\" \"13:00\") then gaps that contain
  1168. 4:00 in the morning (i.e. the night) and 13:00
  1169. (i.e. a typical lunch time) do not cause a warning.
  1170. You should have at least one time during the night in this
  1171. list, or otherwise the first task each morning will trigger
  1172. a warning because it follows a long gap.
  1173. Furthermore, the following properties can be used to define faces for
  1174. issue display.
  1175. :default-face the default face, if the specific face is undefined
  1176. :overlap-face face for overlapping clocks
  1177. :gap-face face for gaps between clocks
  1178. :no-end-time-face face for incomplete clocks
  1179. :long-face face for clock intervals that are too long
  1180. :short-face face for clock intervals that are too short"
  1181. :group 'org-agenda-daily/weekly
  1182. :group 'org-clock
  1183. :version "24.1"
  1184. :type 'plist)
  1185. (defcustom org-agenda-log-mode-add-notes t
  1186. "Non-nil means add first line of notes to log entries in agenda views.
  1187. If a log item like a state change or a clock entry is associated with
  1188. notes, the first line of these notes will be added to the entry in the
  1189. agenda display."
  1190. :group 'org-agenda-daily/weekly
  1191. :type 'boolean)
  1192. (defcustom org-agenda-start-with-log-mode nil
  1193. "The initial value of log-mode in a newly created agenda window.
  1194. See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
  1195. explanations on the possible values."
  1196. :group 'org-agenda-startup
  1197. :group 'org-agenda-daily/weekly
  1198. :type '(choice (const :tag "Don't show log items" nil)
  1199. (const :tag "Show only log items" only)
  1200. (const :tag "Show all possible log items" clockcheck)
  1201. (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
  1202. (choice (const :tag "Show closed log items" closed)
  1203. (const :tag "Show clocked log items" clock)
  1204. (const :tag "Show all logged state changes" state)))))
  1205. (defcustom org-agenda-start-with-clockreport-mode nil
  1206. "The initial value of clockreport-mode in a newly created agenda window."
  1207. :group 'org-agenda-startup
  1208. :group 'org-agenda-daily/weekly
  1209. :type 'boolean)
  1210. (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
  1211. "Property list with parameters for the clocktable in clockreport mode.
  1212. This is the display mode that shows a clock table in the daily/weekly
  1213. agenda, the properties for this dynamic block can be set here.
  1214. The usual clocktable parameters are allowed here, but you cannot set
  1215. the properties :name, :tstart, :tend, :block, and :scope - these will
  1216. be overwritten to make sure the content accurately reflects the
  1217. current display in the agenda."
  1218. :group 'org-agenda-daily/weekly
  1219. :type 'plist)
  1220. (defcustom org-agenda-search-view-always-boolean nil
  1221. "Non-nil means the search string is interpreted as individual parts.
  1222. The search string for search view can either be interpreted as a phrase,
  1223. or as a list of snippets that define a boolean search for a number of
  1224. strings.
  1225. When this is non-nil, the string will be split on whitespace, and each
  1226. snippet will be searched individually, and all must match in order to
  1227. select an entry. A snippet is then a single string of non-white
  1228. characters, or a string in double quotes, or a regexp in {} braces.
  1229. If a snippet is preceded by \"-\", the snippet must *not* match.
  1230. \"+\" is syntactic sugar for positive selection. Each snippet may
  1231. be found as a full word or a partial word, but see the variable
  1232. `org-agenda-search-view-force-full-words'.
  1233. When this is nil, search will look for the entire search phrase as one,
  1234. with each space character matching any amount of whitespace, including
  1235. line breaks.
  1236. Even when this is nil, you can still switch to Boolean search dynamically
  1237. by preceding the first snippet with \"+\" or \"-\". If the first snippet
  1238. is a regexp marked with braces like \"{abc}\", this will also switch to
  1239. boolean search."
  1240. :group 'org-agenda-search-view
  1241. :version "24.1"
  1242. :type 'boolean)
  1243. (org-defvaralias 'org-agenda-search-view-search-words-only
  1244. 'org-agenda-search-view-always-boolean)
  1245. (defcustom org-agenda-search-view-force-full-words nil
  1246. "Non-nil means, search words must be matches as complete words.
  1247. When nil, they may also match part of a word."
  1248. :group 'org-agenda-search-view
  1249. :version "24.1"
  1250. :type 'boolean)
  1251. (defcustom org-agenda-search-view-max-outline-level 0
  1252. "Maximum outline level to display in search view.
  1253. E.g. when this is set to 1, the search view will only
  1254. show headlines of level 1. When set to 0, the default
  1255. value, don't limit agenda view by outline level."
  1256. :group 'org-agenda-search-view
  1257. :version "24.4"
  1258. :package-version '(Org . "8.3")
  1259. :type 'integer)
  1260. (defgroup org-agenda-time-grid nil
  1261. "Options concerning the time grid in the Org-mode Agenda."
  1262. :tag "Org Agenda Time Grid"
  1263. :group 'org-agenda)
  1264. (defcustom org-agenda-search-headline-for-time t
  1265. "Non-nil means search headline for a time-of-day.
  1266. If the headline contains a time-of-day in one format or another, it will
  1267. be used to sort the entry into the time sequence of items for a day.
  1268. Some people have time stamps in the headline that refer to the creation
  1269. time or so, and then this produces an unwanted side effect. If this is
  1270. the case for your, use this variable to turn off searching the headline
  1271. for a time."
  1272. :group 'org-agenda-time-grid
  1273. :type 'boolean)
  1274. (defcustom org-agenda-use-time-grid t
  1275. "Non-nil means show a time grid in the agenda schedule.
  1276. A time grid is a set of lines for specific times (like every two hours between
  1277. 8:00 and 20:00). The items scheduled for a day at specific times are
  1278. sorted in between these lines.
  1279. For details about when the grid will be shown, and what it will look like, see
  1280. the variable `org-agenda-time-grid'."
  1281. :group 'org-agenda-time-grid
  1282. :type 'boolean)
  1283. (defcustom org-agenda-time-grid
  1284. '((daily today require-timed)
  1285. "----------------"
  1286. (800 1000 1200 1400 1600 1800 2000))
  1287. "The settings for time grid for agenda display.
  1288. This is a list of three items. The first item is again a list. It contains
  1289. symbols specifying conditions when the grid should be displayed:
  1290. daily if the agenda shows a single day
  1291. weekly if the agenda shows an entire week
  1292. today show grid on current date, independent of daily/weekly display
  1293. require-timed show grid only if at least one item has a time specification
  1294. The second item is a string which will be placed behind the grid time.
  1295. The third item is a list of integers, indicating the times that should have
  1296. a grid line."
  1297. :group 'org-agenda-time-grid
  1298. :type
  1299. '(list
  1300. (set :greedy t :tag "Grid Display Options"
  1301. (const :tag "Show grid in single day agenda display" daily)
  1302. (const :tag "Show grid in weekly agenda display" weekly)
  1303. (const :tag "Always show grid for today" today)
  1304. (const :tag "Show grid only if any timed entries are present"
  1305. require-timed)
  1306. (const :tag "Skip grid times already present in an entry"
  1307. remove-match))
  1308. (string :tag "Grid String")
  1309. (repeat :tag "Grid Times" (integer :tag "Time"))))
  1310. (defcustom org-agenda-show-current-time-in-grid t
  1311. "Non-nil means show the current time in the time grid."
  1312. :group 'org-agenda-time-grid
  1313. :version "24.1"
  1314. :type 'boolean)
  1315. (defcustom org-agenda-current-time-string
  1316. "now - - - - - - - - - - - - - - - - - - - - - - - - -"
  1317. "The string for the current time marker in the agenda."
  1318. :group 'org-agenda-time-grid
  1319. :version "24.1"
  1320. :type 'string)
  1321. (defgroup org-agenda-sorting nil
  1322. "Options concerning sorting in the Org-mode Agenda."
  1323. :tag "Org Agenda Sorting"
  1324. :group 'org-agenda)
  1325. (defcustom org-agenda-sorting-strategy
  1326. '((agenda habit-down time-up priority-down category-keep)
  1327. (todo priority-down category-keep)
  1328. (tags priority-down category-keep)
  1329. (search category-keep))
  1330. "Sorting structure for the agenda items of a single day.
  1331. This is a list of symbols which will be used in sequence to determine
  1332. if an entry should be listed before another entry. The following
  1333. symbols are recognized:
  1334. time-up Put entries with time-of-day indications first, early first
  1335. time-down Put entries with time-of-day indications first, late first
  1336. timestamp-up Sort by any timestamp, early first
  1337. timestamp-down Sort by any timestamp, late first
  1338. scheduled-up Sort by scheduled timestamp, early first
  1339. scheduled-down Sort by scheduled timestamp, late first
  1340. deadline-up Sort by deadline timestamp, early first
  1341. deadline-down Sort by deadline timestamp, late first
  1342. ts-up Sort by active timestamp, early first
  1343. ts-down Sort by active timestamp, late first
  1344. tsia-up Sort by inactive timestamp, early first
  1345. tsia-down Sort by inactive timestamp, late first
  1346. category-keep Keep the default order of categories, corresponding to the
  1347. sequence in `org-agenda-files'.
  1348. category-up Sort alphabetically by category, A-Z.
  1349. category-down Sort alphabetically by category, Z-A.
  1350. tag-up Sort alphabetically by last tag, A-Z.
  1351. tag-down Sort alphabetically by last tag, Z-A.
  1352. priority-up Sort numerically by priority, high priority last.
  1353. priority-down Sort numerically by priority, high priority first.
  1354. todo-state-up Sort by todo state, tasks that are done last.
  1355. todo-state-down Sort by todo state, tasks that are done first.
  1356. effort-up Sort numerically by estimated effort, high effort last.
  1357. effort-down Sort numerically by estimated effort, high effort first.
  1358. user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
  1359. user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
  1360. habit-up Put entries that are habits first
  1361. habit-down Put entries that are habits last
  1362. alpha-up Sort headlines alphabetically
  1363. alpha-down Sort headlines alphabetically, reversed
  1364. The different possibilities will be tried in sequence, and testing stops
  1365. if one comparison returns a \"not-equal\". For example, the default
  1366. '(time-up category-keep priority-down)
  1367. means: Pull out all entries having a specified time of day and sort them,
  1368. in order to make a time schedule for the current day the first thing in the
  1369. agenda listing for the day. Of the entries without a time indication, keep
  1370. the grouped in categories, don't sort the categories, but keep them in
  1371. the sequence given in `org-agenda-files'. Within each category sort by
  1372. priority.
  1373. Leaving out `category-keep' would mean that items will be sorted across
  1374. categories by priority.
  1375. Instead of a single list, this can also be a set of list for specific
  1376. contents, with a context symbol in the car of the list, any of
  1377. `agenda', `todo', `tags', `search' for the corresponding agenda views.
  1378. Custom commands can bind this variable in the options section."
  1379. :group 'org-agenda-sorting
  1380. :type `(choice
  1381. (repeat :tag "General" ,org-sorting-choice)
  1382. (list :tag "Individually"
  1383. (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
  1384. (repeat ,org-sorting-choice))
  1385. (cons (const :tag "Strategy for TODO lists" todo)
  1386. (repeat ,org-sorting-choice))
  1387. (cons (const :tag "Strategy for Tags matches" tags)
  1388. (repeat ,org-sorting-choice))
  1389. (cons (const :tag "Strategy for search matches" search)
  1390. (repeat ,org-sorting-choice)))))
  1391. (defcustom org-agenda-cmp-user-defined nil
  1392. "A function to define the comparison `user-defined'.
  1393. This function must receive two arguments, agenda entry a and b.
  1394. If a>b, return +1. If a<b, return -1. If they are equal as seen by
  1395. the user comparison, return nil.
  1396. When this is defined, you can make `user-defined-up' and `user-defined-down'
  1397. part of an agenda sorting strategy."
  1398. :group 'org-agenda-sorting
  1399. :type 'symbol)
  1400. (defcustom org-sort-agenda-notime-is-late t
  1401. "Non-nil means items without time are considered late.
  1402. This is only relevant for sorting. When t, items which have no explicit
  1403. time like 15:30 will be considered as 99:01, i.e. later than any items which
  1404. do have a time. When nil, the default time is before 0:00. You can use this
  1405. option to decide if the schedule for today should come before or after timeless
  1406. agenda entries."
  1407. :group 'org-agenda-sorting
  1408. :type 'boolean)
  1409. (defcustom org-sort-agenda-noeffort-is-high t
  1410. "Non-nil means items without effort estimate are sorted as high effort.
  1411. This also applies when filtering an agenda view with respect to the
  1412. < or > effort operator. Then, tasks with no effort defined will be treated
  1413. as tasks with high effort.
  1414. When nil, such items are sorted as 0 minutes effort."
  1415. :group 'org-agenda-sorting
  1416. :type 'boolean)
  1417. (defgroup org-agenda-line-format nil
  1418. "Options concerning the entry prefix in the Org-mode agenda display."
  1419. :tag "Org Agenda Line Format"
  1420. :group 'org-agenda)
  1421. (defcustom org-agenda-prefix-format
  1422. '((agenda . " %i %-12:c%?-12t% s")
  1423. (timeline . " % s")
  1424. (todo . " %i %-12:c")
  1425. (tags . " %i %-12:c")
  1426. (search . " %i %-12:c"))
  1427. "Format specifications for the prefix of items in the agenda views.
  1428. An alist with five entries, each for the different agenda types. The
  1429. keys of the sublists are `agenda', `timeline', `todo', `search' and `tags'.
  1430. The values are format strings.
  1431. This format works similar to a printf format, with the following meaning:
  1432. %c the category of the item, \"Diary\" for entries from the diary,
  1433. or as given by the CATEGORY keyword or derived from the file name
  1434. %e the effort required by the item
  1435. %l the level of the item (insert X space(s) if item is of level X)
  1436. %i the icon category of the item, see `org-agenda-category-icon-alist'
  1437. %T the last tag of the item (ignore inherited tags, which come first)
  1438. %t the HH:MM time-of-day specification if one applies to the entry
  1439. %s Scheduling/Deadline information, a short string
  1440. %b show breadcrumbs, i.e., the names of the higher levels
  1441. %(expression) Eval EXPRESSION and replace the control string
  1442. by the result
  1443. All specifiers work basically like the standard `%s' of printf, but may
  1444. contain two additional characters: a question mark just after the `%'
  1445. and a whitespace/punctuation character just before the final letter.
  1446. If the first character after `%' is a question mark, the entire field
  1447. will only be included if the corresponding value applies to the current
  1448. entry. This is useful for fields which should have fixed width when
  1449. present, but zero width when absent. For example, \"%?-12t\" will
  1450. result in a 12 character time field if a time of the day is specified,
  1451. but will completely disappear in entries which do not contain a time.
  1452. If there is punctuation or whitespace character just before the
  1453. final format letter, this character will be appended to the field
  1454. value if the value is not empty. For example, the format
  1455. \"%-12:c\" leads to \"Diary: \" if the category is \"Diary\". If
  1456. the category is empty, no additional colon is inserted.
  1457. The default value for the agenda sublist is \" %-12:c%?-12t% s\",
  1458. which means:
  1459. - Indent the line with two space characters
  1460. - Give the category a 12 chars wide field, padded with whitespace on
  1461. the right (because of `-'). Append a colon if there is a category
  1462. (because of `:').
  1463. - If there is a time-of-day, put it into a 12 chars wide field. If no
  1464. time, don't put in an empty field, just skip it (because of '?').
  1465. - Finally, put the scheduling information.
  1466. See also the variables `org-agenda-remove-times-when-in-prefix' and
  1467. `org-agenda-remove-tags'.
  1468. Custom commands can set this variable in the options section."
  1469. :type '(choice
  1470. (string :tag "General format")
  1471. (list :greedy t :tag "View dependent"
  1472. (cons (const agenda) (string :tag "Format"))
  1473. (cons (const timeline) (string :tag "Format"))
  1474. (cons (const todo) (string :tag "Format"))
  1475. (cons (const tags) (string :tag "Format"))
  1476. (cons (const search) (string :tag "Format"))))
  1477. :group 'org-agenda-line-format)
  1478. (defvar org-prefix-format-compiled nil
  1479. "The compiled prefix format and associated variables.
  1480. This is a list where first element is a list of variable bindings, and second
  1481. element is the compiled format expression. See the variable
  1482. `org-agenda-prefix-format'.")
  1483. (defcustom org-agenda-todo-keyword-format "%-1s"
  1484. "Format for the TODO keyword in agenda lines.
  1485. Set this to something like \"%-12s\" if you want all TODO keywords
  1486. to occupy a fixed space in the agenda display."
  1487. :group 'org-agenda-line-format
  1488. :type 'string)
  1489. (defcustom org-agenda-diary-sexp-prefix nil
  1490. "A regexp that matches part of a diary sexp entry
  1491. which should be treated as scheduling/deadline information in
  1492. `org-agenda'.
  1493. For example, you can use this to extract the `diary-remind-message' from
  1494. `diary-remind' entries."
  1495. :group 'org-agenda-line-format
  1496. :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
  1497. (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
  1498. "Text preceding timerange entries in the agenda view.
  1499. This is a list with two strings. The first applies when the range
  1500. is entirely on one day. The second applies if the range spans several days.
  1501. The strings may have two \"%d\" format specifiers which will be filled
  1502. with the sequence number of the days, and the total number of days in the
  1503. range, respectively."
  1504. :group 'org-agenda-line-format
  1505. :type '(list
  1506. (string :tag "Deadline today ")
  1507. (choice :tag "Deadline relative"
  1508. (string :tag "Format string")
  1509. (function))))
  1510. (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
  1511. "Text preceding scheduled items in the agenda view.
  1512. This is a list with two strings. The first applies when the item is
  1513. scheduled on the current day. The second applies when it has been scheduled
  1514. previously, it may contain a %d indicating that this is the nth time that
  1515. this item is scheduled, due to automatic rescheduling of unfinished items
  1516. for the following day. So this number is one larger than the number of days
  1517. that passed since this item was scheduled first."
  1518. :group 'org-agenda-line-format
  1519. :version "24.4"
  1520. :package-version '(Org . "8.0")
  1521. :type '(list
  1522. (string :tag "Scheduled today ")
  1523. (string :tag "Scheduled previously")))
  1524. (defcustom org-agenda-inactive-leader "["
  1525. "Text preceding item pulled into the agenda by inactive time stamps.
  1526. These entries are added to the agenda when pressing \"[\"."
  1527. :group 'org-agenda-line-format
  1528. :version "24.1"
  1529. :type 'string)
  1530. (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: " "%2d d. ago: ")
  1531. "Text preceding deadline items in the agenda view.
  1532. This is a list with three strings. The first applies when the item has its
  1533. deadline on the current day. The second applies when the deadline is in the
  1534. future, the third one when it is in the past. The strings may contain %d
  1535. to capture the number of days."
  1536. :group 'org-agenda-line-format
  1537. :version "24.4"
  1538. :package-version '(Org . "8.0")
  1539. :type '(list
  1540. (string :tag "Deadline today ")
  1541. (string :tag "Deadline in the future ")
  1542. (string :tag "Deadline in the past ")))
  1543. (defcustom org-agenda-remove-times-when-in-prefix t
  1544. "Non-nil means remove duplicate time specifications in agenda items.
  1545. When the format `org-agenda-prefix-format' contains a `%t' specifier, a
  1546. time-of-day specification in a headline or diary entry is extracted and
  1547. placed into the prefix. If this option is non-nil, the original specification
  1548. \(a timestamp or -range, or just a plain time(range) specification like
  1549. 11:30-4pm) will be removed for agenda display. This makes the agenda less
  1550. cluttered.
  1551. The option can be t or nil. It may also be the symbol `beg', indicating
  1552. that the time should only be removed when it is located at the beginning of
  1553. the headline/diary entry."
  1554. :group 'org-agenda-line-format
  1555. :type '(choice
  1556. (const :tag "Always" t)
  1557. (const :tag "Never" nil)
  1558. (const :tag "When at beginning of entry" beg)))
  1559. (defcustom org-agenda-remove-timeranges-from-blocks nil
  1560. "Non-nil means remove time ranges specifications in agenda
  1561. items that span on several days."
  1562. :group 'org-agenda-line-format
  1563. :version "24.1"
  1564. :type 'boolean)
  1565. (defcustom org-agenda-default-appointment-duration nil
  1566. "Default duration for appointments that only have a starting time.
  1567. When nil, no duration is specified in such cases.
  1568. When non-nil, this must be the number of minutes, e.g. 60 for one hour."
  1569. :group 'org-agenda-line-format
  1570. :type '(choice
  1571. (integer :tag "Minutes")
  1572. (const :tag "No default duration")))
  1573. (defcustom org-agenda-show-inherited-tags t
  1574. "Non-nil means show inherited tags in each agenda line.
  1575. When this option is set to 'always, it take precedences over
  1576. `org-agenda-use-tag-inheritance' and inherited tags are shown
  1577. in every agenda.
  1578. When this option is set to t (the default), inherited tags are
  1579. shown when they are available, i.e. when the value of
  1580. `org-agenda-use-tag-inheritance' has been taken into account.
  1581. This can be set to a list of agenda types in which the agenda
  1582. must display the inherited tags. Available types are 'todo,
  1583. 'agenda, 'search and 'timeline.
  1584. When set to nil, never show inherited tags in agenda lines."
  1585. :group 'org-agenda-line-format
  1586. :group 'org-agenda
  1587. :version "24.3"
  1588. :type '(choice
  1589. (const :tag "Show inherited tags when available" t)
  1590. (const :tag "Always show inherited tags" always)
  1591. (repeat :tag "Show inherited tags only in selected agenda types"
  1592. (symbol :tag "Agenda type"))))
  1593. (defcustom org-agenda-use-tag-inheritance '(todo search timeline agenda)
  1594. "List of agenda view types where to use tag inheritance.
  1595. In tags/tags-todo/tags-tree agenda views, tag inheritance is
  1596. controlled by `org-use-tag-inheritance'. In other agenda types,
  1597. `org-use-tag-inheritance' is not used for the selection of the
  1598. agenda entries. Still, you may want the agenda to be aware of
  1599. the inherited tags anyway, e.g. for later tag filtering.
  1600. Allowed value are 'todo, 'search, 'timeline and 'agenda.
  1601. This variable has no effect if `org-agenda-show-inherited-tags'
  1602. is set to 'always. In that case, the agenda is aware of those
  1603. tags.
  1604. The default value sets tags in every agenda type. Setting this
  1605. option to nil will speed up non-tags agenda view a lot."
  1606. :group 'org-agenda
  1607. :version "24.3"
  1608. :type '(choice
  1609. (const :tag "Use tag inheritance in all agenda types" t)
  1610. (repeat :tag "Use tag inheritance in selected agenda types"
  1611. (symbol :tag "Agenda type"))))
  1612. (defcustom org-agenda-hide-tags-regexp nil
  1613. "Regular expression used to filter away specific tags in agenda views.
  1614. This means that these tags will be present, but not be shown in the agenda
  1615. line. Secondary filtering will still work on the hidden tags.
  1616. Nil means don't hide any tags."
  1617. :group 'org-agenda-line-format
  1618. :type '(choice
  1619. (const :tag "Hide none" nil)
  1620. (string :tag "Regexp ")))
  1621. (defcustom org-agenda-remove-tags nil
  1622. "Non-nil means remove the tags from the headline copy in the agenda.
  1623. When this is the symbol `prefix', only remove tags when
  1624. `org-agenda-prefix-format' contains a `%T' specifier."
  1625. :group 'org-agenda-line-format
  1626. :type '(choice
  1627. (const :tag "Always" t)
  1628. (const :tag "Never" nil)
  1629. (const :tag "When prefix format contains %T" prefix)))
  1630. (org-defvaralias 'org-agenda-remove-tags-when-in-prefix
  1631. 'org-agenda-remove-tags)
  1632. (defcustom org-agenda-tags-column (if (featurep 'xemacs) -79 -80)
  1633. "Shift tags in agenda items to this column.
  1634. If this number is positive, it specifies the column. If it is negative,
  1635. it means that the tags should be flushright to that column. For example,
  1636. -80 works well for a normal 80 character screen."
  1637. :group 'org-agenda-line-format
  1638. :type 'integer)
  1639. (org-defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column)
  1640. (defcustom org-agenda-fontify-priorities 'cookies
  1641. "Non-nil means highlight low and high priorities in agenda.
  1642. When t, the highest priority entries are bold, lowest priority italic.
  1643. However, settings in `org-priority-faces' will overrule these faces.
  1644. When this variable is the symbol `cookies', only fontify the
  1645. cookies, not the entire task.
  1646. This may also be an association list of priority faces, whose
  1647. keys are the character values of `org-highest-priority',
  1648. `org-default-priority', and `org-lowest-priority' (the default values
  1649. are ?A, ?B, and ?C, respectively). The face may be a named face, a
  1650. color as a string, or a list like `(:background \"Red\")'.
  1651. If it is a color, the variable `org-faces-easy-properties'
  1652. determines if it is a foreground or a background color."
  1653. :group 'org-agenda-line-format
  1654. :type '(choice
  1655. (const :tag "Never" nil)
  1656. (const :tag "Defaults" t)
  1657. (const :tag "Cookies only" cookies)
  1658. (repeat :tag "Specify"
  1659. (list (character :tag "Priority" :value ?A)
  1660. (choice :tag "Face "
  1661. (string :tag "Color")
  1662. (sexp :tag "Face"))))))
  1663. (defcustom org-agenda-day-face-function nil
  1664. "Function called to determine what face should be used to display a day.
  1665. The only argument passed to that function is the day. It should
  1666. returns a face, or nil if does not want to specify a face and let
  1667. the normal rules apply."
  1668. :group 'org-agenda-line-format
  1669. :version "24.1"
  1670. :type '(choice (const nil) (function)))
  1671. (defcustom org-agenda-category-icon-alist nil
  1672. "Alist of category icon to be displayed in agenda views.
  1673. Each entry should have the following format:
  1674. (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
  1675. Where CATEGORY-REGEXP is a regexp matching the categories where
  1676. the icon should be displayed.
  1677. FILE-OR-DATA either a file path or a string containing image data.
  1678. The other fields can be omitted safely if not needed:
  1679. TYPE indicates the image type.
  1680. DATA-P is a boolean indicating whether the FILE-OR-DATA string is
  1681. image data.
  1682. PROPS are additional image attributes to assign to the image,
  1683. like, e.g. `:ascent center'.
  1684. (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
  1685. If you want to set the display properties yourself, just put a
  1686. list as second element:
  1687. (CATEGORY-REGEXP (MY PROPERTY LIST))
  1688. For example, to display a 16px horizontal space for Emacs
  1689. category, you can use:
  1690. (\"Emacs\" '(space . (:width (16))))"
  1691. :group 'org-agenda-line-format
  1692. :version "24.1"
  1693. :type '(alist :key-type (string :tag "Regexp matching category")
  1694. :value-type (choice (list :tag "Icon"
  1695. (string :tag "File or data")
  1696. (symbol :tag "Type")
  1697. (boolean :tag "Data?")
  1698. (repeat :tag "Extra image properties" :inline t symbol))
  1699. (list :tag "Display properties" sexp))))
  1700. (defgroup org-agenda-column-view nil
  1701. "Options concerning column view in the agenda."
  1702. :tag "Org Agenda Column View"
  1703. :group 'org-agenda)
  1704. (defcustom org-agenda-columns-show-summaries t
  1705. "Non-nil means show summaries for columns displayed in the agenda view."
  1706. :group 'org-agenda-column-view
  1707. :type 'boolean)
  1708. (defcustom org-agenda-columns-compute-summary-properties t
  1709. "Non-nil means recompute all summary properties before column view.
  1710. When column view in the agenda is listing properties that have a summary
  1711. operator, it can go to all relevant buffers and recompute the summaries
  1712. there. This can mean overhead for the agenda column view, but is necessary
  1713. to have thing up to date.
  1714. As a special case, a CLOCKSUM property also makes sure that the clock
  1715. computations are current."
  1716. :group 'org-agenda-column-view
  1717. :type 'boolean)
  1718. (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
  1719. "Non-nil means the duration of an appointment will add to day effort.
  1720. The property to which appointment durations will be added is the one given
  1721. in the option `org-effort-property'. If an appointment does not have
  1722. an end time, `org-agenda-default-appointment-duration' will be used. If that
  1723. is not set, an appointment without end time will not contribute to the time
  1724. estimate."
  1725. :group 'org-agenda-column-view
  1726. :type 'boolean)
  1727. (defcustom org-agenda-auto-exclude-function nil
  1728. "A function called with a tag to decide if it is filtered on '/ RET'.
  1729. The sole argument to the function, which is called once for each
  1730. possible tag, is a string giving the name of the tag. The
  1731. function should return either nil if the tag should be included
  1732. as normal, or \"-<TAG>\" to exclude the tag.
  1733. Note that for the purpose of tag filtering, only the lower-case version of
  1734. all tags will be considered, so that this function will only ever see
  1735. the lower-case version of all tags."
  1736. :group 'org-agenda
  1737. :type '(choice (const nil) (function)))
  1738. (defcustom org-agenda-bulk-custom-functions nil
  1739. "Alist of characters and custom functions for bulk actions.
  1740. For example, this value makes those two functions available:
  1741. '((?R set-category)
  1742. (?C bulk-cut))
  1743. With selected entries in an agenda buffer, `B R' will call
  1744. the custom function `set-category' on the selected entries.
  1745. Note that functions in this alist don't need to be quoted."
  1746. :type 'alist
  1747. :version "24.1"
  1748. :group 'org-agenda)
  1749. (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
  1750. "Execute BODY with point at location given by `org-hd-marker' property.
  1751. If STRING is non-nil, the text property will be fetched from position 0
  1752. in that string. If STRING is nil, it will be fetched from the beginning
  1753. of the current line."
  1754. (org-with-gensyms (marker)
  1755. `(let ((,marker (get-text-property (if string 0 (point-at-bol))
  1756. 'org-hd-marker ,string)))
  1757. (with-current-buffer (marker-buffer ,marker)
  1758. (save-excursion
  1759. (goto-char ,marker)
  1760. ,@body)))))
  1761. (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
  1762. (defun org-add-agenda-custom-command (entry)
  1763. "Replace or add a command in `org-agenda-custom-commands'.
  1764. This is mostly for hacking and trying a new command - once the command
  1765. works you probably want to add it to `org-agenda-custom-commands' for good."
  1766. (let ((ass (assoc (car entry) org-agenda-custom-commands)))
  1767. (if ass
  1768. (setcdr ass (cdr entry))
  1769. (push entry org-agenda-custom-commands))))
  1770. ;;; Define the org-agenda-mode
  1771. (defvar org-agenda-mode-map (make-sparse-keymap)
  1772. "Keymap for `org-agenda-mode'.")
  1773. (org-defvaralias 'org-agenda-keymap 'org-agenda-mode-map)
  1774. (defvar org-agenda-menu) ; defined later in this file.
  1775. (defvar org-agenda-restrict nil) ; defined later in this file.
  1776. (defvar org-agenda-follow-mode nil)
  1777. (defvar org-agenda-entry-text-mode nil)
  1778. (defvar org-agenda-clockreport-mode nil)
  1779. (defvar org-agenda-show-log nil)
  1780. (defvar org-agenda-redo-command nil)
  1781. (defvar org-agenda-query-string nil)
  1782. (defvar org-agenda-mode-hook nil
  1783. "Hook run after `org-agenda-mode' is turned on.
  1784. The buffer is still writable when this hook is called.")
  1785. (defvar org-agenda-type nil)
  1786. (defvar org-agenda-force-single-file nil)
  1787. (defvar org-agenda-bulk-marked-entries nil
  1788. "List of markers that refer to marked entries in the agenda.")
  1789. ;;; Multiple agenda buffers support
  1790. (defcustom org-agenda-sticky nil
  1791. "Non-nil means agenda q key will bury agenda buffers.
  1792. Agenda commands will then show existing buffer instead of generating new ones.
  1793. When nil, `q' will kill the single agenda buffer."
  1794. :group 'org-agenda
  1795. :version "24.3"
  1796. :type 'boolean)
  1797. ;;;###autoload
  1798. (defun org-toggle-sticky-agenda (&optional arg)
  1799. "Toggle `org-agenda-sticky'."
  1800. (interactive "P")
  1801. (let ((new-value (if arg
  1802. (> (prefix-numeric-value arg) 0)
  1803. (not org-agenda-sticky))))
  1804. (if (equal new-value org-agenda-sticky)
  1805. (and (org-called-interactively-p 'interactive)
  1806. (message "Sticky agenda was already %s"
  1807. (if org-agenda-sticky "enabled" "disabled")))
  1808. (setq org-agenda-sticky new-value)
  1809. (org-agenda-kill-all-agenda-buffers)
  1810. (and (org-called-interactively-p 'interactive)
  1811. (message "Sticky agenda was %s"
  1812. (if org-agenda-sticky "enabled" "disabled"))))))
  1813. (defvar org-agenda-buffer nil
  1814. "Agenda buffer currently being generated.")
  1815. (defvar org-agenda-last-prefix-arg nil)
  1816. (defvar org-agenda-this-buffer-name nil)
  1817. (defvar org-agenda-doing-sticky-redo nil)
  1818. (defvar org-agenda-this-buffer-is-sticky nil)
  1819. (defconst org-agenda-local-vars
  1820. '(org-agenda-this-buffer-name
  1821. org-agenda-undo-list
  1822. org-agenda-pending-undo-list
  1823. org-agenda-follow-mode
  1824. org-agenda-entry-text-mode
  1825. org-agenda-clockreport-mode
  1826. org-agenda-show-log
  1827. org-agenda-redo-command
  1828. org-agenda-query-string
  1829. org-agenda-type
  1830. org-agenda-bulk-marked-entries
  1831. org-agenda-undo-has-started-in
  1832. org-agenda-info
  1833. org-agenda-pre-window-conf
  1834. org-agenda-columns-active
  1835. org-agenda-tag-filter-overlays
  1836. org-agenda-tag-filter
  1837. org-agenda-cat-filter-overlays
  1838. org-agenda-category-filter
  1839. org-agenda-re-filter-overlays
  1840. org-agenda-regexp-filter
  1841. org-agenda-markers
  1842. org-agenda-last-search-view-search-was-boolean
  1843. org-agenda-filtered-by-category
  1844. org-agenda-filter-form
  1845. org-agenda-cycle-counter
  1846. org-agenda-last-prefix-arg)
  1847. "Variables that must be local in agenda buffers to allow multiple buffers.")
  1848. (defun org-agenda-mode ()
  1849. "Mode for time-sorted view on action items in Org-mode files.
  1850. The following commands are available:
  1851. \\{org-agenda-mode-map}"
  1852. (interactive)
  1853. (cond (org-agenda-doing-sticky-redo
  1854. ;; Refreshing sticky agenda-buffer
  1855. ;;
  1856. ;; Preserve the value of `org-agenda-local-vars' variables,
  1857. ;; while letting `kill-all-local-variables' kill the rest
  1858. (let ((save (buffer-local-variables)))
  1859. (kill-all-local-variables)
  1860. (mapc 'make-local-variable org-agenda-local-vars)
  1861. (dolist (elem save)
  1862. (let ((var (car elem))
  1863. (val (cdr elem)))
  1864. (when (and val
  1865. (member var org-agenda-local-vars))
  1866. (set var val)))))
  1867. (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
  1868. (org-agenda-sticky
  1869. ;; Creating a sticky Agenda buffer for the first time
  1870. (kill-all-local-variables)
  1871. (mapc 'make-local-variable org-agenda-local-vars)
  1872. (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
  1873. (t
  1874. ;; Creating a non-sticky agenda buffer
  1875. (kill-all-local-variables)
  1876. (set (make-local-variable 'org-agenda-this-buffer-is-sticky) nil)))
  1877. (setq org-agenda-undo-list nil
  1878. org-agenda-pending-undo-list nil
  1879. org-agenda-bulk-marked-entries nil)
  1880. (setq major-mode 'org-agenda-mode)
  1881. ;; Keep global-font-lock-mode from turning on font-lock-mode
  1882. (org-set-local 'font-lock-global-modes (list 'not major-mode))
  1883. (setq mode-name "Org-Agenda")
  1884. (use-local-map org-agenda-mode-map)
  1885. (easy-menu-add org-agenda-menu)
  1886. (if org-startup-truncated (setq truncate-lines t))
  1887. (org-set-local 'line-move-visual nil)
  1888. (org-add-hook 'post-command-hook 'org-agenda-update-agenda-type nil 'local)
  1889. (org-add-hook 'pre-command-hook 'org-unhighlight nil 'local)
  1890. ;; Make sure properties are removed when copying text
  1891. (org-add-hook 'filter-buffer-substring-functions
  1892. (lambda (fun start end delete)
  1893. (substring-no-properties (funcall fun start end delete)))
  1894. nil t)
  1895. (unless org-agenda-keep-modes
  1896. (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
  1897. org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
  1898. org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode
  1899. org-agenda-show-log org-agenda-start-with-log-mode))
  1900. (easy-menu-change
  1901. '("Agenda") "Agenda Files"
  1902. (append
  1903. (list
  1904. (vector
  1905. (if (get 'org-agenda-files 'org-restrict)
  1906. "Restricted to single file"
  1907. "Edit File List")
  1908. '(org-edit-agenda-file-list)
  1909. (not (get 'org-agenda-files 'org-restrict)))
  1910. "--")
  1911. (mapcar 'org-file-menu-entry (org-agenda-files))))
  1912. (org-agenda-set-mode-name)
  1913. (apply
  1914. (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
  1915. (list 'org-agenda-mode-hook)))
  1916. (substitute-key-definition 'undo 'org-agenda-undo
  1917. org-agenda-mode-map global-map)
  1918. (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
  1919. (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
  1920. (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
  1921. (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
  1922. (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
  1923. (org-defkey org-agenda-mode-map [(meta down)] 'org-agenda-drag-line-forward)
  1924. (org-defkey org-agenda-mode-map [(meta up)] 'org-agenda-drag-line-backward)
  1925. (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
  1926. (org-defkey org-agenda-mode-map "\M-m" 'org-agenda-bulk-toggle)
  1927. (org-defkey org-agenda-mode-map "*" 'org-agenda-bulk-mark-all)
  1928. (org-defkey org-agenda-mode-map "\M-*" 'org-agenda-bulk-toggle-all)
  1929. (org-defkey org-agenda-mode-map "#" 'org-agenda-dim-blocked-tasks)
  1930. (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
  1931. (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
  1932. (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-unmark-all)
  1933. (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
  1934. (org-defkey org-agenda-mode-map "k" 'org-agenda-capture)
  1935. (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
  1936. (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
  1937. (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
  1938. (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
  1939. (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
  1940. (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
  1941. (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
  1942. (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
  1943. (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
  1944. (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
  1945. (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
  1946. (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
  1947. (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
  1948. (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
  1949. (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
  1950. (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
  1951. (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
  1952. (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
  1953. (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
  1954. (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
  1955. (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
  1956. (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
  1957. (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
  1958. (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
  1959. (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
  1960. (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
  1961. (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
  1962. (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
  1963. (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
  1964. (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
  1965. (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
  1966. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
  1967. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
  1968. (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
  1969. (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
  1970. (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
  1971. (let ((l '(1 2 3 4 5 6 7 8 9 0)))
  1972. (while l (org-defkey org-agenda-mode-map
  1973. (int-to-string (pop l)) 'digit-argument)))
  1974. (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
  1975. (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
  1976. (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
  1977. (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
  1978. (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
  1979. (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
  1980. (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
  1981. (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
  1982. (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
  1983. (org-defkey org-agenda-mode-map "g" (lambda () (interactive) (org-agenda-redo t)))
  1984. (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
  1985. (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
  1986. (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
  1987. 'org-clock-modify-effort-estimate)
  1988. (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
  1989. (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
  1990. (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
  1991. (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
  1992. (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
  1993. (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
  1994. (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
  1995. (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
  1996. (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
  1997. (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
  1998. (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
  1999. (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
  2000. (substitute-key-definition 'next-line 'org-agenda-next-line
  2001. org-agenda-mode-map global-map)
  2002. (substitute-key-definition 'previous-line 'org-agenda-previous-line
  2003. org-agenda-mode-map global-map)
  2004. (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
  2005. (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
  2006. (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
  2007. (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
  2008. (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
  2009. (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
  2010. (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
  2011. (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
  2012. (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
  2013. (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
  2014. (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
  2015. (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
  2016. (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
  2017. (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
  2018. (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
  2019. (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
  2020. (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
  2021. (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
  2022. (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  2023. (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
  2024. (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
  2025. (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
  2026. (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
  2027. (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
  2028. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
  2029. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
  2030. (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
  2031. (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
  2032. (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
  2033. (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  2034. (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
  2035. (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
  2036. (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
  2037. (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
  2038. (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
  2039. (org-defkey org-agenda-mode-map "=" 'org-agenda-filter-by-regexp)
  2040. (org-defkey org-agenda-mode-map "|" 'org-agenda-filter-remove-all)
  2041. (org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag-refine)
  2042. (org-defkey org-agenda-mode-map "~" 'org-agenda-limit-interactively)
  2043. (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
  2044. (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-headline)
  2045. (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
  2046. (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
  2047. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  2048. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  2049. (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
  2050. (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
  2051. (when org-agenda-mouse-1-follows-link
  2052. (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
  2053. (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
  2054. '("Agenda"
  2055. ("Agenda Files")
  2056. "--"
  2057. ("Agenda Dates"
  2058. ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
  2059. ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
  2060. ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
  2061. ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
  2062. "--"
  2063. ("View"
  2064. ["Day View" org-agenda-day-view
  2065. :active (org-agenda-check-type nil 'agenda)
  2066. :style radio :selected (eq org-agenda-current-span 'day)
  2067. :keys "v d (or just d)"]
  2068. ["Week View" org-agenda-week-view
  2069. :active (org-agenda-check-type nil 'agenda)
  2070. :style radio :selected (eq org-agenda-current-span 'week)
  2071. :keys "v w"]
  2072. ["Fortnight View" org-agenda-fortnight-view
  2073. :active (org-agenda-check-type nil 'agenda)
  2074. :style radio :selected (eq org-agenda-current-span 'fortnight)
  2075. :keys "v f"]
  2076. ["Month View" org-agenda-month-view
  2077. :active (org-agenda-check-type nil 'agenda)
  2078. :style radio :selected (eq org-agenda-current-span 'month)
  2079. :keys "v m"]
  2080. ["Year View" org-agenda-year-view
  2081. :active (org-agenda-check-type nil 'agenda)
  2082. :style radio :selected (eq org-agenda-current-span 'year)
  2083. :keys "v y"]
  2084. "--"
  2085. ["Include Diary" org-agenda-toggle-diary
  2086. :style toggle :selected org-agenda-include-diary
  2087. :active (org-agenda-check-type nil 'agenda)]
  2088. ["Include Deadlines" org-agenda-toggle-deadlines
  2089. :style toggle :selected org-agenda-include-deadlines
  2090. :active (org-agenda-check-type nil 'agenda)]
  2091. ["Use Time Grid" org-agenda-toggle-time-grid
  2092. :style toggle :selected org-agenda-use-time-grid
  2093. :active (org-agenda-check-type nil 'agenda)]
  2094. "--"
  2095. ["Show clock report" org-agenda-clockreport-mode
  2096. :style toggle :selected org-agenda-clockreport-mode
  2097. :active (org-agenda-check-type nil 'agenda)]
  2098. ["Show some entry text" org-agenda-entry-text-mode
  2099. :style toggle :selected org-agenda-entry-text-mode
  2100. :active t]
  2101. "--"
  2102. ["Show Logbook entries" org-agenda-log-mode
  2103. :style toggle :selected org-agenda-show-log
  2104. :active (org-agenda-check-type nil 'agenda 'timeline)
  2105. :keys "v l (or just l)"]
  2106. ["Include archived trees" org-agenda-archives-mode
  2107. :style toggle :selected org-agenda-archives-mode :active t
  2108. :keys "v a"]
  2109. ["Include archive files" (org-agenda-archives-mode t)
  2110. :style toggle :selected (eq org-agenda-archives-mode t) :active t
  2111. :keys "v A"]
  2112. "--"
  2113. ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
  2114. ["Write view to file" org-agenda-write t]
  2115. ["Rebuild buffer" org-agenda-redo t]
  2116. ["Save all Org-mode Buffers" org-save-all-org-buffers t]
  2117. "--"
  2118. ["Show original entry" org-agenda-show t]
  2119. ["Go To (other window)" org-agenda-goto t]
  2120. ["Go To (this window)" org-agenda-switch-to t]
  2121. ["Capture with cursor date" org-agenda-capture t]
  2122. ["Follow Mode" org-agenda-follow-mode
  2123. :style toggle :selected org-agenda-follow-mode :active t]
  2124. ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
  2125. "--"
  2126. ("TODO"
  2127. ["Cycle TODO" org-agenda-todo t]
  2128. ["Next TODO set" org-agenda-todo-nextset t]
  2129. ["Previous TODO set" org-agenda-todo-previousset t]
  2130. ["Add note" org-agenda-add-note t])
  2131. ("Archive/Refile/Delete"
  2132. ["Archive default" org-agenda-archive-default t]
  2133. ["Archive default" org-agenda-archive-default-with-confirmation t]
  2134. ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
  2135. ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
  2136. ["Archive subtree" org-agenda-archive t]
  2137. "--"
  2138. ["Refile" org-agenda-refile t]
  2139. "--"
  2140. ["Delete subtree" org-agenda-kill t])
  2141. ("Bulk action"
  2142. ["Mark entry" org-agenda-bulk-mark t]
  2143. ["Mark all" org-agenda-bulk-mark-all t]
  2144. ["Unmark entry" org-agenda-bulk-unmark t]
  2145. ["Unmark all" org-agenda-bulk-unmark-all :active t :keys "U"]
  2146. ["Toggle mark" org-agenda-bulk-toggle t]
  2147. ["Toggle all" org-agenda-bulk-toggle-all t]
  2148. ["Mark regexp" org-agenda-bulk-mark-regexp t])
  2149. ["Act on all marked" org-agenda-bulk-action t]
  2150. "--"
  2151. ("Tags and Properties"
  2152. ["Show all Tags" org-agenda-show-tags t]
  2153. ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
  2154. ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
  2155. "--"
  2156. ["Column View" org-columns t])
  2157. ("Deadline/Schedule"
  2158. ["Schedule" org-agenda-schedule t]
  2159. ["Set Deadline" org-agenda-deadline t]
  2160. "--"
  2161. ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
  2162. ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
  2163. ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
  2164. ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
  2165. ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
  2166. ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
  2167. ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
  2168. ("Clock and Effort"
  2169. ["Clock in" org-agenda-clock-in t]
  2170. ["Clock out" org-agenda-clock-out t]
  2171. ["Clock cancel" org-agenda-clock-cancel t]
  2172. ["Goto running clock" org-clock-goto t]
  2173. "--"
  2174. ["Set Effort" org-agenda-set-effort t]
  2175. ["Change clocked effort" org-clock-modify-effort-estimate
  2176. (org-clock-is-active)])
  2177. ("Priority"
  2178. ["Set Priority" org-agenda-priority t]
  2179. ["Increase Priority" org-agenda-priority-up t]
  2180. ["Decrease Priority" org-agenda-priority-down t]
  2181. ["Show Priority" org-show-priority t])
  2182. ("Calendar/Diary"
  2183. ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
  2184. ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
  2185. ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
  2186. ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
  2187. ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
  2188. ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
  2189. "--"
  2190. ["Create iCalendar File" org-icalendar-combine-agenda-files t])
  2191. "--"
  2192. ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
  2193. "--"
  2194. ("MobileOrg"
  2195. ["Push Files and Views" org-mobile-push t]
  2196. ["Get Captured and Flagged" org-mobile-pull t]
  2197. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
  2198. ["Show note / unflag" org-agenda-show-the-flagging-note t]
  2199. "--"
  2200. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  2201. "--"
  2202. ["Quit" org-agenda-quit t]
  2203. ["Exit and Release Buffers" org-agenda-exit t]
  2204. ))
  2205. ;;; Agenda undo
  2206. (defvar org-agenda-allow-remote-undo t
  2207. "Non-nil means allow remote undo from the agenda buffer.")
  2208. (defvar org-agenda-undo-has-started-in nil
  2209. "Buffers that have already seen `undo-start' in the current undo sequence.")
  2210. (defun org-agenda-undo ()
  2211. "Undo a remote editing step in the agenda.
  2212. This undoes changes both in the agenda buffer and in the remote buffer
  2213. that have been changed along."
  2214. (interactive)
  2215. (or org-agenda-allow-remote-undo
  2216. (user-error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
  2217. (if (not (eq this-command last-command))
  2218. (setq org-agenda-undo-has-started-in nil
  2219. org-agenda-pending-undo-list org-agenda-undo-list))
  2220. (if (not org-agenda-pending-undo-list)
  2221. (user-error "No further undo information"))
  2222. (let* ((entry (pop org-agenda-pending-undo-list))
  2223. buf line cmd rembuf)
  2224. (setq cmd (pop entry) line (pop entry))
  2225. (setq rembuf (nth 2 entry))
  2226. (org-with-remote-undo rembuf
  2227. (while (bufferp (setq buf (pop entry)))
  2228. (if (pop entry)
  2229. (with-current-buffer buf
  2230. (let ((last-undo-buffer buf)
  2231. (inhibit-read-only t))
  2232. (unless (memq buf org-agenda-undo-has-started-in)
  2233. (push buf org-agenda-undo-has-started-in)
  2234. (make-local-variable 'pending-undo-list)
  2235. (undo-start))
  2236. (while (and pending-undo-list
  2237. (listp pending-undo-list)
  2238. (not (car pending-undo-list)))
  2239. (pop pending-undo-list))
  2240. (undo-more 1))))))
  2241. (org-goto-line line)
  2242. (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
  2243. (defun org-verify-change-for-undo (l1 l2)
  2244. "Verify that a real change occurred between the undo lists L1 and L2."
  2245. (while (and l1 (listp l1) (null (car l1))) (pop l1))
  2246. (while (and l2 (listp l2) (null (car l2))) (pop l2))
  2247. (not (eq l1 l2)))
  2248. ;;; Agenda dispatch
  2249. (defvar org-agenda-restrict-begin (make-marker))
  2250. (defvar org-agenda-restrict-end (make-marker))
  2251. (defvar org-agenda-last-dispatch-buffer nil)
  2252. (defvar org-agenda-overriding-restriction nil)
  2253. (defcustom org-agenda-custom-commands-contexts nil
  2254. "Alist of custom agenda keys and contextual rules.
  2255. For example, if you have a custom agenda command \"p\" and you
  2256. want this command to be accessible only from plain text files,
  2257. use this:
  2258. '((\"p\" ((in-file . \"\\.txt\"))))
  2259. Here are the available contexts definitions:
  2260. in-file: command displayed only in matching files
  2261. in-mode: command displayed only in matching modes
  2262. not-in-file: command not displayed in matching files
  2263. not-in-mode: command not displayed in matching modes
  2264. in-buffer: command displayed only in matching buffers
  2265. not-in-buffer: command not displayed in matching buffers
  2266. [function]: a custom function taking no argument
  2267. If you define several checks, the agenda command will be
  2268. accessible if there is at least one valid check.
  2269. You can also bind a key to another agenda custom command
  2270. depending on contextual rules.
  2271. '((\"p\" \"q\" ((in-file . \"\\.txt\"))))
  2272. Here it means: in .txt files, use \"p\" as the key for the
  2273. agenda command otherwise associated with \"q\". (The command
  2274. originally associated with \"q\" is not displayed to avoid
  2275. duplicates.)"
  2276. :version "24.3"
  2277. :group 'org-agenda-custom-commands
  2278. :type '(repeat (list :tag "Rule"
  2279. (string :tag " Agenda key")
  2280. (string :tag "Replace by command")
  2281. (repeat :tag "Available when"
  2282. (choice
  2283. (cons :tag "Condition"
  2284. (choice
  2285. (const :tag "In file" in-file)
  2286. (const :tag "Not in file" not-in-file)
  2287. (const :tag "In buffer" in-buffer)
  2288. (const :tag "Not in buffer" not-in-buffer)
  2289. (const :tag "In mode" in-mode)
  2290. (const :tag "Not in mode" not-in-mode))
  2291. (regexp))
  2292. (function :tag "Custom function"))))))
  2293. (defcustom org-agenda-max-entries nil
  2294. "Maximum number of entries to display in an agenda.
  2295. This can be nil (no limit) or an integer or an alist of agenda
  2296. types with an associated number of entries to display in this
  2297. type."
  2298. :version "24.4"
  2299. :package-version '(Org . "8.0")
  2300. :group 'org-agenda-custom-commands
  2301. :type '(choice (symbol :tag "No limit" nil)
  2302. (integer :tag "Max number of entries")
  2303. (repeat
  2304. (cons (choice :tag "Agenda type"
  2305. (const agenda)
  2306. (const todo)
  2307. (const tags)
  2308. (const search)
  2309. (const timeline))
  2310. (integer :tag "Max number of entries")))))
  2311. (defcustom org-agenda-max-todos nil
  2312. "Maximum number of TODOs to display in an agenda.
  2313. This can be nil (no limit) or an integer or an alist of agenda
  2314. types with an associated number of entries to display in this
  2315. type."
  2316. :version "24.4"
  2317. :package-version '(Org . "8.0")
  2318. :group 'org-agenda-custom-commands
  2319. :type '(choice (symbol :tag "No limit" nil)
  2320. (integer :tag "Max number of entries")
  2321. (repeat
  2322. (cons (choice :tag "Agenda type"
  2323. (const agenda)
  2324. (const todo)
  2325. (const tags)
  2326. (const search)
  2327. (const timeline))
  2328. (integer :tag "Max number of entries")))))
  2329. (defcustom org-agenda-max-tags nil
  2330. "Maximum number of tagged entries to display in an agenda.
  2331. This can be nil (no limit) or an integer or an alist of agenda
  2332. types with an associated number of entries to display in this
  2333. type."
  2334. :version "24.4"
  2335. :package-version '(Org . "8.0")
  2336. :group 'org-agenda-custom-commands
  2337. :type '(choice (symbol :tag "No limit" nil)
  2338. (integer :tag "Max number of entries")
  2339. (repeat
  2340. (cons (choice :tag "Agenda type"
  2341. (const agenda)
  2342. (const todo)
  2343. (const tags)
  2344. (const search)
  2345. (const timeline))
  2346. (integer :tag "Max number of entries")))))
  2347. (defcustom org-agenda-max-effort nil
  2348. "Maximum cumulated effort duration for the agenda.
  2349. This can be nil (no limit) or a number of minutes (as an integer)
  2350. or an alist of agenda types with an associated number of minutes
  2351. to limit entries to in this type."
  2352. :version "24.4"
  2353. :package-version '(Org . "8.0")
  2354. :group 'org-agenda-custom-commands
  2355. :type '(choice (symbol :tag "No limit" nil)
  2356. (integer :tag "Max number of entries")
  2357. (repeat
  2358. (cons (choice :tag "Agenda type"
  2359. (const agenda)
  2360. (const todo)
  2361. (const tags)
  2362. (const search)
  2363. (const timeline))
  2364. (integer :tag "Max number of entries")))))
  2365. (defvar org-keys nil)
  2366. (defvar org-match nil)
  2367. ;;;###autoload
  2368. (defun org-agenda (&optional arg org-keys restriction)
  2369. "Dispatch agenda commands to collect entries to the agenda buffer.
  2370. Prompts for a command to execute. Any prefix arg will be passed
  2371. on to the selected command. The default selections are:
  2372. a Call `org-agenda-list' to display the agenda for current day or week.
  2373. t Call `org-todo-list' to display the global todo list.
  2374. T Call `org-todo-list' to display the global todo list, select only
  2375. entries with a specific TODO keyword (the user gets a prompt).
  2376. m Call `org-tags-view' to display headlines with tags matching
  2377. a condition (the user is prompted for the condition).
  2378. M Like `m', but select only TODO entries, no ordinary headlines.
  2379. L Create a timeline for the current buffer.
  2380. e Export views to associated files.
  2381. s Search entries for keywords.
  2382. S Search entries for keywords, only with TODO keywords.
  2383. / Multi occur across all agenda files and also files listed
  2384. in `org-agenda-text-search-extra-files'.
  2385. < Restrict agenda commands to buffer, subtree, or region.
  2386. Press several times to get the desired effect.
  2387. > Remove a previous restriction.
  2388. # List \"stuck\" projects.
  2389. ! Configure what \"stuck\" means.
  2390. C Configure custom agenda commands.
  2391. More commands can be added by configuring the variable
  2392. `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
  2393. searches can be pre-defined in this way.
  2394. If the current buffer is in Org-mode and visiting a file, you can also
  2395. first press `<' once to indicate that the agenda should be temporarily
  2396. \(until the next use of \\[org-agenda]) restricted to the current file.
  2397. Pressing `<' twice means to restrict to the current subtree or region
  2398. \(if active)."
  2399. (interactive "P")
  2400. (catch 'exit
  2401. (let* ((prefix-descriptions nil)
  2402. (org-agenda-buffer-name org-agenda-buffer-name)
  2403. (org-agenda-window-setup (if (equal (buffer-name)
  2404. org-agenda-buffer-name)
  2405. 'current-window
  2406. org-agenda-window-setup))
  2407. (org-agenda-custom-commands-orig org-agenda-custom-commands)
  2408. (org-agenda-custom-commands
  2409. ;; normalize different versions
  2410. (delq nil
  2411. (mapcar
  2412. (lambda (x)
  2413. (cond ((stringp (cdr x))
  2414. (push x prefix-descriptions)
  2415. nil)
  2416. ((stringp (nth 1 x)) x)
  2417. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2418. (t (cons (car x) (cons "" (cdr x))))))
  2419. org-agenda-custom-commands)))
  2420. (org-agenda-custom-commands
  2421. (org-contextualize-keys
  2422. org-agenda-custom-commands org-agenda-custom-commands-contexts))
  2423. (buf (current-buffer))
  2424. (bfn (buffer-file-name (buffer-base-buffer)))
  2425. entry key type org-match lprops ans)
  2426. ;; Turn off restriction unless there is an overriding one,
  2427. (unless org-agenda-overriding-restriction
  2428. (unless (org-bound-and-true-p org-agenda-keep-restricted-file-list)
  2429. ;; There is a request to keep the file list in place
  2430. (put 'org-agenda-files 'org-restrict nil))
  2431. (setq org-agenda-restrict nil)
  2432. (move-marker org-agenda-restrict-begin nil)
  2433. (move-marker org-agenda-restrict-end nil))
  2434. ;; Delete old local properties
  2435. (put 'org-agenda-redo-command 'org-lprops nil)
  2436. ;; Delete previously set last-arguments
  2437. (put 'org-agenda-redo-command 'last-args nil)
  2438. ;; Remember where this call originated
  2439. (setq org-agenda-last-dispatch-buffer (current-buffer))
  2440. (unless org-keys
  2441. (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
  2442. org-keys (car ans)
  2443. restriction (cdr ans)))
  2444. ;; If we have sticky agenda buffers, set a name for the buffer,
  2445. ;; depending on the invoking keys. The user may still set this
  2446. ;; as a command option, which will overwrite what we do here.
  2447. (if org-agenda-sticky
  2448. (setq org-agenda-buffer-name
  2449. (format "*Org Agenda(%s)*" org-keys)))
  2450. ;; Establish the restriction, if any
  2451. (when (and (not org-agenda-overriding-restriction) restriction)
  2452. (put 'org-agenda-files 'org-restrict (list bfn))
  2453. (cond
  2454. ((eq restriction 'region)
  2455. (setq org-agenda-restrict (current-buffer))
  2456. (move-marker org-agenda-restrict-begin (region-beginning))
  2457. (move-marker org-agenda-restrict-end (region-end)))
  2458. ((eq restriction 'subtree)
  2459. (save-excursion
  2460. (setq org-agenda-restrict (current-buffer))
  2461. (org-back-to-heading t)
  2462. (move-marker org-agenda-restrict-begin (point))
  2463. (move-marker org-agenda-restrict-end
  2464. (progn (org-end-of-subtree t)))))))
  2465. ;; For example the todo list should not need it (but does...)
  2466. (cond
  2467. ((setq entry (assoc org-keys org-agenda-custom-commands))
  2468. (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
  2469. (progn
  2470. (setq type (nth 2 entry) org-match (eval (nth 3 entry))
  2471. lprops (nth 4 entry))
  2472. (if org-agenda-sticky
  2473. (setq org-agenda-buffer-name
  2474. (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
  2475. (format "*Org Agenda(%s)*" org-keys))))
  2476. (put 'org-agenda-redo-command 'org-lprops lprops)
  2477. (cond
  2478. ((eq type 'agenda)
  2479. (org-let lprops '(org-agenda-list current-prefix-arg)))
  2480. ((eq type 'agenda*)
  2481. (org-let lprops '(org-agenda-list current-prefix-arg nil nil t)))
  2482. ((eq type 'alltodo)
  2483. (org-let lprops '(org-todo-list current-prefix-arg)))
  2484. ((eq type 'search)
  2485. (org-let lprops '(org-search-view current-prefix-arg org-match nil)))
  2486. ((eq type 'stuck)
  2487. (org-let lprops '(org-agenda-list-stuck-projects
  2488. current-prefix-arg)))
  2489. ((eq type 'tags)
  2490. (org-let lprops '(org-tags-view current-prefix-arg org-match)))
  2491. ((eq type 'tags-todo)
  2492. (org-let lprops '(org-tags-view '(4) org-match)))
  2493. ((eq type 'todo)
  2494. (org-let lprops '(org-todo-list org-match)))
  2495. ((eq type 'tags-tree)
  2496. (org-check-for-org-mode)
  2497. (org-let lprops '(org-match-sparse-tree current-prefix-arg org-match)))
  2498. ((eq type 'todo-tree)
  2499. (org-check-for-org-mode)
  2500. (org-let lprops
  2501. '(org-occur (concat "^" org-outline-regexp "[ \t]*"
  2502. (regexp-quote org-match) "\\>"))))
  2503. ((eq type 'occur-tree)
  2504. (org-check-for-org-mode)
  2505. (org-let lprops '(org-occur org-match)))
  2506. ((functionp type)
  2507. (org-let lprops '(funcall type org-match)))
  2508. ((fboundp type)
  2509. (org-let lprops '(funcall type org-match)))
  2510. (t (user-error "Invalid custom agenda command type %s" type))))
  2511. (org-agenda-run-series (nth 1 entry) (cddr entry))))
  2512. ((equal org-keys "C")
  2513. (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
  2514. (customize-variable 'org-agenda-custom-commands))
  2515. ((equal org-keys "a") (call-interactively 'org-agenda-list))
  2516. ((equal org-keys "s") (call-interactively 'org-search-view))
  2517. ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
  2518. ((equal org-keys "t") (call-interactively 'org-todo-list))
  2519. ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
  2520. ((equal org-keys "m") (call-interactively 'org-tags-view))
  2521. ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
  2522. ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
  2523. ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
  2524. (org-add-hook
  2525. 'post-command-hook
  2526. (lambda ()
  2527. (unless (current-message)
  2528. (let* ((m (org-agenda-get-any-marker))
  2529. (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
  2530. (when note
  2531. (message (concat
  2532. "FLAGGING-NOTE ([?] for more info): "
  2533. (org-add-props
  2534. (replace-regexp-in-string
  2535. "\\\\n" "//"
  2536. (copy-sequence note))
  2537. nil 'face 'org-warning)))))))
  2538. t t))
  2539. ((equal org-keys "L")
  2540. (unless (derived-mode-p 'org-mode)
  2541. (user-error "This is not an Org-mode file"))
  2542. (unless restriction
  2543. (put 'org-agenda-files 'org-restrict (list bfn))
  2544. (org-call-with-arg 'org-timeline arg)))
  2545. ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
  2546. ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
  2547. ((equal org-keys "!") (customize-variable 'org-stuck-projects))
  2548. (t (user-error "Invalid agenda key"))))))
  2549. (defvar org-agenda-multi)
  2550. (defun org-agenda-append-agenda ()
  2551. "Append another agenda view to the current one.
  2552. This function allows interactive building of block agendas.
  2553. Agenda views are separated by `org-agenda-block-separator'."
  2554. (interactive)
  2555. (unless (derived-mode-p 'org-agenda-mode)
  2556. (user-error "Can only append from within agenda buffer"))
  2557. (let ((org-agenda-multi t))
  2558. (org-agenda)
  2559. (widen)
  2560. (org-agenda-finalize)
  2561. (setq buffer-read-only t)
  2562. (org-agenda-fit-window-to-buffer)))
  2563. (defun org-agenda-normalize-custom-commands (cmds)
  2564. "Normalize custom commands CMDS."
  2565. (delq nil
  2566. (mapcar
  2567. (lambda (x)
  2568. (cond ((stringp (cdr x)) nil)
  2569. ((stringp (nth 1 x)) x)
  2570. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2571. (t (cons (car x) (cons "" (cdr x))))))
  2572. cmds)))
  2573. (defun org-agenda-get-restriction-and-command (prefix-descriptions)
  2574. "The user interface for selecting an agenda command."
  2575. (catch 'exit
  2576. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  2577. (restrict-ok (and bfn (derived-mode-p 'org-mode)))
  2578. (region-p (org-region-active-p))
  2579. (custom org-agenda-custom-commands)
  2580. (selstring "")
  2581. restriction second-time
  2582. c entry key type match prefixes rmheader header-end custom1 desc
  2583. line lines left right n n1)
  2584. (save-window-excursion
  2585. (delete-other-windows)
  2586. (org-switch-to-buffer-other-window " *Agenda Commands*")
  2587. (erase-buffer)
  2588. (insert (eval-when-compile
  2589. (let ((header
  2590. "Press key for an agenda command: < Buffer, subtree/region restriction
  2591. -------------------------------- > Remove restriction
  2592. a Agenda for current week or day e Export agenda views
  2593. t List of all TODO entries T Entries with special TODO kwd
  2594. m Match a TAGS/PROP/TODO query M Like m, but only TODO entries
  2595. s Search for keywords S Like s, but only TODO entries
  2596. L Timeline for current buffer # List stuck projects (!=configure)
  2597. / Multi-occur C Configure custom agenda commands
  2598. ? Find :FLAGGED: entries * Toggle sticky agenda views
  2599. ")
  2600. (start 0))
  2601. (while (string-match
  2602. "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
  2603. header start)
  2604. (setq start (match-end 0))
  2605. (add-text-properties (match-beginning 2) (match-end 2)
  2606. '(face bold) header))
  2607. header)))
  2608. (setq header-end (point-marker))
  2609. (while t
  2610. (setq custom1 custom)
  2611. (when (eq rmheader t)
  2612. (org-goto-line 1)
  2613. (re-search-forward ":" nil t)
  2614. (delete-region (match-end 0) (point-at-eol))
  2615. (forward-char 1)
  2616. (looking-at "-+")
  2617. (delete-region (match-end 0) (point-at-eol))
  2618. (move-marker header-end (match-end 0)))
  2619. (goto-char header-end)
  2620. (delete-region (point) (point-max))
  2621. ;; Produce all the lines that describe custom commands and prefixes
  2622. (setq lines nil)
  2623. (while (setq entry (pop custom1))
  2624. (setq key (car entry) desc (nth 1 entry)
  2625. type (nth 2 entry)
  2626. match (nth 3 entry))
  2627. (if (> (length key) 1)
  2628. (add-to-list 'prefixes (string-to-char key))
  2629. (setq line
  2630. (format
  2631. "%-4s%-14s"
  2632. (org-add-props (copy-sequence key)
  2633. '(face bold))
  2634. (cond
  2635. ((string-match "\\S-" desc) desc)
  2636. ((eq type 'agenda) "Agenda for current week or day")
  2637. ((eq type 'agenda*) "Appointments for current week or day")
  2638. ((eq type 'alltodo) "List of all TODO entries")
  2639. ((eq type 'search) "Word search")
  2640. ((eq type 'stuck) "List of stuck projects")
  2641. ((eq type 'todo) "TODO keyword")
  2642. ((eq type 'tags) "Tags query")
  2643. ((eq type 'tags-todo) "Tags (TODO)")
  2644. ((eq type 'tags-tree) "Tags tree")
  2645. ((eq type 'todo-tree) "TODO kwd tree")
  2646. ((eq type 'occur-tree) "Occur tree")
  2647. ((functionp type) (if (symbolp type)
  2648. (symbol-name type)
  2649. "Lambda expression"))
  2650. (t "???"))))
  2651. (if org-agenda-menu-show-matcher
  2652. (setq line
  2653. (concat line ": "
  2654. (cond
  2655. ((stringp match)
  2656. (setq match (copy-sequence match))
  2657. (org-add-props match nil 'face 'org-warning))
  2658. ((listp type)
  2659. (format "set of %d commands" (length type))))))
  2660. (if (org-string-nw-p match)
  2661. (add-text-properties
  2662. 0 (length line) (list 'help-echo
  2663. (concat "Matcher: " match)) line)))
  2664. (push line lines)))
  2665. (setq lines (nreverse lines))
  2666. (when prefixes
  2667. (mapc (lambda (x)
  2668. (push
  2669. (format "%s %s"
  2670. (org-add-props (char-to-string x)
  2671. nil 'face 'bold)
  2672. (or (cdr (assoc (concat selstring
  2673. (char-to-string x))
  2674. prefix-descriptions))
  2675. "Prefix key"))
  2676. lines))
  2677. prefixes))
  2678. ;; Check if we should display in two columns
  2679. (if org-agenda-menu-two-columns
  2680. (progn
  2681. (setq n (length lines)
  2682. n1 (+ (/ n 2) (mod n 2))
  2683. right (nthcdr n1 lines)
  2684. left (copy-sequence lines))
  2685. (setcdr (nthcdr (1- n1) left) nil))
  2686. (setq left lines right nil))
  2687. (while left
  2688. (insert "\n" (pop left))
  2689. (when right
  2690. (if (< (current-column) 40)
  2691. (move-to-column 40 t)
  2692. (insert " "))
  2693. (insert (pop right))))
  2694. ;; Make the window the right size
  2695. (goto-char (point-min))
  2696. (if second-time
  2697. (if (not (pos-visible-in-window-p (point-max)))
  2698. (org-fit-window-to-buffer))
  2699. (setq second-time t)
  2700. (org-fit-window-to-buffer))
  2701. ;; Ask for selection
  2702. (message "Press key for agenda command%s:"
  2703. (if (or restrict-ok org-agenda-overriding-restriction)
  2704. (if org-agenda-overriding-restriction
  2705. " (restriction lock active)"
  2706. (if restriction
  2707. (format " (restricted to %s)" restriction)
  2708. " (unrestricted)"))
  2709. ""))
  2710. (setq c (read-char-exclusive))
  2711. (message "")
  2712. (cond
  2713. ((assoc (char-to-string c) custom)
  2714. (setq selstring (concat selstring (char-to-string c)))
  2715. (throw 'exit (cons selstring restriction)))
  2716. ((memq c prefixes)
  2717. (setq selstring (concat selstring (char-to-string c))
  2718. prefixes nil
  2719. rmheader (or rmheader t)
  2720. custom (delq nil (mapcar
  2721. (lambda (x)
  2722. (if (or (= (length (car x)) 1)
  2723. (/= (string-to-char (car x)) c))
  2724. nil
  2725. (cons (substring (car x) 1) (cdr x))))
  2726. custom))))
  2727. ((eq c ?*)
  2728. (call-interactively 'org-toggle-sticky-agenda)
  2729. (sit-for 2))
  2730. ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
  2731. (message "Restriction is only possible in Org-mode buffers")
  2732. (ding) (sit-for 1))
  2733. ((eq c ?1)
  2734. (org-agenda-remove-restriction-lock 'noupdate)
  2735. (setq restriction 'buffer))
  2736. ((eq c ?0)
  2737. (org-agenda-remove-restriction-lock 'noupdate)
  2738. (setq restriction (if region-p 'region 'subtree)))
  2739. ((eq c ?<)
  2740. (org-agenda-remove-restriction-lock 'noupdate)
  2741. (setq restriction
  2742. (cond
  2743. ((eq restriction 'buffer)
  2744. (if region-p 'region 'subtree))
  2745. ((memq restriction '(subtree region))
  2746. nil)
  2747. (t 'buffer))))
  2748. ((eq c ?>)
  2749. (org-agenda-remove-restriction-lock 'noupdate)
  2750. (setq restriction nil))
  2751. ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
  2752. (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
  2753. ((and (> (length selstring) 0) (eq c ?\d))
  2754. (delete-window)
  2755. (org-agenda-get-restriction-and-command prefix-descriptions))
  2756. ((equal c ?q) (error "Abort"))
  2757. (t (user-error "Invalid key %c" c))))))))
  2758. (defun org-agenda-fit-window-to-buffer ()
  2759. "Fit the window to the buffer size."
  2760. (and (memq org-agenda-window-setup '(reorganize-frame))
  2761. (fboundp 'fit-window-to-buffer)
  2762. (if (and (= (cdr org-agenda-window-frame-fractions) 1.0)
  2763. (= (car org-agenda-window-frame-fractions) 1.0))
  2764. (delete-other-windows)
  2765. (org-fit-window-to-buffer
  2766. nil
  2767. (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
  2768. (floor (* (frame-height) (car org-agenda-window-frame-fractions)))))))
  2769. (defvar org-cmd nil)
  2770. (defvar org-agenda-overriding-cmd nil)
  2771. (defvar org-agenda-overriding-arguments nil)
  2772. (defvar org-agenda-overriding-cmd-arguments nil)
  2773. (defun org-agenda-run-series (name series)
  2774. "Run agenda NAME as a SERIES of agenda commands."
  2775. (org-let (nth 1 series) '(org-agenda-prepare name))
  2776. ;; We need to reset agenda markers here, because when constructing a
  2777. ;; block agenda, the individual blocks do not do that.
  2778. (org-agenda-reset-markers)
  2779. (let* ((org-agenda-multi t)
  2780. (redo (list 'org-agenda-run-series name (list 'quote series)))
  2781. (cmds (car series))
  2782. (gprops (nth 1 series))
  2783. match ;; The byte compiler incorrectly complains about this. Keep it!
  2784. org-cmd type lprops)
  2785. (while (setq org-cmd (pop cmds))
  2786. (setq type (car org-cmd)
  2787. match (eval (nth 1 org-cmd))
  2788. lprops (nth 2 org-cmd))
  2789. (let ((org-agenda-overriding-arguments
  2790. (if (eq org-agenda-overriding-cmd org-cmd)
  2791. (or org-agenda-overriding-arguments
  2792. org-agenda-overriding-cmd-arguments))))
  2793. (cond
  2794. ((eq type 'agenda)
  2795. (org-let2 gprops lprops
  2796. '(call-interactively 'org-agenda-list)))
  2797. ((eq type 'agenda*)
  2798. (org-let2 gprops lprops
  2799. '(funcall 'org-agenda-list nil nil t)))
  2800. ((eq type 'alltodo)
  2801. (org-let2 gprops lprops
  2802. '(call-interactively 'org-todo-list)))
  2803. ((eq type 'search)
  2804. (org-let2 gprops lprops
  2805. '(org-search-view current-prefix-arg match nil)))
  2806. ((eq type 'stuck)
  2807. (org-let2 gprops lprops
  2808. '(call-interactively 'org-agenda-list-stuck-projects)))
  2809. ((eq type 'tags)
  2810. (org-let2 gprops lprops
  2811. '(org-tags-view current-prefix-arg match)))
  2812. ((eq type 'tags-todo)
  2813. (org-let2 gprops lprops
  2814. '(org-tags-view '(4) match)))
  2815. ((eq type 'todo)
  2816. (org-let2 gprops lprops
  2817. '(org-todo-list match)))
  2818. ((fboundp type)
  2819. (org-let2 gprops lprops
  2820. '(funcall type match)))
  2821. (t (error "Invalid type in command series")))))
  2822. (widen)
  2823. (let ((inhibit-read-only t))
  2824. (add-text-properties (point-min) (point-max)
  2825. `(org-series t org-series-redo-cmd ,redo)))
  2826. (setq org-agenda-redo-command redo)
  2827. (goto-char (point-min)))
  2828. (org-agenda-fit-window-to-buffer)
  2829. (org-let (nth 1 series) '(org-agenda-finalize)))
  2830. ;;;###autoload
  2831. (defmacro org-batch-agenda (cmd-key &rest parameters)
  2832. "Run an agenda command in batch mode and send the result to STDOUT.
  2833. If CMD-KEY is a string of length 1, it is used as a key in
  2834. `org-agenda-custom-commands' and triggers this command. If it is a
  2835. longer string it is used as a tags/todo match string.
  2836. Parameters are alternating variable names and values that will be bound
  2837. before running the agenda command."
  2838. (org-eval-in-environment (org-make-parameter-alist parameters)
  2839. (let (org-agenda-sticky)
  2840. (if (> (length cmd-key) 2)
  2841. (org-tags-view nil cmd-key)
  2842. (org-agenda nil cmd-key))))
  2843. (set-buffer org-agenda-buffer-name)
  2844. (princ (buffer-string)))
  2845. (defvar org-agenda-info nil)
  2846. ;;;###autoload
  2847. (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
  2848. "Run an agenda command in batch mode and send the result to STDOUT.
  2849. If CMD-KEY is a string of length 1, it is used as a key in
  2850. `org-agenda-custom-commands' and triggers this command. If it is a
  2851. longer string it is used as a tags/todo match string.
  2852. Parameters are alternating variable names and values that will be bound
  2853. before running the agenda command.
  2854. The output gives a line for each selected agenda item. Each
  2855. item is a list of comma-separated values, like this:
  2856. category,head,type,todo,tags,date,time,extra,priority-l,priority-n
  2857. category The category of the item
  2858. head The headline, without TODO kwd, TAGS and PRIORITY
  2859. type The type of the agenda entry, can be
  2860. todo selected in TODO match
  2861. tagsmatch selected in tags match
  2862. diary imported from diary
  2863. deadline a deadline on given date
  2864. scheduled scheduled on given date
  2865. timestamp entry has timestamp on given date
  2866. closed entry was closed on given date
  2867. upcoming-deadline warning about deadline
  2868. past-scheduled forwarded scheduled item
  2869. block entry has date block including g. date
  2870. todo The todo keyword, if any
  2871. tags All tags including inherited ones, separated by colons
  2872. date The relevant date, like 2007-2-14
  2873. time The time, like 15:00-16:50
  2874. extra Sting with extra planning info
  2875. priority-l The priority letter if any was given
  2876. priority-n The computed numerical priority
  2877. agenda-day The day in the agenda where this is listed"
  2878. (org-eval-in-environment (append '((org-agenda-remove-tags t))
  2879. (org-make-parameter-alist parameters))
  2880. (if (> (length cmd-key) 2)
  2881. (org-tags-view nil cmd-key)
  2882. (org-agenda nil cmd-key)))
  2883. (set-buffer org-agenda-buffer-name)
  2884. (let* ((lines (org-split-string (buffer-string) "\n"))
  2885. line)
  2886. (while (setq line (pop lines))
  2887. (catch 'next
  2888. (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
  2889. (setq org-agenda-info
  2890. (org-fix-agenda-info (text-properties-at 0 line)))
  2891. (princ
  2892. (mapconcat 'org-agenda-export-csv-mapper
  2893. '(org-category txt type todo tags date time extra
  2894. priority-letter priority agenda-day)
  2895. ","))
  2896. (princ "\n")))))
  2897. (defun org-fix-agenda-info (props)
  2898. "Make sure all properties on an agenda item have a canonical form.
  2899. This ensures the export commands can easily use it."
  2900. (let (tmp re)
  2901. (when (setq tmp (plist-get props 'tags))
  2902. (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
  2903. (when (setq tmp (plist-get props 'date))
  2904. (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2905. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2906. '((format "%4d, %9s %2s, %4s" dayname monthname day year))
  2907. (setq tmp (calendar-date-string tmp)))
  2908. (setq props (plist-put props 'date tmp)))
  2909. (when (setq tmp (plist-get props 'day))
  2910. (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2911. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2912. (setq tmp (calendar-date-string tmp)))
  2913. (setq props (plist-put props 'day tmp))
  2914. (setq props (plist-put props 'agenda-day tmp)))
  2915. (when (setq tmp (plist-get props 'txt))
  2916. (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
  2917. (plist-put props 'priority-letter (match-string 1 tmp))
  2918. (setq tmp (replace-match "" t t tmp)))
  2919. (when (and (setq re (plist-get props 'org-todo-regexp))
  2920. (setq re (concat "\\`\\.*" re " ?"))
  2921. (string-match re tmp))
  2922. (plist-put props 'todo (match-string 1 tmp))
  2923. (setq tmp (replace-match "" t t tmp)))
  2924. (plist-put props 'txt tmp)))
  2925. props)
  2926. (defun org-agenda-export-csv-mapper (prop)
  2927. (let ((res (plist-get org-agenda-info prop)))
  2928. (setq res
  2929. (cond
  2930. ((not res) "")
  2931. ((stringp res) res)
  2932. (t (prin1-to-string res))))
  2933. (while (string-match "," res)
  2934. (setq res (replace-match ";" t t res)))
  2935. (org-trim res)))
  2936. ;;;###autoload
  2937. (defun org-store-agenda-views (&rest parameters)
  2938. "Store agenda views."
  2939. (interactive)
  2940. (eval (list 'org-batch-store-agenda-views)))
  2941. ;;;###autoload
  2942. (defmacro org-batch-store-agenda-views (&rest parameters)
  2943. "Run all custom agenda commands that have a file argument."
  2944. (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
  2945. (pop-up-frames nil)
  2946. (dir default-directory)
  2947. (pars (org-make-parameter-alist parameters))
  2948. cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
  2949. (save-window-excursion
  2950. (while cmds
  2951. (setq cmd (pop cmds)
  2952. thiscmdkey (car cmd)
  2953. thiscmdcmd (cdr cmd)
  2954. match (nth 2 thiscmdcmd)
  2955. bufname (if org-agenda-sticky
  2956. (or (and (stringp match)
  2957. (format "*Org Agenda(%s:%s)*" thiscmdkey match))
  2958. (format "*Org Agenda(%s)*" thiscmdkey))
  2959. org-agenda-buffer-name)
  2960. cmd-or-set (nth 2 cmd)
  2961. opts (nth (if (listp cmd-or-set) 3 4) cmd)
  2962. files (nth (if (listp cmd-or-set) 4 5) cmd))
  2963. (if (stringp files) (setq files (list files)))
  2964. (when files
  2965. (org-eval-in-environment (append org-agenda-exporter-settings
  2966. opts pars)
  2967. (org-agenda nil thiscmdkey))
  2968. (set-buffer bufname)
  2969. (while files
  2970. (org-eval-in-environment (append org-agenda-exporter-settings
  2971. opts pars)
  2972. (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
  2973. (and (get-buffer bufname)
  2974. (kill-buffer bufname)))))))
  2975. (defvar org-agenda-current-span nil
  2976. "The current span used in the agenda view.") ; local variable in the agenda buffer
  2977. (defun org-agenda-mark-header-line (pos)
  2978. "Mark the line at POS as an agenda structure header."
  2979. (save-excursion
  2980. (goto-char pos)
  2981. (put-text-property (point-at-bol) (point-at-eol)
  2982. 'org-agenda-structural-header t)
  2983. (when org-agenda-title-append
  2984. (put-text-property (point-at-bol) (point-at-eol)
  2985. 'org-agenda-title-append org-agenda-title-append))))
  2986. (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
  2987. (defvar org-agenda-write-buffer-name "Agenda View")
  2988. (defun org-agenda-write (file &optional open nosettings agenda-bufname)
  2989. "Write the current buffer (an agenda view) as a file.
  2990. Depending on the extension of the file name, plain text (.txt),
  2991. HTML (.html or .htm), PDF (.pdf) or Postscript (.ps) is produced.
  2992. If the extension is .ics, run icalendar export over all files used
  2993. to construct the agenda and limit the export to entries listed in the
  2994. agenda now.
  2995. If the extension is .org, collect all subtrees corresponding to the
  2996. agenda entries and add them in an .org file.
  2997. With prefix argument OPEN, open the new file immediately.
  2998. If NOSETTINGS is given, do not scope the settings of
  2999. `org-agenda-exporter-settings' into the export commands. This is used when
  3000. the settings have already been scoped and we do not wish to overrule other,
  3001. higher priority settings.
  3002. If AGENDA-BUFFER-NAME, use this as the buffer name for the agenda to write."
  3003. (interactive "FWrite agenda to file: \nP")
  3004. (if (or (not (file-writable-p file))
  3005. (and (file-exists-p file)
  3006. (if (org-called-interactively-p 'any)
  3007. (not (y-or-n-p (format "Overwrite existing file %s? " file))))))
  3008. (user-error "Cannot write agenda to file %s" file))
  3009. (org-let (if nosettings nil org-agenda-exporter-settings)
  3010. '(save-excursion
  3011. (save-window-excursion
  3012. (org-agenda-mark-filtered-text)
  3013. (let ((bs (copy-sequence (buffer-string))) beg content)
  3014. (org-agenda-unmark-filtered-text)
  3015. (with-temp-buffer
  3016. (rename-buffer org-agenda-write-buffer-name t)
  3017. (set-buffer-modified-p nil)
  3018. (insert bs)
  3019. (org-agenda-remove-marked-text 'org-filtered)
  3020. (while (setq beg (text-property-any (point-min) (point-max)
  3021. 'org-filtered t))
  3022. (delete-region
  3023. beg (or (next-single-property-change beg 'org-filtered)
  3024. (point-max))))
  3025. (run-hooks 'org-agenda-before-write-hook)
  3026. (cond
  3027. ((org-bound-and-true-p org-mobile-creating-agendas)
  3028. (org-mobile-write-agenda-for-mobile file))
  3029. ((string-match "\\.org\\'" file)
  3030. (let (content p m message-log-max)
  3031. (goto-char (point-min))
  3032. (while (setq p (next-single-property-change (point) 'org-hd-marker nil))
  3033. (goto-char p)
  3034. (setq m (get-text-property (point) 'org-hd-marker))
  3035. (when m
  3036. (push (save-excursion
  3037. (set-buffer (marker-buffer m))
  3038. (goto-char m)
  3039. (org-copy-subtree 1 nil t t)
  3040. org-subtree-clip)
  3041. content)))
  3042. (find-file file)
  3043. (erase-buffer)
  3044. (mapcar (lambda (s) (org-paste-subtree 1 s)) (reverse content))
  3045. (write-file file)
  3046. (kill-buffer (current-buffer))
  3047. (message "Org file written to %s" file)))
  3048. ((string-match "\\.html?\\'" file)
  3049. (require 'htmlize)
  3050. (set-buffer (htmlize-buffer (current-buffer)))
  3051. (when org-agenda-export-html-style
  3052. ;; replace <style> section with org-agenda-export-html-style
  3053. (goto-char (point-min))
  3054. (kill-region (- (search-forward "<style") 6)
  3055. (search-forward "</style>"))
  3056. (insert org-agenda-export-html-style))
  3057. (write-file file)
  3058. (kill-buffer (current-buffer))
  3059. (message "HTML written to %s" file))
  3060. ((string-match "\\.ps\\'" file)
  3061. (require 'ps-print)
  3062. (ps-print-buffer-with-faces file)
  3063. (message "Postscript written to %s" file))
  3064. ((string-match "\\.pdf\\'" file)
  3065. (require 'ps-print)
  3066. (ps-print-buffer-with-faces
  3067. (concat (file-name-sans-extension file) ".ps"))
  3068. (call-process "ps2pdf" nil nil nil
  3069. (expand-file-name
  3070. (concat (file-name-sans-extension file) ".ps"))
  3071. (expand-file-name file))
  3072. (delete-file (concat (file-name-sans-extension file) ".ps"))
  3073. (message "PDF written to %s" file))
  3074. ((string-match "\\.ics\\'" file)
  3075. (require 'ox-icalendar)
  3076. (org-icalendar-export-current-agenda (expand-file-name file)))
  3077. (t
  3078. (let ((bs (buffer-string)))
  3079. (find-file file)
  3080. (erase-buffer)
  3081. (insert bs)
  3082. (save-buffer 0)
  3083. (kill-buffer (current-buffer))
  3084. (message "Plain text written to %s" file))))))))
  3085. (set-buffer (or agenda-bufname
  3086. (and (org-called-interactively-p 'any) (buffer-name))
  3087. org-agenda-buffer-name)))
  3088. (when open (org-open-file file)))
  3089. (defvar org-agenda-tag-filter-overlays nil)
  3090. (defvar org-agenda-cat-filter-overlays nil)
  3091. (defvar org-agenda-re-filter-overlays nil)
  3092. (defun org-agenda-mark-filtered-text ()
  3093. "Mark all text hidden by filtering with a text property."
  3094. (let ((inhibit-read-only t))
  3095. (mapc
  3096. (lambda (o)
  3097. (when (equal (overlay-buffer o) (current-buffer))
  3098. (put-text-property
  3099. (overlay-start o) (overlay-end o)
  3100. 'org-filtered t)))
  3101. (append org-agenda-tag-filter-overlays
  3102. org-agenda-cat-filter-overlays
  3103. org-agenda-re-filter-overlays))))
  3104. (defun org-agenda-unmark-filtered-text ()
  3105. "Remove the filtering text property."
  3106. (let ((inhibit-read-only t))
  3107. (remove-text-properties (point-min) (point-max) '(org-filtered t))))
  3108. (defun org-agenda-remove-marked-text (property &optional value)
  3109. "Delete all text marked with VALUE of PROPERTY.
  3110. VALUE defaults to t."
  3111. (let (beg)
  3112. (setq value (or value t))
  3113. (while (setq beg (text-property-any (point-min) (point-max)
  3114. property value))
  3115. (delete-region
  3116. beg (or (next-single-property-change beg 'org-filtered)
  3117. (point-max))))))
  3118. (defun org-agenda-add-entry-text ()
  3119. "Add entry text to agenda lines.
  3120. This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
  3121. entry text following headings shown in the agenda.
  3122. Drawers will be excluded, also the line with scheduling/deadline info."
  3123. (when (and (> org-agenda-add-entry-text-maxlines 0)
  3124. (not (org-bound-and-true-p org-mobile-creating-agendas)))
  3125. (let (m txt)
  3126. (goto-char (point-min))
  3127. (while (not (eobp))
  3128. (if (not (setq m (org-get-at-bol 'org-hd-marker)))
  3129. (beginning-of-line 2)
  3130. (setq txt (org-agenda-get-some-entry-text
  3131. m org-agenda-add-entry-text-maxlines " > "))
  3132. (end-of-line 1)
  3133. (if (string-match "\\S-" txt)
  3134. (insert "\n" txt)
  3135. (or (eobp) (forward-char 1))))))))
  3136. (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
  3137. &rest keep)
  3138. "Extract entry text from MARKER, at most N-LINES lines.
  3139. This will ignore drawers etc, just get the text.
  3140. If INDENT is given, prefix every line with this string. If KEEP is
  3141. given, it is a list of symbols, defining stuff that should not be
  3142. removed from the entry content. Currently only `planning' is allowed here."
  3143. (let (txt drawer-re kwd-time-re ind)
  3144. (save-excursion
  3145. (with-current-buffer (marker-buffer marker)
  3146. (if (not (derived-mode-p 'org-mode))
  3147. (setq txt "")
  3148. (save-excursion
  3149. (save-restriction
  3150. (widen)
  3151. (goto-char marker)
  3152. (end-of-line 1)
  3153. (setq txt (buffer-substring
  3154. (min (1+ (point)) (point-max))
  3155. (progn (outline-next-heading) (point)))
  3156. drawer-re org-drawer-regexp
  3157. kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
  3158. ".*\n?"))
  3159. (with-temp-buffer
  3160. (insert txt)
  3161. (when org-agenda-add-entry-text-descriptive-links
  3162. (goto-char (point-min))
  3163. (while (org-activate-bracket-links (point-max))
  3164. (add-text-properties (match-beginning 0) (match-end 0)
  3165. '(face org-link))))
  3166. (goto-char (point-min))
  3167. (while (re-search-forward org-bracket-link-regexp (point-max) t)
  3168. (set-text-properties (match-beginning 0) (match-end 0)
  3169. nil))
  3170. (goto-char (point-min))
  3171. (while (re-search-forward drawer-re nil t)
  3172. (delete-region
  3173. (match-beginning 0)
  3174. (progn (re-search-forward
  3175. "^[ \t]*:END:.*\n?" nil 'move)
  3176. (point))))
  3177. (unless (member 'planning keep)
  3178. (goto-char (point-min))
  3179. (while (re-search-forward kwd-time-re nil t)
  3180. (replace-match "")))
  3181. (goto-char (point-min))
  3182. (when org-agenda-entry-text-exclude-regexps
  3183. (let ((re-list org-agenda-entry-text-exclude-regexps) re)
  3184. (while (setq re (pop re-list))
  3185. (goto-char (point-min))
  3186. (while (re-search-forward re nil t)
  3187. (replace-match "")))))
  3188. (goto-char (point-max))
  3189. (skip-chars-backward " \t\n")
  3190. (if (looking-at "[ \t\n]+\\'") (replace-match ""))
  3191. ;; find and remove min common indentation
  3192. (goto-char (point-min))
  3193. (untabify (point-min) (point-max))
  3194. (setq ind (org-get-indentation))
  3195. (while (not (eobp))
  3196. (unless (looking-at "[ \t]*$")
  3197. (setq ind (min ind (org-get-indentation))))
  3198. (beginning-of-line 2))
  3199. (goto-char (point-min))
  3200. (while (not (eobp))
  3201. (unless (looking-at "[ \t]*$")
  3202. (move-to-column ind)
  3203. (delete-region (point-at-bol) (point)))
  3204. (beginning-of-line 2))
  3205. (run-hooks 'org-agenda-entry-text-cleanup-hook)
  3206. (goto-char (point-min))
  3207. (when indent
  3208. (while (and (not (eobp)) (re-search-forward "^" nil t))
  3209. (replace-match indent t t)))
  3210. (goto-char (point-min))
  3211. (while (looking-at "[ \t]*\n") (replace-match ""))
  3212. (goto-char (point-max))
  3213. (when (> (org-current-line)
  3214. n-lines)
  3215. (org-goto-line (1+ n-lines))
  3216. (backward-char 1))
  3217. (setq txt (buffer-substring (point-min) (point)))))))))
  3218. txt))
  3219. (defun org-check-for-org-mode ()
  3220. "Make sure current buffer is in org-mode. Error if not."
  3221. (or (derived-mode-p 'org-mode)
  3222. (error "Cannot execute org-mode agenda command on buffer in %s"
  3223. major-mode)))
  3224. ;;; Agenda prepare and finalize
  3225. (defvar org-agenda-multi nil) ; dynamically scoped
  3226. (defvar org-agenda-pre-window-conf nil)
  3227. (defvar org-agenda-columns-active nil)
  3228. (defvar org-agenda-name nil)
  3229. (defvar org-agenda-tag-filter nil)
  3230. (defvar org-agenda-category-filter nil)
  3231. (defvar org-agenda-regexp-filter nil)
  3232. (defvar org-agenda-top-headline-filter nil)
  3233. (defvar org-agenda-tag-filter-while-redo nil)
  3234. (defvar org-agenda-tag-filter-preset nil
  3235. "A preset of the tags filter used for secondary agenda filtering.
  3236. This must be a list of strings, each string must be a single tag preceded
  3237. by \"+\" or \"-\".
  3238. This variable should not be set directly, but agenda custom commands can
  3239. bind it in the options section. The preset filter is a global property of
  3240. the entire agenda view. In a block agenda, it will not work reliably to
  3241. define a filter for one of the individual blocks. You need to set it in
  3242. the global options and expect it to be applied to the entire view.")
  3243. (defvar org-agenda-category-filter-preset nil
  3244. "A preset of the category filter used for secondary agenda filtering.
  3245. This must be a list of strings, each string must be a single category
  3246. preceded by \"+\" or \"-\".
  3247. This variable should not be set directly, but agenda custom commands can
  3248. bind it in the options section. The preset filter is a global property of
  3249. the entire agenda view. In a block agenda, it will not work reliably to
  3250. define a filter for one of the individual blocks. You need to set it in
  3251. the global options and expect it to be applied to the entire view.")
  3252. (defvar org-agenda-regexp-filter-preset nil
  3253. "A preset of the regexp filter used for secondary agenda filtering.
  3254. This must be a list of strings, each string must be a single regexp
  3255. preceded by \"+\" or \"-\".
  3256. This variable should not be set directly, but agenda custom commands can
  3257. bind it in the options section. The preset filter is a global property of
  3258. the entire agenda view. In a block agenda, it will not work reliably to
  3259. define a filter for one of the individual blocks. You need to set it in
  3260. the global options and expect it to be applied to the entire view.")
  3261. (defun org-agenda-use-sticky-p ()
  3262. "Return non-nil if an agenda buffer named
  3263. `org-agenda-buffer-name' exists and should be shown instead of
  3264. generating a new one."
  3265. (and
  3266. ;; turned off by user
  3267. org-agenda-sticky
  3268. ;; For multi-agenda buffer already exists
  3269. (not org-agenda-multi)
  3270. ;; buffer found
  3271. (get-buffer org-agenda-buffer-name)
  3272. ;; C-u parameter is same as last call
  3273. (with-current-buffer (get-buffer org-agenda-buffer-name)
  3274. (and
  3275. (equal current-prefix-arg
  3276. org-agenda-last-prefix-arg)
  3277. ;; In case user turned stickiness on, while having existing
  3278. ;; Agenda buffer active, don't reuse that buffer, because it
  3279. ;; does not have org variables local
  3280. org-agenda-this-buffer-is-sticky))))
  3281. (defun org-agenda-prepare-window (abuf)
  3282. "Setup agenda buffer in the window."
  3283. (let* ((awin (get-buffer-window abuf))
  3284. wconf)
  3285. (cond
  3286. ((equal (current-buffer) abuf) nil)
  3287. (awin (select-window awin))
  3288. ((not (setq wconf (current-window-configuration))))
  3289. ((equal org-agenda-window-setup 'current-window)
  3290. (org-pop-to-buffer-same-window abuf))
  3291. ((equal org-agenda-window-setup 'other-window)
  3292. (org-switch-to-buffer-other-window abuf))
  3293. ((equal org-agenda-window-setup 'other-frame)
  3294. (switch-to-buffer-other-frame abuf))
  3295. ((equal org-agenda-window-setup 'reorganize-frame)
  3296. (delete-other-windows)
  3297. (org-switch-to-buffer-other-window abuf)))
  3298. ;; additional test in case agenda is invoked from within agenda
  3299. ;; buffer via elisp link
  3300. (unless (equal (current-buffer) abuf)
  3301. (org-pop-to-buffer-same-window abuf))
  3302. (setq org-agenda-pre-window-conf
  3303. (or org-agenda-pre-window-conf wconf))))
  3304. (defun org-agenda-prepare (&optional name)
  3305. (if (org-agenda-use-sticky-p)
  3306. (progn
  3307. ;; Popup existing buffer
  3308. (org-agenda-prepare-window (get-buffer org-agenda-buffer-name))
  3309. (message "Sticky Agenda buffer, use `r' to refresh")
  3310. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3311. (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
  3312. (setq org-todo-keywords-for-agenda nil)
  3313. (unless org-agenda-persistent-filter
  3314. (setq org-agenda-tag-filter nil
  3315. org-agenda-category-filter nil
  3316. org-agenda-regexp-filter nil))
  3317. (put 'org-agenda-tag-filter :preset-filter
  3318. org-agenda-tag-filter-preset)
  3319. (put 'org-agenda-category-filter :preset-filter
  3320. org-agenda-category-filter-preset)
  3321. (put 'org-agenda-regexp-filter :preset-filter
  3322. org-agenda-regexp-filter-preset)
  3323. (if org-agenda-multi
  3324. (progn
  3325. (setq buffer-read-only nil)
  3326. (goto-char (point-max))
  3327. (unless (or (bobp) org-agenda-compact-blocks
  3328. (not org-agenda-block-separator))
  3329. (insert "\n"
  3330. (if (stringp org-agenda-block-separator)
  3331. org-agenda-block-separator
  3332. (make-string (window-width) org-agenda-block-separator))
  3333. "\n"))
  3334. (narrow-to-region (point) (point-max)))
  3335. (setq org-done-keywords-for-agenda nil)
  3336. ;; Setting any org variables that are in org-agenda-local-vars
  3337. ;; list need to be done after the prepare call
  3338. (org-agenda-prepare-window (get-buffer-create org-agenda-buffer-name))
  3339. (setq buffer-read-only nil)
  3340. (org-agenda-reset-markers)
  3341. (let ((inhibit-read-only t)) (erase-buffer))
  3342. (org-agenda-mode)
  3343. (setq org-agenda-buffer (current-buffer))
  3344. (setq org-agenda-contributing-files nil)
  3345. (setq org-agenda-columns-active nil)
  3346. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  3347. (setq org-todo-keywords-for-agenda
  3348. (org-uniquify org-todo-keywords-for-agenda))
  3349. (setq org-done-keywords-for-agenda
  3350. (org-uniquify org-done-keywords-for-agenda))
  3351. (setq org-agenda-last-prefix-arg current-prefix-arg)
  3352. (setq org-agenda-this-buffer-name org-agenda-buffer-name)
  3353. (and name (not org-agenda-name)
  3354. (org-set-local 'org-agenda-name name)))
  3355. (setq buffer-read-only nil)))
  3356. (defvar org-agenda-overriding-columns-format) ; From org-colview.el
  3357. (defun org-agenda-finalize ()
  3358. "Finishing touch for the agenda buffer, called just before displaying it."
  3359. (unless org-agenda-multi
  3360. (save-excursion
  3361. (let ((inhibit-read-only t))
  3362. (goto-char (point-min))
  3363. (save-excursion
  3364. (while (org-activate-bracket-links (point-max))
  3365. (add-text-properties (match-beginning 0) (match-end 0)
  3366. '(face org-link))))
  3367. (save-excursion
  3368. (while (org-activate-plain-links (point-max))
  3369. (add-text-properties (match-beginning 0) (match-end 0)
  3370. '(face org-link))))
  3371. (unless (eq org-agenda-remove-tags t)
  3372. (org-agenda-align-tags))
  3373. (unless org-agenda-with-colors
  3374. (remove-text-properties (point-min) (point-max) '(face nil)))
  3375. (if (and (boundp 'org-agenda-overriding-columns-format)
  3376. org-agenda-overriding-columns-format)
  3377. (org-set-local 'org-agenda-overriding-columns-format
  3378. org-agenda-overriding-columns-format))
  3379. (if (and (boundp 'org-agenda-view-columns-initially)
  3380. org-agenda-view-columns-initially)
  3381. (org-agenda-columns))
  3382. (when org-agenda-fontify-priorities
  3383. (org-agenda-fontify-priorities))
  3384. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  3385. (org-agenda-dim-blocked-tasks))
  3386. (org-agenda-mark-clocking-task)
  3387. (when org-agenda-entry-text-mode
  3388. (org-agenda-entry-text-hide)
  3389. (org-agenda-entry-text-show))
  3390. (if (and (functionp 'org-habit-insert-consistency-graphs)
  3391. (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
  3392. (org-habit-insert-consistency-graphs))
  3393. (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
  3394. (unless (or (eq org-agenda-show-inherited-tags 'always)
  3395. (and (listp org-agenda-show-inherited-tags)
  3396. (memq org-agenda-type org-agenda-show-inherited-tags))
  3397. (and (eq org-agenda-show-inherited-tags t)
  3398. (or (eq org-agenda-use-tag-inheritance t)
  3399. (and (listp org-agenda-use-tag-inheritance)
  3400. (not (memq org-agenda-type
  3401. org-agenda-use-tag-inheritance))))))
  3402. (let (mrk)
  3403. (save-excursion
  3404. (goto-char (point-min))
  3405. (while (equal (forward-line) 0)
  3406. (when (setq mrk (or (get-text-property (point) 'org-hd-marker)
  3407. (get-text-property (point) 'org-hd-marker)))
  3408. (put-text-property (point-at-bol) (point-at-eol)
  3409. 'tags (org-with-point-at mrk
  3410. (delete-dups
  3411. (mapcar 'downcase (org-get-tags-at))))))))))
  3412. (run-hooks 'org-agenda-finalize-hook)
  3413. (when (or org-agenda-tag-filter (get 'org-agenda-tag-filter :preset-filter))
  3414. (org-agenda-filter-apply org-agenda-tag-filter 'tag))
  3415. (when (or org-agenda-category-filter (get 'org-agenda-category-filter :preset-filter))
  3416. (org-agenda-filter-apply org-agenda-category-filter 'category))
  3417. (when (or org-agenda-regexp-filter (get 'org-agenda-regexp-filter :preset-filter))
  3418. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
  3419. (org-add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)))))
  3420. (defun org-agenda-mark-clocking-task ()
  3421. "Mark the current clock entry in the agenda if it is present."
  3422. ;; We need to widen when `org-agenda-finalize' is called from
  3423. ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in')
  3424. (when org-clock-current-task
  3425. (save-restriction
  3426. (widen)
  3427. (org-agenda-unmark-clocking-task)
  3428. (when (marker-buffer org-clock-hd-marker)
  3429. (save-excursion
  3430. (goto-char (point-min))
  3431. (let (s ov)
  3432. (while (setq s (next-single-property-change (point) 'org-hd-marker))
  3433. (goto-char s)
  3434. (when (equal (org-get-at-bol 'org-hd-marker)
  3435. org-clock-hd-marker)
  3436. (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
  3437. (overlay-put ov 'type 'org-agenda-clocking)
  3438. (overlay-put ov 'face 'org-agenda-clocking)
  3439. (overlay-put ov 'help-echo
  3440. "The clock is running in this item")))))))))
  3441. (defun org-agenda-unmark-clocking-task ()
  3442. "Unmark the current clocking task."
  3443. (mapc (lambda (o)
  3444. (if (eq (overlay-get o 'type) 'org-agenda-clocking)
  3445. (delete-overlay o)))
  3446. (overlays-in (point-min) (point-max))))
  3447. (defun org-agenda-fontify-priorities ()
  3448. "Make highest priority lines bold, and lowest italic."
  3449. (interactive)
  3450. (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
  3451. (delete-overlay o)))
  3452. (overlays-in (point-min) (point-max)))
  3453. (save-excursion
  3454. (let (b e p ov h l)
  3455. (goto-char (point-min))
  3456. (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
  3457. (setq h (or (get-char-property (point) 'org-highest-priority)
  3458. org-highest-priority)
  3459. l (or (get-char-property (point) 'org-lowest-priority)
  3460. org-lowest-priority)
  3461. p (string-to-char (match-string 1))
  3462. b (match-beginning 0)
  3463. e (if (eq org-agenda-fontify-priorities 'cookies)
  3464. (match-end 0)
  3465. (point-at-eol))
  3466. ov (make-overlay b e))
  3467. (overlay-put
  3468. ov 'face
  3469. (cons (cond ((org-face-from-face-or-color
  3470. 'priority nil
  3471. (cdr (assoc p org-priority-faces))))
  3472. ((and (listp org-agenda-fontify-priorities)
  3473. (org-face-from-face-or-color
  3474. 'priority nil
  3475. (cdr (assoc p org-agenda-fontify-priorities)))))
  3476. ((equal p l) 'italic)
  3477. ((equal p h) 'bold))
  3478. 'org-priority))
  3479. (overlay-put ov 'org-type 'org-priority)))))
  3480. (defvar org-depend-tag-blocked)
  3481. (defun org-agenda-dim-blocked-tasks (&optional invisible)
  3482. "Dim currently blocked TODO's in the agenda display.
  3483. When INVISIBLE is non-nil, hide currently blocked TODO instead of
  3484. dimming them."
  3485. (interactive "P")
  3486. (when (org-called-interactively-p 'interactive)
  3487. (message "Dim or hide blocked tasks..."))
  3488. (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-blocked-todo)
  3489. (delete-overlay o)))
  3490. (overlays-in (point-min) (point-max)))
  3491. (save-excursion
  3492. (let ((inhibit-read-only t)
  3493. (org-depend-tag-blocked nil)
  3494. (invis (or (not (null invisible))
  3495. (eq org-agenda-dim-blocked-tasks 'invisible)))
  3496. org-blocked-by-checkboxes
  3497. invis1 b e p ov h l)
  3498. (goto-char (point-min))
  3499. (while (let ((pos (next-single-property-change (point) 'todo-state)))
  3500. (and pos (goto-char (1+ pos))))
  3501. (setq org-blocked-by-checkboxes nil invis1 invis)
  3502. (let ((marker (org-get-at-bol 'org-hd-marker)))
  3503. (when (and marker
  3504. (with-current-buffer (marker-buffer marker)
  3505. (save-excursion (goto-char marker)
  3506. (org-entry-blocked-p))))
  3507. (if org-blocked-by-checkboxes (setq invis1 nil))
  3508. (setq b (if invis1
  3509. (max (point-min) (1- (point-at-bol)))
  3510. (point-at-bol))
  3511. e (point-at-eol)
  3512. ov (make-overlay b e))
  3513. (if invis1
  3514. (overlay-put ov 'invisible t)
  3515. (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
  3516. (overlay-put ov 'org-type 'org-blocked-todo))))))
  3517. (when (org-called-interactively-p 'interactive)
  3518. (message "Dim or hide blocked tasks...done")))
  3519. (defvar org-agenda-skip-function nil
  3520. "Function to be called at each match during agenda construction.
  3521. If this function returns nil, the current match should not be skipped.
  3522. Otherwise, the function must return a position from where the search
  3523. should be continued.
  3524. This may also be a Lisp form, it will be evaluated.
  3525. Never set this variable using `setq' or so, because then it will apply
  3526. to all future agenda commands. If you do want a global skipping condition,
  3527. use the option `org-agenda-skip-function-global' instead.
  3528. The correct usage for `org-agenda-skip-function' is to bind it with
  3529. `let' to scope it dynamically into the agenda-constructing command.
  3530. A good way to set it is through options in `org-agenda-custom-commands'.")
  3531. (defun org-agenda-skip ()
  3532. "Throw to `:skip' in places that should be skipped.
  3533. Also moves point to the end of the skipped region, so that search can
  3534. continue from there."
  3535. (let ((p (point-at-bol)) to)
  3536. (when (or
  3537. (save-excursion (goto-char p) (looking-at comment-start-skip))
  3538. (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
  3539. (get-text-property p :org-archived)
  3540. (org-end-of-subtree t))
  3541. (and org-agenda-skip-comment-trees
  3542. (get-text-property p :org-comment)
  3543. (org-end-of-subtree t))
  3544. (and (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
  3545. (org-agenda-skip-eval org-agenda-skip-function)))
  3546. (goto-char to))
  3547. (org-in-src-block-p t))
  3548. (throw :skip t))))
  3549. (defun org-agenda-skip-eval (form)
  3550. "If FORM is a function or a list, call (or eval) it and return the result.
  3551. `save-excursion' and `save-match-data' are wrapped around the call, so point
  3552. and match data are returned to the previous state no matter what these
  3553. functions do."
  3554. (let (fp)
  3555. (and form
  3556. (or (setq fp (functionp form))
  3557. (consp form))
  3558. (save-excursion
  3559. (save-match-data
  3560. (if fp
  3561. (funcall form)
  3562. (eval form)))))))
  3563. (defvar org-agenda-markers nil
  3564. "List of all currently active markers created by `org-agenda'.")
  3565. (defvar org-agenda-last-marker-time (org-float-time)
  3566. "Creation time of the last agenda marker.")
  3567. (defun org-agenda-new-marker (&optional pos)
  3568. "Return a new agenda marker.
  3569. Org-mode keeps a list of these markers and resets them when they are
  3570. no longer in use."
  3571. (let ((m (copy-marker (or pos (point)))))
  3572. (setq org-agenda-last-marker-time (org-float-time))
  3573. (if org-agenda-buffer
  3574. (with-current-buffer org-agenda-buffer
  3575. (push m org-agenda-markers))
  3576. (push m org-agenda-markers))
  3577. m))
  3578. (defun org-agenda-reset-markers ()
  3579. "Reset markers created by `org-agenda'."
  3580. (while org-agenda-markers
  3581. (move-marker (pop org-agenda-markers) nil)))
  3582. (defun org-agenda-save-markers-for-cut-and-paste (beg end)
  3583. "Save relative positions of markers in region.
  3584. This check for agenda markers in all agenda buffers currently active."
  3585. (dolist (buf (buffer-list))
  3586. (with-current-buffer buf
  3587. (when (eq major-mode 'org-agenda-mode)
  3588. (mapc (lambda (m) (org-check-and-save-marker m beg end))
  3589. org-agenda-markers)))))
  3590. ;;; Entry text mode
  3591. (defun org-agenda-entry-text-show-here ()
  3592. "Add some text from the entry as context to the current line."
  3593. (let (m txt o)
  3594. (setq m (org-get-at-bol 'org-hd-marker))
  3595. (unless (marker-buffer m)
  3596. (error "No marker points to an entry here"))
  3597. (setq txt (concat "\n" (org-no-properties
  3598. (org-agenda-get-some-entry-text
  3599. m org-agenda-entry-text-maxlines
  3600. org-agenda-entry-text-leaders))))
  3601. (when (string-match "\\S-" txt)
  3602. (setq o (make-overlay (point-at-bol) (point-at-eol)))
  3603. (overlay-put o 'evaporate t)
  3604. (overlay-put o 'org-overlay-type 'agenda-entry-content)
  3605. (overlay-put o 'after-string txt))))
  3606. (defun org-agenda-entry-text-show ()
  3607. "Add entry context for all agenda lines."
  3608. (interactive)
  3609. (save-excursion
  3610. (goto-char (point-max))
  3611. (beginning-of-line 1)
  3612. (while (not (bobp))
  3613. (when (org-get-at-bol 'org-hd-marker)
  3614. (org-agenda-entry-text-show-here))
  3615. (beginning-of-line 0))))
  3616. (defun org-agenda-entry-text-hide ()
  3617. "Remove any shown entry context."
  3618. (delq nil
  3619. (mapcar (lambda (o)
  3620. (if (eq (overlay-get o 'org-overlay-type)
  3621. 'agenda-entry-content)
  3622. (progn (delete-overlay o) t)))
  3623. (overlays-in (point-min) (point-max)))))
  3624. (defun org-agenda-get-day-face (date)
  3625. "Return the face DATE should be displayed with."
  3626. (or (and (functionp org-agenda-day-face-function)
  3627. (funcall org-agenda-day-face-function date))
  3628. (cond ((org-agenda-todayp date)
  3629. 'org-agenda-date-today)
  3630. ((member (calendar-day-of-week date) org-agenda-weekend-days)
  3631. 'org-agenda-date-weekend)
  3632. (t 'org-agenda-date))))
  3633. ;;; Agenda timeline
  3634. (defvar org-agenda-only-exact-dates nil) ; dynamically scoped
  3635. (defvar org-agenda-show-log-scoped) ;; dynamically scope in `org-timeline' or `org-agenda-list'
  3636. (defun org-timeline (&optional dotodo)
  3637. "Show a time-sorted view of the entries in the current org file.
  3638. Only entries with a time stamp of today or later will be listed. With
  3639. \\[universal-argument] prefix, all unfinished TODO items will also be shown,
  3640. under the current date.
  3641. If the buffer contains an active region, only check the region for
  3642. dates."
  3643. (interactive "P")
  3644. (let* ((dopast t)
  3645. (org-agenda-show-log-scoped org-agenda-show-log)
  3646. (org-agenda-show-log org-agenda-show-log-scoped)
  3647. (entry (buffer-file-name (or (buffer-base-buffer (current-buffer))
  3648. (current-buffer))))
  3649. (date (calendar-current-date))
  3650. (beg (if (org-region-active-p) (region-beginning) (point-min)))
  3651. (end (if (org-region-active-p) (region-end) (point-max)))
  3652. (day-numbers (org-get-all-dates
  3653. beg end 'no-ranges
  3654. t org-agenda-show-log-scoped ; always include today
  3655. org-timeline-show-empty-dates))
  3656. (org-deadline-warning-days 0)
  3657. (org-agenda-only-exact-dates t)
  3658. (today (org-today))
  3659. (past t)
  3660. args
  3661. s e rtn d emptyp)
  3662. (setq org-agenda-redo-command
  3663. (list 'let
  3664. (list (list 'org-agenda-show-log 'org-agenda-show-log))
  3665. (list 'org-switch-to-buffer-other-window (current-buffer))
  3666. (list 'org-timeline (list 'quote dotodo))))
  3667. (put 'org-agenda-redo-command 'org-lprops nil)
  3668. (if (not dopast)
  3669. ;; Remove past dates from the list of dates.
  3670. (setq day-numbers (delq nil (mapcar (lambda(x)
  3671. (if (>= x today) x nil))
  3672. day-numbers))))
  3673. (org-agenda-prepare (concat "Timeline " (file-name-nondirectory entry)))
  3674. (org-compile-prefix-format 'timeline)
  3675. (org-set-sorting-strategy 'timeline)
  3676. (if org-agenda-show-log-scoped (push :closed args))
  3677. (push :timestamp args)
  3678. (push :deadline args)
  3679. (push :scheduled args)
  3680. (push :sexp args)
  3681. (if dotodo (push :todo args))
  3682. (insert "Timeline of file " entry "\n")
  3683. (add-text-properties (point-min) (point)
  3684. (list 'face 'org-agenda-structure))
  3685. (org-agenda-mark-header-line (point-min))
  3686. (while (setq d (pop day-numbers))
  3687. (if (and (listp d) (eq (car d) :omitted))
  3688. (progn
  3689. (setq s (point))
  3690. (insert (format "\n[... %d empty days omitted]\n\n" (cdr d)))
  3691. (put-text-property s (1- (point)) 'face 'org-agenda-structure))
  3692. (if (listp d) (setq d (car d) emptyp t) (setq emptyp nil))
  3693. (if (and (>= d today)
  3694. dopast
  3695. past)
  3696. (progn
  3697. (setq past nil)
  3698. (insert (make-string 79 ?-) "\n")))
  3699. (setq date (calendar-gregorian-from-absolute d))
  3700. (setq s (point))
  3701. (setq rtn (and (not emptyp)
  3702. (apply 'org-agenda-get-day-entries entry
  3703. date args)))
  3704. (if (or rtn (equal d today) org-timeline-show-empty-dates)
  3705. (progn
  3706. (insert
  3707. (if (stringp org-agenda-format-date)
  3708. (format-time-string org-agenda-format-date
  3709. (org-time-from-absolute date))
  3710. (funcall org-agenda-format-date date))
  3711. "\n")
  3712. (put-text-property s (1- (point)) 'face
  3713. (org-agenda-get-day-face date))
  3714. (put-text-property s (1- (point)) 'org-date-line t)
  3715. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3716. (if (equal d today)
  3717. (put-text-property s (1- (point)) 'org-today t))
  3718. (and rtn (insert (org-agenda-finalize-entries rtn 'timeline) "\n"))
  3719. (put-text-property s (1- (point)) 'day d)))))
  3720. (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
  3721. (point-min)))
  3722. (add-text-properties
  3723. (point-min) (point-max)
  3724. `(org-agenda-type timeline org-redo-cmd ,org-agenda-redo-command))
  3725. (org-agenda-finalize)
  3726. (setq buffer-read-only t)))
  3727. (defun org-get-all-dates (beg end &optional no-ranges force-today inactive empty pre-re)
  3728. "Return a list of all relevant day numbers from BEG to END buffer positions.
  3729. If NO-RANGES is non-nil, include only the start and end dates of a range,
  3730. not every single day in the range. If FORCE-TODAY is non-nil, make
  3731. sure that TODAY is included in the list. If INACTIVE is non-nil, also
  3732. inactive time stamps (those in square brackets) are included.
  3733. When EMPTY is non-nil, also include days without any entries."
  3734. (let ((re (concat
  3735. (if pre-re pre-re "")
  3736. (if inactive org-ts-regexp-both org-ts-regexp)))
  3737. dates dates1 date day day1 day2 ts1 ts2 pos)
  3738. (if force-today
  3739. (setq dates (list (org-today))))
  3740. (save-excursion
  3741. (goto-char beg)
  3742. (while (re-search-forward re end t)
  3743. (setq day (time-to-days (org-time-string-to-time
  3744. (substring (match-string 1) 0 10)
  3745. (current-buffer) (match-beginning 0))))
  3746. (or (memq day dates) (push day dates)))
  3747. (unless no-ranges
  3748. (goto-char beg)
  3749. (while (re-search-forward org-tr-regexp end t)
  3750. (setq pos (match-beginning 0))
  3751. (setq ts1 (substring (match-string 1) 0 10)
  3752. ts2 (substring (match-string 2) 0 10)
  3753. day1 (time-to-days (org-time-string-to-time
  3754. ts1 (current-buffer) pos))
  3755. day2 (time-to-days (org-time-string-to-time
  3756. ts2 (current-buffer) pos)))
  3757. (while (< (setq day1 (1+ day1)) day2)
  3758. (or (memq day1 dates) (push day1 dates)))))
  3759. (setq dates (sort dates '<))
  3760. (when empty
  3761. (while (setq day (pop dates))
  3762. (setq day2 (car dates))
  3763. (push day dates1)
  3764. (when (and day2 empty)
  3765. (if (or (eq empty t)
  3766. (and (numberp empty) (<= (- day2 day) empty)))
  3767. (while (< (setq day (1+ day)) day2)
  3768. (push (list day) dates1))
  3769. (push (cons :omitted (- day2 day)) dates1))))
  3770. (setq dates (nreverse dates1)))
  3771. dates)))
  3772. ;;; Agenda Daily/Weekly
  3773. (defvar org-agenda-start-day nil ; dynamically scoped parameter
  3774. "Start day for the agenda view.
  3775. Custom commands can set this variable in the options section.
  3776. This is usually a string like \"2007-11-01\", \"+2d\" or any other
  3777. input allowed when reading a date through the Org calendar.
  3778. See the docstring of `org-read-date' for details.")
  3779. (defvar org-starting-day nil) ; local variable in the agenda buffer
  3780. (defvar org-arg-loc nil) ; local variable
  3781. (defvar org-agenda-buffer-tmp-name nil)
  3782. ;;;###autoload
  3783. (defun org-agenda-list (&optional arg start-day span with-hour)
  3784. "Produce a daily/weekly view from all files in variable `org-agenda-files'.
  3785. The view will be for the current day or week, but from the overview buffer
  3786. you will be able to go to other days/weeks.
  3787. With a numeric prefix argument in an interactive call, the agenda will
  3788. span ARG days. Lisp programs should instead specify SPAN to change
  3789. the number of days. SPAN defaults to `org-agenda-span'.
  3790. START-DAY defaults to TODAY, or to the most recent match for the weekday
  3791. given in `org-agenda-start-on-weekday'.
  3792. When WITH-HOUR is non-nil, only include scheduled and deadline
  3793. items if they have an hour specification like [h]h:mm."
  3794. (interactive "P")
  3795. (if org-agenda-overriding-arguments
  3796. (setq arg (car org-agenda-overriding-arguments)
  3797. start-day (nth 1 org-agenda-overriding-arguments)
  3798. span (nth 2 org-agenda-overriding-arguments)))
  3799. (if (and (integerp arg) (> arg 0))
  3800. (setq span arg arg nil))
  3801. (catch 'exit
  3802. (setq org-agenda-buffer-name
  3803. (or org-agenda-buffer-tmp-name
  3804. (if org-agenda-sticky
  3805. (cond ((and org-keys (stringp org-match))
  3806. (format "*Org Agenda(%s:%s)*" org-keys org-match))
  3807. (org-keys
  3808. (format "*Org Agenda(%s)*" org-keys))
  3809. (t "*Org Agenda(a)*")))
  3810. org-agenda-buffer-name))
  3811. (org-agenda-prepare "Day/Week")
  3812. (setq start-day (or start-day org-agenda-start-day))
  3813. (if (stringp start-day)
  3814. ;; Convert to an absolute day number
  3815. (setq start-day (time-to-days (org-read-date nil t start-day))))
  3816. (org-compile-prefix-format 'agenda)
  3817. (org-set-sorting-strategy 'agenda)
  3818. (let* ((span (org-agenda-ndays-to-span
  3819. (or span org-agenda-ndays org-agenda-span)))
  3820. (today (org-today))
  3821. (sd (or start-day today))
  3822. (ndays (org-agenda-span-to-ndays span sd))
  3823. (org-agenda-start-on-weekday
  3824. (if (or (eq ndays 7) (eq ndays 14))
  3825. org-agenda-start-on-weekday))
  3826. (thefiles (org-agenda-files nil 'ifmode))
  3827. (files thefiles)
  3828. (start (if (or (null org-agenda-start-on-weekday)
  3829. (< ndays 7))
  3830. sd
  3831. (let* ((nt (calendar-day-of-week
  3832. (calendar-gregorian-from-absolute sd)))
  3833. (n1 org-agenda-start-on-weekday)
  3834. (d (- nt n1)))
  3835. (- sd (+ (if (< d 0) 7 0) d)))))
  3836. (day-numbers (list start))
  3837. (day-cnt 0)
  3838. (inhibit-redisplay (not debug-on-error))
  3839. (org-agenda-show-log-scoped org-agenda-show-log)
  3840. s e rtn rtnall file date d start-pos end-pos todayp
  3841. clocktable-start clocktable-end filter)
  3842. (setq org-agenda-redo-command
  3843. (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span) with-hour))
  3844. (dotimes (n (1- ndays))
  3845. (push (1+ (car day-numbers)) day-numbers))
  3846. (setq day-numbers (nreverse day-numbers))
  3847. (setq clocktable-start (car day-numbers)
  3848. clocktable-end (1+ (or (org-last day-numbers) 0)))
  3849. (org-set-local 'org-starting-day (car day-numbers))
  3850. (org-set-local 'org-arg-loc arg)
  3851. (org-set-local 'org-agenda-current-span (org-agenda-ndays-to-span span))
  3852. (unless org-agenda-compact-blocks
  3853. (let* ((d1 (car day-numbers))
  3854. (d2 (org-last day-numbers))
  3855. (w1 (org-days-to-iso-week d1))
  3856. (w2 (org-days-to-iso-week d2)))
  3857. (setq s (point))
  3858. (if org-agenda-overriding-header
  3859. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  3860. nil 'face 'org-agenda-structure) "\n")
  3861. (insert (org-agenda-span-name span)
  3862. "-agenda"
  3863. (if (< (- d2 d1) 350)
  3864. (if (= w1 w2)
  3865. (format " (W%02d)" w1)
  3866. (format " (W%02d-W%02d)" w1 w2))
  3867. "")
  3868. ":\n")))
  3869. (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
  3870. 'org-date-line t))
  3871. (org-agenda-mark-header-line s))
  3872. (while (setq d (pop day-numbers))
  3873. (setq date (calendar-gregorian-from-absolute d)
  3874. s (point))
  3875. (if (or (setq todayp (= d today))
  3876. (and (not start-pos) (= d sd)))
  3877. (setq start-pos (point))
  3878. (if (and start-pos (not end-pos))
  3879. (setq end-pos (point))))
  3880. (setq files thefiles
  3881. rtnall nil)
  3882. (while (setq file (pop files))
  3883. (catch 'nextfile
  3884. (org-check-agenda-file file)
  3885. (let ((org-agenda-entry-types org-agenda-entry-types))
  3886. ;; Starred types override non-starred equivalents
  3887. (when (member :deadline* org-agenda-entry-types)
  3888. (setq org-agenda-entry-types
  3889. (delq :deadline org-agenda-entry-types)))
  3890. (when (member :scheduled* org-agenda-entry-types)
  3891. (setq org-agenda-entry-types
  3892. (delq :scheduled org-agenda-entry-types)))
  3893. ;; Honor with-hour
  3894. (when with-hour
  3895. (when (member :deadline org-agenda-entry-types)
  3896. (setq org-agenda-entry-types
  3897. (delq :deadline org-agenda-entry-types))
  3898. (push :deadline* org-agenda-entry-types))
  3899. (when (member :scheduled org-agenda-entry-types)
  3900. (setq org-agenda-entry-types
  3901. (delq :scheduled org-agenda-entry-types))
  3902. (push :scheduled* org-agenda-entry-types)))
  3903. (unless org-agenda-include-deadlines
  3904. (setq org-agenda-entry-types
  3905. (delq :deadline* (delq :deadline org-agenda-entry-types))))
  3906. (cond
  3907. ((memq org-agenda-show-log-scoped '(only clockcheck))
  3908. (setq rtn (org-agenda-get-day-entries
  3909. file date :closed)))
  3910. (org-agenda-show-log-scoped
  3911. (setq rtn (apply 'org-agenda-get-day-entries
  3912. file date
  3913. (append '(:closed) org-agenda-entry-types))))
  3914. (t
  3915. (setq rtn (apply 'org-agenda-get-day-entries
  3916. file date
  3917. org-agenda-entry-types)))))
  3918. (setq rtnall (append rtnall rtn)))) ;; all entries
  3919. (if org-agenda-include-diary
  3920. (let ((org-agenda-search-headline-for-time t))
  3921. (require 'diary-lib)
  3922. (setq rtn (org-get-entries-from-diary date))
  3923. (setq rtnall (append rtnall rtn))))
  3924. (if (or rtnall org-agenda-show-all-dates)
  3925. (progn
  3926. (setq day-cnt (1+ day-cnt))
  3927. (insert
  3928. (if (stringp org-agenda-format-date)
  3929. (format-time-string org-agenda-format-date
  3930. (org-time-from-absolute date))
  3931. (funcall org-agenda-format-date date))
  3932. "\n")
  3933. (put-text-property s (1- (point)) 'face
  3934. (org-agenda-get-day-face date))
  3935. (put-text-property s (1- (point)) 'org-date-line t)
  3936. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3937. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
  3938. (when todayp
  3939. (put-text-property s (1- (point)) 'org-today t))
  3940. (setq rtnall
  3941. (org-agenda-add-time-grid-maybe rtnall ndays todayp))
  3942. (if rtnall (insert ;; all entries
  3943. (org-agenda-finalize-entries rtnall 'agenda)
  3944. "\n"))
  3945. (put-text-property s (1- (point)) 'day d)
  3946. (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
  3947. (when (and org-agenda-clockreport-mode clocktable-start)
  3948. (let ((org-agenda-files (org-agenda-files nil 'ifmode))
  3949. ;; the above line is to ensure the restricted range!
  3950. (p (copy-sequence org-agenda-clockreport-parameter-plist))
  3951. tbl)
  3952. (setq p (org-plist-delete p :block))
  3953. (setq p (plist-put p :tstart clocktable-start))
  3954. (setq p (plist-put p :tend clocktable-end))
  3955. (setq p (plist-put p :scope 'agenda))
  3956. (when (and (eq org-agenda-clockreport-mode 'with-filter)
  3957. (setq filter (or org-agenda-tag-filter-while-redo
  3958. (get 'org-agenda-tag-filter :preset-filter))))
  3959. (setq p (plist-put p :tags (mapconcat (lambda (x)
  3960. (if (string-match "[<>=]" x)
  3961. ""
  3962. x))
  3963. filter ""))))
  3964. (setq tbl (apply 'org-clock-get-clocktable p))
  3965. (insert tbl)))
  3966. (goto-char (point-min))
  3967. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3968. (unless (and (pos-visible-in-window-p (point-min))
  3969. (pos-visible-in-window-p (point-max)))
  3970. (goto-char (1- (point-max)))
  3971. (recenter -1)
  3972. (if (not (pos-visible-in-window-p (or start-pos 1)))
  3973. (progn
  3974. (goto-char (or start-pos 1))
  3975. (recenter 1))))
  3976. (goto-char (or start-pos 1))
  3977. (add-text-properties (point-min) (point-max)
  3978. `(org-agenda-type agenda
  3979. org-last-args (,arg ,start-day ,span)
  3980. org-redo-cmd ,org-agenda-redo-command
  3981. org-series-cmd ,org-cmd))
  3982. (if (eq org-agenda-show-log-scoped 'clockcheck)
  3983. (org-agenda-show-clocking-issues))
  3984. (org-agenda-finalize)
  3985. (setq buffer-read-only t)
  3986. (message ""))))
  3987. (defun org-agenda-ndays-to-span (n)
  3988. "Return a span symbol for a span of N days, or N if none matches."
  3989. (cond ((symbolp n) n)
  3990. ((= n 1) 'day)
  3991. ((= n 7) 'week)
  3992. ((= n 14) 'fortnight)
  3993. (t n)))
  3994. (defun org-agenda-span-to-ndays (span &optional start-day)
  3995. "Return ndays from SPAN, possibly starting at START-DAY.
  3996. START-DAY is an absolute time value."
  3997. (cond ((numberp span) span)
  3998. ((eq span 'day) 1)
  3999. ((eq span 'week) 7)
  4000. ((eq span 'fortnight) 14)
  4001. ((eq span 'month)
  4002. (let ((date (calendar-gregorian-from-absolute start-day)))
  4003. (calendar-last-day-of-month (car date) (caddr date))))
  4004. ((eq span 'year)
  4005. (let ((date (calendar-gregorian-from-absolute start-day)))
  4006. (if (calendar-leap-year-p (caddr date)) 366 365)))))
  4007. (defun org-agenda-span-name (span)
  4008. "Return a SPAN name."
  4009. (if (null span)
  4010. ""
  4011. (if (symbolp span)
  4012. (capitalize (symbol-name span))
  4013. (format "%d days" span))))
  4014. ;;; Agenda word search
  4015. (defvar org-agenda-search-history nil)
  4016. (defvar org-search-syntax-table nil
  4017. "Special syntax table for org-mode search.
  4018. In this table, we have single quotes not as word constituents, to
  4019. that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
  4020. (defvar org-mode-syntax-table) ; From org.el
  4021. (defun org-search-syntax-table ()
  4022. (unless org-search-syntax-table
  4023. (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
  4024. (modify-syntax-entry ?' "." org-search-syntax-table)
  4025. (modify-syntax-entry ?` "." org-search-syntax-table))
  4026. org-search-syntax-table)
  4027. (defvar org-agenda-last-search-view-search-was-boolean nil)
  4028. ;;;###autoload
  4029. (defun org-search-view (&optional todo-only string edit-at)
  4030. "Show all entries that contain a phrase or words or regular expressions.
  4031. With optional prefix argument TODO-ONLY, only consider entries that are
  4032. TODO entries. The argument STRING can be used to pass a default search
  4033. string into this function. If EDIT-AT is non-nil, it means that the
  4034. user should get a chance to edit this string, with cursor at position
  4035. EDIT-AT.
  4036. The search string can be viewed either as a phrase that should be found as
  4037. is, or it can be broken into a number of snippets, each of which must match
  4038. in a Boolean way to select an entry. The default depends on the variable
  4039. `org-agenda-search-view-always-boolean'.
  4040. Even if this is turned off (the default) you can always switch to
  4041. Boolean search dynamically by preceding the first word with \"+\" or \"-\".
  4042. The default is a direct search of the whole phrase, where each space in
  4043. the search string can expand to an arbitrary amount of whitespace,
  4044. including newlines.
  4045. If using a Boolean search, the search string is split on whitespace and
  4046. each snippet is searched separately, with logical AND to select an entry.
  4047. Words prefixed with a minus must *not* occur in the entry. Words without
  4048. a prefix or prefixed with a plus must occur in the entry. Matching is
  4049. case-insensitive. Words are enclosed by word delimiters (i.e. they must
  4050. match whole words, not parts of a word) if
  4051. `org-agenda-search-view-force-full-words' is set (default is nil).
  4052. Boolean search snippets enclosed by curly braces are interpreted as
  4053. regular expressions that must or (when preceded with \"-\") must not
  4054. match in the entry. Snippets enclosed into double quotes will be taken
  4055. as a whole, to include whitespace.
  4056. - If the search string starts with an asterisk, search only in headlines.
  4057. - If (possibly after the leading star) the search string starts with an
  4058. exclamation mark, this also means to look at TODO entries only, an effect
  4059. that can also be achieved with a prefix argument.
  4060. - If (possibly after star and exclamation mark) the search string starts
  4061. with a colon, this will mean that the (non-regexp) snippets of the
  4062. Boolean search must match as full words.
  4063. This command searches the agenda files, and in addition the files listed
  4064. in `org-agenda-text-search-extra-files'."
  4065. (interactive "P")
  4066. (if org-agenda-overriding-arguments
  4067. (setq todo-only (car org-agenda-overriding-arguments)
  4068. string (nth 1 org-agenda-overriding-arguments)
  4069. edit-at (nth 2 org-agenda-overriding-arguments)))
  4070. (let* ((props (list 'face nil
  4071. 'done-face 'org-agenda-done
  4072. 'org-not-done-regexp org-not-done-regexp
  4073. 'org-todo-regexp org-todo-regexp
  4074. 'org-complex-heading-regexp org-complex-heading-regexp
  4075. 'mouse-face 'highlight
  4076. 'help-echo (format "mouse-2 or RET jump to location")))
  4077. (full-words org-agenda-search-view-force-full-words)
  4078. (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
  4079. regexp rtn rtnall files file pos inherited-tags
  4080. marker category category-pos level tags c neg re boolean
  4081. ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
  4082. (unless (and (not edit-at)
  4083. (stringp string)
  4084. (string-match "\\S-" string))
  4085. (setq string (read-string
  4086. (if org-agenda-search-view-always-boolean
  4087. "[+-]Word/{Regexp} ...: "
  4088. "Phrase or [+-]Word/{Regexp} ...: ")
  4089. (cond
  4090. ((integerp edit-at) (cons string edit-at))
  4091. (edit-at string))
  4092. 'org-agenda-search-history)))
  4093. (catch 'exit
  4094. (if org-agenda-sticky
  4095. (setq org-agenda-buffer-name
  4096. (if (stringp string)
  4097. (format "*Org Agenda(%s:%s)*"
  4098. (or org-keys (or (and todo-only "S") "s")) string)
  4099. (format "*Org Agenda(%s)*" (or (and todo-only "S") "s")))))
  4100. (org-agenda-prepare "SEARCH")
  4101. (org-compile-prefix-format 'search)
  4102. (org-set-sorting-strategy 'search)
  4103. (setq org-agenda-redo-command
  4104. (list 'org-search-view (if todo-only t nil)
  4105. (list 'if 'current-prefix-arg nil string)))
  4106. (setq org-agenda-query-string string)
  4107. (if (equal (string-to-char string) ?*)
  4108. (setq hdl-only t
  4109. words (substring string 1))
  4110. (setq words string))
  4111. (when (equal (string-to-char words) ?!)
  4112. (setq todo-only t
  4113. words (substring words 1)))
  4114. (when (equal (string-to-char words) ?:)
  4115. (setq full-words t
  4116. words (substring words 1)))
  4117. (if (or org-agenda-search-view-always-boolean
  4118. (member (string-to-char words) '(?- ?+ ?\{)))
  4119. (setq boolean t))
  4120. (setq words (org-split-string words))
  4121. (let (www w)
  4122. (while (setq w (pop words))
  4123. (while (and (string-match "\\\\\\'" w) words)
  4124. (setq w (concat (substring w 0 -1) " " (pop words))))
  4125. (push w www))
  4126. (setq words (nreverse www) www nil)
  4127. (while (setq w (pop words))
  4128. (when (and (string-match "\\`[-+]?{" w)
  4129. (not (string-match "}\\'" w)))
  4130. (while (and words (not (string-match "}\\'" (car words))))
  4131. (setq w (concat w " " (pop words))))
  4132. (setq w (concat w " " (pop words))))
  4133. (push w www))
  4134. (setq words (nreverse www)))
  4135. (setq org-agenda-last-search-view-search-was-boolean boolean)
  4136. (when boolean
  4137. (let (wds w)
  4138. (while (setq w (pop words))
  4139. (if (or (equal (substring w 0 1) "\"")
  4140. (and (> (length w) 1)
  4141. (member (substring w 0 1) '("+" "-"))
  4142. (equal (substring w 1 2) "\"")))
  4143. (while (and words (not (equal (substring w -1) "\"")))
  4144. (setq w (concat w " " (pop words)))))
  4145. (and (string-match "\\`\\([-+]?\\)\"" w)
  4146. (setq w (replace-match "\\1" nil nil w)))
  4147. (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
  4148. (push w wds))
  4149. (setq words (nreverse wds))))
  4150. (if boolean
  4151. (mapc (lambda (w)
  4152. (setq c (string-to-char w))
  4153. (if (equal c ?-)
  4154. (setq neg t w (substring w 1))
  4155. (if (equal c ?+)
  4156. (setq neg nil w (substring w 1))
  4157. (setq neg nil)))
  4158. (if (string-match "\\`{.*}\\'" w)
  4159. (setq re (substring w 1 -1))
  4160. (if full-words
  4161. (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
  4162. (setq re (regexp-quote (downcase w)))))
  4163. (if neg (push re regexps-) (push re regexps+)))
  4164. words)
  4165. (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
  4166. regexps+))
  4167. (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
  4168. (if (not regexps+)
  4169. (setq regexp org-outline-regexp-bol)
  4170. (setq regexp (pop regexps+))
  4171. (if hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
  4172. regexp))))
  4173. (setq files (org-agenda-files nil 'ifmode))
  4174. (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
  4175. (pop org-agenda-text-search-extra-files)
  4176. (setq files (org-add-archive-files files)))
  4177. (setq files (append files org-agenda-text-search-extra-files)
  4178. rtnall nil)
  4179. (while (setq file (pop files))
  4180. (setq ee nil)
  4181. (catch 'nextfile
  4182. (org-check-agenda-file file)
  4183. (setq buffer (if (file-exists-p file)
  4184. (org-get-agenda-file-buffer file)
  4185. (error "No such file %s" file)))
  4186. (if (not buffer)
  4187. ;; If file does not exist, make sure an error message is sent
  4188. (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
  4189. file))))
  4190. (with-current-buffer buffer
  4191. (with-syntax-table (org-search-syntax-table)
  4192. (unless (derived-mode-p 'org-mode)
  4193. (error "Agenda file %s is not in `org-mode'" file))
  4194. (let ((case-fold-search t))
  4195. (save-excursion
  4196. (save-restriction
  4197. (if (eq buffer org-agenda-restrict)
  4198. (narrow-to-region org-agenda-restrict-begin
  4199. org-agenda-restrict-end)
  4200. (widen))
  4201. (goto-char (point-min))
  4202. (unless (or (org-at-heading-p)
  4203. (outline-next-heading))
  4204. (throw 'nextfile t))
  4205. (goto-char (max (point-min) (1- (point))))
  4206. (while (re-search-forward regexp nil t)
  4207. (org-back-to-heading t)
  4208. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4209. (> (org-reduced-level (org-outline-level))
  4210. org-agenda-search-view-max-outline-level)
  4211. (forward-line -1)
  4212. (outline-back-to-heading t)))
  4213. (skip-chars-forward "* ")
  4214. (setq beg (point-at-bol)
  4215. beg1 (point)
  4216. end (progn
  4217. (outline-next-heading)
  4218. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4219. (> (org-reduced-level (org-outline-level))
  4220. org-agenda-search-view-max-outline-level)
  4221. (forward-line 1)
  4222. (outline-next-heading)))
  4223. (point)))
  4224. (catch :skip
  4225. (goto-char beg)
  4226. (org-agenda-skip)
  4227. (setq str (buffer-substring-no-properties
  4228. (point-at-bol)
  4229. (if hdl-only (point-at-eol) end)))
  4230. (mapc (lambda (wr) (when (string-match wr str)
  4231. (goto-char (1- end))
  4232. (throw :skip t)))
  4233. regexps-)
  4234. (mapc (lambda (wr) (unless (string-match wr str)
  4235. (goto-char (1- end))
  4236. (throw :skip t)))
  4237. (if todo-only
  4238. (cons (concat "^\*+[ \t]+" org-not-done-regexp)
  4239. regexps+)
  4240. regexps+))
  4241. (goto-char beg)
  4242. (setq marker (org-agenda-new-marker (point))
  4243. category (org-get-category)
  4244. level (make-string (org-reduced-level (org-outline-level)) ? )
  4245. category-pos (get-text-property (point) 'org-category-position)
  4246. inherited-tags
  4247. (or (eq org-agenda-show-inherited-tags 'always)
  4248. (and (listp org-agenda-show-inherited-tags)
  4249. (memq 'todo org-agenda-show-inherited-tags))
  4250. (and (eq org-agenda-show-inherited-tags t)
  4251. (or (eq org-agenda-use-tag-inheritance t)
  4252. (memq 'todo org-agenda-use-tag-inheritance))))
  4253. tags (org-get-tags-at nil (not inherited-tags))
  4254. txt (org-agenda-format-item
  4255. ""
  4256. (buffer-substring-no-properties
  4257. beg1 (point-at-eol))
  4258. level category tags t))
  4259. (org-add-props txt props
  4260. 'org-marker marker 'org-hd-marker marker
  4261. 'org-todo-regexp org-todo-regexp
  4262. 'level level
  4263. 'org-complex-heading-regexp org-complex-heading-regexp
  4264. 'priority 1000 'org-category category
  4265. 'org-category-position category-pos
  4266. 'type "search")
  4267. (push txt ee)
  4268. (goto-char (1- end))))))))))
  4269. (setq rtn (nreverse ee))
  4270. (setq rtnall (append rtnall rtn)))
  4271. (if org-agenda-overriding-header
  4272. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4273. nil 'face 'org-agenda-structure) "\n")
  4274. (insert "Search words: ")
  4275. (add-text-properties (point-min) (1- (point))
  4276. (list 'face 'org-agenda-structure))
  4277. (setq pos (point))
  4278. (insert string "\n")
  4279. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4280. (setq pos (point))
  4281. (unless org-agenda-multi
  4282. (insert "Press `[', `]' to add/sub word, `{', `}' to add/sub regexp, `C-u r' to edit\n")
  4283. (add-text-properties pos (1- (point))
  4284. (list 'face 'org-agenda-structure))))
  4285. (org-agenda-mark-header-line (point-min))
  4286. (when rtnall
  4287. (insert (org-agenda-finalize-entries rtnall 'search) "\n"))
  4288. (goto-char (point-min))
  4289. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4290. (add-text-properties (point-min) (point-max)
  4291. `(org-agenda-type search
  4292. org-last-args (,todo-only ,string ,edit-at)
  4293. org-redo-cmd ,org-agenda-redo-command
  4294. org-series-cmd ,org-cmd))
  4295. (org-agenda-finalize)
  4296. (setq buffer-read-only t))))
  4297. ;;; Agenda TODO list
  4298. (defun org-agenda-propertize-selected-todo-keywords (keywords)
  4299. "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
  4300. (concat
  4301. (if (or (equal keywords "ALL") (not keywords))
  4302. (propertize "ALL" 'face 'warning)
  4303. (mapconcat
  4304. (lambda (kw)
  4305. (propertize kw 'face (org-get-todo-face kw)))
  4306. (org-split-string keywords "|")
  4307. "|"))
  4308. "\n"))
  4309. (defvar org-select-this-todo-keyword nil)
  4310. (defvar org-last-arg nil)
  4311. ;;;###autoload
  4312. (defun org-todo-list (&optional arg)
  4313. "Show all (not done) TODO entries from all agenda file in a single list.
  4314. The prefix arg can be used to select a specific TODO keyword and limit
  4315. the list to these. When using \\[universal-argument], you will be prompted
  4316. for a keyword. A numeric prefix directly selects the Nth keyword in
  4317. `org-todo-keywords-1'."
  4318. (interactive "P")
  4319. (if org-agenda-overriding-arguments
  4320. (setq arg org-agenda-overriding-arguments))
  4321. (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
  4322. (let* ((today (org-today))
  4323. (date (calendar-gregorian-from-absolute today))
  4324. (kwds org-todo-keywords-for-agenda)
  4325. (completion-ignore-case t)
  4326. (org-select-this-todo-keyword
  4327. (if (stringp arg) arg
  4328. (and arg (integerp arg) (> arg 0)
  4329. (nth (1- arg) kwds))))
  4330. rtn rtnall files file pos)
  4331. (when (equal arg '(4))
  4332. (setq org-select-this-todo-keyword
  4333. (org-icompleting-read "Keyword (or KWD1|K2D2|...): "
  4334. (mapcar 'list kwds) nil nil)))
  4335. (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
  4336. (catch 'exit
  4337. (if org-agenda-sticky
  4338. (setq org-agenda-buffer-name
  4339. (if (stringp org-select-this-todo-keyword)
  4340. (format "*Org Agenda(%s:%s)*" (or org-keys "t")
  4341. org-select-this-todo-keyword)
  4342. (format "*Org Agenda(%s)*" (or org-keys "t")))))
  4343. (org-agenda-prepare "TODO")
  4344. (org-compile-prefix-format 'todo)
  4345. (org-set-sorting-strategy 'todo)
  4346. (setq org-agenda-redo-command
  4347. `(org-todo-list (or (and (numberp current-prefix-arg)
  4348. current-prefix-arg)
  4349. ,org-select-this-todo-keyword
  4350. current-prefix-arg ,arg)))
  4351. (setq files (org-agenda-files nil 'ifmode)
  4352. rtnall nil)
  4353. (while (setq file (pop files))
  4354. (catch 'nextfile
  4355. (org-check-agenda-file file)
  4356. (setq rtn (org-agenda-get-day-entries file date :todo))
  4357. (setq rtnall (append rtnall rtn))))
  4358. (if org-agenda-overriding-header
  4359. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4360. nil 'face 'org-agenda-structure) "\n")
  4361. (insert "Global list of TODO items of type: ")
  4362. (add-text-properties (point-min) (1- (point))
  4363. (list 'face 'org-agenda-structure
  4364. 'short-heading
  4365. (concat "ToDo: "
  4366. (or org-select-this-todo-keyword "ALL"))))
  4367. (org-agenda-mark-header-line (point-min))
  4368. (insert (org-agenda-propertize-selected-todo-keywords
  4369. org-select-this-todo-keyword))
  4370. (setq pos (point))
  4371. (unless org-agenda-multi
  4372. (insert "Available with `N r': (0)[ALL]")
  4373. (let ((n 0) s)
  4374. (mapc (lambda (x)
  4375. (setq s (format "(%d)%s" (setq n (1+ n)) x))
  4376. (if (> (+ (current-column) (string-width s) 1) (frame-width))
  4377. (insert "\n "))
  4378. (insert " " s))
  4379. kwds))
  4380. (insert "\n"))
  4381. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
  4382. (org-agenda-mark-header-line (point-min))
  4383. (when rtnall
  4384. (insert (org-agenda-finalize-entries rtnall 'todo) "\n"))
  4385. (goto-char (point-min))
  4386. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4387. (add-text-properties (point-min) (point-max)
  4388. `(org-agenda-type todo
  4389. org-last-args ,arg
  4390. org-redo-cmd ,org-agenda-redo-command
  4391. org-series-cmd ,org-cmd))
  4392. (org-agenda-finalize)
  4393. (setq buffer-read-only t))))
  4394. ;;; Agenda tags match
  4395. ;;;###autoload
  4396. (defun org-tags-view (&optional todo-only match)
  4397. "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
  4398. The prefix arg TODO-ONLY limits the search to TODO entries."
  4399. (interactive "P")
  4400. (if org-agenda-overriding-arguments
  4401. (setq todo-only (car org-agenda-overriding-arguments)
  4402. match (nth 1 org-agenda-overriding-arguments)))
  4403. (let* ((org-tags-match-list-sublevels
  4404. org-tags-match-list-sublevels)
  4405. (completion-ignore-case t)
  4406. rtn rtnall files file pos matcher
  4407. buffer)
  4408. (when (and (stringp match) (not (string-match "\\S-" match)))
  4409. (setq match nil))
  4410. (catch 'exit
  4411. (if org-agenda-sticky
  4412. (setq org-agenda-buffer-name
  4413. (if (stringp match)
  4414. (format "*Org Agenda(%s:%s)*"
  4415. (or org-keys (or (and todo-only "M") "m")) match)
  4416. (format "*Org Agenda(%s)*" (or (and todo-only "M") "m")))))
  4417. ;; Prepare agendas (and `org-tag-alist-for-agenda') before
  4418. ;; expanding tags within `org-make-tags-matcher'
  4419. (org-agenda-prepare (concat "TAGS " match))
  4420. (setq matcher (org-make-tags-matcher match)
  4421. match (car matcher) matcher (cdr matcher))
  4422. (org-compile-prefix-format 'tags)
  4423. (org-set-sorting-strategy 'tags)
  4424. (setq org-agenda-query-string match)
  4425. (setq org-agenda-redo-command
  4426. (list 'org-tags-view `(quote ,todo-only)
  4427. (list 'if 'current-prefix-arg nil `(quote ,org-agenda-query-string))))
  4428. (setq files (org-agenda-files nil 'ifmode)
  4429. rtnall nil)
  4430. (while (setq file (pop files))
  4431. (catch 'nextfile
  4432. (org-check-agenda-file file)
  4433. (setq buffer (if (file-exists-p file)
  4434. (org-get-agenda-file-buffer file)
  4435. (error "No such file %s" file)))
  4436. (if (not buffer)
  4437. ;; If file does not exist, error message to agenda
  4438. (setq rtn (list
  4439. (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4440. rtnall (append rtnall rtn))
  4441. (with-current-buffer buffer
  4442. (unless (derived-mode-p 'org-mode)
  4443. (error "Agenda file %s is not in `org-mode'" file))
  4444. (save-excursion
  4445. (save-restriction
  4446. (if (eq buffer org-agenda-restrict)
  4447. (narrow-to-region org-agenda-restrict-begin
  4448. org-agenda-restrict-end)
  4449. (widen))
  4450. (setq rtn (org-scan-tags 'agenda matcher todo-only))
  4451. (setq rtnall (append rtnall rtn))))))))
  4452. (if org-agenda-overriding-header
  4453. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4454. nil 'face 'org-agenda-structure) "\n")
  4455. (insert "Headlines with TAGS match: ")
  4456. (add-text-properties (point-min) (1- (point))
  4457. (list 'face 'org-agenda-structure
  4458. 'short-heading
  4459. (concat "Match: " match)))
  4460. (setq pos (point))
  4461. (insert match "\n")
  4462. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4463. (setq pos (point))
  4464. (unless org-agenda-multi
  4465. (insert "Press `C-u r' to search again with new search string\n"))
  4466. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
  4467. (org-agenda-mark-header-line (point-min))
  4468. (when rtnall
  4469. (insert (org-agenda-finalize-entries rtnall 'tags) "\n"))
  4470. (goto-char (point-min))
  4471. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4472. (add-text-properties (point-min) (point-max)
  4473. `(org-agenda-type tags
  4474. org-last-args (,todo-only ,match)
  4475. org-redo-cmd ,org-agenda-redo-command
  4476. org-series-cmd ,org-cmd))
  4477. (org-agenda-finalize)
  4478. (setq buffer-read-only t))))
  4479. ;;; Agenda Finding stuck projects
  4480. (defvar org-agenda-skip-regexp nil
  4481. "Regular expression used in skipping subtrees for the agenda.
  4482. This is basically a temporary global variable that can be set and then
  4483. used by user-defined selections using `org-agenda-skip-function'.")
  4484. (defvar org-agenda-overriding-header nil
  4485. "When set during agenda, todo and tags searches it replaces the header.
  4486. This variable should not be set directly, but custom commands can bind it
  4487. in the options section.")
  4488. (defun org-agenda-skip-entry-when-regexp-matches ()
  4489. "Check if the current entry contains match for `org-agenda-skip-regexp'.
  4490. If yes, it returns the end position of this entry, causing agenda commands
  4491. to skip the entry but continuing the search in the subtree. This is a
  4492. function that can be put into `org-agenda-skip-function' for the duration
  4493. of a command."
  4494. (let ((end (save-excursion (org-end-of-subtree t)))
  4495. skip)
  4496. (save-excursion
  4497. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  4498. (and skip end)))
  4499. (defun org-agenda-skip-subtree-when-regexp-matches ()
  4500. "Check if the current subtree contains match for `org-agenda-skip-regexp'.
  4501. If yes, it returns the end position of this tree, causing agenda commands
  4502. to skip this subtree. This is a function that can be put into
  4503. `org-agenda-skip-function' for the duration of a command."
  4504. (let ((end (save-excursion (org-end-of-subtree t)))
  4505. skip)
  4506. (save-excursion
  4507. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  4508. (and skip end)))
  4509. (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
  4510. "Check if the current subtree contains match for `org-agenda-skip-regexp'.
  4511. If yes, it returns the end position of the current entry (NOT the tree),
  4512. causing agenda commands to skip the entry but continuing the search in
  4513. the subtree. This is a function that can be put into
  4514. `org-agenda-skip-function' for the duration of a command. An important
  4515. use of this function is for the stuck project list."
  4516. (let ((end (save-excursion (org-end-of-subtree t)))
  4517. (entry-end (save-excursion (outline-next-heading) (1- (point))))
  4518. skip)
  4519. (save-excursion
  4520. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  4521. (and skip entry-end)))
  4522. (defun org-agenda-skip-entry-if (&rest conditions)
  4523. "Skip entry if any of CONDITIONS is true.
  4524. See `org-agenda-skip-if' for details."
  4525. (org-agenda-skip-if nil conditions))
  4526. (defun org-agenda-skip-subtree-if (&rest conditions)
  4527. "Skip entry if any of CONDITIONS is true.
  4528. See `org-agenda-skip-if' for details."
  4529. (org-agenda-skip-if t conditions))
  4530. (defun org-agenda-skip-if (subtree conditions)
  4531. "Checks current entity for CONDITIONS.
  4532. If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
  4533. the entry (i.e. the text before the next heading) is checked.
  4534. CONDITIONS is a list of symbols, boolean OR is used to combine the results
  4535. from different tests. Valid conditions are:
  4536. scheduled Check if there is a scheduled cookie
  4537. notscheduled Check if there is no scheduled cookie
  4538. deadline Check if there is a deadline
  4539. notdeadline Check if there is no deadline
  4540. timestamp Check if there is a timestamp (also deadline or scheduled)
  4541. nottimestamp Check if there is no timestamp (also deadline or scheduled)
  4542. regexp Check if regexp matches
  4543. notregexp Check if regexp does not match.
  4544. todo Check if TODO keyword matches
  4545. nottodo Check if TODO keyword does not match
  4546. The regexp is taken from the conditions list, it must come right after
  4547. the `regexp' or `notregexp' element.
  4548. `todo' and `nottodo' accept as an argument a list of todo
  4549. keywords, which may include \"*\" to match any todo keyword.
  4550. (org-agenda-skip-entry-if 'todo '(\"TODO\" \"WAITING\"))
  4551. would skip all entries with \"TODO\" or \"WAITING\" keywords.
  4552. Instead of a list, a keyword class may be given. For example:
  4553. (org-agenda-skip-entry-if 'nottodo 'done)
  4554. would skip entries that haven't been marked with any of \"DONE\"
  4555. keywords. Possible classes are: `todo', `done', `any'.
  4556. If any of these conditions is met, this function returns the end point of
  4557. the entity, causing the search to continue from there. This is a function
  4558. that can be put into `org-agenda-skip-function' for the duration of a command."
  4559. (let (beg end m)
  4560. (org-back-to-heading t)
  4561. (setq beg (point)
  4562. end (if subtree
  4563. (progn (org-end-of-subtree t) (point))
  4564. (progn (outline-next-heading) (1- (point)))))
  4565. (goto-char beg)
  4566. (and
  4567. (or
  4568. (and (memq 'scheduled conditions)
  4569. (re-search-forward org-scheduled-time-regexp end t))
  4570. (and (memq 'notscheduled conditions)
  4571. (not (re-search-forward org-scheduled-time-regexp end t)))
  4572. (and (memq 'deadline conditions)
  4573. (re-search-forward org-deadline-time-regexp end t))
  4574. (and (memq 'notdeadline conditions)
  4575. (not (re-search-forward org-deadline-time-regexp end t)))
  4576. (and (memq 'timestamp conditions)
  4577. (re-search-forward org-ts-regexp end t))
  4578. (and (memq 'nottimestamp conditions)
  4579. (not (re-search-forward org-ts-regexp end t)))
  4580. (and (setq m (memq 'regexp conditions))
  4581. (stringp (nth 1 m))
  4582. (re-search-forward (nth 1 m) end t))
  4583. (and (setq m (memq 'notregexp conditions))
  4584. (stringp (nth 1 m))
  4585. (not (re-search-forward (nth 1 m) end t)))
  4586. (and (or
  4587. (setq m (memq 'nottodo conditions))
  4588. (setq m (memq 'todo-unblocked conditions))
  4589. (setq m (memq 'nottodo-unblocked conditions))
  4590. (setq m (memq 'todo conditions)))
  4591. (org-agenda-skip-if-todo m end)))
  4592. end)))
  4593. (defun org-agenda-skip-if-todo (args end)
  4594. "Helper function for `org-agenda-skip-if', do not use it directly.
  4595. ARGS is a list with first element either `todo', `nottodo',
  4596. `todo-unblocked' or `nottodo-unblocked'. The remainder is either
  4597. a list of TODO keywords, or a state symbol `todo' or `done' or
  4598. `any'."
  4599. (let ((kw (car args))
  4600. (arg (cadr args))
  4601. todo-wds todo-re)
  4602. (setq todo-wds
  4603. (org-uniquify
  4604. (cond
  4605. ((listp arg) ;; list of keywords
  4606. (if (member "*" arg)
  4607. (mapcar 'substring-no-properties org-todo-keywords-1)
  4608. arg))
  4609. ((symbolp arg) ;; keyword class name
  4610. (cond
  4611. ((eq arg 'todo)
  4612. (org-delete-all org-done-keywords
  4613. (mapcar 'substring-no-properties
  4614. org-todo-keywords-1)))
  4615. ((eq arg 'done) org-done-keywords)
  4616. ((eq arg 'any)
  4617. (mapcar 'substring-no-properties org-todo-keywords-1)))))))
  4618. (setq todo-re
  4619. (concat "^\\*+[ \t]+\\<\\("
  4620. (mapconcat 'identity todo-wds "\\|")
  4621. "\\)\\>"))
  4622. (cond
  4623. ((eq kw 'todo) (re-search-forward todo-re end t))
  4624. ((eq kw 'nottodo) (not (re-search-forward todo-re end t)))
  4625. ((eq kw 'todo-unblocked)
  4626. (catch 'unblocked
  4627. (while (re-search-forward todo-re end t)
  4628. (or (org-entry-blocked-p) (throw 'unblocked t)))
  4629. nil))
  4630. ((eq kw 'nottodo-unblocked)
  4631. (catch 'unblocked
  4632. (while (re-search-forward todo-re end t)
  4633. (or (org-entry-blocked-p) (throw 'unblocked nil)))
  4634. t))
  4635. )))
  4636. ;;;###autoload
  4637. (defun org-agenda-list-stuck-projects (&rest ignore)
  4638. "Create agenda view for projects that are stuck.
  4639. Stuck projects are project that have no next actions. For the definitions
  4640. of what a project is and how to check if it stuck, customize the variable
  4641. `org-stuck-projects'."
  4642. (interactive)
  4643. (let* ((org-agenda-skip-function
  4644. 'org-agenda-skip-entry-when-regexp-matches-in-subtree)
  4645. ;; We could have used org-agenda-skip-if here.
  4646. (org-agenda-overriding-header
  4647. (or org-agenda-overriding-header "List of stuck projects: "))
  4648. (matcher (nth 0 org-stuck-projects))
  4649. (todo (nth 1 org-stuck-projects))
  4650. (todo-wds (if (member "*" todo)
  4651. (progn
  4652. (org-agenda-prepare-buffers (org-agenda-files
  4653. nil 'ifmode))
  4654. (org-delete-all
  4655. org-done-keywords-for-agenda
  4656. (copy-sequence org-todo-keywords-for-agenda)))
  4657. todo))
  4658. (todo-re (concat "^\\*+[ \t]+\\("
  4659. (mapconcat 'identity todo-wds "\\|")
  4660. "\\)\\>"))
  4661. (tags (nth 2 org-stuck-projects))
  4662. (tags-re (if (member "*" tags)
  4663. (concat org-outline-regexp-bol
  4664. (org-re ".*:[[:alnum:]_@#%]+:[ \t]*$"))
  4665. (if tags
  4666. (concat org-outline-regexp-bol
  4667. ".*:\\("
  4668. (mapconcat 'identity tags "\\|")
  4669. (org-re "\\):[[:alnum:]_@#%:]*[ \t]*$")))))
  4670. (gen-re (nth 3 org-stuck-projects))
  4671. (re-list
  4672. (delq nil
  4673. (list
  4674. (if todo todo-re)
  4675. (if tags tags-re)
  4676. (and gen-re (stringp gen-re) (string-match "\\S-" gen-re)
  4677. gen-re)))))
  4678. (setq org-agenda-skip-regexp
  4679. (if re-list
  4680. (mapconcat 'identity re-list "\\|")
  4681. (error "No information how to identify unstuck projects")))
  4682. (org-tags-view nil matcher)
  4683. (with-current-buffer org-agenda-buffer-name
  4684. (setq org-agenda-redo-command
  4685. `(org-agenda-list-stuck-projects ,current-prefix-arg)))))
  4686. ;;; Diary integration
  4687. (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
  4688. (defvar diary-list-entries-hook)
  4689. (defvar diary-time-regexp)
  4690. (defun org-get-entries-from-diary (date)
  4691. "Get the (Emacs Calendar) diary entries for DATE."
  4692. (require 'diary-lib)
  4693. (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
  4694. (diary-display-hook '(fancy-diary-display))
  4695. (diary-display-function 'fancy-diary-display)
  4696. (pop-up-frames nil)
  4697. (diary-list-entries-hook
  4698. (cons 'org-diary-default-entry diary-list-entries-hook))
  4699. (diary-file-name-prefix nil) ; turn this feature off
  4700. (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
  4701. entries
  4702. (org-disable-agenda-to-diary t))
  4703. (save-excursion
  4704. (save-window-excursion
  4705. (funcall (if (fboundp 'diary-list-entries)
  4706. 'diary-list-entries 'list-diary-entries)
  4707. date 1)))
  4708. (if (not (get-buffer diary-fancy-buffer))
  4709. (setq entries nil)
  4710. (with-current-buffer diary-fancy-buffer
  4711. (setq buffer-read-only nil)
  4712. (if (zerop (buffer-size))
  4713. ;; No entries
  4714. (setq entries nil)
  4715. ;; Omit the date and other unnecessary stuff
  4716. (org-agenda-cleanup-fancy-diary)
  4717. ;; Add prefix to each line and extend the text properties
  4718. (if (zerop (buffer-size))
  4719. (setq entries nil)
  4720. (setq entries (buffer-substring (point-min) (- (point-max) 1)))
  4721. (setq entries
  4722. (with-temp-buffer
  4723. (insert entries) (goto-char (point-min))
  4724. (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
  4725. (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
  4726. (replace-match (concat "; " (match-string 1)))))
  4727. (buffer-string)))))
  4728. (set-buffer-modified-p nil)
  4729. (kill-buffer diary-fancy-buffer)))
  4730. (when entries
  4731. (setq entries (org-split-string entries "\n"))
  4732. (setq entries
  4733. (mapcar
  4734. (lambda (x)
  4735. (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
  4736. ;; Extend the text properties to the beginning of the line
  4737. (org-add-props x (text-properties-at (1- (length x)) x)
  4738. 'type "diary" 'date date 'face 'org-agenda-diary))
  4739. entries)))))
  4740. (defvar org-agenda-cleanup-fancy-diary-hook nil
  4741. "Hook run when the fancy diary buffer is cleaned up.")
  4742. (defun org-agenda-cleanup-fancy-diary ()
  4743. "Remove unwanted stuff in buffer created by `fancy-diary-display'.
  4744. This gets rid of the date, the underline under the date, and
  4745. the dummy entry installed by `org-mode' to ensure non-empty diary for each
  4746. date. It also removes lines that contain only whitespace."
  4747. (goto-char (point-min))
  4748. (if (looking-at ".*?:[ \t]*")
  4749. (progn
  4750. (replace-match "")
  4751. (re-search-forward "\n=+$" nil t)
  4752. (replace-match "")
  4753. (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
  4754. (re-search-forward "\n=+$" nil t)
  4755. (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
  4756. (goto-char (point-min))
  4757. (while (re-search-forward "^ +\n" nil t)
  4758. (replace-match ""))
  4759. (goto-char (point-min))
  4760. (if (re-search-forward "^Org-mode dummy\n?" nil t)
  4761. (replace-match ""))
  4762. (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
  4763. ;; Make sure entries from the diary have the right text properties.
  4764. (eval-after-load "diary-lib"
  4765. '(if (boundp 'diary-modify-entry-list-string-function)
  4766. ;; We can rely on the hook, nothing to do
  4767. nil
  4768. ;; Hook not available, must use advice to make this work
  4769. (defadvice add-to-diary-list (before org-mark-diary-entry activate)
  4770. "Make the position visible."
  4771. (if (and org-disable-agenda-to-diary ;; called from org-agenda
  4772. (stringp string)
  4773. buffer-file-name)
  4774. (setq string (org-modify-diary-entry-string string))))))
  4775. (defun org-modify-diary-entry-string (string)
  4776. "Add text properties to string, allowing org-mode to act on it."
  4777. (org-add-props string nil
  4778. 'mouse-face 'highlight
  4779. 'help-echo (if buffer-file-name
  4780. (format "mouse-2 or RET jump to diary file %s"
  4781. (abbreviate-file-name buffer-file-name))
  4782. "")
  4783. 'org-agenda-diary-link t
  4784. 'org-marker (org-agenda-new-marker (point-at-bol))))
  4785. (defun org-diary-default-entry ()
  4786. "Add a dummy entry to the diary.
  4787. Needed to avoid empty dates which mess up holiday display."
  4788. ;; Catch the error if dealing with the new add-to-diary-alist
  4789. (when org-disable-agenda-to-diary
  4790. (condition-case nil
  4791. (org-add-to-diary-list original-date "Org-mode dummy" "")
  4792. (error
  4793. (org-add-to-diary-list original-date "Org-mode dummy" "" nil)))))
  4794. (defun org-add-to-diary-list (&rest args)
  4795. (if (fboundp 'diary-add-to-list)
  4796. (apply 'diary-add-to-list args)
  4797. (apply 'add-to-diary-list args)))
  4798. (defvar org-diary-last-run-time nil)
  4799. ;;;###autoload
  4800. (defun org-diary (&rest args)
  4801. "Return diary information from org files.
  4802. This function can be used in a \"sexp\" diary entry in the Emacs calendar.
  4803. It accesses org files and extracts information from those files to be
  4804. listed in the diary. The function accepts arguments specifying what
  4805. items should be listed. For a list of arguments allowed here, see the
  4806. variable `org-agenda-entry-types'.
  4807. The call in the diary file should look like this:
  4808. &%%(org-diary) ~/path/to/some/orgfile.org
  4809. Use a separate line for each org file to check. Or, if you omit the file name,
  4810. all files listed in `org-agenda-files' will be checked automatically:
  4811. &%%(org-diary)
  4812. If you don't give any arguments (as in the example above), the default value
  4813. of `org-agenda-entry-types' is used: (:deadline :scheduled :timestamp :sexp).
  4814. So the example above may also be written as
  4815. &%%(org-diary :deadline :timestamp :sexp :scheduled)
  4816. The function expects the lisp variables `entry' and `date' to be provided
  4817. by the caller, because this is how the calendar works. Don't use this
  4818. function from a program - use `org-agenda-get-day-entries' instead."
  4819. (when (> (- (org-float-time)
  4820. org-agenda-last-marker-time)
  4821. 5)
  4822. ;; I am not sure if this works with sticky agendas, because the marker
  4823. ;; list is then no longer a global variable.
  4824. (org-agenda-reset-markers))
  4825. (org-compile-prefix-format 'agenda)
  4826. (org-set-sorting-strategy 'agenda)
  4827. (setq args (or args org-agenda-entry-types))
  4828. (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
  4829. (list entry)
  4830. (org-agenda-files t)))
  4831. (time (org-float-time))
  4832. file rtn results)
  4833. (when (or (not org-diary-last-run-time)
  4834. (> (- time
  4835. org-diary-last-run-time)
  4836. 3))
  4837. (org-agenda-prepare-buffers files))
  4838. (setq org-diary-last-run-time time)
  4839. ;; If this is called during org-agenda, don't return any entries to
  4840. ;; the calendar. Org Agenda will list these entries itself.
  4841. (if org-disable-agenda-to-diary (setq files nil))
  4842. (while (setq file (pop files))
  4843. (setq rtn (apply 'org-agenda-get-day-entries file date args))
  4844. (setq results (append results rtn)))
  4845. (when results
  4846. (setq results
  4847. (mapcar (lambda (i) (replace-regexp-in-string
  4848. org-bracket-link-regexp "\\3" i)) results))
  4849. (concat (org-agenda-finalize-entries results) "\n"))))
  4850. ;;; Agenda entry finders
  4851. (defun org-agenda-get-day-entries (file date &rest args)
  4852. "Does the work for `org-diary' and `org-agenda'.
  4853. FILE is the path to a file to be checked for entries. DATE is date like
  4854. the one returned by `calendar-current-date'. ARGS are symbols indicating
  4855. which kind of entries should be extracted. For details about these, see
  4856. the documentation of `org-diary'."
  4857. (setq args (or args org-agenda-entry-types))
  4858. (let* ((org-startup-folded nil)
  4859. (org-startup-align-all-tables nil)
  4860. (buffer (if (file-exists-p file)
  4861. (org-get-agenda-file-buffer file)
  4862. (error "No such file %s" file)))
  4863. arg results rtn deadline-results)
  4864. (if (not buffer)
  4865. ;; If file does not exist, make sure an error message ends up in diary
  4866. (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4867. (with-current-buffer buffer
  4868. (unless (derived-mode-p 'org-mode)
  4869. (error "Agenda file %s is not in `org-mode'" file))
  4870. (setq org-agenda-buffer (or org-agenda-buffer buffer))
  4871. (let ((case-fold-search nil))
  4872. (save-excursion
  4873. (save-restriction
  4874. (if (eq buffer org-agenda-restrict)
  4875. (narrow-to-region org-agenda-restrict-begin
  4876. org-agenda-restrict-end)
  4877. (widen))
  4878. ;; The way we repeatedly append to `results' makes it O(n^2) :-(
  4879. (while (setq arg (pop args))
  4880. (cond
  4881. ((and (eq arg :todo)
  4882. (equal date (calendar-gregorian-from-absolute
  4883. (org-today))))
  4884. (setq rtn (org-agenda-get-todos))
  4885. (setq results (append results rtn)))
  4886. ((eq arg :timestamp)
  4887. (setq rtn (org-agenda-get-blocks))
  4888. (setq results (append results rtn))
  4889. (setq rtn (org-agenda-get-timestamps deadline-results))
  4890. (setq results (append results rtn)))
  4891. ((eq arg :sexp)
  4892. (setq rtn (org-agenda-get-sexps))
  4893. (setq results (append results rtn)))
  4894. ((eq arg :scheduled)
  4895. (setq rtn (org-agenda-get-scheduled deadline-results))
  4896. (setq results (append results rtn)))
  4897. ((eq arg :scheduled*)
  4898. (setq rtn (org-agenda-get-scheduled deadline-results t))
  4899. (setq results (append results rtn)))
  4900. ((eq arg :closed)
  4901. (setq rtn (org-agenda-get-progress))
  4902. (setq results (append results rtn)))
  4903. ((eq arg :deadline)
  4904. (setq rtn (org-agenda-get-deadlines))
  4905. (setq deadline-results (copy-sequence rtn))
  4906. (setq results (append results rtn)))
  4907. ((eq arg :deadline*)
  4908. (setq rtn (org-agenda-get-deadlines t))
  4909. (setq deadline-results (copy-sequence rtn))
  4910. (setq results (append results rtn))))))))
  4911. results))))
  4912. (defsubst org-em (x y list)
  4913. "Is X or Y a member of LIST?"
  4914. (or (memq x list) (memq y list)))
  4915. (defvar org-heading-keyword-regexp-format) ; defined in org.el
  4916. (defvar org-agenda-sorting-strategy-selected nil)
  4917. (defun org-agenda-get-todos ()
  4918. "Return the TODO information for agenda display."
  4919. (let* ((props (list 'face nil
  4920. 'done-face 'org-agenda-done
  4921. 'org-not-done-regexp org-not-done-regexp
  4922. 'org-todo-regexp org-todo-regexp
  4923. 'org-complex-heading-regexp org-complex-heading-regexp
  4924. 'mouse-face 'highlight
  4925. 'help-echo
  4926. (format "mouse-2 or RET jump to org file %s"
  4927. (abbreviate-file-name buffer-file-name))))
  4928. (regexp (format org-heading-keyword-regexp-format
  4929. (cond
  4930. ((and org-select-this-todo-keyword
  4931. (equal org-select-this-todo-keyword "*"))
  4932. org-todo-regexp)
  4933. (org-select-this-todo-keyword
  4934. (concat "\\("
  4935. (mapconcat 'identity
  4936. (org-split-string
  4937. org-select-this-todo-keyword
  4938. "|")
  4939. "\\|") "\\)"))
  4940. (t org-not-done-regexp))))
  4941. marker priority category category-pos level tags todo-state ts-date ts-date-type
  4942. ee txt beg end inherited-tags todo-state-end-pos)
  4943. (goto-char (point-min))
  4944. (while (re-search-forward regexp nil t)
  4945. (catch :skip
  4946. (save-match-data
  4947. (beginning-of-line)
  4948. (org-agenda-skip)
  4949. (setq beg (point) end (save-excursion (outline-next-heading) (point)))
  4950. (unless (and (setq todo-state (org-get-todo-state))
  4951. (setq todo-state-end-pos (match-end 2)))
  4952. (goto-char end)
  4953. (throw :skip nil))
  4954. (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
  4955. (goto-char (1+ beg))
  4956. (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
  4957. (throw :skip nil)))
  4958. (goto-char (match-beginning 2))
  4959. (setq marker (org-agenda-new-marker (match-beginning 0))
  4960. category (org-get-category)
  4961. ts-date (let (ts)
  4962. (save-match-data
  4963. (cond ((org-em 'scheduled-up 'scheduled-down
  4964. org-agenda-sorting-strategy-selected)
  4965. (setq ts (org-entry-get (point) "SCHEDULED")
  4966. ts-date-type " scheduled"))
  4967. ((org-em 'deadline-up 'deadline-down
  4968. org-agenda-sorting-strategy-selected)
  4969. (setq ts (org-entry-get (point) "DEADLINE")
  4970. ts-date-type " deadline"))
  4971. ((org-em 'ts-up 'ts-down
  4972. org-agenda-sorting-strategy-selected)
  4973. (setq ts (org-entry-get (point) "TIMESTAMP")
  4974. ts-date-type " timestamp"))
  4975. ((org-em 'tsia-up 'tsia-down
  4976. org-agenda-sorting-strategy-selected)
  4977. (setq ts (org-entry-get (point) "TIMESTAMP_IA")
  4978. ts-date-type " timestamp_ia"))
  4979. ((org-em 'timestamp-up 'timestamp-down
  4980. org-agenda-sorting-strategy-selected)
  4981. (setq ts (or (org-entry-get (point) "SCHEDULED")
  4982. (org-entry-get (point) "DEADLINE")
  4983. (org-entry-get (point) "TIMESTAMP")
  4984. (org-entry-get (point) "TIMESTAMP_IA"))
  4985. ts-date-type ""))
  4986. (t (setq ts-date-type "")))
  4987. (when ts (ignore-errors (org-time-string-to-absolute ts)))))
  4988. category-pos (get-text-property (point) 'org-category-position)
  4989. txt (org-trim
  4990. (buffer-substring (match-beginning 2) (match-end 0)))
  4991. inherited-tags
  4992. (or (eq org-agenda-show-inherited-tags 'always)
  4993. (and (listp org-agenda-show-inherited-tags)
  4994. (memq 'todo org-agenda-show-inherited-tags))
  4995. (and (eq org-agenda-show-inherited-tags t)
  4996. (or (eq org-agenda-use-tag-inheritance t)
  4997. (memq 'todo org-agenda-use-tag-inheritance))))
  4998. tags (org-get-tags-at nil (not inherited-tags))
  4999. level (make-string (org-reduced-level (org-outline-level)) ? )
  5000. txt (org-agenda-format-item "" txt level category tags t)
  5001. priority (1+ (org-get-priority txt)))
  5002. (org-add-props txt props
  5003. 'org-marker marker 'org-hd-marker marker
  5004. 'priority priority 'org-category category
  5005. 'level level
  5006. 'ts-date ts-date
  5007. 'org-category-position category-pos
  5008. 'type (concat "todo" ts-date-type) 'todo-state todo-state)
  5009. (push txt ee)
  5010. (if org-agenda-todo-list-sublevels
  5011. (goto-char todo-state-end-pos)
  5012. (org-end-of-subtree 'invisible))))
  5013. (nreverse ee)))
  5014. (defun org-agenda-todo-custom-ignore-p (time n)
  5015. "Check whether timestamp is farther away than n number of days.
  5016. This function is invoked if `org-agenda-todo-ignore-deadlines',
  5017. `org-agenda-todo-ignore-scheduled' or
  5018. `org-agenda-todo-ignore-timestamp' is set to an integer."
  5019. (let ((days (org-time-stamp-to-now
  5020. time org-agenda-todo-ignore-time-comparison-use-seconds)))
  5021. (if (>= n 0)
  5022. (>= days n)
  5023. (<= days n))))
  5024. ;;;###autoload
  5025. (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  5026. (&optional end)
  5027. "Do we have a reason to ignore this TODO entry because it has a time stamp?"
  5028. (when (or org-agenda-todo-ignore-with-date
  5029. org-agenda-todo-ignore-scheduled
  5030. org-agenda-todo-ignore-deadlines
  5031. org-agenda-todo-ignore-timestamp)
  5032. (setq end (or end (save-excursion (outline-next-heading) (point))))
  5033. (save-excursion
  5034. (or (and org-agenda-todo-ignore-with-date
  5035. (re-search-forward org-ts-regexp end t))
  5036. (and org-agenda-todo-ignore-scheduled
  5037. (re-search-forward org-scheduled-time-regexp end t)
  5038. (cond
  5039. ((eq org-agenda-todo-ignore-scheduled 'future)
  5040. (> (org-time-stamp-to-now
  5041. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5042. ((eq org-agenda-todo-ignore-scheduled 'past)
  5043. (<= (org-time-stamp-to-now
  5044. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5045. ((numberp org-agenda-todo-ignore-scheduled)
  5046. (org-agenda-todo-custom-ignore-p
  5047. (match-string 1) org-agenda-todo-ignore-scheduled))
  5048. (t)))
  5049. (and org-agenda-todo-ignore-deadlines
  5050. (re-search-forward org-deadline-time-regexp end t)
  5051. (cond
  5052. ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
  5053. ((eq org-agenda-todo-ignore-deadlines 'far)
  5054. (not (org-deadline-close (match-string 1))))
  5055. ((eq org-agenda-todo-ignore-deadlines 'future)
  5056. (> (org-time-stamp-to-now
  5057. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5058. ((eq org-agenda-todo-ignore-deadlines 'past)
  5059. (<= (org-time-stamp-to-now
  5060. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5061. ((numberp org-agenda-todo-ignore-deadlines)
  5062. (org-agenda-todo-custom-ignore-p
  5063. (match-string 1) org-agenda-todo-ignore-deadlines))
  5064. (t (org-deadline-close (match-string 1)))))
  5065. (and org-agenda-todo-ignore-timestamp
  5066. (let ((buffer (current-buffer))
  5067. (regexp
  5068. (concat
  5069. org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
  5070. (start (point)))
  5071. ;; Copy current buffer into a temporary one
  5072. (with-temp-buffer
  5073. (insert-buffer-substring buffer start end)
  5074. (goto-char (point-min))
  5075. ;; Delete SCHEDULED and DEADLINE items
  5076. (while (re-search-forward regexp end t)
  5077. (delete-region (match-beginning 0) (match-end 0)))
  5078. (goto-char (point-min))
  5079. ;; No search for timestamp left
  5080. (when (re-search-forward org-ts-regexp nil t)
  5081. (cond
  5082. ((eq org-agenda-todo-ignore-timestamp 'future)
  5083. (> (org-time-stamp-to-now
  5084. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5085. ((eq org-agenda-todo-ignore-timestamp 'past)
  5086. (<= (org-time-stamp-to-now
  5087. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5088. ((numberp org-agenda-todo-ignore-timestamp)
  5089. (org-agenda-todo-custom-ignore-p
  5090. (match-string 1) org-agenda-todo-ignore-timestamp))
  5091. (t))))))))))
  5092. (defun org-agenda-get-timestamps (&optional deadline-results)
  5093. "Return the date stamp information for agenda display."
  5094. (let* ((props (list 'face 'org-agenda-calendar-event
  5095. 'org-not-done-regexp org-not-done-regexp
  5096. 'org-todo-regexp org-todo-regexp
  5097. 'org-complex-heading-regexp org-complex-heading-regexp
  5098. 'mouse-face 'highlight
  5099. 'help-echo
  5100. (format "mouse-2 or RET jump to org file %s"
  5101. (abbreviate-file-name buffer-file-name))))
  5102. (d1 (calendar-absolute-from-gregorian date))
  5103. mm
  5104. (deadline-position-alist
  5105. (mapcar (lambda (a) (and (setq mm (get-text-property
  5106. 0 'org-hd-marker a))
  5107. (cons (marker-position mm) a)))
  5108. deadline-results))
  5109. (remove-re org-ts-regexp)
  5110. (regexp
  5111. (concat
  5112. (if org-agenda-include-inactive-timestamps "[[<]" "<")
  5113. (regexp-quote
  5114. (substring
  5115. (format-time-string
  5116. (car org-time-stamp-formats)
  5117. (apply 'encode-time ; DATE bound by calendar
  5118. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  5119. 1 11))
  5120. "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
  5121. "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
  5122. marker hdmarker deadlinep scheduledp clockp closedp inactivep
  5123. donep tmp priority category category-pos level ee txt timestr tags
  5124. b0 b3 e3 head todo-state end-of-match show-all warntime habitp
  5125. inherited-tags ts-date)
  5126. (goto-char (point-min))
  5127. (while (setq end-of-match (re-search-forward regexp nil t))
  5128. (setq b0 (match-beginning 0)
  5129. b3 (match-beginning 3) e3 (match-end 3)
  5130. todo-state (save-match-data (ignore-errors (org-get-todo-state)))
  5131. habitp (and (functionp 'org-is-habit-p) (save-match-data (org-is-habit-p)))
  5132. show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  5133. (member todo-state
  5134. org-agenda-repeating-timestamp-show-all)))
  5135. (catch :skip
  5136. (and (org-at-date-range-p) (throw :skip nil))
  5137. (org-agenda-skip)
  5138. (if (and (match-end 1)
  5139. (not (= d1 (org-time-string-to-absolute
  5140. (match-string 1) d1 nil show-all
  5141. (current-buffer) b0))))
  5142. (throw :skip nil))
  5143. (if (and e3
  5144. (not (org-diary-sexp-entry (buffer-substring b3 e3) "" date)))
  5145. (throw :skip nil))
  5146. (setq tmp (buffer-substring (max (point-min)
  5147. (- b0 org-ds-keyword-length))
  5148. b0)
  5149. timestr (if b3 "" (buffer-substring b0 (point-at-eol)))
  5150. inactivep (= (char-after b0) ?\[)
  5151. deadlinep (string-match org-deadline-regexp tmp)
  5152. scheduledp (string-match org-scheduled-regexp tmp)
  5153. closedp (and org-agenda-include-inactive-timestamps
  5154. (string-match org-closed-string tmp))
  5155. clockp (and org-agenda-include-inactive-timestamps
  5156. (or (string-match org-clock-string tmp)
  5157. (string-match "]-+\\'" tmp)))
  5158. warntime (get-text-property (point) 'org-appt-warntime)
  5159. donep (member todo-state org-done-keywords))
  5160. (if (or scheduledp deadlinep closedp clockp
  5161. (and donep org-agenda-skip-timestamp-if-done))
  5162. (throw :skip t))
  5163. (if (string-match ">" timestr)
  5164. ;; substring should only run to end of time stamp
  5165. (setq timestr (substring timestr 0 (match-end 0))))
  5166. (setq marker (org-agenda-new-marker b0)
  5167. category (org-get-category b0)
  5168. category-pos (get-text-property b0 'org-category-position))
  5169. (save-excursion
  5170. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5171. (throw :skip nil)
  5172. (goto-char (match-beginning 0))
  5173. (if (and (eq t org-agenda-skip-timestamp-if-deadline-is-shown)
  5174. (assoc (point) deadline-position-alist))
  5175. (throw :skip nil))
  5176. (setq hdmarker (org-agenda-new-marker)
  5177. inherited-tags
  5178. (or (eq org-agenda-show-inherited-tags 'always)
  5179. (and (listp org-agenda-show-inherited-tags)
  5180. (memq 'agenda org-agenda-show-inherited-tags))
  5181. (and (eq org-agenda-show-inherited-tags t)
  5182. (or (eq org-agenda-use-tag-inheritance t)
  5183. (memq 'agenda org-agenda-use-tag-inheritance))))
  5184. tags (org-get-tags-at nil (not inherited-tags))
  5185. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5186. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5187. (setq head (or (match-string 1) ""))
  5188. (setq txt (org-agenda-format-item
  5189. (if inactivep org-agenda-inactive-leader nil)
  5190. head level category tags timestr
  5191. remove-re habitp)))
  5192. (setq priority (org-get-priority txt))
  5193. (org-add-props txt props 'priority priority
  5194. 'org-marker marker 'org-hd-marker hdmarker
  5195. 'org-category category 'date date
  5196. 'level level
  5197. 'ts-date
  5198. (ignore-errors (org-time-string-to-absolute timestr))
  5199. 'org-category-position category-pos
  5200. 'todo-state todo-state
  5201. 'warntime warntime
  5202. 'type "timestamp")
  5203. (push txt ee))
  5204. (if org-agenda-skip-additional-timestamps-same-entry
  5205. (outline-next-heading)
  5206. (goto-char end-of-match))))
  5207. (nreverse ee)))
  5208. (defun org-agenda-get-sexps ()
  5209. "Return the sexp information for agenda display."
  5210. (require 'diary-lib)
  5211. (let* ((props (list 'face 'org-agenda-calendar-sexp
  5212. 'mouse-face 'highlight
  5213. 'help-echo
  5214. (format "mouse-2 or RET jump to org file %s"
  5215. (abbreviate-file-name buffer-file-name))))
  5216. (regexp "^&?%%(")
  5217. marker category extra category-pos level ee txt tags entry
  5218. result beg b sexp sexp-entry todo-state warntime inherited-tags)
  5219. (goto-char (point-min))
  5220. (while (re-search-forward regexp nil t)
  5221. (catch :skip
  5222. (org-agenda-skip)
  5223. (setq beg (match-beginning 0))
  5224. (goto-char (1- (match-end 0)))
  5225. (setq b (point))
  5226. (forward-sexp 1)
  5227. (setq sexp (buffer-substring b (point)))
  5228. (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
  5229. (org-trim (match-string 1))
  5230. ""))
  5231. (setq result (org-diary-sexp-entry sexp sexp-entry date))
  5232. (when result
  5233. (setq marker (org-agenda-new-marker beg)
  5234. level (make-string (org-reduced-level (org-outline-level)) ? )
  5235. category (org-get-category beg)
  5236. category-pos (get-text-property beg 'org-category-position)
  5237. inherited-tags
  5238. (or (eq org-agenda-show-inherited-tags 'always)
  5239. (and (listp org-agenda-show-inherited-tags)
  5240. (memq 'agenda org-agenda-show-inherited-tags))
  5241. (and (eq org-agenda-show-inherited-tags t)
  5242. (or (eq org-agenda-use-tag-inheritance t)
  5243. (memq 'agenda org-agenda-use-tag-inheritance))))
  5244. tags (org-get-tags-at nil (not inherited-tags))
  5245. todo-state (org-get-todo-state)
  5246. warntime (get-text-property (point) 'org-appt-warntime)
  5247. extra nil)
  5248. (dolist (r (if (stringp result)
  5249. (list result)
  5250. result)) ;; we expect a list here
  5251. (when (and org-agenda-diary-sexp-prefix
  5252. (string-match org-agenda-diary-sexp-prefix r))
  5253. (setq extra (match-string 0 r)
  5254. r (replace-match "" nil nil r)))
  5255. (if (string-match "\\S-" r)
  5256. (setq txt r)
  5257. (setq txt "SEXP entry returned empty string"))
  5258. (setq txt (org-agenda-format-item extra txt level category tags 'time))
  5259. (org-add-props txt props 'org-marker marker
  5260. 'org-category category 'date date 'todo-state todo-state
  5261. 'org-category-position category-pos 'tags tags
  5262. 'level level
  5263. '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. ;; Normally I would like to use ISO format when calling the diary functions,
  5269. ;; but to make sure we still have Emacs 22 compatibility we bind
  5270. ;; also `european-calendar-style' and use european format
  5271. (defun org-anniversary (year month day &optional mark)
  5272. "Like `diary-anniversary', but with fixed (ISO) order of arguments."
  5273. (org-no-warnings
  5274. (let ((calendar-date-style 'european) (european-calendar-style t))
  5275. (diary-anniversary day month year mark))))
  5276. (defun org-cyclic (N year month day &optional mark)
  5277. "Like `diary-cyclic', but with fixed (ISO) order of arguments."
  5278. (org-no-warnings
  5279. (let ((calendar-date-style 'european) (european-calendar-style t))
  5280. (diary-cyclic N day month year mark))))
  5281. (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
  5282. "Like `diary-block', but with fixed (ISO) order of arguments."
  5283. (org-no-warnings
  5284. (let ((calendar-date-style 'european) (european-calendar-style t))
  5285. (diary-block D1 M1 Y1 D2 M2 Y2 mark))))
  5286. (defun org-date (year month day &optional mark)
  5287. "Like `diary-date', but with fixed (ISO) order of arguments."
  5288. (org-no-warnings
  5289. (let ((calendar-date-style 'european) (european-calendar-style t))
  5290. (diary-date day month year mark))))
  5291. ;; Define the` org-class' function
  5292. (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
  5293. "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
  5294. DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
  5295. SKIP-WEEKS is any number of ISO weeks in the block period for which the
  5296. item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
  5297. `holidays', then any date that is known by the Emacs calendar to be a
  5298. holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
  5299. then those holidays will be skipped."
  5300. (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
  5301. (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
  5302. (d (calendar-absolute-from-gregorian date))
  5303. (h (when skip-weeks (calendar-check-holidays date))))
  5304. (and
  5305. (<= date1 d)
  5306. (<= d date2)
  5307. (= (calendar-day-of-week date) dayname)
  5308. (or (not skip-weeks)
  5309. (progn
  5310. (require 'cal-iso)
  5311. (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
  5312. (not (or (and h (memq 'holidays skip-weeks))
  5313. (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
  5314. entry)))
  5315. (defun org-diary-class (m1 d1 y1 m2 d2 y2 dayname &rest skip-weeks)
  5316. "Like `org-class', but honor `calendar-date-style'.
  5317. The order of the first 2 times 3 arguments depends on the variable
  5318. `calendar-date-style' or, if that is not defined, on `european-calendar-style'.
  5319. So for American calendars, give this as MONTH DAY YEAR, for European as
  5320. DAY MONTH YEAR, and for ISO as YEAR MONTH DAY.
  5321. DAYNAME is a number between 0 (Sunday) and 6 (Saturday). SKIP-WEEKS
  5322. is any number of ISO weeks in the block period for which the item should
  5323. be skipped.
  5324. This function is here only for backward compatibility and it is deprecated,
  5325. please use `org-class' instead."
  5326. (let* ((date1 (org-order-calendar-date-args m1 d1 y1))
  5327. (date2 (org-order-calendar-date-args m2 d2 y2)))
  5328. (org-class
  5329. (nth 2 date1) (car date1) (nth 1 date1)
  5330. (nth 2 date2) (car date2) (nth 1 date2)
  5331. dayname skip-weeks)))
  5332. (make-obsolete 'org-diary-class 'org-class "")
  5333. (defalias 'org-get-closed 'org-agenda-get-progress)
  5334. (defun org-agenda-get-progress ()
  5335. "Return the logged TODO entries for agenda display."
  5336. (let* ((props (list 'mouse-face 'highlight
  5337. 'org-not-done-regexp org-not-done-regexp
  5338. 'org-todo-regexp org-todo-regexp
  5339. 'org-complex-heading-regexp org-complex-heading-regexp
  5340. 'help-echo
  5341. (format "mouse-2 or RET jump to org file %s"
  5342. (abbreviate-file-name buffer-file-name))))
  5343. (items (if (consp org-agenda-show-log-scoped)
  5344. org-agenda-show-log-scoped
  5345. (if (eq org-agenda-show-log-scoped 'clockcheck)
  5346. '(clock)
  5347. org-agenda-log-mode-items)))
  5348. (parts
  5349. (delq nil
  5350. (list
  5351. (if (memq 'closed items) (concat "\\<" org-closed-string))
  5352. (if (memq 'clock items) (concat "\\<" org-clock-string))
  5353. (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
  5354. (parts-re (if parts (mapconcat 'identity parts "\\|")
  5355. (error "`org-agenda-log-mode-items' is empty")))
  5356. (regexp (concat
  5357. "\\(" parts-re "\\)"
  5358. " *\\["
  5359. (regexp-quote
  5360. (substring
  5361. (format-time-string
  5362. (car org-time-stamp-formats)
  5363. (apply 'encode-time ; DATE bound by calendar
  5364. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  5365. 1 11))))
  5366. (org-agenda-search-headline-for-time nil)
  5367. marker hdmarker priority category category-pos level tags closedp
  5368. statep clockp state ee txt extra timestr rest clocked inherited-tags)
  5369. (goto-char (point-min))
  5370. (while (re-search-forward regexp nil t)
  5371. (catch :skip
  5372. (org-agenda-skip)
  5373. (setq marker (org-agenda-new-marker (match-beginning 0))
  5374. closedp (equal (match-string 1) org-closed-string)
  5375. statep (equal (string-to-char (match-string 1)) ?-)
  5376. clockp (not (or closedp statep))
  5377. state (and statep (match-string 2))
  5378. category (org-get-category (match-beginning 0))
  5379. category-pos (get-text-property (match-beginning 0) 'org-category-position)
  5380. timestr (buffer-substring (match-beginning 0) (point-at-eol)))
  5381. (when (string-match "\\]" timestr)
  5382. ;; substring should only run to end of time stamp
  5383. (setq rest (substring timestr (match-end 0))
  5384. timestr (substring timestr 0 (match-end 0)))
  5385. (if (and (not closedp) (not statep)
  5386. (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
  5387. rest))
  5388. (progn (setq timestr (concat (substring timestr 0 -1)
  5389. "-" (match-string 1 rest) "]"))
  5390. (setq clocked (match-string 2 rest)))
  5391. (setq clocked "-")))
  5392. (save-excursion
  5393. (setq extra
  5394. (cond
  5395. ((not org-agenda-log-mode-add-notes) nil)
  5396. (statep
  5397. (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
  5398. (match-string 1)))
  5399. (clockp
  5400. (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
  5401. (match-string 1)))))
  5402. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5403. (throw :skip nil)
  5404. (goto-char (match-beginning 0))
  5405. (setq hdmarker (org-agenda-new-marker)
  5406. inherited-tags
  5407. (or (eq org-agenda-show-inherited-tags 'always)
  5408. (and (listp org-agenda-show-inherited-tags)
  5409. (memq 'todo org-agenda-show-inherited-tags))
  5410. (and (eq org-agenda-show-inherited-tags t)
  5411. (or (eq org-agenda-use-tag-inheritance t)
  5412. (memq 'todo org-agenda-use-tag-inheritance))))
  5413. tags (org-get-tags-at nil (not inherited-tags))
  5414. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5415. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5416. (setq txt (match-string 1))
  5417. (when extra
  5418. (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
  5419. (setq txt (concat (substring txt 0 (match-beginning 1))
  5420. " - " extra " " (match-string 2 txt)))
  5421. (setq txt (concat txt " - " extra))))
  5422. (setq txt (org-agenda-format-item
  5423. (cond
  5424. (closedp "Closed: ")
  5425. (statep (concat "State: (" state ")"))
  5426. (t (concat "Clocked: (" clocked ")")))
  5427. txt level category tags timestr)))
  5428. (setq priority 100000)
  5429. (org-add-props txt props
  5430. 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
  5431. 'priority priority 'org-category category
  5432. 'org-category-position category-pos
  5433. 'level level
  5434. 'type "closed" 'date date
  5435. 'undone-face 'org-warning 'done-face 'org-agenda-done)
  5436. (push txt ee))
  5437. (goto-char (point-at-eol))))
  5438. (nreverse ee)))
  5439. (defun org-agenda-show-clocking-issues ()
  5440. "Add overlays, showing issues with clocking.
  5441. See also the user option `org-agenda-clock-consistency-checks'."
  5442. (interactive)
  5443. (let* ((org-time-clocksum-use-effort-durations nil)
  5444. (pl org-agenda-clock-consistency-checks)
  5445. (re (concat "^[ \t]*"
  5446. org-clock-string
  5447. "[ \t]+"
  5448. "\\(\\[.*?\\]\\)" ; group 1 is first stamp
  5449. "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
  5450. (tlstart 0.)
  5451. (tlend 0.)
  5452. (maxtime (org-hh:mm-string-to-minutes
  5453. (or (plist-get pl :max-duration) "24:00")))
  5454. (mintime (org-hh:mm-string-to-minutes
  5455. (or (plist-get pl :min-duration) 0)))
  5456. (maxgap (org-hh:mm-string-to-minutes
  5457. ;; default 30:00 means never complain
  5458. (or (plist-get pl :max-gap) "30:00")))
  5459. (gapok (mapcar 'org-hh:mm-string-to-minutes
  5460. (plist-get pl :gap-ok-around)))
  5461. (def-face (or (plist-get pl :default-face)
  5462. '((:background "DarkRed") (:foreground "white"))))
  5463. issue face m te ts dt ov)
  5464. (goto-char (point-min))
  5465. (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
  5466. (setq issue nil face def-face)
  5467. (catch 'next
  5468. (setq m (org-get-at-bol 'org-marker)
  5469. te nil ts nil)
  5470. (unless (and m (markerp m))
  5471. (setq issue "No valid clock line") (throw 'next t))
  5472. (org-with-point-at m
  5473. (save-excursion
  5474. (goto-char (point-at-bol))
  5475. (unless (looking-at re)
  5476. (error "No valid Clock line")
  5477. (throw 'next t))
  5478. (unless (match-end 3)
  5479. (setq issue "No end time"
  5480. face (or (plist-get pl :no-end-time-face) face))
  5481. (throw 'next t))
  5482. (setq ts (match-string 1)
  5483. te (match-string 3)
  5484. ts (org-float-time
  5485. (apply 'encode-time (org-parse-time-string ts)))
  5486. te (org-float-time
  5487. (apply 'encode-time (org-parse-time-string te)))
  5488. dt (- te ts))))
  5489. (cond
  5490. ((> dt (* 60 maxtime))
  5491. ;; a very long clocking chunk
  5492. (setq issue (format "Clocking interval is very long: %s"
  5493. (org-minutes-to-clocksum-string
  5494. (floor (/ (float dt) 60.))))
  5495. face (or (plist-get pl :long-face) face)))
  5496. ((< dt (* 60 mintime))
  5497. ;; a very short clocking chunk
  5498. (setq issue (format "Clocking interval is very short: %s"
  5499. (org-minutes-to-clocksum-string
  5500. (floor (/ (float dt) 60.))))
  5501. face (or (plist-get pl :short-face) face)))
  5502. ((and (> tlend 0) (< ts tlend))
  5503. ;; Two clock entries are overlapping
  5504. (setq issue (format "Clocking overlap: %d minutes"
  5505. (/ (- tlend ts) 60))
  5506. face (or (plist-get pl :overlap-face) face)))
  5507. ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
  5508. ;; There is a gap, lets see if we need to report it
  5509. (unless (org-agenda-check-clock-gap tlend ts gapok)
  5510. (setq issue (format "Clocking gap: %d minutes"
  5511. (/ (- ts tlend) 60))
  5512. face (or (plist-get pl :gap-face) face))))
  5513. (t nil)))
  5514. (setq tlend (or te tlend) tlstart (or ts tlstart))
  5515. (when issue
  5516. ;; OK, there was some issue, add an overlay to show the issue
  5517. (setq ov (make-overlay (point-at-bol) (point-at-eol)))
  5518. (overlay-put ov 'before-string
  5519. (concat
  5520. (org-add-props
  5521. (format "%-43s" (concat " " issue))
  5522. nil
  5523. 'face face)
  5524. "\n"))
  5525. (overlay-put ov 'evaporate t)))))
  5526. (defun org-agenda-check-clock-gap (t1 t2 ok-list)
  5527. "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
  5528. (catch 'exit
  5529. (unless ok-list
  5530. ;; there are no OK times for gaps...
  5531. (throw 'exit nil))
  5532. (if (> (- (/ t2 36000) (/ t1 36000)) 24)
  5533. ;; This is more than 24 hours, so it is OK.
  5534. ;; because we have at least one OK time, that must be in the
  5535. ;; 24 hour interval.
  5536. (throw 'exit t))
  5537. ;; We have a shorter gap.
  5538. ;; Now we have to get the minute of the day when these times are
  5539. (let* ((t1dec (decode-time (seconds-to-time t1)))
  5540. (t2dec (decode-time (seconds-to-time t2)))
  5541. ;; compute the minute on the day
  5542. (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
  5543. (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
  5544. (when (< min2 min1)
  5545. ;; if min2 is smaller than min1, this means it is on the next day.
  5546. ;; Wrap it to after midnight.
  5547. (setq min2 (+ min2 1440)))
  5548. ;; Now check if any of the OK times is in the gap
  5549. (mapc (lambda (x)
  5550. ;; Wrap the time to after midnight if necessary
  5551. (if (< x min1) (setq x (+ x 1440)))
  5552. ;; Check if in interval
  5553. (and (<= min1 x) (>= min2 x) (throw 'exit t)))
  5554. ok-list)
  5555. ;; Nope, this gap is not OK
  5556. nil)))
  5557. (defun org-agenda-get-deadlines (&optional with-hour)
  5558. "Return the deadline information for agenda display.
  5559. When WITH-HOUR is non-nil, only return deadlines with an hour
  5560. specification like [h]h:mm."
  5561. (let* ((props (list 'mouse-face 'highlight
  5562. 'org-not-done-regexp org-not-done-regexp
  5563. 'org-todo-regexp org-todo-regexp
  5564. 'org-complex-heading-regexp org-complex-heading-regexp
  5565. 'help-echo
  5566. (format "mouse-2 or RET jump to org file %s"
  5567. (abbreviate-file-name buffer-file-name))))
  5568. (regexp (if with-hour
  5569. org-deadline-time-hour-regexp
  5570. org-deadline-time-regexp))
  5571. (todayp (org-agenda-todayp date)) ; DATE bound by calendar
  5572. (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
  5573. (dl0 (car org-agenda-deadline-leaders))
  5574. (dl1 (nth 1 org-agenda-deadline-leaders))
  5575. (dl2 (or (nth 2 org-agenda-deadline-leaders) dl1))
  5576. d2 diff dfrac wdays pos pos1 category category-pos level
  5577. tags suppress-prewarning ee txt head face s todo-state
  5578. show-all upcomingp donep timestr warntime inherited-tags ts-date)
  5579. (goto-char (point-min))
  5580. (while (re-search-forward regexp nil t)
  5581. (catch :skip
  5582. (org-agenda-skip)
  5583. (setq s (match-string 1)
  5584. txt nil
  5585. pos (1- (match-beginning 1))
  5586. todo-state (save-match-data (org-get-todo-state))
  5587. show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  5588. (member todo-state
  5589. org-agenda-repeating-timestamp-show-all))
  5590. d2 (org-time-string-to-absolute
  5591. s d1 'past show-all (current-buffer) pos)
  5592. diff (- d2 d1))
  5593. (setq suppress-prewarning
  5594. (let ((ds (and org-agenda-skip-deadline-prewarning-if-scheduled
  5595. (let ((item (buffer-substring (point-at-bol)
  5596. (point-at-eol))))
  5597. (save-match-data
  5598. (and (string-match
  5599. org-scheduled-time-regexp item)
  5600. (match-string 1 item)))))))
  5601. (cond
  5602. ((not ds) nil)
  5603. ;; The current item has a scheduled date (in ds), so
  5604. ;; evaluate its prewarning lead time.
  5605. ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
  5606. ;; Use global prewarning-restart lead time.
  5607. org-agenda-skip-deadline-prewarning-if-scheduled)
  5608. ((eq org-agenda-skip-deadline-prewarning-if-scheduled
  5609. 'pre-scheduled)
  5610. ;; Set prewarning to no earlier than scheduled.
  5611. (min (- d2 (org-time-string-to-absolute
  5612. ds d1 'past show-all (current-buffer) pos))
  5613. org-deadline-warning-days))
  5614. ;; Set prewarning to deadline.
  5615. (t 0))))
  5616. (setq wdays (if suppress-prewarning
  5617. (let ((org-deadline-warning-days suppress-prewarning))
  5618. (org-get-wdays s))
  5619. (org-get-wdays s))
  5620. dfrac (- 1 (/ (* 1.0 diff) (max wdays 1)))
  5621. upcomingp (and todayp (> diff 0)))
  5622. ;; When to show a deadline in the calendar:
  5623. ;; If the expiration is within wdays warning time.
  5624. ;; Past-due deadlines are only shown on the current date
  5625. (if (and (or (and (<= diff wdays)
  5626. (and todayp (not org-agenda-only-exact-dates)))
  5627. (= diff 0)))
  5628. (save-excursion
  5629. ;; (setq todo-state (org-get-todo-state))
  5630. (setq donep (member todo-state org-done-keywords))
  5631. (if (and donep
  5632. (or org-agenda-skip-deadline-if-done
  5633. (not (= diff 0))))
  5634. (setq txt nil)
  5635. (setq category (org-get-category)
  5636. warntime (get-text-property (point) 'org-appt-warntime)
  5637. category-pos (get-text-property (point) 'org-category-position))
  5638. (if (not (re-search-backward "^\\*+[ \t]+" nil t))
  5639. (throw :skip nil)
  5640. (goto-char (match-end 0))
  5641. (setq pos1 (match-beginning 0))
  5642. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  5643. (setq inherited-tags
  5644. (or (eq org-agenda-show-inherited-tags 'always)
  5645. (and (listp org-agenda-show-inherited-tags)
  5646. (memq 'agenda org-agenda-show-inherited-tags))
  5647. (and (eq org-agenda-show-inherited-tags t)
  5648. (or (eq org-agenda-use-tag-inheritance t)
  5649. (memq 'agenda org-agenda-use-tag-inheritance))))
  5650. tags (org-get-tags-at pos1 (not inherited-tags)))
  5651. (setq head (buffer-substring
  5652. (point)
  5653. (progn (skip-chars-forward "^\r\n")
  5654. (point))))
  5655. (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5656. (setq timestr
  5657. (concat (substring s (match-beginning 1)) " "))
  5658. (setq timestr 'time))
  5659. (setq txt (org-agenda-format-item
  5660. (cond ((= diff 0) dl0)
  5661. ((> diff 0)
  5662. (if (functionp dl1)
  5663. (funcall dl1 diff date)
  5664. (format dl1 diff)))
  5665. (t
  5666. (if (functionp dl2)
  5667. (funcall dl2 diff date)
  5668. (format dl2 (if (string= dl2 dl1)
  5669. diff (abs diff))))))
  5670. head level category tags
  5671. (if (not (= diff 0)) nil timestr)))))
  5672. (when txt
  5673. (setq face (org-agenda-deadline-face dfrac))
  5674. (org-add-props txt props
  5675. 'org-marker (org-agenda-new-marker pos)
  5676. 'warntime warntime
  5677. 'level level
  5678. 'ts-date d2
  5679. 'org-hd-marker (org-agenda-new-marker pos1)
  5680. 'priority (+ (- diff)
  5681. (org-get-priority txt))
  5682. 'org-category category
  5683. 'org-category-position category-pos
  5684. 'todo-state todo-state
  5685. 'type (if upcomingp "upcoming-deadline" "deadline")
  5686. 'date (if upcomingp date d2)
  5687. 'face (if donep 'org-agenda-done face)
  5688. 'undone-face face 'done-face 'org-agenda-done)
  5689. (push txt ee))))))
  5690. (nreverse ee)))
  5691. (defun org-agenda-deadline-face (fraction)
  5692. "Return the face to displaying a deadline item.
  5693. FRACTION is what fraction of the head-warning time has passed."
  5694. (let ((faces org-agenda-deadline-faces) f)
  5695. (catch 'exit
  5696. (while (setq f (pop faces))
  5697. (if (>= fraction (car f)) (throw 'exit (cdr f)))))))
  5698. (defun org-agenda-get-scheduled (&optional deadline-results with-hour)
  5699. "Return the scheduled information for agenda display.
  5700. When WITH-HOUR is non-nil, only return scheduled items with
  5701. an hour specification like [h]h:mm."
  5702. (let* ((props (list 'org-not-done-regexp org-not-done-regexp
  5703. 'org-todo-regexp org-todo-regexp
  5704. 'org-complex-heading-regexp org-complex-heading-regexp
  5705. 'done-face 'org-agenda-done
  5706. 'mouse-face 'highlight
  5707. 'help-echo
  5708. (format "mouse-2 or RET jump to org file %s"
  5709. (abbreviate-file-name buffer-file-name))))
  5710. (regexp (if with-hour
  5711. org-scheduled-time-hour-regexp
  5712. org-scheduled-time-regexp))
  5713. (todayp (org-agenda-todayp date)) ; DATE bound by calendar
  5714. (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
  5715. mm
  5716. (deadline-position-alist
  5717. (mapcar (lambda (a) (and (setq mm (get-text-property
  5718. 0 'org-hd-marker a))
  5719. (cons (marker-position mm) a)))
  5720. deadline-results))
  5721. d2 diff pos pos1 category category-pos level tags donep
  5722. ee txt head pastschedp todo-state face timestr s habitp show-all
  5723. did-habit-check-p warntime inherited-tags ts-date suppress-delay
  5724. ddays)
  5725. (goto-char (point-min))
  5726. (while (re-search-forward regexp nil t)
  5727. (catch :skip
  5728. (org-agenda-skip)
  5729. (setq s (match-string 1)
  5730. txt nil
  5731. pos (1- (match-beginning 1))
  5732. todo-state (save-match-data (org-get-todo-state))
  5733. show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  5734. (member todo-state
  5735. org-agenda-repeating-timestamp-show-all))
  5736. d2 (org-time-string-to-absolute
  5737. s d1 'past show-all (current-buffer) pos)
  5738. diff (- d2 d1)
  5739. warntime (get-text-property (point) 'org-appt-warntime))
  5740. (setq pastschedp (and todayp (< diff 0)))
  5741. (setq did-habit-check-p nil)
  5742. (setq suppress-delay
  5743. (let ((ds (and org-agenda-skip-scheduled-delay-if-deadline
  5744. (let ((item (buffer-substring (point-at-bol) (point-at-eol))))
  5745. (save-match-data
  5746. (and (string-match
  5747. org-deadline-time-regexp item)
  5748. (match-string 1 item)))))))
  5749. (cond
  5750. ((not ds) nil)
  5751. ;; The current item has a deadline date (in ds), so
  5752. ;; evaluate its delay time.
  5753. ((integerp org-agenda-skip-scheduled-delay-if-deadline)
  5754. ;; Use global delay time.
  5755. (- org-agenda-skip-scheduled-delay-if-deadline))
  5756. ((eq org-agenda-skip-scheduled-delay-if-deadline
  5757. 'post-deadline)
  5758. ;; Set delay to no later than deadline.
  5759. (min (- d2 (org-time-string-to-absolute
  5760. ds d1 'past show-all (current-buffer) pos))
  5761. org-scheduled-delay-days))
  5762. (t 0))))
  5763. (setq ddays (if suppress-delay
  5764. (let ((org-scheduled-delay-days suppress-delay))
  5765. (org-get-wdays s t t))
  5766. (org-get-wdays s t)))
  5767. ;; Use a delay of 0 when there is a repeater and the delay is
  5768. ;; of the form --3d
  5769. (when (and (save-match-data (string-match "--[0-9]+[hdwmy]" s))
  5770. (< (org-time-string-to-absolute s)
  5771. (org-time-string-to-absolute
  5772. s d2 'past nil (current-buffer) pos)))
  5773. (setq ddays 0))
  5774. ;; When to show a scheduled item in the calendar:
  5775. ;; If it is on or past the date.
  5776. (when (or (and (> ddays 0) (= diff (- ddays)))
  5777. (and (zerop ddays) (= diff 0))
  5778. (and (< (+ diff ddays) 0)
  5779. (< (abs diff) org-scheduled-past-days)
  5780. (and todayp (not org-agenda-only-exact-dates)))
  5781. ;; org-is-habit-p uses org-entry-get, which is expansive
  5782. ;; so we go extra mile to only call it once
  5783. (and todayp
  5784. (boundp 'org-habit-show-all-today)
  5785. org-habit-show-all-today
  5786. (setq did-habit-check-p t)
  5787. (setq habitp (and (functionp 'org-is-habit-p)
  5788. (org-is-habit-p)))))
  5789. (save-excursion
  5790. (setq donep (member todo-state org-done-keywords))
  5791. (if (and donep
  5792. (or org-agenda-skip-scheduled-if-done
  5793. (not (= diff 0))
  5794. (and (functionp 'org-is-habit-p)
  5795. (org-is-habit-p))))
  5796. (setq txt nil)
  5797. (setq habitp (if did-habit-check-p habitp
  5798. (and (functionp 'org-is-habit-p)
  5799. (org-is-habit-p))))
  5800. (setq category (org-get-category)
  5801. category-pos (get-text-property (point) 'org-category-position))
  5802. (if (and (eq org-agenda-skip-scheduled-if-deadline-is-shown
  5803. 'repeated-after-deadline)
  5804. (<= 0 (- d2 (time-to-days (org-get-deadline-time (point))))))
  5805. (throw :skip nil))
  5806. (if (not (re-search-backward "^\\*+[ \t]+" nil t))
  5807. (throw :skip nil)
  5808. (goto-char (match-end 0))
  5809. (setq pos1 (match-beginning 0))
  5810. (if habitp
  5811. (if (or (not org-habit-show-habits)
  5812. (and (not todayp)
  5813. (boundp 'org-habit-show-habits-only-for-today)
  5814. org-habit-show-habits-only-for-today))
  5815. (throw :skip nil))
  5816. (if (and
  5817. (or (eq t org-agenda-skip-scheduled-if-deadline-is-shown)
  5818. (and (eq org-agenda-skip-scheduled-if-deadline-is-shown 'not-today)
  5819. pastschedp))
  5820. (setq mm (assoc pos1 deadline-position-alist)))
  5821. (throw :skip nil)))
  5822. (setq inherited-tags
  5823. (or (eq org-agenda-show-inherited-tags 'always)
  5824. (and (listp org-agenda-show-inherited-tags)
  5825. (memq 'agenda org-agenda-show-inherited-tags))
  5826. (and (eq org-agenda-show-inherited-tags t)
  5827. (or (eq org-agenda-use-tag-inheritance t)
  5828. (memq 'agenda org-agenda-use-tag-inheritance))))
  5829. tags (org-get-tags-at nil (not inherited-tags)))
  5830. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  5831. (setq head (buffer-substring
  5832. (point)
  5833. (progn (skip-chars-forward "^\r\n") (point))))
  5834. (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5835. (setq timestr
  5836. (concat (substring s (match-beginning 1)) " "))
  5837. (setq timestr 'time))
  5838. (setq txt (org-agenda-format-item
  5839. (if (= diff 0)
  5840. (car org-agenda-scheduled-leaders)
  5841. (format (nth 1 org-agenda-scheduled-leaders)
  5842. (- 1 diff)))
  5843. head level category tags
  5844. (if (not (= diff 0)) nil timestr)
  5845. nil habitp))))
  5846. (when txt
  5847. (setq face
  5848. (cond
  5849. ((and (not habitp) pastschedp)
  5850. 'org-scheduled-previously)
  5851. (todayp 'org-scheduled-today)
  5852. (t 'org-scheduled))
  5853. habitp (and habitp (org-habit-parse-todo)))
  5854. (org-add-props txt props
  5855. 'undone-face face
  5856. 'face (if donep 'org-agenda-done face)
  5857. 'org-marker (org-agenda-new-marker pos)
  5858. 'org-hd-marker (org-agenda-new-marker pos1)
  5859. 'type (if pastschedp "past-scheduled" "scheduled")
  5860. 'date (if pastschedp d2 date)
  5861. 'ts-date d2
  5862. 'warntime warntime
  5863. 'level level
  5864. 'priority (if habitp
  5865. (org-habit-get-priority habitp)
  5866. (+ 94 (- 5 diff) (org-get-priority txt)))
  5867. 'org-category category
  5868. 'category-position category-pos
  5869. 'org-habit-p habitp
  5870. 'todo-state todo-state)
  5871. (push txt ee))))))
  5872. (nreverse ee)))
  5873. (defun org-agenda-get-blocks ()
  5874. "Return the date-range information for agenda display."
  5875. (let* ((props (list 'face nil
  5876. 'org-not-done-regexp org-not-done-regexp
  5877. 'org-todo-regexp org-todo-regexp
  5878. 'org-complex-heading-regexp org-complex-heading-regexp
  5879. 'mouse-face 'highlight
  5880. 'help-echo
  5881. (format "mouse-2 or RET jump to org file %s"
  5882. (abbreviate-file-name buffer-file-name))))
  5883. (regexp org-tr-regexp)
  5884. (d0 (calendar-absolute-from-gregorian date))
  5885. marker hdmarker ee txt d1 d2 s1 s2 category category-pos
  5886. level todo-state tags pos head donep inherited-tags)
  5887. (goto-char (point-min))
  5888. (while (re-search-forward regexp nil t)
  5889. (catch :skip
  5890. (org-agenda-skip)
  5891. (setq pos (point))
  5892. (let ((start-time (match-string 1))
  5893. (end-time (match-string 2)))
  5894. (setq s1 (match-string 1)
  5895. s2 (match-string 2)
  5896. d1 (time-to-days (org-time-string-to-time s1 (current-buffer) pos))
  5897. d2 (time-to-days (org-time-string-to-time s2 (current-buffer) pos)))
  5898. (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
  5899. ;; Only allow days between the limits, because the normal
  5900. ;; date stamps will catch the limits.
  5901. (save-excursion
  5902. (setq todo-state (org-get-todo-state))
  5903. (setq donep (member todo-state org-done-keywords))
  5904. (if (and donep org-agenda-skip-timestamp-if-done)
  5905. (throw :skip t))
  5906. (setq marker (org-agenda-new-marker (point)))
  5907. (setq category (org-get-category)
  5908. category-pos (get-text-property (point) 'org-category-position))
  5909. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5910. (throw :skip nil)
  5911. (goto-char (match-beginning 0))
  5912. (setq hdmarker (org-agenda-new-marker (point))
  5913. inherited-tags
  5914. (or (eq org-agenda-show-inherited-tags 'always)
  5915. (and (listp org-agenda-show-inherited-tags)
  5916. (memq 'agenda org-agenda-show-inherited-tags))
  5917. (and (eq org-agenda-show-inherited-tags t)
  5918. (or (eq org-agenda-use-tag-inheritance t)
  5919. (memq 'agenda org-agenda-use-tag-inheritance))))
  5920. tags (org-get-tags-at nil (not inherited-tags)))
  5921. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  5922. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5923. (setq head (match-string 1))
  5924. (let ((remove-re
  5925. (if org-agenda-remove-timeranges-from-blocks
  5926. (concat
  5927. "<" (regexp-quote s1) ".*?>"
  5928. "--"
  5929. "<" (regexp-quote s2) ".*?>")
  5930. nil)))
  5931. (setq txt (org-agenda-format-item
  5932. (format
  5933. (nth (if (= d1 d2) 0 1)
  5934. org-agenda-timerange-leaders)
  5935. (1+ (- d0 d1)) (1+ (- d2 d1)))
  5936. head level category tags
  5937. (cond ((and (= d1 d0) (= d2 d0))
  5938. (concat "<" start-time ">--<" end-time ">"))
  5939. ((= d1 d0)
  5940. (concat "<" start-time ">"))
  5941. ((= d2 d0)
  5942. (concat "<" end-time ">")))
  5943. remove-re))))
  5944. (org-add-props txt props
  5945. 'org-marker marker 'org-hd-marker hdmarker
  5946. 'type "block" 'date date
  5947. 'level level
  5948. 'todo-state todo-state
  5949. 'priority (org-get-priority txt) 'org-category category
  5950. 'org-category-position category-pos)
  5951. (push txt ee))))
  5952. (goto-char pos)))
  5953. ;; Sort the entries by expiration date.
  5954. (nreverse ee)))
  5955. ;;; Agenda presentation and sorting
  5956. (defvar org-prefix-has-time nil
  5957. "A flag, set by `org-compile-prefix-format'.
  5958. The flag is set if the currently compiled format contains a `%t'.")
  5959. (defvar org-prefix-has-tag nil
  5960. "A flag, set by `org-compile-prefix-format'.
  5961. The flag is set if the currently compiled format contains a `%T'.")
  5962. (defvar org-prefix-has-effort nil
  5963. "A flag, set by `org-compile-prefix-format'.
  5964. The flag is set if the currently compiled format contains a `%e'.")
  5965. (defvar org-prefix-has-breadcrumbs nil
  5966. "A flag, set by `org-compile-prefix-format'.
  5967. The flag is set if the currently compiled format contains a `%b'.")
  5968. (defvar org-prefix-category-length nil
  5969. "Used by `org-compile-prefix-format' to remember the category field width.")
  5970. (defvar org-prefix-category-max-length nil
  5971. "Used by `org-compile-prefix-format' to remember the category field width.")
  5972. (defun org-agenda-get-category-icon (category)
  5973. "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
  5974. (dolist (entry org-agenda-category-icon-alist)
  5975. (when (org-string-match-p (car entry) category)
  5976. (if (listp (cadr entry))
  5977. (return (cadr entry))
  5978. (return (apply 'create-image (cdr entry)))))))
  5979. (defun org-agenda-format-item (extra txt &optional level category tags dotime
  5980. remove-re habitp)
  5981. "Format TXT to be inserted into the agenda buffer.
  5982. In particular, add the prefix and corresponding text properties.
  5983. EXTRA must be a string to replace the `%s' specifier in the prefix format.
  5984. LEVEL may be a string to replace the `%l' specifier.
  5985. CATEGORY (a string, a symbol or nil) may be used to overrule the default
  5986. category taken from local variable or file name. It will replace the `%c'
  5987. specifier in the format.
  5988. DOTIME, when non-nil, indicates that a time-of-day should be extracted from
  5989. TXT for sorting of this entry, and for the `%t' specifier in the format.
  5990. When DOTIME is a string, this string is searched for a time before TXT is.
  5991. TAGS can be the tags of the headline.
  5992. Any match of REMOVE-RE will be removed from TXT."
  5993. ;; We keep the org-prefix-* variable values along with a compiled
  5994. ;; formatter, so that multiple agendas existing at the same time do
  5995. ;; not step on each other toes.
  5996. ;;
  5997. ;; It was inconvenient to make these variables buffer local in
  5998. ;; Agenda buffers, because this function expects to be called with
  5999. ;; the buffer where item comes from being current, and not agenda
  6000. ;; buffer
  6001. (let* ((bindings (car org-prefix-format-compiled))
  6002. (formatter (cadr org-prefix-format-compiled)))
  6003. (loop for (var value) in bindings
  6004. do (set var value))
  6005. (save-match-data
  6006. ;; Diary entries sometimes have extra whitespace at the beginning
  6007. (setq txt (org-trim txt))
  6008. ;; Fix the tags part in txt
  6009. (setq txt (org-agenda-fix-displayed-tags
  6010. txt tags
  6011. org-agenda-show-inherited-tags
  6012. org-agenda-hide-tags-regexp))
  6013. (let* ((category (or category
  6014. (if (stringp org-category)
  6015. org-category
  6016. (and org-category (symbol-name org-category)))
  6017. (if buffer-file-name
  6018. (file-name-sans-extension
  6019. (file-name-nondirectory buffer-file-name))
  6020. "")))
  6021. (category-icon (org-agenda-get-category-icon category))
  6022. (category-icon (if category-icon
  6023. (propertize " " 'display category-icon)
  6024. ""))
  6025. ;; time, tag, effort are needed for the eval of the prefix format
  6026. (tag (if tags (nth (1- (length tags)) tags) ""))
  6027. time effort neffort
  6028. (ts (if dotime (concat
  6029. (if (stringp dotime) dotime "")
  6030. (and org-agenda-search-headline-for-time txt))))
  6031. (time-of-day (and dotime (org-get-time-of-day ts)))
  6032. stamp plain s0 s1 s2 rtn srp l
  6033. duration thecategory breadcrumbs)
  6034. (and (derived-mode-p 'org-mode) buffer-file-name
  6035. (add-to-list 'org-agenda-contributing-files buffer-file-name))
  6036. (when (and dotime time-of-day)
  6037. ;; Extract starting and ending time and move them to prefix
  6038. (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
  6039. (setq plain (string-match org-plain-time-of-day-regexp ts)))
  6040. (setq s0 (match-string 0 ts)
  6041. srp (and stamp (match-end 3))
  6042. s1 (match-string (if plain 1 2) ts)
  6043. s2 (match-string (if plain 8 (if srp 4 6)) ts))
  6044. ;; If the times are in TXT (not in DOTIMES), and the prefix will list
  6045. ;; them, we might want to remove them there to avoid duplication.
  6046. ;; The user can turn this off with a variable.
  6047. (if (and org-prefix-has-time
  6048. org-agenda-remove-times-when-in-prefix (or stamp plain)
  6049. (string-match (concat (regexp-quote s0) " *") txt)
  6050. (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
  6051. (if (eq org-agenda-remove-times-when-in-prefix 'beg)
  6052. (= (match-beginning 0) 0)
  6053. t))
  6054. (setq txt (replace-match "" nil nil txt))))
  6055. ;; Normalize the time(s) to 24 hour
  6056. (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
  6057. (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
  6058. ;; Try to set s2 if s1 and `org-agenda-default-appointment-duration' are set
  6059. (let (org-time-clocksum-use-effort-durations)
  6060. (when (and s1 (not s2) org-agenda-default-appointment-duration)
  6061. (setq s2
  6062. (org-minutes-to-clocksum-string
  6063. (+ (org-hh:mm-string-to-minutes s1)
  6064. org-agenda-default-appointment-duration)))))
  6065. ;; Compute the duration
  6066. (when s2
  6067. (setq duration (- (org-hh:mm-string-to-minutes s2)
  6068. (org-hh:mm-string-to-minutes s1)))))
  6069. (when (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
  6070. txt)
  6071. ;; Tags are in the string
  6072. (if (or (eq org-agenda-remove-tags t)
  6073. (and org-agenda-remove-tags
  6074. org-prefix-has-tag))
  6075. (setq txt (replace-match "" t t txt))
  6076. (setq txt (replace-match
  6077. (concat (make-string (max (- 50 (length txt)) 1) ?\ )
  6078. (match-string 2 txt))
  6079. t t txt))))
  6080. (when (derived-mode-p 'org-mode)
  6081. (setq effort (ignore-errors (get-text-property 0 'org-effort txt))))
  6082. ;; org-agenda-add-time-grid-maybe calls us with *Agenda* as
  6083. ;; current buffer, so move this check outside of above
  6084. (if effort
  6085. (setq neffort (org-duration-string-to-minutes effort)
  6086. effort (setq effort (concat "[" effort "]")))
  6087. ;; prevent erroring out with %e format when there is no effort
  6088. (setq effort ""))
  6089. (when remove-re
  6090. (while (string-match remove-re txt)
  6091. (setq txt (replace-match "" t t txt))))
  6092. ;; Set org-heading property on `txt' to mark the start of the
  6093. ;; heading.
  6094. (add-text-properties 0 (length txt) '(org-heading t) txt)
  6095. ;; Prepare the variables needed in the eval of the compiled format
  6096. (if org-prefix-has-breadcrumbs
  6097. (setq breadcrumbs (org-with-point-at (org-get-at-bol 'org-marker)
  6098. (let ((s (org-display-outline-path nil nil "->" t)))
  6099. (if (eq "" s) "" (concat s "->"))))))
  6100. (setq time (cond (s2 (concat
  6101. (org-agenda-time-of-day-to-ampm-maybe s1)
  6102. "-" (org-agenda-time-of-day-to-ampm-maybe s2)
  6103. (if org-agenda-timegrid-use-ampm " ")))
  6104. (s1 (concat
  6105. (org-agenda-time-of-day-to-ampm-maybe s1)
  6106. (if org-agenda-timegrid-use-ampm
  6107. "........ "
  6108. "......")))
  6109. (t ""))
  6110. extra (or (and (not habitp) extra) "")
  6111. category (if (symbolp category) (symbol-name category) category)
  6112. thecategory (copy-sequence category)
  6113. level (or level ""))
  6114. (if (string-match org-bracket-link-regexp category)
  6115. (progn
  6116. (setq l (if (match-end 3)
  6117. (- (match-end 3) (match-beginning 3))
  6118. (- (match-end 1) (match-beginning 1))))
  6119. (when (< l (or org-prefix-category-length 0))
  6120. (setq category (copy-sequence category))
  6121. (org-add-props category nil
  6122. 'extra-space (make-string
  6123. (- org-prefix-category-length l 1) ?\ ))))
  6124. (if (and org-prefix-category-max-length
  6125. (>= (length category) org-prefix-category-max-length))
  6126. (setq category (substring category 0 (1- org-prefix-category-max-length)))))
  6127. ;; Evaluate the compiled format
  6128. (setq rtn (concat (eval formatter) txt))
  6129. ;; And finally add the text properties
  6130. (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
  6131. (org-add-props rtn nil
  6132. 'org-category (if thecategory (downcase thecategory) category)
  6133. 'tags (mapcar 'org-downcase-keep-props tags)
  6134. 'org-highest-priority org-highest-priority
  6135. 'org-lowest-priority org-lowest-priority
  6136. 'time-of-day time-of-day
  6137. 'duration duration
  6138. 'effort effort
  6139. 'effort-minutes neffort
  6140. 'breadcrumbs breadcrumbs
  6141. 'txt txt
  6142. 'level level
  6143. 'time time
  6144. 'extra extra
  6145. 'format org-prefix-format-compiled
  6146. 'dotime dotime)))))
  6147. (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
  6148. "Remove tags string from TXT, and add a modified list of tags.
  6149. The modified list may contain inherited tags, and tags matched by
  6150. `org-agenda-hide-tags-regexp' will be removed."
  6151. (when (or add-inherited hide-re)
  6152. (if (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") txt)
  6153. (setq txt (substring txt 0 (match-beginning 0))))
  6154. (setq tags
  6155. (delq nil
  6156. (mapcar (lambda (tg)
  6157. (if (or (and hide-re (string-match hide-re tg))
  6158. (and (not add-inherited)
  6159. (get-text-property 0 'inherited tg)))
  6160. nil
  6161. tg))
  6162. tags)))
  6163. (when tags
  6164. (let ((have-i (get-text-property 0 'inherited (car tags)))
  6165. i)
  6166. (setq txt (concat txt " :"
  6167. (mapconcat
  6168. (lambda (x)
  6169. (setq i (get-text-property 0 'inherited x))
  6170. (if (and have-i (not i))
  6171. (progn
  6172. (setq have-i nil)
  6173. (concat ":" x))
  6174. x))
  6175. tags ":")
  6176. (if have-i "::" ":"))))))
  6177. txt)
  6178. (defun org-downcase-keep-props (s)
  6179. (let ((props (text-properties-at 0 s)))
  6180. (setq s (downcase s))
  6181. (add-text-properties 0 (length s) props s)
  6182. s))
  6183. (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
  6184. (defun org-agenda-add-time-grid-maybe (list ndays todayp)
  6185. "Add a time-grid for agenda items which need it.
  6186. LIST is the list of agenda items formatted by `org-agenda-list'.
  6187. NDAYS is the span of the current agenda view.
  6188. TODAYP is `t' when the current agenda view is on today."
  6189. (catch 'exit
  6190. (cond ((not org-agenda-use-time-grid) (throw 'exit list))
  6191. ((and todayp (member 'today (car org-agenda-time-grid))))
  6192. ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
  6193. ((member 'weekly (car org-agenda-time-grid)))
  6194. (t (throw 'exit list)))
  6195. (let* ((have (delq nil (mapcar
  6196. (lambda (x) (get-text-property 1 'time-of-day x))
  6197. list)))
  6198. (string (nth 1 org-agenda-time-grid))
  6199. (gridtimes (nth 2 org-agenda-time-grid))
  6200. (req (car org-agenda-time-grid))
  6201. (remove (member 'remove-match req))
  6202. new time)
  6203. (if (and (member 'require-timed req) (not have))
  6204. ;; don't show empty grid
  6205. (throw 'exit list))
  6206. (while (setq time (pop gridtimes))
  6207. (unless (and remove (member time have))
  6208. (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
  6209. (push (org-agenda-format-item
  6210. nil string nil "" nil
  6211. (concat (substring time 0 -2) ":" (substring time -2)))
  6212. new)
  6213. (put-text-property
  6214. 2 (length (car new)) 'face 'org-time-grid (car new))))
  6215. (when (and todayp org-agenda-show-current-time-in-grid)
  6216. (push (org-agenda-format-item
  6217. nil org-agenda-current-time-string nil "" nil
  6218. (format-time-string "%H:%M "))
  6219. new)
  6220. (put-text-property
  6221. 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
  6222. (if (member 'time-up org-agenda-sorting-strategy-selected)
  6223. (append new list)
  6224. (append list new)))))
  6225. (defun org-compile-prefix-format (key)
  6226. "Compile the prefix format into a Lisp form that can be evaluated.
  6227. The resulting form and associated variable bindings is returned
  6228. and stored in the variable `org-prefix-format-compiled'."
  6229. (setq org-prefix-has-time nil
  6230. org-prefix-has-tag nil
  6231. org-prefix-category-length nil
  6232. org-prefix-has-effort nil
  6233. org-prefix-has-breadcrumbs nil)
  6234. (let ((s (cond
  6235. ((stringp org-agenda-prefix-format)
  6236. org-agenda-prefix-format)
  6237. ((assq key org-agenda-prefix-format)
  6238. (cdr (assq key org-agenda-prefix-format)))
  6239. (t " %-12:c%?-12t% s")))
  6240. (start 0)
  6241. varform vars var e c f opt)
  6242. (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cltseib]\\|(.+)\\)"
  6243. s start)
  6244. (setq var (or (cdr (assoc (match-string 4 s)
  6245. '(("c" . category) ("t" . time) ("l" . level) ("s" . extra)
  6246. ("i" . category-icon) ("T" . tag) ("e" . effort) ("b" . breadcrumbs))))
  6247. 'eval)
  6248. c (or (match-string 3 s) "")
  6249. opt (match-beginning 1)
  6250. start (1+ (match-beginning 0)))
  6251. (if (equal var 'time) (setq org-prefix-has-time t))
  6252. (if (equal var 'tag) (setq org-prefix-has-tag t))
  6253. (if (equal var 'effort) (setq org-prefix-has-effort t))
  6254. (if (equal var 'breadcrumbs) (setq org-prefix-has-breadcrumbs t))
  6255. (setq f (concat "%" (match-string 2 s) "s"))
  6256. (when (equal var 'category)
  6257. (setq org-prefix-category-length
  6258. (floor (abs (string-to-number (match-string 2 s)))))
  6259. (setq org-prefix-category-max-length
  6260. (let ((x (match-string 2 s)))
  6261. (save-match-data
  6262. (if (string-match "\\.[0-9]+" x)
  6263. (string-to-number (substring (match-string 0 x) 1)))))))
  6264. (if (eq var 'eval)
  6265. (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
  6266. (if opt
  6267. (setq varform
  6268. `(if (equal "" ,var)
  6269. ""
  6270. (format ,f (if (equal "" ,var) "" (concat ,var ,c)))))
  6271. (setq varform `(format ,f (if (equal ,var "") "" (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
  6272. (setq s (replace-match "%s" t nil s))
  6273. (push varform vars))
  6274. (setq vars (nreverse vars))
  6275. (with-current-buffer (or org-agenda-buffer (current-buffer))
  6276. (setq org-prefix-format-compiled
  6277. (list
  6278. `((org-prefix-has-time ,org-prefix-has-time)
  6279. (org-prefix-has-tag ,org-prefix-has-tag)
  6280. (org-prefix-category-length ,org-prefix-category-length)
  6281. (org-prefix-has-effort ,org-prefix-has-effort)
  6282. (org-prefix-has-breadcrumbs ,org-prefix-has-breadcrumbs))
  6283. `(format ,s ,@vars))))))
  6284. (defun org-set-sorting-strategy (key)
  6285. (if (symbolp (car org-agenda-sorting-strategy))
  6286. ;; the old format
  6287. (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
  6288. (setq org-agenda-sorting-strategy-selected
  6289. (or (cdr (assq key org-agenda-sorting-strategy))
  6290. (cdr (assq 'agenda org-agenda-sorting-strategy))
  6291. '(time-up category-keep priority-down)))))
  6292. (defun org-get-time-of-day (s &optional string mod24)
  6293. "Check string S for a time of day.
  6294. If found, return it as a military time number between 0 and 2400.
  6295. If not found, return nil.
  6296. The optional STRING argument forces conversion into a 5 character wide string
  6297. HH:MM."
  6298. (save-match-data
  6299. (when
  6300. (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
  6301. (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
  6302. (let* ((h (string-to-number (match-string 1 s)))
  6303. (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
  6304. (ampm (if (match-end 4) (downcase (match-string 4 s))))
  6305. (am-p (equal ampm "am"))
  6306. (h1 (cond ((not ampm) h)
  6307. ((= h 12) (if am-p 0 12))
  6308. (t (+ h (if am-p 0 12)))))
  6309. (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
  6310. (mod h1 24) h1))
  6311. (t0 (+ (* 100 h2) m))
  6312. (t1 (concat (if (>= h1 24) "+" " ")
  6313. (if (and org-agenda-time-leading-zero
  6314. (< t0 1000)) "0" "")
  6315. (if (< t0 100) "0" "")
  6316. (if (< t0 10) "0" "")
  6317. (int-to-string t0))))
  6318. (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
  6319. (defvar org-agenda-before-sorting-filter-function nil
  6320. "Function to be applied to agenda items prior to sorting.
  6321. Prior to sorting also means just before they are inserted into the agenda.
  6322. To aid sorting, you may revisit the original entries and add more text
  6323. properties which will later be used by the sorting functions.
  6324. The function should take a string argument, an agenda line.
  6325. It has access to the text properties in that line, which contain among
  6326. other things, the property `org-hd-marker' that points to the entry
  6327. where the line comes from. Note that not all lines going into the agenda
  6328. have this property, only most.
  6329. The function should return the modified string. It is probably best
  6330. to ONLY change text properties.
  6331. You can also use this function as a filter, by returning nil for lines
  6332. you don't want to have in the agenda at all. For this application, you
  6333. could bind the variable in the options section of a custom command.")
  6334. (defun org-agenda-finalize-entries (list &optional type)
  6335. "Sort, limit and concatenate the LIST of agenda items.
  6336. The optional argument TYPE tells the agenda type."
  6337. (let ((max-effort (cond ((listp org-agenda-max-effort)
  6338. (cdr (assoc type org-agenda-max-effort)))
  6339. (t org-agenda-max-effort)))
  6340. (max-todo (cond ((listp org-agenda-max-todos)
  6341. (cdr (assoc type org-agenda-max-todos)))
  6342. (t org-agenda-max-todos)))
  6343. (max-tags (cond ((listp org-agenda-max-tags)
  6344. (cdr (assoc type org-agenda-max-tags)))
  6345. (t org-agenda-max-tags)))
  6346. (max-entries (cond ((listp org-agenda-max-entries)
  6347. (cdr (assoc type org-agenda-max-entries)))
  6348. (t org-agenda-max-entries))) l)
  6349. (when org-agenda-before-sorting-filter-function
  6350. (setq list
  6351. (delq nil
  6352. (mapcar
  6353. org-agenda-before-sorting-filter-function list))))
  6354. (setq list (mapcar 'org-agenda-highlight-todo list)
  6355. list (mapcar 'identity (sort list 'org-entries-lessp)))
  6356. (when max-effort
  6357. (setq list (org-agenda-limit-entries
  6358. list 'effort-minutes max-effort 'identity)))
  6359. (when max-todo
  6360. (setq list (org-agenda-limit-entries list 'todo-state max-todo)))
  6361. (when max-tags
  6362. (setq list (org-agenda-limit-entries list 'tags max-tags)))
  6363. (when max-entries
  6364. (setq list (org-agenda-limit-entries list 'org-hd-marker max-entries)))
  6365. (mapconcat 'identity list "\n")))
  6366. (defun org-agenda-limit-entries (list prop limit &optional fn)
  6367. "Limit the number of agenda entries."
  6368. (let ((include (and limit (< limit 0))))
  6369. (if limit
  6370. (let ((fun (or fn (lambda (p) (if p 1))))
  6371. (lim 0))
  6372. (delq nil
  6373. (mapcar
  6374. (lambda (e)
  6375. (let ((pval (funcall fun (get-text-property 1 prop e))))
  6376. (if pval (setq lim (+ lim pval)))
  6377. (cond ((and pval (<= lim (abs limit))) e)
  6378. ((and include (not pval)) e))))
  6379. list)))
  6380. list)))
  6381. (defun org-agenda-limit-interactively ()
  6382. "In agenda, interactively limit entries to various maximums."
  6383. (interactive)
  6384. (let* ((max (read-char "Number of [e]ntries [t]odos [T]ags [E]ffort? "))
  6385. (num (string-to-number (read-from-minibuffer "How many? "))))
  6386. (cond ((equal max ?e)
  6387. (let ((org-agenda-max-entries num)) (org-agenda-redo)))
  6388. ((equal max ?t)
  6389. (let ((org-agenda-max-todos num)) (org-agenda-redo)))
  6390. ((equal max ?T)
  6391. (let ((org-agenda-max-tags num)) (org-agenda-redo)))
  6392. ((equal max ?E)
  6393. (let ((org-agenda-max-effort num)) (org-agenda-redo)))))
  6394. (org-agenda-fit-window-to-buffer))
  6395. (defun org-agenda-highlight-todo (x)
  6396. (let ((org-done-keywords org-done-keywords-for-agenda)
  6397. (case-fold-search nil)
  6398. re)
  6399. (if (eq x 'line)
  6400. (save-excursion
  6401. (beginning-of-line 1)
  6402. (setq re (org-get-at-bol 'org-todo-regexp))
  6403. (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
  6404. (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
  6405. (add-text-properties (match-beginning 0) (match-end 1)
  6406. (list 'face (org-get-todo-face 1)))
  6407. (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
  6408. (delete-region (match-beginning 1) (1- (match-end 0)))
  6409. (goto-char (match-beginning 1))
  6410. (insert (format org-agenda-todo-keyword-format s)))))
  6411. (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
  6412. (setq re (get-text-property 0 'org-todo-regexp x))
  6413. (when (and re
  6414. ;; Test `pl' because if there's no heading content,
  6415. ;; there's no point matching to highlight. Note
  6416. ;; that if we didn't test `pl' first, and there
  6417. ;; happened to be no keyword from `org-todo-regexp'
  6418. ;; on this heading line, then the `equal' comparison
  6419. ;; afterwards would spuriously succeed in the case
  6420. ;; where `pl' is nil -- causing an args-out-of-range
  6421. ;; error when we try to add text properties to text
  6422. ;; that isn't there.
  6423. pl
  6424. (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
  6425. x pl) pl))
  6426. (add-text-properties
  6427. (or (match-end 1) (match-end 0)) (match-end 0)
  6428. (list 'face (org-get-todo-face (match-string 2 x)))
  6429. x)
  6430. (when (match-end 1)
  6431. (setq x (concat (substring x 0 (match-end 1))
  6432. (format org-agenda-todo-keyword-format
  6433. (match-string 2 x))
  6434. (org-add-props " " (text-properties-at 0 x))
  6435. (substring x (match-end 3)))))))
  6436. x)))
  6437. (defsubst org-cmp-priority (a b)
  6438. "Compare the priorities of string A and B."
  6439. (let ((pa (or (get-text-property 1 'priority a) 0))
  6440. (pb (or (get-text-property 1 'priority b) 0)))
  6441. (cond ((> pa pb) +1)
  6442. ((< pa pb) -1))))
  6443. (defsubst org-cmp-effort (a b)
  6444. "Compare the effort values of string A and B."
  6445. (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
  6446. (ea (or (get-text-property 1 'effort-minutes a) def))
  6447. (eb (or (get-text-property 1 'effort-minutes b) def)))
  6448. (cond ((> ea eb) +1)
  6449. ((< ea eb) -1))))
  6450. (defsubst org-cmp-category (a b)
  6451. "Compare the string values of categories of strings A and B."
  6452. (let ((ca (or (get-text-property 1 'org-category a) ""))
  6453. (cb (or (get-text-property 1 'org-category b) "")))
  6454. (cond ((string-lessp ca cb) -1)
  6455. ((string-lessp cb ca) +1))))
  6456. (defsubst org-cmp-todo-state (a b)
  6457. "Compare the todo states of strings A and B."
  6458. (let* ((ma (or (get-text-property 1 'org-marker a)
  6459. (get-text-property 1 'org-hd-marker a)))
  6460. (mb (or (get-text-property 1 'org-marker b)
  6461. (get-text-property 1 'org-hd-marker b)))
  6462. (fa (and ma (marker-buffer ma)))
  6463. (fb (and mb (marker-buffer mb)))
  6464. (todo-kwds
  6465. (or (and fa (with-current-buffer fa org-todo-keywords-1))
  6466. (and fb (with-current-buffer fb org-todo-keywords-1))))
  6467. (ta (or (get-text-property 1 'todo-state a) ""))
  6468. (tb (or (get-text-property 1 'todo-state b) ""))
  6469. (la (- (length (member ta todo-kwds))))
  6470. (lb (- (length (member tb todo-kwds))))
  6471. (donepa (member ta org-done-keywords-for-agenda))
  6472. (donepb (member tb org-done-keywords-for-agenda)))
  6473. (cond ((and donepa (not donepb)) -1)
  6474. ((and (not donepa) donepb) +1)
  6475. ((< la lb) -1)
  6476. ((< lb la) +1))))
  6477. (defsubst org-cmp-alpha (a b)
  6478. "Compare the headlines, alphabetically."
  6479. (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
  6480. (plb (text-property-any 0 (length b) 'org-heading t b))
  6481. (ta (and pla (substring a pla)))
  6482. (tb (and plb (substring b plb))))
  6483. (when pla
  6484. (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
  6485. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
  6486. (setq ta (substring ta (match-end 0))))
  6487. (setq ta (downcase ta)))
  6488. (when plb
  6489. (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
  6490. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
  6491. (setq tb (substring tb (match-end 0))))
  6492. (setq tb (downcase tb)))
  6493. (cond ((not ta) +1)
  6494. ((not tb) -1)
  6495. ((string-lessp ta tb) -1)
  6496. ((string-lessp tb ta) +1))))
  6497. (defsubst org-cmp-tag (a b)
  6498. "Compare the string values of the first tags of A and B."
  6499. (let ((ta (car (last (get-text-property 1 'tags a))))
  6500. (tb (car (last (get-text-property 1 'tags b)))))
  6501. (cond ((not ta) +1)
  6502. ((not tb) -1)
  6503. ((string-lessp ta tb) -1)
  6504. ((string-lessp tb ta) +1))))
  6505. (defsubst org-cmp-time (a b)
  6506. "Compare the time-of-day values of strings A and B."
  6507. (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
  6508. (ta (or (get-text-property 1 'time-of-day a) def))
  6509. (tb (or (get-text-property 1 'time-of-day b) def)))
  6510. (cond ((< ta tb) -1)
  6511. ((< tb ta) +1))))
  6512. (defsubst org-cmp-ts (a b &optional type)
  6513. "Compare the timestamps values of entries A and B.
  6514. When TYPE is \"scheduled\", \"deadline\", \"timestamp\" or
  6515. \"timestamp_ia\", compare within each of these type. When TYPE
  6516. is the empty string, compare all timestamps without respect of
  6517. their type."
  6518. (let* ((def (if org-sort-agenda-notime-is-late most-positive-fixnum -1))
  6519. (ta (or (and (string-match type (or (get-text-property 1 'type a) ""))
  6520. (get-text-property 1 'ts-date a)) def))
  6521. (tb (or (and (string-match type (or (get-text-property 1 'type b) ""))
  6522. (get-text-property 1 'ts-date b)) def)))
  6523. (cond ((< ta tb) -1)
  6524. ((< tb ta) +1))))
  6525. (defsubst org-cmp-habit-p (a b)
  6526. "Compare the todo states of strings A and B."
  6527. (let ((ha (get-text-property 1 'org-habit-p a))
  6528. (hb (get-text-property 1 'org-habit-p b)))
  6529. (cond ((and ha (not hb)) -1)
  6530. ((and (not ha) hb) +1))))
  6531. (defun org-entries-lessp (a b)
  6532. "Predicate for sorting agenda entries."
  6533. ;; The following variables will be used when the form is evaluated.
  6534. ;; So even though the compiler complains, keep them.
  6535. (let* ((ss org-agenda-sorting-strategy-selected)
  6536. (timestamp-up (and (org-em 'timestamp-up 'timestamp-down ss)
  6537. (org-cmp-ts a b "")))
  6538. (timestamp-down (if timestamp-up (- timestamp-up) nil))
  6539. (scheduled-up (and (org-em 'scheduled-up 'scheduled-down ss)
  6540. (org-cmp-ts a b "scheduled")))
  6541. (scheduled-down (if scheduled-up (- scheduled-up) nil))
  6542. (deadline-up (and (org-em 'deadline-up 'deadline-down ss)
  6543. (org-cmp-ts a b "deadline")))
  6544. (deadline-down (if deadline-up (- deadline-up) nil))
  6545. (tsia-up (and (org-em 'tsia-up 'tsia-down ss)
  6546. (org-cmp-ts a b "iatimestamp_ia")))
  6547. (tsia-down (if tsia-up (- tsia-up) nil))
  6548. (ts-up (and (org-em 'ts-up 'ts-down ss)
  6549. (org-cmp-ts a b "timestamp")))
  6550. (ts-down (if ts-up (- ts-up) nil))
  6551. (time-up (and (org-em 'time-up 'time-down ss)
  6552. (org-cmp-time a b)))
  6553. (time-down (if time-up (- time-up) nil))
  6554. (priority-up (and (org-em 'priority-up 'priority-down ss)
  6555. (org-cmp-priority a b)))
  6556. (priority-down (if priority-up (- priority-up) nil))
  6557. (effort-up (and (org-em 'effort-up 'effort-down ss)
  6558. (org-cmp-effort a b)))
  6559. (effort-down (if effort-up (- effort-up) nil))
  6560. (category-up (and (or (org-em 'category-up 'category-down ss)
  6561. (memq 'category-keep ss))
  6562. (org-cmp-category a b)))
  6563. (category-down (if category-up (- category-up) nil))
  6564. (category-keep (if category-up +1 nil))
  6565. (tag-up (and (org-em 'tag-up 'tag-down ss)
  6566. (org-cmp-tag a b)))
  6567. (tag-down (if tag-up (- tag-up) nil))
  6568. (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
  6569. (org-cmp-todo-state a b)))
  6570. (todo-state-down (if todo-state-up (- todo-state-up) nil))
  6571. (habit-up (and (org-em 'habit-up 'habit-down ss)
  6572. (org-cmp-habit-p a b)))
  6573. (habit-down (if habit-up (- habit-up) nil))
  6574. (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
  6575. (org-cmp-alpha a b)))
  6576. (alpha-down (if alpha-up (- alpha-up) nil))
  6577. (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
  6578. user-defined-up user-defined-down)
  6579. (if (and need-user-cmp org-agenda-cmp-user-defined
  6580. (functionp org-agenda-cmp-user-defined))
  6581. (setq user-defined-up
  6582. (funcall org-agenda-cmp-user-defined a b)
  6583. user-defined-down (if user-defined-up (- user-defined-up) nil)))
  6584. (cdr (assoc
  6585. (eval (cons 'or org-agenda-sorting-strategy-selected))
  6586. '((-1 . t) (1 . nil) (nil . nil))))))
  6587. ;;; Agenda restriction lock
  6588. (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
  6589. "Overlay to mark the headline to which agenda commands are restricted.")
  6590. (overlay-put org-agenda-restriction-lock-overlay
  6591. 'face 'org-agenda-restriction-lock)
  6592. (overlay-put org-agenda-restriction-lock-overlay
  6593. 'help-echo "Agendas are currently limited to this subtree.")
  6594. (org-detach-overlay org-agenda-restriction-lock-overlay)
  6595. ;;;###autoload
  6596. (defun org-agenda-set-restriction-lock (&optional type)
  6597. "Set restriction lock for agenda, to current subtree or file.
  6598. Restriction will be the file if TYPE is `file', or if type is the
  6599. universal prefix '(4), or if the cursor is before the first headline
  6600. in the file. Otherwise, restriction will be to the current subtree."
  6601. (interactive "P")
  6602. (and (equal type '(4)) (setq type 'file))
  6603. (setq type (cond
  6604. (type type)
  6605. ((org-at-heading-p) 'subtree)
  6606. ((condition-case nil (org-back-to-heading t) (error nil))
  6607. 'subtree)
  6608. (t 'file)))
  6609. (if (eq type 'subtree)
  6610. (progn
  6611. (setq org-agenda-restrict (current-buffer))
  6612. (setq org-agenda-overriding-restriction 'subtree)
  6613. (put 'org-agenda-files 'org-restrict
  6614. (list (buffer-file-name (buffer-base-buffer))))
  6615. (org-back-to-heading t)
  6616. (move-overlay org-agenda-restriction-lock-overlay
  6617. (point)
  6618. (if org-agenda-restriction-lock-highlight-subtree
  6619. (save-excursion (org-end-of-subtree t t) (point))
  6620. (point-at-eol)))
  6621. (move-marker org-agenda-restrict-begin (point))
  6622. (move-marker org-agenda-restrict-end
  6623. (save-excursion (org-end-of-subtree t t)))
  6624. (message "Locking agenda restriction to subtree"))
  6625. (put 'org-agenda-files 'org-restrict
  6626. (list (buffer-file-name (buffer-base-buffer))))
  6627. (setq org-agenda-restrict nil)
  6628. (setq org-agenda-overriding-restriction 'file)
  6629. (move-marker org-agenda-restrict-begin nil)
  6630. (move-marker org-agenda-restrict-end nil)
  6631. (message "Locking agenda restriction to file"))
  6632. (setq current-prefix-arg nil)
  6633. (org-agenda-maybe-redo))
  6634. (defun org-agenda-remove-restriction-lock (&optional noupdate)
  6635. "Remove the agenda restriction lock."
  6636. (interactive "P")
  6637. (org-detach-overlay org-agenda-restriction-lock-overlay)
  6638. (org-detach-overlay org-speedbar-restriction-lock-overlay)
  6639. (setq org-agenda-overriding-restriction nil)
  6640. (setq org-agenda-restrict nil)
  6641. (put 'org-agenda-files 'org-restrict nil)
  6642. (move-marker org-agenda-restrict-begin nil)
  6643. (move-marker org-agenda-restrict-end nil)
  6644. (setq current-prefix-arg nil)
  6645. (message "Agenda restriction lock removed")
  6646. (or noupdate (org-agenda-maybe-redo)))
  6647. (defun org-agenda-maybe-redo ()
  6648. "If there is any window showing the agenda view, update it."
  6649. (let ((w (get-buffer-window org-agenda-buffer-name t))
  6650. (w0 (selected-window)))
  6651. (when w
  6652. (select-window w)
  6653. (org-agenda-redo)
  6654. (select-window w0)
  6655. (if org-agenda-overriding-restriction
  6656. (message "Agenda view shifted to new %s restriction"
  6657. org-agenda-overriding-restriction)
  6658. (message "Agenda restriction lock removed")))))
  6659. ;;; Agenda commands
  6660. (defun org-agenda-check-type (error &rest types)
  6661. "Check if agenda buffer is of allowed type.
  6662. If ERROR is non-nil, throw an error, otherwise just return nil.
  6663. Allowed types are 'agenda 'timeline 'todo 'tags 'search."
  6664. (if (not org-agenda-type)
  6665. (error "No Org agenda currently displayed")
  6666. (if (memq org-agenda-type types)
  6667. t
  6668. (if error
  6669. (error "Not allowed in %s-type agenda buffers" org-agenda-type)
  6670. nil))))
  6671. (defun org-agenda-Quit ()
  6672. "Exit the agenda and kill buffers loaded by `org-agenda'.
  6673. Also restore the window configuration."
  6674. (interactive)
  6675. (if org-agenda-columns-active
  6676. (org-columns-quit)
  6677. (let ((buf (current-buffer)))
  6678. (if (eq org-agenda-window-setup 'other-frame)
  6679. (progn
  6680. (org-agenda-reset-markers)
  6681. (kill-buffer buf)
  6682. (org-columns-remove-overlays)
  6683. (setq org-agenda-archives-mode nil)
  6684. (delete-frame))
  6685. (and (not (eq org-agenda-window-setup 'current-window))
  6686. (not (one-window-p))
  6687. (delete-window))
  6688. (org-agenda-reset-markers)
  6689. (kill-buffer buf)
  6690. (org-columns-remove-overlays)
  6691. (setq org-agenda-archives-mode nil)))
  6692. (setq org-agenda-buffer nil)
  6693. ;; Maybe restore the pre-agenda window configuration.
  6694. (and org-agenda-restore-windows-after-quit
  6695. (not (eq org-agenda-window-setup 'other-frame))
  6696. org-agenda-pre-window-conf
  6697. (set-window-configuration org-agenda-pre-window-conf)
  6698. (setq org-agenda-pre-window-conf nil))))
  6699. (defun org-agenda-quit ()
  6700. "Exit the agenda and restore the window configuration.
  6701. When `org-agenda-sticky' is non-nil, only bury the agenda."
  6702. (interactive)
  6703. (if (and (eq org-indirect-buffer-display 'other-window)
  6704. org-last-indirect-buffer)
  6705. (let ((org-last-indirect-window
  6706. (get-buffer-window org-last-indirect-buffer)))
  6707. (if org-last-indirect-window
  6708. (delete-window org-last-indirect-window))))
  6709. (if org-agenda-columns-active
  6710. (org-columns-quit)
  6711. (if org-agenda-sticky
  6712. (let ((buf (current-buffer)))
  6713. (if (eq org-agenda-window-setup 'other-frame)
  6714. (progn
  6715. (delete-frame))
  6716. (and (not (eq org-agenda-window-setup 'current-window))
  6717. (not (one-window-p))
  6718. (delete-window)))
  6719. (with-current-buffer buf
  6720. (bury-buffer)
  6721. ;; Maybe restore the pre-agenda window configuration.
  6722. (and org-agenda-restore-windows-after-quit
  6723. (not (eq org-agenda-window-setup 'other-frame))
  6724. org-agenda-pre-window-conf
  6725. (set-window-configuration org-agenda-pre-window-conf)
  6726. (setq org-agenda-pre-window-conf nil))))
  6727. (org-agenda-Quit))))
  6728. (defun org-agenda-exit ()
  6729. "Exit the agenda and restore the window configuration.
  6730. Also kill Org-mode buffers loaded by `org-agenda'. Org-mode
  6731. buffers visited directly by the user will not be touched."
  6732. (interactive)
  6733. (org-release-buffers org-agenda-new-buffers)
  6734. (setq org-agenda-new-buffers nil)
  6735. (org-agenda-Quit))
  6736. (defun org-agenda-kill-all-agenda-buffers ()
  6737. "Kill all buffers in `org-agenda-mode'.
  6738. This is used when toggling sticky agendas.
  6739. You can also explicitly invoke it with `C-c a C-k'."
  6740. (interactive)
  6741. (let (blist)
  6742. (dolist (buf (buffer-list))
  6743. (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
  6744. (push buf blist)))
  6745. (mapc 'kill-buffer blist)))
  6746. (defun org-agenda-execute (arg)
  6747. "Execute another agenda command, keeping same window.
  6748. So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
  6749. in the agenda."
  6750. (interactive "P")
  6751. (let ((org-agenda-window-setup 'current-window))
  6752. (org-agenda arg)))
  6753. (defun org-agenda-redo (&optional all)
  6754. "Rebuild possibly ALL agenda view(s) in the current buffer."
  6755. (interactive "P")
  6756. (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
  6757. (cpa (unless (eq all t) current-prefix-arg))
  6758. (org-agenda-doing-sticky-redo org-agenda-sticky)
  6759. (org-agenda-sticky nil)
  6760. (org-agenda-buffer-name (or org-agenda-this-buffer-name
  6761. org-agenda-buffer-name))
  6762. (org-agenda-keep-modes t)
  6763. (tag-filter org-agenda-tag-filter)
  6764. (tag-preset (get 'org-agenda-tag-filter :preset-filter))
  6765. (top-hl-filter org-agenda-top-headline-filter)
  6766. (cat-filter org-agenda-category-filter)
  6767. (cat-preset (get 'org-agenda-category-filter :preset-filter))
  6768. (re-filter org-agenda-regexp-filter)
  6769. (re-preset (get 'org-agenda-regexp-filter :preset-filter))
  6770. (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
  6771. (cols org-agenda-columns-active)
  6772. (line (org-current-line))
  6773. (window-line (- line (org-current-line (window-start))))
  6774. (lprops (get 'org-agenda-redo-command 'org-lprops))
  6775. (redo-cmd (get-text-property p 'org-redo-cmd))
  6776. (last-args (get-text-property p 'org-last-args))
  6777. (org-agenda-overriding-cmd (get-text-property p 'org-series-cmd))
  6778. (org-agenda-overriding-cmd-arguments
  6779. (unless (eq all t)
  6780. (cond ((listp last-args)
  6781. (cons (or cpa (car last-args)) (cdr last-args)))
  6782. ((stringp last-args)
  6783. last-args))))
  6784. (series-redo-cmd (get-text-property p 'org-series-redo-cmd)))
  6785. (put 'org-agenda-tag-filter :preset-filter nil)
  6786. (put 'org-agenda-category-filter :preset-filter nil)
  6787. (put 'org-agenda-regexp-filter :preset-filter nil)
  6788. (and cols (org-columns-quit))
  6789. (message "Rebuilding agenda buffer...")
  6790. (if series-redo-cmd
  6791. (eval series-redo-cmd)
  6792. (org-let lprops redo-cmd))
  6793. (setq org-agenda-undo-list nil
  6794. org-agenda-pending-undo-list nil
  6795. org-agenda-tag-filter tag-filter
  6796. org-agenda-category-filter cat-filter
  6797. org-agenda-regexp-filter re-filter
  6798. org-agenda-top-headline-filter top-hl-filter)
  6799. (message "Rebuilding agenda buffer...done")
  6800. (put 'org-agenda-tag-filter :preset-filter tag-preset)
  6801. (put 'org-agenda-category-filter :preset-filter cat-preset)
  6802. (put 'org-agenda-regexp-filter :preset-filter re-preset)
  6803. (and (or tag-filter tag-preset) (org-agenda-filter-apply tag-filter 'tag))
  6804. (and (or cat-filter cat-preset) (org-agenda-filter-apply cat-filter 'category))
  6805. (and (or re-filter re-preset) (org-agenda-filter-apply re-filter 'regexp))
  6806. (and top-hl-filter (org-agenda-filter-top-headline-apply top-hl-filter))
  6807. (and cols (org-called-interactively-p 'any) (org-agenda-columns))
  6808. (org-goto-line line)
  6809. (recenter window-line)))
  6810. (defvar org-global-tags-completion-table nil)
  6811. (defvar org-agenda-filter-form nil)
  6812. (defvar org-agenda-filtered-by-category nil)
  6813. (defun org-agenda-filter-by-category (strip)
  6814. "Keep only those lines in the agenda buffer that have a specific category.
  6815. The category is that of the current line."
  6816. (interactive "P")
  6817. (if (and org-agenda-filtered-by-category
  6818. org-agenda-category-filter)
  6819. (org-agenda-filter-show-all-cat)
  6820. (let ((cat (org-no-properties (get-text-property (point) 'org-category))))
  6821. (cond
  6822. ((and cat strip)
  6823. (org-agenda-filter-apply
  6824. (push (concat "-" cat) org-agenda-category-filter) 'category))
  6825. ((and cat)
  6826. (org-agenda-filter-apply
  6827. (setq org-agenda-category-filter
  6828. (list (concat "+" cat))) 'category))
  6829. ((error "No category at point"))))))
  6830. (defun org-find-top-headline (&optional pos)
  6831. "Find the topmost parent headline and return it."
  6832. (save-excursion
  6833. (with-current-buffer (if pos (marker-buffer pos) (current-buffer))
  6834. (if pos (goto-char pos))
  6835. ;; Skip up to the topmost parent
  6836. (while (ignore-errors (outline-up-heading 1) t))
  6837. (ignore-errors
  6838. (nth 4 (org-heading-components))))))
  6839. (defvar org-agenda-filtered-by-top-headline nil)
  6840. (defun org-agenda-filter-by-top-headline (strip)
  6841. "Keep only those lines that are descendants from the same top headline.
  6842. The top headline is that of the current line."
  6843. (interactive "P")
  6844. (if org-agenda-filtered-by-top-headline
  6845. (progn
  6846. (setq org-agenda-filtered-by-top-headline nil
  6847. org-agenda-top-headline-filter nil)
  6848. (org-agenda-filter-show-all-cat))
  6849. (let ((cat (org-find-top-headline (org-get-at-bol 'org-hd-marker))))
  6850. (if cat (org-agenda-filter-top-headline-apply cat strip)
  6851. (error "No top-level category at point")))))
  6852. (defvar org-agenda-regexp-filter nil)
  6853. (defun org-agenda-filter-by-regexp (strip)
  6854. "Filter agenda entries by a regular expression.
  6855. Regexp filters are cumulative.
  6856. With no prefix argument, keep entries matching the regexp.
  6857. With one prefix argument, filter out entries matching the regexp.
  6858. With two prefix arguments, remove the regexp filters."
  6859. (interactive "P")
  6860. (if (not (equal strip '(16)))
  6861. (let ((flt (concat (if (equal strip '(4)) "-" "+")
  6862. (read-from-minibuffer
  6863. (if (equal strip '(4))
  6864. "Filter out entries matching regexp: "
  6865. "Narrow to entries matching regexp: ")))))
  6866. (push flt org-agenda-regexp-filter)
  6867. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
  6868. (org-agenda-filter-show-all-re)
  6869. (message "Regexp filter removed")))
  6870. (defun org-agenda-filter-remove-all ()
  6871. "Remove all filters from the current agenda buffer."
  6872. (interactive)
  6873. (when org-agenda-tag-filter
  6874. (org-agenda-filter-show-all-tag))
  6875. (when org-agenda-category-filter
  6876. (org-agenda-filter-show-all-cat))
  6877. (when org-agenda-regexp-filter
  6878. (org-agenda-filter-show-all-re)))
  6879. (defun org-agenda-filter-by-tag (strip &optional char narrow)
  6880. "Keep only those lines in the agenda buffer that have a specific tag.
  6881. The tag is selected with its fast selection letter, as configured.
  6882. With prefix argument STRIP, remove all lines that do have the tag.
  6883. A lisp caller can specify CHAR. NARROW means that the new tag should be
  6884. used to narrow the search - the interactive user can also press `-' or `+'
  6885. to switch to narrowing."
  6886. (interactive "P")
  6887. (let* ((alist org-tag-alist-for-agenda)
  6888. (tag-chars (mapconcat
  6889. (lambda (x) (if (and (not (symbolp (car x)))
  6890. (cdr x))
  6891. (char-to-string (cdr x))
  6892. ""))
  6893. alist ""))
  6894. (efforts (org-split-string
  6895. (or (cdr (assoc (concat org-effort-property "_ALL")
  6896. org-global-properties))
  6897. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00"
  6898. "")))
  6899. (effort-op org-agenda-filter-effort-default-operator)
  6900. (effort-prompt "")
  6901. (inhibit-read-only t)
  6902. (current org-agenda-tag-filter)
  6903. maybe-refresh a n tag)
  6904. (unless char
  6905. (message
  6906. "%s by tag [%s ], [TAB], %s[/]:off, [+-]:narrow, [>=<?]:effort: "
  6907. (if narrow "Narrow" "Filter") tag-chars
  6908. (if org-agenda-auto-exclude-function "[RET], " ""))
  6909. (setq char (read-char-exclusive)))
  6910. (when (member char '(?+ ?-))
  6911. ;; Narrowing down
  6912. (cond ((equal char ?-) (setq strip t narrow t))
  6913. ((equal char ?+) (setq strip nil narrow t)))
  6914. (message
  6915. "Narrow by tag [%s ], [TAB], [/]:off, [>=<]:effort: " tag-chars)
  6916. (setq char (read-char-exclusive)))
  6917. (when (member char '(?< ?> ?= ??))
  6918. ;; An effort operator
  6919. (setq effort-op (char-to-string char))
  6920. (setq alist nil) ; to make sure it will be interpreted as effort.
  6921. (unless (equal char ??)
  6922. (loop for i from 0 to 9 do
  6923. (setq effort-prompt
  6924. (concat
  6925. effort-prompt " ["
  6926. (if (= i 9) "0" (int-to-string (1+ i)))
  6927. "]" (nth i efforts))))
  6928. (message "Effort%s: %s " effort-op effort-prompt)
  6929. (setq char (read-char-exclusive))
  6930. (when (or (< char ?0) (> char ?9))
  6931. (error "Need 1-9,0 to select effort"))))
  6932. (when (equal char ?\t)
  6933. (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
  6934. (org-set-local 'org-global-tags-completion-table
  6935. (org-global-tags-completion-table)))
  6936. (let ((completion-ignore-case t))
  6937. (setq tag (org-icompleting-read
  6938. "Tag: " org-global-tags-completion-table))))
  6939. (cond
  6940. ((equal char ?\r)
  6941. (org-agenda-filter-show-all-tag)
  6942. (when org-agenda-auto-exclude-function
  6943. (setq org-agenda-tag-filter nil)
  6944. (dolist (tag (org-agenda-get-represented-tags))
  6945. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  6946. (if modifier
  6947. (push modifier org-agenda-tag-filter))))
  6948. (if (not (null org-agenda-tag-filter))
  6949. (org-agenda-filter-apply org-agenda-tag-filter 'tag)))
  6950. (setq maybe-refresh t))
  6951. ((equal char ?/)
  6952. (org-agenda-filter-show-all-tag)
  6953. (when (get 'org-agenda-tag-filter :preset-filter)
  6954. (org-agenda-filter-apply org-agenda-tag-filter 'tag))
  6955. (setq maybe-refresh t))
  6956. ((equal char ?. )
  6957. (setq org-agenda-tag-filter
  6958. (mapcar (lambda(tag) (concat "+" tag))
  6959. (org-get-at-bol 'tags)))
  6960. (org-agenda-filter-apply org-agenda-tag-filter 'tag)
  6961. (setq maybe-refresh t))
  6962. ((or (equal char ?\ )
  6963. (setq a (rassoc char alist))
  6964. (and (>= char ?0) (<= char ?9)
  6965. (setq n (if (= char ?0) 9 (- char ?0 1))
  6966. tag (concat effort-op (nth n efforts))
  6967. a (cons tag nil)))
  6968. (and (= char ??)
  6969. (setq tag "?eff")
  6970. a (cons tag nil))
  6971. (and tag (setq a (cons tag nil))))
  6972. (org-agenda-filter-show-all-tag)
  6973. (setq tag (car a))
  6974. (setq org-agenda-tag-filter
  6975. (cons (concat (if strip "-" "+") tag)
  6976. (if narrow current nil)))
  6977. (org-agenda-filter-apply org-agenda-tag-filter 'tag)
  6978. (setq maybe-refresh t))
  6979. (t (error "Invalid tag selection character %c" char)))
  6980. (when (and maybe-refresh
  6981. (eq org-agenda-clockreport-mode 'with-filter))
  6982. (org-agenda-redo))))
  6983. (defun org-agenda-get-represented-tags ()
  6984. "Get a list of all tags currently represented in the agenda."
  6985. (let (p tags)
  6986. (save-excursion
  6987. (goto-char (point-min))
  6988. (while (setq p (next-single-property-change (point) 'tags))
  6989. (goto-char p)
  6990. (mapc (lambda (x) (add-to-list 'tags x))
  6991. (get-text-property (point) 'tags))))
  6992. tags))
  6993. (defun org-agenda-filter-by-tag-refine (strip &optional char)
  6994. "Refine the current filter. See `org-agenda-filter-by-tag'."
  6995. (interactive "P")
  6996. (org-agenda-filter-by-tag strip char 'refine))
  6997. (defun org-agenda-filter-make-matcher (filter type)
  6998. "Create the form that tests a line for agenda filter."
  6999. (let (f f1)
  7000. (cond
  7001. ;; Tag filter
  7002. ((eq type 'tag)
  7003. (setq filter
  7004. (delete-dups
  7005. (append (get 'org-agenda-tag-filter :preset-filter)
  7006. filter)))
  7007. (dolist (x filter)
  7008. (let ((nfilter (org-agenda-filter-expand-tags filter)) nf nf1
  7009. (ffunc
  7010. (lambda (nf0 nf01 fltr notgroup op)
  7011. (dolist (x fltr)
  7012. (if (member x '("-" "+"))
  7013. (setq nf01 (if (equal x "-") 'tags '(not tags)))
  7014. (if (string-match "[<=>?]" x)
  7015. (setq nf01 (org-agenda-filter-effort-form x))
  7016. (setq nf01 (list 'member (downcase (substring x 1))
  7017. 'tags)))
  7018. (when (equal (string-to-char x) ?-)
  7019. (setq nf01 (list 'not nf01))
  7020. (when (not notgroup) (setq op 'and))))
  7021. (push nf01 nf0))
  7022. (if notgroup
  7023. (push (cons 'and nf0) f)
  7024. (push (cons (or op 'or) nf0) f)))))
  7025. (cond ((equal filter '("+"))
  7026. (setq f (list (list 'not 'tags))))
  7027. ((equal nfilter filter)
  7028. (funcall ffunc f1 f filter t nil))
  7029. (t (funcall ffunc nf1 nf nfilter nil nil))))))
  7030. ;; Category filter
  7031. ((eq type 'category)
  7032. (setq filter
  7033. (delete-dups
  7034. (append (get 'org-agenda-category-filter :preset-filter)
  7035. filter)))
  7036. (dolist (x filter)
  7037. (if (equal "-" (substring x 0 1))
  7038. (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
  7039. (setq f1 (list 'equal (substring x 1) 'cat)))
  7040. (push f1 f)))
  7041. ;; Regexp filter
  7042. ((eq type 'regexp)
  7043. (setq filter
  7044. (delete-dups
  7045. (append (get 'org-agenda-regexp-filter :preset-filter)
  7046. filter)))
  7047. (dolist (x filter)
  7048. (if (equal "-" (substring x 0 1))
  7049. (setq f1 (list 'not (list 'string-match (substring x 1) 'txt)))
  7050. (setq f1 (list 'string-match (substring x 1) 'txt)))
  7051. (push f1 f))))
  7052. (cons 'and (nreverse f))))
  7053. (defun org-agenda-filter-effort-form (e)
  7054. "Return the form to compare the effort of the current line with what E says.
  7055. E looks like \"+<2:25\"."
  7056. (let (op)
  7057. (setq e (substring e 1))
  7058. (setq op (string-to-char e) e (substring e 1))
  7059. (setq op (cond ((equal op ?<) '<=)
  7060. ((equal op ?>) '>=)
  7061. ((equal op ??) op)
  7062. (t '=)))
  7063. (list 'org-agenda-compare-effort (list 'quote op)
  7064. (org-duration-string-to-minutes e))))
  7065. (defun org-agenda-compare-effort (op value)
  7066. "Compare the effort of the current line with VALUE, using OP.
  7067. If the line does not have an effort defined, return nil."
  7068. (let ((eff (org-get-at-bol 'effort-minutes)))
  7069. (if (equal op ??)
  7070. (not eff)
  7071. (funcall op (or eff (if org-sort-agenda-noeffort-is-high 32767 0))
  7072. value))))
  7073. (defun org-agenda-filter-expand-tags (filter &optional no-operator)
  7074. "Expand group tags in FILTER for the agenda.
  7075. When NO-OPERATOR is non-nil, do not add the + operator to returned tags."
  7076. (if org-group-tags
  7077. (let ((case-fold-search t) rtn)
  7078. (mapc
  7079. (lambda (f)
  7080. (let (f0 dir)
  7081. (if (string-match "^\\([+-]\\)\\(.+\\)" f)
  7082. (setq dir (match-string 1 f) f0 (match-string 2 f))
  7083. (setq dir (if no-operator "" "+") f0 f))
  7084. (setq rtn (append (mapcar (lambda(f1) (concat dir f1))
  7085. (org-tags-expand f0 t t))
  7086. rtn))))
  7087. filter)
  7088. (reverse rtn))
  7089. filter))
  7090. (defun org-agenda-filter-apply (filter type)
  7091. "Set FILTER as the new agenda filter and apply it."
  7092. ;; Deactivate `org-agenda-entry-text-mode' when filtering
  7093. (if org-agenda-entry-text-mode (org-agenda-entry-text-mode))
  7094. (let (tags cat txt)
  7095. (setq org-agenda-filter-form
  7096. (org-agenda-filter-make-matcher filter type))
  7097. (if (and (eq type 'category)
  7098. (not (equal (substring (car filter) 0 1) "-")))
  7099. ;; Only set `org-agenda-filtered-by-category' to t
  7100. ;; when a unique category is used as the filter
  7101. (setq org-agenda-filtered-by-category t))
  7102. (org-agenda-set-mode-name)
  7103. (save-excursion
  7104. (goto-char (point-min))
  7105. (while (not (eobp))
  7106. (if (org-get-at-bol 'org-marker)
  7107. (progn
  7108. (setq tags ; used in eval
  7109. (apply 'append
  7110. (mapcar (lambda (f)
  7111. (org-agenda-filter-expand-tags (list f) t))
  7112. (org-get-at-bol 'tags)))
  7113. cat (get-text-property (point) 'org-category)
  7114. txt (get-text-property (point) 'txt))
  7115. (if (not (eval org-agenda-filter-form))
  7116. (org-agenda-filter-hide-line type))
  7117. (beginning-of-line 2))
  7118. (beginning-of-line 2))))
  7119. (if (get-char-property (point) 'invisible)
  7120. (ignore-errors (org-agenda-previous-line)))))
  7121. (defun org-agenda-filter-top-headline-apply (hl &optional negative)
  7122. "Filter by top headline HL."
  7123. (org-agenda-set-mode-name)
  7124. (save-excursion
  7125. (goto-char (point-min))
  7126. (while (not (eobp))
  7127. (let* ((pos (org-get-at-bol 'org-hd-marker))
  7128. (tophl (and pos (org-find-top-headline pos))))
  7129. (if (and tophl (funcall (if negative 'identity 'not)
  7130. (string= hl tophl)))
  7131. (org-agenda-filter-hide-line 'category)))
  7132. (beginning-of-line 2)))
  7133. (if (get-char-property (point) 'invisible)
  7134. (org-agenda-previous-line))
  7135. (setq org-agenda-top-headline-filter hl
  7136. org-agenda-filtered-by-top-headline t))
  7137. (defun org-agenda-filter-hide-line (type)
  7138. "Hide lines with TYPE in the agenda buffer."
  7139. (let (ov)
  7140. (setq ov (make-overlay (max (point-min) (1- (point-at-bol)))
  7141. (point-at-eol)))
  7142. (overlay-put ov 'invisible t)
  7143. (overlay-put ov 'type type)
  7144. (cond ((eq type 'tag) (push ov org-agenda-tag-filter-overlays))
  7145. ((eq type 'category) (push ov org-agenda-cat-filter-overlays))
  7146. ((eq type 'regexp) (push ov org-agenda-re-filter-overlays)))))
  7147. (defun org-agenda-fix-tags-filter-overlays-at (&optional pos)
  7148. (setq pos (or pos (point)))
  7149. (save-excursion
  7150. (dolist (ov (overlays-at pos))
  7151. (when (and (overlay-get ov 'invisible)
  7152. (eq (overlay-get ov 'type) 'tag))
  7153. (goto-char pos)
  7154. (if (< (overlay-start ov) (point-at-eol))
  7155. (move-overlay ov (point-at-eol)
  7156. (overlay-end ov)))))))
  7157. (defun org-agenda-filter-show-all-tag nil
  7158. "Remove tag filter overlays from the agenda buffer."
  7159. (mapc 'delete-overlay org-agenda-tag-filter-overlays)
  7160. (setq org-agenda-tag-filter-overlays nil
  7161. org-agenda-tag-filter nil
  7162. org-agenda-filter-form nil)
  7163. (org-agenda-set-mode-name))
  7164. (defun org-agenda-filter-show-all-re nil
  7165. "Remove regexp filter overlays from the agenda buffer."
  7166. (mapc 'delete-overlay org-agenda-re-filter-overlays)
  7167. (setq org-agenda-re-filter-overlays nil
  7168. org-agenda-regexp-filter nil
  7169. org-agenda-filter-form nil)
  7170. (org-agenda-set-mode-name))
  7171. (defun org-agenda-filter-show-all-cat nil
  7172. "Remove category filter overlays from the agenda buffer."
  7173. (mapc 'delete-overlay org-agenda-cat-filter-overlays)
  7174. (setq org-agenda-cat-filter-overlays nil
  7175. org-agenda-filtered-by-category nil
  7176. org-agenda-category-filter nil
  7177. org-agenda-filter-form nil)
  7178. (org-agenda-set-mode-name))
  7179. (defun org-agenda-manipulate-query-add ()
  7180. "Manipulate the query by adding a search term with positive selection.
  7181. Positive selection means the term must be matched for selection of an entry."
  7182. (interactive)
  7183. (org-agenda-manipulate-query ?\[))
  7184. (defun org-agenda-manipulate-query-subtract ()
  7185. "Manipulate the query by adding a search term with negative selection.
  7186. Negative selection means term must not be matched for selection of an entry."
  7187. (interactive)
  7188. (org-agenda-manipulate-query ?\]))
  7189. (defun org-agenda-manipulate-query-add-re ()
  7190. "Manipulate the query by adding a search regexp with positive selection.
  7191. Positive selection means the regexp must match for selection of an entry."
  7192. (interactive)
  7193. (org-agenda-manipulate-query ?\{))
  7194. (defun org-agenda-manipulate-query-subtract-re ()
  7195. "Manipulate the query by adding a search regexp with negative selection.
  7196. Negative selection means regexp must not match for selection of an entry."
  7197. (interactive)
  7198. (org-agenda-manipulate-query ?\}))
  7199. (defun org-agenda-manipulate-query (char)
  7200. (cond
  7201. ((memq org-agenda-type '(timeline agenda))
  7202. (let ((org-agenda-include-inactive-timestamps t))
  7203. (org-agenda-redo))
  7204. (message "Display now includes inactive timestamps as well"))
  7205. ((eq org-agenda-type 'search)
  7206. (org-add-to-string
  7207. 'org-agenda-query-string
  7208. (if org-agenda-last-search-view-search-was-boolean
  7209. (cdr (assoc char '((?\[ . " +") (?\] . " -")
  7210. (?\{ . " +{}") (?\} . " -{}"))))
  7211. " "))
  7212. (setq org-agenda-redo-command
  7213. (list 'org-search-view
  7214. (car (get-text-property (min (1- (point-max)) (point))
  7215. 'org-last-args))
  7216. org-agenda-query-string
  7217. (+ (length org-agenda-query-string)
  7218. (if (member char '(?\{ ?\})) 0 1))))
  7219. (set-register org-agenda-query-register org-agenda-query-string)
  7220. (let ((org-agenda-overriding-arguments
  7221. (cdr org-agenda-redo-command)))
  7222. (org-agenda-redo)))
  7223. (t (error "Cannot manipulate query for %s-type agenda buffers"
  7224. org-agenda-type))))
  7225. (defun org-add-to-string (var string)
  7226. (set var (concat (symbol-value var) string)))
  7227. (defun org-agenda-goto-date (span)
  7228. "Jump to DATE in agenda."
  7229. (interactive "P")
  7230. (let* ((org-read-date-prefer-future
  7231. (eval org-agenda-jump-prefer-future))
  7232. (date (org-read-date))
  7233. (day (time-to-days (org-time-string-to-time date)))
  7234. (org-agenda-sticky-orig org-agenda-sticky)
  7235. (org-agenda-buffer-tmp-name (buffer-name))
  7236. (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7237. (0-arg (or current-prefix-arg (car args)))
  7238. (2-arg (nth 2 args))
  7239. (with-hour-p (nth 4 org-agenda-redo-command))
  7240. (newcmd (list 'org-agenda-list 0-arg date
  7241. (org-agenda-span-to-ndays
  7242. 2-arg (org-time-string-to-absolute date))
  7243. with-hour-p))
  7244. (newargs (cdr newcmd))
  7245. (inhibit-read-only t)
  7246. org-agenda-sticky)
  7247. (if (not (org-agenda-check-type t 'agenda))
  7248. (error "Not available in non-agenda views")
  7249. (add-text-properties (point-min) (point-max)
  7250. `(org-redo-cmd ,newcmd org-last-args ,newargs))
  7251. (org-agenda-redo)
  7252. (goto-char (point-min))
  7253. (while (not (or (= (or (get-text-property (point) 'day) 0) day)
  7254. (save-excursion (move-beginning-of-line 2) (eobp))))
  7255. (move-beginning-of-line 2))
  7256. (setq org-agenda-sticky org-agenda-sticky-orig
  7257. org-agenda-this-buffer-is-sticky org-agenda-sticky))))
  7258. (defun org-agenda-goto-today ()
  7259. "Go to today."
  7260. (interactive)
  7261. (org-agenda-check-type t 'timeline 'agenda)
  7262. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7263. (curspan (nth 2 args))
  7264. (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
  7265. (cond
  7266. (tdpos (goto-char tdpos))
  7267. ((eq org-agenda-type 'agenda)
  7268. (let* ((sd (org-agenda-compute-starting-span
  7269. (org-today) (or curspan org-agenda-ndays org-agenda-span)))
  7270. (org-agenda-overriding-arguments args))
  7271. (setf (nth 1 org-agenda-overriding-arguments) sd)
  7272. (org-agenda-redo)
  7273. (org-agenda-find-same-or-today-or-agenda)))
  7274. (t (error "Cannot find today")))))
  7275. (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
  7276. (goto-char
  7277. (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
  7278. (text-property-any (point-min) (point-max) 'org-today t)
  7279. (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
  7280. (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
  7281. (org-agenda-goto-block-beginning))
  7282. (point-min))))
  7283. (defun org-agenda-goto-block-beginning ()
  7284. "Go the agenda block beginning."
  7285. (interactive)
  7286. (if (not (derived-mode-p 'org-agenda-mode))
  7287. (error "Cannot execute this command outside of org-agenda-mode buffers")
  7288. (let (dest)
  7289. (save-excursion
  7290. (unless (looking-at "\\'")
  7291. (forward-char))
  7292. (let* ((prop 'org-agenda-structural-header)
  7293. (p (previous-single-property-change (point) prop))
  7294. (n (next-single-property-change (or (and (looking-at "\\`") 1)
  7295. (1- (point))) prop)))
  7296. (setq dest (cond ((eq n (point-at-eol)) (1- n)) (p (1- p))))))
  7297. (if (not dest)
  7298. (error "Cannot find the beginning of the blog")
  7299. (goto-char dest)
  7300. (move-beginning-of-line 1)))))
  7301. (defun org-agenda-later (arg)
  7302. "Go forward in time by the current span.
  7303. With prefix ARG, go forward that many times the current span."
  7304. (interactive "p")
  7305. (org-agenda-check-type t 'agenda)
  7306. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7307. (span (or (nth 2 args) org-agenda-current-span))
  7308. (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
  7309. (greg (calendar-gregorian-from-absolute sd))
  7310. (cnt (org-get-at-bol 'org-day-cnt))
  7311. greg2)
  7312. (cond
  7313. ((numberp span)
  7314. (setq sd (+ (* span arg) sd)))
  7315. ((eq span 'day)
  7316. (setq sd (+ arg sd)))
  7317. ((eq span 'week)
  7318. (setq sd (+ (* 7 arg) sd)))
  7319. ((eq span 'fortnight)
  7320. (setq sd (+ (* 14 arg) sd)))
  7321. ((eq span 'month)
  7322. (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
  7323. sd (calendar-absolute-from-gregorian greg2))
  7324. (setcar greg2 (1+ (car greg2))))
  7325. ((eq span 'year)
  7326. (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
  7327. sd (calendar-absolute-from-gregorian greg2))
  7328. (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
  7329. (t
  7330. (setq sd (+ (* span arg) sd))))
  7331. (let ((org-agenda-overriding-cmd
  7332. ;; `cmd' may have been set by `org-agenda-run-series' which
  7333. ;; uses `org-agenda-overriding-cmd' to decide whether
  7334. ;; overriding is allowed for `cmd'
  7335. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7336. (org-agenda-overriding-arguments
  7337. (list (car args) sd span)))
  7338. (org-agenda-redo)
  7339. (org-agenda-find-same-or-today-or-agenda cnt))))
  7340. (defun org-agenda-earlier (arg)
  7341. "Go backward in time by the current span.
  7342. With prefix ARG, go backward that many times the current span."
  7343. (interactive "p")
  7344. (org-agenda-later (- arg)))
  7345. (defun org-agenda-view-mode-dispatch ()
  7346. "Call one of the view mode commands."
  7347. (interactive)
  7348. (message "View: [d]ay [w]eek for[t]night [m]onth [y]ear [SPC]reset [q]uit/abort
  7349. time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
  7350. [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
  7351. (let ((a (read-char-exclusive)))
  7352. (case a
  7353. (?\ (call-interactively 'org-agenda-reset-view))
  7354. (?d (call-interactively 'org-agenda-day-view))
  7355. (?w (call-interactively 'org-agenda-week-view))
  7356. (?t (call-interactively 'org-agenda-fortnight-view))
  7357. (?m (call-interactively 'org-agenda-month-view))
  7358. (?y (call-interactively 'org-agenda-year-view))
  7359. (?l (call-interactively 'org-agenda-log-mode))
  7360. (?L (org-agenda-log-mode '(4)))
  7361. (?c (org-agenda-log-mode 'clockcheck))
  7362. ((?F ?f) (call-interactively 'org-agenda-follow-mode))
  7363. (?a (call-interactively 'org-agenda-archives-mode))
  7364. (?A (org-agenda-archives-mode 'files))
  7365. ((?R ?r) (call-interactively 'org-agenda-clockreport-mode))
  7366. ((?E ?e) (call-interactively 'org-agenda-entry-text-mode))
  7367. (?G (call-interactively 'org-agenda-toggle-time-grid))
  7368. (?D (call-interactively 'org-agenda-toggle-diary))
  7369. (?\! (call-interactively 'org-agenda-toggle-deadlines))
  7370. (?\[ (let ((org-agenda-include-inactive-timestamps t))
  7371. (org-agenda-check-type t 'timeline 'agenda)
  7372. (org-agenda-redo))
  7373. (message "Display now includes inactive timestamps as well"))
  7374. (?q (message "Abort"))
  7375. (otherwise (error "Invalid key" )))))
  7376. (defun org-agenda-reset-view ()
  7377. "Switch to default view for agenda."
  7378. (interactive)
  7379. (org-agenda-change-time-span (or org-agenda-ndays org-agenda-span)))
  7380. (defun org-agenda-day-view (&optional day-of-month)
  7381. "Switch to daily view for agenda.
  7382. With argument DAY-OF-MONTH, switch to that day of the month."
  7383. (interactive "P")
  7384. (org-agenda-change-time-span 'day day-of-month))
  7385. (defun org-agenda-week-view (&optional iso-week)
  7386. "Switch to daily view for agenda.
  7387. With argument ISO-WEEK, switch to the corresponding ISO week.
  7388. If ISO-WEEK has more then 2 digits, only the last two encode the
  7389. week. Any digits before this encode a year. So 200712 means
  7390. week 12 of year 2007. Years in the range 1938-2037 can also be
  7391. written as 2-digit years."
  7392. (interactive "P")
  7393. (org-agenda-change-time-span 'week iso-week))
  7394. (defun org-agenda-fortnight-view (&optional iso-week)
  7395. "Switch to daily view for agenda.
  7396. With argument ISO-WEEK, switch to the corresponding ISO week.
  7397. If ISO-WEEK has more then 2 digits, only the last two encode the
  7398. week. Any digits before this encode a year. So 200712 means
  7399. week 12 of year 2007. Years in the range 1938-2037 can also be
  7400. written as 2-digit years."
  7401. (interactive "P")
  7402. (org-agenda-change-time-span 'fortnight iso-week))
  7403. (defun org-agenda-month-view (&optional month)
  7404. "Switch to monthly view for agenda.
  7405. With argument MONTH, switch to that month."
  7406. (interactive "P")
  7407. (org-agenda-change-time-span 'month month))
  7408. (defun org-agenda-year-view (&optional year)
  7409. "Switch to yearly view for agenda.
  7410. With argument YEAR, switch to that year.
  7411. If MONTH has more then 2 digits, only the last two encode the
  7412. month. Any digits before this encode a year. So 200712 means
  7413. December year 2007. Years in the range 1938-2037 can also be
  7414. written as 2-digit years."
  7415. (interactive "P")
  7416. (when year
  7417. (setq year (org-small-year-to-year year)))
  7418. (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
  7419. (org-agenda-change-time-span 'year year)
  7420. (error "Abort")))
  7421. (defun org-agenda-change-time-span (span &optional n)
  7422. "Change the agenda view to SPAN.
  7423. SPAN may be `day', `week', `fortnight', `month', `year'."
  7424. (org-agenda-check-type t 'agenda)
  7425. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7426. (curspan (nth 2 args)))
  7427. (if (and (not n) (equal curspan span))
  7428. (error "Viewing span is already \"%s\"" span))
  7429. (let* ((sd (or (org-get-at-bol 'day)
  7430. (nth 1 args)
  7431. org-starting-day))
  7432. (sd (org-agenda-compute-starting-span sd span n))
  7433. (org-agenda-overriding-cmd
  7434. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7435. (org-agenda-overriding-arguments
  7436. (list (car args) sd span)))
  7437. (org-agenda-redo)
  7438. (org-agenda-find-same-or-today-or-agenda))
  7439. (org-agenda-set-mode-name)
  7440. (message "Switched to %s view" span)))
  7441. (defun org-agenda-compute-starting-span (sd span &optional n)
  7442. "Compute starting date for agenda.
  7443. SPAN may be `day', `week', `fortnight', `month', `year'. The return value
  7444. is a cons cell with the starting date and the number of days,
  7445. so that the date SD will be in that range."
  7446. (let* ((greg (calendar-gregorian-from-absolute sd))
  7447. (dg (nth 1 greg))
  7448. (mg (car greg))
  7449. (yg (nth 2 greg)))
  7450. (cond
  7451. ((eq span 'day)
  7452. (when n
  7453. (setq sd (+ (calendar-absolute-from-gregorian
  7454. (list mg 1 yg))
  7455. n -1))))
  7456. ((or (eq span 'week) (eq span 'fortnight))
  7457. (let* ((nt (calendar-day-of-week
  7458. (calendar-gregorian-from-absolute sd)))
  7459. (d (if org-agenda-start-on-weekday
  7460. (- nt org-agenda-start-on-weekday)
  7461. 0))
  7462. y1)
  7463. (setq sd (- sd (+ (if (< d 0) 7 0) d)))
  7464. (when n
  7465. (require 'cal-iso)
  7466. (when (> n 99)
  7467. (setq y1 (org-small-year-to-year (/ n 100))
  7468. n (mod n 100)))
  7469. (setq sd
  7470. (calendar-absolute-from-iso
  7471. (list n 1
  7472. (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
  7473. ((eq span 'month)
  7474. (let (y1)
  7475. (when (and n (> n 99))
  7476. (setq y1 (org-small-year-to-year (/ n 100))
  7477. n (mod n 100)))
  7478. (setq sd (calendar-absolute-from-gregorian
  7479. (list (or n mg) 1 (or y1 yg))))))
  7480. ((eq span 'year)
  7481. (setq sd (calendar-absolute-from-gregorian
  7482. (list 1 1 (or n yg))))))
  7483. sd))
  7484. (defun org-agenda-next-date-line (&optional arg)
  7485. "Jump to the next line indicating a date in agenda buffer."
  7486. (interactive "p")
  7487. (org-agenda-check-type t 'agenda 'timeline)
  7488. (beginning-of-line 1)
  7489. ;; This does not work if user makes date format that starts with a blank
  7490. (if (looking-at "^\\S-") (forward-char 1))
  7491. (if (not (re-search-forward "^\\S-" nil t arg))
  7492. (progn
  7493. (backward-char 1)
  7494. (error "No next date after this line in this buffer")))
  7495. (goto-char (match-beginning 0)))
  7496. (defun org-agenda-previous-date-line (&optional arg)
  7497. "Jump to the previous line indicating a date in agenda buffer."
  7498. (interactive "p")
  7499. (org-agenda-check-type t 'agenda 'timeline)
  7500. (beginning-of-line 1)
  7501. (if (not (re-search-backward "^\\S-" nil t arg))
  7502. (error "No previous date before this line in this buffer")))
  7503. ;; Initialize the highlight
  7504. (defvar org-hl (make-overlay 1 1))
  7505. (overlay-put org-hl 'face 'highlight)
  7506. (defun org-highlight (begin end &optional buffer)
  7507. "Highlight a region with overlay."
  7508. (move-overlay org-hl begin end (or buffer (current-buffer))))
  7509. (defun org-unhighlight ()
  7510. "Detach overlay INDEX."
  7511. (org-detach-overlay org-hl))
  7512. (defun org-unhighlight-once ()
  7513. "Remove the highlight from its position, and this function from the hook."
  7514. (remove-hook 'pre-command-hook 'org-unhighlight-once)
  7515. (org-unhighlight))
  7516. (defvar org-agenda-pre-follow-window-conf nil)
  7517. (defun org-agenda-follow-mode ()
  7518. "Toggle follow mode in an agenda buffer."
  7519. (interactive)
  7520. (unless org-agenda-follow-mode
  7521. (setq org-agenda-pre-follow-window-conf
  7522. (current-window-configuration)))
  7523. (setq org-agenda-follow-mode (not org-agenda-follow-mode))
  7524. (unless org-agenda-follow-mode
  7525. (set-window-configuration org-agenda-pre-follow-window-conf))
  7526. (org-agenda-set-mode-name)
  7527. (org-agenda-do-context-action)
  7528. (message "Follow mode is %s"
  7529. (if org-agenda-follow-mode "on" "off")))
  7530. (defun org-agenda-entry-text-mode (&optional arg)
  7531. "Toggle entry text mode in an agenda buffer."
  7532. (interactive "P")
  7533. (if (or org-agenda-tag-filter
  7534. org-agenda-category-filter
  7535. org-agenda-regexp-filter
  7536. org-agenda-top-headline-filter)
  7537. (user-error "Can't show entry text in filtered views")
  7538. (setq org-agenda-entry-text-mode (or (integerp arg)
  7539. (not org-agenda-entry-text-mode)))
  7540. (org-agenda-entry-text-hide)
  7541. (and org-agenda-entry-text-mode
  7542. (let ((org-agenda-entry-text-maxlines
  7543. (if (integerp arg) arg org-agenda-entry-text-maxlines)))
  7544. (org-agenda-entry-text-show)))
  7545. (org-agenda-set-mode-name)
  7546. (message "Entry text mode is %s%s"
  7547. (if org-agenda-entry-text-mode "on" "off")
  7548. (if (not org-agenda-entry-text-mode) ""
  7549. (format " (maximum number of lines is %d)"
  7550. (if (integerp arg) arg org-agenda-entry-text-maxlines))))))
  7551. (defun org-agenda-clockreport-mode (&optional with-filter)
  7552. "Toggle clocktable mode in an agenda buffer.
  7553. With prefix arg WITH-FILTER, make the clocktable respect the current
  7554. agenda filter."
  7555. (interactive "P")
  7556. (org-agenda-check-type t 'agenda)
  7557. (if with-filter
  7558. (setq org-agenda-clockreport-mode 'with-filter)
  7559. (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode)))
  7560. (org-agenda-set-mode-name)
  7561. (org-agenda-redo)
  7562. (message "Clocktable mode is %s"
  7563. (if org-agenda-clockreport-mode "on" "off")))
  7564. (defun org-agenda-log-mode (&optional special)
  7565. "Toggle log mode in an agenda buffer.
  7566. With argument SPECIAL, show all possible log items, not only the ones
  7567. configured in `org-agenda-log-mode-items'.
  7568. With a double `C-u' prefix arg, show *only* log items, nothing else."
  7569. (interactive "P")
  7570. (org-agenda-check-type t 'agenda 'timeline)
  7571. (setq org-agenda-show-log
  7572. (cond
  7573. ((equal special '(16)) 'only)
  7574. ((eq special 'clockcheck)
  7575. (if (eq org-agenda-show-log 'clockcheck)
  7576. nil 'clockcheck))
  7577. (special '(closed clock state))
  7578. (t (not org-agenda-show-log))))
  7579. (org-agenda-set-mode-name)
  7580. (org-agenda-redo)
  7581. (message "Log mode is %s"
  7582. (if org-agenda-show-log "on" "off")))
  7583. (defun org-agenda-archives-mode (&optional with-files)
  7584. "Toggle inclusion of items in trees marked with :ARCHIVE:.
  7585. When called with a prefix argument, include all archive files as well."
  7586. (interactive "P")
  7587. (setq org-agenda-archives-mode
  7588. (if with-files t (if org-agenda-archives-mode nil 'trees)))
  7589. (org-agenda-set-mode-name)
  7590. (org-agenda-redo)
  7591. (message
  7592. "%s"
  7593. (cond
  7594. ((eq org-agenda-archives-mode nil)
  7595. "No archives are included")
  7596. ((eq org-agenda-archives-mode 'trees)
  7597. (format "Trees with :%s: tag are included" org-archive-tag))
  7598. ((eq org-agenda-archives-mode t)
  7599. (format "Trees with :%s: tag and all active archive files are included"
  7600. org-archive-tag)))))
  7601. (defun org-agenda-toggle-diary ()
  7602. "Toggle diary inclusion in an agenda buffer."
  7603. (interactive)
  7604. (org-agenda-check-type t 'agenda)
  7605. (setq org-agenda-include-diary (not org-agenda-include-diary))
  7606. (org-agenda-redo)
  7607. (org-agenda-set-mode-name)
  7608. (message "Diary inclusion turned %s"
  7609. (if org-agenda-include-diary "on" "off")))
  7610. (defun org-agenda-toggle-deadlines ()
  7611. "Toggle inclusion of entries with a deadline in an agenda buffer."
  7612. (interactive)
  7613. (org-agenda-check-type t 'agenda)
  7614. (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
  7615. (org-agenda-redo)
  7616. (org-agenda-set-mode-name)
  7617. (message "Deadlines inclusion turned %s"
  7618. (if org-agenda-include-deadlines "on" "off")))
  7619. (defun org-agenda-toggle-time-grid ()
  7620. "Toggle time grid in an agenda buffer."
  7621. (interactive)
  7622. (org-agenda-check-type t 'agenda)
  7623. (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
  7624. (org-agenda-redo)
  7625. (org-agenda-set-mode-name)
  7626. (message "Time-grid turned %s"
  7627. (if org-agenda-use-time-grid "on" "off")))
  7628. (defun org-agenda-set-mode-name ()
  7629. "Set the mode name to indicate all the small mode settings."
  7630. (setq mode-name
  7631. (list "Org-Agenda"
  7632. (if (get 'org-agenda-files 'org-restrict) " []" "")
  7633. " "
  7634. '(:eval (org-agenda-span-name org-agenda-current-span))
  7635. (if org-agenda-follow-mode " Follow" "")
  7636. (if org-agenda-entry-text-mode " ETxt" "")
  7637. (if org-agenda-include-diary " Diary" "")
  7638. (if org-agenda-include-deadlines " Ddl" "")
  7639. (if org-agenda-use-time-grid " Grid" "")
  7640. (if (and (boundp 'org-habit-show-habits)
  7641. org-habit-show-habits) " Habit" "")
  7642. (cond
  7643. ((consp org-agenda-show-log) " LogAll")
  7644. ((eq org-agenda-show-log 'clockcheck) " ClkCk")
  7645. (org-agenda-show-log " Log")
  7646. (t ""))
  7647. (if (or org-agenda-category-filter
  7648. (get 'org-agenda-category-filter :preset-filter))
  7649. '(:eval (org-propertize
  7650. (concat " <"
  7651. (mapconcat
  7652. 'identity
  7653. (append
  7654. (get 'org-agenda-category-filter :preset-filter)
  7655. org-agenda-category-filter)
  7656. "")
  7657. ">")
  7658. 'face 'org-agenda-filter-category
  7659. 'help-echo "Category used in filtering")) "")
  7660. (if (or org-agenda-tag-filter
  7661. (get 'org-agenda-tag-filter :preset-filter))
  7662. '(:eval (org-propertize
  7663. (concat " {"
  7664. (mapconcat
  7665. 'identity
  7666. (append
  7667. (get 'org-agenda-tag-filter :preset-filter)
  7668. org-agenda-tag-filter)
  7669. "")
  7670. "}")
  7671. 'face 'org-agenda-filter-tags
  7672. 'help-echo "Tags used in filtering")) "")
  7673. (if (or org-agenda-regexp-filter
  7674. (get 'org-agenda-regexp-filter :preset-filter))
  7675. '(:eval (org-propertize
  7676. (concat " ["
  7677. (mapconcat
  7678. 'identity
  7679. (append
  7680. (get 'org-agenda-regexp-filter :preset-filter)
  7681. org-agenda-regexp-filter)
  7682. "")
  7683. "]")
  7684. 'face 'org-agenda-filter-regexp
  7685. 'help-echo "Regexp used in filtering")) "")
  7686. (if org-agenda-archives-mode
  7687. (if (eq org-agenda-archives-mode t)
  7688. " Archives"
  7689. (format " :%s:" org-archive-tag))
  7690. "")
  7691. (if org-agenda-clockreport-mode
  7692. (if (eq org-agenda-clockreport-mode 'with-filter)
  7693. " Clock{}" " Clock")
  7694. "")))
  7695. (force-mode-line-update))
  7696. (define-obsolete-function-alias
  7697. 'org-agenda-post-command-hook 'org-agenda-update-agenda-type "24.3")
  7698. (defun org-agenda-update-agenda-type ()
  7699. "Update the agenda type after each command."
  7700. (setq org-agenda-type
  7701. (or (get-text-property (point) 'org-agenda-type)
  7702. (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
  7703. (defun org-agenda-next-line ()
  7704. "Move cursor to the next line, and show if follow mode is active."
  7705. (interactive)
  7706. (call-interactively 'next-line)
  7707. (org-agenda-do-context-action))
  7708. (defun org-agenda-previous-line ()
  7709. "Move cursor to the previous line, and show if follow-mode is active."
  7710. (interactive)
  7711. (call-interactively 'previous-line)
  7712. (org-agenda-do-context-action))
  7713. (defun org-agenda-next-item (n)
  7714. "Move cursor to next agenda item."
  7715. (interactive "p")
  7716. (let ((col (current-column)))
  7717. (dotimes (c n)
  7718. (when (next-single-property-change (point-at-eol) 'org-marker)
  7719. (move-end-of-line 1)
  7720. (goto-char (next-single-property-change (point) 'org-marker))))
  7721. (org-move-to-column col nil nil t))
  7722. (org-agenda-do-context-action))
  7723. (defun org-agenda-previous-item (n)
  7724. "Move cursor to next agenda item."
  7725. (interactive "p")
  7726. (dotimes (c n)
  7727. (let ((col (current-column))
  7728. (goto (save-excursion
  7729. (move-end-of-line 0)
  7730. (previous-single-property-change (point) 'org-marker))))
  7731. (if goto (goto-char goto))
  7732. (org-move-to-column col nil nil t)))
  7733. (org-agenda-do-context-action))
  7734. (defun org-agenda-do-context-action ()
  7735. "Show outline path and, maybe, follow mode window."
  7736. (let ((m (org-get-at-bol 'org-marker)))
  7737. (when (and (markerp m) (marker-buffer m))
  7738. (and org-agenda-follow-mode
  7739. (if org-agenda-follow-indirect
  7740. (org-agenda-tree-to-indirect-buffer nil)
  7741. (org-agenda-show)))
  7742. (and org-agenda-show-outline-path
  7743. (org-with-point-at m (org-display-outline-path t))))))
  7744. (defun org-agenda-show-tags ()
  7745. "Show the tags applicable to the current item."
  7746. (interactive)
  7747. (let* ((tags (org-get-at-bol 'tags)))
  7748. (if tags
  7749. (message "Tags are :%s:"
  7750. (org-no-properties (mapconcat 'identity tags ":")))
  7751. (message "No tags associated with this line"))))
  7752. (defun org-agenda-goto (&optional highlight)
  7753. "Go to the Org-mode file which contains the item at point."
  7754. (interactive)
  7755. (let* ((marker (or (org-get-at-bol 'org-marker)
  7756. (org-agenda-error)))
  7757. (buffer (marker-buffer marker))
  7758. (pos (marker-position marker)))
  7759. (switch-to-buffer-other-window buffer)
  7760. (widen)
  7761. (push-mark)
  7762. (goto-char pos)
  7763. (when (derived-mode-p 'org-mode)
  7764. (org-show-context 'agenda)
  7765. (save-excursion
  7766. (and (outline-next-heading)
  7767. (org-flag-heading nil)))) ; show the next heading
  7768. (when (outline-invisible-p)
  7769. (show-entry)) ; display invisible text
  7770. (recenter (/ (window-height) 2))
  7771. (run-hooks 'org-agenda-after-show-hook)
  7772. (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
  7773. (defvar org-agenda-after-show-hook nil
  7774. "Normal hook run after an item has been shown from the agenda.
  7775. Point is in the buffer where the item originated.")
  7776. (defun org-agenda-kill ()
  7777. "Kill the entry or subtree belonging to the current agenda entry."
  7778. (interactive)
  7779. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  7780. (let* ((bufname-orig (buffer-name))
  7781. (marker (or (org-get-at-bol 'org-marker)
  7782. (org-agenda-error)))
  7783. (buffer (marker-buffer marker))
  7784. (pos (marker-position marker))
  7785. (type (org-get-at-bol 'type))
  7786. dbeg dend (n 0) conf)
  7787. (org-with-remote-undo buffer
  7788. (with-current-buffer buffer
  7789. (save-excursion
  7790. (goto-char pos)
  7791. (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
  7792. (setq dbeg (progn (org-back-to-heading t) (point))
  7793. dend (org-end-of-subtree t t))
  7794. (setq dbeg (point-at-bol)
  7795. dend (min (point-max) (1+ (point-at-eol)))))
  7796. (goto-char dbeg)
  7797. (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
  7798. (setq conf (or (eq t org-agenda-confirm-kill)
  7799. (and (numberp org-agenda-confirm-kill)
  7800. (> n org-agenda-confirm-kill))))
  7801. (and conf
  7802. (not (y-or-n-p
  7803. (format "Delete entry with %d lines in buffer \"%s\"? "
  7804. n (buffer-name buffer))))
  7805. (error "Abort"))
  7806. (let ((org-agenda-buffer-name bufname-orig))
  7807. (org-remove-subtree-entries-from-agenda buffer dbeg dend))
  7808. (with-current-buffer buffer (delete-region dbeg dend))
  7809. (message "Agenda item and source killed"))))
  7810. (defvar org-archive-default-command) ; defined in org-archive.el
  7811. (defun org-agenda-archive-default ()
  7812. "Archive the entry or subtree belonging to the current agenda entry."
  7813. (interactive)
  7814. (require 'org-archive)
  7815. (org-agenda-archive-with org-archive-default-command))
  7816. (defun org-agenda-archive-default-with-confirmation ()
  7817. "Archive the entry or subtree belonging to the current agenda entry."
  7818. (interactive)
  7819. (require 'org-archive)
  7820. (org-agenda-archive-with org-archive-default-command 'confirm))
  7821. (defun org-agenda-archive ()
  7822. "Archive the entry or subtree belonging to the current agenda entry."
  7823. (interactive)
  7824. (org-agenda-archive-with 'org-archive-subtree))
  7825. (defun org-agenda-archive-to-archive-sibling ()
  7826. "Move the entry to the archive sibling."
  7827. (interactive)
  7828. (org-agenda-archive-with 'org-archive-to-archive-sibling))
  7829. (defun org-agenda-archive-with (cmd &optional confirm)
  7830. "Move the entry to the archive sibling."
  7831. (interactive)
  7832. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  7833. (let* ((bufname-orig (buffer-name))
  7834. (marker (or (org-get-at-bol 'org-marker)
  7835. (org-agenda-error)))
  7836. (buffer (marker-buffer marker))
  7837. (pos (marker-position marker)))
  7838. (org-with-remote-undo buffer
  7839. (with-current-buffer buffer
  7840. (if (derived-mode-p 'org-mode)
  7841. (if (and confirm
  7842. (not (y-or-n-p "Archive this subtree or entry? ")))
  7843. (error "Abort")
  7844. (save-window-excursion
  7845. (goto-char pos)
  7846. (let ((org-agenda-buffer-name bufname-orig))
  7847. (org-remove-subtree-entries-from-agenda))
  7848. (org-back-to-heading t)
  7849. (funcall cmd)))
  7850. (error "Archiving works only in Org-mode files"))))))
  7851. (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
  7852. "Remove all lines in the agenda that correspond to a given subtree.
  7853. The subtree is the one in buffer BUF, starting at BEG and ending at END.
  7854. If this information is not given, the function uses the tree at point."
  7855. (let ((buf (or buf (current-buffer))) m p)
  7856. (save-excursion
  7857. (unless (and beg end)
  7858. (org-back-to-heading t)
  7859. (setq beg (point))
  7860. (org-end-of-subtree t)
  7861. (setq end (point)))
  7862. (set-buffer (get-buffer org-agenda-buffer-name))
  7863. (save-excursion
  7864. (goto-char (point-max))
  7865. (beginning-of-line 1)
  7866. (while (not (bobp))
  7867. (when (and (setq m (org-get-at-bol 'org-marker))
  7868. (equal buf (marker-buffer m))
  7869. (setq p (marker-position m))
  7870. (>= p beg)
  7871. (< p end))
  7872. (let ((inhibit-read-only t))
  7873. (delete-region (point-at-bol) (1+ (point-at-eol)))))
  7874. (beginning-of-line 0))))))
  7875. (defun org-agenda-refile (&optional goto rfloc no-update)
  7876. "Refile the item at point.
  7877. When GOTO is 0 or '(64), clear the refile cache.
  7878. When GOTO is '(16), go to the location of the last refiled item.
  7879. RFLOC can be a refile location obtained in a different way.
  7880. When NO-UPDATE is non-nil, don't redo the agenda buffer."
  7881. (interactive "P")
  7882. (cond
  7883. ((member goto '(0 (64)))
  7884. (org-refile-cache-clear))
  7885. ((equal goto '(16))
  7886. (org-refile-goto-last-stored))
  7887. (t
  7888. (let* ((buffer-orig (buffer-name))
  7889. (marker (or (org-get-at-bol 'org-hd-marker)
  7890. (org-agenda-error)))
  7891. (buffer (marker-buffer marker))
  7892. (pos (marker-position marker))
  7893. (rfloc (or rfloc
  7894. (org-refile-get-location
  7895. (if goto "Goto" "Refile to") buffer
  7896. org-refile-allow-creating-parent-nodes))))
  7897. (with-current-buffer buffer
  7898. (save-excursion
  7899. (save-restriction
  7900. (widen)
  7901. (goto-char marker)
  7902. (let ((org-agenda-buffer-name buffer-orig))
  7903. (org-remove-subtree-entries-from-agenda))
  7904. (org-refile goto buffer rfloc)))))
  7905. (unless no-update (org-agenda-redo)))))
  7906. (defun org-agenda-open-link (&optional arg)
  7907. "Open the link(s) in the current entry, if any.
  7908. This looks for a link in the displayed line in the agenda.
  7909. It also looks at the text of the entry itself."
  7910. (interactive "P")
  7911. (let* ((marker (or (org-get-at-bol 'org-hd-marker)
  7912. (org-get-at-bol 'org-marker)))
  7913. (buffer (and marker (marker-buffer marker)))
  7914. (prefix (buffer-substring (point-at-bol) (point-at-eol)))
  7915. (lkall (org-offer-links-in-entry buffer marker arg prefix))
  7916. (lk0 (car lkall))
  7917. (lk (if (stringp lk0) (list lk0) lk0))
  7918. (lkend (cdr lkall))
  7919. trg)
  7920. (cond
  7921. ((and buffer lk)
  7922. (mapcar (lambda(l)
  7923. (with-current-buffer buffer
  7924. (setq trg (and (string-match org-bracket-link-regexp l)
  7925. (match-string 1 l)))
  7926. (if (or (not trg) (string-match org-any-link-re trg))
  7927. (save-excursion
  7928. (save-restriction
  7929. (widen)
  7930. (goto-char marker)
  7931. (when (search-forward l nil lkend)
  7932. (goto-char (match-beginning 0))
  7933. (org-open-at-point))))
  7934. ;; This is an internal link, widen the buffer
  7935. (switch-to-buffer-other-window buffer)
  7936. (widen)
  7937. (goto-char marker)
  7938. (when (search-forward l nil lkend)
  7939. (goto-char (match-beginning 0))
  7940. (org-open-at-point)))))
  7941. lk))
  7942. ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
  7943. (save-excursion
  7944. (beginning-of-line 1)
  7945. (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
  7946. (org-open-link-from-string (match-string 1)))
  7947. (t (message "No link to open here")))))
  7948. (defun org-agenda-copy-local-variable (var)
  7949. "Get a variable from a referenced buffer and install it here."
  7950. (let ((m (org-get-at-bol 'org-marker)))
  7951. (when (and m (buffer-live-p (marker-buffer m)))
  7952. (org-set-local var (with-current-buffer (marker-buffer m)
  7953. (symbol-value var))))))
  7954. (defun org-agenda-switch-to (&optional delete-other-windows)
  7955. "Go to the Org-mode file which contains the item at point."
  7956. (interactive)
  7957. (if (and org-return-follows-link
  7958. (not (org-get-at-bol 'org-marker))
  7959. (org-in-regexp org-bracket-link-regexp))
  7960. (org-open-link-from-string (match-string 0))
  7961. (let* ((marker (or (org-get-at-bol 'org-marker)
  7962. (org-agenda-error)))
  7963. (buffer (marker-buffer marker))
  7964. (pos (marker-position marker)))
  7965. (org-pop-to-buffer-same-window buffer)
  7966. (and delete-other-windows (delete-other-windows))
  7967. (widen)
  7968. (goto-char pos)
  7969. (when (derived-mode-p 'org-mode)
  7970. (org-show-context 'agenda)
  7971. (save-excursion
  7972. (and (outline-next-heading)
  7973. (org-flag-heading nil))) ; show the next heading
  7974. (when (outline-invisible-p)
  7975. (show-entry)) ; display invisible text
  7976. (run-hooks 'org-agenda-after-show-hook)))))
  7977. (defun org-agenda-goto-mouse (ev)
  7978. "Go to the Org-mode file which contains the item at the mouse click."
  7979. (interactive "e")
  7980. (mouse-set-point ev)
  7981. (org-agenda-goto))
  7982. (defun org-agenda-show (&optional full-entry)
  7983. "Display the Org-mode file which contains the item at point.
  7984. With prefix argument FULL-ENTRY, make the entire entry visible
  7985. if it was hidden in the outline."
  7986. (interactive "P")
  7987. (let ((win (selected-window)))
  7988. (if full-entry
  7989. (let ((org-show-entry-below t))
  7990. (org-agenda-goto t))
  7991. (org-agenda-goto t))
  7992. (select-window win)))
  7993. (defvar org-agenda-show-window nil)
  7994. (defun org-agenda-show-and-scroll-up (&optional arg)
  7995. "Display the Org-mode file which contains the item at point.
  7996. When called repeatedly, scroll the window that is displaying the buffer.
  7997. With a \\[universal-argument] prefix, use `org-show-entry' instead of
  7998. `show-subtree' to display the item, so that drawers and logbooks stay
  7999. folded."
  8000. (interactive "P")
  8001. (let ((win (selected-window)))
  8002. (if (and (window-live-p org-agenda-show-window)
  8003. (eq this-command last-command))
  8004. (progn
  8005. (select-window org-agenda-show-window)
  8006. (ignore-errors (scroll-up)))
  8007. (org-agenda-goto t)
  8008. (if arg (org-show-entry) (show-subtree))
  8009. (setq org-agenda-show-window (selected-window)))
  8010. (select-window win)))
  8011. (defun org-agenda-show-scroll-down ()
  8012. "Scroll down the window showing the agenda."
  8013. (interactive)
  8014. (let ((win (selected-window)))
  8015. (when (window-live-p org-agenda-show-window)
  8016. (select-window org-agenda-show-window)
  8017. (ignore-errors (scroll-down))
  8018. (select-window win))))
  8019. (defun org-agenda-show-1 (&optional more)
  8020. "Display the Org-mode file which contains the item at point.
  8021. The prefix arg selects the amount of information to display:
  8022. 0 hide the subtree
  8023. 1 just show the entry according to defaults.
  8024. 2 show the children view
  8025. 3 show the subtree view
  8026. 4 show the entire subtree and any LOGBOOK drawers
  8027. 5 show the entire subtree and any drawers
  8028. With prefix argument FULL-ENTRY, make the entire entry visible
  8029. if it was hidden in the outline."
  8030. (interactive "p")
  8031. (let ((win (selected-window)))
  8032. (org-agenda-goto t)
  8033. (org-recenter-heading 1)
  8034. (cond
  8035. ((= more 0)
  8036. (hide-subtree)
  8037. (save-excursion
  8038. (org-back-to-heading)
  8039. (run-hook-with-args 'org-cycle-hook 'folded))
  8040. (message "Remote: FOLDED"))
  8041. ((and (org-called-interactively-p 'any) (= more 1))
  8042. (message "Remote: show with default settings"))
  8043. ((= more 2)
  8044. (show-entry)
  8045. (show-children)
  8046. (save-excursion
  8047. (org-back-to-heading)
  8048. (run-hook-with-args 'org-cycle-hook 'children))
  8049. (message "Remote: CHILDREN"))
  8050. ((= more 3)
  8051. (show-subtree)
  8052. (save-excursion
  8053. (org-back-to-heading)
  8054. (run-hook-with-args 'org-cycle-hook 'subtree))
  8055. (message "Remote: SUBTREE"))
  8056. ((= more 4)
  8057. (show-subtree)
  8058. (save-excursion
  8059. (org-back-to-heading)
  8060. (org-cycle-hide-drawers 'subtree '("LOGBOOK")))
  8061. (message "Remote: SUBTREE AND LOGBOOK"))
  8062. ((> more 4)
  8063. (show-subtree)
  8064. (message "Remote: SUBTREE AND ALL DRAWERS")))
  8065. (select-window win)))
  8066. (defun org-recenter-heading (n)
  8067. (save-excursion
  8068. (org-back-to-heading)
  8069. (recenter n)))
  8070. (defvar org-agenda-cycle-counter nil)
  8071. (defun org-agenda-cycle-show (&optional n)
  8072. "Show the current entry in another window, with default settings.
  8073. Default settings are taken from `org-show-hierarchy-above' and siblings.
  8074. When use repeatedly in immediate succession, the remote entry will cycle
  8075. through visibility
  8076. children -> subtree -> folded
  8077. When called with a numeric prefix arg, that arg will be passed through to
  8078. `org-agenda-show-1'. For the interpretation of that argument, see the
  8079. docstring of `org-agenda-show-1'."
  8080. (interactive "P")
  8081. (if (integerp n)
  8082. (setq org-agenda-cycle-counter n)
  8083. (if (not (eq last-command this-command))
  8084. (setq org-agenda-cycle-counter 1)
  8085. (if (equal org-agenda-cycle-counter 0)
  8086. (setq org-agenda-cycle-counter 2)
  8087. (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
  8088. (if (> org-agenda-cycle-counter 3)
  8089. (setq org-agenda-cycle-counter 0)))))
  8090. (org-agenda-show-1 org-agenda-cycle-counter))
  8091. (defun org-agenda-recenter (arg)
  8092. "Display the Org-mode file which contains the item at point and recenter."
  8093. (interactive "P")
  8094. (let ((win (selected-window)))
  8095. (org-agenda-goto t)
  8096. (recenter arg)
  8097. (select-window win)))
  8098. (defun org-agenda-show-mouse (ev)
  8099. "Display the Org-mode file which contains the item at the mouse click."
  8100. (interactive "e")
  8101. (mouse-set-point ev)
  8102. (org-agenda-show))
  8103. (defun org-agenda-check-no-diary ()
  8104. "Check if the entry is a diary link and abort if yes."
  8105. (if (org-get-at-bol 'org-agenda-diary-link)
  8106. (org-agenda-error)))
  8107. (defun org-agenda-error ()
  8108. (error "Command not allowed in this line"))
  8109. (defun org-agenda-tree-to-indirect-buffer (arg)
  8110. "Show the subtree corresponding to the current entry in an indirect buffer.
  8111. This calls the command `org-tree-to-indirect-buffer' from the original buffer.
  8112. With a numerical prefix ARG, go up to this level and then take that tree.
  8113. With a negative numeric ARG, go up by this number of levels.
  8114. With a \\[universal-argument] prefix, make a separate frame for this tree (i.e. don't
  8115. use the dedicated frame)."
  8116. (interactive "P")
  8117. (if current-prefix-arg
  8118. (org-agenda-do-tree-to-indirect-buffer arg)
  8119. (let ((agenda-buffer (buffer-name))
  8120. (agenda-window (selected-window))
  8121. (indirect-window
  8122. (and org-last-indirect-buffer
  8123. (get-buffer-window org-last-indirect-buffer))))
  8124. (save-window-excursion (org-agenda-do-tree-to-indirect-buffer arg))
  8125. (unless (or (eq org-indirect-buffer-display 'new-frame)
  8126. (eq org-indirect-buffer-display 'dedicated-frame))
  8127. (unwind-protect
  8128. (unless (and indirect-window (window-live-p indirect-window))
  8129. (setq indirect-window (split-window agenda-window)))
  8130. (and indirect-window (select-window indirect-window))
  8131. (switch-to-buffer org-last-indirect-buffer :norecord)
  8132. (fit-window-to-buffer indirect-window)))
  8133. (select-window (get-buffer-window agenda-buffer)))))
  8134. (defun org-agenda-do-tree-to-indirect-buffer (arg)
  8135. "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
  8136. (org-agenda-check-no-diary)
  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. (with-current-buffer buffer
  8142. (save-excursion
  8143. (goto-char pos)
  8144. (funcall 'org-tree-to-indirect-buffer arg)))))
  8145. (defvar org-last-heading-marker (make-marker)
  8146. "Marker pointing to the headline that last changed its TODO state
  8147. by a remote command from the agenda.")
  8148. (defun org-agenda-todo-nextset ()
  8149. "Switch TODO entry to next sequence."
  8150. (interactive)
  8151. (org-agenda-todo 'nextset))
  8152. (defun org-agenda-todo-previousset ()
  8153. "Switch TODO entry to previous sequence."
  8154. (interactive)
  8155. (org-agenda-todo 'previousset))
  8156. (defun org-agenda-todo (&optional arg)
  8157. "Cycle TODO state of line at point, also in Org-mode file.
  8158. This changes the line at point, all other lines in the agenda referring to
  8159. the same tree node, and the headline of the tree node in the Org-mode file."
  8160. (interactive "P")
  8161. (org-agenda-check-no-diary)
  8162. (let* ((col (current-column))
  8163. (marker (or (org-get-at-bol 'org-marker)
  8164. (org-agenda-error)))
  8165. (buffer (marker-buffer marker))
  8166. (pos (marker-position marker))
  8167. (hdmarker (org-get-at-bol 'org-hd-marker))
  8168. (todayp (org-agenda-todayp (org-get-at-bol 'day)))
  8169. (inhibit-read-only t)
  8170. org-agenda-headline-snapshot-before-repeat newhead just-one)
  8171. (org-with-remote-undo buffer
  8172. (with-current-buffer buffer
  8173. (widen)
  8174. (goto-char pos)
  8175. (org-show-context 'agenda)
  8176. (save-excursion
  8177. (and (outline-next-heading)
  8178. (org-flag-heading nil))) ; show the next heading
  8179. (let ((current-prefix-arg arg))
  8180. (call-interactively 'org-todo))
  8181. (and (bolp) (forward-char 1))
  8182. (setq newhead (org-get-heading))
  8183. (when (and (org-bound-and-true-p
  8184. org-agenda-headline-snapshot-before-repeat)
  8185. (not (equal org-agenda-headline-snapshot-before-repeat
  8186. newhead))
  8187. todayp)
  8188. (setq newhead org-agenda-headline-snapshot-before-repeat
  8189. just-one t))
  8190. (save-excursion
  8191. (org-back-to-heading)
  8192. (move-marker org-last-heading-marker (point))))
  8193. (beginning-of-line 1)
  8194. (save-excursion
  8195. (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
  8196. (when (org-bound-and-true-p org-clock-out-when-done)
  8197. (string-match (concat "^" (regexp-opt org-done-keywords-for-agenda))
  8198. newhead)
  8199. (org-agenda-unmark-clocking-task))
  8200. (org-move-to-column col nil nil t))))
  8201. (defun org-agenda-add-note (&optional arg)
  8202. "Add a time-stamped note to the entry at point."
  8203. (interactive "P")
  8204. (org-agenda-check-no-diary)
  8205. (let* ((marker (or (org-get-at-bol 'org-marker)
  8206. (org-agenda-error)))
  8207. (buffer (marker-buffer marker))
  8208. (pos (marker-position marker))
  8209. (hdmarker (org-get-at-bol 'org-hd-marker))
  8210. (inhibit-read-only t))
  8211. (with-current-buffer buffer
  8212. (widen)
  8213. (goto-char pos)
  8214. (org-show-context 'agenda)
  8215. (save-excursion
  8216. (and (outline-next-heading)
  8217. (org-flag-heading nil))) ; show the next heading
  8218. (org-add-note))))
  8219. (defun org-agenda-change-all-lines (newhead hdmarker
  8220. &optional fixface just-this)
  8221. "Change all lines in the agenda buffer which match HDMARKER.
  8222. The new content of the line will be NEWHEAD (as modified by
  8223. `org-agenda-format-item'). HDMARKER is checked with
  8224. `equal' against all `org-hd-marker' text properties in the file.
  8225. If FIXFACE is non-nil, the face of each item is modified according to
  8226. the new TODO state.
  8227. If JUST-THIS is non-nil, change just the current line, not all.
  8228. If FORCE-TAGS is non nil, the car of it returns the new tags."
  8229. (let* ((inhibit-read-only t)
  8230. (line (org-current-line))
  8231. (org-agenda-buffer (current-buffer))
  8232. (thetags (with-current-buffer (marker-buffer hdmarker)
  8233. (save-excursion (save-restriction (widen)
  8234. (goto-char hdmarker)
  8235. (org-get-tags-at)))))
  8236. props m pl undone-face done-face finish new dotime level cat tags)
  8237. (save-excursion
  8238. (goto-char (point-max))
  8239. (beginning-of-line 1)
  8240. (while (not finish)
  8241. (setq finish (bobp))
  8242. (when (and (setq m (org-get-at-bol 'org-hd-marker))
  8243. (or (not just-this) (= (org-current-line) line))
  8244. (equal m hdmarker))
  8245. (setq props (text-properties-at (point))
  8246. dotime (org-get-at-bol 'dotime)
  8247. cat (org-get-at-bol 'org-category)
  8248. level (org-get-at-bol 'level)
  8249. tags thetags
  8250. new
  8251. (let ((org-prefix-format-compiled
  8252. (or (get-text-property (min (1- (point-max)) (point)) 'format)
  8253. org-prefix-format-compiled))
  8254. (extra (org-get-at-bol 'extra)))
  8255. (with-current-buffer (marker-buffer hdmarker)
  8256. (save-excursion
  8257. (save-restriction
  8258. (widen)
  8259. (org-agenda-format-item extra newhead level cat tags dotime)))))
  8260. pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
  8261. undone-face (org-get-at-bol 'undone-face)
  8262. done-face (org-get-at-bol 'done-face))
  8263. (beginning-of-line 1)
  8264. (cond
  8265. ((equal new "")
  8266. (and (looking-at ".*\n?") (replace-match "")))
  8267. ((looking-at ".*")
  8268. (replace-match new t t)
  8269. (beginning-of-line 1)
  8270. (add-text-properties (point-at-bol) (point-at-eol) props)
  8271. (when fixface
  8272. (add-text-properties
  8273. (point-at-bol) (point-at-eol)
  8274. (list 'face
  8275. (if org-last-todo-state-is-todo
  8276. undone-face done-face))))
  8277. (org-agenda-highlight-todo 'line)
  8278. (beginning-of-line 1))
  8279. (t (error "Line update did not work")))
  8280. (save-restriction
  8281. (narrow-to-region (point-at-bol) (point-at-eol))
  8282. (org-agenda-finalize)))
  8283. (beginning-of-line 0)))))
  8284. (defun org-agenda-align-tags (&optional line)
  8285. "Align all tags in agenda items to `org-agenda-tags-column'."
  8286. (let ((inhibit-read-only t) l c)
  8287. (save-excursion
  8288. (goto-char (if line (point-at-bol) (point-min)))
  8289. (while (re-search-forward (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
  8290. (if line (point-at-eol) nil) t)
  8291. (add-text-properties
  8292. (match-beginning 2) (match-end 2)
  8293. (list 'face (delq nil (let ((prop (get-text-property
  8294. (match-beginning 2) 'face)))
  8295. (or (listp prop) (setq prop (list prop)))
  8296. (if (memq 'org-tag prop)
  8297. prop
  8298. (cons 'org-tag prop))))))
  8299. (setq l (- (match-end 2) (match-beginning 2))
  8300. c (if (< org-agenda-tags-column 0)
  8301. (- (abs org-agenda-tags-column) l)
  8302. org-agenda-tags-column))
  8303. (delete-region (match-beginning 1) (match-end 1))
  8304. (goto-char (match-beginning 1))
  8305. (insert (org-add-props
  8306. (make-string (max 1 (- c (current-column))) ?\ )
  8307. (plist-put (copy-sequence (text-properties-at (point)))
  8308. 'face nil))))
  8309. (goto-char (point-min))
  8310. (org-font-lock-add-tag-faces (point-max)))))
  8311. (defun org-agenda-priority-up ()
  8312. "Increase the priority of line at point, also in Org-mode file."
  8313. (interactive)
  8314. (org-agenda-priority 'up))
  8315. (defun org-agenda-priority-down ()
  8316. "Decrease the priority of line at point, also in Org-mode file."
  8317. (interactive)
  8318. (org-agenda-priority 'down))
  8319. (defun org-agenda-priority (&optional force-direction)
  8320. "Set the priority of line at point, also in Org-mode file.
  8321. This changes the line at point, all other lines in the agenda referring to
  8322. the same tree node, and the headline of the tree node in the Org-mode file.
  8323. Called with a universal prefix arg, show the priority instead of setting it."
  8324. (interactive "P")
  8325. (if (equal force-direction '(4))
  8326. (org-show-priority)
  8327. (unless org-enable-priority-commands
  8328. (error "Priority commands are disabled"))
  8329. (org-agenda-check-no-diary)
  8330. (let* ((col (current-column))
  8331. (marker (or (org-get-at-bol 'org-marker)
  8332. (org-agenda-error)))
  8333. (hdmarker (org-get-at-bol 'org-hd-marker))
  8334. (buffer (marker-buffer hdmarker))
  8335. (pos (marker-position hdmarker))
  8336. (inhibit-read-only t)
  8337. newhead)
  8338. (org-with-remote-undo buffer
  8339. (with-current-buffer buffer
  8340. (widen)
  8341. (goto-char pos)
  8342. (org-show-context 'agenda)
  8343. (save-excursion
  8344. (and (outline-next-heading)
  8345. (org-flag-heading nil))) ; show the next heading
  8346. (funcall 'org-priority force-direction)
  8347. (end-of-line 1)
  8348. (setq newhead (org-get-heading)))
  8349. (org-agenda-change-all-lines newhead hdmarker)
  8350. (org-move-to-column col nil nil t)))))
  8351. ;; FIXME: should fix the tags property of the agenda line.
  8352. (defun org-agenda-set-tags (&optional tag onoff)
  8353. "Set tags for the current headline."
  8354. (interactive)
  8355. (org-agenda-check-no-diary)
  8356. (if (and (org-region-active-p) (org-called-interactively-p 'any))
  8357. (call-interactively 'org-change-tag-in-region)
  8358. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8359. (org-agenda-error)))
  8360. (buffer (marker-buffer hdmarker))
  8361. (pos (marker-position hdmarker))
  8362. (inhibit-read-only t)
  8363. newhead)
  8364. (org-with-remote-undo buffer
  8365. (with-current-buffer buffer
  8366. (widen)
  8367. (goto-char pos)
  8368. (save-excursion
  8369. (org-show-context 'agenda))
  8370. (save-excursion
  8371. (and (outline-next-heading)
  8372. (org-flag-heading nil))) ; show the next heading
  8373. (goto-char pos)
  8374. (if tag
  8375. (org-toggle-tag tag onoff)
  8376. (call-interactively 'org-set-tags))
  8377. (end-of-line 1)
  8378. (setq newhead (org-get-heading)))
  8379. (org-agenda-change-all-lines newhead hdmarker)
  8380. (beginning-of-line 1)))))
  8381. (defun org-agenda-set-property ()
  8382. "Set a property for the current headline."
  8383. (interactive)
  8384. (org-agenda-check-no-diary)
  8385. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8386. (org-agenda-error)))
  8387. (buffer (marker-buffer hdmarker))
  8388. (pos (marker-position hdmarker))
  8389. (inhibit-read-only t)
  8390. newhead)
  8391. (org-with-remote-undo buffer
  8392. (with-current-buffer buffer
  8393. (widen)
  8394. (goto-char pos)
  8395. (save-excursion
  8396. (org-show-context 'agenda))
  8397. (save-excursion
  8398. (and (outline-next-heading)
  8399. (org-flag-heading nil))) ; show the next heading
  8400. (goto-char pos)
  8401. (call-interactively 'org-set-property)))))
  8402. (defun org-agenda-set-effort ()
  8403. "Set the effort property for the current headline."
  8404. (interactive)
  8405. (org-agenda-check-no-diary)
  8406. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8407. (org-agenda-error)))
  8408. (buffer (marker-buffer hdmarker))
  8409. (pos (marker-position hdmarker))
  8410. (inhibit-read-only t)
  8411. newhead)
  8412. (org-with-remote-undo buffer
  8413. (with-current-buffer buffer
  8414. (widen)
  8415. (goto-char pos)
  8416. (save-excursion
  8417. (org-show-context 'agenda))
  8418. (save-excursion
  8419. (and (outline-next-heading)
  8420. (org-flag-heading nil))) ; show the next heading
  8421. (goto-char pos)
  8422. (call-interactively 'org-set-effort)
  8423. (end-of-line 1)
  8424. (setq newhead (org-get-heading)))
  8425. (org-agenda-change-all-lines newhead hdmarker))))
  8426. (defun org-agenda-toggle-archive-tag ()
  8427. "Toggle the archive tag for the current entry."
  8428. (interactive)
  8429. (org-agenda-check-no-diary)
  8430. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8431. (org-agenda-error)))
  8432. (buffer (marker-buffer hdmarker))
  8433. (pos (marker-position hdmarker))
  8434. (inhibit-read-only t)
  8435. newhead)
  8436. (org-with-remote-undo buffer
  8437. (with-current-buffer buffer
  8438. (widen)
  8439. (goto-char pos)
  8440. (org-show-context 'agenda)
  8441. (save-excursion
  8442. (and (outline-next-heading)
  8443. (org-flag-heading nil))) ; show the next heading
  8444. (call-interactively 'org-toggle-archive-tag)
  8445. (end-of-line 1)
  8446. (setq newhead (org-get-heading)))
  8447. (org-agenda-change-all-lines newhead hdmarker)
  8448. (beginning-of-line 1))))
  8449. (defun org-agenda-do-date-later (arg)
  8450. (interactive "P")
  8451. (cond
  8452. ((or (equal arg '(16))
  8453. (memq last-command
  8454. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  8455. (setq this-command 'org-agenda-date-later-minutes)
  8456. (org-agenda-date-later-minutes 1))
  8457. ((or (equal arg '(4))
  8458. (memq last-command
  8459. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  8460. (setq this-command 'org-agenda-date-later-hours)
  8461. (org-agenda-date-later-hours 1))
  8462. (t
  8463. (org-agenda-date-later (prefix-numeric-value arg)))))
  8464. (defun org-agenda-do-date-earlier (arg)
  8465. (interactive "P")
  8466. (cond
  8467. ((or (equal arg '(16))
  8468. (memq last-command
  8469. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  8470. (setq this-command 'org-agenda-date-earlier-minutes)
  8471. (org-agenda-date-earlier-minutes 1))
  8472. ((or (equal arg '(4))
  8473. (memq last-command
  8474. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  8475. (setq this-command 'org-agenda-date-earlier-hours)
  8476. (org-agenda-date-earlier-hours 1))
  8477. (t
  8478. (org-agenda-date-earlier (prefix-numeric-value arg)))))
  8479. (defun org-agenda-date-later (arg &optional what)
  8480. "Change the date of this item to ARG day(s) later."
  8481. (interactive "p")
  8482. (org-agenda-check-type t 'agenda 'timeline)
  8483. (org-agenda-check-no-diary)
  8484. (let* ((marker (or (org-get-at-bol 'org-marker)
  8485. (org-agenda-error)))
  8486. (buffer (marker-buffer marker))
  8487. (pos (marker-position marker))
  8488. cdate today)
  8489. (org-with-remote-undo buffer
  8490. (with-current-buffer buffer
  8491. (widen)
  8492. (goto-char pos)
  8493. (if (not (org-at-timestamp-p))
  8494. (error "Cannot find time stamp"))
  8495. (when (and org-agenda-move-date-from-past-immediately-to-today
  8496. (equal arg 1)
  8497. (or (not what) (eq what 'day))
  8498. (not (save-match-data (org-at-date-range-p))))
  8499. (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
  8500. cdate (calendar-absolute-from-gregorian
  8501. (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
  8502. today (org-today))
  8503. (if (> today cdate)
  8504. ;; immediately shift to today
  8505. (setq arg (- today cdate))))
  8506. (org-timestamp-change arg (or what 'day))
  8507. (when (and (org-at-date-range-p)
  8508. (re-search-backward org-tr-regexp-both (point-at-bol)))
  8509. (let ((end org-last-changed-timestamp))
  8510. (org-timestamp-change arg (or what 'day))
  8511. (setq org-last-changed-timestamp
  8512. (concat org-last-changed-timestamp "--" end)))))
  8513. (org-agenda-show-new-time marker org-last-changed-timestamp))
  8514. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  8515. (defun org-agenda-date-earlier (arg &optional what)
  8516. "Change the date of this item to ARG day(s) earlier."
  8517. (interactive "p")
  8518. (org-agenda-date-later (- arg) what))
  8519. (defun org-agenda-date-later-minutes (arg)
  8520. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  8521. (interactive "p")
  8522. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  8523. (org-agenda-date-later arg 'minute))
  8524. (defun org-agenda-date-earlier-minutes (arg)
  8525. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  8526. (interactive "p")
  8527. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  8528. (org-agenda-date-earlier arg 'minute))
  8529. (defun org-agenda-date-later-hours (arg)
  8530. "Change the time of this item, in hour steps."
  8531. (interactive "p")
  8532. (org-agenda-date-later arg 'hour))
  8533. (defun org-agenda-date-earlier-hours (arg)
  8534. "Change the time of this item, in hour steps."
  8535. (interactive "p")
  8536. (org-agenda-date-earlier arg 'hour))
  8537. (defun org-agenda-show-new-time (marker stamp &optional prefix)
  8538. "Show new date stamp via text properties."
  8539. ;; We use text properties to make this undoable
  8540. (let ((inhibit-read-only t))
  8541. (setq stamp (concat prefix " => " stamp " "))
  8542. (save-excursion
  8543. (goto-char (point-max))
  8544. (while (not (bobp))
  8545. (when (equal marker (org-get-at-bol 'org-marker))
  8546. (org-move-to-column (- (window-width) (length stamp)) t nil t)
  8547. (org-agenda-fix-tags-filter-overlays-at (point))
  8548. (if (featurep 'xemacs)
  8549. ;; Use `duplicable' property to trigger undo recording
  8550. (let ((ex (make-extent nil nil))
  8551. (gl (make-glyph stamp)))
  8552. (set-glyph-face gl 'secondary-selection)
  8553. (set-extent-properties
  8554. ex (list 'invisible t 'end-glyph gl 'duplicable t))
  8555. (insert-extent ex (1- (point)) (point-at-eol)))
  8556. (add-text-properties
  8557. (1- (point)) (point-at-eol)
  8558. (list 'display (org-add-props stamp nil
  8559. 'face 'secondary-selection))))
  8560. (beginning-of-line 1))
  8561. (beginning-of-line 0)))))
  8562. (defun org-agenda-date-prompt (arg)
  8563. "Change the date of this item. Date is prompted for, with default today.
  8564. The prefix ARG is passed to the `org-time-stamp' command and can therefore
  8565. be used to request time specification in the time stamp."
  8566. (interactive "P")
  8567. (org-agenda-check-type t 'agenda 'timeline)
  8568. (org-agenda-check-no-diary)
  8569. (let* ((marker (or (org-get-at-bol 'org-marker)
  8570. (org-agenda-error)))
  8571. (buffer (marker-buffer marker))
  8572. (pos (marker-position marker)))
  8573. (org-with-remote-undo buffer
  8574. (with-current-buffer buffer
  8575. (widen)
  8576. (goto-char pos)
  8577. (if (not (org-at-timestamp-p t))
  8578. (error "Cannot find time stamp"))
  8579. (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
  8580. (org-agenda-show-new-time marker org-last-changed-timestamp))
  8581. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  8582. (defun org-agenda-schedule (arg &optional time)
  8583. "Schedule the item at point.
  8584. ARG is passed through to `org-schedule'."
  8585. (interactive "P")
  8586. (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
  8587. (org-agenda-check-no-diary)
  8588. (let* ((marker (or (org-get-at-bol 'org-marker)
  8589. (org-agenda-error)))
  8590. (type (marker-insertion-type marker))
  8591. (buffer (marker-buffer marker))
  8592. (pos (marker-position marker))
  8593. (org-insert-labeled-timestamps-at-point nil)
  8594. ts)
  8595. (set-marker-insertion-type marker t)
  8596. (org-with-remote-undo buffer
  8597. (with-current-buffer buffer
  8598. (widen)
  8599. (goto-char pos)
  8600. (setq ts (org-schedule arg time)))
  8601. (org-agenda-show-new-time marker ts " S"))
  8602. (message "%s" ts)))
  8603. (defun org-agenda-deadline (arg &optional time)
  8604. "Schedule the item at point.
  8605. ARG is passed through to `org-deadline'."
  8606. (interactive "P")
  8607. (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
  8608. (org-agenda-check-no-diary)
  8609. (let* ((marker (or (org-get-at-bol 'org-marker)
  8610. (org-agenda-error)))
  8611. (buffer (marker-buffer marker))
  8612. (pos (marker-position marker))
  8613. (org-insert-labeled-timestamps-at-point nil)
  8614. ts)
  8615. (org-with-remote-undo buffer
  8616. (with-current-buffer buffer
  8617. (widen)
  8618. (goto-char pos)
  8619. (setq ts (org-deadline arg time)))
  8620. (org-agenda-show-new-time marker ts " D"))
  8621. (message "%s" ts)))
  8622. (defun org-agenda-clock-in (&optional arg)
  8623. "Start the clock on the currently selected item."
  8624. (interactive "P")
  8625. (org-agenda-check-no-diary)
  8626. (if (equal arg '(4))
  8627. (org-clock-in arg)
  8628. (let* ((marker (or (org-get-at-bol 'org-marker)
  8629. (org-agenda-error)))
  8630. (hdmarker (or (org-get-at-bol 'org-hd-marker) marker))
  8631. (pos (marker-position marker))
  8632. (col (current-column))
  8633. newhead)
  8634. (org-with-remote-undo (marker-buffer marker)
  8635. (with-current-buffer (marker-buffer marker)
  8636. (widen)
  8637. (goto-char pos)
  8638. (org-show-context 'agenda)
  8639. (org-show-entry)
  8640. (org-cycle-hide-drawers 'children)
  8641. (org-clock-in arg)
  8642. (setq newhead (org-get-heading)))
  8643. (org-agenda-change-all-lines newhead hdmarker))
  8644. (org-move-to-column col nil nil