org-agenda.el 372 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639
  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. (org-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. (org-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-use-tag-inheritance '(todo search timeline agenda)
  1483. "List of agenda view types where to use tag inheritance.
  1484. In tags/tags-todo/tags-tree agenda views, tag inheritance is
  1485. controlled by `org-use-tag-inheritance'. In other agenda types,
  1486. `org-use-tag-inheritance' is not used when selecting the agenda
  1487. entries, but you may want the agenda to use the inherited tags
  1488. anyway, e.g. for later tag filtering.
  1489. The default value reset tags in every agenda type. Setting this
  1490. option to nil will speed up non-tags agenda view a lot.
  1491. Allowed value are 'todo, 'search, 'timeline and 'agenda."
  1492. :version "24.3"
  1493. :group 'org-agenda
  1494. :type '(repeat (symbol :tag "Agenda type")))
  1495. (defcustom org-agenda-hide-tags-regexp nil
  1496. "Regular expression used to filter away specific tags in agenda views.
  1497. This means that these tags will be present, but not be shown in the agenda
  1498. line. Secondary filtering will still work on the hidden tags.
  1499. Nil means don't hide any tags."
  1500. :group 'org-agenda-line-format
  1501. :type '(choice
  1502. (const :tag "Hide none" nil)
  1503. (string :tag "Regexp ")))
  1504. (defcustom org-agenda-remove-tags nil
  1505. "Non-nil means remove the tags from the headline copy in the agenda.
  1506. When this is the symbol `prefix', only remove tags when
  1507. `org-agenda-prefix-format' contains a `%T' specifier."
  1508. :group 'org-agenda-line-format
  1509. :type '(choice
  1510. (const :tag "Always" t)
  1511. (const :tag "Never" nil)
  1512. (const :tag "When prefix format contains %T" prefix)))
  1513. (if (fboundp 'defvaralias)
  1514. (defvaralias 'org-agenda-remove-tags-when-in-prefix
  1515. 'org-agenda-remove-tags))
  1516. (defcustom org-agenda-tags-column (if (featurep 'xemacs) -79 -80)
  1517. "Shift tags in agenda items to this column.
  1518. If this number is positive, it specifies the column. If it is negative,
  1519. it means that the tags should be flushright to that column. For example,
  1520. -80 works well for a normal 80 character screen."
  1521. :group 'org-agenda-line-format
  1522. :type 'integer)
  1523. (if (fboundp 'defvaralias)
  1524. (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column))
  1525. (defcustom org-agenda-fontify-priorities 'cookies
  1526. "Non-nil means highlight low and high priorities in agenda.
  1527. When t, the highest priority entries are bold, lowest priority italic.
  1528. However, settings in `org-priority-faces' will overrule these faces.
  1529. When this variable is the symbol `cookies', only fontify the
  1530. cookies, not the entire task.
  1531. This may also be an association list of priority faces, whose
  1532. keys are the character values of `org-highest-priority',
  1533. `org-default-priority', and `org-lowest-priority' (the default values
  1534. are ?A, ?B, and ?C, respectively). The face may be a named face, a
  1535. color as a string, or a list like `(:background \"Red\")'.
  1536. If it is a color, the variable `org-faces-easy-properties'
  1537. determines if it is a foreground or a background color."
  1538. :group 'org-agenda-line-format
  1539. :type '(choice
  1540. (const :tag "Never" nil)
  1541. (const :tag "Defaults" t)
  1542. (const :tag "Cookies only" cookies)
  1543. (repeat :tag "Specify"
  1544. (list (character :tag "Priority" :value ?A)
  1545. (choice :tag "Face "
  1546. (string :tag "Color")
  1547. (sexp :tag "Face"))))))
  1548. (defcustom org-agenda-day-face-function nil
  1549. "Function called to determine what face should be used to display a day.
  1550. The only argument passed to that function is the day. It should
  1551. returns a face, or nil if does not want to specify a face and let
  1552. the normal rules apply."
  1553. :group 'org-agenda-line-format
  1554. :version "24.1"
  1555. :type 'function)
  1556. (defcustom org-agenda-category-icon-alist nil
  1557. "Alist of category icon to be displayed in agenda views.
  1558. Each entry should have the following format:
  1559. (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
  1560. Where CATEGORY-REGEXP is a regexp matching the categories where
  1561. the icon should be displayed.
  1562. FILE-OR-DATA either a file path or a string containing image data.
  1563. The other fields can be omitted safely if not needed:
  1564. TYPE indicates the image type.
  1565. DATA-P is a boolean indicating whether the FILE-OR-DATA string is
  1566. image data.
  1567. PROPS are additional image attributes to assign to the image,
  1568. like, e.g. `:ascent center'.
  1569. (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
  1570. If you want to set the display properties yourself, just put a
  1571. list as second element:
  1572. (CATEGORY-REGEXP (MY PROPERTY LIST))
  1573. For example, to display a 16px horizontal space for Emacs
  1574. category, you can use:
  1575. (\"Emacs\" '(space . (:width (16))))"
  1576. :group 'org-agenda-line-format
  1577. :version "24.1"
  1578. :type '(alist :key-type (string :tag "Regexp matching category")
  1579. :value-type (choice (list :tag "Icon"
  1580. (string :tag "File or data")
  1581. (symbol :tag "Type")
  1582. (boolean :tag "Data?")
  1583. (repeat :tag "Extra image properties" :inline t symbol))
  1584. (list :tag "Display properties" sexp))))
  1585. (defgroup org-agenda-column-view nil
  1586. "Options concerning column view in the agenda."
  1587. :tag "Org Agenda Column View"
  1588. :group 'org-agenda)
  1589. (defcustom org-agenda-columns-show-summaries t
  1590. "Non-nil means show summaries for columns displayed in the agenda view."
  1591. :group 'org-agenda-column-view
  1592. :type 'boolean)
  1593. (defcustom org-agenda-columns-compute-summary-properties t
  1594. "Non-nil means recompute all summary properties before column view.
  1595. When column view in the agenda is listing properties that have a summary
  1596. operator, it can go to all relevant buffers and recompute the summaries
  1597. there. This can mean overhead for the agenda column view, but is necessary
  1598. to have thing up to date.
  1599. As a special case, a CLOCKSUM property also makes sure that the clock
  1600. computations are current."
  1601. :group 'org-agenda-column-view
  1602. :type 'boolean)
  1603. (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
  1604. "Non-nil means the duration of an appointment will add to day effort.
  1605. The property to which appointment durations will be added is the one given
  1606. in the option `org-effort-property'. If an appointment does not have
  1607. an end time, `org-agenda-default-appointment-duration' will be used. If that
  1608. is not set, an appointment without end time will not contribute to the time
  1609. estimate."
  1610. :group 'org-agenda-column-view
  1611. :type 'boolean)
  1612. (defcustom org-agenda-auto-exclude-function nil
  1613. "A function called with a tag to decide if it is filtered on '/ RET'.
  1614. The sole argument to the function, which is called once for each
  1615. possible tag, is a string giving the name of the tag. The
  1616. function should return either nil if the tag should be included
  1617. as normal, or \"-<TAG>\" to exclude the tag.
  1618. Note that for the purpose of tag filtering, only the lower-case version of
  1619. all tags will be considered, so that this function will only ever see
  1620. the lower-case version of all tags."
  1621. :group 'org-agenda
  1622. :type 'function)
  1623. (defcustom org-agenda-bulk-custom-functions nil
  1624. "Alist of characters and custom functions for bulk actions.
  1625. For example, this value makes those two functions available:
  1626. '((?R set-category)
  1627. (?C bulk-cut))
  1628. With selected entries in an agenda buffer, `B R' will call
  1629. the custom function `set-category' on the selected entries.
  1630. Note that functions in this alist don't need to be quoted."
  1631. :type 'alist
  1632. :version "24.1"
  1633. :group 'org-agenda)
  1634. (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
  1635. "Execute BODY with point at location given by `org-hd-marker' property.
  1636. If STRING is non-nil, the text property will be fetched from position 0
  1637. in that string. If STRING is nil, it will be fetched from the beginning
  1638. of the current line."
  1639. (org-with-gensyms (marker)
  1640. `(let ((,marker (get-text-property (if string 0 (point-at-bol))
  1641. 'org-hd-marker ,string)))
  1642. (with-current-buffer (marker-buffer ,marker)
  1643. (save-excursion
  1644. (goto-char ,marker)
  1645. ,@body)))))
  1646. (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
  1647. (defun org-add-agenda-custom-command (entry)
  1648. "Replace or add a command in `org-agenda-custom-commands'.
  1649. This is mostly for hacking and trying a new command - once the command
  1650. works you probably want to add it to `org-agenda-custom-commands' for good."
  1651. (let ((ass (assoc (car entry) org-agenda-custom-commands)))
  1652. (if ass
  1653. (setcdr ass (cdr entry))
  1654. (push entry org-agenda-custom-commands))))
  1655. ;;; Define the org-agenda-mode
  1656. (defvar org-agenda-mode-map (make-sparse-keymap)
  1657. "Keymap for `org-agenda-mode'.")
  1658. (if (fboundp 'defvaralias)
  1659. (defvaralias 'org-agenda-keymap 'org-agenda-mode-map))
  1660. (defvar org-agenda-menu) ; defined later in this file.
  1661. (defvar org-agenda-restrict nil) ; defined later in this file.
  1662. (defvar org-agenda-follow-mode nil)
  1663. (defvar org-agenda-entry-text-mode nil)
  1664. (defvar org-agenda-clockreport-mode nil)
  1665. (defvar org-agenda-show-log nil)
  1666. (defvar org-agenda-redo-command nil)
  1667. (defvar org-agenda-query-string nil)
  1668. (defvar org-agenda-mode-hook nil
  1669. "Hook run after `org-agenda-mode' is turned on.
  1670. The buffer is still writable when this hook is called.")
  1671. (defvar org-agenda-type nil)
  1672. (defvar org-agenda-force-single-file nil)
  1673. (defvar org-agenda-bulk-marked-entries nil
  1674. "List of markers that refer to marked entries in the agenda.")
  1675. ;;; Multiple agenda buffers support
  1676. (defcustom org-agenda-sticky nil
  1677. "Non-nil means agenda q key will bury agenda buffers.
  1678. Agenda commands will then show existing buffer instead of generating new ones.
  1679. When nil, `q' will kill the single agenda buffer."
  1680. :group 'org-agenda
  1681. :version "24.3"
  1682. :type 'boolean)
  1683. ;;;###autoload
  1684. (defun org-toggle-sticky-agenda (&optional arg)
  1685. "Toggle `org-agenda-sticky'."
  1686. (interactive "P")
  1687. (let ((new-value (if arg
  1688. (> (prefix-numeric-value arg) 0)
  1689. (not org-agenda-sticky))))
  1690. (if (equal new-value org-agenda-sticky)
  1691. (and (org-called-interactively-p 'interactive)
  1692. (message "Sticky agenda was already %s"
  1693. (if org-agenda-sticky "enabled" "disabled")))
  1694. (setq org-agenda-sticky new-value)
  1695. (org-agenda-kill-all-agenda-buffers)
  1696. (and (org-called-interactively-p 'interactive)
  1697. (message "Sticky agenda was %s"
  1698. (if org-agenda-sticky "enabled" "disabled"))))))
  1699. (autoload 'org-toggle-sticky-agenda "org-agenda" "\
  1700. Toggle `org-agenda-sticky'.
  1701. \(fn &optional ARG)" t nil)
  1702. (defvar org-agenda-buffer nil
  1703. "Agenda buffer currently being generated.")
  1704. (defvar org-agenda-last-prefix-arg nil)
  1705. (defvar org-agenda-this-buffer-name nil)
  1706. (defvar org-agenda-doing-sticky-redo nil)
  1707. (defvar org-agenda-this-buffer-is-sticky nil)
  1708. (defconst org-agenda-local-vars
  1709. '(org-agenda-this-buffer-name
  1710. org-agenda-undo-list
  1711. org-agenda-pending-undo-list
  1712. org-agenda-follow-mode
  1713. org-agenda-entry-text-mode
  1714. org-agenda-clockreport-mode
  1715. org-agenda-show-log
  1716. org-agenda-redo-command
  1717. org-agenda-query-string
  1718. org-agenda-type
  1719. org-agenda-bulk-marked-entries
  1720. org-agenda-undo-has-started-in
  1721. org-agenda-info
  1722. org-agenda-tag-filter-overlays
  1723. org-agenda-cat-filter-overlays
  1724. org-agenda-pre-window-conf
  1725. org-agenda-columns-active
  1726. org-agenda-tag-filter
  1727. org-agenda-category-filter
  1728. org-agenda-markers
  1729. org-agenda-last-search-view-search-was-boolean
  1730. org-agenda-filtered-by-category
  1731. org-agenda-filter-form
  1732. org-agenda-show-window
  1733. org-agenda-cycle-counter
  1734. org-agenda-last-prefix-arg)
  1735. "Variables that must be local in agenda buffers to allow multiple buffers.")
  1736. (defun org-agenda-mode ()
  1737. "Mode for time-sorted view on action items in Org-mode files.
  1738. The following commands are available:
  1739. \\{org-agenda-mode-map}"
  1740. (interactive)
  1741. (cond (org-agenda-doing-sticky-redo
  1742. ;; Refreshing sticky agenda-buffer
  1743. ;;
  1744. ;; Preserve the value of `org-agenda-local-vars' variables,
  1745. ;; while letting `kill-all-local-variables' kill the rest
  1746. (let ((save (buffer-local-variables)))
  1747. (kill-all-local-variables)
  1748. (mapc 'make-local-variable org-agenda-local-vars)
  1749. (dolist (elem save)
  1750. (let ((var (car elem))
  1751. (val (cdr elem)))
  1752. (when (and val
  1753. (member var org-agenda-local-vars))
  1754. (set var val)))))
  1755. (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
  1756. (org-agenda-sticky
  1757. ;; Creating a sticky Agenda buffer for the first time
  1758. (kill-all-local-variables)
  1759. (mapc 'make-local-variable org-agenda-local-vars)
  1760. (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
  1761. (t
  1762. ;; Creating a non-sticky agenda buffer
  1763. (kill-all-local-variables)
  1764. (set (make-local-variable 'org-agenda-this-buffer-is-sticky) nil)))
  1765. (setq org-agenda-undo-list nil
  1766. org-agenda-pending-undo-list nil
  1767. org-agenda-bulk-marked-entries nil)
  1768. (setq major-mode 'org-agenda-mode)
  1769. ;; Keep global-font-lock-mode from turning on font-lock-mode
  1770. (org-set-local 'font-lock-global-modes (list 'not major-mode))
  1771. (setq mode-name "Org-Agenda")
  1772. (use-local-map org-agenda-mode-map)
  1773. (easy-menu-add org-agenda-menu)
  1774. (if org-startup-truncated (setq truncate-lines t))
  1775. (org-set-local 'line-move-visual nil)
  1776. (org-add-hook 'post-command-hook 'org-agenda-update-agenda-type nil 'local)
  1777. (org-add-hook 'pre-command-hook 'org-unhighlight nil 'local)
  1778. ;; Make sure properties are removed when copying text
  1779. (make-local-variable 'filter-buffer-substring-functions)
  1780. (add-hook 'filter-buffer-substring-functions
  1781. (lambda (fun start end delete)
  1782. (substring-no-properties (funcall fun start end delete))))
  1783. (unless org-agenda-keep-modes
  1784. (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
  1785. org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
  1786. org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode
  1787. org-agenda-show-log org-agenda-start-with-log-mode))
  1788. (easy-menu-change
  1789. '("Agenda") "Agenda Files"
  1790. (append
  1791. (list
  1792. (vector
  1793. (if (get 'org-agenda-files 'org-restrict)
  1794. "Restricted to single file"
  1795. "Edit File List")
  1796. '(org-edit-agenda-file-list)
  1797. (not (get 'org-agenda-files 'org-restrict)))
  1798. "--")
  1799. (mapcar 'org-file-menu-entry (org-agenda-files))))
  1800. (org-agenda-set-mode-name)
  1801. (apply
  1802. (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
  1803. (list 'org-agenda-mode-hook)))
  1804. (substitute-key-definition 'undo 'org-agenda-undo
  1805. org-agenda-mode-map global-map)
  1806. (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
  1807. (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
  1808. (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
  1809. (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
  1810. (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
  1811. (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
  1812. (org-defkey org-agenda-mode-map "*" 'org-agenda-bulk-mark-all)
  1813. (org-defkey org-agenda-mode-map "#" 'org-agenda-dim-blocked-tasks)
  1814. (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
  1815. (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
  1816. (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-unmark-all)
  1817. (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
  1818. (org-defkey org-agenda-mode-map "k" 'org-agenda-capture)
  1819. (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
  1820. (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
  1821. (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
  1822. (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
  1823. (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
  1824. (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
  1825. (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
  1826. (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
  1827. (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
  1828. (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
  1829. (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
  1830. (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
  1831. (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
  1832. (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
  1833. (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
  1834. (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
  1835. (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
  1836. (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
  1837. (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
  1838. (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
  1839. (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
  1840. (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
  1841. (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
  1842. (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
  1843. (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
  1844. (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
  1845. (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
  1846. (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
  1847. (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
  1848. (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
  1849. (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
  1850. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
  1851. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
  1852. (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
  1853. (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
  1854. (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
  1855. (let ((l '(1 2 3 4 5 6 7 8 9 0)))
  1856. (while l (org-defkey org-agenda-mode-map
  1857. (int-to-string (pop l)) 'digit-argument)))
  1858. (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
  1859. (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
  1860. (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
  1861. (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
  1862. (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
  1863. (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
  1864. (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
  1865. (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
  1866. (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
  1867. (org-defkey org-agenda-mode-map "g" (lambda () (interactive) (org-agenda-redo t)))
  1868. (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
  1869. (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
  1870. (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
  1871. 'org-clock-modify-effort-estimate)
  1872. (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
  1873. (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
  1874. (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
  1875. (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
  1876. (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
  1877. (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
  1878. (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
  1879. (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
  1880. (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
  1881. (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
  1882. (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
  1883. (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
  1884. (substitute-key-definition 'next-line 'org-agenda-next-line
  1885. org-agenda-mode-map global-map)
  1886. (substitute-key-definition 'previous-line 'org-agenda-previous-line
  1887. org-agenda-mode-map global-map)
  1888. (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
  1889. (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
  1890. (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
  1891. (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
  1892. (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
  1893. (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
  1894. (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
  1895. (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
  1896. (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
  1897. (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
  1898. (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
  1899. (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
  1900. (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
  1901. (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
  1902. (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
  1903. (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
  1904. (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
  1905. (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
  1906. (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  1907. (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
  1908. (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
  1909. (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
  1910. (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
  1911. (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
  1912. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
  1913. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
  1914. (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
  1915. (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
  1916. (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
  1917. (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  1918. (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
  1919. (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
  1920. (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
  1921. (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
  1922. (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
  1923. (org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag-refine)
  1924. (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
  1925. (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-category)
  1926. (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
  1927. (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
  1928. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  1929. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  1930. (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
  1931. (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
  1932. (when org-agenda-mouse-1-follows-link
  1933. (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
  1934. (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
  1935. '("Agenda"
  1936. ("Agenda Files")
  1937. "--"
  1938. ("Agenda Dates"
  1939. ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
  1940. ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
  1941. ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
  1942. ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
  1943. "--"
  1944. ("View"
  1945. ["Day View" org-agenda-day-view
  1946. :active (org-agenda-check-type nil 'agenda)
  1947. :style radio :selected (eq org-agenda-current-span 'day)
  1948. :keys "v d (or just d)"]
  1949. ["Week View" org-agenda-week-view
  1950. :active (org-agenda-check-type nil 'agenda)
  1951. :style radio :selected (eq org-agenda-current-span 'week)
  1952. :keys "v w (or just w)"]
  1953. ["Month View" org-agenda-month-view
  1954. :active (org-agenda-check-type nil 'agenda)
  1955. :style radio :selected (eq org-agenda-current-span 'month)
  1956. :keys "v m"]
  1957. ["Year View" org-agenda-year-view
  1958. :active (org-agenda-check-type nil 'agenda)
  1959. :style radio :selected (eq org-agenda-current-span 'year)
  1960. :keys "v y"]
  1961. "--"
  1962. ["Include Diary" org-agenda-toggle-diary
  1963. :style toggle :selected org-agenda-include-diary
  1964. :active (org-agenda-check-type nil 'agenda)]
  1965. ["Include Deadlines" org-agenda-toggle-deadlines
  1966. :style toggle :selected org-agenda-include-deadlines
  1967. :active (org-agenda-check-type nil 'agenda)]
  1968. ["Use Time Grid" org-agenda-toggle-time-grid
  1969. :style toggle :selected org-agenda-use-time-grid
  1970. :active (org-agenda-check-type nil 'agenda)]
  1971. "--"
  1972. ["Show clock report" org-agenda-clockreport-mode
  1973. :style toggle :selected org-agenda-clockreport-mode
  1974. :active (org-agenda-check-type nil 'agenda)]
  1975. ["Show some entry text" org-agenda-entry-text-mode
  1976. :style toggle :selected org-agenda-entry-text-mode
  1977. :active t]
  1978. "--"
  1979. ["Show Logbook entries" org-agenda-log-mode
  1980. :style toggle :selected org-agenda-show-log
  1981. :active (org-agenda-check-type nil 'agenda 'timeline)
  1982. :keys "v l (or just l)"]
  1983. ["Include archived trees" org-agenda-archives-mode
  1984. :style toggle :selected org-agenda-archives-mode :active t
  1985. :keys "v a"]
  1986. ["Include archive files" (org-agenda-archives-mode t)
  1987. :style toggle :selected (eq org-agenda-archives-mode t) :active t
  1988. :keys "v A"]
  1989. "--"
  1990. ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
  1991. ["Write view to file" org-agenda-write t]
  1992. ["Rebuild buffer" org-agenda-redo t]
  1993. ["Save all Org-mode Buffers" org-save-all-org-buffers t]
  1994. "--"
  1995. ["Show original entry" org-agenda-show t]
  1996. ["Go To (other window)" org-agenda-goto t]
  1997. ["Go To (this window)" org-agenda-switch-to t]
  1998. ["Capture with cursor date" org-agenda-capture t]
  1999. ["Follow Mode" org-agenda-follow-mode
  2000. :style toggle :selected org-agenda-follow-mode :active t]
  2001. ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
  2002. "--"
  2003. ("TODO"
  2004. ["Cycle TODO" org-agenda-todo t]
  2005. ["Next TODO set" org-agenda-todo-nextset t]
  2006. ["Previous TODO set" org-agenda-todo-previousset t]
  2007. ["Add note" org-agenda-add-note t])
  2008. ("Archive/Refile/Delete"
  2009. ["Archive default" org-agenda-archive-default t]
  2010. ["Archive default" org-agenda-archive-default-with-confirmation t]
  2011. ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
  2012. ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
  2013. ["Archive subtree" org-agenda-archive t]
  2014. "--"
  2015. ["Refile" org-agenda-refile t]
  2016. "--"
  2017. ["Delete subtree" org-agenda-kill t])
  2018. ("Bulk action"
  2019. ["Mark entry" org-agenda-bulk-mark t]
  2020. ["Mark all" org-agenda-bulk-mark-all t]
  2021. ["Mark matching regexp" org-agenda-bulk-mark-regexp t]
  2022. ["Unmark entry" org-agenda-bulk-unmark t]
  2023. ["Unmark all entries" org-agenda-bulk-unmark-all :active t :keys "U"])
  2024. ["Act on all marked" org-agenda-bulk-action t]
  2025. "--"
  2026. ("Tags and Properties"
  2027. ["Show all Tags" org-agenda-show-tags t]
  2028. ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
  2029. ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
  2030. "--"
  2031. ["Column View" org-columns t])
  2032. ("Deadline/Schedule"
  2033. ["Schedule" org-agenda-schedule t]
  2034. ["Set Deadline" org-agenda-deadline t]
  2035. "--"
  2036. ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
  2037. ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
  2038. ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
  2039. ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
  2040. ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
  2041. ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
  2042. ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
  2043. ("Clock and Effort"
  2044. ["Clock in" org-agenda-clock-in t]
  2045. ["Clock out" org-agenda-clock-out t]
  2046. ["Clock cancel" org-agenda-clock-cancel t]
  2047. ["Goto running clock" org-clock-goto t]
  2048. "--"
  2049. ["Set Effort" org-agenda-set-effort t]
  2050. ["Change clocked effort" org-clock-modify-effort-estimate
  2051. (org-clock-is-active)])
  2052. ("Priority"
  2053. ["Set Priority" org-agenda-priority t]
  2054. ["Increase Priority" org-agenda-priority-up t]
  2055. ["Decrease Priority" org-agenda-priority-down t]
  2056. ["Show Priority" org-show-priority t])
  2057. ("Calendar/Diary"
  2058. ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
  2059. ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
  2060. ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
  2061. ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
  2062. ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
  2063. ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
  2064. "--"
  2065. ["Create iCalendar File" org-export-icalendar-combine-agenda-files t])
  2066. "--"
  2067. ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
  2068. "--"
  2069. ("MobileOrg"
  2070. ["Push Files and Views" org-mobile-push t]
  2071. ["Get Captured and Flagged" org-mobile-pull t]
  2072. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
  2073. ["Show note / unflag" org-agenda-show-the-flagging-note t]
  2074. "--"
  2075. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  2076. "--"
  2077. ["Quit" org-agenda-quit t]
  2078. ["Exit and Release Buffers" org-agenda-exit t]
  2079. ))
  2080. ;;; Agenda undo
  2081. (defvar org-agenda-allow-remote-undo t
  2082. "Non-nil means allow remote undo from the agenda buffer.")
  2083. (defvar org-agenda-undo-has-started-in nil
  2084. "Buffers that have already seen `undo-start' in the current undo sequence.")
  2085. (defun org-agenda-undo ()
  2086. "Undo a remote editing step in the agenda.
  2087. This undoes changes both in the agenda buffer and in the remote buffer
  2088. that have been changed along."
  2089. (interactive)
  2090. (or org-agenda-allow-remote-undo
  2091. (error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
  2092. (if (not (eq this-command last-command))
  2093. (setq org-agenda-undo-has-started-in nil
  2094. org-agenda-pending-undo-list org-agenda-undo-list))
  2095. (if (not org-agenda-pending-undo-list)
  2096. (error "No further undo information"))
  2097. (let* ((entry (pop org-agenda-pending-undo-list))
  2098. buf line cmd rembuf)
  2099. (setq cmd (pop entry) line (pop entry))
  2100. (setq rembuf (nth 2 entry))
  2101. (org-with-remote-undo rembuf
  2102. (while (bufferp (setq buf (pop entry)))
  2103. (if (pop entry)
  2104. (with-current-buffer buf
  2105. (let ((last-undo-buffer buf)
  2106. (inhibit-read-only t))
  2107. (unless (memq buf org-agenda-undo-has-started-in)
  2108. (push buf org-agenda-undo-has-started-in)
  2109. (make-local-variable 'pending-undo-list)
  2110. (undo-start))
  2111. (while (and pending-undo-list
  2112. (listp pending-undo-list)
  2113. (not (car pending-undo-list)))
  2114. (pop pending-undo-list))
  2115. (undo-more 1))))))
  2116. (org-goto-line line)
  2117. (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
  2118. (defun org-verify-change-for-undo (l1 l2)
  2119. "Verify that a real change occurred between the undo lists L1 and L2."
  2120. (while (and l1 (listp l1) (null (car l1))) (pop l1))
  2121. (while (and l2 (listp l2) (null (car l2))) (pop l2))
  2122. (not (eq l1 l2)))
  2123. ;;; Agenda dispatch
  2124. (defvar org-agenda-restrict-begin (make-marker))
  2125. (defvar org-agenda-restrict-end (make-marker))
  2126. (defvar org-agenda-last-dispatch-buffer nil)
  2127. (defvar org-agenda-overriding-restriction nil)
  2128. (defcustom org-agenda-custom-commands-contexts nil
  2129. "Alist of custom agenda keys and contextual rules.
  2130. For example, if you have a custom agenda command \"p\" and you
  2131. want this command to be accessible only from plain text files,
  2132. use this:
  2133. '((\"p\" (in-file . \"\\.txt\")))
  2134. Here are the available contexts definitions:
  2135. in-file: command displayed only in matching files
  2136. in-mode: command displayed only in matching modes
  2137. not-in-file: command not displayed in matching files
  2138. not-in-mode: command not displayed in matching modes
  2139. [function]: a custom function taking no argument
  2140. If you define several checks, the agenda command will be
  2141. accessible if there is at least one valid check.
  2142. You can also bind a key to another agenda custom command
  2143. depending on contextual rules.
  2144. '((\"p\" \"q\" (in-file . \"\\.txt\")))
  2145. Here it means: in .txt files, use \"p\" as the key for the
  2146. agenda command otherwise associated with \"q\". (The command
  2147. originally associated with \"q\" is not displayed to avoid
  2148. duplicates.)"
  2149. :version "24.3"
  2150. :group 'org-agenda-custom-commands
  2151. :type '(repeat (list :tag "Rule"
  2152. (string :tag " Agenda key")
  2153. (string :tag "Replace by command")
  2154. (repeat :tag "Available when"
  2155. (choice
  2156. (cons :tag "Condition"
  2157. (choice
  2158. (const :tag "In file" in-file)
  2159. (const :tag "Not in file" not-in-file)
  2160. (const :tag "In mode" in-mode)
  2161. (const :tag "Not in mode" not-in-mode))
  2162. (regexp))
  2163. (function :tag "Custom function"))))))
  2164. (defvar org-keys nil)
  2165. (defvar org-match nil)
  2166. ;;;###autoload
  2167. (defun org-agenda (&optional arg org-keys restriction)
  2168. "Dispatch agenda commands to collect entries to the agenda buffer.
  2169. Prompts for a command to execute. Any prefix arg will be passed
  2170. on to the selected command. The default selections are:
  2171. a Call `org-agenda-list' to display the agenda for current day or week.
  2172. t Call `org-todo-list' to display the global todo list.
  2173. T Call `org-todo-list' to display the global todo list, select only
  2174. entries with a specific TODO keyword (the user gets a prompt).
  2175. m Call `org-tags-view' to display headlines with tags matching
  2176. a condition (the user is prompted for the condition).
  2177. M Like `m', but select only TODO entries, no ordinary headlines.
  2178. L Create a timeline for the current buffer.
  2179. e Export views to associated files.
  2180. s Search entries for keywords.
  2181. S Search entries for keywords, only with TODO keywords.
  2182. / Multi occur across all agenda files and also files listed
  2183. in `org-agenda-text-search-extra-files'.
  2184. < Restrict agenda commands to buffer, subtree, or region.
  2185. Press several times to get the desired effect.
  2186. > Remove a previous restriction.
  2187. # List \"stuck\" projects.
  2188. ! Configure what \"stuck\" means.
  2189. C Configure custom agenda commands.
  2190. More commands can be added by configuring the variable
  2191. `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
  2192. searches can be pre-defined in this way.
  2193. If the current buffer is in Org-mode and visiting a file, you can also
  2194. first press `<' once to indicate that the agenda should be temporarily
  2195. \(until the next use of \\[org-agenda]) restricted to the current file.
  2196. Pressing `<' twice means to restrict to the current subtree or region
  2197. \(if active)."
  2198. (interactive "P")
  2199. (catch 'exit
  2200. (let* ((prefix-descriptions nil)
  2201. (org-agenda-buffer-name org-agenda-buffer-name)
  2202. (org-agenda-window-setup (if (equal (buffer-name)
  2203. org-agenda-buffer-name)
  2204. 'current-window
  2205. org-agenda-window-setup))
  2206. (org-agenda-custom-commands-orig org-agenda-custom-commands)
  2207. (org-agenda-custom-commands
  2208. ;; normalize different versions
  2209. (delq nil
  2210. (mapcar
  2211. (lambda (x)
  2212. (cond ((stringp (cdr x))
  2213. (push x prefix-descriptions)
  2214. nil)
  2215. ((stringp (nth 1 x)) x)
  2216. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2217. (t (cons (car x) (cons "" (cdr x))))))
  2218. org-agenda-custom-commands)))
  2219. (org-agenda-custom-commands
  2220. (org-contextualize-keys
  2221. org-agenda-custom-commands org-agenda-custom-commands-contexts))
  2222. (buf (current-buffer))
  2223. (bfn (buffer-file-name (buffer-base-buffer)))
  2224. entry key type org-match lprops ans)
  2225. ;; Turn off restriction unless there is an overriding one,
  2226. (unless org-agenda-overriding-restriction
  2227. (unless (org-bound-and-true-p org-agenda-keep-restricted-file-list)
  2228. ;; There is a request to keep the file list in place
  2229. (put 'org-agenda-files 'org-restrict nil))
  2230. (setq org-agenda-restrict nil)
  2231. (move-marker org-agenda-restrict-begin nil)
  2232. (move-marker org-agenda-restrict-end nil))
  2233. ;; Delete old local properties
  2234. (put 'org-agenda-redo-command 'org-lprops nil)
  2235. ;; Delete previously set last-arguments
  2236. (put 'org-agenda-redo-command 'last-args nil)
  2237. ;; Remember where this call originated
  2238. (setq org-agenda-last-dispatch-buffer (current-buffer))
  2239. (unless org-keys
  2240. (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
  2241. org-keys (car ans)
  2242. restriction (cdr ans)))
  2243. ;; If we have sticky agenda buffers, set a name for the buffer,
  2244. ;; depending on the invoking keys. The user may still set this
  2245. ;; as a command option, which will overwrite what we do here.
  2246. (if org-agenda-sticky
  2247. (setq org-agenda-buffer-name
  2248. (format "*Org Agenda(%s)*" org-keys)))
  2249. ;; Establish the restriction, if any
  2250. (when (and (not org-agenda-overriding-restriction) restriction)
  2251. (put 'org-agenda-files 'org-restrict (list bfn))
  2252. (cond
  2253. ((eq restriction 'region)
  2254. (setq org-agenda-restrict t)
  2255. (move-marker org-agenda-restrict-begin (region-beginning))
  2256. (move-marker org-agenda-restrict-end (region-end)))
  2257. ((eq restriction 'subtree)
  2258. (save-excursion
  2259. (setq org-agenda-restrict t)
  2260. (org-back-to-heading t)
  2261. (move-marker org-agenda-restrict-begin (point))
  2262. (move-marker org-agenda-restrict-end
  2263. (progn (org-end-of-subtree t)))))))
  2264. ;; For example the todo list should not need it (but does...)
  2265. (cond
  2266. ((setq entry (assoc org-keys org-agenda-custom-commands))
  2267. (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
  2268. (progn
  2269. (setq type (nth 2 entry) org-match (eval (nth 3 entry))
  2270. lprops (nth 4 entry))
  2271. (if org-agenda-sticky
  2272. (setq org-agenda-buffer-name
  2273. (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
  2274. (format "*Org Agenda(%s)*" org-keys))))
  2275. (put 'org-agenda-redo-command 'org-lprops lprops)
  2276. (cond
  2277. ((eq type 'agenda)
  2278. (org-let lprops '(org-agenda-list current-prefix-arg)))
  2279. ((eq type 'alltodo)
  2280. (org-let lprops '(org-todo-list current-prefix-arg)))
  2281. ((eq type 'search)
  2282. (org-let lprops '(org-search-view current-prefix-arg org-match nil)))
  2283. ((eq type 'stuck)
  2284. (org-let lprops '(org-agenda-list-stuck-projects
  2285. current-prefix-arg)))
  2286. ((eq type 'tags)
  2287. (org-let lprops '(org-tags-view current-prefix-arg org-match)))
  2288. ((eq type 'tags-todo)
  2289. (org-let lprops '(org-tags-view '(4) org-match)))
  2290. ((eq type 'todo)
  2291. (org-let lprops '(org-todo-list org-match)))
  2292. ((eq type 'tags-tree)
  2293. (org-check-for-org-mode)
  2294. (org-let lprops '(org-match-sparse-tree current-prefix-arg org-match)))
  2295. ((eq type 'todo-tree)
  2296. (org-check-for-org-mode)
  2297. (org-let lprops
  2298. '(org-occur (concat "^" org-outline-regexp "[ \t]*"
  2299. (regexp-quote org-match) "\\>"))))
  2300. ((eq type 'occur-tree)
  2301. (org-check-for-org-mode)
  2302. (org-let lprops '(org-occur org-match)))
  2303. ((functionp type)
  2304. (org-let lprops '(funcall type org-match)))
  2305. ((fboundp type)
  2306. (org-let lprops '(funcall type org-match)))
  2307. (t (error "Invalid custom agenda command type %s" type))))
  2308. (org-agenda-run-series (nth 1 entry) (cddr entry))))
  2309. ((equal org-keys "C")
  2310. (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
  2311. (customize-variable 'org-agenda-custom-commands))
  2312. ((equal org-keys "a") (call-interactively 'org-agenda-list))
  2313. ((equal org-keys "s") (call-interactively 'org-search-view))
  2314. ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
  2315. ((equal org-keys "t") (call-interactively 'org-todo-list))
  2316. ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
  2317. ((equal org-keys "m") (call-interactively 'org-tags-view))
  2318. ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
  2319. ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
  2320. ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
  2321. (org-add-hook
  2322. 'post-command-hook
  2323. (lambda ()
  2324. (unless (current-message)
  2325. (let* ((m (org-agenda-get-any-marker))
  2326. (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
  2327. (when note
  2328. (message (concat
  2329. "FLAGGING-NOTE ([?] for more info): "
  2330. (org-add-props
  2331. (replace-regexp-in-string
  2332. "\\\\n" "//"
  2333. (copy-sequence note))
  2334. nil 'face 'org-warning)))))))
  2335. t t))
  2336. ((equal org-keys "L")
  2337. (unless (derived-mode-p 'org-mode)
  2338. (error "This is not an Org-mode file"))
  2339. (unless restriction
  2340. (put 'org-agenda-files 'org-restrict (list bfn))
  2341. (org-call-with-arg 'org-timeline arg)))
  2342. ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
  2343. ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
  2344. ((equal org-keys "!") (customize-variable 'org-stuck-projects))
  2345. (t (error "Invalid agenda key"))))))
  2346. (autoload 'org-agenda "org-agenda" "\
  2347. Dispatch agenda commands to collect entries to the agenda buffer.
  2348. Prompts for a command to execute. Any prefix arg will be passed
  2349. on to the selected command. The default selections are:
  2350. a Call `org-agenda-list' to display the agenda for current day or week.
  2351. t Call `org-todo-list' to display the global todo list.
  2352. T Call `org-todo-list' to display the global todo list, select only
  2353. entries with a specific TODO keyword (the user gets a prompt).
  2354. m Call `org-tags-view' to display headlines with tags matching
  2355. a condition (the user is prompted for the condition).
  2356. M Like `m', but select only TODO entries, no ordinary headlines.
  2357. L Create a timeline for the current buffer.
  2358. e Export views to associated files.
  2359. s Search entries for keywords.
  2360. S Search entries for keywords, only with TODO keywords.
  2361. / Multi occur across all agenda files and also files listed
  2362. in `org-agenda-text-search-extra-files'.
  2363. < Restrict agenda commands to buffer, subtree, or region.
  2364. Press several times to get the desired effect.
  2365. > Remove a previous restriction.
  2366. # List \"stuck\" projects.
  2367. ! Configure what \"stuck\" means.
  2368. C Configure custom agenda commands.
  2369. More commands can be added by configuring the variable
  2370. `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
  2371. searches can be pre-defined in this way.
  2372. If the current buffer is in Org-mode and visiting a file, you can also
  2373. first press `<' once to indicate that the agenda should be temporarily
  2374. \(until the next use of \\[org-agenda]) restricted to the current file.
  2375. Pressing `<' twice means to restrict to the current subtree or region
  2376. \(if active).
  2377. \(fn &optional ARG ORG-KEYS RESTRICTION)" t nil)
  2378. (defun org-agenda-append-agenda ()
  2379. "Append another agenda view to the current one.
  2380. This function allows interactive building of block agendas.
  2381. Agenda views are separated by `org-agenda-block-separator'."
  2382. (interactive)
  2383. (unless (derived-mode-p 'org-agenda-mode)
  2384. (error "Can only append from within agenda buffer"))
  2385. (let ((org-agenda-multi t))
  2386. (org-agenda)
  2387. (widen)
  2388. (org-agenda-finalize)
  2389. (org-agenda-fit-window-to-buffer)))
  2390. (defun org-agenda-normalize-custom-commands (cmds)
  2391. (delq nil
  2392. (mapcar
  2393. (lambda (x)
  2394. (cond ((stringp (cdr x)) nil)
  2395. ((stringp (nth 1 x)) x)
  2396. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2397. (t (cons (car x) (cons "" (cdr x))))))
  2398. cmds)))
  2399. (defun org-agenda-get-restriction-and-command (prefix-descriptions)
  2400. "The user interface for selecting an agenda command."
  2401. (catch 'exit
  2402. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  2403. (restrict-ok (and bfn (derived-mode-p 'org-mode)))
  2404. (region-p (org-region-active-p))
  2405. (custom org-agenda-custom-commands)
  2406. (selstring "")
  2407. restriction second-time
  2408. c entry key type match prefixes rmheader header-end custom1 desc
  2409. line lines left right n n1)
  2410. (save-window-excursion
  2411. (delete-other-windows)
  2412. (org-switch-to-buffer-other-window " *Agenda Commands*")
  2413. (erase-buffer)
  2414. (insert (eval-when-compile
  2415. (let ((header
  2416. "Press key for an agenda command: < Buffer, subtree/region restriction
  2417. -------------------------------- > Remove restriction
  2418. a Agenda for current week or day e Export agenda views
  2419. t List of all TODO entries T Entries with special TODO kwd
  2420. m Match a TAGS/PROP/TODO query M Like m, but only TODO entries
  2421. s Search for keywords S Like s, but only TODO entries
  2422. L Timeline for current buffer # List stuck projects (!=configure)
  2423. / Multi-occur C Configure custom agenda commands
  2424. ? Find :FLAGGED: entries * Toggle sticky agenda views
  2425. ")
  2426. (start 0))
  2427. (while (string-match
  2428. "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
  2429. header start)
  2430. (setq start (match-end 0))
  2431. (add-text-properties (match-beginning 2) (match-end 2)
  2432. '(face bold) header))
  2433. header)))
  2434. (setq header-end (point-marker))
  2435. (while t
  2436. (setq custom1 custom)
  2437. (when (eq rmheader t)
  2438. (org-goto-line 1)
  2439. (re-search-forward ":" nil t)
  2440. (delete-region (match-end 0) (point-at-eol))
  2441. (forward-char 1)
  2442. (looking-at "-+")
  2443. (delete-region (match-end 0) (point-at-eol))
  2444. (move-marker header-end (match-end 0)))
  2445. (goto-char header-end)
  2446. (delete-region (point) (point-max))
  2447. ;; Produce all the lines that describe custom commands and prefixes
  2448. (setq lines nil)
  2449. (while (setq entry (pop custom1))
  2450. (setq key (car entry) desc (nth 1 entry)
  2451. type (nth 2 entry)
  2452. match (nth 3 entry))
  2453. (if (> (length key) 1)
  2454. (add-to-list 'prefixes (string-to-char key))
  2455. (setq line
  2456. (format
  2457. "%-4s%-14s"
  2458. (org-add-props (copy-sequence key)
  2459. '(face bold))
  2460. (cond
  2461. ((string-match "\\S-" desc) desc)
  2462. ((eq type 'agenda) "Agenda for current week or day")
  2463. ((eq type 'alltodo) "List of all TODO entries")
  2464. ((eq type 'search) "Word search")
  2465. ((eq type 'stuck) "List of stuck projects")
  2466. ((eq type 'todo) "TODO keyword")
  2467. ((eq type 'tags) "Tags query")
  2468. ((eq type 'tags-todo) "Tags (TODO)")
  2469. ((eq type 'tags-tree) "Tags tree")
  2470. ((eq type 'todo-tree) "TODO kwd tree")
  2471. ((eq type 'occur-tree) "Occur tree")
  2472. ((functionp type) (if (symbolp type)
  2473. (symbol-name type)
  2474. "Lambda expression"))
  2475. (t "???"))))
  2476. (if org-agenda-menu-show-matcher
  2477. (setq line
  2478. (concat line ": "
  2479. (cond
  2480. ((stringp match)
  2481. (setq match (copy-sequence match))
  2482. (org-add-props match nil 'face 'org-warning))
  2483. ((listp type)
  2484. (format "set of %d commands" (length type))))))
  2485. (if (org-string-nw-p match)
  2486. (add-text-properties
  2487. 0 (length line) (list 'help-echo
  2488. (concat "Matcher: " match)) line)))
  2489. (push line lines)))
  2490. (setq lines (nreverse lines))
  2491. (when prefixes
  2492. (mapc (lambda (x)
  2493. (push
  2494. (format "%s %s"
  2495. (org-add-props (char-to-string x)
  2496. nil 'face 'bold)
  2497. (or (cdr (assoc (concat selstring
  2498. (char-to-string x))
  2499. prefix-descriptions))
  2500. "Prefix key"))
  2501. lines))
  2502. prefixes))
  2503. ;; Check if we should display in two columns
  2504. (if org-agenda-menu-two-columns
  2505. (progn
  2506. (setq n (length lines)
  2507. n1 (+ (/ n 2) (mod n 2))
  2508. right (nthcdr n1 lines)
  2509. left (copy-sequence lines))
  2510. (setcdr (nthcdr (1- n1) left) nil))
  2511. (setq left lines right nil))
  2512. (while left
  2513. (insert "\n" (pop left))
  2514. (when right
  2515. (if (< (current-column) 40)
  2516. (move-to-column 40 t)
  2517. (insert " "))
  2518. (insert (pop right))))
  2519. ;; Make the window the right size
  2520. (goto-char (point-min))
  2521. (if second-time
  2522. (if (not (pos-visible-in-window-p (point-max)))
  2523. (org-fit-window-to-buffer))
  2524. (setq second-time t)
  2525. (org-fit-window-to-buffer))
  2526. ;; Ask for selection
  2527. (message "Press key for agenda command%s:"
  2528. (if (or restrict-ok org-agenda-overriding-restriction)
  2529. (if org-agenda-overriding-restriction
  2530. " (restriction lock active)"
  2531. (if restriction
  2532. (format " (restricted to %s)" restriction)
  2533. " (unrestricted)"))
  2534. ""))
  2535. (setq c (read-char-exclusive))
  2536. (message "")
  2537. (cond
  2538. ((assoc (char-to-string c) custom)
  2539. (setq selstring (concat selstring (char-to-string c)))
  2540. (throw 'exit (cons selstring restriction)))
  2541. ((memq c prefixes)
  2542. (setq selstring (concat selstring (char-to-string c))
  2543. prefixes nil
  2544. rmheader (or rmheader t)
  2545. custom (delq nil (mapcar
  2546. (lambda (x)
  2547. (if (or (= (length (car x)) 1)
  2548. (/= (string-to-char (car x)) c))
  2549. nil
  2550. (cons (substring (car x) 1) (cdr x))))
  2551. custom))))
  2552. ((eq c ?*)
  2553. (call-interactively 'org-toggle-sticky-agenda)
  2554. (sit-for 2))
  2555. ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
  2556. (message "Restriction is only possible in Org-mode buffers")
  2557. (ding) (sit-for 1))
  2558. ((eq c ?1)
  2559. (org-agenda-remove-restriction-lock 'noupdate)
  2560. (setq restriction 'buffer))
  2561. ((eq c ?0)
  2562. (org-agenda-remove-restriction-lock 'noupdate)
  2563. (setq restriction (if region-p 'region 'subtree)))
  2564. ((eq c ?<)
  2565. (org-agenda-remove-restriction-lock 'noupdate)
  2566. (setq restriction
  2567. (cond
  2568. ((eq restriction 'buffer)
  2569. (if region-p 'region 'subtree))
  2570. ((memq restriction '(subtree region))
  2571. nil)
  2572. (t 'buffer))))
  2573. ((eq c ?>)
  2574. (org-agenda-remove-restriction-lock 'noupdate)
  2575. (setq restriction nil))
  2576. ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
  2577. (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
  2578. ((and (> (length selstring) 0) (eq c ?\d))
  2579. (delete-window)
  2580. (org-agenda-get-restriction-and-command prefix-descriptions))
  2581. ((equal c ?q) (error "Abort"))
  2582. (t (error "Invalid key %c" c))))))))
  2583. (defun org-agenda-fit-window-to-buffer ()
  2584. "Fit the window to the buffer size."
  2585. (and (memq org-agenda-window-setup '(reorganize-frame))
  2586. (fboundp 'fit-window-to-buffer)
  2587. (org-fit-window-to-buffer
  2588. nil
  2589. (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
  2590. (floor (* (frame-height) (car org-agenda-window-frame-fractions))))))
  2591. (defvar org-cmd nil)
  2592. (defvar org-agenda-overriding-cmd nil)
  2593. (defvar org-agenda-overriding-arguments nil)
  2594. (defvar org-agenda-overriding-cmd-arguments nil)
  2595. (defun org-agenda-run-series (name series)
  2596. (org-let (nth 1 series) '(org-agenda-prepare name))
  2597. ;; We need to reset agenda markers here, because when constructing a
  2598. ;; block agenda, the individual blocks do not do that.
  2599. (org-agenda-reset-markers)
  2600. (let* ((org-agenda-multi t)
  2601. (redo (list 'org-agenda-run-series name (list 'quote series)))
  2602. (cmds (car series))
  2603. (gprops (nth 1 series))
  2604. match ;; The byte compiler incorrectly complains about this. Keep it!
  2605. org-cmd type lprops)
  2606. (while (setq org-cmd (pop cmds))
  2607. (setq type (car org-cmd)
  2608. match (eval (nth 1 org-cmd))
  2609. lprops (nth 2 org-cmd))
  2610. (let ((org-agenda-overriding-arguments
  2611. (if (eq org-agenda-overriding-cmd org-cmd)
  2612. (or org-agenda-overriding-arguments
  2613. org-agenda-overriding-cmd-arguments))))
  2614. (cond
  2615. ((eq type 'agenda)
  2616. (org-let2 gprops lprops
  2617. '(call-interactively 'org-agenda-list)))
  2618. ((eq type 'alltodo)
  2619. (org-let2 gprops lprops
  2620. '(call-interactively 'org-todo-list)))
  2621. ((eq type 'search)
  2622. (org-let2 gprops lprops
  2623. '(org-search-view current-prefix-arg match nil)))
  2624. ((eq type 'stuck)
  2625. (org-let2 gprops lprops
  2626. '(call-interactively 'org-agenda-list-stuck-projects)))
  2627. ((eq type 'tags)
  2628. (org-let2 gprops lprops
  2629. '(org-tags-view current-prefix-arg match)))
  2630. ((eq type 'tags-todo)
  2631. (org-let2 gprops lprops
  2632. '(org-tags-view '(4) match)))
  2633. ((eq type 'todo)
  2634. (org-let2 gprops lprops
  2635. '(org-todo-list match)))
  2636. ((fboundp type)
  2637. (org-let2 gprops lprops
  2638. '(funcall type match)))
  2639. (t (error "Invalid type in command series")))))
  2640. (widen)
  2641. (let ((inhibit-read-only t))
  2642. (add-text-properties (point-min) (point-max)
  2643. `(org-series t org-series-redo-cmd ,redo)))
  2644. (setq org-agenda-redo-command redo)
  2645. (goto-char (point-min)))
  2646. (org-agenda-fit-window-to-buffer)
  2647. (org-let (nth 1 series) '(org-agenda-finalize)))
  2648. ;;;###autoload
  2649. (defmacro org-batch-agenda (cmd-key &rest parameters)
  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. (org-eval-in-environment (org-make-parameter-alist parameters)
  2657. (if (> (length cmd-key) 2)
  2658. (org-tags-view nil cmd-key)
  2659. (org-agenda nil cmd-key)))
  2660. (set-buffer org-agenda-buffer-name)
  2661. (princ (buffer-string)))
  2662. (autoload 'org-batch-agenda "org-agenda" "\
  2663. Run an agenda command in batch mode and send the result to STDOUT.
  2664. If CMD-KEY is a string of length 1, it is used as a key in
  2665. `org-agenda-custom-commands' and triggers this command. If it is a
  2666. longer string it is used as a tags/todo match string.
  2667. Parameters are alternating variable names and values that will be bound
  2668. before running the agenda command.
  2669. \(fn CMD-KEY &rest PARAMETERS)" nil t)
  2670. (def-edebug-spec org-batch-agenda (form &rest sexp))
  2671. (defvar org-agenda-info nil)
  2672. ;;;###autoload
  2673. (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
  2674. "Run an agenda command in batch mode and send the result to STDOUT.
  2675. If CMD-KEY is a string of length 1, it is used as a key in
  2676. `org-agenda-custom-commands' and triggers this command. If it is a
  2677. longer string it is used as a tags/todo match string.
  2678. Parameters are alternating variable names and values that will be bound
  2679. before running the agenda command.
  2680. The output gives a line for each selected agenda item. Each
  2681. item is a list of comma-separated values, like this:
  2682. category,head,type,todo,tags,date,time,extra,priority-l,priority-n
  2683. category The category of the item
  2684. head The headline, without TODO kwd, TAGS and PRIORITY
  2685. type The type of the agenda entry, can be
  2686. todo selected in TODO match
  2687. tagsmatch selected in tags match
  2688. diary imported from diary
  2689. deadline a deadline on given date
  2690. scheduled scheduled on given date
  2691. timestamp entry has timestamp on given date
  2692. closed entry was closed on given date
  2693. upcoming-deadline warning about deadline
  2694. past-scheduled forwarded scheduled item
  2695. block entry has date block including g. date
  2696. todo The todo keyword, if any
  2697. tags All tags including inherited ones, separated by colons
  2698. date The relevant date, like 2007-2-14
  2699. time The time, like 15:00-16:50
  2700. extra Sting with extra planning info
  2701. priority-l The priority letter if any was given
  2702. priority-n The computed numerical priority
  2703. agenda-day The day in the agenda where this is listed"
  2704. (org-eval-in-environment (append '((org-agenda-remove-tags t))
  2705. (org-make-parameter-alist parameters))
  2706. (if (> (length cmd-key) 2)
  2707. (org-tags-view nil cmd-key)
  2708. (org-agenda nil cmd-key)))
  2709. (set-buffer org-agenda-buffer-name)
  2710. (let* ((lines (org-split-string (buffer-string) "\n"))
  2711. line)
  2712. (while (setq line (pop lines))
  2713. (catch 'next
  2714. (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
  2715. (setq org-agenda-info
  2716. (org-fix-agenda-info (text-properties-at 0 line)))
  2717. (princ
  2718. (mapconcat 'org-agenda-export-csv-mapper
  2719. '(org-category txt type todo tags date time extra
  2720. priority-letter priority agenda-day)
  2721. ","))
  2722. (princ "\n")))))
  2723. (autoload 'org-batch-agenda-csv "org-agenda" "\
  2724. Run an agenda command in batch mode and send the result to STDOUT.
  2725. If CMD-KEY is a string of length 1, it is used as a key in
  2726. `org-agenda-custom-commands' and triggers this command. If it is a
  2727. longer string it is used as a tags/todo match string.
  2728. Parameters are alternating variable names and values that will be bound
  2729. before running the agenda command.
  2730. The output gives a line for each selected agenda item. Each
  2731. item is a list of comma-separated values, like this:
  2732. category,head,type,todo,tags,date,time,extra,priority-l,priority-n
  2733. category The category of the item
  2734. head The headline, without TODO kwd, TAGS and PRIORITY
  2735. type The type of the agenda entry, can be
  2736. todo selected in TODO match
  2737. tagsmatch selected in tags match
  2738. diary imported from diary
  2739. deadline a deadline on given date
  2740. scheduled scheduled on given date
  2741. timestamp entry has timestamp on given date
  2742. closed entry was closed on given date
  2743. upcoming-deadline warning about deadline
  2744. past-scheduled forwarded scheduled item
  2745. block entry has date block including g. date
  2746. todo The todo keyword, if any
  2747. tags All tags including inherited ones, separated by colons
  2748. date The relevant date, like 2007-2-14
  2749. time The time, like 15:00-16:50
  2750. extra Sting with extra planning info
  2751. priority-l The priority letter if any was given
  2752. priority-n The computed numerical priority
  2753. agenda-day The day in the agenda where this is listed
  2754. \(fn CMD-KEY &rest PARAMETERS)" nil t)
  2755. (def-edebug-spec org-batch-agenda-csv (form &rest sexp))
  2756. (defun org-fix-agenda-info (props)
  2757. "Make sure all properties on an agenda item have a canonical form.
  2758. This ensures the export commands can easily use it."
  2759. (let (tmp re)
  2760. (when (setq tmp (plist-get props 'tags))
  2761. (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
  2762. (when (setq tmp (plist-get props 'date))
  2763. (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2764. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2765. '((format "%4d, %9s %2s, %4s" dayname monthname day year))
  2766. (setq tmp (calendar-date-string tmp)))
  2767. (setq props (plist-put props 'date tmp)))
  2768. (when (setq tmp (plist-get props 'day))
  2769. (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2770. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2771. (setq tmp (calendar-date-string tmp)))
  2772. (setq props (plist-put props 'day tmp))
  2773. (setq props (plist-put props 'agenda-day tmp)))
  2774. (when (setq tmp (plist-get props 'txt))
  2775. (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
  2776. (plist-put props 'priority-letter (match-string 1 tmp))
  2777. (setq tmp (replace-match "" t t tmp)))
  2778. (when (and (setq re (plist-get props 'org-todo-regexp))
  2779. (setq re (concat "\\`\\.*" re " ?"))
  2780. (string-match re tmp))
  2781. (plist-put props 'todo (match-string 1 tmp))
  2782. (setq tmp (replace-match "" t t tmp)))
  2783. (plist-put props 'txt tmp)))
  2784. props)
  2785. (defun org-agenda-export-csv-mapper (prop)
  2786. (let ((res (plist-get org-agenda-info prop)))
  2787. (setq res
  2788. (cond
  2789. ((not res) "")
  2790. ((stringp res) res)
  2791. (t (prin1-to-string res))))
  2792. (while (string-match "," res)
  2793. (setq res (replace-match ";" t t res)))
  2794. (org-trim res)))
  2795. ;;;###autoload
  2796. (defun org-store-agenda-views (&rest parameters)
  2797. (interactive)
  2798. (eval (list 'org-batch-store-agenda-views)))
  2799. (autoload 'org-store-agenda-views "org-agenda" "\
  2800. \(fn &rest PARAMETERS)" t nil)
  2801. ;;;###autoload
  2802. (defmacro org-batch-store-agenda-views (&rest parameters)
  2803. "Run all custom agenda commands that have a file argument."
  2804. (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
  2805. (pop-up-frames nil)
  2806. (dir default-directory)
  2807. (pars (org-make-parameter-alist parameters))
  2808. cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
  2809. (save-window-excursion
  2810. (while cmds
  2811. (setq cmd (pop cmds)
  2812. thiscmdkey (car cmd)
  2813. thiscmdcmd (cdr cmd)
  2814. match (nth 2 thiscmdcmd)
  2815. bufname (if org-agenda-sticky
  2816. (or (and (stringp match)
  2817. (format "*Org Agenda(%s:%s)*" thiscmdkey match))
  2818. (format "*Org Agenda(%s)*" thiscmdkey))
  2819. org-agenda-buffer-name)
  2820. cmd-or-set (nth 2 cmd)
  2821. opts (nth (if (listp cmd-or-set) 3 4) cmd)
  2822. files (nth (if (listp cmd-or-set) 4 5) cmd))
  2823. (if (stringp files) (setq files (list files)))
  2824. (when files
  2825. (org-eval-in-environment (append org-agenda-exporter-settings
  2826. opts pars)
  2827. (org-agenda nil thiscmdkey))
  2828. (set-buffer bufname)
  2829. (while files
  2830. (org-eval-in-environment (append org-agenda-exporter-settings
  2831. opts pars)
  2832. (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
  2833. (and (get-buffer bufname)
  2834. (kill-buffer bufname)))))))
  2835. (autoload 'org-batch-store-agenda-views "org-agenda" "\
  2836. Run all custom agenda commands that have a file argument.
  2837. \(fn &rest PARAMETERS)" nil t)
  2838. (def-edebug-spec org-batch-store-agenda-views (&rest sexp))
  2839. (defvar org-agenda-current-span nil
  2840. "The current span used in the agenda view.") ; local variable in the agenda buffer
  2841. (defun org-agenda-mark-header-line (pos)
  2842. "Mark the line at POS as an agenda structure header."
  2843. (save-excursion
  2844. (goto-char pos)
  2845. (put-text-property (point-at-bol) (point-at-eol)
  2846. 'org-agenda-structural-header t)
  2847. (when org-agenda-title-append
  2848. (put-text-property (point-at-bol) (point-at-eol)
  2849. 'org-agenda-title-append org-agenda-title-append))))
  2850. (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
  2851. (defvar org-agenda-write-buffer-name "Agenda View")
  2852. (defun org-agenda-write (file &optional open nosettings agenda-bufname)
  2853. "Write the current buffer (an agenda view) as a file.
  2854. Depending on the extension of the file name, plain text (.txt),
  2855. HTML (.html or .htm) or Postscript (.ps) is produced.
  2856. If the extension is .ics, run icalendar export over all files used
  2857. to construct the agenda and limit the export to entries listed in the
  2858. agenda now.
  2859. With prefix argument OPEN, open the new file immediately.
  2860. If NOSETTINGS is given, do not scope the settings of
  2861. `org-agenda-exporter-settings' into the export commands. This is used when
  2862. the settings have already been scoped and we do not wish to overrule other,
  2863. higher priority settings.
  2864. If AGENDA-BUFFER-NAME, use this as the buffer name for the agenda to write."
  2865. (interactive "FWrite agenda to file: \nP")
  2866. (if (not (file-writable-p file))
  2867. (error "Cannot write agenda to file %s" file))
  2868. (org-let (if nosettings nil org-agenda-exporter-settings)
  2869. '(save-excursion
  2870. (save-window-excursion
  2871. (org-agenda-mark-filtered-text)
  2872. (let ((bs (copy-sequence (buffer-string))) beg)
  2873. (org-agenda-unmark-filtered-text)
  2874. (with-temp-buffer
  2875. (rename-buffer org-agenda-write-buffer-name t)
  2876. (set-buffer-modified-p nil)
  2877. (insert bs)
  2878. (org-agenda-remove-marked-text 'org-filtered)
  2879. (while (setq beg (text-property-any (point-min) (point-max)
  2880. 'org-filtered t))
  2881. (delete-region
  2882. beg (or (next-single-property-change beg 'org-filtered)
  2883. (point-max))))
  2884. (run-hooks 'org-agenda-before-write-hook)
  2885. (cond
  2886. ((org-bound-and-true-p org-mobile-creating-agendas)
  2887. (org-mobile-write-agenda-for-mobile file))
  2888. ((string-match "\\.html?\\'" file)
  2889. (require 'htmlize)
  2890. (set-buffer (htmlize-buffer (current-buffer)))
  2891. (when org-agenda-export-html-style
  2892. ;; replace <style> section with org-agenda-export-html-style
  2893. (goto-char (point-min))
  2894. (kill-region (- (search-forward "<style") 6)
  2895. (search-forward "</style>"))
  2896. (insert org-agenda-export-html-style))
  2897. (write-file file)
  2898. (kill-buffer (current-buffer))
  2899. (message "HTML written to %s" file))
  2900. ((string-match "\\.ps\\'" file)
  2901. (require 'ps-print)
  2902. (ps-print-buffer-with-faces file)
  2903. (message "Postscript written to %s" file))
  2904. ((string-match "\\.pdf\\'" file)
  2905. (require 'ps-print)
  2906. (ps-print-buffer-with-faces
  2907. (concat (file-name-sans-extension file) ".ps"))
  2908. (call-process "ps2pdf" nil nil nil
  2909. (expand-file-name
  2910. (concat (file-name-sans-extension file) ".ps"))
  2911. (expand-file-name file))
  2912. (delete-file (concat (file-name-sans-extension file) ".ps"))
  2913. (message "PDF written to %s" file))
  2914. ((string-match "\\.ics\\'" file)
  2915. (require 'org-icalendar)
  2916. (let ((org-agenda-marker-table
  2917. (org-create-marker-find-array
  2918. (org-agenda-collect-markers)))
  2919. (org-icalendar-verify-function 'org-check-agenda-marker-table)
  2920. (org-combined-agenda-icalendar-file file))
  2921. (apply 'org-export-icalendar 'combine
  2922. (org-agenda-files nil 'ifmode))))
  2923. (t
  2924. (let ((bs (buffer-string)))
  2925. (find-file file)
  2926. (erase-buffer)
  2927. (insert bs)
  2928. (save-buffer 0)
  2929. (kill-buffer (current-buffer))
  2930. (message "Plain text written to %s" file))))))))
  2931. (set-buffer (or agenda-bufname
  2932. (and (org-called-interactively-p 'any) (buffer-name))
  2933. org-agenda-buffer-name)))
  2934. (when open (org-open-file file)))
  2935. (defvar org-agenda-tag-filter-overlays nil)
  2936. (defvar org-agenda-cat-filter-overlays nil)
  2937. (defun org-agenda-mark-filtered-text ()
  2938. "Mark all text hidden by filtering with a text property."
  2939. (let ((inhibit-read-only t))
  2940. (mapc
  2941. (lambda (o)
  2942. (when (equal (overlay-buffer o) (current-buffer))
  2943. (put-text-property
  2944. (overlay-start o) (overlay-end o)
  2945. 'org-filtered t)))
  2946. (append org-agenda-tag-filter-overlays
  2947. org-agenda-cat-filter-overlays))))
  2948. (defun org-agenda-unmark-filtered-text ()
  2949. "Remove the filtering text property."
  2950. (let ((inhibit-read-only t))
  2951. (remove-text-properties (point-min) (point-max) '(org-filtered t))))
  2952. (defun org-agenda-remove-marked-text (property &optional value)
  2953. "Delete all text marked with VALUE of PROPERTY.
  2954. VALUE defaults to t."
  2955. (let (beg)
  2956. (setq value (or value t))
  2957. (while (setq beg (text-property-any (point-min) (point-max)
  2958. property value))
  2959. (delete-region
  2960. beg (or (next-single-property-change beg 'org-filtered)
  2961. (point-max))))))
  2962. (defun org-agenda-add-entry-text ()
  2963. "Add entry text to agenda lines.
  2964. This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
  2965. entry text following headings shown in the agenda.
  2966. Drawers will be excluded, also the line with scheduling/deadline info."
  2967. (when (and (> org-agenda-add-entry-text-maxlines 0)
  2968. (not (org-bound-and-true-p org-mobile-creating-agendas)))
  2969. (let (m txt)
  2970. (goto-char (point-min))
  2971. (while (not (eobp))
  2972. (if (not (setq m (org-get-at-bol 'org-hd-marker)))
  2973. (beginning-of-line 2)
  2974. (setq txt (org-agenda-get-some-entry-text
  2975. m org-agenda-add-entry-text-maxlines " > "))
  2976. (end-of-line 1)
  2977. (if (string-match "\\S-" txt)
  2978. (insert "\n" txt)
  2979. (or (eobp) (forward-char 1))))))))
  2980. (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
  2981. &rest keep)
  2982. "Extract entry text from MARKER, at most N-LINES lines.
  2983. This will ignore drawers etc, just get the text.
  2984. If INDENT is given, prefix every line with this string. If KEEP is
  2985. given, it is a list of symbols, defining stuff that should not be
  2986. removed from the entry content. Currently only `planning' is allowed here."
  2987. (let (txt drawer-re kwd-time-re ind)
  2988. (save-excursion
  2989. (with-current-buffer (marker-buffer marker)
  2990. (if (not (derived-mode-p 'org-mode))
  2991. (setq txt "")
  2992. (save-excursion
  2993. (save-restriction
  2994. (widen)
  2995. (goto-char marker)
  2996. (end-of-line 1)
  2997. (setq txt (buffer-substring
  2998. (min (1+ (point)) (point-max))
  2999. (progn (outline-next-heading) (point)))
  3000. drawer-re org-drawer-regexp
  3001. kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
  3002. ".*\n?"))
  3003. (with-temp-buffer
  3004. (insert txt)
  3005. (when org-agenda-add-entry-text-descriptive-links
  3006. (goto-char (point-min))
  3007. (while (org-activate-bracket-links (point-max))
  3008. (add-text-properties (match-beginning 0) (match-end 0)
  3009. '(face org-link))))
  3010. (goto-char (point-min))
  3011. (while (re-search-forward org-bracket-link-regexp (point-max) t)
  3012. (set-text-properties (match-beginning 0) (match-end 0)
  3013. nil))
  3014. (goto-char (point-min))
  3015. (while (re-search-forward drawer-re nil t)
  3016. (delete-region
  3017. (match-beginning 0)
  3018. (progn (re-search-forward
  3019. "^[ \t]*:END:.*\n?" nil 'move)
  3020. (point))))
  3021. (unless (member 'planning keep)
  3022. (goto-char (point-min))
  3023. (while (re-search-forward kwd-time-re nil t)
  3024. (replace-match "")))
  3025. (goto-char (point-min))
  3026. (when org-agenda-entry-text-exclude-regexps
  3027. (let ((re-list org-agenda-entry-text-exclude-regexps) re)
  3028. (while (setq re (pop re-list))
  3029. (goto-char (point-min))
  3030. (while (re-search-forward re nil t)
  3031. (replace-match "")))))
  3032. (goto-char (point-max))
  3033. (skip-chars-backward " \t\n")
  3034. (if (looking-at "[ \t\n]+\\'") (replace-match ""))
  3035. ;; find and remove min common indentation
  3036. (goto-char (point-min))
  3037. (untabify (point-min) (point-max))
  3038. (setq ind (org-get-indentation))
  3039. (while (not (eobp))
  3040. (unless (looking-at "[ \t]*$")
  3041. (setq ind (min ind (org-get-indentation))))
  3042. (beginning-of-line 2))
  3043. (goto-char (point-min))
  3044. (while (not (eobp))
  3045. (unless (looking-at "[ \t]*$")
  3046. (move-to-column ind)
  3047. (delete-region (point-at-bol) (point)))
  3048. (beginning-of-line 2))
  3049. (run-hooks 'org-agenda-entry-text-cleanup-hook)
  3050. (goto-char (point-min))
  3051. (when indent
  3052. (while (and (not (eobp)) (re-search-forward "^" nil t))
  3053. (replace-match indent t t)))
  3054. (goto-char (point-min))
  3055. (while (looking-at "[ \t]*\n") (replace-match ""))
  3056. (goto-char (point-max))
  3057. (when (> (org-current-line)
  3058. n-lines)
  3059. (org-goto-line (1+ n-lines))
  3060. (backward-char 1))
  3061. (setq txt (buffer-substring (point-min) (point)))))))))
  3062. txt))
  3063. (defun org-agenda-collect-markers ()
  3064. "Collect the markers pointing to entries in the agenda buffer."
  3065. (let (m markers)
  3066. (save-excursion
  3067. (goto-char (point-min))
  3068. (while (not (eobp))
  3069. (when (setq m (or (org-get-at-bol 'org-hd-marker)
  3070. (org-get-at-bol 'org-marker)))
  3071. (push m markers))
  3072. (beginning-of-line 2)))
  3073. (nreverse markers)))
  3074. (defun org-create-marker-find-array (marker-list)
  3075. "Create a alist of files names with all marker positions in that file."
  3076. (let (f tbl m a p)
  3077. (while (setq m (pop marker-list))
  3078. (setq p (marker-position m)
  3079. f (buffer-file-name (or (buffer-base-buffer
  3080. (marker-buffer m))
  3081. (marker-buffer m))))
  3082. (if (setq a (assoc f tbl))
  3083. (push (marker-position m) (cdr a))
  3084. (push (list f p) tbl)))
  3085. (mapcar (lambda (x) (setcdr x (sort (copy-sequence (cdr x)) '<)) x)
  3086. tbl)))
  3087. (defvar org-agenda-marker-table nil) ; dynamically scoped parameter
  3088. (defun org-check-agenda-marker-table ()
  3089. "Check of the current entry is on the marker list."
  3090. (let ((file (buffer-file-name (or (buffer-base-buffer) (current-buffer))))
  3091. a)
  3092. (and (setq a (assoc file org-agenda-marker-table))
  3093. (save-match-data
  3094. (save-excursion
  3095. (org-back-to-heading t)
  3096. (member (point) (cdr a)))))))
  3097. (defun org-check-for-org-mode ()
  3098. "Make sure current buffer is in org-mode. Error if not."
  3099. (or (derived-mode-p 'org-mode)
  3100. (error "Cannot execute org-mode agenda command on buffer in %s"
  3101. major-mode)))
  3102. ;;; Agenda prepare and finalize
  3103. (defvar org-agenda-multi nil) ; dynamically scoped
  3104. (defvar org-agenda-pre-window-conf nil)
  3105. (defvar org-agenda-columns-active nil)
  3106. (defvar org-agenda-name nil)
  3107. (defvar org-agenda-tag-filter nil)
  3108. (defvar org-agenda-category-filter nil)
  3109. (defvar org-agenda-top-category-filter nil)
  3110. (defvar org-agenda-tag-filter-while-redo nil)
  3111. (defvar org-agenda-tag-filter-preset nil
  3112. "A preset of the tags filter used for secondary agenda filtering.
  3113. This must be a list of strings, each string must be a single tag preceded
  3114. by \"+\" or \"-\".
  3115. This variable should not be set directly, but agenda custom commands can
  3116. bind it in the options section. The preset filter is a global property of
  3117. the entire agenda view. In a block agenda, it will not work reliably to
  3118. define a filter for one of the individual blocks. You need to set it in
  3119. the global options and expect it to be applied to the entire view.")
  3120. (defvar org-agenda-category-filter-preset nil
  3121. "A preset of the category filter used for secondary agenda filtering.
  3122. This must be a list of strings, each string must be a single category
  3123. preceded by \"+\" or \"-\".
  3124. This variable should not be set directly, but agenda custom commands can
  3125. bind it in the options section. The preset filter is a global property of
  3126. the entire agenda view. In a block agenda, it will not work reliably to
  3127. define a filter for one of the individual blocks. You need to set it in
  3128. the global options and expect it to be applied to the entire view.")
  3129. (defun org-agenda-use-sticky-p ()
  3130. "Return non-nil if an agenda buffer named
  3131. `org-agenda-buffer-name' exists and should be shown instead of
  3132. generating a new one."
  3133. (and
  3134. ;; turned off by user
  3135. org-agenda-sticky
  3136. ;; For multi-agenda buffer already exists
  3137. (not org-agenda-multi)
  3138. ;; buffer found
  3139. (get-buffer org-agenda-buffer-name)
  3140. ;; C-u parameter is same as last call
  3141. (with-current-buffer (get-buffer org-agenda-buffer-name)
  3142. (and
  3143. (equal current-prefix-arg
  3144. org-agenda-last-prefix-arg)
  3145. ;; In case user turned stickiness on, while having existing
  3146. ;; Agenda buffer active, don't reuse that buffer, because it
  3147. ;; does not have org variables local
  3148. org-agenda-this-buffer-is-sticky))))
  3149. (defun org-agenda-prepare-window (abuf)
  3150. "Setup agenda buffer in the window."
  3151. (let* ((awin (get-buffer-window abuf))
  3152. wconf)
  3153. (cond
  3154. ((equal (current-buffer) abuf) nil)
  3155. (awin (select-window awin))
  3156. ((not (setq wconf (current-window-configuration))))
  3157. ((equal org-agenda-window-setup 'current-window)
  3158. (org-pop-to-buffer-same-window abuf))
  3159. ((equal org-agenda-window-setup 'other-window)
  3160. (org-switch-to-buffer-other-window abuf))
  3161. ((equal org-agenda-window-setup 'other-frame)
  3162. (switch-to-buffer-other-frame abuf))
  3163. ((equal org-agenda-window-setup 'reorganize-frame)
  3164. (delete-other-windows)
  3165. (org-switch-to-buffer-other-window abuf)))
  3166. ;; additional test in case agenda is invoked from within agenda
  3167. ;; buffer via elisp link
  3168. (unless (equal (current-buffer) abuf)
  3169. (org-pop-to-buffer-same-window abuf))
  3170. (setq org-agenda-pre-window-conf
  3171. (or org-agenda-pre-window-conf wconf))))
  3172. (defun org-agenda-prepare (&optional name)
  3173. (if (org-agenda-use-sticky-p)
  3174. (progn
  3175. ;; Popup existing buffer
  3176. (org-agenda-prepare-window (get-buffer org-agenda-buffer-name))
  3177. (message "Sticky Agenda buffer, use `r' to refresh")
  3178. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3179. (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
  3180. (setq org-todo-keywords-for-agenda nil)
  3181. (setq org-drawers-for-agenda nil)
  3182. (unless org-agenda-persistent-filter
  3183. (setq org-agenda-tag-filter nil
  3184. org-agenda-category-filter nil))
  3185. (put 'org-agenda-tag-filter :preset-filter
  3186. org-agenda-tag-filter-preset)
  3187. (put 'org-agenda-category-filter :preset-filter
  3188. org-agenda-category-filter-preset)
  3189. (if org-agenda-multi
  3190. (progn
  3191. (setq buffer-read-only nil)
  3192. (goto-char (point-max))
  3193. (unless (or (bobp) org-agenda-compact-blocks
  3194. (not org-agenda-block-separator))
  3195. (insert "\n"
  3196. (if (stringp org-agenda-block-separator)
  3197. org-agenda-block-separator
  3198. (make-string (window-width) org-agenda-block-separator))
  3199. "\n"))
  3200. (narrow-to-region (point) (point-max)))
  3201. (setq org-done-keywords-for-agenda nil)
  3202. ;; Setting any org variables that are in org-agenda-local-vars
  3203. ;; list need to be done after the prepare call
  3204. (org-agenda-prepare-window (get-buffer-create org-agenda-buffer-name))
  3205. (setq buffer-read-only nil)
  3206. (org-agenda-reset-markers)
  3207. (let ((inhibit-read-only t)) (erase-buffer))
  3208. (org-agenda-mode)
  3209. (setq org-agenda-buffer (current-buffer))
  3210. (setq org-agenda-contributing-files nil)
  3211. (setq org-agenda-columns-active nil)
  3212. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  3213. (setq org-todo-keywords-for-agenda
  3214. (org-uniquify org-todo-keywords-for-agenda))
  3215. (setq org-done-keywords-for-agenda
  3216. (org-uniquify org-done-keywords-for-agenda))
  3217. (setq org-drawers-for-agenda (org-uniquify org-drawers-for-agenda))
  3218. (setq org-agenda-last-prefix-arg current-prefix-arg)
  3219. (setq org-agenda-this-buffer-name org-agenda-buffer-name)
  3220. (and name (not org-agenda-name)
  3221. (org-set-local 'org-agenda-name name)))
  3222. (setq buffer-read-only nil)))
  3223. (defvar org-agenda-overriding-columns-format) ; From org-colview.el
  3224. (defun org-agenda-finalize ()
  3225. "Finishing touch for the agenda buffer, called just before displaying it."
  3226. (unless org-agenda-multi
  3227. (save-excursion
  3228. (let ((inhibit-read-only t))
  3229. (goto-char (point-min))
  3230. (save-excursion
  3231. (while (org-activate-bracket-links (point-max))
  3232. (add-text-properties (match-beginning 0) (match-end 0)
  3233. '(face org-link))))
  3234. (save-excursion
  3235. (while (org-activate-plain-links (point-max))
  3236. (add-text-properties (match-beginning 0) (match-end 0)
  3237. '(face org-link))))
  3238. (unless (eq org-agenda-remove-tags t)
  3239. (org-agenda-align-tags))
  3240. (unless org-agenda-with-colors
  3241. (remove-text-properties (point-min) (point-max) '(face nil)))
  3242. (if (and (boundp 'org-agenda-overriding-columns-format)
  3243. org-agenda-overriding-columns-format)
  3244. (org-set-local 'org-agenda-overriding-columns-format
  3245. org-agenda-overriding-columns-format))
  3246. (if (and (boundp 'org-agenda-view-columns-initially)
  3247. org-agenda-view-columns-initially)
  3248. (org-agenda-columns))
  3249. (when org-agenda-fontify-priorities
  3250. (org-agenda-fontify-priorities))
  3251. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  3252. (org-agenda-dim-blocked-tasks))
  3253. ;; We need to widen when `org-agenda-finalize' is called from
  3254. ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in')
  3255. (when org-clock-current-task
  3256. (save-restriction
  3257. (widen)
  3258. (org-agenda-mark-clocking-task)))
  3259. (when org-agenda-entry-text-mode
  3260. (org-agenda-entry-text-hide)
  3261. (org-agenda-entry-text-show))
  3262. (if (and (functionp 'org-habit-insert-consistency-graphs)
  3263. (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
  3264. (org-habit-insert-consistency-graphs))
  3265. (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
  3266. (when (delq nil (mapcar (lambda (tp) (org-agenda-check-type nil tp))
  3267. org-agenda-use-tag-inheritance))
  3268. (let (mrk)
  3269. (save-excursion
  3270. (goto-char (point-min))
  3271. (while (equal (forward-line) 0)
  3272. (when (setq mrk (or (get-text-property (point) 'org-hd-marker)
  3273. (get-text-property (point) 'org-hd-marker)))
  3274. (put-text-property (point-at-bol) (point-at-eol)
  3275. 'tags (org-with-point-at mrk
  3276. (delete-dups
  3277. (mapcar 'downcase (org-get-tags-at))))))))))
  3278. (run-hooks 'org-agenda-finalize-hook)
  3279. (when (or org-agenda-tag-filter (get 'org-agenda-tag-filter :preset-filter))
  3280. (org-agenda-filter-apply org-agenda-tag-filter 'tag))
  3281. (when (or org-agenda-category-filter (get 'org-agenda-category-filter :preset-filter))
  3282. (org-agenda-filter-apply org-agenda-category-filter 'category))
  3283. (org-add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)))))
  3284. (defun org-agenda-mark-clocking-task ()
  3285. "Mark the current clock entry in the agenda if it is present."
  3286. (mapc (lambda (o)
  3287. (if (eq (overlay-get o 'type) 'org-agenda-clocking)
  3288. (delete-overlay o)))
  3289. (overlays-in (point-min) (point-max)))
  3290. (when (marker-buffer org-clock-hd-marker)
  3291. (save-excursion
  3292. (goto-char (point-min))
  3293. (let (s ov)
  3294. (while (setq s (next-single-property-change (point) 'org-hd-marker))
  3295. (goto-char s)
  3296. (when (equal (org-get-at-bol 'org-hd-marker)
  3297. org-clock-hd-marker)
  3298. (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
  3299. (overlay-put ov 'type 'org-agenda-clocking)
  3300. (overlay-put ov 'face 'org-agenda-clocking)
  3301. (overlay-put ov 'help-echo
  3302. "The clock is running in this item")))))))
  3303. (defun org-agenda-fontify-priorities ()
  3304. "Make highest priority lines bold, and lowest italic."
  3305. (interactive)
  3306. (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
  3307. (delete-overlay o)))
  3308. (overlays-in (point-min) (point-max)))
  3309. (save-excursion
  3310. (let ((inhibit-read-only t)
  3311. b e p ov h l)
  3312. (goto-char (point-min))
  3313. (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
  3314. (setq h (or (get-char-property (point) 'org-highest-priority)
  3315. org-highest-priority)
  3316. l (or (get-char-property (point) 'org-lowest-priority)
  3317. org-lowest-priority)
  3318. p (string-to-char (match-string 1))
  3319. b (match-beginning 0)
  3320. e (if (eq org-agenda-fontify-priorities 'cookies)
  3321. (match-end 0)
  3322. (point-at-eol))
  3323. ov (make-overlay b e))
  3324. (overlay-put
  3325. ov 'face
  3326. (cond ((org-face-from-face-or-color
  3327. 'priority nil
  3328. (cdr (assoc p org-priority-faces))))
  3329. ((and (listp org-agenda-fontify-priorities)
  3330. (org-face-from-face-or-color
  3331. 'priority nil
  3332. (cdr (assoc p org-agenda-fontify-priorities)))))
  3333. ((equal p l) 'italic)
  3334. ((equal p h) 'bold)))
  3335. (overlay-put ov 'org-type 'org-priority)))))
  3336. (defun org-agenda-dim-blocked-tasks (&optional invisible)
  3337. (interactive "P")
  3338. "Dim currently blocked TODO's in the agenda display."
  3339. (message "Dim or hide blocked tasks...")
  3340. (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-blocked-todo)
  3341. (delete-overlay o)))
  3342. (overlays-in (point-min) (point-max)))
  3343. (save-excursion
  3344. (let ((inhibit-read-only t)
  3345. (org-depend-tag-blocked nil)
  3346. (invis (or (not (null invisible))
  3347. (eq org-agenda-dim-blocked-tasks 'invisible)))
  3348. org-blocked-by-checkboxes
  3349. invis1 b e p ov h l)
  3350. (goto-char (point-min))
  3351. (while (let ((pos (next-single-property-change (point) 'todo-state)))
  3352. (and pos (goto-char (1+ pos))))
  3353. (setq org-blocked-by-checkboxes nil invis1 invis)
  3354. (let ((marker (org-get-at-bol 'org-hd-marker)))
  3355. (when (and marker
  3356. (with-current-buffer (marker-buffer marker)
  3357. (save-excursion (goto-char marker)
  3358. (org-entry-blocked-p))))
  3359. (if org-blocked-by-checkboxes (setq invis1 nil))
  3360. (setq b (if invis1
  3361. (max (point-min) (1- (point-at-bol)))
  3362. (point-at-bol))
  3363. e (point-at-eol)
  3364. ov (make-overlay b e))
  3365. (if invis1
  3366. (overlay-put ov 'invisible t)
  3367. (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
  3368. (overlay-put ov 'org-type 'org-blocked-todo))))))
  3369. (message "Dim or hide blocked tasks...done"))
  3370. (defvar org-agenda-skip-function nil
  3371. "Function to be called at each match during agenda construction.
  3372. If this function returns nil, the current match should not be skipped.
  3373. Otherwise, the function must return a position from where the search
  3374. should be continued.
  3375. This may also be a Lisp form, it will be evaluated.
  3376. Never set this variable using `setq' or so, because then it will apply
  3377. to all future agenda commands. If you do want a global skipping condition,
  3378. use the option `org-agenda-skip-function-global' instead.
  3379. The correct usage for `org-agenda-skip-function' is to bind it with
  3380. `let' to scope it dynamically into the agenda-constructing command.
  3381. A good way to set it is through options in `org-agenda-custom-commands'.")
  3382. (defun org-agenda-skip ()
  3383. "Throw to `:skip' in places that should be skipped.
  3384. Also moves point to the end of the skipped region, so that search can
  3385. continue from there."
  3386. (let ((p (point-at-bol)) to)
  3387. (when (org-in-src-block-p t) (throw :skip t))
  3388. (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
  3389. (get-text-property p :org-archived)
  3390. (org-end-of-subtree t)
  3391. (throw :skip t))
  3392. (and org-agenda-skip-comment-trees
  3393. (get-text-property p :org-comment)
  3394. (org-end-of-subtree t)
  3395. (throw :skip t))
  3396. (if (equal (char-after p) ?#) (throw :skip t))
  3397. (when (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
  3398. (org-agenda-skip-eval org-agenda-skip-function)))
  3399. (goto-char to)
  3400. (throw :skip t))))
  3401. (defun org-agenda-skip-eval (form)
  3402. "If FORM is a function or a list, call (or eval) is and return result.
  3403. `save-excursion' and `save-match-data' are wrapped around the call, so point
  3404. and match data are returned to the previous state no matter what these
  3405. functions do."
  3406. (let (fp)
  3407. (and form
  3408. (or (setq fp (functionp form))
  3409. (consp form))
  3410. (save-excursion
  3411. (save-match-data
  3412. (if fp
  3413. (funcall form)
  3414. (eval form)))))))
  3415. (defvar org-agenda-markers nil
  3416. "List of all currently active markers created by `org-agenda'.")
  3417. (defvar org-agenda-last-marker-time (org-float-time)
  3418. "Creation time of the last agenda marker.")
  3419. (defun org-agenda-new-marker (&optional pos)
  3420. "Return a new agenda marker.
  3421. Org-mode keeps a list of these markers and resets them when they are
  3422. no longer in use."
  3423. (let ((m (copy-marker (or pos (point)))))
  3424. (setq org-agenda-last-marker-time (org-float-time))
  3425. (if org-agenda-buffer
  3426. (with-current-buffer org-agenda-buffer
  3427. (push m org-agenda-markers))
  3428. (push m org-agenda-markers))
  3429. m))
  3430. (defun org-agenda-reset-markers ()
  3431. "Reset markers created by `org-agenda'."
  3432. (while org-agenda-markers
  3433. (move-marker (pop org-agenda-markers) nil)))
  3434. (defun org-agenda-save-markers-for-cut-and-paste (beg end)
  3435. "Save relative positions of markers in region.
  3436. This check for agenda markers in all agenda buffers currently active."
  3437. (dolist (buf (buffer-list))
  3438. (with-current-buffer buf
  3439. (when (eq major-mode 'org-agenda-mode)
  3440. (mapc (lambda (m) (org-check-and-save-marker m beg end))
  3441. org-agenda-markers)))))
  3442. ;;; Entry text mode
  3443. (defun org-agenda-entry-text-show-here ()
  3444. "Add some text from the entry as context to the current line."
  3445. (let (m txt o)
  3446. (setq m (org-get-at-bol 'org-hd-marker))
  3447. (unless (marker-buffer m)
  3448. (error "No marker points to an entry here"))
  3449. (setq txt (concat "\n" (org-no-properties
  3450. (org-agenda-get-some-entry-text
  3451. m org-agenda-entry-text-maxlines " > "))))
  3452. (when (string-match "\\S-" txt)
  3453. (setq o (make-overlay (point-at-bol) (point-at-eol)))
  3454. (overlay-put o 'evaporate t)
  3455. (overlay-put o 'org-overlay-type 'agenda-entry-content)
  3456. (overlay-put o 'after-string txt))))
  3457. (defun org-agenda-entry-text-show ()
  3458. "Add entry context for all agenda lines."
  3459. (interactive)
  3460. (save-excursion
  3461. (goto-char (point-max))
  3462. (beginning-of-line 1)
  3463. (while (not (bobp))
  3464. (when (org-get-at-bol 'org-hd-marker)
  3465. (org-agenda-entry-text-show-here))
  3466. (beginning-of-line 0))))
  3467. (defun org-agenda-entry-text-hide ()
  3468. "Remove any shown entry context."
  3469. (delq nil
  3470. (mapcar (lambda (o)
  3471. (if (eq (overlay-get o 'org-overlay-type)
  3472. 'agenda-entry-content)
  3473. (progn (delete-overlay o) t)))
  3474. (overlays-in (point-min) (point-max)))))
  3475. (defun org-agenda-get-day-face (date)
  3476. "Return the face DATE should be displayed with."
  3477. (or (and (functionp org-agenda-day-face-function)
  3478. (funcall org-agenda-day-face-function date))
  3479. (cond ((org-agenda-todayp date)
  3480. 'org-agenda-date-today)
  3481. ((member (calendar-day-of-week date) org-agenda-weekend-days)
  3482. 'org-agenda-date-weekend)
  3483. (t 'org-agenda-date))))
  3484. ;;; Agenda timeline
  3485. (defvar org-agenda-only-exact-dates nil) ; dynamically scoped
  3486. (defun org-timeline (&optional dotodo)
  3487. "Show a time-sorted view of the entries in the current org file.
  3488. Only entries with a time stamp of today or later will be listed. With
  3489. \\[universal-argument] prefix, all unfinished TODO items will also be shown,
  3490. under the current date.
  3491. If the buffer contains an active region, only check the region for
  3492. dates."
  3493. (interactive "P")
  3494. (let* ((dopast t)
  3495. (org-agenda-show-log-scoped org-agenda-show-log)
  3496. (entry (buffer-file-name (or (buffer-base-buffer (current-buffer))
  3497. (current-buffer))))
  3498. (date (calendar-current-date))
  3499. (beg (if (org-region-active-p) (region-beginning) (point-min)))
  3500. (end (if (org-region-active-p) (region-end) (point-max)))
  3501. (day-numbers (org-get-all-dates
  3502. beg end 'no-ranges
  3503. t org-agenda-show-log-scoped ; always include today
  3504. org-timeline-show-empty-dates))
  3505. (org-deadline-warning-days 0)
  3506. (org-agenda-only-exact-dates t)
  3507. (today (org-today))
  3508. (past t)
  3509. args
  3510. s e rtn d emptyp)
  3511. (setq org-agenda-redo-command
  3512. (list 'progn
  3513. (list 'org-switch-to-buffer-other-window (current-buffer))
  3514. (list 'org-timeline (list 'quote dotodo))))
  3515. (if (not dopast)
  3516. ;; Remove past dates from the list of dates.
  3517. (setq day-numbers (delq nil (mapcar (lambda(x)
  3518. (if (>= x today) x nil))
  3519. day-numbers))))
  3520. (org-agenda-prepare (concat "Timeline " (file-name-nondirectory entry)))
  3521. (org-compile-prefix-format 'timeline)
  3522. (org-set-sorting-strategy 'timeline)
  3523. (if org-agenda-show-log-scoped (push :closed args))
  3524. (push :timestamp args)
  3525. (push :deadline args)
  3526. (push :scheduled args)
  3527. (push :sexp args)
  3528. (if dotodo (push :todo args))
  3529. (insert "Timeline of file " entry "\n")
  3530. (add-text-properties (point-min) (point)
  3531. (list 'face 'org-agenda-structure))
  3532. (org-agenda-mark-header-line (point-min))
  3533. (while (setq d (pop day-numbers))
  3534. (if (and (listp d) (eq (car d) :omitted))
  3535. (progn
  3536. (setq s (point))
  3537. (insert (format "\n[... %d empty days omitted]\n\n" (cdr d)))
  3538. (put-text-property s (1- (point)) 'face 'org-agenda-structure))
  3539. (if (listp d) (setq d (car d) emptyp t) (setq emptyp nil))
  3540. (if (and (>= d today)
  3541. dopast
  3542. past)
  3543. (progn
  3544. (setq past nil)
  3545. (insert (make-string 79 ?-) "\n")))
  3546. (setq date (calendar-gregorian-from-absolute d))
  3547. (setq s (point))
  3548. (setq rtn (and (not emptyp)
  3549. (apply 'org-agenda-get-day-entries entry
  3550. date args)))
  3551. (if (or rtn (equal d today) org-timeline-show-empty-dates)
  3552. (progn
  3553. (insert
  3554. (if (stringp org-agenda-format-date)
  3555. (format-time-string org-agenda-format-date
  3556. (org-time-from-absolute date))
  3557. (funcall org-agenda-format-date date))
  3558. "\n")
  3559. (put-text-property s (1- (point)) 'face
  3560. (org-agenda-get-day-face date))
  3561. (put-text-property s (1- (point)) 'org-date-line t)
  3562. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3563. (if (equal d today)
  3564. (put-text-property s (1- (point)) 'org-today t))
  3565. (and rtn (insert (org-agenda-finalize-entries rtn) "\n"))
  3566. (put-text-property s (1- (point)) 'day d)))))
  3567. (goto-char (point-min))
  3568. (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
  3569. (point-min)))
  3570. (add-text-properties (point-min) (point-max) '(org-agenda-type timeline))
  3571. (org-agenda-finalize)
  3572. (setq buffer-read-only t)))
  3573. (defun org-get-all-dates (beg end &optional no-ranges force-today inactive empty pre-re)
  3574. "Return a list of all relevant day numbers from BEG to END buffer positions.
  3575. If NO-RANGES is non-nil, include only the start and end dates of a range,
  3576. not every single day in the range. If FORCE-TODAY is non-nil, make
  3577. sure that TODAY is included in the list. If INACTIVE is non-nil, also
  3578. inactive time stamps (those in square brackets) are included.
  3579. When EMPTY is non-nil, also include days without any entries."
  3580. (let ((re (concat
  3581. (if pre-re pre-re "")
  3582. (if inactive org-ts-regexp-both org-ts-regexp)))
  3583. dates dates1 date day day1 day2 ts1 ts2 pos)
  3584. (if force-today
  3585. (setq dates (list (org-today))))
  3586. (save-excursion
  3587. (goto-char beg)
  3588. (while (re-search-forward re end t)
  3589. (setq day (time-to-days (org-time-string-to-time
  3590. (substring (match-string 1) 0 10)
  3591. (current-buffer) (match-beginning 0))))
  3592. (or (memq day dates) (push day dates)))
  3593. (unless no-ranges
  3594. (goto-char beg)
  3595. (while (re-search-forward org-tr-regexp end t)
  3596. (setq pos (match-beginning 0))
  3597. (setq ts1 (substring (match-string 1) 0 10)
  3598. ts2 (substring (match-string 2) 0 10)
  3599. day1 (time-to-days (org-time-string-to-time
  3600. ts1 (current-buffer) pos))
  3601. day2 (time-to-days (org-time-string-to-time
  3602. ts2 (current-buffer) pos)))
  3603. (while (< (setq day1 (1+ day1)) day2)
  3604. (or (memq day1 dates) (push day1 dates)))))
  3605. (setq dates (sort dates '<))
  3606. (when empty
  3607. (while (setq day (pop dates))
  3608. (setq day2 (car dates))
  3609. (push day dates1)
  3610. (when (and day2 empty)
  3611. (if (or (eq empty t)
  3612. (and (numberp empty) (<= (- day2 day) empty)))
  3613. (while (< (setq day (1+ day)) day2)
  3614. (push (list day) dates1))
  3615. (push (cons :omitted (- day2 day)) dates1))))
  3616. (setq dates (nreverse dates1)))
  3617. dates)))
  3618. ;;; Agenda Daily/Weekly
  3619. (defvar org-agenda-start-day nil ; dynamically scoped parameter
  3620. "Start day for the agenda view.
  3621. Custom commands can set this variable in the options section.")
  3622. (defvar org-starting-day nil) ; local variable in the agenda buffer
  3623. (defvar org-arg-loc nil) ; local variable
  3624. (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
  3625. "List of types searched for when creating the daily/weekly agenda.
  3626. This variable is a list of symbols that controls the types of
  3627. items that appear in the daily/weekly agenda. Allowed symbols in this
  3628. list are are
  3629. :timestamp List items containing a date stamp or date range matching
  3630. the selected date. This includes sexp entries in
  3631. angular brackets.
  3632. :sexp List entries resulting from plain diary-like sexps.
  3633. :deadline List deadline due on that date. When the date is today,
  3634. also list any deadlines past due, or due within
  3635. `org-deadline-warning-days'. `:deadline' must appear before
  3636. `:scheduled' if the setting of
  3637. `org-agenda-skip-scheduled-if-deadline-is-shown' is to have
  3638. any effect.
  3639. :scheduled List all items which are scheduled for the given date.
  3640. The diary for *today* also contains items which were
  3641. scheduled earlier and are not yet marked DONE.
  3642. By default, all four types are turned on.
  3643. Never set this variable globally using `setq', because then it
  3644. will apply to all future agenda commands. Instead, bind it with
  3645. `let' to scope it dynamically into the agenda-constructing
  3646. command. A good way to set it is through options in
  3647. `org-agenda-custom-commands'. For a more flexible (though
  3648. somewhat less efficient) way of determining what is included in
  3649. the daily/weekly agenda, see `org-agenda-skip-function'.")
  3650. (defvar org-agenda-buffer-tmp-name nil)
  3651. ;;;###autoload
  3652. (defun org-agenda-list (&optional arg start-day span)
  3653. "Produce a daily/weekly view from all files in variable `org-agenda-files'.
  3654. The view will be for the current day or week, but from the overview buffer
  3655. you will be able to go to other days/weeks.
  3656. With a numeric prefix argument in an interactive call, the agenda will
  3657. span ARG days. Lisp programs should instead specify SPAN to change
  3658. the number of days. SPAN defaults to `org-agenda-span'.
  3659. START-DAY defaults to TODAY, or to the most recent match for the weekday
  3660. given in `org-agenda-start-on-weekday'."
  3661. (interactive "P")
  3662. (if org-agenda-overriding-arguments
  3663. (setq arg (car org-agenda-overriding-arguments)
  3664. start-day (nth 1 org-agenda-overriding-arguments)
  3665. span (nth 2 org-agenda-overriding-arguments)))
  3666. (if (and (integerp arg) (> arg 0))
  3667. (setq span arg arg nil))
  3668. (catch 'exit
  3669. (setq org-agenda-buffer-name
  3670. (or org-agenda-buffer-tmp-name
  3671. (if org-agenda-sticky
  3672. (cond ((and org-keys (stringp org-match))
  3673. (format "*Org Agenda(%s:%s)*" org-keys org-match))
  3674. (org-keys
  3675. (format "*Org Agenda(%s)*" org-keys))
  3676. (t "*Org Agenda(a)*")))
  3677. org-agenda-buffer-name))
  3678. (org-agenda-prepare "Day/Week")
  3679. (setq start-day (or start-day org-agenda-start-day))
  3680. (if (stringp start-day)
  3681. ;; Convert to an absolute day number
  3682. (setq start-day (time-to-days (org-read-date nil t start-day))))
  3683. (org-compile-prefix-format 'agenda)
  3684. (org-set-sorting-strategy 'agenda)
  3685. (let* ((span (org-agenda-ndays-to-span
  3686. (or span org-agenda-ndays org-agenda-span)))
  3687. (today (org-today))
  3688. (sd (or start-day today))
  3689. (ndays (org-agenda-span-to-ndays span sd))
  3690. (org-agenda-start-on-weekday
  3691. (if (eq ndays 7)
  3692. org-agenda-start-on-weekday))
  3693. (thefiles (org-agenda-files nil 'ifmode))
  3694. (files thefiles)
  3695. (start (if (or (null org-agenda-start-on-weekday)
  3696. (< ndays 7))
  3697. sd
  3698. (let* ((nt (calendar-day-of-week
  3699. (calendar-gregorian-from-absolute sd)))
  3700. (n1 org-agenda-start-on-weekday)
  3701. (d (- nt n1)))
  3702. (- sd (+ (if (< d 0) 7 0) d)))))
  3703. (day-numbers (list start))
  3704. (day-cnt 0)
  3705. (inhibit-redisplay (not debug-on-error))
  3706. (org-agenda-show-log-scoped org-agenda-show-log)
  3707. s e rtn rtnall file date d start-pos end-pos todayp
  3708. clocktable-start clocktable-end filter)
  3709. (setq org-agenda-redo-command
  3710. (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span)))
  3711. (dotimes (n (1- ndays))
  3712. (push (1+ (car day-numbers)) day-numbers))
  3713. (setq day-numbers (nreverse day-numbers))
  3714. (setq clocktable-start (car day-numbers)
  3715. clocktable-end (1+ (or (org-last day-numbers) 0)))
  3716. (org-set-local 'org-starting-day (car day-numbers))
  3717. (org-set-local 'org-arg-loc arg)
  3718. (org-set-local 'org-agenda-current-span (org-agenda-ndays-to-span span))
  3719. (unless org-agenda-compact-blocks
  3720. (let* ((d1 (car day-numbers))
  3721. (d2 (org-last day-numbers))
  3722. (w1 (org-days-to-iso-week d1))
  3723. (w2 (org-days-to-iso-week d2)))
  3724. (setq s (point))
  3725. (if org-agenda-overriding-header
  3726. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  3727. nil 'face 'org-agenda-structure) "\n")
  3728. (insert (org-agenda-span-name span)
  3729. "-agenda"
  3730. (if (< (- d2 d1) 350)
  3731. (if (= w1 w2)
  3732. (format " (W%02d)" w1)
  3733. (format " (W%02d-W%02d)" w1 w2))
  3734. "")
  3735. ":\n")))
  3736. (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
  3737. 'org-date-line t))
  3738. (org-agenda-mark-header-line s))
  3739. (while (setq d (pop day-numbers))
  3740. (setq date (calendar-gregorian-from-absolute d)
  3741. s (point))
  3742. (if (or (setq todayp (= d today))
  3743. (and (not start-pos) (= d sd)))
  3744. (setq start-pos (point))
  3745. (if (and start-pos (not end-pos))
  3746. (setq end-pos (point))))
  3747. (setq files thefiles
  3748. rtnall nil)
  3749. (while (setq file (pop files))
  3750. (catch 'nextfile
  3751. (org-check-agenda-file file)
  3752. (let ((org-agenda-entry-types org-agenda-entry-types))
  3753. (unless org-agenda-include-deadlines
  3754. (setq org-agenda-entry-types
  3755. (delq :deadline org-agenda-entry-types)))
  3756. (cond
  3757. ((memq org-agenda-show-log-scoped '(only clockcheck))
  3758. (setq rtn (org-agenda-get-day-entries
  3759. file date :closed)))
  3760. (org-agenda-show-log-scoped
  3761. (setq rtn (apply 'org-agenda-get-day-entries
  3762. file date
  3763. (append '(:closed) org-agenda-entry-types))))
  3764. (t
  3765. (setq rtn (apply 'org-agenda-get-day-entries
  3766. file date
  3767. org-agenda-entry-types)))))
  3768. (setq rtnall (append rtnall rtn)))) ;; all entries
  3769. (if org-agenda-include-diary
  3770. (let ((org-agenda-search-headline-for-time t))
  3771. (require 'diary-lib)
  3772. (setq rtn (org-get-entries-from-diary date))
  3773. (setq rtnall (append rtnall rtn))))
  3774. (if (or rtnall org-agenda-show-all-dates)
  3775. (progn
  3776. (setq day-cnt (1+ day-cnt))
  3777. (insert
  3778. (if (stringp org-agenda-format-date)
  3779. (format-time-string org-agenda-format-date
  3780. (org-time-from-absolute date))
  3781. (funcall org-agenda-format-date date))
  3782. "\n")
  3783. (put-text-property s (1- (point)) 'face
  3784. (org-agenda-get-day-face date))
  3785. (put-text-property s (1- (point)) 'org-date-line t)
  3786. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3787. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
  3788. (when todayp
  3789. (put-text-property s (1- (point)) 'org-today t))
  3790. (setq rtnall
  3791. (org-agenda-add-time-grid-maybe rtnall ndays todayp))
  3792. (if rtnall (insert ;; all entries
  3793. (org-agenda-finalize-entries rtnall)
  3794. "\n"))
  3795. (put-text-property s (1- (point)) 'day d)
  3796. (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
  3797. (when (and org-agenda-clockreport-mode clocktable-start)
  3798. (let ((org-agenda-files (org-agenda-files nil 'ifmode))
  3799. ;; the above line is to ensure the restricted range!
  3800. (p (copy-sequence org-agenda-clockreport-parameter-plist))
  3801. tbl)
  3802. (setq p (org-plist-delete p :block))
  3803. (setq p (plist-put p :tstart clocktable-start))
  3804. (setq p (plist-put p :tend clocktable-end))
  3805. (setq p (plist-put p :scope 'agenda))
  3806. (when (and (eq org-agenda-clockreport-mode 'with-filter)
  3807. (setq filter (or org-agenda-tag-filter-while-redo
  3808. (get 'org-agenda-tag-filter :preset-filter))))
  3809. (setq p (plist-put p :tags (mapconcat (lambda (x)
  3810. (if (string-match "[<>=]" x)
  3811. ""
  3812. x))
  3813. filter ""))))
  3814. (setq tbl (apply 'org-clock-get-clocktable p))
  3815. (insert tbl)))
  3816. (goto-char (point-min))
  3817. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3818. (unless (and (pos-visible-in-window-p (point-min))
  3819. (pos-visible-in-window-p (point-max)))
  3820. (goto-char (1- (point-max)))
  3821. (recenter -1)
  3822. (if (not (pos-visible-in-window-p (or start-pos 1)))
  3823. (progn
  3824. (goto-char (or start-pos 1))
  3825. (recenter 1))))
  3826. (goto-char (or start-pos 1))
  3827. (add-text-properties (point-min) (point-max)
  3828. `(org-agenda-type agenda
  3829. org-last-args (,arg ,start-day ,span)
  3830. org-redo-cmd ,org-agenda-redo-command
  3831. org-series-cmd ,org-cmd))
  3832. (if (eq org-agenda-show-log-scoped 'clockcheck)
  3833. (org-agenda-show-clocking-issues))
  3834. (org-agenda-finalize)
  3835. (setq buffer-read-only t)
  3836. (message ""))))
  3837. (autoload 'org-agenda-list "org-agenda" "\
  3838. Produce a daily/weekly view from all files in variable `org-agenda-files'.
  3839. The view will be for the current day or week, but from the overview buffer
  3840. you will be able to go to other days/weeks.
  3841. With a numeric prefix argument in an interactive call, the agenda will
  3842. span ARG days. Lisp programs should instead specify SPAN to change
  3843. the number of days. SPAN defaults to `org-agenda-span'.
  3844. START-DAY defaults to TODAY, or to the most recent match for the weekday
  3845. given in `org-agenda-start-on-weekday'.
  3846. \(fn &optional ARG START-DAY SPAN)" t nil)
  3847. (defun org-agenda-ndays-to-span (n)
  3848. "Return a span symbol for a span of N days, or N if none matches."
  3849. (cond ((symbolp n) n)
  3850. ((= n 1) 'day)
  3851. ((= n 7) 'week)
  3852. (t n)))
  3853. (defun org-agenda-span-to-ndays (span &optional start-day)
  3854. "Return ndays from SPAN, possibly starting at START-DAY."
  3855. (cond ((numberp span) span)
  3856. ((eq span 'day) 1)
  3857. ((eq span 'week) 7)
  3858. ((eq span 'month)
  3859. (let ((date (calendar-gregorian-from-absolute start-day)))
  3860. (calendar-last-day-of-month (car date) (caddr date))))
  3861. ((eq span 'year)
  3862. (let ((date (calendar-gregorian-from-absolute start-day)))
  3863. (if (calendar-leap-year-p (caddr date)) 366 365)))))
  3864. (defun org-agenda-span-name (span)
  3865. "Return a SPAN name."
  3866. (if (null span)
  3867. ""
  3868. (if (symbolp span)
  3869. (capitalize (symbol-name span))
  3870. (format "%d days" span))))
  3871. ;;; Agenda word search
  3872. (defvar org-agenda-search-history nil)
  3873. (defvar org-search-syntax-table nil
  3874. "Special syntax table for org-mode search.
  3875. In this table, we have single quotes not as word constituents, to
  3876. that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
  3877. (defvar org-mode-syntax-table) ; From org.el
  3878. (defun org-search-syntax-table ()
  3879. (unless org-search-syntax-table
  3880. (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
  3881. (modify-syntax-entry ?' "." org-search-syntax-table)
  3882. (modify-syntax-entry ?` "." org-search-syntax-table))
  3883. org-search-syntax-table)
  3884. (defvar org-agenda-last-search-view-search-was-boolean nil)
  3885. ;;;###autoload
  3886. (defun org-search-view (&optional todo-only string edit-at)
  3887. "Show all entries that contain a phrase or words or regular expressions.
  3888. With optional prefix argument TODO-ONLY, only consider entries that are
  3889. TODO entries. The argument STRING can be used to pass a default search
  3890. string into this function. If EDIT-AT is non-nil, it means that the
  3891. user should get a chance to edit this string, with cursor at position
  3892. EDIT-AT.
  3893. The search string can be viewed either as a phrase that should be found as
  3894. is, or it can be broken into a number of snippets, each of which must match
  3895. in a Boolean way to select an entry. The default depends on the variable
  3896. `org-agenda-search-view-always-boolean'.
  3897. Even if this is turned off (the default) you can always switch to
  3898. Boolean search dynamically by preceding the first word with \"+\" or \"-\".
  3899. The default is a direct search of the whole phrase, where each space in
  3900. the search string can expand to an arbitrary amount of whitespace,
  3901. including newlines.
  3902. If using a Boolean search, the search string is split on whitespace and
  3903. each snippet is searched separately, with logical AND to select an entry.
  3904. Words prefixed with a minus must *not* occur in the entry. Words without
  3905. a prefix or prefixed with a plus must occur in the entry. Matching is
  3906. case-insensitive. Words are enclosed by word delimiters (i.e. they must
  3907. match whole words, not parts of a word) if
  3908. `org-agenda-search-view-force-full-words' is set (default is nil).
  3909. Boolean search snippets enclosed by curly braces are interpreted as
  3910. regular expressions that must or (when preceded with \"-\") must not
  3911. match in the entry. Snippets enclosed into double quotes will be taken
  3912. as a whole, to include whitespace.
  3913. - If the search string starts with an asterisk, search only in headlines.
  3914. - If (possibly after the leading star) the search string starts with an
  3915. exclamation mark, this also means to look at TODO entries only, an effect
  3916. that can also be achieved with a prefix argument.
  3917. - If (possibly after star and exclamation mark) the search string starts
  3918. with a colon, this will mean that the (non-regexp) snippets of the
  3919. Boolean search must match as full words.
  3920. This command searches the agenda files, and in addition the files listed
  3921. in `org-agenda-text-search-extra-files'."
  3922. (interactive "P")
  3923. (if org-agenda-overriding-arguments
  3924. (setq todo-only (car org-agenda-overriding-arguments)
  3925. string (nth 1 org-agenda-overriding-arguments)
  3926. edit-at (nth 2 org-agenda-overriding-arguments)))
  3927. (let* ((props (list 'face nil
  3928. 'done-face 'org-agenda-done
  3929. 'org-not-done-regexp org-not-done-regexp
  3930. 'org-todo-regexp org-todo-regexp
  3931. 'org-complex-heading-regexp org-complex-heading-regexp
  3932. 'mouse-face 'highlight
  3933. 'help-echo (format "mouse-2 or RET jump to location")))
  3934. (full-words org-agenda-search-view-force-full-words)
  3935. (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
  3936. regexp rtn rtnall files file pos
  3937. marker category category-pos level tags c neg re boolean
  3938. ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
  3939. (unless (and (not edit-at)
  3940. (stringp string)
  3941. (string-match "\\S-" string))
  3942. (setq string (read-string
  3943. (if org-agenda-search-view-always-boolean
  3944. "[+-]Word/{Regexp} ...: "
  3945. "Phrase or [+-]Word/{Regexp} ...: ")
  3946. (cond
  3947. ((integerp edit-at) (cons string edit-at))
  3948. (edit-at string))
  3949. 'org-agenda-search-history)))
  3950. (catch 'exit
  3951. (if org-agenda-sticky
  3952. (setq org-agenda-buffer-name
  3953. (if (stringp string)
  3954. (format "*Org Agenda(%s:%s)*"
  3955. (or org-keys (or (and todo-only "S") "s")) string)
  3956. (format "*Org Agenda(%s)*" (or (and todo-only "S") "s")))))
  3957. (org-agenda-prepare "SEARCH")
  3958. (org-compile-prefix-format 'search)
  3959. (org-set-sorting-strategy 'search)
  3960. (setq org-agenda-redo-command
  3961. (list 'org-search-view (if todo-only t nil)
  3962. (list 'if 'current-prefix-arg nil string)))
  3963. (setq org-agenda-query-string string)
  3964. (if (equal (string-to-char string) ?*)
  3965. (setq hdl-only t
  3966. words (substring string 1))
  3967. (setq words string))
  3968. (when (equal (string-to-char words) ?!)
  3969. (setq todo-only t
  3970. words (substring words 1)))
  3971. (when (equal (string-to-char words) ?:)
  3972. (setq full-words t
  3973. words (substring words 1)))
  3974. (if (or org-agenda-search-view-always-boolean
  3975. (member (string-to-char words) '(?- ?+ ?\{)))
  3976. (setq boolean t))
  3977. (setq words (org-split-string words))
  3978. (let (www w)
  3979. (while (setq w (pop words))
  3980. (while (and (string-match "\\\\\\'" w) words)
  3981. (setq w (concat (substring w 0 -1) " " (pop words))))
  3982. (push w www))
  3983. (setq words (nreverse www) www nil)
  3984. (while (setq w (pop words))
  3985. (when (and (string-match "\\`[-+]?{" w)
  3986. (not (string-match "}\\'" w)))
  3987. (while (and words (not (string-match "}\\'" (car words))))
  3988. (setq w (concat w " " (pop words))))
  3989. (setq w (concat w " " (pop words))))
  3990. (push w www))
  3991. (setq words (nreverse www)))
  3992. (setq org-agenda-last-search-view-search-was-boolean boolean)
  3993. (when boolean
  3994. (let (wds w)
  3995. (while (setq w (pop words))
  3996. (if (or (equal (substring w 0 1) "\"")
  3997. (and (> (length w) 1)
  3998. (member (substring w 0 1) '("+" "-"))
  3999. (equal (substring w 1 2) "\"")))
  4000. (while (and words (not (equal (substring w -1) "\"")))
  4001. (setq w (concat w " " (pop words)))))
  4002. (and (string-match "\\`\\([-+]?\\)\"" w)
  4003. (setq w (replace-match "\\1" nil nil w)))
  4004. (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
  4005. (push w wds))
  4006. (setq words (nreverse wds))))
  4007. (if boolean
  4008. (mapc (lambda (w)
  4009. (setq c (string-to-char w))
  4010. (if (equal c ?-)
  4011. (setq neg t w (substring w 1))
  4012. (if (equal c ?+)
  4013. (setq neg nil w (substring w 1))
  4014. (setq neg nil)))
  4015. (if (string-match "\\`{.*}\\'" w)
  4016. (setq re (substring w 1 -1))
  4017. (if full-words
  4018. (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
  4019. (setq re (regexp-quote (downcase w)))))
  4020. (if neg (push re regexps-) (push re regexps+)))
  4021. words)
  4022. (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
  4023. regexps+))
  4024. (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
  4025. (if (not regexps+)
  4026. (setq regexp org-outline-regexp-bol)
  4027. (setq regexp (pop regexps+))
  4028. (if hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
  4029. regexp))))
  4030. (setq files (org-agenda-files nil 'ifmode))
  4031. (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
  4032. (pop org-agenda-text-search-extra-files)
  4033. (setq files (org-add-archive-files files)))
  4034. (setq files (append files org-agenda-text-search-extra-files)
  4035. rtnall nil)
  4036. (while (setq file (pop files))
  4037. (setq ee nil)
  4038. (catch 'nextfile
  4039. (org-check-agenda-file file)
  4040. (setq buffer (if (file-exists-p file)
  4041. (org-get-agenda-file-buffer file)
  4042. (error "No such file %s" file)))
  4043. (if (not buffer)
  4044. ;; If file does not exist, make sure an error message is sent
  4045. (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
  4046. file))))
  4047. (with-current-buffer buffer
  4048. (with-syntax-table (org-search-syntax-table)
  4049. (unless (derived-mode-p 'org-mode)
  4050. (error "Agenda file %s is not in `org-mode'" file))
  4051. (let ((case-fold-search t))
  4052. (save-excursion
  4053. (save-restriction
  4054. (if org-agenda-restrict
  4055. (narrow-to-region org-agenda-restrict-begin
  4056. org-agenda-restrict-end)
  4057. (widen))
  4058. (goto-char (point-min))
  4059. (unless (or (org-at-heading-p)
  4060. (outline-next-heading))
  4061. (throw 'nextfile t))
  4062. (goto-char (max (point-min) (1- (point))))
  4063. (while (re-search-forward regexp nil t)
  4064. (org-back-to-heading t)
  4065. (while (and org-agenda-search-view-max-outline-level
  4066. (> (org-reduced-level (org-outline-level))
  4067. org-agenda-search-view-max-outline-level)
  4068. (forward-line -1)
  4069. (outline-back-to-heading t)))
  4070. (skip-chars-forward "* ")
  4071. (setq beg (point-at-bol)
  4072. beg1 (point)
  4073. end (progn
  4074. (outline-next-heading)
  4075. (while (and org-agenda-search-view-max-outline-level
  4076. (> (org-reduced-level (org-outline-level))
  4077. org-agenda-search-view-max-outline-level)
  4078. (forward-line 1)
  4079. (outline-next-heading)))
  4080. (point)))
  4081. (catch :skip
  4082. (goto-char beg)
  4083. (org-agenda-skip)
  4084. (setq str (buffer-substring-no-properties
  4085. (point-at-bol)
  4086. (if hdl-only (point-at-eol) end)))
  4087. (mapc (lambda (wr) (when (string-match wr str)
  4088. (goto-char (1- end))
  4089. (throw :skip t)))
  4090. regexps-)
  4091. (mapc (lambda (wr) (unless (string-match wr str)
  4092. (goto-char (1- end))
  4093. (throw :skip t)))
  4094. (if todo-only
  4095. (cons (concat "^\*+[ \t]+" org-not-done-regexp)
  4096. regexps+)
  4097. regexps+))
  4098. (goto-char beg)
  4099. (setq marker (org-agenda-new-marker (point))
  4100. category (org-get-category)
  4101. level (make-string (org-reduced-level (org-outline-level)) ? )
  4102. category-pos (get-text-property (point) 'org-category-position)
  4103. tags (org-get-tags-at nil t)
  4104. txt (org-agenda-format-item
  4105. ""
  4106. (buffer-substring-no-properties
  4107. beg1 (point-at-eol))
  4108. level category tags t))
  4109. (org-add-props txt props
  4110. 'org-marker marker 'org-hd-marker marker
  4111. 'org-todo-regexp org-todo-regexp
  4112. 'level level
  4113. 'org-complex-heading-regexp org-complex-heading-regexp
  4114. 'priority 1000 'org-category category
  4115. 'org-category-position category-pos
  4116. 'type "search")
  4117. (push txt ee)
  4118. (goto-char (1- end))))))))))
  4119. (setq rtn (nreverse ee))
  4120. (setq rtnall (append rtnall rtn)))
  4121. (if org-agenda-overriding-header
  4122. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4123. nil 'face 'org-agenda-structure) "\n")
  4124. (insert "Search words: ")
  4125. (add-text-properties (point-min) (1- (point))
  4126. (list 'face 'org-agenda-structure))
  4127. (setq pos (point))
  4128. (insert string "\n")
  4129. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4130. (setq pos (point))
  4131. (unless org-agenda-multi
  4132. (insert "Press `[', `]' to add/sub word, `{', `}' to add/sub regexp, `C-u r' to edit\n")
  4133. (add-text-properties pos (1- (point))
  4134. (list 'face 'org-agenda-structure))))
  4135. (org-agenda-mark-header-line (point-min))
  4136. (when rtnall
  4137. (insert (org-agenda-finalize-entries rtnall) "\n"))
  4138. (goto-char (point-min))
  4139. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4140. (add-text-properties (point-min) (point-max)
  4141. `(org-agenda-type search
  4142. org-last-args (,todo-only ,string ,edit-at)
  4143. org-redo-cmd ,org-agenda-redo-command
  4144. org-series-cmd ,org-cmd))
  4145. (org-agenda-finalize)
  4146. (setq buffer-read-only t))))
  4147. (autoload 'org-search-view "org-agenda" "\
  4148. Show all entries that contain a phrase or words or regular expressions.
  4149. With optional prefix argument TODO-ONLY, only consider entries that are
  4150. TODO entries. The argument STRING can be used to pass a default search
  4151. string into this function. If EDIT-AT is non-nil, it means that the
  4152. user should get a chance to edit this string, with cursor at position
  4153. EDIT-AT.
  4154. The search string can be viewed either as a phrase that should be found as
  4155. is, or it can be broken into a number of snippets, each of which must match
  4156. in a Boolean way to select an entry. The default depends on the variable
  4157. `org-agenda-search-view-always-boolean'.
  4158. Even if this is turned off (the default) you can always switch to
  4159. Boolean search dynamically by preceding the first word with \"+\" or \"-\".
  4160. The default is a direct search of the whole phrase, where each space in
  4161. the search string can expand to an arbitrary amount of whitespace,
  4162. including newlines.
  4163. If using a Boolean search, the search string is split on whitespace and
  4164. each snippet is searched separately, with logical AND to select an entry.
  4165. Words prefixed with a minus must *not* occur in the entry. Words without
  4166. a prefix or prefixed with a plus must occur in the entry. Matching is
  4167. case-insensitive. Words are enclosed by word delimiters (i.e. they must
  4168. match whole words, not parts of a word) if
  4169. `org-agenda-search-view-force-full-words' is set (default is nil).
  4170. Boolean search snippets enclosed by curly braces are interpreted as
  4171. regular expressions that must or (when preceded with \"-\") must not
  4172. match in the entry. Snippets enclosed into double quotes will be taken
  4173. as a whole, to include whitespace.
  4174. - If the search string starts with an asterisk, search only in headlines.
  4175. - If (possibly after the leading star) the search string starts with an
  4176. exclamation mark, this also means to look at TODO entries only, an effect
  4177. that can also be achieved with a prefix argument.
  4178. - If (possibly after star and exclamation mark) the search string starts
  4179. with a colon, this will mean that the (non-regexp) snippets of the
  4180. Boolean search must match as full words.
  4181. This command searches the agenda files, and in addition the files listed
  4182. in `org-agenda-text-search-extra-files'.
  4183. \(fn &optional TODO-ONLY STRING EDIT-AT)" t nil)
  4184. ;;; Agenda TODO list
  4185. (defun org-agenda-propertize-selected-todo-keywords (keywords)
  4186. "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
  4187. (concat
  4188. (if (or (equal keywords "ALL") (not keywords))
  4189. (propertize "ALL" 'face 'warning)
  4190. (mapconcat
  4191. (lambda (kw)
  4192. (propertize kw 'face (org-get-todo-face kw)))
  4193. (org-split-string keywords "|")
  4194. "|"))
  4195. "\n"))
  4196. (defvar org-select-this-todo-keyword nil)
  4197. (defvar org-last-arg nil)
  4198. ;;;###autoload
  4199. (defun org-todo-list (&optional arg)
  4200. "Show all (not done) TODO entries from all agenda file in a single list.
  4201. The prefix arg can be used to select a specific TODO keyword and limit
  4202. the list to these. When using \\[universal-argument], you will be prompted
  4203. for a keyword. A numeric prefix directly selects the Nth keyword in
  4204. `org-todo-keywords-1'."
  4205. (interactive "P")
  4206. (if org-agenda-overriding-arguments
  4207. (setq arg org-agenda-overriding-arguments))
  4208. (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
  4209. (let* ((today (org-today))
  4210. (date (calendar-gregorian-from-absolute today))
  4211. (kwds org-todo-keywords-for-agenda)
  4212. (completion-ignore-case t)
  4213. (org-select-this-todo-keyword
  4214. (if (stringp arg) arg
  4215. (and arg (integerp arg) (> arg 0)
  4216. (nth (1- arg) kwds))))
  4217. rtn rtnall files file pos)
  4218. (when (equal arg '(4))
  4219. (setq org-select-this-todo-keyword
  4220. (org-icompleting-read "Keyword (or KWD1|K2D2|...): "
  4221. (mapcar 'list kwds) nil nil)))
  4222. (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
  4223. (catch 'exit
  4224. (if org-agenda-sticky
  4225. (setq org-agenda-buffer-name
  4226. (if (stringp org-select-this-todo-keyword)
  4227. (format "*Org Agenda(%s:%s)*" (or org-keys "t")
  4228. org-select-this-todo-keyword)
  4229. (format "*Org Agenda(%s)*" (or org-keys "t")))))
  4230. (org-agenda-prepare "TODO")
  4231. (org-compile-prefix-format 'todo)
  4232. (org-set-sorting-strategy 'todo)
  4233. (setq org-agenda-redo-command
  4234. `(org-todo-list (or (and (numberp current-prefix-arg)
  4235. current-prefix-arg)
  4236. ,org-select-this-todo-keyword
  4237. current-prefix-arg ,arg)))
  4238. (setq files (org-agenda-files nil 'ifmode)
  4239. rtnall nil)
  4240. (while (setq file (pop files))
  4241. (catch 'nextfile
  4242. (org-check-agenda-file file)
  4243. (setq rtn (org-agenda-get-day-entries file date :todo))
  4244. (setq rtnall (append rtnall rtn))))
  4245. (if org-agenda-overriding-header
  4246. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4247. nil 'face 'org-agenda-structure) "\n")
  4248. (insert "Global list of TODO items of type: ")
  4249. (add-text-properties (point-min) (1- (point))
  4250. (list 'face 'org-agenda-structure
  4251. 'short-heading
  4252. (concat "ToDo: "
  4253. (or org-select-this-todo-keyword "ALL"))))
  4254. (org-agenda-mark-header-line (point-min))
  4255. (insert (org-agenda-propertize-selected-todo-keywords
  4256. org-select-this-todo-keyword))
  4257. (setq pos (point))
  4258. (unless org-agenda-multi
  4259. (insert "Available with `N r': (0)[ALL]")
  4260. (let ((n 0) s)
  4261. (mapc (lambda (x)
  4262. (setq s (format "(%d)%s" (setq n (1+ n)) x))
  4263. (if (> (+ (current-column) (string-width s) 1) (frame-width))
  4264. (insert "\n "))
  4265. (insert " " s))
  4266. kwds))
  4267. (insert "\n"))
  4268. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
  4269. (org-agenda-mark-header-line (point-min))
  4270. (when rtnall
  4271. (insert (org-agenda-finalize-entries rtnall) "\n"))
  4272. (goto-char (point-min))
  4273. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4274. (add-text-properties (point-min) (point-max)
  4275. `(org-agenda-type todo
  4276. org-last-args ,arg
  4277. org-redo-cmd ,org-agenda-redo-command
  4278. org-series-cmd ,org-cmd))
  4279. (org-agenda-finalize)
  4280. (setq buffer-read-only t))))
  4281. (autoload 'org-todo-list "org-agenda" "\
  4282. Show all (not done) TODO entries from all agenda file in a single list.
  4283. The prefix arg can be used to select a specific TODO keyword and limit
  4284. the list to these. When using \\[universal-argument], you will be prompted
  4285. for a keyword. A numeric prefix directly selects the Nth keyword in
  4286. `org-todo-keywords-1'.
  4287. \(fn &optional ARG)" t nil)
  4288. ;;; Agenda tags match
  4289. ;;;###autoload
  4290. (defun org-tags-view (&optional todo-only match)
  4291. "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
  4292. The prefix arg TODO-ONLY limits the search to TODO entries."
  4293. (interactive "P")
  4294. (if org-agenda-overriding-arguments
  4295. (setq todo-only (car org-agenda-overriding-arguments)
  4296. match (nth 1 org-agenda-overriding-arguments)))
  4297. (let* ((org-tags-match-list-sublevels
  4298. org-tags-match-list-sublevels)
  4299. (completion-ignore-case t)
  4300. rtn rtnall files file pos matcher
  4301. buffer)
  4302. (when (and (stringp match) (not (string-match "\\S-" match)))
  4303. (setq match nil))
  4304. (setq matcher (org-make-tags-matcher match)
  4305. match (car matcher) matcher (cdr matcher))
  4306. (catch 'exit
  4307. (if org-agenda-sticky
  4308. (setq org-agenda-buffer-name
  4309. (if (stringp match)
  4310. (format "*Org Agenda(%s:%s)*"
  4311. (or org-keys (or (and todo-only "M") "m")) match)
  4312. (format "*Org Agenda(%s)*" (or (and todo-only "M") "m")))))
  4313. (org-agenda-prepare (concat "TAGS " match))
  4314. (org-compile-prefix-format 'tags)
  4315. (org-set-sorting-strategy 'tags)
  4316. (setq org-agenda-query-string match)
  4317. (setq org-agenda-redo-command
  4318. (list 'org-tags-view `(quote ,todo-only)
  4319. (list 'if 'current-prefix-arg nil `(quote ,org-agenda-query-string))))
  4320. (setq files (org-agenda-files nil 'ifmode)
  4321. rtnall nil)
  4322. (while (setq file (pop files))
  4323. (catch 'nextfile
  4324. (org-check-agenda-file file)
  4325. (setq buffer (if (file-exists-p file)
  4326. (org-get-agenda-file-buffer file)
  4327. (error "No such file %s" file)))
  4328. (if (not buffer)
  4329. ;; If file does not exist, error message to agenda
  4330. (setq rtn (list
  4331. (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4332. rtnall (append rtnall rtn))
  4333. (with-current-buffer buffer
  4334. (unless (derived-mode-p 'org-mode)
  4335. (error "Agenda file %s is not in `org-mode'" file))
  4336. (save-excursion
  4337. (save-restriction
  4338. (if org-agenda-restrict
  4339. (narrow-to-region org-agenda-restrict-begin
  4340. org-agenda-restrict-end)
  4341. (widen))
  4342. (setq rtn (org-scan-tags 'agenda matcher todo-only))
  4343. (setq rtnall (append rtnall rtn))))))))
  4344. (if org-agenda-overriding-header
  4345. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4346. nil 'face 'org-agenda-structure) "\n")
  4347. (insert "Headlines with TAGS match: ")
  4348. (add-text-properties (point-min) (1- (point))
  4349. (list 'face 'org-agenda-structure
  4350. 'short-heading
  4351. (concat "Match: " match)))
  4352. (setq pos (point))
  4353. (insert match "\n")
  4354. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4355. (setq pos (point))
  4356. (unless org-agenda-multi
  4357. (insert "Press `C-u r' to search again with new search string\n"))
  4358. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
  4359. (org-agenda-mark-header-line (point-min))
  4360. (when rtnall
  4361. (insert (org-agenda-finalize-entries rtnall) "\n"))
  4362. (goto-char (point-min))
  4363. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4364. (add-text-properties (point-min) (point-max)
  4365. `(org-agenda-type tags
  4366. org-last-args (,todo-only ,match)
  4367. org-redo-cmd ,org-agenda-redo-command
  4368. org-series-cmd ,org-cmd))
  4369. (org-agenda-finalize)
  4370. (setq buffer-read-only t))))
  4371. (autoload 'org-tags-view "org-agenda" "\
  4372. Show all headlines for all `org-agenda-files' matching a TAGS criterion.
  4373. The prefix arg TODO-ONLY limits the search to TODO entries.
  4374. \(fn &optional TODO-ONLY MATCH)" t nil)
  4375. ;;; Agenda Finding stuck projects
  4376. (defvar org-agenda-skip-regexp nil
  4377. "Regular expression used in skipping subtrees for the agenda.
  4378. This is basically a temporary global variable that can be set and then
  4379. used by user-defined selections using `org-agenda-skip-function'.")
  4380. (defvar org-agenda-overriding-header nil
  4381. "When set during agenda, todo and tags searches it replaces the header.
  4382. This variable should not be set directly, but custom commands can bind it
  4383. in the options section.")
  4384. (defun org-agenda-skip-entry-when-regexp-matches ()
  4385. "Check if the current entry contains match for `org-agenda-skip-regexp'.
  4386. If yes, it returns the end position of this entry, causing agenda commands
  4387. to skip the entry but continuing the search in the subtree. This is a
  4388. function that can be put into `org-agenda-skip-function' for the duration
  4389. of a command."
  4390. (let ((end (save-excursion (org-end-of-subtree t)))
  4391. skip)
  4392. (save-excursion
  4393. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  4394. (and skip end)))
  4395. (defun org-agenda-skip-subtree-when-regexp-matches ()
  4396. "Check if the current subtree contains match for `org-agenda-skip-regexp'.
  4397. If yes, it returns the end position of this tree, causing agenda commands
  4398. to skip this subtree. This is a function that can be put into
  4399. `org-agenda-skip-function' for the duration of a command."
  4400. (let ((end (save-excursion (org-end-of-subtree t)))
  4401. skip)
  4402. (save-excursion
  4403. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  4404. (and skip end)))
  4405. (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
  4406. "Check if the current subtree contains match for `org-agenda-skip-regexp'.
  4407. If yes, it returns the end position of the current entry (NOT the tree),
  4408. causing agenda commands to skip the entry but continuing the search in
  4409. the subtree. This is a function that can be put into
  4410. `org-agenda-skip-function' for the duration of a command. An important
  4411. use of this function is for the stuck project list."
  4412. (let ((end (save-excursion (org-end-of-subtree t)))
  4413. (entry-end (save-excursion (outline-next-heading) (1- (point))))
  4414. skip)
  4415. (save-excursion
  4416. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  4417. (and skip entry-end)))
  4418. (defun org-agenda-skip-entry-if (&rest conditions)
  4419. "Skip entry if any of CONDITIONS is true.
  4420. See `org-agenda-skip-if' for details."
  4421. (org-agenda-skip-if nil conditions))
  4422. (defun org-agenda-skip-subtree-if (&rest conditions)
  4423. "Skip entry if any of CONDITIONS is true.
  4424. See `org-agenda-skip-if' for details."
  4425. (org-agenda-skip-if t conditions))
  4426. (defun org-agenda-skip-if (subtree conditions)
  4427. "Checks current entity for CONDITIONS.
  4428. If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
  4429. the entry (i.e. the text before the next heading) is checked.
  4430. CONDITIONS is a list of symbols, boolean OR is used to combine the results
  4431. from different tests. Valid conditions are:
  4432. scheduled Check if there is a scheduled cookie
  4433. notscheduled Check if there is no scheduled cookie
  4434. deadline Check if there is a deadline
  4435. notdeadline Check if there is no deadline
  4436. timestamp Check if there is a timestamp (also deadline or scheduled)
  4437. nottimestamp Check if there is no timestamp (also deadline or scheduled)
  4438. regexp Check if regexp matches
  4439. notregexp Check if regexp does not match.
  4440. todo Check if TODO keyword matches
  4441. nottodo Check if TODO keyword does not match
  4442. The regexp is taken from the conditions list, it must come right after
  4443. the `regexp' or `notregexp' element.
  4444. `todo' and `nottodo' accept as an argument a list of todo
  4445. keywords, which may include \"*\" to match any todo keyword.
  4446. (org-agenda-skip-entry-if 'todo '(\"TODO\" \"WAITING\"))
  4447. would skip all entries with \"TODO\" or \"WAITING\" keywords.
  4448. Instead of a list, a keyword class may be given. For example:
  4449. (org-agenda-skip-entry-if 'nottodo 'done)
  4450. would skip entries that haven't been marked with any of \"DONE\"
  4451. keywords. Possible classes are: `todo', `done', `any'.
  4452. If any of these conditions is met, this function returns the end point of
  4453. the entity, causing the search to continue from there. This is a function
  4454. that can be put into `org-agenda-skip-function' for the duration of a command."
  4455. (let (beg end m)
  4456. (org-back-to-heading t)
  4457. (setq beg (point)
  4458. end (if subtree
  4459. (progn (org-end-of-subtree t) (point))
  4460. (progn (outline-next-heading) (1- (point)))))
  4461. (goto-char beg)
  4462. (and
  4463. (or
  4464. (and (memq 'scheduled conditions)
  4465. (re-search-forward org-scheduled-time-regexp end t))
  4466. (and (memq 'notscheduled conditions)
  4467. (not (re-search-forward org-scheduled-time-regexp end t)))
  4468. (and (memq 'deadline conditions)
  4469. (re-search-forward org-deadline-time-regexp end t))
  4470. (and (memq 'notdeadline conditions)
  4471. (not (re-search-forward org-deadline-time-regexp end t)))
  4472. (and (memq 'timestamp conditions)
  4473. (re-search-forward org-ts-regexp end t))
  4474. (and (memq 'nottimestamp conditions)
  4475. (not (re-search-forward org-ts-regexp end t)))
  4476. (and (setq m (memq 'regexp conditions))
  4477. (stringp (nth 1 m))
  4478. (re-search-forward (nth 1 m) end t))
  4479. (and (setq m (memq 'notregexp conditions))
  4480. (stringp (nth 1 m))
  4481. (not (re-search-forward (nth 1 m) end t)))
  4482. (and (or
  4483. (setq m (memq 'nottodo conditions))
  4484. (setq m (memq 'todo-unblocked conditions))
  4485. (setq m (memq 'nottodo-unblocked conditions))
  4486. (setq m (memq 'todo conditions)))
  4487. (org-agenda-skip-if-todo m end)))
  4488. end)))
  4489. (defun org-agenda-skip-if-todo (args end)
  4490. "Helper function for `org-agenda-skip-if', do not use it directly.
  4491. ARGS is a list with first element either `todo', `nottodo',
  4492. `todo-unblocked' or `nottodo-unblocked'. The remainder is either
  4493. a list of TODO keywords, or a state symbol `todo' or `done' or
  4494. `any'."
  4495. (let ((kw (car args))
  4496. (arg (cadr args))
  4497. todo-wds todo-re)
  4498. (setq todo-wds
  4499. (org-uniquify
  4500. (cond
  4501. ((listp arg) ;; list of keywords
  4502. (if (member "*" arg)
  4503. (mapcar 'substring-no-properties org-todo-keywords-1)
  4504. arg))
  4505. ((symbolp arg) ;; keyword class name
  4506. (cond
  4507. ((eq arg 'todo)
  4508. (org-delete-all org-done-keywords
  4509. (mapcar 'substring-no-properties
  4510. org-todo-keywords-1)))
  4511. ((eq arg 'done) org-done-keywords)
  4512. ((eq arg 'any)
  4513. (mapcar 'substring-no-properties org-todo-keywords-1)))))))
  4514. (setq todo-re
  4515. (concat "^\\*+[ \t]+\\<\\("
  4516. (mapconcat 'identity todo-wds "\\|")
  4517. "\\)\\>"))
  4518. (cond
  4519. ((eq kw 'todo) (re-search-forward todo-re end t))
  4520. ((eq kw 'nottodo) (not (re-search-forward todo-re end t)))
  4521. ((eq kw 'todo-unblocked)
  4522. (catch 'unblocked
  4523. (while (re-search-forward todo-re end t)
  4524. (or (org-entry-blocked-p) (throw 'unblocked t)))
  4525. nil))
  4526. ((eq kw 'nottodo-unblocked)
  4527. (catch 'unblocked
  4528. (while (re-search-forward todo-re end t)
  4529. (or (org-entry-blocked-p) (throw 'unblocked nil)))
  4530. t))
  4531. )))
  4532. ;;;###autoload
  4533. (defun org-agenda-list-stuck-projects (&rest ignore)
  4534. "Create agenda view for projects that are stuck.
  4535. Stuck projects are project that have no next actions. For the definitions
  4536. of what a project is and how to check if it stuck, customize the variable
  4537. `org-stuck-projects'."
  4538. (interactive)
  4539. (let* ((org-agenda-skip-function
  4540. 'org-agenda-skip-entry-when-regexp-matches-in-subtree)
  4541. ;; We could have used org-agenda-skip-if here.
  4542. (org-agenda-overriding-header
  4543. (or org-agenda-overriding-header "List of stuck projects: "))
  4544. (matcher (nth 0 org-stuck-projects))
  4545. (todo (nth 1 org-stuck-projects))
  4546. (todo-wds (if (member "*" todo)
  4547. (progn
  4548. (org-agenda-prepare-buffers (org-agenda-files
  4549. nil 'ifmode))
  4550. (org-delete-all
  4551. org-done-keywords-for-agenda
  4552. (copy-sequence org-todo-keywords-for-agenda)))
  4553. todo))
  4554. (todo-re (concat "^\\*+[ \t]+\\("
  4555. (mapconcat 'identity todo-wds "\\|")
  4556. "\\)\\>"))
  4557. (tags (nth 2 org-stuck-projects))
  4558. (tags-re (if (member "*" tags)
  4559. (concat org-outline-regexp-bol
  4560. (org-re ".*:[[:alnum:]_@#%]+:[ \t]*$"))
  4561. (if tags
  4562. (concat org-outline-regexp-bol
  4563. ".*:\\("
  4564. (mapconcat 'identity tags "\\|")
  4565. (org-re "\\):[[:alnum:]_@#%:]*[ \t]*$")))))
  4566. (gen-re (nth 3 org-stuck-projects))
  4567. (re-list
  4568. (delq nil
  4569. (list
  4570. (if todo todo-re)
  4571. (if tags tags-re)
  4572. (and gen-re (stringp gen-re) (string-match "\\S-" gen-re)
  4573. gen-re)))))
  4574. (setq org-agenda-skip-regexp
  4575. (if re-list
  4576. (mapconcat 'identity re-list "\\|")
  4577. (error "No information how to identify unstuck projects")))
  4578. (org-tags-view nil matcher)
  4579. (with-current-buffer org-agenda-buffer-name
  4580. (setq org-agenda-redo-command
  4581. `(org-agenda-list-stuck-projects ,current-prefix-arg)))))
  4582. (autoload 'org-agenda-list-stuck-projects "org-agenda" "\
  4583. Create agenda view for projects that are stuck.
  4584. Stuck projects are project that have no next actions. For the definitions
  4585. of what a project is and how to check if it stuck, customize the variable
  4586. `org-stuck-projects'.
  4587. \(fn &rest IGNORE)" t nil)
  4588. ;;; Diary integration
  4589. (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
  4590. (defvar diary-list-entries-hook)
  4591. (defvar diary-time-regexp)
  4592. (defun org-get-entries-from-diary (date)
  4593. "Get the (Emacs Calendar) diary entries for DATE."
  4594. (require 'diary-lib)
  4595. (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
  4596. (diary-display-hook '(fancy-diary-display))
  4597. (diary-display-function 'fancy-diary-display)
  4598. (pop-up-frames nil)
  4599. (diary-list-entries-hook
  4600. (cons 'org-diary-default-entry diary-list-entries-hook))
  4601. (diary-file-name-prefix-function nil) ; turn this feature off
  4602. (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
  4603. entries
  4604. (org-disable-agenda-to-diary t))
  4605. (save-excursion
  4606. (save-window-excursion
  4607. (funcall (if (fboundp 'diary-list-entries)
  4608. 'diary-list-entries 'list-diary-entries)
  4609. date 1)))
  4610. (if (not (get-buffer diary-fancy-buffer))
  4611. (setq entries nil)
  4612. (with-current-buffer diary-fancy-buffer
  4613. (setq buffer-read-only nil)
  4614. (if (zerop (buffer-size))
  4615. ;; No entries
  4616. (setq entries nil)
  4617. ;; Omit the date and other unnecessary stuff
  4618. (org-agenda-cleanup-fancy-diary)
  4619. ;; Add prefix to each line and extend the text properties
  4620. (if (zerop (buffer-size))
  4621. (setq entries nil)
  4622. (setq entries (buffer-substring (point-min) (- (point-max) 1)))
  4623. (setq entries
  4624. (with-temp-buffer
  4625. (insert entries) (goto-char (point-min))
  4626. (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
  4627. (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
  4628. (replace-match (concat "; " (match-string 1)))))
  4629. (buffer-string)))))
  4630. (set-buffer-modified-p nil)
  4631. (kill-buffer diary-fancy-buffer)))
  4632. (when entries
  4633. (setq entries (org-split-string entries "\n"))
  4634. (setq entries
  4635. (mapcar
  4636. (lambda (x)
  4637. (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
  4638. ;; Extend the text properties to the beginning of the line
  4639. (org-add-props x (text-properties-at (1- (length x)) x)
  4640. 'type "diary" 'date date 'face 'org-agenda-diary))
  4641. entries)))))
  4642. (defvar org-agenda-cleanup-fancy-diary-hook nil
  4643. "Hook run when the fancy diary buffer is cleaned up.")
  4644. (defun org-agenda-cleanup-fancy-diary ()
  4645. "Remove unwanted stuff in buffer created by `fancy-diary-display'.
  4646. This gets rid of the date, the underline under the date, and
  4647. the dummy entry installed by `org-mode' to ensure non-empty diary for each
  4648. date. It also removes lines that contain only whitespace."
  4649. (goto-char (point-min))
  4650. (if (looking-at ".*?:[ \t]*")
  4651. (progn
  4652. (replace-match "")
  4653. (re-search-forward "\n=+$" nil t)
  4654. (replace-match "")
  4655. (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
  4656. (re-search-forward "\n=+$" nil t)
  4657. (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
  4658. (goto-char (point-min))
  4659. (while (re-search-forward "^ +\n" nil t)
  4660. (replace-match ""))
  4661. (goto-char (point-min))
  4662. (if (re-search-forward "^Org-mode dummy\n?" nil t)
  4663. (replace-match ""))
  4664. (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
  4665. ;; Make sure entries from the diary have the right text properties.
  4666. (eval-after-load "diary-lib"
  4667. '(if (boundp 'diary-modify-entry-list-string-function)
  4668. ;; We can rely on the hook, nothing to do
  4669. nil
  4670. ;; Hook not available, must use advice to make this work
  4671. (defadvice add-to-diary-list (before org-mark-diary-entry activate)
  4672. "Make the position visible."
  4673. (if (and org-disable-agenda-to-diary ;; called from org-agenda
  4674. (stringp string)
  4675. buffer-file-name)
  4676. (setq string (org-modify-diary-entry-string string))))))
  4677. (defun org-modify-diary-entry-string (string)
  4678. "Add text properties to string, allowing org-mode to act on it."
  4679. (org-add-props string nil
  4680. 'mouse-face 'highlight
  4681. 'help-echo (if buffer-file-name
  4682. (format "mouse-2 or RET jump to diary file %s"
  4683. (abbreviate-file-name buffer-file-name))
  4684. "")
  4685. 'org-agenda-diary-link t
  4686. 'org-marker (org-agenda-new-marker (point-at-bol))))
  4687. (defun org-diary-default-entry ()
  4688. "Add a dummy entry to the diary.
  4689. Needed to avoid empty dates which mess up holiday display."
  4690. ;; Catch the error if dealing with the new add-to-diary-alist
  4691. (when org-disable-agenda-to-diary
  4692. (condition-case nil
  4693. (org-add-to-diary-list original-date "Org-mode dummy" "")
  4694. (error
  4695. (org-add-to-diary-list original-date "Org-mode dummy" "" nil)))))
  4696. (defun org-add-to-diary-list (&rest args)
  4697. (if (fboundp 'diary-add-to-list)
  4698. (apply 'diary-add-to-list args)
  4699. (apply 'add-to-diary-list args)))
  4700. (defvar org-diary-last-run-time nil)
  4701. ;;;###autoload
  4702. (defun org-diary (&rest args)
  4703. "Return diary information from org files.
  4704. This function can be used in a \"sexp\" diary entry in the Emacs calendar.
  4705. It accesses org files and extracts information from those files to be
  4706. listed in the diary. The function accepts arguments specifying what
  4707. items should be listed. For a list of arguments allowed here, see the
  4708. variable `org-agenda-entry-types'.
  4709. The call in the diary file should look like this:
  4710. &%%(org-diary) ~/path/to/some/orgfile.org
  4711. Use a separate line for each org file to check. Or, if you omit the file name,
  4712. all files listed in `org-agenda-files' will be checked automatically:
  4713. &%%(org-diary)
  4714. If you don't give any arguments (as in the example above), the default
  4715. arguments (:deadline :scheduled :timestamp :sexp) are used.
  4716. So the example above may also be written as
  4717. &%%(org-diary :deadline :timestamp :sexp :scheduled)
  4718. The function expects the lisp variables `entry' and `date' to be provided
  4719. by the caller, because this is how the calendar works. Don't use this
  4720. function from a program - use `org-agenda-get-day-entries' instead."
  4721. (when (> (- (org-float-time)
  4722. org-agenda-last-marker-time)
  4723. 5)
  4724. ;; I am not sure if this works with sticky agendas, because the marker
  4725. ;; list is then no longer a global variable.
  4726. (org-agenda-reset-markers))
  4727. (org-compile-prefix-format 'agenda)
  4728. (org-set-sorting-strategy 'agenda)
  4729. (setq args (or args '(:deadline :scheduled :timestamp :sexp)))
  4730. (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
  4731. (list entry)
  4732. (org-agenda-files t)))
  4733. (time (org-float-time))
  4734. file rtn results)
  4735. (when (or (not org-diary-last-run-time)
  4736. (> (- time
  4737. org-diary-last-run-time)
  4738. 3))
  4739. (org-agenda-prepare-buffers files))
  4740. (setq org-diary-last-run-time time)
  4741. ;; If this is called during org-agenda, don't return any entries to
  4742. ;; the calendar. Org Agenda will list these entries itself.
  4743. (if org-disable-agenda-to-diary (setq files nil))
  4744. (while (setq file (pop files))
  4745. (setq rtn (apply 'org-agenda-get-day-entries file date args))
  4746. (setq results (append results rtn)))
  4747. (if results
  4748. (concat (org-agenda-finalize-entries results) "\n"))))
  4749. (autoload 'org-diary "org-agenda" "\
  4750. Return diary information from org files.
  4751. This function can be used in a \"sexp\" diary entry in the Emacs calendar.
  4752. It accesses org files and extracts information from those files to be
  4753. listed in the diary. The function accepts arguments specifying what
  4754. items should be listed. For a list of arguments allowed here, see the
  4755. variable `org-agenda-entry-types'.
  4756. The call in the diary file should look like this:
  4757. &%%(org-diary) ~/path/to/some/orgfile.org
  4758. Use a separate line for each org file to check. Or, if you omit the file name,
  4759. all files listed in `org-agenda-files' will be checked automatically:
  4760. &%%(org-diary)
  4761. If you don't give any arguments (as in the example above), the default
  4762. arguments (:deadline :scheduled :timestamp :sexp) are used.
  4763. So the example above may also be written as
  4764. &%%(org-diary :deadline :timestamp :sexp :scheduled)
  4765. The function expects the lisp variables `entry' and `date' to be provided
  4766. by the caller, because this is how the calendar works. Don't use this
  4767. function from a program - use `org-agenda-get-day-entries' instead.
  4768. \(fn &rest ARGS)" nil nil)
  4769. ;;; Agenda entry finders
  4770. (defun org-agenda-get-day-entries (file date &rest args)
  4771. "Does the work for `org-diary' and `org-agenda'.
  4772. FILE is the path to a file to be checked for entries. DATE is date like
  4773. the one returned by `calendar-current-date'. ARGS are symbols indicating
  4774. which kind of entries should be extracted. For details about these, see
  4775. the documentation of `org-diary'."
  4776. (setq args (or args '(:deadline :scheduled :timestamp :sexp)))
  4777. (let* ((org-startup-folded nil)
  4778. (org-startup-align-all-tables nil)
  4779. (buffer (if (file-exists-p file)
  4780. (org-get-agenda-file-buffer file)
  4781. (error "No such file %s" file)))
  4782. arg results rtn deadline-results)
  4783. (if (not buffer)
  4784. ;; If file does not exist, make sure an error message ends up in diary
  4785. (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4786. (with-current-buffer buffer
  4787. (unless (derived-mode-p 'org-mode)
  4788. (error "Agenda file %s is not in `org-mode'" file))
  4789. (setq org-agenda-buffer (or org-agenda-buffer buffer))
  4790. (let ((case-fold-search nil))
  4791. (save-excursion
  4792. (save-restriction
  4793. (if org-agenda-restrict
  4794. (narrow-to-region org-agenda-restrict-begin
  4795. org-agenda-restrict-end)
  4796. (widen))
  4797. ;; The way we repeatedly append to `results' makes it O(n^2) :-(
  4798. (while (setq arg (pop args))
  4799. (cond
  4800. ((and (eq arg :todo)
  4801. (equal date (calendar-gregorian-from-absolute
  4802. (org-today))))
  4803. (setq rtn (org-agenda-get-todos))
  4804. (setq results (append results rtn)))
  4805. ((eq arg :timestamp)
  4806. (setq rtn (org-agenda-get-blocks))
  4807. (setq results (append results rtn))
  4808. (setq rtn (org-agenda-get-timestamps deadline-results))
  4809. (setq results (append results rtn)))
  4810. ((eq arg :sexp)
  4811. (setq rtn (org-agenda-get-sexps))
  4812. (setq results (append results rtn)))
  4813. ((eq arg :scheduled)
  4814. (setq rtn (org-agenda-get-scheduled deadline-results))
  4815. (setq results (append results rtn)))
  4816. ((eq arg :closed)
  4817. (setq rtn (org-agenda-get-progress))
  4818. (setq results (append results rtn)))
  4819. ((eq arg :deadline)
  4820. (setq rtn (org-agenda-get-deadlines))
  4821. (setq deadline-results (copy-sequence rtn))
  4822. (setq results (append results rtn))))))))
  4823. results))))
  4824. (defvar org-heading-keyword-regexp-format) ; defined in org.el
  4825. (defun org-agenda-get-todos ()
  4826. "Return the TODO information for agenda display."
  4827. (let* ((props (list 'face nil
  4828. 'done-face 'org-agenda-done
  4829. 'org-not-done-regexp org-not-done-regexp
  4830. 'org-todo-regexp org-todo-regexp
  4831. 'org-complex-heading-regexp org-complex-heading-regexp
  4832. 'mouse-face 'highlight
  4833. 'help-echo
  4834. (format "mouse-2 or RET jump to org file %s"
  4835. (abbreviate-file-name buffer-file-name))))
  4836. (regexp (format org-heading-keyword-regexp-format
  4837. (cond
  4838. ((and org-select-this-todo-keyword
  4839. (equal org-select-this-todo-keyword "*"))
  4840. org-todo-regexp)
  4841. (org-select-this-todo-keyword
  4842. (concat "\\("
  4843. (mapconcat 'identity
  4844. (org-split-string
  4845. org-select-this-todo-keyword
  4846. "|")
  4847. "\\|") "\\)"))
  4848. (t org-not-done-regexp))))
  4849. marker priority category category-pos level tags todo-state
  4850. ee txt beg end)
  4851. (goto-char (point-min))
  4852. (while (re-search-forward regexp nil t)
  4853. (catch :skip
  4854. (save-match-data
  4855. (beginning-of-line)
  4856. (org-agenda-skip)
  4857. (setq beg (point) end (save-excursion (outline-next-heading) (point)))
  4858. (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
  4859. (goto-char (1+ beg))
  4860. (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
  4861. (throw :skip nil)))
  4862. (goto-char (match-beginning 2))
  4863. (setq marker (org-agenda-new-marker (match-beginning 0))
  4864. category (org-get-category)
  4865. category-pos (get-text-property (point) 'org-category-position)
  4866. txt (org-trim
  4867. (buffer-substring (match-beginning 2) (match-end 0)))
  4868. tags (org-get-tags-at nil t)
  4869. level (make-string (org-reduced-level (org-outline-level)) ? )
  4870. txt (org-agenda-format-item "" txt level category tags t)
  4871. priority (1+ (org-get-priority txt))
  4872. todo-state (org-get-todo-state))
  4873. (org-add-props txt props
  4874. 'org-marker marker 'org-hd-marker marker
  4875. 'priority priority 'org-category category
  4876. 'level level
  4877. 'org-category-position category-pos
  4878. 'type "todo" 'todo-state todo-state)
  4879. (push txt ee)
  4880. (if org-agenda-todo-list-sublevels
  4881. (goto-char (match-end 2))
  4882. (org-end-of-subtree 'invisible))))
  4883. (nreverse ee)))
  4884. (defun org-agenda-todo-custom-ignore-p (time n)
  4885. "Check whether timestamp is farther away than n number of days.
  4886. This function is invoked if `org-agenda-todo-ignore-deadlines',
  4887. `org-agenda-todo-ignore-scheduled' or
  4888. `org-agenda-todo-ignore-timestamp' is set to an integer."
  4889. (let ((days (org-time-stamp-to-now
  4890. time org-agenda-todo-ignore-time-comparison-use-seconds)))
  4891. (if (>= n 0)
  4892. (>= days n)
  4893. (<= days n))))
  4894. (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  4895. (&optional end)
  4896. "Do we have a reason to ignore this TODO entry because it has a time stamp?"
  4897. (when (or org-agenda-todo-ignore-with-date
  4898. org-agenda-todo-ignore-scheduled
  4899. org-agenda-todo-ignore-deadlines
  4900. org-agenda-todo-ignore-timestamp)
  4901. (setq end (or end (save-excursion (outline-next-heading) (point))))
  4902. (save-excursion
  4903. (or (and org-agenda-todo-ignore-with-date
  4904. (re-search-forward org-ts-regexp end t))
  4905. (and org-agenda-todo-ignore-scheduled
  4906. (re-search-forward org-scheduled-time-regexp end t)
  4907. (cond
  4908. ((eq org-agenda-todo-ignore-scheduled 'future)
  4909. (> (org-time-stamp-to-now
  4910. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4911. ((eq org-agenda-todo-ignore-scheduled 'past)
  4912. (<= (org-time-stamp-to-now
  4913. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4914. ((numberp org-agenda-todo-ignore-scheduled)
  4915. (org-agenda-todo-custom-ignore-p
  4916. (match-string 1) org-agenda-todo-ignore-scheduled))
  4917. (t)))
  4918. (and org-agenda-todo-ignore-deadlines
  4919. (re-search-forward org-deadline-time-regexp end t)
  4920. (cond
  4921. ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
  4922. ((eq org-agenda-todo-ignore-deadlines 'far)
  4923. (not (org-deadline-close (match-string 1))))
  4924. ((eq org-agenda-todo-ignore-deadlines 'future)
  4925. (> (org-time-stamp-to-now
  4926. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4927. ((eq org-agenda-todo-ignore-deadlines 'past)
  4928. (<= (org-time-stamp-to-now
  4929. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4930. ((numberp org-agenda-todo-ignore-deadlines)
  4931. (org-agenda-todo-custom-ignore-p
  4932. (match-string 1) org-agenda-todo-ignore-deadlines))
  4933. (t (org-deadline-close (match-string 1)))))
  4934. (and org-agenda-todo-ignore-timestamp
  4935. (let ((buffer (current-buffer))
  4936. (regexp
  4937. (concat
  4938. org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
  4939. (start (point)))
  4940. ;; Copy current buffer into a temporary one
  4941. (with-temp-buffer
  4942. (insert-buffer-substring buffer start end)
  4943. (goto-char (point-min))
  4944. ;; Delete SCHEDULED and DEADLINE items
  4945. (while (re-search-forward regexp end t)
  4946. (delete-region (match-beginning 0) (match-end 0)))
  4947. (goto-char (point-min))
  4948. ;; No search for timestamp left
  4949. (when (re-search-forward org-ts-regexp nil t)
  4950. (cond
  4951. ((eq org-agenda-todo-ignore-timestamp 'future)
  4952. (> (org-time-stamp-to-now
  4953. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4954. ((eq org-agenda-todo-ignore-timestamp 'past)
  4955. (<= (org-time-stamp-to-now
  4956. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4957. ((numberp org-agenda-todo-ignore-timestamp)
  4958. (org-agenda-todo-custom-ignore-p
  4959. (match-string 1) org-agenda-todo-ignore-timestamp))
  4960. (t))))))))))
  4961. (autoload 'org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item "org-agenda" "\
  4962. Do we have a reason to ignore this TODO entry because it has a time stamp?
  4963. \(fn &optional END)" nil nil)
  4964. (defconst org-agenda-no-heading-message
  4965. "No heading for this item in buffer or region.")
  4966. (defun org-agenda-get-timestamps (&optional deadline-results)
  4967. "Return the date stamp information for agenda display."
  4968. (let* ((props (list 'face 'org-agenda-calendar-event
  4969. 'org-not-done-regexp org-not-done-regexp
  4970. 'org-todo-regexp org-todo-regexp
  4971. 'org-complex-heading-regexp org-complex-heading-regexp
  4972. 'mouse-face 'highlight
  4973. 'help-echo
  4974. (format "mouse-2 or RET jump to org file %s"
  4975. (abbreviate-file-name buffer-file-name))))
  4976. (d1 (calendar-absolute-from-gregorian date))
  4977. mm
  4978. (deadline-position-alist
  4979. (mapcar (lambda (a) (and (setq mm (get-text-property
  4980. 0 'org-hd-marker a))
  4981. (cons (marker-position mm) a)))
  4982. deadline-results))
  4983. (remove-re org-ts-regexp)
  4984. (regexp
  4985. (concat
  4986. (if org-agenda-include-inactive-timestamps "[[<]" "<")
  4987. (regexp-quote
  4988. (substring
  4989. (format-time-string
  4990. (car org-time-stamp-formats)
  4991. (apply 'encode-time ; DATE bound by calendar
  4992. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  4993. 1 11))
  4994. "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
  4995. "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
  4996. marker hdmarker deadlinep scheduledp clockp closedp inactivep
  4997. donep tmp priority category category-pos level ee txt timestr tags
  4998. b0 b3 e3 head todo-state end-of-match show-all warntime habitp)
  4999. (goto-char (point-min))
  5000. (while (setq end-of-match (re-search-forward regexp nil t))
  5001. (setq b0 (match-beginning 0)
  5002. b3 (match-beginning 3) e3 (match-end 3)
  5003. todo-state (save-match-data (ignore-errors (org-get-todo-state)))
  5004. habitp (and (functionp 'org-is-habit-p) (save-match-data (org-is-habit-p)))
  5005. show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  5006. (member todo-state
  5007. org-agenda-repeating-timestamp-show-all)))
  5008. (catch :skip
  5009. (and (org-at-date-range-p) (throw :skip nil))
  5010. (org-agenda-skip)
  5011. (if (and (match-end 1)
  5012. (not (= d1 (org-time-string-to-absolute
  5013. (match-string 1) d1 nil show-all
  5014. (current-buffer) b0))))
  5015. (throw :skip nil))
  5016. (if (and e3
  5017. (not (org-diary-sexp-entry (buffer-substring b3 e3) "" date)))
  5018. (throw :skip nil))
  5019. (setq tmp (buffer-substring (max (point-min)
  5020. (- b0 org-ds-keyword-length))
  5021. b0)
  5022. timestr (if b3 "" (buffer-substring b0 (point-at-eol)))
  5023. inactivep (= (char-after b0) ?\[)
  5024. deadlinep (string-match org-deadline-regexp tmp)
  5025. scheduledp (string-match org-scheduled-regexp tmp)
  5026. closedp (and org-agenda-include-inactive-timestamps
  5027. (string-match org-closed-string tmp))
  5028. clockp (and org-agenda-include-inactive-timestamps
  5029. (or (string-match org-clock-string tmp)
  5030. (string-match "]-+\\'" tmp)))
  5031. warntime (get-text-property (point) 'org-appt-warntime)
  5032. donep (member todo-state org-done-keywords))
  5033. (if (or scheduledp deadlinep closedp clockp
  5034. (and donep org-agenda-skip-timestamp-if-done))
  5035. (throw :skip t))
  5036. (if (string-match ">" timestr)
  5037. ;; substring should only run to end of time stamp
  5038. (setq timestr (substring timestr 0 (match-end 0))))
  5039. (setq marker (org-agenda-new-marker b0)
  5040. category (org-get-category b0)
  5041. category-pos (get-text-property b0 'org-category-position))
  5042. (save-excursion
  5043. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5044. (setq txt org-agenda-no-heading-message)
  5045. (goto-char (match-beginning 0))
  5046. (if (and (eq t org-agenda-skip-timestamp-if-deadline-is-shown)
  5047. (assoc (point) deadline-position-alist))
  5048. (throw :skip nil))
  5049. (setq hdmarker (org-agenda-new-marker)
  5050. tags (org-get-tags-at nil t)
  5051. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5052. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5053. (setq head (or (match-string 1) ""))
  5054. (setq txt (org-agenda-format-item
  5055. (if inactivep org-agenda-inactive-leader nil)
  5056. head level category tags timestr
  5057. remove-re habitp)))
  5058. (setq priority (org-get-priority txt))
  5059. (org-add-props txt props 'priority priority
  5060. 'org-marker marker 'org-hd-marker hdmarker
  5061. 'org-category category 'date date
  5062. 'level level
  5063. 'org-category-position category-pos
  5064. 'todo-state todo-state
  5065. 'warntime warntime
  5066. 'type "timestamp")
  5067. (push txt ee))
  5068. (if org-agenda-skip-additional-timestamps-same-entry
  5069. (outline-next-heading)
  5070. (goto-char end-of-match))))
  5071. (nreverse ee)))
  5072. (defun org-agenda-get-sexps ()
  5073. "Return the sexp information for agenda display."
  5074. (require 'diary-lib)
  5075. (let* ((props (list 'face 'org-agenda-calendar-sexp
  5076. 'mouse-face 'highlight
  5077. 'help-echo
  5078. (format "mouse-2 or RET jump to org file %s"
  5079. (abbreviate-file-name buffer-file-name))))
  5080. (regexp "^&?%%(")
  5081. marker category extra category-pos level ee txt tags entry
  5082. result beg b sexp sexp-entry todo-state warntime)
  5083. (goto-char (point-min))
  5084. (while (re-search-forward regexp nil t)
  5085. (catch :skip
  5086. (org-agenda-skip)
  5087. (setq beg (match-beginning 0))
  5088. (goto-char (1- (match-end 0)))
  5089. (setq b (point))
  5090. (forward-sexp 1)
  5091. (setq sexp (buffer-substring b (point)))
  5092. (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
  5093. (org-trim (match-string 1))
  5094. ""))
  5095. (setq result (org-diary-sexp-entry sexp sexp-entry date))
  5096. (when result
  5097. (setq marker (org-agenda-new-marker beg)
  5098. level (make-string (org-reduced-level (org-outline-level)) ? )
  5099. category (org-get-category beg)
  5100. category-pos (get-text-property beg 'org-category-position)
  5101. tags (save-excursion (org-back-to-heading t) (org-get-tags-at nil t))
  5102. todo-state (org-get-todo-state)
  5103. warntime (get-text-property (point) 'org-appt-warntime)
  5104. extra nil)
  5105. (dolist (r (if (stringp result)
  5106. (list result)
  5107. result)) ;; we expect a list here
  5108. (when (and org-agenda-diary-sexp-prefix
  5109. (string-match org-agenda-diary-sexp-prefix r))
  5110. (setq extra (match-string 0 r)
  5111. r (replace-match "" nil nil r)))
  5112. (if (string-match "\\S-" r)
  5113. (setq txt r)
  5114. (setq txt "SEXP entry returned empty string"))
  5115. (setq txt (org-agenda-format-item extra txt level category tags 'time))
  5116. (org-add-props txt props 'org-marker marker
  5117. 'org-category category 'date date 'todo-state todo-state
  5118. 'org-category-position category-pos 'tags tags
  5119. 'level level
  5120. 'type "sexp" 'warntime warntime)
  5121. (push txt ee)))))
  5122. (nreverse ee)))
  5123. ;; Calendar sanity: define some functions that are independent of
  5124. ;; `calendar-date-style'.
  5125. ;; Normally I would like to use ISO format when calling the diary functions,
  5126. ;; but to make sure we still have Emacs 22 compatibility we bind
  5127. ;; also `european-calendar-style' and use european format
  5128. (defun org-anniversary (year month day &optional mark)
  5129. "Like `diary-anniversary', but with fixed (ISO) order of arguments."
  5130. (org-no-warnings
  5131. (let ((calendar-date-style 'european) (european-calendar-style t))
  5132. (diary-anniversary day month year mark))))
  5133. (defun org-cyclic (N year month day &optional mark)
  5134. "Like `diary-cyclic', but with fixed (ISO) order of arguments."
  5135. (org-no-warnings
  5136. (let ((calendar-date-style 'european) (european-calendar-style t))
  5137. (diary-cyclic N day month year mark))))
  5138. (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
  5139. "Like `diary-block', but with fixed (ISO) order of arguments."
  5140. (org-no-warnings
  5141. (let ((calendar-date-style 'european) (european-calendar-style t))
  5142. (diary-block D1 M1 Y1 D2 M2 Y2 mark))))
  5143. (defun org-date (year month day &optional mark)
  5144. "Like `diary-date', but with fixed (ISO) order of arguments."
  5145. (org-no-warnings
  5146. (let ((calendar-date-style 'european) (european-calendar-style t))
  5147. (diary-date day month year mark))))
  5148. ;; Define the` org-class' function
  5149. (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
  5150. "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
  5151. DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
  5152. SKIP-WEEKS is any number of ISO weeks in the block period for which the
  5153. item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
  5154. `holidays', then any date that is known by the Emacs calendar to be a
  5155. holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
  5156. then those holidays will be skipped."
  5157. (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
  5158. (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
  5159. (d (calendar-absolute-from-gregorian date))
  5160. (h (when skip-weeks (calendar-check-holidays date))))
  5161. (and
  5162. (<= date1 d)
  5163. (<= d date2)
  5164. (= (calendar-day-of-week date) dayname)
  5165. (or (not skip-weeks)
  5166. (progn
  5167. (require 'cal-iso)
  5168. (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
  5169. (not (or (and h (memq 'holidays skip-weeks))
  5170. (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
  5171. entry)))
  5172. (defun org-diary-class (m1 d1 y1 m2 d2 y2 dayname &rest skip-weeks)
  5173. "Like `org-class', but honor `calendar-date-style'.
  5174. The order of the first 2 times 3 arguments depends on the variable
  5175. `calendar-date-style' or, if that is not defined, on `european-calendar-style'.
  5176. So for American calendars, give this as MONTH DAY YEAR, for European as
  5177. DAY MONTH YEAR, and for ISO as YEAR MONTH DAY.
  5178. DAYNAME is a number between 0 (Sunday) and 6 (Saturday). SKIP-WEEKS
  5179. is any number of ISO weeks in the block period for which the item should
  5180. be skipped.
  5181. This function is here only for backward compatibility and it is deprecated,
  5182. please use `org-class' instead."
  5183. (let* ((date1 (org-order-calendar-date-args m1 d1 y1))
  5184. (date2 (org-order-calendar-date-args m2 d2 y2)))
  5185. (org-class
  5186. (nth 2 date1) (car date1) (nth 1 date1)
  5187. (nth 2 date2) (car date2) (nth 1 date2)
  5188. dayname skip-weeks)))
  5189. (make-obsolete 'org-diary-class 'org-class "")
  5190. (defvar org-agenda-show-log-scoped) ;; dynamically scope in `org-timeline' or `org-agenda-list'
  5191. (defalias 'org-get-closed 'org-agenda-get-progress)
  5192. (defun org-agenda-get-progress ()
  5193. "Return the logged TODO entries for agenda display."
  5194. (let* ((props (list 'mouse-face 'highlight
  5195. 'org-not-done-regexp org-not-done-regexp
  5196. 'org-todo-regexp org-todo-regexp
  5197. 'org-complex-heading-regexp org-complex-heading-regexp
  5198. 'help-echo
  5199. (format "mouse-2 or RET jump to org file %s"
  5200. (abbreviate-file-name buffer-file-name))))
  5201. (items (if (consp org-agenda-show-log-scoped)
  5202. org-agenda-show-log-scoped
  5203. (if (eq org-agenda-show-log-scoped 'clockcheck)
  5204. '(clock)
  5205. org-agenda-log-mode-items)))
  5206. (parts
  5207. (delq nil
  5208. (list
  5209. (if (memq 'closed items) (concat "\\<" org-closed-string))
  5210. (if (memq 'clock items) (concat "\\<" org-clock-string))
  5211. (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
  5212. (parts-re (if parts (mapconcat 'identity parts "\\|")
  5213. (error "`org-agenda-log-mode-items' is empty")))
  5214. (regexp (concat
  5215. "\\(" parts-re "\\)"
  5216. " *\\["
  5217. (regexp-quote
  5218. (substring
  5219. (format-time-string
  5220. (car org-time-stamp-formats)
  5221. (apply 'encode-time ; DATE bound by calendar
  5222. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  5223. 1 11))))
  5224. (org-agenda-search-headline-for-time nil)
  5225. marker hdmarker priority category category-pos level tags closedp
  5226. statep clockp state ee txt extra timestr rest clocked)
  5227. (goto-char (point-min))
  5228. (while (re-search-forward regexp nil t)
  5229. (catch :skip
  5230. (org-agenda-skip)
  5231. (setq marker (org-agenda-new-marker (match-beginning 0))
  5232. closedp (equal (match-string 1) org-closed-string)
  5233. statep (equal (string-to-char (match-string 1)) ?-)
  5234. clockp (not (or closedp statep))
  5235. state (and statep (match-string 2))
  5236. category (org-get-category (match-beginning 0))
  5237. category-pos (get-text-property (match-beginning 0) 'org-category-position)
  5238. timestr (buffer-substring (match-beginning 0) (point-at-eol)))
  5239. (when (string-match "\\]" timestr)
  5240. ;; substring should only run to end of time stamp
  5241. (setq rest (substring timestr (match-end 0))
  5242. timestr (substring timestr 0 (match-end 0)))
  5243. (if (and (not closedp) (not statep)
  5244. (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
  5245. rest))
  5246. (progn (setq timestr (concat (substring timestr 0 -1)
  5247. "-" (match-string 1 rest) "]"))
  5248. (setq clocked (match-string 2 rest)))
  5249. (setq clocked "-")))
  5250. (save-excursion
  5251. (setq extra
  5252. (cond
  5253. ((not org-agenda-log-mode-add-notes) nil)
  5254. (statep
  5255. (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
  5256. (match-string 1)))
  5257. (clockp
  5258. (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
  5259. (match-string 1)))))
  5260. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5261. (setq txt org-agenda-no-heading-message)
  5262. (goto-char (match-beginning 0))
  5263. (setq hdmarker (org-agenda-new-marker)
  5264. tags (org-get-tags-at nil t)
  5265. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5266. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5267. (setq txt (match-string 1))
  5268. (when extra
  5269. (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
  5270. (setq txt (concat (substring txt 0 (match-beginning 1))
  5271. " - " extra " " (match-string 2 txt)))
  5272. (setq txt (concat txt " - " extra))))
  5273. (setq txt (org-agenda-format-item
  5274. (cond
  5275. (closedp "Closed: ")
  5276. (statep (concat "State: (" state ")"))
  5277. (t (concat "Clocked: (" clocked ")")))
  5278. txt level category tags timestr)))
  5279. (setq priority 100000)
  5280. (org-add-props txt props
  5281. 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
  5282. 'priority priority 'org-category category
  5283. 'org-category-position category-pos
  5284. 'level level
  5285. 'type "closed" 'date date
  5286. 'undone-face 'org-warning 'done-face 'org-agenda-done)
  5287. (push txt ee))
  5288. (goto-char (point-at-eol))))
  5289. (nreverse ee)))
  5290. (defun org-agenda-show-clocking-issues ()
  5291. "Add overlays, showing issues with clocking.
  5292. See also the user option `org-agenda-clock-consistency-checks'."
  5293. (interactive)
  5294. (let* ((pl org-agenda-clock-consistency-checks)
  5295. (re (concat "^[ \t]*"
  5296. org-clock-string
  5297. "[ \t]+"
  5298. "\\(\\[.*?\\]\\)" ; group 1 is first stamp
  5299. "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
  5300. (tlstart 0.)
  5301. (tlend 0.)
  5302. (maxtime (org-hh:mm-string-to-minutes
  5303. (or (plist-get pl :max-duration) "24:00")))
  5304. (mintime (org-hh:mm-string-to-minutes
  5305. (or (plist-get pl :min-duration) 0)))
  5306. (maxgap (org-hh:mm-string-to-minutes
  5307. ;; default 30:00 means never complain
  5308. (or (plist-get pl :max-gap) "30:00")))
  5309. (gapok (mapcar 'org-hh:mm-string-to-minutes
  5310. (plist-get pl :gap-ok-around)))
  5311. (def-face (or (plist-get pl :default-face)
  5312. '((:background "DarkRed") (:foreground "white"))))
  5313. issue face m te ts dt ov)
  5314. (goto-char (point-min))
  5315. (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
  5316. (setq issue nil face def-face)
  5317. (catch 'next
  5318. (setq m (org-get-at-bol 'org-marker)
  5319. te nil ts nil)
  5320. (unless (and m (markerp m))
  5321. (setq issue "No valid clock line") (throw 'next t))
  5322. (org-with-point-at m
  5323. (save-excursion
  5324. (goto-char (point-at-bol))
  5325. (unless (looking-at re)
  5326. (error "No valid Clock line")
  5327. (throw 'next t))
  5328. (unless (match-end 3)
  5329. (setq issue "No end time"
  5330. face (or (plist-get pl :no-end-time-face) face))
  5331. (throw 'next t))
  5332. (setq ts (match-string 1)
  5333. te (match-string 3)
  5334. ts (org-float-time
  5335. (apply 'encode-time (org-parse-time-string ts)))
  5336. te (org-float-time
  5337. (apply 'encode-time (org-parse-time-string te)))
  5338. dt (- te ts))))
  5339. (cond
  5340. ((> dt (* 60 maxtime))
  5341. ;; a very long clocking chunk
  5342. (setq issue (format "Clocking interval is very long: %s"
  5343. (org-minutes-to-clocksum-string
  5344. (floor (/ (float dt) 60.))))
  5345. face (or (plist-get pl :long-face) face)))
  5346. ((< dt (* 60 mintime))
  5347. ;; a very short clocking chunk
  5348. (setq issue (format "Clocking interval is very short: %s"
  5349. (org-minutes-to-clocksum-string
  5350. (floor (/ (float dt) 60.))))
  5351. face (or (plist-get pl :short-face) face)))
  5352. ((and (> tlend 0) (< ts tlend))
  5353. ;; Two clock entries are overlapping
  5354. (setq issue (format "Clocking overlap: %d minutes"
  5355. (/ (- tlend ts) 60))
  5356. face (or (plist-get pl :overlap-face) face)))
  5357. ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
  5358. ;; There is a gap, lets see if we need to report it
  5359. (unless (org-agenda-check-clock-gap tlend ts gapok)
  5360. (setq issue (format "Clocking gap: %d minutes"
  5361. (/ (- ts tlend) 60))
  5362. face (or (plist-get pl :gap-face) face))))
  5363. (t nil)))
  5364. (setq tlend (or te tlend) tlstart (or ts tlstart))
  5365. (when issue
  5366. ;; OK, there was some issue, add an overlay to show the issue
  5367. (setq ov (make-overlay (point-at-bol) (point-at-eol)))
  5368. (overlay-put ov 'before-string
  5369. (concat
  5370. (org-add-props
  5371. (format "%-43s" (concat " " issue))
  5372. nil
  5373. 'face face)
  5374. "\n"))
  5375. (overlay-put ov 'evaporate t)))))
  5376. (defun org-agenda-check-clock-gap (t1 t2 ok-list)
  5377. "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
  5378. (catch 'exit
  5379. (unless ok-list
  5380. ;; there are no OK times for gaps...
  5381. (throw 'exit nil))
  5382. (if (> (- (/ t2 36000) (/ t1 36000)) 24)
  5383. ;; This is more than 24 hours, so it is OK.
  5384. ;; because we have at least one OK time, that must be in the
  5385. ;; 24 hour interval.
  5386. (throw 'exit t))
  5387. ;; We have a shorter gap.
  5388. ;; Now we have to get the minute of the day when these times are
  5389. (let* ((t1dec (decode-time (seconds-to-time t1)))
  5390. (t2dec (decode-time (seconds-to-time t2)))
  5391. ;; compute the minute on the day
  5392. (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
  5393. (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
  5394. (when (< min2 min1)
  5395. ;; if min2 is smaller than min1, this means it is on the next day.
  5396. ;; Wrap it to after midnight.
  5397. (setq min2 (+ min2 1440)))
  5398. ;; Now check if any of the OK times is in the gap
  5399. (mapc (lambda (x)
  5400. ;; Wrap the time to after midnight if necessary
  5401. (if (< x min1) (setq x (+ x 1440)))
  5402. ;; Check if in interval
  5403. (and (<= min1 x) (>= min2 x) (throw 'exit t)))
  5404. ok-list)
  5405. ;; Nope, this gap is not OK
  5406. nil)))
  5407. (defun org-agenda-get-deadlines ()
  5408. "Return the deadline information for agenda display."
  5409. (let* ((props (list 'mouse-face 'highlight
  5410. 'org-not-done-regexp org-not-done-regexp
  5411. 'org-todo-regexp org-todo-regexp
  5412. 'org-complex-heading-regexp org-complex-heading-regexp
  5413. 'help-echo
  5414. (format "mouse-2 or RET jump to org file %s"
  5415. (abbreviate-file-name buffer-file-name))))
  5416. (regexp org-deadline-time-regexp)
  5417. (todayp (org-agenda-todayp date)) ; DATE bound by calendar
  5418. (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
  5419. d2 diff dfrac wdays pos pos1 category category-pos level
  5420. tags suppress-prewarning ee txt head face s todo-state
  5421. show-all upcomingp donep timestr warntime)
  5422. (goto-char (point-min))
  5423. (while (re-search-forward regexp nil t)
  5424. (catch :skip
  5425. (org-agenda-skip)
  5426. (setq s (match-string 1)
  5427. txt nil
  5428. pos (1- (match-beginning 1))
  5429. todo-state (save-match-data (org-get-todo-state))
  5430. show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  5431. (member todo-state
  5432. org-agenda-repeating-timestamp-show-all))
  5433. d2 (org-time-string-to-absolute
  5434. (match-string 1) d1 'past show-all
  5435. (current-buffer) pos)
  5436. diff (- d2 d1))
  5437. (setq suppress-prewarning
  5438. (let ((ds (and org-agenda-skip-deadline-prewarning-if-scheduled
  5439. (let ((item (buffer-substring (point-at-bol)
  5440. (point-at-eol))))
  5441. (save-match-data
  5442. (and (string-match
  5443. org-scheduled-time-regexp item)
  5444. (match-string 1 item)))))))
  5445. (cond
  5446. ((not ds) nil)
  5447. ;; The current item has a scheduled date (in ds), so
  5448. ;; evaluate its prewarning lead time.
  5449. ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
  5450. ;; Use global prewarning-restart lead time.
  5451. org-agenda-skip-deadline-prewarning-if-scheduled)
  5452. ((eq org-agenda-skip-deadline-prewarning-if-scheduled
  5453. 'pre-scheduled)
  5454. ;; Set prewarning to no earlier than scheduled.
  5455. (min (- d2 (org-time-string-to-absolute
  5456. ds d1 'past show-all (current-buffer) pos))
  5457. org-deadline-warning-days))
  5458. ;; Set prewarning to deadline.
  5459. (t 0))))
  5460. (setq wdays (if suppress-prewarning
  5461. (let ((org-deadline-warning-days suppress-prewarning))
  5462. (org-get-wdays s))
  5463. (org-get-wdays s))
  5464. dfrac (- 1 (/ (* 1.0 diff) (max wdays 1)))
  5465. upcomingp (and todayp (> diff 0)))
  5466. ;; When to show a deadline in the calendar:
  5467. ;; If the expiration is within wdays warning time.
  5468. ;; Past-due deadlines are only shown on the current date
  5469. (if (and (or (and (<= diff wdays)
  5470. (and todayp (not org-agenda-only-exact-dates)))
  5471. (= diff 0)))
  5472. (save-excursion
  5473. ;; (setq todo-state (org-get-todo-state))
  5474. (setq donep (member todo-state org-done-keywords))
  5475. (if (and donep
  5476. (or org-agenda-skip-deadline-if-done
  5477. (not (= diff 0))))
  5478. (setq txt nil)
  5479. (setq category (org-get-category)
  5480. warntime (get-text-property (point) 'org-appt-warntime)
  5481. category-pos (get-text-property (point) 'org-category-position))
  5482. (if (not (re-search-backward "^\\*+[ \t]+" nil t))
  5483. (setq txt org-agenda-no-heading-message)
  5484. (goto-char (match-end 0))
  5485. (setq pos1 (match-beginning 0))
  5486. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  5487. (setq tags (org-get-tags-at pos1 t))
  5488. (setq head (buffer-substring-no-properties
  5489. (point)
  5490. (progn (skip-chars-forward "^\r\n")
  5491. (point))))
  5492. (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5493. (setq timestr
  5494. (concat (substring s (match-beginning 1)) " "))
  5495. (setq timestr 'time))
  5496. (setq txt (org-agenda-format-item
  5497. (if (= diff 0)
  5498. (car org-agenda-deadline-leaders)
  5499. (if (functionp
  5500. (nth 1 org-agenda-deadline-leaders))
  5501. (funcall
  5502. (nth 1 org-agenda-deadline-leaders)
  5503. diff date)
  5504. (format (nth 1 org-agenda-deadline-leaders)
  5505. diff)))
  5506. head level category tags
  5507. (if (not (= diff 0)) nil timestr)))))
  5508. (when txt
  5509. (setq face (org-agenda-deadline-face dfrac))
  5510. (org-add-props txt props
  5511. 'org-marker (org-agenda-new-marker pos)
  5512. 'warntime warntime
  5513. 'level level
  5514. 'org-hd-marker (org-agenda-new-marker pos1)
  5515. 'priority (+ (- diff)
  5516. (org-get-priority txt))
  5517. 'org-category category
  5518. 'org-category-position category-pos
  5519. 'todo-state todo-state
  5520. 'type (if upcomingp "upcoming-deadline" "deadline")
  5521. 'date (if upcomingp date d2)
  5522. 'face (if donep 'org-agenda-done face)
  5523. 'undone-face face 'done-face 'org-agenda-done)
  5524. (push txt ee))))))
  5525. (nreverse ee)))
  5526. (defun org-agenda-deadline-face (fraction)
  5527. "Return the face to displaying a deadline item.
  5528. FRACTION is what fraction of the head-warning time has passed."
  5529. (let ((faces org-agenda-deadline-faces) f)
  5530. (catch 'exit
  5531. (while (setq f (pop faces))
  5532. (if (>= fraction (car f)) (throw 'exit (cdr f)))))))
  5533. (defun org-agenda-get-scheduled (&optional deadline-results)
  5534. "Return the scheduled information for agenda display."
  5535. (let* ((props (list 'org-not-done-regexp org-not-done-regexp
  5536. 'org-todo-regexp org-todo-regexp
  5537. 'org-complex-heading-regexp org-complex-heading-regexp
  5538. 'done-face 'org-agenda-done
  5539. 'mouse-face 'highlight
  5540. 'help-echo
  5541. (format "mouse-2 or RET jump to org file %s"
  5542. (abbreviate-file-name buffer-file-name))))
  5543. (regexp org-scheduled-time-regexp)
  5544. (todayp (org-agenda-todayp date)) ; DATE bound by calendar
  5545. (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
  5546. mm
  5547. (deadline-position-alist
  5548. (mapcar (lambda (a) (and (setq mm (get-text-property
  5549. 0 'org-hd-marker a))
  5550. (cons (marker-position mm) a)))
  5551. deadline-results))
  5552. d2 diff pos pos1 category category-pos level tags donep
  5553. ee txt head pastschedp todo-state face timestr s habitp show-all
  5554. did-habit-check-p warntime)
  5555. (goto-char (point-min))
  5556. (while (re-search-forward regexp nil t)
  5557. (catch :skip
  5558. (org-agenda-skip)
  5559. (setq s (match-string 1)
  5560. txt nil
  5561. pos (1- (match-beginning 1))
  5562. todo-state (save-match-data (org-get-todo-state))
  5563. show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  5564. (member todo-state
  5565. org-agenda-repeating-timestamp-show-all))
  5566. d2 (org-time-string-to-absolute
  5567. (match-string 1) d1 'past show-all
  5568. (current-buffer) pos)
  5569. diff (- d2 d1)
  5570. warntime (get-text-property (point) 'org-appt-warntime))
  5571. (setq pastschedp (and todayp (< diff 0)))
  5572. (setq did-habit-check-p nil)
  5573. ;; When to show a scheduled item in the calendar:
  5574. ;; If it is on or past the date.
  5575. (when (or (and (< diff 0)
  5576. (< (abs diff) org-scheduled-past-days)
  5577. (and todayp (not org-agenda-only-exact-dates)))
  5578. (= diff 0)
  5579. ;; org-is-habit-p uses org-entry-get, which is expansive
  5580. ;; so we go extra mile to only call it once
  5581. (and todayp
  5582. (boundp 'org-habit-show-all-today)
  5583. org-habit-show-all-today
  5584. (setq did-habit-check-p t)
  5585. (setq habitp (and (functionp 'org-is-habit-p)
  5586. (org-is-habit-p)))))
  5587. (save-excursion
  5588. (setq donep (member todo-state org-done-keywords))
  5589. (if (and donep
  5590. (or org-agenda-skip-scheduled-if-done
  5591. (not (= diff 0))
  5592. (and (functionp 'org-is-habit-p)
  5593. (org-is-habit-p))))
  5594. (setq txt nil)
  5595. (setq habitp (if did-habit-check-p habitp
  5596. (and (functionp 'org-is-habit-p)
  5597. (org-is-habit-p))))
  5598. (setq category (org-get-category)
  5599. category-pos (get-text-property (point) 'org-category-position))
  5600. (if (not (re-search-backward "^\\*+[ \t]+" nil t))
  5601. (setq txt org-agenda-no-heading-message)
  5602. (goto-char (match-end 0))
  5603. (setq pos1 (match-beginning 0))
  5604. (if habitp
  5605. (if (or (not org-habit-show-habits)
  5606. (and (not todayp)
  5607. (boundp 'org-habit-show-habits-only-for-today)
  5608. org-habit-show-habits-only-for-today))
  5609. (throw :skip nil))
  5610. (if (and
  5611. (or (eq t org-agenda-skip-scheduled-if-deadline-is-shown)
  5612. (and org-agenda-skip-scheduled-if-deadline-is-shown
  5613. pastschedp))
  5614. (setq mm (assoc pos1 deadline-position-alist)))
  5615. (throw :skip nil)))
  5616. (setq tags (org-get-tags-at nil t))
  5617. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  5618. (setq head (buffer-substring-no-properties
  5619. (point)
  5620. (progn (skip-chars-forward "^\r\n") (point))))
  5621. (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5622. (setq timestr
  5623. (concat (substring s (match-beginning 1)) " "))
  5624. (setq timestr 'time))
  5625. (setq txt (org-agenda-format-item
  5626. (if (= diff 0)
  5627. (car org-agenda-scheduled-leaders)
  5628. (format (nth 1 org-agenda-scheduled-leaders)
  5629. (- 1 diff)))
  5630. head level category tags
  5631. (if (not (= diff 0)) nil timestr)
  5632. nil habitp))))
  5633. (when txt
  5634. (setq face
  5635. (cond
  5636. ((and (not habitp) pastschedp)
  5637. 'org-scheduled-previously)
  5638. (todayp 'org-scheduled-today)
  5639. (t 'org-scheduled))
  5640. habitp (and habitp (org-habit-parse-todo)))
  5641. (org-add-props txt props
  5642. 'undone-face face
  5643. 'face (if donep 'org-agenda-done face)
  5644. 'org-marker (org-agenda-new-marker pos)
  5645. 'org-hd-marker (org-agenda-new-marker pos1)
  5646. 'type (if pastschedp "past-scheduled" "scheduled")
  5647. 'date (if pastschedp d2 date)
  5648. 'warntime warntime
  5649. 'level level
  5650. 'priority (if habitp
  5651. (org-habit-get-priority habitp)
  5652. (+ 94 (- 5 diff) (org-get-priority txt)))
  5653. 'org-category category
  5654. 'category-position category-pos
  5655. 'org-habit-p habitp
  5656. 'todo-state todo-state)
  5657. (push txt ee))))))
  5658. (nreverse ee)))
  5659. (defun org-agenda-get-blocks ()
  5660. "Return the date-range information for agenda display."
  5661. (let* ((props (list 'face nil
  5662. 'org-not-done-regexp org-not-done-regexp
  5663. 'org-todo-regexp org-todo-regexp
  5664. 'org-complex-heading-regexp org-complex-heading-regexp
  5665. 'mouse-face 'highlight
  5666. 'help-echo
  5667. (format "mouse-2 or RET jump to org file %s"
  5668. (abbreviate-file-name buffer-file-name))))
  5669. (regexp org-tr-regexp)
  5670. (d0 (calendar-absolute-from-gregorian date))
  5671. marker hdmarker ee txt d1 d2 s1 s2 category category-pos
  5672. level todo-state tags pos head donep)
  5673. (goto-char (point-min))
  5674. (while (re-search-forward regexp nil t)
  5675. (catch :skip
  5676. (org-agenda-skip)
  5677. (setq pos (point))
  5678. (let ((start-time (match-string 1))
  5679. (end-time (match-string 2)))
  5680. (setq s1 (match-string 1)
  5681. s2 (match-string 2)
  5682. d1 (time-to-days (org-time-string-to-time s1 (current-buffer) pos))
  5683. d2 (time-to-days (org-time-string-to-time s2 (current-buffer) pos)))
  5684. (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
  5685. ;; Only allow days between the limits, because the normal
  5686. ;; date stamps will catch the limits.
  5687. (save-excursion
  5688. (setq todo-state (org-get-todo-state))
  5689. (setq donep (member todo-state org-done-keywords))
  5690. (if (and donep org-agenda-skip-timestamp-if-done)
  5691. (throw :skip t))
  5692. (setq marker (org-agenda-new-marker (point)))
  5693. (setq category (org-get-category)
  5694. category-pos (get-text-property (point) 'org-category-position))
  5695. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5696. (setq txt org-agenda-no-heading-message)
  5697. (goto-char (match-beginning 0))
  5698. (setq hdmarker (org-agenda-new-marker (point)))
  5699. (setq tags (org-get-tags-at nil t))
  5700. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  5701. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5702. (setq head (match-string 1))
  5703. (let ((remove-re
  5704. (if org-agenda-remove-timeranges-from-blocks
  5705. (concat
  5706. "<" (regexp-quote s1) ".*?>"
  5707. "--"
  5708. "<" (regexp-quote s2) ".*?>")
  5709. nil)))
  5710. (setq txt (org-agenda-format-item
  5711. (format
  5712. (nth (if (= d1 d2) 0 1)
  5713. org-agenda-timerange-leaders)
  5714. (1+ (- d0 d1)) (1+ (- d2 d1)))
  5715. head level category tags
  5716. (cond ((and (= d1 d0) (= d2 d0))
  5717. (concat "<" start-time ">--<" end-time ">"))
  5718. ((= d1 d0)
  5719. (concat "<" start-time ">"))
  5720. ((= d2 d0)
  5721. (concat "<" end-time ">")))
  5722. remove-re))))
  5723. (org-add-props txt props
  5724. 'org-marker marker 'org-hd-marker hdmarker
  5725. 'type "block" 'date date
  5726. 'level level
  5727. 'todo-state todo-state
  5728. 'priority (org-get-priority txt) 'org-category category
  5729. 'org-category-position category-pos)
  5730. (push txt ee))))
  5731. (goto-char pos)))
  5732. ;; Sort the entries by expiration date.
  5733. (nreverse ee)))
  5734. ;;; Agenda presentation and sorting
  5735. (defvar org-prefix-has-time nil
  5736. "A flag, set by `org-compile-prefix-format'.
  5737. The flag is set if the currently compiled format contains a `%t'.")
  5738. (defvar org-prefix-has-tag nil
  5739. "A flag, set by `org-compile-prefix-format'.
  5740. The flag is set if the currently compiled format contains a `%T'.")
  5741. (defvar org-prefix-has-effort nil
  5742. "A flag, set by `org-compile-prefix-format'.
  5743. The flag is set if the currently compiled format contains a `%e'.")
  5744. (defvar org-prefix-category-length nil
  5745. "Used by `org-compile-prefix-format' to remember the category field width.")
  5746. (defvar org-prefix-category-max-length nil
  5747. "Used by `org-compile-prefix-format' to remember the category field width.")
  5748. (defun org-agenda-get-category-icon (category)
  5749. "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
  5750. (dolist (entry org-agenda-category-icon-alist)
  5751. (when (org-string-match-p (car entry) category)
  5752. (if (listp (cadr entry))
  5753. (return (cadr entry))
  5754. (return (apply 'create-image (cdr entry)))))))
  5755. (defun org-agenda-format-item (extra txt &optional level category tags dotime
  5756. remove-re habitp)
  5757. "Format TXT to be inserted into the agenda buffer.
  5758. In particular, add the prefix and corresponding text properties.
  5759. EXTRA must be a string to replace the `%s' specifier in the prefix format.
  5760. LEVEL may be a string to replace the `%l' specifier.
  5761. CATEGORY (a string, a symbol or nil) may be used to overrule the default
  5762. category taken from local variable or file name. It will replace the `%c'
  5763. specifier in the format.
  5764. DOTIME, when non-nil, indicates that a time-of-day should be extracted from
  5765. TXT for sorting of this entry, and for the `%t' specifier in the format.
  5766. When DOTIME is a string, this string is searched for a time before TXT is.
  5767. TAGS can be the tags of the headline.
  5768. Any match of REMOVE-RE will be removed from TXT."
  5769. ;; We keep the org-prefix-* variable values along with a compiled
  5770. ;; formatter, so that multiple agendas existing at the same time do
  5771. ;; not step on each other toes.
  5772. ;;
  5773. ;; It was inconvenient to make these variables buffer local in
  5774. ;; Agenda buffers, because this function expects to be called with
  5775. ;; the buffer where item comes from being current, and not agenda
  5776. ;; buffer
  5777. (let* ((bindings (car org-prefix-format-compiled))
  5778. (formatter (cadr org-prefix-format-compiled)))
  5779. (loop for (var value) in bindings
  5780. do (set var value))
  5781. (save-match-data
  5782. ;; Diary entries sometimes have extra whitespace at the beginning
  5783. (setq txt (org-trim txt))
  5784. ;; Fix the tags part in txt
  5785. (setq txt (org-agenda-fix-displayed-tags
  5786. txt tags
  5787. org-agenda-show-inherited-tags
  5788. org-agenda-hide-tags-regexp))
  5789. (let* ((category (or category
  5790. (if (stringp org-category)
  5791. org-category
  5792. (and org-category (symbol-name org-category)))
  5793. (if buffer-file-name
  5794. (file-name-sans-extension
  5795. (file-name-nondirectory buffer-file-name))
  5796. "")))
  5797. (category-icon (org-agenda-get-category-icon category))
  5798. (category-icon (if category-icon
  5799. (propertize " " 'display category-icon)
  5800. ""))
  5801. ;; time, tag, effort are needed for the eval of the prefix format
  5802. (tag (if tags (nth (1- (length tags)) tags) ""))
  5803. time effort neffort
  5804. (ts (if dotime (concat
  5805. (if (stringp dotime) dotime "")
  5806. (and org-agenda-search-headline-for-time txt))))
  5807. (time-of-day (and dotime (org-get-time-of-day ts)))
  5808. stamp plain s0 s1 s2 rtn srp l
  5809. duration thecategory)
  5810. (and (derived-mode-p 'org-mode) buffer-file-name
  5811. (add-to-list 'org-agenda-contributing-files buffer-file-name))
  5812. (when (and dotime time-of-day)
  5813. ;; Extract starting and ending time and move them to prefix
  5814. (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
  5815. (setq plain (string-match org-plain-time-of-day-regexp ts)))
  5816. (setq s0 (match-string 0 ts)
  5817. srp (and stamp (match-end 3))
  5818. s1 (match-string (if plain 1 2) ts)
  5819. s2 (match-string (if plain 8 (if srp 4 6)) ts))
  5820. ;; If the times are in TXT (not in DOTIMES), and the prefix will list
  5821. ;; them, we might want to remove them there to avoid duplication.
  5822. ;; The user can turn this off with a variable.
  5823. (if (and org-prefix-has-time
  5824. org-agenda-remove-times-when-in-prefix (or stamp plain)
  5825. (string-match (concat (regexp-quote s0) " *") txt)
  5826. (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
  5827. (if (eq org-agenda-remove-times-when-in-prefix 'beg)
  5828. (= (match-beginning 0) 0)
  5829. t))
  5830. (setq txt (replace-match "" nil nil txt))))
  5831. ;; Normalize the time(s) to 24 hour
  5832. (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
  5833. (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
  5834. ;; Try to set s2 if s1 and `org-agenda-default-appointment-duration' are set
  5835. (when (and s1 (not s2) org-agenda-default-appointment-duration)
  5836. (setq s2
  5837. (org-minutes-to-clocksum-string
  5838. (+ (org-hh:mm-string-to-minutes s1) org-agenda-default-appointment-duration))))
  5839. ;; Compute the duration
  5840. (when s2
  5841. (setq duration (- (org-hh:mm-string-to-minutes s2)
  5842. (org-hh:mm-string-to-minutes s1)))))
  5843. (when (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
  5844. txt)
  5845. ;; Tags are in the string
  5846. (if (or (eq org-agenda-remove-tags t)
  5847. (and org-agenda-remove-tags
  5848. org-prefix-has-tag))
  5849. (setq txt (replace-match "" t t txt))
  5850. (setq txt (replace-match
  5851. (concat (make-string (max (- 50 (length txt)) 1) ?\ )
  5852. (match-string 2 txt))
  5853. t t txt))))
  5854. (when (derived-mode-p 'org-mode)
  5855. (setq effort (ignore-errors (get-text-property 0 'org-effort txt)))
  5856. (when effort
  5857. (setq neffort (org-duration-string-to-minutes effort)
  5858. effort (setq effort (concat "[" effort "]")))))
  5859. ;; prevent erroring out with %e format when there is no effort
  5860. (or effort (setq effort ""))
  5861. (when remove-re
  5862. (while (string-match remove-re txt)
  5863. (setq txt (replace-match "" t t txt))))
  5864. ;; Set org-heading property on `txt' to mark the start of the
  5865. ;; heading.
  5866. (add-text-properties 0 (length txt) '(org-heading t) txt)
  5867. ;; Prepare the variables needed in the eval of the compiled format
  5868. (setq time (cond (s2 (concat
  5869. (org-agenda-time-of-day-to-ampm-maybe s1)
  5870. "-" (org-agenda-time-of-day-to-ampm-maybe s2)
  5871. (if org-agenda-timegrid-use-ampm " ")))
  5872. (s1 (concat
  5873. (org-agenda-time-of-day-to-ampm-maybe s1)
  5874. (if org-agenda-timegrid-use-ampm
  5875. "........ "
  5876. "......")))
  5877. (t ""))
  5878. extra (or (and (not habitp) extra) "")
  5879. category (if (symbolp category) (symbol-name category) category)
  5880. thecategory (copy-sequence category)
  5881. level (or level ""))
  5882. (if (string-match org-bracket-link-regexp category)
  5883. (progn
  5884. (setq l (if (match-end 3)
  5885. (- (match-end 3) (match-beginning 3))
  5886. (- (match-end 1) (match-beginning 1))))
  5887. (when (< l (or org-prefix-category-length 0))
  5888. (setq category (copy-sequence category))
  5889. (org-add-props category nil
  5890. 'extra-space (make-string
  5891. (- org-prefix-category-length l 1) ?\ ))))
  5892. (if (and org-prefix-category-max-length
  5893. (>= (length category) org-prefix-category-max-length))
  5894. (setq category (substring category 0 (1- org-prefix-category-max-length)))))
  5895. ;; Evaluate the compiled format
  5896. (setq rtn (concat (eval formatter) txt))
  5897. ;; And finally add the text properties
  5898. (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
  5899. (org-add-props rtn nil
  5900. 'org-category (if thecategory (downcase thecategory) category)
  5901. 'tags (mapcar 'org-downcase-keep-props tags)
  5902. 'org-highest-priority org-highest-priority
  5903. 'org-lowest-priority org-lowest-priority
  5904. 'time-of-day time-of-day
  5905. 'duration duration
  5906. 'effort effort
  5907. 'effort-minutes neffort
  5908. 'txt txt
  5909. 'level level
  5910. 'time time
  5911. 'extra extra
  5912. 'format org-prefix-format-compiled
  5913. 'dotime dotime)))))
  5914. (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
  5915. "Remove tags string from TXT, and add a modified list of tags.
  5916. The modified list may contain inherited tags, and tags matched by
  5917. `org-agenda-hide-tags-regexp' will be removed."
  5918. (when (or add-inherited hide-re)
  5919. (if (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") txt)
  5920. (setq txt (substring txt 0 (match-beginning 0))))
  5921. (setq tags
  5922. (delq nil
  5923. (mapcar (lambda (tg)
  5924. (if (or (and hide-re (string-match hide-re tg))
  5925. (and (not add-inherited)
  5926. (get-text-property 0 'inherited tg)))
  5927. nil
  5928. tg))
  5929. tags)))
  5930. (when tags
  5931. (let ((have-i (get-text-property 0 'inherited (car tags)))
  5932. i)
  5933. (setq txt (concat txt " :"
  5934. (mapconcat
  5935. (lambda (x)
  5936. (setq i (get-text-property 0 'inherited x))
  5937. (if (and have-i (not i))
  5938. (progn
  5939. (setq have-i nil)
  5940. (concat ":" x))
  5941. x))
  5942. tags ":")
  5943. (if have-i "::" ":"))))))
  5944. txt)
  5945. (defun org-downcase-keep-props (s)
  5946. (let ((props (text-properties-at 0 s)))
  5947. (setq s (downcase s))
  5948. (add-text-properties 0 (length s) props s)
  5949. s))
  5950. (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
  5951. (defvar org-agenda-sorting-strategy-selected nil)
  5952. (defun org-agenda-add-time-grid-maybe (list ndays todayp)
  5953. "Add a time-grid for agenda items which need it.
  5954. LIST is the list of agenda items formatted by `org-agenda-list'.
  5955. NDAYS is the span of the current agenda view.
  5956. TODAYP is `t' when the current agenda view is on today."
  5957. (catch 'exit
  5958. (cond ((not org-agenda-use-time-grid) (throw 'exit list))
  5959. ((and todayp (member 'today (car org-agenda-time-grid))))
  5960. ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
  5961. ((member 'weekly (car org-agenda-time-grid)))
  5962. (t (throw 'exit list)))
  5963. (let* ((have (delq nil (mapcar
  5964. (lambda (x) (get-text-property 1 'time-of-day x))
  5965. list)))
  5966. (string (nth 1 org-agenda-time-grid))
  5967. (gridtimes (nth 2 org-agenda-time-grid))
  5968. (req (car org-agenda-time-grid))
  5969. (remove (member 'remove-match req))
  5970. new time)
  5971. (if (and (member 'require-timed req) (not have))
  5972. ;; don't show empty grid
  5973. (throw 'exit list))
  5974. (while (setq time (pop gridtimes))
  5975. (unless (and remove (member time have))
  5976. (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
  5977. (push (org-agenda-format-item
  5978. nil string nil "" nil
  5979. (concat (substring time 0 -2) ":" (substring time -2)))
  5980. new)
  5981. (put-text-property
  5982. 2 (length (car new)) 'face 'org-time-grid (car new))))
  5983. (when (and todayp org-agenda-show-current-time-in-grid)
  5984. (push (org-agenda-format-item
  5985. nil org-agenda-current-time-string nil "" nil
  5986. (format-time-string "%H:%M "))
  5987. new)
  5988. (put-text-property
  5989. 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
  5990. (if (member 'time-up org-agenda-sorting-strategy-selected)
  5991. (append new list)
  5992. (append list new)))))
  5993. (defun org-compile-prefix-format (key)
  5994. "Compile the prefix format into a Lisp form that can be evaluated.
  5995. The resulting form and associated variable bindings is returned
  5996. and stored in the variable `org-prefix-format-compiled'."
  5997. (setq org-prefix-has-time nil
  5998. org-prefix-has-tag nil
  5999. org-prefix-category-length nil
  6000. org-prefix-has-effort nil)
  6001. (let ((s (cond
  6002. ((stringp org-agenda-prefix-format)
  6003. org-agenda-prefix-format)
  6004. ((assq key org-agenda-prefix-format)
  6005. (cdr (assq key org-agenda-prefix-format)))
  6006. (t " %-12:c%?-12t% s")))
  6007. (start 0)
  6008. varform vars var e c f opt)
  6009. (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cltsei]\\|(.+)\\)"
  6010. s start)
  6011. (setq var (or (cdr (assoc (match-string 4 s)
  6012. '(("c" . category) ("t" . time) ("l" . level) ("s" . extra)
  6013. ("i" . category-icon) ("T" . tag) ("e" . effort))))
  6014. 'eval)
  6015. c (or (match-string 3 s) "")
  6016. opt (match-beginning 1)
  6017. start (1+ (match-beginning 0)))
  6018. (if (equal var 'time) (setq org-prefix-has-time t))
  6019. (if (equal var 'tag) (setq org-prefix-has-tag t))
  6020. (if (equal var 'effort) (setq org-prefix-has-effort t))
  6021. (setq f (concat "%" (match-string 2 s) "s"))
  6022. (when (equal var 'category)
  6023. (setq org-prefix-category-length
  6024. (floor (abs (string-to-number (match-string 2 s)))))
  6025. (setq org-prefix-category-max-length
  6026. (let ((x (match-string 2 s)))
  6027. (save-match-data
  6028. (if (string-match "\\.[0-9]+" x)
  6029. (string-to-number (substring (match-string 0 x) 1)))))))
  6030. (if (eq var 'eval)
  6031. (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
  6032. (if opt
  6033. (setq varform
  6034. `(if (equal "" ,var)
  6035. ""
  6036. (format ,f (if (equal "" ,var) "" (concat ,var ,c)))))
  6037. (setq varform `(format ,f (if (equal ,var "") "" (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
  6038. (setq s (replace-match "%s" t nil s))
  6039. (push varform vars))
  6040. (setq vars (nreverse vars))
  6041. (with-current-buffer (or org-agenda-buffer (current-buffer))
  6042. (setq org-prefix-format-compiled
  6043. (list
  6044. `((org-prefix-has-time ,org-prefix-has-time)
  6045. (org-prefix-has-tag ,org-prefix-has-tag)
  6046. (org-prefix-category-length ,org-prefix-category-length)
  6047. (org-prefix-has-effort ,org-prefix-has-effort))
  6048. `(format ,s ,@vars))))))
  6049. (defun org-set-sorting-strategy (key)
  6050. (if (symbolp (car org-agenda-sorting-strategy))
  6051. ;; the old format
  6052. (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
  6053. (setq org-agenda-sorting-strategy-selected
  6054. (or (cdr (assq key org-agenda-sorting-strategy))
  6055. (cdr (assq 'agenda org-agenda-sorting-strategy))
  6056. '(time-up category-keep priority-down)))))
  6057. (defun org-get-time-of-day (s &optional string mod24)
  6058. "Check string S for a time of day.
  6059. If found, return it as a military time number between 0 and 2400.
  6060. If not found, return nil.
  6061. The optional STRING argument forces conversion into a 5 character wide string
  6062. HH:MM."
  6063. (save-match-data
  6064. (when
  6065. (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
  6066. (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
  6067. (let* ((h (string-to-number (match-string 1 s)))
  6068. (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
  6069. (ampm (if (match-end 4) (downcase (match-string 4 s))))
  6070. (am-p (equal ampm "am"))
  6071. (h1 (cond ((not ampm) h)
  6072. ((= h 12) (if am-p 0 12))
  6073. (t (+ h (if am-p 0 12)))))
  6074. (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
  6075. (mod h1 24) h1))
  6076. (t0 (+ (* 100 h2) m))
  6077. (t1 (concat (if (>= h1 24) "+" " ")
  6078. (if (and org-agenda-time-leading-zero
  6079. (< t0 1000)) "0" "")
  6080. (if (< t0 100) "0" "")
  6081. (if (< t0 10) "0" "")
  6082. (int-to-string t0))))
  6083. (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
  6084. (defvar org-agenda-before-sorting-filter-function nil
  6085. "Function to be applied to agenda items prior to sorting.
  6086. Prior to sorting also means just before they are inserted into the agenda.
  6087. To aid sorting, you may revisit the original entries and add more text
  6088. properties which will later be used by the sorting functions.
  6089. The function should take a string argument, an agenda line.
  6090. It has access to the text properties in that line, which contain among
  6091. other things, the property `org-hd-marker' that points to the entry
  6092. where the line comes from. Note that not all lines going into the agenda
  6093. have this property, only most.
  6094. The function should return the modified string. It is probably best
  6095. to ONLY change text properties.
  6096. You can also use this function as a filter, by returning nil for lines
  6097. you don't want to have in the agenda at all. For this application, you
  6098. could bind the variable in the options section of a custom command.")
  6099. (defun org-agenda-finalize-entries (list &optional nosort)
  6100. "Sort and concatenate the agenda items."
  6101. (setq list (mapcar 'org-agenda-highlight-todo list))
  6102. (if nosort
  6103. list
  6104. (when org-agenda-before-sorting-filter-function
  6105. (setq list (delq nil (mapcar org-agenda-before-sorting-filter-function list))))
  6106. (mapconcat 'identity (sort list 'org-entries-lessp) "\n")))
  6107. (defun org-agenda-highlight-todo (x)
  6108. (let ((org-done-keywords org-done-keywords-for-agenda)
  6109. (case-fold-search nil)
  6110. re)
  6111. (if (eq x 'line)
  6112. (save-excursion
  6113. (beginning-of-line 1)
  6114. (setq re (org-get-at-bol 'org-todo-regexp))
  6115. (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
  6116. (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
  6117. (add-text-properties (match-beginning 0) (match-end 1)
  6118. (list 'face (org-get-todo-face 1)))
  6119. (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
  6120. (delete-region (match-beginning 1) (1- (match-end 0)))
  6121. (goto-char (match-beginning 1))
  6122. (insert (format org-agenda-todo-keyword-format s)))))
  6123. (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
  6124. (setq re (get-text-property 0 'org-todo-regexp x))
  6125. (when (and re
  6126. ;; Test `pl' because if there's no heading content,
  6127. ;; there's no point matching to highlight. Note
  6128. ;; that if we didn't test `pl' first, and there
  6129. ;; happened to be no keyword from `org-todo-regexp'
  6130. ;; on this heading line, then the `equal' comparison
  6131. ;; afterwards would spuriously succeed in the case
  6132. ;; where `pl' is nil -- causing an args-out-of-range
  6133. ;; error when we try to add text properties to text
  6134. ;; that isn't there.
  6135. pl
  6136. (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
  6137. x pl) pl))
  6138. (add-text-properties
  6139. (or (match-end 1) (match-end 0)) (match-end 0)
  6140. (list 'face (org-get-todo-face (match-string 2 x)))
  6141. x)
  6142. (when (match-end 1)
  6143. (setq x (concat (substring x 0 (match-end 1))
  6144. (format org-agenda-todo-keyword-format
  6145. (match-string 2 x))
  6146. (org-add-props " " (text-properties-at 0 x))
  6147. (substring x (match-end 3)))))))
  6148. x)))
  6149. (defsubst org-cmp-priority (a b)
  6150. "Compare the priorities of string A and B."
  6151. (let ((pa (or (get-text-property 1 'priority a) 0))
  6152. (pb (or (get-text-property 1 'priority b) 0)))
  6153. (cond ((> pa pb) +1)
  6154. ((< pa pb) -1))))
  6155. (defsubst org-cmp-effort (a b)
  6156. "Compare the effort values of string A and B."
  6157. (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
  6158. (ea (or (get-text-property 1 'effort-minutes a) def))
  6159. (eb (or (get-text-property 1 'effort-minutes b) def)))
  6160. (cond ((> ea eb) +1)
  6161. ((< ea eb) -1))))
  6162. (defsubst org-cmp-category (a b)
  6163. "Compare the string values of categories of strings A and B."
  6164. (let ((ca (or (get-text-property 1 'org-category a) ""))
  6165. (cb (or (get-text-property 1 'org-category b) "")))
  6166. (cond ((string-lessp ca cb) -1)
  6167. ((string-lessp cb ca) +1))))
  6168. (defsubst org-cmp-todo-state (a b)
  6169. "Compare the todo states of strings A and B."
  6170. (let* ((ma (or (get-text-property 1 'org-marker a)
  6171. (get-text-property 1 'org-hd-marker a)))
  6172. (mb (or (get-text-property 1 'org-marker b)
  6173. (get-text-property 1 'org-hd-marker b)))
  6174. (fa (and ma (marker-buffer ma)))
  6175. (fb (and mb (marker-buffer mb)))
  6176. (todo-kwds
  6177. (or (and fa (with-current-buffer fa org-todo-keywords-1))
  6178. (and fb (with-current-buffer fb org-todo-keywords-1))))
  6179. (ta (or (get-text-property 1 'todo-state a) ""))
  6180. (tb (or (get-text-property 1 'todo-state b) ""))
  6181. (la (- (length (member ta todo-kwds))))
  6182. (lb (- (length (member tb todo-kwds))))
  6183. (donepa (member ta org-done-keywords-for-agenda))
  6184. (donepb (member tb org-done-keywords-for-agenda)))
  6185. (cond ((and donepa (not donepb)) -1)
  6186. ((and (not donepa) donepb) +1)
  6187. ((< la lb) -1)
  6188. ((< lb la) +1))))
  6189. (defsubst org-cmp-alpha (a b)
  6190. "Compare the headlines, alphabetically."
  6191. (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
  6192. (plb (text-property-any 0 (length b) 'org-heading t b))
  6193. (ta (and pla (substring a pla)))
  6194. (tb (and plb (substring b plb))))
  6195. (when pla
  6196. (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
  6197. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
  6198. (setq ta (substring ta (match-end 0))))
  6199. (setq ta (downcase ta)))
  6200. (when plb
  6201. (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
  6202. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
  6203. (setq tb (substring tb (match-end 0))))
  6204. (setq tb (downcase tb)))
  6205. (cond ((not ta) +1)
  6206. ((not tb) -1)
  6207. ((string-lessp ta tb) -1)
  6208. ((string-lessp tb ta) +1))))
  6209. (defsubst org-cmp-tag (a b)
  6210. "Compare the string values of the first tags of A and B."
  6211. (let ((ta (car (last (get-text-property 1 'tags a))))
  6212. (tb (car (last (get-text-property 1 'tags b)))))
  6213. (cond ((not ta) +1)
  6214. ((not tb) -1)
  6215. ((string-lessp ta tb) -1)
  6216. ((string-lessp tb ta) +1))))
  6217. (defsubst org-cmp-time (a b)
  6218. "Compare the time-of-day values of strings A and B."
  6219. (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
  6220. (ta (or (get-text-property 1 'time-of-day a) def))
  6221. (tb (or (get-text-property 1 'time-of-day b) def)))
  6222. (cond ((< ta tb) -1)
  6223. ((< tb ta) +1))))
  6224. (defsubst org-cmp-habit-p (a b)
  6225. "Compare the todo states of strings A and B."
  6226. (let ((ha (get-text-property 1 'org-habit-p a))
  6227. (hb (get-text-property 1 'org-habit-p b)))
  6228. (cond ((and ha (not hb)) -1)
  6229. ((and (not ha) hb) +1))))
  6230. (defsubst org-em (x y list) (or (memq x list) (memq y list)))
  6231. (defun org-entries-lessp (a b)
  6232. "Predicate for sorting agenda entries."
  6233. ;; The following variables will be used when the form is evaluated.
  6234. ;; So even though the compiler complains, keep them.
  6235. (let* ((ss org-agenda-sorting-strategy-selected)
  6236. (time-up (and (org-em 'time-up 'time-down ss)
  6237. (org-cmp-time a b)))
  6238. (time-down (if time-up (- time-up) nil))
  6239. (priority-up (and (org-em 'priority-up 'priority-down ss)
  6240. (org-cmp-priority a b)))
  6241. (priority-down (if priority-up (- priority-up) nil))
  6242. (effort-up (and (org-em 'effort-up 'effort-down ss)
  6243. (org-cmp-effort a b)))
  6244. (effort-down (if effort-up (- effort-up) nil))
  6245. (category-up (and (or (org-em 'category-up 'category-down ss)
  6246. (memq 'category-keep ss))
  6247. (org-cmp-category a b)))
  6248. (category-down (if category-up (- category-up) nil))
  6249. (category-keep (if category-up +1 nil))
  6250. (tag-up (and (org-em 'tag-up 'tag-down ss)
  6251. (org-cmp-tag a b)))
  6252. (tag-down (if tag-up (- tag-up) nil))
  6253. (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
  6254. (org-cmp-todo-state a b)))
  6255. (todo-state-down (if todo-state-up (- todo-state-up) nil))
  6256. (habit-up (and (org-em 'habit-up 'habit-down ss)
  6257. (org-cmp-habit-p a b)))
  6258. (habit-down (if habit-up (- habit-up) nil))
  6259. (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
  6260. (org-cmp-alpha a b)))
  6261. (alpha-down (if alpha-up (- alpha-up) nil))
  6262. (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
  6263. user-defined-up user-defined-down)
  6264. (if (and need-user-cmp org-agenda-cmp-user-defined
  6265. (functionp org-agenda-cmp-user-defined))
  6266. (setq user-defined-up
  6267. (funcall org-agenda-cmp-user-defined a b)
  6268. user-defined-down (if user-defined-up (- user-defined-up) nil)))
  6269. (cdr (assoc
  6270. (eval (cons 'or org-agenda-sorting-strategy-selected))
  6271. '((-1 . t) (1 . nil) (nil . nil))))))
  6272. ;;; Agenda restriction lock
  6273. (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
  6274. "Overlay to mark the headline to which agenda commands are restricted.")
  6275. (overlay-put org-agenda-restriction-lock-overlay
  6276. 'face 'org-agenda-restriction-lock)
  6277. (overlay-put org-agenda-restriction-lock-overlay
  6278. 'help-echo "Agendas are currently limited to this subtree.")
  6279. (org-detach-overlay org-agenda-restriction-lock-overlay)
  6280. (defun org-agenda-set-restriction-lock (&optional type)
  6281. "Set restriction lock for agenda, to current subtree or file.
  6282. Restriction will be the file if TYPE is `file', or if type is the
  6283. universal prefix '(4), or if the cursor is before the first headline
  6284. in the file. Otherwise, restriction will be to the current subtree."
  6285. (interactive "P")
  6286. (and (equal type '(4)) (setq type 'file))
  6287. (setq type (cond
  6288. (type type)
  6289. ((org-at-heading-p) 'subtree)
  6290. ((condition-case nil (org-back-to-heading t) (error nil))
  6291. 'subtree)
  6292. (t 'file)))
  6293. (if (eq type 'subtree)
  6294. (progn
  6295. (setq org-agenda-restrict t)
  6296. (setq org-agenda-overriding-restriction 'subtree)
  6297. (put 'org-agenda-files 'org-restrict
  6298. (list (buffer-file-name (buffer-base-buffer))))
  6299. (org-back-to-heading t)
  6300. (move-overlay org-agenda-restriction-lock-overlay (point) (point-at-eol))
  6301. (move-marker org-agenda-restrict-begin (point))
  6302. (move-marker org-agenda-restrict-end
  6303. (save-excursion (org-end-of-subtree t)))
  6304. (message "Locking agenda restriction to subtree"))
  6305. (put 'org-agenda-files 'org-restrict
  6306. (list (buffer-file-name (buffer-base-buffer))))
  6307. (setq org-agenda-restrict nil)
  6308. (setq org-agenda-overriding-restriction 'file)
  6309. (move-marker org-agenda-restrict-begin nil)
  6310. (move-marker org-agenda-restrict-end nil)
  6311. (message "Locking agenda restriction to file"))
  6312. (setq current-prefix-arg nil)
  6313. (org-agenda-maybe-redo))
  6314. (defun org-agenda-remove-restriction-lock (&optional noupdate)
  6315. "Remove the agenda restriction lock."
  6316. (interactive "P")
  6317. (org-detach-overlay org-agenda-restriction-lock-overlay)
  6318. (org-detach-overlay org-speedbar-restriction-lock-overlay)
  6319. (setq org-agenda-overriding-restriction nil)
  6320. (setq org-agenda-restrict nil)
  6321. (put 'org-agenda-files 'org-restrict nil)
  6322. (move-marker org-agenda-restrict-begin nil)
  6323. (move-marker org-agenda-restrict-end nil)
  6324. (setq current-prefix-arg nil)
  6325. (message "Agenda restriction lock removed")
  6326. (or noupdate (org-agenda-maybe-redo)))
  6327. (defun org-agenda-maybe-redo ()
  6328. "If there is any window showing the agenda view, update it."
  6329. (let ((w (get-buffer-window org-agenda-buffer-name t))
  6330. (w0 (selected-window)))
  6331. (when w
  6332. (select-window w)
  6333. (org-agenda-redo)
  6334. (select-window w0)
  6335. (if org-agenda-overriding-restriction
  6336. (message "Agenda view shifted to new %s restriction"
  6337. org-agenda-overriding-restriction)
  6338. (message "Agenda restriction lock removed")))))
  6339. ;;; Agenda commands
  6340. (defun org-agenda-check-type (error &rest types)
  6341. "Check if agenda buffer is of allowed type.
  6342. If ERROR is non-nil, throw an error, otherwise just return nil.
  6343. Allowed types are 'agenda 'timeline 'todo 'tags 'search."
  6344. (if (not org-agenda-type)
  6345. (error "No Org agenda currently displayed")
  6346. (if (memq org-agenda-type types)
  6347. t
  6348. (if error
  6349. (error "Not allowed in %s-type agenda buffers" org-agenda-type)
  6350. nil))))
  6351. (defun org-agenda-Quit ()
  6352. "Exit the agenda and kill buffers loaded by `org-agenda'.
  6353. Also restore the window configuration."
  6354. (interactive)
  6355. (if org-agenda-columns-active
  6356. (org-columns-quit)
  6357. (let ((buf (current-buffer)))
  6358. (if (eq org-agenda-window-setup 'other-frame)
  6359. (progn
  6360. (org-agenda-reset-markers)
  6361. (kill-buffer buf)
  6362. (org-columns-remove-overlays)
  6363. (setq org-agenda-archives-mode nil)
  6364. (delete-frame))
  6365. (and (not (eq org-agenda-window-setup 'current-window))
  6366. (not (one-window-p))
  6367. (delete-window))
  6368. (org-agenda-reset-markers)
  6369. (kill-buffer buf)
  6370. (org-columns-remove-overlays)
  6371. (setq org-agenda-archives-mode nil)))
  6372. ;; Maybe restore the pre-agenda window configuration.
  6373. (and org-agenda-restore-windows-after-quit
  6374. (not (eq org-agenda-window-setup 'other-frame))
  6375. org-agenda-pre-window-conf
  6376. (set-window-configuration org-agenda-pre-window-conf)
  6377. (setq org-agenda-pre-window-conf nil))))
  6378. (defun org-agenda-quit ()
  6379. "Exit the agenda and restore the window configuration.
  6380. When `org-agenda-sticky' is non-nil, only bury the agenda."
  6381. (interactive)
  6382. (if (and (eq org-indirect-buffer-display 'other-window)
  6383. org-last-indirect-buffer)
  6384. (delete-window (get-buffer-window org-last-indirect-buffer)))
  6385. (if org-agenda-columns-active
  6386. (org-columns-quit)
  6387. (if org-agenda-sticky
  6388. (let ((buf (current-buffer)))
  6389. (if (eq org-agenda-window-setup 'other-frame)
  6390. (progn
  6391. (delete-frame))
  6392. (and (not (eq org-agenda-window-setup 'current-window))
  6393. (not (one-window-p))
  6394. (delete-window)))
  6395. (with-current-buffer buf
  6396. (bury-buffer)
  6397. ;; Maybe restore the pre-agenda window configuration.
  6398. (and org-agenda-restore-windows-after-quit
  6399. (not (eq org-agenda-window-setup 'other-frame))
  6400. org-agenda-pre-window-conf
  6401. (set-window-configuration org-agenda-pre-window-conf)
  6402. (setq org-agenda-pre-window-conf nil))))
  6403. (org-agenda-Quit))))
  6404. (defun org-agenda-exit ()
  6405. "Exit the agenda and restore the window configuration.
  6406. Also kill Org-mode buffers loaded by `org-agenda'. Org-mode
  6407. buffers visited directly by the user will not be touched."
  6408. (interactive)
  6409. (org-release-buffers org-agenda-new-buffers)
  6410. (setq org-agenda-new-buffers nil)
  6411. (org-agenda-Quit))
  6412. (defun org-agenda-kill-all-agenda-buffers ()
  6413. "Kill all buffers in `org-agenda-mode'.
  6414. This is used when toggling sticky agendas.
  6415. You can also explicitly invoke it with `C-c a C-k'."
  6416. (interactive)
  6417. (let (blist)
  6418. (dolist (buf (buffer-list))
  6419. (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
  6420. (push buf blist)))
  6421. (mapc 'kill-buffer blist)))
  6422. (defun org-agenda-execute (arg)
  6423. "Execute another agenda command, keeping same window.
  6424. So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
  6425. in the agenda."
  6426. (interactive "P")
  6427. (let ((org-agenda-window-setup 'current-window))
  6428. (org-agenda arg)))
  6429. (defun org-agenda-redo (&optional all)
  6430. "Rebuild possibly ALL agenda view(s) in the current buffer."
  6431. (interactive "P")
  6432. (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
  6433. (cpa (unless (eq all t) current-prefix-arg))
  6434. (org-agenda-doing-sticky-redo org-agenda-sticky)
  6435. (org-agenda-sticky nil)
  6436. (org-agenda-buffer-name (or org-agenda-this-buffer-name
  6437. org-agenda-buffer-name))
  6438. (org-agenda-keep-modes t)
  6439. (tag-filter org-agenda-tag-filter)
  6440. (tag-preset (get 'org-agenda-tag-filter :preset-filter))
  6441. (top-cat-filter org-agenda-top-category-filter)
  6442. (cat-filter org-agenda-category-filter)
  6443. (cat-preset (get 'org-agenda-category-filter :preset-filter))
  6444. (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
  6445. (cols org-agenda-columns-active)
  6446. (line (org-current-line))
  6447. (window-line (- line (org-current-line (window-start))))
  6448. (lprops (get 'org-agenda-redo-command 'org-lprops))
  6449. (redo-cmd (get-text-property p 'org-redo-cmd))
  6450. (last-args (get-text-property p 'org-last-args))
  6451. (org-agenda-overriding-cmd (get-text-property p 'org-series-cmd))
  6452. (org-agenda-overriding-cmd-arguments
  6453. (unless (eq all t)
  6454. (cond ((listp last-args)
  6455. (cons (or cpa (car last-args)) (cdr last-args)))
  6456. ((stringp last-args)
  6457. last-args))))
  6458. (series-redo-cmd (get-text-property p 'org-series-redo-cmd)))
  6459. (put 'org-agenda-tag-filter :preset-filter nil)
  6460. (put 'org-agenda-category-filter :preset-filter nil)
  6461. (and cols (org-columns-quit))
  6462. (message "Rebuilding agenda buffer...")
  6463. (if series-redo-cmd
  6464. (eval series-redo-cmd)
  6465. (org-let lprops '(eval redo-cmd)))
  6466. (setq org-agenda-undo-list nil
  6467. org-agenda-pending-undo-list nil)
  6468. (message "Rebuilding agenda buffer...done")
  6469. (put 'org-agenda-tag-filter :preset-filter tag-preset)
  6470. (put 'org-agenda-category-filter :preset-filter cat-preset)
  6471. (and (or tag-filter tag-preset) (org-agenda-filter-apply tag-filter 'tag))
  6472. (and (or cat-filter cat-preset) (org-agenda-filter-apply cat-filter 'category))
  6473. (and top-cat-filter (org-agenda-filter-top-category-apply top-cat-filter))
  6474. (and cols (org-called-interactively-p 'any) (org-agenda-columns))
  6475. (org-goto-line line)
  6476. (recenter window-line)))
  6477. (defvar org-global-tags-completion-table nil)
  6478. (defvar org-agenda-filter-form nil)
  6479. (defvar org-agenda-filtered-by-category nil)
  6480. (defun org-agenda-filter-by-category (strip)
  6481. "Keep only those lines in the agenda buffer that have a specific category.
  6482. The category is that of the current line."
  6483. (interactive "P")
  6484. (if (and org-agenda-filtered-by-category
  6485. org-agenda-category-filter)
  6486. (org-agenda-filter-show-all-cat)
  6487. (let ((cat (org-no-properties (get-text-property (point) 'org-category))))
  6488. (if cat (org-agenda-filter-apply
  6489. (list (concat (if strip "-" "+") cat)) 'category)
  6490. (error "No category at point")))))
  6491. (defun org-find-top-category (&optional pos)
  6492. (save-excursion
  6493. (with-current-buffer (if pos (marker-buffer pos) (current-buffer))
  6494. (if pos (goto-char pos))
  6495. ;; Skip up to the topmost parent
  6496. (while (ignore-errors (outline-up-heading 1) t))
  6497. (ignore-errors
  6498. (nth 4 (org-heading-components))))))
  6499. (defvar org-agenda-filtered-by-top-category nil)
  6500. (defun org-agenda-filter-by-top-category (strip)
  6501. "Keep only those lines in the agenda buffer that have a specific category.
  6502. The category is that of the current line."
  6503. (interactive "P")
  6504. (if org-agenda-filtered-by-top-category
  6505. (progn
  6506. (setq org-agenda-filtered-by-top-category nil
  6507. org-agenda-top-category-filter nil)
  6508. (org-agenda-filter-show-all-cat))
  6509. (let ((cat (org-find-top-category (org-get-at-bol 'org-hd-marker))))
  6510. (if cat (org-agenda-filter-top-category-apply cat strip)
  6511. (error "No top-level category at point")))))
  6512. (defun org-agenda-filter-by-tag (strip &optional char narrow)
  6513. "Keep only those lines in the agenda buffer that have a specific tag.
  6514. The tag is selected with its fast selection letter, as configured.
  6515. With prefix argument STRIP, remove all lines that do have the tag.
  6516. A lisp caller can specify CHAR. NARROW means that the new tag should be
  6517. used to narrow the search - the interactive user can also press `-' or `+'
  6518. to switch to narrowing."
  6519. (interactive "P")
  6520. (let* ((alist org-tag-alist-for-agenda)
  6521. (tag-chars (mapconcat
  6522. (lambda (x) (if (and (not (symbolp (car x)))
  6523. (cdr x))
  6524. (char-to-string (cdr x))
  6525. ""))
  6526. alist ""))
  6527. (efforts (org-split-string
  6528. (or (cdr (assoc (concat org-effort-property "_ALL")
  6529. org-global-properties))
  6530. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00"
  6531. "")))
  6532. (effort-op org-agenda-filter-effort-default-operator)
  6533. (effort-prompt "")
  6534. (inhibit-read-only t)
  6535. (current org-agenda-tag-filter)
  6536. maybe-refresh a n tag)
  6537. (unless char
  6538. (message
  6539. "%s by tag [%s ], [TAB], %s[/]:off, [+-]:narrow, [>=<?]:effort: "
  6540. (if narrow "Narrow" "Filter") tag-chars
  6541. (if org-agenda-auto-exclude-function "[RET], " ""))
  6542. (setq char (read-char-exclusive)))
  6543. (when (member char '(?+ ?-))
  6544. ;; Narrowing down
  6545. (cond ((equal char ?-) (setq strip t narrow t))
  6546. ((equal char ?+) (setq strip nil narrow t)))
  6547. (message
  6548. "Narrow by tag [%s ], [TAB], [/]:off, [>=<]:effort: " tag-chars)
  6549. (setq char (read-char-exclusive)))
  6550. (when (member char '(?< ?> ?= ??))
  6551. ;; An effort operator
  6552. (setq effort-op (char-to-string char))
  6553. (setq alist nil) ; to make sure it will be interpreted as effort.
  6554. (unless (equal char ??)
  6555. (loop for i from 0 to 9 do
  6556. (setq effort-prompt
  6557. (concat
  6558. effort-prompt " ["
  6559. (if (= i 9) "0" (int-to-string (1+ i)))
  6560. "]" (nth i efforts))))
  6561. (message "Effort%s: %s " effort-op effort-prompt)
  6562. (setq char (read-char-exclusive))
  6563. (when (or (< char ?0) (> char ?9))
  6564. (error "Need 1-9,0 to select effort"))))
  6565. (when (equal char ?\t)
  6566. (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
  6567. (org-set-local 'org-global-tags-completion-table
  6568. (org-global-tags-completion-table)))
  6569. (let ((completion-ignore-case t))
  6570. (setq tag (org-icompleting-read
  6571. "Tag: " org-global-tags-completion-table))))
  6572. (cond
  6573. ((equal char ?\r)
  6574. (org-agenda-filter-show-all-tag)
  6575. (when org-agenda-auto-exclude-function
  6576. (setq org-agenda-tag-filter '())
  6577. (dolist (tag (org-agenda-get-represented-tags))
  6578. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  6579. (if modifier
  6580. (push modifier org-agenda-tag-filter))))
  6581. (if (not (null org-agenda-tag-filter))
  6582. (org-agenda-filter-apply org-agenda-tag-filter 'tag)))
  6583. (setq maybe-refresh t))
  6584. ((equal char ?/)
  6585. (org-agenda-filter-show-all-tag)
  6586. (when (get 'org-agenda-tag-filter :preset-filter)
  6587. (org-agenda-filter-apply org-agenda-tag-filter 'tag))
  6588. (setq maybe-refresh t))
  6589. ((equal char ?. )
  6590. (setq org-agenda-tag-filter
  6591. (mapcar (lambda(tag) (concat "+" tag))
  6592. (org-get-at-bol 'tags)))
  6593. (org-agenda-filter-apply org-agenda-tag-filter 'tag)
  6594. (setq maybe-refresh t))
  6595. ((or (equal char ?\ )
  6596. (setq a (rassoc char alist))
  6597. (and (>= char ?0) (<= char ?9)
  6598. (setq n (if (= char ?0) 9 (- char ?0 1))
  6599. tag (concat effort-op (nth n efforts))
  6600. a (cons tag nil)))
  6601. (and (= char ??)
  6602. (setq tag "?eff")
  6603. a (cons tag nil))
  6604. (and tag (setq a (cons tag nil))))
  6605. (org-agenda-filter-show-all-tag)
  6606. (setq tag (car a))
  6607. (setq org-agenda-tag-filter
  6608. (cons (concat (if strip "-" "+") tag)
  6609. (if narrow current nil)))
  6610. (org-agenda-filter-apply org-agenda-tag-filter 'tag)
  6611. (setq maybe-refresh t))
  6612. (t (error "Invalid tag selection character %c" char)))
  6613. (when (and maybe-refresh
  6614. (eq org-agenda-clockreport-mode 'with-filter))
  6615. (org-agenda-redo))))
  6616. (defun org-agenda-get-represented-tags ()
  6617. "Get a list of all tags currently represented in the agenda."
  6618. (let (p tags)
  6619. (save-excursion
  6620. (goto-char (point-min))
  6621. (while (setq p (next-single-property-change (point) 'tags))
  6622. (goto-char p)
  6623. (mapc (lambda (x) (add-to-list 'tags x))
  6624. (get-text-property (point) 'tags))))
  6625. tags))
  6626. (defun org-agenda-filter-by-tag-refine (strip &optional char)
  6627. "Refine the current filter. See `org-agenda-filter-by-tag'."
  6628. (interactive "P")
  6629. (org-agenda-filter-by-tag strip char 'refine))
  6630. (defun org-agenda-filter-make-matcher ()
  6631. "Create the form that tests a line for agenda filter."
  6632. (let (f f1)
  6633. ;; first compute the tag-filter matcher
  6634. (dolist (x (delete-dups
  6635. (append (get 'org-agenda-tag-filter
  6636. :preset-filter) org-agenda-tag-filter)))
  6637. (if (member x '("-" "+"))
  6638. (setq f1 (if (equal x "-") 'tags '(not tags)))
  6639. (if (string-match "[<=>?]" x)
  6640. (setq f1 (org-agenda-filter-effort-form x))
  6641. (setq f1 (list 'member (downcase (substring x 1)) 'tags)))
  6642. (if (equal (string-to-char x) ?-)
  6643. (setq f1 (list 'not f1))))
  6644. (push f1 f))
  6645. ;; then compute the category-filter matcher
  6646. (dolist (x (delete-dups
  6647. (append (get 'org-agenda-category-filter
  6648. :preset-filter) org-agenda-category-filter)))
  6649. (if (equal "-" (substring x 0 1))
  6650. (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
  6651. (setq f1 (list 'equal (substring x 1) 'cat)))
  6652. (push f1 f))
  6653. (cons 'and (nreverse f))))
  6654. (defun org-agenda-filter-effort-form (e)
  6655. "Return the form to compare the effort of the current line with what E says.
  6656. E looks like \"+<2:25\"."
  6657. (let (op)
  6658. (setq e (substring e 1))
  6659. (setq op (string-to-char e) e (substring e 1))
  6660. (setq op (cond ((equal op ?<) '<=)
  6661. ((equal op ?>) '>=)
  6662. ((equal op ??) op)
  6663. (t '=)))
  6664. (list 'org-agenda-compare-effort (list 'quote op)
  6665. (org-duration-string-to-minutes e))))
  6666. (defun org-agenda-compare-effort (op value)
  6667. "Compare the effort of the current line with VALUE, using OP.
  6668. If the line does not have an effort defined, return nil."
  6669. (let ((eff (org-get-at-bol 'effort-minutes)))
  6670. (if (equal op ??)
  6671. (not eff)
  6672. (funcall op (or eff (if org-sort-agenda-noeffort-is-high 32767 0))
  6673. value))))
  6674. (defun org-agenda-filter-apply (filter type)
  6675. "Set FILTER as the new agenda filter and apply it."
  6676. (let (tags cat)
  6677. (if (eq type 'tag)
  6678. (setq org-agenda-tag-filter filter)
  6679. (setq org-agenda-category-filter filter))
  6680. (setq org-agenda-filter-form (org-agenda-filter-make-matcher))
  6681. (if (and (eq type 'category)
  6682. (not (equal (substring (car filter) 0 1) "-")))
  6683. ;; Only set `org-agenda-filtered-by-category' to t
  6684. ;; when a unique category is used as the filter
  6685. (setq org-agenda-filtered-by-category t))
  6686. (org-agenda-set-mode-name)
  6687. (save-excursion
  6688. (goto-char (point-min))
  6689. (while (not (eobp))
  6690. (if (org-get-at-bol 'org-marker)
  6691. (progn
  6692. (setq tags (org-get-at-bol 'tags) ; used in eval
  6693. cat (get-text-property (point) 'org-category))
  6694. (if (not (eval org-agenda-filter-form))
  6695. (org-agenda-filter-hide-line type))
  6696. (beginning-of-line 2))
  6697. (beginning-of-line 2))))
  6698. (if (get-char-property (point) 'invisible)
  6699. (ignore-errors (org-agenda-previous-line)))))
  6700. (defun org-agenda-filter-top-category-apply (category &optional negative)
  6701. "Set FILTER as the new agenda filter and apply it."
  6702. (org-agenda-set-mode-name)
  6703. (save-excursion
  6704. (goto-char (point-min))
  6705. (while (not (eobp))
  6706. (let* ((pos (org-get-at-bol 'org-hd-marker))
  6707. (topcat (and pos (org-find-top-category pos))))
  6708. (if (and topcat (funcall (if negative 'identity 'not)
  6709. (string= category topcat)))
  6710. (org-agenda-filter-hide-line 'category)))
  6711. (beginning-of-line 2)))
  6712. (if (get-char-property (point) 'invisible)
  6713. (org-agenda-previous-line))
  6714. (setq org-agenda-top-category-filter category
  6715. org-agenda-filtered-by-top-category t))
  6716. (defun org-agenda-filter-hide-line (type)
  6717. (let (ov)
  6718. (setq ov (make-overlay (max (point-min) (1- (point-at-bol)))
  6719. (point-at-eol)))
  6720. (overlay-put ov 'invisible t)
  6721. (overlay-put ov 'type type)
  6722. (if (eq type 'tag)
  6723. (push ov org-agenda-tag-filter-overlays)
  6724. (push ov org-agenda-cat-filter-overlays))))
  6725. (defun org-agenda-fix-tags-filter-overlays-at (&optional pos)
  6726. (setq pos (or pos (point)))
  6727. (save-excursion
  6728. (dolist (ov (overlays-at pos))
  6729. (when (and (overlay-get ov 'invisible)
  6730. (eq (overlay-get ov 'type) 'tag))
  6731. (goto-char pos)
  6732. (if (< (overlay-start ov) (point-at-eol))
  6733. (move-overlay ov (point-at-eol)
  6734. (overlay-end ov)))))))
  6735. (defun org-agenda-filter-show-all-tag nil
  6736. (mapc 'delete-overlay org-agenda-tag-filter-overlays)
  6737. (setq org-agenda-tag-filter-overlays nil
  6738. org-agenda-tag-filter nil
  6739. org-agenda-filter-form nil)
  6740. (org-agenda-set-mode-name))
  6741. (defun org-agenda-filter-show-all-cat nil
  6742. (mapc 'delete-overlay org-agenda-cat-filter-overlays)
  6743. (setq org-agenda-cat-filter-overlays nil
  6744. org-agenda-filtered-by-category nil
  6745. org-agenda-category-filter nil
  6746. org-agenda-filter-form nil)
  6747. (org-agenda-set-mode-name))
  6748. (defun org-agenda-manipulate-query-add ()
  6749. "Manipulate the query by adding a search term with positive selection.
  6750. Positive selection means the term must be matched for selection of an entry."
  6751. (interactive)
  6752. (org-agenda-manipulate-query ?\[))
  6753. (defun org-agenda-manipulate-query-subtract ()
  6754. "Manipulate the query by adding a search term with negative selection.
  6755. Negative selection means term must not be matched for selection of an entry."
  6756. (interactive)
  6757. (org-agenda-manipulate-query ?\]))
  6758. (defun org-agenda-manipulate-query-add-re ()
  6759. "Manipulate the query by adding a search regexp with positive selection.
  6760. Positive selection means the regexp must match for selection of an entry."
  6761. (interactive)
  6762. (org-agenda-manipulate-query ?\{))
  6763. (defun org-agenda-manipulate-query-subtract-re ()
  6764. "Manipulate the query by adding a search regexp with negative selection.
  6765. Negative selection means regexp must not match for selection of an entry."
  6766. (interactive)
  6767. (org-agenda-manipulate-query ?\}))
  6768. (defun org-agenda-manipulate-query (char)
  6769. (cond
  6770. ((memq org-agenda-type '(timeline agenda))
  6771. (let ((org-agenda-include-inactive-timestamps t))
  6772. (org-agenda-redo))
  6773. (message "Display now includes inactive timestamps as well"))
  6774. ((eq org-agenda-type 'search)
  6775. (org-add-to-string
  6776. 'org-agenda-query-string
  6777. (if org-agenda-last-search-view-search-was-boolean
  6778. (cdr (assoc char '((?\[ . " +") (?\] . " -")
  6779. (?\{ . " +{}") (?\} . " -{}"))))
  6780. " "))
  6781. (setq org-agenda-redo-command
  6782. (list 'org-search-view
  6783. (car (get-text-property (min (1- (point-max)) (point))
  6784. 'org-last-args))
  6785. org-agenda-query-string
  6786. (+ (length org-agenda-query-string)
  6787. (if (member char '(?\{ ?\})) 0 1))))
  6788. (set-register org-agenda-query-register org-agenda-query-string)
  6789. (let ((org-agenda-overriding-arguments
  6790. (cdr org-agenda-redo-command)))
  6791. (org-agenda-redo)))
  6792. (t (error "Cannot manipulate query for %s-type agenda buffers"
  6793. org-agenda-type))))
  6794. (defun org-add-to-string (var string)
  6795. (set var (concat (symbol-value var) string)))
  6796. (defun org-agenda-goto-date (span)
  6797. "Jump to DATE in agenda."
  6798. (interactive "P")
  6799. (let* ((org-read-date-prefer-future
  6800. (eval org-agenda-jump-prefer-future))
  6801. (date (org-read-date))
  6802. (org-agenda-sticky-orig org-agenda-sticky)
  6803. (org-agenda-buffer-tmp-name (buffer-name))
  6804. (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  6805. (0-arg (or current-prefix-arg (car args)))
  6806. (2-arg (nth 2 args))
  6807. (newcmd (list 'org-agenda-list 0-arg date
  6808. (org-agenda-span-to-ndays 2-arg)))
  6809. (newargs (cdr newcmd))
  6810. (inhibit-read-only t)
  6811. org-agenda-sticky)
  6812. (if (not (org-agenda-check-type t 'agenda))
  6813. (error "Not available in non-agenda blocks")
  6814. (add-text-properties (point-min) (point-max)
  6815. `(org-redo-cmd ,newcmd org-last-args ,newargs))
  6816. (org-agenda-redo)
  6817. (setq org-agenda-sticky org-agenda-sticky-orig
  6818. org-agenda-this-buffer-is-sticky org-agenda-sticky))))
  6819. (defun org-agenda-goto-today ()
  6820. "Go to today."
  6821. (interactive)
  6822. (org-agenda-check-type t 'timeline 'agenda)
  6823. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  6824. (curspan (nth 2 args))
  6825. (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
  6826. (cond
  6827. (tdpos (goto-char tdpos))
  6828. ((eq org-agenda-type 'agenda)
  6829. (let* ((sd (org-agenda-compute-starting-span
  6830. (org-today) (or curspan org-agenda-ndays org-agenda-span)))
  6831. (org-agenda-overriding-arguments args))
  6832. (setf (nth 1 org-agenda-overriding-arguments) sd)
  6833. (org-agenda-redo)
  6834. (org-agenda-find-same-or-today-or-agenda)))
  6835. (t (error "Cannot find today")))))
  6836. (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
  6837. (goto-char
  6838. (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
  6839. (text-property-any (point-min) (point-max) 'org-today t)
  6840. (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
  6841. (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
  6842. (org-agenda-goto-block-beginning))
  6843. (point-min))))
  6844. (defun org-agenda-goto-block-beginning ()
  6845. "Go the agenda block beginning."
  6846. (interactive)
  6847. (if (not (derived-mode-p 'org-agenda-mode))
  6848. (error "Cannot execute this command outside of org-agenda-mode buffers")
  6849. (let (dest)
  6850. (save-excursion
  6851. (unless (looking-at "\\'")
  6852. (forward-char))
  6853. (let* ((prop 'org-agenda-structural-header)
  6854. (p (previous-single-property-change (point) prop))
  6855. (n (next-single-property-change (or (and (looking-at "\\`") 1)
  6856. (1- (point))) prop)))
  6857. (setq dest (cond ((eq n (point-at-eol)) (1- n)) (p (1- p))))))
  6858. (if (not dest)
  6859. (error "Cannot find the beginning of the blog")
  6860. (goto-char dest)
  6861. (move-beginning-of-line 1)))))
  6862. (defun org-agenda-later (arg)
  6863. "Go forward in time by the current span.
  6864. With prefix ARG, go forward that many times the current span."
  6865. (interactive "p")
  6866. (org-agenda-check-type t 'agenda)
  6867. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  6868. (span (or (nth 2 args) org-agenda-current-span))
  6869. (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
  6870. (greg (calendar-gregorian-from-absolute sd))
  6871. (cnt (org-get-at-bol 'org-day-cnt))
  6872. greg2)
  6873. (cond
  6874. ((numberp span)
  6875. (setq sd (+ (* span arg) sd)))
  6876. ((eq span 'day)
  6877. (setq sd (+ arg sd)))
  6878. ((eq span 'week)
  6879. (setq sd (+ (* 7 arg) sd)))
  6880. ((eq span 'month)
  6881. (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
  6882. sd (calendar-absolute-from-gregorian greg2))
  6883. (setcar greg2 (1+ (car greg2))))
  6884. ((eq span 'year)
  6885. (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
  6886. sd (calendar-absolute-from-gregorian greg2))
  6887. (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
  6888. (t
  6889. (setq sd (+ (* span arg) sd))))
  6890. (let ((org-agenda-overriding-cmd
  6891. ;; `cmd' may have been set by `org-agenda-run-series' which
  6892. ;; uses `org-agenda-overriding-cmd' to decide whether
  6893. ;; overriding is allowed for `cmd'
  6894. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  6895. (org-agenda-overriding-arguments
  6896. (list (car args) sd span)))
  6897. (org-agenda-redo)
  6898. (org-agenda-find-same-or-today-or-agenda cnt))))
  6899. (defun org-agenda-earlier (arg)
  6900. "Go backward in time by the current span.
  6901. With prefix ARG, go backward that many times the current span."
  6902. (interactive "p")
  6903. (org-agenda-later (- arg)))
  6904. (defun org-agenda-view-mode-dispatch ()
  6905. "Call one of the view mode commands."
  6906. (interactive)
  6907. (message "View: [d]ay [w]eek [m]onth [y]ear [SPC]reset [q]uit/abort
  6908. time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
  6909. [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
  6910. (let ((a (read-char-exclusive)))
  6911. (case a
  6912. (?\ (call-interactively 'org-agenda-reset-view))
  6913. (?d (call-interactively 'org-agenda-day-view))
  6914. (?w (call-interactively 'org-agenda-week-view))
  6915. (?m (call-interactively 'org-agenda-month-view))
  6916. (?y (call-interactively 'org-agenda-year-view))
  6917. (?l (call-interactively 'org-agenda-log-mode))
  6918. (?L (org-agenda-log-mode '(4)))
  6919. (?c (org-agenda-log-mode 'clockcheck))
  6920. ((?F ?f) (call-interactively 'org-agenda-follow-mode))
  6921. (?a (call-interactively 'org-agenda-archives-mode))
  6922. (?A (org-agenda-archives-mode 'files))
  6923. ((?R ?r) (call-interactively 'org-agenda-clockreport-mode))
  6924. ((?E ?e) (call-interactively 'org-agenda-entry-text-mode))
  6925. (?G (call-interactively 'org-agenda-toggle-time-grid))
  6926. (?D (call-interactively 'org-agenda-toggle-diary))
  6927. (?\! (call-interactively 'org-agenda-toggle-deadlines))
  6928. (?\[ (let ((org-agenda-include-inactive-timestamps t))
  6929. (org-agenda-check-type t 'timeline 'agenda)
  6930. (org-agenda-redo))
  6931. (message "Display now includes inactive timestamps as well"))
  6932. (?q (message "Abort"))
  6933. (otherwise (error "Invalid key" )))))
  6934. (defun org-agenda-reset-view ()
  6935. "Switch to default view for agenda."
  6936. (interactive)
  6937. (org-agenda-change-time-span (or org-agenda-ndays org-agenda-span)))
  6938. (defun org-agenda-day-view (&optional day-of-year)
  6939. "Switch to daily view for agenda.
  6940. With argument DAY-OF-YEAR, switch to that day of the year."
  6941. (interactive "P")
  6942. (org-agenda-change-time-span 'day day-of-year))
  6943. (defun org-agenda-week-view (&optional iso-week)
  6944. "Switch to daily view for agenda.
  6945. With argument ISO-WEEK, switch to the corresponding ISO week.
  6946. If ISO-WEEK has more then 2 digits, only the last two encode the
  6947. week. Any digits before this encode a year. So 200712 means
  6948. week 12 of year 2007. Years in the range 1938-2037 can also be
  6949. written as 2-digit years."
  6950. (interactive "P")
  6951. (org-agenda-change-time-span 'week iso-week))
  6952. (defun org-agenda-month-view (&optional month)
  6953. "Switch to monthly view for agenda.
  6954. With argument MONTH, switch to that month."
  6955. (interactive "P")
  6956. (org-agenda-change-time-span 'month month))
  6957. (defun org-agenda-year-view (&optional year)
  6958. "Switch to yearly view for agenda.
  6959. With argument YEAR, switch to that year.
  6960. If MONTH has more then 2 digits, only the last two encode the
  6961. month. Any digits before this encode a year. So 200712 means
  6962. December year 2007. Years in the range 1938-2037 can also be
  6963. written as 2-digit years."
  6964. (interactive "P")
  6965. (when year
  6966. (setq year (org-small-year-to-year year)))
  6967. (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
  6968. (org-agenda-change-time-span 'year year)
  6969. (error "Abort")))
  6970. (defun org-agenda-change-time-span (span &optional n)
  6971. "Change the agenda view to SPAN.
  6972. SPAN may be `day', `week', `month', `year'."
  6973. (org-agenda-check-type t 'agenda)
  6974. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  6975. (curspan (nth 2 args)))
  6976. (if (and (not n) (equal curspan span))
  6977. (error "Viewing span is already \"%s\"" span))
  6978. (let* ((sd (or (org-get-at-bol 'day)
  6979. (nth 1 args)
  6980. org-starting-day))
  6981. (sd (org-agenda-compute-starting-span sd span n))
  6982. (org-agenda-overriding-cmd
  6983. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  6984. (org-agenda-overriding-arguments
  6985. (list (car args) sd span)))
  6986. (org-agenda-redo)
  6987. (org-agenda-find-same-or-today-or-agenda))
  6988. (org-agenda-set-mode-name)
  6989. (message "Switched to %s view" span)))
  6990. (defun org-agenda-compute-starting-span (sd span &optional n)
  6991. "Compute starting date for agenda.
  6992. SPAN may be `day', `week', `month', `year'. The return value
  6993. is a cons cell with the starting date and the number of days,
  6994. so that the date SD will be in that range."
  6995. (let* ((greg (calendar-gregorian-from-absolute sd))
  6996. (dg (nth 1 greg))
  6997. (mg (car greg))
  6998. (yg (nth 2 greg)))
  6999. (cond
  7000. ((eq span 'day)
  7001. (when n
  7002. (setq sd (+ (calendar-absolute-from-gregorian
  7003. (list mg 1 yg))
  7004. n -1))))
  7005. ((eq span 'week)
  7006. (let* ((nt (calendar-day-of-week
  7007. (calendar-gregorian-from-absolute sd)))
  7008. (d (if org-agenda-start-on-weekday
  7009. (- nt org-agenda-start-on-weekday)
  7010. 0))
  7011. y1)
  7012. (setq sd (- sd (+ (if (< d 0) 7 0) d)))
  7013. (when n
  7014. (require 'cal-iso)
  7015. (when (> n 99)
  7016. (setq y1 (org-small-year-to-year (/ n 100))
  7017. n (mod n 100)))
  7018. (setq sd
  7019. (calendar-absolute-from-iso
  7020. (list n 1
  7021. (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
  7022. ((eq span 'month)
  7023. (let (y1)
  7024. (when (and n (> n 99))
  7025. (setq y1 (org-small-year-to-year (/ n 100))
  7026. n (mod n 100)))
  7027. (setq sd (calendar-absolute-from-gregorian
  7028. (list (or n mg) 1 (or y1 yg))))))
  7029. ((eq span 'year)
  7030. (setq sd (calendar-absolute-from-gregorian
  7031. (list 1 1 (or n yg))))))
  7032. sd))
  7033. (defun org-agenda-next-date-line (&optional arg)
  7034. "Jump to the next line indicating a date in agenda buffer."
  7035. (interactive "p")
  7036. (org-agenda-check-type t 'agenda 'timeline)
  7037. (beginning-of-line 1)
  7038. ;; This does not work if user makes date format that starts with a blank
  7039. (if (looking-at "^\\S-") (forward-char 1))
  7040. (if (not (re-search-forward "^\\S-" nil t arg))
  7041. (progn
  7042. (backward-char 1)
  7043. (error "No next date after this line in this buffer")))
  7044. (goto-char (match-beginning 0)))
  7045. (defun org-agenda-previous-date-line (&optional arg)
  7046. "Jump to the previous line indicating a date in agenda buffer."
  7047. (interactive "p")
  7048. (org-agenda-check-type t 'agenda 'timeline)
  7049. (beginning-of-line 1)
  7050. (if (not (re-search-backward "^\\S-" nil t arg))
  7051. (error "No previous date before this line in this buffer")))
  7052. ;; Initialize the highlight
  7053. (defvar org-hl (make-overlay 1 1))
  7054. (overlay-put org-hl 'face 'highlight)
  7055. (defun org-highlight (begin end &optional buffer)
  7056. "Highlight a region with overlay."
  7057. (move-overlay org-hl begin end (or buffer (current-buffer))))
  7058. (defun org-unhighlight ()
  7059. "Detach overlay INDEX."
  7060. (org-detach-overlay org-hl))
  7061. (defun org-unhighlight-once ()
  7062. "Remove the highlight from its position, and this function from the hook."
  7063. (remove-hook 'pre-command-hook 'org-unhighlight-once)
  7064. (org-unhighlight))
  7065. (defvar org-agenda-pre-follow-window-conf nil)
  7066. (defun org-agenda-follow-mode ()
  7067. "Toggle follow mode in an agenda buffer."
  7068. (interactive)
  7069. (unless org-agenda-follow-mode
  7070. (setq org-agenda-pre-follow-window-conf
  7071. (current-window-configuration)))
  7072. (setq org-agenda-follow-mode (not org-agenda-follow-mode))
  7073. (unless org-agenda-follow-mode
  7074. (set-window-configuration org-agenda-pre-follow-window-conf))
  7075. (org-agenda-set-mode-name)
  7076. (org-agenda-do-context-action)
  7077. (message "Follow mode is %s"
  7078. (if org-agenda-follow-mode "on" "off")))
  7079. (defun org-agenda-entry-text-mode (&optional arg)
  7080. "Toggle entry text mode in an agenda buffer."
  7081. (interactive "P")
  7082. (setq org-agenda-entry-text-mode (or (integerp arg)
  7083. (not org-agenda-entry-text-mode)))
  7084. (org-agenda-entry-text-hide)
  7085. (and org-agenda-entry-text-mode
  7086. (let ((org-agenda-entry-text-maxlines
  7087. (if (integerp arg) arg org-agenda-entry-text-maxlines)))
  7088. (org-agenda-entry-text-show)))
  7089. (org-agenda-set-mode-name)
  7090. (message "Entry text mode is %s. Maximum number of lines is %d"
  7091. (if org-agenda-entry-text-mode "on" "off")
  7092. (if (integerp arg) arg org-agenda-entry-text-maxlines)))
  7093. (defun org-agenda-clockreport-mode (&optional with-filter)
  7094. "Toggle clocktable mode in an agenda buffer.
  7095. With prefix arg WITH-FILTER, make the clocktable respect the current
  7096. agenda filter."
  7097. (interactive "P")
  7098. (org-agenda-check-type t 'agenda)
  7099. (if with-filter
  7100. (setq org-agenda-clockreport-mode 'with-filter)
  7101. (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode)))
  7102. (org-agenda-set-mode-name)
  7103. (org-agenda-redo)
  7104. (message "Clocktable mode is %s"
  7105. (if org-agenda-clockreport-mode "on" "off")))
  7106. (defun org-agenda-log-mode (&optional special)
  7107. "Toggle log mode in an agenda buffer.
  7108. With argument SPECIAL, show all possible log items, not only the ones
  7109. configured in `org-agenda-log-mode-items'.
  7110. With a double `C-u' prefix arg, show *only* log items, nothing else."
  7111. (interactive "P")
  7112. (org-agenda-check-type t 'agenda 'timeline)
  7113. (setq org-agenda-show-log
  7114. (cond
  7115. ((equal special '(16)) 'only)
  7116. ((eq special 'clockcheck)
  7117. (if (eq org-agenda-show-log 'clockcheck)
  7118. nil 'clockcheck))
  7119. (special '(closed clock state))
  7120. (t (not org-agenda-show-log))))
  7121. (org-agenda-set-mode-name)
  7122. (org-agenda-redo)
  7123. (message "Log mode is %s"
  7124. (if org-agenda-show-log "on" "off")))
  7125. (defun org-agenda-archives-mode (&optional with-files)
  7126. "Toggle inclusion of items in trees marked with :ARCHIVE:.
  7127. When called with a prefix argument, include all archive files as well."
  7128. (interactive "P")
  7129. (setq org-agenda-archives-mode
  7130. (if with-files t (if org-agenda-archives-mode nil 'trees)))
  7131. (org-agenda-set-mode-name)
  7132. (org-agenda-redo)
  7133. (message
  7134. "%s"
  7135. (cond
  7136. ((eq org-agenda-archives-mode nil)
  7137. "No archives are included")
  7138. ((eq org-agenda-archives-mode 'trees)
  7139. (format "Trees with :%s: tag are included" org-archive-tag))
  7140. ((eq org-agenda-archives-mode t)
  7141. (format "Trees with :%s: tag and all active archive files are included"
  7142. org-archive-tag)))))
  7143. (defun org-agenda-toggle-diary ()
  7144. "Toggle diary inclusion in an agenda buffer."
  7145. (interactive)
  7146. (org-agenda-check-type t 'agenda)
  7147. (setq org-agenda-include-diary (not org-agenda-include-diary))
  7148. (org-agenda-redo)
  7149. (org-agenda-set-mode-name)
  7150. (message "Diary inclusion turned %s"
  7151. (if org-agenda-include-diary "on" "off")))
  7152. (defun org-agenda-toggle-deadlines ()
  7153. "Toggle inclusion of entries with a deadline in an agenda buffer."
  7154. (interactive)
  7155. (org-agenda-check-type t 'agenda)
  7156. (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
  7157. (org-agenda-redo)
  7158. (org-agenda-set-mode-name)
  7159. (message "Deadlines inclusion turned %s"
  7160. (if org-agenda-include-deadlines "on" "off")))
  7161. (defun org-agenda-toggle-time-grid ()
  7162. "Toggle time grid in an agenda buffer."
  7163. (interactive)
  7164. (org-agenda-check-type t 'agenda)
  7165. (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
  7166. (org-agenda-redo)
  7167. (org-agenda-set-mode-name)
  7168. (message "Time-grid turned %s"
  7169. (if org-agenda-use-time-grid "on" "off")))
  7170. (defun org-agenda-set-mode-name ()
  7171. "Set the mode name to indicate all the small mode settings."
  7172. (setq mode-name
  7173. (list "Org-Agenda"
  7174. (if (get 'org-agenda-files 'org-restrict) " []" "")
  7175. " "
  7176. '(:eval (org-agenda-span-name org-agenda-current-span))
  7177. (if org-agenda-follow-mode " Follow" "")
  7178. (if org-agenda-entry-text-mode " ETxt" "")
  7179. (if org-agenda-include-diary " Diary" "")
  7180. (if org-agenda-include-deadlines " Ddl" "")
  7181. (if org-agenda-use-time-grid " Grid" "")
  7182. (if (and (boundp 'org-habit-show-habits)
  7183. org-habit-show-habits) " Habit" "")
  7184. (cond
  7185. ((consp org-agenda-show-log) " LogAll")
  7186. ((eq org-agenda-show-log 'clockcheck) " ClkCk")
  7187. (org-agenda-show-log " Log")
  7188. (t ""))
  7189. (if (or org-agenda-category-filter (get 'org-agenda-category-filter
  7190. :preset-filter))
  7191. '(:eval (org-propertize
  7192. (concat " <"
  7193. (mapconcat
  7194. 'identity
  7195. (append
  7196. (get 'org-agenda-category-filter :preset-filter)
  7197. org-agenda-category-filter)
  7198. "")
  7199. ">")
  7200. 'face 'org-agenda-filter-category
  7201. 'help-echo "Category used in filtering"))
  7202. "")
  7203. (if (or org-agenda-tag-filter (get 'org-agenda-tag-filter
  7204. :preset-filter))
  7205. '(:eval (org-propertize
  7206. (concat " {"
  7207. (mapconcat
  7208. 'identity
  7209. (append
  7210. (get 'org-agenda-tag-filter :preset-filter)
  7211. org-agenda-tag-filter)
  7212. "")
  7213. "}")
  7214. 'face 'org-agenda-filter-tags
  7215. 'help-echo "Tags used in filtering"))
  7216. "")
  7217. (if org-agenda-archives-mode
  7218. (if (eq org-agenda-archives-mode t)
  7219. " Archives"
  7220. (format " :%s:" org-archive-tag))
  7221. "")
  7222. (if org-agenda-clockreport-mode
  7223. (if (eq org-agenda-clockreport-mode 'with-filter)
  7224. " Clock{}" " Clock")
  7225. "")))
  7226. (force-mode-line-update))
  7227. (org-define-obsolete-function-alias
  7228. 'org-agenda-post-command-hook 'org-agenda-update-agenda-type "24.3")
  7229. (defun org-agenda-update-agenda-type ()
  7230. "Update the agenda type after each command."
  7231. (setq org-agenda-type
  7232. (or (get-text-property (point) 'org-agenda-type)
  7233. (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
  7234. (defun org-agenda-next-line ()
  7235. "Move cursor to the next line, and show if follow mode is active."
  7236. (interactive)
  7237. (call-interactively 'next-line)
  7238. (org-agenda-do-context-action))
  7239. (defun org-agenda-previous-line ()
  7240. "Move cursor to the previous line, and show if follow-mode is active."
  7241. (interactive)
  7242. (call-interactively 'previous-line)
  7243. (org-agenda-do-context-action))
  7244. (defun org-agenda-next-item (n)
  7245. "Move cursor to next agenda item."
  7246. (interactive "p")
  7247. (let ((col (current-column)))
  7248. (dotimes (c n)
  7249. (when (next-single-property-change (point-at-eol) 'org-marker)
  7250. (move-end-of-line 1)
  7251. (goto-char (next-single-property-change (point) 'org-marker))))
  7252. (org-move-to-column col))
  7253. (org-agenda-do-context-action))
  7254. (defun org-agenda-previous-item (n)
  7255. "Move cursor to next agenda item."
  7256. (interactive "p")
  7257. (dotimes (c n)
  7258. (let ((col (current-column))
  7259. (goto (save-excursion
  7260. (move-end-of-line 0)
  7261. (previous-single-property-change (point) 'org-marker))))
  7262. (if goto (goto-char goto))
  7263. (org-move-to-column col)))
  7264. (org-agenda-do-context-action))
  7265. (defun org-agenda-do-context-action ()
  7266. "Show outline path and, maybe, follow mode window."
  7267. (let ((m (org-get-at-bol 'org-marker)))
  7268. (when (and (markerp m) (marker-buffer m))
  7269. (and org-agenda-follow-mode
  7270. (if org-agenda-follow-indirect
  7271. (org-agenda-tree-to-indirect-buffer nil)
  7272. (org-agenda-show)))
  7273. (and org-agenda-show-outline-path
  7274. (org-with-point-at m (org-display-outline-path t))))))
  7275. (defun org-agenda-show-tags ()
  7276. "Show the tags applicable to the current item."
  7277. (interactive)
  7278. (let* ((tags (org-get-at-bol 'tags)))
  7279. (if tags
  7280. (message "Tags are :%s:"
  7281. (org-no-properties (mapconcat 'identity tags ":")))
  7282. (message "No tags associated with this line"))))
  7283. (defun org-agenda-goto (&optional highlight)
  7284. "Go to the Org-mode file which contains the item at point."
  7285. (interactive)
  7286. (let* ((marker (or (org-get-at-bol 'org-marker)
  7287. (org-agenda-error)))
  7288. (buffer (marker-buffer marker))
  7289. (pos (marker-position marker)))
  7290. (switch-to-buffer-other-window buffer)
  7291. (widen)
  7292. (push-mark)
  7293. (goto-char pos)
  7294. (when (derived-mode-p 'org-mode)
  7295. (org-show-context 'agenda)
  7296. (save-excursion
  7297. (and (outline-next-heading)
  7298. (org-flag-heading nil)))) ; show the next heading
  7299. (when (outline-invisible-p)
  7300. (show-entry)) ; display invisible text
  7301. (recenter (/ (window-height) 2))
  7302. (run-hooks 'org-agenda-after-show-hook)
  7303. (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
  7304. (defvar org-agenda-after-show-hook nil
  7305. "Normal hook run after an item has been shown from the agenda.
  7306. Point is in the buffer where the item originated.")
  7307. (defun org-agenda-kill ()
  7308. "Kill the entry or subtree belonging to the current agenda entry."
  7309. (interactive)
  7310. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  7311. (let* ((bufname-orig (buffer-name))
  7312. (marker (or (org-get-at-bol 'org-marker)
  7313. (org-agenda-error)))
  7314. (buffer (marker-buffer marker))
  7315. (pos (marker-position marker))
  7316. (type (org-get-at-bol 'type))
  7317. dbeg dend (n 0) conf)
  7318. (org-with-remote-undo buffer
  7319. (with-current-buffer buffer
  7320. (save-excursion
  7321. (goto-char pos)
  7322. (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
  7323. (setq dbeg (progn (org-back-to-heading t) (point))
  7324. dend (org-end-of-subtree t t))
  7325. (setq dbeg (point-at-bol)
  7326. dend (min (point-max) (1+ (point-at-eol)))))
  7327. (goto-char dbeg)
  7328. (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
  7329. (setq conf (or (eq t org-agenda-confirm-kill)
  7330. (and (numberp org-agenda-confirm-kill)
  7331. (> n org-agenda-confirm-kill))))
  7332. (and conf
  7333. (not (y-or-n-p
  7334. (format "Delete entry with %d lines in buffer \"%s\"? "
  7335. n (buffer-name buffer))))
  7336. (error "Abort"))
  7337. (let ((org-agenda-buffer-name bufname-orig))
  7338. (org-remove-subtree-entries-from-agenda buffer dbeg dend))
  7339. (with-current-buffer buffer (delete-region dbeg dend))
  7340. (message "Agenda item and source killed"))))
  7341. (defvar org-archive-default-command) ; defined in org-archive.el
  7342. (defun org-agenda-archive-default ()
  7343. "Archive the entry or subtree belonging to the current agenda entry."
  7344. (interactive)
  7345. (require 'org-archive)
  7346. (org-agenda-archive-with org-archive-default-command))
  7347. (defun org-agenda-archive-default-with-confirmation ()
  7348. "Archive the entry or subtree belonging to the current agenda entry."
  7349. (interactive)
  7350. (require 'org-archive)
  7351. (org-agenda-archive-with org-archive-default-command 'confirm))
  7352. (defun org-agenda-archive ()
  7353. "Archive the entry or subtree belonging to the current agenda entry."
  7354. (interactive)
  7355. (org-agenda-archive-with 'org-archive-subtree))
  7356. (defun org-agenda-archive-to-archive-sibling ()
  7357. "Move the entry to the archive sibling."
  7358. (interactive)
  7359. (org-agenda-archive-with 'org-archive-to-archive-sibling))
  7360. (defun org-agenda-archive-with (cmd &optional confirm)
  7361. "Move the entry to the archive sibling."
  7362. (interactive)
  7363. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  7364. (let* ((bufname-orig (buffer-name))
  7365. (marker (or (org-get-at-bol 'org-marker)
  7366. (org-agenda-error)))
  7367. (buffer (marker-buffer marker))
  7368. (pos (marker-position marker)))
  7369. (org-with-remote-undo buffer
  7370. (with-current-buffer buffer
  7371. (if (derived-mode-p 'org-mode)
  7372. (if (and confirm
  7373. (not (y-or-n-p "Archive this subtree or entry? ")))
  7374. (error "Abort")
  7375. (save-excursion
  7376. (goto-char pos)
  7377. (let ((org-agenda-buffer-name bufname-orig))
  7378. (org-remove-subtree-entries-from-agenda))
  7379. (org-back-to-heading t)
  7380. (funcall cmd)))
  7381. (error "Archiving works only in Org-mode files"))))))
  7382. (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
  7383. "Remove all lines in the agenda that correspond to a given subtree.
  7384. The subtree is the one in buffer BUF, starting at BEG and ending at END.
  7385. If this information is not given, the function uses the tree at point."
  7386. (let ((buf (or buf (current-buffer))) m p)
  7387. (save-excursion
  7388. (unless (and beg end)
  7389. (org-back-to-heading t)
  7390. (setq beg (point))
  7391. (org-end-of-subtree t)
  7392. (setq end (point)))
  7393. (set-buffer (get-buffer org-agenda-buffer-name))
  7394. (save-excursion
  7395. (goto-char (point-max))
  7396. (beginning-of-line 1)
  7397. (while (not (bobp))
  7398. (when (and (setq m (org-get-at-bol 'org-marker))
  7399. (equal buf (marker-buffer m))
  7400. (setq p (marker-position m))
  7401. (>= p beg)
  7402. (< p end))
  7403. (let ((inhibit-read-only t))
  7404. (delete-region (point-at-bol) (1+ (point-at-eol)))))
  7405. (beginning-of-line 0))))))
  7406. (defun org-agenda-refile (&optional goto rfloc no-update)
  7407. "Refile the item at point."
  7408. (interactive "P")
  7409. (if (equal goto '(16))
  7410. (org-refile-goto-last-stored)
  7411. (let* ((buffer-orig (buffer-name))
  7412. (marker (or (org-get-at-bol 'org-hd-marker)
  7413. (org-agenda-error)))
  7414. (buffer (marker-buffer marker))
  7415. (pos (marker-position marker))
  7416. (rfloc (or rfloc
  7417. (org-refile-get-location
  7418. (if goto "Goto" "Refile to") buffer
  7419. org-refile-allow-creating-parent-nodes))))
  7420. (with-current-buffer buffer
  7421. (save-excursion
  7422. (save-restriction
  7423. (widen)
  7424. (goto-char marker)
  7425. (let ((org-agenda-buffer-name buffer-orig))
  7426. (org-remove-subtree-entries-from-agenda))
  7427. (org-refile goto buffer rfloc)))))
  7428. (unless no-update (org-agenda-redo))))
  7429. (defun org-agenda-open-link (&optional arg)
  7430. "Open the link(s) in the current entry, if any.
  7431. This looks for a link in the displayed line in the agenda.
  7432. It also looks at the text of the entry itself."
  7433. (interactive "P")
  7434. (let* ((marker (or (org-get-at-bol 'org-hd-marker)
  7435. (org-get-at-bol 'org-marker)))
  7436. (buffer (and marker (marker-buffer marker)))
  7437. (prefix (buffer-substring
  7438. (point-at-bol) (point-at-eol)))
  7439. (lkall (org-offer-links-in-entry buffer marker arg prefix))
  7440. (lk (car lkall))
  7441. (lkend (cdr lkall))
  7442. trg)
  7443. (cond
  7444. ((and buffer (stringp lk))
  7445. (with-current-buffer buffer
  7446. (setq trg (and (string-match org-bracket-link-regexp lk)
  7447. (match-string 1 lk)))
  7448. (if (or (not trg) (string-match org-any-link-re trg))
  7449. (save-excursion
  7450. (save-restriction
  7451. (widen)
  7452. (goto-char marker)
  7453. (when (search-forward lk nil lkend)
  7454. (goto-char (match-beginning 0))
  7455. (org-open-at-point))))
  7456. ;; This is an internal link, widen the buffer
  7457. (switch-to-buffer-other-window buffer)
  7458. (widen)
  7459. (goto-char marker)
  7460. (when (search-forward lk nil lkend)
  7461. (goto-char (match-beginning 0))
  7462. (org-open-at-point)))))
  7463. ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
  7464. (save-excursion
  7465. (beginning-of-line 1)
  7466. (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
  7467. (org-open-link-from-string (match-string 1)))
  7468. (t (message "No link to open here")))))
  7469. (defun org-agenda-copy-local-variable (var)
  7470. "Get a variable from a referenced buffer and install it here."
  7471. (let ((m (org-get-at-bol 'org-marker)))
  7472. (when (and m (buffer-live-p (marker-buffer m)))
  7473. (org-set-local var (with-current-buffer (marker-buffer m)
  7474. (symbol-value var))))))
  7475. (defun org-agenda-switch-to (&optional delete-other-windows)
  7476. "Go to the Org-mode file which contains the item at point."
  7477. (interactive)
  7478. (if (and org-return-follows-link
  7479. (not (org-get-at-bol 'org-marker))
  7480. (org-in-regexp org-bracket-link-regexp))
  7481. (org-open-link-from-string (match-string 0))
  7482. (let* ((marker (or (org-get-at-bol 'org-marker)
  7483. (org-agenda-error)))
  7484. (buffer (marker-buffer marker))
  7485. (pos (marker-position marker)))
  7486. (org-pop-to-buffer-same-window buffer)
  7487. (and delete-other-windows (delete-other-windows))
  7488. (widen)
  7489. (goto-char pos)
  7490. (when (derived-mode-p 'org-mode)
  7491. (org-show-context 'agenda)
  7492. (save-excursion
  7493. (and (outline-next-heading)
  7494. (org-flag-heading nil))) ; show the next heading
  7495. (when (outline-invisible-p)
  7496. (show-entry)) ; display invisible text
  7497. (run-hooks 'org-agenda-after-show-hook)))))
  7498. (defun org-agenda-goto-mouse (ev)
  7499. "Go to the Org-mode file which contains the item at the mouse click."
  7500. (interactive "e")
  7501. (mouse-set-point ev)
  7502. (org-agenda-goto))
  7503. (defun org-agenda-show (&optional full-entry)
  7504. "Display the Org-mode file which contains the item at point.
  7505. With prefix argument FULL-ENTRY, make the entire entry visible
  7506. if it was hidden in the outline."
  7507. (interactive "P")
  7508. (let ((win (selected-window)))
  7509. (if full-entry
  7510. (let ((org-show-entry-below t))
  7511. (org-agenda-goto t))
  7512. (org-agenda-goto t))
  7513. (select-window win)))
  7514. (defvar org-agenda-show-window nil)
  7515. (defun org-agenda-show-and-scroll-up (&optional arg)
  7516. "Display the Org-mode file which contains the item at point.
  7517. When called repeatedly, scroll the window that is displaying the buffer.
  7518. With a \\[universal-argument] prefix, use `org-show-entry' instead of
  7519. `show-subtree' to display the item, so that drawers and logbooks stay
  7520. folded."
  7521. (interactive "P")
  7522. (let ((win (selected-window)))
  7523. (if (and (window-live-p org-agenda-show-window)
  7524. (eq this-command last-command))
  7525. (progn
  7526. (select-window org-agenda-show-window)
  7527. (ignore-errors (scroll-up)))
  7528. (org-agenda-goto t)
  7529. (if arg (org-show-entry) (show-subtree))
  7530. (setq org-agenda-show-window (selected-window)))
  7531. (select-window win)))
  7532. (defun org-agenda-show-scroll-down ()
  7533. "Scroll down the window showing the agenda."
  7534. (interactive)
  7535. (let ((win (selected-window)))
  7536. (when (window-live-p org-agenda-show-window)
  7537. (select-window org-agenda-show-window)
  7538. (ignore-errors (scroll-down))
  7539. (select-window win))))
  7540. (defun org-agenda-show-1 (&optional more)
  7541. "Display the Org-mode file which contains the item at point.
  7542. The prefix arg selects the amount of information to display:
  7543. 0 hide the subtree
  7544. 1 just show the entry according to defaults.
  7545. 2 show the children view
  7546. 3 show the subtree view
  7547. 4 show the entire subtree and any LOGBOOK drawers
  7548. 5 show the entire subtree and any drawers
  7549. With prefix argument FULL-ENTRY, make the entire entry visible
  7550. if it was hidden in the outline."
  7551. (interactive "p")
  7552. (let ((win (selected-window)))
  7553. (org-agenda-goto t)
  7554. (org-recenter-heading 1)
  7555. (cond
  7556. ((= more 0)
  7557. (hide-subtree)
  7558. (save-excursion
  7559. (org-back-to-heading)
  7560. (run-hook-with-args 'org-cycle-hook 'folded))
  7561. (message "Remote: FOLDED"))
  7562. ((and (org-called-interactively-p 'any) (= more 1))
  7563. (message "Remote: show with default settings"))
  7564. ((= more 2)
  7565. (show-entry)
  7566. (show-children)
  7567. (save-excursion
  7568. (org-back-to-heading)
  7569. (run-hook-with-args 'org-cycle-hook 'children))
  7570. (message "Remote: CHILDREN"))
  7571. ((= more 3)
  7572. (show-subtree)
  7573. (save-excursion
  7574. (org-back-to-heading)
  7575. (run-hook-with-args 'org-cycle-hook 'subtree))
  7576. (message "Remote: SUBTREE"))
  7577. ((= more 4)
  7578. (let* ((org-drawers (delete "LOGBOOK" (copy-sequence org-drawers)))
  7579. (org-drawer-regexp
  7580. (concat "^[ \t]*:\\("
  7581. (mapconcat 'regexp-quote org-drawers "\\|")
  7582. "\\):[ \t]*$")))
  7583. (show-subtree)
  7584. (save-excursion
  7585. (org-back-to-heading)
  7586. (org-cycle-hide-drawers 'subtree)))
  7587. (message "Remote: SUBTREE AND LOGBOOK"))
  7588. ((> more 4)
  7589. (show-subtree)
  7590. (message "Remote: SUBTREE AND ALL DRAWERS")))
  7591. (select-window win)))
  7592. (defun org-recenter-heading (n)
  7593. (save-excursion
  7594. (org-back-to-heading)
  7595. (recenter n)))
  7596. (defvar org-agenda-cycle-counter nil)
  7597. (defun org-agenda-cycle-show (&optional n)
  7598. "Show the current entry in another window, with default settings.
  7599. Default settings are taken from `org-show-hierarchy-above' and siblings.
  7600. When use repeatedly in immediate succession, the remote entry will cycle
  7601. through visibility
  7602. children -> subtree -> folded
  7603. When called with a numeric prefix arg, that arg will be passed through to
  7604. `org-agenda-show-1'. For the interpretation of that argument, see the
  7605. docstring of `org-agenda-show-1'."
  7606. (interactive "P")
  7607. (if (integerp n)
  7608. (setq org-agenda-cycle-counter n)
  7609. (if (not (eq last-command this-command))
  7610. (setq org-agenda-cycle-counter 1)
  7611. (if (equal org-agenda-cycle-counter 0)
  7612. (setq org-agenda-cycle-counter 2)
  7613. (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
  7614. (if (> org-agenda-cycle-counter 3)
  7615. (setq org-agenda-cycle-counter 0)))))
  7616. (org-agenda-show-1 org-agenda-cycle-counter))
  7617. (defun org-agenda-recenter (arg)
  7618. "Display the Org-mode file which contains the item at point and recenter."
  7619. (interactive "P")
  7620. (let ((win (selected-window)))
  7621. (org-agenda-goto t)
  7622. (recenter arg)
  7623. (select-window win)))
  7624. (defun org-agenda-show-mouse (ev)
  7625. "Display the Org-mode file which contains the item at the mouse click."
  7626. (interactive "e")
  7627. (mouse-set-point ev)
  7628. (org-agenda-show))
  7629. (defun org-agenda-check-no-diary ()
  7630. "Check if the entry is a diary link and abort if yes."
  7631. (if (org-get-at-bol 'org-agenda-diary-link)
  7632. (org-agenda-error)))
  7633. (defun org-agenda-error ()
  7634. (error "Command not allowed in this line"))
  7635. (defun org-agenda-tree-to-indirect-buffer (arg)
  7636. "Show the subtree corresponding to the current entry in an indirect buffer.
  7637. This calls the command `org-tree-to-indirect-buffer' from the original buffer.
  7638. With a numerical prefix ARG, go up to this level and then take that tree.
  7639. With a negative numeric ARG, go up by this number of levels.
  7640. With a \\[universal-argument] prefix, make a separate frame for this tree (i.e. don't
  7641. use the dedicated frame)."
  7642. (interactive "P")
  7643. (if current-prefix-arg
  7644. (org-agenda-do-tree-to-indirect-buffer arg)
  7645. (let ((agenda-buffer (buffer-name))
  7646. (agenda-window (selected-window))
  7647. (indirect-window
  7648. (and org-last-indirect-buffer
  7649. (get-buffer-window org-last-indirect-buffer))))
  7650. (save-window-excursion (org-agenda-do-tree-to-indirect-buffer arg))
  7651. (unless (or (eq org-indirect-buffer-display 'new-frame)
  7652. (eq org-indirect-buffer-display 'dedicated-frame))
  7653. (unwind-protect
  7654. (unless (and indirect-window (window-live-p indirect-window))
  7655. (setq indirect-window (split-window agenda-window)))
  7656. (and indirect-window (select-window indirect-window))
  7657. (switch-to-buffer org-last-indirect-buffer :norecord)
  7658. (fit-window-to-buffer indirect-window)))
  7659. (select-window (get-buffer-window agenda-buffer)))))
  7660. (defun org-agenda-do-tree-to-indirect-buffer (arg)
  7661. "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
  7662. (org-agenda-check-no-diary)
  7663. (let* ((marker (or (org-get-at-bol 'org-marker)
  7664. (org-agenda-error)))
  7665. (buffer (marker-buffer marker))
  7666. (pos (marker-position marker)))
  7667. (with-current-buffer buffer
  7668. (save-excursion
  7669. (goto-char pos)
  7670. (funcall 'org-tree-to-indirect-buffer arg)))))
  7671. (defvar org-last-heading-marker (make-marker)
  7672. "Marker pointing to the headline that last changed its TODO state
  7673. by a remote command from the agenda.")
  7674. (defun org-agenda-todo-nextset ()
  7675. "Switch TODO entry to next sequence."
  7676. (interactive)
  7677. (org-agenda-todo 'nextset))
  7678. (defun org-agenda-todo-previousset ()
  7679. "Switch TODO entry to previous sequence."
  7680. (interactive)
  7681. (org-agenda-todo 'previousset))
  7682. (defun org-agenda-todo (&optional arg)
  7683. "Cycle TODO state of line at point, also in Org-mode file.
  7684. This changes the line at point, all other lines in the agenda referring to
  7685. the same tree node, and the headline of the tree node in the Org-mode file."
  7686. (interactive "P")
  7687. (org-agenda-check-no-diary)
  7688. (let* ((col (current-column))
  7689. (marker (or (org-get-at-bol 'org-marker)
  7690. (org-agenda-error)))
  7691. (buffer (marker-buffer marker))
  7692. (pos (marker-position marker))
  7693. (hdmarker (org-get-at-bol 'org-hd-marker))
  7694. (todayp (org-agenda-todayp (org-get-at-bol 'day)))
  7695. (inhibit-read-only t)
  7696. org-agenda-headline-snapshot-before-repeat newhead just-one)
  7697. (org-with-remote-undo buffer
  7698. (with-current-buffer buffer
  7699. (widen)
  7700. (goto-char pos)
  7701. (org-show-context 'agenda)
  7702. (save-excursion
  7703. (and (outline-next-heading)
  7704. (org-flag-heading nil))) ; show the next heading
  7705. (let ((current-prefix-arg arg))
  7706. (call-interactively 'org-todo))
  7707. (and (bolp) (forward-char 1))
  7708. (setq newhead (org-get-heading))
  7709. (when (and (org-bound-and-true-p
  7710. org-agenda-headline-snapshot-before-repeat)
  7711. (not (equal org-agenda-headline-snapshot-before-repeat
  7712. newhead))
  7713. todayp)
  7714. (setq newhead org-agenda-headline-snapshot-before-repeat
  7715. just-one t))
  7716. (save-excursion
  7717. (org-back-to-heading)
  7718. (move-marker org-last-heading-marker (point))))
  7719. (beginning-of-line 1)
  7720. (save-excursion
  7721. (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
  7722. (org-move-to-column col))))
  7723. (defun org-agenda-add-note (&optional arg)
  7724. "Add a time-stamped note to the entry at point."
  7725. (interactive "P")
  7726. (org-agenda-check-no-diary)
  7727. (let* ((marker (or (org-get-at-bol 'org-marker)
  7728. (org-agenda-error)))
  7729. (buffer (marker-buffer marker))
  7730. (pos (marker-position marker))
  7731. (hdmarker (org-get-at-bol 'org-hd-marker))
  7732. (inhibit-read-only t))
  7733. (with-current-buffer buffer
  7734. (widen)
  7735. (goto-char pos)
  7736. (org-show-context 'agenda)
  7737. (save-excursion
  7738. (and (outline-next-heading)
  7739. (org-flag-heading nil))) ; show the next heading
  7740. (org-add-note))))
  7741. (defun org-agenda-change-all-lines (newhead hdmarker
  7742. &optional fixface just-this)
  7743. "Change all lines in the agenda buffer which match HDMARKER.
  7744. The new content of the line will be NEWHEAD (as modified by
  7745. `org-agenda-format-item'). HDMARKER is checked with
  7746. `equal' against all `org-hd-marker' text properties in the file.
  7747. If FIXFACE is non-nil, the face of each item is modified according to
  7748. the new TODO state.
  7749. If JUST-THIS is non-nil, change just the current line, not all.
  7750. If FORCE-TAGS is non nil, the car of it returns the new tags."
  7751. (let* ((inhibit-read-only t)
  7752. (line (org-current-line))
  7753. (org-agenda-buffer (current-buffer))
  7754. (thetags (with-current-buffer (marker-buffer hdmarker)
  7755. (save-excursion (save-restriction (widen)
  7756. (goto-char hdmarker)
  7757. (org-get-tags-at)))))
  7758. props m pl undone-face done-face finish new dotime level cat tags)
  7759. (save-excursion
  7760. (goto-char (point-max))
  7761. (beginning-of-line 1)
  7762. (while (not finish)
  7763. (setq finish (bobp))
  7764. (when (and (setq m (org-get-at-bol 'org-hd-marker))
  7765. (or (not just-this) (= (org-current-line) line))
  7766. (equal m hdmarker))
  7767. (setq props (text-properties-at (point))
  7768. dotime (org-get-at-bol 'dotime)
  7769. cat (org-get-at-bol 'org-category)
  7770. level (org-get-at-bol 'level)
  7771. tags thetags
  7772. new
  7773. (let ((org-prefix-format-compiled
  7774. (or (get-text-property (min (1- (point-max)) (point)) 'format)
  7775. org-prefix-format-compiled))
  7776. (extra (org-get-at-bol 'extra)))
  7777. (with-current-buffer (marker-buffer hdmarker)
  7778. (save-excursion
  7779. (save-restriction
  7780. (widen)
  7781. (org-agenda-format-item extra newhead level cat tags dotime)))))
  7782. pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
  7783. undone-face (org-get-at-bol 'undone-face)
  7784. done-face (org-get-at-bol 'done-face))
  7785. (beginning-of-line 1)
  7786. (cond
  7787. ((equal new "")
  7788. (and (looking-at ".*\n?") (replace-match "")))
  7789. ((looking-at ".*")
  7790. (replace-match new t t)
  7791. (beginning-of-line 1)
  7792. (add-text-properties (point-at-bol) (point-at-eol) props)
  7793. (when fixface
  7794. (add-text-properties
  7795. (point-at-bol) (point-at-eol)
  7796. (list 'face
  7797. (if org-last-todo-state-is-todo
  7798. undone-face done-face))))
  7799. (org-agenda-highlight-todo 'line)
  7800. (beginning-of-line 1))
  7801. (t (error "Line update did not work")))
  7802. (save-restriction
  7803. (narrow-to-region (point-at-bol) (point-at-eol))
  7804. (org-agenda-finalize)))
  7805. (beginning-of-line 0)))))
  7806. (defun org-agenda-align-tags (&optional line)
  7807. "Align all tags in agenda items to `org-agenda-tags-column'."
  7808. (let ((inhibit-read-only t) l c)
  7809. (save-excursion
  7810. (goto-char (if line (point-at-bol) (point-min)))
  7811. (while (re-search-forward (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
  7812. (if line (point-at-eol) nil) t)
  7813. (add-text-properties
  7814. (match-beginning 2) (match-end 2)
  7815. (list 'face (delq nil (let ((prop (get-text-property
  7816. (match-beginning 2) 'face)))
  7817. (or (listp prop) (setq prop (list prop)))
  7818. (if (memq 'org-tag prop)
  7819. prop
  7820. (cons 'org-tag prop))))))
  7821. (setq l (- (match-end 2) (match-beginning 2))
  7822. c (if (< org-agenda-tags-column 0)
  7823. (- (abs org-agenda-tags-column) l)
  7824. org-agenda-tags-column))
  7825. (delete-region (match-beginning 1) (match-end 1))
  7826. (goto-char (match-beginning 1))
  7827. (insert (org-add-props
  7828. (make-string (max 1 (- c (current-column))) ?\ )
  7829. (plist-put (copy-sequence (text-properties-at (point)))
  7830. 'face nil))))
  7831. (goto-char (point-min))
  7832. (org-font-lock-add-tag-faces (point-max)))))
  7833. (defun org-agenda-priority-up ()
  7834. "Increase the priority of line at point, also in Org-mode file."
  7835. (interactive)
  7836. (org-agenda-priority 'up))
  7837. (defun org-agenda-priority-down ()
  7838. "Decrease the priority of line at point, also in Org-mode file."
  7839. (interactive)
  7840. (org-agenda-priority 'down))
  7841. (defun org-agenda-priority (&optional force-direction)
  7842. "Set the priority of line at point, also in Org-mode file.
  7843. This changes the line at point, all other lines in the agenda referring to
  7844. the same tree node, and the headline of the tree node in the Org-mode file.
  7845. Called with a universal prefix arg, show the priority instead of setting it."
  7846. (interactive "P")
  7847. (if (equal force-direction '(4))
  7848. (org-show-priority)
  7849. (unless org-enable-priority-commands
  7850. (error "Priority commands are disabled"))
  7851. (org-agenda-check-no-diary)
  7852. (let* ((marker (or (org-get-at-bol 'org-marker)
  7853. (org-agenda-error)))
  7854. (hdmarker (org-get-at-bol 'org-hd-marker))
  7855. (buffer (marker-buffer hdmarker))
  7856. (pos (marker-position hdmarker))
  7857. (inhibit-read-only t)
  7858. newhead)
  7859. (org-with-remote-undo buffer
  7860. (with-current-buffer buffer
  7861. (widen)
  7862. (goto-char pos)
  7863. (org-show-context 'agenda)
  7864. (save-excursion
  7865. (and (outline-next-heading)
  7866. (org-flag-heading nil))) ; show the next heading
  7867. (funcall 'org-priority force-direction)
  7868. (end-of-line 1)
  7869. (setq newhead (org-get-heading)))
  7870. (org-agenda-change-all-lines newhead hdmarker)
  7871. (beginning-of-line 1)))))
  7872. ;; FIXME: should fix the tags property of the agenda line.
  7873. (defun org-agenda-set-tags (&optional tag onoff)
  7874. "Set tags for the current headline."
  7875. (interactive)
  7876. (org-agenda-check-no-diary)
  7877. (if (and (org-region-active-p) (org-called-interactively-p 'any))
  7878. (call-interactively 'org-change-tag-in-region)
  7879. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  7880. (org-agenda-error)))
  7881. (buffer (marker-buffer hdmarker))
  7882. (pos (marker-position hdmarker))
  7883. (inhibit-read-only t)
  7884. newhead)
  7885. (org-with-remote-undo buffer
  7886. (with-current-buffer buffer
  7887. (widen)
  7888. (goto-char pos)
  7889. (save-excursion
  7890. (org-show-context 'agenda))
  7891. (save-excursion
  7892. (and (outline-next-heading)
  7893. (org-flag-heading nil))) ; show the next heading
  7894. (goto-char pos)
  7895. (if tag
  7896. (org-toggle-tag tag onoff)
  7897. (call-interactively 'org-set-tags))
  7898. (end-of-line 1)
  7899. (setq newhead (org-get-heading)))
  7900. (org-agenda-change-all-lines newhead hdmarker)
  7901. (beginning-of-line 1)))))
  7902. (defun org-agenda-set-property ()
  7903. "Set a property for the current headline."
  7904. (interactive)
  7905. (org-agenda-check-no-diary)
  7906. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  7907. (org-agenda-error)))
  7908. (buffer (marker-buffer hdmarker))
  7909. (pos (marker-position hdmarker))
  7910. (inhibit-read-only t)
  7911. newhead)
  7912. (org-with-remote-undo buffer
  7913. (with-current-buffer buffer
  7914. (widen)
  7915. (goto-char pos)
  7916. (save-excursion
  7917. (org-show-context 'agenda))
  7918. (save-excursion
  7919. (and (outline-next-heading)
  7920. (org-flag-heading nil))) ; show the next heading
  7921. (goto-char pos)
  7922. (call-interactively 'org-set-property)))))
  7923. (defun org-agenda-set-effort ()
  7924. "Set the effort property for the current headline."
  7925. (interactive)
  7926. (org-agenda-check-no-diary)
  7927. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  7928. (org-agenda-error)))
  7929. (buffer (marker-buffer hdmarker))
  7930. (pos (marker-position hdmarker))
  7931. (inhibit-read-only t)
  7932. newhead)
  7933. (org-with-remote-undo buffer
  7934. (with-current-buffer buffer
  7935. (widen)
  7936. (goto-char pos)
  7937. (save-excursion
  7938. (org-show-context 'agenda))
  7939. (save-excursion
  7940. (and (outline-next-heading)
  7941. (org-flag-heading nil))) ; show the next heading
  7942. (goto-char pos)
  7943. (call-interactively 'org-set-effort)
  7944. (end-of-line 1)
  7945. (setq newhead (org-get-heading)))
  7946. (org-agenda-change-all-lines newhead hdmarker))))
  7947. (defun org-agenda-toggle-archive-tag ()
  7948. "Toggle the archive tag for the current entry."
  7949. (interactive)
  7950. (org-agenda-check-no-diary)
  7951. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  7952. (org-agenda-error)))
  7953. (buffer (marker-buffer hdmarker))
  7954. (pos (marker-position hdmarker))
  7955. (inhibit-read-only t)
  7956. newhead)
  7957. (org-with-remote-undo buffer
  7958. (with-current-buffer buffer
  7959. (widen)
  7960. (goto-char pos)
  7961. (org-show-context 'agenda)
  7962. (save-excursion
  7963. (and (outline-next-heading)
  7964. (org-flag-heading nil))) ; show the next heading
  7965. (call-interactively 'org-toggle-archive-tag)
  7966. (end-of-line 1)
  7967. (setq newhead (org-get-heading)))
  7968. (org-agenda-change-all-lines newhead hdmarker)
  7969. (beginning-of-line 1))))
  7970. (defun org-agenda-do-date-later (arg)
  7971. (interactive "P")
  7972. (cond
  7973. ((or (equal arg '(16))
  7974. (memq last-command
  7975. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  7976. (setq this-command 'org-agenda-date-later-minutes)
  7977. (org-agenda-date-later-minutes 1))
  7978. ((or (equal arg '(4))
  7979. (memq last-command
  7980. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  7981. (setq this-command 'org-agenda-date-later-hours)
  7982. (org-agenda-date-later-hours 1))
  7983. (t
  7984. (org-agenda-date-later (prefix-numeric-value arg)))))
  7985. (defun org-agenda-do-date-earlier (arg)
  7986. (interactive "P")
  7987. (cond
  7988. ((or (equal arg '(16))
  7989. (memq last-command
  7990. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  7991. (setq this-command 'org-agenda-date-earlier-minutes)
  7992. (org-agenda-date-earlier-minutes 1))
  7993. ((or (equal arg '(4))
  7994. (memq last-command
  7995. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  7996. (setq this-command 'org-agenda-date-earlier-hours)
  7997. (org-agenda-date-earlier-hours 1))
  7998. (t
  7999. (org-agenda-date-earlier (prefix-numeric-value arg)))))
  8000. (defun org-agenda-date-later (arg &optional what)
  8001. "Change the date of this item to ARG day(s) later."
  8002. (interactive "p")
  8003. (org-agenda-check-type t 'agenda 'timeline)
  8004. (org-agenda-check-no-diary)
  8005. (let* ((marker (or (org-get-at-bol 'org-marker)
  8006. (org-agenda-error)))
  8007. (buffer (marker-buffer marker))
  8008. (pos (marker-position marker))
  8009. cdate today)
  8010. (org-with-remote-undo buffer
  8011. (with-current-buffer buffer
  8012. (widen)
  8013. (goto-char pos)
  8014. (if (not (org-at-timestamp-p))
  8015. (error "Cannot find time stamp"))
  8016. (when (and org-agenda-move-date-from-past-immediately-to-today
  8017. (equal arg 1)
  8018. (or (not what) (eq what 'day))
  8019. (not (save-match-data (org-at-date-range-p))))
  8020. (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
  8021. cdate (calendar-absolute-from-gregorian
  8022. (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
  8023. today (org-today))
  8024. (if (> today cdate)
  8025. ;; immediately shift to today
  8026. (setq arg (- today cdate))))
  8027. (org-timestamp-change arg (or what 'day))
  8028. (when (and (org-at-date-range-p)
  8029. (re-search-backward org-tr-regexp-both (point-at-bol)))
  8030. (let ((end org-last-changed-timestamp))
  8031. (org-timestamp-change arg (or what 'day))
  8032. (setq org-last-changed-timestamp
  8033. (concat org-last-changed-timestamp "--" end)))))
  8034. (org-agenda-show-new-time marker org-last-changed-timestamp))
  8035. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  8036. (defun org-agenda-date-earlier (arg &optional what)
  8037. "Change the date of this item to ARG day(s) earlier."
  8038. (interactive "p")
  8039. (org-agenda-date-later (- arg) what))
  8040. (defun org-agenda-date-later-minutes (arg)
  8041. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  8042. (interactive "p")
  8043. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  8044. (org-agenda-date-later arg 'minute))
  8045. (defun org-agenda-date-earlier-minutes (arg)
  8046. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  8047. (interactive "p")
  8048. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  8049. (org-agenda-date-earlier arg 'minute))
  8050. (defun org-agenda-date-later-hours (arg)
  8051. "Change the time of this item, in hour steps."
  8052. (interactive "p")
  8053. (org-agenda-date-later arg 'hour))
  8054. (defun org-agenda-date-earlier-hours (arg)
  8055. "Change the time of this item, in hour steps."
  8056. (interactive "p")
  8057. (org-agenda-date-earlier arg 'hour))
  8058. (defun org-agenda-show-new-time (marker stamp &optional prefix)
  8059. "Show new date stamp via text properties."
  8060. ;; We use text properties to make this undoable
  8061. (let ((inhibit-read-only t)
  8062. (buffer-invisibility-spec))
  8063. (setq stamp (concat " " prefix " => " stamp))
  8064. (save-excursion
  8065. (goto-char (point-max))
  8066. (while (not (bobp))
  8067. (when (equal marker (org-get-at-bol 'org-marker))
  8068. (org-move-to-column (- (window-width) (length stamp)) t)
  8069. (org-agenda-fix-tags-filter-overlays-at (point))
  8070. (if (featurep 'xemacs)
  8071. ;; Use `duplicable' property to trigger undo recording
  8072. (let ((ex (make-extent nil nil))
  8073. (gl (make-glyph stamp)))
  8074. (set-glyph-face gl 'secondary-selection)
  8075. (set-extent-properties
  8076. ex (list 'invisible t 'end-glyph gl 'duplicable t))
  8077. (insert-extent ex (1- (point)) (point-at-eol)))
  8078. (add-text-properties
  8079. (1- (point)) (point-at-eol)
  8080. (list 'display (org-add-props stamp nil
  8081. 'face 'secondary-selection))))
  8082. (beginning-of-line 1))
  8083. (beginning-of-line 0)))))
  8084. (defun org-agenda-date-prompt (arg)
  8085. "Change the date of this item. Date is prompted for, with default today.
  8086. The prefix ARG is passed to the `org-time-stamp' command and can therefore
  8087. be used to request time specification in the time stamp."
  8088. (interactive "P")
  8089. (org-agenda-check-type t 'agenda 'timeline)
  8090. (org-agenda-check-no-diary)
  8091. (let* ((marker (or (org-get-at-bol 'org-marker)
  8092. (org-agenda-error)))
  8093. (buffer (marker-buffer marker))
  8094. (pos (marker-position marker)))
  8095. (org-with-remote-undo buffer
  8096. (with-current-buffer buffer
  8097. (widen)
  8098. (goto-char pos)
  8099. (if (not (org-at-timestamp-p t))
  8100. (error "Cannot find time stamp"))
  8101. (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
  8102. (org-agenda-show-new-time marker org-last-changed-timestamp))
  8103. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  8104. (defun org-agenda-schedule (arg &optional time)
  8105. "Schedule the item at point.
  8106. ARG is passed through to `org-schedule'."
  8107. (interactive "P")
  8108. (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
  8109. (org-agenda-check-no-diary)
  8110. (let* ((marker (or (org-get-at-bol 'org-marker)
  8111. (org-agenda-error)))
  8112. (type (marker-insertion-type marker))
  8113. (buffer (marker-buffer marker))
  8114. (pos (marker-position marker))
  8115. (org-insert-labeled-timestamps-at-point nil)
  8116. ts)
  8117. (set-marker-insertion-type marker t)
  8118. (org-with-remote-undo buffer
  8119. (with-current-buffer buffer
  8120. (widen)
  8121. (goto-char pos)
  8122. (setq ts (org-schedule arg time)))
  8123. (org-agenda-show-new-time marker ts "S"))
  8124. (message "%s" ts)))
  8125. (defun org-agenda-deadline (arg &optional time)
  8126. "Schedule the item at point.
  8127. ARG is passed through to `org-deadline'."
  8128. (interactive "P")
  8129. (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
  8130. (org-agenda-check-no-diary)
  8131. (let* ((marker (or (org-get-at-bol 'org-marker)
  8132. (org-agenda-error)))
  8133. (buffer (marker-buffer marker))
  8134. (pos (marker-position marker))
  8135. (org-insert-labeled-timestamps-at-point nil)
  8136. ts)
  8137. (org-with-remote-undo buffer
  8138. (with-current-buffer buffer
  8139. (widen)
  8140. (goto-char pos)
  8141. (setq ts (org-deadline arg time)))
  8142. (org-agenda-show-new-time marker ts "D"))
  8143. (message "%s" ts)))
  8144. (defun org-agenda-clock-in (&optional arg)
  8145. "Start the clock on the currently selected item."
  8146. (interactive "P")
  8147. (org-agenda-check-no-diary)
  8148. (if (equal arg '(4))
  8149. (org-clock-in arg)
  8150. (let* ((marker (or (org-get-at-bol 'org-marker)
  8151. (org-agenda-error)))
  8152. (hdmarker (or (org-get-at-bol 'org-hd-marker)
  8153. marker))
  8154. (pos (marker-position marker))
  8155. newhead)
  8156. (org-with-remote-undo (marker-buffer marker)
  8157. (with-current-buffer (marker-buffer marker)
  8158. (widen)
  8159. (goto-char pos)
  8160. (org-show-context 'agenda)
  8161. (org-show-entry)
  8162. (org-cycle-hide-drawers 'children)
  8163. (org-clock-in arg)
  8164. (setq newhead (org-get-heading)))
  8165. (org-agenda-change-all-lines newhead hdmarker)))))
  8166. (defun org-agenda-clock-out ()
  8167. "Stop the currently running clock."
  8168. (interactive)
  8169. (unless (marker-buffer org-clock-marker)
  8170. (error "No running clock"))
  8171. (let ((marker (make-marker)) newhead)
  8172. (org-with-remote-undo (marker-buffer org-clock-marker)
  8173. (with-current-buffer (marker-buffer org-clock-marker)
  8174. (save-excursion
  8175. (save-restriction
  8176. (widen)
  8177. (goto-char org-clock-marker)
  8178. (org-back-to-heading t)
  8179. (move-marker marker (point))
  8180. (org-clock-out)
  8181. (setq newhead (org-get-heading))))))
  8182. (org-agenda-change-all-lines newhead marker)
  8183. (move-marker marker nil)))
  8184. (defun org-agenda-clock-cancel (&optional arg)
  8185. "Cancel the currently running clock."
  8186. (interactive "P")
  8187. (unless (marker-buffer org-clock-marker)
  8188. (error "No running clock"))
  8189. (org-with-remote-undo (marker-buffer org-clock-marker)
  8190. (org-clock-cancel)))
  8191. (defun org-agenda-clock-goto ()
  8192. "Jump to the currently clocked in task within the agenda.
  8193. If the currently clocked in task is not listed in the agenda
  8194. buffer, display it in another window."
  8195. (interactive)
  8196. (let (pos)
  8197. (mapc (lambda (o)
  8198. (if (eq (overlay-get o 'type) 'org-agenda-clocking)
  8199. (setq pos (overlay-start o))))
  8200. (overlays-in (point-min) (point-max)))
  8201. (cond (pos (goto-char pos))
  8202. ;; If the currently clocked entry is not in the agenda
  8203. ;; buffer, we visit it in another window:
  8204. (org-clock-current-task
  8205. (org-switch-to-buffer-other-window (org-clock-goto)))
  8206. (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
  8207. (defun org-agenda-diary-entry-in-org-file ()
  8208. "Make a diary entry in the file `org-agenda-diary-file'."
  8209. (let (d1 d2 char (text "") dp1 dp2)
  8210. (if (equal (buffer-name) "*Calendar*")
  8211. (setq d1 (calendar-cursor-to-date t)
  8212. d2 (car calendar-mark-ring))
  8213. (setq dp1 (get-text-property (point-at-bol) 'day))
  8214. (unless dp1 (error "No date defined in current line"))
  8215. (setq d1 (calendar-gregorian-from-absolute dp1)
  8216. d2 (and (ignore-errors (mark))
  8217. (save-excursion
  8218. (goto-char (mark))
  8219. (setq dp2 (get-text-property (point-at-bol) 'day)))
  8220. (calendar-gregorian-from-absolute dp2))))
  8221. (message "Diary entry: [d]ay [a]nniversary [b]lock [j]ump to date tree")
  8222. (setq char (read-char-exclusive))
  8223. (cond
  8224. ((equal char ?d)
  8225. (setq text (read-string "Day entry: "))
  8226. (org-agenda-add-entry-to-org-agenda-diary-file 'day text d1)
  8227. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  8228. ((equal char ?a)
  8229. (setq d1 (list (car d1) (nth 1 d1)
  8230. (read-number (format "Reference year [%d]: " (nth 2 d1))
  8231. (nth 2 d1))))
  8232. (setq text (read-string "Anniversary (use %d to show years): "))
  8233. (org-agenda-add-entry-to-org-agenda-diary-file 'anniversary text d1)
  8234. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  8235. ((equal char ?b)
  8236. (setq text (read-string "Block entry: "))
  8237. (unless (and d1 d2 (not (equal d1 d2)))
  8238. (error "No block of days selected"))
  8239. (org-agenda-add-entry-to-org-agenda-diary-file 'block text d1 d2)
  8240. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  8241. ((equal char ?j)
  8242. (org-switch-to-buffer-other-window
  8243. (find-file-noselect org-agenda-diary-file))
  8244. (require 'org-datetree)
  8245. (org-datetree-find-date-create d1)
  8246. (org-reveal t))
  8247. (t (error "Invalid selection character `%c'" char)))))
  8248. (defcustom org-agenda-insert-diary-strategy 'date-tree
  8249. "Where in `org-agenda-diary-file' should new entries be added?
  8250. Valid values:
  8251. date-tree in the date tree, as child of the date
  8252. top-level as top-level entries at the end of the file."
  8253. :group 'org-agenda
  8254. :type '(choice
  8255. (const :tag "in a date tree" date-tree)
  8256. (const :tag "as top level at end of file" top-level)))
  8257. (defcustom org-agenda-insert-diary-extract-time nil
  8258. "Non-nil means extract any time specification from the diary entry."
  8259. :group 'org-agenda
  8260. :version "24.1"
  8261. :type 'boolean)
  8262. (defcustom org-agenda-bulk-mark-char ">"
  8263. "A single-character string to be used as the bulk mark."
  8264. :group 'org-agenda
  8265. :version "24.1"
  8266. :type 'string)
  8267. (defun org-agenda-add-entry-to-org-agenda-diary-file (type text &optional d1 d2)
  8268. "Add a diary entry with TYPE to `org-agenda-diary-file'.
  8269. If TEXT is not empty, it will become the headline of the new entry, and
  8270. the resulting entry will not be shown. When TEXT is empty, switch to
  8271. `org-agenda-diary-file' and let the user finish the entry there."
  8272. (let ((cw (current-window-configuration)))
  8273. (org-switch-to-buffer-other-window
  8274. (find-file-noselect org-agenda-diary-file))
  8275. (widen)
  8276. (goto-char (point-min))
  8277. (cond
  8278. ((eq type 'anniversary)
  8279. (or (re-search-forward "^*[ \t]+Anniversaries" nil t)
  8280. (progn
  8281. (or (org-at-heading-p t)
  8282. (progn
  8283. (outline-next-heading)
  8284. (insert "* Anniversaries\n\n")
  8285. (beginning-of-line -1)))))
  8286. (outline-next-heading)
  8287. (org-back-over-empty-lines)
  8288. (backward-char 1)
  8289. (insert "\n")
  8290. (insert (format "%%%%(org-anniversary %d %2d %2d) %s"
  8291. (nth 2 d1) (car d1) (nth 1 d1) text)))
  8292. ((eq type 'day)
  8293. (let ((org-prefix-has-time t)
  8294. (org-agenda-time-leading-zero t)
  8295. fmt time time2)
  8296. (if org-agenda-insert-diary-extract-time
  8297. ;; Use org-agenda-format-item to parse text for a time-range and
  8298. ;; remove it. FIXME: This is a hack, we should refactor
  8299. ;; that function to make time extraction available separately
  8300. (setq fmt (org-agenda-format-item nil text nil nil nil t)
  8301. time (get-text-property 0 'time fmt)
  8302. time2 (if (> (length time) 0)
  8303. ;; split-string removes trailing ...... if
  8304. ;; no end time given. First space
  8305. ;; separates time from date.
  8306. (concat " " (car (split-string time "\\.")))
  8307. nil)
  8308. text (get-text-property 0 'txt fmt)))
  8309. (if (eq org-agenda-insert-diary-strategy 'top-level)
  8310. (org-agenda-insert-diary-as-top-level text)
  8311. (require 'org-datetree)
  8312. (org-datetree-find-date-create d1)
  8313. (org-agenda-insert-diary-make-new-entry text))
  8314. (org-insert-time-stamp (org-time-from-absolute
  8315. (calendar-absolute-from-gregorian d1))
  8316. nil nil nil nil time2))
  8317. (end-of-line 0))
  8318. ((eq type 'block)
  8319. (if (> (calendar-absolute-from-gregorian d1)
  8320. (calendar-absolute-from-gregorian d2))
  8321. (setq d1 (prog1 d2 (setq d2 d1))))
  8322. (if (eq org-agenda-insert-diary-strategy 'top-level)
  8323. (org-agenda-insert-diary-as-top-level text)
  8324. (require 'org-datetree)
  8325. (org-datetree-find-date-create d1)
  8326. (org-agenda-insert-diary-make-new-entry text))
  8327. (org-insert-time-stamp (org-time-from-absolute
  8328. (calendar-absolute-from-gregorian d1)))
  8329. (insert "--")
  8330. (org-insert-time-stamp (org-time-from-absolute
  8331. (calendar-absolute-from-gregorian d2)))
  8332. (end-of-line 0)))
  8333. (if (string-match "\\S-" text)
  8334. (progn
  8335. (set-window-configuration cw)
  8336. (message "%s entry added to %s"
  8337. (capitalize (symbol-name type))
  8338. (abbreviate-file-name org-agenda-diary-file)))
  8339. (org-reveal t)
  8340. (message "Please finish entry here"))))
  8341. (defun org-agenda-insert-diary-as-top-level (text)
  8342. "Make new entry as a top-level entry at the end of the file.
  8343. Add TEXT as headline, and position the cursor in the second line so that
  8344. a timestamp can be added there."
  8345. (widen)
  8346. (goto-char (point-max))
  8347. (or (bolp) (insert "\n"))
  8348. (insert "* " text "\n")
  8349. (if org-adapt-indentation (org-indent-to-column 2)))
  8350. (defun org-agenda-insert-diary-make-new-entry (text)
  8351. "Make new entry as last child of current entry.
  8352. Add TEXT as headline, and position the cursor in the second line so that
  8353. a timestamp can be added there."
  8354. (let ((org-show-following-heading t)
  8355. (org-show-siblings t)
  8356. (org-show-hierarchy-above t)
  8357. (org-show-entry-below t)
  8358. col)
  8359. (outline-next-heading)
  8360. (org-back-over-empty-lines)
  8361. (or (looking-at "[ \t]*$")
  8362. (progn (insert "\n") (backward-char 1)))
  8363. (org-insert-heading nil t)
  8364. (org-do-demote)
  8365. (setq col (current-column))
  8366. (insert text "\n")
  8367. (if org-adapt-indentation (org-indent-to-column col))
  8368. (let ((org-show-following-heading t)
  8369. (org-show-siblings t)
  8370. (org-show-hierarchy-above t)
  8371. (org-show-entry-below t))
  8372. (org-show-context))))
  8373. (defun org-agenda-diary-entry ()
  8374. "Make a diary entry, like the `i' command from the calendar.
  8375. All the standard commands work: block, weekly etc.
  8376. When `org-agenda-diary-file' points to a file,
  8377. `org-agenda-diary-entry-in-org-file' is called instead to create
  8378. entries in that Org-mode file."
  8379. (interactive)
  8380. (if (not (eq org-agenda-diary-file 'diary-file))
  8381. (org-agenda-diary-entry-in-org-file)
  8382. (require 'diary-lib)
  8383. (let* ((char (progn
  8384. (message "Diary entry: [d]ay [w]eekly [m]onthly [y]early [a]nniversary [b]lock [c]yclic")
  8385. (read-char-exclusive)))
  8386. (cmd (cdr (assoc char
  8387. '((?d . insert-diary-entry)
  8388. (?w . insert-weekly-diary-entry)
  8389. (?m . insert-monthly-diary-entry)
  8390. (?y . insert-yearly-diary-entry)
  8391. (?a . insert-anniversary-diary-entry)
  8392. (?b . insert-block-diary-entry)
  8393. (?c . insert-cyclic-diary-entry)))))
  8394. (oldf (symbol-function 'calendar-cursor-to-date))
  8395. ;; (buf (get-file-buffer (substitute-in-file-name diary-file)))
  8396. (point (point))
  8397. (mark (or (mark t) (point))))
  8398. (unless cmd
  8399. (error "No command associated with <%c>" char))
  8400. (unless (and (get-text-property point 'day)
  8401. (or (not (equal ?b char))
  8402. (get-text-property mark 'day)))
  8403. (error "Don't know which date to use for diary entry"))
  8404. ;; We implement this by hacking the `calendar-cursor-to-date' function
  8405. ;; and the `calendar-mark-ring' variable. Saves a lot of code.
  8406. (let ((calendar-mark-ring
  8407. (list (calendar-gregorian-from-absolute
  8408. (or (get-text-property mark 'day)
  8409. (get-text-property point 'day))))))
  8410. (unwind-protect
  8411. (progn
  8412. (fset 'calendar-cursor-to-date
  8413. (lambda (&optional error dummy)
  8414. (calendar-gregorian-from-absolute
  8415. (get-text-property point 'day))))
  8416. (call-interactively cmd))
  8417. (fset 'calendar-cursor-to-date oldf))))))
  8418. (defun org-agenda-execute-calendar-command (cmd)
  8419. "Execute a calendar command from the agenda with date from cursor."
  8420. (org-agenda-check-type t 'agenda 'timeline)
  8421. (require 'diary-lib)
  8422. (unless (get-text-property (min (1- (point-max)) (point)) 'day)
  8423. (error "Don't know which date to use for the calendar command"))
  8424. (let* ((oldf (symbol-function 'calendar-cursor-to-date))
  8425. (point (point))
  8426. (date (calendar-gregorian-from-absolute
  8427. (get-text-property point 'day)))
  8428. ;; the following 2 vars are needed in the calendar
  8429. (displayed-month (car date))
  8430. (displayed-year (nth 2 date)))
  8431. (unwind-protect
  8432. (progn
  8433. (fset 'calendar-cursor-to-date
  8434. (lambda (&optional error dummy)
  8435. (calendar-gregorian-from-absolute
  8436. (get-text-property point 'day))))
  8437. (call-interactively cmd))
  8438. (fset 'calendar-cursor-to-date oldf))))
  8439. (defun org-agenda-phases-of-moon ()
  8440. "Display the phases of the moon for the 3 months around the cursor date."
  8441. (interactive)
  8442. (org-agenda-execute-calendar-command 'calendar-phases-of-moon))
  8443. (defun org-agenda-holidays ()
  8444. "Display the holidays for the 3 months around the cursor date."
  8445. (interactive)
  8446. (org-agenda-execute-calendar-command 'list-calendar-holidays))
  8447. (defvar calendar-longitude) ; defined in calendar.el
  8448. (defvar calendar-latitude) ; defined in calendar.el
  8449. (defvar calendar-location-name) ; defined in calendar.el
  8450. (defun org-agenda-sunrise-sunset (arg)
  8451. "Display sunrise and sunset for the cursor date.
  8452. Latitude and longitude can be specified with the variables
  8453. `calendar-latitude' and `calendar-longitude'. When called with prefix
  8454. argument, latitude and longitude will be prompted for."
  8455. (interactive "P")
  8456. (require 'solar)
  8457. (let ((calendar-longitude (if arg nil calendar-longitude))
  8458. (calendar-latitude (if arg nil calendar-latitude))
  8459. (calendar-location-name
  8460. (if arg "the given coordinates" calendar-location-name)))
  8461. (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
  8462. (defun org-agenda-goto-calendar ()
  8463. "Open the Emacs calendar with the date at the cursor."
  8464. (interactive)
  8465. (org-agenda-check-type t 'agenda 'timeline)
  8466. (let* ((day (or (get-text-property (min (1- (point-max)) (point)) 'day)
  8467. (error "Don't know which date to open in calendar")))
  8468. (date (calendar-gregorian-from-absolute day))
  8469. (calendar-move-hook nil)
  8470. (calendar-view-holidays-initially-flag nil)
  8471. (calendar-view-diary-initially-flag nil))
  8472. (calendar)
  8473. (calendar-goto-date date)))
  8474. ;;;###autoload
  8475. (defun org-calendar-goto-agenda ()
  8476. "Compute the Org-mode agenda for the calendar date displayed at the cursor.
  8477. This is a command that has to be installed in `calendar-mode-map'."
  8478. (interactive)
  8479. (org-agenda-list nil (calendar-absolute-from-gregorian
  8480. (calendar-cursor-to-date))
  8481. nil))
  8482. (autoload 'org-calendar-goto-agenda "org-agenda" "\
  8483. Compute the Org-mode agenda for the calendar date displayed at the cursor.
  8484. This is a command that has to be installed in `calendar-mode-map'.
  8485. \(fn)" t nil)
  8486. (defun org-agenda-convert-date ()
  8487. (interactive)
  8488. (org-agenda-check-type t 'agenda 'timeline)
  8489. (let ((day (get-text-property (min (1- (point-max)) (point)) 'day))
  8490. date s)
  8491. (unless day
  8492. (error "Don't know which date to convert"))
  8493. (setq date (calendar-gregorian-from-absolute day))
  8494. (setq s (concat
  8495. "Gregorian: " (calendar-date-string date) "\n"
  8496. "ISO: " (calendar-iso-date-string date) "\n"
  8497. "Day of Yr: " (calendar-day-of-year-string date) "\n"
  8498. "Julian: " (calendar-julian-date-string date) "\n"
  8499. "Astron. JD: " (calendar-astro-date-string date)
  8500. " (Julian date number at noon UTC)\n"
  8501. "Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
  8502. "Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
  8503. "French: " (calendar-french-date-string date) "\n"
  8504. "Baha'i: " (calendar-bahai-date-string date) " (until sunset)\n"
  8505. "Mayan: " (calendar-mayan-date-string date) "\n"
  8506. "Coptic: " (calendar-coptic-date-string date) "\n"
  8507. "Ethiopic: " (calendar-ethiopic-date-string date) "\n"
  8508. "Persian: " (calendar-persian-date-string date) "\n"
  8509. "Chinese: " (calendar-chinese-date-string date) "\n"))
  8510. (with-output-to-temp-buffer "*Dates*"
  8511. (princ s))
  8512. (org-fit-window-to-buffer (get-buffer-window "*Dates*"))))
  8513. ;;; Bulk commands
  8514. (defun org-agenda-bulk-marked-p ()
  8515. (eq (get-char-property (point-at-bol) 'type)
  8516. 'org-marked-entry-overlay))
  8517. (defun org-agenda-bulk-mark (&optional arg)
  8518. "Mark the entry at point for future bulk action."
  8519. (interactive "p")
  8520. (dotimes (i (or arg 1))
  8521. (unless (org-get-at-bol 'org-agenda-diary-link)
  8522. (let* ((m (org-get-at-bol 'org-hd-marker))
  8523. ov)
  8524. (unless (org-agenda-bulk-marked-p)
  8525. (unless m (error "Nothing to mark at point"))
  8526. (push m org-agenda-bulk-marked-entries)
  8527. (setq ov (make-overlay (point-at-bol) (+ 2 (point-at-bol))))
  8528. (org-overlay-display ov (concat org-agenda-bulk-mark-char " ")
  8529. (org-get-todo-face "TODO")
  8530. 'evaporate)
  8531. (overlay-put ov 'type 'org-marked-entry-overlay))
  8532. (beginning-of-line 2)
  8533. (while (and (get-char-property (point) 'invisible) (not (eobp)))
  8534. (beginning-of-line 2))
  8535. (message "%d entries marked for bulk action"
  8536. (length org-agenda-bulk-marked-entries))))))
  8537. (defun org-agenda-bulk-mark-all ()
  8538. "Mark all entries for future agenda bulk action."
  8539. (interactive)
  8540. (org-agenda-bulk-mark-regexp "."))
  8541. (defun org-agenda-bulk-mark-regexp (regexp)
  8542. "Mark entries matching REGEXP for future agenda bulk action."
  8543. (interactive "sMark entries matching regexp: ")
  8544. (let ((entries-marked 0))
  8545. (save-excursion
  8546. (goto-char (point-min))
  8547. (goto-char (next-single-property-change (point) 'txt))
  8548. (while (re-search-forward regexp nil t)
  8549. (when (string-match regexp (get-text-property (point) 'txt))
  8550. (setq entries-marked (1+ entries-marked))
  8551. (call-interactively 'org-agenda-bulk-mark))))
  8552. (if (not entries-marked)
  8553. (message "No entry matching this regexp."))))
  8554. (defun org-agenda-bulk-unmark (&optional arg)
  8555. "Unmark the entry at point for future bulk action."
  8556. (interactive "P")
  8557. (if arg
  8558. (org-agenda-bulk-unmark-all)
  8559. (cond ((org-agenda-bulk-marked-p)
  8560. (org-agenda-bulk-remove-overlays
  8561. (point-at-bol) (+ 2 (point-at-bol)))
  8562. (setq org-agenda-bulk-marked-entries
  8563. (delete (org-get-at-bol 'org-hd-marker)
  8564. org-agenda-bulk-marked-entries))
  8565. (beginning-of-line 2)
  8566. (while (and (get-char-property (point) 'invisible) (not (eobp)))
  8567. (beginning-of-line 2))
  8568. (message "%d entries left marked for bulk action"
  8569. (length org-agenda-bulk-marked-entries)))
  8570. (t (message "No entry to unmark here")))))
  8571. (defun org-agenda-bulk-toggle ()
  8572. "Toggle marking the entry at point for bulk action."
  8573. (interactive)
  8574. (if (org-agenda-bulk-marked-p)
  8575. (org-agenda-bulk-unmark)
  8576. (org-agenda-bulk-mark)))
  8577. (defun org-agenda-bulk-remove-overlays (&optional beg end)
  8578. "Remove the mark overlays between BEG and END in the agenda buffer.
  8579. BEG and END default to the buffer limits.
  8580. This only removes the overlays, it does not remove the markers
  8581. from the list in `org-agenda-bulk-marked-entries'."
  8582. (interactive)
  8583. (mapc (lambda (ov)
  8584. (and (eq (overlay-get ov 'type) 'org-marked-entry-overlay)
  8585. (delete-overlay ov)))
  8586. (overlays-in (or beg (point-min)) (or end (point-max)))))
  8587. (defun org-agenda-bulk-unmark-all ()
  8588. "Remove all marks in the agenda buffer.
  8589. This will remove the markers and the overlays."
  8590. (interactive)
  8591. (if (null org-agenda-bulk-marked-entries)
  8592. (message "No entry to unmark")
  8593. (mapc (lambda (m) (move-marker m nil)) org-agenda-bulk-marked-entries)
  8594. (setq org-agenda-bulk-marked-entries nil)
  8595. (org-agenda-bulk-remove-overlays (point-min) (point-max))))
  8596. (defcustom org-agenda-persistent-marks nil
  8597. "Non-nil means marked items will stay marked after a bulk action.
  8598. You can toggle this interactively by typing `p' when prompted for a
  8599. bulk action."
  8600. :group 'org-agenda
  8601. :version "24.1"
  8602. :type 'boolean)
  8603. (defun org-agenda-bulk-action (&optional arg)
  8604. "Execute an remote-editing action on all marked entries.
  8605. The prefix arg is passed through to the command if possible."
  8606. (interactive "P")
  8607. ;; Make sure we have markers, and only valid ones
  8608. (unless org-agenda-bulk-marked-entries (error "No entries are marked"))
  8609. (mapc
  8610. (lambda (m)
  8611. (unless (and (markerp m)
  8612. (marker-buffer m)
  8613. (buffer-live-p (marker-buffer m))
  8614. (marker-position m))
  8615. (error "Marker %s for bulk command is invalid" m)))
  8616. org-agenda-bulk-marked-entries)
  8617. ;; Prompt for the bulk command
  8618. (let* ((msg (if org-agenda-persistent-marks "Bulk (persistent): " "Bulk: ")))
  8619. (message (concat msg "[$]arch [A]rch->sib [t]odo [+/-]tag [s]chd [d]eadline [r]efile "
  8620. "[S]catter [f]unction "
  8621. (when org-agenda-bulk-custom-functions
  8622. (concat " Custom: ["
  8623. (mapconcat (lambda(f) (char-to-string (car f)))
  8624. org-agenda-bulk-custom-functions "")
  8625. "]"))))
  8626. (catch 'exit
  8627. (let* ((action (read-char-exclusive))
  8628. (org-log-refile (if org-log-refile 'time nil))
  8629. (entries (reverse org-agenda-bulk-marked-entries))
  8630. (org-overriding-default-time
  8631. (if (get-text-property (point) 'org-agenda-date-header)
  8632. (org-get-cursor-date)))
  8633. redo-at-end
  8634. cmd rfloc state e tag pos (cnt 0) (cntskip 0))
  8635. (cond
  8636. ((equal action ?p)
  8637. (let ((org-agenda-persistent-marks
  8638. (not org-agenda-persistent-marks)))
  8639. (org-agenda-bulk-action)
  8640. (throw 'exit nil)))
  8641. ((equal action ?$)
  8642. (setq cmd '(org-agenda-archive)))
  8643. ((equal action ?A)
  8644. (setq cmd '(org-agenda-archive-to-archive-sibling)))
  8645. ((member action '(?r ?w))
  8646. (setq rfloc (org-refile-get-location
  8647. "Refile to"
  8648. (marker-buffer (car entries))
  8649. org-refile-allow-creating-parent-nodes))
  8650. (if (nth 3 rfloc)
  8651. (setcar (nthcdr 3 rfloc)
  8652. (move-marker (make-marker) (nth 3 rfloc)
  8653. (or (get-file-buffer (nth 1 rfloc))
  8654. (find-buffer-visiting (nth 1 rfloc))
  8655. (error "This should not happen")))))
  8656. (setq cmd (list 'org-agenda-refile nil (list 'quote rfloc) t)
  8657. redo-at-end t))
  8658. ((equal action ?t)
  8659. (setq state (org-icompleting-read
  8660. "Todo state: "
  8661. (with-current-buffer (marker-buffer (car entries))
  8662. (mapcar 'list org-todo-keywords-1))))
  8663. (setq cmd `(let ((org-inhibit-blocking t)
  8664. (org-inhibit-logging 'note))
  8665. (org-agenda-todo ,state))))
  8666. ((memq action '(?- ?+))
  8667. (setq tag (org-icompleting-read
  8668. (format "Tag to %s: " (if (eq action ?+) "add" "remove"))
  8669. (with-current-buffer (marker-buffer (car entries))
  8670. (delq nil
  8671. (mapcar (lambda (x)
  8672. (if (stringp (car x)) x)) org-tag-alist)))))
  8673. (setq cmd `(org-agenda-set-tags ,tag ,(if (eq action ?+) ''on ''off))))
  8674. ((memq action '(?s ?d))
  8675. (let* ((time
  8676. (unless arg
  8677. (org-read-date
  8678. nil nil nil
  8679. (if (eq action ?s) "(Re)Schedule to" "(Re)Set Deadline to")
  8680. org-overriding-default-time)))
  8681. (c1 (if (eq action ?s) 'org-agenda-schedule 'org-agenda-deadline)))
  8682. (setq cmd `(eval '(,c1 arg ,time)))))
  8683. ((equal action ?S)
  8684. (if (not (org-agenda-check-type nil 'agenda 'timeline 'todo))
  8685. (error "Can't scatter tasks in \"%s\" agenda view" org-agenda-type)
  8686. (let ((days (read-number
  8687. (format "Scatter tasks across how many %sdays: "
  8688. (if arg "week" "")) 7)))
  8689. (setq cmd
  8690. `(let ((distance (1+ (random ,days))))
  8691. (if arg
  8692. (let ((dist distance)
  8693. (day-of-week
  8694. (calendar-day-of-week
  8695. (calendar-gregorian-from-absolute (org-today)))))
  8696. (dotimes (i (1+ dist))
  8697. (while (member day-of-week org-agenda-weekend-days)
  8698. (incf distance)
  8699. (incf day-of-week)
  8700. (if (= day-of-week 7)
  8701. (setq day-of-week 0)))
  8702. (incf day-of-week)
  8703. (if (= day-of-week 7)
  8704. (setq day-of-week 0)))))
  8705. ;; silently fail when try to replan a sexp entry
  8706. (condition-case nil
  8707. (let* ((date (calendar-gregorian-from-absolute
  8708. (+ (org-today) distance)))
  8709. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date)
  8710. (nth 2 date))))
  8711. (org-agenda-schedule nil time))
  8712. (error nil)))))))
  8713. ((assoc action org-agenda-bulk-custom-functions)
  8714. (setq cmd (list (cadr (assoc action org-agenda-bulk-custom-functions)))
  8715. redo-at-end t))
  8716. ((equal action ?f)
  8717. (setq cmd (list (intern
  8718. (org-icompleting-read "Function: "
  8719. obarray 'fboundp t nil nil)))))
  8720. (t (error "Invalid bulk action")))
  8721. ;; Sort the markers, to make sure that parents are handled before children
  8722. (setq entries (sort entries
  8723. (lambda (a b)
  8724. (cond
  8725. ((equal (marker-buffer a) (marker-buffer b))
  8726. (< (marker-position a) (marker-position b)))
  8727. (t
  8728. (string< (buffer-name (marker-buffer a))
  8729. (buffer-name (marker-buffer b))))))))
  8730. ;; Now loop over all markers and apply cmd
  8731. (while (setq e (pop entries))
  8732. (setq pos (text-property-any (point-min) (point-max) 'org-hd-marker e))
  8733. (if (not pos)
  8734. (progn (message "Skipping removed entry at %s" e)
  8735. (setq cntskip (1+ cntskip)))
  8736. (goto-char pos)
  8737. (let (org-loop-over-headlines-in-active-region)
  8738. (eval cmd))
  8739. (setq cnt (1+ cnt))))
  8740. (when redo-at-end (org-agenda-redo))
  8741. (unless org-agenda-persistent-marks
  8742. (org-agenda-bulk-unmark-all))
  8743. (message "Acted on %d entries%s%s"
  8744. cnt
  8745. (if (= cntskip 0)
  8746. ""
  8747. (format ", skipped %d (disappeared before their turn)"
  8748. cntskip))
  8749. (if (not org-agenda-persistent-marks)
  8750. "" " (kept marked)"))))))
  8751. (defun org-agenda-capture (&optional with-time)
  8752. "Call `org-capture' with the date at point.
  8753. With a `C-1' prefix, use the HH:MM value at point (if any) or the
  8754. current HH:MM time."
  8755. (interactive "P")
  8756. (if (not (eq major-mode 'org-agenda-mode))
  8757. (user-error "You cannot do this outside of agenda buffers")
  8758. (let ((org-overriding-default-time
  8759. (org-get-cursor-date (equal with-time 1))))
  8760. (call-interactively 'org-capture))))
  8761. ;;; Flagging notes
  8762. (defun org-agenda-show-the-flagging-note ()
  8763. "Display the flagging note in the other window.
  8764. When called a second time in direct sequence, offer to remove the FLAGGING
  8765. tag and (if present) the flagging note."
  8766. (interactive)
  8767. (let ((hdmarker (org-get-at-bol 'org-hd-marker))
  8768. (win (selected-window))
  8769. note heading newhead)
  8770. (unless hdmarker
  8771. (error "No linked entry at point"))
  8772. (if (and (eq this-command last-command)
  8773. (y-or-n-p "Unflag and remove any flagging note? "))
  8774. (progn
  8775. (org-agenda-remove-flag hdmarker)
  8776. (let ((win (get-buffer-window "*Flagging Note*")))
  8777. (and win (delete-window win)))
  8778. (message "Entry unflagged"))
  8779. (setq note (org-entry-get hdmarker "THEFLAGGINGNOTE"))
  8780. (unless note
  8781. (error "No flagging note"))
  8782. (org-kill-new note)
  8783. (org-switch-to-buffer-other-window "*Flagging Note*")
  8784. (erase-buffer)
  8785. (insert note)
  8786. (goto-char (point-min))
  8787. (while (re-search-forward "\\\\n" nil t)
  8788. (replace-match "\n" t t))
  8789. (goto-char (point-min))
  8790. (select-window win)
  8791. (message "Flagging note pushed to kill ring. Press [?] again to remove tag and note"))))
  8792. (defun org-agenda-remove-flag (marker)
  8793. "Remove the FLAGGED tag and any flagging note in the entry."
  8794. (let (newhead)
  8795. (org-with-point-at marker
  8796. (org-toggle-tag "FLAGGED" 'off)
  8797. (org-entry-delete nil "THEFLAGGINGNOTE")
  8798. (setq newhead (org-get-heading)))
  8799. (org-agenda-change-all-lines newhead marker)
  8800. (message "Entry unflagged")))
  8801. (defun org-agenda-get-any-marker (&optional pos)
  8802. (or (get-text-property (or pos (point-at-bol)) 'org-hd-marker)
  8803. (get-text-property (or pos (point-at-bol)) 'org-marker)))
  8804. ;;; Appointment reminders
  8805. (defvar appt-time-msg-list) ; defined in appt.el
  8806. ;;;###autoload
  8807. (defun org-agenda-to-appt (&optional refresh filter &rest args)
  8808. "Activate appointments found in `org-agenda-files'.
  8809. With a \\[universal-argument] prefix, refresh the list of
  8810. appointments.
  8811. If FILTER is t, interactively prompt the user for a regular
  8812. expression, and filter out entries that don't match it.
  8813. If FILTER is a string, use this string as a regular expression
  8814. for filtering entries out.
  8815. If FILTER is a function, filter out entries against which
  8816. calling the function returns nil. This function takes one
  8817. argument: an entry from `org-agenda-get-day-entries'.
  8818. FILTER can also be an alist with the car of each cell being
  8819. either 'headline or 'category. For example:
  8820. '((headline \"IMPORTANT\")
  8821. (category \"Work\"))
  8822. will only add headlines containing IMPORTANT or headlines
  8823. belonging to the \"Work\" category.
  8824. ARGS are symbols indicating what kind of entries to consider.
  8825. By default `org-agenda-to-appt' will use :deadline, :scheduled
  8826. and :timestamp entries. See the docstring of `org-diary' for
  8827. details and examples.
  8828. If an entry as a APPT_WARNTIME property, its value will be used
  8829. to override `appt-message-warning-time'."
  8830. (interactive "P")
  8831. (if refresh (setq appt-time-msg-list nil))
  8832. (if (eq filter t)
  8833. (setq filter (read-from-minibuffer "Regexp filter: ")))
  8834. (let* ((cnt 0) ; count added events
  8835. (scope (or args '(:deadline :scheduled :timestamp)))
  8836. (org-agenda-new-buffers nil)
  8837. (org-deadline-warning-days 0)
  8838. ;; Do not use `org-today' here because appt only takes
  8839. ;; time and without date as argument, so it may pass wrong
  8840. ;; information otherwise
  8841. (today (org-date-to-gregorian
  8842. (time-to-days (current-time))))
  8843. (org-agenda-restrict nil)
  8844. (files (org-agenda-files 'unrestricted)) entries file
  8845. (org-agenda-buffer nil))
  8846. ;; Get all entries which may contain an appt
  8847. (org-agenda-prepare-buffers files)
  8848. (while (setq file (pop files))
  8849. (setq entries
  8850. (delq nil
  8851. (append entries
  8852. (apply 'org-agenda-get-day-entries
  8853. file today scope)))))
  8854. ;; Map thru entries and find if we should filter them out
  8855. (mapc
  8856. (lambda(x)
  8857. (let* ((evt (org-trim (or (get-text-property 1 'txt x) "")))
  8858. (cat (get-text-property 1 'org-category x))
  8859. (tod (get-text-property 1 'time-of-day x))
  8860. (ok (or (null filter)
  8861. (and (stringp filter) (string-match filter evt))
  8862. (and (functionp filter) (funcall filter x))
  8863. (and (listp filter)
  8864. (let ((cat-filter (cadr (assoc 'category filter)))
  8865. (evt-filter (cadr (assoc 'headline filter))))
  8866. (or (and (stringp cat-filter)
  8867. (string-match cat-filter cat))
  8868. (and (stringp evt-filter)
  8869. (string-match evt-filter evt)))))))
  8870. (wrn (get-text-property 1 'warntime x)))
  8871. ;; FIXME: Shall we remove text-properties for the appt text?
  8872. ;; (setq evt (set-text-properties 0 (length evt) nil evt))
  8873. (when (and ok tod)
  8874. (setq tod (concat "00" (number-to-string tod))
  8875. tod (when (string-match
  8876. "\\([0-9]\\{1,2\\}\\)\\([0-9]\\{2\\}\\)\\'" tod)
  8877. (concat (match-string 1 tod) ":"
  8878. (match-string 2 tod))))
  8879. (if (version< emacs-version "23.3")
  8880. (appt-add tod evt)
  8881. (appt-add tod evt wrn))
  8882. (setq cnt (1+ cnt))))) entries)
  8883. (org-release-buffers org-agenda-new-buffers)
  8884. (if (eq cnt 0)
  8885. (message "No event to add")
  8886. (message "Added %d event%s for today" cnt (if (> cnt 1) "s" "")))))
  8887. (autoload 'org-agenda-to-appt "org-agenda" "\
  8888. Activate appointments found in `org-agenda-files'.
  8889. With a \\[universal-argument] prefix, refresh the list of
  8890. appointments.
  8891. If FILTER is t, interactively prompt the user for a regular
  8892. expression, and filter out entries that don't match it.
  8893. If FILTER is a string, use this string as a regular expression
  8894. for filtering entries out.
  8895. If FILTER is a function, filter out entries against which
  8896. calling the function returns nil. This function takes one
  8897. argument: an entry from `org-agenda-get-day-entries'.
  8898. FILTER can also be an alist with the car of each cell being
  8899. either 'headline or 'category. For example:
  8900. '((headline \"IMPORTANT\")
  8901. (category \"Work\"))
  8902. will only add headlines containing IMPORTANT or headlines
  8903. belonging to the \"Work\" category.
  8904. ARGS are symbols indicating what kind of entries to consider.
  8905. By default `org-agenda-to-appt' will use :deadline, :scheduled
  8906. and :timestamp entries. See the docstring of `org-diary' for
  8907. details and examples.
  8908. If an entry as a APPT_WARNTIME property, its value will be used
  8909. to override `appt-message-warning-time'.
  8910. \(fn &optional REFRESH FILTER &rest ARGS)" t nil)
  8911. (defun org-agenda-todayp (date)
  8912. "Does DATE mean today, when considering `org-extend-today-until'?"
  8913. (let ((today (org-today))
  8914. (date (if (and date (listp date)) (calendar-absolute-from-gregorian date)
  8915. date)))
  8916. (eq date today)))
  8917. (defun org-agenda-todo-yesterday (&optional arg)
  8918. "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday."
  8919. (interactive "P")
  8920. (let* ((hour (third (decode-time
  8921. (org-current-time))))
  8922. (org-extend-today-until (1+ hour)))
  8923. (org-agenda-todo arg)))
  8924. (provide 'org-agenda)
  8925. ;;; org-agenda.el ends here