org-agenda.el 371 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618
  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 category-keep) (const category-up) (const category-down)
  215. (const tag-down) (const tag-up)
  216. (const priority-up) (const priority-down)
  217. (const todo-state-up) (const todo-state-down)
  218. (const effort-up) (const effort-down)
  219. (const habit-up) (const habit-down)
  220. (const alpha-up) (const alpha-down)
  221. (const user-defined-up) (const user-defined-down))
  222. "Sorting choices.")
  223. ;; Keep custom values for `org-agenda-filter-preset' compatible with
  224. ;; the new variable `org-agenda-tag-filter-preset'.
  225. (if (fboundp 'defvaralias)
  226. (defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
  227. (defvaralias 'org-agenda-filter 'org-agenda-tag-filter))
  228. (defconst org-agenda-custom-commands-local-options
  229. `(repeat :tag "Local settings for this command. Remember to quote values"
  230. (choice :tag "Setting"
  231. (list :tag "Heading for this block"
  232. (const org-agenda-overriding-header)
  233. (string :tag "Headline"))
  234. (list :tag "Files to be searched"
  235. (const org-agenda-files)
  236. (list
  237. (const :format "" quote)
  238. (repeat (file))))
  239. (list :tag "Sorting strategy"
  240. (const org-agenda-sorting-strategy)
  241. (list
  242. (const :format "" quote)
  243. (repeat
  244. ,org-sorting-choice)))
  245. (list :tag "Prefix format"
  246. (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
  247. (string))
  248. (list :tag "Number of days in agenda"
  249. (const org-agenda-span)
  250. (choice (const :tag "Day" 'day)
  251. (const :tag "Week" 'week)
  252. (const :tag "Month" 'month)
  253. (const :tag "Year" 'year)
  254. (integer :tag "Custom")))
  255. (list :tag "Fixed starting date"
  256. (const org-agenda-start-day)
  257. (string :value "2007-11-01"))
  258. (list :tag "Start on day of week"
  259. (const org-agenda-start-on-weekday)
  260. (choice :value 1
  261. (const :tag "Today" nil)
  262. (integer :tag "Weekday No.")))
  263. (list :tag "Include data from diary"
  264. (const org-agenda-include-diary)
  265. (boolean))
  266. (list :tag "Deadline Warning days"
  267. (const org-deadline-warning-days)
  268. (integer :value 1))
  269. (list :tag "Category filter preset"
  270. (const org-agenda-category-filter-preset)
  271. (list
  272. (const :format "" quote)
  273. (repeat
  274. (string :tag "+category or -category"))))
  275. (list :tag "Tags filter preset"
  276. (const org-agenda-tag-filter-preset)
  277. (list
  278. (const :format "" quote)
  279. (repeat
  280. (string :tag "+tag or -tag"))))
  281. (list :tag "Set daily/weekly entry types"
  282. (const org-agenda-entry-types)
  283. (list
  284. (const :format "" quote)
  285. (set :greedy t :value (:deadline :scheduled :timestamp :sexp)
  286. (const :deadline)
  287. (const :scheduled)
  288. (const :timestamp)
  289. (const :sexp))))
  290. (list :tag "Standard skipping condition"
  291. :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
  292. (const org-agenda-skip-function)
  293. (list
  294. (const :format "" quote)
  295. (list
  296. (choice
  297. :tag "Skipping range"
  298. (const :tag "Skip entry" org-agenda-skip-entry-if)
  299. (const :tag "Skip subtree" org-agenda-skip-subtree-if))
  300. (repeat :inline t :tag "Conditions for skipping"
  301. (choice
  302. :tag "Condition type"
  303. (list :tag "Regexp matches" :inline t (const :format "" 'regexp) (regexp))
  304. (list :tag "Regexp does not match" :inline t (const :format "" 'notregexp) (regexp))
  305. (list :tag "TODO state is" :inline t
  306. (const 'todo)
  307. (choice
  308. (const :tag "any not-done state" 'todo)
  309. (const :tag "any done state" 'done)
  310. (const :tag "any state" 'any)
  311. (list :tag "Keyword list"
  312. (const :format "" quote)
  313. (repeat (string :tag "Keyword")))))
  314. (list :tag "TODO state is not" :inline t
  315. (const 'nottodo)
  316. (choice
  317. (const :tag "any not-done state" 'todo)
  318. (const :tag "any done state" 'done)
  319. (const :tag "any state" 'any)
  320. (list :tag "Keyword list"
  321. (const :format "" quote)
  322. (repeat (string :tag "Keyword")))))
  323. (const :tag "scheduled" 'scheduled)
  324. (const :tag "not scheduled" 'notscheduled)
  325. (const :tag "deadline" 'deadline)
  326. (const :tag "no deadline" 'notdeadline)
  327. (const :tag "timestamp" 'timestamp)
  328. (const :tag "no timestamp" 'nottimestamp))))))
  329. (list :tag "Non-standard skipping condition"
  330. :value (org-agenda-skip-function)
  331. (const org-agenda-skip-function)
  332. (sexp :tag "Function or form (quoted!)"))
  333. (list :tag "Any variable"
  334. (variable :tag "Variable")
  335. (sexp :tag "Value (sexp)"))))
  336. "Selection of examples for agenda command settings.
  337. This will be spliced into the custom type of
  338. `org-agenda-custom-commands'.")
  339. (defcustom org-agenda-custom-commands '(("n" "Agenda and all TODO's"
  340. ((agenda "") (alltodo))))
  341. "Custom commands for the agenda.
  342. These commands will be offered on the splash screen displayed by the
  343. agenda dispatcher \\[org-agenda]. Each entry is a list like this:
  344. (key desc type match settings files)
  345. key The key (one or more characters as a string) to be associated
  346. with the command.
  347. desc A description of the command, when omitted or nil, a default
  348. description is built using MATCH.
  349. type The command type, any of the following symbols:
  350. agenda The daily/weekly agenda.
  351. todo Entries with a specific TODO keyword, in all agenda files.
  352. search Entries containing search words entry or headline.
  353. tags Tags/Property/TODO match in all agenda files.
  354. tags-todo Tags/P/T match in all agenda files, TODO entries only.
  355. todo-tree Sparse tree of specific TODO keyword in *current* file.
  356. tags-tree Sparse tree with all tags matches in *current* file.
  357. occur-tree Occur sparse tree for *current* file.
  358. ... A user-defined function.
  359. match What to search for:
  360. - a single keyword for TODO keyword searches
  361. - a tags match expression for tags searches
  362. - a word search expression for text searches.
  363. - a regular expression for occur searches
  364. For all other commands, this should be the empty string.
  365. settings A list of option settings, similar to that in a let form, so like
  366. this: ((opt1 val1) (opt2 val2) ...). The values will be
  367. evaluated at the moment of execution, so quote them when needed.
  368. files A list of files file to write the produced agenda buffer to
  369. with the command `org-store-agenda-views'.
  370. If a file name ends in \".html\", an HTML version of the buffer
  371. is written out. If it ends in \".ps\", a postscript version is
  372. produced. Otherwise, only the plain text is written to the file.
  373. You can also define a set of commands, to create a composite agenda buffer.
  374. In this case, an entry looks like this:
  375. (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
  376. where
  377. desc A description string to be displayed in the dispatcher menu.
  378. cmd An agenda command, similar to the above. However, tree commands
  379. are not allowed, but instead you can get agenda and global todo list.
  380. So valid commands for a set are:
  381. (agenda \"\" settings)
  382. (alltodo \"\" settings)
  383. (stuck \"\" settings)
  384. (todo \"match\" settings files)
  385. (search \"match\" settings files)
  386. (tags \"match\" settings files)
  387. (tags-todo \"match\" settings files)
  388. Each command can carry a list of options, and another set of options can be
  389. given for the whole set of commands. Individual command options take
  390. precedence over the general options.
  391. When using several characters as key to a command, the first characters
  392. are prefix commands. For the dispatcher to display useful information, you
  393. should provide a description for the prefix, like
  394. (setq org-agenda-custom-commands
  395. '((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
  396. (\"hl\" tags \"+HOME+Lisa\")
  397. (\"hp\" tags \"+HOME+Peter\")
  398. (\"hk\" tags \"+HOME+Kim\")))"
  399. :group 'org-agenda-custom-commands
  400. :type `(repeat
  401. (choice :value ("x" "Describe command here" tags "" nil)
  402. (list :tag "Single command"
  403. (string :tag "Access Key(s) ")
  404. (option (string :tag "Description"))
  405. (choice
  406. (const :tag "Agenda" agenda)
  407. (const :tag "TODO list" alltodo)
  408. (const :tag "Search words" search)
  409. (const :tag "Stuck projects" stuck)
  410. (const :tag "Tags/Property match (all agenda files)" tags)
  411. (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
  412. (const :tag "TODO keyword search (all agenda files)" todo)
  413. (const :tag "Tags sparse tree (current buffer)" tags-tree)
  414. (const :tag "TODO keyword tree (current buffer)" todo-tree)
  415. (const :tag "Occur tree (current buffer)" occur-tree)
  416. (sexp :tag "Other, user-defined function"))
  417. (string :tag "Match (only for some commands)")
  418. ,org-agenda-custom-commands-local-options
  419. (option (repeat :tag "Export" (file :tag "Export to"))))
  420. (list :tag "Command series, all agenda files"
  421. (string :tag "Access Key(s)")
  422. (string :tag "Description ")
  423. (repeat :tag "Component"
  424. (choice
  425. (list :tag "Agenda"
  426. (const :format "" agenda)
  427. (const :tag "" :format "" "")
  428. ,org-agenda-custom-commands-local-options)
  429. (list :tag "TODO list (all keywords)"
  430. (const :format "" alltodo)
  431. (const :tag "" :format "" "")
  432. ,org-agenda-custom-commands-local-options)
  433. (list :tag "Search words"
  434. (const :format "" search)
  435. (string :tag "Match")
  436. ,org-agenda-custom-commands-local-options)
  437. (list :tag "Stuck projects"
  438. (const :format "" stuck)
  439. (const :tag "" :format "" "")
  440. ,org-agenda-custom-commands-local-options)
  441. (list :tag "Tags search"
  442. (const :format "" tags)
  443. (string :tag "Match")
  444. ,org-agenda-custom-commands-local-options)
  445. (list :tag "Tags search, TODO entries only"
  446. (const :format "" tags-todo)
  447. (string :tag "Match")
  448. ,org-agenda-custom-commands-local-options)
  449. (list :tag "TODO keyword search"
  450. (const :format "" todo)
  451. (string :tag "Match")
  452. ,org-agenda-custom-commands-local-options)
  453. (list :tag "Other, user-defined function"
  454. (symbol :tag "function")
  455. (string :tag "Match")
  456. ,org-agenda-custom-commands-local-options)))
  457. (repeat :tag "Settings for entire command set"
  458. (list (variable :tag "Any variable")
  459. (sexp :tag "Value")))
  460. (option (repeat :tag "Export" (file :tag "Export to"))))
  461. (cons :tag "Prefix key documentation"
  462. (string :tag "Access Key(s)")
  463. (string :tag "Description ")))))
  464. (defcustom org-agenda-query-register ?o
  465. "The register holding the current query string.
  466. The purpose of this is that if you construct a query string interactively,
  467. you can then use it to define a custom command."
  468. :group 'org-agenda-custom-commands
  469. :type 'character)
  470. (defcustom org-stuck-projects
  471. '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
  472. "How to identify stuck projects.
  473. This is a list of four items:
  474. 1. A tags/todo/property matcher string that is used to identify a project.
  475. See the manual for a description of tag and property searches.
  476. The entire tree below a headline matched by this is considered one project.
  477. 2. A list of TODO keywords identifying non-stuck projects.
  478. If the project subtree contains any headline with one of these todo
  479. keywords, the project is considered to be not stuck. If you specify
  480. \"*\" as a keyword, any TODO keyword will mark the project unstuck.
  481. 3. A list of tags identifying non-stuck projects.
  482. If the project subtree contains any headline with one of these tags,
  483. the project is considered to be not stuck. If you specify \"*\" as
  484. a tag, any tag will mark the project unstuck. Note that this is about
  485. the explicit presence of a tag somewhere in the subtree, inherited
  486. tags to not count here. If inherited tags make a project not stuck,
  487. use \"-TAG\" in the tags part of the matcher under (1.) above.
  488. 4. An arbitrary regular expression matching non-stuck projects.
  489. If the project turns out to be not stuck, search continues also in the
  490. subtree to see if any of the subtasks have project status.
  491. See also the variable `org-tags-match-list-sublevels' which applies
  492. to projects matched by this search as well.
  493. After defining this variable, you may use \\[org-agenda-list-stuck-projects]
  494. or `C-c a #' to produce the list."
  495. :group 'org-agenda-custom-commands
  496. :type '(list
  497. (string :tag "Tags/TODO match to identify a project")
  498. (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
  499. (repeat :tag "Projects are *not* stuck if they have an entry with TAG being any of" (string))
  500. (regexp :tag "Projects are *not* stuck if this regexp matches inside the subtree")))
  501. (defcustom org-agenda-filter-effort-default-operator "<"
  502. "The default operator for effort estimate filtering.
  503. If you select an effort estimate limit without first pressing an operator,
  504. this one will be used."
  505. :group 'org-agenda-custom-commands
  506. :type '(choice (const :tag "less or equal" "<")
  507. (const :tag "greater or equal"">")
  508. (const :tag "equal" "=")))
  509. (defgroup org-agenda-skip nil
  510. "Options concerning skipping parts of agenda files."
  511. :tag "Org Agenda Skip"
  512. :group 'org-agenda)
  513. (defcustom org-agenda-skip-function-global nil
  514. "Function to be called at each match during agenda construction.
  515. If this function returns nil, the current match should not be skipped.
  516. If the function decided to skip an agenda match, is must return the
  517. buffer position from which the search should be continued.
  518. This may also be a Lisp form, which will be evaluated.
  519. This variable will be applied to every agenda match, including
  520. tags/property searches and TODO lists. So try to make the test function
  521. do its checking as efficiently as possible. To implement a skipping
  522. condition just for specific agenda commands, use the variable
  523. `org-agenda-skip-function' which can be set in the options section
  524. of custom agenda commands."
  525. :group 'org-agenda-skip
  526. :type 'sexp)
  527. (defgroup org-agenda-daily/weekly nil
  528. "Options concerning the daily/weekly agenda."
  529. :tag "Org Agenda Daily/Weekly"
  530. :group 'org-agenda)
  531. (defgroup org-agenda-todo-list nil
  532. "Options concerning the global todo list agenda view."
  533. :tag "Org Agenda Todo List"
  534. :group 'org-agenda)
  535. (defgroup org-agenda-match-view nil
  536. "Options concerning the general tags/property/todo match agenda view."
  537. :tag "Org Agenda Match View"
  538. :group 'org-agenda)
  539. (defgroup org-agenda-search-view nil
  540. "Options concerning the general tags/property/todo match agenda view."
  541. :tag "Org Agenda Match View"
  542. :group 'org-agenda)
  543. (defvar org-agenda-archives-mode nil
  544. "Non-nil means the agenda will include archived items.
  545. If this is the symbol `trees', trees in the selected agenda scope
  546. that are marked with the ARCHIVE tag will be included anyway. When this is
  547. t, also all archive files associated with the current selection of agenda
  548. files will be included.")
  549. (defcustom org-agenda-skip-comment-trees t
  550. "Non-nil means skip trees that start with the COMMENT keyword.
  551. When nil, these trees are also scanned by agenda commands."
  552. :group 'org-agenda-skip
  553. :type 'boolean)
  554. (defcustom org-agenda-todo-list-sublevels t
  555. "Non-nil means check also the sublevels of a TODO entry for TODO entries.
  556. When nil, the sublevels of a TODO entry are not checked, resulting in
  557. potentially much shorter TODO lists."
  558. :group 'org-agenda-skip
  559. :group 'org-agenda-todo-list
  560. :type 'boolean)
  561. (defcustom org-agenda-todo-ignore-with-date nil
  562. "Non-nil means don't show entries with a date in the global todo list.
  563. You can use this if you prefer to mark mere appointments with a TODO keyword,
  564. but don't want them to show up in the TODO list.
  565. When this is set, it also covers deadlines and scheduled items, the settings
  566. of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
  567. will be ignored.
  568. See also the variable `org-agenda-tags-todo-honor-ignore-options'."
  569. :group 'org-agenda-skip
  570. :group 'org-agenda-todo-list
  571. :type 'boolean)
  572. (defcustom org-agenda-todo-ignore-timestamp nil
  573. "Non-nil means don't show entries with a timestamp.
  574. This applies when creating the global todo list.
  575. Valid values are:
  576. past Don't show entries for today or in the past.
  577. future Don't show entries with a timestamp in the future.
  578. The idea behind this is that if it has a future
  579. timestamp, you don't want to think about it until the
  580. date.
  581. all Don't show any entries with a timestamp in the global todo list.
  582. The idea behind this is that by setting a timestamp, you
  583. have already \"taken care\" of this item.
  584. This variable can also have an integer as a value. If positive (N),
  585. todos with a timestamp N or more days in the future will be ignored. If
  586. negative (-N), todos with a timestamp N or more days in the past will be
  587. ignored. If 0, todos with a timestamp either today or in the future will
  588. be ignored. For example, a value of -1 will exclude todos with a
  589. timestamp in the past (yesterday or earlier), while a value of 7 will
  590. exclude todos with a timestamp a week or more in the future.
  591. See also `org-agenda-todo-ignore-with-date'.
  592. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  593. to make his option also apply to the tags-todo list."
  594. :group 'org-agenda-skip
  595. :group 'org-agenda-todo-list
  596. :version "24.1"
  597. :type '(choice
  598. (const :tag "Ignore future timestamp todos" future)
  599. (const :tag "Ignore past or present timestamp todos" past)
  600. (const :tag "Ignore all timestamp todos" all)
  601. (const :tag "Show timestamp todos" nil)
  602. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  603. (defcustom org-agenda-todo-ignore-scheduled nil
  604. "Non-nil means, ignore some scheduled TODO items when making TODO list.
  605. This applies when creating the global todo list.
  606. Valid values are:
  607. past Don't show entries scheduled today or in the past.
  608. future Don't show entries scheduled in the future.
  609. The idea behind this is that by scheduling it, you don't want to
  610. think about it until the scheduled date.
  611. all Don't show any scheduled entries in the global todo list.
  612. The idea behind this is that by scheduling it, you have already
  613. \"taken care\" of this item.
  614. t Same as `all', for backward compatibility.
  615. This variable can also have an integer as a value. See
  616. `org-agenda-todo-ignore-timestamp' for more details.
  617. See also `org-agenda-todo-ignore-with-date'.
  618. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  619. to make his option also apply to the tags-todo list."
  620. :group 'org-agenda-skip
  621. :group 'org-agenda-todo-list
  622. :type '(choice
  623. (const :tag "Ignore future-scheduled todos" future)
  624. (const :tag "Ignore past- or present-scheduled todos" past)
  625. (const :tag "Ignore all scheduled todos" all)
  626. (const :tag "Ignore all scheduled todos (compatibility)" t)
  627. (const :tag "Show scheduled todos" nil)
  628. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  629. (defcustom org-agenda-todo-ignore-deadlines nil
  630. "Non-nil means ignore some deadlined TODO items when making TODO list.
  631. There are different motivations for using different values, please think
  632. carefully when configuring this variable.
  633. This applies when creating the global todo list.
  634. Valid values are:
  635. near Don't show near deadline entries. A deadline is near when it is
  636. closer than `org-deadline-warning-days' days. The idea behind this
  637. is that such items will appear in the agenda anyway.
  638. far Don't show TODO entries where a deadline has been defined, but
  639. the deadline is not near. This is useful if you don't want to
  640. use the todo list to figure out what to do now.
  641. past Don't show entries with a deadline timestamp for today or in the past.
  642. future Don't show entries with a deadline timestamp in the future, not even
  643. when they become `near' ones. Use it with caution.
  644. all Ignore all TODO entries that do have a deadline.
  645. t Same as `near', for backward compatibility.
  646. This variable can also have an integer as a value. See
  647. `org-agenda-todo-ignore-timestamp' for more details.
  648. See also `org-agenda-todo-ignore-with-date'.
  649. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  650. to make his option also apply to the tags-todo list."
  651. :group 'org-agenda-skip
  652. :group 'org-agenda-todo-list
  653. :type '(choice
  654. (const :tag "Ignore near deadlines" near)
  655. (const :tag "Ignore near deadlines (compatibility)" t)
  656. (const :tag "Ignore far deadlines" far)
  657. (const :tag "Ignore all TODOs with a deadlines" all)
  658. (const :tag "Show all TODOs, even if they have a deadline" nil)
  659. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  660. (defcustom org-agenda-todo-ignore-time-comparison-use-seconds nil
  661. "Time unit to use when possibly ignoring an agenda item.
  662. See the docstring of various `org-agenda-todo-ignore-*' options.
  663. The default is to compare time stamps using days. An item is thus
  664. considered to be in the future if it is at least one day after today.
  665. Non-nil means to compare time stamps using seconds. An item is then
  666. considered future if it has a time value later than current time."
  667. :group 'org-agenda-skip
  668. :group 'org-agenda-todo-list
  669. :type '(choice
  670. (const :tag "Compare time with days" nil)
  671. (const :tag "Compare time with seconds" t)))
  672. (defcustom org-agenda-tags-todo-honor-ignore-options nil
  673. "Non-nil means honor todo-list ...ignore options also in tags-todo search.
  674. The variables
  675. `org-agenda-todo-ignore-with-date',
  676. `org-agenda-todo-ignore-timestamp',
  677. `org-agenda-todo-ignore-scheduled',
  678. `org-agenda-todo-ignore-deadlines'
  679. make the global TODO list skip entries that have time stamps of certain
  680. kinds. If this option is set, the same options will also apply for the
  681. tags-todo search, which is the general tags/property matcher
  682. restricted to unfinished TODO entries only."
  683. :group 'org-agenda-skip
  684. :group 'org-agenda-todo-list
  685. :group 'org-agenda-match-view
  686. :type 'boolean)
  687. (defcustom org-agenda-skip-scheduled-if-done nil
  688. "Non-nil means don't show scheduled items in agenda when they are done.
  689. This is relevant for the daily/weekly agenda, not for the TODO list. And
  690. it applies only to the actual date of the scheduling. Warnings about
  691. an item with a past scheduling dates are always turned off when the item
  692. is DONE."
  693. :group 'org-agenda-skip
  694. :group 'org-agenda-daily/weekly
  695. :type 'boolean)
  696. (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
  697. "Non-nil means skip scheduling line if same entry shows because of deadline.
  698. In the agenda of today, an entry can show up multiple times because
  699. it is both scheduled and has a nearby deadline, and maybe a plain time
  700. stamp as well.
  701. When this variable is t, then only the deadline is shown and the fact that
  702. the entry is scheduled today or was scheduled previously is not shown.
  703. When this variable is nil, the entry will be shown several times. When
  704. the variable is the symbol `not-today', then skip scheduled previously,
  705. but not scheduled today."
  706. :group 'org-agenda-skip
  707. :group 'org-agenda-daily/weekly
  708. :type '(choice
  709. (const :tag "Never" nil)
  710. (const :tag "Always" t)
  711. (const :tag "Not when scheduled today" not-today)))
  712. (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
  713. "Non-nil means skip timestamp line if same entry shows because of deadline.
  714. In the agenda of today, an entry can show up multiple times
  715. because it has both a plain timestamp and has a nearby deadline.
  716. When this variable is t, then only the deadline is shown and the
  717. fact that the entry has a timestamp for or including today is not
  718. shown. When this variable is nil, the entry will be shown
  719. several times."
  720. :group 'org-agenda-skip
  721. :group 'org-agenda-daily/weekly
  722. :version "24.1"
  723. :type '(choice
  724. (const :tag "Never" nil)
  725. (const :tag "Always" t)))
  726. (defcustom org-agenda-skip-deadline-if-done nil
  727. "Non-nil means don't show deadlines when the corresponding item is done.
  728. When nil, the deadline is still shown and should give you a happy feeling.
  729. This is relevant for the daily/weekly agenda. And it applied only to the
  730. actually date of the deadline. Warnings about approaching and past-due
  731. deadlines are always turned off when the item is DONE."
  732. :group 'org-agenda-skip
  733. :group 'org-agenda-daily/weekly
  734. :type 'boolean)
  735. (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
  736. "Non-nil means skip deadline prewarning when entry is also scheduled.
  737. This will apply on all days where a prewarning for the deadline would
  738. be shown, but not at the day when the entry is actually due. On that day,
  739. the deadline will be shown anyway.
  740. This variable may be set to nil, t, the symbol `pre-scheduled',
  741. or a number which will then give the number of days before the actual
  742. deadline when the prewarnings should resume. The symbol `pre-scheduled'
  743. eliminates the deadline prewarning only prior to the scheduled date.
  744. This can be used in a workflow where the first showing of the deadline will
  745. trigger you to schedule it, and then you don't want to be reminded of it
  746. because you will take care of it on the day when scheduled."
  747. :group 'org-agenda-skip
  748. :group 'org-agenda-daily/weekly
  749. :version "24.1"
  750. :type '(choice
  751. (const :tag "Always show prewarning" nil)
  752. (const :tag "Remove prewarning prior to scheduled date" pre-scheduled)
  753. (const :tag "Remove prewarning if entry is scheduled" t)
  754. (integer :tag "Restart prewarning N days before deadline")))
  755. (defcustom org-agenda-skip-additional-timestamps-same-entry nil
  756. "When nil, multiple same-day timestamps in entry make multiple agenda lines.
  757. When non-nil, after the search for timestamps has matched once in an
  758. entry, the rest of the entry will not be searched."
  759. :group 'org-agenda-skip
  760. :type 'boolean)
  761. (defcustom org-agenda-skip-timestamp-if-done nil
  762. "Non-nil means don't select item by timestamp or -range if it is DONE."
  763. :group 'org-agenda-skip
  764. :group 'org-agenda-daily/weekly
  765. :type 'boolean)
  766. (defcustom org-agenda-dim-blocked-tasks nil
  767. "Non-nil means dim blocked tasks in the agenda display.
  768. This causes some overhead during agenda construction, but if you
  769. have turned on `org-enforce-todo-dependencies',
  770. `org-enforce-todo-checkbox-dependencies', or any other blocking
  771. mechanism, this will create useful feedback in the agenda.
  772. Instead of t, this variable can also have the value `invisible'.
  773. Then blocked tasks will be invisible and only become visible when
  774. they become unblocked. An exemption to this behavior is when a task is
  775. blocked because of unchecked checkboxes below it. Since checkboxes do
  776. not show up in the agenda views, making this task invisible you remove any
  777. trace from agenda views that there is something to do. Therefore, a task
  778. that is blocked because of checkboxes will never be made invisible, it
  779. will only be dimmed."
  780. :group 'org-agenda-daily/weekly
  781. :group 'org-agenda-todo-list
  782. :version "24.3"
  783. :type '(choice
  784. (const :tag "Do not dim" nil)
  785. (const :tag "Dim to a gray face" t)
  786. (const :tag "Make invisible" invisible)))
  787. (defcustom org-timeline-show-empty-dates 3
  788. "Non-nil means `org-timeline' also shows dates without an entry.
  789. When nil, only the days which actually have entries are shown.
  790. When t, all days between the first and the last date are shown.
  791. When an integer, show also empty dates, but if there is a gap of more than
  792. N days, just insert a special line indicating the size of the gap."
  793. :group 'org-agenda-skip
  794. :type '(choice
  795. (const :tag "None" nil)
  796. (const :tag "All" t)
  797. (integer :tag "at most")))
  798. (defgroup org-agenda-startup nil
  799. "Options concerning initial settings in the Agenda in Org Mode."
  800. :tag "Org Agenda Startup"
  801. :group 'org-agenda)
  802. (defcustom org-agenda-menu-show-matcher t
  803. "Non-nil means show the match string in the agenda dispatcher menu.
  804. When nil, the matcher string is not shown, but is put into the help-echo
  805. property so than moving the mouse over the command shows it.
  806. Setting it to nil is good if matcher strings are very long and/or if
  807. you want to use two-columns display (see `org-agenda-menu-two-columns')."
  808. :group 'org-agenda
  809. :version "24.1"
  810. :type 'boolean)
  811. (define-obsolete-variable-alias 'org-agenda-menu-two-column 'org-agenda-menu-two-columns "24.3")
  812. (defcustom org-agenda-menu-two-columns nil
  813. "Non-nil means, use two columns to show custom commands in the dispatcher.
  814. If you use this, you probably want to set `org-agenda-menu-show-matcher'
  815. to nil."
  816. :group 'org-agenda
  817. :version "24.1"
  818. :type 'boolean)
  819. (define-obsolete-variable-alias 'org-finalize-agenda-hook 'org-agenda-finalize-hook "24.3")
  820. (defcustom org-agenda-finalize-hook nil
  821. "Hook run just before displaying an agenda buffer.
  822. The buffer is still writable when the hook is called.
  823. You can modify some of the buffer substrings but you should be
  824. extra careful not to modify the text properties of the agenda
  825. headlines as the agenda display heavily relies on them."
  826. :group 'org-agenda-startup
  827. :type 'hook)
  828. (defcustom org-agenda-mouse-1-follows-link nil
  829. "Non-nil means mouse-1 on a link will follow the link in the agenda.
  830. A longer mouse click will still set point. Does not work on XEmacs.
  831. Needs to be set before org.el is loaded."
  832. :group 'org-agenda-startup
  833. :type 'boolean)
  834. (defcustom org-agenda-start-with-follow-mode nil
  835. "The initial value of follow mode in a newly created agenda window."
  836. :group 'org-agenda-startup
  837. :type 'boolean)
  838. (defcustom org-agenda-follow-indirect nil
  839. "Non-nil means `org-agenda-follow-mode' displays only the
  840. current item's tree, in an indirect buffer."
  841. :group 'org-agenda
  842. :version "24.1"
  843. :type 'boolean)
  844. (defcustom org-agenda-show-outline-path t
  845. "Non-nil means show outline path in echo area after line motion."
  846. :group 'org-agenda-startup
  847. :type 'boolean)
  848. (defcustom org-agenda-start-with-entry-text-mode nil
  849. "The initial value of entry-text-mode in a newly created agenda window."
  850. :group 'org-agenda-startup
  851. :type 'boolean)
  852. (defcustom org-agenda-entry-text-maxlines 5
  853. "Number of text lines to be added when `E' is pressed in the agenda.
  854. Note that this variable only used during agenda display. Add add entry text
  855. when exporting the agenda, configure the variable
  856. `org-agenda-add-entry-ext-maxlines'."
  857. :group 'org-agenda
  858. :type 'integer)
  859. (defcustom org-agenda-entry-text-exclude-regexps nil
  860. "List of regular expressions to clean up entry text.
  861. The complete matches of all regular expressions in this list will be
  862. removed from entry text before it is shown in the agenda."
  863. :group 'org-agenda
  864. :type '(repeat (regexp)))
  865. (defvar org-agenda-entry-text-cleanup-hook nil
  866. "Hook that is run after basic cleanup of entry text to be shown in agenda.
  867. This cleanup is done in a temporary buffer, so the function may inspect and
  868. change the entire buffer.
  869. Some default stuff like drawers and scheduling/deadline dates will already
  870. have been removed when this is called, as will any matches for regular
  871. expressions listed in `org-agenda-entry-text-exclude-regexps'.")
  872. (defvar org-agenda-include-inactive-timestamps nil
  873. "Non-nil means include inactive time stamps in agenda and timeline.
  874. Dynamically scoped.")
  875. (defgroup org-agenda-windows nil
  876. "Options concerning the windows used by the Agenda in Org Mode."
  877. :tag "Org Agenda Windows"
  878. :group 'org-agenda)
  879. (defcustom org-agenda-window-setup 'reorganize-frame
  880. "How the agenda buffer should be displayed.
  881. Possible values for this option are:
  882. current-window Show agenda in the current window, keeping all other windows.
  883. other-window Use `switch-to-buffer-other-window' to display agenda.
  884. reorganize-frame Show only two windows on the current frame, the current
  885. window and the agenda.
  886. other-frame Use `switch-to-buffer-other-frame' to display agenda.
  887. Also, when exiting the agenda, kill that frame.
  888. See also the variable `org-agenda-restore-windows-after-quit'."
  889. :group 'org-agenda-windows
  890. :type '(choice
  891. (const current-window)
  892. (const other-frame)
  893. (const other-window)
  894. (const reorganize-frame)))
  895. (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
  896. "The min and max height of the agenda window as a fraction of frame height.
  897. The value of the variable is a cons cell with two numbers between 0 and 1.
  898. It only matters if `org-agenda-window-setup' is `reorganize-frame'."
  899. :group 'org-agenda-windows
  900. :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
  901. (defcustom org-agenda-restore-windows-after-quit nil
  902. "Non-nil means restore window configuration upon exiting agenda.
  903. Before the window configuration is changed for displaying the agenda,
  904. the current status is recorded. When the agenda is exited with
  905. `q' or `x' and this option is set, the old state is restored. If
  906. `org-agenda-window-setup' is `other-frame', the value of this
  907. option will be ignored."
  908. :group 'org-agenda-windows
  909. :type 'boolean)
  910. (defcustom org-agenda-ndays nil
  911. "Number of days to include in overview display.
  912. Should be 1 or 7.
  913. Obsolete, see `org-agenda-span'."
  914. :group 'org-agenda-daily/weekly
  915. :type 'integer)
  916. (make-obsolete-variable 'org-agenda-ndays 'org-agenda-span "24.1")
  917. (defcustom org-agenda-span 'week
  918. "Number of days to include in overview display.
  919. Can be day, week, month, year, or any number of days.
  920. Custom commands can set this variable in the options section."
  921. :group 'org-agenda-daily/weekly
  922. :type '(choice (const :tag "Day" day)
  923. (const :tag "Week" week)
  924. (const :tag "Month" month)
  925. (const :tag "Year" year)
  926. (integer :tag "Custom")))
  927. (defcustom org-agenda-start-on-weekday 1
  928. "Non-nil means start the overview always on the specified weekday.
  929. 0 denotes Sunday, 1 denotes Monday etc.
  930. When nil, always start on the current day.
  931. Custom commands can set this variable in the options section."
  932. :group 'org-agenda-daily/weekly
  933. :type '(choice (const :tag "Today" nil)
  934. (integer :tag "Weekday No.")))
  935. (defcustom org-agenda-show-all-dates t
  936. "Non-nil means `org-agenda' shows every day in the selected range.
  937. When nil, only the days which actually have entries are shown."
  938. :group 'org-agenda-daily/weekly
  939. :type 'boolean)
  940. (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
  941. "Format string for displaying dates in the agenda.
  942. Used by the daily/weekly agenda and by the timeline. This should be
  943. a format string understood by `format-time-string', or a function returning
  944. the formatted date as a string. The function must take a single argument,
  945. a calendar-style date list like (month day year)."
  946. :group 'org-agenda-daily/weekly
  947. :type '(choice
  948. (string :tag "Format string")
  949. (function :tag "Function")))
  950. (defun org-agenda-format-date-aligned (date)
  951. "Format a date string for display in the daily/weekly agenda, or timeline.
  952. This function makes sure that dates are aligned for easy reading."
  953. (require 'cal-iso)
  954. (let* ((dayname (calendar-day-name date))
  955. (day (cadr date))
  956. (day-of-week (calendar-day-of-week date))
  957. (month (car date))
  958. (monthname (calendar-month-name month))
  959. (year (nth 2 date))
  960. (iso-week (org-days-to-iso-week
  961. (calendar-absolute-from-gregorian date)))
  962. (weekyear (cond ((and (= month 1) (>= iso-week 52))
  963. (1- year))
  964. ((and (= month 12) (<= iso-week 1))
  965. (1+ year))
  966. (t year)))
  967. (weekstring (if (= day-of-week 1)
  968. (format " W%02d" iso-week)
  969. "")))
  970. (format "%-10s %2d %s %4d%s"
  971. dayname day monthname year weekstring)))
  972. (defcustom org-agenda-time-leading-zero nil
  973. "Non-nil means use leading zero for military times in agenda.
  974. For example, 9:30am would become 09:30 rather than 9:30."
  975. :group 'org-agenda-daily/weekly
  976. :version "24.1"
  977. :type 'boolean)
  978. (defcustom org-agenda-timegrid-use-ampm nil
  979. "When set, show AM/PM style timestamps on the timegrid."
  980. :group 'org-agenda
  981. :version "24.1"
  982. :type 'boolean)
  983. (defun org-agenda-time-of-day-to-ampm (time)
  984. "Convert TIME of a string like '13:45' to an AM/PM style time string."
  985. (let* ((hour-number (string-to-number (substring time 0 -3)))
  986. (minute (substring time -2))
  987. (ampm "am"))
  988. (cond
  989. ((equal hour-number 12)
  990. (setq ampm "pm"))
  991. ((> hour-number 12)
  992. (setq ampm "pm")
  993. (setq hour-number (- hour-number 12))))
  994. (concat
  995. (if org-agenda-time-leading-zero
  996. (format "%02d" hour-number)
  997. (format "%02s" (number-to-string hour-number)))
  998. ":" minute ampm)))
  999. (defun org-agenda-time-of-day-to-ampm-maybe (time)
  1000. "Conditionally convert TIME to AM/PM format
  1001. based on `org-agenda-timegrid-use-ampm'"
  1002. (if org-agenda-timegrid-use-ampm
  1003. (org-agenda-time-of-day-to-ampm time)
  1004. time))
  1005. (defcustom org-agenda-weekend-days '(6 0)
  1006. "Which days are weekend?
  1007. These days get the special face `org-agenda-date-weekend' in the agenda
  1008. and timeline buffers."
  1009. :group 'org-agenda-daily/weekly
  1010. :type '(set :greedy t
  1011. (const :tag "Monday" 1)
  1012. (const :tag "Tuesday" 2)
  1013. (const :tag "Wednesday" 3)
  1014. (const :tag "Thursday" 4)
  1015. (const :tag "Friday" 5)
  1016. (const :tag "Saturday" 6)
  1017. (const :tag "Sunday" 0)))
  1018. (defcustom org-agenda-move-date-from-past-immediately-to-today t
  1019. "Non-nil means jump to today when moving a past date forward in time.
  1020. When using S-right in the agenda to move a a date forward, and the date
  1021. stamp currently points to the past, the first key press will move it
  1022. to today. WHen nil, just move one day forward even if the date stays
  1023. in the past."
  1024. :group 'org-agenda-daily/weekly
  1025. :version "24.1"
  1026. :type 'boolean)
  1027. (defcustom org-agenda-include-diary nil
  1028. "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
  1029. Custom commands can set this variable in the options section."
  1030. :group 'org-agenda-daily/weekly
  1031. :type 'boolean)
  1032. (defcustom org-agenda-include-deadlines t
  1033. "If non-nil, include entries within their deadline warning period.
  1034. Custom commands can set this variable in the options section."
  1035. :group 'org-agenda-daily/weekly
  1036. :version "24.1"
  1037. :type 'boolean)
  1038. (defcustom org-agenda-repeating-timestamp-show-all t
  1039. "Non-nil means show all occurrences of a repeating stamp in the agenda.
  1040. When set to a list of strings, only show occurrences of repeating
  1041. stamps for these TODO keywords. When nil, only one occurrence is
  1042. shown, either today or the nearest into the future."
  1043. :group 'org-agenda-daily/weekly
  1044. :type '(choice
  1045. (const :tag "Show repeating stamps" t)
  1046. (repeat :tag "Show repeating stamps for these TODO keywords"
  1047. (string :tag "TODO Keyword"))
  1048. (const :tag "Don't show repeating stamps" nil)))
  1049. (defcustom org-scheduled-past-days 10000
  1050. "No. of days to continue listing scheduled items that are not marked DONE.
  1051. When an item is scheduled on a date, it shows up in the agenda on this
  1052. day and will be listed until it is marked done for the number of days
  1053. given here."
  1054. :group 'org-agenda-daily/weekly
  1055. :type 'integer)
  1056. (defcustom org-agenda-log-mode-items '(closed clock)
  1057. "List of items that should be shown in agenda log mode.
  1058. This list may contain the following symbols:
  1059. closed Show entries that have been closed on that day.
  1060. clock Show entries that have received clocked time on that day.
  1061. state Show all logged state changes.
  1062. Note that instead of changing this variable, you can also press `C-u l' in
  1063. the agenda to display all available LOG items temporarily."
  1064. :group 'org-agenda-daily/weekly
  1065. :type '(set :greedy t (const closed) (const clock) (const state)))
  1066. (defcustom org-agenda-clock-consistency-checks
  1067. '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
  1068. :gap-ok-around ("4:00")
  1069. :default-face ((:background "DarkRed") (:foreground "white"))
  1070. :overlap-face nil :gap-face nil :no-end-time-face nil
  1071. :long-face nil :short-face nil)
  1072. "This is a property list, with the following keys:
  1073. :max-duration Mark clocking chunks that are longer than this time.
  1074. This is a time string like \"HH:MM\", or the number
  1075. of minutes as an integer.
  1076. :min-duration Mark clocking chunks that are shorter that this.
  1077. This is a time string like \"HH:MM\", or the number
  1078. of minutes as an integer.
  1079. :max-gap Mark gaps between clocking chunks that are longer than
  1080. this duration. A number of minutes, or a string
  1081. like \"HH:MM\".
  1082. :gap-ok-around List of times during the day which are usually not working
  1083. times. When a gap is detected, but the gap contains any
  1084. of these times, the gap is *not* reported. For example,
  1085. if this is (\"4:00\" \"13:00\") then gaps that contain
  1086. 4:00 in the morning (i.e. the night) and 13:00
  1087. (i.e. a typical lunch time) do not cause a warning.
  1088. You should have at least one time during the night in this
  1089. list, or otherwise the first task each morning will trigger
  1090. a warning because it follows a long gap.
  1091. Furthermore, the following properties can be used to define faces for
  1092. issue display.
  1093. :default-face the default face, if the specific face is undefined
  1094. :overlap-face face for overlapping clocks
  1095. :gap-face face for gaps between clocks
  1096. :no-end-time-face face for incomplete clocks
  1097. :long-face face for clock intervals that are too long
  1098. :short-face face for clock intervals that are too short"
  1099. :group 'org-agenda-daily/weekly
  1100. :group 'org-clock
  1101. :version "24.1"
  1102. :type 'plist)
  1103. (defcustom org-agenda-log-mode-add-notes t
  1104. "Non-nil means add first line of notes to log entries in agenda views.
  1105. If a log item like a state change or a clock entry is associated with
  1106. notes, the first line of these notes will be added to the entry in the
  1107. agenda display."
  1108. :group 'org-agenda-daily/weekly
  1109. :type 'boolean)
  1110. (defcustom org-agenda-start-with-log-mode nil
  1111. "The initial value of log-mode in a newly created agenda window.
  1112. See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
  1113. explanations on the possible values."
  1114. :group 'org-agenda-startup
  1115. :group 'org-agenda-daily/weekly
  1116. :type '(choice (const :tag "Don't show log items" nil)
  1117. (const :tag "Show only log items" 'only)
  1118. (const :tag "Show all possible log items" 'clockcheck)
  1119. (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
  1120. (choice (const :tag "Show closed log items" 'closed)
  1121. (const :tag "Show clocked log items" 'clock)
  1122. (const :tag "Show all logged state changes" 'state)))))
  1123. (defcustom org-agenda-start-with-clockreport-mode nil
  1124. "The initial value of clockreport-mode in a newly created agenda window."
  1125. :group 'org-agenda-startup
  1126. :group 'org-agenda-daily/weekly
  1127. :type 'boolean)
  1128. (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
  1129. "Property list with parameters for the clocktable in clockreport mode.
  1130. This is the display mode that shows a clock table in the daily/weekly
  1131. agenda, the properties for this dynamic block can be set here.
  1132. The usual clocktable parameters are allowed here, but you cannot set
  1133. the properties :name, :tstart, :tend, :block, and :scope - these will
  1134. be overwritten to make sure the content accurately reflects the
  1135. current display in the agenda."
  1136. :group 'org-agenda-daily/weekly
  1137. :type 'plist)
  1138. (defcustom org-agenda-search-view-always-boolean nil
  1139. "Non-nil means the search string is interpreted as individual parts.
  1140. The search string for search view can either be interpreted as a phrase,
  1141. or as a list of snippets that define a boolean search for a number of
  1142. strings.
  1143. When this is non-nil, the string will be split on whitespace, and each
  1144. snippet will be searched individually, and all must match in order to
  1145. select an entry. A snippet is then a single string of non-white
  1146. characters, or a string in double quotes, or a regexp in {} braces.
  1147. If a snippet is preceded by \"-\", the snippet must *not* match.
  1148. \"+\" is syntactic sugar for positive selection. Each snippet may
  1149. be found as a full word or a partial word, but see the variable
  1150. `org-agenda-search-view-force-full-words'.
  1151. When this is nil, search will look for the entire search phrase as one,
  1152. with each space character matching any amount of whitespace, including
  1153. line breaks.
  1154. Even when this is nil, you can still switch to Boolean search dynamically
  1155. by preceding the first snippet with \"+\" or \"-\". If the first snippet
  1156. is a regexp marked with braces like \"{abc}\", this will also switch to
  1157. boolean search."
  1158. :group 'org-agenda-search-view
  1159. :version "24.1"
  1160. :type 'boolean)
  1161. (if (fboundp 'defvaralias)
  1162. (defvaralias 'org-agenda-search-view-search-words-only
  1163. 'org-agenda-search-view-always-boolean))
  1164. (defcustom org-agenda-search-view-force-full-words nil
  1165. "Non-nil means, search words must be matches as complete words.
  1166. When nil, they may also match part of a word."
  1167. :group 'org-agenda-search-view
  1168. :version "24.1"
  1169. :type 'boolean)
  1170. (defcustom org-agenda-search-view-max-outline-level nil
  1171. "Maximum outline level to display in search view.
  1172. E.g. when this is set to 1, the search view will only
  1173. show headlines of level 1."
  1174. :group 'org-agenda-search-view
  1175. :version "24.3"
  1176. :type 'integer)
  1177. (defgroup org-agenda-time-grid nil
  1178. "Options concerning the time grid in the Org-mode Agenda."
  1179. :tag "Org Agenda Time Grid"
  1180. :group 'org-agenda)
  1181. (defcustom org-agenda-search-headline-for-time t
  1182. "Non-nil means search headline for a time-of-day.
  1183. If the headline contains a time-of-day in one format or another, it will
  1184. be used to sort the entry into the time sequence of items for a day.
  1185. Some people have time stamps in the headline that refer to the creation
  1186. time or so, and then this produces an unwanted side effect. If this is
  1187. the case for your, use this variable to turn off searching the headline
  1188. for a time."
  1189. :group 'org-agenda-time-grid
  1190. :type 'boolean)
  1191. (defcustom org-agenda-use-time-grid t
  1192. "Non-nil means show a time grid in the agenda schedule.
  1193. A time grid is a set of lines for specific times (like every two hours between
  1194. 8:00 and 20:00). The items scheduled for a day at specific times are
  1195. sorted in between these lines.
  1196. For details about when the grid will be shown, and what it will look like, see
  1197. the variable `org-agenda-time-grid'."
  1198. :group 'org-agenda-time-grid
  1199. :type 'boolean)
  1200. (defcustom org-agenda-time-grid
  1201. '((daily today require-timed)
  1202. "----------------"
  1203. (800 1000 1200 1400 1600 1800 2000))
  1204. "The settings for time grid for agenda display.
  1205. This is a list of three items. The first item is again a list. It contains
  1206. symbols specifying conditions when the grid should be displayed:
  1207. daily if the agenda shows a single day
  1208. weekly if the agenda shows an entire week
  1209. today show grid on current date, independent of daily/weekly display
  1210. require-timed show grid only if at least one item has a time specification
  1211. The second item is a string which will be placed behind the grid time.
  1212. The third item is a list of integers, indicating the times that should have
  1213. a grid line."
  1214. :group 'org-agenda-time-grid
  1215. :type
  1216. '(list
  1217. (set :greedy t :tag "Grid Display Options"
  1218. (const :tag "Show grid in single day agenda display" daily)
  1219. (const :tag "Show grid in weekly agenda display" weekly)
  1220. (const :tag "Always show grid for today" today)
  1221. (const :tag "Show grid only if any timed entries are present"
  1222. require-timed)
  1223. (const :tag "Skip grid times already present in an entry"
  1224. remove-match))
  1225. (string :tag "Grid String")
  1226. (repeat :tag "Grid Times" (integer :tag "Time"))))
  1227. (defcustom org-agenda-show-current-time-in-grid t
  1228. "Non-nil means show the current time in the time grid."
  1229. :group 'org-agenda-time-grid
  1230. :version "24.1"
  1231. :type 'boolean)
  1232. (defcustom org-agenda-current-time-string
  1233. "now - - - - - - - - - - - - - - - - - - - - - - - - -"
  1234. "The string for the current time marker in the agenda."
  1235. :group 'org-agenda-time-grid
  1236. :version "24.1"
  1237. :type 'string)
  1238. (defgroup org-agenda-sorting nil
  1239. "Options concerning sorting in the Org-mode Agenda."
  1240. :tag "Org Agenda Sorting"
  1241. :group 'org-agenda)
  1242. (defcustom org-agenda-sorting-strategy
  1243. '((agenda habit-down time-up priority-down category-keep)
  1244. (todo priority-down category-keep)
  1245. (tags priority-down category-keep)
  1246. (search category-keep))
  1247. "Sorting structure for the agenda items of a single day.
  1248. This is a list of symbols which will be used in sequence to determine
  1249. if an entry should be listed before another entry. The following
  1250. symbols are recognized:
  1251. time-up Put entries with time-of-day indications first, early first
  1252. time-down Put entries with time-of-day indications first, late first
  1253. category-keep Keep the default order of categories, corresponding to the
  1254. sequence in `org-agenda-files'.
  1255. category-up Sort alphabetically by category, A-Z.
  1256. category-down Sort alphabetically by category, Z-A.
  1257. tag-up Sort alphabetically by last tag, A-Z.
  1258. tag-down Sort alphabetically by last tag, Z-A.
  1259. priority-up Sort numerically by priority, high priority last.
  1260. priority-down Sort numerically by priority, high priority first.
  1261. todo-state-up Sort by todo state, tasks that are done last.
  1262. todo-state-down Sort by todo state, tasks that are done first.
  1263. effort-up Sort numerically by estimated effort, high effort last.
  1264. effort-down Sort numerically by estimated effort, high effort first.
  1265. user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
  1266. user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
  1267. habit-up Put entries that are habits first
  1268. habit-down Put entries that are habits last
  1269. alpha-up Sort headlines alphabetically
  1270. alpha-down Sort headlines alphabetically, reversed
  1271. The different possibilities will be tried in sequence, and testing stops
  1272. if one comparison returns a \"not-equal\". For example, the default
  1273. '(time-up category-keep priority-down)
  1274. means: Pull out all entries having a specified time of day and sort them,
  1275. in order to make a time schedule for the current day the first thing in the
  1276. agenda listing for the day. Of the entries without a time indication, keep
  1277. the grouped in categories, don't sort the categories, but keep them in
  1278. the sequence given in `org-agenda-files'. Within each category sort by
  1279. priority.
  1280. Leaving out `category-keep' would mean that items will be sorted across
  1281. categories by priority.
  1282. Instead of a single list, this can also be a set of list for specific
  1283. contents, with a context symbol in the car of the list, any of
  1284. `agenda', `todo', `tags', `search' for the corresponding agenda views.
  1285. Custom commands can bind this variable in the options section."
  1286. :group 'org-agenda-sorting
  1287. :type `(choice
  1288. (repeat :tag "General" ,org-sorting-choice)
  1289. (list :tag "Individually"
  1290. (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
  1291. (repeat ,org-sorting-choice))
  1292. (cons (const :tag "Strategy for TODO lists" todo)
  1293. (repeat ,org-sorting-choice))
  1294. (cons (const :tag "Strategy for Tags matches" tags)
  1295. (repeat ,org-sorting-choice))
  1296. (cons (const :tag "Strategy for search matches" search)
  1297. (repeat ,org-sorting-choice)))))
  1298. (defcustom org-agenda-cmp-user-defined nil
  1299. "A function to define the comparison `user-defined'.
  1300. This function must receive two arguments, agenda entry a and b.
  1301. If a>b, return +1. If a<b, return -1. If they are equal as seen by
  1302. the user comparison, return nil.
  1303. When this is defined, you can make `user-defined-up' and `user-defined-down'
  1304. part of an agenda sorting strategy."
  1305. :group 'org-agenda-sorting
  1306. :type 'symbol)
  1307. (defcustom org-sort-agenda-notime-is-late t
  1308. "Non-nil means items without time are considered late.
  1309. This is only relevant for sorting. When t, items which have no explicit
  1310. time like 15:30 will be considered as 99:01, i.e. later than any items which
  1311. do have a time. When nil, the default time is before 0:00. You can use this
  1312. option to decide if the schedule for today should come before or after timeless
  1313. agenda entries."
  1314. :group 'org-agenda-sorting
  1315. :type 'boolean)
  1316. (defcustom org-sort-agenda-noeffort-is-high t
  1317. "Non-nil means items without effort estimate are sorted as high effort.
  1318. This also applies when filtering an agenda view with respect to the
  1319. < or > effort operator. Then, tasks with no effort defined will be treated
  1320. as tasks with high effort.
  1321. When nil, such items are sorted as 0 minutes effort."
  1322. :group 'org-agenda-sorting
  1323. :type 'boolean)
  1324. (defgroup org-agenda-line-format nil
  1325. "Options concerning the entry prefix in the Org-mode agenda display."
  1326. :tag "Org Agenda Line Format"
  1327. :group 'org-agenda)
  1328. (defcustom org-agenda-prefix-format
  1329. '((agenda . " %i %-12:c%?-12t% s")
  1330. (timeline . " % s")
  1331. (todo . " %i %-12:c")
  1332. (tags . " %i %-12:c")
  1333. (search . " %i %-12:c"))
  1334. "Format specifications for the prefix of items in the agenda views.
  1335. An alist with five entries, each for the different agenda types. The
  1336. keys of the sublists are `agenda', `timeline', `todo', `search' and `tags'.
  1337. The values are format strings.
  1338. This format works similar to a printf format, with the following meaning:
  1339. %c the category of the item, \"Diary\" for entries from the diary,
  1340. or as given by the CATEGORY keyword or derived from the file name
  1341. %e the effort required by the item
  1342. %l the level of the item (insert X space(s) if item is of level X)
  1343. %i the icon category of the item, see `org-agenda-category-icon-alist'
  1344. %T the last tag of the item (ignore inherited tags, which come first)
  1345. %t the HH:MM time-of-day specification if one applies to the entry
  1346. %s Scheduling/Deadline information, a short string
  1347. %(expression) Eval EXPRESSION and replace the control string
  1348. by the result
  1349. All specifiers work basically like the standard `%s' of printf, but may
  1350. contain two additional characters: a question mark just after the `%'
  1351. and a whitespace/punctuation character just before the final letter.
  1352. If the first character after `%' is a question mark, the entire field
  1353. will only be included if the corresponding value applies to the current
  1354. entry. This is useful for fields which should have fixed width when
  1355. present, but zero width when absent. For example, \"%?-12t\" will
  1356. result in a 12 character time field if a time of the day is specified,
  1357. but will completely disappear in entries which do not contain a time.
  1358. If there is punctuation or whitespace character just before the final
  1359. format letter, this character will be appended to the field value if
  1360. the value is not empty. For example, the format \"%-12:c\" leads to
  1361. \"Diary: \" if the category is \"Diary\". If the category were be
  1362. empty, no additional colon would be inserted.
  1363. The default value for the agenda sublist is \" %-12:c%?-12t% s\",
  1364. which means:
  1365. - Indent the line with two space characters
  1366. - Give the category a 12 chars wide field, padded with whitespace on
  1367. the right (because of `-'). Append a colon if there is a category
  1368. (because of `:').
  1369. - If there is a time-of-day, put it into a 12 chars wide field. If no
  1370. time, don't put in an empty field, just skip it (because of '?').
  1371. - Finally, put the scheduling information.
  1372. See also the variables `org-agenda-remove-times-when-in-prefix' and
  1373. `org-agenda-remove-tags'.
  1374. Custom commands can set this variable in the options section."
  1375. :type '(choice
  1376. (string :tag "General format")
  1377. (list :greedy t :tag "View dependent"
  1378. (cons (const agenda) (string :tag "Format"))
  1379. (cons (const timeline) (string :tag "Format"))
  1380. (cons (const todo) (string :tag "Format"))
  1381. (cons (const tags) (string :tag "Format"))
  1382. (cons (const search) (string :tag "Format"))))
  1383. :group 'org-agenda-line-format)
  1384. (defvar org-prefix-format-compiled nil
  1385. "The compiled prefix format and associated variables.
  1386. This is a list where first element is a list of variable bindings, and second
  1387. element is the compiled format expression. See the variable
  1388. `org-agenda-prefix-format'.")
  1389. (defcustom org-agenda-todo-keyword-format "%-1s"
  1390. "Format for the TODO keyword in agenda lines.
  1391. Set this to something like \"%-12s\" if you want all TODO keywords
  1392. to occupy a fixed space in the agenda display."
  1393. :group 'org-agenda-line-format
  1394. :type 'string)
  1395. (defcustom org-agenda-diary-sexp-prefix nil
  1396. "A regexp that matches part of a diary sexp entry
  1397. which should be treated as scheduling/deadline information in
  1398. `org-agenda'.
  1399. For example, you can use this to extract the `diary-remind-message' from
  1400. `diary-remind' entries."
  1401. :group 'org-agenda-line-format
  1402. :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
  1403. (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
  1404. "Text preceding timerange entries in the agenda view.
  1405. This is a list with two strings. The first applies when the range
  1406. is entirely on one day. The second applies if the range spans several days.
  1407. The strings may have two \"%d\" format specifiers which will be filled
  1408. with the sequence number of the days, and the total number of days in the
  1409. range, respectively."
  1410. :group 'org-agenda-line-format
  1411. :type '(list
  1412. (string :tag "Deadline today ")
  1413. (choice :tag "Deadline relative"
  1414. (string :tag "Format string")
  1415. (function))))
  1416. (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
  1417. "Text preceding scheduled items in the agenda view.
  1418. This is a list with two strings. The first applies when the item is
  1419. scheduled on the current day. The second applies when it has been scheduled
  1420. previously, it may contain a %d indicating that this is the nth time that
  1421. this item is scheduled, due to automatic rescheduling of unfinished items
  1422. for the following day. So this number is one larger than the number of days
  1423. that passed since this item was scheduled first."
  1424. :group 'org-agenda-line-format
  1425. :type '(list
  1426. (string :tag "Scheduled today ")
  1427. (string :tag "Scheduled previously")))
  1428. (defcustom org-agenda-inactive-leader "["
  1429. "Text preceding item pulled into the agenda by inactive time stamps.
  1430. These entries are added to the agenda when pressing \"[\"."
  1431. :group 'org-agenda-line-format
  1432. :version "24.1"
  1433. :type '(list
  1434. (string :tag "Scheduled today ")
  1435. (string :tag "Scheduled previously")))
  1436. (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: ")
  1437. "Text preceding deadline items in the agenda view.
  1438. This is a list with two strings. The first applies when the item has its
  1439. deadline on the current day. The second applies when it is in the past or
  1440. in the future, it may contain %d to capture how many days away the deadline
  1441. is (was)."
  1442. :group 'org-agenda-line-format
  1443. :type '(list
  1444. (string :tag "Deadline today ")
  1445. (choice :tag "Deadline relative"
  1446. (string :tag "Format string")
  1447. (function))))
  1448. (defcustom org-agenda-remove-times-when-in-prefix t
  1449. "Non-nil means remove duplicate time specifications in agenda items.
  1450. When the format `org-agenda-prefix-format' contains a `%t' specifier, a
  1451. time-of-day specification in a headline or diary entry is extracted and
  1452. placed into the prefix. If this option is non-nil, the original specification
  1453. \(a timestamp or -range, or just a plain time(range) specification like
  1454. 11:30-4pm) will be removed for agenda display. This makes the agenda less
  1455. cluttered.
  1456. The option can be t or nil. It may also be the symbol `beg', indicating
  1457. that the time should only be removed when it is located at the beginning of
  1458. the headline/diary entry."
  1459. :group 'org-agenda-line-format
  1460. :type '(choice
  1461. (const :tag "Always" t)
  1462. (const :tag "Never" nil)
  1463. (const :tag "When at beginning of entry" beg)))
  1464. (defcustom org-agenda-remove-timeranges-from-blocks nil
  1465. "Non-nil means remove time ranges specifications in agenda
  1466. items that span on several days."
  1467. :group 'org-agenda-line-format
  1468. :version "24.1"
  1469. :type 'boolean)
  1470. (defcustom org-agenda-default-appointment-duration nil
  1471. "Default duration for appointments that only have a starting time.
  1472. When nil, no duration is specified in such cases.
  1473. When non-nil, this must be the number of minutes, e.g. 60 for one hour."
  1474. :group 'org-agenda-line-format
  1475. :type '(choice
  1476. (integer :tag "Minutes")
  1477. (const :tag "No default duration")))
  1478. (defcustom org-agenda-show-inherited-tags t
  1479. "Non-nil means show inherited tags in each agenda line."
  1480. :group 'org-agenda-line-format
  1481. :type 'boolean)
  1482. (defcustom org-agenda-hide-tags-regexp nil
  1483. "Regular expression used to filter away specific tags in agenda views.
  1484. This means that these tags will be present, but not be shown in the agenda
  1485. line. Secondary filtering will still work on the hidden tags.
  1486. Nil means don't hide any tags."
  1487. :group 'org-agenda-line-format
  1488. :type '(choice
  1489. (const :tag "Hide none" nil)
  1490. (string :tag "Regexp ")))
  1491. (defcustom org-agenda-remove-tags nil
  1492. "Non-nil means remove the tags from the headline copy in the agenda.
  1493. When this is the symbol `prefix', only remove tags when
  1494. `org-agenda-prefix-format' contains a `%T' specifier."
  1495. :group 'org-agenda-line-format
  1496. :type '(choice
  1497. (const :tag "Always" t)
  1498. (const :tag "Never" nil)
  1499. (const :tag "When prefix format contains %T" prefix)))
  1500. (if (fboundp 'defvaralias)
  1501. (defvaralias 'org-agenda-remove-tags-when-in-prefix
  1502. 'org-agenda-remove-tags))
  1503. (defcustom org-agenda-tags-column (if (featurep 'xemacs) -79 -80)
  1504. "Shift tags in agenda items to this column.
  1505. If this number is positive, it specifies the column. If it is negative,
  1506. it means that the tags should be flushright to that column. For example,
  1507. -80 works well for a normal 80 character screen."
  1508. :group 'org-agenda-line-format
  1509. :type 'integer)
  1510. (if (fboundp 'defvaralias)
  1511. (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column))
  1512. (defcustom org-agenda-fontify-priorities 'cookies
  1513. "Non-nil means highlight low and high priorities in agenda.
  1514. When t, the highest priority entries are bold, lowest priority italic.
  1515. However, settings in `org-priority-faces' will overrule these faces.
  1516. When this variable is the symbol `cookies', only fontify the
  1517. cookies, not the entire task.
  1518. This may also be an association list of priority faces, whose
  1519. keys are the character values of `org-highest-priority',
  1520. `org-default-priority', and `org-lowest-priority' (the default values
  1521. are ?A, ?B, and ?C, respectively). The face may be a named face, a
  1522. color as a string, or a list like `(:background \"Red\")'.
  1523. If it is a color, the variable `org-faces-easy-properties'
  1524. determines if it is a foreground or a background color."
  1525. :group 'org-agenda-line-format
  1526. :type '(choice
  1527. (const :tag "Never" nil)
  1528. (const :tag "Defaults" t)
  1529. (const :tag "Cookies only" cookies)
  1530. (repeat :tag "Specify"
  1531. (list (character :tag "Priority" :value ?A)
  1532. (choice :tag "Face "
  1533. (string :tag "Color")
  1534. (sexp :tag "Face"))))))
  1535. (defcustom org-agenda-day-face-function nil
  1536. "Function called to determine what face should be used to display a day.
  1537. The only argument passed to that function is the day. It should
  1538. returns a face, or nil if does not want to specify a face and let
  1539. the normal rules apply."
  1540. :group 'org-agenda-line-format
  1541. :version "24.1"
  1542. :type 'function)
  1543. (defcustom org-agenda-category-icon-alist nil
  1544. "Alist of category icon to be displayed in agenda views.
  1545. Each entry should have the following format:
  1546. (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
  1547. Where CATEGORY-REGEXP is a regexp matching the categories where
  1548. the icon should be displayed.
  1549. FILE-OR-DATA either a file path or a string containing image data.
  1550. The other fields can be omitted safely if not needed:
  1551. TYPE indicates the image type.
  1552. DATA-P is a boolean indicating whether the FILE-OR-DATA string is
  1553. image data.
  1554. PROPS are additional image attributes to assign to the image,
  1555. like, e.g. `:ascent center'.
  1556. (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
  1557. If you want to set the display properties yourself, just put a
  1558. list as second element:
  1559. (CATEGORY-REGEXP (MY PROPERTY LIST))
  1560. For example, to display a 16px horizontal space for Emacs
  1561. category, you can use:
  1562. (\"Emacs\" '(space . (:width (16))))"
  1563. :group 'org-agenda-line-format
  1564. :version "24.1"
  1565. :type '(alist :key-type (string :tag "Regexp matching category")
  1566. :value-type (choice (list :tag "Icon"
  1567. (string :tag "File or data")
  1568. (symbol :tag "Type")
  1569. (boolean :tag "Data?")
  1570. (repeat :tag "Extra image properties" :inline t symbol))
  1571. (list :tag "Display properties" sexp))))
  1572. (defgroup org-agenda-column-view nil
  1573. "Options concerning column view in the agenda."
  1574. :tag "Org Agenda Column View"
  1575. :group 'org-agenda)
  1576. (defcustom org-agenda-columns-show-summaries t
  1577. "Non-nil means show summaries for columns displayed in the agenda view."
  1578. :group 'org-agenda-column-view
  1579. :type 'boolean)
  1580. (defcustom org-agenda-columns-compute-summary-properties t
  1581. "Non-nil means recompute all summary properties before column view.
  1582. When column view in the agenda is listing properties that have a summary
  1583. operator, it can go to all relevant buffers and recompute the summaries
  1584. there. This can mean overhead for the agenda column view, but is necessary
  1585. to have thing up to date.
  1586. As a special case, a CLOCKSUM property also makes sure that the clock
  1587. computations are current."
  1588. :group 'org-agenda-column-view
  1589. :type 'boolean)
  1590. (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
  1591. "Non-nil means the duration of an appointment will add to day effort.
  1592. The property to which appointment durations will be added is the one given
  1593. in the option `org-effort-property'. If an appointment does not have
  1594. an end time, `org-agenda-default-appointment-duration' will be used. If that
  1595. is not set, an appointment without end time will not contribute to the time
  1596. estimate."
  1597. :group 'org-agenda-column-view
  1598. :type 'boolean)
  1599. (defcustom org-agenda-auto-exclude-function nil
  1600. "A function called with a tag to decide if it is filtered on '/ RET'.
  1601. The sole argument to the function, which is called once for each
  1602. possible tag, is a string giving the name of the tag. The
  1603. function should return either nil if the tag should be included
  1604. as normal, or \"-<TAG>\" to exclude the tag.
  1605. Note that for the purpose of tag filtering, only the lower-case version of
  1606. all tags will be considered, so that this function will only ever see
  1607. the lower-case version of all tags."
  1608. :group 'org-agenda
  1609. :type 'function)
  1610. (defcustom org-agenda-bulk-custom-functions nil
  1611. "Alist of characters and custom functions for bulk actions.
  1612. For example, this value makes those two functions available:
  1613. '((?R set-category)
  1614. (?C bulk-cut))
  1615. With selected entries in an agenda buffer, `B R' will call
  1616. the custom function `set-category' on the selected entries.
  1617. Note that functions in this alist don't need to be quoted."
  1618. :type 'alist
  1619. :version "24.1"
  1620. :group 'org-agenda)
  1621. (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
  1622. "Execute BODY with point at location given by `org-hd-marker' property.
  1623. If STRING is non-nil, the text property will be fetched from position 0
  1624. in that string. If STRING is nil, it will be fetched from the beginning
  1625. of the current line."
  1626. (org-with-gensyms (marker)
  1627. `(let ((,marker (get-text-property (if string 0 (point-at-bol))
  1628. 'org-hd-marker ,string)))
  1629. (with-current-buffer (marker-buffer ,marker)
  1630. (save-excursion
  1631. (goto-char ,marker)
  1632. ,@body)))))
  1633. (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
  1634. (defun org-add-agenda-custom-command (entry)
  1635. "Replace or add a command in `org-agenda-custom-commands'.
  1636. This is mostly for hacking and trying a new command - once the command
  1637. works you probably want to add it to `org-agenda-custom-commands' for good."
  1638. (let ((ass (assoc (car entry) org-agenda-custom-commands)))
  1639. (if ass
  1640. (setcdr ass (cdr entry))
  1641. (push entry org-agenda-custom-commands))))
  1642. ;;; Define the org-agenda-mode
  1643. (defvar org-agenda-mode-map (make-sparse-keymap)
  1644. "Keymap for `org-agenda-mode'.")
  1645. (if (fboundp 'defvaralias)
  1646. (defvaralias 'org-agenda-keymap 'org-agenda-mode-map))
  1647. (defvar org-agenda-menu) ; defined later in this file.
  1648. (defvar org-agenda-restrict nil) ; defined later in this file.
  1649. (defvar org-agenda-follow-mode nil)
  1650. (defvar org-agenda-entry-text-mode nil)
  1651. (defvar org-agenda-clockreport-mode nil)
  1652. (defvar org-agenda-show-log nil)
  1653. (defvar org-agenda-redo-command nil)
  1654. (defvar org-agenda-query-string nil)
  1655. (defvar org-agenda-mode-hook nil
  1656. "Hook run after `org-agenda-mode' is turned on.
  1657. The buffer is still writable when this hook is called.")
  1658. (defvar org-agenda-type nil)
  1659. (defvar org-agenda-force-single-file nil)
  1660. (defvar org-agenda-bulk-marked-entries nil
  1661. "List of markers that refer to marked entries in the agenda.")
  1662. ;;; Multiple agenda buffers support
  1663. (defcustom org-agenda-sticky nil
  1664. "Non-nil means agenda q key will bury agenda buffers.
  1665. Agenda commands will then show existing buffer instead of generating new ones.
  1666. When nil, `q' will kill the single agenda buffer."
  1667. :group 'org-agenda
  1668. :version "24.3"
  1669. :type 'boolean)
  1670. ;;;###autoload
  1671. (defun org-toggle-sticky-agenda (&optional arg)
  1672. "Toggle `org-agenda-sticky'."
  1673. (interactive "P")
  1674. (let ((new-value (if arg
  1675. (> (prefix-numeric-value arg) 0)
  1676. (not org-agenda-sticky))))
  1677. (if (equal new-value org-agenda-sticky)
  1678. (and (org-called-interactively-p 'interactive)
  1679. (message "Sticky agenda was already %s"
  1680. (if org-agenda-sticky "enabled" "disabled")))
  1681. (setq org-agenda-sticky new-value)
  1682. (org-agenda-kill-all-agenda-buffers)
  1683. (and (org-called-interactively-p 'interactive)
  1684. (message "Sticky agenda was %s"
  1685. (if org-agenda-sticky "enabled" "disabled"))))))
  1686. (autoload 'org-toggle-sticky-agenda "org-agenda" "\
  1687. Toggle `org-agenda-sticky'.
  1688. \(fn &optional ARG)" t nil)
  1689. (defvar org-agenda-buffer nil
  1690. "Agenda buffer currently being generated.")
  1691. (defvar org-agenda-last-prefix-arg nil)
  1692. (defvar org-agenda-this-buffer-name nil)
  1693. (defvar org-agenda-doing-sticky-redo nil)
  1694. (defvar org-agenda-this-buffer-is-sticky nil)
  1695. (defconst org-agenda-local-vars
  1696. '(org-agenda-this-buffer-name
  1697. org-agenda-undo-list
  1698. org-agenda-pending-undo-list
  1699. org-agenda-follow-mode
  1700. org-agenda-entry-text-mode
  1701. org-agenda-clockreport-mode
  1702. org-agenda-show-log
  1703. org-agenda-redo-command
  1704. org-agenda-query-string
  1705. org-agenda-type
  1706. org-agenda-bulk-marked-entries
  1707. org-agenda-undo-has-started-in
  1708. org-agenda-info
  1709. org-agenda-tag-filter-overlays
  1710. org-agenda-cat-filter-overlays
  1711. org-agenda-pre-window-conf
  1712. org-agenda-columns-active
  1713. org-agenda-tag-filter
  1714. org-agenda-category-filter
  1715. org-agenda-markers
  1716. org-agenda-last-search-view-search-was-boolean
  1717. org-agenda-filtered-by-category
  1718. org-agenda-filter-form
  1719. org-agenda-show-window
  1720. org-agenda-cycle-counter
  1721. org-agenda-last-prefix-arg)
  1722. "Variables that must be local in agenda buffers to allow multiple buffers.")
  1723. (defun org-agenda-mode ()
  1724. "Mode for time-sorted view on action items in Org-mode files.
  1725. The following commands are available:
  1726. \\{org-agenda-mode-map}"
  1727. (interactive)
  1728. (cond (org-agenda-doing-sticky-redo
  1729. ;; Refreshing sticky agenda-buffer
  1730. ;;
  1731. ;; Preserve the value of `org-agenda-local-vars' variables,
  1732. ;; while letting `kill-all-local-variables' kill the rest
  1733. (let ((save (buffer-local-variables)))
  1734. (kill-all-local-variables)
  1735. (mapc 'make-local-variable org-agenda-local-vars)
  1736. (dolist (elem save)
  1737. (let ((var (car elem))
  1738. (val (cdr elem)))
  1739. (when (and val
  1740. (member var org-agenda-local-vars))
  1741. (set var val)))))
  1742. (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
  1743. (org-agenda-sticky
  1744. ;; Creating a sticky Agenda buffer for the first time
  1745. (kill-all-local-variables)
  1746. (mapc 'make-local-variable org-agenda-local-vars)
  1747. (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
  1748. (t
  1749. ;; Creating a non-sticky agenda buffer
  1750. (kill-all-local-variables)
  1751. (set (make-local-variable 'org-agenda-this-buffer-is-sticky) nil)))
  1752. (setq org-agenda-undo-list nil
  1753. org-agenda-pending-undo-list nil
  1754. org-agenda-bulk-marked-entries nil)
  1755. (setq major-mode 'org-agenda-mode)
  1756. ;; Keep global-font-lock-mode from turning on font-lock-mode
  1757. (org-set-local 'font-lock-global-modes (list 'not major-mode))
  1758. (setq mode-name "Org-Agenda")
  1759. (use-local-map org-agenda-mode-map)
  1760. (easy-menu-add org-agenda-menu)
  1761. (if org-startup-truncated (setq truncate-lines t))
  1762. (org-set-local 'line-move-visual nil)
  1763. (org-add-hook 'post-command-hook 'org-agenda-update-agenda-type nil 'local)
  1764. (org-add-hook 'pre-command-hook 'org-unhighlight nil 'local)
  1765. ;; Make sure properties are removed when copying text
  1766. (make-local-variable 'filter-buffer-substring-functions)
  1767. (add-hook 'filter-buffer-substring-functions
  1768. (lambda (fun start end delete)
  1769. (substring-no-properties (funcall fun start end delete))))
  1770. (unless org-agenda-keep-modes
  1771. (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
  1772. org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
  1773. org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode
  1774. org-agenda-show-log org-agenda-start-with-log-mode))
  1775. (easy-menu-change
  1776. '("Agenda") "Agenda Files"
  1777. (append
  1778. (list
  1779. (vector
  1780. (if (get 'org-agenda-files 'org-restrict)
  1781. "Restricted to single file"
  1782. "Edit File List")
  1783. '(org-edit-agenda-file-list)
  1784. (not (get 'org-agenda-files 'org-restrict)))
  1785. "--")
  1786. (mapcar 'org-file-menu-entry (org-agenda-files))))
  1787. (org-agenda-set-mode-name)
  1788. (apply
  1789. (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
  1790. (list 'org-agenda-mode-hook)))
  1791. (substitute-key-definition 'undo 'org-agenda-undo
  1792. org-agenda-mode-map global-map)
  1793. (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
  1794. (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
  1795. (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
  1796. (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
  1797. (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
  1798. (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
  1799. (org-defkey org-agenda-mode-map "*" 'org-agenda-bulk-mark-all)
  1800. (org-defkey org-agenda-mode-map "#" 'org-agenda-dim-blocked-tasks)
  1801. (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
  1802. (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
  1803. (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-unmark-all)
  1804. (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
  1805. (org-defkey org-agenda-mode-map "k" 'org-agenda-capture)
  1806. (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
  1807. (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
  1808. (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
  1809. (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
  1810. (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
  1811. (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
  1812. (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
  1813. (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
  1814. (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
  1815. (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
  1816. (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
  1817. (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
  1818. (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
  1819. (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
  1820. (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
  1821. (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
  1822. (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
  1823. (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
  1824. (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
  1825. (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
  1826. (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
  1827. (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
  1828. (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
  1829. (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
  1830. (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
  1831. (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
  1832. (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
  1833. (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
  1834. (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
  1835. (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
  1836. (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
  1837. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
  1838. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
  1839. (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
  1840. (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
  1841. (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
  1842. (let ((l '(1 2 3 4 5 6 7 8 9 0)))
  1843. (while l (org-defkey org-agenda-mode-map
  1844. (int-to-string (pop l)) 'digit-argument)))
  1845. (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
  1846. (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
  1847. (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
  1848. (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
  1849. (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
  1850. (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
  1851. (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
  1852. (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
  1853. (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
  1854. (org-defkey org-agenda-mode-map "g" (lambda () (interactive) (org-agenda-redo t)))
  1855. (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
  1856. (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
  1857. (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
  1858. 'org-clock-modify-effort-estimate)
  1859. (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
  1860. (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
  1861. (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
  1862. (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
  1863. (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
  1864. (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
  1865. (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
  1866. (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
  1867. (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
  1868. (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
  1869. (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
  1870. (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
  1871. (substitute-key-definition 'next-line 'org-agenda-next-line
  1872. org-agenda-mode-map global-map)
  1873. (substitute-key-definition 'previous-line 'org-agenda-previous-line
  1874. org-agenda-mode-map global-map)
  1875. (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
  1876. (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
  1877. (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
  1878. (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
  1879. (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
  1880. (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
  1881. (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
  1882. (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
  1883. (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
  1884. (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
  1885. (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
  1886. (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
  1887. (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
  1888. (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
  1889. (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
  1890. (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
  1891. (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
  1892. (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
  1893. (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  1894. (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
  1895. (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
  1896. (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
  1897. (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
  1898. (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
  1899. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
  1900. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
  1901. (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
  1902. (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
  1903. (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
  1904. (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  1905. (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
  1906. (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
  1907. (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
  1908. (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
  1909. (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
  1910. (org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag-refine)
  1911. (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
  1912. (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-category)
  1913. (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
  1914. (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
  1915. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  1916. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  1917. (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
  1918. (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
  1919. (when org-agenda-mouse-1-follows-link
  1920. (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
  1921. (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
  1922. '("Agenda"
  1923. ("Agenda Files")
  1924. "--"
  1925. ("Agenda Dates"
  1926. ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
  1927. ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
  1928. ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
  1929. ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
  1930. "--"
  1931. ("View"
  1932. ["Day View" org-agenda-day-view
  1933. :active (org-agenda-check-type nil 'agenda)
  1934. :style radio :selected (eq org-agenda-current-span 'day)
  1935. :keys "v d (or just d)"]
  1936. ["Week View" org-agenda-week-view
  1937. :active (org-agenda-check-type nil 'agenda)
  1938. :style radio :selected (eq org-agenda-current-span 'week)
  1939. :keys "v w (or just w)"]
  1940. ["Month View" org-agenda-month-view
  1941. :active (org-agenda-check-type nil 'agenda)
  1942. :style radio :selected (eq org-agenda-current-span 'month)
  1943. :keys "v m"]
  1944. ["Year View" org-agenda-year-view
  1945. :active (org-agenda-check-type nil 'agenda)
  1946. :style radio :selected (eq org-agenda-current-span 'year)
  1947. :keys "v y"]
  1948. "--"
  1949. ["Include Diary" org-agenda-toggle-diary
  1950. :style toggle :selected org-agenda-include-diary
  1951. :active (org-agenda-check-type nil 'agenda)]
  1952. ["Include Deadlines" org-agenda-toggle-deadlines
  1953. :style toggle :selected org-agenda-include-deadlines
  1954. :active (org-agenda-check-type nil 'agenda)]
  1955. ["Use Time Grid" org-agenda-toggle-time-grid
  1956. :style toggle :selected org-agenda-use-time-grid
  1957. :active (org-agenda-check-type nil 'agenda)]
  1958. "--"
  1959. ["Show clock report" org-agenda-clockreport-mode
  1960. :style toggle :selected org-agenda-clockreport-mode
  1961. :active (org-agenda-check-type nil 'agenda)]
  1962. ["Show some entry text" org-agenda-entry-text-mode
  1963. :style toggle :selected org-agenda-entry-text-mode
  1964. :active t]
  1965. "--"
  1966. ["Show Logbook entries" org-agenda-log-mode
  1967. :style toggle :selected org-agenda-show-log
  1968. :active (org-agenda-check-type nil 'agenda 'timeline)
  1969. :keys "v l (or just l)"]
  1970. ["Include archived trees" org-agenda-archives-mode
  1971. :style toggle :selected org-agenda-archives-mode :active t
  1972. :keys "v a"]
  1973. ["Include archive files" (org-agenda-archives-mode t)
  1974. :style toggle :selected (eq org-agenda-archives-mode t) :active t
  1975. :keys "v A"]
  1976. "--"
  1977. ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
  1978. ["Write view to file" org-agenda-write t]
  1979. ["Rebuild buffer" org-agenda-redo t]
  1980. ["Save all Org-mode Buffers" org-save-all-org-buffers t]
  1981. "--"
  1982. ["Show original entry" org-agenda-show t]
  1983. ["Go To (other window)" org-agenda-goto t]
  1984. ["Go To (this window)" org-agenda-switch-to t]
  1985. ["Capture with cursor date" org-agenda-capture t]
  1986. ["Follow Mode" org-agenda-follow-mode
  1987. :style toggle :selected org-agenda-follow-mode :active t]
  1988. ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
  1989. "--"
  1990. ("TODO"
  1991. ["Cycle TODO" org-agenda-todo t]
  1992. ["Next TODO set" org-agenda-todo-nextset t]
  1993. ["Previous TODO set" org-agenda-todo-previousset t]
  1994. ["Add note" org-agenda-add-note t])
  1995. ("Archive/Refile/Delete"
  1996. ["Archive default" org-agenda-archive-default t]
  1997. ["Archive default" org-agenda-archive-default-with-confirmation t]
  1998. ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
  1999. ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
  2000. ["Archive subtree" org-agenda-archive t]
  2001. "--"
  2002. ["Refile" org-agenda-refile t]
  2003. "--"
  2004. ["Delete subtree" org-agenda-kill t])
  2005. ("Bulk action"
  2006. ["Mark entry" org-agenda-bulk-mark t]
  2007. ["Mark all" org-agenda-bulk-mark-all t]
  2008. ["Mark matching regexp" org-agenda-bulk-mark-regexp t]
  2009. ["Unmark entry" org-agenda-bulk-unmark t]
  2010. ["Unmark all entries" org-agenda-bulk-unmark-all :active t :keys "U"])
  2011. ["Act on all marked" org-agenda-bulk-action t]
  2012. "--"
  2013. ("Tags and Properties"
  2014. ["Show all Tags" org-agenda-show-tags t]
  2015. ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
  2016. ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
  2017. "--"
  2018. ["Column View" org-columns t])
  2019. ("Deadline/Schedule"
  2020. ["Schedule" org-agenda-schedule t]
  2021. ["Set Deadline" org-agenda-deadline t]
  2022. "--"
  2023. ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
  2024. ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
  2025. ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
  2026. ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
  2027. ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
  2028. ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
  2029. ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
  2030. ("Clock and Effort"
  2031. ["Clock in" org-agenda-clock-in t]
  2032. ["Clock out" org-agenda-clock-out t]
  2033. ["Clock cancel" org-agenda-clock-cancel t]
  2034. ["Goto running clock" org-clock-goto t]
  2035. "--"
  2036. ["Set Effort" org-agenda-set-effort t]
  2037. ["Change clocked effort" org-clock-modify-effort-estimate
  2038. (org-clock-is-active)])
  2039. ("Priority"
  2040. ["Set Priority" org-agenda-priority t]
  2041. ["Increase Priority" org-agenda-priority-up t]
  2042. ["Decrease Priority" org-agenda-priority-down t]
  2043. ["Show Priority" org-show-priority t])
  2044. ("Calendar/Diary"
  2045. ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
  2046. ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
  2047. ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
  2048. ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
  2049. ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
  2050. ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
  2051. "--"
  2052. ["Create iCalendar File" org-export-icalendar-combine-agenda-files t])
  2053. "--"
  2054. ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
  2055. "--"
  2056. ("MobileOrg"
  2057. ["Push Files and Views" org-mobile-push t]
  2058. ["Get Captured and Flagged" org-mobile-pull t]
  2059. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
  2060. ["Show note / unflag" org-agenda-show-the-flagging-note t]
  2061. "--"
  2062. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  2063. "--"
  2064. ["Quit" org-agenda-quit t]
  2065. ["Exit and Release Buffers" org-agenda-exit t]
  2066. ))
  2067. ;;; Agenda undo
  2068. (defvar org-agenda-allow-remote-undo t
  2069. "Non-nil means allow remote undo from the agenda buffer.")
  2070. (defvar org-agenda-undo-has-started-in nil
  2071. "Buffers that have already seen `undo-start' in the current undo sequence.")
  2072. (defun org-agenda-undo ()
  2073. "Undo a remote editing step in the agenda.
  2074. This undoes changes both in the agenda buffer and in the remote buffer
  2075. that have been changed along."
  2076. (interactive)
  2077. (or org-agenda-allow-remote-undo
  2078. (error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
  2079. (if (not (eq this-command last-command))
  2080. (setq org-agenda-undo-has-started-in nil
  2081. org-agenda-pending-undo-list org-agenda-undo-list))
  2082. (if (not org-agenda-pending-undo-list)
  2083. (error "No further undo information"))
  2084. (let* ((entry (pop org-agenda-pending-undo-list))
  2085. buf line cmd rembuf)
  2086. (setq cmd (pop entry) line (pop entry))
  2087. (setq rembuf (nth 2 entry))
  2088. (org-with-remote-undo rembuf
  2089. (while (bufferp (setq buf (pop entry)))
  2090. (if (pop entry)
  2091. (with-current-buffer buf
  2092. (let ((last-undo-buffer buf)
  2093. (inhibit-read-only t))
  2094. (unless (memq buf org-agenda-undo-has-started-in)
  2095. (push buf org-agenda-undo-has-started-in)
  2096. (make-local-variable 'pending-undo-list)
  2097. (undo-start))
  2098. (while (and pending-undo-list
  2099. (listp pending-undo-list)
  2100. (not (car pending-undo-list)))
  2101. (pop pending-undo-list))
  2102. (undo-more 1))))))
  2103. (org-goto-line line)
  2104. (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
  2105. (defun org-verify-change-for-undo (l1 l2)
  2106. "Verify that a real change occurred between the undo lists L1 and L2."
  2107. (while (and l1 (listp l1) (null (car l1))) (pop l1))
  2108. (while (and l2 (listp l2) (null (car l2))) (pop l2))
  2109. (not (eq l1 l2)))
  2110. ;;; Agenda dispatch
  2111. (defvar org-agenda-restrict-begin (make-marker))
  2112. (defvar org-agenda-restrict-end (make-marker))
  2113. (defvar org-agenda-last-dispatch-buffer nil)
  2114. (defvar org-agenda-overriding-restriction nil)
  2115. (defcustom org-agenda-custom-commands-contexts nil
  2116. "Alist of custom agenda keys and contextual rules.
  2117. For example, if you have a custom agenda command \"p\" and you
  2118. want this command to be accessible only from plain text files,
  2119. use this:
  2120. '((\"p\" (in-file . \"\\.txt\")))
  2121. Here are the available contexts definitions:
  2122. in-file: command displayed only in matching files
  2123. in-mode: command displayed only in matching modes
  2124. not-in-file: command not displayed in matching files
  2125. not-in-mode: command not displayed in matching modes
  2126. [function]: a custom function taking no argument
  2127. If you define several checks, the agenda command will be
  2128. accessible if there is at least one valid check.
  2129. You can also bind a key to another agenda custom command
  2130. depending on contextual rules.
  2131. '((\"p\" \"q\" (in-file . \"\\.txt\")))
  2132. Here it means: in .txt files, use \"p\" as the key for the
  2133. agenda command otherwise associated with \"q\". (The command
  2134. originally associated with \"q\" is not displayed to avoid
  2135. duplicates.)"
  2136. :version "24.3"
  2137. :group 'org-agenda-custom-commands
  2138. :type '(repeat (list :tag "Rule"
  2139. (string :tag " Agenda key")
  2140. (string :tag "Replace by command")
  2141. (repeat :tag "Available when"
  2142. (choice
  2143. (cons :tag "Condition"
  2144. (choice
  2145. (const :tag "In file" in-file)
  2146. (const :tag "Not in file" not-in-file)
  2147. (const :tag "In mode" in-mode)
  2148. (const :tag "Not in mode" not-in-mode))
  2149. (regexp))
  2150. (function :tag "Custom function"))))))
  2151. (defvar org-keys nil)
  2152. (defvar org-match nil)
  2153. ;;;###autoload
  2154. (defun org-agenda (&optional arg org-keys restriction)
  2155. "Dispatch agenda commands to collect entries to the agenda buffer.
  2156. Prompts for a command to execute. Any prefix arg will be passed
  2157. on to the selected command. The default selections are:
  2158. a Call `org-agenda-list' to display the agenda for current day or week.
  2159. t Call `org-todo-list' to display the global todo list.
  2160. T Call `org-todo-list' to display the global todo list, select only
  2161. entries with a specific TODO keyword (the user gets a prompt).
  2162. m Call `org-tags-view' to display headlines with tags matching
  2163. a condition (the user is prompted for the condition).
  2164. M Like `m', but select only TODO entries, no ordinary headlines.
  2165. L Create a timeline for the current buffer.
  2166. e Export views to associated files.
  2167. s Search entries for keywords.
  2168. S Search entries for keywords, only with TODO keywords.
  2169. / Multi occur across all agenda files and also files listed
  2170. in `org-agenda-text-search-extra-files'.
  2171. < Restrict agenda commands to buffer, subtree, or region.
  2172. Press several times to get the desired effect.
  2173. > Remove a previous restriction.
  2174. # List \"stuck\" projects.
  2175. ! Configure what \"stuck\" means.
  2176. C Configure custom agenda commands.
  2177. More commands can be added by configuring the variable
  2178. `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
  2179. searches can be pre-defined in this way.
  2180. If the current buffer is in Org-mode and visiting a file, you can also
  2181. first press `<' once to indicate that the agenda should be temporarily
  2182. \(until the next use of \\[org-agenda]) restricted to the current file.
  2183. Pressing `<' twice means to restrict to the current subtree or region
  2184. \(if active)."
  2185. (interactive "P")
  2186. (catch 'exit
  2187. (let* ((prefix-descriptions nil)
  2188. (org-agenda-buffer-name org-agenda-buffer-name)
  2189. (org-agenda-window-setup (if (equal (buffer-name)
  2190. org-agenda-buffer-name)
  2191. 'current-window
  2192. org-agenda-window-setup))
  2193. (org-agenda-custom-commands-orig org-agenda-custom-commands)
  2194. (org-agenda-custom-commands
  2195. ;; normalize different versions
  2196. (delq nil
  2197. (mapcar
  2198. (lambda (x)
  2199. (cond ((stringp (cdr x))
  2200. (push x prefix-descriptions)
  2201. nil)
  2202. ((stringp (nth 1 x)) x)
  2203. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2204. (t (cons (car x) (cons "" (cdr x))))))
  2205. org-agenda-custom-commands)))
  2206. (org-agenda-custom-commands
  2207. (org-contextualize-keys
  2208. org-agenda-custom-commands org-agenda-custom-commands-contexts))
  2209. (buf (current-buffer))
  2210. (bfn (buffer-file-name (buffer-base-buffer)))
  2211. entry key type org-match lprops ans)
  2212. ;; Turn off restriction unless there is an overriding one,
  2213. (unless org-agenda-overriding-restriction
  2214. (unless (org-bound-and-true-p org-agenda-keep-restricted-file-list)
  2215. ;; There is a request to keep the file list in place
  2216. (put 'org-agenda-files 'org-restrict nil))
  2217. (setq org-agenda-restrict nil)
  2218. (move-marker org-agenda-restrict-begin nil)
  2219. (move-marker org-agenda-restrict-end nil))
  2220. ;; Delete old local properties
  2221. (put 'org-agenda-redo-command 'org-lprops nil)
  2222. ;; Delete previously set last-arguments
  2223. (put 'org-agenda-redo-command 'last-args nil)
  2224. ;; Remember where this call originated
  2225. (setq org-agenda-last-dispatch-buffer (current-buffer))
  2226. (unless org-keys
  2227. (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
  2228. org-keys (car ans)
  2229. restriction (cdr ans)))
  2230. ;; If we have sticky agenda buffers, set a name for the buffer,
  2231. ;; depending on the invoking keys. The user may still set this
  2232. ;; as a command option, which will overwrite what we do here.
  2233. (if org-agenda-sticky
  2234. (setq org-agenda-buffer-name
  2235. (format "*Org Agenda(%s)*" org-keys)))
  2236. ;; Establish the restriction, if any
  2237. (when (and (not org-agenda-overriding-restriction) restriction)
  2238. (put 'org-agenda-files 'org-restrict (list bfn))
  2239. (cond
  2240. ((eq restriction 'region)
  2241. (setq org-agenda-restrict t)
  2242. (move-marker org-agenda-restrict-begin (region-beginning))
  2243. (move-marker org-agenda-restrict-end (region-end)))
  2244. ((eq restriction 'subtree)
  2245. (save-excursion
  2246. (setq org-agenda-restrict t)
  2247. (org-back-to-heading t)
  2248. (move-marker org-agenda-restrict-begin (point))
  2249. (move-marker org-agenda-restrict-end
  2250. (progn (org-end-of-subtree t)))))))
  2251. ;; For example the todo list should not need it (but does...)
  2252. (cond
  2253. ((setq entry (assoc org-keys org-agenda-custom-commands))
  2254. (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
  2255. (progn
  2256. (setq type (nth 2 entry) org-match (eval (nth 3 entry))
  2257. lprops (nth 4 entry))
  2258. (if org-agenda-sticky
  2259. (setq org-agenda-buffer-name
  2260. (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
  2261. (format "*Org Agenda(%s)*" org-keys))))
  2262. (put 'org-agenda-redo-command 'org-lprops lprops)
  2263. (cond
  2264. ((eq type 'agenda)
  2265. (org-let lprops '(org-agenda-list current-prefix-arg)))
  2266. ((eq type 'alltodo)
  2267. (org-let lprops '(org-todo-list current-prefix-arg)))
  2268. ((eq type 'search)
  2269. (org-let lprops '(org-search-view current-prefix-arg org-match nil)))
  2270. ((eq type 'stuck)
  2271. (org-let lprops '(org-agenda-list-stuck-projects
  2272. current-prefix-arg)))
  2273. ((eq type 'tags)
  2274. (org-let lprops '(org-tags-view current-prefix-arg org-match)))
  2275. ((eq type 'tags-todo)
  2276. (org-let lprops '(org-tags-view '(4) org-match)))
  2277. ((eq type 'todo)
  2278. (org-let lprops '(org-todo-list org-match)))
  2279. ((eq type 'tags-tree)
  2280. (org-check-for-org-mode)
  2281. (org-let lprops '(org-match-sparse-tree current-prefix-arg org-match)))
  2282. ((eq type 'todo-tree)
  2283. (org-check-for-org-mode)
  2284. (org-let lprops
  2285. '(org-occur (concat "^" org-outline-regexp "[ \t]*"
  2286. (regexp-quote org-match) "\\>"))))
  2287. ((eq type 'occur-tree)
  2288. (org-check-for-org-mode)
  2289. (org-let lprops '(org-occur org-match)))
  2290. ((functionp type)
  2291. (org-let lprops '(funcall type org-match)))
  2292. ((fboundp type)
  2293. (org-let lprops '(funcall type org-match)))
  2294. (t (error "Invalid custom agenda command type %s" type))))
  2295. (org-agenda-run-series (nth 1 entry) (cddr entry))))
  2296. ((equal org-keys "C")
  2297. (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
  2298. (customize-variable 'org-agenda-custom-commands))
  2299. ((equal org-keys "a") (call-interactively 'org-agenda-list))
  2300. ((equal org-keys "s") (call-interactively 'org-search-view))
  2301. ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
  2302. ((equal org-keys "t") (call-interactively 'org-todo-list))
  2303. ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
  2304. ((equal org-keys "m") (call-interactively 'org-tags-view))
  2305. ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
  2306. ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
  2307. ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
  2308. (org-add-hook
  2309. 'post-command-hook
  2310. (lambda ()
  2311. (unless (current-message)
  2312. (let* ((m (org-agenda-get-any-marker))
  2313. (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
  2314. (when note
  2315. (message (concat
  2316. "FLAGGING-NOTE ([?] for more info): "
  2317. (org-add-props
  2318. (replace-regexp-in-string
  2319. "\\\\n" "//"
  2320. (copy-sequence note))
  2321. nil 'face 'org-warning)))))))
  2322. t t))
  2323. ((equal org-keys "L")
  2324. (unless (derived-mode-p 'org-mode)
  2325. (error "This is not an Org-mode file"))
  2326. (unless restriction
  2327. (put 'org-agenda-files 'org-restrict (list bfn))
  2328. (org-call-with-arg 'org-timeline arg)))
  2329. ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
  2330. ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
  2331. ((equal org-keys "!") (customize-variable 'org-stuck-projects))
  2332. (t (error "Invalid agenda key"))))))
  2333. (autoload 'org-agenda "org-agenda" "\
  2334. Dispatch agenda commands to collect entries to the agenda buffer.
  2335. Prompts for a command to execute. Any prefix arg will be passed
  2336. on to the selected command. The default selections are:
  2337. a Call `org-agenda-list' to display the agenda for current day or week.
  2338. t Call `org-todo-list' to display the global todo list.
  2339. T Call `org-todo-list' to display the global todo list, select only
  2340. entries with a specific TODO keyword (the user gets a prompt).
  2341. m Call `org-tags-view' to display headlines with tags matching
  2342. a condition (the user is prompted for the condition).
  2343. M Like `m', but select only TODO entries, no ordinary headlines.
  2344. L Create a timeline for the current buffer.
  2345. e Export views to associated files.
  2346. s Search entries for keywords.
  2347. S Search entries for keywords, only with TODO keywords.
  2348. / Multi occur across all agenda files and also files listed
  2349. in `org-agenda-text-search-extra-files'.
  2350. < Restrict agenda commands to buffer, subtree, or region.
  2351. Press several times to get the desired effect.
  2352. > Remove a previous restriction.
  2353. # List \"stuck\" projects.
  2354. ! Configure what \"stuck\" means.
  2355. C Configure custom agenda commands.
  2356. More commands can be added by configuring the variable
  2357. `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
  2358. searches can be pre-defined in this way.
  2359. If the current buffer is in Org-mode and visiting a file, you can also
  2360. first press `<' once to indicate that the agenda should be temporarily
  2361. \(until the next use of \\[org-agenda]) restricted to the current file.
  2362. Pressing `<' twice means to restrict to the current subtree or region
  2363. \(if active).
  2364. \(fn &optional ARG ORG-KEYS RESTRICTION)" t nil)
  2365. (defun org-agenda-append-agenda ()
  2366. "Append another agenda view to the current one.
  2367. This function allows interactive building of block agendas.
  2368. Agenda views are separated by `org-agenda-block-separator'."
  2369. (interactive)
  2370. (unless (derived-mode-p 'org-agenda-mode)
  2371. (error "Can only append from within agenda buffer"))
  2372. (let ((org-agenda-multi t))
  2373. (org-agenda)
  2374. (widen)
  2375. (org-agenda-finalize)
  2376. (org-agenda-fit-window-to-buffer)))
  2377. (defun org-agenda-normalize-custom-commands (cmds)
  2378. (delq nil
  2379. (mapcar
  2380. (lambda (x)
  2381. (cond ((stringp (cdr x)) nil)
  2382. ((stringp (nth 1 x)) x)
  2383. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2384. (t (cons (car x) (cons "" (cdr x))))))
  2385. cmds)))
  2386. (defun org-agenda-get-restriction-and-command (prefix-descriptions)
  2387. "The user interface for selecting an agenda command."
  2388. (catch 'exit
  2389. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  2390. (restrict-ok (and bfn (derived-mode-p 'org-mode)))
  2391. (region-p (org-region-active-p))
  2392. (custom org-agenda-custom-commands)
  2393. (selstring "")
  2394. restriction second-time
  2395. c entry key type match prefixes rmheader header-end custom1 desc
  2396. line lines left right n n1)
  2397. (save-window-excursion
  2398. (delete-other-windows)
  2399. (org-switch-to-buffer-other-window " *Agenda Commands*")
  2400. (erase-buffer)
  2401. (insert (eval-when-compile
  2402. (let ((header
  2403. "Press key for an agenda command: < Buffer, subtree/region restriction
  2404. -------------------------------- > Remove restriction
  2405. a Agenda for current week or day e Export agenda views
  2406. t List of all TODO entries T Entries with special TODO kwd
  2407. m Match a TAGS/PROP/TODO query M Like m, but only TODO entries
  2408. s Search for keywords S Like s, but only TODO entries
  2409. L Timeline for current buffer # List stuck projects (!=configure)
  2410. / Multi-occur C Configure custom agenda commands
  2411. ? Find :FLAGGED: entries * Toggle sticky agenda views
  2412. ")
  2413. (start 0))
  2414. (while (string-match
  2415. "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
  2416. header start)
  2417. (setq start (match-end 0))
  2418. (add-text-properties (match-beginning 2) (match-end 2)
  2419. '(face bold) header))
  2420. header)))
  2421. (setq header-end (point-marker))
  2422. (while t
  2423. (setq custom1 custom)
  2424. (when (eq rmheader t)
  2425. (org-goto-line 1)
  2426. (re-search-forward ":" nil t)
  2427. (delete-region (match-end 0) (point-at-eol))
  2428. (forward-char 1)
  2429. (looking-at "-+")
  2430. (delete-region (match-end 0) (point-at-eol))
  2431. (move-marker header-end (match-end 0)))
  2432. (goto-char header-end)
  2433. (delete-region (point) (point-max))
  2434. ;; Produce all the lines that describe custom commands and prefixes
  2435. (setq lines nil)
  2436. (while (setq entry (pop custom1))
  2437. (setq key (car entry) desc (nth 1 entry)
  2438. type (nth 2 entry)
  2439. match (nth 3 entry))
  2440. (if (> (length key) 1)
  2441. (add-to-list 'prefixes (string-to-char key))
  2442. (setq line
  2443. (format
  2444. "%-4s%-14s"
  2445. (org-add-props (copy-sequence key)
  2446. '(face bold))
  2447. (cond
  2448. ((string-match "\\S-" desc) desc)
  2449. ((eq type 'agenda) "Agenda for current week or day")
  2450. ((eq type 'alltodo) "List of all TODO entries")
  2451. ((eq type 'search) "Word search")
  2452. ((eq type 'stuck) "List of stuck projects")
  2453. ((eq type 'todo) "TODO keyword")
  2454. ((eq type 'tags) "Tags query")
  2455. ((eq type 'tags-todo) "Tags (TODO)")
  2456. ((eq type 'tags-tree) "Tags tree")
  2457. ((eq type 'todo-tree) "TODO kwd tree")
  2458. ((eq type 'occur-tree) "Occur tree")
  2459. ((functionp type) (if (symbolp type)
  2460. (symbol-name type)
  2461. "Lambda expression"))
  2462. (t "???"))))
  2463. (if org-agenda-menu-show-matcher
  2464. (setq line
  2465. (concat line ": "
  2466. (cond
  2467. ((stringp match)
  2468. (setq match (copy-sequence match))
  2469. (org-add-props match nil 'face 'org-warning))
  2470. ((listp type)
  2471. (format "set of %d commands" (length type))))))
  2472. (if (org-string-nw-p match)
  2473. (add-text-properties
  2474. 0 (length line) (list 'help-echo
  2475. (concat "Matcher: " match)) line)))
  2476. (push line lines)))
  2477. (setq lines (nreverse lines))
  2478. (when prefixes
  2479. (mapc (lambda (x)
  2480. (push
  2481. (format "%s %s"
  2482. (org-add-props (char-to-string x)
  2483. nil 'face 'bold)
  2484. (or (cdr (assoc (concat selstring
  2485. (char-to-string x))
  2486. prefix-descriptions))
  2487. "Prefix key"))
  2488. lines))
  2489. prefixes))
  2490. ;; Check if we should display in two columns
  2491. (if org-agenda-menu-two-columns
  2492. (progn
  2493. (setq n (length lines)
  2494. n1 (+ (/ n 2) (mod n 2))
  2495. right (nthcdr n1 lines)
  2496. left (copy-sequence lines))
  2497. (setcdr (nthcdr (1- n1) left) nil))
  2498. (setq left lines right nil))
  2499. (while left
  2500. (insert "\n" (pop left))
  2501. (when right
  2502. (if (< (current-column) 40)
  2503. (move-to-column 40 t)
  2504. (insert " "))
  2505. (insert (pop right))))
  2506. ;; Make the window the right size
  2507. (goto-char (point-min))
  2508. (if second-time
  2509. (if (not (pos-visible-in-window-p (point-max)))
  2510. (org-fit-window-to-buffer))
  2511. (setq second-time t)
  2512. (org-fit-window-to-buffer))
  2513. ;; Ask for selection
  2514. (message "Press key for agenda command%s:"
  2515. (if (or restrict-ok org-agenda-overriding-restriction)
  2516. (if org-agenda-overriding-restriction
  2517. " (restriction lock active)"
  2518. (if restriction
  2519. (format " (restricted to %s)" restriction)
  2520. " (unrestricted)"))
  2521. ""))
  2522. (setq c (read-char-exclusive))
  2523. (message "")
  2524. (cond
  2525. ((assoc (char-to-string c) custom)
  2526. (setq selstring (concat selstring (char-to-string c)))
  2527. (throw 'exit (cons selstring restriction)))
  2528. ((memq c prefixes)
  2529. (setq selstring (concat selstring (char-to-string c))
  2530. prefixes nil
  2531. rmheader (or rmheader t)
  2532. custom (delq nil (mapcar
  2533. (lambda (x)
  2534. (if (or (= (length (car x)) 1)
  2535. (/= (string-to-char (car x)) c))
  2536. nil
  2537. (cons (substring (car x) 1) (cdr x))))
  2538. custom))))
  2539. ((eq c ?*)
  2540. (call-interactively 'org-toggle-sticky-agenda)
  2541. (sit-for 2))
  2542. ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
  2543. (message "Restriction is only possible in Org-mode buffers")
  2544. (ding) (sit-for 1))
  2545. ((eq c ?1)
  2546. (org-agenda-remove-restriction-lock 'noupdate)
  2547. (setq restriction 'buffer))
  2548. ((eq c ?0)
  2549. (org-agenda-remove-restriction-lock 'noupdate)
  2550. (setq restriction (if region-p 'region 'subtree)))
  2551. ((eq c ?<)
  2552. (org-agenda-remove-restriction-lock 'noupdate)
  2553. (setq restriction
  2554. (cond
  2555. ((eq restriction 'buffer)
  2556. (if region-p 'region 'subtree))
  2557. ((memq restriction '(subtree region))
  2558. nil)
  2559. (t 'buffer))))
  2560. ((eq c ?>)
  2561. (org-agenda-remove-restriction-lock 'noupdate)
  2562. (setq restriction nil))
  2563. ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
  2564. (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
  2565. ((and (> (length selstring) 0) (eq c ?\d))
  2566. (delete-window)
  2567. (org-agenda-get-restriction-and-command prefix-descriptions))
  2568. ((equal c ?q) (error "Abort"))
  2569. (t (error "Invalid key %c" c))))))))
  2570. (defun org-agenda-fit-window-to-buffer ()
  2571. "Fit the window to the buffer size."
  2572. (and (memq org-agenda-window-setup '(reorganize-frame))
  2573. (fboundp 'fit-window-to-buffer)
  2574. (org-fit-window-to-buffer
  2575. nil
  2576. (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
  2577. (floor (* (frame-height) (car org-agenda-window-frame-fractions))))))
  2578. (defvar org-cmd nil)
  2579. (defvar org-agenda-overriding-cmd nil)
  2580. (defvar org-agenda-overriding-arguments nil)
  2581. (defvar org-agenda-overriding-cmd-arguments nil)
  2582. (defun org-agenda-run-series (name series)
  2583. (org-let (nth 1 series) '(org-agenda-prepare name))
  2584. ;; We need to reset agenda markers here, because when constructing a
  2585. ;; block agenda, the individual blocks do not do that.
  2586. (org-agenda-reset-markers)
  2587. (let* ((org-agenda-multi t)
  2588. (redo (list 'org-agenda-run-series name (list 'quote series)))
  2589. (cmds (car series))
  2590. (gprops (nth 1 series))
  2591. match ;; The byte compiler incorrectly complains about this. Keep it!
  2592. org-cmd type lprops)
  2593. (while (setq org-cmd (pop cmds))
  2594. (setq type (car org-cmd)
  2595. match (eval (nth 1 org-cmd))
  2596. lprops (nth 2 org-cmd))
  2597. (let ((org-agenda-overriding-arguments
  2598. (if (eq org-agenda-overriding-cmd org-cmd)
  2599. (or org-agenda-overriding-arguments
  2600. org-agenda-overriding-cmd-arguments))))
  2601. (cond
  2602. ((eq type 'agenda)
  2603. (org-let2 gprops lprops
  2604. '(call-interactively 'org-agenda-list)))
  2605. ((eq type 'alltodo)
  2606. (org-let2 gprops lprops
  2607. '(call-interactively 'org-todo-list)))
  2608. ((eq type 'search)
  2609. (org-let2 gprops lprops
  2610. '(org-search-view current-prefix-arg match nil)))
  2611. ((eq type 'stuck)
  2612. (org-let2 gprops lprops
  2613. '(call-interactively 'org-agenda-list-stuck-projects)))
  2614. ((eq type 'tags)
  2615. (org-let2 gprops lprops
  2616. '(org-tags-view current-prefix-arg match)))
  2617. ((eq type 'tags-todo)
  2618. (org-let2 gprops lprops
  2619. '(org-tags-view '(4) match)))
  2620. ((eq type 'todo)
  2621. (org-let2 gprops lprops
  2622. '(org-todo-list match)))
  2623. ((fboundp type)
  2624. (org-let2 gprops lprops
  2625. '(funcall type match)))
  2626. (t (error "Invalid type in command series")))))
  2627. (widen)
  2628. (let ((inhibit-read-only t))
  2629. (add-text-properties (point-min) (point-max)
  2630. `(org-series t org-series-redo-cmd ,redo)))
  2631. (setq org-agenda-redo-command redo)
  2632. (goto-char (point-min)))
  2633. (org-agenda-fit-window-to-buffer)
  2634. (org-let (nth 1 series) '(org-agenda-finalize)))
  2635. ;;;###autoload
  2636. (defmacro org-batch-agenda (cmd-key &rest parameters)
  2637. "Run an agenda command in batch mode and send the result to STDOUT.
  2638. If CMD-KEY is a string of length 1, it is used as a key in
  2639. `org-agenda-custom-commands' and triggers this command. If it is a
  2640. longer string it is used as a tags/todo match string.
  2641. Parameters are alternating variable names and values that will be bound
  2642. before running the agenda command."
  2643. (org-eval-in-environment (org-make-parameter-alist parameters)
  2644. (if (> (length cmd-key) 2)
  2645. (org-tags-view nil cmd-key)
  2646. (org-agenda nil cmd-key)))
  2647. (set-buffer org-agenda-buffer-name)
  2648. (princ (buffer-string)))
  2649. (autoload 'org-batch-agenda "org-agenda" "\
  2650. Run an agenda command in batch mode and send the result to STDOUT.
  2651. If CMD-KEY is a string of length 1, it is used as a key in
  2652. `org-agenda-custom-commands' and triggers this command. If it is a
  2653. longer string it is used as a tags/todo match string.
  2654. Parameters are alternating variable names and values that will be bound
  2655. before running the agenda command.
  2656. \(fn CMD-KEY &rest PARAMETERS)" nil t)
  2657. (def-edebug-spec org-batch-agenda (form &rest sexp))
  2658. (defvar org-agenda-info nil)
  2659. ;;;###autoload
  2660. (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
  2661. "Run an agenda command in batch mode and send the result to STDOUT.
  2662. If CMD-KEY is a string of length 1, it is used as a key in
  2663. `org-agenda-custom-commands' and triggers this command. If it is a
  2664. longer string it is used as a tags/todo match string.
  2665. Parameters are alternating variable names and values that will be bound
  2666. before running the agenda command.
  2667. The output gives a line for each selected agenda item. Each
  2668. item is a list of comma-separated values, like this:
  2669. category,head,type,todo,tags,date,time,extra,priority-l,priority-n
  2670. category The category of the item
  2671. head The headline, without TODO kwd, TAGS and PRIORITY
  2672. type The type of the agenda entry, can be
  2673. todo selected in TODO match
  2674. tagsmatch selected in tags match
  2675. diary imported from diary
  2676. deadline a deadline on given date
  2677. scheduled scheduled on given date
  2678. timestamp entry has timestamp on given date
  2679. closed entry was closed on given date
  2680. upcoming-deadline warning about deadline
  2681. past-scheduled forwarded scheduled item
  2682. block entry has date block including g. date
  2683. todo The todo keyword, if any
  2684. tags All tags including inherited ones, separated by colons
  2685. date The relevant date, like 2007-2-14
  2686. time The time, like 15:00-16:50
  2687. extra Sting with extra planning info
  2688. priority-l The priority letter if any was given
  2689. priority-n The computed numerical priority
  2690. agenda-day The day in the agenda where this is listed"
  2691. (org-eval-in-environment (append '((org-agenda-remove-tags t))
  2692. (org-make-parameter-alist parameters))
  2693. (if (> (length cmd-key) 2)
  2694. (org-tags-view nil cmd-key)
  2695. (org-agenda nil cmd-key)))
  2696. (set-buffer org-agenda-buffer-name)
  2697. (let* ((lines (org-split-string (buffer-string) "\n"))
  2698. line)
  2699. (while (setq line (pop lines))
  2700. (catch 'next
  2701. (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
  2702. (setq org-agenda-info
  2703. (org-fix-agenda-info (text-properties-at 0 line)))
  2704. (princ
  2705. (mapconcat 'org-agenda-export-csv-mapper
  2706. '(org-category txt type todo tags date time extra
  2707. priority-letter priority agenda-day)
  2708. ","))
  2709. (princ "\n")))))
  2710. (autoload 'org-batch-agenda-csv "org-agenda" "\
  2711. Run an agenda command in batch mode and send the result to STDOUT.
  2712. If CMD-KEY is a string of length 1, it is used as a key in
  2713. `org-agenda-custom-commands' and triggers this command. If it is a
  2714. longer string it is used as a tags/todo match string.
  2715. Parameters are alternating variable names and values that will be bound
  2716. before running the agenda command.
  2717. The output gives a line for each selected agenda item. Each
  2718. item is a list of comma-separated values, like this:
  2719. category,head,type,todo,tags,date,time,extra,priority-l,priority-n
  2720. category The category of the item
  2721. head The headline, without TODO kwd, TAGS and PRIORITY
  2722. type The type of the agenda entry, can be
  2723. todo selected in TODO match
  2724. tagsmatch selected in tags match
  2725. diary imported from diary
  2726. deadline a deadline on given date
  2727. scheduled scheduled on given date
  2728. timestamp entry has timestamp on given date
  2729. closed entry was closed on given date
  2730. upcoming-deadline warning about deadline
  2731. past-scheduled forwarded scheduled item
  2732. block entry has date block including g. date
  2733. todo The todo keyword, if any
  2734. tags All tags including inherited ones, separated by colons
  2735. date The relevant date, like 2007-2-14
  2736. time The time, like 15:00-16:50
  2737. extra Sting with extra planning info
  2738. priority-l The priority letter if any was given
  2739. priority-n The computed numerical priority
  2740. agenda-day The day in the agenda where this is listed
  2741. \(fn CMD-KEY &rest PARAMETERS)" nil t)
  2742. (def-edebug-spec org-batch-agenda-csv (form &rest sexp))
  2743. (defun org-fix-agenda-info (props)
  2744. "Make sure all properties on an agenda item have a canonical form.
  2745. This ensures the export commands can easily use it."
  2746. (let (tmp re)
  2747. (when (setq tmp (plist-get props 'tags))
  2748. (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
  2749. (when (setq tmp (plist-get props 'date))
  2750. (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2751. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2752. '((format "%4d, %9s %2s, %4s" dayname monthname day year))
  2753. (setq tmp (calendar-date-string tmp)))
  2754. (setq props (plist-put props 'date tmp)))
  2755. (when (setq tmp (plist-get props 'day))
  2756. (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2757. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2758. (setq tmp (calendar-date-string tmp)))
  2759. (setq props (plist-put props 'day tmp))
  2760. (setq props (plist-put props 'agenda-day tmp)))
  2761. (when (setq tmp (plist-get props 'txt))
  2762. (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
  2763. (plist-put props 'priority-letter (match-string 1 tmp))
  2764. (setq tmp (replace-match "" t t tmp)))
  2765. (when (and (setq re (plist-get props 'org-todo-regexp))
  2766. (setq re (concat "\\`\\.*" re " ?"))
  2767. (string-match re tmp))
  2768. (plist-put props 'todo (match-string 1 tmp))
  2769. (setq tmp (replace-match "" t t tmp)))
  2770. (plist-put props 'txt tmp)))
  2771. props)
  2772. (defun org-agenda-export-csv-mapper (prop)
  2773. (let ((res (plist-get org-agenda-info prop)))
  2774. (setq res
  2775. (cond
  2776. ((not res) "")
  2777. ((stringp res) res)
  2778. (t (prin1-to-string res))))
  2779. (while (string-match "," res)
  2780. (setq res (replace-match ";" t t res)))
  2781. (org-trim res)))
  2782. ;;;###autoload
  2783. (defun org-store-agenda-views (&rest parameters)
  2784. (interactive)
  2785. (eval (list 'org-batch-store-agenda-views)))
  2786. (autoload 'org-store-agenda-views "org-agenda" "\
  2787. \(fn &rest PARAMETERS)" t nil)
  2788. ;;;###autoload
  2789. (defmacro org-batch-store-agenda-views (&rest parameters)
  2790. "Run all custom agenda commands that have a file argument."
  2791. (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
  2792. (pop-up-frames nil)
  2793. (dir default-directory)
  2794. (pars (org-make-parameter-alist parameters))
  2795. cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
  2796. (save-window-excursion
  2797. (while cmds
  2798. (setq cmd (pop cmds)
  2799. thiscmdkey (car cmd)
  2800. thiscmdcmd (cdr cmd)
  2801. match (nth 2 thiscmdcmd)
  2802. bufname (if org-agenda-sticky
  2803. (or (and (stringp match)
  2804. (format "*Org Agenda(%s:%s)*" thiscmdkey match))
  2805. (format "*Org Agenda(%s)*" thiscmdkey))
  2806. org-agenda-buffer-name)
  2807. cmd-or-set (nth 2 cmd)
  2808. opts (nth (if (listp cmd-or-set) 3 4) cmd)
  2809. files (nth (if (listp cmd-or-set) 4 5) cmd))
  2810. (if (stringp files) (setq files (list files)))
  2811. (when files
  2812. (org-eval-in-environment (append org-agenda-exporter-settings
  2813. opts pars)
  2814. (org-agenda nil thiscmdkey))
  2815. (set-buffer bufname)
  2816. (while files
  2817. (org-eval-in-environment (append org-agenda-exporter-settings
  2818. opts pars)
  2819. (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
  2820. (and (get-buffer bufname)
  2821. (kill-buffer bufname)))))))
  2822. (autoload 'org-batch-store-agenda-views "org-agenda" "\
  2823. Run all custom agenda commands that have a file argument.
  2824. \(fn &rest PARAMETERS)" nil t)
  2825. (def-edebug-spec org-batch-store-agenda-views (&rest sexp))
  2826. (defvar org-agenda-current-span nil
  2827. "The current span used in the agenda view.") ; local variable in the agenda buffer
  2828. (defun org-agenda-mark-header-line (pos)
  2829. "Mark the line at POS as an agenda structure header."
  2830. (save-excursion
  2831. (goto-char pos)
  2832. (put-text-property (point-at-bol) (point-at-eol)
  2833. 'org-agenda-structural-header t)
  2834. (when org-agenda-title-append
  2835. (put-text-property (point-at-bol) (point-at-eol)
  2836. 'org-agenda-title-append org-agenda-title-append))))
  2837. (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
  2838. (defvar org-agenda-write-buffer-name "Agenda View")
  2839. (defun org-agenda-write (file &optional open nosettings agenda-bufname)
  2840. "Write the current buffer (an agenda view) as a file.
  2841. Depending on the extension of the file name, plain text (.txt),
  2842. HTML (.html or .htm) or Postscript (.ps) is produced.
  2843. If the extension is .ics, run icalendar export over all files used
  2844. to construct the agenda and limit the export to entries listed in the
  2845. agenda now.
  2846. With prefix argument OPEN, open the new file immediately.
  2847. If NOSETTINGS is given, do not scope the settings of
  2848. `org-agenda-exporter-settings' into the export commands. This is used when
  2849. the settings have already been scoped and we do not wish to overrule other,
  2850. higher priority settings.
  2851. If AGENDA-BUFFER-NAME, use this as the buffer name for the agenda to write."
  2852. (interactive "FWrite agenda to file: \nP")
  2853. (if (not (file-writable-p file))
  2854. (error "Cannot write agenda to file %s" file))
  2855. (org-let (if nosettings nil org-agenda-exporter-settings)
  2856. '(save-excursion
  2857. (save-window-excursion
  2858. (org-agenda-mark-filtered-text)
  2859. (let ((bs (copy-sequence (buffer-string))) beg)
  2860. (org-agenda-unmark-filtered-text)
  2861. (with-temp-buffer
  2862. (rename-buffer org-agenda-write-buffer-name t)
  2863. (set-buffer-modified-p nil)
  2864. (insert bs)
  2865. (org-agenda-remove-marked-text 'org-filtered)
  2866. (while (setq beg (text-property-any (point-min) (point-max)
  2867. 'org-filtered t))
  2868. (delete-region
  2869. beg (or (next-single-property-change beg 'org-filtered)
  2870. (point-max))))
  2871. (run-hooks 'org-agenda-before-write-hook)
  2872. (cond
  2873. ((org-bound-and-true-p org-mobile-creating-agendas)
  2874. (org-mobile-write-agenda-for-mobile file))
  2875. ((string-match "\\.html?\\'" file)
  2876. (require 'htmlize)
  2877. (set-buffer (htmlize-buffer (current-buffer)))
  2878. (when org-agenda-export-html-style
  2879. ;; replace <style> section with org-agenda-export-html-style
  2880. (goto-char (point-min))
  2881. (kill-region (- (search-forward "<style") 6)
  2882. (search-forward "</style>"))
  2883. (insert org-agenda-export-html-style))
  2884. (write-file file)
  2885. (kill-buffer (current-buffer))
  2886. (message "HTML written to %s" file))
  2887. ((string-match "\\.ps\\'" file)
  2888. (require 'ps-print)
  2889. (ps-print-buffer-with-faces file)
  2890. (message "Postscript written to %s" file))
  2891. ((string-match "\\.pdf\\'" file)
  2892. (require 'ps-print)
  2893. (ps-print-buffer-with-faces
  2894. (concat (file-name-sans-extension file) ".ps"))
  2895. (call-process "ps2pdf" nil nil nil
  2896. (expand-file-name
  2897. (concat (file-name-sans-extension file) ".ps"))
  2898. (expand-file-name file))
  2899. (delete-file (concat (file-name-sans-extension file) ".ps"))
  2900. (message "PDF written to %s" file))
  2901. ((string-match "\\.ics\\'" file)
  2902. (require 'org-icalendar)
  2903. (let ((org-agenda-marker-table
  2904. (org-create-marker-find-array
  2905. (org-agenda-collect-markers)))
  2906. (org-icalendar-verify-function 'org-check-agenda-marker-table)
  2907. (org-combined-agenda-icalendar-file file))
  2908. (apply 'org-export-icalendar 'combine
  2909. (org-agenda-files nil 'ifmode))))
  2910. (t
  2911. (let ((bs (buffer-string)))
  2912. (find-file file)
  2913. (erase-buffer)
  2914. (insert bs)
  2915. (save-buffer 0)
  2916. (kill-buffer (current-buffer))
  2917. (message "Plain text written to %s" file))))))))
  2918. (set-buffer (or agenda-bufname
  2919. (and (org-called-interactively-p 'any) (buffer-name))
  2920. org-agenda-buffer-name)))
  2921. (when open (org-open-file file)))
  2922. (defvar org-agenda-tag-filter-overlays nil)
  2923. (defvar org-agenda-cat-filter-overlays nil)
  2924. (defun org-agenda-mark-filtered-text ()
  2925. "Mark all text hidden by filtering with a text property."
  2926. (let ((inhibit-read-only t))
  2927. (mapc
  2928. (lambda (o)
  2929. (when (equal (overlay-buffer o) (current-buffer))
  2930. (put-text-property
  2931. (overlay-start o) (overlay-end o)
  2932. 'org-filtered t)))
  2933. (append org-agenda-tag-filter-overlays
  2934. org-agenda-cat-filter-overlays))))
  2935. (defun org-agenda-unmark-filtered-text ()
  2936. "Remove the filtering text property."
  2937. (let ((inhibit-read-only t))
  2938. (remove-text-properties (point-min) (point-max) '(org-filtered t))))
  2939. (defun org-agenda-remove-marked-text (property &optional value)
  2940. "Delete all text marked with VALUE of PROPERTY.
  2941. VALUE defaults to t."
  2942. (let (beg)
  2943. (setq value (or value t))
  2944. (while (setq beg (text-property-any (point-min) (point-max)
  2945. property value))
  2946. (delete-region
  2947. beg (or (next-single-property-change beg 'org-filtered)
  2948. (point-max))))))
  2949. (defun org-agenda-add-entry-text ()
  2950. "Add entry text to agenda lines.
  2951. This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
  2952. entry text following headings shown in the agenda.
  2953. Drawers will be excluded, also the line with scheduling/deadline info."
  2954. (when (and (> org-agenda-add-entry-text-maxlines 0)
  2955. (not (org-bound-and-true-p org-mobile-creating-agendas)))
  2956. (let (m txt)
  2957. (goto-char (point-min))
  2958. (while (not (eobp))
  2959. (if (not (setq m (org-get-at-bol 'org-hd-marker)))
  2960. (beginning-of-line 2)
  2961. (setq txt (org-agenda-get-some-entry-text
  2962. m org-agenda-add-entry-text-maxlines " > "))
  2963. (end-of-line 1)
  2964. (if (string-match "\\S-" txt)
  2965. (insert "\n" txt)
  2966. (or (eobp) (forward-char 1))))))))
  2967. (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
  2968. &rest keep)
  2969. "Extract entry text from MARKER, at most N-LINES lines.
  2970. This will ignore drawers etc, just get the text.
  2971. If INDENT is given, prefix every line with this string. If KEEP is
  2972. given, it is a list of symbols, defining stuff that should not be
  2973. removed from the entry content. Currently only `planning' is allowed here."
  2974. (let (txt drawer-re kwd-time-re ind)
  2975. (save-excursion
  2976. (with-current-buffer (marker-buffer marker)
  2977. (if (not (derived-mode-p 'org-mode))
  2978. (setq txt "")
  2979. (save-excursion
  2980. (save-restriction
  2981. (widen)
  2982. (goto-char marker)
  2983. (end-of-line 1)
  2984. (setq txt (buffer-substring
  2985. (min (1+ (point)) (point-max))
  2986. (progn (outline-next-heading) (point)))
  2987. drawer-re org-drawer-regexp
  2988. kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
  2989. ".*\n?"))
  2990. (with-temp-buffer
  2991. (insert txt)
  2992. (when org-agenda-add-entry-text-descriptive-links
  2993. (goto-char (point-min))
  2994. (while (org-activate-bracket-links (point-max))
  2995. (add-text-properties (match-beginning 0) (match-end 0)
  2996. '(face org-link))))
  2997. (goto-char (point-min))
  2998. (while (re-search-forward org-bracket-link-regexp (point-max) t)
  2999. (set-text-properties (match-beginning 0) (match-end 0)
  3000. nil))
  3001. (goto-char (point-min))
  3002. (while (re-search-forward drawer-re nil t)
  3003. (delete-region
  3004. (match-beginning 0)
  3005. (progn (re-search-forward
  3006. "^[ \t]*:END:.*\n?" nil 'move)
  3007. (point))))
  3008. (unless (member 'planning keep)
  3009. (goto-char (point-min))
  3010. (while (re-search-forward kwd-time-re nil t)
  3011. (replace-match "")))
  3012. (goto-char (point-min))
  3013. (when org-agenda-entry-text-exclude-regexps
  3014. (let ((re-list org-agenda-entry-text-exclude-regexps) re)
  3015. (while (setq re (pop re-list))
  3016. (goto-char (point-min))
  3017. (while (re-search-forward re nil t)
  3018. (replace-match "")))))
  3019. (goto-char (point-max))
  3020. (skip-chars-backward " \t\n")
  3021. (if (looking-at "[ \t\n]+\\'") (replace-match ""))
  3022. ;; find and remove min common indentation
  3023. (goto-char (point-min))
  3024. (untabify (point-min) (point-max))
  3025. (setq ind (org-get-indentation))
  3026. (while (not (eobp))
  3027. (unless (looking-at "[ \t]*$")
  3028. (setq ind (min ind (org-get-indentation))))
  3029. (beginning-of-line 2))
  3030. (goto-char (point-min))
  3031. (while (not (eobp))
  3032. (unless (looking-at "[ \t]*$")
  3033. (move-to-column ind)
  3034. (delete-region (point-at-bol) (point)))
  3035. (beginning-of-line 2))
  3036. (run-hooks 'org-agenda-entry-text-cleanup-hook)
  3037. (goto-char (point-min))
  3038. (when indent
  3039. (while (and (not (eobp)) (re-search-forward "^" nil t))
  3040. (replace-match indent t t)))
  3041. (goto-char (point-min))
  3042. (while (looking-at "[ \t]*\n") (replace-match ""))
  3043. (goto-char (point-max))
  3044. (when (> (org-current-line)
  3045. n-lines)
  3046. (org-goto-line (1+ n-lines))
  3047. (backward-char 1))
  3048. (setq txt (buffer-substring (point-min) (point)))))))))
  3049. txt))
  3050. (defun org-agenda-collect-markers ()
  3051. "Collect the markers pointing to entries in the agenda buffer."
  3052. (let (m markers)
  3053. (save-excursion
  3054. (goto-char (point-min))
  3055. (while (not (eobp))
  3056. (when (setq m (or (org-get-at-bol 'org-hd-marker)
  3057. (org-get-at-bol 'org-marker)))
  3058. (push m markers))
  3059. (beginning-of-line 2)))
  3060. (nreverse markers)))
  3061. (defun org-create-marker-find-array (marker-list)
  3062. "Create a alist of files names with all marker positions in that file."
  3063. (let (f tbl m a p)
  3064. (while (setq m (pop marker-list))
  3065. (setq p (marker-position m)
  3066. f (buffer-file-name (or (buffer-base-buffer
  3067. (marker-buffer m))
  3068. (marker-buffer m))))
  3069. (if (setq a (assoc f tbl))
  3070. (push (marker-position m) (cdr a))
  3071. (push (list f p) tbl)))
  3072. (mapcar (lambda (x) (setcdr x (sort (copy-sequence (cdr x)) '<)) x)
  3073. tbl)))
  3074. (defvar org-agenda-marker-table nil) ; dynamically scoped parameter
  3075. (defun org-check-agenda-marker-table ()
  3076. "Check of the current entry is on the marker list."
  3077. (let ((file (buffer-file-name (or (buffer-base-buffer) (current-buffer))))
  3078. a)
  3079. (and (setq a (assoc file org-agenda-marker-table))
  3080. (save-match-data
  3081. (save-excursion
  3082. (org-back-to-heading t)
  3083. (member (point) (cdr a)))))))
  3084. (defun org-check-for-org-mode ()
  3085. "Make sure current buffer is in org-mode. Error if not."
  3086. (or (derived-mode-p 'org-mode)
  3087. (error "Cannot execute org-mode agenda command on buffer in %s"
  3088. major-mode)))
  3089. ;;; Agenda prepare and finalize
  3090. (defvar org-agenda-multi nil) ; dynamically scoped
  3091. (defvar org-agenda-pre-window-conf nil)
  3092. (defvar org-agenda-columns-active nil)
  3093. (defvar org-agenda-name nil)
  3094. (defvar org-agenda-tag-filter nil)
  3095. (defvar org-agenda-category-filter nil)
  3096. (defvar org-agenda-top-category-filter nil)
  3097. (defvar org-agenda-tag-filter-while-redo nil)
  3098. (defvar org-agenda-tag-filter-preset nil
  3099. "A preset of the tags filter used for secondary agenda filtering.
  3100. This must be a list of strings, each string must be a single tag preceded
  3101. by \"+\" or \"-\".
  3102. This variable should not be set directly, but agenda custom commands can
  3103. bind it in the options section. The preset filter is a global property of
  3104. the entire agenda view. In a block agenda, it will not work reliably to
  3105. define a filter for one of the individual blocks. You need to set it in
  3106. the global options and expect it to be applied to the entire view.")
  3107. (defvar org-agenda-category-filter-preset nil
  3108. "A preset of the category filter used for secondary agenda filtering.
  3109. This must be a list of strings, each string must be a single category
  3110. preceded by \"+\" or \"-\".
  3111. This variable should not be set directly, but agenda custom commands can
  3112. bind it in the options section. The preset filter is a global property of
  3113. the entire agenda view. In a block agenda, it will not work reliably to
  3114. define a filter for one of the individual blocks. You need to set it in
  3115. the global options and expect it to be applied to the entire view.")
  3116. (defun org-agenda-use-sticky-p ()
  3117. "Return non-nil if an agenda buffer named
  3118. `org-agenda-buffer-name' exists and should be shown instead of
  3119. generating a new one."
  3120. (and
  3121. ;; turned off by user
  3122. org-agenda-sticky
  3123. ;; For multi-agenda buffer already exists
  3124. (not org-agenda-multi)
  3125. ;; buffer found
  3126. (get-buffer org-agenda-buffer-name)
  3127. ;; C-u parameter is same as last call
  3128. (with-current-buffer (get-buffer org-agenda-buffer-name)
  3129. (and
  3130. (equal current-prefix-arg
  3131. org-agenda-last-prefix-arg)
  3132. ;; In case user turned stickiness on, while having existing
  3133. ;; Agenda buffer active, don't reuse that buffer, because it
  3134. ;; does not have org variables local
  3135. org-agenda-this-buffer-is-sticky))))
  3136. (defun org-agenda-prepare-window (abuf)
  3137. "Setup agenda buffer in the window."
  3138. (let* ((awin (get-buffer-window abuf))
  3139. wconf)
  3140. (cond
  3141. ((equal (current-buffer) abuf) nil)
  3142. (awin (select-window awin))
  3143. ((not (setq wconf (current-window-configuration))))
  3144. ((equal org-agenda-window-setup 'current-window)
  3145. (org-pop-to-buffer-same-window abuf))
  3146. ((equal org-agenda-window-setup 'other-window)
  3147. (org-switch-to-buffer-other-window abuf))
  3148. ((equal org-agenda-window-setup 'other-frame)
  3149. (switch-to-buffer-other-frame abuf))
  3150. ((equal org-agenda-window-setup 'reorganize-frame)
  3151. (delete-other-windows)
  3152. (org-switch-to-buffer-other-window abuf)))
  3153. ;; additional test in case agenda is invoked from within agenda
  3154. ;; buffer via elisp link
  3155. (unless (equal (current-buffer) abuf)
  3156. (org-pop-to-buffer-same-window abuf))
  3157. (setq org-agenda-pre-window-conf
  3158. (or org-agenda-pre-window-conf wconf))))
  3159. (defun org-agenda-prepare (&optional name)
  3160. (if (org-agenda-use-sticky-p)
  3161. (progn
  3162. ;; Popup existing buffer
  3163. (org-agenda-prepare-window (get-buffer org-agenda-buffer-name))
  3164. (message "Sticky Agenda buffer, use `r' to refresh")
  3165. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3166. (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
  3167. (setq org-todo-keywords-for-agenda nil)
  3168. (setq org-drawers-for-agenda nil)
  3169. (unless org-agenda-persistent-filter
  3170. (setq org-agenda-tag-filter nil
  3171. org-agenda-category-filter nil))
  3172. (put 'org-agenda-tag-filter :preset-filter
  3173. org-agenda-tag-filter-preset)
  3174. (put 'org-agenda-category-filter :preset-filter
  3175. org-agenda-category-filter-preset)
  3176. (if org-agenda-multi
  3177. (progn
  3178. (setq buffer-read-only nil)
  3179. (goto-char (point-max))
  3180. (unless (or (bobp) org-agenda-compact-blocks
  3181. (not org-agenda-block-separator))
  3182. (insert "\n"
  3183. (if (stringp org-agenda-block-separator)
  3184. org-agenda-block-separator
  3185. (make-string (window-width) org-agenda-block-separator))
  3186. "\n"))
  3187. (narrow-to-region (point) (point-max)))
  3188. (setq org-done-keywords-for-agenda nil)
  3189. ;; Setting any org variables that are in org-agenda-local-vars
  3190. ;; list need to be done after the prepare call
  3191. (org-agenda-prepare-window (get-buffer-create org-agenda-buffer-name))
  3192. (setq buffer-read-only nil)
  3193. (org-agenda-reset-markers)
  3194. (let ((inhibit-read-only t)) (erase-buffer))
  3195. (org-agenda-mode)
  3196. (setq org-agenda-buffer (current-buffer))
  3197. (setq org-agenda-contributing-files nil)
  3198. (setq org-agenda-columns-active nil)
  3199. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  3200. (setq org-todo-keywords-for-agenda
  3201. (org-uniquify org-todo-keywords-for-agenda))
  3202. (setq org-done-keywords-for-agenda
  3203. (org-uniquify org-done-keywords-for-agenda))
  3204. (setq org-drawers-for-agenda (org-uniquify org-drawers-for-agenda))
  3205. (setq org-agenda-last-prefix-arg current-prefix-arg)
  3206. (setq org-agenda-this-buffer-name org-agenda-buffer-name)
  3207. (and name (not org-agenda-name)
  3208. (org-set-local 'org-agenda-name name)))
  3209. (setq buffer-read-only nil)))
  3210. (defvar org-agenda-overriding-columns-format) ; From org-colview.el
  3211. (defun org-agenda-finalize ()
  3212. "Finishing touch for the agenda buffer, called just before displaying it."
  3213. (unless org-agenda-multi
  3214. (save-excursion
  3215. (let ((inhibit-read-only t))
  3216. (goto-char (point-min))
  3217. (save-excursion
  3218. (while (org-activate-bracket-links (point-max))
  3219. (add-text-properties (match-beginning 0) (match-end 0)
  3220. '(face org-link))))
  3221. (save-excursion
  3222. (while (org-activate-plain-links (point-max))
  3223. (add-text-properties (match-beginning 0) (match-end 0)
  3224. '(face org-link))))
  3225. (when (cadr (assoc 'org-prefix-has-tag
  3226. (car org-prefix-format-compiled)))
  3227. (org-agenda-align-tags))
  3228. (unless org-agenda-with-colors
  3229. (remove-text-properties (point-min) (point-max) '(face nil))))
  3230. (if (and (boundp 'org-agenda-overriding-columns-format)
  3231. org-agenda-overriding-columns-format)
  3232. (org-set-local 'org-agenda-overriding-columns-format
  3233. org-agenda-overriding-columns-format))
  3234. (if (and (boundp 'org-agenda-view-columns-initially)
  3235. org-agenda-view-columns-initially)
  3236. (org-agenda-columns))
  3237. (when org-agenda-fontify-priorities
  3238. (org-agenda-fontify-priorities))
  3239. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  3240. (org-agenda-dim-blocked-tasks))
  3241. ;; We need to widen when `org-agenda-finalize' is called from
  3242. ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in')
  3243. (when org-clock-current-task
  3244. (save-restriction
  3245. (widen)
  3246. (org-agenda-mark-clocking-task)))
  3247. (when org-agenda-entry-text-mode
  3248. (org-agenda-entry-text-hide)
  3249. (org-agenda-entry-text-show))
  3250. (if (and (functionp 'org-habit-insert-consistency-graphs)
  3251. (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
  3252. (org-habit-insert-consistency-graphs))
  3253. (let ((inhibit-read-only t))
  3254. (run-hooks 'org-agenda-finalize-hook))
  3255. (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
  3256. (when (or org-agenda-tag-filter (get 'org-agenda-tag-filter :preset-filter))
  3257. (org-agenda-filter-apply org-agenda-tag-filter 'tag))
  3258. (when (or org-agenda-category-filter (get 'org-agenda-category-filter :preset-filter))
  3259. (org-agenda-filter-apply org-agenda-category-filter 'category))
  3260. (org-add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local))))
  3261. (defun org-agenda-mark-clocking-task ()
  3262. "Mark the current clock entry in the agenda if it is present."
  3263. (mapc (lambda (o)
  3264. (if (eq (overlay-get o 'type) 'org-agenda-clocking)
  3265. (delete-overlay o)))
  3266. (overlays-in (point-min) (point-max)))
  3267. (when (marker-buffer org-clock-hd-marker)
  3268. (save-excursion
  3269. (goto-char (point-min))
  3270. (let (s ov)
  3271. (while (setq s (next-single-property-change (point) 'org-hd-marker))
  3272. (goto-char s)
  3273. (when (equal (org-get-at-bol 'org-hd-marker)
  3274. org-clock-hd-marker)
  3275. (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
  3276. (overlay-put ov 'type 'org-agenda-clocking)
  3277. (overlay-put ov 'face 'org-agenda-clocking)
  3278. (overlay-put ov 'help-echo
  3279. "The clock is running in this item")))))))
  3280. (defun org-agenda-fontify-priorities ()
  3281. "Make highest priority lines bold, and lowest italic."
  3282. (interactive)
  3283. (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
  3284. (delete-overlay o)))
  3285. (overlays-in (point-min) (point-max)))
  3286. (save-excursion
  3287. (let ((inhibit-read-only t)
  3288. b e p ov h l)
  3289. (goto-char (point-min))
  3290. (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
  3291. (setq h (or (get-char-property (point) 'org-highest-priority)
  3292. org-highest-priority)
  3293. l (or (get-char-property (point) 'org-lowest-priority)
  3294. org-lowest-priority)
  3295. p (string-to-char (match-string 1))
  3296. b (match-beginning 0)
  3297. e (if (eq org-agenda-fontify-priorities 'cookies)
  3298. (match-end 0)
  3299. (point-at-eol))
  3300. ov (make-overlay b e))
  3301. (overlay-put
  3302. ov 'face
  3303. (cond ((org-face-from-face-or-color
  3304. 'priority nil
  3305. (cdr (assoc p org-priority-faces))))
  3306. ((and (listp org-agenda-fontify-priorities)
  3307. (org-face-from-face-or-color
  3308. 'priority nil
  3309. (cdr (assoc p org-agenda-fontify-priorities)))))
  3310. ((equal p l) 'italic)
  3311. ((equal p h) 'bold)))
  3312. (overlay-put ov 'org-type 'org-priority)))))
  3313. (defun org-agenda-dim-blocked-tasks (&optional invisible)
  3314. (interactive "P")
  3315. "Dim currently blocked TODO's in the agenda display."
  3316. (message "Dim or hide blocked tasks...")
  3317. (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-blocked-todo)
  3318. (delete-overlay o)))
  3319. (overlays-in (point-min) (point-max)))
  3320. (save-excursion
  3321. (let ((inhibit-read-only t)
  3322. (org-depend-tag-blocked nil)
  3323. (invis (or (not (null invisible))
  3324. (eq org-agenda-dim-blocked-tasks 'invisible)))
  3325. org-blocked-by-checkboxes
  3326. invis1 b e p ov h l)
  3327. (goto-char (point-min))
  3328. (while (let ((pos (next-single-property-change (point) 'todo-state)))
  3329. (and pos (goto-char (1+ pos))))
  3330. (setq org-blocked-by-checkboxes nil invis1 invis)
  3331. (let ((marker (org-get-at-bol 'org-hd-marker)))
  3332. (when (and marker
  3333. (with-current-buffer (marker-buffer marker)
  3334. (save-excursion (goto-char marker)
  3335. (org-entry-blocked-p))))
  3336. (if org-blocked-by-checkboxes (setq invis1 nil))
  3337. (setq b (if invis1
  3338. (max (point-min) (1- (point-at-bol)))
  3339. (point-at-bol))
  3340. e (point-at-eol)
  3341. ov (make-overlay b e))
  3342. (if invis1
  3343. (overlay-put ov 'invisible t)
  3344. (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
  3345. (overlay-put ov 'org-type 'org-blocked-todo))))))
  3346. (message "Dim or hide blocked tasks...done"))
  3347. (defvar org-agenda-skip-function nil
  3348. "Function to be called at each match during agenda construction.
  3349. If this function returns nil, the current match should not be skipped.
  3350. Otherwise, the function must return a position from where the search
  3351. should be continued.
  3352. This may also be a Lisp form, it will be evaluated.
  3353. Never set this variable using `setq' or so, because then it will apply
  3354. to all future agenda commands. If you do want a global skipping condition,
  3355. use the option `org-agenda-skip-function-global' instead.
  3356. The correct usage for `org-agenda-skip-function' is to bind it with
  3357. `let' to scope it dynamically into the agenda-constructing command.
  3358. A good way to set it is through options in `org-agenda-custom-commands'.")
  3359. (defun org-agenda-skip ()
  3360. "Throw to `:skip' in places that should be skipped.
  3361. Also moves point to the end of the skipped region, so that search can
  3362. continue from there."
  3363. (let ((p (point-at-bol)) to)
  3364. (when (org-in-src-block-p t) (throw :skip t))
  3365. (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
  3366. (get-text-property p :org-archived)
  3367. (org-end-of-subtree t)
  3368. (throw :skip t))
  3369. (and org-agenda-skip-comment-trees
  3370. (get-text-property p :org-comment)
  3371. (org-end-of-subtree t)
  3372. (throw :skip t))
  3373. (if (equal (char-after p) ?#) (throw :skip t))
  3374. (when (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
  3375. (org-agenda-skip-eval org-agenda-skip-function)))
  3376. (goto-char to)
  3377. (throw :skip t))))
  3378. (defun org-agenda-skip-eval (form)
  3379. "If FORM is a function or a list, call (or eval) is and return result.
  3380. `save-excursion' and `save-match-data' are wrapped around the call, so point
  3381. and match data are returned to the previous state no matter what these
  3382. functions do."
  3383. (let (fp)
  3384. (and form
  3385. (or (setq fp (functionp form))
  3386. (consp form))
  3387. (save-excursion
  3388. (save-match-data
  3389. (if fp
  3390. (funcall form)
  3391. (eval form)))))))
  3392. (defvar org-agenda-markers nil
  3393. "List of all currently active markers created by `org-agenda'.")
  3394. (defvar org-agenda-last-marker-time (org-float-time)
  3395. "Creation time of the last agenda marker.")
  3396. (defun org-agenda-new-marker (&optional pos)
  3397. "Return a new agenda marker.
  3398. Org-mode keeps a list of these markers and resets them when they are
  3399. no longer in use."
  3400. (let ((m (copy-marker (or pos (point)))))
  3401. (setq org-agenda-last-marker-time (org-float-time))
  3402. (if org-agenda-buffer
  3403. (with-current-buffer org-agenda-buffer
  3404. (push m org-agenda-markers))
  3405. (push m org-agenda-markers))
  3406. m))
  3407. (defun org-agenda-reset-markers ()
  3408. "Reset markers created by `org-agenda'."
  3409. (while org-agenda-markers
  3410. (move-marker (pop org-agenda-markers) nil)))
  3411. (defun org-agenda-save-markers-for-cut-and-paste (beg end)
  3412. "Save relative positions of markers in region.
  3413. This check for agenda markers in all agenda buffers currently active."
  3414. (dolist (buf (buffer-list))
  3415. (with-current-buffer buf
  3416. (when (eq major-mode 'org-agenda-mode)
  3417. (mapc (lambda (m) (org-check-and-save-marker m beg end))
  3418. org-agenda-markers)))))
  3419. ;;; Entry text mode
  3420. (defun org-agenda-entry-text-show-here ()
  3421. "Add some text from the entry as context to the current line."
  3422. (let (m txt o)
  3423. (setq m (org-get-at-bol 'org-hd-marker))
  3424. (unless (marker-buffer m)
  3425. (error "No marker points to an entry here"))
  3426. (setq txt (concat "\n" (org-no-properties
  3427. (org-agenda-get-some-entry-text
  3428. m org-agenda-entry-text-maxlines " > "))))
  3429. (when (string-match "\\S-" txt)
  3430. (setq o (make-overlay (point-at-bol) (point-at-eol)))
  3431. (overlay-put o 'evaporate t)
  3432. (overlay-put o 'org-overlay-type 'agenda-entry-content)
  3433. (overlay-put o 'after-string txt))))
  3434. (defun org-agenda-entry-text-show ()
  3435. "Add entry context for all agenda lines."
  3436. (interactive)
  3437. (save-excursion
  3438. (goto-char (point-max))
  3439. (beginning-of-line 1)
  3440. (while (not (bobp))
  3441. (when (org-get-at-bol 'org-hd-marker)
  3442. (org-agenda-entry-text-show-here))
  3443. (beginning-of-line 0))))
  3444. (defun org-agenda-entry-text-hide ()
  3445. "Remove any shown entry context."
  3446. (delq nil
  3447. (mapcar (lambda (o)
  3448. (if (eq (overlay-get o 'org-overlay-type)
  3449. 'agenda-entry-content)
  3450. (progn (delete-overlay o) t)))
  3451. (overlays-in (point-min) (point-max)))))
  3452. (defun org-agenda-get-day-face (date)
  3453. "Return the face DATE should be displayed with."
  3454. (or (and (functionp org-agenda-day-face-function)
  3455. (funcall org-agenda-day-face-function date))
  3456. (cond ((org-agenda-todayp date)
  3457. 'org-agenda-date-today)
  3458. ((member (calendar-day-of-week date) org-agenda-weekend-days)
  3459. 'org-agenda-date-weekend)
  3460. (t 'org-agenda-date))))
  3461. ;;; Agenda timeline
  3462. (defvar org-agenda-only-exact-dates nil) ; dynamically scoped
  3463. (defun org-timeline (&optional dotodo)
  3464. "Show a time-sorted view of the entries in the current org file.
  3465. Only entries with a time stamp of today or later will be listed. With
  3466. \\[universal-argument] prefix, all unfinished TODO items will also be shown,
  3467. under the current date.
  3468. If the buffer contains an active region, only check the region for
  3469. dates."
  3470. (interactive "P")
  3471. (let* ((dopast t)
  3472. (org-agenda-show-log-scoped org-agenda-show-log)
  3473. (entry (buffer-file-name (or (buffer-base-buffer (current-buffer))
  3474. (current-buffer))))
  3475. (date (calendar-current-date))
  3476. (beg (if (org-region-active-p) (region-beginning) (point-min)))
  3477. (end (if (org-region-active-p) (region-end) (point-max)))
  3478. (day-numbers (org-get-all-dates
  3479. beg end 'no-ranges
  3480. t org-agenda-show-log-scoped ; always include today
  3481. org-timeline-show-empty-dates))
  3482. (org-deadline-warning-days 0)
  3483. (org-agenda-only-exact-dates t)
  3484. (today (org-today))
  3485. (past t)
  3486. args
  3487. s e rtn d emptyp)
  3488. (setq org-agenda-redo-command
  3489. (list 'progn
  3490. (list 'org-switch-to-buffer-other-window (current-buffer))
  3491. (list 'org-timeline (list 'quote dotodo))))
  3492. (if (not dopast)
  3493. ;; Remove past dates from the list of dates.
  3494. (setq day-numbers (delq nil (mapcar (lambda(x)
  3495. (if (>= x today) x nil))
  3496. day-numbers))))
  3497. (org-agenda-prepare (concat "Timeline " (file-name-nondirectory entry)))
  3498. (org-compile-prefix-format 'timeline)
  3499. (org-set-sorting-strategy 'timeline)
  3500. (if org-agenda-show-log-scoped (push :closed args))
  3501. (push :timestamp args)
  3502. (push :deadline args)
  3503. (push :scheduled args)
  3504. (push :sexp args)
  3505. (if dotodo (push :todo args))
  3506. (insert "Timeline of file " entry "\n")
  3507. (add-text-properties (point-min) (point)
  3508. (list 'face 'org-agenda-structure))
  3509. (org-agenda-mark-header-line (point-min))
  3510. (while (setq d (pop day-numbers))
  3511. (if (and (listp d) (eq (car d) :omitted))
  3512. (progn
  3513. (setq s (point))
  3514. (insert (format "\n[... %d empty days omitted]\n\n" (cdr d)))
  3515. (put-text-property s (1- (point)) 'face 'org-agenda-structure))
  3516. (if (listp d) (setq d (car d) emptyp t) (setq emptyp nil))
  3517. (if (and (>= d today)
  3518. dopast
  3519. past)
  3520. (progn
  3521. (setq past nil)
  3522. (insert (make-string 79 ?-) "\n")))
  3523. (setq date (calendar-gregorian-from-absolute d))
  3524. (setq s (point))
  3525. (setq rtn (and (not emptyp)
  3526. (apply 'org-agenda-get-day-entries entry
  3527. date args)))
  3528. (if (or rtn (equal d today) org-timeline-show-empty-dates)
  3529. (progn
  3530. (insert
  3531. (if (stringp org-agenda-format-date)
  3532. (format-time-string org-agenda-format-date
  3533. (org-time-from-absolute date))
  3534. (funcall org-agenda-format-date date))
  3535. "\n")
  3536. (put-text-property s (1- (point)) 'face
  3537. (org-agenda-get-day-face date))
  3538. (put-text-property s (1- (point)) 'org-date-line t)
  3539. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3540. (if (equal d today)
  3541. (put-text-property s (1- (point)) 'org-today t))
  3542. (and rtn (insert (org-agenda-finalize-entries rtn) "\n"))
  3543. (put-text-property s (1- (point)) 'day d)))))
  3544. (goto-char (point-min))
  3545. (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
  3546. (point-min)))
  3547. (add-text-properties (point-min) (point-max) '(org-agenda-type timeline))
  3548. (org-agenda-finalize)
  3549. (setq buffer-read-only t)))
  3550. (defun org-get-all-dates (beg end &optional no-ranges force-today inactive empty pre-re)
  3551. "Return a list of all relevant day numbers from BEG to END buffer positions.
  3552. If NO-RANGES is non-nil, include only the start and end dates of a range,
  3553. not every single day in the range. If FORCE-TODAY is non-nil, make
  3554. sure that TODAY is included in the list. If INACTIVE is non-nil, also
  3555. inactive time stamps (those in square brackets) are included.
  3556. When EMPTY is non-nil, also include days without any entries."
  3557. (let ((re (concat
  3558. (if pre-re pre-re "")
  3559. (if inactive org-ts-regexp-both org-ts-regexp)))
  3560. dates dates1 date day day1 day2 ts1 ts2 pos)
  3561. (if force-today
  3562. (setq dates (list (org-today))))
  3563. (save-excursion
  3564. (goto-char beg)
  3565. (while (re-search-forward re end t)
  3566. (setq day (time-to-days (org-time-string-to-time
  3567. (substring (match-string 1) 0 10)
  3568. (current-buffer) (match-beginning 0))))
  3569. (or (memq day dates) (push day dates)))
  3570. (unless no-ranges
  3571. (goto-char beg)
  3572. (while (re-search-forward org-tr-regexp end t)
  3573. (setq pos (match-beginning 0))
  3574. (setq ts1 (substring (match-string 1) 0 10)
  3575. ts2 (substring (match-string 2) 0 10)
  3576. day1 (time-to-days (org-time-string-to-time
  3577. ts1 (current-buffer) pos))
  3578. day2 (time-to-days (org-time-string-to-time
  3579. ts2 (current-buffer) pos)))
  3580. (while (< (setq day1 (1+ day1)) day2)
  3581. (or (memq day1 dates) (push day1 dates)))))
  3582. (setq dates (sort dates '<))
  3583. (when empty
  3584. (while (setq day (pop dates))
  3585. (setq day2 (car dates))
  3586. (push day dates1)
  3587. (when (and day2 empty)
  3588. (if (or (eq empty t)
  3589. (and (numberp empty) (<= (- day2 day) empty)))
  3590. (while (< (setq day (1+ day)) day2)
  3591. (push (list day) dates1))
  3592. (push (cons :omitted (- day2 day)) dates1))))
  3593. (setq dates (nreverse dates1)))
  3594. dates)))
  3595. ;;; Agenda Daily/Weekly
  3596. (defvar org-agenda-start-day nil ; dynamically scoped parameter
  3597. "Start day for the agenda view.
  3598. Custom commands can set this variable in the options section.")
  3599. (defvar org-starting-day nil) ; local variable in the agenda buffer
  3600. (defvar org-arg-loc nil) ; local variable
  3601. (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
  3602. "List of types searched for when creating the daily/weekly agenda.
  3603. This variable is a list of symbols that controls the types of
  3604. items that appear in the daily/weekly agenda. Allowed symbols in this
  3605. list are are
  3606. :timestamp List items containing a date stamp or date range matching
  3607. the selected date. This includes sexp entries in
  3608. angular brackets.
  3609. :sexp List entries resulting from plain diary-like sexps.
  3610. :deadline List deadline due on that date. When the date is today,
  3611. also list any deadlines past due, or due within
  3612. `org-deadline-warning-days'. `:deadline' must appear before
  3613. `:scheduled' if the setting of
  3614. `org-agenda-skip-scheduled-if-deadline-is-shown' is to have
  3615. any effect.
  3616. :scheduled List all items which are scheduled for the given date.
  3617. The diary for *today* also contains items which were
  3618. scheduled earlier and are not yet marked DONE.
  3619. By default, all four types are turned on.
  3620. Never set this variable globally using `setq', because then it
  3621. will apply to all future agenda commands. Instead, bind it with
  3622. `let' to scope it dynamically into the agenda-constructing
  3623. command. A good way to set it is through options in
  3624. `org-agenda-custom-commands'. For a more flexible (though
  3625. somewhat less efficient) way of determining what is included in
  3626. the daily/weekly agenda, see `org-agenda-skip-function'.")
  3627. (defvar org-agenda-buffer-tmp-name nil)
  3628. ;;;###autoload
  3629. (defun org-agenda-list (&optional arg start-day span)
  3630. "Produce a daily/weekly view from all files in variable `org-agenda-files'.
  3631. The view will be for the current day or week, but from the overview buffer
  3632. you will be able to go to other days/weeks.
  3633. With a numeric prefix argument in an interactive call, the agenda will
  3634. span ARG days. Lisp programs should instead specify SPAN to change
  3635. the number of days. SPAN defaults to `org-agenda-span'.
  3636. START-DAY defaults to TODAY, or to the most recent match for the weekday
  3637. given in `org-agenda-start-on-weekday'."
  3638. (interactive "P")
  3639. (if org-agenda-overriding-arguments
  3640. (setq arg (car org-agenda-overriding-arguments)
  3641. start-day (nth 1 org-agenda-overriding-arguments)
  3642. span (nth 2 org-agenda-overriding-arguments)))
  3643. (if (and (integerp arg) (> arg 0))
  3644. (setq span arg arg nil))
  3645. (catch 'exit
  3646. (setq org-agenda-buffer-name
  3647. (or org-agenda-buffer-tmp-name
  3648. (if org-agenda-sticky
  3649. (cond ((and org-keys (stringp org-match))
  3650. (format "*Org Agenda(%s:%s)*" org-keys org-match))
  3651. (org-keys
  3652. (format "*Org Agenda(%s)*" org-keys))
  3653. (t "*Org Agenda(a)*")))
  3654. org-agenda-buffer-name))
  3655. (org-agenda-prepare "Day/Week")
  3656. (setq start-day (or start-day org-agenda-start-day))
  3657. (if (stringp start-day)
  3658. ;; Convert to an absolute day number
  3659. (setq start-day (time-to-days (org-read-date nil t start-day))))
  3660. (org-compile-prefix-format 'agenda)
  3661. (org-set-sorting-strategy 'agenda)
  3662. (let* ((span (org-agenda-ndays-to-span
  3663. (or span org-agenda-ndays org-agenda-span)))
  3664. (today (org-today))
  3665. (sd (or start-day today))
  3666. (ndays (org-agenda-span-to-ndays span sd))
  3667. (org-agenda-start-on-weekday
  3668. (if (eq ndays 7)
  3669. org-agenda-start-on-weekday))
  3670. (thefiles (org-agenda-files nil 'ifmode))
  3671. (files thefiles)
  3672. (start (if (or (null org-agenda-start-on-weekday)
  3673. (< ndays 7))
  3674. sd
  3675. (let* ((nt (calendar-day-of-week
  3676. (calendar-gregorian-from-absolute sd)))
  3677. (n1 org-agenda-start-on-weekday)
  3678. (d (- nt n1)))
  3679. (- sd (+ (if (< d 0) 7 0) d)))))
  3680. (day-numbers (list start))
  3681. (day-cnt 0)
  3682. (inhibit-redisplay (not debug-on-error))
  3683. (org-agenda-show-log-scoped org-agenda-show-log)
  3684. s e rtn rtnall file date d start-pos end-pos todayp
  3685. clocktable-start clocktable-end filter)
  3686. (setq org-agenda-redo-command
  3687. (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span)))
  3688. (dotimes (n (1- ndays))
  3689. (push (1+ (car day-numbers)) day-numbers))
  3690. (setq day-numbers (nreverse day-numbers))
  3691. (setq clocktable-start (car day-numbers)
  3692. clocktable-end (1+ (or (org-last day-numbers) 0)))
  3693. (org-set-local 'org-starting-day (car day-numbers))
  3694. (org-set-local 'org-arg-loc arg)
  3695. (org-set-local 'org-agenda-current-span (org-agenda-ndays-to-span span))
  3696. (unless org-agenda-compact-blocks
  3697. (let* ((d1 (car day-numbers))
  3698. (d2 (org-last day-numbers))
  3699. (w1 (org-days-to-iso-week d1))
  3700. (w2 (org-days-to-iso-week d2)))
  3701. (setq s (point))
  3702. (if org-agenda-overriding-header
  3703. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  3704. nil 'face 'org-agenda-structure) "\n")
  3705. (insert (org-agenda-span-name span)
  3706. "-agenda"
  3707. (if (< (- d2 d1) 350)
  3708. (if (= w1 w2)
  3709. (format " (W%02d)" w1)
  3710. (format " (W%02d-W%02d)" w1 w2))
  3711. "")
  3712. ":\n")))
  3713. (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
  3714. 'org-date-line t))
  3715. (org-agenda-mark-header-line s))
  3716. (while (setq d (pop day-numbers))
  3717. (setq date (calendar-gregorian-from-absolute d)
  3718. s (point))
  3719. (if (or (setq todayp (= d today))
  3720. (and (not start-pos) (= d sd)))
  3721. (setq start-pos (point))
  3722. (if (and start-pos (not end-pos))
  3723. (setq end-pos (point))))
  3724. (setq files thefiles
  3725. rtnall nil)
  3726. (while (setq file (pop files))
  3727. (catch 'nextfile
  3728. (org-check-agenda-file file)
  3729. (let ((org-agenda-entry-types org-agenda-entry-types))
  3730. (unless org-agenda-include-deadlines
  3731. (setq org-agenda-entry-types
  3732. (delq :deadline org-agenda-entry-types)))
  3733. (cond
  3734. ((memq org-agenda-show-log-scoped '(only clockcheck))
  3735. (setq rtn (org-agenda-get-day-entries
  3736. file date :closed)))
  3737. (org-agenda-show-log-scoped
  3738. (setq rtn (apply 'org-agenda-get-day-entries
  3739. file date
  3740. (append '(:closed) org-agenda-entry-types))))
  3741. (t
  3742. (setq rtn (apply 'org-agenda-get-day-entries
  3743. file date
  3744. org-agenda-entry-types)))))
  3745. (setq rtnall (append rtnall rtn)))) ;; all entries
  3746. (if org-agenda-include-diary
  3747. (let ((org-agenda-search-headline-for-time t))
  3748. (require 'diary-lib)
  3749. (setq rtn (org-get-entries-from-diary date))
  3750. (setq rtnall (append rtnall rtn))))
  3751. (if (or rtnall org-agenda-show-all-dates)
  3752. (progn
  3753. (setq day-cnt (1+ day-cnt))
  3754. (insert
  3755. (if (stringp org-agenda-format-date)
  3756. (format-time-string org-agenda-format-date
  3757. (org-time-from-absolute date))
  3758. (funcall org-agenda-format-date date))
  3759. "\n")
  3760. (put-text-property s (1- (point)) 'face
  3761. (org-agenda-get-day-face date))
  3762. (put-text-property s (1- (point)) 'org-date-line t)
  3763. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3764. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
  3765. (when todayp
  3766. (put-text-property s (1- (point)) 'org-today t))
  3767. (setq rtnall
  3768. (org-agenda-add-time-grid-maybe rtnall ndays todayp))
  3769. (if rtnall (insert ;; all entries
  3770. (org-agenda-finalize-entries rtnall)
  3771. "\n"))
  3772. (put-text-property s (1- (point)) 'day d)
  3773. (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
  3774. (when (and org-agenda-clockreport-mode clocktable-start)
  3775. (let ((org-agenda-files (org-agenda-files nil 'ifmode))
  3776. ;; the above line is to ensure the restricted range!
  3777. (p (copy-sequence org-agenda-clockreport-parameter-plist))
  3778. tbl)
  3779. (setq p (org-plist-delete p :block))
  3780. (setq p (plist-put p :tstart clocktable-start))
  3781. (setq p (plist-put p :tend clocktable-end))
  3782. (setq p (plist-put p :scope 'agenda))
  3783. (when (and (eq org-agenda-clockreport-mode 'with-filter)
  3784. (setq filter (or org-agenda-tag-filter-while-redo
  3785. (get 'org-agenda-tag-filter :preset-filter))))
  3786. (setq p (plist-put p :tags (mapconcat (lambda (x)
  3787. (if (string-match "[<>=]" x)
  3788. ""
  3789. x))
  3790. filter ""))))
  3791. (setq tbl (apply 'org-clock-get-clocktable p))
  3792. (insert tbl)))
  3793. (goto-char (point-min))
  3794. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3795. (unless (and (pos-visible-in-window-p (point-min))
  3796. (pos-visible-in-window-p (point-max)))
  3797. (goto-char (1- (point-max)))
  3798. (recenter -1)
  3799. (if (not (pos-visible-in-window-p (or start-pos 1)))
  3800. (progn
  3801. (goto-char (or start-pos 1))
  3802. (recenter 1))))
  3803. (goto-char (or start-pos 1))
  3804. (add-text-properties (point-min) (point-max)
  3805. `(org-agenda-type agenda
  3806. org-last-args (,arg ,start-day ,span)
  3807. org-redo-cmd ,org-agenda-redo-command
  3808. org-series-cmd ,org-cmd))
  3809. (if (eq org-agenda-show-log-scoped 'clockcheck)
  3810. (org-agenda-show-clocking-issues))
  3811. (org-agenda-finalize)
  3812. (setq buffer-read-only t)
  3813. (message ""))))
  3814. (autoload 'org-agenda-list "org-agenda" "\
  3815. Produce a daily/weekly view from all files in variable `org-agenda-files'.
  3816. The view will be for the current day or week, but from the overview buffer
  3817. you will be able to go to other days/weeks.
  3818. With a numeric prefix argument in an interactive call, the agenda will
  3819. span ARG days. Lisp programs should instead specify SPAN to change
  3820. the number of days. SPAN defaults to `org-agenda-span'.
  3821. START-DAY defaults to TODAY, or to the most recent match for the weekday
  3822. given in `org-agenda-start-on-weekday'.
  3823. \(fn &optional ARG START-DAY SPAN)" t nil)
  3824. (defun org-agenda-ndays-to-span (n)
  3825. "Return a span symbol for a span of N days, or N if none matches."
  3826. (cond ((symbolp n) n)
  3827. ((= n 1) 'day)
  3828. ((= n 7) 'week)
  3829. (t n)))
  3830. (defun org-agenda-span-to-ndays (span &optional start-day)
  3831. "Return ndays from SPAN, possibly starting at START-DAY."
  3832. (cond ((numberp span) span)
  3833. ((eq span 'day) 1)
  3834. ((eq span 'week) 7)
  3835. ((eq span 'month)
  3836. (let ((date (calendar-gregorian-from-absolute start-day)))
  3837. (calendar-last-day-of-month (car date) (caddr date))))
  3838. ((eq span 'year)
  3839. (let ((date (calendar-gregorian-from-absolute start-day)))
  3840. (if (calendar-leap-year-p (caddr date)) 366 365)))))
  3841. (defun org-agenda-span-name (span)
  3842. "Return a SPAN name."
  3843. (if (null span)
  3844. ""
  3845. (if (symbolp span)
  3846. (capitalize (symbol-name span))
  3847. (format "%d days" span))))
  3848. ;;; Agenda word search
  3849. (defvar org-agenda-search-history nil)
  3850. (defvar org-search-syntax-table nil
  3851. "Special syntax table for org-mode search.
  3852. In this table, we have single quotes not as word constituents, to
  3853. that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
  3854. (defvar org-mode-syntax-table) ; From org.el
  3855. (defun org-search-syntax-table ()
  3856. (unless org-search-syntax-table
  3857. (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
  3858. (modify-syntax-entry ?' "." org-search-syntax-table)
  3859. (modify-syntax-entry ?` "." org-search-syntax-table))
  3860. org-search-syntax-table)
  3861. (defvar org-agenda-last-search-view-search-was-boolean nil)
  3862. ;;;###autoload
  3863. (defun org-search-view (&optional todo-only string edit-at)
  3864. "Show all entries that contain a phrase or words or regular expressions.
  3865. With optional prefix argument TODO-ONLY, only consider entries that are
  3866. TODO entries. The argument STRING can be used to pass a default search
  3867. string into this function. If EDIT-AT is non-nil, it means that the
  3868. user should get a chance to edit this string, with cursor at position
  3869. EDIT-AT.
  3870. The search string can be viewed either as a phrase that should be found as
  3871. is, or it can be broken into a number of snippets, each of which must match
  3872. in a Boolean way to select an entry. The default depends on the variable
  3873. `org-agenda-search-view-always-boolean'.
  3874. Even if this is turned off (the default) you can always switch to
  3875. Boolean search dynamically by preceding the first word with \"+\" or \"-\".
  3876. The default is a direct search of the whole phrase, where each space in
  3877. the search string can expand to an arbitrary amount of whitespace,
  3878. including newlines.
  3879. If using a Boolean search, the search string is split on whitespace and
  3880. each snippet is searched separately, with logical AND to select an entry.
  3881. Words prefixed with a minus must *not* occur in the entry. Words without
  3882. a prefix or prefixed with a plus must occur in the entry. Matching is
  3883. case-insensitive. Words are enclosed by word delimiters (i.e. they must
  3884. match whole words, not parts of a word) if
  3885. `org-agenda-search-view-force-full-words' is set (default is nil).
  3886. Boolean search snippets enclosed by curly braces are interpreted as
  3887. regular expressions that must or (when preceded with \"-\") must not
  3888. match in the entry. Snippets enclosed into double quotes will be taken
  3889. as a whole, to include whitespace.
  3890. - If the search string starts with an asterisk, search only in headlines.
  3891. - If (possibly after the leading star) the search string starts with an
  3892. exclamation mark, this also means to look at TODO entries only, an effect
  3893. that can also be achieved with a prefix argument.
  3894. - If (possibly after star and exclamation mark) the search string starts
  3895. with a colon, this will mean that the (non-regexp) snippets of the
  3896. Boolean search must match as full words.
  3897. This command searches the agenda files, and in addition the files listed
  3898. in `org-agenda-text-search-extra-files'."
  3899. (interactive "P")
  3900. (if org-agenda-overriding-arguments
  3901. (setq todo-only (car org-agenda-overriding-arguments)
  3902. string (nth 1 org-agenda-overriding-arguments)
  3903. edit-at (nth 2 org-agenda-overriding-arguments)))
  3904. (let* ((props (list 'face nil
  3905. 'done-face 'org-agenda-done
  3906. 'org-not-done-regexp org-not-done-regexp
  3907. 'org-todo-regexp org-todo-regexp
  3908. 'org-complex-heading-regexp org-complex-heading-regexp
  3909. 'mouse-face 'highlight
  3910. 'help-echo (format "mouse-2 or RET jump to location")))
  3911. (full-words org-agenda-search-view-force-full-words)
  3912. (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
  3913. regexp rtn rtnall files file pos
  3914. marker category category-pos level tags c neg re boolean
  3915. ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
  3916. (unless (and (not edit-at)
  3917. (stringp string)
  3918. (string-match "\\S-" string))
  3919. (setq string (read-string
  3920. (if org-agenda-search-view-always-boolean
  3921. "[+-]Word/{Regexp} ...: "
  3922. "Phrase or [+-]Word/{Regexp} ...: ")
  3923. (cond
  3924. ((integerp edit-at) (cons string edit-at))
  3925. (edit-at string))
  3926. 'org-agenda-search-history)))
  3927. (catch 'exit
  3928. (if org-agenda-sticky
  3929. (setq org-agenda-buffer-name
  3930. (if (stringp string)
  3931. (format "*Org Agenda(%s:%s)*"
  3932. (or org-keys (or (and todo-only "S") "s")) string)
  3933. (format "*Org Agenda(%s)*" (or (and todo-only "S") "s")))))
  3934. (org-agenda-prepare "SEARCH")
  3935. (org-compile-prefix-format 'search)
  3936. (org-set-sorting-strategy 'search)
  3937. (setq org-agenda-redo-command
  3938. (list 'org-search-view (if todo-only t nil)
  3939. (list 'if 'current-prefix-arg nil string)))
  3940. (setq org-agenda-query-string string)
  3941. (if (equal (string-to-char string) ?*)
  3942. (setq hdl-only t
  3943. words (substring string 1))
  3944. (setq words string))
  3945. (when (equal (string-to-char words) ?!)
  3946. (setq todo-only t
  3947. words (substring words 1)))
  3948. (when (equal (string-to-char words) ?:)
  3949. (setq full-words t
  3950. words (substring words 1)))
  3951. (if (or org-agenda-search-view-always-boolean
  3952. (member (string-to-char words) '(?- ?+ ?\{)))
  3953. (setq boolean t))
  3954. (setq words (org-split-string words))
  3955. (let (www w)
  3956. (while (setq w (pop words))
  3957. (while (and (string-match "\\\\\\'" w) words)
  3958. (setq w (concat (substring w 0 -1) " " (pop words))))
  3959. (push w www))
  3960. (setq words (nreverse www) www nil)
  3961. (while (setq w (pop words))
  3962. (when (and (string-match "\\`[-+]?{" w)
  3963. (not (string-match "}\\'" w)))
  3964. (while (and words (not (string-match "}\\'" (car words))))
  3965. (setq w (concat w " " (pop words))))
  3966. (setq w (concat w " " (pop words))))
  3967. (push w www))
  3968. (setq words (nreverse www)))
  3969. (setq org-agenda-last-search-view-search-was-boolean boolean)
  3970. (when boolean
  3971. (let (wds w)
  3972. (while (setq w (pop words))
  3973. (if (or (equal (substring w 0 1) "\"")
  3974. (and (> (length w) 1)
  3975. (member (substring w 0 1) '("+" "-"))
  3976. (equal (substring w 1 2) "\"")))
  3977. (while (and words (not (equal (substring w -1) "\"")))
  3978. (setq w (concat w " " (pop words)))))
  3979. (and (string-match "\\`\\([-+]?\\)\"" w)
  3980. (setq w (replace-match "\\1" nil nil w)))
  3981. (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
  3982. (push w wds))
  3983. (setq words (nreverse wds))))
  3984. (if boolean
  3985. (mapc (lambda (w)
  3986. (setq c (string-to-char w))
  3987. (if (equal c ?-)
  3988. (setq neg t w (substring w 1))
  3989. (if (equal c ?+)
  3990. (setq neg nil w (substring w 1))
  3991. (setq neg nil)))
  3992. (if (string-match "\\`{.*}\\'" w)
  3993. (setq re (substring w 1 -1))
  3994. (if full-words
  3995. (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
  3996. (setq re (regexp-quote (downcase w)))))
  3997. (if neg (push re regexps-) (push re regexps+)))
  3998. words)
  3999. (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
  4000. regexps+))
  4001. (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
  4002. (if (not regexps+)
  4003. (setq regexp org-outline-regexp-bol)
  4004. (setq regexp (pop regexps+))
  4005. (if hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
  4006. regexp))))
  4007. (setq files (org-agenda-files nil 'ifmode))
  4008. (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
  4009. (pop org-agenda-text-search-extra-files)
  4010. (setq files (org-add-archive-files files)))
  4011. (setq files (append files org-agenda-text-search-extra-files)
  4012. rtnall nil)
  4013. (while (setq file (pop files))
  4014. (setq ee nil)
  4015. (catch 'nextfile
  4016. (org-check-agenda-file file)
  4017. (setq buffer (if (file-exists-p file)
  4018. (org-get-agenda-file-buffer file)
  4019. (error "No such file %s" file)))
  4020. (if (not buffer)
  4021. ;; If file does not exist, make sure an error message is sent
  4022. (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
  4023. file))))
  4024. (with-current-buffer buffer
  4025. (with-syntax-table (org-search-syntax-table)
  4026. (unless (derived-mode-p 'org-mode)
  4027. (error "Agenda file %s is not in `org-mode'" file))
  4028. (let ((case-fold-search t))
  4029. (save-excursion
  4030. (save-restriction
  4031. (if org-agenda-restrict
  4032. (narrow-to-region org-agenda-restrict-begin
  4033. org-agenda-restrict-end)
  4034. (widen))
  4035. (goto-char (point-min))
  4036. (unless (or (org-at-heading-p)
  4037. (outline-next-heading))
  4038. (throw 'nextfile t))
  4039. (goto-char (max (point-min) (1- (point))))
  4040. (while (re-search-forward regexp nil t)
  4041. (org-back-to-heading t)
  4042. (while (and org-agenda-search-view-max-outline-level
  4043. (> (org-reduced-level (org-outline-level))
  4044. org-agenda-search-view-max-outline-level)
  4045. (forward-line -1)
  4046. (outline-back-to-heading t)))
  4047. (skip-chars-forward "* ")
  4048. (setq beg (point-at-bol)
  4049. beg1 (point)
  4050. end (progn
  4051. (outline-next-heading)
  4052. (while (and org-agenda-search-view-max-outline-level
  4053. (> (org-reduced-level (org-outline-level))
  4054. org-agenda-search-view-max-outline-level)
  4055. (forward-line 1)
  4056. (outline-next-heading)))
  4057. (point)))
  4058. (catch :skip
  4059. (goto-char beg)
  4060. (org-agenda-skip)
  4061. (setq str (buffer-substring-no-properties
  4062. (point-at-bol)
  4063. (if hdl-only (point-at-eol) end)))
  4064. (mapc (lambda (wr) (when (string-match wr str)
  4065. (goto-char (1- end))
  4066. (throw :skip t)))
  4067. regexps-)
  4068. (mapc (lambda (wr) (unless (string-match wr str)
  4069. (goto-char (1- end))
  4070. (throw :skip t)))
  4071. (if todo-only
  4072. (cons (concat "^\*+[ \t]+" org-not-done-regexp)
  4073. regexps+)
  4074. regexps+))
  4075. (goto-char beg)
  4076. (setq marker (org-agenda-new-marker (point))
  4077. category (org-get-category)
  4078. level (make-string (org-reduced-level (org-outline-level)) ? )
  4079. category-pos (get-text-property (point) 'org-category-position)
  4080. tags (org-get-tags-at (point))
  4081. txt (org-agenda-format-item
  4082. ""
  4083. (buffer-substring-no-properties
  4084. beg1 (point-at-eol))
  4085. level category tags t))
  4086. (org-add-props txt props
  4087. 'org-marker marker 'org-hd-marker marker
  4088. 'org-todo-regexp org-todo-regexp
  4089. 'level level
  4090. 'org-complex-heading-regexp org-complex-heading-regexp
  4091. 'priority 1000 'org-category category
  4092. 'org-category-position category-pos
  4093. 'type "search")
  4094. (push txt ee)
  4095. (goto-char (1- end))))))))))
  4096. (setq rtn (nreverse ee))
  4097. (setq rtnall (append rtnall rtn)))
  4098. (if org-agenda-overriding-header
  4099. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4100. nil 'face 'org-agenda-structure) "\n")
  4101. (insert "Search words: ")
  4102. (add-text-properties (point-min) (1- (point))
  4103. (list 'face 'org-agenda-structure))
  4104. (setq pos (point))
  4105. (insert string "\n")
  4106. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4107. (setq pos (point))
  4108. (unless org-agenda-multi
  4109. (insert "Press `[', `]' to add/sub word, `{', `}' to add/sub regexp, `C-u r' to edit\n")
  4110. (add-text-properties pos (1- (point))
  4111. (list 'face 'org-agenda-structure))))
  4112. (org-agenda-mark-header-line (point-min))
  4113. (when rtnall
  4114. (insert (org-agenda-finalize-entries rtnall) "\n"))
  4115. (goto-char (point-min))
  4116. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4117. (add-text-properties (point-min) (point-max)
  4118. `(org-agenda-type search
  4119. org-last-args (,todo-only ,string ,edit-at)
  4120. org-redo-cmd ,org-agenda-redo-command
  4121. org-series-cmd ,org-cmd))
  4122. (org-agenda-finalize)
  4123. (setq buffer-read-only t))))
  4124. (autoload 'org-search-view "org-agenda" "\
  4125. Show all entries that contain a phrase or words or regular expressions.
  4126. With optional prefix argument TODO-ONLY, only consider entries that are
  4127. TODO entries. The argument STRING can be used to pass a default search
  4128. string into this function. If EDIT-AT is non-nil, it means that the
  4129. user should get a chance to edit this string, with cursor at position
  4130. EDIT-AT.
  4131. The search string can be viewed either as a phrase that should be found as
  4132. is, or it can be broken into a number of snippets, each of which must match
  4133. in a Boolean way to select an entry. The default depends on the variable
  4134. `org-agenda-search-view-always-boolean'.
  4135. Even if this is turned off (the default) you can always switch to
  4136. Boolean search dynamically by preceding the first word with \"+\" or \"-\".
  4137. The default is a direct search of the whole phrase, where each space in
  4138. the search string can expand to an arbitrary amount of whitespace,
  4139. including newlines.
  4140. If using a Boolean search, the search string is split on whitespace and
  4141. each snippet is searched separately, with logical AND to select an entry.
  4142. Words prefixed with a minus must *not* occur in the entry. Words without
  4143. a prefix or prefixed with a plus must occur in the entry. Matching is
  4144. case-insensitive. Words are enclosed by word delimiters (i.e. they must
  4145. match whole words, not parts of a word) if
  4146. `org-agenda-search-view-force-full-words' is set (default is nil).
  4147. Boolean search snippets enclosed by curly braces are interpreted as
  4148. regular expressions that must or (when preceded with \"-\") must not
  4149. match in the entry. Snippets enclosed into double quotes will be taken
  4150. as a whole, to include whitespace.
  4151. - If the search string starts with an asterisk, search only in headlines.
  4152. - If (possibly after the leading star) the search string starts with an
  4153. exclamation mark, this also means to look at TODO entries only, an effect
  4154. that can also be achieved with a prefix argument.
  4155. - If (possibly after star and exclamation mark) the search string starts
  4156. with a colon, this will mean that the (non-regexp) snippets of the
  4157. Boolean search must match as full words.
  4158. This command searches the agenda files, and in addition the files listed
  4159. in `org-agenda-text-search-extra-files'.
  4160. \(fn &optional TODO-ONLY STRING EDIT-AT)" t nil)
  4161. ;;; Agenda TODO list
  4162. (defun org-agenda-propertize-selected-todo-keywords (keywords)
  4163. "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
  4164. (concat
  4165. (if (or (equal keywords "ALL") (not keywords))
  4166. (propertize "ALL" 'face 'warning)
  4167. (mapconcat
  4168. (lambda (kw)
  4169. (propertize kw 'face (org-get-todo-face kw)))
  4170. (org-split-string keywords "|")
  4171. "|"))
  4172. "\n"))
  4173. (defvar org-select-this-todo-keyword nil)
  4174. (defvar org-last-arg nil)
  4175. ;;;###autoload
  4176. (defun org-todo-list (&optional arg)
  4177. "Show all (not done) TODO entries from all agenda file in a single list.
  4178. The prefix arg can be used to select a specific TODO keyword and limit
  4179. the list to these. When using \\[universal-argument], you will be prompted
  4180. for a keyword. A numeric prefix directly selects the Nth keyword in
  4181. `org-todo-keywords-1'."
  4182. (interactive "P")
  4183. (if org-agenda-overriding-arguments
  4184. (setq arg org-agenda-overriding-arguments))
  4185. (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
  4186. (let* ((today (org-today))
  4187. (date (calendar-gregorian-from-absolute today))
  4188. (kwds org-todo-keywords-for-agenda)
  4189. (completion-ignore-case t)
  4190. (org-select-this-todo-keyword
  4191. (if (stringp arg) arg
  4192. (and arg (integerp arg) (> arg 0)
  4193. (nth (1- arg) kwds))))
  4194. rtn rtnall files file pos)
  4195. (when (equal arg '(4))
  4196. (setq org-select-this-todo-keyword
  4197. (org-icompleting-read "Keyword (or KWD1|K2D2|...): "
  4198. (mapcar 'list kwds) nil nil)))
  4199. (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
  4200. (catch 'exit
  4201. (if org-agenda-sticky
  4202. (setq org-agenda-buffer-name
  4203. (if (stringp org-select-this-todo-keyword)
  4204. (format "*Org Agenda(%s:%s)*" (or org-keys "t")
  4205. org-select-this-todo-keyword)
  4206. (format "*Org Agenda(%s)*" (or org-keys "t")))))
  4207. (org-agenda-prepare "TODO")
  4208. (org-compile-prefix-format 'todo)
  4209. (org-set-sorting-strategy 'todo)
  4210. (setq org-agenda-redo-command
  4211. `(org-todo-list (or (and (numberp current-prefix-arg)
  4212. current-prefix-arg)
  4213. ,org-select-this-todo-keyword
  4214. current-prefix-arg ,arg)))
  4215. (setq files (org-agenda-files nil 'ifmode)
  4216. rtnall nil)
  4217. (while (setq file (pop files))
  4218. (catch 'nextfile
  4219. (org-check-agenda-file file)
  4220. (setq rtn (org-agenda-get-day-entries file date :todo))
  4221. (setq rtnall (append rtnall rtn))))
  4222. (if org-agenda-overriding-header
  4223. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4224. nil 'face 'org-agenda-structure) "\n")
  4225. (insert "Global list of TODO items of type: ")
  4226. (add-text-properties (point-min) (1- (point))
  4227. (list 'face 'org-agenda-structure
  4228. 'short-heading
  4229. (concat "ToDo: "
  4230. (or org-select-this-todo-keyword "ALL"))))
  4231. (org-agenda-mark-header-line (point-min))
  4232. (insert (org-agenda-propertize-selected-todo-keywords
  4233. org-select-this-todo-keyword))
  4234. (setq pos (point))
  4235. (unless org-agenda-multi
  4236. (insert "Available with `N r': (0)[ALL]")
  4237. (let ((n 0) s)
  4238. (mapc (lambda (x)
  4239. (setq s (format "(%d)%s" (setq n (1+ n)) x))
  4240. (if (> (+ (current-column) (string-width s) 1) (frame-width))
  4241. (insert "\n "))
  4242. (insert " " s))
  4243. kwds))
  4244. (insert "\n"))
  4245. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
  4246. (org-agenda-mark-header-line (point-min))
  4247. (when rtnall
  4248. (insert (org-agenda-finalize-entries rtnall) "\n"))
  4249. (goto-char (point-min))
  4250. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4251. (add-text-properties (point-min) (point-max)
  4252. `(org-agenda-type todo
  4253. org-last-args ,arg
  4254. org-redo-cmd ,org-agenda-redo-command
  4255. org-series-cmd ,org-cmd))
  4256. (org-agenda-finalize)
  4257. (setq buffer-read-only t))))
  4258. (autoload 'org-todo-list "org-agenda" "\
  4259. Show all (not done) TODO entries from all agenda file in a single list.
  4260. The prefix arg can be used to select a specific TODO keyword and limit
  4261. the list to these. When using \\[universal-argument], you will be prompted
  4262. for a keyword. A numeric prefix directly selects the Nth keyword in
  4263. `org-todo-keywords-1'.
  4264. \(fn &optional ARG)" t nil)
  4265. ;;; Agenda tags match
  4266. ;;;###autoload
  4267. (defun org-tags-view (&optional todo-only match)
  4268. "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
  4269. The prefix arg TODO-ONLY limits the search to TODO entries."
  4270. (interactive "P")
  4271. (if org-agenda-overriding-arguments
  4272. (setq todo-only (car org-agenda-overriding-arguments)
  4273. match (nth 1 org-agenda-overriding-arguments)))
  4274. (let* ((org-tags-match-list-sublevels
  4275. org-tags-match-list-sublevels)
  4276. (completion-ignore-case t)
  4277. rtn rtnall files file pos matcher
  4278. buffer)
  4279. (when (and (stringp match) (not (string-match "\\S-" match)))
  4280. (setq match nil))
  4281. (setq matcher (org-make-tags-matcher match)
  4282. match (car matcher) matcher (cdr matcher))
  4283. (catch 'exit
  4284. (if org-agenda-sticky
  4285. (setq org-agenda-buffer-name
  4286. (if (stringp match)
  4287. (format "*Org Agenda(%s:%s)*"
  4288. (or org-keys (or (and todo-only "M") "m")) match)
  4289. (format "*Org Agenda(%s)*" (or (and todo-only "M") "m")))))
  4290. (org-agenda-prepare (concat "TAGS " match))
  4291. (org-compile-prefix-format 'tags)
  4292. (org-set-sorting-strategy 'tags)
  4293. (setq org-agenda-query-string match)
  4294. (setq org-agenda-redo-command
  4295. (list 'org-tags-view `(quote ,todo-only)
  4296. (list 'if 'current-prefix-arg nil `(quote ,org-agenda-query-string))))
  4297. (setq files (org-agenda-files nil 'ifmode)
  4298. rtnall nil)
  4299. (while (setq file (pop files))
  4300. (catch 'nextfile
  4301. (org-check-agenda-file file)
  4302. (setq buffer (if (file-exists-p file)
  4303. (org-get-agenda-file-buffer file)
  4304. (error "No such file %s" file)))
  4305. (if (not buffer)
  4306. ;; If file does not exist, error message to agenda
  4307. (setq rtn (list
  4308. (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4309. rtnall (append rtnall rtn))
  4310. (with-current-buffer buffer
  4311. (unless (derived-mode-p 'org-mode)
  4312. (error "Agenda file %s is not in `org-mode'" file))
  4313. (save-excursion
  4314. (save-restriction
  4315. (if org-agenda-restrict
  4316. (narrow-to-region org-agenda-restrict-begin
  4317. org-agenda-restrict-end)
  4318. (widen))
  4319. (setq rtn (org-scan-tags 'agenda matcher todo-only))
  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 "Headlines with TAGS match: ")
  4325. (add-text-properties (point-min) (1- (point))
  4326. (list 'face 'org-agenda-structure
  4327. 'short-heading
  4328. (concat "Match: " match)))
  4329. (setq pos (point))
  4330. (insert match "\n")
  4331. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4332. (setq pos (point))
  4333. (unless org-agenda-multi
  4334. (insert "Press `C-u r' to search again with new search string\n"))
  4335. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
  4336. (org-agenda-mark-header-line (point-min))
  4337. (when rtnall
  4338. (insert (org-agenda-finalize-entries rtnall) "\n"))
  4339. (goto-char (point-min))
  4340. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4341. (add-text-properties (point-min) (point-max)
  4342. `(org-agenda-type tags
  4343. org-last-args (,todo-only ,match)
  4344. org-redo-cmd ,org-agenda-redo-command
  4345. org-series-cmd ,org-cmd))
  4346. (org-agenda-finalize)
  4347. (setq buffer-read-only t))))
  4348. (autoload 'org-tags-view "org-agenda" "\
  4349. Show all headlines for all `org-agenda-files' matching a TAGS criterion.
  4350. The prefix arg TODO-ONLY limits the search to TODO entries.
  4351. \(fn &optional TODO-ONLY MATCH)" t nil)
  4352. ;;; Agenda Finding stuck projects
  4353. (defvar org-agenda-skip-regexp nil
  4354. "Regular expression used in skipping subtrees for the agenda.
  4355. This is basically a temporary global variable that can be set and then
  4356. used by user-defined selections using `org-agenda-skip-function'.")
  4357. (defvar org-agenda-overriding-header nil
  4358. "When set during agenda, todo and tags searches it replaces the header.
  4359. This variable should not be set directly, but custom commands can bind it
  4360. in the options section.")
  4361. (defun org-agenda-skip-entry-when-regexp-matches ()
  4362. "Check if the current entry contains match for `org-agenda-skip-regexp'.
  4363. If yes, it returns the end position of this entry, causing agenda commands
  4364. to skip the entry but continuing the search in the subtree. This is a
  4365. function that can be put into `org-agenda-skip-function' for the duration
  4366. of a command."
  4367. (let ((end (save-excursion (org-end-of-subtree t)))
  4368. skip)
  4369. (save-excursion
  4370. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  4371. (and skip end)))
  4372. (defun org-agenda-skip-subtree-when-regexp-matches ()
  4373. "Check if the current subtree contains match for `org-agenda-skip-regexp'.
  4374. If yes, it returns the end position of this tree, causing agenda commands
  4375. to skip this subtree. This is a function that can be put into
  4376. `org-agenda-skip-function' for the duration of a command."
  4377. (let ((end (save-excursion (org-end-of-subtree t)))
  4378. skip)
  4379. (save-excursion
  4380. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  4381. (and skip end)))
  4382. (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
  4383. "Check if the current subtree contains match for `org-agenda-skip-regexp'.
  4384. If yes, it returns the end position of the current entry (NOT the tree),
  4385. causing agenda commands to skip the entry but continuing the search in
  4386. the subtree. This is a function that can be put into
  4387. `org-agenda-skip-function' for the duration of a command. An important
  4388. use of this function is for the stuck project list."
  4389. (let ((end (save-excursion (org-end-of-subtree t)))
  4390. (entry-end (save-excursion (outline-next-heading) (1- (point))))
  4391. skip)
  4392. (save-excursion
  4393. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  4394. (and skip entry-end)))
  4395. (defun org-agenda-skip-entry-if (&rest conditions)
  4396. "Skip entry if any of CONDITIONS is true.
  4397. See `org-agenda-skip-if' for details."
  4398. (org-agenda-skip-if nil conditions))
  4399. (defun org-agenda-skip-subtree-if (&rest conditions)
  4400. "Skip entry if any of CONDITIONS is true.
  4401. See `org-agenda-skip-if' for details."
  4402. (org-agenda-skip-if t conditions))
  4403. (defun org-agenda-skip-if (subtree conditions)
  4404. "Checks current entity for CONDITIONS.
  4405. If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
  4406. the entry (i.e. the text before the next heading) is checked.
  4407. CONDITIONS is a list of symbols, boolean OR is used to combine the results
  4408. from different tests. Valid conditions are:
  4409. scheduled Check if there is a scheduled cookie
  4410. notscheduled Check if there is no scheduled cookie
  4411. deadline Check if there is a deadline
  4412. notdeadline Check if there is no deadline
  4413. timestamp Check if there is a timestamp (also deadline or scheduled)
  4414. nottimestamp Check if there is no timestamp (also deadline or scheduled)
  4415. regexp Check if regexp matches
  4416. notregexp Check if regexp does not match.
  4417. todo Check if TODO keyword matches
  4418. nottodo Check if TODO keyword does not match
  4419. The regexp is taken from the conditions list, it must come right after
  4420. the `regexp' or `notregexp' element.
  4421. `todo' and `nottodo' accept as an argument a list of todo
  4422. keywords, which may include \"*\" to match any todo keyword.
  4423. (org-agenda-skip-entry-if 'todo '(\"TODO\" \"WAITING\"))
  4424. would skip all entries with \"TODO\" or \"WAITING\" keywords.
  4425. Instead of a list, a keyword class may be given. For example:
  4426. (org-agenda-skip-entry-if 'nottodo 'done)
  4427. would skip entries that haven't been marked with any of \"DONE\"
  4428. keywords. Possible classes are: `todo', `done', `any'.
  4429. If any of these conditions is met, this function returns the end point of
  4430. the entity, causing the search to continue from there. This is a function
  4431. that can be put into `org-agenda-skip-function' for the duration of a command."
  4432. (let (beg end m)
  4433. (org-back-to-heading t)
  4434. (setq beg (point)
  4435. end (if subtree
  4436. (progn (org-end-of-subtree t) (point))
  4437. (progn (outline-next-heading) (1- (point)))))
  4438. (goto-char beg)
  4439. (and
  4440. (or
  4441. (and (memq 'scheduled conditions)
  4442. (re-search-forward org-scheduled-time-regexp end t))
  4443. (and (memq 'notscheduled conditions)
  4444. (not (re-search-forward org-scheduled-time-regexp end t)))
  4445. (and (memq 'deadline conditions)
  4446. (re-search-forward org-deadline-time-regexp end t))
  4447. (and (memq 'notdeadline conditions)
  4448. (not (re-search-forward org-deadline-time-regexp end t)))
  4449. (and (memq 'timestamp conditions)
  4450. (re-search-forward org-ts-regexp end t))
  4451. (and (memq 'nottimestamp conditions)
  4452. (not (re-search-forward org-ts-regexp end t)))
  4453. (and (setq m (memq 'regexp conditions))
  4454. (stringp (nth 1 m))
  4455. (re-search-forward (nth 1 m) end t))
  4456. (and (setq m (memq 'notregexp conditions))
  4457. (stringp (nth 1 m))
  4458. (not (re-search-forward (nth 1 m) end t)))
  4459. (and (or
  4460. (setq m (memq 'nottodo conditions))
  4461. (setq m (memq 'todo-unblocked conditions))
  4462. (setq m (memq 'nottodo-unblocked conditions))
  4463. (setq m (memq 'todo conditions)))
  4464. (org-agenda-skip-if-todo m end)))
  4465. end)))
  4466. (defun org-agenda-skip-if-todo (args end)
  4467. "Helper function for `org-agenda-skip-if', do not use it directly.
  4468. ARGS is a list with first element either `todo', `nottodo',
  4469. `todo-unblocked' or `nottodo-unblocked'. The remainder is either
  4470. a list of TODO keywords, or a state symbol `todo' or `done' or
  4471. `any'."
  4472. (let ((kw (car args))
  4473. (arg (cadr args))
  4474. todo-wds todo-re)
  4475. (setq todo-wds
  4476. (org-uniquify
  4477. (cond
  4478. ((listp arg) ;; list of keywords
  4479. (if (member "*" arg)
  4480. (mapcar 'substring-no-properties org-todo-keywords-1)
  4481. arg))
  4482. ((symbolp arg) ;; keyword class name
  4483. (cond
  4484. ((eq arg 'todo)
  4485. (org-delete-all org-done-keywords
  4486. (mapcar 'substring-no-properties
  4487. org-todo-keywords-1)))
  4488. ((eq arg 'done) org-done-keywords)
  4489. ((eq arg 'any)
  4490. (mapcar 'substring-no-properties org-todo-keywords-1)))))))
  4491. (setq todo-re
  4492. (concat "^\\*+[ \t]+\\<\\("
  4493. (mapconcat 'identity todo-wds "\\|")
  4494. "\\)\\>"))
  4495. (cond
  4496. ((eq kw 'todo) (re-search-forward todo-re end t))
  4497. ((eq kw 'nottodo) (not (re-search-forward todo-re end t)))
  4498. ((eq kw 'todo-unblocked)
  4499. (catch 'unblocked
  4500. (while (re-search-forward todo-re end t)
  4501. (or (org-entry-blocked-p) (throw 'unblocked t)))
  4502. nil))
  4503. ((eq kw 'nottodo-unblocked)
  4504. (catch 'unblocked
  4505. (while (re-search-forward todo-re end t)
  4506. (or (org-entry-blocked-p) (throw 'unblocked nil)))
  4507. t))
  4508. )))
  4509. ;;;###autoload
  4510. (defun org-agenda-list-stuck-projects (&rest ignore)
  4511. "Create agenda view for projects that are stuck.
  4512. Stuck projects are project that have no next actions. For the definitions
  4513. of what a project is and how to check if it stuck, customize the variable
  4514. `org-stuck-projects'."
  4515. (interactive)
  4516. (let* ((org-agenda-skip-function
  4517. 'org-agenda-skip-entry-when-regexp-matches-in-subtree)
  4518. ;; We could have used org-agenda-skip-if here.
  4519. (org-agenda-overriding-header
  4520. (or org-agenda-overriding-header "List of stuck projects: "))
  4521. (matcher (nth 0 org-stuck-projects))
  4522. (todo (nth 1 org-stuck-projects))
  4523. (todo-wds (if (member "*" todo)
  4524. (progn
  4525. (org-agenda-prepare-buffers (org-agenda-files
  4526. nil 'ifmode))
  4527. (org-delete-all
  4528. org-done-keywords-for-agenda
  4529. (copy-sequence org-todo-keywords-for-agenda)))
  4530. todo))
  4531. (todo-re (concat "^\\*+[ \t]+\\("
  4532. (mapconcat 'identity todo-wds "\\|")
  4533. "\\)\\>"))
  4534. (tags (nth 2 org-stuck-projects))
  4535. (tags-re (if (member "*" tags)
  4536. (concat org-outline-regexp-bol
  4537. (org-re ".*:[[:alnum:]_@#%]+:[ \t]*$"))
  4538. (if tags
  4539. (concat org-outline-regexp-bol
  4540. ".*:\\("
  4541. (mapconcat 'identity tags "\\|")
  4542. (org-re "\\):[[:alnum:]_@#%:]*[ \t]*$")))))
  4543. (gen-re (nth 3 org-stuck-projects))
  4544. (re-list
  4545. (delq nil
  4546. (list
  4547. (if todo todo-re)
  4548. (if tags tags-re)
  4549. (and gen-re (stringp gen-re) (string-match "\\S-" gen-re)
  4550. gen-re)))))
  4551. (setq org-agenda-skip-regexp
  4552. (if re-list
  4553. (mapconcat 'identity re-list "\\|")
  4554. (error "No information how to identify unstuck projects")))
  4555. (org-tags-view nil matcher)
  4556. (with-current-buffer org-agenda-buffer-name
  4557. (setq org-agenda-redo-command
  4558. `(org-agenda-list-stuck-projects ,current-prefix-arg)))))
  4559. (autoload 'org-agenda-list-stuck-projects "org-agenda" "\
  4560. Create agenda view for projects that are stuck.
  4561. Stuck projects are project that have no next actions. For the definitions
  4562. of what a project is and how to check if it stuck, customize the variable
  4563. `org-stuck-projects'.
  4564. \(fn &rest IGNORE)" t nil)
  4565. ;;; Diary integration
  4566. (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
  4567. (defvar diary-list-entries-hook)
  4568. (defvar diary-time-regexp)
  4569. (defun org-get-entries-from-diary (date)
  4570. "Get the (Emacs Calendar) diary entries for DATE."
  4571. (require 'diary-lib)
  4572. (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
  4573. (diary-display-hook '(fancy-diary-display))
  4574. (diary-display-function 'fancy-diary-display)
  4575. (pop-up-frames nil)
  4576. (diary-list-entries-hook
  4577. (cons 'org-diary-default-entry diary-list-entries-hook))
  4578. (diary-file-name-prefix-function nil) ; turn this feature off
  4579. (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
  4580. entries
  4581. (org-disable-agenda-to-diary t))
  4582. (save-excursion
  4583. (save-window-excursion
  4584. (funcall (if (fboundp 'diary-list-entries)
  4585. 'diary-list-entries 'list-diary-entries)
  4586. date 1)))
  4587. (if (not (get-buffer diary-fancy-buffer))
  4588. (setq entries nil)
  4589. (with-current-buffer diary-fancy-buffer
  4590. (setq buffer-read-only nil)
  4591. (if (zerop (buffer-size))
  4592. ;; No entries
  4593. (setq entries nil)
  4594. ;; Omit the date and other unnecessary stuff
  4595. (org-agenda-cleanup-fancy-diary)
  4596. ;; Add prefix to each line and extend the text properties
  4597. (if (zerop (buffer-size))
  4598. (setq entries nil)
  4599. (setq entries (buffer-substring (point-min) (- (point-max) 1)))
  4600. (setq entries
  4601. (with-temp-buffer
  4602. (insert entries) (goto-char (point-min))
  4603. (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
  4604. (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
  4605. (replace-match (concat "; " (match-string 1)))))
  4606. (buffer-string)))))
  4607. (set-buffer-modified-p nil)
  4608. (kill-buffer diary-fancy-buffer)))
  4609. (when entries
  4610. (setq entries (org-split-string entries "\n"))
  4611. (setq entries
  4612. (mapcar
  4613. (lambda (x)
  4614. (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
  4615. ;; Extend the text properties to the beginning of the line
  4616. (org-add-props x (text-properties-at (1- (length x)) x)
  4617. 'type "diary" 'date date 'face 'org-agenda-diary))
  4618. entries)))))
  4619. (defvar org-agenda-cleanup-fancy-diary-hook nil
  4620. "Hook run when the fancy diary buffer is cleaned up.")
  4621. (defun org-agenda-cleanup-fancy-diary ()
  4622. "Remove unwanted stuff in buffer created by `fancy-diary-display'.
  4623. This gets rid of the date, the underline under the date, and
  4624. the dummy entry installed by `org-mode' to ensure non-empty diary for each
  4625. date. It also removes lines that contain only whitespace."
  4626. (goto-char (point-min))
  4627. (if (looking-at ".*?:[ \t]*")
  4628. (progn
  4629. (replace-match "")
  4630. (re-search-forward "\n=+$" nil t)
  4631. (replace-match "")
  4632. (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
  4633. (re-search-forward "\n=+$" nil t)
  4634. (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
  4635. (goto-char (point-min))
  4636. (while (re-search-forward "^ +\n" nil t)
  4637. (replace-match ""))
  4638. (goto-char (point-min))
  4639. (if (re-search-forward "^Org-mode dummy\n?" nil t)
  4640. (replace-match ""))
  4641. (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
  4642. ;; Make sure entries from the diary have the right text properties.
  4643. (eval-after-load "diary-lib"
  4644. '(if (boundp 'diary-modify-entry-list-string-function)
  4645. ;; We can rely on the hook, nothing to do
  4646. nil
  4647. ;; Hook not available, must use advice to make this work
  4648. (defadvice add-to-diary-list (before org-mark-diary-entry activate)
  4649. "Make the position visible."
  4650. (if (and org-disable-agenda-to-diary ;; called from org-agenda
  4651. (stringp string)
  4652. buffer-file-name)
  4653. (setq string (org-modify-diary-entry-string string))))))
  4654. (defun org-modify-diary-entry-string (string)
  4655. "Add text properties to string, allowing org-mode to act on it."
  4656. (org-add-props string nil
  4657. 'mouse-face 'highlight
  4658. 'help-echo (if buffer-file-name
  4659. (format "mouse-2 or RET jump to diary file %s"
  4660. (abbreviate-file-name buffer-file-name))
  4661. "")
  4662. 'org-agenda-diary-link t
  4663. 'org-marker (org-agenda-new-marker (point-at-bol))))
  4664. (defun org-diary-default-entry ()
  4665. "Add a dummy entry to the diary.
  4666. Needed to avoid empty dates which mess up holiday display."
  4667. ;; Catch the error if dealing with the new add-to-diary-alist
  4668. (when org-disable-agenda-to-diary
  4669. (condition-case nil
  4670. (org-add-to-diary-list original-date "Org-mode dummy" "")
  4671. (error
  4672. (org-add-to-diary-list original-date "Org-mode dummy" "" nil)))))
  4673. (defun org-add-to-diary-list (&rest args)
  4674. (if (fboundp 'diary-add-to-list)
  4675. (apply 'diary-add-to-list args)
  4676. (apply 'add-to-diary-list args)))
  4677. (defvar org-diary-last-run-time nil)
  4678. ;;;###autoload
  4679. (defun org-diary (&rest args)
  4680. "Return diary information from org files.
  4681. This function can be used in a \"sexp\" diary entry in the Emacs calendar.
  4682. It accesses org files and extracts information from those files to be
  4683. listed in the diary. The function accepts arguments specifying what
  4684. items should be listed. For a list of arguments allowed here, see the
  4685. variable `org-agenda-entry-types'.
  4686. The call in the diary file should look like this:
  4687. &%%(org-diary) ~/path/to/some/orgfile.org
  4688. Use a separate line for each org file to check. Or, if you omit the file name,
  4689. all files listed in `org-agenda-files' will be checked automatically:
  4690. &%%(org-diary)
  4691. If you don't give any arguments (as in the example above), the default
  4692. arguments (:deadline :scheduled :timestamp :sexp) are used.
  4693. So the example above may also be written as
  4694. &%%(org-diary :deadline :timestamp :sexp :scheduled)
  4695. The function expects the lisp variables `entry' and `date' to be provided
  4696. by the caller, because this is how the calendar works. Don't use this
  4697. function from a program - use `org-agenda-get-day-entries' instead."
  4698. (when (> (- (org-float-time)
  4699. org-agenda-last-marker-time)
  4700. 5)
  4701. ;; I am not sure if this works with sticky agendas, because the marker
  4702. ;; list is then no longer a global variable.
  4703. (org-agenda-reset-markers))
  4704. (org-compile-prefix-format 'agenda)
  4705. (org-set-sorting-strategy 'agenda)
  4706. (setq args (or args '(:deadline :scheduled :timestamp :sexp)))
  4707. (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
  4708. (list entry)
  4709. (org-agenda-files t)))
  4710. (time (org-float-time))
  4711. file rtn results)
  4712. (when (or (not org-diary-last-run-time)
  4713. (> (- time
  4714. org-diary-last-run-time)
  4715. 3))
  4716. (org-agenda-prepare-buffers files))
  4717. (setq org-diary-last-run-time time)
  4718. ;; If this is called during org-agenda, don't return any entries to
  4719. ;; the calendar. Org Agenda will list these entries itself.
  4720. (if org-disable-agenda-to-diary (setq files nil))
  4721. (while (setq file (pop files))
  4722. (setq rtn (apply 'org-agenda-get-day-entries file date args))
  4723. (setq results (append results rtn)))
  4724. (if results
  4725. (concat (org-agenda-finalize-entries results) "\n"))))
  4726. (autoload 'org-diary "org-agenda" "\
  4727. Return diary information from org files.
  4728. This function can be used in a \"sexp\" diary entry in the Emacs calendar.
  4729. It accesses org files and extracts information from those files to be
  4730. listed in the diary. The function accepts arguments specifying what
  4731. items should be listed. For a list of arguments allowed here, see the
  4732. variable `org-agenda-entry-types'.
  4733. The call in the diary file should look like this:
  4734. &%%(org-diary) ~/path/to/some/orgfile.org
  4735. Use a separate line for each org file to check. Or, if you omit the file name,
  4736. all files listed in `org-agenda-files' will be checked automatically:
  4737. &%%(org-diary)
  4738. If you don't give any arguments (as in the example above), the default
  4739. arguments (:deadline :scheduled :timestamp :sexp) are used.
  4740. So the example above may also be written as
  4741. &%%(org-diary :deadline :timestamp :sexp :scheduled)
  4742. The function expects the lisp variables `entry' and `date' to be provided
  4743. by the caller, because this is how the calendar works. Don't use this
  4744. function from a program - use `org-agenda-get-day-entries' instead.
  4745. \(fn &rest ARGS)" nil nil)
  4746. ;;; Agenda entry finders
  4747. (defun org-agenda-get-day-entries (file date &rest args)
  4748. "Does the work for `org-diary' and `org-agenda'.
  4749. FILE is the path to a file to be checked for entries. DATE is date like
  4750. the one returned by `calendar-current-date'. ARGS are symbols indicating
  4751. which kind of entries should be extracted. For details about these, see
  4752. the documentation of `org-diary'."
  4753. (setq args (or args '(:deadline :scheduled :timestamp :sexp)))
  4754. (let* ((org-startup-folded nil)
  4755. (org-startup-align-all-tables nil)
  4756. (buffer (if (file-exists-p file)
  4757. (org-get-agenda-file-buffer file)
  4758. (error "No such file %s" file)))
  4759. arg results rtn deadline-results)
  4760. (if (not buffer)
  4761. ;; If file does not exist, make sure an error message ends up in diary
  4762. (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4763. (with-current-buffer buffer
  4764. (unless (derived-mode-p 'org-mode)
  4765. (error "Agenda file %s is not in `org-mode'" file))
  4766. (setq org-agenda-buffer (or org-agenda-buffer buffer))
  4767. (let ((case-fold-search nil))
  4768. (save-excursion
  4769. (save-restriction
  4770. (if org-agenda-restrict
  4771. (narrow-to-region org-agenda-restrict-begin
  4772. org-agenda-restrict-end)
  4773. (widen))
  4774. ;; The way we repeatedly append to `results' makes it O(n^2) :-(
  4775. (while (setq arg (pop args))
  4776. (cond
  4777. ((and (eq arg :todo)
  4778. (equal date (calendar-gregorian-from-absolute
  4779. (org-today))))
  4780. (setq rtn (org-agenda-get-todos))
  4781. (setq results (append results rtn)))
  4782. ((eq arg :timestamp)
  4783. (setq rtn (org-agenda-get-blocks))
  4784. (setq results (append results rtn))
  4785. (setq rtn (org-agenda-get-timestamps deadline-results))
  4786. (setq results (append results rtn)))
  4787. ((eq arg :sexp)
  4788. (setq rtn (org-agenda-get-sexps))
  4789. (setq results (append results rtn)))
  4790. ((eq arg :scheduled)
  4791. (setq rtn (org-agenda-get-scheduled deadline-results))
  4792. (setq results (append results rtn)))
  4793. ((eq arg :closed)
  4794. (setq rtn (org-agenda-get-progress))
  4795. (setq results (append results rtn)))
  4796. ((eq arg :deadline)
  4797. (setq rtn (org-agenda-get-deadlines))
  4798. (setq deadline-results (copy-sequence rtn))
  4799. (setq results (append results rtn))))))))
  4800. results))))
  4801. (defvar org-heading-keyword-regexp-format) ; defined in org.el
  4802. (defun org-agenda-get-todos ()
  4803. "Return the TODO information for agenda display."
  4804. (let* ((props (list 'face nil
  4805. 'done-face 'org-agenda-done
  4806. 'org-not-done-regexp org-not-done-regexp
  4807. 'org-todo-regexp org-todo-regexp
  4808. 'org-complex-heading-regexp org-complex-heading-regexp
  4809. 'mouse-face 'highlight
  4810. 'help-echo
  4811. (format "mouse-2 or RET jump to org file %s"
  4812. (abbreviate-file-name buffer-file-name))))
  4813. (regexp (format org-heading-keyword-regexp-format
  4814. (cond
  4815. ((and org-select-this-todo-keyword
  4816. (equal org-select-this-todo-keyword "*"))
  4817. org-todo-regexp)
  4818. (org-select-this-todo-keyword
  4819. (concat "\\("
  4820. (mapconcat 'identity
  4821. (org-split-string
  4822. org-select-this-todo-keyword
  4823. "|")
  4824. "\\|") "\\)"))
  4825. (t org-not-done-regexp))))
  4826. marker priority category category-pos level tags todo-state
  4827. ee txt beg end)
  4828. (goto-char (point-min))
  4829. (while (re-search-forward regexp nil t)
  4830. (catch :skip
  4831. (save-match-data
  4832. (beginning-of-line)
  4833. (org-agenda-skip)
  4834. (setq beg (point) end (save-excursion (outline-next-heading) (point)))
  4835. (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
  4836. (goto-char (1+ beg))
  4837. (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
  4838. (throw :skip nil)))
  4839. (goto-char (match-beginning 2))
  4840. (setq marker (org-agenda-new-marker (match-beginning 0))
  4841. category (org-get-category)
  4842. category-pos (get-text-property (point) 'org-category-position)
  4843. txt (org-trim
  4844. (buffer-substring (match-beginning 2) (match-end 0)))
  4845. tags (org-get-tags-at (point))
  4846. level (make-string (org-reduced-level (org-outline-level)) ? )
  4847. txt (org-agenda-format-item "" txt level category tags t)
  4848. priority (1+ (org-get-priority txt))
  4849. todo-state (org-get-todo-state))
  4850. (org-add-props txt props
  4851. 'org-marker marker 'org-hd-marker marker
  4852. 'priority priority 'org-category category
  4853. 'level level
  4854. 'org-category-position category-pos
  4855. 'type "todo" 'todo-state todo-state)
  4856. (push txt ee)
  4857. (if org-agenda-todo-list-sublevels
  4858. (goto-char (match-end 2))
  4859. (org-end-of-subtree 'invisible))))
  4860. (nreverse ee)))
  4861. (defun org-agenda-todo-custom-ignore-p (time n)
  4862. "Check whether timestamp is farther away than n number of days.
  4863. This function is invoked if `org-agenda-todo-ignore-deadlines',
  4864. `org-agenda-todo-ignore-scheduled' or
  4865. `org-agenda-todo-ignore-timestamp' is set to an integer."
  4866. (let ((days (org-time-stamp-to-now
  4867. time org-agenda-todo-ignore-time-comparison-use-seconds)))
  4868. (if (>= n 0)
  4869. (>= days n)
  4870. (<= days n))))
  4871. (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  4872. (&optional end)
  4873. "Do we have a reason to ignore this TODO entry because it has a time stamp?"
  4874. (when (or org-agenda-todo-ignore-with-date
  4875. org-agenda-todo-ignore-scheduled
  4876. org-agenda-todo-ignore-deadlines
  4877. org-agenda-todo-ignore-timestamp)
  4878. (setq end (or end (save-excursion (outline-next-heading) (point))))
  4879. (save-excursion
  4880. (or (and org-agenda-todo-ignore-with-date
  4881. (re-search-forward org-ts-regexp end t))
  4882. (and org-agenda-todo-ignore-scheduled
  4883. (re-search-forward org-scheduled-time-regexp end t)
  4884. (cond
  4885. ((eq org-agenda-todo-ignore-scheduled 'future)
  4886. (> (org-time-stamp-to-now
  4887. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4888. ((eq org-agenda-todo-ignore-scheduled 'past)
  4889. (<= (org-time-stamp-to-now
  4890. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4891. ((numberp org-agenda-todo-ignore-scheduled)
  4892. (org-agenda-todo-custom-ignore-p
  4893. (match-string 1) org-agenda-todo-ignore-scheduled))
  4894. (t)))
  4895. (and org-agenda-todo-ignore-deadlines
  4896. (re-search-forward org-deadline-time-regexp end t)
  4897. (cond
  4898. ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
  4899. ((eq org-agenda-todo-ignore-deadlines 'far)
  4900. (not (org-deadline-close (match-string 1))))
  4901. ((eq org-agenda-todo-ignore-deadlines 'future)
  4902. (> (org-time-stamp-to-now
  4903. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4904. ((eq org-agenda-todo-ignore-deadlines 'past)
  4905. (<= (org-time-stamp-to-now
  4906. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4907. ((numberp org-agenda-todo-ignore-deadlines)
  4908. (org-agenda-todo-custom-ignore-p
  4909. (match-string 1) org-agenda-todo-ignore-deadlines))
  4910. (t (org-deadline-close (match-string 1)))))
  4911. (and org-agenda-todo-ignore-timestamp
  4912. (let ((buffer (current-buffer))
  4913. (regexp
  4914. (concat
  4915. org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
  4916. (start (point)))
  4917. ;; Copy current buffer into a temporary one
  4918. (with-temp-buffer
  4919. (insert-buffer-substring buffer start end)
  4920. (goto-char (point-min))
  4921. ;; Delete SCHEDULED and DEADLINE items
  4922. (while (re-search-forward regexp end t)
  4923. (delete-region (match-beginning 0) (match-end 0)))
  4924. (goto-char (point-min))
  4925. ;; No search for timestamp left
  4926. (when (re-search-forward org-ts-regexp nil t)
  4927. (cond
  4928. ((eq org-agenda-todo-ignore-timestamp 'future)
  4929. (> (org-time-stamp-to-now
  4930. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4931. ((eq org-agenda-todo-ignore-timestamp 'past)
  4932. (<= (org-time-stamp-to-now
  4933. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4934. ((numberp org-agenda-todo-ignore-timestamp)
  4935. (org-agenda-todo-custom-ignore-p
  4936. (match-string 1) org-agenda-todo-ignore-timestamp))
  4937. (t))))))))))
  4938. (autoload 'org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item "org-agenda" "\
  4939. Do we have a reason to ignore this TODO entry because it has a time stamp?
  4940. \(fn &optional END)" nil nil)
  4941. (defconst org-agenda-no-heading-message
  4942. "No heading for this item in buffer or region.")
  4943. (defun org-agenda-get-timestamps (&optional deadline-results)
  4944. "Return the date stamp information for agenda display."
  4945. (let* ((props (list 'face 'org-agenda-calendar-event
  4946. 'org-not-done-regexp org-not-done-regexp
  4947. 'org-todo-regexp org-todo-regexp
  4948. 'org-complex-heading-regexp org-complex-heading-regexp
  4949. 'mouse-face 'highlight
  4950. 'help-echo
  4951. (format "mouse-2 or RET jump to org file %s"
  4952. (abbreviate-file-name buffer-file-name))))
  4953. (d1 (calendar-absolute-from-gregorian date))
  4954. mm
  4955. (deadline-position-alist
  4956. (mapcar (lambda (a) (and (setq mm (get-text-property
  4957. 0 'org-hd-marker a))
  4958. (cons (marker-position mm) a)))
  4959. deadline-results))
  4960. (remove-re org-ts-regexp)
  4961. (regexp
  4962. (concat
  4963. (if org-agenda-include-inactive-timestamps "[[<]" "<")
  4964. (regexp-quote
  4965. (substring
  4966. (format-time-string
  4967. (car org-time-stamp-formats)
  4968. (apply 'encode-time ; DATE bound by calendar
  4969. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  4970. 1 11))
  4971. "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
  4972. "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
  4973. marker hdmarker deadlinep scheduledp clockp closedp inactivep
  4974. donep tmp priority category category-pos level ee txt timestr tags
  4975. b0 b3 e3 head todo-state end-of-match show-all warntime habitp)
  4976. (goto-char (point-min))
  4977. (while (setq end-of-match (re-search-forward regexp nil t))
  4978. (setq b0 (match-beginning 0)
  4979. b3 (match-beginning 3) e3 (match-end 3)
  4980. todo-state (save-match-data (ignore-errors (org-get-todo-state)))
  4981. habitp (and (functionp 'org-is-habit-p) (save-match-data (org-is-habit-p)))
  4982. show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  4983. (member todo-state
  4984. org-agenda-repeating-timestamp-show-all)))
  4985. (catch :skip
  4986. (and (org-at-date-range-p) (throw :skip nil))
  4987. (org-agenda-skip)
  4988. (if (and (match-end 1)
  4989. (not (= d1 (org-time-string-to-absolute
  4990. (match-string 1) d1 nil show-all
  4991. (current-buffer) b0))))
  4992. (throw :skip nil))
  4993. (if (and e3
  4994. (not (org-diary-sexp-entry (buffer-substring b3 e3) "" date)))
  4995. (throw :skip nil))
  4996. (setq tmp (buffer-substring (max (point-min)
  4997. (- b0 org-ds-keyword-length))
  4998. b0)
  4999. timestr (if b3 "" (buffer-substring b0 (point-at-eol)))
  5000. inactivep (= (char-after b0) ?\[)
  5001. deadlinep (string-match org-deadline-regexp tmp)
  5002. scheduledp (string-match org-scheduled-regexp tmp)
  5003. closedp (and org-agenda-include-inactive-timestamps
  5004. (string-match org-closed-string tmp))
  5005. clockp (and org-agenda-include-inactive-timestamps
  5006. (or (string-match org-clock-string tmp)
  5007. (string-match "]-+\\'" tmp)))
  5008. warntime (org-entry-get (point) "APPT_WARNTIME")
  5009. donep (member todo-state org-done-keywords))
  5010. (if (or scheduledp deadlinep closedp clockp
  5011. (and donep org-agenda-skip-timestamp-if-done))
  5012. (throw :skip t))
  5013. (if (string-match ">" timestr)
  5014. ;; substring should only run to end of time stamp
  5015. (setq timestr (substring timestr 0 (match-end 0))))
  5016. (setq marker (org-agenda-new-marker b0)
  5017. category (org-get-category b0)
  5018. category-pos (get-text-property b0 'org-category-position))
  5019. (save-excursion
  5020. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5021. (setq txt org-agenda-no-heading-message)
  5022. (goto-char (match-beginning 0))
  5023. (if (and (eq t org-agenda-skip-timestamp-if-deadline-is-shown)
  5024. (assoc (point) deadline-position-alist))
  5025. (throw :skip nil))
  5026. (setq hdmarker (org-agenda-new-marker)
  5027. tags (org-get-tags-at)
  5028. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5029. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5030. (setq head (or (match-string 1) ""))
  5031. (setq txt (org-agenda-format-item
  5032. (if inactivep org-agenda-inactive-leader nil)
  5033. head level category tags timestr
  5034. remove-re habitp)))
  5035. (setq priority (org-get-priority txt))
  5036. (org-add-props txt props 'priority priority
  5037. 'org-marker marker 'org-hd-marker hdmarker
  5038. 'org-category category 'date date
  5039. 'level level
  5040. 'org-category-position category-pos
  5041. 'todo-state todo-state
  5042. 'warntime warntime
  5043. 'type "timestamp")
  5044. (push txt ee))
  5045. (if org-agenda-skip-additional-timestamps-same-entry
  5046. (outline-next-heading)
  5047. (goto-char end-of-match))))
  5048. (nreverse ee)))
  5049. (defun org-agenda-get-sexps ()
  5050. "Return the sexp information for agenda display."
  5051. (require 'diary-lib)
  5052. (let* ((props (list 'face 'org-agenda-calendar-sexp
  5053. 'mouse-face 'highlight
  5054. 'help-echo
  5055. (format "mouse-2 or RET jump to org file %s"
  5056. (abbreviate-file-name buffer-file-name))))
  5057. (regexp "^&?%%(")
  5058. marker category extra category-pos level ee txt tags entry
  5059. result beg b sexp sexp-entry todo-state warntime)
  5060. (goto-char (point-min))
  5061. (while (re-search-forward regexp nil t)
  5062. (catch :skip
  5063. (org-agenda-skip)
  5064. (setq beg (match-beginning 0))
  5065. (goto-char (1- (match-end 0)))
  5066. (setq b (point))
  5067. (forward-sexp 1)
  5068. (setq sexp (buffer-substring b (point)))
  5069. (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
  5070. (org-trim (match-string 1))
  5071. ""))
  5072. (setq result (org-diary-sexp-entry sexp sexp-entry date))
  5073. (when result
  5074. (setq marker (org-agenda-new-marker beg)
  5075. level (make-string (org-reduced-level (org-outline-level)) ? )
  5076. category (org-get-category beg)
  5077. category-pos (get-text-property beg 'org-category-position)
  5078. tags (save-excursion (org-backward-heading-same-level 0)
  5079. (org-get-tags-at))
  5080. todo-state (org-get-todo-state)
  5081. warntime (org-entry-get (point) "APPT_WARNTIME")
  5082. extra nil)
  5083. (dolist (r (if (stringp result)
  5084. (list result)
  5085. result)) ;; we expect a list here
  5086. (when (and org-agenda-diary-sexp-prefix
  5087. (string-match org-agenda-diary-sexp-prefix r))
  5088. (setq extra (match-string 0 r)
  5089. r (replace-match "" nil nil r)))
  5090. (if (string-match "\\S-" r)
  5091. (setq txt r)
  5092. (setq txt "SEXP entry returned empty string"))
  5093. (setq txt (org-agenda-format-item extra txt level category tags 'time))
  5094. (org-add-props txt props 'org-marker marker
  5095. 'org-category category 'date date 'todo-state todo-state
  5096. 'org-category-position category-pos 'tags tags
  5097. 'level level
  5098. 'type "sexp" 'warntime warntime)
  5099. (push txt ee)))))
  5100. (nreverse ee)))
  5101. ;; Calendar sanity: define some functions that are independent of
  5102. ;; `calendar-date-style'.
  5103. ;; Normally I would like to use ISO format when calling the diary functions,
  5104. ;; but to make sure we still have Emacs 22 compatibility we bind
  5105. ;; also `european-calendar-style' and use european format
  5106. (defun org-anniversary (year month day &optional mark)
  5107. "Like `diary-anniversary', but with fixed (ISO) order of arguments."
  5108. (org-no-warnings
  5109. (let ((calendar-date-style 'european) (european-calendar-style t))
  5110. (diary-anniversary day month year mark))))
  5111. (defun org-cyclic (N year month day &optional mark)
  5112. "Like `diary-cyclic', but with fixed (ISO) order of arguments."
  5113. (org-no-warnings
  5114. (let ((calendar-date-style 'european) (european-calendar-style t))
  5115. (diary-cyclic N day month year mark))))
  5116. (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
  5117. "Like `diary-block', but with fixed (ISO) order of arguments."
  5118. (org-no-warnings
  5119. (let ((calendar-date-style 'european) (european-calendar-style t))
  5120. (diary-block D1 M1 Y1 D2 M2 Y2 mark))))
  5121. (defun org-date (year month day &optional mark)
  5122. "Like `diary-date', but with fixed (ISO) order of arguments."
  5123. (org-no-warnings
  5124. (let ((calendar-date-style 'european) (european-calendar-style t))
  5125. (diary-date day month year mark))))
  5126. (defalias 'org-float 'diary-float)
  5127. ;; Define the` org-class' function
  5128. (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
  5129. "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
  5130. DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
  5131. SKIP-WEEKS is any number of ISO weeks in the block period for which the
  5132. item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
  5133. `holidays', then any date that is known by the Emacs calendar to be a
  5134. holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
  5135. then those holidays will be skipped."
  5136. (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
  5137. (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
  5138. (d (calendar-absolute-from-gregorian date))
  5139. (h (when skip-weeks (calendar-check-holidays date))))
  5140. (and
  5141. (<= date1 d)
  5142. (<= d date2)
  5143. (= (calendar-day-of-week date) dayname)
  5144. (or (not skip-weeks)
  5145. (progn
  5146. (require 'cal-iso)
  5147. (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
  5148. (not (or (and h (memq 'holidays skip-weeks))
  5149. (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
  5150. entry)))
  5151. (defun org-diary-class (m1 d1 y1 m2 d2 y2 dayname &rest skip-weeks)
  5152. "Like `org-class', but honor `calendar-date-style'.
  5153. The order of the first 2 times 3 arguments depends on the variable
  5154. `calendar-date-style' or, if that is not defined, on `european-calendar-style'.
  5155. So for American calendars, give this as MONTH DAY YEAR, for European as
  5156. DAY MONTH YEAR, and for ISO as YEAR MONTH DAY.
  5157. DAYNAME is a number between 0 (Sunday) and 6 (Saturday). SKIP-WEEKS
  5158. is any number of ISO weeks in the block period for which the item should
  5159. be skipped.
  5160. This function is here only for backward compatibility and it is deprecated,
  5161. please use `org-class' instead."
  5162. (let* ((date1 (org-order-calendar-date-args m1 d1 y1))
  5163. (date2 (org-order-calendar-date-args m2 d2 y2)))
  5164. (org-class
  5165. (nth 2 date1) (car date1) (nth 1 date1)
  5166. (nth 2 date2) (car date2) (nth 1 date2)
  5167. dayname skip-weeks)))
  5168. (make-obsolete 'org-diary-class 'org-class "")
  5169. (defvar org-agenda-show-log-scoped) ;; dynamically scope in `org-timeline' or `org-agenda-list'
  5170. (defalias 'org-get-closed 'org-agenda-get-progress)
  5171. (defun org-agenda-get-progress ()
  5172. "Return the logged TODO entries for agenda display."
  5173. (let* ((props (list 'mouse-face 'highlight
  5174. 'org-not-done-regexp org-not-done-regexp
  5175. 'org-todo-regexp org-todo-regexp
  5176. 'org-complex-heading-regexp org-complex-heading-regexp
  5177. 'help-echo
  5178. (format "mouse-2 or RET jump to org file %s"
  5179. (abbreviate-file-name buffer-file-name))))
  5180. (items (if (consp org-agenda-show-log-scoped)
  5181. org-agenda-show-log-scoped
  5182. (if (eq org-agenda-show-log-scoped 'clockcheck)
  5183. '(clock)
  5184. org-agenda-log-mode-items)))
  5185. (parts
  5186. (delq nil
  5187. (list
  5188. (if (memq 'closed items) (concat "\\<" org-closed-string))
  5189. (if (memq 'clock items) (concat "\\<" org-clock-string))
  5190. (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
  5191. (parts-re (if parts (mapconcat 'identity parts "\\|")
  5192. (error "`org-agenda-log-mode-items' is empty")))
  5193. (regexp (concat
  5194. "\\(" parts-re "\\)"
  5195. " *\\["
  5196. (regexp-quote
  5197. (substring
  5198. (format-time-string
  5199. (car org-time-stamp-formats)
  5200. (apply 'encode-time ; DATE bound by calendar
  5201. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  5202. 1 11))))
  5203. (org-agenda-search-headline-for-time nil)
  5204. marker hdmarker priority category category-pos level tags closedp
  5205. statep clockp state ee txt extra timestr rest clocked)
  5206. (goto-char (point-min))
  5207. (while (re-search-forward regexp nil t)
  5208. (catch :skip
  5209. (org-agenda-skip)
  5210. (setq marker (org-agenda-new-marker (match-beginning 0))
  5211. closedp (equal (match-string 1) org-closed-string)
  5212. statep (equal (string-to-char (match-string 1)) ?-)
  5213. clockp (not (or closedp statep))
  5214. state (and statep (match-string 2))
  5215. category (org-get-category (match-beginning 0))
  5216. category-pos (get-text-property (match-beginning 0) 'org-category-position)
  5217. timestr (buffer-substring (match-beginning 0) (point-at-eol)))
  5218. (when (string-match "\\]" timestr)
  5219. ;; substring should only run to end of time stamp
  5220. (setq rest (substring timestr (match-end 0))
  5221. timestr (substring timestr 0 (match-end 0)))
  5222. (if (and (not closedp) (not statep)
  5223. (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
  5224. rest))
  5225. (progn (setq timestr (concat (substring timestr 0 -1)
  5226. "-" (match-string 1 rest) "]"))
  5227. (setq clocked (match-string 2 rest)))
  5228. (setq clocked "-")))
  5229. (save-excursion
  5230. (setq extra
  5231. (cond
  5232. ((not org-agenda-log-mode-add-notes) nil)
  5233. (statep
  5234. (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
  5235. (match-string 1)))
  5236. (clockp
  5237. (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
  5238. (match-string 1)))))
  5239. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5240. (setq txt org-agenda-no-heading-message)
  5241. (goto-char (match-beginning 0))
  5242. (setq hdmarker (org-agenda-new-marker)
  5243. tags (org-get-tags-at)
  5244. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5245. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5246. (setq txt (match-string 1))
  5247. (when extra
  5248. (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
  5249. (setq txt (concat (substring txt 0 (match-beginning 1))
  5250. " - " extra " " (match-string 2 txt)))
  5251. (setq txt (concat txt " - " extra))))
  5252. (setq txt (org-agenda-format-item
  5253. (cond
  5254. (closedp "Closed: ")
  5255. (statep (concat "State: (" state ")"))
  5256. (t (concat "Clocked: (" clocked ")")))
  5257. txt level category tags timestr)))
  5258. (setq priority 100000)
  5259. (org-add-props txt props
  5260. 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
  5261. 'priority priority 'org-category category
  5262. 'org-category-position category-pos
  5263. 'level level
  5264. 'type "closed" 'date date
  5265. 'undone-face 'org-warning 'done-face 'org-agenda-done)
  5266. (push txt ee))
  5267. (goto-char (point-at-eol))))
  5268. (nreverse ee)))
  5269. (defun org-agenda-show-clocking-issues ()
  5270. "Add overlays, showing issues with clocking.
  5271. See also the user option `org-agenda-clock-consistency-checks'."
  5272. (interactive)
  5273. (let* ((pl org-agenda-clock-consistency-checks)
  5274. (re (concat "^[ \t]*"
  5275. org-clock-string
  5276. "[ \t]+"
  5277. "\\(\\[.*?\\]\\)" ; group 1 is first stamp
  5278. "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
  5279. (tlstart 0.)
  5280. (tlend 0.)
  5281. (maxtime (org-hh:mm-string-to-minutes
  5282. (or (plist-get pl :max-duration) "24:00")))
  5283. (mintime (org-hh:mm-string-to-minutes
  5284. (or (plist-get pl :min-duration) 0)))
  5285. (maxgap (org-hh:mm-string-to-minutes
  5286. ;; default 30:00 means never complain
  5287. (or (plist-get pl :max-gap) "30:00")))
  5288. (gapok (mapcar 'org-hh:mm-string-to-minutes
  5289. (plist-get pl :gap-ok-around)))
  5290. (def-face (or (plist-get pl :default-face)
  5291. '((:background "DarkRed") (:foreground "white"))))
  5292. issue face m te ts dt ov)
  5293. (goto-char (point-min))
  5294. (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
  5295. (setq issue nil face def-face)
  5296. (catch 'next
  5297. (setq m (org-get-at-bol 'org-marker)
  5298. te nil ts nil)
  5299. (unless (and m (markerp m))
  5300. (setq issue "No valid clock line") (throw 'next t))
  5301. (org-with-point-at m
  5302. (save-excursion
  5303. (goto-char (point-at-bol))
  5304. (unless (looking-at re)
  5305. (error "No valid Clock line")
  5306. (throw 'next t))
  5307. (unless (match-end 3)
  5308. (setq issue "No end time"
  5309. face (or (plist-get pl :no-end-time-face) face))
  5310. (throw 'next t))
  5311. (setq ts (match-string 1)
  5312. te (match-string 3)
  5313. ts (org-float-time
  5314. (apply 'encode-time (org-parse-time-string ts)))
  5315. te (org-float-time
  5316. (apply 'encode-time (org-parse-time-string te)))
  5317. dt (- te ts))))
  5318. (cond
  5319. ((> dt (* 60 maxtime))
  5320. ;; a very long clocking chunk
  5321. (setq issue (format "Clocking interval is very long: %s"
  5322. (org-minutes-to-clocksum-string
  5323. (floor (/ (float dt) 60.))))
  5324. face (or (plist-get pl :long-face) face)))
  5325. ((< dt (* 60 mintime))
  5326. ;; a very short clocking chunk
  5327. (setq issue (format "Clocking interval is very short: %s"
  5328. (org-minutes-to-clocksum-string
  5329. (floor (/ (float dt) 60.))))
  5330. face (or (plist-get pl :short-face) face)))
  5331. ((and (> tlend 0) (< ts tlend))
  5332. ;; Two clock entries are overlapping
  5333. (setq issue (format "Clocking overlap: %d minutes"
  5334. (/ (- tlend ts) 60))
  5335. face (or (plist-get pl :overlap-face) face)))
  5336. ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
  5337. ;; There is a gap, lets see if we need to report it
  5338. (unless (org-agenda-check-clock-gap tlend ts gapok)
  5339. (setq issue (format "Clocking gap: %d minutes"
  5340. (/ (- ts tlend) 60))
  5341. face (or (plist-get pl :gap-face) face))))
  5342. (t nil)))
  5343. (setq tlend (or te tlend) tlstart (or ts tlstart))
  5344. (when issue
  5345. ;; OK, there was some issue, add an overlay to show the issue
  5346. (setq ov (make-overlay (point-at-bol) (point-at-eol)))
  5347. (overlay-put ov 'before-string
  5348. (concat
  5349. (org-add-props
  5350. (format "%-43s" (concat " " issue))
  5351. nil
  5352. 'face face)
  5353. "\n"))
  5354. (overlay-put ov 'evaporate t)))))
  5355. (defun org-agenda-check-clock-gap (t1 t2 ok-list)
  5356. "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
  5357. (catch 'exit
  5358. (unless ok-list
  5359. ;; there are no OK times for gaps...
  5360. (throw 'exit nil))
  5361. (if (> (- (/ t2 36000) (/ t1 36000)) 24)
  5362. ;; This is more than 24 hours, so it is OK.
  5363. ;; because we have at least one OK time, that must be in the
  5364. ;; 24 hour interval.
  5365. (throw 'exit t))
  5366. ;; We have a shorter gap.
  5367. ;; Now we have to get the minute of the day when these times are
  5368. (let* ((t1dec (decode-time (seconds-to-time t1)))
  5369. (t2dec (decode-time (seconds-to-time t2)))
  5370. ;; compute the minute on the day
  5371. (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
  5372. (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
  5373. (when (< min2 min1)
  5374. ;; if min2 is smaller than min1, this means it is on the next day.
  5375. ;; Wrap it to after midnight.
  5376. (setq min2 (+ min2 1440)))
  5377. ;; Now check if any of the OK times is in the gap
  5378. (mapc (lambda (x)
  5379. ;; Wrap the time to after midnight if necessary
  5380. (if (< x min1) (setq x (+ x 1440)))
  5381. ;; Check if in interval
  5382. (and (<= min1 x) (>= min2 x) (throw 'exit t)))
  5383. ok-list)
  5384. ;; Nope, this gap is not OK
  5385. nil)))
  5386. (defun org-agenda-get-deadlines ()
  5387. "Return the deadline information for agenda display."
  5388. (let* ((props (list 'mouse-face 'highlight
  5389. 'org-not-done-regexp org-not-done-regexp
  5390. 'org-todo-regexp org-todo-regexp
  5391. 'org-complex-heading-regexp org-complex-heading-regexp
  5392. 'help-echo
  5393. (format "mouse-2 or RET jump to org file %s"
  5394. (abbreviate-file-name buffer-file-name))))
  5395. (regexp org-deadline-time-regexp)
  5396. (todayp (org-agenda-todayp date)) ; DATE bound by calendar
  5397. (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
  5398. d2 diff dfrac wdays pos pos1 category category-pos level
  5399. tags suppress-prewarning ee txt head face s todo-state
  5400. show-all upcomingp donep timestr warntime)
  5401. (goto-char (point-min))
  5402. (while (re-search-forward regexp nil t)
  5403. (catch :skip
  5404. (org-agenda-skip)
  5405. (setq s (match-string 1)
  5406. txt nil
  5407. pos (1- (match-beginning 1))
  5408. todo-state (save-match-data (org-get-todo-state))
  5409. show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  5410. (member todo-state
  5411. org-agenda-repeating-timestamp-show-all))
  5412. d2 (org-time-string-to-absolute
  5413. (match-string 1) d1 'past show-all
  5414. (current-buffer) pos)
  5415. diff (- d2 d1))
  5416. (setq suppress-prewarning
  5417. (let ((ds (and org-agenda-skip-deadline-prewarning-if-scheduled
  5418. (let ((item (buffer-substring (point-at-bol)
  5419. (point-at-eol))))
  5420. (save-match-data
  5421. (and (string-match
  5422. org-scheduled-time-regexp item)
  5423. (match-string 1 item)))))))
  5424. (cond
  5425. ((not ds) nil)
  5426. ;; The current item has a scheduled date (in ds), so
  5427. ;; evaluate its prewarning lead time.
  5428. ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
  5429. ;; Use global prewarning-restart lead time.
  5430. org-agenda-skip-deadline-prewarning-if-scheduled)
  5431. ((eq org-agenda-skip-deadline-prewarning-if-scheduled
  5432. 'pre-scheduled)
  5433. ;; Set prewarning to no earlier than scheduled.
  5434. (min (- d2 (org-time-string-to-absolute
  5435. ds d1 'past show-all (current-buffer) pos))
  5436. org-deadline-warning-days))
  5437. ;; Set prewarning to deadline.
  5438. (t 0))))
  5439. (setq wdays (if suppress-prewarning
  5440. (let ((org-deadline-warning-days suppress-prewarning))
  5441. (org-get-wdays s))
  5442. (org-get-wdays s))
  5443. dfrac (- 1 (/ (* 1.0 diff) (max wdays 1)))
  5444. upcomingp (and todayp (> diff 0)))
  5445. ;; When to show a deadline in the calendar:
  5446. ;; If the expiration is within wdays warning time.
  5447. ;; Past-due deadlines are only shown on the current date
  5448. (if (and (or (and (<= diff wdays)
  5449. (and todayp (not org-agenda-only-exact-dates)))
  5450. (= diff 0)))
  5451. (save-excursion
  5452. ;; (setq todo-state (org-get-todo-state))
  5453. (setq donep (member todo-state org-done-keywords))
  5454. (if (and donep
  5455. (or org-agenda-skip-deadline-if-done
  5456. (not (= diff 0))))
  5457. (setq txt nil)
  5458. (setq category (org-get-category)
  5459. warntime (org-entry-get (point) "APPT_WARNTIME")
  5460. category-pos (get-text-property (point) 'org-category-position))
  5461. (if (not (re-search-backward "^\\*+[ \t]+" nil t))
  5462. (setq txt org-agenda-no-heading-message)
  5463. (goto-char (match-end 0))
  5464. (setq pos1 (match-beginning 0))
  5465. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  5466. (setq tags (org-get-tags-at pos1))
  5467. (setq head (buffer-substring-no-properties
  5468. (point)
  5469. (progn (skip-chars-forward "^\r\n")
  5470. (point))))
  5471. (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5472. (setq timestr
  5473. (concat (substring s (match-beginning 1)) " "))
  5474. (setq timestr 'time))
  5475. (setq txt (org-agenda-format-item
  5476. (if (= diff 0)
  5477. (car org-agenda-deadline-leaders)
  5478. (if (functionp
  5479. (nth 1 org-agenda-deadline-leaders))
  5480. (funcall
  5481. (nth 1 org-agenda-deadline-leaders)
  5482. diff date)
  5483. (format (nth 1 org-agenda-deadline-leaders)
  5484. diff)))
  5485. head level category tags
  5486. (if (not (= diff 0)) nil timestr)))))
  5487. (when txt
  5488. (setq face (org-agenda-deadline-face dfrac))
  5489. (org-add-props txt props
  5490. 'org-marker (org-agenda-new-marker pos)
  5491. 'warntime warntime
  5492. 'level level
  5493. 'org-hd-marker (org-agenda-new-marker pos1)
  5494. 'priority (+ (- diff)
  5495. (org-get-priority txt))
  5496. 'org-category category
  5497. 'org-category-position category-pos
  5498. 'todo-state todo-state
  5499. 'type (if upcomingp "upcoming-deadline" "deadline")
  5500. 'date (if upcomingp date d2)
  5501. 'face (if donep 'org-agenda-done face)
  5502. 'undone-face face 'done-face 'org-agenda-done)
  5503. (push txt ee))))))
  5504. (nreverse ee)))
  5505. (defun org-agenda-deadline-face (fraction)
  5506. "Return the face to displaying a deadline item.
  5507. FRACTION is what fraction of the head-warning time has passed."
  5508. (let ((faces org-agenda-deadline-faces) f)
  5509. (catch 'exit
  5510. (while (setq f (pop faces))
  5511. (if (>= fraction (car f)) (throw 'exit (cdr f)))))))
  5512. (defun org-agenda-get-scheduled (&optional deadline-results)
  5513. "Return the scheduled information for agenda display."
  5514. (let* ((props (list 'org-not-done-regexp org-not-done-regexp
  5515. 'org-todo-regexp org-todo-regexp
  5516. 'org-complex-heading-regexp org-complex-heading-regexp
  5517. 'done-face 'org-agenda-done
  5518. 'mouse-face 'highlight
  5519. 'help-echo
  5520. (format "mouse-2 or RET jump to org file %s"
  5521. (abbreviate-file-name buffer-file-name))))
  5522. (regexp org-scheduled-time-regexp)
  5523. (todayp (org-agenda-todayp date)) ; DATE bound by calendar
  5524. (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
  5525. mm
  5526. (deadline-position-alist
  5527. (mapcar (lambda (a) (and (setq mm (get-text-property
  5528. 0 'org-hd-marker a))
  5529. (cons (marker-position mm) a)))
  5530. deadline-results))
  5531. d2 diff pos pos1 category category-pos level tags donep
  5532. ee txt head pastschedp todo-state face timestr s habitp show-all
  5533. did-habit-check-p warntime)
  5534. (goto-char (point-min))
  5535. (while (re-search-forward regexp nil t)
  5536. (catch :skip
  5537. (org-agenda-skip)
  5538. (setq s (match-string 1)
  5539. txt nil
  5540. pos (1- (match-beginning 1))
  5541. todo-state (save-match-data (org-get-todo-state))
  5542. show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  5543. (member todo-state
  5544. org-agenda-repeating-timestamp-show-all))
  5545. d2 (org-time-string-to-absolute
  5546. (match-string 1) d1 'past show-all
  5547. (current-buffer) pos)
  5548. diff (- d2 d1)
  5549. warntime (org-entry-get (point) "APPT_WARNTIME"))
  5550. (setq pastschedp (and todayp (< diff 0)))
  5551. (setq did-habit-check-p nil)
  5552. ;; When to show a scheduled item in the calendar:
  5553. ;; If it is on or past the date.
  5554. (when (or (and (< diff 0)
  5555. (< (abs diff) org-scheduled-past-days)
  5556. (and todayp (not org-agenda-only-exact-dates)))
  5557. (= diff 0)
  5558. ;; org-is-habit-p uses org-entry-get, which is expansive
  5559. ;; so we go extra mile to only call it once
  5560. (and todayp
  5561. (boundp 'org-habit-show-all-today)
  5562. org-habit-show-all-today
  5563. (setq did-habit-check-p t)
  5564. (setq habitp (and (functionp 'org-is-habit-p)
  5565. (org-is-habit-p)))))
  5566. (save-excursion
  5567. (setq donep (member todo-state org-done-keywords))
  5568. (if (and donep
  5569. (or org-agenda-skip-scheduled-if-done
  5570. (not (= diff 0))
  5571. (and (functionp 'org-is-habit-p)
  5572. (org-is-habit-p))))
  5573. (setq txt nil)
  5574. (setq habitp (if did-habit-check-p habitp
  5575. (and (functionp 'org-is-habit-p)
  5576. (org-is-habit-p))))
  5577. (setq category (org-get-category)
  5578. category-pos (get-text-property (point) 'org-category-position))
  5579. (if (not (re-search-backward "^\\*+[ \t]+" nil t))
  5580. (setq txt org-agenda-no-heading-message)
  5581. (goto-char (match-end 0))
  5582. (setq pos1 (match-beginning 0))
  5583. (if habitp
  5584. (if (or (not org-habit-show-habits)
  5585. (and (not todayp)
  5586. (boundp 'org-habit-show-habits-only-for-today)
  5587. org-habit-show-habits-only-for-today))
  5588. (throw :skip nil))
  5589. (if (and
  5590. (or (eq t org-agenda-skip-scheduled-if-deadline-is-shown)
  5591. (and org-agenda-skip-scheduled-if-deadline-is-shown
  5592. pastschedp))
  5593. (setq mm (assoc pos1 deadline-position-alist)))
  5594. (throw :skip nil)))
  5595. (setq tags (org-get-tags-at))
  5596. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  5597. (setq head (buffer-substring-no-properties
  5598. (point)
  5599. (progn (skip-chars-forward "^\r\n") (point))))
  5600. (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5601. (setq timestr
  5602. (concat (substring s (match-beginning 1)) " "))
  5603. (setq timestr 'time))
  5604. (setq txt (org-agenda-format-item
  5605. (if (= diff 0)
  5606. (car org-agenda-scheduled-leaders)
  5607. (format (nth 1 org-agenda-scheduled-leaders)
  5608. (- 1 diff)))
  5609. head level category tags
  5610. (if (not (= diff 0)) nil timestr)
  5611. nil habitp))))
  5612. (when txt
  5613. (setq face
  5614. (cond
  5615. ((and (not habitp) pastschedp)
  5616. 'org-scheduled-previously)
  5617. (todayp 'org-scheduled-today)
  5618. (t 'org-scheduled))
  5619. habitp (and habitp (org-habit-parse-todo)))
  5620. (org-add-props txt props
  5621. 'undone-face face
  5622. 'face (if donep 'org-agenda-done face)
  5623. 'org-marker (org-agenda-new-marker pos)
  5624. 'org-hd-marker (org-agenda-new-marker pos1)
  5625. 'type (if pastschedp "past-scheduled" "scheduled")
  5626. 'date (if pastschedp d2 date)
  5627. 'warntime warntime
  5628. 'level level
  5629. 'priority (if habitp
  5630. (org-habit-get-priority habitp)
  5631. (+ 94 (- 5 diff) (org-get-priority txt)))
  5632. 'org-category category
  5633. 'category-position category-pos
  5634. 'org-habit-p habitp
  5635. 'todo-state todo-state)
  5636. (push txt ee))))))
  5637. (nreverse ee)))
  5638. (defun org-agenda-get-blocks ()
  5639. "Return the date-range information for agenda display."
  5640. (let* ((props (list 'face nil
  5641. 'org-not-done-regexp org-not-done-regexp
  5642. 'org-todo-regexp org-todo-regexp
  5643. 'org-complex-heading-regexp org-complex-heading-regexp
  5644. 'mouse-face 'highlight
  5645. 'help-echo
  5646. (format "mouse-2 or RET jump to org file %s"
  5647. (abbreviate-file-name buffer-file-name))))
  5648. (regexp org-tr-regexp)
  5649. (d0 (calendar-absolute-from-gregorian date))
  5650. marker hdmarker ee txt d1 d2 s1 s2 category category-pos
  5651. level todo-state tags pos head donep)
  5652. (goto-char (point-min))
  5653. (while (re-search-forward regexp nil t)
  5654. (catch :skip
  5655. (org-agenda-skip)
  5656. (setq pos (point))
  5657. (let ((start-time (match-string 1))
  5658. (end-time (match-string 2)))
  5659. (setq s1 (match-string 1)
  5660. s2 (match-string 2)
  5661. d1 (time-to-days (org-time-string-to-time s1 (current-buffer) pos))
  5662. d2 (time-to-days (org-time-string-to-time s2 (current-buffer) pos)))
  5663. (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
  5664. ;; Only allow days between the limits, because the normal
  5665. ;; date stamps will catch the limits.
  5666. (save-excursion
  5667. (setq todo-state (org-get-todo-state))
  5668. (setq donep (member todo-state org-done-keywords))
  5669. (if (and donep org-agenda-skip-timestamp-if-done)
  5670. (throw :skip t))
  5671. (setq marker (org-agenda-new-marker (point)))
  5672. (setq category (org-get-category)
  5673. category-pos (get-text-property (point) 'org-category-position))
  5674. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5675. (setq txt org-agenda-no-heading-message)
  5676. (goto-char (match-beginning 0))
  5677. (setq hdmarker (org-agenda-new-marker (point)))
  5678. (setq tags (org-get-tags-at))
  5679. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  5680. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5681. (setq head (match-string 1))
  5682. (let ((remove-re
  5683. (if org-agenda-remove-timeranges-from-blocks
  5684. (concat
  5685. "<" (regexp-quote s1) ".*?>"
  5686. "--"
  5687. "<" (regexp-quote s2) ".*?>")
  5688. nil)))
  5689. (setq txt (org-agenda-format-item
  5690. (format
  5691. (nth (if (= d1 d2) 0 1)
  5692. org-agenda-timerange-leaders)
  5693. (1+ (- d0 d1)) (1+ (- d2 d1)))
  5694. head level category tags
  5695. (cond ((and (= d1 d0) (= d2 d0))
  5696. (concat "<" start-time ">--<" end-time ">"))
  5697. ((= d1 d0)
  5698. (concat "<" start-time ">"))
  5699. ((= d2 d0)
  5700. (concat "<" end-time ">")))
  5701. remove-re))))
  5702. (org-add-props txt props
  5703. 'org-marker marker 'org-hd-marker hdmarker
  5704. 'type "block" 'date date
  5705. 'level level
  5706. 'todo-state todo-state
  5707. 'priority (org-get-priority txt) 'org-category category
  5708. 'org-category-position category-pos)
  5709. (push txt ee))))
  5710. (goto-char pos)))
  5711. ;; Sort the entries by expiration date.
  5712. (nreverse ee)))
  5713. ;;; Agenda presentation and sorting
  5714. (defvar org-prefix-has-time nil
  5715. "A flag, set by `org-compile-prefix-format'.
  5716. The flag is set if the currently compiled format contains a `%t'.")
  5717. (defvar org-prefix-has-tag nil
  5718. "A flag, set by `org-compile-prefix-format'.
  5719. The flag is set if the currently compiled format contains a `%T'.")
  5720. (defvar org-prefix-has-effort nil
  5721. "A flag, set by `org-compile-prefix-format'.
  5722. The flag is set if the currently compiled format contains a `%e'.")
  5723. (defvar org-prefix-category-length nil
  5724. "Used by `org-compile-prefix-format' to remember the category field width.")
  5725. (defvar org-prefix-category-max-length nil
  5726. "Used by `org-compile-prefix-format' to remember the category field width.")
  5727. (defun org-agenda-get-category-icon (category)
  5728. "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
  5729. (dolist (entry org-agenda-category-icon-alist)
  5730. (when (org-string-match-p (car entry) category)
  5731. (if (listp (cadr entry))
  5732. (return (cadr entry))
  5733. (return (apply 'create-image (cdr entry)))))))
  5734. (defun org-agenda-format-item (extra txt &optional level category tags dotime
  5735. remove-re habitp)
  5736. "Format TXT to be inserted into the agenda buffer.
  5737. In particular, add the prefix and corresponding text properties.
  5738. EXTRA must be a string to replace the `%s' specifier in the prefix format.
  5739. LEVEL may be a string to replace the `%l' specifier.
  5740. CATEGORY (a string, a symbol or nil) may be used to overrule the default
  5741. category taken from local variable or file name. It will replace the `%c'
  5742. specifier in the format.
  5743. DOTIME, when non-nil, indicates that a time-of-day should be extracted from
  5744. TXT for sorting of this entry, and for the `%t' specifier in the format.
  5745. When DOTIME is a string, this string is searched for a time before TXT is.
  5746. TAGS can be the tags of the headline.
  5747. Any match of REMOVE-RE will be removed from TXT."
  5748. ;; We keep the org-prefix-* variable values along with a compiled
  5749. ;; formatter, so that multiple agendas existing at the same time do
  5750. ;; not step on each other toes.
  5751. ;;
  5752. ;; It was inconvenient to make these variables buffer local in
  5753. ;; Agenda buffers, because this function expects to be called with
  5754. ;; the buffer where item comes from being current, and not agenda
  5755. ;; buffer
  5756. (let* ((bindings (car org-prefix-format-compiled))
  5757. (formatter (cadr org-prefix-format-compiled)))
  5758. (loop for (var value) in bindings
  5759. do (set var value))
  5760. (save-match-data
  5761. ;; Diary entries sometimes have extra whitespace at the beginning
  5762. (setq txt (org-trim txt))
  5763. ;; Fix the tags part in txt
  5764. (setq txt (org-agenda-fix-displayed-tags
  5765. txt tags
  5766. org-agenda-show-inherited-tags
  5767. org-agenda-hide-tags-regexp))
  5768. (let* ((category (or category
  5769. (if (stringp org-category)
  5770. org-category
  5771. (and org-category (symbol-name org-category)))
  5772. (if buffer-file-name
  5773. (file-name-sans-extension
  5774. (file-name-nondirectory buffer-file-name))
  5775. "")))
  5776. (category-icon (org-agenda-get-category-icon category))
  5777. (category-icon (if category-icon
  5778. (propertize " " 'display category-icon)
  5779. ""))
  5780. ;; time, tag, effort are needed for the eval of the prefix format
  5781. (tag (if tags (nth (1- (length tags)) tags) ""))
  5782. time effort neffort
  5783. (ts (if dotime (concat
  5784. (if (stringp dotime) dotime "")
  5785. (and org-agenda-search-headline-for-time txt))))
  5786. (time-of-day (and dotime (org-get-time-of-day ts)))
  5787. stamp plain s0 s1 s2 rtn srp l
  5788. duration thecategory)
  5789. (and (derived-mode-p 'org-mode) buffer-file-name
  5790. (add-to-list 'org-agenda-contributing-files buffer-file-name))
  5791. (when (and dotime time-of-day)
  5792. ;; Extract starting and ending time and move them to prefix
  5793. (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
  5794. (setq plain (string-match org-plain-time-of-day-regexp ts)))
  5795. (setq s0 (match-string 0 ts)
  5796. srp (and stamp (match-end 3))
  5797. s1 (match-string (if plain 1 2) ts)
  5798. s2 (match-string (if plain 8 (if srp 4 6)) ts))
  5799. ;; If the times are in TXT (not in DOTIMES), and the prefix will list
  5800. ;; them, we might want to remove them there to avoid duplication.
  5801. ;; The user can turn this off with a variable.
  5802. (if (and org-prefix-has-time
  5803. org-agenda-remove-times-when-in-prefix (or stamp plain)
  5804. (string-match (concat (regexp-quote s0) " *") txt)
  5805. (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
  5806. (if (eq org-agenda-remove-times-when-in-prefix 'beg)
  5807. (= (match-beginning 0) 0)
  5808. t))
  5809. (setq txt (replace-match "" nil nil txt))))
  5810. ;; Normalize the time(s) to 24 hour
  5811. (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
  5812. (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
  5813. ;; Try to set s2 if s1 and `org-agenda-default-appointment-duration' are set
  5814. (when (and s1 (not s2) org-agenda-default-appointment-duration)
  5815. (setq s2
  5816. (org-minutes-to-clocksum-string
  5817. (+ (org-hh:mm-string-to-minutes s1) org-agenda-default-appointment-duration))))
  5818. ;; Compute the duration
  5819. (when s2
  5820. (setq duration (- (org-hh:mm-string-to-minutes s2)
  5821. (org-hh:mm-string-to-minutes s1)))))
  5822. (when (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
  5823. txt)
  5824. ;; Tags are in the string
  5825. (if (or (eq org-agenda-remove-tags t)
  5826. (and org-agenda-remove-tags
  5827. org-prefix-has-tag))
  5828. (setq txt (replace-match "" t t txt))
  5829. (setq txt (replace-match
  5830. (concat (make-string (max (- 50 (length txt)) 1) ?\ )
  5831. (match-string 2 txt))
  5832. t t txt))))
  5833. (when (derived-mode-p 'org-mode)
  5834. (setq effort
  5835. (condition-case nil
  5836. (org-get-effort
  5837. (or (get-text-property 0 'org-hd-marker txt)
  5838. (get-text-property 0 'org-marker txt)))
  5839. (error nil)))
  5840. (when effort
  5841. (setq neffort (org-duration-string-to-minutes effort)
  5842. effort (setq effort (concat "[" effort "]")))))
  5843. ;; prevent erroring out with %e format when there is no effort
  5844. (or effort (setq effort ""))
  5845. (when remove-re
  5846. (while (string-match remove-re txt)
  5847. (setq txt (replace-match "" t t txt))))
  5848. ;; Set org-heading property on `txt' to mark the start of the
  5849. ;; heading.
  5850. (add-text-properties 0 (length txt) '(org-heading t) txt)
  5851. ;; Prepare the variables needed in the eval of the compiled format
  5852. (setq time (cond (s2 (concat
  5853. (org-agenda-time-of-day-to-ampm-maybe s1)
  5854. "-" (org-agenda-time-of-day-to-ampm-maybe s2)
  5855. (if org-agenda-timegrid-use-ampm " ")))
  5856. (s1 (concat
  5857. (org-agenda-time-of-day-to-ampm-maybe s1)
  5858. (if org-agenda-timegrid-use-ampm
  5859. "........ "
  5860. "......")))
  5861. (t ""))
  5862. extra (or (and (not habitp) extra) "")
  5863. category (if (symbolp category) (symbol-name category) category)
  5864. thecategory (copy-sequence category)
  5865. level (or level ""))
  5866. (if (string-match org-bracket-link-regexp category)
  5867. (progn
  5868. (setq l (if (match-end 3)
  5869. (- (match-end 3) (match-beginning 3))
  5870. (- (match-end 1) (match-beginning 1))))
  5871. (when (< l (or org-prefix-category-length 0))
  5872. (setq category (copy-sequence category))
  5873. (org-add-props category nil
  5874. 'extra-space (make-string
  5875. (- org-prefix-category-length l 1) ?\ ))))
  5876. (if (and org-prefix-category-max-length
  5877. (>= (length category) org-prefix-category-max-length))
  5878. (setq category (substring category 0 (1- org-prefix-category-max-length)))))
  5879. ;; Evaluate the compiled format
  5880. (setq rtn (concat (eval formatter) txt))
  5881. ;; And finally add the text properties
  5882. (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
  5883. (org-add-props rtn nil
  5884. 'org-category (if thecategory (downcase thecategory) category)
  5885. 'tags (mapcar 'org-downcase-keep-props tags)
  5886. 'org-highest-priority org-highest-priority
  5887. 'org-lowest-priority org-lowest-priority
  5888. 'time-of-day time-of-day
  5889. 'duration duration
  5890. 'effort effort
  5891. 'effort-minutes neffort
  5892. 'txt txt
  5893. 'level level
  5894. 'time time
  5895. 'extra extra
  5896. 'format org-prefix-format-compiled
  5897. 'dotime dotime)))))
  5898. (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
  5899. "Remove tags string from TXT, and add a modified list of tags.
  5900. The modified list may contain inherited tags, and tags matched by
  5901. `org-agenda-hide-tags-regexp' will be removed."
  5902. (when (or add-inherited hide-re)
  5903. (if (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") txt)
  5904. (setq txt (substring txt 0 (match-beginning 0))))
  5905. (setq tags
  5906. (delq nil
  5907. (mapcar (lambda (tg)
  5908. (if (or (and hide-re (string-match hide-re tg))
  5909. (and (not add-inherited)
  5910. (get-text-property 0 'inherited tg)))
  5911. nil
  5912. tg))
  5913. tags)))
  5914. (when tags
  5915. (let ((have-i (get-text-property 0 'inherited (car tags)))
  5916. i)
  5917. (setq txt (concat txt " :"
  5918. (mapconcat
  5919. (lambda (x)
  5920. (setq i (get-text-property 0 'inherited x))
  5921. (if (and have-i (not i))
  5922. (progn
  5923. (setq have-i nil)
  5924. (concat ":" x))
  5925. x))
  5926. tags ":")
  5927. (if have-i "::" ":"))))))
  5928. txt)
  5929. (defun org-downcase-keep-props (s)
  5930. (let ((props (text-properties-at 0 s)))
  5931. (setq s (downcase s))
  5932. (add-text-properties 0 (length s) props s)
  5933. s))
  5934. (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
  5935. (defvar org-agenda-sorting-strategy-selected nil)
  5936. (defun org-agenda-add-time-grid-maybe (list ndays todayp)
  5937. "Add a time-grid for agenda items which need it.
  5938. LIST is the list of agenda items formatted by `org-agenda-list'.
  5939. NDAYS is the span of the current agenda view.
  5940. TODAYP is `t' when the current agenda view is on today."
  5941. (catch 'exit
  5942. (cond ((not org-agenda-use-time-grid) (throw 'exit list))
  5943. ((and todayp (member 'today (car org-agenda-time-grid))))
  5944. ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
  5945. ((member 'weekly (car org-agenda-time-grid)))
  5946. (t (throw 'exit list)))
  5947. (let* ((have (delq nil (mapcar
  5948. (lambda (x) (get-text-property 1 'time-of-day x))
  5949. list)))
  5950. (string (nth 1 org-agenda-time-grid))
  5951. (gridtimes (nth 2 org-agenda-time-grid))
  5952. (req (car org-agenda-time-grid))
  5953. (remove (member 'remove-match req))
  5954. new time)
  5955. (if (and (member 'require-timed req) (not have))
  5956. ;; don't show empty grid
  5957. (throw 'exit list))
  5958. (while (setq time (pop gridtimes))
  5959. (unless (and remove (member time have))
  5960. (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
  5961. (push (org-agenda-format-item
  5962. nil string nil "" nil
  5963. (concat (substring time 0 -2) ":" (substring time -2)))
  5964. new)
  5965. (put-text-property
  5966. 2 (length (car new)) 'face 'org-time-grid (car new))))
  5967. (when (and todayp org-agenda-show-current-time-in-grid)
  5968. (push (org-agenda-format-item
  5969. nil org-agenda-current-time-string nil "" nil
  5970. (format-time-string "%H:%M "))
  5971. new)
  5972. (put-text-property
  5973. 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
  5974. (if (member 'time-up org-agenda-sorting-strategy-selected)
  5975. (append new list)
  5976. (append list new)))))
  5977. (defun org-compile-prefix-format (key)
  5978. "Compile the prefix format into a Lisp form that can be evaluated.
  5979. The resulting form and associated variable bindings is returned
  5980. and stored in the variable `org-prefix-format-compiled'."
  5981. (setq org-prefix-has-time nil
  5982. org-prefix-has-tag nil
  5983. org-prefix-category-length nil
  5984. org-prefix-has-effort nil)
  5985. (let ((s (cond
  5986. ((stringp org-agenda-prefix-format)
  5987. org-agenda-prefix-format)
  5988. ((assq key org-agenda-prefix-format)
  5989. (cdr (assq key org-agenda-prefix-format)))
  5990. (t " %-12:c%?-12t% s")))
  5991. (start 0)
  5992. varform vars var e c f opt)
  5993. (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cltsei]\\|(.+)\\)"
  5994. s start)
  5995. (setq var (or (cdr (assoc (match-string 4 s)
  5996. '(("c" . category) ("t" . time) ("l" . level) ("s" . extra)
  5997. ("i" . category-icon) ("T" . tag) ("e" . effort))))
  5998. 'eval)
  5999. c (or (match-string 3 s) "")
  6000. opt (match-beginning 1)
  6001. start (1+ (match-beginning 0)))
  6002. (if (equal var 'time) (setq org-prefix-has-time t))
  6003. (if (equal var 'tag) (setq org-prefix-has-tag t))
  6004. (if (equal var 'effort) (setq org-prefix-has-effort t))
  6005. (setq f (concat "%" (match-string 2 s) "s"))
  6006. (when (equal var 'category)
  6007. (setq org-prefix-category-length
  6008. (floor (abs (string-to-number (match-string 2 s)))))
  6009. (setq org-prefix-category-max-length
  6010. (let ((x (match-string 2 s)))
  6011. (save-match-data
  6012. (if (string-match "\\.[0-9]+" x)
  6013. (string-to-number (substring (match-string 0 x) 1)))))))
  6014. (if (eq var 'eval)
  6015. (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
  6016. (if opt
  6017. (setq varform
  6018. `(if (equal "" ,var)
  6019. ""
  6020. (format ,f (if (equal "" ,var) "" (concat ,var ,c)))))
  6021. (setq varform `(format ,f (if (equal ,var "") "" (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
  6022. (setq s (replace-match "%s" t nil s))
  6023. (push varform vars))
  6024. (setq vars (nreverse vars))
  6025. (with-current-buffer (or org-agenda-buffer (current-buffer))
  6026. (setq org-prefix-format-compiled
  6027. (list
  6028. `((org-prefix-has-time ,org-prefix-has-time)
  6029. (org-prefix-has-tag ,org-prefix-has-tag)
  6030. (org-prefix-category-length ,org-prefix-category-length)
  6031. (org-prefix-has-effort ,org-prefix-has-effort))
  6032. `(format ,s ,@vars))))))
  6033. (defun org-set-sorting-strategy (key)
  6034. (if (symbolp (car org-agenda-sorting-strategy))
  6035. ;; the old format
  6036. (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
  6037. (setq org-agenda-sorting-strategy-selected
  6038. (or (cdr (assq key org-agenda-sorting-strategy))
  6039. (cdr (assq 'agenda org-agenda-sorting-strategy))
  6040. '(time-up category-keep priority-down)))))
  6041. (defun org-get-time-of-day (s &optional string mod24)
  6042. "Check string S for a time of day.
  6043. If found, return it as a military time number between 0 and 2400.
  6044. If not found, return nil.
  6045. The optional STRING argument forces conversion into a 5 character wide string
  6046. HH:MM."
  6047. (save-match-data
  6048. (when
  6049. (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
  6050. (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
  6051. (let* ((h (string-to-number (match-string 1 s)))
  6052. (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
  6053. (ampm (if (match-end 4) (downcase (match-string 4 s))))
  6054. (am-p (equal ampm "am"))
  6055. (h1 (cond ((not ampm) h)
  6056. ((= h 12) (if am-p 0 12))
  6057. (t (+ h (if am-p 0 12)))))
  6058. (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
  6059. (mod h1 24) h1))
  6060. (t0 (+ (* 100 h2) m))
  6061. (t1 (concat (if (>= h1 24) "+" " ")
  6062. (if (and org-agenda-time-leading-zero
  6063. (< t0 1000)) "0" "")
  6064. (if (< t0 100) "0" "")
  6065. (if (< t0 10) "0" "")
  6066. (int-to-string t0))))
  6067. (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
  6068. (defvar org-agenda-before-sorting-filter-function nil
  6069. "Function to be applied to agenda items prior to sorting.
  6070. Prior to sorting also means just before they are inserted into the agenda.
  6071. To aid sorting, you may revisit the original entries and add more text
  6072. properties which will later be used by the sorting functions.
  6073. The function should take a string argument, an agenda line.
  6074. It has access to the text properties in that line, which contain among
  6075. other things, the property `org-hd-marker' that points to the entry
  6076. where the line comes from. Note that not all lines going into the agenda
  6077. have this property, only most.
  6078. The function should return the modified string. It is probably best
  6079. to ONLY change text properties.
  6080. You can also use this function as a filter, by returning nil for lines
  6081. you don't want to have in the agenda at all. For this application, you
  6082. could bind the variable in the options section of a custom command.")
  6083. (defun org-agenda-finalize-entries (list &optional nosort)
  6084. "Sort and concatenate the agenda items."
  6085. (setq list (mapcar 'org-agenda-highlight-todo list))
  6086. (if nosort
  6087. list
  6088. (when org-agenda-before-sorting-filter-function
  6089. (setq list (delq nil (mapcar org-agenda-before-sorting-filter-function list))))
  6090. (mapconcat 'identity (sort list 'org-entries-lessp) "\n")))
  6091. (defun org-agenda-highlight-todo (x)
  6092. (let ((org-done-keywords org-done-keywords-for-agenda)
  6093. (case-fold-search nil)
  6094. re)
  6095. (if (eq x 'line)
  6096. (save-excursion
  6097. (beginning-of-line 1)
  6098. (setq re (org-get-at-bol 'org-todo-regexp))
  6099. (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
  6100. (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
  6101. (add-text-properties (match-beginning 0) (match-end 1)
  6102. (list 'face (org-get-todo-face 1)))
  6103. (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
  6104. (delete-region (match-beginning 1) (1- (match-end 0)))
  6105. (goto-char (match-beginning 1))
  6106. (insert (format org-agenda-todo-keyword-format s)))))
  6107. (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
  6108. (setq re (get-text-property 0 'org-todo-regexp x))
  6109. (when (and re
  6110. ;; Test `pl' because if there's no heading content,
  6111. ;; there's no point matching to highlight. Note
  6112. ;; that if we didn't test `pl' first, and there
  6113. ;; happened to be no keyword from `org-todo-regexp'
  6114. ;; on this heading line, then the `equal' comparison
  6115. ;; afterwards would spuriously succeed in the case
  6116. ;; where `pl' is nil -- causing an args-out-of-range
  6117. ;; error when we try to add text properties to text
  6118. ;; that isn't there.
  6119. pl
  6120. (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
  6121. x pl) pl))
  6122. (add-text-properties
  6123. (or (match-end 1) (match-end 0)) (match-end 0)
  6124. (list 'face (org-get-todo-face (match-string 2 x)))
  6125. x)
  6126. (when (match-end 1)
  6127. (setq x (concat (substring x 0 (match-end 1))
  6128. (format org-agenda-todo-keyword-format
  6129. (match-string 2 x))
  6130. (org-add-props " " (text-properties-at 0 x))
  6131. (substring x (match-end 3)))))))
  6132. x)))
  6133. (defsubst org-cmp-priority (a b)
  6134. "Compare the priorities of string A and B."
  6135. (let ((pa (or (get-text-property 1 'priority a) 0))
  6136. (pb (or (get-text-property 1 'priority b) 0)))
  6137. (cond ((> pa pb) +1)
  6138. ((< pa pb) -1))))
  6139. (defsubst org-cmp-effort (a b)
  6140. "Compare the effort values of string A and B."
  6141. (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
  6142. (ea (or (get-text-property 1 'effort-minutes a) def))
  6143. (eb (or (get-text-property 1 'effort-minutes b) def)))
  6144. (cond ((> ea eb) +1)
  6145. ((< ea eb) -1))))
  6146. (defsubst org-cmp-category (a b)
  6147. "Compare the string values of categories of strings A and B."
  6148. (let ((ca (or (get-text-property 1 'org-category a) ""))
  6149. (cb (or (get-text-property 1 'org-category b) "")))
  6150. (cond ((string-lessp ca cb) -1)
  6151. ((string-lessp cb ca) +1))))
  6152. (defsubst org-cmp-todo-state (a b)
  6153. "Compare the todo states of strings A and B."
  6154. (let* ((ma (or (get-text-property 1 'org-marker a)
  6155. (get-text-property 1 'org-hd-marker a)))
  6156. (mb (or (get-text-property 1 'org-marker b)
  6157. (get-text-property 1 'org-hd-marker b)))
  6158. (fa (and ma (marker-buffer ma)))
  6159. (fb (and mb (marker-buffer mb)))
  6160. (todo-kwds
  6161. (or (and fa (with-current-buffer fa org-todo-keywords-1))
  6162. (and fb (with-current-buffer fb org-todo-keywords-1))))
  6163. (ta (or (get-text-property 1 'todo-state a) ""))
  6164. (tb (or (get-text-property 1 'todo-state b) ""))
  6165. (la (- (length (member ta todo-kwds))))
  6166. (lb (- (length (member tb todo-kwds))))
  6167. (donepa (member ta org-done-keywords-for-agenda))
  6168. (donepb (member tb org-done-keywords-for-agenda)))
  6169. (cond ((and donepa (not donepb)) -1)
  6170. ((and (not donepa) donepb) +1)
  6171. ((< la lb) -1)
  6172. ((< lb la) +1))))
  6173. (defsubst org-cmp-alpha (a b)
  6174. "Compare the headlines, alphabetically."
  6175. (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
  6176. (plb (text-property-any 0 (length b) 'org-heading t b))
  6177. (ta (and pla (substring a pla)))
  6178. (tb (and plb (substring b plb))))
  6179. (when pla
  6180. (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
  6181. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
  6182. (setq ta (substring ta (match-end 0))))
  6183. (setq ta (downcase ta)))
  6184. (when plb
  6185. (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
  6186. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
  6187. (setq tb (substring tb (match-end 0))))
  6188. (setq tb (downcase tb)))
  6189. (cond ((not ta) +1)
  6190. ((not tb) -1)
  6191. ((string-lessp ta tb) -1)
  6192. ((string-lessp tb ta) +1))))
  6193. (defsubst org-cmp-tag (a b)
  6194. "Compare the string values of the first tags of A and B."
  6195. (let ((ta (car (last (get-text-property 1 'tags a))))
  6196. (tb (car (last (get-text-property 1 'tags b)))))
  6197. (cond ((not ta) +1)
  6198. ((not tb) -1)
  6199. ((string-lessp ta tb) -1)
  6200. ((string-lessp tb ta) +1))))
  6201. (defsubst org-cmp-time (a b)
  6202. "Compare the time-of-day values of strings A and B."
  6203. (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
  6204. (ta (or (get-text-property 1 'time-of-day a) def))
  6205. (tb (or (get-text-property 1 'time-of-day b) def)))
  6206. (cond ((< ta tb) -1)
  6207. ((< tb ta) +1))))
  6208. (defsubst org-cmp-habit-p (a b)
  6209. "Compare the todo states of strings A and B."
  6210. (let ((ha (get-text-property 1 'org-habit-p a))
  6211. (hb (get-text-property 1 'org-habit-p b)))
  6212. (cond ((and ha (not hb)) -1)
  6213. ((and (not ha) hb) +1))))
  6214. (defsubst org-em (x y list) (or (memq x list) (memq y list)))
  6215. (defun org-entries-lessp (a b)
  6216. "Predicate for sorting agenda entries."
  6217. ;; The following variables will be used when the form is evaluated.
  6218. ;; So even though the compiler complains, keep them.
  6219. (let* ((ss org-agenda-sorting-strategy-selected)
  6220. (time-up (and (org-em 'time-up 'time-down ss)
  6221. (org-cmp-time a b)))
  6222. (time-down (if time-up (- time-up) nil))
  6223. (priority-up (and (org-em 'priority-up 'priority-down ss)
  6224. (org-cmp-priority a b)))
  6225. (priority-down (if priority-up (- priority-up) nil))
  6226. (effort-up (and (org-em 'effort-up 'effort-down ss)
  6227. (org-cmp-effort a b)))
  6228. (effort-down (if effort-up (- effort-up) nil))
  6229. (category-up (and (or (org-em 'category-up 'category-down ss)
  6230. (memq 'category-keep ss))
  6231. (org-cmp-category a b)))
  6232. (category-down (if category-up (- category-up) nil))
  6233. (category-keep (if category-up +1 nil))
  6234. (tag-up (and (org-em 'tag-up 'tag-down ss)
  6235. (org-cmp-tag a b)))
  6236. (tag-down (if tag-up (- tag-up) nil))
  6237. (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
  6238. (org-cmp-todo-state a b)))
  6239. (todo-state-down (if todo-state-up (- todo-state-up) nil))
  6240. (habit-up (and (org-em 'habit-up 'habit-down ss)
  6241. (org-cmp-habit-p a b)))
  6242. (habit-down (if habit-up (- habit-up) nil))
  6243. (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
  6244. (org-cmp-alpha a b)))
  6245. (alpha-down (if alpha-up (- alpha-up) nil))
  6246. (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
  6247. user-defined-up user-defined-down)
  6248. (if (and need-user-cmp org-agenda-cmp-user-defined
  6249. (functionp org-agenda-cmp-user-defined))
  6250. (setq user-defined-up
  6251. (funcall org-agenda-cmp-user-defined a b)
  6252. user-defined-down (if user-defined-up (- user-defined-up) nil)))
  6253. (cdr (assoc
  6254. (eval (cons 'or org-agenda-sorting-strategy-selected))
  6255. '((-1 . t) (1 . nil) (nil . nil))))))
  6256. ;;; Agenda restriction lock
  6257. (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
  6258. "Overlay to mark the headline to which agenda commands are restricted.")
  6259. (overlay-put org-agenda-restriction-lock-overlay
  6260. 'face 'org-agenda-restriction-lock)
  6261. (overlay-put org-agenda-restriction-lock-overlay
  6262. 'help-echo "Agendas are currently limited to this subtree.")
  6263. (org-detach-overlay org-agenda-restriction-lock-overlay)
  6264. (defun org-agenda-set-restriction-lock (&optional type)
  6265. "Set restriction lock for agenda, to current subtree or file.
  6266. Restriction will be the file if TYPE is `file', or if type is the
  6267. universal prefix '(4), or if the cursor is before the first headline
  6268. in the file. Otherwise, restriction will be to the current subtree."
  6269. (interactive "P")
  6270. (and (equal type '(4)) (setq type 'file))
  6271. (setq type (cond
  6272. (type type)
  6273. ((org-at-heading-p) 'subtree)
  6274. ((condition-case nil (org-back-to-heading t) (error nil))
  6275. 'subtree)
  6276. (t 'file)))
  6277. (if (eq type 'subtree)
  6278. (progn
  6279. (setq org-agenda-restrict t)
  6280. (setq org-agenda-overriding-restriction 'subtree)
  6281. (put 'org-agenda-files 'org-restrict
  6282. (list (buffer-file-name (buffer-base-buffer))))
  6283. (org-back-to-heading t)
  6284. (move-overlay org-agenda-restriction-lock-overlay (point) (point-at-eol))
  6285. (move-marker org-agenda-restrict-begin (point))
  6286. (move-marker org-agenda-restrict-end
  6287. (save-excursion (org-end-of-subtree t)))
  6288. (message "Locking agenda restriction to subtree"))
  6289. (put 'org-agenda-files 'org-restrict
  6290. (list (buffer-file-name (buffer-base-buffer))))
  6291. (setq org-agenda-restrict nil)
  6292. (setq org-agenda-overriding-restriction 'file)
  6293. (move-marker org-agenda-restrict-begin nil)
  6294. (move-marker org-agenda-restrict-end nil)
  6295. (message "Locking agenda restriction to file"))
  6296. (setq current-prefix-arg nil)
  6297. (org-agenda-maybe-redo))
  6298. (defun org-agenda-remove-restriction-lock (&optional noupdate)
  6299. "Remove the agenda restriction lock."
  6300. (interactive "P")
  6301. (org-detach-overlay org-agenda-restriction-lock-overlay)
  6302. (org-detach-overlay org-speedbar-restriction-lock-overlay)
  6303. (setq org-agenda-overriding-restriction nil)
  6304. (setq org-agenda-restrict nil)
  6305. (put 'org-agenda-files 'org-restrict nil)
  6306. (move-marker org-agenda-restrict-begin nil)
  6307. (move-marker org-agenda-restrict-end nil)
  6308. (setq current-prefix-arg nil)
  6309. (message "Agenda restriction lock removed")
  6310. (or noupdate (org-agenda-maybe-redo)))
  6311. (defun org-agenda-maybe-redo ()
  6312. "If there is any window showing the agenda view, update it."
  6313. (let ((w (get-buffer-window org-agenda-buffer-name t))
  6314. (w0 (selected-window)))
  6315. (when w
  6316. (select-window w)
  6317. (org-agenda-redo)
  6318. (select-window w0)
  6319. (if org-agenda-overriding-restriction
  6320. (message "Agenda view shifted to new %s restriction"
  6321. org-agenda-overriding-restriction)
  6322. (message "Agenda restriction lock removed")))))
  6323. ;;; Agenda commands
  6324. (defun org-agenda-check-type (error &rest types)
  6325. "Check if agenda buffer is of allowed type.
  6326. If ERROR is non-nil, throw an error, otherwise just return nil."
  6327. (if (not org-agenda-type)
  6328. (error "No Org agenda currently displayed")
  6329. (if (memq org-agenda-type types)
  6330. t
  6331. (if error
  6332. (error "Not allowed in %s-type agenda buffers" org-agenda-type)
  6333. nil))))
  6334. (defun org-agenda-Quit ()
  6335. "Exit the agenda and kill buffers loaded by `org-agenda'.
  6336. Also restore the window configuration."
  6337. (interactive)
  6338. (if org-agenda-columns-active
  6339. (org-columns-quit)
  6340. (let ((buf (current-buffer)))
  6341. (if (eq org-agenda-window-setup 'other-frame)
  6342. (progn
  6343. (org-agenda-reset-markers)
  6344. (kill-buffer buf)
  6345. (org-columns-remove-overlays)
  6346. (setq org-agenda-archives-mode nil)
  6347. (delete-frame))
  6348. (and (not (eq org-agenda-window-setup 'current-window))
  6349. (not (one-window-p))
  6350. (delete-window))
  6351. (org-agenda-reset-markers)
  6352. (kill-buffer buf)
  6353. (org-columns-remove-overlays)
  6354. (setq org-agenda-archives-mode nil)))
  6355. ;; Maybe restore the pre-agenda window configuration.
  6356. (and org-agenda-restore-windows-after-quit
  6357. (not (eq org-agenda-window-setup 'other-frame))
  6358. org-agenda-pre-window-conf
  6359. (set-window-configuration org-agenda-pre-window-conf)
  6360. (setq org-agenda-pre-window-conf nil))))
  6361. (defun org-agenda-quit ()
  6362. "Exit the agenda and restore the window configuration.
  6363. When `org-agenda-sticky' is non-nil, only bury the agenda."
  6364. (interactive)
  6365. (if (and (eq org-indirect-buffer-display 'other-window)
  6366. org-last-indirect-buffer)
  6367. (delete-window (get-buffer-window org-last-indirect-buffer)))
  6368. (if org-agenda-columns-active
  6369. (org-columns-quit)
  6370. (if org-agenda-sticky
  6371. (let ((buf (current-buffer)))
  6372. (if (eq org-agenda-window-setup 'other-frame)
  6373. (progn
  6374. (delete-frame))
  6375. (and (not (eq org-agenda-window-setup 'current-window))
  6376. (not (one-window-p))
  6377. (delete-window)))
  6378. (with-current-buffer buf
  6379. (bury-buffer)
  6380. ;; Maybe restore the pre-agenda window configuration.
  6381. (and org-agenda-restore-windows-after-quit
  6382. (not (eq org-agenda-window-setup 'other-frame))
  6383. org-agenda-pre-window-conf
  6384. (set-window-configuration org-agenda-pre-window-conf)
  6385. (setq org-agenda-pre-window-conf nil))))
  6386. (org-agenda-Quit))))
  6387. (defun org-agenda-exit ()
  6388. "Exit the agenda and restore the window configuration.
  6389. Also kill Org-mode buffers loaded by `org-agenda'. Org-mode
  6390. buffers visited directly by the user will not be touched."
  6391. (interactive)
  6392. (org-release-buffers org-agenda-new-buffers)
  6393. (setq org-agenda-new-buffers nil)
  6394. (org-agenda-Quit))
  6395. (defun org-agenda-kill-all-agenda-buffers ()
  6396. "Kill all buffers in `org-agenda-mode'.
  6397. This is used when toggling sticky agendas.
  6398. You can also explicitly invoke it with `C-c a C-k'."
  6399. (interactive)
  6400. (let (blist)
  6401. (dolist (buf (buffer-list))
  6402. (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
  6403. (push buf blist)))
  6404. (mapc 'kill-buffer blist)))
  6405. (defun org-agenda-execute (arg)
  6406. "Execute another agenda command, keeping same window.
  6407. So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
  6408. in the agenda."
  6409. (interactive "P")
  6410. (let ((org-agenda-window-setup 'current-window))
  6411. (org-agenda arg)))
  6412. (defun org-agenda-redo (&optional all)
  6413. "Rebuild possibly ALL agenda view(s) in the current buffer."
  6414. (interactive "P")
  6415. (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
  6416. (cpa (unless (eq all t) current-prefix-arg))
  6417. (org-agenda-doing-sticky-redo org-agenda-sticky)
  6418. (org-agenda-sticky nil)
  6419. (org-agenda-buffer-name (or org-agenda-this-buffer-name
  6420. org-agenda-buffer-name))
  6421. (org-agenda-keep-modes t)
  6422. (tag-filter org-agenda-tag-filter)
  6423. (tag-preset (get 'org-agenda-tag-filter :preset-filter))
  6424. (top-cat-filter org-agenda-top-category-filter)
  6425. (cat-filter org-agenda-category-filter)
  6426. (cat-preset (get 'org-agenda-category-filter :preset-filter))
  6427. (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
  6428. (cols org-agenda-columns-active)
  6429. (line (org-current-line))
  6430. (window-line (- line (org-current-line (window-start))))
  6431. (lprops (get 'org-agenda-redo-command 'org-lprops))
  6432. (redo-cmd (get-text-property p 'org-redo-cmd))
  6433. (last-args (get-text-property p 'org-last-args))
  6434. (org-agenda-overriding-cmd (get-text-property p 'org-series-cmd))
  6435. (org-agenda-overriding-cmd-arguments
  6436. (unless (eq all t)
  6437. (cond ((listp last-args)
  6438. (cons (or cpa (car last-args)) (cdr last-args)))
  6439. ((stringp last-args)
  6440. last-args))))
  6441. (series-redo-cmd (get-text-property p 'org-series-redo-cmd)))
  6442. (put 'org-agenda-tag-filter :preset-filter nil)
  6443. (put 'org-agenda-category-filter :preset-filter nil)
  6444. (and cols (org-columns-quit))
  6445. (message "Rebuilding agenda buffer...")
  6446. (if series-redo-cmd
  6447. (eval series-redo-cmd)
  6448. (org-let lprops '(eval redo-cmd)))
  6449. (setq org-agenda-undo-list nil
  6450. org-agenda-pending-undo-list nil)
  6451. (message "Rebuilding agenda buffer...done")
  6452. (put 'org-agenda-tag-filter :preset-filter tag-preset)
  6453. (put 'org-agenda-category-filter :preset-filter cat-preset)
  6454. (and (or tag-filter tag-preset) (org-agenda-filter-apply tag-filter 'tag))
  6455. (and (or cat-filter cat-preset) (org-agenda-filter-apply cat-filter 'category))
  6456. (and top-cat-filter (org-agenda-filter-top-category-apply top-cat-filter))
  6457. (and cols (org-called-interactively-p 'any) (org-agenda-columns))
  6458. (org-goto-line line)
  6459. (recenter window-line)))
  6460. (defvar org-global-tags-completion-table nil)
  6461. (defvar org-agenda-filter-form nil)
  6462. (defvar org-agenda-filtered-by-category nil)
  6463. (defun org-agenda-filter-by-category (strip)
  6464. "Keep only those lines in the agenda buffer that have a specific category.
  6465. The category is that of the current line."
  6466. (interactive "P")
  6467. (if (and org-agenda-filtered-by-category
  6468. org-agenda-category-filter)
  6469. (org-agenda-filter-show-all-cat)
  6470. (let ((cat (org-no-properties (get-text-property (point) 'org-category))))
  6471. (if cat (org-agenda-filter-apply
  6472. (list (concat (if strip "-" "+") cat)) 'category)
  6473. (error "No category at point")))))
  6474. (defun org-find-top-category (&optional pos)
  6475. (save-excursion
  6476. (with-current-buffer (if pos (marker-buffer pos) (current-buffer))
  6477. (if pos (goto-char pos))
  6478. ;; Skip up to the topmost parent
  6479. (while (ignore-errors (outline-up-heading 1) t))
  6480. (ignore-errors
  6481. (nth 4 (org-heading-components))))))
  6482. (defvar org-agenda-filtered-by-top-category nil)
  6483. (defun org-agenda-filter-by-top-category (strip)
  6484. "Keep only those lines in the agenda buffer that have a specific category.
  6485. The category is that of the current line."
  6486. (interactive "P")
  6487. (if org-agenda-filtered-by-top-category
  6488. (progn
  6489. (setq org-agenda-filtered-by-top-category nil
  6490. org-agenda-top-category-filter nil)
  6491. (org-agenda-filter-show-all-cat))
  6492. (let ((cat (org-find-top-category (org-get-at-bol 'org-hd-marker))))
  6493. (if cat (org-agenda-filter-top-category-apply cat strip)
  6494. (error "No top-level category at point")))))
  6495. (defun org-agenda-filter-by-tag (strip &optional char narrow)
  6496. "Keep only those lines in the agenda buffer that have a specific tag.
  6497. The tag is selected with its fast selection letter, as configured.
  6498. With prefix argument STRIP, remove all lines that do have the tag.
  6499. A lisp caller can specify CHAR. NARROW means that the new tag should be
  6500. used to narrow the search - the interactive user can also press `-' or `+'
  6501. to switch to narrowing."
  6502. (interactive "P")
  6503. (let* ((alist org-tag-alist-for-agenda)
  6504. (tag-chars (mapconcat
  6505. (lambda (x) (if (and (not (symbolp (car x)))
  6506. (cdr x))
  6507. (char-to-string (cdr x))
  6508. ""))
  6509. alist ""))
  6510. (efforts (org-split-string
  6511. (or (cdr (assoc (concat org-effort-property "_ALL")
  6512. org-global-properties))
  6513. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00"
  6514. "")))
  6515. (effort-op org-agenda-filter-effort-default-operator)
  6516. (effort-prompt "")
  6517. (inhibit-read-only t)
  6518. (current org-agenda-tag-filter)
  6519. maybe-refresh a n tag)
  6520. (unless char
  6521. (message
  6522. "%s by tag [%s ], [TAB], %s[/]:off, [+-]:narrow, [>=<?]:effort: "
  6523. (if narrow "Narrow" "Filter") tag-chars
  6524. (if org-agenda-auto-exclude-function "[RET], " ""))
  6525. (setq char (read-char-exclusive)))
  6526. (when (member char '(?+ ?-))
  6527. ;; Narrowing down
  6528. (cond ((equal char ?-) (setq strip t narrow t))
  6529. ((equal char ?+) (setq strip nil narrow t)))
  6530. (message
  6531. "Narrow by tag [%s ], [TAB], [/]:off, [>=<]:effort: " tag-chars)
  6532. (setq char (read-char-exclusive)))
  6533. (when (member char '(?< ?> ?= ??))
  6534. ;; An effort operator
  6535. (setq effort-op (char-to-string char))
  6536. (setq alist nil) ; to make sure it will be interpreted as effort.
  6537. (unless (equal char ??)
  6538. (loop for i from 0 to 9 do
  6539. (setq effort-prompt
  6540. (concat
  6541. effort-prompt " ["
  6542. (if (= i 9) "0" (int-to-string (1+ i)))
  6543. "]" (nth i efforts))))
  6544. (message "Effort%s: %s " effort-op effort-prompt)
  6545. (setq char (read-char-exclusive))
  6546. (when (or (< char ?0) (> char ?9))
  6547. (error "Need 1-9,0 to select effort"))))
  6548. (when (equal char ?\t)
  6549. (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
  6550. (org-set-local 'org-global-tags-completion-table
  6551. (org-global-tags-completion-table)))
  6552. (let ((completion-ignore-case t))
  6553. (setq tag (org-icompleting-read
  6554. "Tag: " org-global-tags-completion-table))))
  6555. (cond
  6556. ((equal char ?\r)
  6557. (org-agenda-filter-show-all-tag)
  6558. (when org-agenda-auto-exclude-function
  6559. (setq org-agenda-tag-filter '())
  6560. (dolist (tag (org-agenda-get-represented-tags))
  6561. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  6562. (if modifier
  6563. (push modifier org-agenda-tag-filter))))
  6564. (if (not (null org-agenda-tag-filter))
  6565. (org-agenda-filter-apply org-agenda-tag-filter 'tag)))
  6566. (setq maybe-refresh t))
  6567. ((equal char ?/)
  6568. (org-agenda-filter-show-all-tag)
  6569. (when (get 'org-agenda-tag-filter :preset-filter)
  6570. (org-agenda-filter-apply org-agenda-tag-filter 'tag))
  6571. (setq maybe-refresh t))
  6572. ((equal char ?. )
  6573. (setq org-agenda-tag-filter
  6574. (mapcar (lambda(tag) (concat "+" tag))
  6575. (org-get-at-bol 'tags)))
  6576. (org-agenda-filter-apply org-agenda-tag-filter 'tag)
  6577. (setq maybe-refresh t))
  6578. ((or (equal char ?\ )
  6579. (setq a (rassoc char alist))
  6580. (and (>= char ?0) (<= char ?9)
  6581. (setq n (if (= char ?0) 9 (- char ?0 1))
  6582. tag (concat effort-op (nth n efforts))
  6583. a (cons tag nil)))
  6584. (and (= char ??)
  6585. (setq tag "?eff")
  6586. a (cons tag nil))
  6587. (and tag (setq a (cons tag nil))))
  6588. (org-agenda-filter-show-all-tag)
  6589. (setq tag (car a))
  6590. (setq org-agenda-tag-filter
  6591. (cons (concat (if strip "-" "+") tag)
  6592. (if narrow current nil)))
  6593. (org-agenda-filter-apply org-agenda-tag-filter 'tag)
  6594. (setq maybe-refresh t))
  6595. (t (error "Invalid tag selection character %c" char)))
  6596. (when (and maybe-refresh
  6597. (eq org-agenda-clockreport-mode 'with-filter))
  6598. (org-agenda-redo))))
  6599. (defun org-agenda-get-represented-tags ()
  6600. "Get a list of all tags currently represented in the agenda."
  6601. (let (p tags)
  6602. (save-excursion
  6603. (goto-char (point-min))
  6604. (while (setq p (next-single-property-change (point) 'tags))
  6605. (goto-char p)
  6606. (mapc (lambda (x) (add-to-list 'tags x))
  6607. (get-text-property (point) 'tags))))
  6608. tags))
  6609. (defun org-agenda-filter-by-tag-refine (strip &optional char)
  6610. "Refine the current filter. See `org-agenda-filter-by-tag'."
  6611. (interactive "P")
  6612. (org-agenda-filter-by-tag strip char 'refine))
  6613. (defun org-agenda-filter-make-matcher ()
  6614. "Create the form that tests a line for agenda filter."
  6615. (let (f f1)
  6616. ;; first compute the tag-filter matcher
  6617. (dolist (x (delete-dups
  6618. (append (get 'org-agenda-tag-filter
  6619. :preset-filter) org-agenda-tag-filter)))
  6620. (if (member x '("-" "+"))
  6621. (setq f1 (if (equal x "-") 'tags '(not tags)))
  6622. (if (string-match "[<=>?]" x)
  6623. (setq f1 (org-agenda-filter-effort-form x))
  6624. (setq f1 (list 'member (downcase (substring x 1)) 'tags)))
  6625. (if (equal (string-to-char x) ?-)
  6626. (setq f1 (list 'not f1))))
  6627. (push f1 f))
  6628. ;; then compute the category-filter matcher
  6629. (dolist (x (delete-dups
  6630. (append (get 'org-agenda-category-filter
  6631. :preset-filter) org-agenda-category-filter)))
  6632. (if (equal "-" (substring x 0 1))
  6633. (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
  6634. (setq f1 (list 'equal (substring x 1) 'cat)))
  6635. (push f1 f))
  6636. (cons 'and (nreverse f))))
  6637. (defun org-agenda-filter-effort-form (e)
  6638. "Return the form to compare the effort of the current line with what E says.
  6639. E looks like \"+<2:25\"."
  6640. (let (op)
  6641. (setq e (substring e 1))
  6642. (setq op (string-to-char e) e (substring e 1))
  6643. (setq op (cond ((equal op ?<) '<=)
  6644. ((equal op ?>) '>=)
  6645. ((equal op ??) op)
  6646. (t '=)))
  6647. (list 'org-agenda-compare-effort (list 'quote op)
  6648. (org-duration-string-to-minutes e))))
  6649. (defun org-agenda-compare-effort (op value)
  6650. "Compare the effort of the current line with VALUE, using OP.
  6651. If the line does not have an effort defined, return nil."
  6652. (let ((eff (org-get-at-bol 'effort-minutes)))
  6653. (if (equal op ??)
  6654. (not eff)
  6655. (funcall op (or eff (if org-sort-agenda-noeffort-is-high 32767 0))
  6656. value))))
  6657. (defun org-agenda-filter-apply (filter type)
  6658. "Set FILTER as the new agenda filter and apply it."
  6659. (let (tags cat)
  6660. (if (eq type 'tag)
  6661. (setq org-agenda-tag-filter filter)
  6662. (setq org-agenda-category-filter filter))
  6663. (setq org-agenda-filter-form (org-agenda-filter-make-matcher))
  6664. (if (and (eq type 'category)
  6665. (not (equal (substring (car filter) 0 1) "-")))
  6666. ;; Only set `org-agenda-filtered-by-category' to t
  6667. ;; when a unique category is used as the filter
  6668. (setq org-agenda-filtered-by-category t))
  6669. (org-agenda-set-mode-name)
  6670. (save-excursion
  6671. (goto-char (point-min))
  6672. (while (not (eobp))
  6673. (if (org-get-at-bol 'org-marker)
  6674. (progn
  6675. (setq tags (org-get-at-bol 'tags) ; used in eval
  6676. cat (get-text-property (point) 'org-category))
  6677. (if (not (eval org-agenda-filter-form))
  6678. (org-agenda-filter-hide-line type))
  6679. (beginning-of-line 2))
  6680. (beginning-of-line 2))))
  6681. (if (get-char-property (point) 'invisible)
  6682. (ignore-errors (org-agenda-previous-line)))))
  6683. (defun org-agenda-filter-top-category-apply (category &optional negative)
  6684. "Set FILTER as the new agenda filter and apply it."
  6685. (org-agenda-set-mode-name)
  6686. (save-excursion
  6687. (goto-char (point-min))
  6688. (while (not (eobp))
  6689. (let* ((pos (org-get-at-bol 'org-hd-marker))
  6690. (topcat (and pos (org-find-top-category pos))))
  6691. (if (and topcat (funcall (if negative 'identity 'not)
  6692. (string= category topcat)))
  6693. (org-agenda-filter-hide-line 'category)))
  6694. (beginning-of-line 2)))
  6695. (if (get-char-property (point) 'invisible)
  6696. (org-agenda-previous-line))
  6697. (setq org-agenda-top-category-filter category
  6698. org-agenda-filtered-by-top-category t))
  6699. (defun org-agenda-filter-hide-line (type)
  6700. (let (ov)
  6701. (setq ov (make-overlay (max (point-min) (1- (point-at-bol)))
  6702. (point-at-eol)))
  6703. (overlay-put ov 'invisible t)
  6704. (overlay-put ov 'type type)
  6705. (if (eq type 'tag)
  6706. (push ov org-agenda-tag-filter-overlays)
  6707. (push ov org-agenda-cat-filter-overlays))))
  6708. (defun org-agenda-fix-tags-filter-overlays-at (&optional pos)
  6709. (setq pos (or pos (point)))
  6710. (save-excursion
  6711. (dolist (ov (overlays-at pos))
  6712. (when (and (overlay-get ov 'invisible)
  6713. (eq (overlay-get ov 'type) 'tag))
  6714. (goto-char pos)
  6715. (if (< (overlay-start ov) (point-at-eol))
  6716. (move-overlay ov (point-at-eol)
  6717. (overlay-end ov)))))))
  6718. (defun org-agenda-filter-show-all-tag nil
  6719. (mapc 'delete-overlay org-agenda-tag-filter-overlays)
  6720. (setq org-agenda-tag-filter-overlays nil
  6721. org-agenda-tag-filter nil
  6722. org-agenda-filter-form nil)
  6723. (org-agenda-set-mode-name))
  6724. (defun org-agenda-filter-show-all-cat nil
  6725. (mapc 'delete-overlay org-agenda-cat-filter-overlays)
  6726. (setq org-agenda-cat-filter-overlays nil
  6727. org-agenda-filtered-by-category nil
  6728. org-agenda-category-filter nil
  6729. org-agenda-filter-form nil)
  6730. (org-agenda-set-mode-name))
  6731. (defun org-agenda-manipulate-query-add ()
  6732. "Manipulate the query by adding a search term with positive selection.
  6733. Positive selection means the term must be matched for selection of an entry."
  6734. (interactive)
  6735. (org-agenda-manipulate-query ?\[))
  6736. (defun org-agenda-manipulate-query-subtract ()
  6737. "Manipulate the query by adding a search term with negative selection.
  6738. Negative selection means term must not be matched for selection of an entry."
  6739. (interactive)
  6740. (org-agenda-manipulate-query ?\]))
  6741. (defun org-agenda-manipulate-query-add-re ()
  6742. "Manipulate the query by adding a search regexp with positive selection.
  6743. Positive selection means the regexp must match for selection of an entry."
  6744. (interactive)
  6745. (org-agenda-manipulate-query ?\{))
  6746. (defun org-agenda-manipulate-query-subtract-re ()
  6747. "Manipulate the query by adding a search regexp with negative selection.
  6748. Negative selection means regexp must not match for selection of an entry."
  6749. (interactive)
  6750. (org-agenda-manipulate-query ?\}))
  6751. (defun org-agenda-manipulate-query (char)
  6752. (cond
  6753. ((memq org-agenda-type '(timeline agenda))
  6754. (let ((org-agenda-include-inactive-timestamps t))
  6755. (org-agenda-redo))
  6756. (message "Display now includes inactive timestamps as well"))
  6757. ((eq org-agenda-type 'search)
  6758. (org-add-to-string
  6759. 'org-agenda-query-string
  6760. (if org-agenda-last-search-view-search-was-boolean
  6761. (cdr (assoc char '((?\[ . " +") (?\] . " -")
  6762. (?\{ . " +{}") (?\} . " -{}"))))
  6763. " "))
  6764. (setq org-agenda-redo-command
  6765. (list 'org-search-view
  6766. (car (get-text-property (min (1- (point-max)) (point))
  6767. 'org-last-args))
  6768. org-agenda-query-string
  6769. (+ (length org-agenda-query-string)
  6770. (if (member char '(?\{ ?\})) 0 1))))
  6771. (set-register org-agenda-query-register org-agenda-query-string)
  6772. (let ((org-agenda-overriding-arguments
  6773. (cdr org-agenda-redo-command)))
  6774. (org-agenda-redo)))
  6775. (t (error "Cannot manipulate query for %s-type agenda buffers"
  6776. org-agenda-type))))
  6777. (defun org-add-to-string (var string)
  6778. (set var (concat (symbol-value var) string)))
  6779. (defun org-agenda-goto-date (span)
  6780. "Jump to DATE in agenda."
  6781. (interactive "P")
  6782. (let* ((org-read-date-prefer-future
  6783. (eval org-agenda-jump-prefer-future))
  6784. (date (org-read-date))
  6785. (org-agenda-sticky-orig org-agenda-sticky)
  6786. (org-agenda-buffer-tmp-name (buffer-name))
  6787. (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  6788. (0-arg (or current-prefix-arg (car args)))
  6789. (2-arg (nth 2 args))
  6790. (newcmd (list 'org-agenda-list 0-arg date
  6791. (org-agenda-span-to-ndays 2-arg)))
  6792. (newargs (cdr newcmd))
  6793. (inhibit-read-only t)
  6794. org-agenda-sticky)
  6795. (if (not (org-agenda-check-type t 'agenda))
  6796. (error "Not available in non-agenda blocks")
  6797. (add-text-properties (point-min) (point-max)
  6798. `(org-redo-cmd ,newcmd org-last-args ,newargs))
  6799. (org-agenda-redo)
  6800. (setq org-agenda-sticky org-agenda-sticky-orig
  6801. org-agenda-this-buffer-is-sticky org-agenda-sticky))))
  6802. (defun org-agenda-goto-today ()
  6803. "Go to today."
  6804. (interactive)
  6805. (org-agenda-check-type t 'timeline 'agenda)
  6806. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  6807. (curspan (nth 2 args))
  6808. (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
  6809. (cond
  6810. (tdpos (goto-char tdpos))
  6811. ((eq org-agenda-type 'agenda)
  6812. (let* ((sd (org-agenda-compute-starting-span
  6813. (org-today) (or curspan org-agenda-ndays org-agenda-span)))
  6814. (org-agenda-overriding-arguments args))
  6815. (setf (nth 1 org-agenda-overriding-arguments) sd)
  6816. (org-agenda-redo)
  6817. (org-agenda-find-same-or-today-or-agenda)))
  6818. (t (error "Cannot find today")))))
  6819. (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
  6820. (goto-char
  6821. (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
  6822. (text-property-any (point-min) (point-max) 'org-today t)
  6823. (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
  6824. (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
  6825. (org-agenda-goto-block-beginning))
  6826. (point-min))))
  6827. (defun org-agenda-goto-block-beginning ()
  6828. "Go the agenda block beginning."
  6829. (interactive)
  6830. (if (not (derived-mode-p 'org-agenda-mode))
  6831. (error "Cannot execute this command outside of org-agenda-mode buffers")
  6832. (let (dest)
  6833. (save-excursion
  6834. (unless (looking-at "\\'")
  6835. (forward-char))
  6836. (let* ((prop 'org-agenda-structural-header)
  6837. (p (previous-single-property-change (point) prop))
  6838. (n (next-single-property-change (or (and (looking-at "\\`") 1)
  6839. (1- (point))) prop)))
  6840. (setq dest (cond ((eq n (point-at-eol)) (1- n)) (p (1- p))))))
  6841. (if (not dest)
  6842. (error "Cannot find the beginning of the blog")
  6843. (goto-char dest)
  6844. (move-beginning-of-line 1)))))
  6845. (defun org-agenda-later (arg)
  6846. "Go forward in time by the current span.
  6847. With prefix ARG, go forward that many times the current span."
  6848. (interactive "p")
  6849. (org-agenda-check-type t 'agenda)
  6850. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  6851. (span (or (nth 2 args) org-agenda-current-span))
  6852. (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
  6853. (greg (calendar-gregorian-from-absolute sd))
  6854. (cnt (org-get-at-bol 'org-day-cnt))
  6855. greg2)
  6856. (cond
  6857. ((numberp span)
  6858. (setq sd (+ (* span arg) sd)))
  6859. ((eq span 'day)
  6860. (setq sd (+ arg sd)))
  6861. ((eq span 'week)
  6862. (setq sd (+ (* 7 arg) sd)))
  6863. ((eq span 'month)
  6864. (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
  6865. sd (calendar-absolute-from-gregorian greg2))
  6866. (setcar greg2 (1+ (car greg2))))
  6867. ((eq span 'year)
  6868. (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
  6869. sd (calendar-absolute-from-gregorian greg2))
  6870. (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
  6871. (t
  6872. (setq sd (+ (* span arg) sd))))
  6873. (let ((org-agenda-overriding-cmd
  6874. ;; `cmd' may have been set by `org-agenda-run-series' which
  6875. ;; uses `org-agenda-overriding-cmd' to decide whether
  6876. ;; overriding is allowed for `cmd'
  6877. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  6878. (org-agenda-overriding-arguments
  6879. (list (car args) sd span)))
  6880. (org-agenda-redo)
  6881. (org-agenda-find-same-or-today-or-agenda cnt))))
  6882. (defun org-agenda-earlier (arg)
  6883. "Go backward in time by the current span.
  6884. With prefix ARG, go backward that many times the current span."
  6885. (interactive "p")
  6886. (org-agenda-later (- arg)))
  6887. (defun org-agenda-view-mode-dispatch ()
  6888. "Call one of the view mode commands."
  6889. (interactive)
  6890. (message "View: [d]ay [w]eek [m]onth [y]ear [SPC]reset [q]uit/abort
  6891. time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
  6892. [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
  6893. (let ((a (read-char-exclusive)))
  6894. (case a
  6895. (?\ (call-interactively 'org-agenda-reset-view))
  6896. (?d (call-interactively 'org-agenda-day-view))
  6897. (?w (call-interactively 'org-agenda-week-view))
  6898. (?m (call-interactively 'org-agenda-month-view))
  6899. (?y (call-interactively 'org-agenda-year-view))
  6900. (?l (call-interactively 'org-agenda-log-mode))
  6901. (?L (org-agenda-log-mode '(4)))
  6902. (?c (org-agenda-log-mode 'clockcheck))
  6903. ((?F ?f) (call-interactively 'org-agenda-follow-mode))
  6904. (?a (call-interactively 'org-agenda-archives-mode))
  6905. (?A (org-agenda-archives-mode 'files))
  6906. ((?R ?r) (call-interactively 'org-agenda-clockreport-mode))
  6907. ((?E ?e) (call-interactively 'org-agenda-entry-text-mode))
  6908. (?G (call-interactively 'org-agenda-toggle-time-grid))
  6909. (?D (call-interactively 'org-agenda-toggle-diary))
  6910. (?\! (call-interactively 'org-agenda-toggle-deadlines))
  6911. (?\[ (let ((org-agenda-include-inactive-timestamps t))
  6912. (org-agenda-check-type t 'timeline 'agenda)
  6913. (org-agenda-redo))
  6914. (message "Display now includes inactive timestamps as well"))
  6915. (?q (message "Abort"))
  6916. (otherwise (error "Invalid key" )))))
  6917. (defun org-agenda-reset-view ()
  6918. "Switch to default view for agenda."
  6919. (interactive)
  6920. (org-agenda-change-time-span (or org-agenda-ndays org-agenda-span)))
  6921. (defun org-agenda-day-view (&optional day-of-year)
  6922. "Switch to daily view for agenda.
  6923. With argument DAY-OF-YEAR, switch to that day of the year."
  6924. (interactive "P")
  6925. (org-agenda-change-time-span 'day day-of-year))
  6926. (defun org-agenda-week-view (&optional iso-week)
  6927. "Switch to daily view for agenda.
  6928. With argument ISO-WEEK, switch to the corresponding ISO week.
  6929. If ISO-WEEK has more then 2 digits, only the last two encode the
  6930. week. Any digits before this encode a year. So 200712 means
  6931. week 12 of year 2007. Years in the range 1938-2037 can also be
  6932. written as 2-digit years."
  6933. (interactive "P")
  6934. (org-agenda-change-time-span 'week iso-week))
  6935. (defun org-agenda-month-view (&optional month)
  6936. "Switch to monthly view for agenda.
  6937. With argument MONTH, switch to that month."
  6938. (interactive "P")
  6939. (org-agenda-change-time-span 'month month))
  6940. (defun org-agenda-year-view (&optional year)
  6941. "Switch to yearly view for agenda.
  6942. With argument YEAR, switch to that year.
  6943. If MONTH has more then 2 digits, only the last two encode the
  6944. month. Any digits before this encode a year. So 200712 means
  6945. December year 2007. Years in the range 1938-2037 can also be
  6946. written as 2-digit years."
  6947. (interactive "P")
  6948. (when year
  6949. (setq year (org-small-year-to-year year)))
  6950. (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
  6951. (org-agenda-change-time-span 'year year)
  6952. (error "Abort")))
  6953. (defun org-agenda-change-time-span (span &optional n)
  6954. "Change the agenda view to SPAN.
  6955. SPAN may be `day', `week', `month', `year'."
  6956. (org-agenda-check-type t 'agenda)
  6957. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  6958. (curspan (nth 2 args)))
  6959. (if (and (not n) (equal curspan span))
  6960. (error "Viewing span is already \"%s\"" span))
  6961. (let* ((sd (or (org-get-at-bol 'day)
  6962. (nth 1 args)
  6963. org-starting-day))
  6964. (sd (org-agenda-compute-starting-span sd span n))
  6965. (org-agenda-overriding-cmd
  6966. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  6967. (org-agenda-overriding-arguments
  6968. (list (car args) sd span)))
  6969. (org-agenda-redo)
  6970. (org-agenda-find-same-or-today-or-agenda))
  6971. (org-agenda-set-mode-name)
  6972. (message "Switched to %s view" span)))
  6973. (defun org-agenda-compute-starting-span (sd span &optional n)
  6974. "Compute starting date for agenda.
  6975. SPAN may be `day', `week', `month', `year'. The return value
  6976. is a cons cell with the starting date and the number of days,
  6977. so that the date SD will be in that range."
  6978. (let* ((greg (calendar-gregorian-from-absolute sd))
  6979. (dg (nth 1 greg))
  6980. (mg (car greg))
  6981. (yg (nth 2 greg)))
  6982. (cond
  6983. ((eq span 'day)
  6984. (when n
  6985. (setq sd (+ (calendar-absolute-from-gregorian
  6986. (list mg 1 yg))
  6987. n -1))))
  6988. ((eq span 'week)
  6989. (let* ((nt (calendar-day-of-week
  6990. (calendar-gregorian-from-absolute sd)))
  6991. (d (if org-agenda-start-on-weekday
  6992. (- nt org-agenda-start-on-weekday)
  6993. 0))
  6994. y1)
  6995. (setq sd (- sd (+ (if (< d 0) 7 0) d)))
  6996. (when n
  6997. (require 'cal-iso)
  6998. (when (> n 99)
  6999. (setq y1 (org-small-year-to-year (/ n 100))
  7000. n (mod n 100)))
  7001. (setq sd
  7002. (calendar-absolute-from-iso
  7003. (list n 1
  7004. (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
  7005. ((eq span 'month)
  7006. (let (y1)
  7007. (when (and n (> n 99))
  7008. (setq y1 (org-small-year-to-year (/ n 100))
  7009. n (mod n 100)))
  7010. (setq sd (calendar-absolute-from-gregorian
  7011. (list (or n mg) 1 (or y1 yg))))))
  7012. ((eq span 'year)
  7013. (setq sd (calendar-absolute-from-gregorian
  7014. (list 1 1 (or n yg))))))
  7015. sd))
  7016. (defun org-agenda-next-date-line (&optional arg)
  7017. "Jump to the next line indicating a date in agenda buffer."
  7018. (interactive "p")
  7019. (org-agenda-check-type t 'agenda 'timeline)
  7020. (beginning-of-line 1)
  7021. ;; This does not work if user makes date format that starts with a blank
  7022. (if (looking-at "^\\S-") (forward-char 1))
  7023. (if (not (re-search-forward "^\\S-" nil t arg))
  7024. (progn
  7025. (backward-char 1)
  7026. (error "No next date after this line in this buffer")))
  7027. (goto-char (match-beginning 0)))
  7028. (defun org-agenda-previous-date-line (&optional arg)
  7029. "Jump to the previous line indicating a date in agenda buffer."
  7030. (interactive "p")
  7031. (org-agenda-check-type t 'agenda 'timeline)
  7032. (beginning-of-line 1)
  7033. (if (not (re-search-backward "^\\S-" nil t arg))
  7034. (error "No previous date before this line in this buffer")))
  7035. ;; Initialize the highlight
  7036. (defvar org-hl (make-overlay 1 1))
  7037. (overlay-put org-hl 'face 'highlight)
  7038. (defun org-highlight (begin end &optional buffer)
  7039. "Highlight a region with overlay."
  7040. (move-overlay org-hl begin end (or buffer (current-buffer))))
  7041. (defun org-unhighlight ()
  7042. "Detach overlay INDEX."
  7043. (org-detach-overlay org-hl))
  7044. (defun org-unhighlight-once ()
  7045. "Remove the highlight from its position, and this function from the hook."
  7046. (remove-hook 'pre-command-hook 'org-unhighlight-once)
  7047. (org-unhighlight))
  7048. (defvar org-agenda-pre-follow-window-conf nil)
  7049. (defun org-agenda-follow-mode ()
  7050. "Toggle follow mode in an agenda buffer."
  7051. (interactive)
  7052. (unless org-agenda-follow-mode
  7053. (setq org-agenda-pre-follow-window-conf
  7054. (current-window-configuration)))
  7055. (setq org-agenda-follow-mode (not org-agenda-follow-mode))
  7056. (unless org-agenda-follow-mode
  7057. (set-window-configuration org-agenda-pre-follow-window-conf))
  7058. (org-agenda-set-mode-name)
  7059. (org-agenda-do-context-action)
  7060. (message "Follow mode is %s"
  7061. (if org-agenda-follow-mode "on" "off")))
  7062. (defun org-agenda-entry-text-mode (&optional arg)
  7063. "Toggle entry text mode in an agenda buffer."
  7064. (interactive "P")
  7065. (setq org-agenda-entry-text-mode (or (integerp arg)
  7066. (not org-agenda-entry-text-mode)))
  7067. (org-agenda-entry-text-hide)
  7068. (and org-agenda-entry-text-mode
  7069. (let ((org-agenda-entry-text-maxlines
  7070. (if (integerp arg) arg org-agenda-entry-text-maxlines)))
  7071. (org-agenda-entry-text-show)))
  7072. (org-agenda-set-mode-name)
  7073. (message "Entry text mode is %s. Maximum number of lines is %d"
  7074. (if org-agenda-entry-text-mode "on" "off")
  7075. (if (integerp arg) arg org-agenda-entry-text-maxlines)))
  7076. (defun org-agenda-clockreport-mode (&optional with-filter)
  7077. "Toggle clocktable mode in an agenda buffer.
  7078. With prefix arg WITH-FILTER, make the clocktable respect the current
  7079. agenda filter."
  7080. (interactive "P")
  7081. (org-agenda-check-type t 'agenda)
  7082. (if with-filter
  7083. (setq org-agenda-clockreport-mode 'with-filter)
  7084. (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode)))
  7085. (org-agenda-set-mode-name)
  7086. (org-agenda-redo)
  7087. (message "Clocktable mode is %s"
  7088. (if org-agenda-clockreport-mode "on" "off")))
  7089. (defun org-agenda-log-mode (&optional special)
  7090. "Toggle log mode in an agenda buffer.
  7091. With argument SPECIAL, show all possible log items, not only the ones
  7092. configured in `org-agenda-log-mode-items'.
  7093. With a double `C-u' prefix arg, show *only* log items, nothing else."
  7094. (interactive "P")
  7095. (org-agenda-check-type t 'agenda 'timeline)
  7096. (setq org-agenda-show-log
  7097. (cond
  7098. ((equal special '(16)) 'only)
  7099. ((eq special 'clockcheck)
  7100. (if (eq org-agenda-show-log 'clockcheck)
  7101. nil 'clockcheck))
  7102. (special '(closed clock state))
  7103. (t (not org-agenda-show-log))))
  7104. (org-agenda-set-mode-name)
  7105. (org-agenda-redo)
  7106. (message "Log mode is %s"
  7107. (if org-agenda-show-log "on" "off")))
  7108. (defun org-agenda-archives-mode (&optional with-files)
  7109. "Toggle inclusion of items in trees marked with :ARCHIVE:.
  7110. When called with a prefix argument, include all archive files as well."
  7111. (interactive "P")
  7112. (setq org-agenda-archives-mode
  7113. (if with-files t (if org-agenda-archives-mode nil 'trees)))
  7114. (org-agenda-set-mode-name)
  7115. (org-agenda-redo)
  7116. (message
  7117. "%s"
  7118. (cond
  7119. ((eq org-agenda-archives-mode nil)
  7120. "No archives are included")
  7121. ((eq org-agenda-archives-mode 'trees)
  7122. (format "Trees with :%s: tag are included" org-archive-tag))
  7123. ((eq org-agenda-archives-mode t)
  7124. (format "Trees with :%s: tag and all active archive files are included"
  7125. org-archive-tag)))))
  7126. (defun org-agenda-toggle-diary ()
  7127. "Toggle diary inclusion in an agenda buffer."
  7128. (interactive)
  7129. (org-agenda-check-type t 'agenda)
  7130. (setq org-agenda-include-diary (not org-agenda-include-diary))
  7131. (org-agenda-redo)
  7132. (org-agenda-set-mode-name)
  7133. (message "Diary inclusion turned %s"
  7134. (if org-agenda-include-diary "on" "off")))
  7135. (defun org-agenda-toggle-deadlines ()
  7136. "Toggle inclusion of entries with a deadline in an agenda buffer."
  7137. (interactive)
  7138. (org-agenda-check-type t 'agenda)
  7139. (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
  7140. (org-agenda-redo)
  7141. (org-agenda-set-mode-name)
  7142. (message "Deadlines inclusion turned %s"
  7143. (if org-agenda-include-deadlines "on" "off")))
  7144. (defun org-agenda-toggle-time-grid ()
  7145. "Toggle time grid in an agenda buffer."
  7146. (interactive)
  7147. (org-agenda-check-type t 'agenda)
  7148. (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
  7149. (org-agenda-redo)
  7150. (org-agenda-set-mode-name)
  7151. (message "Time-grid turned %s"
  7152. (if org-agenda-use-time-grid "on" "off")))
  7153. (defun org-agenda-set-mode-name ()
  7154. "Set the mode name to indicate all the small mode settings."
  7155. (setq mode-name
  7156. (list "Org-Agenda"
  7157. (if (get 'org-agenda-files 'org-restrict) " []" "")
  7158. " "
  7159. '(:eval (org-agenda-span-name org-agenda-current-span))
  7160. (if org-agenda-follow-mode " Follow" "")
  7161. (if org-agenda-entry-text-mode " ETxt" "")
  7162. (if org-agenda-include-diary " Diary" "")
  7163. (if org-agenda-include-deadlines " Ddl" "")
  7164. (if org-agenda-use-time-grid " Grid" "")
  7165. (if (and (boundp 'org-habit-show-habits)
  7166. org-habit-show-habits) " Habit" "")
  7167. (cond
  7168. ((consp org-agenda-show-log) " LogAll")
  7169. ((eq org-agenda-show-log 'clockcheck) " ClkCk")
  7170. (org-agenda-show-log " Log")
  7171. (t ""))
  7172. (if (or org-agenda-category-filter (get 'org-agenda-category-filter
  7173. :preset-filter))
  7174. '(:eval (org-propertize
  7175. (concat " <"
  7176. (mapconcat
  7177. 'identity
  7178. (append
  7179. (get 'org-agenda-category-filter :preset-filter)
  7180. org-agenda-category-filter)
  7181. "")
  7182. ">")
  7183. 'face 'org-agenda-filter-category
  7184. 'help-echo "Category used in filtering"))
  7185. "")
  7186. (if (or org-agenda-tag-filter (get 'org-agenda-tag-filter
  7187. :preset-filter))
  7188. '(:eval (org-propertize
  7189. (concat " {"
  7190. (mapconcat
  7191. 'identity
  7192. (append
  7193. (get 'org-agenda-tag-filter :preset-filter)
  7194. org-agenda-tag-filter)
  7195. "")
  7196. "}")
  7197. 'face 'org-agenda-filter-tags
  7198. 'help-echo "Tags used in filtering"))
  7199. "")
  7200. (if org-agenda-archives-mode
  7201. (if (eq org-agenda-archives-mode t)
  7202. " Archives"
  7203. (format " :%s:" org-archive-tag))
  7204. "")
  7205. (if org-agenda-clockreport-mode
  7206. (if (eq org-agenda-clockreport-mode 'with-filter)
  7207. " Clock{}" " Clock")
  7208. "")))
  7209. (force-mode-line-update))
  7210. (define-obsolete-function-alias
  7211. 'org-agenda-post-command-hook 'org-agenda-update-agenda-type "24.3")
  7212. (defun org-agenda-update-agenda-type ()
  7213. "Update the agenda type after each command."
  7214. (setq org-agenda-type
  7215. (or (get-text-property (point) 'org-agenda-type)
  7216. (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
  7217. (defun org-agenda-next-line ()
  7218. "Move cursor to the next line, and show if follow mode is active."
  7219. (interactive)
  7220. (call-interactively 'next-line)
  7221. (org-agenda-do-context-action))
  7222. (defun org-agenda-previous-line ()
  7223. "Move cursor to the previous line, and show if follow-mode is active."
  7224. (interactive)
  7225. (call-interactively 'previous-line)
  7226. (org-agenda-do-context-action))
  7227. (defun org-agenda-next-item (n)
  7228. "Move cursor to next agenda item."
  7229. (interactive "p")
  7230. (let ((col (current-column)))
  7231. (dotimes (c n)
  7232. (when (next-single-property-change (point-at-eol) 'org-marker)
  7233. (move-end-of-line 1)
  7234. (goto-char (next-single-property-change (point) 'org-marker))))
  7235. (org-move-to-column col))
  7236. (org-agenda-do-context-action))
  7237. (defun org-agenda-previous-item (n)
  7238. "Move cursor to next agenda item."
  7239. (interactive "p")
  7240. (dotimes (c n)
  7241. (let ((col (current-column))
  7242. (goto (save-excursion
  7243. (move-end-of-line 0)
  7244. (previous-single-property-change (point) 'org-marker))))
  7245. (if goto (goto-char goto))
  7246. (org-move-to-column col)))
  7247. (org-agenda-do-context-action))
  7248. (defun org-agenda-do-context-action ()
  7249. "Show outline path and, maybe, follow mode window."
  7250. (let ((m (org-get-at-bol 'org-marker)))
  7251. (when (and (markerp m) (marker-buffer m))
  7252. (and org-agenda-follow-mode
  7253. (if org-agenda-follow-indirect
  7254. (org-agenda-tree-to-indirect-buffer nil)
  7255. (org-agenda-show)))
  7256. (and org-agenda-show-outline-path
  7257. (org-with-point-at m (org-display-outline-path t))))))
  7258. (defun org-agenda-show-tags ()
  7259. "Show the tags applicable to the current item."
  7260. (interactive)
  7261. (let* ((tags (org-get-at-bol 'tags)))
  7262. (if tags
  7263. (message "Tags are :%s:"
  7264. (org-no-properties (mapconcat 'identity tags ":")))
  7265. (message "No tags associated with this line"))))
  7266. (defun org-agenda-goto (&optional highlight)
  7267. "Go to the Org-mode file which contains the item at point."
  7268. (interactive)
  7269. (let* ((marker (or (org-get-at-bol 'org-marker)
  7270. (org-agenda-error)))
  7271. (buffer (marker-buffer marker))
  7272. (pos (marker-position marker)))
  7273. (switch-to-buffer-other-window buffer)
  7274. (widen)
  7275. (push-mark)
  7276. (goto-char pos)
  7277. (when (derived-mode-p 'org-mode)
  7278. (org-show-context 'agenda)
  7279. (save-excursion
  7280. (and (outline-next-heading)
  7281. (org-flag-heading nil)))) ; show the next heading
  7282. (when (outline-invisible-p)
  7283. (show-entry)) ; display invisible text
  7284. (recenter (/ (window-height) 2))
  7285. (run-hooks 'org-agenda-after-show-hook)
  7286. (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
  7287. (defvar org-agenda-after-show-hook nil
  7288. "Normal hook run after an item has been shown from the agenda.
  7289. Point is in the buffer where the item originated.")
  7290. (defun org-agenda-kill ()
  7291. "Kill the entry or subtree belonging to the current agenda entry."
  7292. (interactive)
  7293. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  7294. (let* ((bufname-orig (buffer-name))
  7295. (marker (or (org-get-at-bol 'org-marker)
  7296. (org-agenda-error)))
  7297. (buffer (marker-buffer marker))
  7298. (pos (marker-position marker))
  7299. (type (org-get-at-bol 'type))
  7300. dbeg dend (n 0) conf)
  7301. (org-with-remote-undo buffer
  7302. (with-current-buffer buffer
  7303. (save-excursion
  7304. (goto-char pos)
  7305. (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
  7306. (setq dbeg (progn (org-back-to-heading t) (point))
  7307. dend (org-end-of-subtree t t))
  7308. (setq dbeg (point-at-bol)
  7309. dend (min (point-max) (1+ (point-at-eol)))))
  7310. (goto-char dbeg)
  7311. (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
  7312. (setq conf (or (eq t org-agenda-confirm-kill)
  7313. (and (numberp org-agenda-confirm-kill)
  7314. (> n org-agenda-confirm-kill))))
  7315. (and conf
  7316. (not (y-or-n-p
  7317. (format "Delete entry with %d lines in buffer \"%s\"? "
  7318. n (buffer-name buffer))))
  7319. (error "Abort"))
  7320. (let ((org-agenda-buffer-name bufname-orig))
  7321. (org-remove-subtree-entries-from-agenda buffer dbeg dend))
  7322. (with-current-buffer buffer (delete-region dbeg dend))
  7323. (message "Agenda item and source killed"))))
  7324. (defvar org-archive-default-command) ; defined in org-archive.el
  7325. (defun org-agenda-archive-default ()
  7326. "Archive the entry or subtree belonging to the current agenda entry."
  7327. (interactive)
  7328. (require 'org-archive)
  7329. (org-agenda-archive-with org-archive-default-command))
  7330. (defun org-agenda-archive-default-with-confirmation ()
  7331. "Archive the entry or subtree belonging to the current agenda entry."
  7332. (interactive)
  7333. (require 'org-archive)
  7334. (org-agenda-archive-with org-archive-default-command 'confirm))
  7335. (defun org-agenda-archive ()
  7336. "Archive the entry or subtree belonging to the current agenda entry."
  7337. (interactive)
  7338. (org-agenda-archive-with 'org-archive-subtree))
  7339. (defun org-agenda-archive-to-archive-sibling ()
  7340. "Move the entry to the archive sibling."
  7341. (interactive)
  7342. (org-agenda-archive-with 'org-archive-to-archive-sibling))
  7343. (defun org-agenda-archive-with (cmd &optional confirm)
  7344. "Move the entry to the archive sibling."
  7345. (interactive)
  7346. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  7347. (let* ((bufname-orig (buffer-name))
  7348. (marker (or (org-get-at-bol 'org-marker)
  7349. (org-agenda-error)))
  7350. (buffer (marker-buffer marker))
  7351. (pos (marker-position marker)))
  7352. (org-with-remote-undo buffer
  7353. (with-current-buffer buffer
  7354. (if (derived-mode-p 'org-mode)
  7355. (if (and confirm
  7356. (not (y-or-n-p "Archive this subtree or entry? ")))
  7357. (error "Abort")
  7358. (save-excursion
  7359. (goto-char pos)
  7360. (let ((org-agenda-buffer-name bufname-orig))
  7361. (org-remove-subtree-entries-from-agenda))
  7362. (org-back-to-heading t)
  7363. (funcall cmd)))
  7364. (error "Archiving works only in Org-mode files"))))))
  7365. (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
  7366. "Remove all lines in the agenda that correspond to a given subtree.
  7367. The subtree is the one in buffer BUF, starting at BEG and ending at END.
  7368. If this information is not given, the function uses the tree at point."
  7369. (let ((buf (or buf (current-buffer))) m p)
  7370. (save-excursion
  7371. (unless (and beg end)
  7372. (org-back-to-heading t)
  7373. (setq beg (point))
  7374. (org-end-of-subtree t)
  7375. (setq end (point)))
  7376. (set-buffer (get-buffer org-agenda-buffer-name))
  7377. (save-excursion
  7378. (goto-char (point-max))
  7379. (beginning-of-line 1)
  7380. (while (not (bobp))
  7381. (when (and (setq m (org-get-at-bol 'org-marker))
  7382. (equal buf (marker-buffer m))
  7383. (setq p (marker-position m))
  7384. (>= p beg)
  7385. (< p end))
  7386. (let ((inhibit-read-only t))
  7387. (delete-region (point-at-bol) (1+ (point-at-eol)))))
  7388. (beginning-of-line 0))))))
  7389. (defun org-agenda-refile (&optional goto rfloc no-update)
  7390. "Refile the item at point."
  7391. (interactive "P")
  7392. (if (equal goto '(16))
  7393. (org-refile-goto-last-stored)
  7394. (let* ((buffer-orig (buffer-name))
  7395. (marker (or (org-get-at-bol 'org-hd-marker)
  7396. (org-agenda-error)))
  7397. (buffer (marker-buffer marker))
  7398. (pos (marker-position marker))
  7399. (rfloc (or rfloc
  7400. (org-refile-get-location
  7401. (if goto "Goto" "Refile to") buffer
  7402. org-refile-allow-creating-parent-nodes))))
  7403. (with-current-buffer buffer
  7404. (save-excursion
  7405. (save-restriction
  7406. (widen)
  7407. (goto-char marker)
  7408. (let ((org-agenda-buffer-name buffer-orig))
  7409. (org-remove-subtree-entries-from-agenda))
  7410. (org-refile goto buffer rfloc)))))
  7411. (unless no-update (org-agenda-redo))))
  7412. (defun org-agenda-open-link (&optional arg)
  7413. "Open the link(s) in the current entry, if any.
  7414. This looks for a link in the displayed line in the agenda.
  7415. It also looks at the text of the entry itself."
  7416. (interactive "P")
  7417. (let* ((marker (or (org-get-at-bol 'org-hd-marker)
  7418. (org-get-at-bol 'org-marker)))
  7419. (buffer (and marker (marker-buffer marker)))
  7420. (prefix (buffer-substring
  7421. (point-at-bol) (point-at-eol)))
  7422. (lkall (org-offer-links-in-entry buffer marker arg prefix))
  7423. (lk (car lkall))
  7424. (lkend (cdr lkall))
  7425. trg)
  7426. (cond
  7427. ((and buffer (stringp lk))
  7428. (with-current-buffer buffer
  7429. (setq trg (and (string-match org-bracket-link-regexp lk)
  7430. (match-string 1 lk)))
  7431. (if (or (not trg) (string-match org-any-link-re trg))
  7432. (save-excursion
  7433. (save-restriction
  7434. (widen)
  7435. (goto-char marker)
  7436. (when (search-forward lk nil lkend)
  7437. (goto-char (match-beginning 0))
  7438. (org-open-at-point))))
  7439. ;; This is an internal link, widen the buffer
  7440. (switch-to-buffer-other-window buffer)
  7441. (widen)
  7442. (goto-char marker)
  7443. (when (search-forward lk nil lkend)
  7444. (goto-char (match-beginning 0))
  7445. (org-open-at-point)))))
  7446. ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
  7447. (save-excursion
  7448. (beginning-of-line 1)
  7449. (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
  7450. (org-open-link-from-string (match-string 1)))
  7451. (t (message "No link to open here")))))
  7452. (defun org-agenda-copy-local-variable (var)
  7453. "Get a variable from a referenced buffer and install it here."
  7454. (let ((m (org-get-at-bol 'org-marker)))
  7455. (when (and m (buffer-live-p (marker-buffer m)))
  7456. (org-set-local var (with-current-buffer (marker-buffer m)
  7457. (symbol-value var))))))
  7458. (defun org-agenda-switch-to (&optional delete-other-windows)
  7459. "Go to the Org-mode file which contains the item at point."
  7460. (interactive)
  7461. (if (and org-return-follows-link
  7462. (not (org-get-at-bol 'org-marker))
  7463. (org-in-regexp org-bracket-link-regexp))
  7464. (org-open-link-from-string (match-string 0))
  7465. (let* ((marker (or (org-get-at-bol 'org-marker)
  7466. (org-agenda-error)))
  7467. (buffer (marker-buffer marker))
  7468. (pos (marker-position marker)))
  7469. (org-pop-to-buffer-same-window buffer)
  7470. (and delete-other-windows (delete-other-windows))
  7471. (widen)
  7472. (goto-char pos)
  7473. (when (derived-mode-p 'org-mode)
  7474. (org-show-context 'agenda)
  7475. (save-excursion
  7476. (and (outline-next-heading)
  7477. (org-flag-heading nil))) ; show the next heading
  7478. (when (outline-invisible-p)
  7479. (show-entry)) ; display invisible text
  7480. (run-hooks 'org-agenda-after-show-hook)))))
  7481. (defun org-agenda-goto-mouse (ev)
  7482. "Go to the Org-mode file which contains the item at the mouse click."
  7483. (interactive "e")
  7484. (mouse-set-point ev)
  7485. (org-agenda-goto))
  7486. (defun org-agenda-show (&optional full-entry)
  7487. "Display the Org-mode file which contains the item at point.
  7488. With prefix argument FULL-ENTRY, make the entire entry visible
  7489. if it was hidden in the outline."
  7490. (interactive "P")
  7491. (let ((win (selected-window)))
  7492. (if full-entry
  7493. (let ((org-show-entry-below t))
  7494. (org-agenda-goto t))
  7495. (org-agenda-goto t))
  7496. (select-window win)))
  7497. (defvar org-agenda-show-window nil)
  7498. (defun org-agenda-show-and-scroll-up (&optional arg)
  7499. "Display the Org-mode file which contains the item at point.
  7500. When called repeatedly, scroll the window that is displaying the buffer.
  7501. With a \\[universal-argument] prefix, use `org-show-entry' instead of
  7502. `show-subtree' to display the item, so that drawers and logbooks stay
  7503. folded."
  7504. (interactive "P")
  7505. (let ((win (selected-window)))
  7506. (if (and (window-live-p org-agenda-show-window)
  7507. (eq this-command last-command))
  7508. (progn
  7509. (select-window org-agenda-show-window)
  7510. (ignore-errors (scroll-up)))
  7511. (org-agenda-goto t)
  7512. (if arg (org-show-entry) (show-subtree))
  7513. (setq org-agenda-show-window (selected-window)))
  7514. (select-window win)))
  7515. (defun org-agenda-show-scroll-down ()
  7516. "Scroll down the window showing the agenda."
  7517. (interactive)
  7518. (let ((win (selected-window)))
  7519. (when (window-live-p org-agenda-show-window)
  7520. (select-window org-agenda-show-window)
  7521. (ignore-errors (scroll-down))
  7522. (select-window win))))
  7523. (defun org-agenda-show-1 (&optional more)
  7524. "Display the Org-mode file which contains the item at point.
  7525. The prefix arg selects the amount of information to display:
  7526. 0 hide the subtree
  7527. 1 just show the entry according to defaults.
  7528. 2 show the children view
  7529. 3 show the subtree view
  7530. 4 show the entire subtree and any LOGBOOK drawers
  7531. 5 show the entire subtree and any drawers
  7532. With prefix argument FULL-ENTRY, make the entire entry visible
  7533. if it was hidden in the outline."
  7534. (interactive "p")
  7535. (let ((win (selected-window)))
  7536. (org-agenda-goto t)
  7537. (org-recenter-heading 1)
  7538. (cond
  7539. ((= more 0)
  7540. (hide-subtree)
  7541. (save-excursion
  7542. (org-back-to-heading)
  7543. (run-hook-with-args 'org-cycle-hook 'folded))
  7544. (message "Remote: FOLDED"))
  7545. ((and (org-called-interactively-p 'any) (= more 1))
  7546. (message "Remote: show with default settings"))
  7547. ((= more 2)
  7548. (show-entry)
  7549. (show-children)
  7550. (save-excursion
  7551. (org-back-to-heading)
  7552. (run-hook-with-args 'org-cycle-hook 'children))
  7553. (message "Remote: CHILDREN"))
  7554. ((= more 3)
  7555. (show-subtree)
  7556. (save-excursion
  7557. (org-back-to-heading)
  7558. (run-hook-with-args 'org-cycle-hook 'subtree))
  7559. (message "Remote: SUBTREE"))
  7560. ((= more 4)
  7561. (let* ((org-drawers (delete "LOGBOOK" (copy-sequence org-drawers)))
  7562. (org-drawer-regexp
  7563. (concat "^[ \t]*:\\("
  7564. (mapconcat 'regexp-quote org-drawers "\\|")
  7565. "\\):[ \t]*$")))
  7566. (show-subtree)
  7567. (save-excursion
  7568. (org-back-to-heading)
  7569. (org-cycle-hide-drawers 'subtree)))
  7570. (message "Remote: SUBTREE AND LOGBOOK"))
  7571. ((> more 4)
  7572. (show-subtree)
  7573. (message "Remote: SUBTREE AND ALL DRAWERS")))
  7574. (select-window win)))
  7575. (defun org-recenter-heading (n)
  7576. (save-excursion
  7577. (org-back-to-heading)
  7578. (recenter n)))
  7579. (defvar org-agenda-cycle-counter nil)
  7580. (defun org-agenda-cycle-show (&optional n)
  7581. "Show the current entry in another window, with default settings.
  7582. Default settings are taken from `org-show-hierarchy-above' and siblings.
  7583. When use repeatedly in immediate succession, the remote entry will cycle
  7584. through visibility
  7585. children -> subtree -> folded
  7586. When called with a numeric prefix arg, that arg will be passed through to
  7587. `org-agenda-show-1'. For the interpretation of that argument, see the
  7588. docstring of `org-agenda-show-1'."
  7589. (interactive "P")
  7590. (if (integerp n)
  7591. (setq org-agenda-cycle-counter n)
  7592. (if (not (eq last-command this-command))
  7593. (setq org-agenda-cycle-counter 1)
  7594. (if (equal org-agenda-cycle-counter 0)
  7595. (setq org-agenda-cycle-counter 2)
  7596. (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
  7597. (if (> org-agenda-cycle-counter 3)
  7598. (setq org-agenda-cycle-counter 0)))))
  7599. (org-agenda-show-1 org-agenda-cycle-counter))
  7600. (defun org-agenda-recenter (arg)
  7601. "Display the Org-mode file which contains the item at point and recenter."
  7602. (interactive "P")
  7603. (let ((win (selected-window)))
  7604. (org-agenda-goto t)
  7605. (recenter arg)
  7606. (select-window win)))
  7607. (defun org-agenda-show-mouse (ev)
  7608. "Display the Org-mode file which contains the item at the mouse click."
  7609. (interactive "e")
  7610. (mouse-set-point ev)
  7611. (org-agenda-show))
  7612. (defun org-agenda-check-no-diary ()
  7613. "Check if the entry is a diary link and abort if yes."
  7614. (if (org-get-at-bol 'org-agenda-diary-link)
  7615. (org-agenda-error)))
  7616. (defun org-agenda-error ()
  7617. (error "Command not allowed in this line"))
  7618. (defun org-agenda-tree-to-indirect-buffer (arg)
  7619. "Show the subtree corresponding to the current entry in an indirect buffer.
  7620. This calls the command `org-tree-to-indirect-buffer' from the original buffer.
  7621. With a numerical prefix ARG, go up to this level and then take that tree.
  7622. With a negative numeric ARG, go up by this number of levels.
  7623. With a \\[universal-argument] prefix, make a separate frame for this tree (i.e. don't
  7624. use the dedicated frame)."
  7625. (interactive "P")
  7626. (if current-prefix-arg
  7627. (org-agenda-do-tree-to-indirect-buffer arg)
  7628. (let ((agenda-buffer (buffer-name))
  7629. (agenda-window (selected-window))
  7630. (indirect-window
  7631. (and org-last-indirect-buffer
  7632. (get-buffer-window org-last-indirect-buffer))))
  7633. (save-window-excursion (org-agenda-do-tree-to-indirect-buffer arg))
  7634. (unless (or (eq org-indirect-buffer-display 'new-frame)
  7635. (eq org-indirect-buffer-display 'dedicated-frame))
  7636. (unwind-protect
  7637. (unless (and indirect-window (window-live-p indirect-window))
  7638. (setq indirect-window (split-window agenda-window)))
  7639. (and indirect-window (select-window indirect-window))
  7640. (switch-to-buffer org-last-indirect-buffer :norecord)
  7641. (fit-window-to-buffer indirect-window)))
  7642. (select-window (get-buffer-window agenda-buffer)))))
  7643. (defun org-agenda-do-tree-to-indirect-buffer (arg)
  7644. "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
  7645. (org-agenda-check-no-diary)
  7646. (let* ((marker (or (org-get-at-bol 'org-marker)
  7647. (org-agenda-error)))
  7648. (buffer (marker-buffer marker))
  7649. (pos (marker-position marker)))
  7650. (with-current-buffer buffer
  7651. (save-excursion
  7652. (goto-char pos)
  7653. (funcall 'org-tree-to-indirect-buffer arg)))))
  7654. (defvar org-last-heading-marker (make-marker)
  7655. "Marker pointing to the headline that last changed its TODO state
  7656. by a remote command from the agenda.")
  7657. (defun org-agenda-todo-nextset ()
  7658. "Switch TODO entry to next sequence."
  7659. (interactive)
  7660. (org-agenda-todo 'nextset))
  7661. (defun org-agenda-todo-previousset ()
  7662. "Switch TODO entry to previous sequence."
  7663. (interactive)
  7664. (org-agenda-todo 'previousset))
  7665. (defun org-agenda-todo (&optional arg)
  7666. "Cycle TODO state of line at point, also in Org-mode file.
  7667. This changes the line at point, all other lines in the agenda referring to
  7668. the same tree node, and the headline of the tree node in the Org-mode file."
  7669. (interactive "P")
  7670. (org-agenda-check-no-diary)
  7671. (let* ((col (current-column))
  7672. (marker (or (org-get-at-bol 'org-marker)
  7673. (org-agenda-error)))
  7674. (buffer (marker-buffer marker))
  7675. (pos (marker-position marker))
  7676. (hdmarker (org-get-at-bol 'org-hd-marker))
  7677. (todayp (org-agenda-todayp (org-get-at-bol 'day)))
  7678. (inhibit-read-only t)
  7679. org-agenda-headline-snapshot-before-repeat newhead just-one)
  7680. (org-with-remote-undo buffer
  7681. (with-current-buffer buffer
  7682. (widen)
  7683. (goto-char pos)
  7684. (org-show-context 'agenda)
  7685. (save-excursion
  7686. (and (outline-next-heading)
  7687. (org-flag-heading nil))) ; show the next heading
  7688. (let ((current-prefix-arg arg))
  7689. (call-interactively 'org-todo))
  7690. (and (bolp) (forward-char 1))
  7691. (setq newhead (org-get-heading))
  7692. (when (and (org-bound-and-true-p
  7693. org-agenda-headline-snapshot-before-repeat)
  7694. (not (equal org-agenda-headline-snapshot-before-repeat
  7695. newhead))
  7696. todayp)
  7697. (setq newhead org-agenda-headline-snapshot-before-repeat
  7698. just-one t))
  7699. (save-excursion
  7700. (org-back-to-heading)
  7701. (move-marker org-last-heading-marker (point))))
  7702. (beginning-of-line 1)
  7703. (save-excursion
  7704. (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
  7705. (org-move-to-column col))))
  7706. (defun org-agenda-add-note (&optional arg)
  7707. "Add a time-stamped note to the entry at point."
  7708. (interactive "P")
  7709. (org-agenda-check-no-diary)
  7710. (let* ((marker (or (org-get-at-bol 'org-marker)
  7711. (org-agenda-error)))
  7712. (buffer (marker-buffer marker))
  7713. (pos (marker-position marker))
  7714. (hdmarker (org-get-at-bol 'org-hd-marker))
  7715. (inhibit-read-only t))
  7716. (with-current-buffer buffer
  7717. (widen)
  7718. (goto-char pos)
  7719. (org-show-context 'agenda)
  7720. (save-excursion
  7721. (and (outline-next-heading)
  7722. (org-flag-heading nil))) ; show the next heading
  7723. (org-add-note))))
  7724. (defun org-agenda-change-all-lines (newhead hdmarker
  7725. &optional fixface just-this)
  7726. "Change all lines in the agenda buffer which match HDMARKER.
  7727. The new content of the line will be NEWHEAD (as modified by
  7728. `org-agenda-format-item'). HDMARKER is checked with
  7729. `equal' against all `org-hd-marker' text properties in the file.
  7730. If FIXFACE is non-nil, the face of each item is modified according to
  7731. the new TODO state.
  7732. If JUST-THIS is non-nil, change just the current line, not all.
  7733. If FORCE-TAGS is non nil, the car of it returns the new tags."
  7734. (let* ((inhibit-read-only t)
  7735. (line (org-current-line))
  7736. (org-agenda-buffer (current-buffer))
  7737. (thetags (with-current-buffer (marker-buffer hdmarker)
  7738. (save-excursion (save-restriction (widen)
  7739. (goto-char hdmarker)
  7740. (org-get-tags-at)))))
  7741. props m pl undone-face done-face finish new dotime level cat tags)
  7742. (save-excursion
  7743. (goto-char (point-max))
  7744. (beginning-of-line 1)
  7745. (while (not finish)
  7746. (setq finish (bobp))
  7747. (when (and (setq m (org-get-at-bol 'org-hd-marker))
  7748. (or (not just-this) (= (org-current-line) line))
  7749. (equal m hdmarker))
  7750. (setq props (text-properties-at (point))
  7751. dotime (org-get-at-bol 'dotime)
  7752. cat (org-get-at-bol 'org-category)
  7753. level (org-get-at-bol 'level)
  7754. tags thetags
  7755. new
  7756. (let ((org-prefix-format-compiled
  7757. (or (get-text-property (min (1- (point-max)) (point)) 'format)
  7758. org-prefix-format-compiled))
  7759. (extra (org-get-at-bol 'extra)))
  7760. (with-current-buffer (marker-buffer hdmarker)
  7761. (save-excursion
  7762. (save-restriction
  7763. (widen)
  7764. (org-agenda-format-item extra newhead level cat tags dotime)))))
  7765. pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
  7766. undone-face (org-get-at-bol 'undone-face)
  7767. done-face (org-get-at-bol 'done-face))
  7768. (beginning-of-line 1)
  7769. (cond
  7770. ((equal new "")
  7771. (and (looking-at ".*\n?") (replace-match "")))
  7772. ((looking-at ".*")
  7773. (replace-match new t t)
  7774. (beginning-of-line 1)
  7775. (add-text-properties (point-at-bol) (point-at-eol) props)
  7776. (when fixface
  7777. (add-text-properties
  7778. (point-at-bol) (point-at-eol)
  7779. (list 'face
  7780. (if org-last-todo-state-is-todo
  7781. undone-face done-face))))
  7782. (org-agenda-highlight-todo 'line)
  7783. (beginning-of-line 1))
  7784. (t (error "Line update did not work")))
  7785. (save-restriction
  7786. (narrow-to-region (point-at-bol) (point-at-eol))
  7787. (org-agenda-finalize)))
  7788. (beginning-of-line 0)))))
  7789. (defun org-agenda-align-tags (&optional line)
  7790. "Align all tags in agenda items to `org-agenda-tags-column'."
  7791. (let ((inhibit-read-only t) l c)
  7792. (save-excursion
  7793. (goto-char (if line (point-at-bol) (point-min)))
  7794. (while (re-search-forward (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
  7795. (if line (point-at-eol) nil) t)
  7796. (add-text-properties
  7797. (match-beginning 2) (match-end 2)
  7798. (list 'face (delq nil (let ((prop (get-text-property
  7799. (match-beginning 2) 'face)))
  7800. (or (listp prop) (setq prop (list prop)))
  7801. (if (memq 'org-tag prop)
  7802. prop
  7803. (cons 'org-tag prop))))))
  7804. (setq l (- (match-end 2) (match-beginning 2))
  7805. c (if (< org-agenda-tags-column 0)
  7806. (- (abs org-agenda-tags-column) l)
  7807. org-agenda-tags-column))
  7808. (delete-region (match-beginning 1) (match-end 1))
  7809. (goto-char (match-beginning 1))
  7810. (insert (org-add-props
  7811. (make-string (max 1 (- c (current-column))) ?\ )
  7812. (plist-put (copy-sequence (text-properties-at (point)))
  7813. 'face nil))))
  7814. (goto-char (point-min))
  7815. (org-font-lock-add-tag-faces (point-max)))))
  7816. (defun org-agenda-priority-up ()
  7817. "Increase the priority of line at point, also in Org-mode file."
  7818. (interactive)
  7819. (org-agenda-priority 'up))
  7820. (defun org-agenda-priority-down ()
  7821. "Decrease the priority of line at point, also in Org-mode file."
  7822. (interactive)
  7823. (org-agenda-priority 'down))
  7824. (defun org-agenda-priority (&optional force-direction)
  7825. "Set the priority of line at point, also in Org-mode file.
  7826. This changes the line at point, all other lines in the agenda referring to
  7827. the same tree node, and the headline of the tree node in the Org-mode file.
  7828. Called with a universal prefix arg, show the priority instead of setting it."
  7829. (interactive "P")
  7830. (if (equal force-direction '(4))
  7831. (org-show-priority)
  7832. (unless org-enable-priority-commands
  7833. (error "Priority commands are disabled"))
  7834. (org-agenda-check-no-diary)
  7835. (let* ((marker (or (org-get-at-bol 'org-marker)
  7836. (org-agenda-error)))
  7837. (hdmarker (org-get-at-bol 'org-hd-marker))
  7838. (buffer (marker-buffer hdmarker))
  7839. (pos (marker-position hdmarker))
  7840. (inhibit-read-only t)
  7841. newhead)
  7842. (org-with-remote-undo buffer
  7843. (with-current-buffer buffer
  7844. (widen)
  7845. (goto-char pos)
  7846. (org-show-context 'agenda)
  7847. (save-excursion
  7848. (and (outline-next-heading)
  7849. (org-flag-heading nil))) ; show the next heading
  7850. (funcall 'org-priority force-direction)
  7851. (end-of-line 1)
  7852. (setq newhead (org-get-heading)))
  7853. (org-agenda-change-all-lines newhead hdmarker)
  7854. (beginning-of-line 1)))))
  7855. ;; FIXME: should fix the tags property of the agenda line.
  7856. (defun org-agenda-set-tags (&optional tag onoff)
  7857. "Set tags for the current headline."
  7858. (interactive)
  7859. (org-agenda-check-no-diary)
  7860. (if (and (org-region-active-p) (org-called-interactively-p 'any))
  7861. (call-interactively 'org-change-tag-in-region)
  7862. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  7863. (org-agenda-error)))
  7864. (buffer (marker-buffer hdmarker))
  7865. (pos (marker-position hdmarker))
  7866. (inhibit-read-only t)
  7867. newhead)
  7868. (org-with-remote-undo buffer
  7869. (with-current-buffer buffer
  7870. (widen)
  7871. (goto-char pos)
  7872. (save-excursion
  7873. (org-show-context 'agenda))
  7874. (save-excursion
  7875. (and (outline-next-heading)
  7876. (org-flag-heading nil))) ; show the next heading
  7877. (goto-char pos)
  7878. (if tag
  7879. (org-toggle-tag tag onoff)
  7880. (call-interactively 'org-set-tags))
  7881. (end-of-line 1)
  7882. (setq newhead (org-get-heading)))
  7883. (org-agenda-change-all-lines newhead hdmarker)
  7884. (beginning-of-line 1)))))
  7885. (defun org-agenda-set-property ()
  7886. "Set a property for the current headline."
  7887. (interactive)
  7888. (org-agenda-check-no-diary)
  7889. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  7890. (org-agenda-error)))
  7891. (buffer (marker-buffer hdmarker))
  7892. (pos (marker-position hdmarker))
  7893. (inhibit-read-only t)
  7894. newhead)
  7895. (org-with-remote-undo buffer
  7896. (with-current-buffer buffer
  7897. (widen)
  7898. (goto-char pos)
  7899. (save-excursion
  7900. (org-show-context 'agenda))
  7901. (save-excursion
  7902. (and (outline-next-heading)
  7903. (org-flag-heading nil))) ; show the next heading
  7904. (goto-char pos)
  7905. (call-interactively 'org-set-property)))))
  7906. (defun org-agenda-set-effort ()
  7907. "Set the effort property for the current headline."
  7908. (interactive)
  7909. (org-agenda-check-no-diary)
  7910. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  7911. (org-agenda-error)))
  7912. (buffer (marker-buffer hdmarker))
  7913. (pos (marker-position hdmarker))
  7914. (inhibit-read-only t)
  7915. newhead)
  7916. (org-with-remote-undo buffer
  7917. (with-current-buffer buffer
  7918. (widen)
  7919. (goto-char pos)
  7920. (save-excursion
  7921. (org-show-context 'agenda))
  7922. (save-excursion
  7923. (and (outline-next-heading)
  7924. (org-flag-heading nil))) ; show the next heading
  7925. (goto-char pos)
  7926. (call-interactively 'org-set-effort)
  7927. (end-of-line 1)
  7928. (setq newhead (org-get-heading)))
  7929. (org-agenda-change-all-lines newhead hdmarker))))
  7930. (defun org-agenda-toggle-archive-tag ()
  7931. "Toggle the archive tag for the current entry."
  7932. (interactive)
  7933. (org-agenda-check-no-diary)
  7934. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  7935. (org-agenda-error)))
  7936. (buffer (marker-buffer hdmarker))
  7937. (pos (marker-position hdmarker))
  7938. (inhibit-read-only t)
  7939. newhead)
  7940. (org-with-remote-undo buffer
  7941. (with-current-buffer buffer
  7942. (widen)
  7943. (goto-char pos)
  7944. (org-show-context 'agenda)
  7945. (save-excursion
  7946. (and (outline-next-heading)
  7947. (org-flag-heading nil))) ; show the next heading
  7948. (call-interactively 'org-toggle-archive-tag)
  7949. (end-of-line 1)
  7950. (setq newhead (org-get-heading)))
  7951. (org-agenda-change-all-lines newhead hdmarker)
  7952. (beginning-of-line 1))))
  7953. (defun org-agenda-do-date-later (arg)
  7954. (interactive "P")
  7955. (cond
  7956. ((or (equal arg '(16))
  7957. (memq last-command
  7958. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  7959. (setq this-command 'org-agenda-date-later-minutes)
  7960. (org-agenda-date-later-minutes 1))
  7961. ((or (equal arg '(4))
  7962. (memq last-command
  7963. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  7964. (setq this-command 'org-agenda-date-later-hours)
  7965. (org-agenda-date-later-hours 1))
  7966. (t
  7967. (org-agenda-date-later (prefix-numeric-value arg)))))
  7968. (defun org-agenda-do-date-earlier (arg)
  7969. (interactive "P")
  7970. (cond
  7971. ((or (equal arg '(16))
  7972. (memq last-command
  7973. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  7974. (setq this-command 'org-agenda-date-earlier-minutes)
  7975. (org-agenda-date-earlier-minutes 1))
  7976. ((or (equal arg '(4))
  7977. (memq last-command
  7978. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  7979. (setq this-command 'org-agenda-date-earlier-hours)
  7980. (org-agenda-date-earlier-hours 1))
  7981. (t
  7982. (org-agenda-date-earlier (prefix-numeric-value arg)))))
  7983. (defun org-agenda-date-later (arg &optional what)
  7984. "Change the date of this item to ARG day(s) later."
  7985. (interactive "p")
  7986. (org-agenda-check-type t 'agenda 'timeline)
  7987. (org-agenda-check-no-diary)
  7988. (let* ((marker (or (org-get-at-bol 'org-marker)
  7989. (org-agenda-error)))
  7990. (buffer (marker-buffer marker))
  7991. (pos (marker-position marker))
  7992. cdate today)
  7993. (org-with-remote-undo buffer
  7994. (with-current-buffer buffer
  7995. (widen)
  7996. (goto-char pos)
  7997. (if (not (org-at-timestamp-p))
  7998. (error "Cannot find time stamp"))
  7999. (when (and org-agenda-move-date-from-past-immediately-to-today
  8000. (equal arg 1)
  8001. (or (not what) (eq what 'day))
  8002. (not (save-match-data (org-at-date-range-p))))
  8003. (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
  8004. cdate (calendar-absolute-from-gregorian
  8005. (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
  8006. today (org-today))
  8007. (if (> today cdate)
  8008. ;; immediately shift to today
  8009. (setq arg (- today cdate))))
  8010. (org-timestamp-change arg (or what 'day))
  8011. (when (and (org-at-date-range-p)
  8012. (re-search-backward org-tr-regexp-both (point-at-bol)))
  8013. (let ((end org-last-changed-timestamp))
  8014. (org-timestamp-change arg (or what 'day))
  8015. (setq org-last-changed-timestamp
  8016. (concat org-last-changed-timestamp "--" end)))))
  8017. (org-agenda-show-new-time marker org-last-changed-timestamp))
  8018. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  8019. (defun org-agenda-date-earlier (arg &optional what)
  8020. "Change the date of this item to ARG day(s) earlier."
  8021. (interactive "p")
  8022. (org-agenda-date-later (- arg) what))
  8023. (defun org-agenda-date-later-minutes (arg)
  8024. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  8025. (interactive "p")
  8026. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  8027. (org-agenda-date-later arg 'minute))
  8028. (defun org-agenda-date-earlier-minutes (arg)
  8029. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  8030. (interactive "p")
  8031. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  8032. (org-agenda-date-earlier arg 'minute))
  8033. (defun org-agenda-date-later-hours (arg)
  8034. "Change the time of this item, in hour steps."
  8035. (interactive "p")
  8036. (org-agenda-date-later arg 'hour))
  8037. (defun org-agenda-date-earlier-hours (arg)
  8038. "Change the time of this item, in hour steps."
  8039. (interactive "p")
  8040. (org-agenda-date-earlier arg 'hour))
  8041. (defun org-agenda-show-new-time (marker stamp &optional prefix)
  8042. "Show new date stamp via text properties."
  8043. ;; We use text properties to make this undoable
  8044. (let ((inhibit-read-only t)
  8045. (buffer-invisibility-spec))
  8046. (setq stamp (concat " " prefix " => " stamp))
  8047. (save-excursion
  8048. (goto-char (point-max))
  8049. (while (not (bobp))
  8050. (when (equal marker (org-get-at-bol 'org-marker))
  8051. (org-move-to-column (- (window-width) (length stamp)) t)
  8052. (org-agenda-fix-tags-filter-overlays-at (point))
  8053. (if (featurep 'xemacs)
  8054. ;; Use `duplicable' property to trigger undo recording
  8055. (let ((ex (make-extent nil nil))
  8056. (gl (make-glyph stamp)))
  8057. (set-glyph-face gl 'secondary-selection)
  8058. (set-extent-properties
  8059. ex (list 'invisible t 'end-glyph gl 'duplicable t))
  8060. (insert-extent ex (1- (point)) (point-at-eol)))
  8061. (add-text-properties
  8062. (1- (point)) (point-at-eol)
  8063. (list 'display (org-add-props stamp nil
  8064. 'face 'secondary-selection))))
  8065. (beginning-of-line 1))
  8066. (beginning-of-line 0)))))
  8067. (defun org-agenda-date-prompt (arg)
  8068. "Change the date of this item. Date is prompted for, with default today.
  8069. The prefix ARG is passed to the `org-time-stamp' command and can therefore
  8070. be used to request time specification in the time stamp."
  8071. (interactive "P")
  8072. (org-agenda-check-type t 'agenda 'timeline)
  8073. (org-agenda-check-no-diary)
  8074. (let* ((marker (or (org-get-at-bol 'org-marker)
  8075. (org-agenda-error)))
  8076. (buffer (marker-buffer marker))
  8077. (pos (marker-position marker)))
  8078. (org-with-remote-undo buffer
  8079. (with-current-buffer buffer
  8080. (widen)
  8081. (goto-char pos)
  8082. (if (not (org-at-timestamp-p t))
  8083. (error "Cannot find time stamp"))
  8084. (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
  8085. (org-agenda-show-new-time marker org-last-changed-timestamp))
  8086. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  8087. (defun org-agenda-schedule (arg &optional time)
  8088. "Schedule the item at point.
  8089. ARG is passed through to `org-schedule'."
  8090. (interactive "P")
  8091. (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
  8092. (org-agenda-check-no-diary)
  8093. (let* ((marker (or (org-get-at-bol 'org-marker)
  8094. (org-agenda-error)))
  8095. (type (marker-insertion-type marker))
  8096. (buffer (marker-buffer marker))
  8097. (pos (marker-position marker))
  8098. (org-insert-labeled-timestamps-at-point nil)
  8099. ts)
  8100. (set-marker-insertion-type marker t)
  8101. (org-with-remote-undo buffer
  8102. (with-current-buffer buffer
  8103. (widen)
  8104. (goto-char pos)
  8105. (setq ts (org-schedule arg time)))
  8106. (org-agenda-show-new-time marker ts "S"))
  8107. (message "%s" ts)))
  8108. (defun org-agenda-deadline (arg &optional time)
  8109. "Schedule the item at point.
  8110. ARG is passed through to `org-deadline'."
  8111. (interactive "P")
  8112. (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
  8113. (org-agenda-check-no-diary)
  8114. (let* ((marker (or (org-get-at-bol 'org-marker)
  8115. (org-agenda-error)))
  8116. (buffer (marker-buffer marker))
  8117. (pos (marker-position marker))
  8118. (org-insert-labeled-timestamps-at-point nil)
  8119. ts)
  8120. (org-with-remote-undo buffer
  8121. (with-current-buffer buffer
  8122. (widen)
  8123. (goto-char pos)
  8124. (setq ts (org-deadline arg time)))
  8125. (org-agenda-show-new-time marker ts "D"))
  8126. (message "%s" ts)))
  8127. (defun org-agenda-clock-in (&optional arg)
  8128. "Start the clock on the currently selected item."
  8129. (interactive "P")
  8130. (org-agenda-check-no-diary)
  8131. (if (equal arg '(4))
  8132. (org-clock-in arg)
  8133. (let* ((marker (or (org-get-at-bol 'org-marker)
  8134. (org-agenda-error)))
  8135. (hdmarker (or (org-get-at-bol 'org-hd-marker)
  8136. marker))
  8137. (pos (marker-position marker))
  8138. newhead)
  8139. (org-with-remote-undo (marker-buffer marker)
  8140. (with-current-buffer (marker-buffer marker)
  8141. (widen)
  8142. (goto-char pos)
  8143. (org-show-context 'agenda)
  8144. (org-show-entry)
  8145. (org-cycle-hide-drawers 'children)
  8146. (org-clock-in arg)
  8147. (setq newhead (org-get-heading)))
  8148. (org-agenda-change-all-lines newhead hdmarker)))))
  8149. (defun org-agenda-clock-out ()
  8150. "Stop the currently running clock."
  8151. (interactive)
  8152. (unless (marker-buffer org-clock-marker)
  8153. (error "No running clock"))
  8154. (let ((marker (make-marker)) newhead)
  8155. (org-with-remote-undo (marker-buffer org-clock-marker)
  8156. (with-current-buffer (marker-buffer org-clock-marker)
  8157. (save-excursion
  8158. (save-restriction
  8159. (widen)
  8160. (goto-char org-clock-marker)
  8161. (org-back-to-heading t)
  8162. (move-marker marker (point))
  8163. (org-clock-out)
  8164. (setq newhead (org-get-heading))))))
  8165. (org-agenda-change-all-lines newhead marker)
  8166. (move-marker marker nil)))
  8167. (defun org-agenda-clock-cancel (&optional arg)
  8168. "Cancel the currently running clock."
  8169. (interactive "P")
  8170. (unless (marker-buffer org-clock-marker)
  8171. (error "No running clock"))
  8172. (org-with-remote-undo (marker-buffer org-clock-marker)
  8173. (org-clock-cancel)))
  8174. (defun org-agenda-clock-goto ()
  8175. "Jump to the currently clocked in task within the agenda.
  8176. If the currently clocked in task is not listed in the agenda
  8177. buffer, display it in another window."
  8178. (interactive)
  8179. (let (pos)
  8180. (mapc (lambda (o)
  8181. (if (eq (overlay-get o 'type) 'org-agenda-clocking)
  8182. (setq pos (overlay-start o))))
  8183. (overlays-in (point-min) (point-max)))
  8184. (cond (pos (goto-char pos))
  8185. ;; If the currently clocked entry is not in the agenda
  8186. ;; buffer, we visit it in another window:
  8187. (org-clock-current-task
  8188. (org-switch-to-buffer-other-window (org-clock-goto)))
  8189. (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
  8190. (defun org-agenda-diary-entry-in-org-file ()
  8191. "Make a diary entry in the file `org-agenda-diary-file'."
  8192. (let (d1 d2 char (text "") dp1 dp2)
  8193. (if (equal (buffer-name) "*Calendar*")
  8194. (setq d1 (calendar-cursor-to-date t)
  8195. d2 (car calendar-mark-ring))
  8196. (setq dp1 (get-text-property (point-at-bol) 'day))
  8197. (unless dp1 (error "No date defined in current line"))
  8198. (setq d1 (calendar-gregorian-from-absolute dp1)
  8199. d2 (and (ignore-errors (mark))
  8200. (save-excursion
  8201. (goto-char (mark))
  8202. (setq dp2 (get-text-property (point-at-bol) 'day)))
  8203. (calendar-gregorian-from-absolute dp2))))
  8204. (message "Diary entry: [d]ay [a]nniversary [b]lock [j]ump to date tree")
  8205. (setq char (read-char-exclusive))
  8206. (cond
  8207. ((equal char ?d)
  8208. (setq text (read-string "Day entry: "))
  8209. (org-agenda-add-entry-to-org-agenda-diary-file 'day text d1)
  8210. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  8211. ((equal char ?a)
  8212. (setq d1 (list (car d1) (nth 1 d1)
  8213. (read-number (format "Reference year [%d]: " (nth 2 d1))
  8214. (nth 2 d1))))
  8215. (setq text (read-string "Anniversary (use %d to show years): "))
  8216. (org-agenda-add-entry-to-org-agenda-diary-file 'anniversary text d1)
  8217. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  8218. ((equal char ?b)
  8219. (setq text (read-string "Block entry: "))
  8220. (unless (and d1 d2 (not (equal d1 d2)))
  8221. (error "No block of days selected"))
  8222. (org-agenda-add-entry-to-org-agenda-diary-file 'block text d1 d2)
  8223. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  8224. ((equal char ?j)
  8225. (org-switch-to-buffer-other-window
  8226. (find-file-noselect org-agenda-diary-file))
  8227. (require 'org-datetree)
  8228. (org-datetree-find-date-create d1)
  8229. (org-reveal t))
  8230. (t (error "Invalid selection character `%c'" char)))))
  8231. (defcustom org-agenda-insert-diary-strategy 'date-tree
  8232. "Where in `org-agenda-diary-file' should new entries be added?
  8233. Valid values:
  8234. date-tree in the date tree, as child of the date
  8235. top-level as top-level entries at the end of the file."
  8236. :group 'org-agenda
  8237. :type '(choice
  8238. (const :tag "in a date tree" date-tree)
  8239. (const :tag "as top level at end of file" top-level)))
  8240. (defcustom org-agenda-insert-diary-extract-time nil
  8241. "Non-nil means extract any time specification from the diary entry."
  8242. :group 'org-agenda
  8243. :version "24.1"
  8244. :type 'boolean)
  8245. (defcustom org-agenda-bulk-mark-char ">"
  8246. "A single-character string to be used as the bulk mark."
  8247. :group 'org-agenda
  8248. :version "24.1"
  8249. :type 'string)
  8250. (defun org-agenda-add-entry-to-org-agenda-diary-file (type text &optional d1 d2)
  8251. "Add a diary entry with TYPE to `org-agenda-diary-file'.
  8252. If TEXT is not empty, it will become the headline of the new entry, and
  8253. the resulting entry will not be shown. When TEXT is empty, switch to
  8254. `org-agenda-diary-file' and let the user finish the entry there."
  8255. (let ((cw (current-window-configuration)))
  8256. (org-switch-to-buffer-other-window
  8257. (find-file-noselect org-agenda-diary-file))
  8258. (widen)
  8259. (goto-char (point-min))
  8260. (cond
  8261. ((eq type 'anniversary)
  8262. (or (re-search-forward "^*[ \t]+Anniversaries" nil t)
  8263. (progn
  8264. (or (org-at-heading-p t)
  8265. (progn
  8266. (outline-next-heading)
  8267. (insert "* Anniversaries\n\n")
  8268. (beginning-of-line -1)))))
  8269. (outline-next-heading)
  8270. (org-back-over-empty-lines)
  8271. (backward-char 1)
  8272. (insert "\n")
  8273. (insert (format "%%%%(org-anniversary %d %2d %2d) %s"
  8274. (nth 2 d1) (car d1) (nth 1 d1) text)))
  8275. ((eq type 'day)
  8276. (let ((org-prefix-has-time t)
  8277. (org-agenda-time-leading-zero t)
  8278. fmt time time2)
  8279. (if org-agenda-insert-diary-extract-time
  8280. ;; Use org-agenda-format-item to parse text for a time-range and
  8281. ;; remove it. FIXME: This is a hack, we should refactor
  8282. ;; that function to make time extraction available separately
  8283. (setq fmt (org-agenda-format-item nil text nil nil nil t)
  8284. time (get-text-property 0 'time fmt)
  8285. time2 (if (> (length time) 0)
  8286. ;; split-string removes trailing ...... if
  8287. ;; no end time given. First space
  8288. ;; separates time from date.
  8289. (concat " " (car (split-string time "\\.")))
  8290. nil)
  8291. text (get-text-property 0 'txt fmt)))
  8292. (if (eq org-agenda-insert-diary-strategy 'top-level)
  8293. (org-agenda-insert-diary-as-top-level text)
  8294. (require 'org-datetree)
  8295. (org-datetree-find-date-create d1)
  8296. (org-agenda-insert-diary-make-new-entry text))
  8297. (org-insert-time-stamp (org-time-from-absolute
  8298. (calendar-absolute-from-gregorian d1))
  8299. nil nil nil nil time2))
  8300. (end-of-line 0))
  8301. ((eq type 'block)
  8302. (if (> (calendar-absolute-from-gregorian d1)
  8303. (calendar-absolute-from-gregorian d2))
  8304. (setq d1 (prog1 d2 (setq d2 d1))))
  8305. (if (eq org-agenda-insert-diary-strategy 'top-level)
  8306. (org-agenda-insert-diary-as-top-level text)
  8307. (require 'org-datetree)
  8308. (org-datetree-find-date-create d1)
  8309. (org-agenda-insert-diary-make-new-entry text))
  8310. (org-insert-time-stamp (org-time-from-absolute
  8311. (calendar-absolute-from-gregorian d1)))
  8312. (insert "--")
  8313. (org-insert-time-stamp (org-time-from-absolute
  8314. (calendar-absolute-from-gregorian d2)))
  8315. (end-of-line 0)))
  8316. (if (string-match "\\S-" text)
  8317. (progn
  8318. (set-window-configuration cw)
  8319. (message "%s entry added to %s"
  8320. (capitalize (symbol-name type))
  8321. (abbreviate-file-name org-agenda-diary-file)))
  8322. (org-reveal t)
  8323. (message "Please finish entry here"))))
  8324. (defun org-agenda-insert-diary-as-top-level (text)
  8325. "Make new entry as a top-level entry at the end of the file.
  8326. Add TEXT as headline, and position the cursor in the second line so that
  8327. a timestamp can be added there."
  8328. (widen)
  8329. (goto-char (point-max))
  8330. (or (bolp) (insert "\n"))
  8331. (insert "* " text "\n")
  8332. (if org-adapt-indentation (org-indent-to-column 2)))
  8333. (defun org-agenda-insert-diary-make-new-entry (text)
  8334. "Make new entry as last child of current entry.
  8335. Add TEXT as headline, and position the cursor in the second line so that
  8336. a timestamp can be added there."
  8337. (let ((org-show-following-heading t)
  8338. (org-show-siblings t)
  8339. (org-show-hierarchy-above t)
  8340. (org-show-entry-below t)
  8341. col)
  8342. (outline-next-heading)
  8343. (org-back-over-empty-lines)
  8344. (or (looking-at "[ \t]*$")
  8345. (progn (insert "\n") (backward-char 1)))
  8346. (org-insert-heading nil t)
  8347. (org-do-demote)
  8348. (setq col (current-column))
  8349. (insert text "\n")
  8350. (if org-adapt-indentation (org-indent-to-column col))
  8351. (let ((org-show-following-heading t)
  8352. (org-show-siblings t)
  8353. (org-show-hierarchy-above t)
  8354. (org-show-entry-below t))
  8355. (org-show-context))))
  8356. (defun org-agenda-diary-entry ()
  8357. "Make a diary entry, like the `i' command from the calendar.
  8358. All the standard commands work: block, weekly etc.
  8359. When `org-agenda-diary-file' points to a file,
  8360. `org-agenda-diary-entry-in-org-file' is called instead to create
  8361. entries in that Org-mode file."
  8362. (interactive)
  8363. (if (not (eq org-agenda-diary-file 'diary-file))
  8364. (org-agenda-diary-entry-in-org-file)
  8365. (require 'diary-lib)
  8366. (let* ((char (progn
  8367. (message "Diary entry: [d]ay [w]eekly [m]onthly [y]early [a]nniversary [b]lock [c]yclic")
  8368. (read-char-exclusive)))
  8369. (cmd (cdr (assoc char
  8370. '((?d . insert-diary-entry)
  8371. (?w . insert-weekly-diary-entry)
  8372. (?m . insert-monthly-diary-entry)
  8373. (?y . insert-yearly-diary-entry)
  8374. (?a . insert-anniversary-diary-entry)
  8375. (?b . insert-block-diary-entry)
  8376. (?c . insert-cyclic-diary-entry)))))
  8377. (oldf (symbol-function 'calendar-cursor-to-date))
  8378. ;; (buf (get-file-buffer (substitute-in-file-name diary-file)))
  8379. (point (point))
  8380. (mark (or (mark t) (point))))
  8381. (unless cmd
  8382. (error "No command associated with <%c>" char))
  8383. (unless (and (get-text-property point 'day)
  8384. (or (not (equal ?b char))
  8385. (get-text-property mark 'day)))
  8386. (error "Don't know which date to use for diary entry"))
  8387. ;; We implement this by hacking the `calendar-cursor-to-date' function
  8388. ;; and the `calendar-mark-ring' variable. Saves a lot of code.
  8389. (let ((calendar-mark-ring
  8390. (list (calendar-gregorian-from-absolute
  8391. (or (get-text-property mark 'day)
  8392. (get-text-property point 'day))))))
  8393. (unwind-protect
  8394. (progn
  8395. (fset 'calendar-cursor-to-date
  8396. (lambda (&optional error dummy)
  8397. (calendar-gregorian-from-absolute
  8398. (get-text-property point 'day))))
  8399. (call-interactively cmd))
  8400. (fset 'calendar-cursor-to-date oldf))))))
  8401. (defun org-agenda-execute-calendar-command (cmd)
  8402. "Execute a calendar command from the agenda with date from cursor."
  8403. (org-agenda-check-type t 'agenda 'timeline)
  8404. (require 'diary-lib)
  8405. (unless (get-text-property (min (1- (point-max)) (point)) 'day)
  8406. (error "Don't know which date to use for the calendar command"))
  8407. (let* ((oldf (symbol-function 'calendar-cursor-to-date))
  8408. (point (point))
  8409. (date (calendar-gregorian-from-absolute
  8410. (get-text-property point 'day)))
  8411. ;; the following 2 vars are needed in the calendar
  8412. (displayed-month (car date))
  8413. (displayed-year (nth 2 date)))
  8414. (unwind-protect
  8415. (progn
  8416. (fset 'calendar-cursor-to-date
  8417. (lambda (&optional error dummy)
  8418. (calendar-gregorian-from-absolute
  8419. (get-text-property point 'day))))
  8420. (call-interactively cmd))
  8421. (fset 'calendar-cursor-to-date oldf))))
  8422. (defun org-agenda-phases-of-moon ()
  8423. "Display the phases of the moon for the 3 months around the cursor date."
  8424. (interactive)
  8425. (org-agenda-execute-calendar-command 'calendar-phases-of-moon))
  8426. (defun org-agenda-holidays ()
  8427. "Display the holidays for the 3 months around the cursor date."
  8428. (interactive)
  8429. (org-agenda-execute-calendar-command 'list-calendar-holidays))
  8430. (defvar calendar-longitude) ; defined in calendar.el
  8431. (defvar calendar-latitude) ; defined in calendar.el
  8432. (defvar calendar-location-name) ; defined in calendar.el
  8433. (defun org-agenda-sunrise-sunset (arg)
  8434. "Display sunrise and sunset for the cursor date.
  8435. Latitude and longitude can be specified with the variables
  8436. `calendar-latitude' and `calendar-longitude'. When called with prefix
  8437. argument, latitude and longitude will be prompted for."
  8438. (interactive "P")
  8439. (require 'solar)
  8440. (let ((calendar-longitude (if arg nil calendar-longitude))
  8441. (calendar-latitude (if arg nil calendar-latitude))
  8442. (calendar-location-name
  8443. (if arg "the given coordinates" calendar-location-name)))
  8444. (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
  8445. (defun org-agenda-goto-calendar ()
  8446. "Open the Emacs calendar with the date at the cursor."
  8447. (interactive)
  8448. (org-agenda-check-type t 'agenda 'timeline)
  8449. (let* ((day (or (get-text-property (min (1- (point-max)) (point)) 'day)
  8450. (error "Don't know which date to open in calendar")))
  8451. (date (calendar-gregorian-from-absolute day))
  8452. (calendar-move-hook nil)
  8453. (calendar-view-holidays-initially-flag nil)
  8454. (calendar-view-diary-initially-flag nil))
  8455. (calendar)
  8456. (calendar-goto-date date)))
  8457. ;;;###autoload
  8458. (defun org-calendar-goto-agenda ()
  8459. "Compute the Org-mode agenda for the calendar date displayed at the cursor.
  8460. This is a command that has to be installed in `calendar-mode-map'."
  8461. (interactive)
  8462. (org-agenda-list nil (calendar-absolute-from-gregorian
  8463. (calendar-cursor-to-date))
  8464. nil))
  8465. (autoload 'org-calendar-goto-agenda "org-agenda" "\
  8466. Compute the Org-mode agenda for the calendar date displayed at the cursor.
  8467. This is a command that has to be installed in `calendar-mode-map'.
  8468. \(fn)" t nil)
  8469. (defun org-agenda-convert-date ()
  8470. (interactive)
  8471. (org-agenda-check-type t 'agenda 'timeline)
  8472. (let ((day (get-text-property (min (1- (point-max)) (point)) 'day))
  8473. date s)
  8474. (unless day
  8475. (error "Don't know which date to convert"))
  8476. (setq date (calendar-gregorian-from-absolute day))
  8477. (setq s (concat
  8478. "Gregorian: " (calendar-date-string date) "\n"
  8479. "ISO: " (calendar-iso-date-string date) "\n"
  8480. "Day of Yr: " (calendar-day-of-year-string date) "\n"
  8481. "Julian: " (calendar-julian-date-string date) "\n"
  8482. "Astron. JD: " (calendar-astro-date-string date)
  8483. " (Julian date number at noon UTC)\n"
  8484. "Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
  8485. "Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
  8486. "French: " (calendar-french-date-string date) "\n"
  8487. "Baha'i: " (calendar-bahai-date-string date) " (until sunset)\n"
  8488. "Mayan: " (calendar-mayan-date-string date) "\n"
  8489. "Coptic: " (calendar-coptic-date-string date) "\n"
  8490. "Ethiopic: " (calendar-ethiopic-date-string date) "\n"
  8491. "Persian: " (calendar-persian-date-string date) "\n"
  8492. "Chinese: " (calendar-chinese-date-string date) "\n"))
  8493. (with-output-to-temp-buffer "*Dates*"
  8494. (princ s))
  8495. (org-fit-window-to-buffer (get-buffer-window "*Dates*"))))
  8496. ;;; Bulk commands
  8497. (defun org-agenda-bulk-marked-p ()
  8498. (eq (get-char-property (point-at-bol) 'type)
  8499. 'org-marked-entry-overlay))
  8500. (defun org-agenda-bulk-mark (&optional arg)
  8501. "Mark the entry at point for future bulk action."
  8502. (interactive "p")
  8503. (dotimes (i (or arg 1))
  8504. (unless (org-get-at-bol 'org-agenda-diary-link)
  8505. (let* ((m (org-get-at-bol 'org-hd-marker))
  8506. ov)
  8507. (unless (org-agenda-bulk-marked-p)
  8508. (unless m (error "Nothing to mark at point"))
  8509. (push m org-agenda-bulk-marked-entries)
  8510. (setq ov (make-overlay (point-at-bol) (+ 2 (point-at-bol))))
  8511. (org-overlay-display ov (concat org-agenda-bulk-mark-char " ")
  8512. (org-get-todo-face "TODO")
  8513. 'evaporate)
  8514. (overlay-put ov 'type 'org-marked-entry-overlay))
  8515. (beginning-of-line 2)
  8516. (while (and (get-char-property (point) 'invisible) (not (eobp)))
  8517. (beginning-of-line 2))
  8518. (message "%d entries marked for bulk action"
  8519. (length org-agenda-bulk-marked-entries))))))
  8520. (defun org-agenda-bulk-mark-all ()
  8521. "Mark all entries for future agenda bulk action."
  8522. (interactive)
  8523. (org-agenda-bulk-mark-regexp "."))
  8524. (defun org-agenda-bulk-mark-regexp (regexp)
  8525. "Mark entries matching REGEXP for future agenda bulk action."
  8526. (interactive "sMark entries matching regexp: ")
  8527. (let ((entries-marked 0))
  8528. (save-excursion
  8529. (goto-char (point-min))
  8530. (goto-char (next-single-property-change (point) 'txt))
  8531. (while (re-search-forward regexp nil t)
  8532. (when (string-match regexp (get-text-property (point) 'txt))
  8533. (setq entries-marked (1+ entries-marked))
  8534. (call-interactively 'org-agenda-bulk-mark))))
  8535. (if (not entries-marked)
  8536. (message "No entry matching this regexp."))))
  8537. (defun org-agenda-bulk-unmark (&optional arg)
  8538. "Unmark the entry at point for future bulk action."
  8539. (interactive "P")
  8540. (if arg
  8541. (org-agenda-bulk-unmark-all)
  8542. (cond ((org-agenda-bulk-marked-p)
  8543. (org-agenda-bulk-remove-overlays
  8544. (point-at-bol) (+ 2 (point-at-bol)))
  8545. (setq org-agenda-bulk-marked-entries
  8546. (delete (org-get-at-bol 'org-hd-marker)
  8547. org-agenda-bulk-marked-entries))
  8548. (beginning-of-line 2)
  8549. (while (and (get-char-property (point) 'invisible) (not (eobp)))
  8550. (beginning-of-line 2))
  8551. (message "%d entries left marked for bulk action"
  8552. (length org-agenda-bulk-marked-entries)))
  8553. (t (message "No entry to unmark here")))))
  8554. (defun org-agenda-bulk-toggle ()
  8555. "Toggle marking the entry at point for bulk action."
  8556. (interactive)
  8557. (if (org-agenda-bulk-marked-p)
  8558. (org-agenda-bulk-unmark)
  8559. (org-agenda-bulk-mark)))
  8560. (defun org-agenda-bulk-remove-overlays (&optional beg end)
  8561. "Remove the mark overlays between BEG and END in the agenda buffer.
  8562. BEG and END default to the buffer limits.
  8563. This only removes the overlays, it does not remove the markers
  8564. from the list in `org-agenda-bulk-marked-entries'."
  8565. (interactive)
  8566. (mapc (lambda (ov)
  8567. (and (eq (overlay-get ov 'type) 'org-marked-entry-overlay)
  8568. (delete-overlay ov)))
  8569. (overlays-in (or beg (point-min)) (or end (point-max)))))
  8570. (defun org-agenda-bulk-unmark-all ()
  8571. "Remove all marks in the agenda buffer.
  8572. This will remove the markers and the overlays."
  8573. (interactive)
  8574. (if (null org-agenda-bulk-marked-entries)
  8575. (message "No entry to unmark")
  8576. (mapc (lambda (m) (move-marker m nil)) org-agenda-bulk-marked-entries)
  8577. (setq org-agenda-bulk-marked-entries nil)
  8578. (org-agenda-bulk-remove-overlays (point-min) (point-max))))
  8579. (defcustom org-agenda-persistent-marks nil
  8580. "Non-nil means marked items will stay marked after a bulk action.
  8581. You can toggle this interactively by typing `p' when prompted for a
  8582. bulk action."
  8583. :group 'org-agenda
  8584. :version "24.1"
  8585. :type 'boolean)
  8586. (defun org-agenda-bulk-action (&optional arg)
  8587. "Execute an remote-editing action on all marked entries.
  8588. The prefix arg is passed through to the command if possible."
  8589. (interactive "P")
  8590. ;; Make sure we have markers, and only valid ones
  8591. (unless org-agenda-bulk-marked-entries (error "No entries are marked"))
  8592. (mapc
  8593. (lambda (m)
  8594. (unless (and (markerp m)
  8595. (marker-buffer m)
  8596. (buffer-live-p (marker-buffer m))
  8597. (marker-position m))
  8598. (error "Marker %s for bulk command is invalid" m)))
  8599. org-agenda-bulk-marked-entries)
  8600. ;; Prompt for the bulk command
  8601. (let* ((msg (if org-agenda-persistent-marks "Bulk (persistent): " "Bulk: ")))
  8602. (message (concat msg "[$]arch [A]rch->sib [t]odo [+/-]tag [s]chd [d]eadline [r]efile "
  8603. "[S]catter [f]unction "
  8604. (when org-agenda-bulk-custom-functions
  8605. (concat " Custom: ["
  8606. (mapconcat (lambda(f) (char-to-string (car f)))
  8607. org-agenda-bulk-custom-functions "")
  8608. "]"))))
  8609. (catch 'exit
  8610. (let* ((action (read-char-exclusive))
  8611. (org-log-refile (if org-log-refile 'time nil))
  8612. (entries (reverse org-agenda-bulk-marked-entries))
  8613. (org-overriding-default-time
  8614. (if (get-text-property (point) 'org-agenda-date-header)
  8615. (org-get-cursor-date)))
  8616. redo-at-end
  8617. cmd rfloc state e tag pos (cnt 0) (cntskip 0))
  8618. (cond
  8619. ((equal action ?p)
  8620. (let ((org-agenda-persistent-marks
  8621. (not org-agenda-persistent-marks)))
  8622. (org-agenda-bulk-action)
  8623. (throw 'exit nil)))
  8624. ((equal action ?$)
  8625. (setq cmd '(org-agenda-archive)))
  8626. ((equal action ?A)
  8627. (setq cmd '(org-agenda-archive-to-archive-sibling)))
  8628. ((member action '(?r ?w))
  8629. (setq rfloc (org-refile-get-location
  8630. "Refile to"
  8631. (marker-buffer (car entries))
  8632. org-refile-allow-creating-parent-nodes))
  8633. (if (nth 3 rfloc)
  8634. (setcar (nthcdr 3 rfloc)
  8635. (move-marker (make-marker) (nth 3 rfloc)
  8636. (or (get-file-buffer (nth 1 rfloc))
  8637. (find-buffer-visiting (nth 1 rfloc))
  8638. (error "This should not happen")))))
  8639. (setq cmd (list 'org-agenda-refile nil (list 'quote rfloc) t)
  8640. redo-at-end t))
  8641. ((equal action ?t)
  8642. (setq state (org-icompleting-read
  8643. "Todo state: "
  8644. (with-current-buffer (marker-buffer (car entries))
  8645. (mapcar 'list org-todo-keywords-1))))
  8646. (setq cmd `(let ((org-inhibit-blocking t)
  8647. (org-inhibit-logging 'note))
  8648. (org-agenda-todo ,state))))
  8649. ((memq action '(?- ?+))
  8650. (setq tag (org-icompleting-read
  8651. (format "Tag to %s: " (if (eq action ?+) "add" "remove"))
  8652. (with-current-buffer (marker-buffer (car entries))
  8653. (delq nil
  8654. (mapcar (lambda (x)
  8655. (if (stringp (car x)) x)) org-tag-alist)))))
  8656. (setq cmd `(org-agenda-set-tags ,tag ,(if (eq action ?+) ''on ''off))))
  8657. ((memq action '(?s ?d))
  8658. (let* ((time
  8659. (unless arg
  8660. (org-read-date
  8661. nil nil nil
  8662. (if (eq action ?s) "(Re)Schedule to" "(Re)Set Deadline to")
  8663. org-overriding-default-time)))
  8664. (c1 (if (eq action ?s) 'org-agenda-schedule 'org-agenda-deadline)))
  8665. (setq cmd `(eval '(,c1 arg ,time)))))
  8666. ((equal action ?S)
  8667. (if (not (org-agenda-check-type nil 'agenda 'timeline 'todo))
  8668. (error "Can't scatter tasks in \"%s\" agenda view" org-agenda-type)
  8669. (let ((days (read-number
  8670. (format "Scatter tasks across how many %sdays: "
  8671. (if arg "week" "")) 7)))
  8672. (setq cmd
  8673. `(let ((distance (1+ (random ,days))))
  8674. (if arg
  8675. (let ((dist distance)
  8676. (day-of-week
  8677. (calendar-day-of-week
  8678. (calendar-gregorian-from-absolute (org-today)))))
  8679. (dotimes (i (1+ dist))
  8680. (while (member day-of-week org-agenda-weekend-days)
  8681. (incf distance)
  8682. (incf day-of-week)
  8683. (if (= day-of-week 7)
  8684. (setq day-of-week 0)))
  8685. (incf day-of-week)
  8686. (if (= day-of-week 7)
  8687. (setq day-of-week 0)))))
  8688. ;; silently fail when try to replan a sexp entry
  8689. (condition-case nil
  8690. (let* ((date (calendar-gregorian-from-absolute
  8691. (+ (org-today) distance)))
  8692. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date)
  8693. (nth 2 date))))
  8694. (org-agenda-schedule nil time))
  8695. (error nil)))))))
  8696. ((assoc action org-agenda-bulk-custom-functions)
  8697. (setq cmd (list (cadr (assoc action org-agenda-bulk-custom-functions)))
  8698. redo-at-end t))
  8699. ((equal action ?f)
  8700. (setq cmd (list (intern
  8701. (org-icompleting-read "Function: "
  8702. obarray 'fboundp t nil nil)))))
  8703. (t (error "Invalid bulk action")))
  8704. ;; Sort the markers, to make sure that parents are handled before children
  8705. (setq entries (sort entries
  8706. (lambda (a b)
  8707. (cond
  8708. ((equal (marker-buffer a) (marker-buffer b))
  8709. (< (marker-position a) (marker-position b)))
  8710. (t
  8711. (string< (buffer-name (marker-buffer a))
  8712. (buffer-name (marker-buffer b))))))))
  8713. ;; Now loop over all markers and apply cmd
  8714. (while (setq e (pop entries))
  8715. (setq pos (text-property-any (point-min) (point-max) 'org-hd-marker e))
  8716. (if (not pos)
  8717. (progn (message "Skipping removed entry at %s" e)
  8718. (setq cntskip (1+ cntskip)))
  8719. (goto-char pos)
  8720. (let (org-loop-over-headlines-in-active-region)
  8721. (eval cmd))
  8722. (setq cnt (1+ cnt))))
  8723. (when redo-at-end (org-agenda-redo))
  8724. (unless org-agenda-persistent-marks
  8725. (org-agenda-bulk-unmark-all))
  8726. (message "Acted on %d entries%s%s"
  8727. cnt
  8728. (if (= cntskip 0)
  8729. ""
  8730. (format ", skipped %d (disappeared before their turn)"
  8731. cntskip))
  8732. (if (not org-agenda-persistent-marks)
  8733. "" " (kept marked)"))))))
  8734. (defun org-agenda-capture (&optional with-time)
  8735. "Call `org-capture' with the date at point.
  8736. With a `C-1' prefix, use the HH:MM value at point (if any) or the
  8737. current HH:MM time."
  8738. (interactive "P")
  8739. (if (not (eq major-mode 'org-agenda-mode))
  8740. (user-error "You cannot do this outside of agenda buffers")
  8741. (let ((org-overriding-default-time
  8742. (org-get-cursor-date (equal with-time 1))))
  8743. (call-interactively 'org-capture))))
  8744. ;;; Flagging notes
  8745. (defun org-agenda-show-the-flagging-note ()
  8746. "Display the flagging note in the other window.
  8747. When called a second time in direct sequence, offer to remove the FLAGGING
  8748. tag and (if present) the flagging note."
  8749. (interactive)
  8750. (let ((hdmarker (org-get-at-bol 'org-hd-marker))
  8751. (win (selected-window))
  8752. note heading newhead)
  8753. (unless hdmarker
  8754. (error "No linked entry at point"))
  8755. (if (and (eq this-command last-command)
  8756. (y-or-n-p "Unflag and remove any flagging note? "))
  8757. (progn
  8758. (org-agenda-remove-flag hdmarker)
  8759. (let ((win (get-buffer-window "*Flagging Note*")))
  8760. (and win (delete-window win)))
  8761. (message "Entry unflagged"))
  8762. (setq note (org-entry-get hdmarker "THEFLAGGINGNOTE"))
  8763. (unless note
  8764. (error "No flagging note"))
  8765. (org-kill-new note)
  8766. (org-switch-to-buffer-other-window "*Flagging Note*")
  8767. (erase-buffer)
  8768. (insert note)
  8769. (goto-char (point-min))
  8770. (while (re-search-forward "\\\\n" nil t)
  8771. (replace-match "\n" t t))
  8772. (goto-char (point-min))
  8773. (select-window win)
  8774. (message "Flagging note pushed to kill ring. Press [?] again to remove tag and note"))))
  8775. (defun org-agenda-remove-flag (marker)
  8776. "Remove the FLAGGED tag and any flagging note in the entry."
  8777. (let (newhead)
  8778. (org-with-point-at marker
  8779. (org-toggle-tag "FLAGGED" 'off)
  8780. (org-entry-delete nil "THEFLAGGINGNOTE")
  8781. (setq newhead (org-get-heading)))
  8782. (org-agenda-change-all-lines newhead marker)
  8783. (message "Entry unflagged")))
  8784. (defun org-agenda-get-any-marker (&optional pos)
  8785. (or (get-text-property (or pos (point-at-bol)) 'org-hd-marker)
  8786. (get-text-property (or pos (point-at-bol)) 'org-marker)))
  8787. ;;; Appointment reminders
  8788. (defvar appt-time-msg-list) ; defined in appt.el
  8789. ;;;###autoload
  8790. (defun org-agenda-to-appt (&optional refresh filter &rest args)
  8791. "Activate appointments found in `org-agenda-files'.
  8792. With a \\[universal-argument] prefix, refresh the list of
  8793. appointments.
  8794. If FILTER is t, interactively prompt the user for a regular
  8795. expression, and filter out entries that don't match it.
  8796. If FILTER is a string, use this string as a regular expression
  8797. for filtering entries out.
  8798. If FILTER is a function, filter out entries against which
  8799. calling the function returns nil. This function takes one
  8800. argument: an entry from `org-agenda-get-day-entries'.
  8801. FILTER can also be an alist with the car of each cell being
  8802. either 'headline or 'category. For example:
  8803. '((headline \"IMPORTANT\")
  8804. (category \"Work\"))
  8805. will only add headlines containing IMPORTANT or headlines
  8806. belonging to the \"Work\" category.
  8807. ARGS are symbols indicating what kind of entries to consider.
  8808. By default `org-agenda-to-appt' will use :deadline, :scheduled
  8809. and :timestamp entries. See the docstring of `org-diary' for
  8810. details and examples.
  8811. If an entry as a APPT_WARNTIME property, its value will be used
  8812. to override `appt-message-warning-time'."
  8813. (interactive "P")
  8814. (if refresh (setq appt-time-msg-list nil))
  8815. (if (eq filter t)
  8816. (setq filter (read-from-minibuffer "Regexp filter: ")))
  8817. (let* ((cnt 0) ; count added events
  8818. (scope (or args '(:deadline :scheduled :timestamp)))
  8819. (org-agenda-new-buffers nil)
  8820. (org-deadline-warning-days 0)
  8821. ;; Do not use `org-today' here because appt only takes
  8822. ;; time and without date as argument, so it may pass wrong
  8823. ;; information otherwise
  8824. (today (org-date-to-gregorian
  8825. (time-to-days (current-time))))
  8826. (org-agenda-restrict nil)
  8827. (files (org-agenda-files 'unrestricted)) entries file
  8828. (org-agenda-buffer nil))
  8829. ;; Get all entries which may contain an appt
  8830. (org-agenda-prepare-buffers files)
  8831. (while (setq file (pop files))
  8832. (setq entries
  8833. (delq nil
  8834. (append entries
  8835. (apply 'org-agenda-get-day-entries
  8836. file today scope)))))
  8837. ;; Map thru entries and find if we should filter them out
  8838. (mapc
  8839. (lambda(x)
  8840. (let* ((evt (org-trim (or (get-text-property 1 'txt x) "")))
  8841. (cat (get-text-property 1 'org-category x))
  8842. (tod (get-text-property 1 'time-of-day x))
  8843. (ok (or (null filter)
  8844. (and (stringp filter) (string-match filter evt))
  8845. (and (functionp filter) (funcall filter x))
  8846. (and (listp filter)
  8847. (let ((cat-filter (cadr (assoc 'category filter)))
  8848. (evt-filter (cadr (assoc 'headline filter))))
  8849. (or (and (stringp cat-filter)
  8850. (string-match cat-filter cat))
  8851. (and (stringp evt-filter)
  8852. (string-match evt-filter evt)))))))
  8853. (wrn (get-text-property 1 'warntime x)))
  8854. ;; FIXME: Shall we remove text-properties for the appt text?
  8855. ;; (setq evt (set-text-properties 0 (length evt) nil evt))
  8856. (when (and ok tod)
  8857. (setq tod (concat "00" (number-to-string tod))
  8858. tod (when (string-match
  8859. "\\([0-9]\\{1,2\\}\\)\\([0-9]\\{2\\}\\)\\'" tod)
  8860. (concat (match-string 1 tod) ":"
  8861. (match-string 2 tod))))
  8862. (if (version< emacs-version "23.3")
  8863. (appt-add tod evt)
  8864. (appt-add tod evt wrn))
  8865. (setq cnt (1+ cnt))))) entries)
  8866. (org-release-buffers org-agenda-new-buffers)
  8867. (if (eq cnt 0)
  8868. (message "No event to add")
  8869. (message "Added %d event%s for today" cnt (if (> cnt 1) "s" "")))))
  8870. (autoload 'org-agenda-to-appt "org-agenda" "\
  8871. Activate appointments found in `org-agenda-files'.
  8872. With a \\[universal-argument] prefix, refresh the list of
  8873. appointments.
  8874. If FILTER is t, interactively prompt the user for a regular
  8875. expression, and filter out entries that don't match it.
  8876. If FILTER is a string, use this string as a regular expression
  8877. for filtering entries out.
  8878. If FILTER is a function, filter out entries against which
  8879. calling the function returns nil. This function takes one
  8880. argument: an entry from `org-agenda-get-day-entries'.
  8881. FILTER can also be an alist with the car of each cell being
  8882. either 'headline or 'category. For example:
  8883. '((headline \"IMPORTANT\")
  8884. (category \"Work\"))
  8885. will only add headlines containing IMPORTANT or headlines
  8886. belonging to the \"Work\" category.
  8887. ARGS are symbols indicating what kind of entries to consider.
  8888. By default `org-agenda-to-appt' will use :deadline, :scheduled
  8889. and :timestamp entries. See the docstring of `org-diary' for
  8890. details and examples.
  8891. If an entry as a APPT_WARNTIME property, its value will be used
  8892. to override `appt-message-warning-time'.
  8893. \(fn &optional REFRESH FILTER &rest ARGS)" t nil)
  8894. (defun org-agenda-todayp (date)
  8895. "Does DATE mean today, when considering `org-extend-today-until'?"
  8896. (let ((today (org-today))
  8897. (date (if (and date (listp date)) (calendar-absolute-from-gregorian date)
  8898. date)))
  8899. (eq date today)))
  8900. (defun org-agenda-todo-yesterday (&optional arg)
  8901. "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday."
  8902. (interactive "P")
  8903. (let* ((hour (third (decode-time
  8904. (org-current-time))))
  8905. (org-extend-today-until (1+ hour)))
  8906. (org-agenda-todo arg)))
  8907. (provide 'org-agenda)
  8908. ;;; org-agenda.el ends here