org-agenda.el 383 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903
  1. ;;; org-agenda.el --- Dynamic task and appointment lists for Org
  2. ;; Copyright (C) 2004-2013 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-datetree-find-date-create "org-datetree"
  64. (date &optional keep-restriction))
  65. (declare-function org-columns-quit "org-colview" ())
  66. (declare-function diary-date-display-form "diary-lib" (&optional type))
  67. (declare-function org-mobile-write-agenda-for-mobile "org-mobile" (file))
  68. (declare-function org-habit-insert-consistency-graphs
  69. "org-habit" (&optional line))
  70. (declare-function org-is-habit-p "org-habit" (&optional pom))
  71. (declare-function org-habit-parse-todo "org-habit" (&optional pom))
  72. (declare-function org-habit-get-priority "org-habit" (habit &optional moment))
  73. (declare-function org-pop-to-buffer-same-window "org-compat"
  74. (&optional buffer-or-name norecord label))
  75. (declare-function org-agenda-columns "org-colview" ())
  76. (declare-function org-add-archive-files "org-archive" (files))
  77. (declare-function org-capture "org-capture" (&optional goto keys))
  78. (defvar calendar-mode-map) ; defined in calendar.el
  79. (defvar org-clock-current-task nil) ; defined in org-clock.el
  80. (defvar org-mobile-force-id-on-agenda-items) ; defined in org-mobile.el
  81. (defvar org-habit-show-habits) ; defined in org-habit.el
  82. (defvar org-habit-show-habits-only-for-today)
  83. (defvar org-habit-show-all-today)
  84. ;; Defined somewhere in this file, but used before definition.
  85. (defvar org-agenda-buffer-name "*Org Agenda*")
  86. (defvar org-agenda-overriding-header nil)
  87. (defvar org-agenda-title-append nil)
  88. (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  89. (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  90. (defvar original-date) ; dynamically scoped, calendar.el does scope this
  91. (defvar org-agenda-undo-list nil
  92. "List of undoable operations in the agenda since last refresh.")
  93. (defvar org-agenda-pending-undo-list nil
  94. "In a series of undo commands, this is the list of remaining undo items.")
  95. (defcustom org-agenda-confirm-kill 1
  96. "When set, remote killing from the agenda buffer needs confirmation.
  97. When t, a confirmation is always needed. When a number N, confirmation is
  98. only needed when the text to be killed contains more than N non-white lines."
  99. :group 'org-agenda
  100. :type '(choice
  101. (const :tag "Never" nil)
  102. (const :tag "Always" t)
  103. (integer :tag "When more than N lines")))
  104. (defcustom org-agenda-compact-blocks nil
  105. "Non-nil means make the block agenda more compact.
  106. This is done globally by leaving out lines like the agenda span
  107. name and week number or the separator lines."
  108. :group 'org-agenda
  109. :type 'boolean)
  110. (defcustom org-agenda-block-separator ?=
  111. "The separator between blocks in the agenda.
  112. If this is a string, it will be used as the separator, with a newline added.
  113. If it is a character, it will be repeated to fill the window width.
  114. If nil the separator is disabled. In `org-agenda-custom-commands' this
  115. addresses the separator between the current and the previous block."
  116. :group 'org-agenda
  117. :type '(choice
  118. (const :tag "Disabled" nil)
  119. (character)
  120. (string)))
  121. (defgroup org-agenda-export nil
  122. "Options concerning exporting agenda views in Org-mode."
  123. :tag "Org Agenda Export"
  124. :group 'org-agenda)
  125. (defcustom org-agenda-with-colors t
  126. "Non-nil means use colors in agenda views."
  127. :group 'org-agenda-export
  128. :type 'boolean)
  129. (defcustom org-agenda-exporter-settings nil
  130. "Alist of variable/value pairs that should be active during agenda export.
  131. This is a good place to set options for ps-print and for htmlize.
  132. Note that the way this is implemented, the values will be evaluated
  133. before assigned to the variables. So make sure to quote values you do
  134. *not* want evaluated, for example
  135. (setq org-agenda-exporter-settings
  136. '((ps-print-color-p 'black-white)))"
  137. :group 'org-agenda-export
  138. :type '(repeat
  139. (list
  140. (variable)
  141. (sexp :tag "Value"))))
  142. (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
  143. "Hook run in a temporary buffer before writing the agenda to an export file.
  144. A useful function for this hook is `org-agenda-add-entry-text'."
  145. :group 'org-agenda-export
  146. :type 'hook
  147. :options '(org-agenda-add-entry-text))
  148. (defcustom org-agenda-add-entry-text-maxlines 0
  149. "Maximum number of entry text lines to be added to agenda.
  150. This is only relevant when `org-agenda-add-entry-text' is part of
  151. `org-agenda-before-write-hook', which is the default.
  152. When this is 0, nothing will happen. When it is greater than 0, it
  153. specifies the maximum number of lines that will be added for each entry
  154. that is listed in the agenda view.
  155. Note that this variable is not used during display, only when exporting
  156. the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
  157. and `org-agenda-entry-text-maxlines'."
  158. :group 'org-agenda
  159. :type 'integer)
  160. (defcustom org-agenda-add-entry-text-descriptive-links t
  161. "Non-nil means export org-links as descriptive links in agenda added text.
  162. This variable applies to the text added to the agenda when
  163. `org-agenda-add-entry-text-maxlines' is larger than 0.
  164. When this variable nil, the URL will (also) be shown."
  165. :group 'org-agenda
  166. :type 'boolean)
  167. (defcustom org-agenda-export-html-style nil
  168. "The style specification for exported HTML Agenda files.
  169. If this variable contains a string, it will replace the default <style>
  170. section as produced by `htmlize'.
  171. Since there are different ways of setting style information, this variable
  172. needs to contain the full HTML structure to provide a style, including the
  173. surrounding HTML tags. The style specifications should include definitions
  174. the fonts used by the agenda, here is an example:
  175. <style type=\"text/css\">
  176. p { font-weight: normal; color: gray; }
  177. .org-agenda-structure {
  178. font-size: 110%;
  179. color: #003399;
  180. font-weight: 600;
  181. }
  182. .org-todo {
  183. color: #cc6666;
  184. font-weight: bold;
  185. }
  186. .org-agenda-done {
  187. color: #339933;
  188. }
  189. .org-done {
  190. color: #339933;
  191. }
  192. .title { text-align: center; }
  193. .todo, .deadline { color: red; }
  194. .done { color: green; }
  195. </style>
  196. or, if you want to keep the style in a file,
  197. <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
  198. As the value of this option simply gets inserted into the HTML <head> header,
  199. you can \"misuse\" it to also add other text to the header."
  200. :group 'org-agenda-export
  201. :group 'org-export-html
  202. :type 'string)
  203. (defcustom org-agenda-persistent-filter nil
  204. "When set, keep filters from one agenda view to the next."
  205. :group 'org-agenda
  206. :type 'boolean)
  207. (defgroup org-agenda-custom-commands nil
  208. "Options concerning agenda views in Org-mode."
  209. :tag "Org Agenda Custom Commands"
  210. :group 'org-agenda)
  211. (defconst org-sorting-choice
  212. '(choice
  213. (const time-up) (const time-down)
  214. (const timestamp-up) (const timestamp-down)
  215. (const scheduled-up) (const scheduled-down)
  216. (const deadline-up) (const deadline-down)
  217. (const ts-up) (const ts-down)
  218. (const tsia-up) (const tsia-down)
  219. (const category-keep) (const category-up) (const category-down)
  220. (const tag-down) (const tag-up)
  221. (const priority-up) (const priority-down)
  222. (const todo-state-up) (const todo-state-down)
  223. (const effort-up) (const effort-down)
  224. (const habit-up) (const habit-down)
  225. (const alpha-up) (const alpha-down)
  226. (const user-defined-up) (const user-defined-down))
  227. "Sorting choices.")
  228. ;; Keep custom values for `org-agenda-filter-preset' compatible with
  229. ;; the new variable `org-agenda-tag-filter-preset'.
  230. (if (fboundp 'defvaralias)
  231. (defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
  232. (defvaralias 'org-agenda-filter 'org-agenda-tag-filter))
  233. (defconst org-agenda-custom-commands-local-options
  234. `(repeat :tag "Local settings for this command. Remember to quote values"
  235. (choice :tag "Setting"
  236. (list :tag "Heading for this block"
  237. (const org-agenda-overriding-header)
  238. (string :tag "Headline"))
  239. (list :tag "Files to be searched"
  240. (const org-agenda-files)
  241. (list
  242. (const :format "" quote)
  243. (repeat (file))))
  244. (list :tag "Sorting strategy"
  245. (const org-agenda-sorting-strategy)
  246. (list
  247. (const :format "" quote)
  248. (repeat
  249. ,org-sorting-choice)))
  250. (list :tag "Prefix format"
  251. (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
  252. (string))
  253. (list :tag "Number of days in agenda"
  254. (const org-agenda-span)
  255. (choice (const :tag "Day" 'day)
  256. (const :tag "Week" 'week)
  257. (const :tag "Month" 'month)
  258. (const :tag "Year" 'year)
  259. (integer :tag "Custom")))
  260. (list :tag "Fixed starting date"
  261. (const org-agenda-start-day)
  262. (string :value "2007-11-01"))
  263. (list :tag "Start on day of week"
  264. (const org-agenda-start-on-weekday)
  265. (choice :value 1
  266. (const :tag "Today" nil)
  267. (integer :tag "Weekday No.")))
  268. (list :tag "Include data from diary"
  269. (const org-agenda-include-diary)
  270. (boolean))
  271. (list :tag "Deadline Warning days"
  272. (const org-deadline-warning-days)
  273. (integer :value 1))
  274. (list :tag "Category filter preset"
  275. (const org-agenda-category-filter-preset)
  276. (list
  277. (const :format "" quote)
  278. (repeat
  279. (string :tag "+category or -category"))))
  280. (list :tag "Tags filter preset"
  281. (const org-agenda-tag-filter-preset)
  282. (list
  283. (const :format "" quote)
  284. (repeat
  285. (string :tag "+tag or -tag"))))
  286. (list :tag "Regexp filter preset"
  287. (const org-agenda-regexp-filter-preset)
  288. (list
  289. (const :format "" quote)
  290. (repeat
  291. (string :tag "+regexp or -regexp"))))
  292. (list :tag "Set daily/weekly entry types"
  293. (const org-agenda-entry-types)
  294. (list
  295. (const :format "" quote)
  296. (set :greedy t :value (:deadline :scheduled :timestamp :sexp)
  297. (const :deadline)
  298. (const :scheduled)
  299. (const :deadline*)
  300. (const :scheduled*)
  301. (const :timestamp)
  302. (const :sexp))))
  303. (list :tag "Standard skipping condition"
  304. :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
  305. (const org-agenda-skip-function)
  306. (list
  307. (const :format "" quote)
  308. (list
  309. (choice
  310. :tag "Skipping range"
  311. (const :tag "Skip entry" org-agenda-skip-entry-if)
  312. (const :tag "Skip subtree" org-agenda-skip-subtree-if))
  313. (repeat :inline t :tag "Conditions for skipping"
  314. (choice
  315. :tag "Condition type"
  316. (list :tag "Regexp matches" :inline t (const :format "" 'regexp) (regexp))
  317. (list :tag "Regexp does not match" :inline t (const :format "" 'notregexp) (regexp))
  318. (list :tag "TODO state is" :inline t
  319. (const 'todo)
  320. (choice
  321. (const :tag "any not-done state" 'todo)
  322. (const :tag "any done state" 'done)
  323. (const :tag "any state" 'any)
  324. (list :tag "Keyword list"
  325. (const :format "" quote)
  326. (repeat (string :tag "Keyword")))))
  327. (list :tag "TODO state is not" :inline t
  328. (const 'nottodo)
  329. (choice
  330. (const :tag "any not-done state" 'todo)
  331. (const :tag "any done state" 'done)
  332. (const :tag "any state" 'any)
  333. (list :tag "Keyword list"
  334. (const :format "" quote)
  335. (repeat (string :tag "Keyword")))))
  336. (const :tag "scheduled" 'scheduled)
  337. (const :tag "not scheduled" 'notscheduled)
  338. (const :tag "deadline" 'deadline)
  339. (const :tag "no deadline" 'notdeadline)
  340. (const :tag "timestamp" 'timestamp)
  341. (const :tag "no timestamp" 'nottimestamp))))))
  342. (list :tag "Non-standard skipping condition"
  343. :value (org-agenda-skip-function)
  344. (const org-agenda-skip-function)
  345. (sexp :tag "Function or form (quoted!)"))
  346. (list :tag "Any variable"
  347. (variable :tag "Variable")
  348. (sexp :tag "Value (sexp)"))))
  349. "Selection of examples for agenda command settings.
  350. This will be spliced into the custom type of
  351. `org-agenda-custom-commands'.")
  352. (defcustom org-agenda-custom-commands '(("n" "Agenda and all TODO's"
  353. ((agenda "") (alltodo))))
  354. "Custom commands for the agenda.
  355. These commands will be offered on the splash screen displayed by the
  356. agenda dispatcher \\[org-agenda]. Each entry is a list like this:
  357. (key desc type match settings files)
  358. key The key (one or more characters as a string) to be associated
  359. with the command.
  360. desc A description of the command, when omitted or nil, a default
  361. description is built using MATCH.
  362. type The command type, any of the following symbols:
  363. agenda The daily/weekly agenda.
  364. todo Entries with a specific TODO keyword, in all agenda files.
  365. search Entries containing search words entry or headline.
  366. tags Tags/Property/TODO match in all agenda files.
  367. tags-todo Tags/P/T match in all agenda files, TODO entries only.
  368. todo-tree Sparse tree of specific TODO keyword in *current* file.
  369. tags-tree Sparse tree with all tags matches in *current* file.
  370. occur-tree Occur sparse tree for *current* file.
  371. ... A user-defined function.
  372. match What to search for:
  373. - a single keyword for TODO keyword searches
  374. - a tags match expression for tags searches
  375. - a word search expression for text searches.
  376. - a regular expression for occur searches
  377. For all other commands, this should be the empty string.
  378. settings A list of option settings, similar to that in a let form, so like
  379. this: ((opt1 val1) (opt2 val2) ...). The values will be
  380. evaluated at the moment of execution, so quote them when needed.
  381. files A list of files file to write the produced agenda buffer to
  382. with the command `org-store-agenda-views'.
  383. If a file name ends in \".html\", an HTML version of the buffer
  384. is written out. If it ends in \".ps\", a postscript version is
  385. produced. Otherwise, only the plain text is written to the file.
  386. You can also define a set of commands, to create a composite agenda buffer.
  387. In this case, an entry looks like this:
  388. (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
  389. where
  390. desc A description string to be displayed in the dispatcher menu.
  391. cmd An agenda command, similar to the above. However, tree commands
  392. are not allowed, but instead you can get agenda and global todo list.
  393. So valid commands for a set are:
  394. (agenda \"\" settings)
  395. (alltodo \"\" settings)
  396. (stuck \"\" settings)
  397. (todo \"match\" settings files)
  398. (search \"match\" settings files)
  399. (tags \"match\" settings files)
  400. (tags-todo \"match\" settings files)
  401. Each command can carry a list of options, and another set of options can be
  402. given for the whole set of commands. Individual command options take
  403. precedence over the general options.
  404. When using several characters as key to a command, the first characters
  405. are prefix commands. For the dispatcher to display useful information, you
  406. should provide a description for the prefix, like
  407. (setq org-agenda-custom-commands
  408. '((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
  409. (\"hl\" tags \"+HOME+Lisa\")
  410. (\"hp\" tags \"+HOME+Peter\")
  411. (\"hk\" tags \"+HOME+Kim\")))"
  412. :group 'org-agenda-custom-commands
  413. :type `(repeat
  414. (choice :value ("x" "Describe command here" tags "" nil)
  415. (list :tag "Single command"
  416. (string :tag "Access Key(s) ")
  417. (option (string :tag "Description"))
  418. (choice
  419. (const :tag "Agenda" agenda)
  420. (const :tag "TODO list" alltodo)
  421. (const :tag "Search words" search)
  422. (const :tag "Stuck projects" stuck)
  423. (const :tag "Tags/Property match (all agenda files)" tags)
  424. (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
  425. (const :tag "TODO keyword search (all agenda files)" todo)
  426. (const :tag "Tags sparse tree (current buffer)" tags-tree)
  427. (const :tag "TODO keyword tree (current buffer)" todo-tree)
  428. (const :tag "Occur tree (current buffer)" occur-tree)
  429. (sexp :tag "Other, user-defined function"))
  430. (string :tag "Match (only for some commands)")
  431. ,org-agenda-custom-commands-local-options
  432. (option (repeat :tag "Export" (file :tag "Export to"))))
  433. (list :tag "Command series, all agenda files"
  434. (string :tag "Access Key(s)")
  435. (string :tag "Description ")
  436. (repeat :tag "Component"
  437. (choice
  438. (list :tag "Agenda"
  439. (const :format "" agenda)
  440. (const :tag "" :format "" "")
  441. ,org-agenda-custom-commands-local-options)
  442. (list :tag "TODO list (all keywords)"
  443. (const :format "" alltodo)
  444. (const :tag "" :format "" "")
  445. ,org-agenda-custom-commands-local-options)
  446. (list :tag "Search words"
  447. (const :format "" search)
  448. (string :tag "Match")
  449. ,org-agenda-custom-commands-local-options)
  450. (list :tag "Stuck projects"
  451. (const :format "" stuck)
  452. (const :tag "" :format "" "")
  453. ,org-agenda-custom-commands-local-options)
  454. (list :tag "Tags search"
  455. (const :format "" tags)
  456. (string :tag "Match")
  457. ,org-agenda-custom-commands-local-options)
  458. (list :tag "Tags search, TODO entries only"
  459. (const :format "" tags-todo)
  460. (string :tag "Match")
  461. ,org-agenda-custom-commands-local-options)
  462. (list :tag "TODO keyword search"
  463. (const :format "" todo)
  464. (string :tag "Match")
  465. ,org-agenda-custom-commands-local-options)
  466. (list :tag "Other, user-defined function"
  467. (symbol :tag "function")
  468. (string :tag "Match")
  469. ,org-agenda-custom-commands-local-options)))
  470. (repeat :tag "Settings for entire command set"
  471. (list (variable :tag "Any variable")
  472. (sexp :tag "Value")))
  473. (option (repeat :tag "Export" (file :tag "Export to"))))
  474. (cons :tag "Prefix key documentation"
  475. (string :tag "Access Key(s)")
  476. (string :tag "Description ")))))
  477. (defcustom org-agenda-query-register ?o
  478. "The register holding the current query string.
  479. The purpose of this is that if you construct a query string interactively,
  480. you can then use it to define a custom command."
  481. :group 'org-agenda-custom-commands
  482. :type 'character)
  483. (defcustom org-stuck-projects
  484. '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
  485. "How to identify stuck projects.
  486. This is a list of four items:
  487. 1. A tags/todo/property matcher string that is used to identify a project.
  488. See the manual for a description of tag and property searches.
  489. The entire tree below a headline matched by this is considered one project.
  490. 2. A list of TODO keywords identifying non-stuck projects.
  491. If the project subtree contains any headline with one of these todo
  492. keywords, the project is considered to be not stuck. If you specify
  493. \"*\" as a keyword, any TODO keyword will mark the project unstuck.
  494. 3. A list of tags identifying non-stuck projects.
  495. If the project subtree contains any headline with one of these tags,
  496. the project is considered to be not stuck. If you specify \"*\" as
  497. a tag, any tag will mark the project unstuck. Note that this is about
  498. the explicit presence of a tag somewhere in the subtree, inherited
  499. tags do not count here. If inherited tags make a project not stuck,
  500. use \"-TAG\" in the tags part of the matcher under (1.) above.
  501. 4. An arbitrary regular expression matching non-stuck projects.
  502. If the project turns out to be not stuck, search continues also in the
  503. subtree to see if any of the subtasks have project status.
  504. See also the variable `org-tags-match-list-sublevels' which applies
  505. to projects matched by this search as well.
  506. After defining this variable, you may use \\[org-agenda-list-stuck-projects]
  507. or `C-c a #' to produce the list."
  508. :group 'org-agenda-custom-commands
  509. :type '(list
  510. (string :tag "Tags/TODO match to identify a project")
  511. (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
  512. (repeat :tag "Projects are *not* stuck if they have an entry with TAG being any of" (string))
  513. (regexp :tag "Projects are *not* stuck if this regexp matches inside the subtree")))
  514. (defcustom org-agenda-filter-effort-default-operator "<"
  515. "The default operator for effort estimate filtering.
  516. If you select an effort estimate limit without first pressing an operator,
  517. this one will be used."
  518. :group 'org-agenda-custom-commands
  519. :type '(choice (const :tag "less or equal" "<")
  520. (const :tag "greater or equal"">")
  521. (const :tag "equal" "=")))
  522. (defgroup org-agenda-skip nil
  523. "Options concerning skipping parts of agenda files."
  524. :tag "Org Agenda Skip"
  525. :group 'org-agenda)
  526. (defcustom org-agenda-skip-function-global nil
  527. "Function to be called at each match during agenda construction.
  528. If this function returns nil, the current match should not be skipped.
  529. If the function decided to skip an agenda match, is must return the
  530. buffer position from which the search should be continued.
  531. This may also be a Lisp form, which will be evaluated.
  532. This variable will be applied to every agenda match, including
  533. tags/property searches and TODO lists. So try to make the test function
  534. do its checking as efficiently as possible. To implement a skipping
  535. condition just for specific agenda commands, use the variable
  536. `org-agenda-skip-function' which can be set in the options section
  537. of custom agenda commands."
  538. :group 'org-agenda-skip
  539. :type 'sexp)
  540. (defgroup org-agenda-daily/weekly nil
  541. "Options concerning the daily/weekly agenda."
  542. :tag "Org Agenda Daily/Weekly"
  543. :group 'org-agenda)
  544. (defgroup org-agenda-todo-list nil
  545. "Options concerning the global todo list agenda view."
  546. :tag "Org Agenda Todo List"
  547. :group 'org-agenda)
  548. (defgroup org-agenda-match-view nil
  549. "Options concerning the general tags/property/todo match agenda view."
  550. :tag "Org Agenda Match View"
  551. :group 'org-agenda)
  552. (defgroup org-agenda-search-view nil
  553. "Options concerning the general tags/property/todo match agenda view."
  554. :tag "Org Agenda Match View"
  555. :group 'org-agenda)
  556. (defvar org-agenda-archives-mode nil
  557. "Non-nil means the agenda will include archived items.
  558. If this is the symbol `trees', trees in the selected agenda scope
  559. that are marked with the ARCHIVE tag will be included anyway. When this is
  560. t, also all archive files associated with the current selection of agenda
  561. files will be included.")
  562. (defcustom org-agenda-skip-comment-trees t
  563. "Non-nil means skip trees that start with the COMMENT keyword.
  564. When nil, these trees are also scanned by agenda commands."
  565. :group 'org-agenda-skip
  566. :type 'boolean)
  567. (defcustom org-agenda-todo-list-sublevels t
  568. "Non-nil means check also the sublevels of a TODO entry for TODO entries.
  569. When nil, the sublevels of a TODO entry are not checked, resulting in
  570. potentially much shorter TODO lists."
  571. :group 'org-agenda-skip
  572. :group 'org-agenda-todo-list
  573. :type 'boolean)
  574. (defcustom org-agenda-todo-ignore-with-date nil
  575. "Non-nil means don't show entries with a date in the global todo list.
  576. You can use this if you prefer to mark mere appointments with a TODO keyword,
  577. but don't want them to show up in the TODO list.
  578. When this is set, it also covers deadlines and scheduled items, the settings
  579. of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
  580. will be ignored.
  581. See also the variable `org-agenda-tags-todo-honor-ignore-options'."
  582. :group 'org-agenda-skip
  583. :group 'org-agenda-todo-list
  584. :type 'boolean)
  585. (defcustom org-agenda-todo-ignore-timestamp nil
  586. "Non-nil means don't show entries with a timestamp.
  587. This applies when creating the global todo list.
  588. Valid values are:
  589. past Don't show entries for today or in the past.
  590. future Don't show entries with a timestamp in the future.
  591. The idea behind this is that if it has a future
  592. timestamp, you don't want to think about it until the
  593. date.
  594. all Don't show any entries with a timestamp in the global todo list.
  595. The idea behind this is that by setting a timestamp, you
  596. have already \"taken care\" of this item.
  597. This variable can also have an integer as a value. If positive (N),
  598. todos with a timestamp N or more days in the future will be ignored. If
  599. negative (-N), todos with a timestamp N or more days in the past will be
  600. ignored. If 0, todos with a timestamp either today or in the future will
  601. be ignored. For example, a value of -1 will exclude todos with a
  602. timestamp in the past (yesterday or earlier), while a value of 7 will
  603. exclude todos with a timestamp a week or more in the future.
  604. See also `org-agenda-todo-ignore-with-date'.
  605. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  606. to make his option also apply to the tags-todo list."
  607. :group 'org-agenda-skip
  608. :group 'org-agenda-todo-list
  609. :version "24.1"
  610. :type '(choice
  611. (const :tag "Ignore future timestamp todos" future)
  612. (const :tag "Ignore past or present timestamp todos" past)
  613. (const :tag "Ignore all timestamp todos" all)
  614. (const :tag "Show timestamp todos" nil)
  615. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  616. (defcustom org-agenda-todo-ignore-scheduled nil
  617. "Non-nil means, ignore some scheduled TODO items when making TODO list.
  618. This applies when creating the global todo list.
  619. Valid values are:
  620. past Don't show entries scheduled today or in the past.
  621. future Don't show entries scheduled in the future.
  622. The idea behind this is that by scheduling it, you don't want to
  623. think about it until the scheduled date.
  624. all Don't show any scheduled entries in the global todo list.
  625. The idea behind this is that by scheduling it, you have already
  626. \"taken care\" of this item.
  627. t Same as `all', for backward compatibility.
  628. This variable can also have an integer as a value. See
  629. `org-agenda-todo-ignore-timestamp' for more details.
  630. See also `org-agenda-todo-ignore-with-date'.
  631. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  632. to make his option also apply to the tags-todo list."
  633. :group 'org-agenda-skip
  634. :group 'org-agenda-todo-list
  635. :type '(choice
  636. (const :tag "Ignore future-scheduled todos" future)
  637. (const :tag "Ignore past- or present-scheduled todos" past)
  638. (const :tag "Ignore all scheduled todos" all)
  639. (const :tag "Ignore all scheduled todos (compatibility)" t)
  640. (const :tag "Show scheduled todos" nil)
  641. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  642. (defcustom org-agenda-todo-ignore-deadlines nil
  643. "Non-nil means ignore some deadlined TODO items when making TODO list.
  644. There are different motivations for using different values, please think
  645. carefully when configuring this variable.
  646. This applies when creating the global todo list.
  647. Valid values are:
  648. near Don't show near deadline entries. A deadline is near when it is
  649. closer than `org-deadline-warning-days' days. The idea behind this
  650. is that such items will appear in the agenda anyway.
  651. far Don't show TODO entries where a deadline has been defined, but
  652. the deadline is not near. This is useful if you don't want to
  653. use the todo list to figure out what to do now.
  654. past Don't show entries with a deadline timestamp for today or in the past.
  655. future Don't show entries with a deadline timestamp in the future, not even
  656. when they become `near' ones. Use it with caution.
  657. all Ignore all TODO entries that do have a deadline.
  658. t Same as `near', for backward compatibility.
  659. This variable can also have an integer as a value. See
  660. `org-agenda-todo-ignore-timestamp' for more details.
  661. See also `org-agenda-todo-ignore-with-date'.
  662. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  663. to make his option also apply to the tags-todo list."
  664. :group 'org-agenda-skip
  665. :group 'org-agenda-todo-list
  666. :type '(choice
  667. (const :tag "Ignore near deadlines" near)
  668. (const :tag "Ignore near deadlines (compatibility)" t)
  669. (const :tag "Ignore far deadlines" far)
  670. (const :tag "Ignore all TODOs with a deadlines" all)
  671. (const :tag "Show all TODOs, even if they have a deadline" nil)
  672. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  673. (defcustom org-agenda-todo-ignore-time-comparison-use-seconds nil
  674. "Time unit to use when possibly ignoring an agenda item.
  675. See the docstring of various `org-agenda-todo-ignore-*' options.
  676. The default is to compare time stamps using days. An item is thus
  677. considered to be in the future if it is at least one day after today.
  678. Non-nil means to compare time stamps using seconds. An item is then
  679. considered future if it has a time value later than current time."
  680. :group 'org-agenda-skip
  681. :group 'org-agenda-todo-list
  682. :version "24.4"
  683. :package-version '(Org . "8.0")
  684. :type '(choice
  685. (const :tag "Compare time with days" nil)
  686. (const :tag "Compare time with seconds" t)))
  687. (defcustom org-agenda-tags-todo-honor-ignore-options nil
  688. "Non-nil means honor todo-list ignores options also in tags-todo search.
  689. The variables
  690. `org-agenda-todo-ignore-with-date',
  691. `org-agenda-todo-ignore-timestamp',
  692. `org-agenda-todo-ignore-scheduled',
  693. `org-agenda-todo-ignore-deadlines'
  694. make the global TODO list skip entries that have time stamps of certain
  695. kinds. If this option is set, the same options will also apply for the
  696. tags-todo search, which is the general tags/property matcher
  697. restricted to unfinished TODO entries only."
  698. :group 'org-agenda-skip
  699. :group 'org-agenda-todo-list
  700. :group 'org-agenda-match-view
  701. :type 'boolean)
  702. (defcustom org-agenda-skip-scheduled-if-done nil
  703. "Non-nil means don't show scheduled items in agenda when they are done.
  704. This is relevant for the daily/weekly agenda, not for the TODO list. And
  705. it applies only to the actual date of the scheduling. Warnings about
  706. an item with a past scheduling dates are always turned off when the item
  707. is DONE."
  708. :group 'org-agenda-skip
  709. :group 'org-agenda-daily/weekly
  710. :type 'boolean)
  711. (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
  712. "Non-nil means skip scheduling line if same entry shows because of deadline.
  713. In the agenda of today, an entry can show up multiple times
  714. because it is both scheduled and has a nearby deadline, and maybe
  715. a plain time stamp as well.
  716. When this variable is nil, the entry will be shown several times.
  717. When set to t, then only the deadline is shown and the fact that
  718. the entry is scheduled today or was scheduled previously is not
  719. shown.
  720. When set to the symbol `not-today', skip scheduled previously,
  721. but not scheduled today.
  722. When set to the symbol `repeated-after-deadline', skip scheduled
  723. items if they are repeated beyond the current dealine."
  724. :group 'org-agenda-skip
  725. :group 'org-agenda-daily/weekly
  726. :type '(choice
  727. (const :tag "Never" nil)
  728. (const :tag "Always" t)
  729. (const :tag "Not when scheduled today" not-today)
  730. (const :tag "When repeated past deadline" repeated-after-deadline)))
  731. (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
  732. "Non-nil means skip timestamp line if same entry shows because of deadline.
  733. In the agenda of today, an entry can show up multiple times
  734. because it has both a plain timestamp and has a nearby deadline.
  735. When this variable is t, then only the deadline is shown and the
  736. fact that the entry has a timestamp for or including today is not
  737. shown. When this variable is nil, the entry will be shown
  738. several times."
  739. :group 'org-agenda-skip
  740. :group 'org-agenda-daily/weekly
  741. :version "24.1"
  742. :type '(choice
  743. (const :tag "Never" nil)
  744. (const :tag "Always" t)))
  745. (defcustom org-agenda-skip-deadline-if-done nil
  746. "Non-nil means don't show deadlines when the corresponding item is done.
  747. When nil, the deadline is still shown and should give you a happy feeling.
  748. This is relevant for the daily/weekly agenda. And it applied only to the
  749. actually date of the deadline. Warnings about approaching and past-due
  750. deadlines are always turned off when the item is DONE."
  751. :group 'org-agenda-skip
  752. :group 'org-agenda-daily/weekly
  753. :type 'boolean)
  754. (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
  755. "Non-nil means skip deadline prewarning when entry is also scheduled.
  756. This will apply on all days where a prewarning for the deadline would
  757. be shown, but not at the day when the entry is actually due. On that day,
  758. the deadline will be shown anyway.
  759. This variable may be set to nil, t, the symbol `pre-scheduled',
  760. or a number which will then give the number of days before the actual
  761. deadline when the prewarnings should resume. The symbol `pre-scheduled'
  762. eliminates the deadline prewarning only prior to the scheduled date.
  763. This can be used in a workflow where the first showing of the deadline will
  764. trigger you to schedule it, and then you don't want to be reminded of it
  765. because you will take care of it on the day when scheduled."
  766. :group 'org-agenda-skip
  767. :group 'org-agenda-daily/weekly
  768. :version "24.1"
  769. :type '(choice
  770. (const :tag "Always show prewarning" nil)
  771. (const :tag "Remove prewarning prior to scheduled date" pre-scheduled)
  772. (const :tag "Remove prewarning if entry is scheduled" t)
  773. (integer :tag "Restart prewarning N days before deadline")))
  774. (defcustom org-agenda-skip-scheduled-delay-if-deadline nil
  775. "Non-nil means skip scheduled delay when entry also has a deadline.
  776. This variable may be set to nil, t, the symbol `post-deadline',
  777. or a number which will then give the number of days after the actual
  778. scheduled date when the delay should expire. The symbol `post-deadline'
  779. eliminates the schedule delay when the date is posterior to the deadline."
  780. :group 'org-agenda-skip
  781. :group 'org-agenda-daily/weekly
  782. :version "24.4"
  783. :package-version '(Org . "8.0")
  784. :type '(choice
  785. (const :tag "Always honor delay" nil)
  786. (const :tag "Ignore delay if posterior to the deadline" post-deadline)
  787. (const :tag "Ignore delay if entry has a deadline" t)
  788. (integer :tag "Honor delay up until N days after the scheduled date")))
  789. (defcustom org-agenda-skip-additional-timestamps-same-entry nil
  790. "When nil, multiple same-day timestamps in entry make multiple agenda lines.
  791. When non-nil, after the search for timestamps has matched once in an
  792. entry, the rest of the entry will not be searched."
  793. :group 'org-agenda-skip
  794. :type 'boolean)
  795. (defcustom org-agenda-skip-timestamp-if-done nil
  796. "Non-nil means don't select item by timestamp or -range if it is DONE."
  797. :group 'org-agenda-skip
  798. :group 'org-agenda-daily/weekly
  799. :type 'boolean)
  800. (defcustom org-agenda-dim-blocked-tasks t
  801. "Non-nil means dim blocked tasks in the agenda display.
  802. This causes some overhead during agenda construction, but if you
  803. have turned on `org-enforce-todo-dependencies',
  804. `org-enforce-todo-checkbox-dependencies', or any other blocking
  805. mechanism, this will create useful feedback in the agenda.
  806. Instead of t, this variable can also have the value `invisible'.
  807. Then blocked tasks will be invisible and only become visible when
  808. they become unblocked. An exemption to this behavior is when a task is
  809. blocked because of unchecked checkboxes below it. Since checkboxes do
  810. not show up in the agenda views, making this task invisible you remove any
  811. trace from agenda views that there is something to do. Therefore, a task
  812. that is blocked because of checkboxes will never be made invisible, it
  813. will only be dimmed."
  814. :group 'org-agenda-daily/weekly
  815. :group 'org-agenda-todo-list
  816. :version "24.3"
  817. :type '(choice
  818. (const :tag "Do not dim" nil)
  819. (const :tag "Dim to a gray face" t)
  820. (const :tag "Make invisible" invisible)))
  821. (defcustom org-timeline-show-empty-dates 3
  822. "Non-nil means `org-timeline' also shows dates without an entry.
  823. When nil, only the days which actually have entries are shown.
  824. When t, all days between the first and the last date are shown.
  825. When an integer, show also empty dates, but if there is a gap of more than
  826. N days, just insert a special line indicating the size of the gap."
  827. :group 'org-agenda-skip
  828. :type '(choice
  829. (const :tag "None" nil)
  830. (const :tag "All" t)
  831. (integer :tag "at most")))
  832. (defgroup org-agenda-startup nil
  833. "Options concerning initial settings in the Agenda in Org Mode."
  834. :tag "Org Agenda Startup"
  835. :group 'org-agenda)
  836. (defcustom org-agenda-menu-show-matcher t
  837. "Non-nil means show the match string in the agenda dispatcher menu.
  838. When nil, the matcher string is not shown, but is put into the help-echo
  839. property so than moving the mouse over the command shows it.
  840. Setting it to nil is good if matcher strings are very long and/or if
  841. you want to use two-columns display (see `org-agenda-menu-two-columns')."
  842. :group 'org-agenda
  843. :version "24.1"
  844. :type 'boolean)
  845. (define-obsolete-variable-alias 'org-agenda-menu-two-column 'org-agenda-menu-two-columns "24.3")
  846. (defcustom org-agenda-menu-two-columns nil
  847. "Non-nil means, use two columns to show custom commands in the dispatcher.
  848. If you use this, you probably want to set `org-agenda-menu-show-matcher'
  849. to nil."
  850. :group 'org-agenda
  851. :version "24.1"
  852. :type 'boolean)
  853. (define-obsolete-variable-alias 'org-finalize-agenda-hook 'org-agenda-finalize-hook "24.3")
  854. (defcustom org-agenda-finalize-hook nil
  855. "Hook run just before displaying an agenda buffer.
  856. The buffer is still writable when the hook is called.
  857. You can modify some of the buffer substrings but you should be
  858. extra careful not to modify the text properties of the agenda
  859. headlines as the agenda display heavily relies on them."
  860. :group 'org-agenda-startup
  861. :type 'hook)
  862. (defcustom org-agenda-mouse-1-follows-link nil
  863. "Non-nil means mouse-1 on a link will follow the link in the agenda.
  864. A longer mouse click will still set point. Does not work on XEmacs.
  865. Needs to be set before org.el is loaded."
  866. :group 'org-agenda-startup
  867. :type 'boolean)
  868. (defcustom org-agenda-start-with-follow-mode nil
  869. "The initial value of follow mode in a newly created agenda window."
  870. :group 'org-agenda-startup
  871. :type 'boolean)
  872. (defcustom org-agenda-follow-indirect nil
  873. "Non-nil means `org-agenda-follow-mode' displays only the
  874. current item's tree, in an indirect buffer."
  875. :group 'org-agenda
  876. :version "24.1"
  877. :type 'boolean)
  878. (defcustom org-agenda-show-outline-path t
  879. "Non-nil means show outline path in echo area after line motion."
  880. :group 'org-agenda-startup
  881. :type 'boolean)
  882. (defcustom org-agenda-start-with-entry-text-mode nil
  883. "The initial value of entry-text-mode in a newly created agenda window."
  884. :group 'org-agenda-startup
  885. :type 'boolean)
  886. (defcustom org-agenda-entry-text-maxlines 5
  887. "Number of text lines to be added when `E' is pressed in the agenda.
  888. Note that this variable only used during agenda display. Add add entry text
  889. when exporting the agenda, configure the variable
  890. `org-agenda-add-entry-ext-maxlines'."
  891. :group 'org-agenda
  892. :type 'integer)
  893. (defcustom org-agenda-entry-text-exclude-regexps nil
  894. "List of regular expressions to clean up entry text.
  895. The complete matches of all regular expressions in this list will be
  896. removed from entry text before it is shown in the agenda."
  897. :group 'org-agenda
  898. :type '(repeat (regexp)))
  899. (defcustom org-agenda-entry-text-leaders " > "
  900. "Text prepended to the entry text in agenda buffers."
  901. :version "24.4"
  902. :package-version '(Org . "8.0")
  903. :group 'org-agenda
  904. :type 'string)
  905. (defvar org-agenda-entry-text-cleanup-hook nil
  906. "Hook that is run after basic cleanup of entry text to be shown in agenda.
  907. This cleanup is done in a temporary buffer, so the function may inspect and
  908. change the entire buffer.
  909. Some default stuff like drawers and scheduling/deadline dates will already
  910. have been removed when this is called, as will any matches for regular
  911. expressions listed in `org-agenda-entry-text-exclude-regexps'.")
  912. (defvar org-agenda-include-inactive-timestamps nil
  913. "Non-nil means include inactive time stamps in agenda and timeline.
  914. Dynamically scoped.")
  915. (defgroup org-agenda-windows nil
  916. "Options concerning the windows used by the Agenda in Org Mode."
  917. :tag "Org Agenda Windows"
  918. :group 'org-agenda)
  919. (defcustom org-agenda-window-setup 'reorganize-frame
  920. "How the agenda buffer should be displayed.
  921. Possible values for this option are:
  922. current-window Show agenda in the current window, keeping all other windows.
  923. other-window Use `switch-to-buffer-other-window' to display agenda.
  924. reorganize-frame Show only two windows on the current frame, the current
  925. window and the agenda.
  926. other-frame Use `switch-to-buffer-other-frame' to display agenda.
  927. Also, when exiting the agenda, kill that frame.
  928. See also the variable `org-agenda-restore-windows-after-quit'."
  929. :group 'org-agenda-windows
  930. :type '(choice
  931. (const current-window)
  932. (const other-frame)
  933. (const other-window)
  934. (const reorganize-frame)))
  935. (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
  936. "The min and max height of the agenda window as a fraction of frame height.
  937. The value of the variable is a cons cell with two numbers between 0 and 1.
  938. It only matters if `org-agenda-window-setup' is `reorganize-frame'."
  939. :group 'org-agenda-windows
  940. :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
  941. (defcustom org-agenda-restore-windows-after-quit nil
  942. "Non-nil means restore window configuration upon exiting agenda.
  943. Before the window configuration is changed for displaying the agenda,
  944. the current status is recorded. When the agenda is exited with
  945. `q' or `x' and this option is set, the old state is restored. If
  946. `org-agenda-window-setup' is `other-frame', the value of this
  947. option will be ignored."
  948. :group 'org-agenda-windows
  949. :type 'boolean)
  950. (defcustom org-agenda-ndays nil
  951. "Number of days to include in overview display.
  952. Should be 1 or 7.
  953. Obsolete, see `org-agenda-span'."
  954. :group 'org-agenda-daily/weekly
  955. :type 'integer)
  956. (make-obsolete-variable 'org-agenda-ndays 'org-agenda-span "24.1")
  957. (defcustom org-agenda-span 'week
  958. "Number of days to include in overview display.
  959. Can be day, week, month, year, or any number of days.
  960. Custom commands can set this variable in the options section."
  961. :group 'org-agenda-daily/weekly
  962. :type '(choice (const :tag "Day" day)
  963. (const :tag "Week" week)
  964. (const :tag "Month" month)
  965. (const :tag "Year" year)
  966. (integer :tag "Custom")))
  967. (defcustom org-agenda-start-on-weekday 1
  968. "Non-nil means start the overview always on the specified weekday.
  969. 0 denotes Sunday, 1 denotes Monday etc.
  970. When nil, always start on the current day.
  971. Custom commands can set this variable in the options section."
  972. :group 'org-agenda-daily/weekly
  973. :type '(choice (const :tag "Today" nil)
  974. (integer :tag "Weekday No.")))
  975. (defcustom org-agenda-show-all-dates t
  976. "Non-nil means `org-agenda' shows every day in the selected range.
  977. When nil, only the days which actually have entries are shown."
  978. :group 'org-agenda-daily/weekly
  979. :type 'boolean)
  980. (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
  981. "Format string for displaying dates in the agenda.
  982. Used by the daily/weekly agenda and by the timeline. This should be
  983. a format string understood by `format-time-string', or a function returning
  984. the formatted date as a string. The function must take a single argument,
  985. a calendar-style date list like (month day year)."
  986. :group 'org-agenda-daily/weekly
  987. :type '(choice
  988. (string :tag "Format string")
  989. (function :tag "Function")))
  990. (defun org-agenda-format-date-aligned (date)
  991. "Format a DATE string for display in the daily/weekly agenda, or timeline.
  992. This function makes sure that dates are aligned for easy reading."
  993. (require 'cal-iso)
  994. (let* ((dayname (calendar-day-name date))
  995. (day (cadr date))
  996. (day-of-week (calendar-day-of-week date))
  997. (month (car date))
  998. (monthname (calendar-month-name month))
  999. (year (nth 2 date))
  1000. (iso-week (org-days-to-iso-week
  1001. (calendar-absolute-from-gregorian date)))
  1002. (weekyear (cond ((and (= month 1) (>= iso-week 52))
  1003. (1- year))
  1004. ((and (= month 12) (<= iso-week 1))
  1005. (1+ year))
  1006. (t year)))
  1007. (weekstring (if (= day-of-week 1)
  1008. (format " W%02d" iso-week)
  1009. "")))
  1010. (format "%-10s %2d %s %4d%s"
  1011. dayname day monthname year weekstring)))
  1012. (defcustom org-agenda-time-leading-zero nil
  1013. "Non-nil means use leading zero for military times in agenda.
  1014. For example, 9:30am would become 09:30 rather than 9:30."
  1015. :group 'org-agenda-daily/weekly
  1016. :version "24.1"
  1017. :type 'boolean)
  1018. (defcustom org-agenda-timegrid-use-ampm nil
  1019. "When set, show AM/PM style timestamps on the timegrid."
  1020. :group 'org-agenda
  1021. :version "24.1"
  1022. :type 'boolean)
  1023. (defun org-agenda-time-of-day-to-ampm (time)
  1024. "Convert TIME of a string like '13:45' to an AM/PM style time string."
  1025. (let* ((hour-number (string-to-number (substring time 0 -3)))
  1026. (minute (substring time -2))
  1027. (ampm "am"))
  1028. (cond
  1029. ((equal hour-number 12)
  1030. (setq ampm "pm"))
  1031. ((> hour-number 12)
  1032. (setq ampm "pm")
  1033. (setq hour-number (- hour-number 12))))
  1034. (concat
  1035. (if org-agenda-time-leading-zero
  1036. (format "%02d" hour-number)
  1037. (format "%02s" (number-to-string hour-number)))
  1038. ":" minute ampm)))
  1039. (defun org-agenda-time-of-day-to-ampm-maybe (time)
  1040. "Conditionally convert TIME to AM/PM format based on `org-agenda-timegrid-use-ampm'."
  1041. (if org-agenda-timegrid-use-ampm
  1042. (org-agenda-time-of-day-to-ampm time)
  1043. time))
  1044. (defcustom org-agenda-weekend-days '(6 0)
  1045. "Which days are weekend?
  1046. These days get the special face `org-agenda-date-weekend' in the agenda
  1047. and timeline buffers."
  1048. :group 'org-agenda-daily/weekly
  1049. :type '(set :greedy t
  1050. (const :tag "Monday" 1)
  1051. (const :tag "Tuesday" 2)
  1052. (const :tag "Wednesday" 3)
  1053. (const :tag "Thursday" 4)
  1054. (const :tag "Friday" 5)
  1055. (const :tag "Saturday" 6)
  1056. (const :tag "Sunday" 0)))
  1057. (defcustom org-agenda-move-date-from-past-immediately-to-today t
  1058. "Non-nil means jump to today when moving a past date forward in time.
  1059. When using S-right in the agenda to move a a date forward, and the date
  1060. stamp currently points to the past, the first key press will move it
  1061. to today. WHen nil, just move one day forward even if the date stays
  1062. in the past."
  1063. :group 'org-agenda-daily/weekly
  1064. :version "24.1"
  1065. :type 'boolean)
  1066. (defcustom org-agenda-include-diary nil
  1067. "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
  1068. Custom commands can set this variable in the options section."
  1069. :group 'org-agenda-daily/weekly
  1070. :type 'boolean)
  1071. (defcustom org-agenda-include-deadlines t
  1072. "If non-nil, include entries within their deadline warning period.
  1073. Custom commands can set this variable in the options section."
  1074. :group 'org-agenda-daily/weekly
  1075. :version "24.1"
  1076. :type 'boolean)
  1077. (defcustom org-agenda-repeating-timestamp-show-all t
  1078. "Non-nil means show all occurrences of a repeating stamp in the agenda.
  1079. When set to a list of strings, only show occurrences of repeating
  1080. stamps for these TODO keywords. When nil, only one occurrence is
  1081. shown, either today or the nearest into the future."
  1082. :group 'org-agenda-daily/weekly
  1083. :type '(choice
  1084. (const :tag "Show repeating stamps" t)
  1085. (repeat :tag "Show repeating stamps for these TODO keywords"
  1086. (string :tag "TODO Keyword"))
  1087. (const :tag "Don't show repeating stamps" nil)))
  1088. (defcustom org-scheduled-past-days 10000
  1089. "Number of days to continue listing scheduled items not marked DONE.
  1090. When an item is scheduled on a date, it shows up in the agenda on this
  1091. day and will be listed until it is marked done for the number of days
  1092. given here."
  1093. :group 'org-agenda-daily/weekly
  1094. :type 'integer)
  1095. (defcustom org-agenda-log-mode-items '(closed clock)
  1096. "List of items that should be shown in agenda log mode.
  1097. This list may contain the following symbols:
  1098. closed Show entries that have been closed on that day.
  1099. clock Show entries that have received clocked time on that day.
  1100. state Show all logged state changes.
  1101. Note that instead of changing this variable, you can also press `C-u l' in
  1102. the agenda to display all available LOG items temporarily."
  1103. :group 'org-agenda-daily/weekly
  1104. :type '(set :greedy t (const closed) (const clock) (const state)))
  1105. (defcustom org-agenda-clock-consistency-checks
  1106. '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
  1107. :gap-ok-around ("4:00")
  1108. :default-face ((:background "DarkRed") (:foreground "white"))
  1109. :overlap-face nil :gap-face nil :no-end-time-face nil
  1110. :long-face nil :short-face nil)
  1111. "This is a property list, with the following keys:
  1112. :max-duration Mark clocking chunks that are longer than this time.
  1113. This is a time string like \"HH:MM\", or the number
  1114. of minutes as an integer.
  1115. :min-duration Mark clocking chunks that are shorter that this.
  1116. This is a time string like \"HH:MM\", or the number
  1117. of minutes as an integer.
  1118. :max-gap Mark gaps between clocking chunks that are longer than
  1119. this duration. A number of minutes, or a string
  1120. like \"HH:MM\".
  1121. :gap-ok-around List of times during the day which are usually not working
  1122. times. When a gap is detected, but the gap contains any
  1123. of these times, the gap is *not* reported. For example,
  1124. if this is (\"4:00\" \"13:00\") then gaps that contain
  1125. 4:00 in the morning (i.e. the night) and 13:00
  1126. (i.e. a typical lunch time) do not cause a warning.
  1127. You should have at least one time during the night in this
  1128. list, or otherwise the first task each morning will trigger
  1129. a warning because it follows a long gap.
  1130. Furthermore, the following properties can be used to define faces for
  1131. issue display.
  1132. :default-face the default face, if the specific face is undefined
  1133. :overlap-face face for overlapping clocks
  1134. :gap-face face for gaps between clocks
  1135. :no-end-time-face face for incomplete clocks
  1136. :long-face face for clock intervals that are too long
  1137. :short-face face for clock intervals that are too short"
  1138. :group 'org-agenda-daily/weekly
  1139. :group 'org-clock
  1140. :version "24.1"
  1141. :type 'plist)
  1142. (defcustom org-agenda-log-mode-add-notes t
  1143. "Non-nil means add first line of notes to log entries in agenda views.
  1144. If a log item like a state change or a clock entry is associated with
  1145. notes, the first line of these notes will be added to the entry in the
  1146. agenda display."
  1147. :group 'org-agenda-daily/weekly
  1148. :type 'boolean)
  1149. (defcustom org-agenda-start-with-log-mode nil
  1150. "The initial value of log-mode in a newly created agenda window.
  1151. See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
  1152. explanations on the possible values."
  1153. :group 'org-agenda-startup
  1154. :group 'org-agenda-daily/weekly
  1155. :type '(choice (const :tag "Don't show log items" nil)
  1156. (const :tag "Show only log items" 'only)
  1157. (const :tag "Show all possible log items" 'clockcheck)
  1158. (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
  1159. (choice (const :tag "Show closed log items" 'closed)
  1160. (const :tag "Show clocked log items" 'clock)
  1161. (const :tag "Show all logged state changes" 'state)))))
  1162. (defcustom org-agenda-start-with-clockreport-mode nil
  1163. "The initial value of clockreport-mode in a newly created agenda window."
  1164. :group 'org-agenda-startup
  1165. :group 'org-agenda-daily/weekly
  1166. :type 'boolean)
  1167. (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
  1168. "Property list with parameters for the clocktable in clockreport mode.
  1169. This is the display mode that shows a clock table in the daily/weekly
  1170. agenda, the properties for this dynamic block can be set here.
  1171. The usual clocktable parameters are allowed here, but you cannot set
  1172. the properties :name, :tstart, :tend, :block, and :scope - these will
  1173. be overwritten to make sure the content accurately reflects the
  1174. current display in the agenda."
  1175. :group 'org-agenda-daily/weekly
  1176. :type 'plist)
  1177. (defcustom org-agenda-search-view-always-boolean nil
  1178. "Non-nil means the search string is interpreted as individual parts.
  1179. The search string for search view can either be interpreted as a phrase,
  1180. or as a list of snippets that define a boolean search for a number of
  1181. strings.
  1182. When this is non-nil, the string will be split on whitespace, and each
  1183. snippet will be searched individually, and all must match in order to
  1184. select an entry. A snippet is then a single string of non-white
  1185. characters, or a string in double quotes, or a regexp in {} braces.
  1186. If a snippet is preceded by \"-\", the snippet must *not* match.
  1187. \"+\" is syntactic sugar for positive selection. Each snippet may
  1188. be found as a full word or a partial word, but see the variable
  1189. `org-agenda-search-view-force-full-words'.
  1190. When this is nil, search will look for the entire search phrase as one,
  1191. with each space character matching any amount of whitespace, including
  1192. line breaks.
  1193. Even when this is nil, you can still switch to Boolean search dynamically
  1194. by preceding the first snippet with \"+\" or \"-\". If the first snippet
  1195. is a regexp marked with braces like \"{abc}\", this will also switch to
  1196. boolean search."
  1197. :group 'org-agenda-search-view
  1198. :version "24.1"
  1199. :type 'boolean)
  1200. (if (fboundp 'defvaralias)
  1201. (defvaralias 'org-agenda-search-view-search-words-only
  1202. 'org-agenda-search-view-always-boolean))
  1203. (defcustom org-agenda-search-view-force-full-words nil
  1204. "Non-nil means, search words must be matches as complete words.
  1205. When nil, they may also match part of a word."
  1206. :group 'org-agenda-search-view
  1207. :version "24.1"
  1208. :type 'boolean)
  1209. (defcustom org-agenda-search-view-max-outline-level nil
  1210. "Maximum outline level to display in search view.
  1211. E.g. when this is set to 1, the search view will only
  1212. show headlines of level 1."
  1213. :group 'org-agenda-search-view
  1214. :version "24.4"
  1215. :package-version '(Org . "8.0")
  1216. :type 'integer)
  1217. (defgroup org-agenda-time-grid nil
  1218. "Options concerning the time grid in the Org-mode Agenda."
  1219. :tag "Org Agenda Time Grid"
  1220. :group 'org-agenda)
  1221. (defcustom org-agenda-search-headline-for-time t
  1222. "Non-nil means search headline for a time-of-day.
  1223. If the headline contains a time-of-day in one format or another, it will
  1224. be used to sort the entry into the time sequence of items for a day.
  1225. Some people have time stamps in the headline that refer to the creation
  1226. time or so, and then this produces an unwanted side effect. If this is
  1227. the case for your, use this variable to turn off searching the headline
  1228. for a time."
  1229. :group 'org-agenda-time-grid
  1230. :type 'boolean)
  1231. (defcustom org-agenda-use-time-grid t
  1232. "Non-nil means show a time grid in the agenda schedule.
  1233. A time grid is a set of lines for specific times (like every two hours between
  1234. 8:00 and 20:00). The items scheduled for a day at specific times are
  1235. sorted in between these lines.
  1236. For details about when the grid will be shown, and what it will look like, see
  1237. the variable `org-agenda-time-grid'."
  1238. :group 'org-agenda-time-grid
  1239. :type 'boolean)
  1240. (defcustom org-agenda-time-grid
  1241. '((daily today require-timed)
  1242. "----------------"
  1243. (800 1000 1200 1400 1600 1800 2000))
  1244. "The settings for time grid for agenda display.
  1245. This is a list of three items. The first item is again a list. It contains
  1246. symbols specifying conditions when the grid should be displayed:
  1247. daily if the agenda shows a single day
  1248. weekly if the agenda shows an entire week
  1249. today show grid on current date, independent of daily/weekly display
  1250. require-timed show grid only if at least one item has a time specification
  1251. The second item is a string which will be placed behind the grid time.
  1252. The third item is a list of integers, indicating the times that should have
  1253. a grid line."
  1254. :group 'org-agenda-time-grid
  1255. :type
  1256. '(list
  1257. (set :greedy t :tag "Grid Display Options"
  1258. (const :tag "Show grid in single day agenda display" daily)
  1259. (const :tag "Show grid in weekly agenda display" weekly)
  1260. (const :tag "Always show grid for today" today)
  1261. (const :tag "Show grid only if any timed entries are present"
  1262. require-timed)
  1263. (const :tag "Skip grid times already present in an entry"
  1264. remove-match))
  1265. (string :tag "Grid String")
  1266. (repeat :tag "Grid Times" (integer :tag "Time"))))
  1267. (defcustom org-agenda-show-current-time-in-grid t
  1268. "Non-nil means show the current time in the time grid."
  1269. :group 'org-agenda-time-grid
  1270. :version "24.1"
  1271. :type 'boolean)
  1272. (defcustom org-agenda-current-time-string
  1273. "now - - - - - - - - - - - - - - - - - - - - - - - - -"
  1274. "The string for the current time marker in the agenda."
  1275. :group 'org-agenda-time-grid
  1276. :version "24.1"
  1277. :type 'string)
  1278. (defgroup org-agenda-sorting nil
  1279. "Options concerning sorting in the Org-mode Agenda."
  1280. :tag "Org Agenda Sorting"
  1281. :group 'org-agenda)
  1282. (defcustom org-agenda-sorting-strategy
  1283. '((agenda habit-down time-up priority-down category-keep)
  1284. (todo priority-down category-keep)
  1285. (tags priority-down category-keep)
  1286. (search category-keep))
  1287. "Sorting structure for the agenda items of a single day.
  1288. This is a list of symbols which will be used in sequence to determine
  1289. if an entry should be listed before another entry. The following
  1290. symbols are recognized:
  1291. time-up Put entries with time-of-day indications first, early first
  1292. time-down Put entries with time-of-day indications first, late first
  1293. timestamp-up Sort by any timestamp, early first
  1294. timestamp-down Sort by any timestamp, late first
  1295. scheduled-up Sort by scheduled timestamp, early first
  1296. scheduled-down Sort by scheduled timestamp, late first
  1297. deadline-up Sort by deadline timestamp, early first
  1298. deadline-down Sort by deadline timestamp, late first
  1299. ts-up Sort by active timestamp, early first
  1300. ts-down Sort by active timestamp, late first
  1301. tsia-up Sort by inactive timestamp, early first
  1302. tsia-down Sort by inactive timestamp, late first
  1303. category-keep Keep the default order of categories, corresponding to the
  1304. sequence in `org-agenda-files'.
  1305. category-up Sort alphabetically by category, A-Z.
  1306. category-down Sort alphabetically by category, Z-A.
  1307. tag-up Sort alphabetically by last tag, A-Z.
  1308. tag-down Sort alphabetically by last tag, Z-A.
  1309. priority-up Sort numerically by priority, high priority last.
  1310. priority-down Sort numerically by priority, high priority first.
  1311. todo-state-up Sort by todo state, tasks that are done last.
  1312. todo-state-down Sort by todo state, tasks that are done first.
  1313. effort-up Sort numerically by estimated effort, high effort last.
  1314. effort-down Sort numerically by estimated effort, high effort first.
  1315. user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
  1316. user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
  1317. habit-up Put entries that are habits first
  1318. habit-down Put entries that are habits last
  1319. alpha-up Sort headlines alphabetically
  1320. alpha-down Sort headlines alphabetically, reversed
  1321. The different possibilities will be tried in sequence, and testing stops
  1322. if one comparison returns a \"not-equal\". For example, the default
  1323. '(time-up category-keep priority-down)
  1324. means: Pull out all entries having a specified time of day and sort them,
  1325. in order to make a time schedule for the current day the first thing in the
  1326. agenda listing for the day. Of the entries without a time indication, keep
  1327. the grouped in categories, don't sort the categories, but keep them in
  1328. the sequence given in `org-agenda-files'. Within each category sort by
  1329. priority.
  1330. Leaving out `category-keep' would mean that items will be sorted across
  1331. categories by priority.
  1332. Instead of a single list, this can also be a set of list for specific
  1333. contents, with a context symbol in the car of the list, any of
  1334. `agenda', `todo', `tags', `search' for the corresponding agenda views.
  1335. Custom commands can bind this variable in the options section."
  1336. :group 'org-agenda-sorting
  1337. :type `(choice
  1338. (repeat :tag "General" ,org-sorting-choice)
  1339. (list :tag "Individually"
  1340. (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
  1341. (repeat ,org-sorting-choice))
  1342. (cons (const :tag "Strategy for TODO lists" todo)
  1343. (repeat ,org-sorting-choice))
  1344. (cons (const :tag "Strategy for Tags matches" tags)
  1345. (repeat ,org-sorting-choice))
  1346. (cons (const :tag "Strategy for search matches" search)
  1347. (repeat ,org-sorting-choice)))))
  1348. (defcustom org-agenda-cmp-user-defined nil
  1349. "A function to define the comparison `user-defined'.
  1350. This function must receive two arguments, agenda entry a and b.
  1351. If a>b, return +1. If a<b, return -1. If they are equal as seen by
  1352. the user comparison, return nil.
  1353. When this is defined, you can make `user-defined-up' and `user-defined-down'
  1354. part of an agenda sorting strategy."
  1355. :group 'org-agenda-sorting
  1356. :type 'symbol)
  1357. (defcustom org-sort-agenda-notime-is-late t
  1358. "Non-nil means items without time are considered late.
  1359. This is only relevant for sorting. When t, items which have no explicit
  1360. time like 15:30 will be considered as 99:01, i.e. later than any items which
  1361. do have a time. When nil, the default time is before 0:00. You can use this
  1362. option to decide if the schedule for today should come before or after timeless
  1363. agenda entries."
  1364. :group 'org-agenda-sorting
  1365. :type 'boolean)
  1366. (defcustom org-sort-agenda-noeffort-is-high t
  1367. "Non-nil means items without effort estimate are sorted as high effort.
  1368. This also applies when filtering an agenda view with respect to the
  1369. < or > effort operator. Then, tasks with no effort defined will be treated
  1370. as tasks with high effort.
  1371. When nil, such items are sorted as 0 minutes effort."
  1372. :group 'org-agenda-sorting
  1373. :type 'boolean)
  1374. (defgroup org-agenda-line-format nil
  1375. "Options concerning the entry prefix in the Org-mode agenda display."
  1376. :tag "Org Agenda Line Format"
  1377. :group 'org-agenda)
  1378. (defcustom org-agenda-prefix-format
  1379. '((agenda . " %i %-12:c%?-12t% s")
  1380. (timeline . " % s")
  1381. (todo . " %i %-12:c")
  1382. (tags . " %i %-12:c")
  1383. (search . " %i %-12:c"))
  1384. "Format specifications for the prefix of items in the agenda views.
  1385. An alist with five entries, each for the different agenda types. The
  1386. keys of the sublists are `agenda', `timeline', `todo', `search' and `tags'.
  1387. The values are format strings.
  1388. This format works similar to a printf format, with the following meaning:
  1389. %c the category of the item, \"Diary\" for entries from the diary,
  1390. or as given by the CATEGORY keyword or derived from the file name
  1391. %e the effort required by the item
  1392. %l the level of the item (insert X space(s) if item is of level X)
  1393. %i the icon category of the item, see `org-agenda-category-icon-alist'
  1394. %T the last tag of the item (ignore inherited tags, which come first)
  1395. %t the HH:MM time-of-day specification if one applies to the entry
  1396. %s Scheduling/Deadline information, a short string
  1397. %b show breadcrumbs, i.e., the names of the higher levels
  1398. %(expression) Eval EXPRESSION and replace the control string
  1399. by the result
  1400. All specifiers work basically like the standard `%s' of printf, but may
  1401. contain two additional characters: a question mark just after the `%'
  1402. and a whitespace/punctuation character just before the final letter.
  1403. If the first character after `%' is a question mark, the entire field
  1404. will only be included if the corresponding value applies to the current
  1405. entry. This is useful for fields which should have fixed width when
  1406. present, but zero width when absent. For example, \"%?-12t\" will
  1407. result in a 12 character time field if a time of the day is specified,
  1408. but will completely disappear in entries which do not contain a time.
  1409. If there is punctuation or whitespace character just before the
  1410. final format letter, this character will be appended to the field
  1411. value if the value is not empty. For example, the format
  1412. \"%-12:c\" leads to \"Diary: \" if the category is \"Diary\". If
  1413. the category is empty, no additional colon is inserted.
  1414. The default value for the agenda sublist is \" %-12:c%?-12t% s\",
  1415. which means:
  1416. - Indent the line with two space characters
  1417. - Give the category a 12 chars wide field, padded with whitespace on
  1418. the right (because of `-'). Append a colon if there is a category
  1419. (because of `:').
  1420. - If there is a time-of-day, put it into a 12 chars wide field. If no
  1421. time, don't put in an empty field, just skip it (because of '?').
  1422. - Finally, put the scheduling information.
  1423. See also the variables `org-agenda-remove-times-when-in-prefix' and
  1424. `org-agenda-remove-tags'.
  1425. Custom commands can set this variable in the options section."
  1426. :type '(choice
  1427. (string :tag "General format")
  1428. (list :greedy t :tag "View dependent"
  1429. (cons (const agenda) (string :tag "Format"))
  1430. (cons (const timeline) (string :tag "Format"))
  1431. (cons (const todo) (string :tag "Format"))
  1432. (cons (const tags) (string :tag "Format"))
  1433. (cons (const search) (string :tag "Format"))))
  1434. :group 'org-agenda-line-format)
  1435. (defvar org-prefix-format-compiled nil
  1436. "The compiled prefix format and associated variables.
  1437. This is a list where first element is a list of variable bindings, and second
  1438. element is the compiled format expression. See the variable
  1439. `org-agenda-prefix-format'.")
  1440. (defcustom org-agenda-todo-keyword-format "%-1s"
  1441. "Format for the TODO keyword in agenda lines.
  1442. Set this to something like \"%-12s\" if you want all TODO keywords
  1443. to occupy a fixed space in the agenda display."
  1444. :group 'org-agenda-line-format
  1445. :type 'string)
  1446. (defcustom org-agenda-diary-sexp-prefix nil
  1447. "A regexp that matches part of a diary sexp entry
  1448. which should be treated as scheduling/deadline information in
  1449. `org-agenda'.
  1450. For example, you can use this to extract the `diary-remind-message' from
  1451. `diary-remind' entries."
  1452. :group 'org-agenda-line-format
  1453. :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
  1454. (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
  1455. "Text preceding timerange entries in the agenda view.
  1456. This is a list with two strings. The first applies when the range
  1457. is entirely on one day. The second applies if the range spans several days.
  1458. The strings may have two \"%d\" format specifiers which will be filled
  1459. with the sequence number of the days, and the total number of days in the
  1460. range, respectively."
  1461. :group 'org-agenda-line-format
  1462. :type '(list
  1463. (string :tag "Deadline today ")
  1464. (choice :tag "Deadline relative"
  1465. (string :tag "Format string")
  1466. (function))))
  1467. (defcustom org-agenda-scheduled-leaders '(" Scheduled: " "Sched.%3dx: ")
  1468. "Text preceding scheduled items in the agenda view.
  1469. This is a list with two strings. The first applies when the item is
  1470. scheduled on the current day. The second applies when it has been scheduled
  1471. previously, it may contain a %d indicating that this is the nth time that
  1472. this item is scheduled, due to automatic rescheduling of unfinished items
  1473. for the following day. So this number is one larger than the number of days
  1474. that passed since this item was scheduled first."
  1475. :group 'org-agenda-line-format
  1476. :version "24.4"
  1477. :package-version '(Org . "8.0")
  1478. :type '(list
  1479. (string :tag "Scheduled today ")
  1480. (string :tag "Scheduled previously")))
  1481. (defcustom org-agenda-inactive-leader "["
  1482. "Text preceding item pulled into the agenda by inactive time stamps.
  1483. These entries are added to the agenda when pressing \"[\"."
  1484. :group 'org-agenda-line-format
  1485. :version "24.1"
  1486. :type '(list
  1487. (string :tag "Scheduled today ")
  1488. (string :tag "Scheduled previously")))
  1489. (defcustom org-agenda-deadline-leaders '(" Deadline: " " In %3d d.: " "%3d d. ago: ")
  1490. "Text preceding deadline items in the agenda view.
  1491. This is a list with three strings. The first applies when the item has its
  1492. deadline on the current day. The second applies when the deadline is in the
  1493. future, the third one when it is in the past. The strings may contain %d
  1494. to capture the number of days."
  1495. :group 'org-agenda-line-format
  1496. :version "24.4"
  1497. :package-version '(Org . "8.0")
  1498. :type '(list
  1499. (string :tag "Deadline today ")
  1500. (choice :tag "Deadline relative"
  1501. (string :tag "Format string")
  1502. (function))))
  1503. (defcustom org-agenda-remove-times-when-in-prefix t
  1504. "Non-nil means remove duplicate time specifications in agenda items.
  1505. When the format `org-agenda-prefix-format' contains a `%t' specifier, a
  1506. time-of-day specification in a headline or diary entry is extracted and
  1507. placed into the prefix. If this option is non-nil, the original specification
  1508. \(a timestamp or -range, or just a plain time(range) specification like
  1509. 11:30-4pm) will be removed for agenda display. This makes the agenda less
  1510. cluttered.
  1511. The option can be t or nil. It may also be the symbol `beg', indicating
  1512. that the time should only be removed when it is located at the beginning of
  1513. the headline/diary entry."
  1514. :group 'org-agenda-line-format
  1515. :type '(choice
  1516. (const :tag "Always" t)
  1517. (const :tag "Never" nil)
  1518. (const :tag "When at beginning of entry" beg)))
  1519. (defcustom org-agenda-remove-timeranges-from-blocks nil
  1520. "Non-nil means remove time ranges specifications in agenda
  1521. items that span on several days."
  1522. :group 'org-agenda-line-format
  1523. :version "24.1"
  1524. :type 'boolean)
  1525. (defcustom org-agenda-default-appointment-duration nil
  1526. "Default duration for appointments that only have a starting time.
  1527. When nil, no duration is specified in such cases.
  1528. When non-nil, this must be the number of minutes, e.g. 60 for one hour."
  1529. :group 'org-agenda-line-format
  1530. :type '(choice
  1531. (integer :tag "Minutes")
  1532. (const :tag "No default duration")))
  1533. (defcustom org-agenda-show-inherited-tags t
  1534. "Non-nil means show inherited tags in each agenda line.
  1535. When this option is set to 'always, it take precedences over
  1536. `org-agenda-use-tag-inheritance' and inherited tags are shown
  1537. in every agenda.
  1538. When this option is set to t (the default), inherited tags are
  1539. shown when they are available, i.e. when the value of
  1540. `org-agenda-use-tag-inheritance' has been taken into account.
  1541. This can be set to a list of agenda types in which the agenda
  1542. must display the inherited tags. Available types are 'todo,
  1543. 'agenda, 'search and 'timeline.
  1544. When set to nil, never show inherited tags in agenda lines."
  1545. :group 'org-agenda-line-format
  1546. :group 'org-agenda
  1547. :version "24.3"
  1548. :type '(choice
  1549. (const :tag "Show inherited tags when available" t)
  1550. (const :tag "Always show inherited tags" 'always)
  1551. (repeat :tag "Show inherited tags only in selected agenda types"
  1552. (symbol :tag "Agenda type"))))
  1553. (defcustom org-agenda-use-tag-inheritance '(todo search timeline agenda)
  1554. "List of agenda view types where to use tag inheritance.
  1555. In tags/tags-todo/tags-tree agenda views, tag inheritance is
  1556. controlled by `org-use-tag-inheritance'. In other agenda types,
  1557. `org-use-tag-inheritance' is not used for the selection of the
  1558. agenda entries. Still, you may want the agenda to be aware of
  1559. the inherited tags anyway, e.g. for later tag filtering.
  1560. Allowed value are 'todo, 'search, 'timeline and 'agenda.
  1561. This variable has no effect if `org-agenda-show-inherited-tags'
  1562. is set to 'always. In that case, the agenda is aware of those
  1563. tags.
  1564. The default value sets tags in every agenda type. Setting this
  1565. option to nil will speed up non-tags agenda view a lot."
  1566. :group 'org-agenda
  1567. :version "24.3"
  1568. :type '(choice
  1569. (const :tag "Use tag inheritance in all agenda types" t)
  1570. (repeat :tag "Use tag inheritance in selected agenda types"
  1571. (symbol :tag "Agenda type"))))
  1572. (defcustom org-agenda-hide-tags-regexp nil
  1573. "Regular expression used to filter away specific tags in agenda views.
  1574. This means that these tags will be present, but not be shown in the agenda
  1575. line. Secondary filtering will still work on the hidden tags.
  1576. Nil means don't hide any tags."
  1577. :group 'org-agenda-line-format
  1578. :type '(choice
  1579. (const :tag "Hide none" nil)
  1580. (string :tag "Regexp ")))
  1581. (defcustom org-agenda-remove-tags nil
  1582. "Non-nil means remove the tags from the headline copy in the agenda.
  1583. When this is the symbol `prefix', only remove tags when
  1584. `org-agenda-prefix-format' contains a `%T' specifier."
  1585. :group 'org-agenda-line-format
  1586. :type '(choice
  1587. (const :tag "Always" t)
  1588. (const :tag "Never" nil)
  1589. (const :tag "When prefix format contains %T" prefix)))
  1590. (if (fboundp 'defvaralias)
  1591. (defvaralias 'org-agenda-remove-tags-when-in-prefix
  1592. 'org-agenda-remove-tags))
  1593. (defcustom org-agenda-tags-column (if (featurep 'xemacs) -79 -80)
  1594. "Shift tags in agenda items to this column.
  1595. If this number is positive, it specifies the column. If it is negative,
  1596. it means that the tags should be flushright to that column. For example,
  1597. -80 works well for a normal 80 character screen."
  1598. :group 'org-agenda-line-format
  1599. :type 'integer)
  1600. (if (fboundp 'defvaralias)
  1601. (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column))
  1602. (defcustom org-agenda-fontify-priorities 'cookies
  1603. "Non-nil means highlight low and high priorities in agenda.
  1604. When t, the highest priority entries are bold, lowest priority italic.
  1605. However, settings in `org-priority-faces' will overrule these faces.
  1606. When this variable is the symbol `cookies', only fontify the
  1607. cookies, not the entire task.
  1608. This may also be an association list of priority faces, whose
  1609. keys are the character values of `org-highest-priority',
  1610. `org-default-priority', and `org-lowest-priority' (the default values
  1611. are ?A, ?B, and ?C, respectively). The face may be a named face, a
  1612. color as a string, or a list like `(:background \"Red\")'.
  1613. If it is a color, the variable `org-faces-easy-properties'
  1614. determines if it is a foreground or a background color."
  1615. :group 'org-agenda-line-format
  1616. :type '(choice
  1617. (const :tag "Never" nil)
  1618. (const :tag "Defaults" t)
  1619. (const :tag "Cookies only" cookies)
  1620. (repeat :tag "Specify"
  1621. (list (character :tag "Priority" :value ?A)
  1622. (choice :tag "Face "
  1623. (string :tag "Color")
  1624. (sexp :tag "Face"))))))
  1625. (defcustom org-agenda-day-face-function nil
  1626. "Function called to determine what face should be used to display a day.
  1627. The only argument passed to that function is the day. It should
  1628. returns a face, or nil if does not want to specify a face and let
  1629. the normal rules apply."
  1630. :group 'org-agenda-line-format
  1631. :version "24.1"
  1632. :type 'function)
  1633. (defcustom org-agenda-category-icon-alist nil
  1634. "Alist of category icon to be displayed in agenda views.
  1635. Each entry should have the following format:
  1636. (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
  1637. Where CATEGORY-REGEXP is a regexp matching the categories where
  1638. the icon should be displayed.
  1639. FILE-OR-DATA either a file path or a string containing image data.
  1640. The other fields can be omitted safely if not needed:
  1641. TYPE indicates the image type.
  1642. DATA-P is a boolean indicating whether the FILE-OR-DATA string is
  1643. image data.
  1644. PROPS are additional image attributes to assign to the image,
  1645. like, e.g. `:ascent center'.
  1646. (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
  1647. If you want to set the display properties yourself, just put a
  1648. list as second element:
  1649. (CATEGORY-REGEXP (MY PROPERTY LIST))
  1650. For example, to display a 16px horizontal space for Emacs
  1651. category, you can use:
  1652. (\"Emacs\" '(space . (:width (16))))"
  1653. :group 'org-agenda-line-format
  1654. :version "24.1"
  1655. :type '(alist :key-type (string :tag "Regexp matching category")
  1656. :value-type (choice (list :tag "Icon"
  1657. (string :tag "File or data")
  1658. (symbol :tag "Type")
  1659. (boolean :tag "Data?")
  1660. (repeat :tag "Extra image properties" :inline t symbol))
  1661. (list :tag "Display properties" sexp))))
  1662. (defgroup org-agenda-column-view nil
  1663. "Options concerning column view in the agenda."
  1664. :tag "Org Agenda Column View"
  1665. :group 'org-agenda)
  1666. (defcustom org-agenda-columns-show-summaries t
  1667. "Non-nil means show summaries for columns displayed in the agenda view."
  1668. :group 'org-agenda-column-view
  1669. :type 'boolean)
  1670. (defcustom org-agenda-columns-compute-summary-properties t
  1671. "Non-nil means recompute all summary properties before column view.
  1672. When column view in the agenda is listing properties that have a summary
  1673. operator, it can go to all relevant buffers and recompute the summaries
  1674. there. This can mean overhead for the agenda column view, but is necessary
  1675. to have thing up to date.
  1676. As a special case, a CLOCKSUM property also makes sure that the clock
  1677. computations are current."
  1678. :group 'org-agenda-column-view
  1679. :type 'boolean)
  1680. (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
  1681. "Non-nil means the duration of an appointment will add to day effort.
  1682. The property to which appointment durations will be added is the one given
  1683. in the option `org-effort-property'. If an appointment does not have
  1684. an end time, `org-agenda-default-appointment-duration' will be used. If that
  1685. is not set, an appointment without end time will not contribute to the time
  1686. estimate."
  1687. :group 'org-agenda-column-view
  1688. :type 'boolean)
  1689. (defcustom org-agenda-auto-exclude-function nil
  1690. "A function called with a tag to decide if it is filtered on '/ RET'.
  1691. The sole argument to the function, which is called once for each
  1692. possible tag, is a string giving the name of the tag. The
  1693. function should return either nil if the tag should be included
  1694. as normal, or \"-<TAG>\" to exclude the tag.
  1695. Note that for the purpose of tag filtering, only the lower-case version of
  1696. all tags will be considered, so that this function will only ever see
  1697. the lower-case version of all tags."
  1698. :group 'org-agenda
  1699. :type 'function)
  1700. (defcustom org-agenda-bulk-custom-functions nil
  1701. "Alist of characters and custom functions for bulk actions.
  1702. For example, this value makes those two functions available:
  1703. '((?R set-category)
  1704. (?C bulk-cut))
  1705. With selected entries in an agenda buffer, `B R' will call
  1706. the custom function `set-category' on the selected entries.
  1707. Note that functions in this alist don't need to be quoted."
  1708. :type 'alist
  1709. :version "24.1"
  1710. :group 'org-agenda)
  1711. (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
  1712. "Execute BODY with point at location given by `org-hd-marker' property.
  1713. If STRING is non-nil, the text property will be fetched from position 0
  1714. in that string. If STRING is nil, it will be fetched from the beginning
  1715. of the current line."
  1716. (org-with-gensyms (marker)
  1717. `(let ((,marker (get-text-property (if string 0 (point-at-bol))
  1718. 'org-hd-marker ,string)))
  1719. (with-current-buffer (marker-buffer ,marker)
  1720. (save-excursion
  1721. (goto-char ,marker)
  1722. ,@body)))))
  1723. (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
  1724. (defun org-add-agenda-custom-command (entry)
  1725. "Replace or add a command in `org-agenda-custom-commands'.
  1726. This is mostly for hacking and trying a new command - once the command
  1727. works you probably want to add it to `org-agenda-custom-commands' for good."
  1728. (let ((ass (assoc (car entry) org-agenda-custom-commands)))
  1729. (if ass
  1730. (setcdr ass (cdr entry))
  1731. (push entry org-agenda-custom-commands))))
  1732. ;;; Define the org-agenda-mode
  1733. (defvar org-agenda-mode-map (make-sparse-keymap)
  1734. "Keymap for `org-agenda-mode'.")
  1735. (if (fboundp 'defvaralias)
  1736. (defvaralias 'org-agenda-keymap 'org-agenda-mode-map))
  1737. (defvar org-agenda-menu) ; defined later in this file.
  1738. (defvar org-agenda-restrict nil) ; defined later in this file.
  1739. (defvar org-agenda-follow-mode nil)
  1740. (defvar org-agenda-entry-text-mode nil)
  1741. (defvar org-agenda-clockreport-mode nil)
  1742. (defvar org-agenda-show-log nil)
  1743. (defvar org-agenda-redo-command nil)
  1744. (defvar org-agenda-query-string nil)
  1745. (defvar org-agenda-mode-hook nil
  1746. "Hook run after `org-agenda-mode' is turned on.
  1747. The buffer is still writable when this hook is called.")
  1748. (defvar org-agenda-type nil)
  1749. (defvar org-agenda-force-single-file nil)
  1750. (defvar org-agenda-bulk-marked-entries nil
  1751. "List of markers that refer to marked entries in the agenda.")
  1752. ;;; Multiple agenda buffers support
  1753. (defcustom org-agenda-sticky nil
  1754. "Non-nil means agenda q key will bury agenda buffers.
  1755. Agenda commands will then show existing buffer instead of generating new ones.
  1756. When nil, `q' will kill the single agenda buffer."
  1757. :group 'org-agenda
  1758. :version "24.3"
  1759. :type 'boolean)
  1760. ;;;###autoload
  1761. (defun org-toggle-sticky-agenda (&optional arg)
  1762. "Toggle `org-agenda-sticky'."
  1763. (interactive "P")
  1764. (let ((new-value (if arg
  1765. (> (prefix-numeric-value arg) 0)
  1766. (not org-agenda-sticky))))
  1767. (if (equal new-value org-agenda-sticky)
  1768. (and (org-called-interactively-p 'interactive)
  1769. (message "Sticky agenda was already %s"
  1770. (if org-agenda-sticky "enabled" "disabled")))
  1771. (setq org-agenda-sticky new-value)
  1772. (org-agenda-kill-all-agenda-buffers)
  1773. (and (org-called-interactively-p 'interactive)
  1774. (message "Sticky agenda was %s"
  1775. (if org-agenda-sticky "enabled" "disabled"))))))
  1776. (defvar org-agenda-buffer nil
  1777. "Agenda buffer currently being generated.")
  1778. (defvar org-agenda-last-prefix-arg nil)
  1779. (defvar org-agenda-this-buffer-name nil)
  1780. (defvar org-agenda-doing-sticky-redo nil)
  1781. (defvar org-agenda-this-buffer-is-sticky nil)
  1782. (defconst org-agenda-local-vars
  1783. '(org-agenda-this-buffer-name
  1784. org-agenda-undo-list
  1785. org-agenda-pending-undo-list
  1786. org-agenda-follow-mode
  1787. org-agenda-entry-text-mode
  1788. org-agenda-clockreport-mode
  1789. org-agenda-show-log
  1790. org-agenda-redo-command
  1791. org-agenda-query-string
  1792. org-agenda-type
  1793. org-agenda-bulk-marked-entries
  1794. org-agenda-undo-has-started-in
  1795. org-agenda-info
  1796. org-agenda-pre-window-conf
  1797. org-agenda-columns-active
  1798. org-agenda-tag-filter-overlays
  1799. org-agenda-tag-filter
  1800. org-agenda-cat-filter-overlays
  1801. org-agenda-category-filter
  1802. org-agenda-re-filter-overlays
  1803. org-agenda-regexp-filter
  1804. org-agenda-markers
  1805. org-agenda-last-search-view-search-was-boolean
  1806. org-agenda-filtered-by-category
  1807. org-agenda-filter-form
  1808. org-agenda-cycle-counter
  1809. org-agenda-last-prefix-arg)
  1810. "Variables that must be local in agenda buffers to allow multiple buffers.")
  1811. (defun org-agenda-mode ()
  1812. "Mode for time-sorted view on action items in Org-mode files.
  1813. The following commands are available:
  1814. \\{org-agenda-mode-map}"
  1815. (interactive)
  1816. (cond (org-agenda-doing-sticky-redo
  1817. ;; Refreshing sticky agenda-buffer
  1818. ;;
  1819. ;; Preserve the value of `org-agenda-local-vars' variables,
  1820. ;; while letting `kill-all-local-variables' kill the rest
  1821. (let ((save (buffer-local-variables)))
  1822. (kill-all-local-variables)
  1823. (mapc 'make-local-variable org-agenda-local-vars)
  1824. (dolist (elem save)
  1825. (let ((var (car elem))
  1826. (val (cdr elem)))
  1827. (when (and val
  1828. (member var org-agenda-local-vars))
  1829. (set var val)))))
  1830. (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
  1831. (org-agenda-sticky
  1832. ;; Creating a sticky Agenda buffer for the first time
  1833. (kill-all-local-variables)
  1834. (mapc 'make-local-variable org-agenda-local-vars)
  1835. (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
  1836. (t
  1837. ;; Creating a non-sticky agenda buffer
  1838. (kill-all-local-variables)
  1839. (set (make-local-variable 'org-agenda-this-buffer-is-sticky) nil)))
  1840. (setq org-agenda-undo-list nil
  1841. org-agenda-pending-undo-list nil
  1842. org-agenda-bulk-marked-entries nil)
  1843. (setq major-mode 'org-agenda-mode)
  1844. ;; Keep global-font-lock-mode from turning on font-lock-mode
  1845. (org-set-local 'font-lock-global-modes (list 'not major-mode))
  1846. (setq mode-name "Org-Agenda")
  1847. (use-local-map org-agenda-mode-map)
  1848. (easy-menu-add org-agenda-menu)
  1849. (if org-startup-truncated (setq truncate-lines t))
  1850. (org-set-local 'line-move-visual nil)
  1851. (org-add-hook 'post-command-hook 'org-agenda-update-agenda-type nil 'local)
  1852. (org-add-hook 'pre-command-hook 'org-unhighlight nil 'local)
  1853. ;; Make sure properties are removed when copying text
  1854. (make-local-variable 'filter-buffer-substring-functions)
  1855. (add-hook 'filter-buffer-substring-functions
  1856. (lambda (fun start end delete)
  1857. (substring-no-properties (funcall fun start end delete))))
  1858. (unless org-agenda-keep-modes
  1859. (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
  1860. org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
  1861. org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode
  1862. org-agenda-show-log org-agenda-start-with-log-mode))
  1863. (easy-menu-change
  1864. '("Agenda") "Agenda Files"
  1865. (append
  1866. (list
  1867. (vector
  1868. (if (get 'org-agenda-files 'org-restrict)
  1869. "Restricted to single file"
  1870. "Edit File List")
  1871. '(org-edit-agenda-file-list)
  1872. (not (get 'org-agenda-files 'org-restrict)))
  1873. "--")
  1874. (mapcar 'org-file-menu-entry (org-agenda-files))))
  1875. (org-agenda-set-mode-name)
  1876. (apply
  1877. (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
  1878. (list 'org-agenda-mode-hook)))
  1879. (substitute-key-definition 'undo 'org-agenda-undo
  1880. org-agenda-mode-map global-map)
  1881. (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
  1882. (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
  1883. (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
  1884. (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
  1885. (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
  1886. (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
  1887. (org-defkey org-agenda-mode-map "*" 'org-agenda-bulk-mark-all)
  1888. (org-defkey org-agenda-mode-map "#" 'org-agenda-dim-blocked-tasks)
  1889. (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
  1890. (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
  1891. (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-unmark-all)
  1892. (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
  1893. (org-defkey org-agenda-mode-map "k" 'org-agenda-capture)
  1894. (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
  1895. (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
  1896. (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
  1897. (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
  1898. (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
  1899. (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
  1900. (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
  1901. (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
  1902. (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
  1903. (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
  1904. (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
  1905. (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
  1906. (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
  1907. (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
  1908. (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
  1909. (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
  1910. (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
  1911. (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
  1912. (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
  1913. (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
  1914. (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
  1915. (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
  1916. (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
  1917. (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
  1918. (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
  1919. (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
  1920. (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
  1921. (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
  1922. (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
  1923. (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
  1924. (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
  1925. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
  1926. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
  1927. (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
  1928. (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
  1929. (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
  1930. (let ((l '(1 2 3 4 5 6 7 8 9 0)))
  1931. (while l (org-defkey org-agenda-mode-map
  1932. (int-to-string (pop l)) 'digit-argument)))
  1933. (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
  1934. (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
  1935. (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
  1936. (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
  1937. (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
  1938. (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
  1939. (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
  1940. (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
  1941. (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
  1942. (org-defkey org-agenda-mode-map "g" (lambda () (interactive) (org-agenda-redo t)))
  1943. (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
  1944. (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
  1945. (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
  1946. 'org-clock-modify-effort-estimate)
  1947. (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
  1948. (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
  1949. (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
  1950. (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
  1951. (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
  1952. (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
  1953. (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
  1954. (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
  1955. (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
  1956. (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
  1957. (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
  1958. (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
  1959. (substitute-key-definition 'next-line 'org-agenda-next-line
  1960. org-agenda-mode-map global-map)
  1961. (substitute-key-definition 'previous-line 'org-agenda-previous-line
  1962. org-agenda-mode-map global-map)
  1963. (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
  1964. (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
  1965. (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
  1966. (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
  1967. (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
  1968. (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
  1969. (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
  1970. (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
  1971. (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
  1972. (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
  1973. (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
  1974. (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
  1975. (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
  1976. (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
  1977. (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
  1978. (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
  1979. (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
  1980. (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
  1981. (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  1982. (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
  1983. (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
  1984. (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
  1985. (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
  1986. (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
  1987. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
  1988. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
  1989. (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
  1990. (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
  1991. (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
  1992. (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  1993. (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
  1994. (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
  1995. (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
  1996. (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
  1997. (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
  1998. (org-defkey org-agenda-mode-map "|" 'org-agenda-filter-by-regexp)
  1999. (org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag-refine)
  2000. (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
  2001. (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-category)
  2002. (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
  2003. (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
  2004. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  2005. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  2006. (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
  2007. (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
  2008. (when org-agenda-mouse-1-follows-link
  2009. (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
  2010. (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
  2011. '("Agenda"
  2012. ("Agenda Files")
  2013. "--"
  2014. ("Agenda Dates"
  2015. ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
  2016. ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
  2017. ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
  2018. ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
  2019. "--"
  2020. ("View"
  2021. ["Day View" org-agenda-day-view
  2022. :active (org-agenda-check-type nil 'agenda)
  2023. :style radio :selected (eq org-agenda-current-span 'day)
  2024. :keys "v d (or just d)"]
  2025. ["Week View" org-agenda-week-view
  2026. :active (org-agenda-check-type nil 'agenda)
  2027. :style radio :selected (eq org-agenda-current-span 'week)
  2028. :keys "v w (or just w)"]
  2029. ["Month View" org-agenda-month-view
  2030. :active (org-agenda-check-type nil 'agenda)
  2031. :style radio :selected (eq org-agenda-current-span 'month)
  2032. :keys "v m"]
  2033. ["Year View" org-agenda-year-view
  2034. :active (org-agenda-check-type nil 'agenda)
  2035. :style radio :selected (eq org-agenda-current-span 'year)
  2036. :keys "v y"]
  2037. "--"
  2038. ["Include Diary" org-agenda-toggle-diary
  2039. :style toggle :selected org-agenda-include-diary
  2040. :active (org-agenda-check-type nil 'agenda)]
  2041. ["Include Deadlines" org-agenda-toggle-deadlines
  2042. :style toggle :selected org-agenda-include-deadlines
  2043. :active (org-agenda-check-type nil 'agenda)]
  2044. ["Use Time Grid" org-agenda-toggle-time-grid
  2045. :style toggle :selected org-agenda-use-time-grid
  2046. :active (org-agenda-check-type nil 'agenda)]
  2047. "--"
  2048. ["Show clock report" org-agenda-clockreport-mode
  2049. :style toggle :selected org-agenda-clockreport-mode
  2050. :active (org-agenda-check-type nil 'agenda)]
  2051. ["Show some entry text" org-agenda-entry-text-mode
  2052. :style toggle :selected org-agenda-entry-text-mode
  2053. :active t]
  2054. "--"
  2055. ["Show Logbook entries" org-agenda-log-mode
  2056. :style toggle :selected org-agenda-show-log
  2057. :active (org-agenda-check-type nil 'agenda 'timeline)
  2058. :keys "v l (or just l)"]
  2059. ["Include archived trees" org-agenda-archives-mode
  2060. :style toggle :selected org-agenda-archives-mode :active t
  2061. :keys "v a"]
  2062. ["Include archive files" (org-agenda-archives-mode t)
  2063. :style toggle :selected (eq org-agenda-archives-mode t) :active t
  2064. :keys "v A"]
  2065. "--"
  2066. ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
  2067. ["Write view to file" org-agenda-write t]
  2068. ["Rebuild buffer" org-agenda-redo t]
  2069. ["Save all Org-mode Buffers" org-save-all-org-buffers t]
  2070. "--"
  2071. ["Show original entry" org-agenda-show t]
  2072. ["Go To (other window)" org-agenda-goto t]
  2073. ["Go To (this window)" org-agenda-switch-to t]
  2074. ["Capture with cursor date" org-agenda-capture t]
  2075. ["Follow Mode" org-agenda-follow-mode
  2076. :style toggle :selected org-agenda-follow-mode :active t]
  2077. ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
  2078. "--"
  2079. ("TODO"
  2080. ["Cycle TODO" org-agenda-todo t]
  2081. ["Next TODO set" org-agenda-todo-nextset t]
  2082. ["Previous TODO set" org-agenda-todo-previousset t]
  2083. ["Add note" org-agenda-add-note t])
  2084. ("Archive/Refile/Delete"
  2085. ["Archive default" org-agenda-archive-default t]
  2086. ["Archive default" org-agenda-archive-default-with-confirmation t]
  2087. ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
  2088. ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
  2089. ["Archive subtree" org-agenda-archive t]
  2090. "--"
  2091. ["Refile" org-agenda-refile t]
  2092. "--"
  2093. ["Delete subtree" org-agenda-kill t])
  2094. ("Bulk action"
  2095. ["Mark entry" org-agenda-bulk-mark t]
  2096. ["Mark all" org-agenda-bulk-mark-all t]
  2097. ["Mark matching regexp" org-agenda-bulk-mark-regexp t]
  2098. ["Unmark entry" org-agenda-bulk-unmark t]
  2099. ["Unmark all entries" org-agenda-bulk-unmark-all :active t :keys "U"])
  2100. ["Act on all marked" org-agenda-bulk-action t]
  2101. "--"
  2102. ("Tags and Properties"
  2103. ["Show all Tags" org-agenda-show-tags t]
  2104. ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
  2105. ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
  2106. "--"
  2107. ["Column View" org-columns t])
  2108. ("Deadline/Schedule"
  2109. ["Schedule" org-agenda-schedule t]
  2110. ["Set Deadline" org-agenda-deadline t]
  2111. "--"
  2112. ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
  2113. ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
  2114. ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
  2115. ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
  2116. ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
  2117. ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
  2118. ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
  2119. ("Clock and Effort"
  2120. ["Clock in" org-agenda-clock-in t]
  2121. ["Clock out" org-agenda-clock-out t]
  2122. ["Clock cancel" org-agenda-clock-cancel t]
  2123. ["Goto running clock" org-clock-goto t]
  2124. "--"
  2125. ["Set Effort" org-agenda-set-effort t]
  2126. ["Change clocked effort" org-clock-modify-effort-estimate
  2127. (org-clock-is-active)])
  2128. ("Priority"
  2129. ["Set Priority" org-agenda-priority t]
  2130. ["Increase Priority" org-agenda-priority-up t]
  2131. ["Decrease Priority" org-agenda-priority-down t]
  2132. ["Show Priority" org-show-priority t])
  2133. ("Calendar/Diary"
  2134. ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
  2135. ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
  2136. ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
  2137. ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
  2138. ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
  2139. ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
  2140. "--"
  2141. ["Create iCalendar File" org-icalendar-combine-agenda-files t])
  2142. "--"
  2143. ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
  2144. "--"
  2145. ("MobileOrg"
  2146. ["Push Files and Views" org-mobile-push t]
  2147. ["Get Captured and Flagged" org-mobile-pull t]
  2148. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
  2149. ["Show note / unflag" org-agenda-show-the-flagging-note t]
  2150. "--"
  2151. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  2152. "--"
  2153. ["Quit" org-agenda-quit t]
  2154. ["Exit and Release Buffers" org-agenda-exit t]
  2155. ))
  2156. ;;; Agenda undo
  2157. (defvar org-agenda-allow-remote-undo t
  2158. "Non-nil means allow remote undo from the agenda buffer.")
  2159. (defvar org-agenda-undo-has-started-in nil
  2160. "Buffers that have already seen `undo-start' in the current undo sequence.")
  2161. (defun org-agenda-undo ()
  2162. "Undo a remote editing step in the agenda.
  2163. This undoes changes both in the agenda buffer and in the remote buffer
  2164. that have been changed along."
  2165. (interactive)
  2166. (or org-agenda-allow-remote-undo
  2167. (error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
  2168. (if (not (eq this-command last-command))
  2169. (setq org-agenda-undo-has-started-in nil
  2170. org-agenda-pending-undo-list org-agenda-undo-list))
  2171. (if (not org-agenda-pending-undo-list)
  2172. (error "No further undo information"))
  2173. (let* ((entry (pop org-agenda-pending-undo-list))
  2174. buf line cmd rembuf)
  2175. (setq cmd (pop entry) line (pop entry))
  2176. (setq rembuf (nth 2 entry))
  2177. (org-with-remote-undo rembuf
  2178. (while (bufferp (setq buf (pop entry)))
  2179. (if (pop entry)
  2180. (with-current-buffer buf
  2181. (let ((last-undo-buffer buf)
  2182. (inhibit-read-only t))
  2183. (unless (memq buf org-agenda-undo-has-started-in)
  2184. (push buf org-agenda-undo-has-started-in)
  2185. (make-local-variable 'pending-undo-list)
  2186. (undo-start))
  2187. (while (and pending-undo-list
  2188. (listp pending-undo-list)
  2189. (not (car pending-undo-list)))
  2190. (pop pending-undo-list))
  2191. (undo-more 1))))))
  2192. (org-goto-line line)
  2193. (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
  2194. (defun org-verify-change-for-undo (l1 l2)
  2195. "Verify that a real change occurred between the undo lists L1 and L2."
  2196. (while (and l1 (listp l1) (null (car l1))) (pop l1))
  2197. (while (and l2 (listp l2) (null (car l2))) (pop l2))
  2198. (not (eq l1 l2)))
  2199. ;;; Agenda dispatch
  2200. (defvar org-agenda-restrict-begin (make-marker))
  2201. (defvar org-agenda-restrict-end (make-marker))
  2202. (defvar org-agenda-last-dispatch-buffer nil)
  2203. (defvar org-agenda-overriding-restriction nil)
  2204. (defcustom org-agenda-custom-commands-contexts nil
  2205. "Alist of custom agenda keys and contextual rules.
  2206. For example, if you have a custom agenda command \"p\" and you
  2207. want this command to be accessible only from plain text files,
  2208. use this:
  2209. '((\"p\" ((in-file . \"\\.txt\"))))
  2210. Here are the available contexts definitions:
  2211. in-file: command displayed only in matching files
  2212. in-mode: command displayed only in matching modes
  2213. not-in-file: command not displayed in matching files
  2214. not-in-mode: command not displayed in matching modes
  2215. in-buffer: command displayed only in matching buffers
  2216. not-in-buffer: command not displayed in matching buffers
  2217. [function]: a custom function taking no argument
  2218. If you define several checks, the agenda command will be
  2219. accessible if there is at least one valid check.
  2220. You can also bind a key to another agenda custom command
  2221. depending on contextual rules.
  2222. '((\"p\" \"q\" ((in-file . \"\\.txt\"))))
  2223. Here it means: in .txt files, use \"p\" as the key for the
  2224. agenda command otherwise associated with \"q\". (The command
  2225. originally associated with \"q\" is not displayed to avoid
  2226. duplicates.)"
  2227. :version "24.3"
  2228. :group 'org-agenda-custom-commands
  2229. :type '(repeat (list :tag "Rule"
  2230. (string :tag " Agenda key")
  2231. (string :tag "Replace by command")
  2232. (repeat :tag "Available when"
  2233. (choice
  2234. (cons :tag "Condition"
  2235. (choice
  2236. (const :tag "In file" in-file)
  2237. (const :tag "Not in file" not-in-file)
  2238. (const :tag "In buffer" in-buffer)
  2239. (const :tag "Not in buffer" not-in-buffer)
  2240. (const :tag "In mode" in-mode)
  2241. (const :tag "Not in mode" not-in-mode))
  2242. (regexp))
  2243. (function :tag "Custom function"))))))
  2244. (defcustom org-agenda-max-entries nil
  2245. "Maximum number of entries to display in an agenda.
  2246. This can be nil (no limit) or an integer or an alist of agenda
  2247. types with an associated number of entries to display in this
  2248. type."
  2249. :version "24.4"
  2250. :package-version '(Org . "8.0")
  2251. :group 'org-agenda-custom-commands
  2252. :type '(choice (symbol :tag "No limit" nil)
  2253. (integer :tag "Max number of entries")
  2254. (repeat
  2255. (cons (choice :tag "Agenda type"
  2256. (const agenda)
  2257. (const todo)
  2258. (const tags)
  2259. (const search)
  2260. (const timeline))
  2261. (integer :tag "Max number of entries")))))
  2262. (defcustom org-agenda-max-todos nil
  2263. "Maximum number of TODOs to display in an agenda.
  2264. This can be nil (no limit) or an integer or an alist of agenda
  2265. types with an associated number of entries to display in this
  2266. type."
  2267. :version "24.4"
  2268. :package-version '(Org . "8.0")
  2269. :group 'org-agenda-custom-commands
  2270. :type '(choice (symbol :tag "No limit" nil)
  2271. (integer :tag "Max number of entries")
  2272. (repeat
  2273. (cons (choice :tag "Agenda type"
  2274. (const agenda)
  2275. (const todo)
  2276. (const tags)
  2277. (const search)
  2278. (const timeline))
  2279. (integer :tag "Max number of entries")))))
  2280. (defcustom org-agenda-max-tags nil
  2281. "Maximum number of tagged entries to display in an agenda.
  2282. This can be nil (no limit) or an integer or an alist of agenda
  2283. types with an associated number of entries to display in this
  2284. type."
  2285. :version "24.4"
  2286. :package-version '(Org . "8.0")
  2287. :group 'org-agenda-custom-commands
  2288. :type '(choice (symbol :tag "No limit" nil)
  2289. (integer :tag "Max number of entries")
  2290. (repeat
  2291. (cons (choice :tag "Agenda type"
  2292. (const agenda)
  2293. (const todo)
  2294. (const tags)
  2295. (const search)
  2296. (const timeline))
  2297. (integer :tag "Max number of entries")))))
  2298. (defcustom org-agenda-max-effort nil
  2299. "Maximum cumulated effort duration for the agenda.
  2300. This can be nil (no limit) or a number of minutes (as an integer)
  2301. or an alist of agenda types with an associated number of minutes
  2302. to limit entries to in this type."
  2303. :version "24.4"
  2304. :package-version '(Org . "8.0")
  2305. :group 'org-agenda-custom-commands
  2306. :type '(choice (symbol :tag "No limit" nil)
  2307. (integer :tag "Max number of entries")
  2308. (repeat
  2309. (cons (choice :tag "Agenda type"
  2310. (const agenda)
  2311. (const todo)
  2312. (const tags)
  2313. (const search)
  2314. (const timeline))
  2315. (integer :tag "Max number of entries")))))
  2316. (defvar org-keys nil)
  2317. (defvar org-match nil)
  2318. ;;;###autoload
  2319. (defun org-agenda (&optional arg org-keys restriction)
  2320. "Dispatch agenda commands to collect entries to the agenda buffer.
  2321. Prompts for a command to execute. Any prefix arg will be passed
  2322. on to the selected command. The default selections are:
  2323. a Call `org-agenda-list' to display the agenda for current day or week.
  2324. t Call `org-todo-list' to display the global todo list.
  2325. T Call `org-todo-list' to display the global todo list, select only
  2326. entries with a specific TODO keyword (the user gets a prompt).
  2327. m Call `org-tags-view' to display headlines with tags matching
  2328. a condition (the user is prompted for the condition).
  2329. M Like `m', but select only TODO entries, no ordinary headlines.
  2330. L Create a timeline for the current buffer.
  2331. e Export views to associated files.
  2332. s Search entries for keywords.
  2333. S Search entries for keywords, only with TODO keywords.
  2334. / Multi occur across all agenda files and also files listed
  2335. in `org-agenda-text-search-extra-files'.
  2336. < Restrict agenda commands to buffer, subtree, or region.
  2337. Press several times to get the desired effect.
  2338. > Remove a previous restriction.
  2339. # List \"stuck\" projects.
  2340. ! Configure what \"stuck\" means.
  2341. C Configure custom agenda commands.
  2342. More commands can be added by configuring the variable
  2343. `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
  2344. searches can be pre-defined in this way.
  2345. If the current buffer is in Org-mode and visiting a file, you can also
  2346. first press `<' once to indicate that the agenda should be temporarily
  2347. \(until the next use of \\[org-agenda]) restricted to the current file.
  2348. Pressing `<' twice means to restrict to the current subtree or region
  2349. \(if active)."
  2350. (interactive "P")
  2351. (catch 'exit
  2352. (let* ((prefix-descriptions nil)
  2353. (org-agenda-buffer-name org-agenda-buffer-name)
  2354. (org-agenda-window-setup (if (equal (buffer-name)
  2355. org-agenda-buffer-name)
  2356. 'current-window
  2357. org-agenda-window-setup))
  2358. (org-agenda-custom-commands-orig org-agenda-custom-commands)
  2359. (org-agenda-custom-commands
  2360. ;; normalize different versions
  2361. (delq nil
  2362. (mapcar
  2363. (lambda (x)
  2364. (cond ((stringp (cdr x))
  2365. (push x prefix-descriptions)
  2366. nil)
  2367. ((stringp (nth 1 x)) x)
  2368. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2369. (t (cons (car x) (cons "" (cdr x))))))
  2370. org-agenda-custom-commands)))
  2371. (org-agenda-custom-commands
  2372. (org-contextualize-keys
  2373. org-agenda-custom-commands org-agenda-custom-commands-contexts))
  2374. (buf (current-buffer))
  2375. (bfn (buffer-file-name (buffer-base-buffer)))
  2376. entry key type org-match lprops ans)
  2377. ;; Turn off restriction unless there is an overriding one,
  2378. (unless org-agenda-overriding-restriction
  2379. (unless (org-bound-and-true-p org-agenda-keep-restricted-file-list)
  2380. ;; There is a request to keep the file list in place
  2381. (put 'org-agenda-files 'org-restrict nil))
  2382. (setq org-agenda-restrict nil)
  2383. (move-marker org-agenda-restrict-begin nil)
  2384. (move-marker org-agenda-restrict-end nil))
  2385. ;; Delete old local properties
  2386. (put 'org-agenda-redo-command 'org-lprops nil)
  2387. ;; Delete previously set last-arguments
  2388. (put 'org-agenda-redo-command 'last-args nil)
  2389. ;; Remember where this call originated
  2390. (setq org-agenda-last-dispatch-buffer (current-buffer))
  2391. (unless org-keys
  2392. (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
  2393. org-keys (car ans)
  2394. restriction (cdr ans)))
  2395. ;; If we have sticky agenda buffers, set a name for the buffer,
  2396. ;; depending on the invoking keys. The user may still set this
  2397. ;; as a command option, which will overwrite what we do here.
  2398. (if org-agenda-sticky
  2399. (setq org-agenda-buffer-name
  2400. (format "*Org Agenda(%s)*" org-keys)))
  2401. ;; Establish the restriction, if any
  2402. (when (and (not org-agenda-overriding-restriction) restriction)
  2403. (put 'org-agenda-files 'org-restrict (list bfn))
  2404. (cond
  2405. ((eq restriction 'region)
  2406. (setq org-agenda-restrict t)
  2407. (move-marker org-agenda-restrict-begin (region-beginning))
  2408. (move-marker org-agenda-restrict-end (region-end)))
  2409. ((eq restriction 'subtree)
  2410. (save-excursion
  2411. (setq org-agenda-restrict t)
  2412. (org-back-to-heading t)
  2413. (move-marker org-agenda-restrict-begin (point))
  2414. (move-marker org-agenda-restrict-end
  2415. (progn (org-end-of-subtree t)))))))
  2416. ;; For example the todo list should not need it (but does...)
  2417. (cond
  2418. ((setq entry (assoc org-keys org-agenda-custom-commands))
  2419. (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
  2420. (progn
  2421. (setq type (nth 2 entry) org-match (eval (nth 3 entry))
  2422. lprops (nth 4 entry))
  2423. (if org-agenda-sticky
  2424. (setq org-agenda-buffer-name
  2425. (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
  2426. (format "*Org Agenda(%s)*" org-keys))))
  2427. (put 'org-agenda-redo-command 'org-lprops lprops)
  2428. (cond
  2429. ((eq type 'agenda)
  2430. (org-let lprops '(org-agenda-list current-prefix-arg)))
  2431. ((eq type 'agenda*)
  2432. (org-let lprops '(org-agenda-list current-prefix-arg nil nil t)))
  2433. ((eq type 'alltodo)
  2434. (org-let lprops '(org-todo-list current-prefix-arg)))
  2435. ((eq type 'search)
  2436. (org-let lprops '(org-search-view current-prefix-arg org-match nil)))
  2437. ((eq type 'stuck)
  2438. (org-let lprops '(org-agenda-list-stuck-projects
  2439. current-prefix-arg)))
  2440. ((eq type 'tags)
  2441. (org-let lprops '(org-tags-view current-prefix-arg org-match)))
  2442. ((eq type 'tags-todo)
  2443. (org-let lprops '(org-tags-view '(4) org-match)))
  2444. ((eq type 'todo)
  2445. (org-let lprops '(org-todo-list org-match)))
  2446. ((eq type 'tags-tree)
  2447. (org-check-for-org-mode)
  2448. (org-let lprops '(org-match-sparse-tree current-prefix-arg org-match)))
  2449. ((eq type 'todo-tree)
  2450. (org-check-for-org-mode)
  2451. (org-let lprops
  2452. '(org-occur (concat "^" org-outline-regexp "[ \t]*"
  2453. (regexp-quote org-match) "\\>"))))
  2454. ((eq type 'occur-tree)
  2455. (org-check-for-org-mode)
  2456. (org-let lprops '(org-occur org-match)))
  2457. ((functionp type)
  2458. (org-let lprops '(funcall type org-match)))
  2459. ((fboundp type)
  2460. (org-let lprops '(funcall type org-match)))
  2461. (t (error "Invalid custom agenda command type %s" type))))
  2462. (org-agenda-run-series (nth 1 entry) (cddr entry))))
  2463. ((equal org-keys "C")
  2464. (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
  2465. (customize-variable 'org-agenda-custom-commands))
  2466. ((equal org-keys "a") (call-interactively 'org-agenda-list))
  2467. ((equal org-keys "s") (call-interactively 'org-search-view))
  2468. ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
  2469. ((equal org-keys "t") (call-interactively 'org-todo-list))
  2470. ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
  2471. ((equal org-keys "m") (call-interactively 'org-tags-view))
  2472. ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
  2473. ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
  2474. ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
  2475. (org-add-hook
  2476. 'post-command-hook
  2477. (lambda ()
  2478. (unless (current-message)
  2479. (let* ((m (org-agenda-get-any-marker))
  2480. (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
  2481. (when note
  2482. (message (concat
  2483. "FLAGGING-NOTE ([?] for more info): "
  2484. (org-add-props
  2485. (replace-regexp-in-string
  2486. "\\\\n" "//"
  2487. (copy-sequence note))
  2488. nil 'face 'org-warning)))))))
  2489. t t))
  2490. ((equal org-keys "L")
  2491. (unless (derived-mode-p 'org-mode)
  2492. (error "This is not an Org-mode file"))
  2493. (unless restriction
  2494. (put 'org-agenda-files 'org-restrict (list bfn))
  2495. (org-call-with-arg 'org-timeline arg)))
  2496. ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
  2497. ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
  2498. ((equal org-keys "!") (customize-variable 'org-stuck-projects))
  2499. (t (error "Invalid agenda key"))))))
  2500. (defun org-agenda-append-agenda ()
  2501. "Append another agenda view to the current one.
  2502. This function allows interactive building of block agendas.
  2503. Agenda views are separated by `org-agenda-block-separator'."
  2504. (interactive)
  2505. (unless (derived-mode-p 'org-agenda-mode)
  2506. (error "Can only append from within agenda buffer"))
  2507. (let ((org-agenda-multi t))
  2508. (org-agenda)
  2509. (widen)
  2510. (org-agenda-finalize)
  2511. (org-agenda-fit-window-to-buffer)))
  2512. (defun org-agenda-normalize-custom-commands (cmds)
  2513. "Normalize custom commands CMDS."
  2514. (delq nil
  2515. (mapcar
  2516. (lambda (x)
  2517. (cond ((stringp (cdr x)) nil)
  2518. ((stringp (nth 1 x)) x)
  2519. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2520. (t (cons (car x) (cons "" (cdr x))))))
  2521. cmds)))
  2522. (defun org-agenda-get-restriction-and-command (prefix-descriptions)
  2523. "The user interface for selecting an agenda command."
  2524. (catch 'exit
  2525. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  2526. (restrict-ok (and bfn (derived-mode-p 'org-mode)))
  2527. (region-p (org-region-active-p))
  2528. (custom org-agenda-custom-commands)
  2529. (selstring "")
  2530. restriction second-time
  2531. c entry key type match prefixes rmheader header-end custom1 desc
  2532. line lines left right n n1)
  2533. (save-window-excursion
  2534. (delete-other-windows)
  2535. (org-switch-to-buffer-other-window " *Agenda Commands*")
  2536. (erase-buffer)
  2537. (insert (eval-when-compile
  2538. (let ((header
  2539. "Press key for an agenda command: < Buffer, subtree/region restriction
  2540. -------------------------------- > Remove restriction
  2541. a Agenda for current week or day e Export agenda views
  2542. t List of all TODO entries T Entries with special TODO kwd
  2543. m Match a TAGS/PROP/TODO query M Like m, but only TODO entries
  2544. s Search for keywords S Like s, but only TODO entries
  2545. L Timeline for current buffer # List stuck projects (!=configure)
  2546. / Multi-occur C Configure custom agenda commands
  2547. ? Find :FLAGGED: entries * Toggle sticky agenda views
  2548. ")
  2549. (start 0))
  2550. (while (string-match
  2551. "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
  2552. header start)
  2553. (setq start (match-end 0))
  2554. (add-text-properties (match-beginning 2) (match-end 2)
  2555. '(face bold) header))
  2556. header)))
  2557. (setq header-end (point-marker))
  2558. (while t
  2559. (setq custom1 custom)
  2560. (when (eq rmheader t)
  2561. (org-goto-line 1)
  2562. (re-search-forward ":" nil t)
  2563. (delete-region (match-end 0) (point-at-eol))
  2564. (forward-char 1)
  2565. (looking-at "-+")
  2566. (delete-region (match-end 0) (point-at-eol))
  2567. (move-marker header-end (match-end 0)))
  2568. (goto-char header-end)
  2569. (delete-region (point) (point-max))
  2570. ;; Produce all the lines that describe custom commands and prefixes
  2571. (setq lines nil)
  2572. (while (setq entry (pop custom1))
  2573. (setq key (car entry) desc (nth 1 entry)
  2574. type (nth 2 entry)
  2575. match (nth 3 entry))
  2576. (if (> (length key) 1)
  2577. (add-to-list 'prefixes (string-to-char key))
  2578. (setq line
  2579. (format
  2580. "%-4s%-14s"
  2581. (org-add-props (copy-sequence key)
  2582. '(face bold))
  2583. (cond
  2584. ((string-match "\\S-" desc) desc)
  2585. ((eq type 'agenda) "Agenda for current week or day")
  2586. ((eq type 'agenda*) "Appointments for current week or day")
  2587. ((eq type 'alltodo) "List of all TODO entries")
  2588. ((eq type 'search) "Word search")
  2589. ((eq type 'stuck) "List of stuck projects")
  2590. ((eq type 'todo) "TODO keyword")
  2591. ((eq type 'tags) "Tags query")
  2592. ((eq type 'tags-todo) "Tags (TODO)")
  2593. ((eq type 'tags-tree) "Tags tree")
  2594. ((eq type 'todo-tree) "TODO kwd tree")
  2595. ((eq type 'occur-tree) "Occur tree")
  2596. ((functionp type) (if (symbolp type)
  2597. (symbol-name type)
  2598. "Lambda expression"))
  2599. (t "???"))))
  2600. (if org-agenda-menu-show-matcher
  2601. (setq line
  2602. (concat line ": "
  2603. (cond
  2604. ((stringp match)
  2605. (setq match (copy-sequence match))
  2606. (org-add-props match nil 'face 'org-warning))
  2607. ((listp type)
  2608. (format "set of %d commands" (length type))))))
  2609. (if (org-string-nw-p match)
  2610. (add-text-properties
  2611. 0 (length line) (list 'help-echo
  2612. (concat "Matcher: " match)) line)))
  2613. (push line lines)))
  2614. (setq lines (nreverse lines))
  2615. (when prefixes
  2616. (mapc (lambda (x)
  2617. (push
  2618. (format "%s %s"
  2619. (org-add-props (char-to-string x)
  2620. nil 'face 'bold)
  2621. (or (cdr (assoc (concat selstring
  2622. (char-to-string x))
  2623. prefix-descriptions))
  2624. "Prefix key"))
  2625. lines))
  2626. prefixes))
  2627. ;; Check if we should display in two columns
  2628. (if org-agenda-menu-two-columns
  2629. (progn
  2630. (setq n (length lines)
  2631. n1 (+ (/ n 2) (mod n 2))
  2632. right (nthcdr n1 lines)
  2633. left (copy-sequence lines))
  2634. (setcdr (nthcdr (1- n1) left) nil))
  2635. (setq left lines right nil))
  2636. (while left
  2637. (insert "\n" (pop left))
  2638. (when right
  2639. (if (< (current-column) 40)
  2640. (move-to-column 40 t)
  2641. (insert " "))
  2642. (insert (pop right))))
  2643. ;; Make the window the right size
  2644. (goto-char (point-min))
  2645. (if second-time
  2646. (if (not (pos-visible-in-window-p (point-max)))
  2647. (org-fit-window-to-buffer))
  2648. (setq second-time t)
  2649. (org-fit-window-to-buffer))
  2650. ;; Ask for selection
  2651. (message "Press key for agenda command%s:"
  2652. (if (or restrict-ok org-agenda-overriding-restriction)
  2653. (if org-agenda-overriding-restriction
  2654. " (restriction lock active)"
  2655. (if restriction
  2656. (format " (restricted to %s)" restriction)
  2657. " (unrestricted)"))
  2658. ""))
  2659. (setq c (read-char-exclusive))
  2660. (message "")
  2661. (cond
  2662. ((assoc (char-to-string c) custom)
  2663. (setq selstring (concat selstring (char-to-string c)))
  2664. (throw 'exit (cons selstring restriction)))
  2665. ((memq c prefixes)
  2666. (setq selstring (concat selstring (char-to-string c))
  2667. prefixes nil
  2668. rmheader (or rmheader t)
  2669. custom (delq nil (mapcar
  2670. (lambda (x)
  2671. (if (or (= (length (car x)) 1)
  2672. (/= (string-to-char (car x)) c))
  2673. nil
  2674. (cons (substring (car x) 1) (cdr x))))
  2675. custom))))
  2676. ((eq c ?*)
  2677. (call-interactively 'org-toggle-sticky-agenda)
  2678. (sit-for 2))
  2679. ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
  2680. (message "Restriction is only possible in Org-mode buffers")
  2681. (ding) (sit-for 1))
  2682. ((eq c ?1)
  2683. (org-agenda-remove-restriction-lock 'noupdate)
  2684. (setq restriction 'buffer))
  2685. ((eq c ?0)
  2686. (org-agenda-remove-restriction-lock 'noupdate)
  2687. (setq restriction (if region-p 'region 'subtree)))
  2688. ((eq c ?<)
  2689. (org-agenda-remove-restriction-lock 'noupdate)
  2690. (setq restriction
  2691. (cond
  2692. ((eq restriction 'buffer)
  2693. (if region-p 'region 'subtree))
  2694. ((memq restriction '(subtree region))
  2695. nil)
  2696. (t 'buffer))))
  2697. ((eq c ?>)
  2698. (org-agenda-remove-restriction-lock 'noupdate)
  2699. (setq restriction nil))
  2700. ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
  2701. (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
  2702. ((and (> (length selstring) 0) (eq c ?\d))
  2703. (delete-window)
  2704. (org-agenda-get-restriction-and-command prefix-descriptions))
  2705. ((equal c ?q) (error "Abort"))
  2706. (t (error "Invalid key %c" c))))))))
  2707. (defun org-agenda-fit-window-to-buffer ()
  2708. "Fit the window to the buffer size."
  2709. (and (memq org-agenda-window-setup '(reorganize-frame))
  2710. (fboundp 'fit-window-to-buffer)
  2711. (org-fit-window-to-buffer
  2712. nil
  2713. (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
  2714. (floor (* (frame-height) (car org-agenda-window-frame-fractions))))))
  2715. (defvar org-cmd nil)
  2716. (defvar org-agenda-overriding-cmd nil)
  2717. (defvar org-agenda-overriding-arguments nil)
  2718. (defvar org-agenda-overriding-cmd-arguments nil)
  2719. (defun org-agenda-run-series (name series)
  2720. "Run agenda NAME as a SERIES of agenda commands."
  2721. (org-let (nth 1 series) '(org-agenda-prepare name))
  2722. ;; We need to reset agenda markers here, because when constructing a
  2723. ;; block agenda, the individual blocks do not do that.
  2724. (org-agenda-reset-markers)
  2725. (let* ((org-agenda-multi t)
  2726. (redo (list 'org-agenda-run-series name (list 'quote series)))
  2727. (cmds (car series))
  2728. (gprops (nth 1 series))
  2729. match ;; The byte compiler incorrectly complains about this. Keep it!
  2730. org-cmd type lprops)
  2731. (while (setq org-cmd (pop cmds))
  2732. (setq type (car org-cmd)
  2733. match (eval (nth 1 org-cmd))
  2734. lprops (nth 2 org-cmd))
  2735. (let ((org-agenda-overriding-arguments
  2736. (if (eq org-agenda-overriding-cmd org-cmd)
  2737. (or org-agenda-overriding-arguments
  2738. org-agenda-overriding-cmd-arguments))))
  2739. (cond
  2740. ((eq type 'agenda)
  2741. (org-let2 gprops lprops
  2742. '(call-interactively 'org-agenda-list)))
  2743. ((eq type 'agenda*)
  2744. (org-let2 gprops lprops
  2745. '(funcall 'org-agenda-list nil nil t)))
  2746. ((eq type 'alltodo)
  2747. (org-let2 gprops lprops
  2748. '(call-interactively 'org-todo-list)))
  2749. ((eq type 'search)
  2750. (org-let2 gprops lprops
  2751. '(org-search-view current-prefix-arg match nil)))
  2752. ((eq type 'stuck)
  2753. (org-let2 gprops lprops
  2754. '(call-interactively 'org-agenda-list-stuck-projects)))
  2755. ((eq type 'tags)
  2756. (org-let2 gprops lprops
  2757. '(org-tags-view current-prefix-arg match)))
  2758. ((eq type 'tags-todo)
  2759. (org-let2 gprops lprops
  2760. '(org-tags-view '(4) match)))
  2761. ((eq type 'todo)
  2762. (org-let2 gprops lprops
  2763. '(org-todo-list match)))
  2764. ((fboundp type)
  2765. (org-let2 gprops lprops
  2766. '(funcall type match)))
  2767. (t (error "Invalid type in command series")))))
  2768. (widen)
  2769. (let ((inhibit-read-only t))
  2770. (add-text-properties (point-min) (point-max)
  2771. `(org-series t org-series-redo-cmd ,redo)))
  2772. (setq org-agenda-redo-command redo)
  2773. (goto-char (point-min)))
  2774. (org-agenda-fit-window-to-buffer)
  2775. (org-let (nth 1 series) '(org-agenda-finalize)))
  2776. ;;;###autoload
  2777. (defmacro org-batch-agenda (cmd-key &rest parameters)
  2778. "Run an agenda command in batch mode and send the result to STDOUT.
  2779. If CMD-KEY is a string of length 1, it is used as a key in
  2780. `org-agenda-custom-commands' and triggers this command. If it is a
  2781. longer string it is used as a tags/todo match string.
  2782. Parameters are alternating variable names and values that will be bound
  2783. before running the agenda command."
  2784. (org-eval-in-environment (org-make-parameter-alist parameters)
  2785. (if (> (length cmd-key) 2)
  2786. (org-tags-view nil cmd-key)
  2787. (org-agenda nil cmd-key)))
  2788. (set-buffer org-agenda-buffer-name)
  2789. (princ (buffer-string)))
  2790. (defvar org-agenda-info nil)
  2791. ;;;###autoload
  2792. (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
  2793. "Run an agenda command in batch mode and send the result to STDOUT.
  2794. If CMD-KEY is a string of length 1, it is used as a key in
  2795. `org-agenda-custom-commands' and triggers this command. If it is a
  2796. longer string it is used as a tags/todo match string.
  2797. Parameters are alternating variable names and values that will be bound
  2798. before running the agenda command.
  2799. The output gives a line for each selected agenda item. Each
  2800. item is a list of comma-separated values, like this:
  2801. category,head,type,todo,tags,date,time,extra,priority-l,priority-n
  2802. category The category of the item
  2803. head The headline, without TODO kwd, TAGS and PRIORITY
  2804. type The type of the agenda entry, can be
  2805. todo selected in TODO match
  2806. tagsmatch selected in tags match
  2807. diary imported from diary
  2808. deadline a deadline on given date
  2809. scheduled scheduled on given date
  2810. timestamp entry has timestamp on given date
  2811. closed entry was closed on given date
  2812. upcoming-deadline warning about deadline
  2813. past-scheduled forwarded scheduled item
  2814. block entry has date block including g. date
  2815. todo The todo keyword, if any
  2816. tags All tags including inherited ones, separated by colons
  2817. date The relevant date, like 2007-2-14
  2818. time The time, like 15:00-16:50
  2819. extra Sting with extra planning info
  2820. priority-l The priority letter if any was given
  2821. priority-n The computed numerical priority
  2822. agenda-day The day in the agenda where this is listed"
  2823. (org-eval-in-environment (append '((org-agenda-remove-tags t))
  2824. (org-make-parameter-alist parameters))
  2825. (if (> (length cmd-key) 2)
  2826. (org-tags-view nil cmd-key)
  2827. (org-agenda nil cmd-key)))
  2828. (set-buffer org-agenda-buffer-name)
  2829. (let* ((lines (org-split-string (buffer-string) "\n"))
  2830. line)
  2831. (while (setq line (pop lines))
  2832. (catch 'next
  2833. (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
  2834. (setq org-agenda-info
  2835. (org-fix-agenda-info (text-properties-at 0 line)))
  2836. (princ
  2837. (mapconcat 'org-agenda-export-csv-mapper
  2838. '(org-category txt type todo tags date time extra
  2839. priority-letter priority agenda-day)
  2840. ","))
  2841. (princ "\n")))))
  2842. (defun org-fix-agenda-info (props)
  2843. "Make sure all properties on an agenda item have a canonical form.
  2844. This ensures the export commands can easily use it."
  2845. (let (tmp re)
  2846. (when (setq tmp (plist-get props 'tags))
  2847. (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
  2848. (when (setq tmp (plist-get props 'date))
  2849. (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2850. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2851. '((format "%4d, %9s %2s, %4s" dayname monthname day year))
  2852. (setq tmp (calendar-date-string tmp)))
  2853. (setq props (plist-put props 'date tmp)))
  2854. (when (setq tmp (plist-get props 'day))
  2855. (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2856. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2857. (setq tmp (calendar-date-string tmp)))
  2858. (setq props (plist-put props 'day tmp))
  2859. (setq props (plist-put props 'agenda-day tmp)))
  2860. (when (setq tmp (plist-get props 'txt))
  2861. (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
  2862. (plist-put props 'priority-letter (match-string 1 tmp))
  2863. (setq tmp (replace-match "" t t tmp)))
  2864. (when (and (setq re (plist-get props 'org-todo-regexp))
  2865. (setq re (concat "\\`\\.*" re " ?"))
  2866. (string-match re tmp))
  2867. (plist-put props 'todo (match-string 1 tmp))
  2868. (setq tmp (replace-match "" t t tmp)))
  2869. (plist-put props 'txt tmp)))
  2870. props)
  2871. (defun org-agenda-export-csv-mapper (prop)
  2872. (let ((res (plist-get org-agenda-info prop)))
  2873. (setq res
  2874. (cond
  2875. ((not res) "")
  2876. ((stringp res) res)
  2877. (t (prin1-to-string res))))
  2878. (while (string-match "," res)
  2879. (setq res (replace-match ";" t t res)))
  2880. (org-trim res)))
  2881. ;;;###autoload
  2882. (defun org-store-agenda-views (&rest parameters)
  2883. "Store agenda views."
  2884. (interactive)
  2885. (eval (list 'org-batch-store-agenda-views)))
  2886. ;;;###autoload
  2887. (defmacro org-batch-store-agenda-views (&rest parameters)
  2888. "Run all custom agenda commands that have a file argument."
  2889. (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
  2890. (pop-up-frames nil)
  2891. (dir default-directory)
  2892. (pars (org-make-parameter-alist parameters))
  2893. cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
  2894. (save-window-excursion
  2895. (while cmds
  2896. (setq cmd (pop cmds)
  2897. thiscmdkey (car cmd)
  2898. thiscmdcmd (cdr cmd)
  2899. match (nth 2 thiscmdcmd)
  2900. bufname (if org-agenda-sticky
  2901. (or (and (stringp match)
  2902. (format "*Org Agenda(%s:%s)*" thiscmdkey match))
  2903. (format "*Org Agenda(%s)*" thiscmdkey))
  2904. org-agenda-buffer-name)
  2905. cmd-or-set (nth 2 cmd)
  2906. opts (nth (if (listp cmd-or-set) 3 4) cmd)
  2907. files (nth (if (listp cmd-or-set) 4 5) cmd))
  2908. (if (stringp files) (setq files (list files)))
  2909. (when files
  2910. (org-eval-in-environment (append org-agenda-exporter-settings
  2911. opts pars)
  2912. (org-agenda nil thiscmdkey))
  2913. (set-buffer bufname)
  2914. (while files
  2915. (org-eval-in-environment (append org-agenda-exporter-settings
  2916. opts pars)
  2917. (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
  2918. (and (get-buffer bufname)
  2919. (kill-buffer bufname)))))))
  2920. (defvar org-agenda-current-span nil
  2921. "The current span used in the agenda view.") ; local variable in the agenda buffer
  2922. (defun org-agenda-mark-header-line (pos)
  2923. "Mark the line at POS as an agenda structure header."
  2924. (save-excursion
  2925. (goto-char pos)
  2926. (put-text-property (point-at-bol) (point-at-eol)
  2927. 'org-agenda-structural-header t)
  2928. (when org-agenda-title-append
  2929. (put-text-property (point-at-bol) (point-at-eol)
  2930. 'org-agenda-title-append org-agenda-title-append))))
  2931. (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
  2932. (defvar org-agenda-write-buffer-name "Agenda View")
  2933. (defun org-agenda-write (file &optional open nosettings agenda-bufname)
  2934. "Write the current buffer (an agenda view) as a file.
  2935. Depending on the extension of the file name, plain text (.txt),
  2936. HTML (.html or .htm), PDF (.pdf) or Postscript (.ps) is produced.
  2937. If the extension is .ics, run icalendar export over all files used
  2938. to construct the agenda and limit the export to entries listed in the
  2939. agenda now.
  2940. If the extension is .org, collect all subtrees corresponding to the
  2941. agenda entries and add them in an .org file.
  2942. With prefix argument OPEN, open the new file immediately.
  2943. If NOSETTINGS is given, do not scope the settings of
  2944. `org-agenda-exporter-settings' into the export commands. This is used when
  2945. the settings have already been scoped and we do not wish to overrule other,
  2946. higher priority settings.
  2947. If AGENDA-BUFFER-NAME, use this as the buffer name for the agenda to write."
  2948. (interactive "FWrite agenda to file: \nP")
  2949. (if (or (not (file-writable-p file))
  2950. (and (file-exists-p file)
  2951. (if (called-interactively-p 'any)
  2952. (not (y-or-n-p (format "Overwrite existing file %s? " file))))))
  2953. (error "Cannot write agenda to file %s" file))
  2954. (org-let (if nosettings nil org-agenda-exporter-settings)
  2955. '(save-excursion
  2956. (save-window-excursion
  2957. (org-agenda-mark-filtered-text)
  2958. (let ((bs (copy-sequence (buffer-string))) beg content)
  2959. (org-agenda-unmark-filtered-text)
  2960. (with-temp-buffer
  2961. (rename-buffer org-agenda-write-buffer-name t)
  2962. (set-buffer-modified-p nil)
  2963. (insert bs)
  2964. (org-agenda-remove-marked-text 'org-filtered)
  2965. (while (setq beg (text-property-any (point-min) (point-max)
  2966. 'org-filtered t))
  2967. (delete-region
  2968. beg (or (next-single-property-change beg 'org-filtered)
  2969. (point-max))))
  2970. (run-hooks 'org-agenda-before-write-hook)
  2971. (cond
  2972. ((org-bound-and-true-p org-mobile-creating-agendas)
  2973. (org-mobile-write-agenda-for-mobile file))
  2974. ((string-match "\\.org\\'" file)
  2975. (let (content p m message-log-max)
  2976. (goto-char (point-min))
  2977. (while (setq p (next-single-property-change (point) 'org-hd-marker nil))
  2978. (goto-char p)
  2979. (setq m (get-text-property (point) 'org-hd-marker))
  2980. (when m
  2981. (push (save-excursion
  2982. (set-buffer (marker-buffer m))
  2983. (goto-char m)
  2984. (org-copy-subtree 1 nil t t)
  2985. org-subtree-clip)
  2986. content)))
  2987. (find-file file)
  2988. (erase-buffer)
  2989. (mapcar (lambda (s) (org-paste-subtree 1 s)) (reverse content))
  2990. (write-file file)
  2991. (kill-buffer (current-buffer))
  2992. (message "Org file written to %s" file)))
  2993. ((string-match "\\.html?\\'" file)
  2994. (require 'htmlize)
  2995. (set-buffer (htmlize-buffer (current-buffer)))
  2996. (when org-agenda-export-html-style
  2997. ;; replace <style> section with org-agenda-export-html-style
  2998. (goto-char (point-min))
  2999. (kill-region (- (search-forward "<style") 6)
  3000. (search-forward "</style>"))
  3001. (insert org-agenda-export-html-style))
  3002. (write-file file)
  3003. (kill-buffer (current-buffer))
  3004. (message "HTML written to %s" file))
  3005. ((string-match "\\.ps\\'" file)
  3006. (require 'ps-print)
  3007. (ps-print-buffer-with-faces file)
  3008. (message "Postscript written to %s" file))
  3009. ((string-match "\\.pdf\\'" file)
  3010. (require 'ps-print)
  3011. (ps-print-buffer-with-faces
  3012. (concat (file-name-sans-extension file) ".ps"))
  3013. (call-process "ps2pdf" nil nil nil
  3014. (expand-file-name
  3015. (concat (file-name-sans-extension file) ".ps"))
  3016. (expand-file-name file))
  3017. (delete-file (concat (file-name-sans-extension file) ".ps"))
  3018. (message "PDF written to %s" file))
  3019. ((string-match "\\.ics\\'" file)
  3020. (require 'ox-icalendar)
  3021. (org-icalendar-export-current-agenda (expand-file-name file)))
  3022. (t
  3023. (let ((bs (buffer-string)))
  3024. (find-file file)
  3025. (erase-buffer)
  3026. (insert bs)
  3027. (save-buffer 0)
  3028. (kill-buffer (current-buffer))
  3029. (message "Plain text written to %s" file))))))))
  3030. (set-buffer (or agenda-bufname
  3031. (and (org-called-interactively-p 'any) (buffer-name))
  3032. org-agenda-buffer-name)))
  3033. (when open (org-open-file file)))
  3034. (defvar org-agenda-tag-filter-overlays nil)
  3035. (defvar org-agenda-cat-filter-overlays nil)
  3036. (defvar org-agenda-re-filter-overlays nil)
  3037. (defun org-agenda-mark-filtered-text ()
  3038. "Mark all text hidden by filtering with a text property."
  3039. (let ((inhibit-read-only t))
  3040. (mapc
  3041. (lambda (o)
  3042. (when (equal (overlay-buffer o) (current-buffer))
  3043. (put-text-property
  3044. (overlay-start o) (overlay-end o)
  3045. 'org-filtered t)))
  3046. (append org-agenda-tag-filter-overlays
  3047. org-agenda-cat-filter-overlays
  3048. org-agenda-re-filter-overlays))))
  3049. (defun org-agenda-unmark-filtered-text ()
  3050. "Remove the filtering text property."
  3051. (let ((inhibit-read-only t))
  3052. (remove-text-properties (point-min) (point-max) '(org-filtered t))))
  3053. (defun org-agenda-remove-marked-text (property &optional value)
  3054. "Delete all text marked with VALUE of PROPERTY.
  3055. VALUE defaults to t."
  3056. (let (beg)
  3057. (setq value (or value t))
  3058. (while (setq beg (text-property-any (point-min) (point-max)
  3059. property value))
  3060. (delete-region
  3061. beg (or (next-single-property-change beg 'org-filtered)
  3062. (point-max))))))
  3063. (defun org-agenda-add-entry-text ()
  3064. "Add entry text to agenda lines.
  3065. This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
  3066. entry text following headings shown in the agenda.
  3067. Drawers will be excluded, also the line with scheduling/deadline info."
  3068. (when (and (> org-agenda-add-entry-text-maxlines 0)
  3069. (not (org-bound-and-true-p org-mobile-creating-agendas)))
  3070. (let (m txt)
  3071. (goto-char (point-min))
  3072. (while (not (eobp))
  3073. (if (not (setq m (org-get-at-bol 'org-hd-marker)))
  3074. (beginning-of-line 2)
  3075. (setq txt (org-agenda-get-some-entry-text
  3076. m org-agenda-add-entry-text-maxlines " > "))
  3077. (end-of-line 1)
  3078. (if (string-match "\\S-" txt)
  3079. (insert "\n" txt)
  3080. (or (eobp) (forward-char 1))))))))
  3081. (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
  3082. &rest keep)
  3083. "Extract entry text from MARKER, at most N-LINES lines.
  3084. This will ignore drawers etc, just get the text.
  3085. If INDENT is given, prefix every line with this string. If KEEP is
  3086. given, it is a list of symbols, defining stuff that should not be
  3087. removed from the entry content. Currently only `planning' is allowed here."
  3088. (let (txt drawer-re kwd-time-re ind)
  3089. (save-excursion
  3090. (with-current-buffer (marker-buffer marker)
  3091. (if (not (derived-mode-p 'org-mode))
  3092. (setq txt "")
  3093. (save-excursion
  3094. (save-restriction
  3095. (widen)
  3096. (goto-char marker)
  3097. (end-of-line 1)
  3098. (setq txt (buffer-substring
  3099. (min (1+ (point)) (point-max))
  3100. (progn (outline-next-heading) (point)))
  3101. drawer-re org-drawer-regexp
  3102. kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
  3103. ".*\n?"))
  3104. (with-temp-buffer
  3105. (insert txt)
  3106. (when org-agenda-add-entry-text-descriptive-links
  3107. (goto-char (point-min))
  3108. (while (org-activate-bracket-links (point-max))
  3109. (add-text-properties (match-beginning 0) (match-end 0)
  3110. '(face org-link))))
  3111. (goto-char (point-min))
  3112. (while (re-search-forward org-bracket-link-regexp (point-max) t)
  3113. (set-text-properties (match-beginning 0) (match-end 0)
  3114. nil))
  3115. (goto-char (point-min))
  3116. (while (re-search-forward drawer-re nil t)
  3117. (delete-region
  3118. (match-beginning 0)
  3119. (progn (re-search-forward
  3120. "^[ \t]*:END:.*\n?" nil 'move)
  3121. (point))))
  3122. (unless (member 'planning keep)
  3123. (goto-char (point-min))
  3124. (while (re-search-forward kwd-time-re nil t)
  3125. (replace-match "")))
  3126. (goto-char (point-min))
  3127. (when org-agenda-entry-text-exclude-regexps
  3128. (let ((re-list org-agenda-entry-text-exclude-regexps) re)
  3129. (while (setq re (pop re-list))
  3130. (goto-char (point-min))
  3131. (while (re-search-forward re nil t)
  3132. (replace-match "")))))
  3133. (goto-char (point-max))
  3134. (skip-chars-backward " \t\n")
  3135. (if (looking-at "[ \t\n]+\\'") (replace-match ""))
  3136. ;; find and remove min common indentation
  3137. (goto-char (point-min))
  3138. (untabify (point-min) (point-max))
  3139. (setq ind (org-get-indentation))
  3140. (while (not (eobp))
  3141. (unless (looking-at "[ \t]*$")
  3142. (setq ind (min ind (org-get-indentation))))
  3143. (beginning-of-line 2))
  3144. (goto-char (point-min))
  3145. (while (not (eobp))
  3146. (unless (looking-at "[ \t]*$")
  3147. (move-to-column ind)
  3148. (delete-region (point-at-bol) (point)))
  3149. (beginning-of-line 2))
  3150. (run-hooks 'org-agenda-entry-text-cleanup-hook)
  3151. (goto-char (point-min))
  3152. (when indent
  3153. (while (and (not (eobp)) (re-search-forward "^" nil t))
  3154. (replace-match indent t t)))
  3155. (goto-char (point-min))
  3156. (while (looking-at "[ \t]*\n") (replace-match ""))
  3157. (goto-char (point-max))
  3158. (when (> (org-current-line)
  3159. n-lines)
  3160. (org-goto-line (1+ n-lines))
  3161. (backward-char 1))
  3162. (setq txt (buffer-substring (point-min) (point)))))))))
  3163. txt))
  3164. (defun org-check-for-org-mode ()
  3165. "Make sure current buffer is in org-mode. Error if not."
  3166. (or (derived-mode-p 'org-mode)
  3167. (error "Cannot execute org-mode agenda command on buffer in %s"
  3168. major-mode)))
  3169. ;;; Agenda prepare and finalize
  3170. (defvar org-agenda-multi nil) ; dynamically scoped
  3171. (defvar org-agenda-pre-window-conf nil)
  3172. (defvar org-agenda-columns-active nil)
  3173. (defvar org-agenda-name nil)
  3174. (defvar org-agenda-tag-filter nil)
  3175. (defvar org-agenda-category-filter nil)
  3176. (defvar org-agenda-top-category-filter nil)
  3177. (defvar org-agenda-tag-filter-while-redo nil)
  3178. (defvar org-agenda-tag-filter-preset nil
  3179. "A preset of the tags filter used for secondary agenda filtering.
  3180. This must be a list of strings, each string must be a single tag preceded
  3181. by \"+\" or \"-\".
  3182. This variable should not be set directly, but agenda custom commands can
  3183. bind it in the options section. The preset filter is a global property of
  3184. the entire agenda view. In a block agenda, it will not work reliably to
  3185. define a filter for one of the individual blocks. You need to set it in
  3186. the global options and expect it to be applied to the entire view.")
  3187. (defvar org-agenda-category-filter-preset nil
  3188. "A preset of the category filter used for secondary agenda filtering.
  3189. This must be a list of strings, each string must be a single category
  3190. preceded by \"+\" or \"-\".
  3191. This variable should not be set directly, but agenda custom commands can
  3192. bind it in the options section. The preset filter is a global property of
  3193. the entire agenda view. In a block agenda, it will not work reliably to
  3194. define a filter for one of the individual blocks. You need to set it in
  3195. the global options and expect it to be applied to the entire view.")
  3196. (defvar org-agenda-regexp-filter-preset nil
  3197. "A preset of the regexp filter used for secondary agenda filtering.
  3198. This must be a list of strings, each string must be a single category
  3199. preceded by \"+\" or \"-\".
  3200. This variable should not be set directly, but agenda custom commands can
  3201. bind it in the options section. The preset filter is a global property of
  3202. the entire agenda view. In a block agenda, it will not work reliably to
  3203. define a filter for one of the individual blocks. You need to set it in
  3204. the global options and expect it to be applied to the entire view.")
  3205. (defun org-agenda-use-sticky-p ()
  3206. "Return non-nil if an agenda buffer named
  3207. `org-agenda-buffer-name' exists and should be shown instead of
  3208. generating a new one."
  3209. (and
  3210. ;; turned off by user
  3211. org-agenda-sticky
  3212. ;; For multi-agenda buffer already exists
  3213. (not org-agenda-multi)
  3214. ;; buffer found
  3215. (get-buffer org-agenda-buffer-name)
  3216. ;; C-u parameter is same as last call
  3217. (with-current-buffer (get-buffer org-agenda-buffer-name)
  3218. (and
  3219. (equal current-prefix-arg
  3220. org-agenda-last-prefix-arg)
  3221. ;; In case user turned stickiness on, while having existing
  3222. ;; Agenda buffer active, don't reuse that buffer, because it
  3223. ;; does not have org variables local
  3224. org-agenda-this-buffer-is-sticky))))
  3225. (defun org-agenda-prepare-window (abuf)
  3226. "Setup agenda buffer in the window."
  3227. (let* ((awin (get-buffer-window abuf))
  3228. wconf)
  3229. (cond
  3230. ((equal (current-buffer) abuf) nil)
  3231. (awin (select-window awin))
  3232. ((not (setq wconf (current-window-configuration))))
  3233. ((equal org-agenda-window-setup 'current-window)
  3234. (org-pop-to-buffer-same-window abuf))
  3235. ((equal org-agenda-window-setup 'other-window)
  3236. (org-switch-to-buffer-other-window abuf))
  3237. ((equal org-agenda-window-setup 'other-frame)
  3238. (switch-to-buffer-other-frame abuf))
  3239. ((equal org-agenda-window-setup 'reorganize-frame)
  3240. (delete-other-windows)
  3241. (org-switch-to-buffer-other-window abuf)))
  3242. ;; additional test in case agenda is invoked from within agenda
  3243. ;; buffer via elisp link
  3244. (unless (equal (current-buffer) abuf)
  3245. (org-pop-to-buffer-same-window abuf))
  3246. (setq org-agenda-pre-window-conf
  3247. (or org-agenda-pre-window-conf wconf))))
  3248. (defun org-agenda-prepare (&optional name)
  3249. (if (org-agenda-use-sticky-p)
  3250. (progn
  3251. ;; Popup existing buffer
  3252. (org-agenda-prepare-window (get-buffer org-agenda-buffer-name))
  3253. (message "Sticky Agenda buffer, use `r' to refresh")
  3254. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3255. (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
  3256. (setq org-todo-keywords-for-agenda nil)
  3257. (setq org-drawers-for-agenda nil)
  3258. (unless org-agenda-persistent-filter
  3259. (setq org-agenda-tag-filter nil
  3260. org-agenda-category-filter nil
  3261. org-agenda-regexp-filter nil))
  3262. (put 'org-agenda-tag-filter :preset-filter
  3263. org-agenda-tag-filter-preset)
  3264. (put 'org-agenda-category-filter :preset-filter
  3265. org-agenda-category-filter-preset)
  3266. (put 'org-agenda-regexp-filter :preset-filter
  3267. org-agenda-regexp-filter-preset)
  3268. (if org-agenda-multi
  3269. (progn
  3270. (setq buffer-read-only nil)
  3271. (goto-char (point-max))
  3272. (unless (or (bobp) org-agenda-compact-blocks
  3273. (not org-agenda-block-separator))
  3274. (insert "\n"
  3275. (if (stringp org-agenda-block-separator)
  3276. org-agenda-block-separator
  3277. (make-string (window-width) org-agenda-block-separator))
  3278. "\n"))
  3279. (narrow-to-region (point) (point-max)))
  3280. (setq org-done-keywords-for-agenda nil)
  3281. ;; Setting any org variables that are in org-agenda-local-vars
  3282. ;; list need to be done after the prepare call
  3283. (org-agenda-prepare-window (get-buffer-create org-agenda-buffer-name))
  3284. (setq buffer-read-only nil)
  3285. (org-agenda-reset-markers)
  3286. (let ((inhibit-read-only t)) (erase-buffer))
  3287. (org-agenda-mode)
  3288. (setq org-agenda-buffer (current-buffer))
  3289. (setq org-agenda-contributing-files nil)
  3290. (setq org-agenda-columns-active nil)
  3291. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  3292. (setq org-todo-keywords-for-agenda
  3293. (org-uniquify org-todo-keywords-for-agenda))
  3294. (setq org-done-keywords-for-agenda
  3295. (org-uniquify org-done-keywords-for-agenda))
  3296. (setq org-drawers-for-agenda (org-uniquify org-drawers-for-agenda))
  3297. (setq org-agenda-last-prefix-arg current-prefix-arg)
  3298. (setq org-agenda-this-buffer-name org-agenda-buffer-name)
  3299. (and name (not org-agenda-name)
  3300. (org-set-local 'org-agenda-name name)))
  3301. (setq buffer-read-only nil)))
  3302. (defvar org-agenda-overriding-columns-format) ; From org-colview.el
  3303. (defun org-agenda-finalize ()
  3304. "Finishing touch for the agenda buffer, called just before displaying it."
  3305. (unless org-agenda-multi
  3306. (save-excursion
  3307. (let ((inhibit-read-only t))
  3308. (goto-char (point-min))
  3309. (save-excursion
  3310. (while (org-activate-bracket-links (point-max))
  3311. (add-text-properties (match-beginning 0) (match-end 0)
  3312. '(face org-link))))
  3313. (save-excursion
  3314. (while (org-activate-plain-links (point-max))
  3315. (add-text-properties (match-beginning 0) (match-end 0)
  3316. '(face org-link))))
  3317. (unless (eq org-agenda-remove-tags t)
  3318. (org-agenda-align-tags))
  3319. (unless org-agenda-with-colors
  3320. (remove-text-properties (point-min) (point-max) '(face nil)))
  3321. (if (and (boundp 'org-agenda-overriding-columns-format)
  3322. org-agenda-overriding-columns-format)
  3323. (org-set-local 'org-agenda-overriding-columns-format
  3324. org-agenda-overriding-columns-format))
  3325. (if (and (boundp 'org-agenda-view-columns-initially)
  3326. org-agenda-view-columns-initially)
  3327. (org-agenda-columns))
  3328. (when org-agenda-fontify-priorities
  3329. (org-agenda-fontify-priorities))
  3330. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  3331. (org-agenda-dim-blocked-tasks))
  3332. ;; We need to widen when `org-agenda-finalize' is called from
  3333. ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in')
  3334. (when org-clock-current-task
  3335. (save-restriction
  3336. (widen)
  3337. (org-agenda-mark-clocking-task)))
  3338. (when org-agenda-entry-text-mode
  3339. (org-agenda-entry-text-hide)
  3340. (org-agenda-entry-text-show))
  3341. (if (and (functionp 'org-habit-insert-consistency-graphs)
  3342. (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
  3343. (org-habit-insert-consistency-graphs))
  3344. (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
  3345. (unless (or (eq org-agenda-show-inherited-tags 'always)
  3346. (and (listp org-agenda-show-inherited-tags)
  3347. (memq org-agenda-type org-agenda-show-inherited-tags))
  3348. (and (eq org-agenda-show-inherited-tags t)
  3349. (or (eq org-agenda-use-tag-inheritance t)
  3350. (and (listp org-agenda-use-tag-inheritance)
  3351. (not (memq org-agenda-type
  3352. org-agenda-use-tag-inheritance))))))
  3353. (let (mrk)
  3354. (save-excursion
  3355. (goto-char (point-min))
  3356. (while (equal (forward-line) 0)
  3357. (when (setq mrk (or (get-text-property (point) 'org-hd-marker)
  3358. (get-text-property (point) 'org-hd-marker)))
  3359. (put-text-property (point-at-bol) (point-at-eol)
  3360. 'tags (org-with-point-at mrk
  3361. (delete-dups
  3362. (mapcar 'downcase (org-get-tags-at))))))))))
  3363. (run-hooks 'org-agenda-finalize-hook)
  3364. (when (or org-agenda-tag-filter (get 'org-agenda-tag-filter :preset-filter))
  3365. (org-agenda-filter-apply org-agenda-tag-filter 'tag))
  3366. (when (or org-agenda-category-filter (get 'org-agenda-category-filter :preset-filter))
  3367. (org-agenda-filter-apply org-agenda-category-filter 'category))
  3368. (when (or org-agenda-regexp-filter (get 'org-agenda-regexp-filter :preset-filter))
  3369. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
  3370. (org-add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)))))
  3371. (defun org-agenda-mark-clocking-task ()
  3372. "Mark the current clock entry in the agenda if it is present."
  3373. (org-agenda-unmark-clocking-task)
  3374. (when (marker-buffer org-clock-hd-marker)
  3375. (save-excursion
  3376. (goto-char (point-min))
  3377. (let (s ov)
  3378. (while (setq s (next-single-property-change (point) 'org-hd-marker))
  3379. (goto-char s)
  3380. (when (equal (org-get-at-bol 'org-hd-marker)
  3381. org-clock-hd-marker)
  3382. (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
  3383. (overlay-put ov 'type 'org-agenda-clocking)
  3384. (overlay-put ov 'face 'org-agenda-clocking)
  3385. (overlay-put ov 'help-echo
  3386. "The clock is running in this item")))))))
  3387. (defun org-agenda-unmark-clocking-task ()
  3388. "Unmark the current clocking task."
  3389. (mapc (lambda (o)
  3390. (if (eq (overlay-get o 'type) 'org-agenda-clocking)
  3391. (delete-overlay o)))
  3392. (overlays-in (point-min) (point-max))))
  3393. (defun org-agenda-fontify-priorities ()
  3394. "Make highest priority lines bold, and lowest italic."
  3395. (interactive)
  3396. (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
  3397. (delete-overlay o)))
  3398. (overlays-in (point-min) (point-max)))
  3399. (save-excursion
  3400. (let (b e p ov h l)
  3401. (goto-char (point-min))
  3402. (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
  3403. (setq h (or (get-char-property (point) 'org-highest-priority)
  3404. org-highest-priority)
  3405. l (or (get-char-property (point) 'org-lowest-priority)
  3406. org-lowest-priority)
  3407. p (string-to-char (match-string 1))
  3408. b (match-beginning 0)
  3409. e (if (eq org-agenda-fontify-priorities 'cookies)
  3410. (match-end 0)
  3411. (point-at-eol))
  3412. ov (make-overlay b e))
  3413. (overlay-put
  3414. ov 'face
  3415. (cons (cond ((org-face-from-face-or-color
  3416. 'priority nil
  3417. (cdr (assoc p org-priority-faces))))
  3418. ((and (listp org-agenda-fontify-priorities)
  3419. (org-face-from-face-or-color
  3420. 'priority nil
  3421. (cdr (assoc p org-agenda-fontify-priorities)))))
  3422. ((equal p l) 'italic)
  3423. ((equal p h) 'bold))
  3424. 'org-priority))
  3425. (overlay-put ov 'org-type 'org-priority)))))
  3426. (defun org-agenda-dim-blocked-tasks (&optional invisible)
  3427. (interactive "P")
  3428. "Dim currently blocked TODO's in the agenda display."
  3429. (message "Dim or hide blocked tasks...")
  3430. (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-blocked-todo)
  3431. (delete-overlay o)))
  3432. (overlays-in (point-min) (point-max)))
  3433. (save-excursion
  3434. (let ((inhibit-read-only t)
  3435. (org-depend-tag-blocked nil)
  3436. (invis (or (not (null invisible))
  3437. (eq org-agenda-dim-blocked-tasks 'invisible)))
  3438. org-blocked-by-checkboxes
  3439. invis1 b e p ov h l)
  3440. (goto-char (point-min))
  3441. (while (let ((pos (next-single-property-change (point) 'todo-state)))
  3442. (and pos (goto-char (1+ pos))))
  3443. (setq org-blocked-by-checkboxes nil invis1 invis)
  3444. (let ((marker (org-get-at-bol 'org-hd-marker)))
  3445. (when (and marker
  3446. (with-current-buffer (marker-buffer marker)
  3447. (save-excursion (goto-char marker)
  3448. (org-entry-blocked-p))))
  3449. (if org-blocked-by-checkboxes (setq invis1 nil))
  3450. (setq b (if invis1
  3451. (max (point-min) (1- (point-at-bol)))
  3452. (point-at-bol))
  3453. e (point-at-eol)
  3454. ov (make-overlay b e))
  3455. (if invis1
  3456. (overlay-put ov 'invisible t)
  3457. (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
  3458. (overlay-put ov 'org-type 'org-blocked-todo))))))
  3459. (message "Dim or hide blocked tasks...done"))
  3460. (defvar org-agenda-skip-function nil
  3461. "Function to be called at each match during agenda construction.
  3462. If this function returns nil, the current match should not be skipped.
  3463. Otherwise, the function must return a position from where the search
  3464. should be continued.
  3465. This may also be a Lisp form, it will be evaluated.
  3466. Never set this variable using `setq' or so, because then it will apply
  3467. to all future agenda commands. If you do want a global skipping condition,
  3468. use the option `org-agenda-skip-function-global' instead.
  3469. The correct usage for `org-agenda-skip-function' is to bind it with
  3470. `let' to scope it dynamically into the agenda-constructing command.
  3471. A good way to set it is through options in `org-agenda-custom-commands'.")
  3472. (defun org-agenda-skip ()
  3473. "Throw to `:skip' in places that should be skipped.
  3474. Also moves point to the end of the skipped region, so that search can
  3475. continue from there."
  3476. (let ((p (point-at-bol)) to)
  3477. (when (or
  3478. (save-excursion (goto-char p) (looking-at comment-start-skip))
  3479. (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
  3480. (get-text-property p :org-archived)
  3481. (org-end-of-subtree t))
  3482. (and org-agenda-skip-comment-trees
  3483. (get-text-property p :org-comment)
  3484. (org-end-of-subtree t))
  3485. (and (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
  3486. (org-agenda-skip-eval org-agenda-skip-function)))
  3487. (goto-char to))
  3488. (org-in-src-block-p t))
  3489. (throw :skip t))))
  3490. (defun org-agenda-skip-eval (form)
  3491. "If FORM is a function or a list, call (or eval) is and return result.
  3492. `save-excursion' and `save-match-data' are wrapped around the call, so point
  3493. and match data are returned to the previous state no matter what these
  3494. functions do."
  3495. (let (fp)
  3496. (and form
  3497. (or (setq fp (functionp form))
  3498. (consp form))
  3499. (save-excursion
  3500. (save-match-data
  3501. (if fp
  3502. (funcall form)
  3503. (eval form)))))))
  3504. (defvar org-agenda-markers nil
  3505. "List of all currently active markers created by `org-agenda'.")
  3506. (defvar org-agenda-last-marker-time (org-float-time)
  3507. "Creation time of the last agenda marker.")
  3508. (defun org-agenda-new-marker (&optional pos)
  3509. "Return a new agenda marker.
  3510. Org-mode keeps a list of these markers and resets them when they are
  3511. no longer in use."
  3512. (let ((m (copy-marker (or pos (point)))))
  3513. (setq org-agenda-last-marker-time (org-float-time))
  3514. (if org-agenda-buffer
  3515. (with-current-buffer org-agenda-buffer
  3516. (push m org-agenda-markers))
  3517. (push m org-agenda-markers))
  3518. m))
  3519. (defun org-agenda-reset-markers ()
  3520. "Reset markers created by `org-agenda'."
  3521. (while org-agenda-markers
  3522. (move-marker (pop org-agenda-markers) nil)))
  3523. (defun org-agenda-save-markers-for-cut-and-paste (beg end)
  3524. "Save relative positions of markers in region.
  3525. This check for agenda markers in all agenda buffers currently active."
  3526. (dolist (buf (buffer-list))
  3527. (with-current-buffer buf
  3528. (when (eq major-mode 'org-agenda-mode)
  3529. (mapc (lambda (m) (org-check-and-save-marker m beg end))
  3530. org-agenda-markers)))))
  3531. ;;; Entry text mode
  3532. (defun org-agenda-entry-text-show-here ()
  3533. "Add some text from the entry as context to the current line."
  3534. (let (m txt o)
  3535. (setq m (org-get-at-bol 'org-hd-marker))
  3536. (unless (marker-buffer m)
  3537. (error "No marker points to an entry here"))
  3538. (setq txt (concat "\n" (org-no-properties
  3539. (org-agenda-get-some-entry-text
  3540. m org-agenda-entry-text-maxlines
  3541. org-agenda-entry-text-leaders))))
  3542. (when (string-match "\\S-" txt)
  3543. (setq o (make-overlay (point-at-bol) (point-at-eol)))
  3544. (overlay-put o 'evaporate t)
  3545. (overlay-put o 'org-overlay-type 'agenda-entry-content)
  3546. (overlay-put o 'after-string txt))))
  3547. (defun org-agenda-entry-text-show ()
  3548. "Add entry context for all agenda lines."
  3549. (interactive)
  3550. (save-excursion
  3551. (goto-char (point-max))
  3552. (beginning-of-line 1)
  3553. (while (not (bobp))
  3554. (when (org-get-at-bol 'org-hd-marker)
  3555. (org-agenda-entry-text-show-here))
  3556. (beginning-of-line 0))))
  3557. (defun org-agenda-entry-text-hide ()
  3558. "Remove any shown entry context."
  3559. (delq nil
  3560. (mapcar (lambda (o)
  3561. (if (eq (overlay-get o 'org-overlay-type)
  3562. 'agenda-entry-content)
  3563. (progn (delete-overlay o) t)))
  3564. (overlays-in (point-min) (point-max)))))
  3565. (defun org-agenda-get-day-face (date)
  3566. "Return the face DATE should be displayed with."
  3567. (or (and (functionp org-agenda-day-face-function)
  3568. (funcall org-agenda-day-face-function date))
  3569. (cond ((org-agenda-todayp date)
  3570. 'org-agenda-date-today)
  3571. ((member (calendar-day-of-week date) org-agenda-weekend-days)
  3572. 'org-agenda-date-weekend)
  3573. (t 'org-agenda-date))))
  3574. ;;; Agenda timeline
  3575. (defvar org-agenda-only-exact-dates nil) ; dynamically scoped
  3576. (defun org-timeline (&optional dotodo)
  3577. "Show a time-sorted view of the entries in the current org file.
  3578. Only entries with a time stamp of today or later will be listed. With
  3579. \\[universal-argument] prefix, all unfinished TODO items will also be shown,
  3580. under the current date.
  3581. If the buffer contains an active region, only check the region for
  3582. dates."
  3583. (interactive "P")
  3584. (let* ((dopast t)
  3585. (org-agenda-show-log-scoped org-agenda-show-log)
  3586. (entry (buffer-file-name (or (buffer-base-buffer (current-buffer))
  3587. (current-buffer))))
  3588. (date (calendar-current-date))
  3589. (beg (if (org-region-active-p) (region-beginning) (point-min)))
  3590. (end (if (org-region-active-p) (region-end) (point-max)))
  3591. (day-numbers (org-get-all-dates
  3592. beg end 'no-ranges
  3593. t org-agenda-show-log-scoped ; always include today
  3594. org-timeline-show-empty-dates))
  3595. (org-deadline-warning-days 0)
  3596. (org-agenda-only-exact-dates t)
  3597. (today (org-today))
  3598. (past t)
  3599. args
  3600. s e rtn d emptyp)
  3601. (setq org-agenda-redo-command
  3602. (list 'progn
  3603. (list 'org-switch-to-buffer-other-window (current-buffer))
  3604. (list 'org-timeline (list 'quote dotodo))))
  3605. (if (not dopast)
  3606. ;; Remove past dates from the list of dates.
  3607. (setq day-numbers (delq nil (mapcar (lambda(x)
  3608. (if (>= x today) x nil))
  3609. day-numbers))))
  3610. (org-agenda-prepare (concat "Timeline " (file-name-nondirectory entry)))
  3611. (org-compile-prefix-format 'timeline)
  3612. (org-set-sorting-strategy 'timeline)
  3613. (if org-agenda-show-log-scoped (push :closed args))
  3614. (push :timestamp args)
  3615. (push :deadline args)
  3616. (push :scheduled args)
  3617. (push :sexp args)
  3618. (if dotodo (push :todo args))
  3619. (insert "Timeline of file " entry "\n")
  3620. (add-text-properties (point-min) (point)
  3621. (list 'face 'org-agenda-structure))
  3622. (org-agenda-mark-header-line (point-min))
  3623. (while (setq d (pop day-numbers))
  3624. (if (and (listp d) (eq (car d) :omitted))
  3625. (progn
  3626. (setq s (point))
  3627. (insert (format "\n[... %d empty days omitted]\n\n" (cdr d)))
  3628. (put-text-property s (1- (point)) 'face 'org-agenda-structure))
  3629. (if (listp d) (setq d (car d) emptyp t) (setq emptyp nil))
  3630. (if (and (>= d today)
  3631. dopast
  3632. past)
  3633. (progn
  3634. (setq past nil)
  3635. (insert (make-string 79 ?-) "\n")))
  3636. (setq date (calendar-gregorian-from-absolute d))
  3637. (setq s (point))
  3638. (setq rtn (and (not emptyp)
  3639. (apply 'org-agenda-get-day-entries entry
  3640. date args)))
  3641. (if (or rtn (equal d today) org-timeline-show-empty-dates)
  3642. (progn
  3643. (insert
  3644. (if (stringp org-agenda-format-date)
  3645. (format-time-string org-agenda-format-date
  3646. (org-time-from-absolute date))
  3647. (funcall org-agenda-format-date date))
  3648. "\n")
  3649. (put-text-property s (1- (point)) 'face
  3650. (org-agenda-get-day-face date))
  3651. (put-text-property s (1- (point)) 'org-date-line t)
  3652. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3653. (if (equal d today)
  3654. (put-text-property s (1- (point)) 'org-today t))
  3655. (and rtn (insert (org-agenda-finalize-entries rtn 'timeline) "\n"))
  3656. (put-text-property s (1- (point)) 'day d)))))
  3657. (goto-char (point-min))
  3658. (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
  3659. (point-min)))
  3660. (add-text-properties (point-min) (point-max) '(org-agenda-type timeline))
  3661. (org-agenda-finalize)
  3662. (setq buffer-read-only t)))
  3663. (defun org-get-all-dates (beg end &optional no-ranges force-today inactive empty pre-re)
  3664. "Return a list of all relevant day numbers from BEG to END buffer positions.
  3665. If NO-RANGES is non-nil, include only the start and end dates of a range,
  3666. not every single day in the range. If FORCE-TODAY is non-nil, make
  3667. sure that TODAY is included in the list. If INACTIVE is non-nil, also
  3668. inactive time stamps (those in square brackets) are included.
  3669. When EMPTY is non-nil, also include days without any entries."
  3670. (let ((re (concat
  3671. (if pre-re pre-re "")
  3672. (if inactive org-ts-regexp-both org-ts-regexp)))
  3673. dates dates1 date day day1 day2 ts1 ts2 pos)
  3674. (if force-today
  3675. (setq dates (list (org-today))))
  3676. (save-excursion
  3677. (goto-char beg)
  3678. (while (re-search-forward re end t)
  3679. (setq day (time-to-days (org-time-string-to-time
  3680. (substring (match-string 1) 0 10)
  3681. (current-buffer) (match-beginning 0))))
  3682. (or (memq day dates) (push day dates)))
  3683. (unless no-ranges
  3684. (goto-char beg)
  3685. (while (re-search-forward org-tr-regexp end t)
  3686. (setq pos (match-beginning 0))
  3687. (setq ts1 (substring (match-string 1) 0 10)
  3688. ts2 (substring (match-string 2) 0 10)
  3689. day1 (time-to-days (org-time-string-to-time
  3690. ts1 (current-buffer) pos))
  3691. day2 (time-to-days (org-time-string-to-time
  3692. ts2 (current-buffer) pos)))
  3693. (while (< (setq day1 (1+ day1)) day2)
  3694. (or (memq day1 dates) (push day1 dates)))))
  3695. (setq dates (sort dates '<))
  3696. (when empty
  3697. (while (setq day (pop dates))
  3698. (setq day2 (car dates))
  3699. (push day dates1)
  3700. (when (and day2 empty)
  3701. (if (or (eq empty t)
  3702. (and (numberp empty) (<= (- day2 day) empty)))
  3703. (while (< (setq day (1+ day)) day2)
  3704. (push (list day) dates1))
  3705. (push (cons :omitted (- day2 day)) dates1))))
  3706. (setq dates (nreverse dates1)))
  3707. dates)))
  3708. ;;; Agenda Daily/Weekly
  3709. (defvar org-agenda-start-day nil ; dynamically scoped parameter
  3710. "Start day for the agenda view.
  3711. Custom commands can set this variable in the options section.
  3712. See the docstring of `org-read-date' on allowed values.")
  3713. (defvar org-starting-day nil) ; local variable in the agenda buffer
  3714. (defvar org-arg-loc nil) ; local variable
  3715. (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
  3716. "List of types searched for when creating the daily/weekly agenda.
  3717. This variable is a list of symbols that controls the types of
  3718. items that appear in the daily/weekly agenda. Allowed symbols in this
  3719. list are are
  3720. :timestamp List items containing a date stamp or date range matching
  3721. the selected date. This includes sexp entries in angular
  3722. brackets.
  3723. :sexp List entries resulting from plain diary-like sexps.
  3724. :deadline List deadline due on that date. When the date is today,
  3725. also list any deadlines past due, or due within
  3726. `org-deadline-warning-days'. `:deadline' must appear before
  3727. `:scheduled' if the setting of
  3728. `org-agenda-skip-scheduled-if-deadline-is-shown' is to have
  3729. any effect.
  3730. :deadline* Same as above, but only include the deadline if it has an
  3731. hour specification as [h]h:mm.
  3732. :scheduled List all items which are scheduled for the given date.
  3733. The diary for *today* also contains items which were
  3734. scheduled earlier and are not yet marked DONE.
  3735. :scheduled* Same as above, but only include the scheduled item if it
  3736. has an hour specification as [h]h:mm.
  3737. By default, all four non-starred types are turned on.
  3738. When :scheduled* or :deadline* are included, :schedule or :deadline
  3739. will be ignored.
  3740. Never set this variable globally using `setq', because then it
  3741. will apply to all future agenda commands. Instead, bind it with
  3742. `let' to scope it dynamically into the agenda-constructing
  3743. command. A good way to set it is through options in
  3744. `org-agenda-custom-commands'. For a more flexible (though
  3745. somewhat less efficient) way of determining what is included in
  3746. the daily/weekly agenda, see `org-agenda-skip-function'.")
  3747. (defvar org-agenda-buffer-tmp-name nil)
  3748. ;;;###autoload
  3749. (defun org-agenda-list (&optional arg start-day span with-hour)
  3750. "Produce a daily/weekly view from all files in variable `org-agenda-files'.
  3751. The view will be for the current day or week, but from the overview buffer
  3752. you will be able to go to other days/weeks.
  3753. With a numeric prefix argument in an interactive call, the agenda will
  3754. span ARG days. Lisp programs should instead specify SPAN to change
  3755. the number of days. SPAN defaults to `org-agenda-span'.
  3756. START-DAY defaults to TODAY, or to the most recent match for the weekday
  3757. given in `org-agenda-start-on-weekday'.
  3758. When WITH-HOUR is non-nil, only include scheduled and deadline
  3759. items if they have an hour specification like [h]h:mm."
  3760. (interactive "P")
  3761. (if org-agenda-overriding-arguments
  3762. (setq arg (car org-agenda-overriding-arguments)
  3763. start-day (nth 1 org-agenda-overriding-arguments)
  3764. span (nth 2 org-agenda-overriding-arguments)))
  3765. (if (and (integerp arg) (> arg 0))
  3766. (setq span arg arg nil))
  3767. (catch 'exit
  3768. (setq org-agenda-buffer-name
  3769. (or org-agenda-buffer-tmp-name
  3770. (if org-agenda-sticky
  3771. (cond ((and org-keys (stringp org-match))
  3772. (format "*Org Agenda(%s:%s)*" org-keys org-match))
  3773. (org-keys
  3774. (format "*Org Agenda(%s)*" org-keys))
  3775. (t "*Org Agenda(a)*")))
  3776. org-agenda-buffer-name))
  3777. (org-agenda-prepare "Day/Week")
  3778. (setq start-day (or start-day org-agenda-start-day))
  3779. (if (stringp start-day)
  3780. ;; Convert to an absolute day number
  3781. (setq start-day (time-to-days (org-read-date nil t start-day))))
  3782. (org-compile-prefix-format 'agenda)
  3783. (org-set-sorting-strategy 'agenda)
  3784. (let* ((span (org-agenda-ndays-to-span
  3785. (or span org-agenda-ndays org-agenda-span)))
  3786. (today (org-today))
  3787. (sd (or start-day today))
  3788. (ndays (org-agenda-span-to-ndays span sd))
  3789. (org-agenda-start-on-weekday
  3790. (if (eq ndays 7)
  3791. org-agenda-start-on-weekday))
  3792. (thefiles (org-agenda-files nil 'ifmode))
  3793. (files thefiles)
  3794. (start (if (or (null org-agenda-start-on-weekday)
  3795. (< ndays 7))
  3796. sd
  3797. (let* ((nt (calendar-day-of-week
  3798. (calendar-gregorian-from-absolute sd)))
  3799. (n1 org-agenda-start-on-weekday)
  3800. (d (- nt n1)))
  3801. (- sd (+ (if (< d 0) 7 0) d)))))
  3802. (day-numbers (list start))
  3803. (day-cnt 0)
  3804. (inhibit-redisplay (not debug-on-error))
  3805. (org-agenda-show-log-scoped org-agenda-show-log)
  3806. s e rtn rtnall file date d start-pos end-pos todayp
  3807. clocktable-start clocktable-end filter)
  3808. (setq org-agenda-redo-command
  3809. (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span) with-hour))
  3810. (dotimes (n (1- ndays))
  3811. (push (1+ (car day-numbers)) day-numbers))
  3812. (setq day-numbers (nreverse day-numbers))
  3813. (setq clocktable-start (car day-numbers)
  3814. clocktable-end (1+ (or (org-last day-numbers) 0)))
  3815. (org-set-local 'org-starting-day (car day-numbers))
  3816. (org-set-local 'org-arg-loc arg)
  3817. (org-set-local 'org-agenda-current-span (org-agenda-ndays-to-span span))
  3818. (unless org-agenda-compact-blocks
  3819. (let* ((d1 (car day-numbers))
  3820. (d2 (org-last day-numbers))
  3821. (w1 (org-days-to-iso-week d1))
  3822. (w2 (org-days-to-iso-week d2)))
  3823. (setq s (point))
  3824. (if org-agenda-overriding-header
  3825. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  3826. nil 'face 'org-agenda-structure) "\n")
  3827. (insert (org-agenda-span-name span)
  3828. "-agenda"
  3829. (if (< (- d2 d1) 350)
  3830. (if (= w1 w2)
  3831. (format " (W%02d)" w1)
  3832. (format " (W%02d-W%02d)" w1 w2))
  3833. "")
  3834. ":\n")))
  3835. (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
  3836. 'org-date-line t))
  3837. (org-agenda-mark-header-line s))
  3838. (while (setq d (pop day-numbers))
  3839. (setq date (calendar-gregorian-from-absolute d)
  3840. s (point))
  3841. (if (or (setq todayp (= d today))
  3842. (and (not start-pos) (= d sd)))
  3843. (setq start-pos (point))
  3844. (if (and start-pos (not end-pos))
  3845. (setq end-pos (point))))
  3846. (setq files thefiles
  3847. rtnall nil)
  3848. (while (setq file (pop files))
  3849. (catch 'nextfile
  3850. (org-check-agenda-file file)
  3851. (let ((org-agenda-entry-types org-agenda-entry-types))
  3852. ;; Starred types override non-starred equivalents
  3853. (when (member :deadline* org-agenda-entry-types)
  3854. (setq org-agenda-entry-types
  3855. (delq :deadline org-agenda-entry-types)))
  3856. (when (member :scheduled* org-agenda-entry-types)
  3857. (setq org-agenda-entry-types
  3858. (delq :scheduled org-agenda-entry-types)))
  3859. ;; Honor with-hour
  3860. (when with-hour
  3861. (when (member :deadline org-agenda-entry-types)
  3862. (setq org-agenda-entry-types
  3863. (delq :deadline org-agenda-entry-types))
  3864. (push :deadline* org-agenda-entry-types))
  3865. (when (member :scheduled org-agenda-entry-types)
  3866. (setq org-agenda-entry-types
  3867. (delq :scheduled org-agenda-entry-types))
  3868. (push :scheduled* org-agenda-entry-types)))
  3869. (unless org-agenda-include-deadlines
  3870. (setq org-agenda-entry-types
  3871. (delq :deadline* (delq :deadline org-agenda-entry-types))))
  3872. (cond
  3873. ((memq org-agenda-show-log-scoped '(only clockcheck))
  3874. (setq rtn (org-agenda-get-day-entries
  3875. file date :closed)))
  3876. (org-agenda-show-log-scoped
  3877. (setq rtn (apply 'org-agenda-get-day-entries
  3878. file date
  3879. (append '(:closed) org-agenda-entry-types))))
  3880. (t
  3881. (setq rtn (apply 'org-agenda-get-day-entries
  3882. file date
  3883. org-agenda-entry-types)))))
  3884. (setq rtnall (append rtnall rtn)))) ;; all entries
  3885. (if org-agenda-include-diary
  3886. (let ((org-agenda-search-headline-for-time t))
  3887. (require 'diary-lib)
  3888. (setq rtn (org-get-entries-from-diary date))
  3889. (setq rtnall (append rtnall rtn))))
  3890. (if (or rtnall org-agenda-show-all-dates)
  3891. (progn
  3892. (setq day-cnt (1+ day-cnt))
  3893. (insert
  3894. (if (stringp org-agenda-format-date)
  3895. (format-time-string org-agenda-format-date
  3896. (org-time-from-absolute date))
  3897. (funcall org-agenda-format-date date))
  3898. "\n")
  3899. (put-text-property s (1- (point)) 'face
  3900. (org-agenda-get-day-face date))
  3901. (put-text-property s (1- (point)) 'org-date-line t)
  3902. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3903. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
  3904. (when todayp
  3905. (put-text-property s (1- (point)) 'org-today t))
  3906. (setq rtnall
  3907. (org-agenda-add-time-grid-maybe rtnall ndays todayp))
  3908. (if rtnall (insert ;; all entries
  3909. (org-agenda-finalize-entries rtnall 'agenda)
  3910. "\n"))
  3911. (put-text-property s (1- (point)) 'day d)
  3912. (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
  3913. (when (and org-agenda-clockreport-mode clocktable-start)
  3914. (let ((org-agenda-files (org-agenda-files nil 'ifmode))
  3915. ;; the above line is to ensure the restricted range!
  3916. (p (copy-sequence org-agenda-clockreport-parameter-plist))
  3917. tbl)
  3918. (setq p (org-plist-delete p :block))
  3919. (setq p (plist-put p :tstart clocktable-start))
  3920. (setq p (plist-put p :tend clocktable-end))
  3921. (setq p (plist-put p :scope 'agenda))
  3922. (when (and (eq org-agenda-clockreport-mode 'with-filter)
  3923. (setq filter (or org-agenda-tag-filter-while-redo
  3924. (get 'org-agenda-tag-filter :preset-filter))))
  3925. (setq p (plist-put p :tags (mapconcat (lambda (x)
  3926. (if (string-match "[<>=]" x)
  3927. ""
  3928. x))
  3929. filter ""))))
  3930. (setq tbl (apply 'org-clock-get-clocktable p))
  3931. (insert tbl)))
  3932. (goto-char (point-min))
  3933. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3934. (unless (and (pos-visible-in-window-p (point-min))
  3935. (pos-visible-in-window-p (point-max)))
  3936. (goto-char (1- (point-max)))
  3937. (recenter -1)
  3938. (if (not (pos-visible-in-window-p (or start-pos 1)))
  3939. (progn
  3940. (goto-char (or start-pos 1))
  3941. (recenter 1))))
  3942. (goto-char (or start-pos 1))
  3943. (add-text-properties (point-min) (point-max)
  3944. `(org-agenda-type agenda
  3945. org-last-args (,arg ,start-day ,span)
  3946. org-redo-cmd ,org-agenda-redo-command
  3947. org-series-cmd ,org-cmd))
  3948. (if (eq org-agenda-show-log-scoped 'clockcheck)
  3949. (org-agenda-show-clocking-issues))
  3950. (org-agenda-finalize)
  3951. (setq buffer-read-only t)
  3952. (message ""))))
  3953. (defun org-agenda-ndays-to-span (n)
  3954. "Return a span symbol for a span of N days, or N if none matches."
  3955. (cond ((symbolp n) n)
  3956. ((= n 1) 'day)
  3957. ((= n 7) 'week)
  3958. (t n)))
  3959. (defun org-agenda-span-to-ndays (span &optional start-day)
  3960. "Return ndays from SPAN, possibly starting at START-DAY."
  3961. (cond ((numberp span) span)
  3962. ((eq span 'day) 1)
  3963. ((eq span 'week) 7)
  3964. ((eq span 'month)
  3965. (let ((date (calendar-gregorian-from-absolute start-day)))
  3966. (calendar-last-day-of-month (car date) (caddr date))))
  3967. ((eq span 'year)
  3968. (let ((date (calendar-gregorian-from-absolute start-day)))
  3969. (if (calendar-leap-year-p (caddr date)) 366 365)))))
  3970. (defun org-agenda-span-name (span)
  3971. "Return a SPAN name."
  3972. (if (null span)
  3973. ""
  3974. (if (symbolp span)
  3975. (capitalize (symbol-name span))
  3976. (format "%d days" span))))
  3977. ;;; Agenda word search
  3978. (defvar org-agenda-search-history nil)
  3979. (defvar org-search-syntax-table nil
  3980. "Special syntax table for org-mode search.
  3981. In this table, we have single quotes not as word constituents, to
  3982. that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
  3983. (defvar org-mode-syntax-table) ; From org.el
  3984. (defun org-search-syntax-table ()
  3985. (unless org-search-syntax-table
  3986. (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
  3987. (modify-syntax-entry ?' "." org-search-syntax-table)
  3988. (modify-syntax-entry ?` "." org-search-syntax-table))
  3989. org-search-syntax-table)
  3990. (defvar org-agenda-last-search-view-search-was-boolean nil)
  3991. ;;;###autoload
  3992. (defun org-search-view (&optional todo-only string edit-at)
  3993. "Show all entries that contain a phrase or words or regular expressions.
  3994. With optional prefix argument TODO-ONLY, only consider entries that are
  3995. TODO entries. The argument STRING can be used to pass a default search
  3996. string into this function. If EDIT-AT is non-nil, it means that the
  3997. user should get a chance to edit this string, with cursor at position
  3998. EDIT-AT.
  3999. The search string can be viewed either as a phrase that should be found as
  4000. is, or it can be broken into a number of snippets, each of which must match
  4001. in a Boolean way to select an entry. The default depends on the variable
  4002. `org-agenda-search-view-always-boolean'.
  4003. Even if this is turned off (the default) you can always switch to
  4004. Boolean search dynamically by preceding the first word with \"+\" or \"-\".
  4005. The default is a direct search of the whole phrase, where each space in
  4006. the search string can expand to an arbitrary amount of whitespace,
  4007. including newlines.
  4008. If using a Boolean search, the search string is split on whitespace and
  4009. each snippet is searched separately, with logical AND to select an entry.
  4010. Words prefixed with a minus must *not* occur in the entry. Words without
  4011. a prefix or prefixed with a plus must occur in the entry. Matching is
  4012. case-insensitive. Words are enclosed by word delimiters (i.e. they must
  4013. match whole words, not parts of a word) if
  4014. `org-agenda-search-view-force-full-words' is set (default is nil).
  4015. Boolean search snippets enclosed by curly braces are interpreted as
  4016. regular expressions that must or (when preceded with \"-\") must not
  4017. match in the entry. Snippets enclosed into double quotes will be taken
  4018. as a whole, to include whitespace.
  4019. - If the search string starts with an asterisk, search only in headlines.
  4020. - If (possibly after the leading star) the search string starts with an
  4021. exclamation mark, this also means to look at TODO entries only, an effect
  4022. that can also be achieved with a prefix argument.
  4023. - If (possibly after star and exclamation mark) the search string starts
  4024. with a colon, this will mean that the (non-regexp) snippets of the
  4025. Boolean search must match as full words.
  4026. This command searches the agenda files, and in addition the files listed
  4027. in `org-agenda-text-search-extra-files'."
  4028. (interactive "P")
  4029. (if org-agenda-overriding-arguments
  4030. (setq todo-only (car org-agenda-overriding-arguments)
  4031. string (nth 1 org-agenda-overriding-arguments)
  4032. edit-at (nth 2 org-agenda-overriding-arguments)))
  4033. (let* ((props (list 'face nil
  4034. 'done-face 'org-agenda-done
  4035. 'org-not-done-regexp org-not-done-regexp
  4036. 'org-todo-regexp org-todo-regexp
  4037. 'org-complex-heading-regexp org-complex-heading-regexp
  4038. 'mouse-face 'highlight
  4039. 'help-echo (format "mouse-2 or RET jump to location")))
  4040. (full-words org-agenda-search-view-force-full-words)
  4041. (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
  4042. regexp rtn rtnall files file pos inherited-tags
  4043. marker category category-pos level tags c neg re boolean
  4044. ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
  4045. (unless (and (not edit-at)
  4046. (stringp string)
  4047. (string-match "\\S-" string))
  4048. (setq string (read-string
  4049. (if org-agenda-search-view-always-boolean
  4050. "[+-]Word/{Regexp} ...: "
  4051. "Phrase or [+-]Word/{Regexp} ...: ")
  4052. (cond
  4053. ((integerp edit-at) (cons string edit-at))
  4054. (edit-at string))
  4055. 'org-agenda-search-history)))
  4056. (catch 'exit
  4057. (if org-agenda-sticky
  4058. (setq org-agenda-buffer-name
  4059. (if (stringp string)
  4060. (format "*Org Agenda(%s:%s)*"
  4061. (or org-keys (or (and todo-only "S") "s")) string)
  4062. (format "*Org Agenda(%s)*" (or (and todo-only "S") "s")))))
  4063. (org-agenda-prepare "SEARCH")
  4064. (org-compile-prefix-format 'search)
  4065. (org-set-sorting-strategy 'search)
  4066. (setq org-agenda-redo-command
  4067. (list 'org-search-view (if todo-only t nil)
  4068. (list 'if 'current-prefix-arg nil string)))
  4069. (setq org-agenda-query-string string)
  4070. (if (equal (string-to-char string) ?*)
  4071. (setq hdl-only t
  4072. words (substring string 1))
  4073. (setq words string))
  4074. (when (equal (string-to-char words) ?!)
  4075. (setq todo-only t
  4076. words (substring words 1)))
  4077. (when (equal (string-to-char words) ?:)
  4078. (setq full-words t
  4079. words (substring words 1)))
  4080. (if (or org-agenda-search-view-always-boolean
  4081. (member (string-to-char words) '(?- ?+ ?\{)))
  4082. (setq boolean t))
  4083. (setq words (org-split-string words))
  4084. (let (www w)
  4085. (while (setq w (pop words))
  4086. (while (and (string-match "\\\\\\'" w) words)
  4087. (setq w (concat (substring w 0 -1) " " (pop words))))
  4088. (push w www))
  4089. (setq words (nreverse www) www nil)
  4090. (while (setq w (pop words))
  4091. (when (and (string-match "\\`[-+]?{" w)
  4092. (not (string-match "}\\'" w)))
  4093. (while (and words (not (string-match "}\\'" (car words))))
  4094. (setq w (concat w " " (pop words))))
  4095. (setq w (concat w " " (pop words))))
  4096. (push w www))
  4097. (setq words (nreverse www)))
  4098. (setq org-agenda-last-search-view-search-was-boolean boolean)
  4099. (when boolean
  4100. (let (wds w)
  4101. (while (setq w (pop words))
  4102. (if (or (equal (substring w 0 1) "\"")
  4103. (and (> (length w) 1)
  4104. (member (substring w 0 1) '("+" "-"))
  4105. (equal (substring w 1 2) "\"")))
  4106. (while (and words (not (equal (substring w -1) "\"")))
  4107. (setq w (concat w " " (pop words)))))
  4108. (and (string-match "\\`\\([-+]?\\)\"" w)
  4109. (setq w (replace-match "\\1" nil nil w)))
  4110. (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
  4111. (push w wds))
  4112. (setq words (nreverse wds))))
  4113. (if boolean
  4114. (mapc (lambda (w)
  4115. (setq c (string-to-char w))
  4116. (if (equal c ?-)
  4117. (setq neg t w (substring w 1))
  4118. (if (equal c ?+)
  4119. (setq neg nil w (substring w 1))
  4120. (setq neg nil)))
  4121. (if (string-match "\\`{.*}\\'" w)
  4122. (setq re (substring w 1 -1))
  4123. (if full-words
  4124. (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
  4125. (setq re (regexp-quote (downcase w)))))
  4126. (if neg (push re regexps-) (push re regexps+)))
  4127. words)
  4128. (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
  4129. regexps+))
  4130. (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
  4131. (if (not regexps+)
  4132. (setq regexp org-outline-regexp-bol)
  4133. (setq regexp (pop regexps+))
  4134. (if hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
  4135. regexp))))
  4136. (setq files (org-agenda-files nil 'ifmode))
  4137. (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
  4138. (pop org-agenda-text-search-extra-files)
  4139. (setq files (org-add-archive-files files)))
  4140. (setq files (append files org-agenda-text-search-extra-files)
  4141. rtnall nil)
  4142. (while (setq file (pop files))
  4143. (setq ee nil)
  4144. (catch 'nextfile
  4145. (org-check-agenda-file file)
  4146. (setq buffer (if (file-exists-p file)
  4147. (org-get-agenda-file-buffer file)
  4148. (error "No such file %s" file)))
  4149. (if (not buffer)
  4150. ;; If file does not exist, make sure an error message is sent
  4151. (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
  4152. file))))
  4153. (with-current-buffer buffer
  4154. (with-syntax-table (org-search-syntax-table)
  4155. (unless (derived-mode-p 'org-mode)
  4156. (error "Agenda file %s is not in `org-mode'" file))
  4157. (let ((case-fold-search t))
  4158. (save-excursion
  4159. (save-restriction
  4160. (if org-agenda-restrict
  4161. (narrow-to-region org-agenda-restrict-begin
  4162. org-agenda-restrict-end)
  4163. (widen))
  4164. (goto-char (point-min))
  4165. (unless (or (org-at-heading-p)
  4166. (outline-next-heading))
  4167. (throw 'nextfile t))
  4168. (goto-char (max (point-min) (1- (point))))
  4169. (while (re-search-forward regexp nil t)
  4170. (org-back-to-heading t)
  4171. (while (and org-agenda-search-view-max-outline-level
  4172. (> (org-reduced-level (org-outline-level))
  4173. org-agenda-search-view-max-outline-level)
  4174. (forward-line -1)
  4175. (outline-back-to-heading t)))
  4176. (skip-chars-forward "* ")
  4177. (setq beg (point-at-bol)
  4178. beg1 (point)
  4179. end (progn
  4180. (outline-next-heading)
  4181. (while (and org-agenda-search-view-max-outline-level
  4182. (> (org-reduced-level (org-outline-level))
  4183. org-agenda-search-view-max-outline-level)
  4184. (forward-line 1)
  4185. (outline-next-heading)))
  4186. (point)))
  4187. (catch :skip
  4188. (goto-char beg)
  4189. (org-agenda-skip)
  4190. (setq str (buffer-substring-no-properties
  4191. (point-at-bol)
  4192. (if hdl-only (point-at-eol) end)))
  4193. (mapc (lambda (wr) (when (string-match wr str)
  4194. (goto-char (1- end))
  4195. (throw :skip t)))
  4196. regexps-)
  4197. (mapc (lambda (wr) (unless (string-match wr str)
  4198. (goto-char (1- end))
  4199. (throw :skip t)))
  4200. (if todo-only
  4201. (cons (concat "^\*+[ \t]+" org-not-done-regexp)
  4202. regexps+)
  4203. regexps+))
  4204. (goto-char beg)
  4205. (setq marker (org-agenda-new-marker (point))
  4206. category (org-get-category)
  4207. level (make-string (org-reduced-level (org-outline-level)) ? )
  4208. category-pos (get-text-property (point) 'org-category-position)
  4209. inherited-tags
  4210. (or (eq org-agenda-show-inherited-tags 'always)
  4211. (and (listp org-agenda-show-inherited-tags)
  4212. (memq 'todo org-agenda-show-inherited-tags))
  4213. (and (eq org-agenda-show-inherited-tags t)
  4214. (or (eq org-agenda-use-tag-inheritance t)
  4215. (memq 'todo org-agenda-use-tag-inheritance))))
  4216. tags (org-get-tags-at nil (not inherited-tags))
  4217. txt (org-agenda-format-item
  4218. ""
  4219. (buffer-substring-no-properties
  4220. beg1 (point-at-eol))
  4221. level category tags t))
  4222. (org-add-props txt props
  4223. 'org-marker marker 'org-hd-marker marker
  4224. 'org-todo-regexp org-todo-regexp
  4225. 'level level
  4226. 'org-complex-heading-regexp org-complex-heading-regexp
  4227. 'priority 1000 'org-category category
  4228. 'org-category-position category-pos
  4229. 'type "search")
  4230. (push txt ee)
  4231. (goto-char (1- end))))))))))
  4232. (setq rtn (nreverse ee))
  4233. (setq rtnall (append rtnall rtn)))
  4234. (if org-agenda-overriding-header
  4235. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4236. nil 'face 'org-agenda-structure) "\n")
  4237. (insert "Search words: ")
  4238. (add-text-properties (point-min) (1- (point))
  4239. (list 'face 'org-agenda-structure))
  4240. (setq pos (point))
  4241. (insert string "\n")
  4242. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4243. (setq pos (point))
  4244. (unless org-agenda-multi
  4245. (insert "Press `[', `]' to add/sub word, `{', `}' to add/sub regexp, `C-u r' to edit\n")
  4246. (add-text-properties pos (1- (point))
  4247. (list 'face 'org-agenda-structure))))
  4248. (org-agenda-mark-header-line (point-min))
  4249. (when rtnall
  4250. (insert (org-agenda-finalize-entries rtnall 'search) "\n"))
  4251. (goto-char (point-min))
  4252. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4253. (add-text-properties (point-min) (point-max)
  4254. `(org-agenda-type search
  4255. org-last-args (,todo-only ,string ,edit-at)
  4256. org-redo-cmd ,org-agenda-redo-command
  4257. org-series-cmd ,org-cmd))
  4258. (org-agenda-finalize)
  4259. (setq buffer-read-only t))))
  4260. ;;; Agenda TODO list
  4261. (defun org-agenda-propertize-selected-todo-keywords (keywords)
  4262. "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
  4263. (concat
  4264. (if (or (equal keywords "ALL") (not keywords))
  4265. (propertize "ALL" 'face 'warning)
  4266. (mapconcat
  4267. (lambda (kw)
  4268. (propertize kw 'face (org-get-todo-face kw)))
  4269. (org-split-string keywords "|")
  4270. "|"))
  4271. "\n"))
  4272. (defvar org-select-this-todo-keyword nil)
  4273. (defvar org-last-arg nil)
  4274. ;;;###autoload
  4275. (defun org-todo-list (&optional arg)
  4276. "Show all (not done) TODO entries from all agenda file in a single list.
  4277. The prefix arg can be used to select a specific TODO keyword and limit
  4278. the list to these. When using \\[universal-argument], you will be prompted
  4279. for a keyword. A numeric prefix directly selects the Nth keyword in
  4280. `org-todo-keywords-1'."
  4281. (interactive "P")
  4282. (if org-agenda-overriding-arguments
  4283. (setq arg org-agenda-overriding-arguments))
  4284. (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
  4285. (let* ((today (org-today))
  4286. (date (calendar-gregorian-from-absolute today))
  4287. (kwds org-todo-keywords-for-agenda)
  4288. (completion-ignore-case t)
  4289. (org-select-this-todo-keyword
  4290. (if (stringp arg) arg
  4291. (and arg (integerp arg) (> arg 0)
  4292. (nth (1- arg) kwds))))
  4293. rtn rtnall files file pos)
  4294. (when (equal arg '(4))
  4295. (setq org-select-this-todo-keyword
  4296. (org-icompleting-read "Keyword (or KWD1|K2D2|...): "
  4297. (mapcar 'list kwds) nil nil)))
  4298. (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
  4299. (catch 'exit
  4300. (if org-agenda-sticky
  4301. (setq org-agenda-buffer-name
  4302. (if (stringp org-select-this-todo-keyword)
  4303. (format "*Org Agenda(%s:%s)*" (or org-keys "t")
  4304. org-select-this-todo-keyword)
  4305. (format "*Org Agenda(%s)*" (or org-keys "t")))))
  4306. (org-agenda-prepare "TODO")
  4307. (org-compile-prefix-format 'todo)
  4308. (org-set-sorting-strategy 'todo)
  4309. (setq org-agenda-redo-command
  4310. `(org-todo-list (or (and (numberp current-prefix-arg)
  4311. current-prefix-arg)
  4312. ,org-select-this-todo-keyword
  4313. current-prefix-arg ,arg)))
  4314. (setq files (org-agenda-files nil 'ifmode)
  4315. rtnall nil)
  4316. (while (setq file (pop files))
  4317. (catch 'nextfile
  4318. (org-check-agenda-file file)
  4319. (setq rtn (org-agenda-get-day-entries file date :todo))
  4320. (setq rtnall (append rtnall rtn))))
  4321. (if org-agenda-overriding-header
  4322. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4323. nil 'face 'org-agenda-structure) "\n")
  4324. (insert "Global list of TODO items of type: ")
  4325. (add-text-properties (point-min) (1- (point))
  4326. (list 'face 'org-agenda-structure
  4327. 'short-heading
  4328. (concat "ToDo: "
  4329. (or org-select-this-todo-keyword "ALL"))))
  4330. (org-agenda-mark-header-line (point-min))
  4331. (insert (org-agenda-propertize-selected-todo-keywords
  4332. org-select-this-todo-keyword))
  4333. (setq pos (point))
  4334. (unless org-agenda-multi
  4335. (insert "Available with `N r': (0)[ALL]")
  4336. (let ((n 0) s)
  4337. (mapc (lambda (x)
  4338. (setq s (format "(%d)%s" (setq n (1+ n)) x))
  4339. (if (> (+ (current-column) (string-width s) 1) (frame-width))
  4340. (insert "\n "))
  4341. (insert " " s))
  4342. kwds))
  4343. (insert "\n"))
  4344. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
  4345. (org-agenda-mark-header-line (point-min))
  4346. (when rtnall
  4347. (insert (org-agenda-finalize-entries rtnall 'todo) "\n"))
  4348. (goto-char (point-min))
  4349. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4350. (add-text-properties (point-min) (point-max)
  4351. `(org-agenda-type todo
  4352. org-last-args ,arg
  4353. org-redo-cmd ,org-agenda-redo-command
  4354. org-series-cmd ,org-cmd))
  4355. (org-agenda-finalize)
  4356. (setq buffer-read-only t))))
  4357. ;;; Agenda tags match
  4358. ;;;###autoload
  4359. (defun org-tags-view (&optional todo-only match)
  4360. "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
  4361. The prefix arg TODO-ONLY limits the search to TODO entries."
  4362. (interactive "P")
  4363. (if org-agenda-overriding-arguments
  4364. (setq todo-only (car org-agenda-overriding-arguments)
  4365. match (nth 1 org-agenda-overriding-arguments)))
  4366. (let* ((org-tags-match-list-sublevels
  4367. org-tags-match-list-sublevels)
  4368. (completion-ignore-case t)
  4369. rtn rtnall files file pos matcher
  4370. buffer)
  4371. (when (and (stringp match) (not (string-match "\\S-" match)))
  4372. (setq match nil))
  4373. (setq matcher (org-make-tags-matcher match)
  4374. match (car matcher) matcher (cdr matcher))
  4375. (catch 'exit
  4376. (if org-agenda-sticky
  4377. (setq org-agenda-buffer-name
  4378. (if (stringp match)
  4379. (format "*Org Agenda(%s:%s)*"
  4380. (or org-keys (or (and todo-only "M") "m")) match)
  4381. (format "*Org Agenda(%s)*" (or (and todo-only "M") "m")))))
  4382. (org-agenda-prepare (concat "TAGS " match))
  4383. (org-compile-prefix-format 'tags)
  4384. (org-set-sorting-strategy 'tags)
  4385. (setq org-agenda-query-string match)
  4386. (setq org-agenda-redo-command
  4387. (list 'org-tags-view `(quote ,todo-only)
  4388. (list 'if 'current-prefix-arg nil `(quote ,org-agenda-query-string))))
  4389. (setq files (org-agenda-files nil 'ifmode)
  4390. rtnall nil)
  4391. (while (setq file (pop files))
  4392. (catch 'nextfile
  4393. (org-check-agenda-file file)
  4394. (setq buffer (if (file-exists-p file)
  4395. (org-get-agenda-file-buffer file)
  4396. (error "No such file %s" file)))
  4397. (if (not buffer)
  4398. ;; If file does not exist, error message to agenda
  4399. (setq rtn (list
  4400. (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4401. rtnall (append rtnall rtn))
  4402. (with-current-buffer buffer
  4403. (unless (derived-mode-p 'org-mode)
  4404. (error "Agenda file %s is not in `org-mode'" file))
  4405. (save-excursion
  4406. (save-restriction
  4407. (if org-agenda-restrict
  4408. (narrow-to-region org-agenda-restrict-begin
  4409. org-agenda-restrict-end)
  4410. (widen))
  4411. (setq rtn (org-scan-tags 'agenda matcher todo-only))
  4412. (setq rtnall (append rtnall rtn))))))))
  4413. (if org-agenda-overriding-header
  4414. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4415. nil 'face 'org-agenda-structure) "\n")
  4416. (insert "Headlines with TAGS match: ")
  4417. (add-text-properties (point-min) (1- (point))
  4418. (list 'face 'org-agenda-structure
  4419. 'short-heading
  4420. (concat "Match: " match)))
  4421. (setq pos (point))
  4422. (insert match "\n")
  4423. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4424. (setq pos (point))
  4425. (unless org-agenda-multi
  4426. (insert "Press `C-u r' to search again with new search string\n"))
  4427. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
  4428. (org-agenda-mark-header-line (point-min))
  4429. (when rtnall
  4430. (insert (org-agenda-finalize-entries rtnall 'tags) "\n"))
  4431. (goto-char (point-min))
  4432. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4433. (add-text-properties (point-min) (point-max)
  4434. `(org-agenda-type tags
  4435. org-last-args (,todo-only ,match)
  4436. org-redo-cmd ,org-agenda-redo-command
  4437. org-series-cmd ,org-cmd))
  4438. (org-agenda-finalize)
  4439. (setq buffer-read-only t))))
  4440. ;;; Agenda Finding stuck projects
  4441. (defvar org-agenda-skip-regexp nil
  4442. "Regular expression used in skipping subtrees for the agenda.
  4443. This is basically a temporary global variable that can be set and then
  4444. used by user-defined selections using `org-agenda-skip-function'.")
  4445. (defvar org-agenda-overriding-header nil
  4446. "When set during agenda, todo and tags searches it replaces the header.
  4447. This variable should not be set directly, but custom commands can bind it
  4448. in the options section.")
  4449. (defun org-agenda-skip-entry-when-regexp-matches ()
  4450. "Check if the current entry contains match for `org-agenda-skip-regexp'.
  4451. If yes, it returns the end position of this entry, causing agenda commands
  4452. to skip the entry but continuing the search in the subtree. This is a
  4453. function that can be put into `org-agenda-skip-function' for the duration
  4454. of a command."
  4455. (let ((end (save-excursion (org-end-of-subtree t)))
  4456. skip)
  4457. (save-excursion
  4458. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  4459. (and skip end)))
  4460. (defun org-agenda-skip-subtree-when-regexp-matches ()
  4461. "Check if the current subtree contains match for `org-agenda-skip-regexp'.
  4462. If yes, it returns the end position of this tree, causing agenda commands
  4463. to skip this subtree. This is a function that can be put into
  4464. `org-agenda-skip-function' for the duration of a command."
  4465. (let ((end (save-excursion (org-end-of-subtree t)))
  4466. skip)
  4467. (save-excursion
  4468. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  4469. (and skip end)))
  4470. (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
  4471. "Check if the current subtree contains match for `org-agenda-skip-regexp'.
  4472. If yes, it returns the end position of the current entry (NOT the tree),
  4473. causing agenda commands to skip the entry but continuing the search in
  4474. the subtree. This is a function that can be put into
  4475. `org-agenda-skip-function' for the duration of a command. An important
  4476. use of this function is for the stuck project list."
  4477. (let ((end (save-excursion (org-end-of-subtree t)))
  4478. (entry-end (save-excursion (outline-next-heading) (1- (point))))
  4479. skip)
  4480. (save-excursion
  4481. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  4482. (and skip entry-end)))
  4483. (defun org-agenda-skip-entry-if (&rest conditions)
  4484. "Skip entry if any of CONDITIONS is true.
  4485. See `org-agenda-skip-if' for details."
  4486. (org-agenda-skip-if nil conditions))
  4487. (defun org-agenda-skip-subtree-if (&rest conditions)
  4488. "Skip entry if any of CONDITIONS is true.
  4489. See `org-agenda-skip-if' for details."
  4490. (org-agenda-skip-if t conditions))
  4491. (defun org-agenda-skip-if (subtree conditions)
  4492. "Checks current entity for CONDITIONS.
  4493. If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
  4494. the entry (i.e. the text before the next heading) is checked.
  4495. CONDITIONS is a list of symbols, boolean OR is used to combine the results
  4496. from different tests. Valid conditions are:
  4497. scheduled Check if there is a scheduled cookie
  4498. notscheduled Check if there is no scheduled cookie
  4499. deadline Check if there is a deadline
  4500. notdeadline Check if there is no deadline
  4501. timestamp Check if there is a timestamp (also deadline or scheduled)
  4502. nottimestamp Check if there is no timestamp (also deadline or scheduled)
  4503. regexp Check if regexp matches
  4504. notregexp Check if regexp does not match.
  4505. todo Check if TODO keyword matches
  4506. nottodo Check if TODO keyword does not match
  4507. The regexp is taken from the conditions list, it must come right after
  4508. the `regexp' or `notregexp' element.
  4509. `todo' and `nottodo' accept as an argument a list of todo
  4510. keywords, which may include \"*\" to match any todo keyword.
  4511. (org-agenda-skip-entry-if 'todo '(\"TODO\" \"WAITING\"))
  4512. would skip all entries with \"TODO\" or \"WAITING\" keywords.
  4513. Instead of a list, a keyword class may be given. For example:
  4514. (org-agenda-skip-entry-if 'nottodo 'done)
  4515. would skip entries that haven't been marked with any of \"DONE\"
  4516. keywords. Possible classes are: `todo', `done', `any'.
  4517. If any of these conditions is met, this function returns the end point of
  4518. the entity, causing the search to continue from there. This is a function
  4519. that can be put into `org-agenda-skip-function' for the duration of a command."
  4520. (let (beg end m)
  4521. (org-back-to-heading t)
  4522. (setq beg (point)
  4523. end (if subtree
  4524. (progn (org-end-of-subtree t) (point))
  4525. (progn (outline-next-heading) (1- (point)))))
  4526. (goto-char beg)
  4527. (and
  4528. (or
  4529. (and (memq 'scheduled conditions)
  4530. (re-search-forward org-scheduled-time-regexp end t))
  4531. (and (memq 'notscheduled conditions)
  4532. (not (re-search-forward org-scheduled-time-regexp end t)))
  4533. (and (memq 'deadline conditions)
  4534. (re-search-forward org-deadline-time-regexp end t))
  4535. (and (memq 'notdeadline conditions)
  4536. (not (re-search-forward org-deadline-time-regexp end t)))
  4537. (and (memq 'timestamp conditions)
  4538. (re-search-forward org-ts-regexp end t))
  4539. (and (memq 'nottimestamp conditions)
  4540. (not (re-search-forward org-ts-regexp end t)))
  4541. (and (setq m (memq 'regexp conditions))
  4542. (stringp (nth 1 m))
  4543. (re-search-forward (nth 1 m) end t))
  4544. (and (setq m (memq 'notregexp conditions))
  4545. (stringp (nth 1 m))
  4546. (not (re-search-forward (nth 1 m) end t)))
  4547. (and (or
  4548. (setq m (memq 'nottodo conditions))
  4549. (setq m (memq 'todo-unblocked conditions))
  4550. (setq m (memq 'nottodo-unblocked conditions))
  4551. (setq m (memq 'todo conditions)))
  4552. (org-agenda-skip-if-todo m end)))
  4553. end)))
  4554. (defun org-agenda-skip-if-todo (args end)
  4555. "Helper function for `org-agenda-skip-if', do not use it directly.
  4556. ARGS is a list with first element either `todo', `nottodo',
  4557. `todo-unblocked' or `nottodo-unblocked'. The remainder is either
  4558. a list of TODO keywords, or a state symbol `todo' or `done' or
  4559. `any'."
  4560. (let ((kw (car args))
  4561. (arg (cadr args))
  4562. todo-wds todo-re)
  4563. (setq todo-wds
  4564. (org-uniquify
  4565. (cond
  4566. ((listp arg) ;; list of keywords
  4567. (if (member "*" arg)
  4568. (mapcar 'substring-no-properties org-todo-keywords-1)
  4569. arg))
  4570. ((symbolp arg) ;; keyword class name
  4571. (cond
  4572. ((eq arg 'todo)
  4573. (org-delete-all org-done-keywords
  4574. (mapcar 'substring-no-properties
  4575. org-todo-keywords-1)))
  4576. ((eq arg 'done) org-done-keywords)
  4577. ((eq arg 'any)
  4578. (mapcar 'substring-no-properties org-todo-keywords-1)))))))
  4579. (setq todo-re
  4580. (concat "^\\*+[ \t]+\\<\\("
  4581. (mapconcat 'identity todo-wds "\\|")
  4582. "\\)\\>"))
  4583. (cond
  4584. ((eq kw 'todo) (re-search-forward todo-re end t))
  4585. ((eq kw 'nottodo) (not (re-search-forward todo-re end t)))
  4586. ((eq kw 'todo-unblocked)
  4587. (catch 'unblocked
  4588. (while (re-search-forward todo-re end t)
  4589. (or (org-entry-blocked-p) (throw 'unblocked t)))
  4590. nil))
  4591. ((eq kw 'nottodo-unblocked)
  4592. (catch 'unblocked
  4593. (while (re-search-forward todo-re end t)
  4594. (or (org-entry-blocked-p) (throw 'unblocked nil)))
  4595. t))
  4596. )))
  4597. ;;;###autoload
  4598. (defun org-agenda-list-stuck-projects (&rest ignore)
  4599. "Create agenda view for projects that are stuck.
  4600. Stuck projects are project that have no next actions. For the definitions
  4601. of what a project is and how to check if it stuck, customize the variable
  4602. `org-stuck-projects'."
  4603. (interactive)
  4604. (let* ((org-agenda-skip-function
  4605. 'org-agenda-skip-entry-when-regexp-matches-in-subtree)
  4606. ;; We could have used org-agenda-skip-if here.
  4607. (org-agenda-overriding-header
  4608. (or org-agenda-overriding-header "List of stuck projects: "))
  4609. (matcher (nth 0 org-stuck-projects))
  4610. (todo (nth 1 org-stuck-projects))
  4611. (todo-wds (if (member "*" todo)
  4612. (progn
  4613. (org-agenda-prepare-buffers (org-agenda-files
  4614. nil 'ifmode))
  4615. (org-delete-all
  4616. org-done-keywords-for-agenda
  4617. (copy-sequence org-todo-keywords-for-agenda)))
  4618. todo))
  4619. (todo-re (concat "^\\*+[ \t]+\\("
  4620. (mapconcat 'identity todo-wds "\\|")
  4621. "\\)\\>"))
  4622. (tags (nth 2 org-stuck-projects))
  4623. (tags-re (if (member "*" tags)
  4624. (concat org-outline-regexp-bol
  4625. (org-re ".*:[[:alnum:]_@#%]+:[ \t]*$"))
  4626. (if tags
  4627. (concat org-outline-regexp-bol
  4628. ".*:\\("
  4629. (mapconcat 'identity tags "\\|")
  4630. (org-re "\\):[[:alnum:]_@#%:]*[ \t]*$")))))
  4631. (gen-re (nth 3 org-stuck-projects))
  4632. (re-list
  4633. (delq nil
  4634. (list
  4635. (if todo todo-re)
  4636. (if tags tags-re)
  4637. (and gen-re (stringp gen-re) (string-match "\\S-" gen-re)
  4638. gen-re)))))
  4639. (setq org-agenda-skip-regexp
  4640. (if re-list
  4641. (mapconcat 'identity re-list "\\|")
  4642. (error "No information how to identify unstuck projects")))
  4643. (org-tags-view nil matcher)
  4644. (with-current-buffer org-agenda-buffer-name
  4645. (setq org-agenda-redo-command
  4646. `(org-agenda-list-stuck-projects ,current-prefix-arg)))))
  4647. ;;; Diary integration
  4648. (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
  4649. (defvar diary-list-entries-hook)
  4650. (defvar diary-time-regexp)
  4651. (defun org-get-entries-from-diary (date)
  4652. "Get the (Emacs Calendar) diary entries for DATE."
  4653. (require 'diary-lib)
  4654. (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
  4655. (diary-display-hook '(fancy-diary-display))
  4656. (diary-display-function 'fancy-diary-display)
  4657. (pop-up-frames nil)
  4658. (diary-list-entries-hook
  4659. (cons 'org-diary-default-entry diary-list-entries-hook))
  4660. (diary-file-name-prefix nil) ; turn this feature off
  4661. (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
  4662. entries
  4663. (org-disable-agenda-to-diary t))
  4664. (save-excursion
  4665. (save-window-excursion
  4666. (funcall (if (fboundp 'diary-list-entries)
  4667. 'diary-list-entries 'list-diary-entries)
  4668. date 1)))
  4669. (if (not (get-buffer diary-fancy-buffer))
  4670. (setq entries nil)
  4671. (with-current-buffer diary-fancy-buffer
  4672. (setq buffer-read-only nil)
  4673. (if (zerop (buffer-size))
  4674. ;; No entries
  4675. (setq entries nil)
  4676. ;; Omit the date and other unnecessary stuff
  4677. (org-agenda-cleanup-fancy-diary)
  4678. ;; Add prefix to each line and extend the text properties
  4679. (if (zerop (buffer-size))
  4680. (setq entries nil)
  4681. (setq entries (buffer-substring (point-min) (- (point-max) 1)))
  4682. (setq entries
  4683. (with-temp-buffer
  4684. (insert entries) (goto-char (point-min))
  4685. (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
  4686. (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
  4687. (replace-match (concat "; " (match-string 1)))))
  4688. (buffer-string)))))
  4689. (set-buffer-modified-p nil)
  4690. (kill-buffer diary-fancy-buffer)))
  4691. (when entries
  4692. (setq entries (org-split-string entries "\n"))
  4693. (setq entries
  4694. (mapcar
  4695. (lambda (x)
  4696. (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
  4697. ;; Extend the text properties to the beginning of the line
  4698. (org-add-props x (text-properties-at (1- (length x)) x)
  4699. 'type "diary" 'date date 'face 'org-agenda-diary))
  4700. entries)))))
  4701. (defvar org-agenda-cleanup-fancy-diary-hook nil
  4702. "Hook run when the fancy diary buffer is cleaned up.")
  4703. (defun org-agenda-cleanup-fancy-diary ()
  4704. "Remove unwanted stuff in buffer created by `fancy-diary-display'.
  4705. This gets rid of the date, the underline under the date, and
  4706. the dummy entry installed by `org-mode' to ensure non-empty diary for each
  4707. date. It also removes lines that contain only whitespace."
  4708. (goto-char (point-min))
  4709. (if (looking-at ".*?:[ \t]*")
  4710. (progn
  4711. (replace-match "")
  4712. (re-search-forward "\n=+$" nil t)
  4713. (replace-match "")
  4714. (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
  4715. (re-search-forward "\n=+$" nil t)
  4716. (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
  4717. (goto-char (point-min))
  4718. (while (re-search-forward "^ +\n" nil t)
  4719. (replace-match ""))
  4720. (goto-char (point-min))
  4721. (if (re-search-forward "^Org-mode dummy\n?" nil t)
  4722. (replace-match ""))
  4723. (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
  4724. ;; Make sure entries from the diary have the right text properties.
  4725. (eval-after-load "diary-lib"
  4726. '(if (boundp 'diary-modify-entry-list-string-function)
  4727. ;; We can rely on the hook, nothing to do
  4728. nil
  4729. ;; Hook not available, must use advice to make this work
  4730. (defadvice add-to-diary-list (before org-mark-diary-entry activate)
  4731. "Make the position visible."
  4732. (if (and org-disable-agenda-to-diary ;; called from org-agenda
  4733. (stringp string)
  4734. buffer-file-name)
  4735. (setq string (org-modify-diary-entry-string string))))))
  4736. (defun org-modify-diary-entry-string (string)
  4737. "Add text properties to string, allowing org-mode to act on it."
  4738. (org-add-props string nil
  4739. 'mouse-face 'highlight
  4740. 'help-echo (if buffer-file-name
  4741. (format "mouse-2 or RET jump to diary file %s"
  4742. (abbreviate-file-name buffer-file-name))
  4743. "")
  4744. 'org-agenda-diary-link t
  4745. 'org-marker (org-agenda-new-marker (point-at-bol))))
  4746. (defun org-diary-default-entry ()
  4747. "Add a dummy entry to the diary.
  4748. Needed to avoid empty dates which mess up holiday display."
  4749. ;; Catch the error if dealing with the new add-to-diary-alist
  4750. (when org-disable-agenda-to-diary
  4751. (condition-case nil
  4752. (org-add-to-diary-list original-date "Org-mode dummy" "")
  4753. (error
  4754. (org-add-to-diary-list original-date "Org-mode dummy" "" nil)))))
  4755. (defun org-add-to-diary-list (&rest args)
  4756. (if (fboundp 'diary-add-to-list)
  4757. (apply 'diary-add-to-list args)
  4758. (apply 'add-to-diary-list args)))
  4759. (defvar org-diary-last-run-time nil)
  4760. ;;;###autoload
  4761. (defun org-diary (&rest args)
  4762. "Return diary information from org files.
  4763. This function can be used in a \"sexp\" diary entry in the Emacs calendar.
  4764. It accesses org files and extracts information from those files to be
  4765. listed in the diary. The function accepts arguments specifying what
  4766. items should be listed. For a list of arguments allowed here, see the
  4767. variable `org-agenda-entry-types'.
  4768. The call in the diary file should look like this:
  4769. &%%(org-diary) ~/path/to/some/orgfile.org
  4770. Use a separate line for each org file to check. Or, if you omit the file name,
  4771. all files listed in `org-agenda-files' will be checked automatically:
  4772. &%%(org-diary)
  4773. If you don't give any arguments (as in the example above), the default
  4774. arguments (:deadline :scheduled :timestamp :sexp) are used.
  4775. So the example above may also be written as
  4776. &%%(org-diary :deadline :timestamp :sexp :scheduled)
  4777. The function expects the lisp variables `entry' and `date' to be provided
  4778. by the caller, because this is how the calendar works. Don't use this
  4779. function from a program - use `org-agenda-get-day-entries' instead."
  4780. (when (> (- (org-float-time)
  4781. org-agenda-last-marker-time)
  4782. 5)
  4783. ;; I am not sure if this works with sticky agendas, because the marker
  4784. ;; list is then no longer a global variable.
  4785. (org-agenda-reset-markers))
  4786. (org-compile-prefix-format 'agenda)
  4787. (org-set-sorting-strategy 'agenda)
  4788. (setq args (or args '(:deadline :scheduled :timestamp :sexp)))
  4789. (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
  4790. (list entry)
  4791. (org-agenda-files t)))
  4792. (time (org-float-time))
  4793. file rtn results)
  4794. (when (or (not org-diary-last-run-time)
  4795. (> (- time
  4796. org-diary-last-run-time)
  4797. 3))
  4798. (org-agenda-prepare-buffers files))
  4799. (setq org-diary-last-run-time time)
  4800. ;; If this is called during org-agenda, don't return any entries to
  4801. ;; the calendar. Org Agenda will list these entries itself.
  4802. (if org-disable-agenda-to-diary (setq files nil))
  4803. (while (setq file (pop files))
  4804. (setq rtn (apply 'org-agenda-get-day-entries file date args))
  4805. (setq results (append results rtn)))
  4806. (when results
  4807. (setq results
  4808. (mapcar (lambda (i) (replace-regexp-in-string
  4809. org-bracket-link-regexp "\\3" i)) results))
  4810. (concat (org-agenda-finalize-entries results) "\n"))))
  4811. ;;; Agenda entry finders
  4812. (defun org-agenda-get-day-entries (file date &rest args)
  4813. "Does the work for `org-diary' and `org-agenda'.
  4814. FILE is the path to a file to be checked for entries. DATE is date like
  4815. the one returned by `calendar-current-date'. ARGS are symbols indicating
  4816. which kind of entries should be extracted. For details about these, see
  4817. the documentation of `org-diary'."
  4818. (setq args (or args '(:deadline :scheduled :timestamp :sexp)))
  4819. (let* ((org-startup-folded nil)
  4820. (org-startup-align-all-tables nil)
  4821. (buffer (if (file-exists-p file)
  4822. (org-get-agenda-file-buffer file)
  4823. (error "No such file %s" file)))
  4824. arg results rtn deadline-results)
  4825. (if (not buffer)
  4826. ;; If file does not exist, make sure an error message ends up in diary
  4827. (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4828. (with-current-buffer buffer
  4829. (unless (derived-mode-p 'org-mode)
  4830. (error "Agenda file %s is not in `org-mode'" file))
  4831. (setq org-agenda-buffer (or org-agenda-buffer buffer))
  4832. (let ((case-fold-search nil))
  4833. (save-excursion
  4834. (save-restriction
  4835. (if org-agenda-restrict
  4836. (narrow-to-region org-agenda-restrict-begin
  4837. org-agenda-restrict-end)
  4838. (widen))
  4839. ;; The way we repeatedly append to `results' makes it O(n^2) :-(
  4840. (while (setq arg (pop args))
  4841. (cond
  4842. ((and (eq arg :todo)
  4843. (equal date (calendar-gregorian-from-absolute
  4844. (org-today))))
  4845. (setq rtn (org-agenda-get-todos))
  4846. (setq results (append results rtn)))
  4847. ((eq arg :timestamp)
  4848. (setq rtn (org-agenda-get-blocks))
  4849. (setq results (append results rtn))
  4850. (setq rtn (org-agenda-get-timestamps deadline-results))
  4851. (setq results (append results rtn)))
  4852. ((eq arg :sexp)
  4853. (setq rtn (org-agenda-get-sexps))
  4854. (setq results (append results rtn)))
  4855. ((eq arg :scheduled)
  4856. (setq rtn (org-agenda-get-scheduled deadline-results))
  4857. (setq results (append results rtn)))
  4858. ((eq arg :scheduled*)
  4859. (setq rtn (org-agenda-get-scheduled deadline-results t))
  4860. (setq results (append results rtn)))
  4861. ((eq arg :closed)
  4862. (setq rtn (org-agenda-get-progress))
  4863. (setq results (append results rtn)))
  4864. ((eq arg :deadline)
  4865. (setq rtn (org-agenda-get-deadlines))
  4866. (setq deadline-results (copy-sequence rtn))
  4867. (setq results (append results rtn)))
  4868. ((eq arg :deadline*)
  4869. (setq rtn (org-agenda-get-deadlines t))
  4870. (setq deadline-results (copy-sequence rtn))
  4871. (setq results (append results rtn))))))))
  4872. results))))
  4873. (defsubst org-em (x y list)
  4874. "Is X or Y a member of LIST?"
  4875. (or (memq x list) (memq y list)))
  4876. (defvar org-heading-keyword-regexp-format) ; defined in org.el
  4877. (defvar org-agenda-sorting-strategy-selected nil)
  4878. (defun org-agenda-get-todos ()
  4879. "Return the TODO information for agenda display."
  4880. (let* ((props (list 'face nil
  4881. 'done-face 'org-agenda-done
  4882. 'org-not-done-regexp org-not-done-regexp
  4883. 'org-todo-regexp org-todo-regexp
  4884. 'org-complex-heading-regexp org-complex-heading-regexp
  4885. 'mouse-face 'highlight
  4886. 'help-echo
  4887. (format "mouse-2 or RET jump to org file %s"
  4888. (abbreviate-file-name buffer-file-name))))
  4889. (regexp (format org-heading-keyword-regexp-format
  4890. (cond
  4891. ((and org-select-this-todo-keyword
  4892. (equal org-select-this-todo-keyword "*"))
  4893. org-todo-regexp)
  4894. (org-select-this-todo-keyword
  4895. (concat "\\("
  4896. (mapconcat 'identity
  4897. (org-split-string
  4898. org-select-this-todo-keyword
  4899. "|")
  4900. "\\|") "\\)"))
  4901. (t org-not-done-regexp))))
  4902. marker priority category category-pos level tags todo-state ts-date ts-date-type
  4903. ee txt beg end inherited-tags)
  4904. (goto-char (point-min))
  4905. (while (re-search-forward regexp nil t)
  4906. (catch :skip
  4907. (save-match-data
  4908. (beginning-of-line)
  4909. (org-agenda-skip)
  4910. (setq beg (point) end (save-excursion (outline-next-heading) (point)))
  4911. (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
  4912. (goto-char (1+ beg))
  4913. (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
  4914. (throw :skip nil)))
  4915. (goto-char (match-beginning 2))
  4916. (setq marker (org-agenda-new-marker (match-beginning 0))
  4917. category (org-get-category)
  4918. ts-date (let (ts)
  4919. (save-match-data
  4920. (cond ((org-em 'scheduled-up 'scheduled-down
  4921. org-agenda-sorting-strategy-selected)
  4922. (setq ts (org-entry-get (point) "SCHEDULED")
  4923. ts-date-type " scheduled"))
  4924. ((org-em 'deadline-up 'deadline-down
  4925. org-agenda-sorting-strategy-selected)
  4926. (setq ts (org-entry-get (point) "DEADLINE")
  4927. ts-date-type " deadline"))
  4928. ((org-em 'ts-up 'ts-down
  4929. org-agenda-sorting-strategy-selected)
  4930. (setq ts (org-entry-get (point) "TIMESTAMP")
  4931. ts-date-type " timestamp"))
  4932. ((org-em 'tsia-up 'tsia-down
  4933. org-agenda-sorting-strategy-selected)
  4934. (setq ts (org-entry-get (point) "TIMESTAMP_IA")
  4935. ts-date-type " timestamp_ia"))
  4936. ((org-em 'timestamp-up 'timestamp-down
  4937. org-agenda-sorting-strategy-selected)
  4938. (setq ts (or (org-entry-get (point) "SCHEDULED")
  4939. (org-entry-get (point) "DEADLINE")
  4940. (org-entry-get (point) "TIMESTAMP")
  4941. (org-entry-get (point) "TIMESTAMP_IA"))
  4942. ts-date-type ""))
  4943. (t (setq ts-date-type "")))
  4944. (when ts (ignore-errors (org-time-string-to-absolute ts)))))
  4945. category-pos (get-text-property (point) 'org-category-position)
  4946. txt (org-trim
  4947. (buffer-substring (match-beginning 2) (match-end 0)))
  4948. inherited-tags
  4949. (or (eq org-agenda-show-inherited-tags 'always)
  4950. (and (listp org-agenda-show-inherited-tags)
  4951. (memq 'todo org-agenda-show-inherited-tags))
  4952. (and (eq org-agenda-show-inherited-tags t)
  4953. (or (eq org-agenda-use-tag-inheritance t)
  4954. (memq 'todo org-agenda-use-tag-inheritance))))
  4955. tags (org-get-tags-at nil (not inherited-tags))
  4956. level (make-string (org-reduced-level (org-outline-level)) ? )
  4957. txt (org-agenda-format-item "" txt level category tags t)
  4958. priority (1+ (org-get-priority txt))
  4959. todo-state (org-get-todo-state))
  4960. (org-add-props txt props
  4961. 'org-marker marker 'org-hd-marker marker
  4962. 'priority priority 'org-category category
  4963. 'level level
  4964. 'ts-date ts-date
  4965. 'org-category-position category-pos
  4966. 'type (concat "todo" ts-date-type) 'todo-state todo-state)
  4967. (push txt ee)
  4968. (if org-agenda-todo-list-sublevels
  4969. (goto-char (match-end 2))
  4970. (org-end-of-subtree 'invisible))))
  4971. (nreverse ee)))
  4972. (defun org-agenda-todo-custom-ignore-p (time n)
  4973. "Check whether timestamp is farther away than n number of days.
  4974. This function is invoked if `org-agenda-todo-ignore-deadlines',
  4975. `org-agenda-todo-ignore-scheduled' or
  4976. `org-agenda-todo-ignore-timestamp' is set to an integer."
  4977. (let ((days (org-time-stamp-to-now
  4978. time org-agenda-todo-ignore-time-comparison-use-seconds)))
  4979. (if (>= n 0)
  4980. (>= days n)
  4981. (<= days n))))
  4982. (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  4983. (&optional end)
  4984. "Do we have a reason to ignore this TODO entry because it has a time stamp?"
  4985. (when (or org-agenda-todo-ignore-with-date
  4986. org-agenda-todo-ignore-scheduled
  4987. org-agenda-todo-ignore-deadlines
  4988. org-agenda-todo-ignore-timestamp)
  4989. (setq end (or end (save-excursion (outline-next-heading) (point))))
  4990. (save-excursion
  4991. (or (and org-agenda-todo-ignore-with-date
  4992. (re-search-forward org-ts-regexp end t))
  4993. (and org-agenda-todo-ignore-scheduled
  4994. (re-search-forward org-scheduled-time-regexp end t)
  4995. (cond
  4996. ((eq org-agenda-todo-ignore-scheduled 'future)
  4997. (> (org-time-stamp-to-now
  4998. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4999. ((eq org-agenda-todo-ignore-scheduled 'past)
  5000. (<= (org-time-stamp-to-now
  5001. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5002. ((numberp org-agenda-todo-ignore-scheduled)
  5003. (org-agenda-todo-custom-ignore-p
  5004. (match-string 1) org-agenda-todo-ignore-scheduled))
  5005. (t)))
  5006. (and org-agenda-todo-ignore-deadlines
  5007. (re-search-forward org-deadline-time-regexp end t)
  5008. (cond
  5009. ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
  5010. ((eq org-agenda-todo-ignore-deadlines 'far)
  5011. (not (org-deadline-close (match-string 1))))
  5012. ((eq org-agenda-todo-ignore-deadlines 'future)
  5013. (> (org-time-stamp-to-now
  5014. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5015. ((eq org-agenda-todo-ignore-deadlines 'past)
  5016. (<= (org-time-stamp-to-now
  5017. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5018. ((numberp org-agenda-todo-ignore-deadlines)
  5019. (org-agenda-todo-custom-ignore-p
  5020. (match-string 1) org-agenda-todo-ignore-deadlines))
  5021. (t (org-deadline-close (match-string 1)))))
  5022. (and org-agenda-todo-ignore-timestamp
  5023. (let ((buffer (current-buffer))
  5024. (regexp
  5025. (concat
  5026. org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
  5027. (start (point)))
  5028. ;; Copy current buffer into a temporary one
  5029. (with-temp-buffer
  5030. (insert-buffer-substring buffer start end)
  5031. (goto-char (point-min))
  5032. ;; Delete SCHEDULED and DEADLINE items
  5033. (while (re-search-forward regexp end t)
  5034. (delete-region (match-beginning 0) (match-end 0)))
  5035. (goto-char (point-min))
  5036. ;; No search for timestamp left
  5037. (when (re-search-forward org-ts-regexp nil t)
  5038. (cond
  5039. ((eq org-agenda-todo-ignore-timestamp '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-timestamp '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-timestamp)
  5046. (org-agenda-todo-custom-ignore-p
  5047. (match-string 1) org-agenda-todo-ignore-timestamp))
  5048. (t))))))))))
  5049. (defun org-agenda-get-timestamps (&optional deadline-results)
  5050. "Return the date stamp information for agenda display."
  5051. (let* ((props (list 'face 'org-agenda-calendar-event
  5052. 'org-not-done-regexp org-not-done-regexp
  5053. 'org-todo-regexp org-todo-regexp
  5054. 'org-complex-heading-regexp org-complex-heading-regexp
  5055. 'mouse-face 'highlight
  5056. 'help-echo
  5057. (format "mouse-2 or RET jump to org file %s"
  5058. (abbreviate-file-name buffer-file-name))))
  5059. (d1 (calendar-absolute-from-gregorian date))
  5060. mm
  5061. (deadline-position-alist
  5062. (mapcar (lambda (a) (and (setq mm (get-text-property
  5063. 0 'org-hd-marker a))
  5064. (cons (marker-position mm) a)))
  5065. deadline-results))
  5066. (remove-re org-ts-regexp)
  5067. (regexp
  5068. (concat
  5069. (if org-agenda-include-inactive-timestamps "[[<]" "<")
  5070. (regexp-quote
  5071. (substring
  5072. (format-time-string
  5073. (car org-time-stamp-formats)
  5074. (apply 'encode-time ; DATE bound by calendar
  5075. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  5076. 1 11))
  5077. "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
  5078. "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
  5079. marker hdmarker deadlinep scheduledp clockp closedp inactivep
  5080. donep tmp priority category category-pos level ee txt timestr tags
  5081. b0 b3 e3 head todo-state end-of-match show-all warntime habitp
  5082. inherited-tags ts-date)
  5083. (goto-char (point-min))
  5084. (while (setq end-of-match (re-search-forward regexp nil t))
  5085. (setq b0 (match-beginning 0)
  5086. b3 (match-beginning 3) e3 (match-end 3)
  5087. todo-state (save-match-data (ignore-errors (org-get-todo-state)))
  5088. habitp (and (functionp 'org-is-habit-p) (save-match-data (org-is-habit-p)))
  5089. show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  5090. (member todo-state
  5091. org-agenda-repeating-timestamp-show-all)))
  5092. (catch :skip
  5093. (and (org-at-date-range-p) (throw :skip nil))
  5094. (org-agenda-skip)
  5095. (if (and (match-end 1)
  5096. (not (= d1 (org-time-string-to-absolute
  5097. (match-string 1) d1 nil show-all
  5098. (current-buffer) b0))))
  5099. (throw :skip nil))
  5100. (if (and e3
  5101. (not (org-diary-sexp-entry (buffer-substring b3 e3) "" date)))
  5102. (throw :skip nil))
  5103. (setq tmp (buffer-substring (max (point-min)
  5104. (- b0 org-ds-keyword-length))
  5105. b0)
  5106. timestr (if b3 "" (buffer-substring b0 (point-at-eol)))
  5107. inactivep (= (char-after b0) ?\[)
  5108. deadlinep (string-match org-deadline-regexp tmp)
  5109. scheduledp (string-match org-scheduled-regexp tmp)
  5110. closedp (and org-agenda-include-inactive-timestamps
  5111. (string-match org-closed-string tmp))
  5112. clockp (and org-agenda-include-inactive-timestamps
  5113. (or (string-match org-clock-string tmp)
  5114. (string-match "]-+\\'" tmp)))
  5115. warntime (get-text-property (point) 'org-appt-warntime)
  5116. donep (member todo-state org-done-keywords))
  5117. (if (or scheduledp deadlinep closedp clockp
  5118. (and donep org-agenda-skip-timestamp-if-done))
  5119. (throw :skip t))
  5120. (if (string-match ">" timestr)
  5121. ;; substring should only run to end of time stamp
  5122. (setq timestr (substring timestr 0 (match-end 0))))
  5123. (setq marker (org-agenda-new-marker b0)
  5124. category (org-get-category b0)
  5125. category-pos (get-text-property b0 'org-category-position))
  5126. (save-excursion
  5127. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5128. (throw :skip nil)
  5129. (goto-char (match-beginning 0))
  5130. (if (and (eq t org-agenda-skip-timestamp-if-deadline-is-shown)
  5131. (assoc (point) deadline-position-alist))
  5132. (throw :skip nil))
  5133. (setq hdmarker (org-agenda-new-marker)
  5134. inherited-tags
  5135. (or (eq org-agenda-show-inherited-tags 'always)
  5136. (and (listp org-agenda-show-inherited-tags)
  5137. (memq 'agenda org-agenda-show-inherited-tags))
  5138. (and (eq org-agenda-show-inherited-tags t)
  5139. (or (eq org-agenda-use-tag-inheritance t)
  5140. (memq 'agenda org-agenda-use-tag-inheritance))))
  5141. tags (org-get-tags-at nil (not inherited-tags))
  5142. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5143. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5144. (setq head (or (match-string 1) ""))
  5145. (setq txt (org-agenda-format-item
  5146. (if inactivep org-agenda-inactive-leader nil)
  5147. head level category tags timestr
  5148. remove-re habitp)))
  5149. (setq priority (org-get-priority txt))
  5150. (org-add-props txt props 'priority priority
  5151. 'org-marker marker 'org-hd-marker hdmarker
  5152. 'org-category category 'date date
  5153. 'level level
  5154. 'ts-date
  5155. (ignore-errors (org-time-string-to-absolute timestr))
  5156. 'org-category-position category-pos
  5157. 'todo-state todo-state
  5158. 'warntime warntime
  5159. 'type "timestamp")
  5160. (push txt ee))
  5161. (if org-agenda-skip-additional-timestamps-same-entry
  5162. (outline-next-heading)
  5163. (goto-char end-of-match))))
  5164. (nreverse ee)))
  5165. (defun org-agenda-get-sexps ()
  5166. "Return the sexp information for agenda display."
  5167. (require 'diary-lib)
  5168. (let* ((props (list 'face 'org-agenda-calendar-sexp
  5169. 'mouse-face 'highlight
  5170. 'help-echo
  5171. (format "mouse-2 or RET jump to org file %s"
  5172. (abbreviate-file-name buffer-file-name))))
  5173. (regexp "^&?%%(")
  5174. marker category extra category-pos level ee txt tags entry
  5175. result beg b sexp sexp-entry todo-state warntime inherited-tags)
  5176. (goto-char (point-min))
  5177. (while (re-search-forward regexp nil t)
  5178. (catch :skip
  5179. (org-agenda-skip)
  5180. (setq beg (match-beginning 0))
  5181. (goto-char (1- (match-end 0)))
  5182. (setq b (point))
  5183. (forward-sexp 1)
  5184. (setq sexp (buffer-substring b (point)))
  5185. (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
  5186. (org-trim (match-string 1))
  5187. ""))
  5188. (setq result (org-diary-sexp-entry sexp sexp-entry date))
  5189. (when result
  5190. (setq marker (org-agenda-new-marker beg)
  5191. level (make-string (org-reduced-level (org-outline-level)) ? )
  5192. category (org-get-category beg)
  5193. category-pos (get-text-property beg 'org-category-position)
  5194. inherited-tags
  5195. (or (eq org-agenda-show-inherited-tags 'always)
  5196. (and (listp org-agenda-show-inherited-tags)
  5197. (memq 'agenda org-agenda-show-inherited-tags))
  5198. (and (eq org-agenda-show-inherited-tags t)
  5199. (or (eq org-agenda-use-tag-inheritance t)
  5200. (memq 'agenda org-agenda-use-tag-inheritance))))
  5201. tags (org-get-tags-at nil (not inherited-tags))
  5202. todo-state (org-get-todo-state)
  5203. warntime (get-text-property (point) 'org-appt-warntime)
  5204. extra nil)
  5205. (dolist (r (if (stringp result)
  5206. (list result)
  5207. result)) ;; we expect a list here
  5208. (when (and org-agenda-diary-sexp-prefix
  5209. (string-match org-agenda-diary-sexp-prefix r))
  5210. (setq extra (match-string 0 r)
  5211. r (replace-match "" nil nil r)))
  5212. (if (string-match "\\S-" r)
  5213. (setq txt r)
  5214. (setq txt "SEXP entry returned empty string"))
  5215. (setq txt (org-agenda-format-item extra txt level category tags 'time))
  5216. (org-add-props txt props 'org-marker marker
  5217. 'org-category category 'date date 'todo-state todo-state
  5218. 'org-category-position category-pos 'tags tags
  5219. 'level level
  5220. 'type "sexp" 'warntime warntime)
  5221. (push txt ee)))))
  5222. (nreverse ee)))
  5223. ;; Calendar sanity: define some functions that are independent of
  5224. ;; `calendar-date-style'.
  5225. ;; Normally I would like to use ISO format when calling the diary functions,
  5226. ;; but to make sure we still have Emacs 22 compatibility we bind
  5227. ;; also `european-calendar-style' and use european format
  5228. (defun org-anniversary (year month day &optional mark)
  5229. "Like `diary-anniversary', but with fixed (ISO) order of arguments."
  5230. (org-no-warnings
  5231. (let ((calendar-date-style 'european) (european-calendar-style t))
  5232. (diary-anniversary day month year mark))))
  5233. (defun org-cyclic (N year month day &optional mark)
  5234. "Like `diary-cyclic', but with fixed (ISO) order of arguments."
  5235. (org-no-warnings
  5236. (let ((calendar-date-style 'european) (european-calendar-style t))
  5237. (diary-cyclic N day month year mark))))
  5238. (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
  5239. "Like `diary-block', but with fixed (ISO) order of arguments."
  5240. (org-no-warnings
  5241. (let ((calendar-date-style 'european) (european-calendar-style t))
  5242. (diary-block D1 M1 Y1 D2 M2 Y2 mark))))
  5243. (defun org-date (year month day &optional mark)
  5244. "Like `diary-date', but with fixed (ISO) order of arguments."
  5245. (org-no-warnings
  5246. (let ((calendar-date-style 'european) (european-calendar-style t))
  5247. (diary-date day month year mark))))
  5248. ;; Define the` org-class' function
  5249. (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
  5250. "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
  5251. DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
  5252. SKIP-WEEKS is any number of ISO weeks in the block period for which the
  5253. item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
  5254. `holidays', then any date that is known by the Emacs calendar to be a
  5255. holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
  5256. then those holidays will be skipped."
  5257. (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
  5258. (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
  5259. (d (calendar-absolute-from-gregorian date))
  5260. (h (when skip-weeks (calendar-check-holidays date))))
  5261. (and
  5262. (<= date1 d)
  5263. (<= d date2)
  5264. (= (calendar-day-of-week date) dayname)
  5265. (or (not skip-weeks)
  5266. (progn
  5267. (require 'cal-iso)
  5268. (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
  5269. (not (or (and h (memq 'holidays skip-weeks))
  5270. (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
  5271. entry)))
  5272. (defun org-diary-class (m1 d1 y1 m2 d2 y2 dayname &rest skip-weeks)
  5273. "Like `org-class', but honor `calendar-date-style'.
  5274. The order of the first 2 times 3 arguments depends on the variable
  5275. `calendar-date-style' or, if that is not defined, on `european-calendar-style'.
  5276. So for American calendars, give this as MONTH DAY YEAR, for European as
  5277. DAY MONTH YEAR, and for ISO as YEAR MONTH DAY.
  5278. DAYNAME is a number between 0 (Sunday) and 6 (Saturday). SKIP-WEEKS
  5279. is any number of ISO weeks in the block period for which the item should
  5280. be skipped.
  5281. This function is here only for backward compatibility and it is deprecated,
  5282. please use `org-class' instead."
  5283. (let* ((date1 (org-order-calendar-date-args m1 d1 y1))
  5284. (date2 (org-order-calendar-date-args m2 d2 y2)))
  5285. (org-class
  5286. (nth 2 date1) (car date1) (nth 1 date1)
  5287. (nth 2 date2) (car date2) (nth 1 date2)
  5288. dayname skip-weeks)))
  5289. (make-obsolete 'org-diary-class 'org-class "")
  5290. (defvar org-agenda-show-log-scoped) ;; dynamically scope in `org-timeline' or `org-agenda-list'
  5291. (defalias 'org-get-closed 'org-agenda-get-progress)
  5292. (defun org-agenda-get-progress ()
  5293. "Return the logged TODO entries for agenda display."
  5294. (let* ((props (list 'mouse-face 'highlight
  5295. 'org-not-done-regexp org-not-done-regexp
  5296. 'org-todo-regexp org-todo-regexp
  5297. 'org-complex-heading-regexp org-complex-heading-regexp
  5298. 'help-echo
  5299. (format "mouse-2 or RET jump to org file %s"
  5300. (abbreviate-file-name buffer-file-name))))
  5301. (items (if (consp org-agenda-show-log-scoped)
  5302. org-agenda-show-log-scoped
  5303. (if (eq org-agenda-show-log-scoped 'clockcheck)
  5304. '(clock)
  5305. org-agenda-log-mode-items)))
  5306. (parts
  5307. (delq nil
  5308. (list
  5309. (if (memq 'closed items) (concat "\\<" org-closed-string))
  5310. (if (memq 'clock items) (concat "\\<" org-clock-string))
  5311. (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
  5312. (parts-re (if parts (mapconcat 'identity parts "\\|")
  5313. (error "`org-agenda-log-mode-items' is empty")))
  5314. (regexp (concat
  5315. "\\(" parts-re "\\)"
  5316. " *\\["
  5317. (regexp-quote
  5318. (substring
  5319. (format-time-string
  5320. (car org-time-stamp-formats)
  5321. (apply 'encode-time ; DATE bound by calendar
  5322. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  5323. 1 11))))
  5324. (org-agenda-search-headline-for-time nil)
  5325. marker hdmarker priority category category-pos level tags closedp
  5326. statep clockp state ee txt extra timestr rest clocked inherited-tags)
  5327. (goto-char (point-min))
  5328. (while (re-search-forward regexp nil t)
  5329. (catch :skip
  5330. (org-agenda-skip)
  5331. (setq marker (org-agenda-new-marker (match-beginning 0))
  5332. closedp (equal (match-string 1) org-closed-string)
  5333. statep (equal (string-to-char (match-string 1)) ?-)
  5334. clockp (not (or closedp statep))
  5335. state (and statep (match-string 2))
  5336. category (org-get-category (match-beginning 0))
  5337. category-pos (get-text-property (match-beginning 0) 'org-category-position)
  5338. timestr (buffer-substring (match-beginning 0) (point-at-eol)))
  5339. (when (string-match "\\]" timestr)
  5340. ;; substring should only run to end of time stamp
  5341. (setq rest (substring timestr (match-end 0))
  5342. timestr (substring timestr 0 (match-end 0)))
  5343. (if (and (not closedp) (not statep)
  5344. (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
  5345. rest))
  5346. (progn (setq timestr (concat (substring timestr 0 -1)
  5347. "-" (match-string 1 rest) "]"))
  5348. (setq clocked (match-string 2 rest)))
  5349. (setq clocked "-")))
  5350. (save-excursion
  5351. (setq extra
  5352. (cond
  5353. ((not org-agenda-log-mode-add-notes) nil)
  5354. (statep
  5355. (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
  5356. (match-string 1)))
  5357. (clockp
  5358. (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
  5359. (match-string 1)))))
  5360. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5361. (throw :skip nil)
  5362. (goto-char (match-beginning 0))
  5363. (setq hdmarker (org-agenda-new-marker)
  5364. inherited-tags
  5365. (or (eq org-agenda-show-inherited-tags 'always)
  5366. (and (listp org-agenda-show-inherited-tags)
  5367. (memq 'todo org-agenda-show-inherited-tags))
  5368. (and (eq org-agenda-show-inherited-tags t)
  5369. (or (eq org-agenda-use-tag-inheritance t)
  5370. (memq 'todo org-agenda-use-tag-inheritance))))
  5371. tags (org-get-tags-at nil (not inherited-tags))
  5372. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5373. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5374. (setq txt (match-string 1))
  5375. (when extra
  5376. (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
  5377. (setq txt (concat (substring txt 0 (match-beginning 1))
  5378. " - " extra " " (match-string 2 txt)))
  5379. (setq txt (concat txt " - " extra))))
  5380. (setq txt (org-agenda-format-item
  5381. (cond
  5382. (closedp "Closed: ")
  5383. (statep (concat "State: (" state ")"))
  5384. (t (concat "Clocked: (" clocked ")")))
  5385. txt level category tags timestr)))
  5386. (setq priority 100000)
  5387. (org-add-props txt props
  5388. 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
  5389. 'priority priority 'org-category category
  5390. 'org-category-position category-pos
  5391. 'level level
  5392. 'type "closed" 'date date
  5393. 'undone-face 'org-warning 'done-face 'org-agenda-done)
  5394. (push txt ee))
  5395. (goto-char (point-at-eol))))
  5396. (nreverse ee)))
  5397. (defun org-agenda-show-clocking-issues ()
  5398. "Add overlays, showing issues with clocking.
  5399. See also the user option `org-agenda-clock-consistency-checks'."
  5400. (interactive)
  5401. (let* ((org-time-clocksum-use-effort-durations nil)
  5402. (pl org-agenda-clock-consistency-checks)
  5403. (re (concat "^[ \t]*"
  5404. org-clock-string
  5405. "[ \t]+"
  5406. "\\(\\[.*?\\]\\)" ; group 1 is first stamp
  5407. "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
  5408. (tlstart 0.)
  5409. (tlend 0.)
  5410. (maxtime (org-hh:mm-string-to-minutes
  5411. (or (plist-get pl :max-duration) "24:00")))
  5412. (mintime (org-hh:mm-string-to-minutes
  5413. (or (plist-get pl :min-duration) 0)))
  5414. (maxgap (org-hh:mm-string-to-minutes
  5415. ;; default 30:00 means never complain
  5416. (or (plist-get pl :max-gap) "30:00")))
  5417. (gapok (mapcar 'org-hh:mm-string-to-minutes
  5418. (plist-get pl :gap-ok-around)))
  5419. (def-face (or (plist-get pl :default-face)
  5420. '((:background "DarkRed") (:foreground "white"))))
  5421. issue face m te ts dt ov)
  5422. (goto-char (point-min))
  5423. (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
  5424. (setq issue nil face def-face)
  5425. (catch 'next
  5426. (setq m (org-get-at-bol 'org-marker)
  5427. te nil ts nil)
  5428. (unless (and m (markerp m))
  5429. (setq issue "No valid clock line") (throw 'next t))
  5430. (org-with-point-at m
  5431. (save-excursion
  5432. (goto-char (point-at-bol))
  5433. (unless (looking-at re)
  5434. (error "No valid Clock line")
  5435. (throw 'next t))
  5436. (unless (match-end 3)
  5437. (setq issue "No end time"
  5438. face (or (plist-get pl :no-end-time-face) face))
  5439. (throw 'next t))
  5440. (setq ts (match-string 1)
  5441. te (match-string 3)
  5442. ts (org-float-time
  5443. (apply 'encode-time (org-parse-time-string ts)))
  5444. te (org-float-time
  5445. (apply 'encode-time (org-parse-time-string te)))
  5446. dt (- te ts))))
  5447. (cond
  5448. ((> dt (* 60 maxtime))
  5449. ;; a very long clocking chunk
  5450. (setq issue (format "Clocking interval is very long: %s"
  5451. (org-minutes-to-clocksum-string
  5452. (floor (/ (float dt) 60.))))
  5453. face (or (plist-get pl :long-face) face)))
  5454. ((< dt (* 60 mintime))
  5455. ;; a very short clocking chunk
  5456. (setq issue (format "Clocking interval is very short: %s"
  5457. (org-minutes-to-clocksum-string
  5458. (floor (/ (float dt) 60.))))
  5459. face (or (plist-get pl :short-face) face)))
  5460. ((and (> tlend 0) (< ts tlend))
  5461. ;; Two clock entries are overlapping
  5462. (setq issue (format "Clocking overlap: %d minutes"
  5463. (/ (- tlend ts) 60))
  5464. face (or (plist-get pl :overlap-face) face)))
  5465. ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
  5466. ;; There is a gap, lets see if we need to report it
  5467. (unless (org-agenda-check-clock-gap tlend ts gapok)
  5468. (setq issue (format "Clocking gap: %d minutes"
  5469. (/ (- ts tlend) 60))
  5470. face (or (plist-get pl :gap-face) face))))
  5471. (t nil)))
  5472. (setq tlend (or te tlend) tlstart (or ts tlstart))
  5473. (when issue
  5474. ;; OK, there was some issue, add an overlay to show the issue
  5475. (setq ov (make-overlay (point-at-bol) (point-at-eol)))
  5476. (overlay-put ov 'before-string
  5477. (concat
  5478. (org-add-props
  5479. (format "%-43s" (concat " " issue))
  5480. nil
  5481. 'face face)
  5482. "\n"))
  5483. (overlay-put ov 'evaporate t)))))
  5484. (defun org-agenda-check-clock-gap (t1 t2 ok-list)
  5485. "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
  5486. (catch 'exit
  5487. (unless ok-list
  5488. ;; there are no OK times for gaps...
  5489. (throw 'exit nil))
  5490. (if (> (- (/ t2 36000) (/ t1 36000)) 24)
  5491. ;; This is more than 24 hours, so it is OK.
  5492. ;; because we have at least one OK time, that must be in the
  5493. ;; 24 hour interval.
  5494. (throw 'exit t))
  5495. ;; We have a shorter gap.
  5496. ;; Now we have to get the minute of the day when these times are
  5497. (let* ((t1dec (decode-time (seconds-to-time t1)))
  5498. (t2dec (decode-time (seconds-to-time t2)))
  5499. ;; compute the minute on the day
  5500. (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
  5501. (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
  5502. (when (< min2 min1)
  5503. ;; if min2 is smaller than min1, this means it is on the next day.
  5504. ;; Wrap it to after midnight.
  5505. (setq min2 (+ min2 1440)))
  5506. ;; Now check if any of the OK times is in the gap
  5507. (mapc (lambda (x)
  5508. ;; Wrap the time to after midnight if necessary
  5509. (if (< x min1) (setq x (+ x 1440)))
  5510. ;; Check if in interval
  5511. (and (<= min1 x) (>= min2 x) (throw 'exit t)))
  5512. ok-list)
  5513. ;; Nope, this gap is not OK
  5514. nil)))
  5515. (defun org-agenda-get-deadlines (&optional with-hour)
  5516. "Return the deadline information for agenda display.
  5517. When WITH-HOUR is non-nil, only return deadlines with an hour
  5518. specification like [h]h:mm."
  5519. (let* ((props (list 'mouse-face 'highlight
  5520. 'org-not-done-regexp org-not-done-regexp
  5521. 'org-todo-regexp org-todo-regexp
  5522. 'org-complex-heading-regexp org-complex-heading-regexp
  5523. 'help-echo
  5524. (format "mouse-2 or RET jump to org file %s"
  5525. (abbreviate-file-name buffer-file-name))))
  5526. (regexp (if with-hour
  5527. org-deadline-time-hour-regexp
  5528. org-deadline-time-regexp))
  5529. (todayp (org-agenda-todayp date)) ; DATE bound by calendar
  5530. (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
  5531. (dl0 (car org-agenda-deadline-leaders))
  5532. (dl1 (nth 1 org-agenda-deadline-leaders))
  5533. (dl2 (or (nth 2 org-agenda-deadline-leaders) dl1))
  5534. d2 diff dfrac wdays pos pos1 category category-pos level
  5535. tags suppress-prewarning ee txt head face s todo-state
  5536. show-all upcomingp donep timestr warntime inherited-tags ts-date)
  5537. (goto-char (point-min))
  5538. (while (re-search-forward regexp nil t)
  5539. (catch :skip
  5540. (org-agenda-skip)
  5541. (setq s (match-string 1)
  5542. txt nil
  5543. pos (1- (match-beginning 1))
  5544. todo-state (save-match-data (org-get-todo-state))
  5545. show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  5546. (member todo-state
  5547. org-agenda-repeating-timestamp-show-all))
  5548. d2 (org-time-string-to-absolute
  5549. s d1 'past show-all (current-buffer) pos)
  5550. diff (- d2 d1))
  5551. (setq suppress-prewarning
  5552. (let ((ds (and org-agenda-skip-deadline-prewarning-if-scheduled
  5553. (let ((item (buffer-substring (point-at-bol)
  5554. (point-at-eol))))
  5555. (save-match-data
  5556. (and (string-match
  5557. org-scheduled-time-regexp item)
  5558. (match-string 1 item)))))))
  5559. (cond
  5560. ((not ds) nil)
  5561. ;; The current item has a scheduled date (in ds), so
  5562. ;; evaluate its prewarning lead time.
  5563. ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
  5564. ;; Use global prewarning-restart lead time.
  5565. org-agenda-skip-deadline-prewarning-if-scheduled)
  5566. ((eq org-agenda-skip-deadline-prewarning-if-scheduled
  5567. 'pre-scheduled)
  5568. ;; Set prewarning to no earlier than scheduled.
  5569. (min (- d2 (org-time-string-to-absolute
  5570. ds d1 'past show-all (current-buffer) pos))
  5571. org-deadline-warning-days))
  5572. ;; Set prewarning to deadline.
  5573. (t 0))))
  5574. (setq wdays (if suppress-prewarning
  5575. (let ((org-deadline-warning-days suppress-prewarning))
  5576. (org-get-wdays s))
  5577. (org-get-wdays s))
  5578. dfrac (- 1 (/ (* 1.0 diff) (max wdays 1)))
  5579. upcomingp (and todayp (> diff 0)))
  5580. ;; When to show a deadline in the calendar:
  5581. ;; If the expiration is within wdays warning time.
  5582. ;; Past-due deadlines are only shown on the current date
  5583. (if (and (or (and (<= diff wdays)
  5584. (and todayp (not org-agenda-only-exact-dates)))
  5585. (= diff 0)))
  5586. (save-excursion
  5587. ;; (setq todo-state (org-get-todo-state))
  5588. (setq donep (member todo-state org-done-keywords))
  5589. (if (and donep
  5590. (or org-agenda-skip-deadline-if-done
  5591. (not (= diff 0))))
  5592. (setq txt nil)
  5593. (setq category (org-get-category)
  5594. warntime (get-text-property (point) 'org-appt-warntime)
  5595. category-pos (get-text-property (point) 'org-category-position))
  5596. (if (not (re-search-backward "^\\*+[ \t]+" nil t))
  5597. (throw :skip nil)
  5598. (goto-char (match-end 0))
  5599. (setq pos1 (match-beginning 0))
  5600. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  5601. (setq inherited-tags
  5602. (or (eq org-agenda-show-inherited-tags 'always)
  5603. (and (listp org-agenda-show-inherited-tags)
  5604. (memq 'agenda org-agenda-show-inherited-tags))
  5605. (and (eq org-agenda-show-inherited-tags t)
  5606. (or (eq org-agenda-use-tag-inheritance t)
  5607. (memq 'agenda org-agenda-use-tag-inheritance))))
  5608. tags (org-get-tags-at pos1 (not inherited-tags)))
  5609. (setq head (buffer-substring
  5610. (point)
  5611. (progn (skip-chars-forward "^\r\n")
  5612. (point))))
  5613. (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5614. (setq timestr
  5615. (concat (substring s (match-beginning 1)) " "))
  5616. (setq timestr 'time))
  5617. (setq txt (org-agenda-format-item
  5618. (cond ((= diff 0) dl0)
  5619. ((> diff 0)
  5620. (if (functionp dl1)
  5621. (funcall dl1 diff date)
  5622. (format dl1 diff)))
  5623. (t
  5624. (if (functionp dl2)
  5625. (funcall dl2 diff date)
  5626. (format dl2 (if (string= dl2 dl1)
  5627. diff (abs diff))))))
  5628. head level category tags
  5629. (if (not (= diff 0)) nil timestr)))))
  5630. (when txt
  5631. (setq face (org-agenda-deadline-face dfrac))
  5632. (org-add-props txt props
  5633. 'org-marker (org-agenda-new-marker pos)
  5634. 'warntime warntime
  5635. 'level level
  5636. 'ts-date d2
  5637. 'org-hd-marker (org-agenda-new-marker pos1)
  5638. 'priority (+ (- diff)
  5639. (org-get-priority txt))
  5640. 'org-category category
  5641. 'org-category-position category-pos
  5642. 'todo-state todo-state
  5643. 'type (if upcomingp "upcoming-deadline" "deadline")
  5644. 'date (if upcomingp date d2)
  5645. 'face (if donep 'org-agenda-done face)
  5646. 'undone-face face 'done-face 'org-agenda-done)
  5647. (push txt ee))))))
  5648. (nreverse ee)))
  5649. (defun org-agenda-deadline-face (fraction)
  5650. "Return the face to displaying a deadline item.
  5651. FRACTION is what fraction of the head-warning time has passed."
  5652. (let ((faces org-agenda-deadline-faces) f)
  5653. (catch 'exit
  5654. (while (setq f (pop faces))
  5655. (if (>= fraction (car f)) (throw 'exit (cdr f)))))))
  5656. (defun org-agenda-get-scheduled (&optional deadline-results with-hour)
  5657. "Return the scheduled information for agenda display.
  5658. When WITH-HOUR is non-nil, only return scheduled items with
  5659. an hour specification like [h]h:mm."
  5660. (let* ((props (list 'org-not-done-regexp org-not-done-regexp
  5661. 'org-todo-regexp org-todo-regexp
  5662. 'org-complex-heading-regexp org-complex-heading-regexp
  5663. 'done-face 'org-agenda-done
  5664. 'mouse-face 'highlight
  5665. 'help-echo
  5666. (format "mouse-2 or RET jump to org file %s"
  5667. (abbreviate-file-name buffer-file-name))))
  5668. (regexp (if with-hour
  5669. org-scheduled-time-hour-regexp
  5670. org-scheduled-time-regexp))
  5671. (todayp (org-agenda-todayp date)) ; DATE bound by calendar
  5672. (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
  5673. mm
  5674. (deadline-position-alist
  5675. (mapcar (lambda (a) (and (setq mm (get-text-property
  5676. 0 'org-hd-marker a))
  5677. (cons (marker-position mm) a)))
  5678. deadline-results))
  5679. d2 diff pos pos1 category category-pos level tags donep
  5680. ee txt head pastschedp todo-state face timestr s habitp show-all
  5681. did-habit-check-p warntime inherited-tags ts-date suppress-delay
  5682. ddays)
  5683. (goto-char (point-min))
  5684. (while (re-search-forward regexp nil t)
  5685. (catch :skip
  5686. (org-agenda-skip)
  5687. (setq s (match-string 1)
  5688. txt nil
  5689. pos (1- (match-beginning 1))
  5690. todo-state (save-match-data (org-get-todo-state))
  5691. show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  5692. (member todo-state
  5693. org-agenda-repeating-timestamp-show-all))
  5694. d2 (org-time-string-to-absolute
  5695. s d1 'past show-all (current-buffer) pos)
  5696. diff (- d2 d1)
  5697. warntime (get-text-property (point) 'org-appt-warntime))
  5698. (setq pastschedp (and todayp (< diff 0)))
  5699. (setq did-habit-check-p nil)
  5700. (setq suppress-delay
  5701. (let ((ds (and org-agenda-skip-scheduled-delay-if-deadline
  5702. (let ((item (buffer-substring (point-at-bol) (point-at-eol))))
  5703. (save-match-data
  5704. (and (string-match
  5705. org-deadline-time-regexp item)
  5706. (match-string 1 item)))))))
  5707. (cond
  5708. ((not ds) nil)
  5709. ;; The current item has a deadline date (in ds), so
  5710. ;; evaluate its delay time.
  5711. ((integerp org-agenda-skip-scheduled-delay-if-deadline)
  5712. ;; Use global delay time.
  5713. (- org-agenda-skip-scheduled-delay-if-deadline))
  5714. ((eq org-agenda-skip-scheduled-delay-if-deadline
  5715. 'post-deadline)
  5716. ;; Set delay to no later than deadline.
  5717. (min (- d2 (org-time-string-to-absolute
  5718. ds d1 'past show-all (current-buffer) pos))
  5719. org-scheduled-delay-days))
  5720. (t 0))))
  5721. (setq ddays (if suppress-delay
  5722. (let ((org-scheduled-delay-days suppress-delay))
  5723. (org-get-wdays s t t))
  5724. (org-get-wdays s t)))
  5725. ;; Use a delay of 0 when there is a repeater and the delay is
  5726. ;; of the form --3d
  5727. (when (and (save-match-data (string-match "--[0-9]+[hdwmy]" s))
  5728. (< (org-time-string-to-absolute s)
  5729. (org-time-string-to-absolute
  5730. s d2 'past nil (current-buffer) pos)))
  5731. (setq ddays 0))
  5732. ;; When to show a scheduled item in the calendar:
  5733. ;; If it is on or past the date.
  5734. (when (or (and (> ddays 0) (= diff (- ddays)))
  5735. (and (zerop ddays) (= diff 0))
  5736. (and (< (+ diff ddays) 0)
  5737. (< (abs diff) org-scheduled-past-days)
  5738. (and todayp (not org-agenda-only-exact-dates)))
  5739. ;; org-is-habit-p uses org-entry-get, which is expansive
  5740. ;; so we go extra mile to only call it once
  5741. (and todayp
  5742. (boundp 'org-habit-show-all-today)
  5743. org-habit-show-all-today
  5744. (setq did-habit-check-p t)
  5745. (setq habitp (and (functionp 'org-is-habit-p)
  5746. (org-is-habit-p)))))
  5747. (save-excursion
  5748. (setq donep (member todo-state org-done-keywords))
  5749. (if (and donep
  5750. (or org-agenda-skip-scheduled-if-done
  5751. (not (= diff 0))
  5752. (and (functionp 'org-is-habit-p)
  5753. (org-is-habit-p))))
  5754. (setq txt nil)
  5755. (setq habitp (if did-habit-check-p habitp
  5756. (and (functionp 'org-is-habit-p)
  5757. (org-is-habit-p))))
  5758. (setq category (org-get-category)
  5759. category-pos (get-text-property (point) 'org-category-position))
  5760. (if (and (eq org-agenda-skip-scheduled-if-deadline-is-shown
  5761. 'repeated-after-deadline)
  5762. (<= 0 (- d2 (time-to-days (org-get-deadline-time (point))))))
  5763. (throw :skip nil))
  5764. (if (not (re-search-backward "^\\*+[ \t]+" nil t))
  5765. (throw :skip nil)
  5766. (goto-char (match-end 0))
  5767. (setq pos1 (match-beginning 0))
  5768. (if habitp
  5769. (if (or (not org-habit-show-habits)
  5770. (and (not todayp)
  5771. (boundp 'org-habit-show-habits-only-for-today)
  5772. org-habit-show-habits-only-for-today))
  5773. (throw :skip nil))
  5774. (if (and
  5775. (or (eq t org-agenda-skip-scheduled-if-deadline-is-shown)
  5776. (and (eq org-agenda-skip-scheduled-if-deadline-is-shown 'not-today)
  5777. pastschedp))
  5778. (setq mm (assoc pos1 deadline-position-alist)))
  5779. (throw :skip nil)))
  5780. (setq inherited-tags
  5781. (or (eq org-agenda-show-inherited-tags 'always)
  5782. (and (listp org-agenda-show-inherited-tags)
  5783. (memq 'agenda org-agenda-show-inherited-tags))
  5784. (and (eq org-agenda-show-inherited-tags t)
  5785. (or (eq org-agenda-use-tag-inheritance t)
  5786. (memq 'agenda org-agenda-use-tag-inheritance))))
  5787. tags (org-get-tags-at nil (not inherited-tags)))
  5788. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  5789. (setq head (buffer-substring
  5790. (point)
  5791. (progn (skip-chars-forward "^\r\n") (point))))
  5792. (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5793. (setq timestr
  5794. (concat (substring s (match-beginning 1)) " "))
  5795. (setq timestr 'time))
  5796. (setq txt (org-agenda-format-item
  5797. (if (= diff 0)
  5798. (car org-agenda-scheduled-leaders)
  5799. (format (nth 1 org-agenda-scheduled-leaders)
  5800. (- 1 diff)))
  5801. head level category tags
  5802. (if (not (= diff 0)) nil timestr)
  5803. nil habitp))))
  5804. (when txt
  5805. (setq face
  5806. (cond
  5807. ((and (not habitp) pastschedp)
  5808. 'org-scheduled-previously)
  5809. (todayp 'org-scheduled-today)
  5810. (t 'org-scheduled))
  5811. habitp (and habitp (org-habit-parse-todo)))
  5812. (org-add-props txt props
  5813. 'undone-face face
  5814. 'face (if donep 'org-agenda-done face)
  5815. 'org-marker (org-agenda-new-marker pos)
  5816. 'org-hd-marker (org-agenda-new-marker pos1)
  5817. 'type (if pastschedp "past-scheduled" "scheduled")
  5818. 'date (if pastschedp d2 date)
  5819. 'ts-date d2
  5820. 'warntime warntime
  5821. 'level level
  5822. 'priority (if habitp
  5823. (org-habit-get-priority habitp)
  5824. (+ 94 (- 5 diff) (org-get-priority txt)))
  5825. 'org-category category
  5826. 'category-position category-pos
  5827. 'org-habit-p habitp
  5828. 'todo-state todo-state)
  5829. (push txt ee))))))
  5830. (nreverse ee)))
  5831. (defun org-agenda-get-blocks ()
  5832. "Return the date-range information for agenda display."
  5833. (let* ((props (list 'face nil
  5834. 'org-not-done-regexp org-not-done-regexp
  5835. 'org-todo-regexp org-todo-regexp
  5836. 'org-complex-heading-regexp org-complex-heading-regexp
  5837. 'mouse-face 'highlight
  5838. 'help-echo
  5839. (format "mouse-2 or RET jump to org file %s"
  5840. (abbreviate-file-name buffer-file-name))))
  5841. (regexp org-tr-regexp)
  5842. (d0 (calendar-absolute-from-gregorian date))
  5843. marker hdmarker ee txt d1 d2 s1 s2 category category-pos
  5844. level todo-state tags pos head donep inherited-tags)
  5845. (goto-char (point-min))
  5846. (while (re-search-forward regexp nil t)
  5847. (catch :skip
  5848. (org-agenda-skip)
  5849. (setq pos (point))
  5850. (let ((start-time (match-string 1))
  5851. (end-time (match-string 2)))
  5852. (setq s1 (match-string 1)
  5853. s2 (match-string 2)
  5854. d1 (time-to-days (org-time-string-to-time s1 (current-buffer) pos))
  5855. d2 (time-to-days (org-time-string-to-time s2 (current-buffer) pos)))
  5856. (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
  5857. ;; Only allow days between the limits, because the normal
  5858. ;; date stamps will catch the limits.
  5859. (save-excursion
  5860. (setq todo-state (org-get-todo-state))
  5861. (setq donep (member todo-state org-done-keywords))
  5862. (if (and donep org-agenda-skip-timestamp-if-done)
  5863. (throw :skip t))
  5864. (setq marker (org-agenda-new-marker (point)))
  5865. (setq category (org-get-category)
  5866. category-pos (get-text-property (point) 'org-category-position))
  5867. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5868. (throw :skip nil)
  5869. (goto-char (match-beginning 0))
  5870. (setq hdmarker (org-agenda-new-marker (point))
  5871. inherited-tags
  5872. (or (eq org-agenda-show-inherited-tags 'always)
  5873. (and (listp org-agenda-show-inherited-tags)
  5874. (memq 'agenda org-agenda-show-inherited-tags))
  5875. (and (eq org-agenda-show-inherited-tags t)
  5876. (or (eq org-agenda-use-tag-inheritance t)
  5877. (memq 'agenda org-agenda-use-tag-inheritance))))
  5878. tags (org-get-tags-at nil (not inherited-tags)))
  5879. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  5880. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5881. (setq head (match-string 1))
  5882. (let ((remove-re
  5883. (if org-agenda-remove-timeranges-from-blocks
  5884. (concat
  5885. "<" (regexp-quote s1) ".*?>"
  5886. "--"
  5887. "<" (regexp-quote s2) ".*?>")
  5888. nil)))
  5889. (setq txt (org-agenda-format-item
  5890. (format
  5891. (nth (if (= d1 d2) 0 1)
  5892. org-agenda-timerange-leaders)
  5893. (1+ (- d0 d1)) (1+ (- d2 d1)))
  5894. head level category tags
  5895. (cond ((and (= d1 d0) (= d2 d0))
  5896. (concat "<" start-time ">--<" end-time ">"))
  5897. ((= d1 d0)
  5898. (concat "<" start-time ">"))
  5899. ((= d2 d0)
  5900. (concat "<" end-time ">")))
  5901. remove-re))))
  5902. (org-add-props txt props
  5903. 'org-marker marker 'org-hd-marker hdmarker
  5904. 'type "block" 'date date
  5905. 'level level
  5906. 'todo-state todo-state
  5907. 'priority (org-get-priority txt) 'org-category category
  5908. 'org-category-position category-pos)
  5909. (push txt ee))))
  5910. (goto-char pos)))
  5911. ;; Sort the entries by expiration date.
  5912. (nreverse ee)))
  5913. ;;; Agenda presentation and sorting
  5914. (defvar org-prefix-has-time nil
  5915. "A flag, set by `org-compile-prefix-format'.
  5916. The flag is set if the currently compiled format contains a `%t'.")
  5917. (defvar org-prefix-has-tag nil
  5918. "A flag, set by `org-compile-prefix-format'.
  5919. The flag is set if the currently compiled format contains a `%T'.")
  5920. (defvar org-prefix-has-effort nil
  5921. "A flag, set by `org-compile-prefix-format'.
  5922. The flag is set if the currently compiled format contains a `%e'.")
  5923. (defvar org-prefix-has-breadcrumbs nil
  5924. "A flag, set by `org-compile-prefix-format'.
  5925. The flag is set if the currently compiled format contains a `%b'.")
  5926. (defvar org-prefix-category-length nil
  5927. "Used by `org-compile-prefix-format' to remember the category field width.")
  5928. (defvar org-prefix-category-max-length nil
  5929. "Used by `org-compile-prefix-format' to remember the category field width.")
  5930. (defun org-agenda-get-category-icon (category)
  5931. "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
  5932. (dolist (entry org-agenda-category-icon-alist)
  5933. (when (org-string-match-p (car entry) category)
  5934. (if (listp (cadr entry))
  5935. (return (cadr entry))
  5936. (return (apply 'create-image (cdr entry)))))))
  5937. (defun org-agenda-format-item (extra txt &optional level category tags dotime
  5938. remove-re habitp)
  5939. "Format TXT to be inserted into the agenda buffer.
  5940. In particular, add the prefix and corresponding text properties.
  5941. EXTRA must be a string to replace the `%s' specifier in the prefix format.
  5942. LEVEL may be a string to replace the `%l' specifier.
  5943. CATEGORY (a string, a symbol or nil) may be used to overrule the default
  5944. category taken from local variable or file name. It will replace the `%c'
  5945. specifier in the format.
  5946. DOTIME, when non-nil, indicates that a time-of-day should be extracted from
  5947. TXT for sorting of this entry, and for the `%t' specifier in the format.
  5948. When DOTIME is a string, this string is searched for a time before TXT is.
  5949. TAGS can be the tags of the headline.
  5950. Any match of REMOVE-RE will be removed from TXT."
  5951. ;; We keep the org-prefix-* variable values along with a compiled
  5952. ;; formatter, so that multiple agendas existing at the same time do
  5953. ;; not step on each other toes.
  5954. ;;
  5955. ;; It was inconvenient to make these variables buffer local in
  5956. ;; Agenda buffers, because this function expects to be called with
  5957. ;; the buffer where item comes from being current, and not agenda
  5958. ;; buffer
  5959. (let* ((bindings (car org-prefix-format-compiled))
  5960. (formatter (cadr org-prefix-format-compiled)))
  5961. (loop for (var value) in bindings
  5962. do (set var value))
  5963. (save-match-data
  5964. ;; Diary entries sometimes have extra whitespace at the beginning
  5965. (setq txt (org-trim txt))
  5966. ;; Fix the tags part in txt
  5967. (setq txt (org-agenda-fix-displayed-tags
  5968. txt tags
  5969. org-agenda-show-inherited-tags
  5970. org-agenda-hide-tags-regexp))
  5971. (let* ((category (or category
  5972. (if (stringp org-category)
  5973. org-category
  5974. (and org-category (symbol-name org-category)))
  5975. (if buffer-file-name
  5976. (file-name-sans-extension
  5977. (file-name-nondirectory buffer-file-name))
  5978. "")))
  5979. (category-icon (org-agenda-get-category-icon category))
  5980. (category-icon (if category-icon
  5981. (propertize " " 'display category-icon)
  5982. ""))
  5983. ;; time, tag, effort are needed for the eval of the prefix format
  5984. (tag (if tags (nth (1- (length tags)) tags) ""))
  5985. time effort neffort
  5986. (ts (if dotime (concat
  5987. (if (stringp dotime) dotime "")
  5988. (and org-agenda-search-headline-for-time txt))))
  5989. (time-of-day (and dotime (org-get-time-of-day ts)))
  5990. stamp plain s0 s1 s2 rtn srp l
  5991. duration thecategory breadcrumbs)
  5992. (and (derived-mode-p 'org-mode) buffer-file-name
  5993. (add-to-list 'org-agenda-contributing-files buffer-file-name))
  5994. (when (and dotime time-of-day)
  5995. ;; Extract starting and ending time and move them to prefix
  5996. (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
  5997. (setq plain (string-match org-plain-time-of-day-regexp ts)))
  5998. (setq s0 (match-string 0 ts)
  5999. srp (and stamp (match-end 3))
  6000. s1 (match-string (if plain 1 2) ts)
  6001. s2 (match-string (if plain 8 (if srp 4 6)) ts))
  6002. ;; If the times are in TXT (not in DOTIMES), and the prefix will list
  6003. ;; them, we might want to remove them there to avoid duplication.
  6004. ;; The user can turn this off with a variable.
  6005. (if (and org-prefix-has-time
  6006. org-agenda-remove-times-when-in-prefix (or stamp plain)
  6007. (string-match (concat (regexp-quote s0) " *") txt)
  6008. (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
  6009. (if (eq org-agenda-remove-times-when-in-prefix 'beg)
  6010. (= (match-beginning 0) 0)
  6011. t))
  6012. (setq txt (replace-match "" nil nil txt))))
  6013. ;; Normalize the time(s) to 24 hour
  6014. (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
  6015. (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
  6016. ;; Try to set s2 if s1 and `org-agenda-default-appointment-duration' are set
  6017. (let (org-time-clocksum-use-effort-durations)
  6018. (when (and s1 (not s2) org-agenda-default-appointment-duration)
  6019. (setq s2
  6020. (org-minutes-to-clocksum-string
  6021. (+ (org-hh:mm-string-to-minutes s1)
  6022. org-agenda-default-appointment-duration)))))
  6023. ;; Compute the duration
  6024. (when s2
  6025. (setq duration (- (org-hh:mm-string-to-minutes s2)
  6026. (org-hh:mm-string-to-minutes s1)))))
  6027. (when (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
  6028. txt)
  6029. ;; Tags are in the string
  6030. (if (or (eq org-agenda-remove-tags t)
  6031. (and org-agenda-remove-tags
  6032. org-prefix-has-tag))
  6033. (setq txt (replace-match "" t t txt))
  6034. (setq txt (replace-match
  6035. (concat (make-string (max (- 50 (length txt)) 1) ?\ )
  6036. (match-string 2 txt))
  6037. t t txt))))
  6038. (when (derived-mode-p 'org-mode)
  6039. (setq effort (ignore-errors (get-text-property 0 'org-effort txt)))
  6040. (if effort
  6041. (setq neffort (org-duration-string-to-minutes effort)
  6042. effort (setq effort (concat "[" effort "]")))
  6043. ;; prevent erroring out with %e format when there is no effort
  6044. (setq effort "")))
  6045. (when remove-re
  6046. (while (string-match remove-re txt)
  6047. (setq txt (replace-match "" t t txt))))
  6048. ;; Set org-heading property on `txt' to mark the start of the
  6049. ;; heading.
  6050. (add-text-properties 0 (length txt) '(org-heading t) txt)
  6051. ;; Prepare the variables needed in the eval of the compiled format
  6052. (if org-prefix-has-breadcrumbs
  6053. (setq breadcrumbs (org-with-point-at (org-get-at-bol 'org-marker)
  6054. (let ((s (org-display-outline-path nil nil "->" t)))
  6055. (if (eq "" s) "" (concat s "->"))))))
  6056. (setq time (cond (s2 (concat
  6057. (org-agenda-time-of-day-to-ampm-maybe s1)
  6058. "-" (org-agenda-time-of-day-to-ampm-maybe s2)
  6059. (if org-agenda-timegrid-use-ampm " ")))
  6060. (s1 (concat
  6061. (org-agenda-time-of-day-to-ampm-maybe s1)
  6062. (if org-agenda-timegrid-use-ampm
  6063. "........ "
  6064. "......")))
  6065. (t ""))
  6066. extra (or (and (not habitp) extra) "")
  6067. category (if (symbolp category) (symbol-name category) category)
  6068. thecategory (copy-sequence category)
  6069. level (or level ""))
  6070. (if (string-match org-bracket-link-regexp category)
  6071. (progn
  6072. (setq l (if (match-end 3)
  6073. (- (match-end 3) (match-beginning 3))
  6074. (- (match-end 1) (match-beginning 1))))
  6075. (when (< l (or org-prefix-category-length 0))
  6076. (setq category (copy-sequence category))
  6077. (org-add-props category nil
  6078. 'extra-space (make-string
  6079. (- org-prefix-category-length l 1) ?\ ))))
  6080. (if (and org-prefix-category-max-length
  6081. (>= (length category) org-prefix-category-max-length))
  6082. (setq category (substring category 0 (1- org-prefix-category-max-length)))))
  6083. ;; Evaluate the compiled format
  6084. (setq rtn (concat (eval formatter) txt))
  6085. ;; And finally add the text properties
  6086. (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
  6087. (org-add-props rtn nil
  6088. 'org-category (if thecategory (downcase thecategory) category)
  6089. 'tags (mapcar 'org-downcase-keep-props tags)
  6090. 'org-highest-priority org-highest-priority
  6091. 'org-lowest-priority org-lowest-priority
  6092. 'time-of-day time-of-day
  6093. 'duration duration
  6094. 'effort effort
  6095. 'effort-minutes neffort
  6096. 'breadcrumbs breadcrumbs
  6097. 'txt txt
  6098. 'level level
  6099. 'time time
  6100. 'extra extra
  6101. 'format org-prefix-format-compiled
  6102. 'dotime dotime)))))
  6103. (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
  6104. "Remove tags string from TXT, and add a modified list of tags.
  6105. The modified list may contain inherited tags, and tags matched by
  6106. `org-agenda-hide-tags-regexp' will be removed."
  6107. (when (or add-inherited hide-re)
  6108. (if (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") txt)
  6109. (setq txt (substring txt 0 (match-beginning 0))))
  6110. (setq tags
  6111. (delq nil
  6112. (mapcar (lambda (tg)
  6113. (if (or (and hide-re (string-match hide-re tg))
  6114. (and (not add-inherited)
  6115. (get-text-property 0 'inherited tg)))
  6116. nil
  6117. tg))
  6118. tags)))
  6119. (when tags
  6120. (let ((have-i (get-text-property 0 'inherited (car tags)))
  6121. i)
  6122. (setq txt (concat txt " :"
  6123. (mapconcat
  6124. (lambda (x)
  6125. (setq i (get-text-property 0 'inherited x))
  6126. (if (and have-i (not i))
  6127. (progn
  6128. (setq have-i nil)
  6129. (concat ":" x))
  6130. x))
  6131. tags ":")
  6132. (if have-i "::" ":"))))))
  6133. txt)
  6134. (defun org-downcase-keep-props (s)
  6135. (let ((props (text-properties-at 0 s)))
  6136. (setq s (downcase s))
  6137. (add-text-properties 0 (length s) props s)
  6138. s))
  6139. (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
  6140. (defun org-agenda-add-time-grid-maybe (list ndays todayp)
  6141. "Add a time-grid for agenda items which need it.
  6142. LIST is the list of agenda items formatted by `org-agenda-list'.
  6143. NDAYS is the span of the current agenda view.
  6144. TODAYP is `t' when the current agenda view is on today."
  6145. (catch 'exit
  6146. (cond ((not org-agenda-use-time-grid) (throw 'exit list))
  6147. ((and todayp (member 'today (car org-agenda-time-grid))))
  6148. ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
  6149. ((member 'weekly (car org-agenda-time-grid)))
  6150. (t (throw 'exit list)))
  6151. (let* ((have (delq nil (mapcar
  6152. (lambda (x) (get-text-property 1 'time-of-day x))
  6153. list)))
  6154. (string (nth 1 org-agenda-time-grid))
  6155. (gridtimes (nth 2 org-agenda-time-grid))
  6156. (req (car org-agenda-time-grid))
  6157. (remove (member 'remove-match req))
  6158. new time)
  6159. (if (and (member 'require-timed req) (not have))
  6160. ;; don't show empty grid
  6161. (throw 'exit list))
  6162. (while (setq time (pop gridtimes))
  6163. (unless (and remove (member time have))
  6164. (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
  6165. (push (org-agenda-format-item
  6166. nil string nil "" nil
  6167. (concat (substring time 0 -2) ":" (substring time -2)))
  6168. new)
  6169. (put-text-property
  6170. 2 (length (car new)) 'face 'org-time-grid (car new))))
  6171. (when (and todayp org-agenda-show-current-time-in-grid)
  6172. (push (org-agenda-format-item
  6173. nil org-agenda-current-time-string nil "" nil
  6174. (format-time-string "%H:%M "))
  6175. new)
  6176. (put-text-property
  6177. 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
  6178. (if (member 'time-up org-agenda-sorting-strategy-selected)
  6179. (append new list)
  6180. (append list new)))))
  6181. (defun org-compile-prefix-format (key)
  6182. "Compile the prefix format into a Lisp form that can be evaluated.
  6183. The resulting form and associated variable bindings is returned
  6184. and stored in the variable `org-prefix-format-compiled'."
  6185. (setq org-prefix-has-time nil
  6186. org-prefix-has-tag nil
  6187. org-prefix-category-length nil
  6188. org-prefix-has-effort nil
  6189. org-prefix-has-breadcrumbs nil)
  6190. (let ((s (cond
  6191. ((stringp org-agenda-prefix-format)
  6192. org-agenda-prefix-format)
  6193. ((assq key org-agenda-prefix-format)
  6194. (cdr (assq key org-agenda-prefix-format)))
  6195. (t " %-12:c%?-12t% s")))
  6196. (start 0)
  6197. varform vars var e c f opt)
  6198. (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cltseib]\\|(.+)\\)"
  6199. s start)
  6200. (setq var (or (cdr (assoc (match-string 4 s)
  6201. '(("c" . category) ("t" . time) ("l" . level) ("s" . extra)
  6202. ("i" . category-icon) ("T" . tag) ("e" . effort) ("b" . breadcrumbs))))
  6203. 'eval)
  6204. c (or (match-string 3 s) "")
  6205. opt (match-beginning 1)
  6206. start (1+ (match-beginning 0)))
  6207. (if (equal var 'time) (setq org-prefix-has-time t))
  6208. (if (equal var 'tag) (setq org-prefix-has-tag t))
  6209. (if (equal var 'effort) (setq org-prefix-has-effort t))
  6210. (if (equal var 'breadcrumbs) (setq org-prefix-has-breadcrumbs t))
  6211. (setq f (concat "%" (match-string 2 s) "s"))
  6212. (when (equal var 'category)
  6213. (setq org-prefix-category-length
  6214. (floor (abs (string-to-number (match-string 2 s)))))
  6215. (setq org-prefix-category-max-length
  6216. (let ((x (match-string 2 s)))
  6217. (save-match-data
  6218. (if (string-match "\\.[0-9]+" x)
  6219. (string-to-number (substring (match-string 0 x) 1)))))))
  6220. (if (eq var 'eval)
  6221. (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
  6222. (if opt
  6223. (setq varform
  6224. `(if (equal "" ,var)
  6225. ""
  6226. (format ,f (if (equal "" ,var) "" (concat ,var ,c)))))
  6227. (setq varform `(format ,f (if (equal ,var "") "" (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
  6228. (setq s (replace-match "%s" t nil s))
  6229. (push varform vars))
  6230. (setq vars (nreverse vars))
  6231. (with-current-buffer (or org-agenda-buffer (current-buffer))
  6232. (setq org-prefix-format-compiled
  6233. (list
  6234. `((org-prefix-has-time ,org-prefix-has-time)
  6235. (org-prefix-has-tag ,org-prefix-has-tag)
  6236. (org-prefix-category-length ,org-prefix-category-length)
  6237. (org-prefix-has-effort ,org-prefix-has-effort)
  6238. (org-prefix-has-breadcrumbs ,org-prefix-has-breadcrumbs))
  6239. `(format ,s ,@vars))))))
  6240. (defun org-set-sorting-strategy (key)
  6241. (if (symbolp (car org-agenda-sorting-strategy))
  6242. ;; the old format
  6243. (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
  6244. (setq org-agenda-sorting-strategy-selected
  6245. (or (cdr (assq key org-agenda-sorting-strategy))
  6246. (cdr (assq 'agenda org-agenda-sorting-strategy))
  6247. '(time-up category-keep priority-down)))))
  6248. (defun org-get-time-of-day (s &optional string mod24)
  6249. "Check string S for a time of day.
  6250. If found, return it as a military time number between 0 and 2400.
  6251. If not found, return nil.
  6252. The optional STRING argument forces conversion into a 5 character wide string
  6253. HH:MM."
  6254. (save-match-data
  6255. (when
  6256. (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
  6257. (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
  6258. (let* ((h (string-to-number (match-string 1 s)))
  6259. (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
  6260. (ampm (if (match-end 4) (downcase (match-string 4 s))))
  6261. (am-p (equal ampm "am"))
  6262. (h1 (cond ((not ampm) h)
  6263. ((= h 12) (if am-p 0 12))
  6264. (t (+ h (if am-p 0 12)))))
  6265. (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
  6266. (mod h1 24) h1))
  6267. (t0 (+ (* 100 h2) m))
  6268. (t1 (concat (if (>= h1 24) "+" " ")
  6269. (if (and org-agenda-time-leading-zero
  6270. (< t0 1000)) "0" "")
  6271. (if (< t0 100) "0" "")
  6272. (if (< t0 10) "0" "")
  6273. (int-to-string t0))))
  6274. (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
  6275. (defvar org-agenda-before-sorting-filter-function nil
  6276. "Function to be applied to agenda items prior to sorting.
  6277. Prior to sorting also means just before they are inserted into the agenda.
  6278. To aid sorting, you may revisit the original entries and add more text
  6279. properties which will later be used by the sorting functions.
  6280. The function should take a string argument, an agenda line.
  6281. It has access to the text properties in that line, which contain among
  6282. other things, the property `org-hd-marker' that points to the entry
  6283. where the line comes from. Note that not all lines going into the agenda
  6284. have this property, only most.
  6285. The function should return the modified string. It is probably best
  6286. to ONLY change text properties.
  6287. You can also use this function as a filter, by returning nil for lines
  6288. you don't want to have in the agenda at all. For this application, you
  6289. could bind the variable in the options section of a custom command.")
  6290. (defun org-agenda-finalize-entries (list &optional type)
  6291. "Sort, limit and concatenate the LIST of agenda items.
  6292. The optional argument TYPE tells the agenda type."
  6293. (let ((max-effort (cond ((listp org-agenda-max-effort)
  6294. (cdr (assoc type org-agenda-max-effort)))
  6295. (t org-agenda-max-effort)))
  6296. (max-todo (cond ((listp org-agenda-max-todos)
  6297. (cdr (assoc type org-agenda-max-todos)))
  6298. (t org-agenda-max-todos)))
  6299. (max-tags (cond ((listp org-agenda-max-tags)
  6300. (cdr (assoc type org-agenda-max-tags)))
  6301. (t org-agenda-max-tags)))
  6302. (max-entries (cond ((listp org-agenda-max-entries)
  6303. (cdr (assoc type org-agenda-max-entries)))
  6304. (t org-agenda-max-entries))) l)
  6305. (when org-agenda-before-sorting-filter-function
  6306. (setq list
  6307. (delq nil
  6308. (mapcar
  6309. org-agenda-before-sorting-filter-function list))))
  6310. (setq list (mapcar 'org-agenda-highlight-todo list)
  6311. list (mapcar 'identity (sort list 'org-entries-lessp))
  6312. list (org-agenda-limit-entries
  6313. list 'effort-minutes max-effort 'identity)
  6314. list (org-agenda-limit-entries list 'todo-state max-todo)
  6315. list (org-agenda-limit-entries list 'tags max-tags)
  6316. list (org-agenda-limit-entries list 'org-hd-marker max-entries)
  6317. list (mapconcat 'identity list "\n"))))
  6318. (defun org-agenda-limit-entries (list prop limit &optional fn)
  6319. "Limit the number of agenda entries."
  6320. (if limit
  6321. (let ((f (or fn (lambda (p) (and p 1)))) (lim 0))
  6322. (delq nil
  6323. (mapcar
  6324. (lambda (e)
  6325. (let ((pval (funcall f (get-text-property 1 prop e))))
  6326. (if pval (setq lim (+ lim pval)))
  6327. (if (or (not pval) (<= lim limit)) e)))
  6328. list)))
  6329. list))
  6330. (defun org-agenda-highlight-todo (x)
  6331. (let ((org-done-keywords org-done-keywords-for-agenda)
  6332. (case-fold-search nil)
  6333. re)
  6334. (if (eq x 'line)
  6335. (save-excursion
  6336. (beginning-of-line 1)
  6337. (setq re (org-get-at-bol 'org-todo-regexp))
  6338. (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
  6339. (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
  6340. (add-text-properties (match-beginning 0) (match-end 1)
  6341. (list 'face (org-get-todo-face 1)))
  6342. (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
  6343. (delete-region (match-beginning 1) (1- (match-end 0)))
  6344. (goto-char (match-beginning 1))
  6345. (insert (format org-agenda-todo-keyword-format s)))))
  6346. (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
  6347. (setq re (get-text-property 0 'org-todo-regexp x))
  6348. (when (and re
  6349. ;; Test `pl' because if there's no heading content,
  6350. ;; there's no point matching to highlight. Note
  6351. ;; that if we didn't test `pl' first, and there
  6352. ;; happened to be no keyword from `org-todo-regexp'
  6353. ;; on this heading line, then the `equal' comparison
  6354. ;; afterwards would spuriously succeed in the case
  6355. ;; where `pl' is nil -- causing an args-out-of-range
  6356. ;; error when we try to add text properties to text
  6357. ;; that isn't there.
  6358. pl
  6359. (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
  6360. x pl) pl))
  6361. (add-text-properties
  6362. (or (match-end 1) (match-end 0)) (match-end 0)
  6363. (list 'face (org-get-todo-face (match-string 2 x)))
  6364. x)
  6365. (when (match-end 1)
  6366. (setq x (concat (substring x 0 (match-end 1))
  6367. (format org-agenda-todo-keyword-format
  6368. (match-string 2 x))
  6369. (org-add-props " " (text-properties-at 0 x))
  6370. (substring x (match-end 3)))))))
  6371. x)))
  6372. (defsubst org-cmp-priority (a b)
  6373. "Compare the priorities of string A and B."
  6374. (let ((pa (or (get-text-property 1 'priority a) 0))
  6375. (pb (or (get-text-property 1 'priority b) 0)))
  6376. (cond ((> pa pb) +1)
  6377. ((< pa pb) -1))))
  6378. (defsubst org-cmp-effort (a b)
  6379. "Compare the effort values of string A and B."
  6380. (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
  6381. (ea (or (get-text-property 1 'effort-minutes a) def))
  6382. (eb (or (get-text-property 1 'effort-minutes b) def)))
  6383. (cond ((> ea eb) +1)
  6384. ((< ea eb) -1))))
  6385. (defsubst org-cmp-category (a b)
  6386. "Compare the string values of categories of strings A and B."
  6387. (let ((ca (or (get-text-property 1 'org-category a) ""))
  6388. (cb (or (get-text-property 1 'org-category b) "")))
  6389. (cond ((string-lessp ca cb) -1)
  6390. ((string-lessp cb ca) +1))))
  6391. (defsubst org-cmp-todo-state (a b)
  6392. "Compare the todo states of strings A and B."
  6393. (let* ((ma (or (get-text-property 1 'org-marker a)
  6394. (get-text-property 1 'org-hd-marker a)))
  6395. (mb (or (get-text-property 1 'org-marker b)
  6396. (get-text-property 1 'org-hd-marker b)))
  6397. (fa (and ma (marker-buffer ma)))
  6398. (fb (and mb (marker-buffer mb)))
  6399. (todo-kwds
  6400. (or (and fa (with-current-buffer fa org-todo-keywords-1))
  6401. (and fb (with-current-buffer fb org-todo-keywords-1))))
  6402. (ta (or (get-text-property 1 'todo-state a) ""))
  6403. (tb (or (get-text-property 1 'todo-state b) ""))
  6404. (la (- (length (member ta todo-kwds))))
  6405. (lb (- (length (member tb todo-kwds))))
  6406. (donepa (member ta org-done-keywords-for-agenda))
  6407. (donepb (member tb org-done-keywords-for-agenda)))
  6408. (cond ((and donepa (not donepb)) -1)
  6409. ((and (not donepa) donepb) +1)
  6410. ((< la lb) -1)
  6411. ((< lb la) +1))))
  6412. (defsubst org-cmp-alpha (a b)
  6413. "Compare the headlines, alphabetically."
  6414. (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
  6415. (plb (text-property-any 0 (length b) 'org-heading t b))
  6416. (ta (and pla (substring a pla)))
  6417. (tb (and plb (substring b plb))))
  6418. (when pla
  6419. (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
  6420. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
  6421. (setq ta (substring ta (match-end 0))))
  6422. (setq ta (downcase ta)))
  6423. (when plb
  6424. (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
  6425. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
  6426. (setq tb (substring tb (match-end 0))))
  6427. (setq tb (downcase tb)))
  6428. (cond ((not ta) +1)
  6429. ((not tb) -1)
  6430. ((string-lessp ta tb) -1)
  6431. ((string-lessp tb ta) +1))))
  6432. (defsubst org-cmp-tag (a b)
  6433. "Compare the string values of the first tags of A and B."
  6434. (let ((ta (car (last (get-text-property 1 'tags a))))
  6435. (tb (car (last (get-text-property 1 'tags b)))))
  6436. (cond ((not ta) +1)
  6437. ((not tb) -1)
  6438. ((string-lessp ta tb) -1)
  6439. ((string-lessp tb ta) +1))))
  6440. (defsubst org-cmp-time (a b)
  6441. "Compare the time-of-day values of strings A and B."
  6442. (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
  6443. (ta (or (get-text-property 1 'time-of-day a) def))
  6444. (tb (or (get-text-property 1 'time-of-day b) def)))
  6445. (cond ((< ta tb) -1)
  6446. ((< tb ta) +1))))
  6447. (defsubst org-cmp-ts (a b &optional type)
  6448. "Compare the timestamps values of entries A and B.
  6449. When TYPE is \"scheduled\", \"deadline\", \"timestamp\"
  6450. or \"timestamp_ia\", compare within each of these type.
  6451. When TYPE is the empty string, compare all timestamps
  6452. without respect of their type."
  6453. (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
  6454. (ta (or (and (string-match type (get-text-property 1 'type a))
  6455. (get-text-property 1 'ts-date a)) def))
  6456. (tb (or (and (string-match type (get-text-property 1 'type b))
  6457. (get-text-property 1 'ts-date b)) def)))
  6458. (cond ((< ta tb) -1)
  6459. ((< tb ta) +1))))
  6460. (defsubst org-cmp-habit-p (a b)
  6461. "Compare the todo states of strings A and B."
  6462. (let ((ha (get-text-property 1 'org-habit-p a))
  6463. (hb (get-text-property 1 'org-habit-p b)))
  6464. (cond ((and ha (not hb)) -1)
  6465. ((and (not ha) hb) +1))))
  6466. (defun org-entries-lessp (a b)
  6467. "Predicate for sorting agenda entries."
  6468. ;; The following variables will be used when the form is evaluated.
  6469. ;; So even though the compiler complains, keep them.
  6470. (let* ((ss org-agenda-sorting-strategy-selected)
  6471. (timestamp-up (and (org-em 'timestamp-up 'timestamp-down ss)
  6472. (org-cmp-ts a b "")))
  6473. (timestamp-down (if timestamp-up (- timestamp-up) nil))
  6474. (scheduled-up (and (org-em 'scheduled-up 'scheduled-down ss)
  6475. (org-cmp-ts a b "scheduled")))
  6476. (scheduled-down (if scheduled-up (- scheduled-up) nil))
  6477. (deadline-up (and (org-em 'deadline-up 'deadline-down ss)
  6478. (org-cmp-ts a b "deadline")))
  6479. (deadline-down (if deadline-up (- deadline-up) nil))
  6480. (tsia-up (and (org-em 'tsia-up 'tsia-down ss)
  6481. (org-cmp-ts a b "iatimestamp_ia")))
  6482. (tsia-down (if tsia-up (- tsia-up) nil))
  6483. (ts-up (and (org-em 'ts-up 'ts-down ss)
  6484. (org-cmp-ts a b "timestamp")))
  6485. (ts-down (if ts-up (- ts-up) nil))
  6486. (time-up (and (org-em 'time-up 'time-down ss)
  6487. (org-cmp-time a b)))
  6488. (time-down (if time-up (- time-up) nil))
  6489. (priority-up (and (org-em 'priority-up 'priority-down ss)
  6490. (org-cmp-priority a b)))
  6491. (priority-down (if priority-up (- priority-up) nil))
  6492. (effort-up (and (org-em 'effort-up 'effort-down ss)
  6493. (org-cmp-effort a b)))
  6494. (effort-down (if effort-up (- effort-up) nil))
  6495. (category-up (and (or (org-em 'category-up 'category-down ss)
  6496. (memq 'category-keep ss))
  6497. (org-cmp-category a b)))
  6498. (category-down (if category-up (- category-up) nil))
  6499. (category-keep (if category-up +1 nil))
  6500. (tag-up (and (org-em 'tag-up 'tag-down ss)
  6501. (org-cmp-tag a b)))
  6502. (tag-down (if tag-up (- tag-up) nil))
  6503. (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
  6504. (org-cmp-todo-state a b)))
  6505. (todo-state-down (if todo-state-up (- todo-state-up) nil))
  6506. (habit-up (and (org-em 'habit-up 'habit-down ss)
  6507. (org-cmp-habit-p a b)))
  6508. (habit-down (if habit-up (- habit-up) nil))
  6509. (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
  6510. (org-cmp-alpha a b)))
  6511. (alpha-down (if alpha-up (- alpha-up) nil))
  6512. (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
  6513. user-defined-up user-defined-down)
  6514. (if (and need-user-cmp org-agenda-cmp-user-defined
  6515. (functionp org-agenda-cmp-user-defined))
  6516. (setq user-defined-up
  6517. (funcall org-agenda-cmp-user-defined a b)
  6518. user-defined-down (if user-defined-up (- user-defined-up) nil)))
  6519. (cdr (assoc
  6520. (eval (cons 'or org-agenda-sorting-strategy-selected))
  6521. '((-1 . t) (1 . nil) (nil . nil))))))
  6522. ;;; Agenda restriction lock
  6523. (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
  6524. "Overlay to mark the headline to which agenda commands are restricted.")
  6525. (overlay-put org-agenda-restriction-lock-overlay
  6526. 'face 'org-agenda-restriction-lock)
  6527. (overlay-put org-agenda-restriction-lock-overlay
  6528. 'help-echo "Agendas are currently limited to this subtree.")
  6529. (org-detach-overlay org-agenda-restriction-lock-overlay)
  6530. (defun org-agenda-set-restriction-lock (&optional type)
  6531. "Set restriction lock for agenda, to current subtree or file.
  6532. Restriction will be the file if TYPE is `file', or if type is the
  6533. universal prefix '(4), or if the cursor is before the first headline
  6534. in the file. Otherwise, restriction will be to the current subtree."
  6535. (interactive "P")
  6536. (and (equal type '(4)) (setq type 'file))
  6537. (setq type (cond
  6538. (type type)
  6539. ((org-at-heading-p) 'subtree)
  6540. ((condition-case nil (org-back-to-heading t) (error nil))
  6541. 'subtree)
  6542. (t 'file)))
  6543. (if (eq type 'subtree)
  6544. (progn
  6545. (setq org-agenda-restrict t)
  6546. (setq org-agenda-overriding-restriction 'subtree)
  6547. (put 'org-agenda-files 'org-restrict
  6548. (list (buffer-file-name (buffer-base-buffer))))
  6549. (org-back-to-heading t)
  6550. (move-overlay org-agenda-restriction-lock-overlay
  6551. (point) (save-excursion (org-end-of-subtree t t) (point)))
  6552. (move-marker org-agenda-restrict-begin (point))
  6553. (move-marker org-agenda-restrict-end
  6554. (save-excursion (org-end-of-subtree t t)))
  6555. (message "Locking agenda restriction to subtree"))
  6556. (put 'org-agenda-files 'org-restrict
  6557. (list (buffer-file-name (buffer-base-buffer))))
  6558. (setq org-agenda-restrict nil)
  6559. (setq org-agenda-overriding-restriction 'file)
  6560. (move-marker org-agenda-restrict-begin nil)
  6561. (move-marker org-agenda-restrict-end nil)
  6562. (message "Locking agenda restriction to file"))
  6563. (setq current-prefix-arg nil)
  6564. (org-agenda-maybe-redo))
  6565. (defun org-agenda-remove-restriction-lock (&optional noupdate)
  6566. "Remove the agenda restriction lock."
  6567. (interactive "P")
  6568. (org-detach-overlay org-agenda-restriction-lock-overlay)
  6569. (org-detach-overlay org-speedbar-restriction-lock-overlay)
  6570. (setq org-agenda-overriding-restriction nil)
  6571. (setq org-agenda-restrict nil)
  6572. (put 'org-agenda-files 'org-restrict nil)
  6573. (move-marker org-agenda-restrict-begin nil)
  6574. (move-marker org-agenda-restrict-end nil)
  6575. (setq current-prefix-arg nil)
  6576. (message "Agenda restriction lock removed")
  6577. (or noupdate (org-agenda-maybe-redo)))
  6578. (defun org-agenda-maybe-redo ()
  6579. "If there is any window showing the agenda view, update it."
  6580. (let ((w (get-buffer-window org-agenda-buffer-name t))
  6581. (w0 (selected-window)))
  6582. (when w
  6583. (select-window w)
  6584. (org-agenda-redo)
  6585. (select-window w0)
  6586. (if org-agenda-overriding-restriction
  6587. (message "Agenda view shifted to new %s restriction"
  6588. org-agenda-overriding-restriction)
  6589. (message "Agenda restriction lock removed")))))
  6590. ;;; Agenda commands
  6591. (defun org-agenda-check-type (error &rest types)
  6592. "Check if agenda buffer is of allowed type.
  6593. If ERROR is non-nil, throw an error, otherwise just return nil.
  6594. Allowed types are 'agenda 'timeline 'todo 'tags 'search."
  6595. (if (not org-agenda-type)
  6596. (error "No Org agenda currently displayed")
  6597. (if (memq org-agenda-type types)
  6598. t
  6599. (if error
  6600. (error "Not allowed in %s-type agenda buffers" org-agenda-type)
  6601. nil))))
  6602. (defun org-agenda-Quit ()
  6603. "Exit the agenda and kill buffers loaded by `org-agenda'.
  6604. Also restore the window configuration."
  6605. (interactive)
  6606. (if org-agenda-columns-active
  6607. (org-columns-quit)
  6608. (let ((buf (current-buffer)))
  6609. (if (eq org-agenda-window-setup 'other-frame)
  6610. (progn
  6611. (org-agenda-reset-markers)
  6612. (kill-buffer buf)
  6613. (org-columns-remove-overlays)
  6614. (setq org-agenda-archives-mode nil)
  6615. (delete-frame))
  6616. (and (not (eq org-agenda-window-setup 'current-window))
  6617. (not (one-window-p))
  6618. (delete-window))
  6619. (org-agenda-reset-markers)
  6620. (kill-buffer buf)
  6621. (org-columns-remove-overlays)
  6622. (setq org-agenda-archives-mode nil)))
  6623. ;; Maybe restore the pre-agenda window configuration.
  6624. (and org-agenda-restore-windows-after-quit
  6625. (not (eq org-agenda-window-setup 'other-frame))
  6626. org-agenda-pre-window-conf
  6627. (set-window-configuration org-agenda-pre-window-conf)
  6628. (setq org-agenda-pre-window-conf nil))))
  6629. (defun org-agenda-quit ()
  6630. "Exit the agenda and restore the window configuration.
  6631. When `org-agenda-sticky' is non-nil, only bury the agenda."
  6632. (interactive)
  6633. (if (and (eq org-indirect-buffer-display 'other-window)
  6634. org-last-indirect-buffer)
  6635. (let ((org-last-indirect-window
  6636. (get-buffer-window org-last-indirect-buffer)))
  6637. (if org-last-indirect-window
  6638. (delete-window org-last-indirect-window))))
  6639. (if org-agenda-columns-active
  6640. (org-columns-quit)
  6641. (if org-agenda-sticky
  6642. (let ((buf (current-buffer)))
  6643. (if (eq org-agenda-window-setup 'other-frame)
  6644. (progn
  6645. (delete-frame))
  6646. (and (not (eq org-agenda-window-setup 'current-window))
  6647. (not (one-window-p))
  6648. (delete-window)))
  6649. (with-current-buffer buf
  6650. (bury-buffer)
  6651. ;; Maybe restore the pre-agenda window configuration.
  6652. (and org-agenda-restore-windows-after-quit
  6653. (not (eq org-agenda-window-setup 'other-frame))
  6654. org-agenda-pre-window-conf
  6655. (set-window-configuration org-agenda-pre-window-conf)
  6656. (setq org-agenda-pre-window-conf nil))))
  6657. (org-agenda-Quit))))
  6658. (defun org-agenda-exit ()
  6659. "Exit the agenda and restore the window configuration.
  6660. Also kill Org-mode buffers loaded by `org-agenda'. Org-mode
  6661. buffers visited directly by the user will not be touched."
  6662. (interactive)
  6663. (org-release-buffers org-agenda-new-buffers)
  6664. (setq org-agenda-new-buffers nil)
  6665. (org-agenda-Quit))
  6666. (defun org-agenda-kill-all-agenda-buffers ()
  6667. "Kill all buffers in `org-agenda-mode'.
  6668. This is used when toggling sticky agendas.
  6669. You can also explicitly invoke it with `C-c a C-k'."
  6670. (interactive)
  6671. (let (blist)
  6672. (dolist (buf (buffer-list))
  6673. (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
  6674. (push buf blist)))
  6675. (mapc 'kill-buffer blist)))
  6676. (defun org-agenda-execute (arg)
  6677. "Execute another agenda command, keeping same window.
  6678. So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
  6679. in the agenda."
  6680. (interactive "P")
  6681. (let ((org-agenda-window-setup 'current-window))
  6682. (org-agenda arg)))
  6683. (defun org-agenda-redo (&optional all)
  6684. "Rebuild possibly ALL agenda view(s) in the current buffer."
  6685. (interactive "P")
  6686. (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
  6687. (cpa (unless (eq all t) current-prefix-arg))
  6688. (org-agenda-doing-sticky-redo org-agenda-sticky)
  6689. (org-agenda-sticky nil)
  6690. (org-agenda-buffer-name (or org-agenda-this-buffer-name
  6691. org-agenda-buffer-name))
  6692. (org-agenda-keep-modes t)
  6693. (tag-filter org-agenda-tag-filter)
  6694. (tag-preset (get 'org-agenda-tag-filter :preset-filter))
  6695. (top-cat-filter org-agenda-top-category-filter)
  6696. (cat-filter org-agenda-category-filter)
  6697. (cat-preset (get 'org-agenda-category-filter :preset-filter))
  6698. (re-preset (get 'org-agenda-category-filter :preset-filter))
  6699. (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
  6700. (cols org-agenda-columns-active)
  6701. (line (org-current-line))
  6702. (window-line (- line (org-current-line (window-start))))
  6703. (lprops (get 'org-agenda-redo-command 'org-lprops))
  6704. (redo-cmd (get-text-property p 'org-redo-cmd))
  6705. (last-args (get-text-property p 'org-last-args))
  6706. (org-agenda-overriding-cmd (get-text-property p 'org-series-cmd))
  6707. (org-agenda-overriding-cmd-arguments
  6708. (unless (eq all t)
  6709. (cond ((listp last-args)
  6710. (cons (or cpa (car last-args)) (cdr last-args)))
  6711. ((stringp last-args)
  6712. last-args))))
  6713. (series-redo-cmd (get-text-property p 'org-series-redo-cmd)))
  6714. (put 'org-agenda-tag-filter :preset-filter nil)
  6715. (put 'org-agenda-category-filter :preset-filter nil)
  6716. (and cols (org-columns-quit))
  6717. (message "Rebuilding agenda buffer...")
  6718. (if series-redo-cmd
  6719. (eval series-redo-cmd)
  6720. (org-let lprops '(eval redo-cmd)))
  6721. (setq org-agenda-undo-list nil
  6722. org-agenda-pending-undo-list nil)
  6723. (message "Rebuilding agenda buffer...done")
  6724. (put 'org-agenda-tag-filter :preset-filter tag-preset)
  6725. (put 'org-agenda-category-filter :preset-filter cat-preset)
  6726. (put 'org-agenda-regexp-filter :preset-filter re-preset)
  6727. (and (or tag-filter tag-preset) (org-agenda-filter-apply tag-filter 'tag))
  6728. (and (or cat-filter cat-preset) (org-agenda-filter-apply cat-filter 'category))
  6729. (and (or re-filter re-preset) (org-agenda-filter-apply re-filter 'regexp))
  6730. (and top-cat-filter (org-agenda-filter-top-category-apply top-cat-filter))
  6731. (and cols (org-called-interactively-p 'any) (org-agenda-columns))
  6732. (org-goto-line line)
  6733. (recenter window-line)))
  6734. (defvar org-global-tags-completion-table nil)
  6735. (defvar org-agenda-filter-form nil)
  6736. (defvar org-agenda-filtered-by-category nil)
  6737. (defun org-agenda-filter-by-category (strip)
  6738. "Keep only those lines in the agenda buffer that have a specific category.
  6739. The category is that of the current line."
  6740. (interactive "P")
  6741. (if (and org-agenda-filtered-by-category
  6742. org-agenda-category-filter)
  6743. (org-agenda-filter-show-all-cat)
  6744. (let ((cat (org-no-properties (get-text-property (point) 'org-category))))
  6745. (if (and cat (not (string= "" cat)))
  6746. (org-agenda-filter-apply
  6747. (setq org-agenda-category-filter
  6748. (list (concat (if strip "-" "+") cat)))
  6749. 'category)
  6750. (error "No category at point")))))
  6751. (defun org-find-top-category (&optional pos)
  6752. (save-excursion
  6753. (with-current-buffer (if pos (marker-buffer pos) (current-buffer))
  6754. (if pos (goto-char pos))
  6755. ;; Skip up to the topmost parent
  6756. (while (ignore-errors (outline-up-heading 1) t))
  6757. (ignore-errors
  6758. (nth 4 (org-heading-components))))))
  6759. (defvar org-agenda-filtered-by-top-category nil)
  6760. (defun org-agenda-filter-by-top-category (strip)
  6761. "Keep only those lines in the agenda buffer that have a specific category.
  6762. The category is that of the current line."
  6763. (interactive "P")
  6764. (if org-agenda-filtered-by-top-category
  6765. (progn
  6766. (setq org-agenda-filtered-by-top-category nil
  6767. org-agenda-top-category-filter nil)
  6768. (org-agenda-filter-show-all-cat))
  6769. (let ((cat (org-find-top-category (org-get-at-bol 'org-hd-marker))))
  6770. (if cat (org-agenda-filter-top-category-apply cat strip)
  6771. (error "No top-level category at point")))))
  6772. (defvar org-agenda-regexp-filter nil)
  6773. (defun org-agenda-filter-by-regexp (strip)
  6774. "Filter agenda entries by a regular expression.
  6775. Regexp filters are cumulative.
  6776. With no prefix argument, keep entries matching the regexp.
  6777. With one prefix argument, filter out entries matching the regexp.
  6778. With two prefix arguments, remove the regexp filters."
  6779. (interactive "P")
  6780. (if (not (equal strip '(16)))
  6781. (let ((flt (concat (if (equal strip '(4)) "-" "+")
  6782. (read-from-minibuffer
  6783. (if (equal strip '(4))
  6784. "Filter out entries matching regexp: "
  6785. "Narrow to entries matching regexp: ")))))
  6786. (push flt org-agenda-regexp-filter)
  6787. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
  6788. (org-agenda-filter-show-all-regexp)
  6789. (message "Regexp filter removed")))
  6790. (defun org-agenda-filter-by-tag (strip &optional char narrow)
  6791. "Keep only those lines in the agenda buffer that have a specific tag.
  6792. The tag is selected with its fast selection letter, as configured.
  6793. With prefix argument STRIP, remove all lines that do have the tag.
  6794. A lisp caller can specify CHAR. NARROW means that the new tag should be
  6795. used to narrow the search - the interactive user can also press `-' or `+'
  6796. to switch to narrowing."
  6797. (interactive "P")
  6798. (let* ((alist org-tag-alist-for-agenda)
  6799. (tag-chars (mapconcat
  6800. (lambda (x) (if (and (not (symbolp (car x)))
  6801. (cdr x))
  6802. (char-to-string (cdr x))
  6803. ""))
  6804. alist ""))
  6805. (efforts (org-split-string
  6806. (or (cdr (assoc (concat org-effort-property "_ALL")
  6807. org-global-properties))
  6808. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00"
  6809. "")))
  6810. (effort-op org-agenda-filter-effort-default-operator)
  6811. (effort-prompt "")
  6812. (inhibit-read-only t)
  6813. (current org-agenda-tag-filter)
  6814. maybe-refresh a n tag)
  6815. (unless char
  6816. (message
  6817. "%s by tag [%s ], [TAB], %s[/]:off, [+-]:narrow, [>=<?]:effort: "
  6818. (if narrow "Narrow" "Filter") tag-chars
  6819. (if org-agenda-auto-exclude-function "[RET], " ""))
  6820. (setq char (read-char-exclusive)))
  6821. (when (member char '(?+ ?-))
  6822. ;; Narrowing down
  6823. (cond ((equal char ?-) (setq strip t narrow t))
  6824. ((equal char ?+) (setq strip nil narrow t)))
  6825. (message
  6826. "Narrow by tag [%s ], [TAB], [/]:off, [>=<]:effort: " tag-chars)
  6827. (setq char (read-char-exclusive)))
  6828. (when (member char '(?< ?> ?= ??))
  6829. ;; An effort operator
  6830. (setq effort-op (char-to-string char))
  6831. (setq alist nil) ; to make sure it will be interpreted as effort.
  6832. (unless (equal char ??)
  6833. (loop for i from 0 to 9 do
  6834. (setq effort-prompt
  6835. (concat
  6836. effort-prompt " ["
  6837. (if (= i 9) "0" (int-to-string (1+ i)))
  6838. "]" (nth i efforts))))
  6839. (message "Effort%s: %s " effort-op effort-prompt)
  6840. (setq char (read-char-exclusive))
  6841. (when (or (< char ?0) (> char ?9))
  6842. (error "Need 1-9,0 to select effort"))))
  6843. (when (equal char ?\t)
  6844. (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
  6845. (org-set-local 'org-global-tags-completion-table
  6846. (org-global-tags-completion-table)))
  6847. (let ((completion-ignore-case t))
  6848. (setq tag (org-icompleting-read
  6849. "Tag: " org-global-tags-completion-table))))
  6850. (cond
  6851. ((equal char ?\r)
  6852. (org-agenda-filter-show-all-tag)
  6853. (when org-agenda-auto-exclude-function
  6854. (setq org-agenda-tag-filter '())
  6855. (dolist (tag (org-agenda-get-represented-tags))
  6856. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  6857. (if modifier
  6858. (push modifier org-agenda-tag-filter))))
  6859. (if (not (null org-agenda-tag-filter))
  6860. (org-agenda-filter-apply org-agenda-tag-filter 'tag)))
  6861. (setq maybe-refresh t))
  6862. ((equal char ?/)
  6863. (org-agenda-filter-show-all-tag)
  6864. (when (get 'org-agenda-tag-filter :preset-filter)
  6865. (org-agenda-filter-apply org-agenda-tag-filter 'tag))
  6866. (setq maybe-refresh t))
  6867. ((equal char ?. )
  6868. (setq org-agenda-tag-filter
  6869. (mapcar (lambda(tag) (concat "+" tag))
  6870. (org-get-at-bol 'tags)))
  6871. (org-agenda-filter-apply org-agenda-tag-filter 'tag)
  6872. (setq maybe-refresh t))
  6873. ((or (equal char ?\ )
  6874. (setq a (rassoc char alist))
  6875. (and (>= char ?0) (<= char ?9)
  6876. (setq n (if (= char ?0) 9 (- char ?0 1))
  6877. tag (concat effort-op (nth n efforts))
  6878. a (cons tag nil)))
  6879. (and (= char ??)
  6880. (setq tag "?eff")
  6881. a (cons tag nil))
  6882. (and tag (setq a (cons tag nil))))
  6883. (org-agenda-filter-show-all-tag)
  6884. (setq tag (car a))
  6885. (setq org-agenda-tag-filter
  6886. (cons (concat (if strip "-" "+") tag)
  6887. (if narrow current nil)))
  6888. (org-agenda-filter-apply org-agenda-tag-filter 'tag)
  6889. (setq maybe-refresh t))
  6890. (t (error "Invalid tag selection character %c" char)))
  6891. (when (and maybe-refresh
  6892. (eq org-agenda-clockreport-mode 'with-filter))
  6893. (org-agenda-redo))))
  6894. (defun org-agenda-get-represented-tags ()
  6895. "Get a list of all tags currently represented in the agenda."
  6896. (let (p tags)
  6897. (save-excursion
  6898. (goto-char (point-min))
  6899. (while (setq p (next-single-property-change (point) 'tags))
  6900. (goto-char p)
  6901. (mapc (lambda (x) (add-to-list 'tags x))
  6902. (get-text-property (point) 'tags))))
  6903. tags))
  6904. (defun org-agenda-filter-by-tag-refine (strip &optional char)
  6905. "Refine the current filter. See `org-agenda-filter-by-tag'."
  6906. (interactive "P")
  6907. (org-agenda-filter-by-tag strip char 'refine))
  6908. (defun org-agenda-filter-make-matcher ()
  6909. "Create the form that tests a line for agenda filter."
  6910. (let (f f1)
  6911. ;; first compute the tag-filter matcher
  6912. (dolist (x (delete-dups
  6913. (append (get 'org-agenda-tag-filter
  6914. :preset-filter) org-agenda-tag-filter)))
  6915. (if (member x '("-" "+"))
  6916. (setq f1 (if (equal x "-") 'tags '(not tags)))
  6917. (if (string-match "[<=>?]" x)
  6918. (setq f1 (org-agenda-filter-effort-form x))
  6919. (setq f1 (list 'member (downcase (substring x 1)) 'tags)))
  6920. (if (equal (string-to-char x) ?-)
  6921. (setq f1 (list 'not f1))))
  6922. (push f1 f))
  6923. ;; then compute the category-filter matcher
  6924. (dolist (x (delete-dups
  6925. (append (get 'org-agenda-category-filter
  6926. :preset-filter) org-agenda-category-filter)))
  6927. (if (equal "-" (substring x 0 1))
  6928. (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
  6929. (setq f1 (list 'equal (substring x 1) 'cat)))
  6930. (push f1 f))
  6931. ;; Finally compute the regexp filter
  6932. (dolist (x (delete-dups
  6933. (append (get 'org-agenda-regexp-filter
  6934. :preset-filter) org-agenda-regexp-filter)))
  6935. (if (equal "-" (substring x 0 1))
  6936. (setq f1 (list 'not (list 'string-match (substring x 1) 'txt)))
  6937. (setq f1 (list 'string-match (substring x 1) 'txt)))
  6938. (push f1 f))
  6939. (cons 'and (nreverse f))))
  6940. (defun org-agenda-filter-effort-form (e)
  6941. "Return the form to compare the effort of the current line with what E says.
  6942. E looks like \"+<2:25\"."
  6943. (let (op)
  6944. (setq e (substring e 1))
  6945. (setq op (string-to-char e) e (substring e 1))
  6946. (setq op (cond ((equal op ?<) '<=)
  6947. ((equal op ?>) '>=)
  6948. ((equal op ??) op)
  6949. (t '=)))
  6950. (list 'org-agenda-compare-effort (list 'quote op)
  6951. (org-duration-string-to-minutes e))))
  6952. (defun org-agenda-compare-effort (op value)
  6953. "Compare the effort of the current line with VALUE, using OP.
  6954. If the line does not have an effort defined, return nil."
  6955. (let ((eff (org-get-at-bol 'effort-minutes)))
  6956. (if (equal op ??)
  6957. (not eff)
  6958. (funcall op (or eff (if org-sort-agenda-noeffort-is-high 32767 0))
  6959. value))))
  6960. (defun org-agenda-filter-apply (filter type)
  6961. "Set FILTER as the new agenda filter and apply it."
  6962. ;; Deactivate `org-agenda-entry-text-mode' when filtering
  6963. (if org-agenda-entry-text-mode (org-agenda-entry-text-mode))
  6964. (let (tags cat txt)
  6965. (setq org-agenda-filter-form (org-agenda-filter-make-matcher))
  6966. (if (and (eq type 'category)
  6967. (not (equal (substring (car filter) 0 1) "-")))
  6968. ;; Only set `org-agenda-filtered-by-category' to t
  6969. ;; when a unique category is used as the filter
  6970. (setq org-agenda-filtered-by-category t))
  6971. (org-agenda-set-mode-name)
  6972. (save-excursion
  6973. (goto-char (point-min))
  6974. (while (not (eobp))
  6975. (if (org-get-at-bol 'org-marker)
  6976. (progn
  6977. (setq tags (org-get-at-bol 'tags) ; used in eval
  6978. cat (get-text-property (point) 'org-category)
  6979. txt (get-text-property (point) 'txt))
  6980. (if (not (eval org-agenda-filter-form))
  6981. (org-agenda-filter-hide-line type))
  6982. (beginning-of-line 2))
  6983. (beginning-of-line 2))))
  6984. (if (get-char-property (point) 'invisible)
  6985. (ignore-errors (org-agenda-previous-line)))))
  6986. (defun org-agenda-filter-top-category-apply (category &optional negative)
  6987. "Set FILTER as the new agenda filter and apply it."
  6988. (org-agenda-set-mode-name)
  6989. (save-excursion
  6990. (goto-char (point-min))
  6991. (while (not (eobp))
  6992. (let* ((pos (org-get-at-bol 'org-hd-marker))
  6993. (topcat (and pos (org-find-top-category pos))))
  6994. (if (and topcat (funcall (if negative 'identity 'not)
  6995. (string= category topcat)))
  6996. (org-agenda-filter-hide-line 'category)))
  6997. (beginning-of-line 2)))
  6998. (if (get-char-property (point) 'invisible)
  6999. (org-agenda-previous-line))
  7000. (setq org-agenda-top-category-filter category
  7001. org-agenda-filtered-by-top-category t))
  7002. (defun org-agenda-filter-hide-line (type)
  7003. "Hide lines with TYPE in the agenda buffer."
  7004. (let (ov)
  7005. (setq ov (make-overlay (max (point-min) (1- (point-at-bol)))
  7006. (point-at-eol)))
  7007. (overlay-put ov 'invisible t)
  7008. (overlay-put ov 'type type)
  7009. (cond ((eq type 'tag) (push ov org-agenda-tag-filter-overlays))
  7010. ((eq type 'category) (push ov org-agenda-cat-filter-overlays))
  7011. ((eq type 'regexp) (push ov org-agenda-re-filter-overlays)))))
  7012. (defun org-agenda-fix-tags-filter-overlays-at (&optional pos)
  7013. (setq pos (or pos (point)))
  7014. (save-excursion
  7015. (dolist (ov (overlays-at pos))
  7016. (when (and (overlay-get ov 'invisible)
  7017. (eq (overlay-get ov 'type) 'tag))
  7018. (goto-char pos)
  7019. (if (< (overlay-start ov) (point-at-eol))
  7020. (move-overlay ov (point-at-eol)
  7021. (overlay-end ov)))))))
  7022. (defun org-agenda-filter-show-all-tag nil
  7023. "Remove tag filter overlays from the agenda buffer."
  7024. (mapc 'delete-overlay org-agenda-tag-filter-overlays)
  7025. (setq org-agenda-tag-filter-overlays nil
  7026. org-agenda-tag-filter nil
  7027. org-agenda-filter-form nil)
  7028. (org-agenda-set-mode-name))
  7029. (defun org-agenda-filter-show-all-regexp nil
  7030. "Remove regexp filter overlays from the agenda buffer."
  7031. (mapc 'delete-overlay org-agenda-re-filter-overlays)
  7032. (setq org-agenda-re-filter-overlays nil
  7033. org-agenda-regexp-filter nil
  7034. org-agenda-filter-form nil)
  7035. (org-agenda-set-mode-name))
  7036. (defun org-agenda-filter-show-all-cat nil
  7037. "Remove category filter overlays from the agenda buffer."
  7038. (mapc 'delete-overlay org-agenda-cat-filter-overlays)
  7039. (setq org-agenda-cat-filter-overlays nil
  7040. org-agenda-filtered-by-category nil
  7041. org-agenda-category-filter nil
  7042. org-agenda-filter-form nil)
  7043. (org-agenda-set-mode-name))
  7044. (defun org-agenda-manipulate-query-add ()
  7045. "Manipulate the query by adding a search term with positive selection.
  7046. Positive selection means the term must be matched for selection of an entry."
  7047. (interactive)
  7048. (org-agenda-manipulate-query ?\[))
  7049. (defun org-agenda-manipulate-query-subtract ()
  7050. "Manipulate the query by adding a search term with negative selection.
  7051. Negative selection means term must not be matched for selection of an entry."
  7052. (interactive)
  7053. (org-agenda-manipulate-query ?\]))
  7054. (defun org-agenda-manipulate-query-add-re ()
  7055. "Manipulate the query by adding a search regexp with positive selection.
  7056. Positive selection means the regexp must match for selection of an entry."
  7057. (interactive)
  7058. (org-agenda-manipulate-query ?\{))
  7059. (defun org-agenda-manipulate-query-subtract-re ()
  7060. "Manipulate the query by adding a search regexp with negative selection.
  7061. Negative selection means regexp must not match for selection of an entry."
  7062. (interactive)
  7063. (org-agenda-manipulate-query ?\}))
  7064. (defun org-agenda-manipulate-query (char)
  7065. (cond
  7066. ((memq org-agenda-type '(timeline agenda))
  7067. (let ((org-agenda-include-inactive-timestamps t))
  7068. (org-agenda-redo))
  7069. (message "Display now includes inactive timestamps as well"))
  7070. ((eq org-agenda-type 'search)
  7071. (org-add-to-string
  7072. 'org-agenda-query-string
  7073. (if org-agenda-last-search-view-search-was-boolean
  7074. (cdr (assoc char '((?\[ . " +") (?\] . " -")
  7075. (?\{ . " +{}") (?\} . " -{}"))))
  7076. " "))
  7077. (setq org-agenda-redo-command
  7078. (list 'org-search-view
  7079. (car (get-text-property (min (1- (point-max)) (point))
  7080. 'org-last-args))
  7081. org-agenda-query-string
  7082. (+ (length org-agenda-query-string)
  7083. (if (member char '(?\{ ?\})) 0 1))))
  7084. (set-register org-agenda-query-register org-agenda-query-string)
  7085. (let ((org-agenda-overriding-arguments
  7086. (cdr org-agenda-redo-command)))
  7087. (org-agenda-redo)))
  7088. (t (error "Cannot manipulate query for %s-type agenda buffers"
  7089. org-agenda-type))))
  7090. (defun org-add-to-string (var string)
  7091. (set var (concat (symbol-value var) string)))
  7092. (defun org-agenda-goto-date (span)
  7093. "Jump to DATE in agenda."
  7094. (interactive "P")
  7095. (let* ((org-read-date-prefer-future
  7096. (eval org-agenda-jump-prefer-future))
  7097. (date (org-read-date))
  7098. (org-agenda-sticky-orig org-agenda-sticky)
  7099. (org-agenda-buffer-tmp-name (buffer-name))
  7100. (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7101. (0-arg (or current-prefix-arg (car args)))
  7102. (2-arg (nth 2 args))
  7103. (newcmd (list 'org-agenda-list 0-arg date
  7104. (org-agenda-span-to-ndays 2-arg)))
  7105. (newargs (cdr newcmd))
  7106. (inhibit-read-only t)
  7107. org-agenda-sticky)
  7108. (if (not (org-agenda-check-type t 'agenda))
  7109. (error "Not available in non-agenda blocks")
  7110. (add-text-properties (point-min) (point-max)
  7111. `(org-redo-cmd ,newcmd org-last-args ,newargs))
  7112. (org-agenda-redo)
  7113. (setq org-agenda-sticky org-agenda-sticky-orig
  7114. org-agenda-this-buffer-is-sticky org-agenda-sticky))))
  7115. (defun org-agenda-goto-today ()
  7116. "Go to today."
  7117. (interactive)
  7118. (org-agenda-check-type t 'timeline 'agenda)
  7119. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7120. (curspan (nth 2 args))
  7121. (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
  7122. (cond
  7123. (tdpos (goto-char tdpos))
  7124. ((eq org-agenda-type 'agenda)
  7125. (let* ((sd (org-agenda-compute-starting-span
  7126. (org-today) (or curspan org-agenda-ndays org-agenda-span)))
  7127. (org-agenda-overriding-arguments args))
  7128. (setf (nth 1 org-agenda-overriding-arguments) sd)
  7129. (org-agenda-redo)
  7130. (org-agenda-find-same-or-today-or-agenda)))
  7131. (t (error "Cannot find today")))))
  7132. (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
  7133. (goto-char
  7134. (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
  7135. (text-property-any (point-min) (point-max) 'org-today t)
  7136. (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
  7137. (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
  7138. (org-agenda-goto-block-beginning))
  7139. (point-min))))
  7140. (defun org-agenda-goto-block-beginning ()
  7141. "Go the agenda block beginning."
  7142. (interactive)
  7143. (if (not (derived-mode-p 'org-agenda-mode))
  7144. (error "Cannot execute this command outside of org-agenda-mode buffers")
  7145. (let (dest)
  7146. (save-excursion
  7147. (unless (looking-at "\\'")
  7148. (forward-char))
  7149. (let* ((prop 'org-agenda-structural-header)
  7150. (p (previous-single-property-change (point) prop))
  7151. (n (next-single-property-change (or (and (looking-at "\\`") 1)
  7152. (1- (point))) prop)))
  7153. (setq dest (cond ((eq n (point-at-eol)) (1- n)) (p (1- p))))))
  7154. (if (not dest)
  7155. (error "Cannot find the beginning of the blog")
  7156. (goto-char dest)
  7157. (move-beginning-of-line 1)))))
  7158. (defun org-agenda-later (arg)
  7159. "Go forward in time by the current span.
  7160. With prefix ARG, go forward that many times the current span."
  7161. (interactive "p")
  7162. (org-agenda-check-type t 'agenda)
  7163. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7164. (span (or (nth 2 args) org-agenda-current-span))
  7165. (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
  7166. (greg (calendar-gregorian-from-absolute sd))
  7167. (cnt (org-get-at-bol 'org-day-cnt))
  7168. greg2)
  7169. (cond
  7170. ((numberp span)
  7171. (setq sd (+ (* span arg) sd)))
  7172. ((eq span 'day)
  7173. (setq sd (+ arg sd)))
  7174. ((eq span 'week)
  7175. (setq sd (+ (* 7 arg) sd)))
  7176. ((eq span 'month)
  7177. (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
  7178. sd (calendar-absolute-from-gregorian greg2))
  7179. (setcar greg2 (1+ (car greg2))))
  7180. ((eq span 'year)
  7181. (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
  7182. sd (calendar-absolute-from-gregorian greg2))
  7183. (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
  7184. (t
  7185. (setq sd (+ (* span arg) sd))))
  7186. (let ((org-agenda-overriding-cmd
  7187. ;; `cmd' may have been set by `org-agenda-run-series' which
  7188. ;; uses `org-agenda-overriding-cmd' to decide whether
  7189. ;; overriding is allowed for `cmd'
  7190. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7191. (org-agenda-overriding-arguments
  7192. (list (car args) sd span)))
  7193. (org-agenda-redo)
  7194. (org-agenda-find-same-or-today-or-agenda cnt))))
  7195. (defun org-agenda-earlier (arg)
  7196. "Go backward in time by the current span.
  7197. With prefix ARG, go backward that many times the current span."
  7198. (interactive "p")
  7199. (org-agenda-later (- arg)))
  7200. (defun org-agenda-view-mode-dispatch ()
  7201. "Call one of the view mode commands."
  7202. (interactive)
  7203. (message "View: [d]ay [w]eek [m]onth [y]ear [SPC]reset [q]uit/abort
  7204. time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
  7205. [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
  7206. (let ((a (read-char-exclusive)))
  7207. (case a
  7208. (?\ (call-interactively 'org-agenda-reset-view))
  7209. (?d (call-interactively 'org-agenda-day-view))
  7210. (?w (call-interactively 'org-agenda-week-view))
  7211. (?m (call-interactively 'org-agenda-month-view))
  7212. (?y (call-interactively 'org-agenda-year-view))
  7213. (?l (call-interactively 'org-agenda-log-mode))
  7214. (?L (org-agenda-log-mode '(4)))
  7215. (?c (org-agenda-log-mode 'clockcheck))
  7216. ((?F ?f) (call-interactively 'org-agenda-follow-mode))
  7217. (?a (call-interactively 'org-agenda-archives-mode))
  7218. (?A (org-agenda-archives-mode 'files))
  7219. ((?R ?r) (call-interactively 'org-agenda-clockreport-mode))
  7220. ((?E ?e) (call-interactively 'org-agenda-entry-text-mode))
  7221. (?G (call-interactively 'org-agenda-toggle-time-grid))
  7222. (?D (call-interactively 'org-agenda-toggle-diary))
  7223. (?\! (call-interactively 'org-agenda-toggle-deadlines))
  7224. (?\[ (let ((org-agenda-include-inactive-timestamps t))
  7225. (org-agenda-check-type t 'timeline 'agenda)
  7226. (org-agenda-redo))
  7227. (message "Display now includes inactive timestamps as well"))
  7228. (?q (message "Abort"))
  7229. (otherwise (error "Invalid key" )))))
  7230. (defun org-agenda-reset-view ()
  7231. "Switch to default view for agenda."
  7232. (interactive)
  7233. (org-agenda-change-time-span (or org-agenda-ndays org-agenda-span)))
  7234. (defun org-agenda-day-view (&optional day-of-month)
  7235. "Switch to daily view for agenda.
  7236. With argument DAY-OF-MONTH, switch to that day of the month."
  7237. (interactive "P")
  7238. (org-agenda-change-time-span 'day day-of-month))
  7239. (defun org-agenda-week-view (&optional iso-week)
  7240. "Switch to daily view for agenda.
  7241. With argument ISO-WEEK, switch to the corresponding ISO week.
  7242. If ISO-WEEK has more then 2 digits, only the last two encode the
  7243. week. Any digits before this encode a year. So 200712 means
  7244. week 12 of year 2007. Years in the range 1938-2037 can also be
  7245. written as 2-digit years."
  7246. (interactive "P")
  7247. (org-agenda-change-time-span 'week iso-week))
  7248. (defun org-agenda-month-view (&optional month)
  7249. "Switch to monthly view for agenda.
  7250. With argument MONTH, switch to that month."
  7251. (interactive "P")
  7252. (org-agenda-change-time-span 'month month))
  7253. (defun org-agenda-year-view (&optional year)
  7254. "Switch to yearly view for agenda.
  7255. With argument YEAR, switch to that year.
  7256. If MONTH has more then 2 digits, only the last two encode the
  7257. month. Any digits before this encode a year. So 200712 means
  7258. December year 2007. Years in the range 1938-2037 can also be
  7259. written as 2-digit years."
  7260. (interactive "P")
  7261. (when year
  7262. (setq year (org-small-year-to-year year)))
  7263. (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
  7264. (org-agenda-change-time-span 'year year)
  7265. (error "Abort")))
  7266. (defun org-agenda-change-time-span (span &optional n)
  7267. "Change the agenda view to SPAN.
  7268. SPAN may be `day', `week', `month', `year'."
  7269. (org-agenda-check-type t 'agenda)
  7270. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7271. (curspan (nth 2 args)))
  7272. (if (and (not n) (equal curspan span))
  7273. (error "Viewing span is already \"%s\"" span))
  7274. (let* ((sd (or (org-get-at-bol 'day)
  7275. (nth 1 args)
  7276. org-starting-day))
  7277. (sd (org-agenda-compute-starting-span sd span n))
  7278. (org-agenda-overriding-cmd
  7279. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7280. (org-agenda-overriding-arguments
  7281. (list (car args) sd span)))
  7282. (org-agenda-redo)
  7283. (org-agenda-find-same-or-today-or-agenda))
  7284. (org-agenda-set-mode-name)
  7285. (message "Switched to %s view" span)))
  7286. (defun org-agenda-compute-starting-span (sd span &optional n)
  7287. "Compute starting date for agenda.
  7288. SPAN may be `day', `week', `month', `year'. The return value
  7289. is a cons cell with the starting date and the number of days,
  7290. so that the date SD will be in that range."
  7291. (let* ((greg (calendar-gregorian-from-absolute sd))
  7292. (dg (nth 1 greg))
  7293. (mg (car greg))
  7294. (yg (nth 2 greg)))
  7295. (cond
  7296. ((eq span 'day)
  7297. (when n
  7298. (setq sd (+ (calendar-absolute-from-gregorian
  7299. (list mg 1 yg))
  7300. n -1))))
  7301. ((eq span 'week)
  7302. (let* ((nt (calendar-day-of-week
  7303. (calendar-gregorian-from-absolute sd)))
  7304. (d (if org-agenda-start-on-weekday
  7305. (- nt org-agenda-start-on-weekday)
  7306. 0))
  7307. y1)
  7308. (setq sd (- sd (+ (if (< d 0) 7 0) d)))
  7309. (when n
  7310. (require 'cal-iso)
  7311. (when (> n 99)
  7312. (setq y1 (org-small-year-to-year (/ n 100))
  7313. n (mod n 100)))
  7314. (setq sd
  7315. (calendar-absolute-from-iso
  7316. (list n 1
  7317. (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
  7318. ((eq span 'month)
  7319. (let (y1)
  7320. (when (and n (> n 99))
  7321. (setq y1 (org-small-year-to-year (/ n 100))
  7322. n (mod n 100)))
  7323. (setq sd (calendar-absolute-from-gregorian
  7324. (list (or n mg) 1 (or y1 yg))))))
  7325. ((eq span 'year)
  7326. (setq sd (calendar-absolute-from-gregorian
  7327. (list 1 1 (or n yg))))))
  7328. sd))
  7329. (defun org-agenda-next-date-line (&optional arg)
  7330. "Jump to the next line indicating a date in agenda buffer."
  7331. (interactive "p")
  7332. (org-agenda-check-type t 'agenda 'timeline)
  7333. (beginning-of-line 1)
  7334. ;; This does not work if user makes date format that starts with a blank
  7335. (if (looking-at "^\\S-") (forward-char 1))
  7336. (if (not (re-search-forward "^\\S-" nil t arg))
  7337. (progn
  7338. (backward-char 1)
  7339. (error "No next date after this line in this buffer")))
  7340. (goto-char (match-beginning 0)))
  7341. (defun org-agenda-previous-date-line (&optional arg)
  7342. "Jump to the previous line indicating a date in agenda buffer."
  7343. (interactive "p")
  7344. (org-agenda-check-type t 'agenda 'timeline)
  7345. (beginning-of-line 1)
  7346. (if (not (re-search-backward "^\\S-" nil t arg))
  7347. (error "No previous date before this line in this buffer")))
  7348. ;; Initialize the highlight
  7349. (defvar org-hl (make-overlay 1 1))
  7350. (overlay-put org-hl 'face 'highlight)
  7351. (defun org-highlight (begin end &optional buffer)
  7352. "Highlight a region with overlay."
  7353. (move-overlay org-hl begin end (or buffer (current-buffer))))
  7354. (defun org-unhighlight ()
  7355. "Detach overlay INDEX."
  7356. (org-detach-overlay org-hl))
  7357. (defun org-unhighlight-once ()
  7358. "Remove the highlight from its position, and this function from the hook."
  7359. (remove-hook 'pre-command-hook 'org-unhighlight-once)
  7360. (org-unhighlight))
  7361. (defvar org-agenda-pre-follow-window-conf nil)
  7362. (defun org-agenda-follow-mode ()
  7363. "Toggle follow mode in an agenda buffer."
  7364. (interactive)
  7365. (unless org-agenda-follow-mode
  7366. (setq org-agenda-pre-follow-window-conf
  7367. (current-window-configuration)))
  7368. (setq org-agenda-follow-mode (not org-agenda-follow-mode))
  7369. (unless org-agenda-follow-mode
  7370. (set-window-configuration org-agenda-pre-follow-window-conf))
  7371. (org-agenda-set-mode-name)
  7372. (org-agenda-do-context-action)
  7373. (message "Follow mode is %s"
  7374. (if org-agenda-follow-mode "on" "off")))
  7375. (defun org-agenda-entry-text-mode (&optional arg)
  7376. "Toggle entry text mode in an agenda buffer."
  7377. (interactive "P")
  7378. (if (or org-agenda-tag-filter
  7379. org-agenda-category-filter
  7380. org-agenda-top-category-filter)
  7381. (user-error "Can't show entry text in filtered views")
  7382. (setq org-agenda-entry-text-mode (or (integerp arg)
  7383. (not org-agenda-entry-text-mode)))
  7384. (org-agenda-entry-text-hide)
  7385. (and org-agenda-entry-text-mode
  7386. (let ((org-agenda-entry-text-maxlines
  7387. (if (integerp arg) arg org-agenda-entry-text-maxlines)))
  7388. (org-agenda-entry-text-show)))
  7389. (org-agenda-set-mode-name)
  7390. (message "Entry text mode is %s%s"
  7391. (if org-agenda-entry-text-mode "on" "off")
  7392. (if (not org-agenda-entry-text-mode) ""
  7393. (format " (maximum number of lines is %d)"
  7394. (if (integerp arg) arg org-agenda-entry-text-maxlines))))))
  7395. (defun org-agenda-clockreport-mode (&optional with-filter)
  7396. "Toggle clocktable mode in an agenda buffer.
  7397. With prefix arg WITH-FILTER, make the clocktable respect the current
  7398. agenda filter."
  7399. (interactive "P")
  7400. (org-agenda-check-type t 'agenda)
  7401. (if with-filter
  7402. (setq org-agenda-clockreport-mode 'with-filter)
  7403. (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode)))
  7404. (org-agenda-set-mode-name)
  7405. (org-agenda-redo)
  7406. (message "Clocktable mode is %s"
  7407. (if org-agenda-clockreport-mode "on" "off")))
  7408. (defun org-agenda-log-mode (&optional special)
  7409. "Toggle log mode in an agenda buffer.
  7410. With argument SPECIAL, show all possible log items, not only the ones
  7411. configured in `org-agenda-log-mode-items'.
  7412. With a double `C-u' prefix arg, show *only* log items, nothing else."
  7413. (interactive "P")
  7414. (org-agenda-check-type t 'agenda 'timeline)
  7415. (setq org-agenda-show-log
  7416. (cond
  7417. ((equal special '(16)) 'only)
  7418. ((eq special 'clockcheck)
  7419. (if (eq org-agenda-show-log 'clockcheck)
  7420. nil 'clockcheck))
  7421. (special '(closed clock state))
  7422. (t (not org-agenda-show-log))))
  7423. (org-agenda-set-mode-name)
  7424. (org-agenda-redo)
  7425. (message "Log mode is %s"
  7426. (if org-agenda-show-log "on" "off")))
  7427. (defun org-agenda-archives-mode (&optional with-files)
  7428. "Toggle inclusion of items in trees marked with :ARCHIVE:.
  7429. When called with a prefix argument, include all archive files as well."
  7430. (interactive "P")
  7431. (setq org-agenda-archives-mode
  7432. (if with-files t (if org-agenda-archives-mode nil 'trees)))
  7433. (org-agenda-set-mode-name)
  7434. (org-agenda-redo)
  7435. (message
  7436. "%s"
  7437. (cond
  7438. ((eq org-agenda-archives-mode nil)
  7439. "No archives are included")
  7440. ((eq org-agenda-archives-mode 'trees)
  7441. (format "Trees with :%s: tag are included" org-archive-tag))
  7442. ((eq org-agenda-archives-mode t)
  7443. (format "Trees with :%s: tag and all active archive files are included"
  7444. org-archive-tag)))))
  7445. (defun org-agenda-toggle-diary ()
  7446. "Toggle diary inclusion in an agenda buffer."
  7447. (interactive)
  7448. (org-agenda-check-type t 'agenda)
  7449. (setq org-agenda-include-diary (not org-agenda-include-diary))
  7450. (org-agenda-redo)
  7451. (org-agenda-set-mode-name)
  7452. (message "Diary inclusion turned %s"
  7453. (if org-agenda-include-diary "on" "off")))
  7454. (defun org-agenda-toggle-deadlines ()
  7455. "Toggle inclusion of entries with a deadline in an agenda buffer."
  7456. (interactive)
  7457. (org-agenda-check-type t 'agenda)
  7458. (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
  7459. (org-agenda-redo)
  7460. (org-agenda-set-mode-name)
  7461. (message "Deadlines inclusion turned %s"
  7462. (if org-agenda-include-deadlines "on" "off")))
  7463. (defun org-agenda-toggle-time-grid ()
  7464. "Toggle time grid in an agenda buffer."
  7465. (interactive)
  7466. (org-agenda-check-type t 'agenda)
  7467. (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
  7468. (org-agenda-redo)
  7469. (org-agenda-set-mode-name)
  7470. (message "Time-grid turned %s"
  7471. (if org-agenda-use-time-grid "on" "off")))
  7472. (defun org-agenda-set-mode-name ()
  7473. "Set the mode name to indicate all the small mode settings."
  7474. (setq mode-name
  7475. (list "Org-Agenda"
  7476. (if (get 'org-agenda-files 'org-restrict) " []" "")
  7477. " "
  7478. '(:eval (org-agenda-span-name org-agenda-current-span))
  7479. (if org-agenda-follow-mode " Follow" "")
  7480. (if org-agenda-entry-text-mode " ETxt" "")
  7481. (if org-agenda-include-diary " Diary" "")
  7482. (if org-agenda-include-deadlines " Ddl" "")
  7483. (if org-agenda-use-time-grid " Grid" "")
  7484. (if (and (boundp 'org-habit-show-habits)
  7485. org-habit-show-habits) " Habit" "")
  7486. (cond
  7487. ((consp org-agenda-show-log) " LogAll")
  7488. ((eq org-agenda-show-log 'clockcheck) " ClkCk")
  7489. (org-agenda-show-log " Log")
  7490. (t ""))
  7491. (if (or org-agenda-category-filter
  7492. (get 'org-agenda-category-filter :preset-filter))
  7493. '(:eval (org-propertize
  7494. (concat " <"
  7495. (mapconcat
  7496. 'identity
  7497. (append
  7498. (get 'org-agenda-category-filter :preset-filter)
  7499. org-agenda-category-filter)
  7500. "")
  7501. ">")
  7502. 'face 'org-agenda-filter-category
  7503. 'help-echo "Category used in filtering")) "")
  7504. (if (or org-agenda-tag-filter
  7505. (get 'org-agenda-tag-filter :preset-filter))
  7506. '(:eval (org-propertize
  7507. (concat " {"
  7508. (mapconcat
  7509. 'identity
  7510. (append
  7511. (get 'org-agenda-tag-filter :preset-filter)
  7512. org-agenda-tag-filter)
  7513. "")
  7514. "}")
  7515. 'face 'org-agenda-filter-tags
  7516. 'help-echo "Tags used in filtering")) "")
  7517. (if (or org-agenda-regexp-filter
  7518. (get 'org-agenda-regexp-filter :preset-filter))
  7519. '(:eval (org-propertize
  7520. (concat " ["
  7521. (mapconcat
  7522. 'identity
  7523. (append
  7524. (get 'org-agenda-regexp-filter :preset-filter)
  7525. org-agenda-regexp-filter)
  7526. "")
  7527. "]")
  7528. 'face 'org-agenda-filter-regexp
  7529. 'help-echo "Regexp used in filtering")) "")
  7530. (if org-agenda-archives-mode
  7531. (if (eq org-agenda-archives-mode t)
  7532. " Archives"
  7533. (format " :%s:" org-archive-tag))
  7534. "")
  7535. (if org-agenda-clockreport-mode
  7536. (if (eq org-agenda-clockreport-mode 'with-filter)
  7537. " Clock{}" " Clock")
  7538. "")))
  7539. (force-mode-line-update))
  7540. (define-obsolete-function-alias
  7541. 'org-agenda-post-command-hook 'org-agenda-update-agenda-type "24.3")
  7542. (defun org-agenda-update-agenda-type ()
  7543. "Update the agenda type after each command."
  7544. (setq org-agenda-type
  7545. (or (get-text-property (point) 'org-agenda-type)
  7546. (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
  7547. (defun org-agenda-next-line ()
  7548. "Move cursor to the next line, and show if follow mode is active."
  7549. (interactive)
  7550. (call-interactively 'next-line)
  7551. (org-agenda-do-context-action))
  7552. (defun org-agenda-previous-line ()
  7553. "Move cursor to the previous line, and show if follow-mode is active."
  7554. (interactive)
  7555. (call-interactively 'previous-line)
  7556. (org-agenda-do-context-action))
  7557. (defun org-agenda-next-item (n)
  7558. "Move cursor to next agenda item."
  7559. (interactive "p")
  7560. (let ((col (current-column)))
  7561. (dotimes (c n)
  7562. (when (next-single-property-change (point-at-eol) 'org-marker)
  7563. (move-end-of-line 1)
  7564. (goto-char (next-single-property-change (point) 'org-marker))))
  7565. (org-move-to-column col))
  7566. (org-agenda-do-context-action))
  7567. (defun org-agenda-previous-item (n)
  7568. "Move cursor to next agenda item."
  7569. (interactive "p")
  7570. (dotimes (c n)
  7571. (let ((col (current-column))
  7572. (goto (save-excursion
  7573. (move-end-of-line 0)
  7574. (previous-single-property-change (point) 'org-marker))))
  7575. (if goto (goto-char goto))
  7576. (org-move-to-column col)))
  7577. (org-agenda-do-context-action))
  7578. (defun org-agenda-do-context-action ()
  7579. "Show outline path and, maybe, follow mode window."
  7580. (let ((m (org-get-at-bol 'org-marker)))
  7581. (when (and (markerp m) (marker-buffer m))
  7582. (and org-agenda-follow-mode
  7583. (if org-agenda-follow-indirect
  7584. (org-agenda-tree-to-indirect-buffer nil)
  7585. (org-agenda-show)))
  7586. (and org-agenda-show-outline-path
  7587. (org-with-point-at m (org-display-outline-path t))))))
  7588. (defun org-agenda-show-tags ()
  7589. "Show the tags applicable to the current item."
  7590. (interactive)
  7591. (let* ((tags (org-get-at-bol 'tags)))
  7592. (if tags
  7593. (message "Tags are :%s:"
  7594. (org-no-properties (mapconcat 'identity tags ":")))
  7595. (message "No tags associated with this line"))))
  7596. (defun org-agenda-goto (&optional highlight)
  7597. "Go to the Org-mode file which contains the item at point."
  7598. (interactive)
  7599. (let* ((marker (or (org-get-at-bol 'org-marker)
  7600. (org-agenda-error)))
  7601. (buffer (marker-buffer marker))
  7602. (pos (marker-position marker)))
  7603. (switch-to-buffer-other-window buffer)
  7604. (widen)
  7605. (push-mark)
  7606. (goto-char pos)
  7607. (when (derived-mode-p 'org-mode)
  7608. (org-show-context 'agenda)
  7609. (save-excursion
  7610. (and (outline-next-heading)
  7611. (org-flag-heading nil)))) ; show the next heading
  7612. (when (outline-invisible-p)
  7613. (show-entry)) ; display invisible text
  7614. (recenter (/ (window-height) 2))
  7615. (run-hooks 'org-agenda-after-show-hook)
  7616. (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
  7617. (defvar org-agenda-after-show-hook nil
  7618. "Normal hook run after an item has been shown from the agenda.
  7619. Point is in the buffer where the item originated.")
  7620. (defun org-agenda-kill ()
  7621. "Kill the entry or subtree belonging to the current agenda entry."
  7622. (interactive)
  7623. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  7624. (let* ((bufname-orig (buffer-name))
  7625. (marker (or (org-get-at-bol 'org-marker)
  7626. (org-agenda-error)))
  7627. (buffer (marker-buffer marker))
  7628. (pos (marker-position marker))
  7629. (type (org-get-at-bol 'type))
  7630. dbeg dend (n 0) conf)
  7631. (org-with-remote-undo buffer
  7632. (with-current-buffer buffer
  7633. (save-excursion
  7634. (goto-char pos)
  7635. (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
  7636. (setq dbeg (progn (org-back-to-heading t) (point))
  7637. dend (org-end-of-subtree t t))
  7638. (setq dbeg (point-at-bol)
  7639. dend (min (point-max) (1+ (point-at-eol)))))
  7640. (goto-char dbeg)
  7641. (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
  7642. (setq conf (or (eq t org-agenda-confirm-kill)
  7643. (and (numberp org-agenda-confirm-kill)
  7644. (> n org-agenda-confirm-kill))))
  7645. (and conf
  7646. (not (y-or-n-p
  7647. (format "Delete entry with %d lines in buffer \"%s\"? "
  7648. n (buffer-name buffer))))
  7649. (error "Abort"))
  7650. (let ((org-agenda-buffer-name bufname-orig))
  7651. (org-remove-subtree-entries-from-agenda buffer dbeg dend))
  7652. (with-current-buffer buffer (delete-region dbeg dend))
  7653. (message "Agenda item and source killed"))))
  7654. (defvar org-archive-default-command) ; defined in org-archive.el
  7655. (defun org-agenda-archive-default ()
  7656. "Archive the entry or subtree belonging to the current agenda entry."
  7657. (interactive)
  7658. (require 'org-archive)
  7659. (org-agenda-archive-with org-archive-default-command))
  7660. (defun org-agenda-archive-default-with-confirmation ()
  7661. "Archive the entry or subtree belonging to the current agenda entry."
  7662. (interactive)
  7663. (require 'org-archive)
  7664. (org-agenda-archive-with org-archive-default-command 'confirm))
  7665. (defun org-agenda-archive ()
  7666. "Archive the entry or subtree belonging to the current agenda entry."
  7667. (interactive)
  7668. (org-agenda-archive-with 'org-archive-subtree))
  7669. (defun org-agenda-archive-to-archive-sibling ()
  7670. "Move the entry to the archive sibling."
  7671. (interactive)
  7672. (org-agenda-archive-with 'org-archive-to-archive-sibling))
  7673. (defun org-agenda-archive-with (cmd &optional confirm)
  7674. "Move the entry to the archive sibling."
  7675. (interactive)
  7676. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  7677. (let* ((bufname-orig (buffer-name))
  7678. (marker (or (org-get-at-bol 'org-marker)
  7679. (org-agenda-error)))
  7680. (buffer (marker-buffer marker))
  7681. (pos (marker-position marker)))
  7682. (org-with-remote-undo buffer
  7683. (with-current-buffer buffer
  7684. (if (derived-mode-p 'org-mode)
  7685. (if (and confirm
  7686. (not (y-or-n-p "Archive this subtree or entry? ")))
  7687. (error "Abort")
  7688. (save-excursion
  7689. (goto-char pos)
  7690. (let ((org-agenda-buffer-name bufname-orig))
  7691. (org-remove-subtree-entries-from-agenda))
  7692. (org-back-to-heading t)
  7693. (funcall cmd)))
  7694. (error "Archiving works only in Org-mode files"))))))
  7695. (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
  7696. "Remove all lines in the agenda that correspond to a given subtree.
  7697. The subtree is the one in buffer BUF, starting at BEG and ending at END.
  7698. If this information is not given, the function uses the tree at point."
  7699. (let ((buf (or buf (current-buffer))) m p)
  7700. (save-excursion
  7701. (unless (and beg end)
  7702. (org-back-to-heading t)
  7703. (setq beg (point))
  7704. (org-end-of-subtree t)
  7705. (setq end (point)))
  7706. (set-buffer (get-buffer org-agenda-buffer-name))
  7707. (save-excursion
  7708. (goto-char (point-max))
  7709. (beginning-of-line 1)
  7710. (while (not (bobp))
  7711. (when (and (setq m (org-get-at-bol 'org-marker))
  7712. (equal buf (marker-buffer m))
  7713. (setq p (marker-position m))
  7714. (>= p beg)
  7715. (< p end))
  7716. (let ((inhibit-read-only t))
  7717. (delete-region (point-at-bol) (1+ (point-at-eol)))))
  7718. (beginning-of-line 0))))))
  7719. (defun org-agenda-refile (&optional goto rfloc no-update)
  7720. "Refile the item at point.
  7721. When GOTO is 0 or '(64), clear the refile cache.
  7722. When GOTO is '(16), go to the location of the last refiled item.
  7723. RFLOC can be a refile location obtained in a different way.
  7724. When NO-UPDATE is non-nil, don't redo the agenda buffer."
  7725. (interactive "P")
  7726. (cond
  7727. ((member goto '(0 (64)))
  7728. (org-refile-cache-clear))
  7729. ((equal goto '(16))
  7730. (org-refile-goto-last-stored))
  7731. (t
  7732. (let* ((buffer-orig (buffer-name))
  7733. (marker (or (org-get-at-bol 'org-hd-marker)
  7734. (org-agenda-error)))
  7735. (buffer (marker-buffer marker))
  7736. (pos (marker-position marker))
  7737. (rfloc (or rfloc
  7738. (org-refile-get-location
  7739. (if goto "Goto" "Refile to") buffer
  7740. org-refile-allow-creating-parent-nodes))))
  7741. (with-current-buffer buffer
  7742. (save-excursion
  7743. (save-restriction
  7744. (widen)
  7745. (goto-char marker)
  7746. (let ((org-agenda-buffer-name buffer-orig))
  7747. (org-remove-subtree-entries-from-agenda))
  7748. (org-refile goto buffer rfloc)))))
  7749. (unless no-update (org-agenda-redo)))))
  7750. (defun org-agenda-open-link (&optional arg)
  7751. "Open the link(s) in the current entry, if any.
  7752. This looks for a link in the displayed line in the agenda.
  7753. It also looks at the text of the entry itself."
  7754. (interactive "P")
  7755. (let* ((marker (or (org-get-at-bol 'org-hd-marker)
  7756. (org-get-at-bol 'org-marker)))
  7757. (buffer (and marker (marker-buffer marker)))
  7758. (prefix (buffer-substring (point-at-bol) (point-at-eol)))
  7759. (lkall (org-offer-links-in-entry buffer marker arg prefix))
  7760. (lk0 (car lkall))
  7761. (lk (if (stringp lk0) (list lk0) lk0))
  7762. (lkend (cdr lkall))
  7763. trg)
  7764. (cond
  7765. ((and buffer lk)
  7766. (mapcar (lambda(l)
  7767. (with-current-buffer buffer
  7768. (setq trg (and (string-match org-bracket-link-regexp l)
  7769. (match-string 1 l)))
  7770. (if (or (not trg) (string-match org-any-link-re trg))
  7771. (save-excursion
  7772. (save-restriction
  7773. (widen)
  7774. (goto-char marker)
  7775. (when (search-forward l nil lkend)
  7776. (goto-char (match-beginning 0))
  7777. (org-open-at-point))))
  7778. ;; This is an internal link, widen the buffer
  7779. (switch-to-buffer-other-window buffer)
  7780. (widen)
  7781. (goto-char marker)
  7782. (when (search-forward l nil lkend)
  7783. (goto-char (match-beginning 0))
  7784. (org-open-at-point)))))
  7785. lk))
  7786. ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
  7787. (save-excursion
  7788. (beginning-of-line 1)
  7789. (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
  7790. (org-open-link-from-string (match-string 1)))
  7791. (t (message "No link to open here")))))
  7792. (defun org-agenda-copy-local-variable (var)
  7793. "Get a variable from a referenced buffer and install it here."
  7794. (let ((m (org-get-at-bol 'org-marker)))
  7795. (when (and m (buffer-live-p (marker-buffer m)))
  7796. (org-set-local var (with-current-buffer (marker-buffer m)
  7797. (symbol-value var))))))
  7798. (defun org-agenda-switch-to (&optional delete-other-windows)
  7799. "Go to the Org-mode file which contains the item at point."
  7800. (interactive)
  7801. (if (and org-return-follows-link
  7802. (not (org-get-at-bol 'org-marker))
  7803. (org-in-regexp org-bracket-link-regexp))
  7804. (org-open-link-from-string (match-string 0))
  7805. (let* ((marker (or (org-get-at-bol 'org-marker)
  7806. (org-agenda-error)))
  7807. (buffer (marker-buffer marker))
  7808. (pos (marker-position marker)))
  7809. (org-pop-to-buffer-same-window buffer)
  7810. (and delete-other-windows (delete-other-windows))
  7811. (widen)
  7812. (goto-char pos)
  7813. (when (derived-mode-p 'org-mode)
  7814. (org-show-context 'agenda)
  7815. (save-excursion
  7816. (and (outline-next-heading)
  7817. (org-flag-heading nil))) ; show the next heading
  7818. (when (outline-invisible-p)
  7819. (show-entry)) ; display invisible text
  7820. (run-hooks 'org-agenda-after-show-hook)))))
  7821. (defun org-agenda-goto-mouse (ev)
  7822. "Go to the Org-mode file which contains the item at the mouse click."
  7823. (interactive "e")
  7824. (mouse-set-point ev)
  7825. (org-agenda-goto))
  7826. (defun org-agenda-show (&optional full-entry)
  7827. "Display the Org-mode file which contains the item at point.
  7828. With prefix argument FULL-ENTRY, make the entire entry visible
  7829. if it was hidden in the outline."
  7830. (interactive "P")
  7831. (let ((win (selected-window)))
  7832. (if full-entry
  7833. (let ((org-show-entry-below t))
  7834. (org-agenda-goto t))
  7835. (org-agenda-goto t))
  7836. (select-window win)))
  7837. (defvar org-agenda-show-window nil)
  7838. (defun org-agenda-show-and-scroll-up (&optional arg)
  7839. "Display the Org-mode file which contains the item at point.
  7840. When called repeatedly, scroll the window that is displaying the buffer.
  7841. With a \\[universal-argument] prefix, use `org-show-entry' instead of
  7842. `show-subtree' to display the item, so that drawers and logbooks stay
  7843. folded."
  7844. (interactive "P")
  7845. (let ((win (selected-window)))
  7846. (if (and (window-live-p org-agenda-show-window)
  7847. (eq this-command last-command))
  7848. (progn
  7849. (select-window org-agenda-show-window)
  7850. (ignore-errors (scroll-up)))
  7851. (org-agenda-goto t)
  7852. (if arg (org-show-entry) (show-subtree))
  7853. (setq org-agenda-show-window (selected-window)))
  7854. (select-window win)))
  7855. (defun org-agenda-show-scroll-down ()
  7856. "Scroll down the window showing the agenda."
  7857. (interactive)
  7858. (let ((win (selected-window)))
  7859. (when (window-live-p org-agenda-show-window)
  7860. (select-window org-agenda-show-window)
  7861. (ignore-errors (scroll-down))
  7862. (select-window win))))
  7863. (defun org-agenda-show-1 (&optional more)
  7864. "Display the Org-mode file which contains the item at point.
  7865. The prefix arg selects the amount of information to display:
  7866. 0 hide the subtree
  7867. 1 just show the entry according to defaults.
  7868. 2 show the children view
  7869. 3 show the subtree view
  7870. 4 show the entire subtree and any LOGBOOK drawers
  7871. 5 show the entire subtree and any drawers
  7872. With prefix argument FULL-ENTRY, make the entire entry visible
  7873. if it was hidden in the outline."
  7874. (interactive "p")
  7875. (let ((win (selected-window)))
  7876. (org-agenda-goto t)
  7877. (org-recenter-heading 1)
  7878. (cond
  7879. ((= more 0)
  7880. (hide-subtree)
  7881. (save-excursion
  7882. (org-back-to-heading)
  7883. (run-hook-with-args 'org-cycle-hook 'folded))
  7884. (message "Remote: FOLDED"))
  7885. ((and (org-called-interactively-p 'any) (= more 1))
  7886. (message "Remote: show with default settings"))
  7887. ((= more 2)
  7888. (show-entry)
  7889. (show-children)
  7890. (save-excursion
  7891. (org-back-to-heading)
  7892. (run-hook-with-args 'org-cycle-hook 'children))
  7893. (message "Remote: CHILDREN"))
  7894. ((= more 3)
  7895. (show-subtree)
  7896. (save-excursion
  7897. (org-back-to-heading)
  7898. (run-hook-with-args 'org-cycle-hook 'subtree))
  7899. (message "Remote: SUBTREE"))
  7900. ((= more 4)
  7901. (let* ((org-drawers (delete "LOGBOOK" (copy-sequence org-drawers)))
  7902. (org-drawer-regexp
  7903. (concat "^[ \t]*:\\("
  7904. (mapconcat 'regexp-quote org-drawers "\\|")
  7905. "\\):[ \t]*$")))
  7906. (show-subtree)
  7907. (save-excursion
  7908. (org-back-to-heading)
  7909. (org-cycle-hide-drawers 'subtree)))
  7910. (message "Remote: SUBTREE AND LOGBOOK"))
  7911. ((> more 4)
  7912. (show-subtree)
  7913. (message "Remote: SUBTREE AND ALL DRAWERS")))
  7914. (select-window win)))
  7915. (defun org-recenter-heading (n)
  7916. (save-excursion
  7917. (org-back-to-heading)
  7918. (recenter n)))
  7919. (defvar org-agenda-cycle-counter nil)
  7920. (defun org-agenda-cycle-show (&optional n)
  7921. "Show the current entry in another window, with default settings.
  7922. Default settings are taken from `org-show-hierarchy-above' and siblings.
  7923. When use repeatedly in immediate succession, the remote entry will cycle
  7924. through visibility
  7925. children -> subtree -> folded
  7926. When called with a numeric prefix arg, that arg will be passed through to
  7927. `org-agenda-show-1'. For the interpretation of that argument, see the
  7928. docstring of `org-agenda-show-1'."
  7929. (interactive "P")
  7930. (if (integerp n)
  7931. (setq org-agenda-cycle-counter n)
  7932. (if (not (eq last-command this-command))
  7933. (setq org-agenda-cycle-counter 1)
  7934. (if (equal org-agenda-cycle-counter 0)
  7935. (setq org-agenda-cycle-counter 2)
  7936. (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
  7937. (if (> org-agenda-cycle-counter 3)
  7938. (setq org-agenda-cycle-counter 0)))))
  7939. (org-agenda-show-1 org-agenda-cycle-counter))
  7940. (defun org-agenda-recenter (arg)
  7941. "Display the Org-mode file which contains the item at point and recenter."
  7942. (interactive "P")
  7943. (let ((win (selected-window)))
  7944. (org-agenda-goto t)
  7945. (recenter arg)
  7946. (select-window win)))
  7947. (defun org-agenda-show-mouse (ev)
  7948. "Display the Org-mode file which contains the item at the mouse click."
  7949. (interactive "e")
  7950. (mouse-set-point ev)
  7951. (org-agenda-show))
  7952. (defun org-agenda-check-no-diary ()
  7953. "Check if the entry is a diary link and abort if yes."
  7954. (if (org-get-at-bol 'org-agenda-diary-link)
  7955. (org-agenda-error)))
  7956. (defun org-agenda-error ()
  7957. (error "Command not allowed in this line"))
  7958. (defun org-agenda-tree-to-indirect-buffer (arg)
  7959. "Show the subtree corresponding to the current entry in an indirect buffer.
  7960. This calls the command `org-tree-to-indirect-buffer' from the original buffer.
  7961. With a numerical prefix ARG, go up to this level and then take that tree.
  7962. With a negative numeric ARG, go up by this number of levels.
  7963. With a \\[universal-argument] prefix, make a separate frame for this tree (i.e. don't
  7964. use the dedicated frame)."
  7965. (interactive "P")
  7966. (if current-prefix-arg
  7967. (org-agenda-do-tree-to-indirect-buffer arg)
  7968. (let ((agenda-buffer (buffer-name))
  7969. (agenda-window (selected-window))
  7970. (indirect-window
  7971. (and org-last-indirect-buffer
  7972. (get-buffer-window org-last-indirect-buffer))))
  7973. (save-window-excursion (org-agenda-do-tree-to-indirect-buffer arg))
  7974. (unless (or (eq org-indirect-buffer-display 'new-frame)
  7975. (eq org-indirect-buffer-display 'dedicated-frame))
  7976. (unwind-protect
  7977. (unless (and indirect-window (window-live-p indirect-window))
  7978. (setq indirect-window (split-window agenda-window)))
  7979. (and indirect-window (select-window indirect-window))
  7980. (switch-to-buffer org-last-indirect-buffer :norecord)
  7981. (fit-window-to-buffer indirect-window)))
  7982. (select-window (get-buffer-window agenda-buffer)))))
  7983. (defun org-agenda-do-tree-to-indirect-buffer (arg)
  7984. "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
  7985. (org-agenda-check-no-diary)
  7986. (let* ((marker (or (org-get-at-bol 'org-marker)
  7987. (org-agenda-error)))
  7988. (buffer (marker-buffer marker))
  7989. (pos (marker-position marker)))
  7990. (with-current-buffer buffer
  7991. (save-excursion
  7992. (goto-char pos)
  7993. (funcall 'org-tree-to-indirect-buffer arg)))))
  7994. (defvar org-last-heading-marker (make-marker)
  7995. "Marker pointing to the headline that last changed its TODO state
  7996. by a remote command from the agenda.")
  7997. (defun org-agenda-todo-nextset ()
  7998. "Switch TODO entry to next sequence."
  7999. (interactive)
  8000. (org-agenda-todo 'nextset))
  8001. (defun org-agenda-todo-previousset ()
  8002. "Switch TODO entry to previous sequence."
  8003. (interactive)
  8004. (org-agenda-todo 'previousset))
  8005. (defun org-agenda-todo (&optional arg)
  8006. "Cycle TODO state of line at point, also in Org-mode file.
  8007. This changes the line at point, all other lines in the agenda referring to
  8008. the same tree node, and the headline of the tree node in the Org-mode file."
  8009. (interactive "P")
  8010. (org-agenda-check-no-diary)
  8011. (let* ((col (current-column))
  8012. (marker (or (org-get-at-bol 'org-marker)
  8013. (org-agenda-error)))
  8014. (buffer (marker-buffer marker))
  8015. (pos (marker-position marker))
  8016. (hdmarker (org-get-at-bol 'org-hd-marker))
  8017. (todayp (org-agenda-todayp (org-get-at-bol 'day)))
  8018. (inhibit-read-only t)
  8019. org-agenda-headline-snapshot-before-repeat newhead just-one)
  8020. (org-with-remote-undo buffer
  8021. (with-current-buffer buffer
  8022. (widen)
  8023. (goto-char pos)
  8024. (org-show-context 'agenda)
  8025. (save-excursion
  8026. (and (outline-next-heading)
  8027. (org-flag-heading nil))) ; show the next heading
  8028. (let ((current-prefix-arg arg))
  8029. (call-interactively 'org-todo))
  8030. (and (bolp) (forward-char 1))
  8031. (setq newhead (org-get-heading))
  8032. (when (and (org-bound-and-true-p
  8033. org-agenda-headline-snapshot-before-repeat)
  8034. (not (equal org-agenda-headline-snapshot-before-repeat
  8035. newhead))
  8036. todayp)
  8037. (setq newhead org-agenda-headline-snapshot-before-repeat
  8038. just-one t))
  8039. (save-excursion
  8040. (org-back-to-heading)
  8041. (move-marker org-last-heading-marker (point))))
  8042. (beginning-of-line 1)
  8043. (save-excursion
  8044. (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
  8045. (org-move-to-column col))))
  8046. (defun org-agenda-add-note (&optional arg)
  8047. "Add a time-stamped note to the entry at point."
  8048. (interactive "P")
  8049. (org-agenda-check-no-diary)
  8050. (let* ((marker (or (org-get-at-bol 'org-marker)
  8051. (org-agenda-error)))
  8052. (buffer (marker-buffer marker))
  8053. (pos (marker-position marker))
  8054. (hdmarker (org-get-at-bol 'org-hd-marker))
  8055. (inhibit-read-only t))
  8056. (with-current-buffer buffer
  8057. (widen)
  8058. (goto-char pos)
  8059. (org-show-context 'agenda)
  8060. (save-excursion
  8061. (and (outline-next-heading)
  8062. (org-flag-heading nil))) ; show the next heading
  8063. (org-add-note))))
  8064. (defun org-agenda-change-all-lines (newhead hdmarker
  8065. &optional fixface just-this)
  8066. "Change all lines in the agenda buffer which match HDMARKER.
  8067. The new content of the line will be NEWHEAD (as modified by
  8068. `org-agenda-format-item'). HDMARKER is checked with
  8069. `equal' against all `org-hd-marker' text properties in the file.
  8070. If FIXFACE is non-nil, the face of each item is modified according to
  8071. the new TODO state.
  8072. If JUST-THIS is non-nil, change just the current line, not all.
  8073. If FORCE-TAGS is non nil, the car of it returns the new tags."
  8074. (let* ((inhibit-read-only t)
  8075. (line (org-current-line))
  8076. (org-agenda-buffer (current-buffer))
  8077. (thetags (with-current-buffer (marker-buffer hdmarker)
  8078. (save-excursion (save-restriction (widen)
  8079. (goto-char hdmarker)
  8080. (org-get-tags-at)))))
  8081. props m pl undone-face done-face finish new dotime level cat tags)
  8082. (save-excursion
  8083. (goto-char (point-max))
  8084. (beginning-of-line 1)
  8085. (while (not finish)
  8086. (setq finish (bobp))
  8087. (when (and (setq m (org-get-at-bol 'org-hd-marker))
  8088. (or (not just-this) (= (org-current-line) line))
  8089. (equal m hdmarker))
  8090. (setq props (text-properties-at (point))
  8091. dotime (org-get-at-bol 'dotime)
  8092. cat (org-get-at-bol 'org-category)
  8093. level (org-get-at-bol 'level)
  8094. tags thetags
  8095. new
  8096. (let ((org-prefix-format-compiled
  8097. (or (get-text-property (min (1- (point-max)) (point)) 'format)
  8098. org-prefix-format-compiled))
  8099. (extra (org-get-at-bol 'extra)))
  8100. (with-current-buffer (marker-buffer hdmarker)
  8101. (save-excursion
  8102. (save-restriction
  8103. (widen)
  8104. (org-agenda-format-item extra newhead level cat tags dotime)))))
  8105. pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
  8106. undone-face (org-get-at-bol 'undone-face)
  8107. done-face (org-get-at-bol 'done-face))
  8108. (beginning-of-line 1)
  8109. (cond
  8110. ((equal new "")
  8111. (and (looking-at ".*\n?") (replace-match "")))
  8112. ((looking-at ".*")
  8113. (replace-match new t t)
  8114. (beginning-of-line 1)
  8115. (add-text-properties (point-at-bol) (point-at-eol) props)
  8116. (when fixface
  8117. (add-text-properties
  8118. (point-at-bol) (point-at-eol)
  8119. (list 'face
  8120. (if org-last-todo-state-is-todo
  8121. undone-face done-face))))
  8122. (org-agenda-highlight-todo 'line)
  8123. (beginning-of-line 1))
  8124. (t (error "Line update did not work")))
  8125. (save-restriction
  8126. (narrow-to-region (point-at-bol) (point-at-eol))
  8127. (org-agenda-finalize)))
  8128. (beginning-of-line 0)))))
  8129. (defun org-agenda-align-tags (&optional line)
  8130. "Align all tags in agenda items to `org-agenda-tags-column'."
  8131. (let ((inhibit-read-only t) l c)
  8132. (save-excursion
  8133. (goto-char (if line (point-at-bol) (point-min)))
  8134. (while (re-search-forward (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
  8135. (if line (point-at-eol) nil) t)
  8136. (add-text-properties
  8137. (match-beginning 2) (match-end 2)
  8138. (list 'face (delq nil (let ((prop (get-text-property
  8139. (match-beginning 2) 'face)))
  8140. (or (listp prop) (setq prop (list prop)))
  8141. (if (memq 'org-tag prop)
  8142. prop
  8143. (cons 'org-tag prop))))))
  8144. (setq l (- (match-end 2) (match-beginning 2))
  8145. c (if (< org-agenda-tags-column 0)
  8146. (- (abs org-agenda-tags-column) l)
  8147. org-agenda-tags-column))
  8148. (delete-region (match-beginning 1) (match-end 1))
  8149. (goto-char (match-beginning 1))
  8150. (insert (org-add-props
  8151. (make-string (max 1 (- c (current-column))) ?\ )
  8152. (plist-put (copy-sequence (text-properties-at (point)))
  8153. 'face nil))))
  8154. (goto-char (point-min))
  8155. (org-font-lock-add-tag-faces (point-max)))))
  8156. (defun org-agenda-priority-up ()
  8157. "Increase the priority of line at point, also in Org-mode file."
  8158. (interactive)
  8159. (org-agenda-priority 'up))
  8160. (defun org-agenda-priority-down ()
  8161. "Decrease the priority of line at point, also in Org-mode file."
  8162. (interactive)
  8163. (org-agenda-priority 'down))
  8164. (defun org-agenda-priority (&optional force-direction)
  8165. "Set the priority of line at point, also in Org-mode file.
  8166. This changes the line at point, all other lines in the agenda referring to
  8167. the same tree node, and the headline of the tree node in the Org-mode file.
  8168. Called with a universal prefix arg, show the priority instead of setting it."
  8169. (interactive "P")
  8170. (if (equal force-direction '(4))
  8171. (org-show-priority)
  8172. (unless org-enable-priority-commands
  8173. (error "Priority commands are disabled"))
  8174. (org-agenda-check-no-diary)
  8175. (let* ((marker (or (org-get-at-bol 'org-marker)
  8176. (org-agenda-error)))
  8177. (hdmarker (org-get-at-bol 'org-hd-marker))
  8178. (buffer (marker-buffer hdmarker))
  8179. (pos (marker-position hdmarker))
  8180. (inhibit-read-only t)
  8181. newhead)
  8182. (org-with-remote-undo buffer
  8183. (with-current-buffer buffer
  8184. (widen)
  8185. (goto-char pos)
  8186. (org-show-context 'agenda)
  8187. (save-excursion
  8188. (and (outline-next-heading)
  8189. (org-flag-heading nil))) ; show the next heading
  8190. (funcall 'org-priority force-direction)
  8191. (end-of-line 1)
  8192. (setq newhead (org-get-heading)))
  8193. (org-agenda-change-all-lines newhead hdmarker)
  8194. (beginning-of-line 1)))))
  8195. ;; FIXME: should fix the tags property of the agenda line.
  8196. (defun org-agenda-set-tags (&optional tag onoff)
  8197. "Set tags for the current headline."
  8198. (interactive)
  8199. (org-agenda-check-no-diary)
  8200. (if (and (org-region-active-p) (org-called-interactively-p 'any))
  8201. (call-interactively 'org-change-tag-in-region)
  8202. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8203. (org-agenda-error)))
  8204. (buffer (marker-buffer hdmarker))
  8205. (pos (marker-position hdmarker))
  8206. (inhibit-read-only t)
  8207. newhead)
  8208. (org-with-remote-undo buffer
  8209. (with-current-buffer buffer
  8210. (widen)
  8211. (goto-char pos)
  8212. (save-excursion
  8213. (org-show-context 'agenda))
  8214. (save-excursion
  8215. (and (outline-next-heading)
  8216. (org-flag-heading nil))) ; show the next heading
  8217. (goto-char pos)
  8218. (if tag
  8219. (org-toggle-tag tag onoff)
  8220. (call-interactively 'org-set-tags))
  8221. (end-of-line 1)
  8222. (setq newhead (org-get-heading)))
  8223. (org-agenda-change-all-lines newhead hdmarker)
  8224. (beginning-of-line 1)))))
  8225. (defun org-agenda-set-property ()
  8226. "Set a property for the current headline."
  8227. (interactive)
  8228. (org-agenda-check-no-diary)
  8229. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8230. (org-agenda-error)))
  8231. (buffer (marker-buffer hdmarker))
  8232. (pos (marker-position hdmarker))
  8233. (inhibit-read-only t)
  8234. newhead)
  8235. (org-with-remote-undo buffer
  8236. (with-current-buffer buffer
  8237. (widen)
  8238. (goto-char pos)
  8239. (save-excursion
  8240. (org-show-context 'agenda))
  8241. (save-excursion
  8242. (and (outline-next-heading)
  8243. (org-flag-heading nil))) ; show the next heading
  8244. (goto-char pos)
  8245. (call-interactively 'org-set-property)))))
  8246. (defun org-agenda-set-effort ()
  8247. "Set the effort property for the current headline."
  8248. (interactive)
  8249. (org-agenda-check-no-diary)
  8250. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8251. (org-agenda-error)))
  8252. (buffer (marker-buffer hdmarker))
  8253. (pos (marker-position hdmarker))
  8254. (inhibit-read-only t)
  8255. newhead)
  8256. (org-with-remote-undo buffer
  8257. (with-current-buffer buffer
  8258. (widen)
  8259. (goto-char pos)
  8260. (save-excursion
  8261. (org-show-context 'agenda))
  8262. (save-excursion
  8263. (and (outline-next-heading)
  8264. (org-flag-heading nil))) ; show the next heading
  8265. (goto-char pos)
  8266. (call-interactively 'org-set-effort)
  8267. (end-of-line 1)
  8268. (setq newhead (org-get-heading)))
  8269. (org-agenda-change-all-lines newhead hdmarker))))
  8270. (defun org-agenda-toggle-archive-tag ()
  8271. "Toggle the archive tag for the current entry."
  8272. (interactive)
  8273. (org-agenda-check-no-diary)
  8274. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8275. (org-agenda-error)))
  8276. (buffer (marker-buffer hdmarker))
  8277. (pos (marker-position hdmarker))
  8278. (inhibit-read-only t)
  8279. newhead)
  8280. (org-with-remote-undo buffer
  8281. (with-current-buffer buffer
  8282. (widen)
  8283. (goto-char pos)
  8284. (org-show-context 'agenda)
  8285. (save-excursion
  8286. (and (outline-next-heading)
  8287. (org-flag-heading nil))) ; show the next heading
  8288. (call-interactively 'org-toggle-archive-tag)
  8289. (end-of-line 1)
  8290. (setq newhead (org-get-heading)))
  8291. (org-agenda-change-all-lines newhead hdmarker)
  8292. (beginning-of-line 1))))
  8293. (defun org-agenda-do-date-later (arg)
  8294. (interactive "P")
  8295. (cond
  8296. ((or (equal arg '(16))
  8297. (memq last-command
  8298. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  8299. (setq this-command 'org-agenda-date-later-minutes)
  8300. (org-agenda-date-later-minutes 1))
  8301. ((or (equal arg '(4))
  8302. (memq last-command
  8303. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  8304. (setq this-command 'org-agenda-date-later-hours)
  8305. (org-agenda-date-later-hours 1))
  8306. (t
  8307. (org-agenda-date-later (prefix-numeric-value arg)))))
  8308. (defun org-agenda-do-date-earlier (arg)
  8309. (interactive "P")
  8310. (cond
  8311. ((or (equal arg '(16))
  8312. (memq last-command
  8313. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  8314. (setq this-command 'org-agenda-date-earlier-minutes)
  8315. (org-agenda-date-earlier-minutes 1))
  8316. ((or (equal arg '(4))
  8317. (memq last-command
  8318. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  8319. (setq this-command 'org-agenda-date-earlier-hours)
  8320. (org-agenda-date-earlier-hours 1))
  8321. (t
  8322. (org-agenda-date-earlier (prefix-numeric-value arg)))))
  8323. (defun org-agenda-date-later (arg &optional what)
  8324. "Change the date of this item to ARG day(s) later."
  8325. (interactive "p")
  8326. (org-agenda-check-type t 'agenda 'timeline)
  8327. (org-agenda-check-no-diary)
  8328. (let* ((marker (or (org-get-at-bol 'org-marker)
  8329. (org-agenda-error)))
  8330. (buffer (marker-buffer marker))
  8331. (pos (marker-position marker))
  8332. cdate today)
  8333. (org-with-remote-undo buffer
  8334. (with-current-buffer buffer
  8335. (widen)
  8336. (goto-char pos)
  8337. (if (not (org-at-timestamp-p))
  8338. (error "Cannot find time stamp"))
  8339. (when (and org-agenda-move-date-from-past-immediately-to-today
  8340. (equal arg 1)
  8341. (or (not what) (eq what 'day))
  8342. (not (save-match-data (org-at-date-range-p))))
  8343. (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
  8344. cdate (calendar-absolute-from-gregorian
  8345. (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
  8346. today (org-today))
  8347. (if (> today cdate)
  8348. ;; immediately shift to today
  8349. (setq arg (- today cdate))))
  8350. (org-timestamp-change arg (or what 'day))
  8351. (when (and (org-at-date-range-p)
  8352. (re-search-backward org-tr-regexp-both (point-at-bol)))
  8353. (let ((end org-last-changed-timestamp))
  8354. (org-timestamp-change arg (or what 'day))
  8355. (setq org-last-changed-timestamp
  8356. (concat org-last-changed-timestamp "--" end)))))
  8357. (org-agenda-show-new-time marker org-last-changed-timestamp))
  8358. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  8359. (defun org-agenda-date-earlier (arg &optional what)
  8360. "Change the date of this item to ARG day(s) earlier."
  8361. (interactive "p")
  8362. (org-agenda-date-later (- arg) what))
  8363. (defun org-agenda-date-later-minutes (arg)
  8364. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  8365. (interactive "p")
  8366. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  8367. (org-agenda-date-later arg 'minute))
  8368. (defun org-agenda-date-earlier-minutes (arg)
  8369. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  8370. (interactive "p")
  8371. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  8372. (org-agenda-date-earlier arg 'minute))
  8373. (defun org-agenda-date-later-hours (arg)
  8374. "Change the time of this item, in hour steps."
  8375. (interactive "p")
  8376. (org-agenda-date-later arg 'hour))
  8377. (defun org-agenda-date-earlier-hours (arg)
  8378. "Change the time of this item, in hour steps."
  8379. (interactive "p")
  8380. (org-agenda-date-earlier arg 'hour))
  8381. (defun org-agenda-show-new-time (marker stamp &optional prefix)
  8382. "Show new date stamp via text properties."
  8383. ;; We use text properties to make this undoable
  8384. (let ((inhibit-read-only t))
  8385. (setq stamp (concat prefix " => " stamp " "))
  8386. (save-excursion
  8387. (goto-char (point-max))
  8388. (while (not (bobp))
  8389. (when (equal marker (org-get-at-bol 'org-marker))
  8390. (org-move-to-column (- (window-width) (length stamp)) t)
  8391. (org-agenda-fix-tags-filter-overlays-at (point))
  8392. (if (featurep 'xemacs)
  8393. ;; Use `duplicable' property to trigger undo recording
  8394. (let ((ex (make-extent nil nil))
  8395. (gl (make-glyph stamp)))
  8396. (set-glyph-face gl 'secondary-selection)
  8397. (set-extent-properties
  8398. ex (list 'invisible t 'end-glyph gl 'duplicable t))
  8399. (insert-extent ex (1- (point)) (point-at-eol)))
  8400. (add-text-properties
  8401. (1- (point)) (point-at-eol)
  8402. (list 'display (org-add-props stamp nil
  8403. 'face 'secondary-selection))))
  8404. (beginning-of-line 1))
  8405. (beginning-of-line 0)))))
  8406. (defun org-agenda-date-prompt (arg)
  8407. "Change the date of this item. Date is prompted for, with default today.
  8408. The prefix ARG is passed to the `org-time-stamp' command and can therefore
  8409. be used to request time specification in the time stamp."
  8410. (interactive "P")
  8411. (org-agenda-check-type t 'agenda 'timeline)
  8412. (org-agenda-check-no-diary)
  8413. (let* ((marker (or (org-get-at-bol 'org-marker)
  8414. (org-agenda-error)))
  8415. (buffer (marker-buffer marker))
  8416. (pos (marker-position marker)))
  8417. (org-with-remote-undo buffer
  8418. (with-current-buffer buffer
  8419. (widen)
  8420. (goto-char pos)
  8421. (if (not (org-at-timestamp-p t))
  8422. (error "Cannot find time stamp"))
  8423. (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
  8424. (org-agenda-show-new-time marker org-last-changed-timestamp))
  8425. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  8426. (defun org-agenda-schedule (arg &optional time)
  8427. "Schedule the item at point.
  8428. ARG is passed through to `org-schedule'."
  8429. (interactive "P")
  8430. (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
  8431. (org-agenda-check-no-diary)
  8432. (let* ((marker (or (org-get-at-bol 'org-marker)
  8433. (org-agenda-error)))
  8434. (type (marker-insertion-type marker))
  8435. (buffer (marker-buffer marker))
  8436. (pos (marker-position marker))
  8437. (org-insert-labeled-timestamps-at-point nil)
  8438. ts)
  8439. (set-marker-insertion-type marker t)
  8440. (org-with-remote-undo buffer
  8441. (with-current-buffer buffer
  8442. (widen)
  8443. (goto-char pos)
  8444. (setq ts (org-schedule arg time)))
  8445. (org-agenda-show-new-time marker ts " S"))
  8446. (message "%s" ts)))
  8447. (defun org-agenda-deadline (arg &optional time)
  8448. "Schedule the item at point.
  8449. ARG is passed through to `org-deadline'."
  8450. (interactive "P")
  8451. (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
  8452. (org-agenda-check-no-diary)
  8453. (let* ((marker (or (org-get-at-bol 'org-marker)
  8454. (org-agenda-error)))
  8455. (buffer (marker-buffer marker))
  8456. (pos (marker-position marker))
  8457. (org-insert-labeled-timestamps-at-point nil)
  8458. ts)
  8459. (org-with-remote-undo buffer
  8460. (with-current-buffer buffer
  8461. (widen)
  8462. (goto-char pos)
  8463. (setq ts (org-deadline arg time)))
  8464. (org-agenda-show-new-time marker ts " D"))
  8465. (message "%s" ts)))
  8466. (defun org-agenda-clock-in (&optional arg)
  8467. "Start the clock on the currently selected item."
  8468. (interactive "P")
  8469. (org-agenda-check-no-diary)
  8470. (if (equal arg '(4))
  8471. (org-clock-in arg)
  8472. (let* ((marker (or (org-get-at-bol 'org-marker)
  8473. (org-agenda-error)))
  8474. (hdmarker (or (org-get-at-bol 'org-hd-marker) marker))
  8475. (pos (marker-position marker))
  8476. (col (current-column))
  8477. newhead)
  8478. (org-with-remote-undo (marker-buffer marker)
  8479. (with-current-buffer (marker-buffer marker)
  8480. (widen)
  8481. (goto-char pos)
  8482. (org-show-context 'agenda)
  8483. (org-show-entry)
  8484. (org-cycle-hide-drawers 'children)
  8485. (org-clock-in arg)
  8486. (setq newhead (org-get-heading)))
  8487. (org-agenda-change-all-lines newhead hdmarker))
  8488. (org-move-to-column col))))
  8489. (defun org-agenda-clock-out ()
  8490. "Stop the currently running clock."
  8491. (interactive)
  8492. (unless (marker-buffer org-clock-marker)
  8493. (error "No running clock"))
  8494. (let ((marker (make-marker)) (col (current-column)) newhead)
  8495. (org-with-remote-undo (marker-buffer org-clock-marker)
  8496. (with-current-buffer (marker-buffer org-clock-marker)
  8497. (save-excursion
  8498. (save-restriction
  8499. (widen)
  8500. (goto-char org-clock-marker)
  8501. (org-back-to-heading t)
  8502. (move-marker marker (point))
  8503. (org-clock-out)
  8504. (setq newhead (org-get-heading))))))
  8505. (org-agenda-change-all-lines newhead marker)
  8506. (move-marker marker nil)
  8507. (org-move-to-column col)
  8508. (org-agenda-unmark-clocking-task)))
  8509. (defun org-agenda-clock-cancel (&optional arg)
  8510. "Cancel the currently running clock."
  8511. (interactive "P")
  8512. (unless (marker-buffer org-clock-marker)
  8513. (error "No running clock"))
  8514. (org-with-remote-undo (marker-buffer org-clock-marker)
  8515. (org-clock-cancel)))
  8516. (defun org-agenda-clock-goto ()
  8517. "Jump to the currently clocked in task within the agenda.
  8518. If the currently clocked in task is not listed in the agenda
  8519. buffer, display it in another window."
  8520. (interactive)
  8521. (let (pos)
  8522. (mapc (lambda (o)
  8523. (if (eq (overlay-get o 'type) 'org-agenda-clocking)
  8524. (setq pos (overlay-start o))))
  8525. (overlays-in (point-min) (point-max)))
  8526. (cond (pos (goto-char pos))
  8527. ;; If the currently clocked entry is not in the agenda
  8528. ;; buffer, we visit it in another window:
  8529. (org-clock-current-task
  8530. (org-switch-to-buffer-other-window (org-clock-goto)))
  8531. (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
  8532. (defun org-agenda-diary-entry-in-org-file ()
  8533. "Make a diary entry in the file `org-agenda-diary-file'."
  8534. (let (d1 d2 char (text "") dp1 dp2)
  8535. (if (equal (buffer-name) "*Calendar*")
  8536. (setq d1 (calendar-cursor-to-date t)
  8537. d2 (car calendar-mark-ring))
  8538. (setq dp1 (get-text-property (point-at-bol) 'day))
  8539. (unless dp1 (error "No date defined in current line"))
  8540. (setq d1 (calendar-gregorian-from-absolute dp1)
  8541. d2 (and (ignore-errors (mark))
  8542. (save-excursion
  8543. (goto-char (mark))
  8544. (setq dp2 (get-text-property (point-at-bol) 'day)))
  8545. (calendar-gregorian-from-absolute dp2))))
  8546. (message "Diary entry: [d]ay [a]nniversary [b]lock [j]ump to date tree")
  8547. (setq char (read-char-exclusive))
  8548. (cond
  8549. ((equal char ?d)
  8550. (setq text (read-string "Day entry: "))
  8551. (org-agenda-add-entry-to-org-agenda-diary-file 'day text d1)
  8552. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  8553. ((equal char ?a)
  8554. (setq d1 (list (car d1) (nth 1 d1)
  8555. (read-number (format "Reference year [%d]: " (nth 2 d1))
  8556. (nth 2 d1))))
  8557. (setq text (read-string "Anniversary (use %d to show years): "))
  8558. (org-agenda-add-entry-to-org-agenda-diary-file 'anniversary text d1)
  8559. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  8560. ((equal char ?b)
  8561. (setq text (read-string "Block entry: "))
  8562. (unless (and d1 d2 (not (equal d1 d2)))
  8563. (error "No block of days selected"))
  8564. (org-agenda-add-entry-to-org-agenda-diary-file 'block text d1 d2)
  8565. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  8566. ((equal char ?j)
  8567. (org-switch-to-buffer-other-window
  8568. (find-file-noselect org-agenda-diary-file))
  8569. (require 'org-datetree)
  8570. (org-datetree-find-date-create d1)
  8571. (org-reveal t))
  8572. (t (error "Invalid selection character `%c'" char)))))
  8573. (defcustom org-agenda-insert-diary-strategy 'date-tree
  8574. "Where in `org-agenda-diary-file' should new entries be added?
  8575. Valid values:
  8576. date-tree in the date tree, as child of the date
  8577. top-level as top-level entries at the end of the file."
  8578. :group 'org-agenda
  8579. :type '(choice
  8580. (const :tag "in a date tree" date-tree)
  8581. (const :tag "as top level at end of file" top-level)))
  8582. (defcustom org-agenda-insert-diary-extract-time nil
  8583. "Non-nil means extract any time specification from the diary entry."
  8584. :group 'org-agenda
  8585. :version "24.1"
  8586. :type 'boolean)
  8587. (defcustom org-agenda-bulk-mark-char ">"
  8588. "A single-character string to be used as the bulk mark."
  8589. :group 'org-agenda
  8590. :version "24.1"
  8591. :type 'string)
  8592. (defun org-agenda-add-entry-to-org-agenda-diary-file (type text &optional d1 d2)
  8593. "Add a diary entry with TYPE to `org-agenda-diary-file'.
  8594. If TEXT is not empty, it will become the headline of the new entry, and
  8595. the resulting entry will not be shown. When TEXT is empty, switch to
  8596. `org-agenda-diary-file' and let the user finish the entry there."
  8597. (let ((cw (current-window-configuration)))
  8598. (org-switch-to-buffer-other-window
  8599. (find-file-noselect org-agenda-diary-file))
  8600. (widen)
  8601. (goto-char (point-min))
  8602. (cond
  8603. ((eq type 'anniversary)
  8604. (or (re-search-forward "^*[ \t]+Anniversaries" nil t)
  8605. (progn
  8606. (or (org-at-heading-p t)
  8607. (progn
  8608. (outline-next-heading)
  8609. (insert "* Anniversaries\n\n")
  8610. (beginning-of-line -1)))))
  8611. (outline-next-heading)
  8612. (org-back-over-empty-lines)
  8613. (backward-char 1)
  8614. (insert "\n")
  8615. (insert (format "%%%%(org-anniversary %d %2d %2d) %s"
  8616. (nth 2 d1) (car d1) (nth 1 d1) text)))
  8617. ((eq type 'day)
  8618. (let ((org-prefix-has-time t)
  8619. (org-agenda-time-leading-zero t)
  8620. fmt time time2)
  8621. (if org-agenda-insert-diary-extract-time
  8622. ;; Use org-agenda-format-item to parse text for a time-range and
  8623. ;; remove it. FIXME: This is a hack, we should refactor
  8624. ;; that function to make time extraction available separately
  8625. (setq fmt (org-agenda-format-item nil text nil nil nil t)
  8626. time (get-text-property 0 'time fmt)
  8627. time2 (if (> (length time) 0)
  8628. ;; split-string removes trailing ...... if
  8629. ;; no end time given. First space
  8630. ;; separates time from date.
  8631. (concat " " (car (split-string time "\\.")))
  8632. nil)
  8633. text (get-text-property 0 'txt fmt)))
  8634. (if (eq org-agenda-insert-diary-strategy 'top-level)
  8635. (org-agenda-insert-diary-as-top-level text)
  8636. (require 'org-datetree)
  8637. (org-datetree-find-date-create d1)
  8638. (org-agenda-insert-diary-make-new-entry text))
  8639. (org-insert-time-stamp (org-time-from-absolute
  8640. (calendar-absolute-from-gregorian d1))
  8641. nil nil nil nil time2))
  8642. (end-of-line 0))
  8643. ((eq type 'block)
  8644. (if (> (calendar-absolute-from-gregorian d1)
  8645. (calendar-absolute-from-gregorian d2))
  8646. (setq d1 (prog1 d2 (setq d2 d1))))
  8647. (if (eq org-agenda-insert-diary-strategy 'top-level)
  8648. (org-agenda-insert-diary-as-top-level text)
  8649. (require 'org-datetree)
  8650. (org-datetree-find-date-create d1)
  8651. (org-agenda-insert-diary-make-new-entry text))
  8652. (org-insert-time-stamp (org-time-from-absolute
  8653. (calendar-absolute-from-gregorian d1)))
  8654. (insert "--")
  8655. (org-insert-time-stamp (org-time-from-absolute
  8656. (calendar-absolute-from-gregorian d2)))
  8657. (end-of-line 0)))
  8658. (if (string-match "\\S-" text)
  8659. (progn
  8660. (set-window-configuration cw)
  8661. (message "%s entry added to %s"
  8662. (capitalize (symbol-name type))
  8663. (abbreviate-file-name org-agenda-diary-file)))
  8664. (org-reveal t)
  8665. (message "Please finish entry here"))))
  8666. (defun org-agenda-insert-diary-as-top-level (text)
  8667. "Make new entry as a top-level entry at the end of the file.
  8668. Add TEXT as headline, and position the cursor in the second line so that
  8669. a timestamp can be added there."
  8670. (widen)
  8671. (goto-char (point-max))
  8672. (or (bolp) (insert "\n"))
  8673. (insert "* " text "\n")
  8674. (if org-adapt-indentation (org-indent-to-column 2)))
  8675. (defun org-agenda-insert-diary-make-new-entry (text)
  8676. "Make new entry as last child of current entry.
  8677. Add TEXT as headline, and position the cursor in the second line so that
  8678. a timestamp can be added there."
  8679. (let ((org-show-following-heading t)
  8680. (org-show-siblings t)
  8681. (org-show-hierarchy-above t)
  8682. (org-show-entry-below t)
  8683. col)
  8684. (outline-next-heading)
  8685. (org-back-over-empty-lines)
  8686. (or (looking-at "[ \t]*$")
  8687. (progn (insert "\n") (backward-char 1)))
  8688. (org-insert-heading nil t)
  8689. (org-do-demote)
  8690. (setq col (current-column))
  8691. (insert text "\n")
  8692. (if org-adapt-indentation (org-indent-to-column col))
  8693. (let ((org-show-following-heading t)
  8694. (org-show-siblings t)
  8695. (org-show-hierarchy-above t)
  8696. (org-show-entry-below t))
  8697. (org-show-context))))
  8698. (defun org-agenda-diary-entry ()
  8699. "Make a diary entry, like the `i' command from the calendar.
  8700. All the standard commands work: block, weekly etc.
  8701. When `org-agenda-diary-file' points to a file,
  8702. `org-agenda-diary-entry-in-org-file' is called instead to create
  8703. entries in that Org-mode file."
  8704. (interactive)
  8705. (if (not (eq org-agenda-diary-file 'diary-file))
  8706. (org-agenda-diary-entry-in-org-file)
  8707. (require 'diary-lib)
  8708. (let* ((char (progn
  8709. (message "Diary entry: [d]ay [w]eekly [m]onthly [y]early [a]nniversary [b]lock [c]yclic")
  8710. (read-char-exclusive)))
  8711. (cmd (cdr (assoc char
  8712. '((?d . insert-diary-entry)
  8713. (?w . insert-weekly-diary-entry)
  8714. (?m . insert-monthly-diary-entry)
  8715. (?y . insert-yearly-diary-entry)
  8716. (?a . insert-anniversary-diary-entry)
  8717. (?b . insert-block-diary-entry)
  8718. (?c . insert-cyclic-diary-entry)))))
  8719. (oldf (symbol-function 'calendar-cursor-to-date))
  8720. ;; (buf (get-file-buffer (substitute-in-file-name diary-file)))
  8721. (point (point))
  8722. (mark (or (mark t) (point))))
  8723. (unless cmd
  8724. (error "No command associated with <%c>" char))
  8725. (unless (and (get-text-property point 'day)
  8726. (or (not (equal ?b char))
  8727. (get-text-property mark 'day)))
  8728. (error "Don't know which date to use for diary entry"))
  8729. ;; We implement this by hacking the `calendar-cursor-to-date' function
  8730. ;; and the `calendar-mark-ring' variable. Saves a lot of code.
  8731. (let ((calendar-mark-ring
  8732. (list (calendar-gregorian-from-absolute
  8733. (or (get-text-property mark 'day)
  8734. (get-text-property point 'day))))))
  8735. (unwind-pr