org-agenda.el 321 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415
  1. ;;; org-agenda.el --- Dynamic task and appointment lists for Org
  2. ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010
  3. ;; Free Software Foundation, Inc.
  4. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  5. ;; Keywords: outlines, hypermedia, calendar, wp
  6. ;; Homepage: http://orgmode.org
  7. ;; Version: 7.5
  8. ;;
  9. ;; This file is part of GNU Emacs.
  10. ;;
  11. ;; GNU Emacs is free software: you can redistribute it and/or modify
  12. ;; it under the terms of the GNU General Public License as published by
  13. ;; the Free Software Foundation, either version 3 of the License, or
  14. ;; (at your option) any later version.
  15. ;; GNU Emacs is distributed in the hope that it will be useful,
  16. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. ;; GNU General Public License for more details.
  19. ;; You should have received a copy of the GNU General Public License
  20. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  21. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  22. ;;
  23. ;;; Commentary:
  24. ;; This file contains the code for creating and using the Agenda for Org-mode.
  25. ;;; Code:
  26. (require 'org)
  27. (eval-when-compile
  28. (require 'cl))
  29. (declare-function diary-add-to-list "diary-lib"
  30. (date string specifier &optional marker globcolor literal))
  31. (declare-function calendar-absolute-from-iso "cal-iso" (date))
  32. (declare-function calendar-astro-date-string "cal-julian" (&optional date))
  33. (declare-function calendar-bahai-date-string "cal-bahai" (&optional date))
  34. (declare-function calendar-chinese-date-string "cal-china" (&optional date))
  35. (declare-function calendar-coptic-date-string "cal-coptic" (&optional date))
  36. (declare-function calendar-ethiopic-date-string "cal-coptic" (&optional date))
  37. (declare-function calendar-french-date-string "cal-french" (&optional date))
  38. (declare-function calendar-goto-date "cal-move" (date))
  39. (declare-function calendar-hebrew-date-string "cal-hebrew" (&optional date))
  40. (declare-function calendar-islamic-date-string "cal-islam" (&optional date))
  41. (declare-function calendar-iso-date-string "cal-iso" (&optional date))
  42. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  43. (declare-function calendar-julian-date-string "cal-julian" (&optional date))
  44. (declare-function calendar-mayan-date-string "cal-mayan" (&optional date))
  45. (declare-function calendar-persian-date-string "cal-persia" (&optional date))
  46. (declare-function org-datetree-find-date-create "org-datetree"
  47. (date &optional keep-restriction))
  48. (declare-function org-columns-quit "org-colview" ())
  49. (declare-function diary-date-display-form "diary-lib" (&optional type))
  50. (declare-function org-mobile-write-agenda-for-mobile "org-mobile" (file))
  51. (declare-function org-habit-insert-consistency-graphs
  52. "org-habit" (&optional line))
  53. (declare-function org-is-habit-p "org-habit" (&optional pom))
  54. (declare-function org-habit-parse-todo "org-habit" (&optional pom))
  55. (declare-function org-habit-get-priority "org-habit" (habit &optional moment))
  56. (defvar calendar-mode-map)
  57. (defvar org-clock-current-task) ; defined in org-clock.el
  58. (defvar org-mobile-force-id-on-agenda-items) ; defined in org-mobile.el
  59. (defvar org-habit-show-habits)
  60. (defvar org-habit-show-habits-only-for-today)
  61. ;; Defined somewhere in this file, but used before definition.
  62. (defvar org-agenda-buffer-name)
  63. (defvar org-agenda-overriding-header)
  64. (defvar org-agenda-title-append nil)
  65. (defvar entry)
  66. (defvar date)
  67. (defvar org-agenda-undo-list)
  68. (defvar org-agenda-pending-undo-list)
  69. (defvar original-date) ; dynamically scoped, calendar.el does scope this
  70. (defcustom org-agenda-confirm-kill 1
  71. "When set, remote killing from the agenda buffer needs confirmation.
  72. When t, a confirmation is always needed. When a number N, confirmation is
  73. only needed when the text to be killed contains more than N non-white lines."
  74. :group 'org-agenda
  75. :type '(choice
  76. (const :tag "Never" nil)
  77. (const :tag "Always" t)
  78. (integer :tag "When more than N lines")))
  79. (defcustom org-agenda-compact-blocks nil
  80. "Non-nil means make the block agenda more compact.
  81. This is done by leaving out unnecessary lines."
  82. :group 'org-agenda
  83. :type 'boolean)
  84. (defcustom org-agenda-block-separator ?=
  85. "The separator between blocks in the agenda.
  86. If this is a string, it will be used as the separator, with a newline added.
  87. If it is a character, it will be repeated to fill the window width."
  88. :group 'org-agenda
  89. :type '(choice
  90. (character)
  91. (string)))
  92. (defgroup org-agenda-export nil
  93. "Options concerning exporting agenda views in Org-mode."
  94. :tag "Org Agenda Export"
  95. :group 'org-agenda)
  96. (defcustom org-agenda-with-colors t
  97. "Non-nil means use colors in agenda views."
  98. :group 'org-agenda-export
  99. :type 'boolean)
  100. (defcustom org-agenda-exporter-settings nil
  101. "Alist of variable/value pairs that should be active during agenda export.
  102. This is a good place to set options for ps-print and for htmlize.
  103. Note that the way this is implemented, the values will be evaluated
  104. before assigned to the variables. So make sure to quote values you do
  105. *not* want evaluated, for example
  106. (setq org-agenda-exporter-settings
  107. '((ps-print-color-p 'black-white)))"
  108. :group 'org-agenda-export
  109. :type '(repeat
  110. (list
  111. (variable)
  112. (sexp :tag "Value"))))
  113. (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
  114. "Hook run in temporary buffer before writing it to an export file.
  115. A useful function is `org-agenda-add-entry-text'."
  116. :group 'org-agenda-export
  117. :type 'hook
  118. :options '(org-agenda-add-entry-text))
  119. (defcustom org-agenda-add-entry-text-maxlines 0
  120. "Maximum number of entry text lines to be added to agenda.
  121. This is only relevant when `org-agenda-add-entry-text' is part of
  122. `org-agenda-before-write-hook', which it is by default.
  123. When this is 0, nothing will happen. When it is greater than 0, it
  124. specifies the maximum number of lines that will be added for each entry
  125. that is listed in the agenda view.
  126. Note that this variable is not used during display, only when exporting
  127. the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
  128. and `org-agenda-entry-text-maxlines'."
  129. :group 'org-agenda
  130. :type 'integer)
  131. (defcustom org-agenda-add-entry-text-descriptive-links t
  132. "Non-nil means export org-links as descriptive links in agenda added text.
  133. This variable applies to the text added to the agenda when
  134. `org-agenda-add-entry-text-maxlines' is larger than 0.
  135. When this variable nil, the URL will (also) be shown."
  136. :group 'org-agenda
  137. :type 'boolean)
  138. (defcustom org-agenda-export-html-style ""
  139. "The style specification for exported HTML Agenda files.
  140. If this variable contains a string, it will replace the default <style>
  141. section as produced by `htmlize'.
  142. Since there are different ways of setting style information, this variable
  143. needs to contain the full HTML structure to provide a style, including the
  144. surrounding HTML tags. The style specifications should include definitions
  145. the fonts used by the agenda, here is an example:
  146. <style type=\"text/css\">
  147. p { font-weight: normal; color: gray; }
  148. .org-agenda-structure {
  149. font-size: 110%;
  150. color: #003399;
  151. font-weight: 600;
  152. }
  153. .org-todo {
  154. color: #cc6666;
  155. font-weight: bold;
  156. }
  157. .org-agenda-done {
  158. color: #339933;
  159. }
  160. .org-done {
  161. color: #339933;
  162. }
  163. .title { text-align: center; }
  164. .todo, .deadline { color: red; }
  165. .done { color: green; }
  166. </style>
  167. or, if you want to keep the style in a file,
  168. <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
  169. As the value of this option simply gets inserted into the HTML <head> header,
  170. you can \"misuse\" it to also add other text to the header. However,
  171. <style>...</style> is required, if not present the variable will be ignored."
  172. :group 'org-agenda-export
  173. :group 'org-export-html
  174. :type 'string)
  175. (defcustom org-agenda-persistent-filter nil
  176. "When set, keep filters from one agenda view to the next."
  177. :group 'org-agenda
  178. :type 'boolean)
  179. (defgroup org-agenda-custom-commands nil
  180. "Options concerning agenda views in Org-mode."
  181. :tag "Org Agenda Custom Commands"
  182. :group 'org-agenda)
  183. (defconst org-sorting-choice
  184. '(choice
  185. (const time-up) (const time-down)
  186. (const category-keep) (const category-up) (const category-down)
  187. (const tag-down) (const tag-up)
  188. (const priority-up) (const priority-down)
  189. (const todo-state-up) (const todo-state-down)
  190. (const effort-up) (const effort-down)
  191. (const habit-up) (const habit-down)
  192. (const alpha-up) (const alpha-down)
  193. (const user-defined-up) (const user-defined-down))
  194. "Sorting choices.")
  195. (defconst org-agenda-custom-commands-local-options
  196. `(repeat :tag "Local settings for this command. Remember to quote values"
  197. (choice :tag "Setting"
  198. (list :tag "Heading for this block"
  199. (const org-agenda-overriding-header)
  200. (string :tag "Headline"))
  201. (list :tag "Files to be searched"
  202. (const org-agenda-files)
  203. (list
  204. (const :format "" quote)
  205. (repeat (file))))
  206. (list :tag "Sorting strategy"
  207. (const org-agenda-sorting-strategy)
  208. (list
  209. (const :format "" quote)
  210. (repeat
  211. ,org-sorting-choice)))
  212. (list :tag "Prefix format"
  213. (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
  214. (string))
  215. (list :tag "Number of days in agenda"
  216. (const org-agenda-span)
  217. (choice (const :tag "Day" 'day)
  218. (const :tag "Week" 'week)
  219. (const :tag "Month" 'month)
  220. (const :tag "Year" 'year)
  221. (integer :tag "Custom")))
  222. (list :tag "Fixed starting date"
  223. (const org-agenda-start-day)
  224. (string :value "2007-11-01"))
  225. (list :tag "Start on day of week"
  226. (const org-agenda-start-on-weekday)
  227. (choice :value 1
  228. (const :tag "Today" nil)
  229. (integer :tag "Weekday No.")))
  230. (list :tag "Include data from diary"
  231. (const org-agenda-include-diary)
  232. (boolean))
  233. (list :tag "Deadline Warning days"
  234. (const org-deadline-warning-days)
  235. (integer :value 1))
  236. (list :tag "Tags filter preset"
  237. (const org-agenda-filter-preset)
  238. (list
  239. (const :format "" quote)
  240. (repeat
  241. (string :tag "+tag or -tag"))))
  242. (list :tag "Set daily/weekly entry types"
  243. (const org-agenda-entry-types)
  244. (set :greedy t :value (:deadline :scheduled :timestamp :sexp)
  245. (const :deadline)
  246. (const :scheduled)
  247. (const :timestamp)
  248. (const :sexp)))
  249. (list :tag "Standard skipping condition"
  250. :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
  251. (const org-agenda-skip-function)
  252. (list
  253. (const :format "" quote)
  254. (list
  255. (choice
  256. :tag "Skipping range"
  257. (const :tag "Skip entry" org-agenda-skip-entry-if)
  258. (const :tag "Skip subtree" org-agenda-skip-subtree-if))
  259. (repeat :inline t :tag "Conditions for skipping"
  260. (choice
  261. :tag "Condition type"
  262. (list :tag "Regexp matches" :inline t (const :format "" 'regexp) (regexp))
  263. (list :tag "Regexp does not match" :inline t (const :format "" 'notregexp) (regexp))
  264. (list :tag "TODO state is" :inline t
  265. (const 'todo)
  266. (choice
  267. (const :tag "any not-done state" 'todo)
  268. (const :tag "any done state" 'done)
  269. (const :tag "any state" 'any)
  270. (list :tag "Keyword list"
  271. (const :format "" quote)
  272. (repeat (string :tag "Keyword")))))
  273. (list :tag "TODO state is not" :inline t
  274. (const 'nottodo)
  275. (choice
  276. (const :tag "any not-done state" 'todo)
  277. (const :tag "any done state" 'done)
  278. (const :tag "any state" 'any)
  279. (list :tag "Keyword list"
  280. (const :format "" quote)
  281. (repeat (string :tag "Keyword")))))
  282. (const :tag "scheduled" 'scheduled)
  283. (const :tag "not scheduled" 'notscheduled)
  284. (const :tag "deadline" 'deadline)
  285. (const :tag "no deadline" 'notdeadline)
  286. (const :tag "timestamp" 'timestamp)
  287. (const :tag "no timestamp" 'nottimestamp))))))
  288. (list :tag "Non-standard skipping condition"
  289. :value (org-agenda-skip-function)
  290. (const org-agenda-skip-function)
  291. (sexp :tag "Function or form (quoted!)"))
  292. (list :tag "Any variable"
  293. (variable :tag "Variable")
  294. (sexp :tag "Value (sexp)"))))
  295. "Selection of examples for agenda command settings.
  296. This will be spliced into the custom type of
  297. `org-agenda-custom-commands'.")
  298. (defcustom org-agenda-custom-commands nil
  299. "Custom commands for the agenda.
  300. These commands will be offered on the splash screen displayed by the
  301. agenda dispatcher \\[org-agenda]. Each entry is a list like this:
  302. (key desc type match settings files)
  303. key The key (one or more characters as a string) to be associated
  304. with the command.
  305. desc A description of the command, when omitted or nil, a default
  306. description is built using MATCH.
  307. type The command type, any of the following symbols:
  308. agenda The daily/weekly agenda.
  309. todo Entries with a specific TODO keyword, in all agenda files.
  310. search Entries containing search words entry or headline.
  311. tags Tags/Property/TODO match in all agenda files.
  312. tags-todo Tags/P/T match in all agenda files, TODO entries only.
  313. todo-tree Sparse tree of specific TODO keyword in *current* file.
  314. tags-tree Sparse tree with all tags matches in *current* file.
  315. occur-tree Occur sparse tree for *current* file.
  316. ... A user-defined function.
  317. match What to search for:
  318. - a single keyword for TODO keyword searches
  319. - a tags match expression for tags searches
  320. - a word search expression for text searches.
  321. - a regular expression for occur searches
  322. For all other commands, this should be the empty string.
  323. settings A list of option settings, similar to that in a let form, so like
  324. this: ((opt1 val1) (opt2 val2) ...). The values will be
  325. evaluated at the moment of execution, so quote them when needed.
  326. files A list of files file to write the produced agenda buffer to
  327. with the command `org-store-agenda-views'.
  328. If a file name ends in \".html\", an HTML version of the buffer
  329. is written out. If it ends in \".ps\", a postscript version is
  330. produced. Otherwise, only the plain text is written to the file.
  331. You can also define a set of commands, to create a composite agenda buffer.
  332. In this case, an entry looks like this:
  333. (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
  334. where
  335. desc A description string to be displayed in the dispatcher menu.
  336. cmd An agenda command, similar to the above. However, tree commands
  337. are no allowed, but instead you can get agenda and global todo list.
  338. So valid commands for a set are:
  339. (agenda \"\" settings)
  340. (alltodo \"\" settings)
  341. (stuck \"\" settings)
  342. (todo \"match\" settings files)
  343. (search \"match\" settings files)
  344. (tags \"match\" settings files)
  345. (tags-todo \"match\" settings files)
  346. Each command can carry a list of options, and another set of options can be
  347. given for the whole set of commands. Individual command options take
  348. precedence over the general options.
  349. When using several characters as key to a command, the first characters
  350. are prefix commands. For the dispatcher to display useful information, you
  351. should provide a description for the prefix, like
  352. (setq org-agenda-custom-commands
  353. '((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
  354. (\"hl\" tags \"+HOME+Lisa\")
  355. (\"hp\" tags \"+HOME+Peter\")
  356. (\"hk\" tags \"+HOME+Kim\")))"
  357. :group 'org-agenda-custom-commands
  358. :type `(repeat
  359. (choice :value ("x" "Describe command here" tags "" nil)
  360. (list :tag "Single command"
  361. (string :tag "Access Key(s) ")
  362. (option (string :tag "Description"))
  363. (choice
  364. (const :tag "Agenda" agenda)
  365. (const :tag "TODO list" alltodo)
  366. (const :tag "Search words" search)
  367. (const :tag "Stuck projects" stuck)
  368. (const :tag "Tags/Property match (all agenda files)" tags)
  369. (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
  370. (const :tag "TODO keyword search (all agenda files)" todo)
  371. (const :tag "Tags sparse tree (current buffer)" tags-tree)
  372. (const :tag "TODO keyword tree (current buffer)" todo-tree)
  373. (const :tag "Occur tree (current buffer)" occur-tree)
  374. (sexp :tag "Other, user-defined function"))
  375. (string :tag "Match (only for some commands)")
  376. ,org-agenda-custom-commands-local-options
  377. (option (repeat :tag "Export" (file :tag "Export to"))))
  378. (list :tag "Command series, all agenda files"
  379. (string :tag "Access Key(s)")
  380. (string :tag "Description ")
  381. (repeat :tag "Component"
  382. (choice
  383. (list :tag "Agenda"
  384. (const :format "" agenda)
  385. (const :tag "" :format "" "")
  386. ,org-agenda-custom-commands-local-options)
  387. (list :tag "TODO list (all keywords)"
  388. (const :format "" alltodo)
  389. (const :tag "" :format "" "")
  390. ,org-agenda-custom-commands-local-options)
  391. (list :tag "Search words"
  392. (const :format "" search)
  393. (string :tag "Match")
  394. ,org-agenda-custom-commands-local-options)
  395. (list :tag "Stuck projects"
  396. (const :format "" stuck)
  397. (const :tag "" :format "" "")
  398. ,org-agenda-custom-commands-local-options)
  399. (list :tag "Tags search"
  400. (const :format "" tags)
  401. (string :tag "Match")
  402. ,org-agenda-custom-commands-local-options)
  403. (list :tag "Tags search, TODO entries only"
  404. (const :format "" tags-todo)
  405. (string :tag "Match")
  406. ,org-agenda-custom-commands-local-options)
  407. (list :tag "TODO keyword search"
  408. (const :format "" todo)
  409. (string :tag "Match")
  410. ,org-agenda-custom-commands-local-options)
  411. (list :tag "Other, user-defined function"
  412. (symbol :tag "function")
  413. (string :tag "Match")
  414. ,org-agenda-custom-commands-local-options)))
  415. (repeat :tag "Settings for entire command set"
  416. (list (variable :tag "Any variable")
  417. (sexp :tag "Value")))
  418. (option (repeat :tag "Export" (file :tag "Export to"))))
  419. (cons :tag "Prefix key documentation"
  420. (string :tag "Access Key(s)")
  421. (string :tag "Description ")))))
  422. (defcustom org-agenda-query-register ?o
  423. "The register holding the current query string.
  424. The purpose of this is that if you construct a query string interactively,
  425. you can then use it to define a custom command."
  426. :group 'org-agenda-custom-commands
  427. :type 'character)
  428. (defcustom org-stuck-projects
  429. '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
  430. "How to identify stuck projects.
  431. This is a list of four items:
  432. 1. A tags/todo/property matcher string that is used to identify a project.
  433. See the manual for a description of tag and property searches.
  434. The entire tree below a headline matched by this is considered one project.
  435. 2. A list of TODO keywords identifying non-stuck projects.
  436. If the project subtree contains any headline with one of these todo
  437. keywords, the project is considered to be not stuck. If you specify
  438. \"*\" as a keyword, any TODO keyword will mark the project unstuck.
  439. 3. A list of tags identifying non-stuck projects.
  440. If the project subtree contains any headline with one of these tags,
  441. the project is considered to be not stuck. If you specify \"*\" as
  442. a tag, any tag will mark the project unstuck. Note that this is about
  443. the explicit presence of a tag somewhere in the subtree, inherited
  444. tags to not count here. If inherited tags make a project not stuck,
  445. use \"-TAG\" in the tags part of the matcher under (1.) above.
  446. 4. An arbitrary regular expression matching non-stuck projects.
  447. If the project turns out to be not stuck, search continues also in the
  448. subtree to see if any of the subtasks have project status.
  449. See also the variable `org-tags-match-list-sublevels' which applies
  450. to projects matched by this search as well.
  451. After defining this variable, you may use \\[org-agenda-list-stuck-projects]
  452. or `C-c a #' to produce the list."
  453. :group 'org-agenda-custom-commands
  454. :type '(list
  455. (string :tag "Tags/TODO match to identify a project")
  456. (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
  457. (repeat :tag "Projects are *not* stuck if they have an entry with TAG being any of" (string))
  458. (regexp :tag "Projects are *not* stuck if this regexp matches inside the subtree")))
  459. (defcustom org-agenda-filter-effort-default-operator "<"
  460. "The default operator for effort estimate filtering.
  461. If you select an effort estimate limit without first pressing an operator,
  462. this one will be used."
  463. :group 'org-agenda-custom-commands
  464. :type '(choice (const :tag "less or equal" "<")
  465. (const :tag "greater or equal"">")
  466. (const :tag "equal" "=")))
  467. (defgroup org-agenda-skip nil
  468. "Options concerning skipping parts of agenda files."
  469. :tag "Org Agenda Skip"
  470. :group 'org-agenda)
  471. (defcustom org-agenda-skip-function-global nil
  472. "Function to be called at each match during agenda construction.
  473. If this function returns nil, the current match should not be skipped.
  474. If the function decided to skip an agenda match, is must return the
  475. buffer position from which the search should be continued.
  476. This may also be a Lisp form, which will be evaluated.
  477. This variable will be applied to every agenda match, including
  478. tags/property searches and TODO lists. So try to make the test function
  479. do its checking as efficiently as possible. To implement a skipping
  480. condition just for specific agenda commands, use the variable
  481. `org-agenda-skip-function' which can be set in the options section
  482. of custom agenda commands."
  483. :group 'org-agenda-skip
  484. :type 'sexp)
  485. (defgroup org-agenda-daily/weekly nil
  486. "Options concerning the daily/weekly agenda."
  487. :tag "Org Agenda Daily/Weekly"
  488. :group 'org-agenda)
  489. (defgroup org-agenda-todo-list nil
  490. "Options concerning the global todo list agenda view."
  491. :tag "Org Agenda Todo List"
  492. :group 'org-agenda)
  493. (defgroup org-agenda-match-view nil
  494. "Options concerning the general tags/property/todo match agenda view."
  495. :tag "Org Agenda Match View"
  496. :group 'org-agenda)
  497. (defgroup org-agenda-search-view nil
  498. "Options concerning the general tags/property/todo match agenda view."
  499. :tag "Org Agenda Match View"
  500. :group 'org-agenda)
  501. (defvar org-agenda-archives-mode nil
  502. "Non-nil means the agenda will include archived items.
  503. If this is the symbol `trees', trees in the selected agenda scope
  504. that are marked with the ARCHIVE tag will be included anyway. When this is
  505. t, also all archive files associated with the current selection of agenda
  506. files will be included.")
  507. (defcustom org-agenda-skip-comment-trees t
  508. "Non-nil means skip trees that start with the COMMENT keyword.
  509. When nil, these trees are also scanned by agenda commands."
  510. :group 'org-agenda-skip
  511. :type 'boolean)
  512. (defcustom org-agenda-todo-list-sublevels t
  513. "Non-nil means check also the sublevels of a TODO entry for TODO entries.
  514. When nil, the sublevels of a TODO entry are not checked, resulting in
  515. potentially much shorter TODO lists."
  516. :group 'org-agenda-skip
  517. :group 'org-agenda-todo-list
  518. :type 'boolean)
  519. (defcustom org-agenda-todo-ignore-with-date nil
  520. "Non-nil means don't show entries with a date in the global todo list.
  521. You can use this if you prefer to mark mere appointments with a TODO keyword,
  522. but don't want them to show up in the TODO list.
  523. When this is set, it also covers deadlines and scheduled items, the settings
  524. of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
  525. will be ignored.
  526. See also the variable `org-agenda-tags-todo-honor-ignore-options'."
  527. :group 'org-agenda-skip
  528. :group 'org-agenda-todo-list
  529. :type 'boolean)
  530. (defcustom org-agenda-todo-ignore-timestamp nil
  531. "Non-nil means don't show entries with a timestamp.
  532. This applies when creating the global todo list.
  533. Valid values are:
  534. past Don't show entries for today or in the past.
  535. future Don't show entries with a timestamp in the future.
  536. The idea behind this is that if it has a future
  537. timestamp, you don't want to think about it until the
  538. date.
  539. all Don't show any entries with a timestamp in the global todo list.
  540. The idea behind this is that by setting a timestamp, you
  541. have already \"taken care\" of this item.
  542. This variable can also have an integer as a value. If positive (N),
  543. todos with a timestamp N or more days in the future will be ignored. If
  544. negative (-N), todos with a timestamp N or more days in the past will be
  545. ignored. If 0, todos with a timestamp either today or in the future will
  546. be ignored. For example, a value of -1 will exclude todos with a
  547. timestamp in the past (yesterday or earlier), while a value of 7 will
  548. exclude todos with a timestamp a week or more in the future.
  549. See also `org-agenda-todo-ignore-with-date'.
  550. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  551. to make his option also apply to the tags-todo list."
  552. :group 'org-agenda-skip
  553. :group 'org-agenda-todo-list
  554. :type '(choice
  555. (const :tag "Ignore future timestamp todos" future)
  556. (const :tag "Ignore past or present timestamp todos" past)
  557. (const :tag "Ignore all timestamp todos" all)
  558. (const :tag "Show timestamp todos" nil)
  559. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  560. (defcustom org-agenda-todo-ignore-scheduled nil
  561. "Non-nil means, ignore some scheduled TODO items when making TODO list.
  562. This applies when creating the global todo list.
  563. Valid values are:
  564. past Don't show entries scheduled today or in the past.
  565. future Don't show entries scheduled in the future.
  566. The idea behind this is that by scheduling it, you don't want to
  567. think about it until the scheduled date.
  568. all Don't show any scheduled entries in the global todo list.
  569. The idea behind this is that by scheduling it, you have already
  570. \"taken care\" of this item.
  571. t Same as `all', for backward compatibility.
  572. This variable can also have an integer as a value. See
  573. `org-agenda-todo-ignore-timestamp' for more details.
  574. See also `org-agenda-todo-ignore-with-date'.
  575. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  576. to make his option also apply to the tags-todo list."
  577. :group 'org-agenda-skip
  578. :group 'org-agenda-todo-list
  579. :type '(choice
  580. (const :tag "Ignore future-scheduled todos" future)
  581. (const :tag "Ignore past- or present-scheduled todos" past)
  582. (const :tag "Ignore all scheduled todos" all)
  583. (const :tag "Ignore all scheduled todos (compatibility)" t)
  584. (const :tag "Show scheduled todos" nil)
  585. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  586. (defcustom org-agenda-todo-ignore-deadlines nil
  587. "Non-nil means ignore some deadlined TODO items when making TODO list.
  588. There are different motivations for using different values, please think
  589. carefully when configuring this variable.
  590. This applies when creating the global todo list.
  591. Valid values are:
  592. near Don't show near deadline entries. A deadline is near when it is
  593. closer than `org-deadline-warning-days' days. The idea behind this
  594. is that such items will appear in the agenda anyway.
  595. far Don't show TODO entries where a deadline has been defined, but
  596. the deadline is not near. This is useful if you don't want to
  597. use the todo list to figure out what to do now.
  598. past Don't show entries with a deadline timestamp for today or in the past.
  599. future Don't show entries with a deadline timestamp in the future, not even
  600. when they become `near' ones. Use it with caution.
  601. all Ignore all TODO entries that do have a deadline.
  602. t Same as `near', for backward compatibility.
  603. This variable can also have an integer as a value. See
  604. `org-agenda-todo-ignore-timestamp' for more details.
  605. See also `org-agenda-todo-ignore-with-date'.
  606. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  607. to make his option also apply to the tags-todo list."
  608. :group 'org-agenda-skip
  609. :group 'org-agenda-todo-list
  610. :type '(choice
  611. (const :tag "Ignore near deadlines" near)
  612. (const :tag "Ignore near deadlines (compatibility)" t)
  613. (const :tag "Ignore far deadlines" far)
  614. (const :tag "Ignore all TODOs with a deadlines" all)
  615. (const :tag "Show all TODOs, even if they have a deadline" nil)
  616. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  617. (defcustom org-agenda-tags-todo-honor-ignore-options nil
  618. "Non-nil means honor todo-list ...ignore options also in tags-todo search.
  619. The variables
  620. `org-agenda-todo-ignore-with-date',
  621. `org-agenda-todo-ignore-timestamp',
  622. `org-agenda-todo-ignore-scheduled',
  623. `org-agenda-todo-ignore-deadlines'
  624. make the global TODO list skip entries that have time stamps of certain
  625. kinds. If this option is set, the same options will also apply for the
  626. tags-todo search, which is the general tags/property matcher
  627. restricted to unfinished TODO entries only."
  628. :group 'org-agenda-skip
  629. :group 'org-agenda-todo-list
  630. :group 'org-agenda-match-view
  631. :type 'boolean)
  632. (defcustom org-agenda-skip-scheduled-if-done nil
  633. "Non-nil means don't show scheduled items in agenda when they are done.
  634. This is relevant for the daily/weekly agenda, not for the TODO list. And
  635. it applies only to the actual date of the scheduling. Warnings about
  636. an item with a past scheduling dates are always turned off when the item
  637. is DONE."
  638. :group 'org-agenda-skip
  639. :group 'org-agenda-daily/weekly
  640. :type 'boolean)
  641. (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
  642. "Non-nil means skip scheduling line if same entry shows because of deadline.
  643. In the agenda of today, an entry can show up multiple times because
  644. it is both scheduled and has a nearby deadline, and maybe a plain time
  645. stamp as well.
  646. When this variable is t, then only the deadline is shown and the fact that
  647. the entry is scheduled today or was scheduled previously is not shown.
  648. When this variable is nil, the entry will be shown several times. When
  649. the variable is the symbol `not-today', then skip scheduled previously,
  650. but not scheduled today."
  651. :group 'org-agenda-skip
  652. :group 'org-agenda-daily/weekly
  653. :type '(choice
  654. (const :tag "Never" nil)
  655. (const :tag "Always" t)
  656. (const :tag "Not when scheduled today" not-today)))
  657. (defcustom org-agenda-skip-deadline-if-done nil
  658. "Non-nil means don't show deadlines when the corresponding item is done.
  659. When nil, the deadline is still shown and should give you a happy feeling.
  660. This is relevant for the daily/weekly agenda. And it applied only to the
  661. actually date of the deadline. Warnings about approaching and past-due
  662. deadlines are always turned off when the item is DONE."
  663. :group 'org-agenda-skip
  664. :group 'org-agenda-daily/weekly
  665. :type 'boolean)
  666. (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
  667. "Non-nil means skip deadline prewarning when entry is also scheduled.
  668. This will apply on all days where a prewarning for the deadline would
  669. be shown, but not at the day when the entry is actually due. On that day,
  670. the deadline will be shown anyway.
  671. This variable may be set to nil, t, or a number which will then give
  672. the number of days before the actual deadline when the prewarnings
  673. should resume.
  674. This can be used in a workflow where the first showing of the deadline will
  675. trigger you to schedule it, and then you don't want to be reminded of it
  676. because you will take care of it on the day when scheduled."
  677. :group 'org-agenda-skip
  678. :group 'org-agenda-daily/weekly
  679. :type '(choice
  680. (const :tag "Alwas show prewarning" nil)
  681. (const :tag "Remove prewarning if entry is scheduled" t)
  682. (integer :tag "Restart prewarning N days before deadline")))
  683. (defcustom org-agenda-skip-additional-timestamps-same-entry t
  684. "When nil, multiple same-day timestamps in entry make multiple agenda lines.
  685. When non-nil, after the search for timestamps has matched once in an
  686. entry, the rest of the entry will not be searched."
  687. :group 'org-agenda-skip
  688. :type 'boolean)
  689. (defcustom org-agenda-skip-timestamp-if-done nil
  690. "Non-nil means don't select item by timestamp or -range if it is DONE."
  691. :group 'org-agenda-skip
  692. :group 'org-agenda-daily/weekly
  693. :type 'boolean)
  694. (defcustom org-agenda-dim-blocked-tasks t
  695. "Non-nil means dim blocked tasks in the agenda display.
  696. This causes some overhead during agenda construction, but if you
  697. have turned on `org-enforce-todo-dependencies',
  698. `org-enforce-todo-checkbox-dependencies', or any other blocking
  699. mechanism, this will create useful feedback in the agenda.
  700. Instead of t, this variable can also have the value `invisible'.
  701. Then blocked tasks will be invisible and only become visible when
  702. they become unblocked. An exemption to this behavior is when a task is
  703. blocked because of unchecked checkboxes below it. Since checkboxes do
  704. not show up in the agenda views, making this task invisible you remove any
  705. trace from agenda views that there is something to do. Therefore, a task
  706. that is blocked because of checkboxes will never be made invisible, it
  707. will only be dimmed."
  708. :group 'org-agenda-daily/weekly
  709. :group 'org-agenda-todo-list
  710. :type '(choice
  711. (const :tag "Do not dim" nil)
  712. (const :tag "Dim to a grey face" t)
  713. (const :tag "Make invisible" invisible)))
  714. (defcustom org-timeline-show-empty-dates 3
  715. "Non-nil means `org-timeline' also shows dates without an entry.
  716. When nil, only the days which actually have entries are shown.
  717. When t, all days between the first and the last date are shown.
  718. When an integer, show also empty dates, but if there is a gap of more than
  719. N days, just insert a special line indicating the size of the gap."
  720. :group 'org-agenda-skip
  721. :type '(choice
  722. (const :tag "None" nil)
  723. (const :tag "All" t)
  724. (integer :tag "at most")))
  725. (defgroup org-agenda-startup nil
  726. "Options concerning initial settings in the Agenda in Org Mode."
  727. :tag "Org Agenda Startup"
  728. :group 'org-agenda)
  729. (defcustom org-agenda-menu-show-matcher t
  730. "Non-nil means show the match string in the agenda dispatcher menu.
  731. When nil, the matcher string is not shown, but is put into the help-echo
  732. property so than moving the mouse over the command shows it.
  733. Setting it to nil is good if matcher strings are very long and/or if
  734. you want to use two-column display (see `org-agenda-menu-two-column')."
  735. :group 'org-agenda
  736. :type 'boolean)
  737. (defcustom org-agenda-menu-two-column nil
  738. "Non-nil means, use two columns to show custom commands in the dispatcher.
  739. If you use this, you probably want to set `org-agenda-menu-show-matcher'
  740. to nil."
  741. :group 'org-agenda
  742. :type 'boolean)
  743. (defcustom org-finalize-agenda-hook nil
  744. "Hook run just before displaying an agenda buffer."
  745. :group 'org-agenda-startup
  746. :type 'hook)
  747. (defcustom org-agenda-mouse-1-follows-link nil
  748. "Non-nil means mouse-1 on a link will follow the link in the agenda.
  749. A longer mouse click will still set point. Does not work on XEmacs.
  750. Needs to be set before org.el is loaded."
  751. :group 'org-agenda-startup
  752. :type 'boolean)
  753. (defcustom org-agenda-start-with-follow-mode nil
  754. "The initial value of follow mode in a newly created agenda window."
  755. :group 'org-agenda-startup
  756. :type 'boolean)
  757. (defcustom org-agenda-show-outline-path t
  758. "Non-nil means show outline path in echo area after line motion."
  759. :group 'org-agenda-startup
  760. :type 'boolean)
  761. (defcustom org-agenda-start-with-entry-text-mode nil
  762. "The initial value of entry-text-mode in a newly created agenda window."
  763. :group 'org-agenda-startup
  764. :type 'boolean)
  765. (defcustom org-agenda-entry-text-maxlines 5
  766. "Number of text lines to be added when `E' is pressed in the agenda.
  767. Note that this variable only used during agenda display. Add add entry text
  768. when exporting the agenda, configure the variable
  769. `org-agenda-add-entry-ext-maxlines'."
  770. :group 'org-agenda
  771. :type 'integer)
  772. (defcustom org-agenda-entry-text-exclude-regexps nil
  773. "List of regular expressions to clean up entry text.
  774. The complete matches of all regular expressions in this list will be
  775. removed from entry text before it is shown in the agenda."
  776. :group 'org-agenda
  777. :type '(repeat (regexp)))
  778. (defvar org-agenda-entry-text-cleanup-hook nil
  779. "Hook that is run after basic cleanup of entry text to be shown in agenda.
  780. This cleanup is done in a temporary buffer, so the function may inspect and
  781. change the entire buffer.
  782. Some default stuff like drawers and scheduling/deadline dates will already
  783. have been removed when this is called, as will any matches for regular
  784. expressions listed in `org-agenda-entry-text-exclude-regexps'.")
  785. (defvar org-agenda-include-inactive-timestamps nil
  786. "Non-nil means include inactive time stamps in agenda and timeline.")
  787. (defgroup org-agenda-windows nil
  788. "Options concerning the windows used by the Agenda in Org Mode."
  789. :tag "Org Agenda Windows"
  790. :group 'org-agenda)
  791. (defcustom org-agenda-window-setup 'reorganize-frame
  792. "How the agenda buffer should be displayed.
  793. Possible values for this option are:
  794. current-window Show agenda in the current window, keeping all other windows.
  795. other-window Use `switch-to-buffer-other-window' to display agenda.
  796. reorganize-frame Show only two windows on the current frame, the current
  797. window and the agenda.
  798. other-frame Use `switch-to-buffer-other-frame' to display agenda.
  799. Also, when exiting the agenda, kill that frame.
  800. See also the variable `org-agenda-restore-windows-after-quit'."
  801. :group 'org-agenda-windows
  802. :type '(choice
  803. (const current-window)
  804. (const other-frame)
  805. (const other-window)
  806. (const reorganize-frame)))
  807. (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
  808. "The min and max height of the agenda window as a fraction of frame height.
  809. The value of the variable is a cons cell with two numbers between 0 and 1.
  810. It only matters if `org-agenda-window-setup' is `reorganize-frame'."
  811. :group 'org-agenda-windows
  812. :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
  813. (defcustom org-agenda-restore-windows-after-quit nil
  814. "Non-nil means restore window configuration upon exiting agenda.
  815. Before the window configuration is changed for displaying the agenda,
  816. the current status is recorded. When the agenda is exited with
  817. `q' or `x' and this option is set, the old state is restored. If
  818. `org-agenda-window-setup' is `other-frame', the value of this
  819. option will be ignored."
  820. :group 'org-agenda-windows
  821. :type 'boolean)
  822. (defcustom org-agenda-ndays nil
  823. "Number of days to include in overview display.
  824. Should be 1 or 7.
  825. Obsolete, see `org-agenda-span'."
  826. :group 'org-agenda-daily/weekly
  827. :type 'integer)
  828. (make-obsolete-variable 'org-agenda-ndays 'org-agenda-span "24.1")
  829. (defcustom org-agenda-span 'week
  830. "Number of days to include in overview display.
  831. Can be day, week, month, year, or any number of days.
  832. Custom commands can set this variable in the options section."
  833. :group 'org-agenda-daily/weekly
  834. :type '(choice (const :tag "Day" day)
  835. (const :tag "Week" week)
  836. (const :tag "Month" month)
  837. (const :tag "Year" year)
  838. (integer :tag "Custom")))
  839. (defcustom org-agenda-start-on-weekday 1
  840. "Non-nil means start the overview always on the specified weekday.
  841. 0 denotes Sunday, 1 denotes Monday etc.
  842. When nil, always start on the current day.
  843. Custom commands can set this variable in the options section."
  844. :group 'org-agenda-daily/weekly
  845. :type '(choice (const :tag "Today" nil)
  846. (integer :tag "Weekday No.")))
  847. (defcustom org-agenda-show-all-dates t
  848. "Non-nil means `org-agenda' shows every day in the selected range.
  849. When nil, only the days which actually have entries are shown."
  850. :group 'org-agenda-daily/weekly
  851. :type 'boolean)
  852. (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
  853. "Format string for displaying dates in the agenda.
  854. Used by the daily/weekly agenda and by the timeline. This should be
  855. a format string understood by `format-time-string', or a function returning
  856. the formatted date as a string. The function must take a single argument,
  857. a calendar-style date list like (month day year)."
  858. :group 'org-agenda-daily/weekly
  859. :type '(choice
  860. (string :tag "Format string")
  861. (function :tag "Function")))
  862. (defun org-agenda-format-date-aligned (date)
  863. "Format a date string for display in the daily/weekly agenda, or timeline.
  864. This function makes sure that dates are aligned for easy reading."
  865. (require 'cal-iso)
  866. (let* ((dayname (calendar-day-name date))
  867. (day (cadr date))
  868. (day-of-week (calendar-day-of-week date))
  869. (month (car date))
  870. (monthname (calendar-month-name month))
  871. (year (nth 2 date))
  872. (iso-week (org-days-to-iso-week
  873. (calendar-absolute-from-gregorian date)))
  874. (weekyear (cond ((and (= month 1) (>= iso-week 52))
  875. (1- year))
  876. ((and (= month 12) (<= iso-week 1))
  877. (1+ year))
  878. (t year)))
  879. (weekstring (if (= day-of-week 1)
  880. (format " W%02d" iso-week)
  881. "")))
  882. (format "%-10s %2d %s %4d%s"
  883. dayname day monthname year weekstring)))
  884. (defcustom org-agenda-time-leading-zero nil
  885. "Non-nil means use leading zero for military times in agenda.
  886. For example, 9:30am would become 09:30 rather than 9:30."
  887. :group 'org-agenda-daily/weekly
  888. :type 'boolean)
  889. (defcustom org-agenda-timegrid-use-ampm nil
  890. "When set, show AM/PM style timestamps on the timegrid."
  891. :group 'org-agenda
  892. :type 'boolean)
  893. (defun org-agenda-time-of-day-to-ampm (time)
  894. "Convert TIME of a string like '13:45' to an AM/PM style time string."
  895. (let* ((hour-number (string-to-number (substring time 0 -3)))
  896. (minute (substring time -2))
  897. (ampm "am"))
  898. (cond
  899. ((equal hour-number 12)
  900. (setq ampm "pm"))
  901. ((> hour-number 12)
  902. (setq ampm "pm")
  903. (setq hour-number (- hour-number 12))))
  904. (concat
  905. (if org-agenda-time-leading-zero
  906. (format "%02d" hour-number)
  907. (format "%02s" (number-to-string hour-number)))
  908. ":" minute ampm)))
  909. (defun org-agenda-time-of-day-to-ampm-maybe (time)
  910. "Conditionally convert TIME to AM/PM format
  911. based on `org-agenda-timegrid-use-ampm'"
  912. (if org-agenda-timegrid-use-ampm
  913. (org-agenda-time-of-day-to-ampm time)
  914. time))
  915. (defcustom org-agenda-weekend-days '(6 0)
  916. "Which days are weekend?
  917. These days get the special face `org-agenda-date-weekend' in the agenda
  918. and timeline buffers."
  919. :group 'org-agenda-daily/weekly
  920. :type '(set :greedy t
  921. (const :tag "Monday" 1)
  922. (const :tag "Tuesday" 2)
  923. (const :tag "Wednesday" 3)
  924. (const :tag "Thursday" 4)
  925. (const :tag "Friday" 5)
  926. (const :tag "Saturday" 6)
  927. (const :tag "Sunday" 0)))
  928. (defcustom org-agenda-include-diary nil
  929. "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
  930. Custom commands can set this variable in the options section."
  931. :group 'org-agenda-daily/weekly
  932. :type 'boolean)
  933. (defcustom org-agenda-include-deadlines t
  934. "If non-nil, include entries within their deadline warning period.
  935. Custom commands can set this variable in the options section."
  936. :group 'org-agenda-daily/weekly
  937. :type 'boolean)
  938. (defcustom org-agenda-include-all-todo nil
  939. "Set means weekly/daily agenda will always contain all TODO entries.
  940. The TODO entries will be listed at the top of the agenda, before
  941. the entries for specific days.
  942. This option is deprecated, it is better to define a block agenda instead."
  943. :group 'org-agenda-daily/weekly
  944. :type 'boolean)
  945. (defcustom org-agenda-repeating-timestamp-show-all t
  946. "Non-nil means show all occurrences of a repeating stamp in the agenda.
  947. When set to a list of strings, only show occurrences of repeating
  948. stamps for these TODO keywords. When nil, only one occurrence is
  949. shown, either today or the nearest into the future."
  950. :group 'org-agenda-daily/weekly
  951. :type '(choice
  952. (const :tag "Show repeating stamps" t)
  953. (repeat :tag "Show repeating stamps for these TODO keywords"
  954. (string :tag "TODO Keyword"))
  955. (const :tag "Don't show repeating stamps" nil)))
  956. (defcustom org-scheduled-past-days 10000
  957. "No. of days to continue listing scheduled items that are not marked DONE.
  958. When an item is scheduled on a date, it shows up in the agenda on this
  959. day and will be listed until it is marked done for the number of days
  960. given here."
  961. :group 'org-agenda-daily/weekly
  962. :type 'integer)
  963. (defcustom org-agenda-log-mode-items '(closed clock)
  964. "List of items that should be shown in agenda log mode.
  965. This list may contain the following symbols:
  966. closed Show entries that have been closed on that day.
  967. clock Show entries that have received clocked time on that day.
  968. state Show all logged state changes.
  969. Note that instead of changing this variable, you can also press `C-u l' in
  970. the agenda to display all available LOG items temporarily."
  971. :group 'org-agenda-daily/weekly
  972. :type '(set :greedy t (const closed) (const clock) (const state)))
  973. (defcustom org-agenda-clock-consistency-checks
  974. '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
  975. :gap-ok-around ("4:00")
  976. :default-face ((:background "DarkRed") (:foreground "white"))
  977. :overlap-face nil :gap-face nil :no-end-time-face nil
  978. :long-face nil :short-face nil)
  979. "This is a property list, with the following keys:
  980. :max-duration Mark clocking chunks that are longer than this time.
  981. This is a time string like \"HH:MM\", or the number
  982. of minutes as an integer.
  983. :min-duration Mark clocking chunks that are shorter that this.
  984. This is a time string like \"HH:MM\", or the number
  985. of minutes as an integer.
  986. :max-gap Mark gaps between clocking chunks that are longer than
  987. this duration. A number of minutes, or a string
  988. like \"HH:MM\".
  989. :gap-ok-around List of times during the day which are usually not working
  990. times. When a gap is detected, but the gap contains any
  991. of these times, the gap is *not* reported. For example,
  992. if this is (\"4:00\" \"13:00\") then gaps that contain
  993. 4:00 in the morning (i.e. the night) and 13:00
  994. (i.e. a typical lunch time) do not cause a warning.
  995. You should have at least one time during the night in this
  996. list, or otherwise the first task each morning will trigger
  997. a warning because it follows a long gap.
  998. Furthermore, the following properties can be used to define faces for
  999. issue display.
  1000. :default-face the default face, if the specific face is undefined
  1001. :overlap-face face for overlapping clocks
  1002. :gap-face face for gaps between clocks
  1003. :no-end-time-face face for incomplete clocks
  1004. :long-face face for clock intervals that are too long
  1005. :short-face face for clock intervals that are too short"
  1006. :group 'org-agenda-daily/weekly
  1007. :group 'org-clock
  1008. :type 'plist)
  1009. (defcustom org-agenda-log-mode-add-notes t
  1010. "Non-nil means add first line of notes to log entries in agenda views.
  1011. If a log item like a state change or a clock entry is associated with
  1012. notes, the first line of these notes will be added to the entry in the
  1013. agenda display."
  1014. :group 'org-agenda-daily/weekly
  1015. :type 'boolean)
  1016. (defcustom org-agenda-start-with-log-mode nil
  1017. "The initial value of log-mode in a newly created agenda window."
  1018. :group 'org-agenda-startup
  1019. :group 'org-agenda-daily/weekly
  1020. :type 'boolean)
  1021. (defcustom org-agenda-start-with-clockreport-mode nil
  1022. "The initial value of clockreport-mode in a newly created agenda window."
  1023. :group 'org-agenda-startup
  1024. :group 'org-agenda-daily/weekly
  1025. :type 'boolean)
  1026. (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
  1027. "Property list with parameters for the clocktable in clockreport mode.
  1028. This is the display mode that shows a clock table in the daily/weekly
  1029. agenda, the properties for this dynamic block can be set here.
  1030. The usual clocktable parameters are allowed here, but you cannot set
  1031. the properties :name, :tstart, :tend, :block, and :scope - these will
  1032. be overwritten to make sure the content accurately reflects the
  1033. current display in the agenda."
  1034. :group 'org-agenda-daily/weekly
  1035. :type 'plist)
  1036. (defcustom org-agenda-search-view-always-boolean nil
  1037. "Non-nil means the search string is interpreted as individual parts.
  1038. The search string for search view can either be interpreted as a phrase,
  1039. or as a list of snippets that define a boolean search for a number of
  1040. strings.
  1041. When this is non-nil, the string will be split on whitespace, and each
  1042. snippet will be searched individually, and all must match in order to
  1043. select an entry. A snippet is then a single string of non-white
  1044. characters, or a string in double quotes, or a regexp in {} braces.
  1045. If a snippet is preceded by \"-\", the snippet must *not* match.
  1046. \"+\" is syntactic sugar for positive selection. Each snippet may
  1047. be found as a full word or a partial word, but see the variable
  1048. `org-agenda-search-view-force-full-words'.
  1049. When this is nil, search will look for the entire search phrase as one,
  1050. with each space character matching any amount of whitespace, including
  1051. line breaks.
  1052. Even when this is nil, you can still switch to Boolean search dynamically
  1053. by preceding the first snippet with \"+\" or \"-\". If the first snippet
  1054. is a regexp marked with braces like \"{abc}\", this will also switch to
  1055. boolean search."
  1056. :group 'org-agenda-search-view
  1057. :type 'boolean)
  1058. (if (fboundp 'defvaralias)
  1059. (defvaralias 'org-agenda-search-view-search-words-only
  1060. 'org-agenda-search-view-always-boolean))
  1061. (defcustom org-agenda-search-view-force-full-words nil
  1062. "Non-nil means, search words must be matches as complete words.
  1063. When nil, they may also match part of a word."
  1064. :group 'org-agenda-search-view
  1065. :type 'boolean)
  1066. (defgroup org-agenda-time-grid nil
  1067. "Options concerning the time grid in the Org-mode Agenda."
  1068. :tag "Org Agenda Time Grid"
  1069. :group 'org-agenda)
  1070. (defcustom org-agenda-search-headline-for-time t
  1071. "Non-nil means search headline for a time-of-day.
  1072. If the headline contains a time-of-day in one format or another, it will
  1073. be used to sort the entry into the time sequence of items for a day.
  1074. Some people have time stamps in the headline that refer to the creation
  1075. time or so, and then this produces an unwanted side effect. If this is
  1076. the case for your, use this variable to turn off searching the headline
  1077. for a time."
  1078. :group 'org-agenda-time-grid
  1079. :type 'boolean)
  1080. (defcustom org-agenda-use-time-grid t
  1081. "Non-nil means show a time grid in the agenda schedule.
  1082. A time grid is a set of lines for specific times (like every two hours between
  1083. 8:00 and 20:00). The items scheduled for a day at specific times are
  1084. sorted in between these lines.
  1085. For details about when the grid will be shown, and what it will look like, see
  1086. the variable `org-agenda-time-grid'."
  1087. :group 'org-agenda-time-grid
  1088. :type 'boolean)
  1089. (defcustom org-agenda-time-grid
  1090. '((daily today require-timed)
  1091. "----------------"
  1092. (800 1000 1200 1400 1600 1800 2000))
  1093. "The settings for time grid for agenda display.
  1094. This is a list of three items. The first item is again a list. It contains
  1095. symbols specifying conditions when the grid should be displayed:
  1096. daily if the agenda shows a single day
  1097. weekly if the agenda shows an entire week
  1098. today show grid on current date, independent of daily/weekly display
  1099. require-timed show grid only if at least one item has a time specification
  1100. The second item is a string which will be placed behind the grid time.
  1101. The third item is a list of integers, indicating the times that should have
  1102. a grid line."
  1103. :group 'org-agenda-time-grid
  1104. :type
  1105. '(list
  1106. (set :greedy t :tag "Grid Display Options"
  1107. (const :tag "Show grid in single day agenda display" daily)
  1108. (const :tag "Show grid in weekly agenda display" weekly)
  1109. (const :tag "Always show grid for today" today)
  1110. (const :tag "Show grid only if any timed entries are present"
  1111. require-timed)
  1112. (const :tag "Skip grid times already present in an entry"
  1113. remove-match))
  1114. (string :tag "Grid String")
  1115. (repeat :tag "Grid Times" (integer :tag "Time"))))
  1116. (defcustom org-agenda-show-current-time-in-grid t
  1117. "Non-nil means show the current time in the time grid."
  1118. :group 'org-agenda-time-grid
  1119. :type 'boolean)
  1120. (defcustom org-agenda-current-time-string
  1121. "now - - - - - - - - - - - - - - - - - - - - - - - - -"
  1122. "The string for the current time marker in the agenda."
  1123. :group 'org-agenda-time-grid
  1124. :type 'string)
  1125. (defgroup org-agenda-sorting nil
  1126. "Options concerning sorting in the Org-mode Agenda."
  1127. :tag "Org Agenda Sorting"
  1128. :group 'org-agenda)
  1129. (defcustom org-agenda-sorting-strategy
  1130. '((agenda habit-down time-up priority-down category-keep)
  1131. (todo priority-down category-keep)
  1132. (tags priority-down category-keep)
  1133. (search category-keep))
  1134. "Sorting structure for the agenda items of a single day.
  1135. This is a list of symbols which will be used in sequence to determine
  1136. if an entry should be listed before another entry. The following
  1137. symbols are recognized:
  1138. time-up Put entries with time-of-day indications first, early first
  1139. time-down Put entries with time-of-day indications first, late first
  1140. category-keep Keep the default order of categories, corresponding to the
  1141. sequence in `org-agenda-files'.
  1142. category-up Sort alphabetically by category, A-Z.
  1143. category-down Sort alphabetically by category, Z-A.
  1144. tag-up Sort alphabetically by last tag, A-Z.
  1145. tag-down Sort alphabetically by last tag, Z-A.
  1146. priority-up Sort numerically by priority, high priority last.
  1147. priority-down Sort numerically by priority, high priority first.
  1148. todo-state-up Sort by todo state, tasks that are done last.
  1149. todo-state-down Sort by todo state, tasks that are done first.
  1150. effort-up Sort numerically by estimated effort, high effort last.
  1151. effort-down Sort numerically by estimated effort, high effort first.
  1152. user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
  1153. user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
  1154. habit-up Put entries that are habits first
  1155. habit-down Put entries that are habits last
  1156. alpha-up Sort headlines alphabetically
  1157. alpha-down Sort headlines alphabetically, reversed
  1158. The different possibilities will be tried in sequence, and testing stops
  1159. if one comparison returns a \"not-equal\". For example, the default
  1160. '(time-up category-keep priority-down)
  1161. means: Pull out all entries having a specified time of day and sort them,
  1162. in order to make a time schedule for the current day the first thing in the
  1163. agenda listing for the day. Of the entries without a time indication, keep
  1164. the grouped in categories, don't sort the categories, but keep them in
  1165. the sequence given in `org-agenda-files'. Within each category sort by
  1166. priority.
  1167. Leaving out `category-keep' would mean that items will be sorted across
  1168. categories by priority.
  1169. Instead of a single list, this can also be a set of list for specific
  1170. contents, with a context symbol in the car of the list, any of
  1171. `agenda', `todo', `tags', `search' for the corresponding agenda views.
  1172. Custom commands can bind this variable in the options section."
  1173. :group 'org-agenda-sorting
  1174. :type `(choice
  1175. (repeat :tag "General" ,org-sorting-choice)
  1176. (list :tag "Individually"
  1177. (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
  1178. (repeat ,org-sorting-choice))
  1179. (cons (const :tag "Strategy for TODO lists" todo)
  1180. (repeat ,org-sorting-choice))
  1181. (cons (const :tag "Strategy for Tags matches" tags)
  1182. (repeat ,org-sorting-choice))
  1183. (cons (const :tag "Strategy for search matches" search)
  1184. (repeat ,org-sorting-choice)))))
  1185. (defcustom org-agenda-cmp-user-defined nil
  1186. "A function to define the comparison `user-defined'.
  1187. This function must receive two arguments, agenda entry a and b.
  1188. If a>b, return +1. If a<b, return -1. If they are equal as seen by
  1189. the user comparison, return nil.
  1190. When this is defined, you can make `user-defined-up' and `user-defined-down'
  1191. part of an agenda sorting strategy."
  1192. :group 'org-agenda-sorting
  1193. :type 'symbol)
  1194. (defcustom org-sort-agenda-notime-is-late t
  1195. "Non-nil means items without time are considered late.
  1196. This is only relevant for sorting. When t, items which have no explicit
  1197. time like 15:30 will be considered as 99:01, i.e. later than any items which
  1198. do have a time. When nil, the default time is before 0:00. You can use this
  1199. option to decide if the schedule for today should come before or after timeless
  1200. agenda entries."
  1201. :group 'org-agenda-sorting
  1202. :type 'boolean)
  1203. (defcustom org-sort-agenda-noeffort-is-high t
  1204. "Non-nil means items without effort estimate are sorted as high effort.
  1205. This also applies when filtering an agenda view with respect to the
  1206. < or > effort operator. Then, tasks with no effort defined will be treated
  1207. as tasks with high effort.
  1208. When nil, such items are sorted as 0 minutes effort."
  1209. :group 'org-agenda-sorting
  1210. :type 'boolean)
  1211. (defgroup org-agenda-line-format nil
  1212. "Options concerning the entry prefix in the Org-mode agenda display."
  1213. :tag "Org Agenda Line Format"
  1214. :group 'org-agenda)
  1215. (defcustom org-agenda-prefix-format
  1216. '((agenda . " %i %-12:c%?-12t% s")
  1217. (timeline . " % s")
  1218. (todo . " %i %-12:c")
  1219. (tags . " %i %-12:c")
  1220. (search . " %i %-12:c"))
  1221. "Format specifications for the prefix of items in the agenda views.
  1222. An alist with four entries, for the different agenda types. The keys to the
  1223. sublists are `agenda', `timeline', `todo', `search' and `tags'. The values
  1224. are format strings.
  1225. This format works similar to a printf format, with the following meaning:
  1226. %c the category of the item, \"Diary\" for entries from the diary, or
  1227. as given by the CATEGORY keyword or derived from the file name.
  1228. %i the icon category of the item, as give in
  1229. `org-agenda-category-icon-alist'.
  1230. %T the *last* tag of the item. Last because inherited tags come
  1231. first in the list.
  1232. %t the time-of-day specification if one applies to the entry, in the
  1233. format HH:MM
  1234. %s Scheduling/Deadline information, a short string
  1235. %(expression) Eval EXPRESSION and replace the control string
  1236. by the result
  1237. All specifiers work basically like the standard `%s' of printf, but may
  1238. contain two additional characters: A question mark just after the `%' and
  1239. a whitespace/punctuation character just before the final letter.
  1240. If the first character after `%' is a question mark, the entire field
  1241. will only be included if the corresponding value applies to the
  1242. current entry. This is useful for fields which should have fixed
  1243. width when present, but zero width when absent. For example,
  1244. \"%?-12t\" will result in a 12 character time field if a time of the
  1245. day is specified, but will completely disappear in entries which do
  1246. not contain a time.
  1247. If there is punctuation or whitespace character just before the final
  1248. format letter, this character will be appended to the field value if
  1249. the value is not empty. For example, the format \"%-12:c\" leads to
  1250. \"Diary: \" if the category is \"Diary\". If the category were be
  1251. empty, no additional colon would be inserted.
  1252. The default value of this option is \" %-12:c%?-12t% s\", meaning:
  1253. - Indent the line with two space characters
  1254. - Give the category in a 12 chars wide field, padded with whitespace on
  1255. the right (because of `-'). Append a colon if there is a category
  1256. (because of `:').
  1257. - If there is a time-of-day, put it into a 12 chars wide field. If no
  1258. time, don't put in an empty field, just skip it (because of '?').
  1259. - Finally, put the scheduling information and append a whitespace.
  1260. As another example, if you don't want the time-of-day of entries in
  1261. the prefix, you could use:
  1262. (setq org-agenda-prefix-format \" %-11:c% s\")
  1263. See also the variables `org-agenda-remove-times-when-in-prefix' and
  1264. `org-agenda-remove-tags'.
  1265. Custom commands can set this variable in the options section."
  1266. :type '(choice
  1267. (string :tag "General format")
  1268. (list :greedy t :tag "View dependent"
  1269. (cons (const agenda) (string :tag "Format"))
  1270. (cons (const timeline) (string :tag "Format"))
  1271. (cons (const todo) (string :tag "Format"))
  1272. (cons (const tags) (string :tag "Format"))
  1273. (cons (const search) (string :tag "Format"))))
  1274. :group 'org-agenda-line-format)
  1275. (defvar org-prefix-format-compiled nil
  1276. "The compiled version of the most recently used prefix format.
  1277. See the variable `org-agenda-prefix-format'.")
  1278. (defcustom org-agenda-todo-keyword-format "%-1s"
  1279. "Format for the TODO keyword in agenda lines.
  1280. Set this to something like \"%-12s\" if you want all TODO keywords
  1281. to occupy a fixed space in the agenda display."
  1282. :group 'org-agenda-line-format
  1283. :type 'string)
  1284. (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
  1285. "Text preceding timerange entries in the agenda view.
  1286. This is a list with two strings. The first applies when the range
  1287. is entirely on one day. The second applies if the range spans several days.
  1288. The strings may have two \"%d\" format specifiers which will be filled
  1289. with the sequence number of the days, and the total number of days in the
  1290. range, respectively."
  1291. :group 'org-agenda-line-format
  1292. :type '(list
  1293. (string :tag "Deadline today ")
  1294. (choice :tag "Deadline relative"
  1295. (string :tag "Format string")
  1296. (function))))
  1297. (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
  1298. "Text preceding scheduled items in the agenda view.
  1299. This is a list with two strings. The first applies when the item is
  1300. scheduled on the current day. The second applies when it has been scheduled
  1301. previously, it may contain a %d indicating that this is the nth time that
  1302. this item is scheduled, due to automatic rescheduling of unfinished items
  1303. for the following day. So this number is one larger than the number of days
  1304. that passed since this item was scheduled first."
  1305. :group 'org-agenda-line-format
  1306. :type '(list
  1307. (string :tag "Scheduled today ")
  1308. (string :tag "Scheduled previously")))
  1309. (defcustom org-agenda-inactive-leader "["
  1310. "Text preceding item pulled into the agenda by inactive time stamps.
  1311. These entries are added to the agenda when pressing \"[\"."
  1312. :group 'org-agenda-line-format
  1313. :type '(list
  1314. (string :tag "Scheduled today ")
  1315. (string :tag "Scheduled previously")))
  1316. (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: ")
  1317. "Text preceding deadline items in the agenda view.
  1318. This is a list with two strings. The first applies when the item has its
  1319. deadline on the current day. The second applies when it is in the past or
  1320. in the future, it may contain %d to capture how many days away the deadline
  1321. is (was)."
  1322. :group 'org-agenda-line-format
  1323. :type '(list
  1324. (string :tag "Deadline today ")
  1325. (choice :tag "Deadline relative"
  1326. (string :tag "Format string")
  1327. (function))))
  1328. (defcustom org-agenda-remove-times-when-in-prefix t
  1329. "Non-nil means remove duplicate time specifications in agenda items.
  1330. When the format `org-agenda-prefix-format' contains a `%t' specifier, a
  1331. time-of-day specification in a headline or diary entry is extracted and
  1332. placed into the prefix. If this option is non-nil, the original specification
  1333. \(a timestamp or -range, or just a plain time(range) specification like
  1334. 11:30-4pm) will be removed for agenda display. This makes the agenda less
  1335. cluttered.
  1336. The option can be t or nil. It may also be the symbol `beg', indicating
  1337. that the time should only be removed when it is located at the beginning of
  1338. the headline/diary entry."
  1339. :group 'org-agenda-line-format
  1340. :type '(choice
  1341. (const :tag "Always" t)
  1342. (const :tag "Never" nil)
  1343. (const :tag "When at beginning of entry" beg)))
  1344. (defcustom org-agenda-remove-timeranges-from-blocks nil
  1345. "Non-nil means remove time ranges specifications in agenda
  1346. items that span on several days."
  1347. :group 'org-agenda-line-format
  1348. :type 'boolean)
  1349. (defcustom org-agenda-default-appointment-duration nil
  1350. "Default duration for appointments that only have a starting time.
  1351. When nil, no duration is specified in such cases.
  1352. When non-nil, this must be the number of minutes, e.g. 60 for one hour."
  1353. :group 'org-agenda-line-format
  1354. :type '(choice
  1355. (integer :tag "Minutes")
  1356. (const :tag "No default duration")))
  1357. (defcustom org-agenda-show-inherited-tags t
  1358. "Non-nil means show inherited tags in each agenda line."
  1359. :group 'org-agenda-line-format
  1360. :type 'boolean)
  1361. (defcustom org-agenda-hide-tags-regexp nil
  1362. "Regular expression used to filter away specific tags in agenda views.
  1363. This means that these tags will be present, but not be shown in the agenda
  1364. line. Secondary filtering will still work on the hidden tags.
  1365. Nil means don't hide any tags."
  1366. :group 'org-agenda-line-format
  1367. :type '(choice
  1368. (const :tag "Hide none" nil)
  1369. (string :tag "Regexp ")))
  1370. (defcustom org-agenda-remove-tags nil
  1371. "Non-nil means remove the tags from the headline copy in the agenda.
  1372. When this is the symbol `prefix', only remove tags when
  1373. `org-agenda-prefix-format' contains a `%T' specifier."
  1374. :group 'org-agenda-line-format
  1375. :type '(choice
  1376. (const :tag "Always" t)
  1377. (const :tag "Never" nil)
  1378. (const :tag "When prefix format contains %T" prefix)))
  1379. (if (fboundp 'defvaralias)
  1380. (defvaralias 'org-agenda-remove-tags-when-in-prefix
  1381. 'org-agenda-remove-tags))
  1382. (defcustom org-agenda-tags-column (if (featurep 'xemacs) -79 -80)
  1383. "Shift tags in agenda items to this column.
  1384. If this number is positive, it specifies the column. If it is negative,
  1385. it means that the tags should be flushright to that column. For example,
  1386. -80 works well for a normal 80 character screen."
  1387. :group 'org-agenda-line-format
  1388. :type 'integer)
  1389. (if (fboundp 'defvaralias)
  1390. (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column))
  1391. (defcustom org-agenda-fontify-priorities 'cookies
  1392. "Non-nil means highlight low and high priorities in agenda.
  1393. When t, the highest priority entries are bold, lowest priority italic.
  1394. However, settings in `org-priority-faces' will overrule these faces.
  1395. When this variable is the symbol `cookies', only fontify the
  1396. cookies, not the entire task.
  1397. This may also be an association list of priority faces, whose
  1398. keys are the character values of `org-highest-priority',
  1399. `org-default-priority', and `org-lowest-priority' (the default values
  1400. are ?A, ?B, and ?C, respectively). The face may be a named face, a
  1401. color as a string, or a list like `(:background \"Red\")'.
  1402. If it is a color, the variable `org-faces-easy-properties'
  1403. determines if it is a foreground or a background color."
  1404. :group 'org-agenda-line-format
  1405. :type '(choice
  1406. (const :tag "Never" nil)
  1407. (const :tag "Defaults" t)
  1408. (const :tag "Cookies only" cookies)
  1409. (repeat :tag "Specify"
  1410. (list (character :tag "Priority" :value ?A)
  1411. (choice :tag "Face "
  1412. (string :tag "Color")
  1413. (sexp :tag "Face"))))))
  1414. (defcustom org-agenda-day-face-function nil
  1415. "Function called to determine what face should be used to display a day.
  1416. The only argument passed to that function is the day. It should
  1417. returns a face, or nil if does not want to specify a face and let
  1418. the normal rules apply."
  1419. :group 'org-agenda-line-format
  1420. :type 'function)
  1421. (defcustom org-agenda-category-icon-alist nil
  1422. "Alist of category icon to be displayed in agenda views.
  1423. Each entry should have the following format:
  1424. (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
  1425. Where CATEGORY-REGEXP is a regexp matching the categories where
  1426. the icon should be displayed.
  1427. FILE-OR-DATA either a file path or a string containing image data.
  1428. The other fields can be omited safely if not needed:
  1429. TYPE indicates the image type.
  1430. DATA-P is a boolean indicating whether the FILE-OR-DATA string is
  1431. image data.
  1432. PROPS are additional image attributes to assign to the image,
  1433. like, e.g. `:ascent center'.
  1434. (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
  1435. If you want to set the display properties yourself, just put a
  1436. list as second element:
  1437. (CATEGORY-REGEXP (MY PROPERTY LIST))
  1438. For example, to display a 16px horizontal space for Emacs
  1439. category, you can use:
  1440. (\"Emacs\" '(space . (:width (16))))"
  1441. :group 'org-agenda-line-format
  1442. :type '(alist :key-type (string :tag "Regexp matching category")
  1443. :value-type (choice (list :tag "Icon"
  1444. (string :tag "File or data")
  1445. (symbol :tag "Type")
  1446. (boolean :tag "Data?")
  1447. (repeat :tag "Extra image properties" :inline t symbol))
  1448. (list :tag "Display properties" sexp))))
  1449. (defgroup org-agenda-column-view nil
  1450. "Options concerning column view in the agenda."
  1451. :tag "Org Agenda Column View"
  1452. :group 'org-agenda)
  1453. (defcustom org-agenda-columns-show-summaries t
  1454. "Non-nil means show summaries for columns displayed in the agenda view."
  1455. :group 'org-agenda-column-view
  1456. :type 'boolean)
  1457. (defcustom org-agenda-columns-compute-summary-properties t
  1458. "Non-nil means recompute all summary properties before column view.
  1459. When column view in the agenda is listing properties that have a summary
  1460. operator, it can go to all relevant buffers and recompute the summaries
  1461. there. This can mean overhead for the agenda column view, but is necessary
  1462. to have thing up to date.
  1463. As a special case, a CLOCKSUM property also makes sure that the clock
  1464. computations are current."
  1465. :group 'org-agenda-column-view
  1466. :type 'boolean)
  1467. (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
  1468. "Non-nil means the duration of an appointment will add to day effort.
  1469. The property to which appointment durations will be added is the one given
  1470. in the option `org-effort-property'. If an appointment does not have
  1471. an end time, `org-agenda-default-appointment-duration' will be used. If that
  1472. is not set, an appointment without end time will not contribute to the time
  1473. estimate."
  1474. :group 'org-agenda-column-view
  1475. :type 'boolean)
  1476. (defcustom org-agenda-auto-exclude-function nil
  1477. "A function called with a tag to decide if it is filtered on '/ RET'.
  1478. The sole argument to the function, which is called once for each
  1479. possible tag, is a string giving the name of the tag. The
  1480. function should return either nil if the tag should be included
  1481. as normal, or \"-<TAG>\" to exclude the tag.
  1482. Note that for the purpose of tag filtering, only the lower-case version of
  1483. all tags will be considered, so that this function will only ever see
  1484. the lower-case version of all tags."
  1485. :group 'org-agenda
  1486. :type 'function)
  1487. (eval-when-compile
  1488. (require 'cl))
  1489. (require 'org)
  1490. (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
  1491. "Execute BODY with point at location given by `org-hd-marker' property.
  1492. If STRING is non-nil, the text property will be fetched from position 0
  1493. in that string. If STRING is nil, it will be fetched from the beginning
  1494. of the current line."
  1495. `(let ((marker (get-text-property (if string 0 (point-at-bol))
  1496. 'org-hd-marker string)))
  1497. (with-current-buffer (marker-buffer marker)
  1498. (save-excursion
  1499. (goto-char marker)
  1500. ,@body))))
  1501. (defun org-add-agenda-custom-command (entry)
  1502. "Replace or add a command in `org-agenda-custom-commands'.
  1503. This is mostly for hacking and trying a new command - once the command
  1504. works you probably want to add it to `org-agenda-custom-commands' for good."
  1505. (let ((ass (assoc (car entry) org-agenda-custom-commands)))
  1506. (if ass
  1507. (setcdr ass (cdr entry))
  1508. (push entry org-agenda-custom-commands))))
  1509. ;;; Define the Org-agenda-mode
  1510. (defvar org-agenda-mode-map (make-sparse-keymap)
  1511. "Keymap for `org-agenda-mode'.")
  1512. (if (fboundp 'defvaralias)
  1513. (defvaralias 'org-agenda-keymap 'org-agenda-mode-map))
  1514. (defvar org-agenda-menu) ; defined later in this file.
  1515. (defvar org-agenda-restrict) ; defined later in this file.
  1516. (defvar org-agenda-follow-mode nil)
  1517. (defvar org-agenda-entry-text-mode nil)
  1518. (defvar org-agenda-clockreport-mode nil)
  1519. (defvar org-agenda-show-log nil)
  1520. (defvar org-agenda-redo-command nil)
  1521. (defvar org-agenda-query-string nil)
  1522. (defvar org-agenda-mode-hook nil
  1523. "Hook for `org-agenda-mode', run after the mode is turned on.")
  1524. (defvar org-agenda-type nil)
  1525. (defvar org-agenda-force-single-file nil)
  1526. (defvar org-agenda-bulk-marked-entries) ;; Defined further down in this file
  1527. (defun org-agenda-mode ()
  1528. "Mode for time-sorted view on action items in Org-mode files.
  1529. The following commands are available:
  1530. \\{org-agenda-mode-map}"
  1531. (interactive)
  1532. (kill-all-local-variables)
  1533. (setq org-agenda-undo-list nil
  1534. org-agenda-pending-undo-list nil
  1535. org-agenda-bulk-marked-entries nil)
  1536. (setq major-mode 'org-agenda-mode)
  1537. ;; Keep global-font-lock-mode from turning on font-lock-mode
  1538. (org-set-local 'font-lock-global-modes (list 'not major-mode))
  1539. (setq mode-name "Org-Agenda")
  1540. (use-local-map org-agenda-mode-map)
  1541. (easy-menu-add org-agenda-menu)
  1542. (if org-startup-truncated (setq truncate-lines t))
  1543. (org-set-local 'line-move-visual nil)
  1544. (org-add-hook 'post-command-hook 'org-agenda-post-command-hook nil 'local)
  1545. (org-add-hook 'pre-command-hook 'org-unhighlight nil 'local)
  1546. ;; Make sure properties are removed when copying text
  1547. (when (boundp 'buffer-substring-filters)
  1548. (org-set-local 'buffer-substring-filters
  1549. (cons (lambda (x)
  1550. (set-text-properties 0 (length x) nil x) x)
  1551. buffer-substring-filters)))
  1552. (unless org-agenda-keep-modes
  1553. (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
  1554. org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
  1555. org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode
  1556. org-agenda-show-log org-agenda-start-with-log-mode))
  1557. (easy-menu-change
  1558. '("Agenda") "Agenda Files"
  1559. (append
  1560. (list
  1561. (vector
  1562. (if (get 'org-agenda-files 'org-restrict)
  1563. "Restricted to single file"
  1564. "Edit File List")
  1565. '(org-edit-agenda-file-list)
  1566. (not (get 'org-agenda-files 'org-restrict)))
  1567. "--")
  1568. (mapcar 'org-file-menu-entry (org-agenda-files))))
  1569. (org-agenda-set-mode-name)
  1570. (apply
  1571. (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
  1572. (list 'org-agenda-mode-hook)))
  1573. (substitute-key-definition 'undo 'org-agenda-undo
  1574. org-agenda-mode-map global-map)
  1575. (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
  1576. (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
  1577. (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
  1578. (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
  1579. (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
  1580. (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
  1581. (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
  1582. (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
  1583. (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-remove-all-marks)
  1584. (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
  1585. (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
  1586. (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
  1587. (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
  1588. (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
  1589. (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
  1590. (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
  1591. (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
  1592. (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
  1593. (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
  1594. (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
  1595. (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
  1596. (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
  1597. (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
  1598. (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
  1599. (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
  1600. (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
  1601. (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
  1602. (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
  1603. (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
  1604. (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
  1605. (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
  1606. (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
  1607. (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
  1608. (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
  1609. (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
  1610. (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
  1611. (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
  1612. (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
  1613. (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
  1614. (org-defkey org-agenda-mode-map "k" 'org-agenda-action)
  1615. (org-defkey org-agenda-mode-map "\C-c\C-x\C-k" 'org-agenda-action)
  1616. (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
  1617. (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
  1618. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
  1619. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
  1620. (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
  1621. (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
  1622. (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
  1623. (let ((l '(1 2 3 4 5 6 7 8 9 0)))
  1624. (while l (org-defkey org-agenda-mode-map
  1625. (int-to-string (pop l)) 'digit-argument)))
  1626. (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
  1627. (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
  1628. (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
  1629. (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
  1630. (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
  1631. (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
  1632. (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
  1633. (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
  1634. (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
  1635. (org-defkey org-agenda-mode-map "g" 'org-agenda-redo)
  1636. (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
  1637. (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
  1638. (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
  1639. 'org-clock-modify-effort-estimate)
  1640. (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
  1641. (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
  1642. (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
  1643. (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-write-agenda)
  1644. (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
  1645. (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
  1646. (org-defkey org-agenda-mode-map "P" 'org-agenda-show-priority)
  1647. (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
  1648. (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
  1649. (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
  1650. (substitute-key-definition 'next-line 'org-agenda-next-line
  1651. org-agenda-mode-map global-map)
  1652. (substitute-key-definition 'previous-line 'org-agenda-previous-line
  1653. org-agenda-mode-map global-map)
  1654. (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
  1655. (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
  1656. (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
  1657. (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
  1658. (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
  1659. (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
  1660. (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
  1661. (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
  1662. (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
  1663. (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
  1664. (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
  1665. (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
  1666. (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
  1667. (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
  1668. (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
  1669. (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
  1670. (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
  1671. (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
  1672. (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  1673. (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
  1674. (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
  1675. (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
  1676. (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
  1677. (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
  1678. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
  1679. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
  1680. (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
  1681. (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
  1682. (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
  1683. (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  1684. (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
  1685. (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
  1686. (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
  1687. (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
  1688. (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
  1689. (org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag-refine)
  1690. (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
  1691. (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
  1692. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  1693. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  1694. (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
  1695. (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
  1696. (when org-agenda-mouse-1-follows-link
  1697. (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
  1698. (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
  1699. '("Agenda"
  1700. ("Agenda Files")
  1701. "--"
  1702. ("Agenda Dates"
  1703. ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
  1704. ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
  1705. ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
  1706. ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
  1707. "--"
  1708. ("View"
  1709. ["Day View" org-agenda-day-view
  1710. :active (org-agenda-check-type nil 'agenda)
  1711. :style radio :selected (eq org-agenda-current-span 'day)
  1712. :keys "v d (or just d)"]
  1713. ["Week View" org-agenda-week-view
  1714. :active (org-agenda-check-type nil 'agenda)
  1715. :style radio :selected (eq org-agenda-current-span 'week)
  1716. :keys "v w (or just w)"]
  1717. ["Month View" org-agenda-month-view
  1718. :active (org-agenda-check-type nil 'agenda)
  1719. :style radio :selected (eq org-agenda-current-span 'month)
  1720. :keys "v m"]
  1721. ["Year View" org-agenda-year-view
  1722. :active (org-agenda-check-type nil 'agenda)
  1723. :style radio :selected (eq org-agenda-current-span 'year)
  1724. :keys "v y"]
  1725. "--"
  1726. ["Include Diary" org-agenda-toggle-diary
  1727. :style toggle :selected org-agenda-include-diary
  1728. :active (org-agenda-check-type nil 'agenda)]
  1729. ["Include Deadlines" org-agenda-toggle-deadlines
  1730. :style toggle :selected org-agenda-include-deadlines
  1731. :active (org-agenda-check-type nil 'agenda)]
  1732. ["Use Time Grid" org-agenda-toggle-time-grid
  1733. :style toggle :selected org-agenda-use-time-grid
  1734. :active (org-agenda-check-type nil 'agenda)]
  1735. "--"
  1736. ["Show clock report" org-agenda-clockreport-mode
  1737. :style toggle :selected org-agenda-clockreport-mode
  1738. :active (org-agenda-check-type nil 'agenda)]
  1739. ["Show some entry text" org-agenda-entry-text-mode
  1740. :style toggle :selected org-agenda-entry-text-mode
  1741. :active t]
  1742. "--"
  1743. ["Show Logbook entries" org-agenda-log-mode
  1744. :style toggle :selected org-agenda-show-log
  1745. :active (org-agenda-check-type nil 'agenda 'timeline)
  1746. :keys "v l (or just l)"]
  1747. ["Include archived trees" org-agenda-archives-mode
  1748. :style toggle :selected org-agenda-archives-mode :active t
  1749. :keys "v a"]
  1750. ["Include archive files" (org-agenda-archives-mode t)
  1751. :style toggle :selected (eq org-agenda-archives-mode t) :active t
  1752. :keys "v A"]
  1753. "--"
  1754. ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
  1755. ["Write view to file" org-write-agenda t]
  1756. ["Rebuild buffer" org-agenda-redo t]
  1757. ["Save all Org-mode Buffers" org-save-all-org-buffers t]
  1758. "--"
  1759. ["Show original entry" org-agenda-show t]
  1760. ["Go To (other window)" org-agenda-goto t]
  1761. ["Go To (this window)" org-agenda-switch-to t]
  1762. ["Follow Mode" org-agenda-follow-mode
  1763. :style toggle :selected org-agenda-follow-mode :active t]
  1764. ; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
  1765. "--"
  1766. ("TODO"
  1767. ["Cycle TODO" org-agenda-todo t]
  1768. ["Next TODO set" org-agenda-todo-nextset t]
  1769. ["Previous TODO set" org-agenda-todo-previousset t]
  1770. ["Add note" org-agenda-add-note t])
  1771. ("Archive/Refile/Delete"
  1772. ["Archive default" org-agenda-archive-default t]
  1773. ["Archive default" org-agenda-archive-default-with-confirmation t]
  1774. ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
  1775. ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
  1776. ["Archive subtree" org-agenda-archive t]
  1777. "--"
  1778. ["Refile" org-agenda-refile t]
  1779. "--"
  1780. ["Delete subtree" org-agenda-kill t])
  1781. ("Bulk action"
  1782. ["Mark entry" org-agenda-bulk-mark t]
  1783. ["Mark matching regexp" org-agenda-bulk-mark-regexp t]
  1784. ["Unmark entry" org-agenda-bulk-unmark t]
  1785. ["Unmark all entries" org-agenda-bulk-remove-all-marks :active t :keys "C-u s"])
  1786. ["Act on all marked" org-agenda-bulk-action t]
  1787. "--"
  1788. ("Tags and Properties"
  1789. ["Show all Tags" org-agenda-show-tags t]
  1790. ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
  1791. ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
  1792. "--"
  1793. ["Column View" org-columns t])
  1794. ("Deadline/Schedule"
  1795. ["Schedule" org-agenda-schedule t]
  1796. ["Set Deadline" org-agenda-deadline t]
  1797. "--"
  1798. ["Mark item" org-agenda-action :active t :keys "k m"]
  1799. ["Show mark item" org-agenda-action :active t :keys "k v"]
  1800. ["Schedule marked item" org-agenda-action :active t :keys "k s"]
  1801. ["Set Deadline for marked item" org-agenda-action :active t :keys "k d"]
  1802. "--"
  1803. ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
  1804. ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
  1805. ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
  1806. ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
  1807. ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
  1808. ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
  1809. ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
  1810. ("Clock and Effort"
  1811. ["Clock in" org-agenda-clock-in t]
  1812. ["Clock out" org-agenda-clock-out t]
  1813. ["Clock cancel" org-agenda-clock-cancel t]
  1814. ["Goto running clock" org-clock-goto t]
  1815. "--"
  1816. ["Set Effort" org-agenda-set-effort t]
  1817. ["Change clocked effort" org-clock-modify-effort-estimate
  1818. (org-clock-is-active)])
  1819. ("Priority"
  1820. ["Set Priority" org-agenda-priority t]
  1821. ["Increase Priority" org-agenda-priority-up t]
  1822. ["Decrease Priority" org-agenda-priority-down t]
  1823. ["Show Priority" org-agenda-show-priority t])
  1824. ("Calendar/Diary"
  1825. ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
  1826. ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
  1827. ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
  1828. ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
  1829. ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
  1830. ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
  1831. "--"
  1832. ["Create iCalendar File" org-export-icalendar-combine-agenda-files t])
  1833. "--"
  1834. ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
  1835. "--"
  1836. ("MobileOrg"
  1837. ["Push Files and Views" org-mobile-push t]
  1838. ["Get Captured and Flagged" org-mobile-pull t]
  1839. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
  1840. ["Show note / unflag" org-agenda-show-the-flagging-note t]
  1841. "--"
  1842. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  1843. "--"
  1844. ["Quit" org-agenda-quit t]
  1845. ["Exit and Release Buffers" org-agenda-exit t]
  1846. ))
  1847. ;;; Agenda undo
  1848. (defvar org-agenda-allow-remote-undo t
  1849. "Non-nil means allow remote undo from the agenda buffer.")
  1850. (defvar org-agenda-undo-list nil
  1851. "List of undoable operations in the agenda since last refresh.")
  1852. (defvar org-agenda-undo-has-started-in nil
  1853. "Buffers that have already seen `undo-start' in the current undo sequence.")
  1854. (defvar org-agenda-pending-undo-list nil
  1855. "In a series of undo commands, this is the list of remaining undo items.")
  1856. (defun org-agenda-undo ()
  1857. "Undo a remote editing step in the agenda.
  1858. This undoes changes both in the agenda buffer and in the remote buffer
  1859. that have been changed along."
  1860. (interactive)
  1861. (or org-agenda-allow-remote-undo
  1862. (error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
  1863. (if (not (eq this-command last-command))
  1864. (setq org-agenda-undo-has-started-in nil
  1865. org-agenda-pending-undo-list org-agenda-undo-list))
  1866. (if (not org-agenda-pending-undo-list)
  1867. (error "No further undo information"))
  1868. (let* ((entry (pop org-agenda-pending-undo-list))
  1869. buf line cmd rembuf)
  1870. (setq cmd (pop entry) line (pop entry))
  1871. (setq rembuf (nth 2 entry))
  1872. (org-with-remote-undo rembuf
  1873. (while (bufferp (setq buf (pop entry)))
  1874. (if (pop entry)
  1875. (with-current-buffer buf
  1876. (let ((last-undo-buffer buf)
  1877. (inhibit-read-only t))
  1878. (unless (memq buf org-agenda-undo-has-started-in)
  1879. (push buf org-agenda-undo-has-started-in)
  1880. (make-local-variable 'pending-undo-list)
  1881. (undo-start))
  1882. (while (and pending-undo-list
  1883. (listp pending-undo-list)
  1884. (not (car pending-undo-list)))
  1885. (pop pending-undo-list))
  1886. (undo-more 1))))))
  1887. (org-goto-line line)
  1888. (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
  1889. (defun org-verify-change-for-undo (l1 l2)
  1890. "Verify that a real change occurred between the undo lists L1 and L2."
  1891. (while (and l1 (listp l1) (null (car l1))) (pop l1))
  1892. (while (and l2 (listp l2) (null (car l2))) (pop l2))
  1893. (not (eq l1 l2)))
  1894. ;;; Agenda dispatch
  1895. (defvar org-agenda-restrict nil)
  1896. (defvar org-agenda-restrict-begin (make-marker))
  1897. (defvar org-agenda-restrict-end (make-marker))
  1898. (defvar org-agenda-last-dispatch-buffer nil)
  1899. (defvar org-agenda-overriding-restriction nil)
  1900. ;;;###autoload
  1901. (defun org-agenda (&optional arg keys restriction)
  1902. "Dispatch agenda commands to collect entries to the agenda buffer.
  1903. Prompts for a command to execute. Any prefix arg will be passed
  1904. on to the selected command. The default selections are:
  1905. a Call `org-agenda-list' to display the agenda for current day or week.
  1906. t Call `org-todo-list' to display the global todo list.
  1907. T Call `org-todo-list' to display the global todo list, select only
  1908. entries with a specific TODO keyword (the user gets a prompt).
  1909. m Call `org-tags-view' to display headlines with tags matching
  1910. a condition (the user is prompted for the condition).
  1911. M Like `m', but select only TODO entries, no ordinary headlines.
  1912. L Create a timeline for the current buffer.
  1913. e Export views to associated files.
  1914. s Search entries for keywords.
  1915. / Multi occur across all agenda files and also files listed
  1916. in `org-agenda-text-search-extra-files'.
  1917. < Restrict agenda commands to buffer, subtree, or region.
  1918. Press several times to get the desired effect.
  1919. > Remove a previous restriction.
  1920. # List \"stuck\" projects.
  1921. ! Configure what \"stuck\" means.
  1922. C Configure custom agenda commands.
  1923. More commands can be added by configuring the variable
  1924. `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
  1925. searches can be pre-defined in this way.
  1926. If the current buffer is in Org-mode and visiting a file, you can also
  1927. first press `<' once to indicate that the agenda should be temporarily
  1928. \(until the next use of \\[org-agenda]) restricted to the current file.
  1929. Pressing `<' twice means to restrict to the current subtree or region
  1930. \(if active)."
  1931. (interactive "P")
  1932. (catch 'exit
  1933. (let* ((prefix-descriptions nil)
  1934. (org-agenda-window-setup (if (equal (buffer-name)
  1935. org-agenda-buffer-name)
  1936. 'current-window
  1937. org-agenda-window-setup))
  1938. (org-agenda-custom-commands-orig org-agenda-custom-commands)
  1939. (org-agenda-custom-commands
  1940. ;; normalize different versions
  1941. (delq nil
  1942. (mapcar
  1943. (lambda (x)
  1944. (cond ((stringp (cdr x))
  1945. (push x prefix-descriptions)
  1946. nil)
  1947. ((stringp (nth 1 x)) x)
  1948. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  1949. (t (cons (car x) (cons "" (cdr x))))))
  1950. org-agenda-custom-commands)))
  1951. (buf (current-buffer))
  1952. (bfn (buffer-file-name (buffer-base-buffer)))
  1953. entry key type match lprops ans)
  1954. ;; Turn off restriction unless there is an overriding one,
  1955. (unless org-agenda-overriding-restriction
  1956. (unless (org-bound-and-true-p org-agenda-keep-restricted-file-list)
  1957. ;; There is a request to keep the file list in place
  1958. (put 'org-agenda-files 'org-restrict nil))
  1959. (setq org-agenda-restrict nil)
  1960. (move-marker org-agenda-restrict-begin nil)
  1961. (move-marker org-agenda-restrict-end nil))
  1962. ;; Delete old local properties
  1963. (put 'org-agenda-redo-command 'org-lprops nil)
  1964. ;; Delete previously set last-arguments
  1965. (put 'org-agenda-redo-command 'last-args nil)
  1966. ;; Remember where this call originated
  1967. (setq org-agenda-last-dispatch-buffer (current-buffer))
  1968. (unless keys
  1969. (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
  1970. keys (car ans)
  1971. restriction (cdr ans)))
  1972. ;; Establish the restriction, if any
  1973. (when (and (not org-agenda-overriding-restriction) restriction)
  1974. (put 'org-agenda-files 'org-restrict (list bfn))
  1975. (cond
  1976. ((eq restriction 'region)
  1977. (setq org-agenda-restrict t)
  1978. (move-marker org-agenda-restrict-begin (region-beginning))
  1979. (move-marker org-agenda-restrict-end (region-end)))
  1980. ((eq restriction 'subtree)
  1981. (save-excursion
  1982. (setq org-agenda-restrict t)
  1983. (org-back-to-heading t)
  1984. (move-marker org-agenda-restrict-begin (point))
  1985. (move-marker org-agenda-restrict-end
  1986. (progn (org-end-of-subtree t)))))))
  1987. ;; For example the todo list should not need it (but does...)
  1988. (cond
  1989. ((setq entry (assoc keys org-agenda-custom-commands))
  1990. (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
  1991. (progn
  1992. (setq type (nth 2 entry) match (eval (nth 3 entry))
  1993. lprops (nth 4 entry))
  1994. (put 'org-agenda-redo-command 'org-lprops lprops)
  1995. (cond
  1996. ((eq type 'agenda)
  1997. (org-let lprops '(org-agenda-list current-prefix-arg)))
  1998. ((eq type 'alltodo)
  1999. (org-let lprops '(org-todo-list current-prefix-arg)))
  2000. ((eq type 'search)
  2001. (org-let lprops '(org-search-view current-prefix-arg match nil)))
  2002. ((eq type 'stuck)
  2003. (org-let lprops '(org-agenda-list-stuck-projects
  2004. current-prefix-arg)))
  2005. ((eq type 'tags)
  2006. (org-let lprops '(org-tags-view current-prefix-arg match)))
  2007. ((eq type 'tags-todo)
  2008. (org-let lprops '(org-tags-view '(4) match)))
  2009. ((eq type 'todo)
  2010. (org-let lprops '(org-todo-list match)))
  2011. ((eq type 'tags-tree)
  2012. (org-check-for-org-mode)
  2013. (org-let lprops '(org-match-sparse-tree current-prefix-arg match)))
  2014. ((eq type 'todo-tree)
  2015. (org-check-for-org-mode)
  2016. (org-let lprops
  2017. '(org-occur (concat "^" outline-regexp "[ \t]*"
  2018. (regexp-quote match) "\\>"))))
  2019. ((eq type 'occur-tree)
  2020. (org-check-for-org-mode)
  2021. (org-let lprops '(org-occur match)))
  2022. ((functionp type)
  2023. (org-let lprops '(funcall type match)))
  2024. ((fboundp type)
  2025. (org-let lprops '(funcall type match)))
  2026. (t (error "Invalid custom agenda command type %s" type))))
  2027. (org-agenda-run-series (nth 1 entry) (cddr entry))))
  2028. ((equal keys "C")
  2029. (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
  2030. (customize-variable 'org-agenda-custom-commands))
  2031. ((equal keys "a") (call-interactively 'org-agenda-list))
  2032. ((equal keys "s") (call-interactively 'org-search-view))
  2033. ((equal keys "t") (call-interactively 'org-todo-list))
  2034. ((equal keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
  2035. ((equal keys "m") (call-interactively 'org-tags-view))
  2036. ((equal keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
  2037. ((equal keys "e") (call-interactively 'org-store-agenda-views))
  2038. ((equal keys "?") (org-tags-view nil "+FLAGGED")
  2039. (org-add-hook
  2040. 'post-command-hook
  2041. (lambda ()
  2042. (unless (current-message)
  2043. (let* ((m (org-agenda-get-any-marker))
  2044. (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
  2045. (when note
  2046. (message (concat
  2047. "FLAGGING-NOTE ([?] for more info): "
  2048. (org-add-props
  2049. (replace-regexp-in-string
  2050. "\\\\n" "//"
  2051. (copy-sequence note))
  2052. nil 'face 'org-warning)))))))
  2053. t t))
  2054. ((equal keys "L")
  2055. (unless (org-mode-p)
  2056. (error "This is not an Org-mode file"))
  2057. (unless restriction
  2058. (put 'org-agenda-files 'org-restrict (list bfn))
  2059. (org-call-with-arg 'org-timeline arg)))
  2060. ((equal keys "#") (call-interactively 'org-agenda-list-stuck-projects))
  2061. ((equal keys "/") (call-interactively 'org-occur-in-agenda-files))
  2062. ((equal keys "!") (customize-variable 'org-stuck-projects))
  2063. (t (error "Invalid agenda key"))))))
  2064. (defun org-agenda-append-agenda ()
  2065. "Append another agenda view to the current one.
  2066. This function allows interactive building of block agendas.
  2067. Agenda views are separated by `org-agenda-block-separator'."
  2068. (interactive)
  2069. (unless (string= (buffer-name) org-agenda-buffer-name)
  2070. (error "Can only append from within agenda buffer"))
  2071. (let ((org-agenda-multi t))
  2072. (org-agenda)
  2073. (widen)))
  2074. (defun org-agenda-normalize-custom-commands (cmds)
  2075. (delq nil
  2076. (mapcar
  2077. (lambda (x)
  2078. (cond ((stringp (cdr x)) nil)
  2079. ((stringp (nth 1 x)) x)
  2080. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2081. (t (cons (car x) (cons "" (cdr x))))))
  2082. cmds)))
  2083. (defun org-agenda-get-restriction-and-command (prefix-descriptions)
  2084. "The user interface for selecting an agenda command."
  2085. (catch 'exit
  2086. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  2087. (restrict-ok (and bfn (org-mode-p)))
  2088. (region-p (org-region-active-p))
  2089. (custom org-agenda-custom-commands)
  2090. (selstring "")
  2091. restriction second-time
  2092. c entry key type match prefixes rmheader header-end custom1 desc
  2093. line lines left right n n1)
  2094. (save-window-excursion
  2095. (delete-other-windows)
  2096. (org-switch-to-buffer-other-window " *Agenda Commands*")
  2097. (erase-buffer)
  2098. (insert (eval-when-compile
  2099. (let ((header
  2100. "
  2101. Press key for an agenda command: < Buffer, subtree/region restriction
  2102. -------------------------------- > Remove restriction
  2103. a Agenda for current week or day e Export agenda views
  2104. t List of all TODO entries T Entries with special TODO kwd
  2105. m Match a TAGS/PROP/TODO query M Like m, but only TODO entries
  2106. L Timeline for current buffer # List stuck projects (!=configure)
  2107. s Search for keywords C Configure custom agenda commands
  2108. / Multi-occur ? Find :FLAGGED: entries
  2109. ")
  2110. (start 0))
  2111. (while (string-match
  2112. "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
  2113. header start)
  2114. (setq start (match-end 0))
  2115. (add-text-properties (match-beginning 2) (match-end 2)
  2116. '(face bold) header))
  2117. header)))
  2118. (setq header-end (move-marker (make-marker) (point)))
  2119. (while t
  2120. (setq custom1 custom)
  2121. (when (eq rmheader t)
  2122. (org-goto-line 1)
  2123. (re-search-forward ":" nil t)
  2124. (delete-region (match-end 0) (point-at-eol))
  2125. (forward-char 1)
  2126. (looking-at "-+")
  2127. (delete-region (match-end 0) (point-at-eol))
  2128. (move-marker header-end (match-end 0)))
  2129. (goto-char header-end)
  2130. (delete-region (point) (point-max))
  2131. ;; Produce all the lines that describe custom commands and prefixes
  2132. (setq lines nil)
  2133. (while (setq entry (pop custom1))
  2134. (setq key (car entry) desc (nth 1 entry)
  2135. type (nth 2 entry)
  2136. match (nth 3 entry))
  2137. (if (> (length key) 1)
  2138. (add-to-list 'prefixes (string-to-char key))
  2139. (setq line
  2140. (format
  2141. "%-4s%-14s"
  2142. (org-add-props (copy-sequence key)
  2143. '(face bold))
  2144. (cond
  2145. ((string-match "\\S-" desc) desc)
  2146. ((eq type 'agenda) "Agenda for current week or day")
  2147. ((eq type 'alltodo) "List of all TODO entries")
  2148. ((eq type 'search) "Word search")
  2149. ((eq type 'stuck) "List of stuck projects")
  2150. ((eq type 'todo) "TODO keyword")
  2151. ((eq type 'tags) "Tags query")
  2152. ((eq type 'tags-todo) "Tags (TODO)")
  2153. ((eq type 'tags-tree) "Tags tree")
  2154. ((eq type 'todo-tree) "TODO kwd tree")
  2155. ((eq type 'occur-tree) "Occur tree")
  2156. ((functionp type) (if (symbolp type)
  2157. (symbol-name type)
  2158. "Lambda expression"))
  2159. (t "???"))))
  2160. (if org-agenda-menu-show-matcher
  2161. (setq line
  2162. (concat line ": "
  2163. (cond
  2164. ((stringp match)
  2165. (setq match (copy-sequence match))
  2166. (org-add-props match nil 'face 'org-warning))
  2167. (match
  2168. (format "set of %d commands" (length match)))
  2169. (t ""))))
  2170. (if (org-string-nw-p match)
  2171. (add-text-properties
  2172. 0 (length line) (list 'help-echo
  2173. (concat "Matcher: "match)) line)))
  2174. (push line lines)))
  2175. (setq lines (nreverse lines))
  2176. (when prefixes
  2177. (mapc (lambda (x)
  2178. (push
  2179. (format "%s %s"
  2180. (org-add-props (char-to-string x)
  2181. nil 'face 'bold)
  2182. (or (cdr (assoc (concat selstring
  2183. (char-to-string x))
  2184. prefix-descriptions))
  2185. "Prefix key"))
  2186. lines))
  2187. prefixes))
  2188. ;; Check if we should display in two columns
  2189. (if org-agenda-menu-two-column
  2190. (progn
  2191. (setq n (length lines)
  2192. n1 (+ (/ n 2) (mod n 2))
  2193. right (nthcdr n1 lines)
  2194. left (copy-sequence lines))
  2195. (setcdr (nthcdr (1- n1) left) nil))
  2196. (setq left lines right nil))
  2197. (while left
  2198. (insert "\n" (pop left))
  2199. (when right
  2200. (if (< (current-column) 40)
  2201. (move-to-column 40 t)
  2202. (insert " "))
  2203. (insert (pop right))))
  2204. ;; Make the window the right size
  2205. (goto-char (point-min))
  2206. (if second-time
  2207. (if (not (pos-visible-in-window-p (point-max)))
  2208. (org-fit-window-to-buffer))
  2209. (setq second-time t)
  2210. (org-fit-window-to-buffer))
  2211. ;; Ask for selection
  2212. (message "Press key for agenda command%s:"
  2213. (if (or restrict-ok org-agenda-overriding-restriction)
  2214. (if org-agenda-overriding-restriction
  2215. " (restriction lock active)"
  2216. (if restriction
  2217. (format " (restricted to %s)" restriction)
  2218. " (unrestricted)"))
  2219. ""))
  2220. (setq c (read-char-exclusive))
  2221. (message "")
  2222. (cond
  2223. ((assoc (char-to-string c) custom)
  2224. (setq selstring (concat selstring (char-to-string c)))
  2225. (throw 'exit (cons selstring restriction)))
  2226. ((memq c prefixes)
  2227. (setq selstring (concat selstring (char-to-string c))
  2228. prefixes nil
  2229. rmheader (or rmheader t)
  2230. custom (delq nil (mapcar
  2231. (lambda (x)
  2232. (if (or (= (length (car x)) 1)
  2233. (/= (string-to-char (car x)) c))
  2234. nil
  2235. (cons (substring (car x) 1) (cdr x))))
  2236. custom))))
  2237. ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
  2238. (message "Restriction is only possible in Org-mode buffers")
  2239. (ding) (sit-for 1))
  2240. ((eq c ?1)
  2241. (org-agenda-remove-restriction-lock 'noupdate)
  2242. (setq restriction 'buffer))
  2243. ((eq c ?0)
  2244. (org-agenda-remove-restriction-lock 'noupdate)
  2245. (setq restriction (if region-p 'region 'subtree)))
  2246. ((eq c ?<)
  2247. (org-agenda-remove-restriction-lock 'noupdate)
  2248. (setq restriction
  2249. (cond
  2250. ((eq restriction 'buffer)
  2251. (if region-p 'region 'subtree))
  2252. ((memq restriction '(subtree region))
  2253. nil)
  2254. (t 'buffer))))
  2255. ((eq c ?>)
  2256. (org-agenda-remove-restriction-lock 'noupdate)
  2257. (setq restriction nil))
  2258. ((and (equal selstring "") (memq c '(?s ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
  2259. (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
  2260. ((and (> (length selstring) 0) (eq c ?\d))
  2261. (delete-window)
  2262. (org-agenda-get-restriction-and-command prefix-descriptions))
  2263. ((equal c ?q) (error "Abort"))
  2264. (t (error "Invalid key %c" c))))))))
  2265. (defvar org-agenda-overriding-arguments nil) ; dynamically scoped parameter
  2266. (defvar org-agenda-last-arguments nil
  2267. "The arguments of the previous call to `org-agenda'.")
  2268. (defun org-agenda-run-series (name series)
  2269. (org-let (nth 1 series) '(org-prepare-agenda name))
  2270. (let* ((org-agenda-multi t)
  2271. (redo (list 'org-agenda-run-series name (list 'quote series)))
  2272. (org-agenda-overriding-arguments
  2273. (or org-agenda-overriding-arguments
  2274. (unless (null (delq nil (get 'org-agenda-redo-command 'last-args)))
  2275. (get 'org-agenda-redo-command 'last-args))))
  2276. (cmds (car series))
  2277. (gprops (nth 1 series))
  2278. match ;; The byte compiler incorrectly complains about this. Keep it!
  2279. cmd type lprops)
  2280. (while (setq cmd (pop cmds))
  2281. (setq type (car cmd) match (eval (nth 1 cmd)) lprops (nth 2 cmd))
  2282. (cond
  2283. ((eq type 'agenda)
  2284. (org-let2 gprops lprops
  2285. '(call-interactively 'org-agenda-list)))
  2286. ((eq type 'alltodo)
  2287. (org-let2 gprops lprops
  2288. '(call-interactively 'org-todo-list)))
  2289. ((eq type 'search)
  2290. (org-let2 gprops lprops
  2291. '(org-search-view current-prefix-arg match nil)))
  2292. ((eq type 'stuck)
  2293. (org-let2 gprops lprops
  2294. '(call-interactively 'org-agenda-list-stuck-projects)))
  2295. ((eq type 'tags)
  2296. (org-let2 gprops lprops
  2297. '(org-tags-view current-prefix-arg match)))
  2298. ((eq type 'tags-todo)
  2299. (org-let2 gprops lprops
  2300. '(org-tags-view '(4) match)))
  2301. ((eq type 'todo)
  2302. (org-let2 gprops lprops
  2303. '(org-todo-list match)))
  2304. ((fboundp type)
  2305. (org-let2 gprops lprops
  2306. '(funcall type match)))
  2307. (t (error "Invalid type in command series"))))
  2308. (widen)
  2309. (setq org-agenda-redo-command redo)
  2310. (put 'org-agenda-redo-command 'last-args org-agenda-last-arguments)
  2311. (goto-char (point-min)))
  2312. (org-fit-agenda-window)
  2313. (org-let (nth 1 series) '(org-finalize-agenda)))
  2314. ;;;###autoload
  2315. (defmacro org-batch-agenda (cmd-key &rest parameters)
  2316. "Run an agenda command in batch mode and send the result to STDOUT.
  2317. If CMD-KEY is a string of length 1, it is used as a key in
  2318. `org-agenda-custom-commands' and triggers this command. If it is a
  2319. longer string it is used as a tags/todo match string.
  2320. Parameters are alternating variable names and values that will be bound
  2321. before running the agenda command."
  2322. (let (pars)
  2323. (while parameters
  2324. (push (list (pop parameters) (if parameters (pop parameters))) pars))
  2325. (if (> (length cmd-key) 2)
  2326. (eval (list 'let (nreverse pars)
  2327. (list 'org-tags-view nil cmd-key)))
  2328. (eval (list 'let (nreverse pars) (list 'org-agenda nil cmd-key))))
  2329. (set-buffer org-agenda-buffer-name)
  2330. (princ (org-encode-for-stdout (buffer-string)))))
  2331. ;(defun org-encode-for-stdout (string)
  2332. ; (if (fboundp 'encode-coding-string)
  2333. ; (encode-coding-string string buffer-file-coding-system)
  2334. ; string))
  2335. (defun org-encode-for-stdout (string)
  2336. string)
  2337. (defvar org-agenda-info nil)
  2338. ;;;###autoload
  2339. (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
  2340. "Run an agenda command in batch mode and send the result to STDOUT.
  2341. If CMD-KEY is a string of length 1, it is used as a key in
  2342. `org-agenda-custom-commands' and triggers this command. If it is a
  2343. longer string it is used as a tags/todo match string.
  2344. Parameters are alternating variable names and values that will be bound
  2345. before running the agenda command.
  2346. The output gives a line for each selected agenda item. Each
  2347. item is a list of comma-separated values, like this:
  2348. category,head,type,todo,tags,date,time,extra,priority-l,priority-n
  2349. category The category of the item
  2350. head The headline, without TODO kwd, TAGS and PRIORITY
  2351. type The type of the agenda entry, can be
  2352. todo selected in TODO match
  2353. tagsmatch selected in tags match
  2354. diary imported from diary
  2355. deadline a deadline on given date
  2356. scheduled scheduled on given date
  2357. timestamp entry has timestamp on given date
  2358. closed entry was closed on given date
  2359. upcoming-deadline warning about deadline
  2360. past-scheduled forwarded scheduled item
  2361. block entry has date block including g. date
  2362. todo The todo keyword, if any
  2363. tags All tags including inherited ones, separated by colons
  2364. date The relevant date, like 2007-2-14
  2365. time The time, like 15:00-16:50
  2366. extra Sting with extra planning info
  2367. priority-l The priority letter if any was given
  2368. priority-n The computed numerical priority
  2369. agenda-day The day in the agenda where this is listed"
  2370. (let (pars)
  2371. (while parameters
  2372. (push (list (pop parameters) (if parameters (pop parameters))) pars))
  2373. (push (list 'org-agenda-remove-tags t) pars)
  2374. (if (> (length cmd-key) 2)
  2375. (eval (list 'let (nreverse pars)
  2376. (list 'org-tags-view nil cmd-key)))
  2377. (eval (list 'let (nreverse pars) (list 'org-agenda nil cmd-key))))
  2378. (set-buffer org-agenda-buffer-name)
  2379. (let* ((lines (org-split-string (buffer-string) "\n"))
  2380. line)
  2381. (while (setq line (pop lines))
  2382. (catch 'next
  2383. (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
  2384. (setq org-agenda-info
  2385. (org-fix-agenda-info (text-properties-at 0 line)))
  2386. (princ
  2387. (org-encode-for-stdout
  2388. (mapconcat 'org-agenda-export-csv-mapper
  2389. '(org-category txt type todo tags date time extra
  2390. priority-letter priority agenda-day)
  2391. ",")))
  2392. (princ "\n"))))))
  2393. (defun org-fix-agenda-info (props)
  2394. "Make sure all properties on an agenda item have a canonical form.
  2395. This ensures the export commands can easily use it."
  2396. (let (tmp re)
  2397. (when (setq tmp (plist-get props 'tags))
  2398. (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
  2399. (when (setq tmp (plist-get props 'date))
  2400. (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2401. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2402. '((format "%4d, %9s %2s, %4s" dayname monthname day year))
  2403. (setq tmp (calendar-date-string tmp)))
  2404. (setq props (plist-put props 'date tmp)))
  2405. (when (setq tmp (plist-get props 'day))
  2406. (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2407. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2408. (setq tmp (calendar-date-string tmp)))
  2409. (setq props (plist-put props 'day tmp))
  2410. (setq props (plist-put props 'agenda-day tmp)))
  2411. (when (setq tmp (plist-get props 'txt))
  2412. (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
  2413. (plist-put props 'priority-letter (match-string 1 tmp))
  2414. (setq tmp (replace-match "" t t tmp)))
  2415. (when (and (setq re (plist-get props 'org-todo-regexp))
  2416. (setq re (concat "\\`\\.*" re " ?"))
  2417. (string-match re tmp))
  2418. (plist-put props 'todo (match-string 1 tmp))
  2419. (setq tmp (replace-match "" t t tmp)))
  2420. (plist-put props 'txt tmp)))
  2421. props)
  2422. (defun org-agenda-export-csv-mapper (prop)
  2423. (let ((res (plist-get org-agenda-info prop)))
  2424. (setq res
  2425. (cond
  2426. ((not res) "")
  2427. ((stringp res) res)
  2428. (t (prin1-to-string res))))
  2429. (while (string-match "," res)
  2430. (setq res (replace-match ";" t t res)))
  2431. (org-trim res)))
  2432. ;;;###autoload
  2433. (defun org-store-agenda-views (&rest parameters)
  2434. (interactive)
  2435. (eval (list 'org-batch-store-agenda-views)))
  2436. ;; FIXME, why is this a macro?????
  2437. ;;;###autoload
  2438. (defmacro org-batch-store-agenda-views (&rest parameters)
  2439. "Run all custom agenda commands that have a file argument."
  2440. (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
  2441. (pop-up-frames nil)
  2442. (dir default-directory)
  2443. pars cmd thiscmdkey files opts cmd-or-set)
  2444. (while parameters
  2445. (push (list (pop parameters) (if parameters (pop parameters))) pars))
  2446. (setq pars (reverse pars))
  2447. (save-window-excursion
  2448. (while cmds
  2449. (setq cmd (pop cmds)
  2450. thiscmdkey (car cmd)
  2451. cmd-or-set (nth 2 cmd)
  2452. opts (nth (if (listp cmd-or-set) 3 4) cmd)
  2453. files (nth (if (listp cmd-or-set) 4 5) cmd))
  2454. (if (stringp files) (setq files (list files)))
  2455. (when files
  2456. (eval (list 'let (append org-agenda-exporter-settings opts pars)
  2457. (list 'org-agenda nil thiscmdkey)))
  2458. (set-buffer org-agenda-buffer-name)
  2459. (while files
  2460. (eval (list 'let (append org-agenda-exporter-settings opts pars)
  2461. (list 'org-write-agenda
  2462. (expand-file-name (pop files) dir) nil t))))
  2463. (and (get-buffer org-agenda-buffer-name)
  2464. (kill-buffer org-agenda-buffer-name)))))))
  2465. (defun org-agenda-mark-header-line (pos)
  2466. "Mark the line at POS as an agenda structure header."
  2467. (save-excursion
  2468. (goto-char pos)
  2469. (put-text-property (point-at-bol) (point-at-eol)
  2470. 'org-agenda-structural-header t)
  2471. (when org-agenda-title-append
  2472. (put-text-property (point-at-bol) (point-at-eol)
  2473. 'org-agenda-title-append org-agenda-title-append))))
  2474. (defvar org-mobile-creating-agendas)
  2475. (defun org-write-agenda (file &optional open nosettings)
  2476. "Write the current buffer (an agenda view) as a file.
  2477. Depending on the extension of the file name, plain text (.txt),
  2478. HTML (.html or .htm) or Postscript (.ps) is produced.
  2479. If the extension is .ics, run icalendar export over all files used
  2480. to construct the agenda and limit the export to entries listed in the
  2481. agenda now.
  2482. With prefix argument OPEN, open the new file immediately.
  2483. If NOSETTINGS is given, do not scope the settings of
  2484. `org-agenda-exporter-settings' into the export commands. This is used when
  2485. the settings have already been scoped and we do not wish to overrule other,
  2486. higher priority settings."
  2487. (interactive "FWrite agenda to file: \nP")
  2488. (if (not (file-writable-p file))
  2489. (error "Cannot write agenda to file %s" file))
  2490. (org-let (if nosettings nil org-agenda-exporter-settings)
  2491. '(save-excursion
  2492. (save-window-excursion
  2493. (org-agenda-mark-filtered-text)
  2494. (let ((bs (copy-sequence (buffer-string))) beg)
  2495. (org-agenda-unmark-filtered-text)
  2496. (with-temp-buffer
  2497. (rename-buffer "Agenda View" t)
  2498. (set-buffer-modified-p nil)
  2499. (insert bs)
  2500. (org-agenda-remove-marked-text 'org-filtered)
  2501. (while (setq beg (text-property-any (point-min) (point-max)
  2502. 'org-filtered t))
  2503. (delete-region
  2504. beg (or (next-single-property-change beg 'org-filtered)
  2505. (point-max))))
  2506. (run-hooks 'org-agenda-before-write-hook)
  2507. (cond
  2508. ((org-bound-and-true-p org-mobile-creating-agendas)
  2509. (org-mobile-write-agenda-for-mobile file))
  2510. ((string-match "\\.html?\\'" file)
  2511. (require 'htmlize)
  2512. (set-buffer (htmlize-buffer (current-buffer)))
  2513. (when (and org-agenda-export-html-style
  2514. (string-match "<style>" org-agenda-export-html-style))
  2515. ;; replace <style> section with org-agenda-export-html-style
  2516. (goto-char (point-min))
  2517. (kill-region (- (search-forward "<style") 6)
  2518. (search-forward "</style>"))
  2519. (insert org-agenda-export-html-style))
  2520. (write-file file)
  2521. (kill-buffer (current-buffer))
  2522. (message "HTML written to %s" file))
  2523. ((string-match "\\.ps\\'" file)
  2524. (require 'ps-print)
  2525. (ps-print-buffer-with-faces file)
  2526. (message "Postscript written to %s" file))
  2527. ((string-match "\\.pdf\\'" file)
  2528. (require 'ps-print)
  2529. (ps-print-buffer-with-faces
  2530. (concat (file-name-sans-extension file) ".ps"))
  2531. (call-process "ps2pdf" nil nil nil
  2532. (expand-file-name
  2533. (concat (file-name-sans-extension file) ".ps"))
  2534. (expand-file-name file))
  2535. (delete-file (concat (file-name-sans-extension file) ".ps"))
  2536. (message "PDF written to %s" file))
  2537. ((string-match "\\.ics\\'" file)
  2538. (require 'org-icalendar)
  2539. (let ((org-agenda-marker-table
  2540. (org-create-marker-find-array
  2541. (org-agenda-collect-markers)))
  2542. (org-icalendar-verify-function 'org-check-agenda-marker-table)
  2543. (org-combined-agenda-icalendar-file file))
  2544. (apply 'org-export-icalendar 'combine
  2545. (org-agenda-files nil 'ifmode))))
  2546. (t
  2547. (let ((bs (buffer-string)))
  2548. (find-file file)
  2549. (erase-buffer)
  2550. (insert bs)
  2551. (save-buffer 0)
  2552. (kill-buffer (current-buffer))
  2553. (message "Plain text written to %s" file))))))))
  2554. (set-buffer org-agenda-buffer-name))
  2555. (when open (org-open-file file)))
  2556. (defvar org-agenda-filter-overlays nil)
  2557. (defun org-agenda-mark-filtered-text ()
  2558. "Mark all text hidden by filtering with a text property."
  2559. (let ((inhibit-read-only t))
  2560. (mapc
  2561. (lambda (o)
  2562. (when (equal (overlay-buffer o) (current-buffer))
  2563. (put-text-property
  2564. (overlay-start o) (overlay-end o)
  2565. 'org-filtered t)))
  2566. org-agenda-filter-overlays)))
  2567. (defun org-agenda-unmark-filtered-text ()
  2568. "Remove the filtering text property."
  2569. (let ((inhibit-read-only t))
  2570. (remove-text-properties (point-min) (point-max) '(org-filtered t))))
  2571. (defun org-agenda-remove-marked-text (property &optional value)
  2572. "Delete all text marked with VALUE of PROPERTY.
  2573. VALUE defaults to t."
  2574. (let (beg)
  2575. (setq value (or value t))
  2576. (while (setq beg (text-property-any (point-min) (point-max)
  2577. property value))
  2578. (delete-region
  2579. beg (or (next-single-property-change beg 'org-filtered)
  2580. (point-max))))))
  2581. (defun org-agenda-add-entry-text ()
  2582. "Add entry text to agenda lines.
  2583. This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
  2584. entry text following headings shown in the agenda.
  2585. Drawers will be excluded, also the line with scheduling/deadline info."
  2586. (when (and (> org-agenda-add-entry-text-maxlines 0)
  2587. (not (org-bound-and-true-p org-mobile-creating-agendas)))
  2588. (let (m txt)
  2589. (goto-char (point-min))
  2590. (while (not (eobp))
  2591. (if (not (setq m (org-get-at-bol 'org-hd-marker)))
  2592. (beginning-of-line 2)
  2593. (setq txt (org-agenda-get-some-entry-text
  2594. m org-agenda-add-entry-text-maxlines " > "))
  2595. (end-of-line 1)
  2596. (if (string-match "\\S-" txt)
  2597. (insert "\n" txt)
  2598. (or (eobp) (forward-char 1))))))))
  2599. (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
  2600. &rest keep)
  2601. "Extract entry text from MARKER, at most N-LINES lines.
  2602. This will ignore drawers etc, just get the text.
  2603. If INDENT is given, prefix every line with this string. If KEEP is
  2604. given, it is a list of symbols, defining stuff that should not be
  2605. removed from the entry content. Currently only `planning' is allowed here."
  2606. (let (txt drawer-re kwd-time-re ind)
  2607. (save-excursion
  2608. (with-current-buffer (marker-buffer marker)
  2609. (if (not (org-mode-p))
  2610. (setq txt "")
  2611. (save-excursion
  2612. (save-restriction
  2613. (widen)
  2614. (goto-char marker)
  2615. (end-of-line 1)
  2616. (setq txt (buffer-substring
  2617. (min (1+ (point)) (point-max))
  2618. (progn (outline-next-heading) (point)))
  2619. drawer-re org-drawer-regexp
  2620. kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
  2621. ".*\n?"))
  2622. (with-temp-buffer
  2623. (insert txt)
  2624. (when org-agenda-add-entry-text-descriptive-links
  2625. (goto-char (point-min))
  2626. (while (org-activate-bracket-links (point-max))
  2627. (add-text-properties (match-beginning 0) (match-end 0)
  2628. '(face org-link))))
  2629. (goto-char (point-min))
  2630. (while (re-search-forward org-bracket-link-regexp (point-max) t)
  2631. (set-text-properties (match-beginning 0) (match-end 0)
  2632. nil))
  2633. (goto-char (point-min))
  2634. (while (re-search-forward drawer-re nil t)
  2635. (delete-region
  2636. (match-beginning 0)
  2637. (progn (re-search-forward
  2638. "^[ \t]*:END:.*\n?" nil 'move)
  2639. (point))))
  2640. (unless (member 'planning keep)
  2641. (goto-char (point-min))
  2642. (while (re-search-forward kwd-time-re nil t)
  2643. (replace-match "")))
  2644. (goto-char (point-min))
  2645. (when org-agenda-entry-text-exclude-regexps
  2646. (let ((re-list org-agenda-entry-text-exclude-regexps) re)
  2647. (while (setq re (pop re-list))
  2648. (goto-char (point-min))
  2649. (while (re-search-forward re nil t)
  2650. (replace-match "")))))
  2651. (goto-char (point-max))
  2652. (skip-chars-backward " \t\n")
  2653. (if (looking-at "[ \t\n]+\\'") (replace-match ""))
  2654. ;; find and remove min common indentation
  2655. (goto-char (point-min))
  2656. (untabify (point-min) (point-max))
  2657. (setq ind (org-get-indentation))
  2658. (while (not (eobp))
  2659. (unless (looking-at "[ \t]*$")
  2660. (setq ind (min ind (org-get-indentation))))
  2661. (beginning-of-line 2))
  2662. (goto-char (point-min))
  2663. (while (not (eobp))
  2664. (unless (looking-at "[ \t]*$")
  2665. (move-to-column ind)
  2666. (delete-region (point-at-bol) (point)))
  2667. (beginning-of-line 2))
  2668. (run-hooks 'org-agenda-entry-text-cleanup-hook)
  2669. (goto-char (point-min))
  2670. (when indent
  2671. (while (and (not (eobp)) (re-search-forward "^" nil t))
  2672. (replace-match indent t t)))
  2673. (goto-char (point-min))
  2674. (while (looking-at "[ \t]*\n") (replace-match ""))
  2675. (goto-char (point-max))
  2676. (when (> (org-current-line)
  2677. n-lines)
  2678. (org-goto-line (1+ n-lines))
  2679. (backward-char 1))
  2680. (setq txt (buffer-substring (point-min) (point)))))))))
  2681. txt))
  2682. (defun org-agenda-collect-markers ()
  2683. "Collect the markers pointing to entries in the agenda buffer."
  2684. (let (m markers)
  2685. (save-excursion
  2686. (goto-char (point-min))
  2687. (while (not (eobp))
  2688. (when (setq m (or (org-get-at-bol 'org-hd-marker)
  2689. (org-get-at-bol 'org-marker)))
  2690. (push m markers))
  2691. (beginning-of-line 2)))
  2692. (nreverse markers)))
  2693. (defun org-create-marker-find-array (marker-list)
  2694. "Create a alist of files names with all marker positions in that file."
  2695. (let (f tbl m a p)
  2696. (while (setq m (pop marker-list))
  2697. (setq p (marker-position m)
  2698. f (buffer-file-name (or (buffer-base-buffer
  2699. (marker-buffer m))
  2700. (marker-buffer m))))
  2701. (if (setq a (assoc f tbl))
  2702. (push (marker-position m) (cdr a))
  2703. (push (list f p) tbl)))
  2704. (mapcar (lambda (x) (setcdr x (sort (copy-sequence (cdr x)) '<)) x)
  2705. tbl)))
  2706. (defvar org-agenda-marker-table nil) ; dynamically scoped parameter
  2707. (defun org-check-agenda-marker-table ()
  2708. "Check of the current entry is on the marker list."
  2709. (let ((file (buffer-file-name (or (buffer-base-buffer) (current-buffer))))
  2710. a)
  2711. (and (setq a (assoc file org-agenda-marker-table))
  2712. (save-match-data
  2713. (save-excursion
  2714. (org-back-to-heading t)
  2715. (member (point) (cdr a)))))))
  2716. (defun org-check-for-org-mode ()
  2717. "Make sure current buffer is in org-mode. Error if not."
  2718. (or (org-mode-p)
  2719. (error "Cannot execute org-mode agenda command on buffer in %s"
  2720. major-mode)))
  2721. (defun org-fit-agenda-window ()
  2722. "Fit the window to the buffer size."
  2723. (and (memq org-agenda-window-setup '(reorganize-frame))
  2724. (fboundp 'fit-window-to-buffer)
  2725. (org-fit-window-to-buffer
  2726. nil
  2727. (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
  2728. (floor (* (frame-height) (car org-agenda-window-frame-fractions))))))
  2729. ;;; Agenda prepare and finalize
  2730. (defvar org-agenda-multi nil) ; dynamically scoped
  2731. (defvar org-agenda-buffer-name "*Org Agenda*")
  2732. (defvar org-pre-agenda-window-conf nil)
  2733. (defvar org-agenda-columns-active nil)
  2734. (defvar org-agenda-name nil)
  2735. (defvar org-agenda-filter nil)
  2736. (defvar org-agenda-filter-while-redo nil)
  2737. (defvar org-agenda-filter-preset nil
  2738. "A preset of the tags filter used for secondary agenda filtering.
  2739. This must be a list of strings, each string must be a single tag preceded
  2740. by \"+\" or \"-\".
  2741. This variable should not be set directly, but agenda custom commands can
  2742. bind it in the options section. The preset filter is a global property of
  2743. the entire agenda view. In a block agenda, it will not work reliably to
  2744. define a filter for one of the individual blocks. You need to set it in
  2745. the global options and expect it to be applied to the entire view.")
  2746. (defun org-prepare-agenda (&optional name)
  2747. (setq org-todo-keywords-for-agenda nil)
  2748. (setq org-done-keywords-for-agenda nil)
  2749. (setq org-drawers-for-agenda nil)
  2750. (unless org-agenda-persistent-filter
  2751. (setq org-agenda-filter nil))
  2752. (put 'org-agenda-filter :preset-filter org-agenda-filter-preset)
  2753. (if org-agenda-multi
  2754. (progn
  2755. (setq buffer-read-only nil)
  2756. (goto-char (point-max))
  2757. (unless (or (bobp) org-agenda-compact-blocks)
  2758. (insert "\n"
  2759. (if (stringp org-agenda-block-separator)
  2760. org-agenda-block-separator
  2761. (make-string (window-width) org-agenda-block-separator))
  2762. "\n"))
  2763. (narrow-to-region (point) (point-max)))
  2764. (org-agenda-reset-markers)
  2765. (setq org-agenda-contributing-files nil)
  2766. (setq org-agenda-columns-active nil)
  2767. (org-prepare-agenda-buffers (org-agenda-files nil 'ifmode))
  2768. (setq org-todo-keywords-for-agenda
  2769. (org-uniquify org-todo-keywords-for-agenda))
  2770. (setq org-done-keywords-for-agenda
  2771. (org-uniquify org-done-keywords-for-agenda))
  2772. (setq org-drawers-for-agenda (org-uniquify org-drawers-for-agenda))
  2773. (let* ((abuf (get-buffer-create org-agenda-buffer-name))
  2774. (awin (get-buffer-window abuf)))
  2775. (cond
  2776. ((equal (current-buffer) abuf) nil)
  2777. (awin (select-window awin))
  2778. ((not (setq org-pre-agenda-window-conf (current-window-configuration))))
  2779. ((equal org-agenda-window-setup 'current-window)
  2780. (switch-to-buffer abuf))
  2781. ((equal org-agenda-window-setup 'other-window)
  2782. (org-switch-to-buffer-other-window abuf))
  2783. ((equal org-agenda-window-setup 'other-frame)
  2784. (switch-to-buffer-other-frame abuf))
  2785. ((equal org-agenda-window-setup 'reorganize-frame)
  2786. (delete-other-windows)
  2787. (org-switch-to-buffer-other-window abuf)))
  2788. ;; additional test in case agenda is invoked from within agenda
  2789. ;; buffer via elisp link
  2790. (unless (equal (current-buffer) abuf)
  2791. (switch-to-buffer abuf)))
  2792. (setq buffer-read-only nil)
  2793. (let ((inhibit-read-only t)) (erase-buffer))
  2794. (org-agenda-mode)
  2795. (and name (not org-agenda-name)
  2796. (org-set-local 'org-agenda-name name)))
  2797. (setq buffer-read-only nil))
  2798. (defun org-finalize-agenda ()
  2799. "Finishing touch for the agenda buffer, called just before displaying it."
  2800. (unless org-agenda-multi
  2801. (save-excursion
  2802. (let ((inhibit-read-only t))
  2803. (goto-char (point-min))
  2804. (while (org-activate-bracket-links (point-max))
  2805. (add-text-properties (match-beginning 0) (match-end 0)
  2806. '(face org-link)))
  2807. (org-agenda-align-tags)
  2808. (unless org-agenda-with-colors
  2809. (remove-text-properties (point-min) (point-max) '(face nil))))
  2810. (if (and (boundp 'org-agenda-overriding-columns-format)
  2811. org-agenda-overriding-columns-format)
  2812. (org-set-local 'org-agenda-overriding-columns-format
  2813. org-agenda-overriding-columns-format))
  2814. (if (and (boundp 'org-agenda-view-columns-initially)
  2815. org-agenda-view-columns-initially)
  2816. (org-agenda-columns))
  2817. (when org-agenda-fontify-priorities
  2818. (org-agenda-fontify-priorities))
  2819. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  2820. (org-agenda-dim-blocked-tasks))
  2821. (org-agenda-mark-clocking-task)
  2822. (when org-agenda-entry-text-mode
  2823. (org-agenda-entry-text-hide)
  2824. (org-agenda-entry-text-show))
  2825. (if (functionp 'org-habit-insert-consistency-graphs)
  2826. (org-habit-insert-consistency-graphs))
  2827. (run-hooks 'org-finalize-agenda-hook)
  2828. (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
  2829. (when (or org-agenda-filter (get 'org-agenda-filter :preset-filter))
  2830. (org-agenda-filter-apply org-agenda-filter))
  2831. )))
  2832. (defun org-agenda-mark-clocking-task ()
  2833. "Mark the current clock entry in the agenda if it is present."
  2834. (mapc (lambda (o)
  2835. (if (eq (overlay-get o 'type) 'org-agenda-clocking)
  2836. (delete-overlay o)))
  2837. (overlays-in (point-min) (point-max)))
  2838. (when (marker-buffer org-clock-hd-marker)
  2839. (save-excursion
  2840. (goto-char (point-min))
  2841. (let (s ov)
  2842. (while (setq s (next-single-property-change (point) 'org-hd-marker))
  2843. (goto-char s)
  2844. (when (equal (org-get-at-bol 'org-hd-marker)
  2845. org-clock-hd-marker)
  2846. (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
  2847. (overlay-put ov 'type 'org-agenda-clocking)
  2848. (overlay-put ov 'face 'org-agenda-clocking)
  2849. (overlay-put ov 'help-echo
  2850. "The clock is running in this item")))))))
  2851. (defun org-agenda-fontify-priorities ()
  2852. "Make highest priority lines bold, and lowest italic."
  2853. (interactive)
  2854. (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
  2855. (delete-overlay o)))
  2856. (overlays-in (point-min) (point-max)))
  2857. (save-excursion
  2858. (let ((inhibit-read-only t)
  2859. b e p ov h l)
  2860. (goto-char (point-min))
  2861. (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
  2862. (setq h (or (get-char-property (point) 'org-highest-priority)
  2863. org-highest-priority)
  2864. l (or (get-char-property (point) 'org-lowest-priority)
  2865. org-lowest-priority)
  2866. p (string-to-char (match-string 1))
  2867. b (match-beginning 0)
  2868. e (if (eq org-agenda-fontify-priorities 'cookies)
  2869. (match-end 0)
  2870. (point-at-eol))
  2871. ov (make-overlay b e))
  2872. (overlay-put
  2873. ov 'face
  2874. (cond ((org-face-from-face-or-color
  2875. 'priority nil
  2876. (cdr (assoc p org-priority-faces))))
  2877. ((and (listp org-agenda-fontify-priorities)
  2878. (org-face-from-face-or-color
  2879. 'priority nil
  2880. (cdr (assoc p org-agenda-fontify-priorities)))))
  2881. ((equal p l) 'italic)
  2882. ((equal p h) 'bold)))
  2883. (overlay-put ov 'org-type 'org-priority)))))
  2884. (defun org-agenda-dim-blocked-tasks ()
  2885. "Dim currently blocked TODO's in the agenda display."
  2886. (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-blocked-todo)
  2887. (delete-overlay o)))
  2888. (overlays-in (point-min) (point-max)))
  2889. (save-excursion
  2890. (let ((inhibit-read-only t)
  2891. (org-depend-tag-blocked nil)
  2892. (invis (eq org-agenda-dim-blocked-tasks 'invisible))
  2893. org-blocked-by-checkboxes
  2894. invis1 b e p ov h l)
  2895. (goto-char (point-min))
  2896. (while (let ((pos (next-single-property-change (point) 'todo-state)))
  2897. (and pos (goto-char (1+ pos))))
  2898. (setq org-blocked-by-checkboxes nil invis1 invis)
  2899. (let ((marker (org-get-at-bol 'org-hd-marker)))
  2900. (when (and marker
  2901. (not (with-current-buffer (marker-buffer marker)
  2902. (save-excursion
  2903. (goto-char marker)
  2904. (if (org-entry-get nil "NOBLOCKING")
  2905. t ;; Never block this entry
  2906. (run-hook-with-args-until-failure
  2907. 'org-blocker-hook
  2908. (list :type 'todo-state-change
  2909. :position marker
  2910. :from 'todo
  2911. :to 'done)))))))
  2912. (if org-blocked-by-checkboxes (setq invis1 nil))
  2913. (setq b (if invis1
  2914. (max (point-min) (1- (point-at-bol)))
  2915. (point-at-bol))
  2916. e (point-at-eol)
  2917. ov (make-overlay b e))
  2918. (if invis1
  2919. (overlay-put ov 'invisible t)
  2920. (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
  2921. (overlay-put ov 'org-type 'org-blocked-todo)))))))
  2922. (defvar org-agenda-skip-function nil
  2923. "Function to be called at each match during agenda construction.
  2924. If this function returns nil, the current match should not be skipped.
  2925. Otherwise, the function must return a position from where the search
  2926. should be continued.
  2927. This may also be a Lisp form, it will be evaluated.
  2928. Never set this variable using `setq' or so, because then it will apply
  2929. to all future agenda commands. If you do want a global skipping condition,
  2930. use the option `org-agenda-skip-function-global' instead.
  2931. The correct usage for `org-agenda-skip-function' is to bind it with
  2932. `let' to scope it dynamically into the agenda-constructing command.
  2933. A good way to set it is through options in `org-agenda-custom-commands'.")
  2934. (defun org-agenda-skip ()
  2935. "Throw to `:skip' in places that should be skipped.
  2936. Also moves point to the end of the skipped region, so that search can
  2937. continue from there."
  2938. (let ((p (point-at-bol)) to)
  2939. (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
  2940. (get-text-property p :org-archived)
  2941. (org-end-of-subtree t)
  2942. (throw :skip t))
  2943. (and org-agenda-skip-comment-trees
  2944. (get-text-property p :org-comment)
  2945. (org-end-of-subtree t)
  2946. (throw :skip t))
  2947. (if (equal (char-after p) ?#) (throw :skip t))
  2948. (when (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
  2949. (org-agenda-skip-eval org-agenda-skip-function)))
  2950. (goto-char to)
  2951. (throw :skip t))))
  2952. (defun org-agenda-skip-eval (form)
  2953. "If FORM is a function or a list, call (or eval) is and return result.
  2954. `save-excursion' and `save-match-data' are wrapped around the call, so point
  2955. and match data are returned to the previous state no matter what these
  2956. functions do."
  2957. (let (fp)
  2958. (and form
  2959. (or (setq fp (functionp form))
  2960. (consp form))
  2961. (save-excursion
  2962. (save-match-data
  2963. (if fp
  2964. (funcall form)
  2965. (eval form)))))))
  2966. (defvar org-agenda-markers nil
  2967. "List of all currently active markers created by `org-agenda'.")
  2968. (defvar org-agenda-last-marker-time (org-float-time)
  2969. "Creation time of the last agenda marker.")
  2970. (defun org-agenda-new-marker (&optional pos)
  2971. "Return a new agenda marker.
  2972. Org-mode keeps a list of these markers and resets them when they are
  2973. no longer in use."
  2974. (let ((m (copy-marker (or pos (point)))))
  2975. (setq org-agenda-last-marker-time (org-float-time))
  2976. (push m org-agenda-markers)
  2977. m))
  2978. (defun org-agenda-reset-markers ()
  2979. "Reset markers created by `org-agenda'."
  2980. (while org-agenda-markers
  2981. (move-marker (pop org-agenda-markers) nil)))
  2982. (defun org-agenda-save-markers-for-cut-and-paste (beg end)
  2983. "Save relative positions of markers in region."
  2984. (mapc (lambda (m) (org-check-and-save-marker m beg end))
  2985. org-agenda-markers))
  2986. ;;; Entry text mode
  2987. (defun org-agenda-entry-text-show-here ()
  2988. "Add some text from the entry as context to the current line."
  2989. (let (m txt o)
  2990. (setq m (org-get-at-bol 'org-hd-marker))
  2991. (unless (marker-buffer m)
  2992. (error "No marker points to an entry here"))
  2993. (setq txt (concat "\n" (org-no-properties
  2994. (org-agenda-get-some-entry-text
  2995. m org-agenda-entry-text-maxlines " > "))))
  2996. (when (string-match "\\S-" txt)
  2997. (setq o (make-overlay (point-at-bol) (point-at-eol)))
  2998. (overlay-put o 'evaporate t)
  2999. (overlay-put o 'org-overlay-type 'agenda-entry-content)
  3000. (overlay-put o 'after-string txt))))
  3001. (defun org-agenda-entry-text-show ()
  3002. "Add entry context for all agenda lines."
  3003. (interactive)
  3004. (save-excursion
  3005. (goto-char (point-max))
  3006. (beginning-of-line 1)
  3007. (while (not (bobp))
  3008. (when (org-get-at-bol 'org-hd-marker)
  3009. (org-agenda-entry-text-show-here))
  3010. (beginning-of-line 0))))
  3011. (defun org-agenda-entry-text-hide ()
  3012. "Remove any shown entry context."
  3013. (delq nil
  3014. (mapcar (lambda (o)
  3015. (if (eq (overlay-get o 'org-overlay-type)
  3016. 'agenda-entry-content)
  3017. (progn (delete-overlay o) t)))
  3018. (overlays-in (point-min) (point-max)))))
  3019. (defun org-agenda-get-day-face (date)
  3020. "Return the face DATE should be displayed with."
  3021. (or (and (functionp org-agenda-day-face-function)
  3022. (funcall org-agenda-day-face-function date))
  3023. (cond ((org-agenda-todayp date)
  3024. 'org-agenda-date-today)
  3025. ((member (calendar-day-of-week date) org-agenda-weekend-days)
  3026. 'org-agenda-date-weekend)
  3027. (t 'org-agenda-date))))
  3028. ;;; Agenda timeline
  3029. (defvar org-agenda-only-exact-dates nil) ; dynamically scoped
  3030. (defun org-timeline (&optional include-all)
  3031. "Show a time-sorted view of the entries in the current org file.
  3032. Only entries with a time stamp of today or later will be listed. With
  3033. \\[universal-argument] prefix, all unfinished TODO items will also be shown,
  3034. under the current date.
  3035. If the buffer contains an active region, only check the region for
  3036. dates."
  3037. (interactive "P")
  3038. (org-compile-prefix-format 'timeline)
  3039. (org-set-sorting-strategy 'timeline)
  3040. (let* ((dopast t)
  3041. (dotodo include-all)
  3042. (doclosed org-agenda-show-log)
  3043. (entry (buffer-file-name (or (buffer-base-buffer (current-buffer))
  3044. (current-buffer))))
  3045. (date (calendar-current-date))
  3046. (beg (if (org-region-active-p) (region-beginning) (point-min)))
  3047. (end (if (org-region-active-p) (region-end) (point-max)))
  3048. (day-numbers (org-get-all-dates beg end 'no-ranges
  3049. t doclosed ; always include today
  3050. org-timeline-show-empty-dates))
  3051. (org-deadline-warning-days 0)
  3052. (org-agenda-only-exact-dates t)
  3053. (today (org-today))
  3054. (past t)
  3055. args
  3056. s e rtn d emptyp)
  3057. (setq org-agenda-redo-command
  3058. (list 'progn
  3059. (list 'org-switch-to-buffer-other-window (current-buffer))
  3060. (list 'org-timeline (list 'quote include-all))))
  3061. (if (not dopast)
  3062. ;; Remove past dates from the list of dates.
  3063. (setq day-numbers (delq nil (mapcar (lambda(x)
  3064. (if (>= x today) x nil))
  3065. day-numbers))))
  3066. (org-prepare-agenda (concat "Timeline " (file-name-nondirectory entry)))
  3067. (if doclosed (push :closed args))
  3068. (push :timestamp args)
  3069. (push :deadline args)
  3070. (push :scheduled args)
  3071. (push :sexp args)
  3072. (if dotodo (push :todo args))
  3073. (insert "Timeline of file " entry "\n")
  3074. (add-text-properties (point-min) (point)
  3075. (list 'face 'org-agenda-structure))
  3076. (org-agenda-mark-header-line (point-min))
  3077. (while (setq d (pop day-numbers))
  3078. (if (and (listp d) (eq (car d) :omitted))
  3079. (progn
  3080. (setq s (point))
  3081. (insert (format "\n[... %d empty days omitted]\n\n" (cdr d)))
  3082. (put-text-property s (1- (point)) 'face 'org-agenda-structure))
  3083. (if (listp d) (setq d (car d) emptyp t) (setq emptyp nil))
  3084. (if (and (>= d today)
  3085. dopast
  3086. past)
  3087. (progn
  3088. (setq past nil)
  3089. (insert (make-string 79 ?-) "\n")))
  3090. (setq date (calendar-gregorian-from-absolute d))
  3091. (setq s (point))
  3092. (setq rtn (and (not emptyp)
  3093. (apply 'org-agenda-get-day-entries entry
  3094. date args)))
  3095. (if (or rtn (equal d today) org-timeline-show-empty-dates)
  3096. (progn
  3097. (insert
  3098. (if (stringp org-agenda-format-date)
  3099. (format-time-string org-agenda-format-date
  3100. (org-time-from-absolute date))
  3101. (funcall org-agenda-format-date date))
  3102. "\n")
  3103. (put-text-property s (1- (point)) 'face
  3104. (org-agenda-get-day-face date))
  3105. (put-text-property s (1- (point)) 'org-date-line t)
  3106. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3107. (if (equal d today)
  3108. (put-text-property s (1- (point)) 'org-today t))
  3109. (and rtn (insert (org-finalize-agenda-entries rtn) "\n"))
  3110. (put-text-property s (1- (point)) 'day d)))))
  3111. (goto-char (point-min))
  3112. (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
  3113. (point-min)))
  3114. (add-text-properties (point-min) (point-max) '(org-agenda-type timeline))
  3115. (org-finalize-agenda)
  3116. (setq buffer-read-only t)))
  3117. (defun org-get-all-dates (beg end &optional no-ranges force-today inactive empty pre-re)
  3118. "Return a list of all relevant day numbers from BEG to END buffer positions.
  3119. If NO-RANGES is non-nil, include only the start and end dates of a range,
  3120. not every single day in the range. If FORCE-TODAY is non-nil, make
  3121. sure that TODAY is included in the list. If INACTIVE is non-nil, also
  3122. inactive time stamps (those in square brackets) are included.
  3123. When EMPTY is non-nil, also include days without any entries."
  3124. (let ((re (concat
  3125. (if pre-re pre-re "")
  3126. (if inactive org-ts-regexp-both org-ts-regexp)))
  3127. dates dates1 date day day1 day2 ts1 ts2)
  3128. (if force-today
  3129. (setq dates (list (org-today))))
  3130. (save-excursion
  3131. (goto-char beg)
  3132. (while (re-search-forward re end t)
  3133. (setq day (time-to-days (org-time-string-to-time
  3134. (substring (match-string 1) 0 10))))
  3135. (or (memq day dates) (push day dates)))
  3136. (unless no-ranges
  3137. (goto-char beg)
  3138. (while (re-search-forward org-tr-regexp end t)
  3139. (setq ts1 (substring (match-string 1) 0 10)
  3140. ts2 (substring (match-string 2) 0 10)
  3141. day1 (time-to-days (org-time-string-to-time ts1))
  3142. day2 (time-to-days (org-time-string-to-time ts2)))
  3143. (while (< (setq day1 (1+ day1)) day2)
  3144. (or (memq day1 dates) (push day1 dates)))))
  3145. (setq dates (sort dates '<))
  3146. (when empty
  3147. (while (setq day (pop dates))
  3148. (setq day2 (car dates))
  3149. (push day dates1)
  3150. (when (and day2 empty)
  3151. (if (or (eq empty t)
  3152. (and (numberp empty) (<= (- day2 day) empty)))
  3153. (while (< (setq day (1+ day)) day2)
  3154. (push (list day) dates1))
  3155. (push (cons :omitted (- day2 day)) dates1))))
  3156. (setq dates (nreverse dates1)))
  3157. dates)))
  3158. ;;; Agenda Daily/Weekly
  3159. (defvar org-agenda-start-day nil ; dynamically scoped parameter
  3160. "Start day for the agenda view.
  3161. Custom commands can set this variable in the options section.")
  3162. (defvar org-starting-day nil) ; local variable in the agenda buffer
  3163. (defvar org-agenda-current-span nil
  3164. "The current span used in the agenda view.") ; local variable in the agenda buffer
  3165. (defvar org-include-all-loc nil) ; local variable
  3166. (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
  3167. "List of types searched for when creating the daily/weekly agenda.
  3168. This variable is a list of symbols that controls the types of
  3169. items that appear in the daily/weekly agenda. Allowed symbols in this
  3170. list are are
  3171. :timestamp List items containing a date stamp or date range matching
  3172. the selected date. This includes sexp entries in
  3173. angular brackets.
  3174. :sexp List entries resulting from plain diary-like sexps.
  3175. :deadline List deadline due on that date. When the date is today,
  3176. also list any deadlines past due, or due within
  3177. `org-deadline-warning-days'. `:deadline' must appear before
  3178. `:scheduled' if the setting of
  3179. `org-agenda-skip-scheduled-if-deadline-is-shown' is to have
  3180. any effect.
  3181. :scheduled List all items which are scheduled for the given date.
  3182. The diary for *today* also contains items which were
  3183. scheduled earlier and are not yet marked DONE.
  3184. By default, all four types are turned on.
  3185. Never set this variable globally using `setq', because then it
  3186. will apply to all future agenda commands. Instead, bind it with
  3187. `let' to scope it dynamically into the agenda-constructing
  3188. command. A good way to set it is through options in
  3189. `org-agenda-custom-commands'. For a more flexible (though
  3190. somewhat less efficient) way of determining what is included in
  3191. the daily/weekly agenda, see `org-agenda-skip-function'.")
  3192. ;;;###autoload
  3193. (defun org-agenda-list (&optional include-all start-day span)
  3194. "Produce a daily/weekly view from all files in variable `org-agenda-files'.
  3195. The view will be for the current day or week, but from the overview buffer
  3196. you will be able to go to other days/weeks.
  3197. With a numeric prefix argument in an interactive call, the agenda will
  3198. span INCLUDE-ALL days. Lisp programs should instead specify SPAN to change
  3199. the number of days. SPAN defaults to `org-agenda-span'.
  3200. START-DAY defaults to TODAY, or to the most recent match for the weekday
  3201. given in `org-agenda-start-on-weekday'."
  3202. (interactive "P")
  3203. (if (and (integerp include-all) (> include-all 0))
  3204. (setq span include-all include-all nil))
  3205. (setq start-day (or start-day org-agenda-start-day))
  3206. (if org-agenda-overriding-arguments
  3207. (setq include-all (car org-agenda-overriding-arguments)
  3208. start-day (nth 1 org-agenda-overriding-arguments)
  3209. span (nth 2 org-agenda-overriding-arguments)))
  3210. (if (stringp start-day)
  3211. ;; Convert to an absolute day number
  3212. (setq start-day (time-to-days (org-read-date nil t start-day))))
  3213. (setq org-agenda-last-arguments (list include-all start-day span))
  3214. (org-compile-prefix-format 'agenda)
  3215. (org-set-sorting-strategy 'agenda)
  3216. (let* ((span (org-agenda-ndays-to-span
  3217. (or span org-agenda-ndays org-agenda-span)))
  3218. (today (org-today))
  3219. (sd (or start-day today))
  3220. (ndays (org-agenda-span-to-ndays span sd))
  3221. (org-agenda-start-on-weekday
  3222. (if (eq ndays 7)
  3223. org-agenda-start-on-weekday))
  3224. (thefiles (org-agenda-files nil 'ifmode))
  3225. (files thefiles)
  3226. (start (if (or (null org-agenda-start-on-weekday)
  3227. (< ndays 7))
  3228. sd
  3229. (let* ((nt (calendar-day-of-week
  3230. (calendar-gregorian-from-absolute sd)))
  3231. (n1 org-agenda-start-on-weekday)
  3232. (d (- nt n1)))
  3233. (- sd (+ (if (< d 0) 7 0) d)))))
  3234. (day-numbers (list start))
  3235. (day-cnt 0)
  3236. (inhibit-redisplay (not debug-on-error))
  3237. s e rtn rtnall file date d start-pos end-pos todayp
  3238. clocktable-start clocktable-end filter)
  3239. (setq org-agenda-redo-command
  3240. (list 'org-agenda-list (list 'quote include-all) start-day (list 'quote span)))
  3241. (dotimes (n (1- ndays))
  3242. (push (1+ (car day-numbers)) day-numbers))
  3243. (setq day-numbers (nreverse day-numbers))
  3244. (setq clocktable-start (car day-numbers)
  3245. clocktable-end (1+ (or (org-last day-numbers) 0)))
  3246. (org-prepare-agenda "Day/Week")
  3247. (org-set-local 'org-starting-day (car day-numbers))
  3248. (org-set-local 'org-include-all-loc include-all)
  3249. (org-set-local 'org-agenda-current-span (org-agenda-ndays-to-span span))
  3250. (unless org-agenda-compact-blocks
  3251. (let* ((d1 (car day-numbers))
  3252. (d2 (org-last day-numbers))
  3253. (w1 (org-days-to-iso-week d1))
  3254. (w2 (org-days-to-iso-week d2)))
  3255. (setq s (point))
  3256. (if org-agenda-overriding-header
  3257. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  3258. nil 'face 'org-agenda-structure) "\n")
  3259. (insert (org-agenda-span-name span)
  3260. "-agenda"
  3261. (if (< (- d2 d1) 350)
  3262. (if (= w1 w2)
  3263. (format " (W%02d)" w1)
  3264. (format " (W%02d-W%02d)" w1 w2))
  3265. "")
  3266. ":\n")))
  3267. (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
  3268. 'org-date-line t))
  3269. (org-agenda-mark-header-line s))
  3270. (while (setq d (pop day-numbers))
  3271. (setq date (calendar-gregorian-from-absolute d)
  3272. s (point))
  3273. (if (or (setq todayp (= d today))
  3274. (and (not start-pos) (= d sd)))
  3275. (setq start-pos (point))
  3276. (if (and start-pos (not end-pos))
  3277. (setq end-pos (point))))
  3278. (setq files thefiles
  3279. rtnall nil)
  3280. (while (setq file (pop files))
  3281. (catch 'nextfile
  3282. (org-check-agenda-file file)
  3283. (let ((org-agenda-entry-types org-agenda-entry-types))
  3284. (unless org-agenda-include-deadlines
  3285. (setq org-agenda-entry-types
  3286. (delq :deadline org-agenda-entry-types)))
  3287. (cond
  3288. ((memq org-agenda-show-log '(only clockcheck))
  3289. (setq rtn (org-agenda-get-day-entries
  3290. file date :closed)))
  3291. (org-agenda-show-log
  3292. (setq rtn (apply 'org-agenda-get-day-entries
  3293. file date
  3294. (append '(:closed) org-agenda-entry-types))))
  3295. (t
  3296. (setq rtn (apply 'org-agenda-get-day-entries
  3297. file date
  3298. org-agenda-entry-types)))))
  3299. (setq rtnall (append rtnall rtn))))
  3300. (if org-agenda-include-diary
  3301. (let ((org-agenda-search-headline-for-time t))
  3302. (require 'diary-lib)
  3303. (setq rtn (org-get-entries-from-diary date))
  3304. (setq rtnall (append rtnall rtn))))
  3305. (if (or rtnall org-agenda-show-all-dates)
  3306. (progn
  3307. (setq day-cnt (1+ day-cnt))
  3308. (insert
  3309. (if (stringp org-agenda-format-date)
  3310. (format-time-string org-agenda-format-date
  3311. (org-time-from-absolute date))
  3312. (funcall org-agenda-format-date date))
  3313. "\n")
  3314. (put-text-property s (1- (point)) 'face
  3315. (org-agenda-get-day-face date))
  3316. (put-text-property s (1- (point)) 'org-date-line t)
  3317. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3318. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
  3319. (when todayp
  3320. (put-text-property s (1- (point)) 'org-today t))
  3321. (if rtnall (insert
  3322. (org-finalize-agenda-entries
  3323. (org-agenda-add-time-grid-maybe
  3324. rtnall ndays todayp))
  3325. "\n"))
  3326. (put-text-property s (1- (point)) 'day d)
  3327. (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
  3328. (when (and org-agenda-clockreport-mode clocktable-start)
  3329. (let ((org-agenda-files (org-agenda-files nil 'ifmode))
  3330. ;; the above line is to ensure the restricted range!
  3331. (p (copy-sequence org-agenda-clockreport-parameter-plist))
  3332. tbl)
  3333. (setq p (org-plist-delete p :block))
  3334. (setq p (plist-put p :tstart clocktable-start))
  3335. (setq p (plist-put p :tend clocktable-end))
  3336. (setq p (plist-put p :scope 'agenda))
  3337. (when (and (eq org-agenda-clockreport-mode 'with-filter)
  3338. (setq filter (or org-agenda-filter-while-redo
  3339. (get 'org-agenda-filter :preset-filter))))
  3340. (setq p (plist-put p :tags (mapconcat (lambda (x)
  3341. (if (string-match "[<>=]" x)
  3342. ""
  3343. x))
  3344. filter ""))))
  3345. (setq tbl (apply 'org-get-clocktable p))
  3346. (insert tbl)))
  3347. (goto-char (point-min))
  3348. (or org-agenda-multi (org-fit-agenda-window))
  3349. (unless (and (pos-visible-in-window-p (point-min))
  3350. (pos-visible-in-window-p (point-max)))
  3351. (goto-char (1- (point-max)))
  3352. (recenter -1)
  3353. (if (not (pos-visible-in-window-p (or start-pos 1)))
  3354. (progn
  3355. (goto-char (or start-pos 1))
  3356. (recenter 1))))
  3357. (goto-char (or start-pos 1))
  3358. (add-text-properties (point-min) (point-max) '(org-agenda-type agenda))
  3359. (if (eq org-agenda-show-log 'clockcheck)
  3360. (org-agenda-show-clocking-issues))
  3361. (org-finalize-agenda)
  3362. (setq buffer-read-only t)
  3363. (message "")))
  3364. (defun org-agenda-ndays-to-span (n)
  3365. "Return a span symbol for a span of N days, or N if none matches."
  3366. (cond ((symbolp n) n)
  3367. ((= n 1) 'day)
  3368. ((= n 7) 'week)
  3369. (t n)))
  3370. (defun org-agenda-span-to-ndays (span start-day)
  3371. "Return ndays from SPAN starting at START-DAY."
  3372. (cond ((numberp span) span)
  3373. ((eq span 'day) 1)
  3374. ((eq span 'week) 7)
  3375. ((eq span 'month)
  3376. (let ((date (calendar-gregorian-from-absolute start-day)))
  3377. (calendar-last-day-of-month (car date) (caddr date))))
  3378. ((eq span 'year)
  3379. (let ((date (calendar-gregorian-from-absolute start-day)))
  3380. (if (calendar-leap-year-p (caddr date)) 366 365)))))
  3381. (defun org-agenda-span-name (span)
  3382. "Return a SPAN name."
  3383. (if (null span)
  3384. ""
  3385. (if (symbolp span)
  3386. (capitalize (symbol-name span))
  3387. (format "%d days" span))))
  3388. ;;; Agenda word search
  3389. (defvar org-agenda-search-history nil)
  3390. (defvar org-todo-only nil)
  3391. (defvar org-search-syntax-table nil
  3392. "Special syntax table for org-mode search.
  3393. In this table, we have single quotes not as word constituents, to
  3394. that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
  3395. (defun org-search-syntax-table ()
  3396. (unless org-search-syntax-table
  3397. (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
  3398. (modify-syntax-entry ?' "." org-search-syntax-table)
  3399. (modify-syntax-entry ?` "." org-search-syntax-table))
  3400. org-search-syntax-table)
  3401. (defvar org-agenda-last-search-view-search-was-boolean nil)
  3402. ;;;###autoload
  3403. (defun org-search-view (&optional todo-only string edit-at)
  3404. "Show all entries that contain a phrase or words or regular expressions.
  3405. With optional prefix argument TODO-ONLY, only consider entries that are
  3406. TODO entries. The argument STRING can be used to pass a default search
  3407. string into this function. If EDIT-AT is non-nil, it means that the
  3408. user should get a chance to edit this string, with cursor at position
  3409. EDIT-AT.
  3410. The search string can be viewed either as a phrase that should be found as
  3411. is, or it can be broken into a number of snippets, each of which must match
  3412. in a Boolean way to select an entry. The default depends on the variable
  3413. `org-agenda-search-view-always-boolean'.
  3414. Even if this is turned off (the default) you can always switch to
  3415. Boolean search dynamically by preceding the first word with \"+\" or \"-\".
  3416. The default is a direct search of the whole phrase, where each space in
  3417. the search string can expand to an arbitrary amount of whitespace,
  3418. including newlines.
  3419. If using a Boolean search, the search string is split on whitespace and
  3420. each snippet is searched separately, with logical AND to select an entry.
  3421. Words prefixed with a minus must *not* occur in the entry. Words without
  3422. a prefix or prefixed with a plus must occur in the entry. Matching is
  3423. case-insensitive. Words are enclosed by word delimiters (i.e. they must
  3424. match whole words, not parts of a word) if
  3425. `org-agenda-search-view-force-full-words' is set (default is nil).
  3426. Boolean search snippets enclosed by curly braces are interpreted as
  3427. regular expressions that must or (when preceded with \"-\") must not
  3428. match in the entry. Snippets enclosed into double quotes will be taken
  3429. as a whole, to include whitespace.
  3430. - If the search string starts with an asterisk, search only in headlines.
  3431. - If (possibly after the leading star) the search string starts with an
  3432. exclamation mark, this also means to look at TODO entries only, an effect
  3433. that can also be achieved with a prefix argument.
  3434. - If (possibly after star and exclamation mark) the search string starts
  3435. with a colon, this will mean that the (non-regexp) snippets of the
  3436. Boolean search must match as full words.
  3437. This command searches the agenda files, and in addition the files listed
  3438. in `org-agenda-text-search-extra-files'."
  3439. (interactive "P")
  3440. (org-compile-prefix-format 'search)
  3441. (org-set-sorting-strategy 'search)
  3442. (org-prepare-agenda "SEARCH")
  3443. (let* ((props (list 'face nil
  3444. 'done-face 'org-agenda-done
  3445. 'org-not-done-regexp org-not-done-regexp
  3446. 'org-todo-regexp org-todo-regexp
  3447. 'org-complex-heading-regexp org-complex-heading-regexp
  3448. 'mouse-face 'highlight
  3449. 'help-echo (format "mouse-2 or RET jump to location")))
  3450. (full-words org-agenda-search-view-force-full-words)
  3451. (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
  3452. regexp rtn rtnall files file pos
  3453. marker category tags c neg re boolean
  3454. ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
  3455. (unless (and (not edit-at)
  3456. (stringp string)
  3457. (string-match "\\S-" string))
  3458. (setq string (read-string
  3459. (if org-agenda-search-view-always-boolean
  3460. "[+-]Word/{Regexp} ...: "
  3461. "Phrase, or [+-]Word/{Regexp} ...: ")
  3462. (cond
  3463. ((integerp edit-at) (cons string edit-at))
  3464. (edit-at string))
  3465. 'org-agenda-search-history)))
  3466. (org-set-local 'org-todo-only todo-only)
  3467. (setq org-agenda-redo-command
  3468. (list 'org-search-view (if todo-only t nil) string
  3469. '(if current-prefix-arg 1 nil)))
  3470. (setq org-agenda-query-string string)
  3471. (if (equal (string-to-char string) ?*)
  3472. (setq hdl-only t
  3473. words (substring string 1))
  3474. (setq words string))
  3475. (when (equal (string-to-char words) ?!)
  3476. (setq todo-only t
  3477. words (substring words 1)))
  3478. (when (equal (string-to-char words) ?:)
  3479. (setq full-words t
  3480. words (substring words 1)))
  3481. (if (or org-agenda-search-view-always-boolean
  3482. (member (string-to-char words) '(?- ?+ ?\{)))
  3483. (setq boolean t))
  3484. (setq words (org-split-string words))
  3485. (let (www w)
  3486. (while (setq w (pop words))
  3487. (while (and (string-match "\\\\\\'" w) words)
  3488. (setq w (concat (substring w 0 -1) " " (pop words))))
  3489. (push w www))
  3490. (setq words (nreverse www) www nil)
  3491. (while (setq w (pop words))
  3492. (when (and (string-match "\\`[-+]?{" w)
  3493. (not (string-match "}\\'" w)))
  3494. (while (and words (not (string-match "}\\'" (car words))))
  3495. (setq w (concat w " " (pop words))))
  3496. (setq w (concat w " " (pop words))))
  3497. (push w www))
  3498. (setq words (nreverse www)))
  3499. (setq org-agenda-last-search-view-search-was-boolean boolean)
  3500. (when boolean
  3501. (let (wds w)
  3502. (while (setq w (pop words))
  3503. (if (or (equal (substring w 0 1) "\"")
  3504. (and (> (length w) 1)
  3505. (member (substring w 0 1) '("+" "-"))
  3506. (equal (substring w 1 2) "\"")))
  3507. (while (and words (not (equal (substring w -1) "\"")))
  3508. (setq w (concat w " " (pop words)))))
  3509. (and (string-match "\\`\\([-+]?\\)\"" w)
  3510. (setq w (replace-match "\\1" nil nil w)))
  3511. (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
  3512. (push w wds))
  3513. (setq words (nreverse wds))))
  3514. (if boolean
  3515. (mapc (lambda (w)
  3516. (setq c (string-to-char w))
  3517. (if (equal c ?-)
  3518. (setq neg t w (substring w 1))
  3519. (if (equal c ?+)
  3520. (setq neg nil w (substring w 1))
  3521. (setq neg nil)))
  3522. (if (string-match "\\`{.*}\\'" w)
  3523. (setq re (substring w 1 -1))
  3524. (if full-words
  3525. (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
  3526. (setq re (regexp-quote (downcase w)))))
  3527. (if neg (push re regexps-) (push re regexps+)))
  3528. words)
  3529. (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
  3530. regexps+))
  3531. (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
  3532. (if (not regexps+)
  3533. (setq regexp (concat "^" org-outline-regexp))
  3534. (setq regexp (pop regexps+))
  3535. (if hdl-only (setq regexp (concat "^" org-outline-regexp ".*?"
  3536. regexp))))
  3537. (setq files (org-agenda-files nil 'ifmode))
  3538. (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
  3539. (pop org-agenda-text-search-extra-files)
  3540. (setq files (org-add-archive-files files)))
  3541. (setq files (append files org-agenda-text-search-extra-files)
  3542. rtnall nil)
  3543. (while (setq file (pop files))
  3544. (setq ee nil)
  3545. (catch 'nextfile
  3546. (org-check-agenda-file file)
  3547. (setq buffer (if (file-exists-p file)
  3548. (org-get-agenda-file-buffer file)
  3549. (error "No such file %s" file)))
  3550. (if (not buffer)
  3551. ;; If file does not exist, make sure an error message is sent
  3552. (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
  3553. file))))
  3554. (with-current-buffer buffer
  3555. (with-syntax-table (org-search-syntax-table)
  3556. (unless (org-mode-p)
  3557. (error "Agenda file %s is not in `org-mode'" file))
  3558. (let ((case-fold-search t))
  3559. (save-excursion
  3560. (save-restriction
  3561. (if org-agenda-restrict
  3562. (narrow-to-region org-agenda-restrict-begin
  3563. org-agenda-restrict-end)
  3564. (widen))
  3565. (goto-char (point-min))
  3566. (unless (or (org-on-heading-p)
  3567. (outline-next-heading))
  3568. (throw 'nextfile t))
  3569. (goto-char (max (point-min) (1- (point))))
  3570. (while (re-search-forward regexp nil t)
  3571. (org-back-to-heading t)
  3572. (skip-chars-forward "* ")
  3573. (setq beg (point-at-bol)
  3574. beg1 (point)
  3575. end (progn (outline-next-heading) (point)))
  3576. (catch :skip
  3577. (goto-char beg)
  3578. (org-agenda-skip)
  3579. (setq str (buffer-substring-no-properties
  3580. (point-at-bol)
  3581. (if hdl-only (point-at-eol) end)))
  3582. (mapc (lambda (wr) (when (string-match wr str)
  3583. (goto-char (1- end))
  3584. (throw :skip t)))
  3585. regexps-)
  3586. (mapc (lambda (wr) (unless (string-match wr str)
  3587. (goto-char (1- end))
  3588. (throw :skip t)))
  3589. (if todo-only
  3590. (cons (concat "^\*+[ \t]+" org-not-done-regexp)
  3591. regexps+)
  3592. regexps+))
  3593. (goto-char beg)
  3594. (setq marker (org-agenda-new-marker (point))
  3595. category (org-get-category)
  3596. tags (org-get-tags-at (point))
  3597. txt (org-format-agenda-item
  3598. ""
  3599. (buffer-substring-no-properties
  3600. beg1 (point-at-eol))
  3601. category tags))
  3602. (org-add-props txt props
  3603. 'org-marker marker 'org-hd-marker marker
  3604. 'org-todo-regexp org-todo-regexp
  3605. 'org-complex-heading-regexp org-complex-heading-regexp
  3606. 'priority 1000 'org-category category
  3607. 'type "search")
  3608. (push txt ee)
  3609. (goto-char (1- end))))))))))
  3610. (setq rtn (nreverse ee))
  3611. (setq rtnall (append rtnall rtn)))
  3612. (if org-agenda-overriding-header
  3613. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  3614. nil 'face 'org-agenda-structure) "\n")
  3615. (insert "Search words: ")
  3616. (add-text-properties (point-min) (1- (point))
  3617. (list 'face 'org-agenda-structure))
  3618. (setq pos (point))
  3619. (insert string "\n")
  3620. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  3621. (setq pos (point))
  3622. (unless org-agenda-multi
  3623. (insert "Press `[', `]' to add/sub word, `{', `}' to add/sub regexp, `C-u r' to edit\n")
  3624. (add-text-properties pos (1- (point))
  3625. (list 'face 'org-agenda-structure))))
  3626. (org-agenda-mark-header-line (point-min))
  3627. (when rtnall
  3628. (insert (org-finalize-agenda-entries rtnall) "\n"))
  3629. (goto-char (point-min))
  3630. (or org-agenda-multi (org-fit-agenda-window))
  3631. (add-text-properties (point-min) (point-max) '(org-agenda-type search))
  3632. (org-finalize-agenda)
  3633. (setq buffer-read-only t)))
  3634. ;;; Agenda TODO list
  3635. (defvar org-select-this-todo-keyword nil)
  3636. (defvar org-last-arg nil)
  3637. ;;;###autoload
  3638. (defun org-todo-list (arg)
  3639. "Show all (not done) TODO entries from all agenda file in a single list.
  3640. The prefix arg can be used to select a specific TODO keyword and limit
  3641. the list to these. When using \\[universal-argument], you will be prompted
  3642. for a keyword. A numeric prefix directly selects the Nth keyword in
  3643. `org-todo-keywords-1'."
  3644. (interactive "P")
  3645. (org-compile-prefix-format 'todo)
  3646. (org-set-sorting-strategy 'todo)
  3647. (org-prepare-agenda "TODO")
  3648. (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
  3649. (let* ((today (org-today))
  3650. (date (calendar-gregorian-from-absolute today))
  3651. (kwds org-todo-keywords-for-agenda)
  3652. (completion-ignore-case t)
  3653. (org-select-this-todo-keyword
  3654. (if (stringp arg) arg
  3655. (and arg (integerp arg) (> arg 0)
  3656. (nth (1- arg) kwds))))
  3657. rtn rtnall files file pos)
  3658. (when (equal arg '(4))
  3659. (setq org-select-this-todo-keyword
  3660. (org-icompleting-read "Keyword (or KWD1|K2D2|...): "
  3661. (mapcar 'list kwds) nil nil)))
  3662. (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
  3663. (org-set-local 'org-last-arg arg)
  3664. (setq org-agenda-redo-command
  3665. '(org-todo-list (or current-prefix-arg org-last-arg)))
  3666. (setq files (org-agenda-files nil 'ifmode)
  3667. rtnall nil)
  3668. (while (setq file (pop files))
  3669. (catch 'nextfile
  3670. (org-check-agenda-file file)
  3671. (setq rtn (org-agenda-get-day-entries file date :todo))
  3672. (setq rtnall (append rtnall rtn))))
  3673. (if org-agenda-overriding-header
  3674. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  3675. nil 'face 'org-agenda-structure) "\n")
  3676. (insert "Global list of TODO items of type: ")
  3677. (add-text-properties (point-min) (1- (point))
  3678. (list 'face 'org-agenda-structure
  3679. 'short-heading
  3680. (concat "ToDo: "
  3681. (or org-select-this-todo-keyword "ALL"))))
  3682. (org-agenda-mark-header-line (point-min))
  3683. (setq pos (point))
  3684. (insert (or org-select-this-todo-keyword "ALL") "\n")
  3685. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  3686. (setq pos (point))
  3687. (unless org-agenda-multi
  3688. (insert "Available with `N r': (0)ALL")
  3689. (let ((n 0) s)
  3690. (mapc (lambda (x)
  3691. (setq s (format "(%d)%s" (setq n (1+ n)) x))
  3692. (if (> (+ (current-column) (string-width s) 1) (frame-width))
  3693. (insert "\n "))
  3694. (insert " " s))
  3695. kwds))
  3696. (insert "\n"))
  3697. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
  3698. (org-agenda-mark-header-line (point-min))
  3699. (when rtnall
  3700. (insert (org-finalize-agenda-entries rtnall) "\n"))
  3701. (goto-char (point-min))
  3702. (or org-agenda-multi (org-fit-agenda-window))
  3703. (add-text-properties (point-min) (point-max) '(org-agenda-type todo))
  3704. (org-finalize-agenda)
  3705. (setq buffer-read-only t)))
  3706. ;;; Agenda tags match
  3707. ;;;###autoload
  3708. (defun org-tags-view (&optional todo-only match)
  3709. "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
  3710. The prefix arg TODO-ONLY limits the search to TODO entries."
  3711. (interactive "P")
  3712. (org-compile-prefix-format 'tags)
  3713. (org-set-sorting-strategy 'tags)
  3714. (let* ((org-tags-match-list-sublevels
  3715. org-tags-match-list-sublevels)
  3716. (completion-ignore-case t)
  3717. rtn rtnall files file pos matcher
  3718. buffer)
  3719. (when (and (stringp match) (not (string-match "\\S-" match)))
  3720. (setq match nil))
  3721. (setq matcher (org-make-tags-matcher match)
  3722. match (car matcher) matcher (cdr matcher))
  3723. (org-prepare-agenda (concat "TAGS " match))
  3724. (setq org-agenda-query-string match)
  3725. (setq org-agenda-redo-command
  3726. (list 'org-tags-view (list 'quote todo-only)
  3727. (list 'if 'current-prefix-arg nil 'org-agenda-query-string)))
  3728. (setq files (org-agenda-files nil 'ifmode)
  3729. rtnall nil)
  3730. (while (setq file (pop files))
  3731. (catch 'nextfile
  3732. (org-check-agenda-file file)
  3733. (setq buffer (if (file-exists-p file)
  3734. (org-get-agenda-file-buffer file)
  3735. (error "No such file %s" file)))
  3736. (if (not buffer)
  3737. ;; If file does not exist, error message to agenda
  3738. (setq rtn (list
  3739. (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  3740. rtnall (append rtnall rtn))
  3741. (with-current-buffer buffer
  3742. (unless (org-mode-p)
  3743. (error "Agenda file %s is not in `org-mode'" file))
  3744. (save-excursion
  3745. (save-restriction
  3746. (if org-agenda-restrict
  3747. (narrow-to-region org-agenda-restrict-begin
  3748. org-agenda-restrict-end)
  3749. (widen))
  3750. (setq rtn (org-scan-tags 'agenda matcher todo-only))
  3751. (setq rtnall (append rtnall rtn))))))))
  3752. (if org-agenda-overriding-header
  3753. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  3754. nil 'face 'org-agenda-structure) "\n")
  3755. (insert "Headlines with TAGS match: ")
  3756. (add-text-properties (point-min) (1- (point))
  3757. (list 'face 'org-agenda-structure
  3758. 'short-heading
  3759. (concat "Match: " match)))
  3760. (setq pos (point))
  3761. (insert match "\n")
  3762. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  3763. (setq pos (point))
  3764. (unless org-agenda-multi
  3765. (insert "Press `C-u r' to search again with new search string\n"))
  3766. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
  3767. (org-agenda-mark-header-line (point-min))
  3768. (when rtnall
  3769. (insert (org-finalize-agenda-entries rtnall) "\n"))
  3770. (goto-char (point-min))
  3771. (or org-agenda-multi (org-fit-agenda-window))
  3772. (add-text-properties (point-min) (point-max) '(org-agenda-type tags))
  3773. (org-finalize-agenda)
  3774. (setq buffer-read-only t)))
  3775. ;;; Agenda Finding stuck projects
  3776. (defvar org-agenda-skip-regexp nil
  3777. "Regular expression used in skipping subtrees for the agenda.
  3778. This is basically a temporary global variable that can be set and then
  3779. used by user-defined selections using `org-agenda-skip-function'.")
  3780. (defvar org-agenda-overriding-header nil
  3781. "When this is set during todo and tags searches, will replace header.
  3782. This variable should not be set directly, but custom commands can bind it
  3783. in the options section.")
  3784. (defun org-agenda-skip-entry-when-regexp-matches ()
  3785. "Check if the current entry contains match for `org-agenda-skip-regexp'.
  3786. If yes, it returns the end position of this entry, causing agenda commands
  3787. to skip the entry but continuing the search in the subtree. This is a
  3788. function that can be put into `org-agenda-skip-function' for the duration
  3789. of a command."
  3790. (let ((end (save-excursion (org-end-of-subtree t)))
  3791. skip)
  3792. (save-excursion
  3793. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  3794. (and skip end)))
  3795. (defun org-agenda-skip-subtree-when-regexp-matches ()
  3796. "Check if the current subtree contains match for `org-agenda-skip-regexp'.
  3797. If yes, it returns the end position of this tree, causing agenda commands
  3798. to skip this subtree. This is a function that can be put into
  3799. `org-agenda-skip-function' for the duration of a command."
  3800. (let ((end (save-excursion (org-end-of-subtree t)))
  3801. skip)
  3802. (save-excursion
  3803. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  3804. (and skip end)))
  3805. (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
  3806. "Check if the current subtree contains match for `org-agenda-skip-regexp'.
  3807. If yes, it returns the end position of the current entry (NOT the tree),
  3808. causing agenda commands to skip the entry but continuing the search in
  3809. the subtree. This is a function that can be put into
  3810. `org-agenda-skip-function' for the duration of a command. An important
  3811. use of this function is for the stuck project list."
  3812. (let ((end (save-excursion (org-end-of-subtree t)))
  3813. (entry-end (save-excursion (outline-next-heading) (1- (point))))
  3814. skip)
  3815. (save-excursion
  3816. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  3817. (and skip entry-end)))
  3818. (defun org-agenda-skip-entry-if (&rest conditions)
  3819. "Skip entry if any of CONDITIONS is true.
  3820. See `org-agenda-skip-if' for details."
  3821. (org-agenda-skip-if nil conditions))
  3822. (defun org-agenda-skip-subtree-if (&rest conditions)
  3823. "Skip entry if any of CONDITIONS is true.
  3824. See `org-agenda-skip-if' for details."
  3825. (org-agenda-skip-if t conditions))
  3826. (defun org-agenda-skip-if (subtree conditions)
  3827. "Checks current entity for CONDITIONS.
  3828. If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
  3829. the entry, i.e. the text before the next heading is checked.
  3830. CONDITIONS is a list of symbols, boolean OR is used to combine the results
  3831. from different tests. Valid conditions are:
  3832. scheduled Check if there is a scheduled cookie
  3833. notscheduled Check if there is no scheduled cookie
  3834. deadline Check if there is a deadline
  3835. notdeadline Check if there is no deadline
  3836. timestamp Check if there is a timestamp (also deadline or scheduled)
  3837. nottimestamp Check if there is no timestamp (also deadline or scheduled)
  3838. regexp Check if regexp matches
  3839. notregexp Check if regexp does not match.
  3840. todo Check if TODO keyword matches
  3841. nottodo Check if TODO keyword does not match
  3842. The regexp is taken from the conditions list, it must come right after
  3843. the `regexp' or `notregexp' element.
  3844. `todo' and `nottodo' accept as an argument a list of todo
  3845. keywords, which may include \"*\" to match any todo keyword.
  3846. (org-agenda-skip-entry-if 'todo '(\"TODO\" \"WAITING\"))
  3847. would skip all entries with \"TODO\" or \"WAITING\" keywords.
  3848. Instead of a list a keyword class may be given
  3849. (org-agenda-skip-entry-if 'nottodo 'done)
  3850. would skip entries that haven't been marked with any of \"DONE\"
  3851. keywords. Possible classes are: `todo', `done', `any'.
  3852. If any of these conditions is met, this function returns the end point of
  3853. the entity, causing the search to continue from there. This is a function
  3854. that can be put into `org-agenda-skip-function' for the duration of a command."
  3855. (let (beg end m)
  3856. (org-back-to-heading t)
  3857. (setq beg (point)
  3858. end (if subtree
  3859. (progn (org-end-of-subtree t) (point))
  3860. (progn (outline-next-heading) (1- (point)))))
  3861. (goto-char beg)
  3862. (and
  3863. (or
  3864. (and (memq 'scheduled conditions)
  3865. (re-search-forward org-scheduled-time-regexp end t))
  3866. (and (memq 'notscheduled conditions)
  3867. (not (re-search-forward org-scheduled-time-regexp end t)))
  3868. (and (memq 'deadline conditions)
  3869. (re-search-forward org-deadline-time-regexp end t))
  3870. (and (memq 'notdeadline conditions)
  3871. (not (re-search-forward org-deadline-time-regexp end t)))
  3872. (and (memq 'timestamp conditions)
  3873. (re-search-forward org-ts-regexp end t))
  3874. (and (memq 'nottimestamp conditions)
  3875. (not (re-search-forward org-ts-regexp end t)))
  3876. (and (setq m (memq 'regexp conditions))
  3877. (stringp (nth 1 m))
  3878. (re-search-forward (nth 1 m) end t))
  3879. (and (setq m (memq 'notregexp conditions))
  3880. (stringp (nth 1 m))
  3881. (not (re-search-forward (nth 1 m) end t)))
  3882. (and (or
  3883. (setq m (memq 'todo conditions))
  3884. (setq m (memq 'nottodo conditions)))
  3885. (org-agenda-skip-if-todo m end)))
  3886. end)))
  3887. (defun org-agenda-skip-if-todo (args end)
  3888. "Helper function for `org-agenda-skip-if', do not use it directly.
  3889. ARGS is a list with first element either `todo' or `nottodo'.
  3890. The remainder is either a list of TODO keywords, or a state symbol
  3891. `todo' or `done' or `any'."
  3892. (let ((kw (car args))
  3893. (arg (cadr args))
  3894. todo-wds todo-re)
  3895. (setq todo-wds
  3896. (org-uniquify
  3897. (cond
  3898. ((listp arg) ;; list of keywords
  3899. (if (member "*" arg)
  3900. (mapcar 'substring-no-properties org-todo-keywords-1)
  3901. arg))
  3902. ((symbolp arg) ;; keyword class name
  3903. (cond
  3904. ((eq arg 'todo)
  3905. (org-delete-all org-done-keywords
  3906. (mapcar 'substring-no-properties
  3907. org-todo-keywords-1)))
  3908. ((eq arg 'done) org-done-keywords)
  3909. ((eq arg 'any)
  3910. (mapcar 'substring-no-properties org-todo-keywords-1)))))))
  3911. (setq todo-re
  3912. (concat "^\\*+[ \t]+\\<\\("
  3913. (mapconcat 'identity todo-wds "\\|")
  3914. "\\)\\>"))
  3915. (if (eq kw 'todo)
  3916. (re-search-forward todo-re end t)
  3917. (not (re-search-forward todo-re end t)))))
  3918. ;;;###autoload
  3919. (defun org-agenda-list-stuck-projects (&rest ignore)
  3920. "Create agenda view for projects that are stuck.
  3921. Stuck projects are project that have no next actions. For the definitions
  3922. of what a project is and how to check if it stuck, customize the variable
  3923. `org-stuck-projects'."
  3924. (interactive)
  3925. (let* ((org-agenda-skip-function
  3926. 'org-agenda-skip-entry-when-regexp-matches-in-subtree)
  3927. ;; We could have used org-agenda-skip-if here.
  3928. (org-agenda-overriding-header
  3929. (or org-agenda-overriding-header "List of stuck projects: "))
  3930. (matcher (nth 0 org-stuck-projects))
  3931. (todo (nth 1 org-stuck-projects))
  3932. (todo-wds (if (member "*" todo)
  3933. (progn
  3934. (org-prepare-agenda-buffers (org-agenda-files
  3935. nil 'ifmode))
  3936. (org-delete-all
  3937. org-done-keywords-for-agenda
  3938. (copy-sequence org-todo-keywords-for-agenda)))
  3939. todo))
  3940. (todo-re (concat "^\\*+[ \t]+\\("
  3941. (mapconcat 'identity todo-wds "\\|")
  3942. "\\)\\>"))
  3943. (tags (nth 2 org-stuck-projects))
  3944. (tags-re (if (member "*" tags)
  3945. (org-re "^\\*+ .*:[[:alnum:]_@#%]+:[ \t]*$")
  3946. (if tags
  3947. (concat "^\\*+ .*:\\("
  3948. (mapconcat 'identity tags "\\|")
  3949. (org-re "\\):[[:alnum:]_@#%:]*[ \t]*$")))))
  3950. (gen-re (nth 3 org-stuck-projects))
  3951. (re-list
  3952. (delq nil
  3953. (list
  3954. (if todo todo-re)
  3955. (if tags tags-re)
  3956. (and gen-re (stringp gen-re) (string-match "\\S-" gen-re)
  3957. gen-re)))))
  3958. (setq org-agenda-skip-regexp
  3959. (if re-list
  3960. (mapconcat 'identity re-list "\\|")
  3961. (error "No information how to identify unstuck projects")))
  3962. (org-tags-view nil matcher)
  3963. (with-current-buffer org-agenda-buffer-name
  3964. (setq org-agenda-redo-command
  3965. '(org-agenda-list-stuck-projects
  3966. (or current-prefix-arg org-last-arg))))))
  3967. ;;; Diary integration
  3968. (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
  3969. (defvar list-diary-entries-hook)
  3970. (defvar diary-time-regexp)
  3971. (defun org-get-entries-from-diary (date)
  3972. "Get the (Emacs Calendar) diary entries for DATE."
  3973. (require 'diary-lib)
  3974. (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
  3975. (diary-display-hook '(fancy-diary-display))
  3976. (diary-display-function 'fancy-diary-display)
  3977. (pop-up-frames nil)
  3978. (list-diary-entries-hook
  3979. (cons 'org-diary-default-entry list-diary-entries-hook))
  3980. (diary-file-name-prefix-function nil) ; turn this feature off
  3981. (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
  3982. entries
  3983. (org-disable-agenda-to-diary t))
  3984. (save-excursion
  3985. (save-window-excursion
  3986. (funcall (if (fboundp 'diary-list-entries)
  3987. 'diary-list-entries 'list-diary-entries)
  3988. date 1)))
  3989. (if (not (get-buffer diary-fancy-buffer))
  3990. (setq entries nil)
  3991. (with-current-buffer diary-fancy-buffer
  3992. (setq buffer-read-only nil)
  3993. (if (zerop (buffer-size))
  3994. ;; No entries
  3995. (setq entries nil)
  3996. ;; Omit the date and other unnecessary stuff
  3997. (org-agenda-cleanup-fancy-diary)
  3998. ;; Add prefix to each line and extend the text properties
  3999. (if (zerop (buffer-size))
  4000. (setq entries nil)
  4001. (setq entries (buffer-substring (point-min) (- (point-max) 1)))
  4002. (setq entries
  4003. (with-temp-buffer
  4004. (insert entries) (goto-char (point-min))
  4005. (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
  4006. (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
  4007. (replace-match (concat "; " (match-string 1)))))
  4008. (buffer-string)))))
  4009. (set-buffer-modified-p nil)
  4010. (kill-buffer diary-fancy-buffer)))
  4011. (when entries
  4012. (setq entries (org-split-string entries "\n"))
  4013. (setq entries
  4014. (mapcar
  4015. (lambda (x)
  4016. (setq x (org-format-agenda-item "" x "Diary" nil 'time))
  4017. ;; Extend the text properties to the beginning of the line
  4018. (org-add-props x (text-properties-at (1- (length x)) x)
  4019. 'type "diary" 'date date 'face 'org-agenda-diary))
  4020. entries)))))
  4021. (defvar org-agenda-cleanup-fancy-diary-hook nil
  4022. "Hook run when the fancy diary buffer is cleaned up.")
  4023. (defun org-agenda-cleanup-fancy-diary ()
  4024. "Remove unwanted stuff in buffer created by `fancy-diary-display'.
  4025. This gets rid of the date, the underline under the date, and
  4026. the dummy entry installed by `org-mode' to ensure non-empty diary for each
  4027. date. It also removes lines that contain only whitespace."
  4028. (goto-char (point-min))
  4029. (if (looking-at ".*?:[ \t]*")
  4030. (progn
  4031. (replace-match "")
  4032. (re-search-forward "\n=+$" nil t)
  4033. (replace-match "")
  4034. (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
  4035. (re-search-forward "\n=+$" nil t)
  4036. (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
  4037. (goto-char (point-min))
  4038. (while (re-search-forward "^ +\n" nil t)
  4039. (replace-match ""))
  4040. (goto-char (point-min))
  4041. (if (re-search-forward "^Org-mode dummy\n?" nil t)
  4042. (replace-match ""))
  4043. (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
  4044. ;; Make sure entries from the diary have the right text properties.
  4045. (eval-after-load "diary-lib"
  4046. '(if (boundp 'diary-modify-entry-list-string-function)
  4047. ;; We can rely on the hook, nothing to do
  4048. nil
  4049. ;; Hook not available, must use advice to make this work
  4050. (defadvice add-to-diary-list (before org-mark-diary-entry activate)
  4051. "Make the position visible."
  4052. (if (and org-disable-agenda-to-diary ;; called from org-agenda
  4053. (stringp string)
  4054. buffer-file-name)
  4055. (setq string (org-modify-diary-entry-string string))))))
  4056. (defun org-modify-diary-entry-string (string)
  4057. "Add text properties to string, allowing org-mode to act on it."
  4058. (org-add-props string nil
  4059. 'mouse-face 'highlight
  4060. 'help-echo (if buffer-file-name
  4061. (format "mouse-2 or RET jump to diary file %s"
  4062. (abbreviate-file-name buffer-file-name))
  4063. "")
  4064. 'org-agenda-diary-link t
  4065. 'org-marker (org-agenda-new-marker (point-at-bol))))
  4066. (defun org-diary-default-entry ()
  4067. "Add a dummy entry to the diary.
  4068. Needed to avoid empty dates which mess up holiday display."
  4069. ;; Catch the error if dealing with the new add-to-diary-alist
  4070. (when org-disable-agenda-to-diary
  4071. (condition-case nil
  4072. (org-add-to-diary-list original-date "Org-mode dummy" "")
  4073. (error
  4074. (org-add-to-diary-list original-date "Org-mode dummy" "" nil)))))
  4075. (defun org-add-to-diary-list (&rest args)
  4076. (if (fboundp 'diary-add-to-list)
  4077. (apply 'diary-add-to-list args)
  4078. (apply 'add-to-diary-list args)))
  4079. (defvar org-diary-last-run-time nil)
  4080. ;;;###autoload
  4081. (defun org-diary (&rest args)
  4082. "Return diary information from org-files.
  4083. This function can be used in a \"sexp\" diary entry in the Emacs calendar.
  4084. It accesses org files and extracts information from those files to be
  4085. listed in the diary. The function accepts arguments specifying what
  4086. items should be listed. For a list of arguments allowed here, see the
  4087. variable `org-agenda-entry-types'.
  4088. The call in the diary file should look like this:
  4089. &%%(org-diary) ~/path/to/some/orgfile.org
  4090. Use a separate line for each org file to check. Or, if you omit the file name,
  4091. all files listed in `org-agenda-files' will be checked automatically:
  4092. &%%(org-diary)
  4093. If you don't give any arguments (as in the example above), the default
  4094. arguments (:deadline :scheduled :timestamp :sexp) are used.
  4095. So the example above may also be written as
  4096. &%%(org-diary :deadline :timestamp :sexp :scheduled)
  4097. The function expects the lisp variables `entry' and `date' to be provided
  4098. by the caller, because this is how the calendar works. Don't use this
  4099. function from a program - use `org-agenda-get-day-entries' instead."
  4100. (when (> (- (org-float-time)
  4101. org-agenda-last-marker-time)
  4102. 5)
  4103. (org-agenda-reset-markers))
  4104. (org-compile-prefix-format 'agenda)
  4105. (org-set-sorting-strategy 'agenda)
  4106. (setq args (or args '(:deadline :scheduled :timestamp :sexp)))
  4107. (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
  4108. (list entry)
  4109. (org-agenda-files t)))
  4110. (time (org-float-time))
  4111. file rtn results)
  4112. (when (or (not org-diary-last-run-time)
  4113. (> (- time
  4114. org-diary-last-run-time)
  4115. 3))
  4116. (org-prepare-agenda-buffers files))
  4117. (setq org-diary-last-run-time time)
  4118. ;; If this is called during org-agenda, don't return any entries to
  4119. ;; the calendar. Org Agenda will list these entries itself.
  4120. (if org-disable-agenda-to-diary (setq files nil))
  4121. (while (setq file (pop files))
  4122. (setq rtn (apply 'org-agenda-get-day-entries file date args))
  4123. (setq results (append results rtn)))
  4124. (if results
  4125. (concat (org-finalize-agenda-entries results) "\n"))))
  4126. ;;; Agenda entry finders
  4127. (defun org-agenda-get-day-entries (file date &rest args)
  4128. "Does the work for `org-diary' and `org-agenda'.
  4129. FILE is the path to a file to be checked for entries. DATE is date like
  4130. the one returned by `calendar-current-date'. ARGS are symbols indicating
  4131. which kind of entries should be extracted. For details about these, see
  4132. the documentation of `org-diary'."
  4133. (setq args (or args '(:deadline :scheduled :timestamp :sexp)))
  4134. (let* ((org-startup-folded nil)
  4135. (org-startup-align-all-tables nil)
  4136. (buffer (if (file-exists-p file)
  4137. (org-get-agenda-file-buffer file)
  4138. (error "No such file %s" file)))
  4139. arg results rtn deadline-results)
  4140. (if (not buffer)
  4141. ;; If file does not exist, make sure an error message ends up in diary
  4142. (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4143. (with-current-buffer buffer
  4144. (unless (org-mode-p)
  4145. (error "Agenda file %s is not in `org-mode'" file))
  4146. (let ((case-fold-search nil))
  4147. (save-excursion
  4148. (save-restriction
  4149. (if org-agenda-restrict
  4150. (narrow-to-region org-agenda-restrict-begin
  4151. org-agenda-restrict-end)
  4152. (widen))
  4153. ;; The way we repeatedly append to `results' makes it O(n^2) :-(
  4154. (while (setq arg (pop args))
  4155. (cond
  4156. ((and (eq arg :todo)
  4157. (equal date (calendar-gregorian-from-absolute
  4158. (org-today))))
  4159. (setq rtn (org-agenda-get-todos))
  4160. (setq results (append results rtn)))
  4161. ((eq arg :timestamp)
  4162. (setq rtn (org-agenda-get-blocks))
  4163. (setq results (append results rtn))
  4164. (setq rtn (org-agenda-get-timestamps))
  4165. (setq results (append results rtn)))
  4166. ((eq arg :sexp)
  4167. (setq rtn (org-agenda-get-sexps))
  4168. (setq results (append results rtn)))
  4169. ((eq arg :scheduled)
  4170. (setq rtn (org-agenda-get-scheduled deadline-results))
  4171. (setq results (append results rtn)))
  4172. ((eq arg :closed)
  4173. (setq rtn (org-agenda-get-progress))
  4174. (setq results (append results rtn)))
  4175. ((eq arg :deadline)
  4176. (setq rtn (org-agenda-get-deadlines))
  4177. (setq deadline-results (copy-sequence rtn))
  4178. (setq results (append results rtn))))))))
  4179. results))))
  4180. (defun org-agenda-get-todos ()
  4181. "Return the TODO information for agenda display."
  4182. (let* ((props (list 'face nil
  4183. 'done-face 'org-agenda-done
  4184. 'org-not-done-regexp org-not-done-regexp
  4185. 'org-todo-regexp org-todo-regexp
  4186. 'org-complex-heading-regexp org-complex-heading-regexp
  4187. 'mouse-face 'highlight
  4188. 'help-echo
  4189. (format "mouse-2 or RET jump to org file %s"
  4190. (abbreviate-file-name buffer-file-name))))
  4191. (regexp (concat "^\\*+[ \t]+\\("
  4192. (if org-select-this-todo-keyword
  4193. (if (equal org-select-this-todo-keyword "*")
  4194. org-todo-regexp
  4195. (concat "\\<\\("
  4196. (mapconcat 'identity (org-split-string org-select-this-todo-keyword "|") "\\|")
  4197. "\\)\\>"))
  4198. org-not-done-regexp)
  4199. "[^\n\r]*\\)"))
  4200. marker priority category tags todo-state
  4201. ee txt beg end)
  4202. (goto-char (point-min))
  4203. (while (re-search-forward regexp nil t)
  4204. (catch :skip
  4205. (save-match-data
  4206. (beginning-of-line)
  4207. (org-agenda-skip)
  4208. (setq beg (point) end (save-excursion (outline-next-heading) (point)))
  4209. (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
  4210. (goto-char (1+ beg))
  4211. (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
  4212. (throw :skip nil)))
  4213. (goto-char (match-beginning 1))
  4214. (setq marker (org-agenda-new-marker (match-beginning 0))
  4215. category (org-get-category)
  4216. txt (match-string 1)
  4217. tags (org-get-tags-at (point))
  4218. txt (org-format-agenda-item "" txt category tags)
  4219. priority (1+ (org-get-priority txt))
  4220. todo-state (org-get-todo-state))
  4221. (org-add-props txt props
  4222. 'org-marker marker 'org-hd-marker marker
  4223. 'priority priority 'org-category category
  4224. 'type "todo" 'todo-state todo-state)
  4225. (push txt ee)
  4226. (if org-agenda-todo-list-sublevels
  4227. (goto-char (match-end 1))
  4228. (org-end-of-subtree 'invisible))))
  4229. (nreverse ee)))
  4230. (defun org-agenda-todo-custom-ignore-p (time n)
  4231. "Check whether timestamp is farther away then n number of days.
  4232. This function is invoked if `org-agenda-todo-ignore-deadlines',
  4233. `org-agenda-todo-ignore-scheduled' or
  4234. `org-agenda-todo-ignore-timestamp' is set to an integer."
  4235. (let ((days (org-days-to-time time)))
  4236. (if (>= n 0)
  4237. (>= days n)
  4238. (<= days n))))
  4239. ;;;###autoload
  4240. (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  4241. (&optional end)
  4242. "Do we have a reason to ignore this TODO entry because it has a time stamp?"
  4243. (when (or org-agenda-todo-ignore-with-date
  4244. org-agenda-todo-ignore-scheduled
  4245. org-agenda-todo-ignore-deadlines
  4246. org-agenda-todo-ignore-timestamp)
  4247. (setq end (or end (save-excursion (outline-next-heading) (point))))
  4248. (save-excursion
  4249. (or (and org-agenda-todo-ignore-with-date
  4250. (re-search-forward org-ts-regexp end t))
  4251. (and org-agenda-todo-ignore-scheduled
  4252. (re-search-forward org-scheduled-time-regexp end t)
  4253. (cond
  4254. ((eq org-agenda-todo-ignore-scheduled 'future)
  4255. (> (org-days-to-time (match-string 1)) 0))
  4256. ((eq org-agenda-todo-ignore-scheduled 'past)
  4257. (<= (org-days-to-time (match-string 1)) 0))
  4258. ((numberp org-agenda-todo-ignore-scheduled)
  4259. (org-agenda-todo-custom-ignore-p
  4260. (match-string 1) org-agenda-todo-ignore-scheduled))
  4261. (t)))
  4262. (and org-agenda-todo-ignore-deadlines
  4263. (re-search-forward org-deadline-time-regexp end t)
  4264. (cond
  4265. ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
  4266. ((eq org-agenda-todo-ignore-deadlines 'far)
  4267. (not (org-deadline-close (match-string 1))))
  4268. ((eq org-agenda-todo-ignore-deadlines 'future)
  4269. (> (org-days-to-time (match-string 1)) 0))
  4270. ((eq org-agenda-todo-ignore-deadlines 'past)
  4271. (<= (org-days-to-time (match-string 1)) 0))
  4272. ((numberp org-agenda-todo-ignore-deadlines)
  4273. (org-agenda-todo-custom-ignore-p
  4274. (match-string 1) org-agenda-todo-ignore-deadlines))
  4275. (t (org-deadline-close (match-string 1)))))
  4276. (and org-agenda-todo-ignore-timestamp
  4277. (let ((buffer (current-buffer))
  4278. (regexp
  4279. (concat
  4280. org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
  4281. (start (point)))
  4282. ;; Copy current buffer into a temporary one
  4283. (with-temp-buffer
  4284. (insert-buffer-substring buffer start end)
  4285. (goto-char (point-min))
  4286. ;; Delete SCHEDULED and DEADLINE items
  4287. (while (re-search-forward regexp end t)
  4288. (delete-region (match-beginning 0) (match-end 0)))
  4289. (goto-char (point-min))
  4290. ;; No search for timestamp left
  4291. (when (re-search-forward org-ts-regexp nil t)
  4292. (cond
  4293. ((eq org-agenda-todo-ignore-timestamp 'future)
  4294. (> (org-days-to-time (match-string 1)) 0))
  4295. ((eq org-agenda-todo-ignore-timestamp 'past)
  4296. (<= (org-days-to-time (match-string 1)) 0))
  4297. ((numberp org-agenda-todo-ignore-timestamp)
  4298. (org-agenda-todo-custom-ignore-p
  4299. (match-string 1) org-agenda-todo-ignore-timestamp))
  4300. (t))))))))))
  4301. (defconst org-agenda-no-heading-message
  4302. "No heading for this item in buffer or region.")
  4303. (defun org-agenda-get-timestamps ()
  4304. "Return the date stamp information for agenda display."
  4305. (let* ((props (list 'face nil
  4306. 'org-not-done-regexp org-not-done-regexp
  4307. 'org-todo-regexp org-todo-regexp
  4308. 'org-complex-heading-regexp org-complex-heading-regexp
  4309. 'mouse-face 'highlight
  4310. 'help-echo
  4311. (format "mouse-2 or RET jump to org file %s"
  4312. (abbreviate-file-name buffer-file-name))))
  4313. (d1 (calendar-absolute-from-gregorian date))
  4314. (remove-re
  4315. (concat
  4316. (regexp-quote
  4317. (format-time-string
  4318. "<%Y-%m-%d"
  4319. (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  4320. ".*?>"))
  4321. (regexp
  4322. (concat
  4323. (if org-agenda-include-inactive-timestamps "[[<]" "<")
  4324. (regexp-quote
  4325. (substring
  4326. (format-time-string
  4327. (car org-time-stamp-formats)
  4328. (apply 'encode-time ; DATE bound by calendar
  4329. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  4330. 1 11))
  4331. "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[dwmy]>\\)"
  4332. "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
  4333. marker hdmarker deadlinep scheduledp clockp closedp inactivep
  4334. donep tmp priority category ee txt timestr tags b0 b3 e3 head
  4335. todo-state end-of-match show-all)
  4336. (goto-char (point-min))
  4337. (while (setq end-of-match (re-search-forward regexp nil t))
  4338. (setq b0 (match-beginning 0)
  4339. b3 (match-beginning 3) e3 (match-end 3)
  4340. todo-state (save-match-data (ignore-errors (org-get-todo-state)))
  4341. show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  4342. (member todo-state
  4343. org-agenda-repeating-timestamp-show-all)))
  4344. (catch :skip
  4345. (and (org-at-date-range-p) (throw :skip nil))
  4346. (org-agenda-skip)
  4347. (if (and (match-end 1)
  4348. (not (= d1 (org-time-string-to-absolute
  4349. (match-string 1) d1 nil show-all))))
  4350. (throw :skip nil))
  4351. (if (and e3
  4352. (not (org-diary-sexp-entry (buffer-substring b3 e3) "" date)))
  4353. (throw :skip nil))
  4354. (setq tmp (buffer-substring (max (point-min)
  4355. (- b0 org-ds-keyword-length))
  4356. b0)
  4357. timestr (if b3 "" (buffer-substring b0 (point-at-eol)))
  4358. inactivep (= (char-after b0) ?\[)
  4359. deadlinep (string-match org-deadline-regexp tmp)
  4360. scheduledp (string-match org-scheduled-regexp tmp)
  4361. closedp (and org-agenda-include-inactive-timestamps
  4362. (string-match org-closed-string tmp))
  4363. clockp (and org-agenda-include-inactive-timestamps
  4364. (or (string-match org-clock-string tmp)
  4365. (string-match "]-+\\'" tmp)))
  4366. donep (member todo-state org-done-keywords))
  4367. (if (or scheduledp deadlinep closedp clockp
  4368. (and donep org-agenda-skip-timestamp-if-done))
  4369. (throw :skip t))
  4370. (if (string-match ">" timestr)
  4371. ;; substring should only run to end of time stamp
  4372. (setq timestr (substring timestr 0 (match-end 0))))
  4373. (setq marker (org-agenda-new-marker b0)
  4374. category (org-get-category b0))
  4375. (save-excursion
  4376. (if (not (re-search-backward "^\\*+ " nil t))
  4377. (setq txt org-agenda-no-heading-message)
  4378. (goto-char (match-beginning 0))
  4379. (setq hdmarker (org-agenda-new-marker)
  4380. tags (org-get-tags-at))
  4381. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  4382. (setq head (or (match-string 1) ""))
  4383. (setq txt (org-format-agenda-item
  4384. (if inactivep org-agenda-inactive-leader nil)
  4385. head category tags timestr
  4386. remove-re)))
  4387. (setq priority (org-get-priority txt))
  4388. (org-add-props txt props
  4389. 'org-marker marker 'org-hd-marker hdmarker)
  4390. (org-add-props txt nil 'priority priority
  4391. 'org-category category 'date date
  4392. 'todo-state todo-state
  4393. 'type "timestamp")
  4394. (push txt ee))
  4395. (if org-agenda-skip-additional-timestamps-same-entry
  4396. (outline-next-heading)
  4397. (goto-char end-of-match))))
  4398. (nreverse ee)))
  4399. (defun org-agenda-get-sexps ()
  4400. "Return the sexp information for agenda display."
  4401. (require 'diary-lib)
  4402. (let* ((props (list 'mouse-face 'highlight
  4403. 'help-echo
  4404. (format "mouse-2 or RET jump to org file %s"
  4405. (abbreviate-file-name buffer-file-name))))
  4406. (regexp "^&?%%(")
  4407. marker category ee txt tags entry result beg b sexp sexp-entry
  4408. todo-state)
  4409. (goto-char (point-min))
  4410. (while (re-search-forward regexp nil t)
  4411. (catch :skip
  4412. (org-agenda-skip)
  4413. (setq beg (match-beginning 0))
  4414. (goto-char (1- (match-end 0)))
  4415. (setq b (point))
  4416. (forward-sexp 1)
  4417. (setq sexp (buffer-substring b (point)))
  4418. (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
  4419. (org-trim (match-string 1))
  4420. ""))
  4421. (setq result (org-diary-sexp-entry sexp sexp-entry date))
  4422. (when result
  4423. (setq marker (org-agenda-new-marker beg)
  4424. category (org-get-category beg)
  4425. todo-state (org-get-todo-state))
  4426. (dolist (r (if (stringp result)
  4427. (list result)
  4428. result)) ;; we expect a list here
  4429. (if (string-match "\\S-" r)
  4430. (setq txt r)
  4431. (setq txt "SEXP entry returned empty string"))
  4432. (setq txt (org-format-agenda-item
  4433. "" txt category tags 'time))
  4434. (org-add-props txt props 'org-marker marker)
  4435. (org-add-props txt nil
  4436. 'org-category category 'date date 'todo-state todo-state
  4437. 'type "sexp")
  4438. (push txt ee)))))
  4439. (nreverse ee)))
  4440. ;; Calendar sanity: define some functions that are independent of
  4441. ;; `calendar-date-style'.
  4442. ;; Normally I would like to use ISO format when calling the diary functions,
  4443. ;; but to make sure we still have Emacs 22 compatibility we bind
  4444. ;; also `european-calendar-style' and use european format
  4445. (defun org-anniversary (year month day &optional mark)
  4446. "Like `diary-anniversary', but with fixed (ISO) order of arguments."
  4447. (org-no-warnings
  4448. (let ((calendar-date-style 'european) (european-calendar-style t))
  4449. (diary-anniversary day month year mark))))
  4450. (defun org-cyclic (N year month day &optional mark)
  4451. "Like `diary-cyclic', but with fixed (ISO) order of arguments."
  4452. (org-no-warnings
  4453. (let ((calendar-date-style 'european) (european-calendar-style t))
  4454. (diary-cyclic N day month year mark))))
  4455. (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
  4456. "Like `diary-block', but with fixed (ISO) order of arguments."
  4457. (org-no-warnings
  4458. (let ((calendar-date-style 'european) (european-calendar-style t))
  4459. (diary-block D1 M1 Y1 D2 M2 Y2 mark))))
  4460. (defun org-date (year month day &optional mark)
  4461. "Like `diary-date', but with fixed (ISO) order of arguments."
  4462. (org-no-warnings
  4463. (let ((calendar-date-style 'european) (european-calendar-style t))
  4464. (diary-date day month year mark))))
  4465. (defalias 'org-float 'diary-float)
  4466. ;; Define the` org-class' function
  4467. (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
  4468. "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
  4469. DAYNAME is a number between 0 (Sunday) and 6 (Saturday). SKIP-WEEKS
  4470. is any number of ISO weeks in the block period for which the item should
  4471. be skipped."
  4472. (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
  4473. (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
  4474. (d (calendar-absolute-from-gregorian date)))
  4475. (and
  4476. (<= date1 d)
  4477. (<= d date2)
  4478. (= (calendar-day-of-week date) dayname)
  4479. (or (not skip-weeks)
  4480. (progn
  4481. (require 'cal-iso)
  4482. (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
  4483. entry)))
  4484. (defun org-diary-class (m1 d1 y1 m2 d2 y2 dayname &rest skip-weeks)
  4485. "Like `org-class', but honor `calendar-date-style'.
  4486. The order of the first 2 times 3 arguments depends on the variable
  4487. `calendar-date-style' or, if that is not defined, on `european-calendar-style'.
  4488. So for American calendars, give this as MONTH DAY YEAR, for European as
  4489. DAY MONTH YEAR, and for ISO as YEAR MONTH DAY.
  4490. DAYNAME is a number between 0 (Sunday) and 6 (Saturday). SKIP-WEEKS
  4491. is any number of ISO weeks in the block period for which the item should
  4492. be skipped.
  4493. This function is here only for backward compatibility and it is deprecated,
  4494. please use `org-class' instead."
  4495. (let* ((date1 (calendar-absolute-from-gregorian
  4496. (org-order-calendar-date-args m1 d1 y1)))
  4497. (date2 (calendar-absolute-from-gregorian
  4498. (org-order-calendar-date-args m2 d2 y2)))
  4499. (d (calendar-absolute-from-gregorian date)))
  4500. (org-class
  4501. (nth 2 date1) (car date1) (nth 1 date1)
  4502. (nth 2 date2) (car date2) (nth 1 date2)
  4503. dayname skip-weeks)))
  4504. (defalias 'org-get-closed 'org-agenda-get-progress)
  4505. (defun org-agenda-get-progress ()
  4506. "Return the logged TODO entries for agenda display."
  4507. (let* ((props (list 'mouse-face 'highlight
  4508. 'org-not-done-regexp org-not-done-regexp
  4509. 'org-todo-regexp org-todo-regexp
  4510. 'org-complex-heading-regexp org-complex-heading-regexp
  4511. 'help-echo
  4512. (format "mouse-2 or RET jump to org file %s"
  4513. (abbreviate-file-name buffer-file-name))))
  4514. (items (if (consp org-agenda-show-log)
  4515. org-agenda-show-log
  4516. (if (eq org-agenda-show-log 'clockcheck)
  4517. '(clock)
  4518. org-agenda-log-mode-items)))
  4519. (parts
  4520. (delq nil
  4521. (list
  4522. (if (memq 'closed items) (concat "\\<" org-closed-string))
  4523. (if (memq 'clock items) (concat "\\<" org-clock-string))
  4524. (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
  4525. (parts-re (if parts (mapconcat 'identity parts "\\|")
  4526. (error "`org-agenda-log-mode-items' is empty")))
  4527. (regexp (concat
  4528. "\\(" parts-re "\\)"
  4529. " *\\["
  4530. (regexp-quote
  4531. (substring
  4532. (format-time-string
  4533. (car org-time-stamp-formats)
  4534. (apply 'encode-time ; DATE bound by calendar
  4535. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  4536. 1 11))))
  4537. (org-agenda-search-headline-for-time nil)
  4538. marker hdmarker priority category tags closedp statep clockp state
  4539. ee txt extra timestr rest clocked)
  4540. (goto-char (point-min))
  4541. (while (re-search-forward regexp nil t)
  4542. (catch :skip
  4543. (org-agenda-skip)
  4544. (setq marker (org-agenda-new-marker (match-beginning 0))
  4545. closedp (equal (match-string 1) org-closed-string)
  4546. statep (equal (string-to-char (match-string 1)) ?-)
  4547. clockp (not (or closedp statep))
  4548. state (and statep (match-string 2))
  4549. category (org-get-category (match-beginning 0))
  4550. timestr (buffer-substring (match-beginning 0) (point-at-eol))
  4551. )
  4552. (when (string-match "\\]" timestr)
  4553. ;; substring should only run to end of time stamp
  4554. (setq rest (substring timestr (match-end 0))
  4555. timestr (substring timestr 0 (match-end 0)))
  4556. (if (and (not closedp) (not statep)
  4557. (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)" rest))
  4558. (progn (setq timestr (concat (substring timestr 0 -1)
  4559. "-" (match-string 1 rest) "]"))
  4560. (setq clocked (match-string 2 rest)))
  4561. (setq clocked "-")))
  4562. (save-excursion
  4563. (setq extra
  4564. (cond
  4565. ((not org-agenda-log-mode-add-notes) nil)
  4566. (statep
  4567. (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
  4568. (match-string 1)))
  4569. (clockp
  4570. (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
  4571. (match-string 1)))))
  4572. (if (not (re-search-backward "^\\*+ " nil t))
  4573. (setq txt org-agenda-no-heading-message)
  4574. (goto-char (match-beginning 0))
  4575. (setq hdmarker (org-agenda-new-marker)
  4576. tags (org-get-tags-at))
  4577. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  4578. (setq txt (match-string 1))
  4579. (when extra
  4580. (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
  4581. (setq txt (concat (substring txt 0 (match-beginning 1))
  4582. " - " extra " " (match-string 2 txt)))
  4583. (setq txt (concat txt " - " extra))))
  4584. (setq txt (org-format-agenda-item
  4585. (cond
  4586. (closedp "Closed: ")
  4587. (statep (concat "State: (" state ")"))
  4588. (t (concat "Clocked: (" clocked ")")))
  4589. txt category tags timestr)))
  4590. (setq priority 100000)
  4591. (org-add-props txt props
  4592. 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
  4593. 'priority priority 'org-category category
  4594. 'type "closed" 'date date
  4595. 'undone-face 'org-warning 'done-face 'org-agenda-done)
  4596. (push txt ee))
  4597. (goto-char (point-at-eol))))
  4598. (nreverse ee)))
  4599. (defun org-agenda-show-clocking-issues ()
  4600. "Add overlays, showing issues with clocking.
  4601. See also the user option `org-agenda-clock-consistency-checks'."
  4602. (interactive)
  4603. (let* ((pl org-agenda-clock-consistency-checks)
  4604. (re (concat "^[ \t]*"
  4605. org-clock-string
  4606. "[ \t]+"
  4607. "\\(\\[.*?\\]\\)" ; group 1 is first stamp
  4608. "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
  4609. (tlstart 0.)
  4610. (tlend 0.)
  4611. (maxtime (org-hh:mm-string-to-minutes
  4612. (or (plist-get pl :max-duration) "24:00")))
  4613. (mintime (org-hh:mm-string-to-minutes
  4614. (or (plist-get pl :min-duration) 0)))
  4615. (maxgap (org-hh:mm-string-to-minutes
  4616. ;; default 30:00 means never complain
  4617. (or (plist-get pl :max-gap) "30:00")))
  4618. (gapok (mapcar 'org-hh:mm-string-to-minutes
  4619. (plist-get pl :gap-ok-around)))
  4620. (def-face (or (plist-get pl :default-face)
  4621. '((:background "DarkRed") (:foreground "white"))))
  4622. issue face m te ts dt ov)
  4623. (goto-char (point-min))
  4624. (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
  4625. (setq issue nil face def-face)
  4626. (catch 'next
  4627. (setq m (org-get-at-bol 'org-marker)
  4628. te nil ts nil)
  4629. (unless (and m (markerp m))
  4630. (setq issue "No valid clock line") (throw 'next t))
  4631. (org-with-point-at m
  4632. (save-excursion
  4633. (goto-char (point-at-bol))
  4634. (unless (looking-at re)
  4635. (error "No valid Clock line")
  4636. (throw 'next t))
  4637. (unless (match-end 3)
  4638. (setq issue "No end time"
  4639. face (or (plist-get pl :no-end-time-face) face))
  4640. (throw 'next t))
  4641. (setq ts (match-string 1)
  4642. te (match-string 3)
  4643. ts (org-float-time
  4644. (apply 'encode-time (org-parse-time-string ts)))
  4645. te (org-float-time
  4646. (apply 'encode-time (org-parse-time-string te)))
  4647. dt (- te ts))))
  4648. (cond
  4649. ((> dt (* 60 maxtime))
  4650. ;; a very long clocking chunk
  4651. (setq issue (format "Clocking interval is very long: %s"
  4652. (org-minutes-to-hh:mm-string
  4653. (floor (/ (float dt) 60.))))
  4654. face (or (plist-get pl :long-face) face)))
  4655. ((< dt (* 60 mintime))
  4656. ;; a very short clocking chunk
  4657. (setq issue (format "Clocking interval is very short: %s"
  4658. (org-minutes-to-hh:mm-string
  4659. (floor (/ (float dt) 60.))))
  4660. face (or (plist-get pl :short-face) face)))
  4661. ((and (> tlend 0) (< ts tlend))
  4662. ;; Two clock entries are overlapping
  4663. (setq issue (format "Clocking overlap: %d minutes"
  4664. (/ (- tlend ts) 60))
  4665. face (or (plist-get pl :overlap-face) face)))
  4666. ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
  4667. ;; There is a gap, lets see if we need to report it
  4668. (unless (org-agenda-check-clock-gap tlend ts gapok)
  4669. (setq issue (format "Clocking gap: %d minutes"
  4670. (/ (- ts tlend) 60))
  4671. face (or (plist-get pl :gap-face) face))))
  4672. (t nil)))
  4673. (setq tlend (or te tlend) tlstart (or ts tlstart))
  4674. (when issue
  4675. ;; OK, there was some issue, add an overlay to show the issue
  4676. (setq ov (make-overlay (point-at-bol) (point-at-eol)))
  4677. (overlay-put ov 'before-string
  4678. (concat
  4679. (org-add-props
  4680. (format "%-43s" (concat " " issue))
  4681. nil
  4682. 'face face)
  4683. "\n"))
  4684. (overlay-put ov 'evaporate t)))))
  4685. (defun org-agenda-check-clock-gap (t1 t2 ok-list)
  4686. "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
  4687. (catch 'exit
  4688. (unless ok-list
  4689. ;; there are no OK times for gaps...
  4690. (throw 'exit nil))
  4691. (if (> (- (/ t2 36000) (/ t1 36000)) 24)
  4692. ;; This is more than 24 hours, so it is OK.
  4693. ;; because we have at least one OK time, that must be in the
  4694. ;; 24 hour interval.
  4695. (throw 'exit t))
  4696. ;; We have a shorter gap.
  4697. ;; Now we have to get the minute of the day when these times are
  4698. (let* ((t1dec (decode-time (seconds-to-time t1)))
  4699. (t2dec (decode-time (seconds-to-time t2)))
  4700. ;; compute the minute on the day
  4701. (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
  4702. (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
  4703. (when (< min2 min1)
  4704. ;; if min2 is smaller than min1, this means it is on the next day.
  4705. ;; Wrap it to after midnight.
  4706. (setq min2 (+ min2 1440)))
  4707. ;; Now check if any of the OK times is in the gap
  4708. (mapc (lambda (x)
  4709. ;; Wrap the time to after midnight if necessary
  4710. (if (< x min1) (setq x (+ x 1440)))
  4711. ;; Check if in interval
  4712. (and (<= min1 x) (>= min2 x) (throw 'exit t)))
  4713. ok-list)
  4714. ;; Nope, this gap is not OK
  4715. nil)))
  4716. (defun org-agenda-get-deadlines ()
  4717. "Return the deadline information for agenda display."
  4718. (let* ((props (list 'mouse-face 'highlight
  4719. 'org-not-done-regexp org-not-done-regexp
  4720. 'org-todo-regexp org-todo-regexp
  4721. 'org-complex-heading-regexp org-complex-heading-regexp
  4722. 'help-echo
  4723. (format "mouse-2 or RET jump to org file %s"
  4724. (abbreviate-file-name buffer-file-name))))
  4725. (regexp org-deadline-time-regexp)
  4726. (todayp (org-agenda-todayp date)) ; DATE bound by calendar
  4727. (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
  4728. d2 diff dfrac wdays pos pos1 category tags
  4729. suppress-prewarning
  4730. ee txt head face s todo-state show-all upcomingp donep timestr)
  4731. (goto-char (point-min))
  4732. (while (re-search-forward regexp nil t)
  4733. (setq suppress-prewarning nil)
  4734. (catch :skip
  4735. (org-agenda-skip)
  4736. (when (and org-agenda-skip-deadline-prewarning-if-scheduled
  4737. (save-match-data
  4738. (string-match org-scheduled-time-regexp
  4739. (buffer-substring (point-at-bol)
  4740. (point-at-eol)))))
  4741. (setq suppress-prewarning
  4742. (if (integerp org-agenda-skip-deadline-prewarning-if-scheduled)
  4743. org-agenda-skip-deadline-prewarning-if-scheduled
  4744. 0)))
  4745. (setq s (match-string 1)
  4746. txt nil
  4747. pos (1- (match-beginning 1))
  4748. todo-state (save-match-data (org-get-todo-state))
  4749. show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  4750. (member todo-state
  4751. org-agenda-repeating-timestamp-show-all))
  4752. d2 (org-time-string-to-absolute
  4753. (match-string 1) d1 'past show-all)
  4754. diff (- d2 d1)
  4755. wdays (if suppress-prewarning
  4756. (let ((org-deadline-warning-days suppress-prewarning))
  4757. (org-get-wdays s))
  4758. (org-get-wdays s))
  4759. dfrac (/ (* 1.0 (- wdays diff)) (max wdays 1))
  4760. upcomingp (and todayp (> diff 0)))
  4761. ;; When to show a deadline in the calendar:
  4762. ;; If the expiration is within wdays warning time.
  4763. ;; Past-due deadlines are only shown on the current date
  4764. (if (and (or (and (<= diff wdays)
  4765. (and todayp (not org-agenda-only-exact-dates)))
  4766. (= diff 0)))
  4767. (save-excursion
  4768. ;; (setq todo-state (org-get-todo-state))
  4769. (setq donep (member todo-state org-done-keywords))
  4770. (if (and donep
  4771. (or org-agenda-skip-deadline-if-done
  4772. (not (= diff 0))))
  4773. (setq txt nil)
  4774. (setq category (org-get-category))
  4775. (if (not (re-search-backward "^\\*+[ \t]+" nil t))
  4776. (setq txt org-agenda-no-heading-message)
  4777. (goto-char (match-end 0))
  4778. (setq pos1 (match-beginning 0))
  4779. (setq tags (org-get-tags-at pos1))
  4780. (setq head (buffer-substring-no-properties
  4781. (point)
  4782. (progn (skip-chars-forward "^\r\n")
  4783. (point))))
  4784. (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  4785. (setq timestr
  4786. (concat (substring s (match-beginning 1)) " "))
  4787. (setq timestr 'time))
  4788. (setq txt (org-format-agenda-item
  4789. (if (= diff 0)
  4790. (car org-agenda-deadline-leaders)
  4791. (if (functionp
  4792. (nth 1 org-agenda-deadline-leaders))
  4793. (funcall
  4794. (nth 1 org-agenda-deadline-leaders)
  4795. diff date)
  4796. (format (nth 1 org-agenda-deadline-leaders)
  4797. diff)))
  4798. head category tags
  4799. (if (not (= diff 0)) nil timestr)))))
  4800. (when txt
  4801. (setq face (org-agenda-deadline-face dfrac wdays))
  4802. (org-add-props txt props
  4803. 'org-marker (org-agenda-new-marker pos)
  4804. 'org-hd-marker (org-agenda-new-marker pos1)
  4805. 'priority (+ (- diff)
  4806. (org-get-priority txt))
  4807. 'org-category category
  4808. 'todo-state todo-state
  4809. 'type (if upcomingp "upcoming-deadline" "deadline")
  4810. 'date (if upcomingp date d2)
  4811. 'face (if donep 'org-agenda-done face)
  4812. 'undone-face face 'done-face 'org-agenda-done)
  4813. (push txt ee))))))
  4814. (nreverse ee)))
  4815. (defun org-agenda-deadline-face (fraction &optional wdays)
  4816. "Return the face to displaying a deadline item.
  4817. FRACTION is what fraction of the head-warning time has passed."
  4818. (if (equal wdays 0) (setq fraction 1.))
  4819. (let ((faces org-agenda-deadline-faces) f)
  4820. (catch 'exit
  4821. (while (setq f (pop faces))
  4822. (if (>= fraction (car f)) (throw 'exit (cdr f)))))))
  4823. (defun org-agenda-get-scheduled (&optional deadline-results)
  4824. "Return the scheduled information for agenda display."
  4825. (let* ((props (list 'org-not-done-regexp org-not-done-regexp
  4826. 'org-todo-regexp org-todo-regexp
  4827. 'org-complex-heading-regexp org-complex-heading-regexp
  4828. 'done-face 'org-agenda-done
  4829. 'mouse-face 'highlight
  4830. 'help-echo
  4831. (format "mouse-2 or RET jump to org file %s"
  4832. (abbreviate-file-name buffer-file-name))))
  4833. (regexp org-scheduled-time-regexp)
  4834. (todayp (org-agenda-todayp date)) ; DATE bound by calendar
  4835. (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
  4836. mm
  4837. (deadline-position-alist
  4838. (mapcar (lambda (a) (and (setq mm (get-text-property
  4839. 0 'org-hd-marker a))
  4840. (cons (marker-position mm) a)))
  4841. deadline-results))
  4842. d2 diff pos pos1 category tags donep
  4843. ee txt head pastschedp todo-state face timestr s habitp show-all)
  4844. (goto-char (point-min))
  4845. (while (re-search-forward regexp nil t)
  4846. (catch :skip
  4847. (org-agenda-skip)
  4848. (setq s (match-string 1)
  4849. txt nil
  4850. pos (1- (match-beginning 1))
  4851. todo-state (save-match-data (org-get-todo-state))
  4852. show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  4853. (member todo-state
  4854. org-agenda-repeating-timestamp-show-all))
  4855. d2 (org-time-string-to-absolute
  4856. (match-string 1) d1 'past show-all)
  4857. diff (- d2 d1))
  4858. (setq pastschedp (and todayp (< diff 0)))
  4859. ;; When to show a scheduled item in the calendar:
  4860. ;; If it is on or past the date.
  4861. (when (or (and (< diff 0)
  4862. (< (abs diff) org-scheduled-past-days)
  4863. (and todayp (not org-agenda-only-exact-dates)))
  4864. (= diff 0))
  4865. (save-excursion
  4866. (setq donep (member todo-state org-done-keywords))
  4867. (if (and donep
  4868. (or org-agenda-skip-scheduled-if-done
  4869. (not (= diff 0))
  4870. (and (functionp 'org-is-habit-p)
  4871. (org-is-habit-p))))
  4872. (setq txt nil)
  4873. (setq habitp (and (functionp 'org-is-habit-p)
  4874. (org-is-habit-p)))
  4875. (setq category (org-get-category))
  4876. (if (not (re-search-backward "^\\*+[ \t]+" nil t))
  4877. (setq txt org-agenda-no-heading-message)
  4878. (goto-char (match-end 0))
  4879. (setq pos1 (match-beginning 0))
  4880. (if habitp
  4881. (if (or (not org-habit-show-habits)
  4882. (and (not todayp)
  4883. org-habit-show-habits-only-for-today))
  4884. (throw :skip nil))
  4885. (if (and
  4886. (or (eq t org-agenda-skip-scheduled-if-deadline-is-shown)
  4887. (and org-agenda-skip-scheduled-if-deadline-is-shown
  4888. pastschedp))
  4889. (setq mm (assoc pos1 deadline-position-alist)))
  4890. (throw :skip nil)))
  4891. (setq tags (org-get-tags-at))
  4892. (setq head (buffer-substring-no-properties
  4893. (point)
  4894. (progn (skip-chars-forward "^\r\n") (point))))
  4895. (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  4896. (setq timestr
  4897. (concat (substring s (match-beginning 1)) " "))
  4898. (setq timestr 'time))
  4899. (setq txt (org-format-agenda-item
  4900. (if (= diff 0)
  4901. (car org-agenda-scheduled-leaders)
  4902. (format (nth 1 org-agenda-scheduled-leaders)
  4903. (- 1 diff)))
  4904. head category tags
  4905. (if (not (= diff 0)) nil timestr)
  4906. nil habitp))))
  4907. (when txt
  4908. (setq face
  4909. (cond
  4910. ((and (not habitp) pastschedp)
  4911. 'org-scheduled-previously)
  4912. (todayp 'org-scheduled-today)
  4913. (t 'org-scheduled))
  4914. habitp (and habitp (org-habit-parse-todo)))
  4915. (org-add-props txt props
  4916. 'undone-face face
  4917. 'face (if donep 'org-agenda-done face)
  4918. 'org-marker (org-agenda-new-marker pos)
  4919. 'org-hd-marker (org-agenda-new-marker pos1)
  4920. 'type (if pastschedp "past-scheduled" "scheduled")
  4921. 'date (if pastschedp d2 date)
  4922. 'priority (if habitp
  4923. (org-habit-get-priority habitp)
  4924. (+ 94 (- 5 diff) (org-get-priority txt)))
  4925. 'org-category category
  4926. 'org-habit-p habitp
  4927. 'todo-state todo-state)
  4928. (push txt ee))))))
  4929. (nreverse ee)))
  4930. (defun org-agenda-get-blocks ()
  4931. "Return the date-range information for agenda display."
  4932. (let* ((props (list 'face nil
  4933. 'org-not-done-regexp org-not-done-regexp
  4934. 'org-todo-regexp org-todo-regexp
  4935. 'org-complex-heading-regexp org-complex-heading-regexp
  4936. 'mouse-face 'highlight
  4937. 'help-echo
  4938. (format "mouse-2 or RET jump to org file %s"
  4939. (abbreviate-file-name buffer-file-name))))
  4940. (regexp org-tr-regexp)
  4941. (d0 (calendar-absolute-from-gregorian date))
  4942. marker hdmarker ee txt d1 d2 s1 s2 category todo-state tags pos
  4943. head donep)
  4944. (goto-char (point-min))
  4945. (while (re-search-forward regexp nil t)
  4946. (catch :skip
  4947. (org-agenda-skip)
  4948. (setq pos (point))
  4949. (let ((start-time (match-string 1))
  4950. (end-time (match-string 2)))
  4951. (setq s1 (match-string 1)
  4952. s2 (match-string 2)
  4953. d1 (time-to-days (org-time-string-to-time s1))
  4954. d2 (time-to-days (org-time-string-to-time s2)))
  4955. (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
  4956. ;; Only allow days between the limits, because the normal
  4957. ;; date stamps will catch the limits.
  4958. (save-excursion
  4959. (setq todo-state (org-get-todo-state))
  4960. (setq donep (member todo-state org-done-keywords))
  4961. (if (and donep org-agenda-skip-timestamp-if-done)
  4962. (throw :skip t))
  4963. (setq marker (org-agenda-new-marker (point)))
  4964. (setq category (org-get-category))
  4965. (if (not (re-search-backward "^\\*+ " nil t))
  4966. (setq txt org-agenda-no-heading-message)
  4967. (goto-char (match-beginning 0))
  4968. (setq hdmarker (org-agenda-new-marker (point)))
  4969. (setq tags (org-get-tags-at))
  4970. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  4971. (setq head (match-string 1))
  4972. (let ((remove-re
  4973. (if org-agenda-remove-timeranges-from-blocks
  4974. (concat
  4975. "<" (regexp-quote s1) ".*?>"
  4976. "--"
  4977. "<" (regexp-quote s2) ".*?>")
  4978. nil)))
  4979. (setq txt (org-format-agenda-item
  4980. (format
  4981. (nth (if (= d1 d2) 0 1)
  4982. org-agenda-timerange-leaders)
  4983. (1+ (- d0 d1)) (1+ (- d2 d1)))
  4984. head category tags
  4985. (cond ((= d1 d0)
  4986. (concat "<" start-time ">"))
  4987. ((= d2 d0)
  4988. (concat "<" end-time ">"))
  4989. (t nil))
  4990. remove-re))))
  4991. (org-add-props txt props
  4992. 'org-marker marker 'org-hd-marker hdmarker
  4993. 'type "block" 'date date
  4994. 'todo-state todo-state
  4995. 'priority (org-get-priority txt) 'org-category category)
  4996. (push txt ee))))
  4997. (goto-char pos)))
  4998. ;; Sort the entries by expiration date.
  4999. (nreverse ee)))
  5000. ;;; Agenda presentation and sorting
  5001. (defvar org-prefix-has-time nil
  5002. "A flag, set by `org-compile-prefix-format'.
  5003. The flag is set if the currently compiled format contains a `%t'.")
  5004. (defvar org-prefix-has-tag nil
  5005. "A flag, set by `org-compile-prefix-format'.
  5006. The flag is set if the currently compiled format contains a `%T'.")
  5007. (defvar org-prefix-has-effort nil
  5008. "A flag, set by `org-compile-prefix-format'.
  5009. The flag is set if the currently compiled format contains a `%e'.")
  5010. (defvar org-prefix-category-length nil
  5011. "Used by `org-compile-prefix-format' to remember the category field width.")
  5012. (defvar org-prefix-category-max-length nil
  5013. "Used by `org-compile-prefix-format' to remember the category field width.")
  5014. (defun org-agenda-get-category-icon (category)
  5015. "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
  5016. (dolist (entry org-agenda-category-icon-alist)
  5017. (when (org-string-match-p (car entry) category)
  5018. (if (listp (cadr entry))
  5019. (return (cadr entry))
  5020. (return (apply 'create-image (cdr entry)))))))
  5021. (defun org-format-agenda-item (extra txt &optional category tags dotime
  5022. remove-re habitp)
  5023. "Format TXT to be inserted into the agenda buffer.
  5024. In particular, it adds the prefix and corresponding text properties. EXTRA
  5025. must be a string and replaces the `%s' specifier in the prefix format.
  5026. CATEGORY (string, symbol or nil) may be used to overrule the default
  5027. category taken from local variable or file name. It will replace the `%c'
  5028. specifier in the format. DOTIME, when non-nil, indicates that a
  5029. time-of-day should be extracted from TXT for sorting of this entry, and for
  5030. the `%t' specifier in the format. When DOTIME is a string, this string is
  5031. searched for a time before TXT is. TAGS can be the tags of the headline.
  5032. Any match of REMOVE-RE will be removed from TXT."
  5033. (save-match-data
  5034. ;; Diary entries sometimes have extra whitespace at the beginning
  5035. (if (string-match "^ +" txt) (setq txt (replace-match "" nil nil txt)))
  5036. ;; Fix the tags part in txt
  5037. (setq txt (org-agenda-fix-displayed-tags
  5038. txt tags
  5039. org-agenda-show-inherited-tags
  5040. org-agenda-hide-tags-regexp))
  5041. (let* ((category (or category
  5042. (if (stringp org-category)
  5043. org-category
  5044. (and org-category (symbol-name org-category)))
  5045. (if buffer-file-name
  5046. (file-name-sans-extension
  5047. (file-name-nondirectory buffer-file-name))
  5048. "")))
  5049. (category-icon (org-agenda-get-category-icon category))
  5050. (category-icon (if category-icon
  5051. (propertize " " 'display category-icon)
  5052. ""))
  5053. ;; time, tag, effort are needed for the eval of the prefix format
  5054. (tag (if tags (nth (1- (length tags)) tags) ""))
  5055. time effort neffort
  5056. (ts (if dotime (concat
  5057. (if (stringp dotime) dotime "")
  5058. (and org-agenda-search-headline-for-time txt))))
  5059. (time-of-day (and dotime (org-get-time-of-day ts)))
  5060. stamp plain s0 s1 s2 rtn srp l
  5061. duration thecategory)
  5062. (and (org-mode-p) buffer-file-name
  5063. (add-to-list 'org-agenda-contributing-files buffer-file-name))
  5064. (when (and dotime time-of-day)
  5065. ;; Extract starting and ending time and move them to prefix
  5066. (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
  5067. (setq plain (string-match org-plain-time-of-day-regexp ts)))
  5068. (setq s0 (match-string 0 ts)
  5069. srp (and stamp (match-end 3))
  5070. s1 (match-string (if plain 1 2) ts)
  5071. s2 (match-string (if plain 8 (if srp 4 6)) ts))
  5072. ;; If the times are in TXT (not in DOTIMES), and the prefix will list
  5073. ;; them, we might want to remove them there to avoid duplication.
  5074. ;; The user can turn this off with a variable.
  5075. (if (and org-prefix-has-time
  5076. org-agenda-remove-times-when-in-prefix (or stamp plain)
  5077. (string-match (concat (regexp-quote s0) " *") txt)
  5078. (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
  5079. (if (eq org-agenda-remove-times-when-in-prefix 'beg)
  5080. (= (match-beginning 0) 0)
  5081. t))
  5082. (setq txt (replace-match "" nil nil txt))))
  5083. ;; Normalize the time(s) to 24 hour
  5084. (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
  5085. (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
  5086. ;; Try to set s2 if s1 and `org-agenda-default-appointment-duration' are set
  5087. (when (and s1 (not s2) org-agenda-default-appointment-duration)
  5088. (setq s2
  5089. (org-minutes-to-hh:mm-string
  5090. (+ (org-hh:mm-string-to-minutes s1) org-agenda-default-appointment-duration))))
  5091. ;; Compute the duration
  5092. (when s2
  5093. (setq duration (- (org-hh:mm-string-to-minutes s2)
  5094. (org-hh:mm-string-to-minutes s1)))))
  5095. (when (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
  5096. txt)
  5097. ;; Tags are in the string
  5098. (if (or (eq org-agenda-remove-tags t)
  5099. (and org-agenda-remove-tags
  5100. org-prefix-has-tag))
  5101. (setq txt (replace-match "" t t txt))
  5102. (setq txt (replace-match
  5103. (concat (make-string (max (- 50 (length txt)) 1) ?\ )
  5104. (match-string 2 txt))
  5105. t t txt))))
  5106. (when (org-mode-p)
  5107. (setq effort
  5108. (condition-case nil
  5109. (org-get-effort
  5110. (or (get-text-property 0 'org-hd-marker txt)
  5111. (get-text-property 0 'org-marker txt)))
  5112. (error nil)))
  5113. (when effort
  5114. (setq neffort (org-duration-string-to-minutes effort)
  5115. effort (setq effort (concat "[" effort "]" )))))
  5116. (when remove-re
  5117. (while (string-match remove-re txt)
  5118. (setq txt (replace-match "" t t txt))))
  5119. ;; Set org-heading property on `txt' to mark the start of the
  5120. ;; heading.
  5121. (add-text-properties 0 (length txt) '(org-heading t) txt)
  5122. ;; Prepare the variables needed in the eval of the compiled format
  5123. (setq time (cond (s2 (concat
  5124. (org-agenda-time-of-day-to-ampm-maybe s1)
  5125. "-" (org-agenda-time-of-day-to-ampm-maybe s2)
  5126. (if org-agenda-timegrid-use-ampm " ")))
  5127. (s1 (concat
  5128. (org-agenda-time-of-day-to-ampm-maybe s1)
  5129. (if org-agenda-timegrid-use-ampm
  5130. "........ "
  5131. "......")))
  5132. (t ""))
  5133. extra (or (and (not habitp) extra) "")
  5134. category (if (symbolp category) (symbol-name category) category)
  5135. thecategory (copy-sequence category))
  5136. (if (string-match org-bracket-link-regexp category)
  5137. (progn
  5138. (setq l (if (match-end 3)
  5139. (- (match-end 3) (match-beginning 3))
  5140. (- (match-end 1) (match-beginning 1))))
  5141. (when (< l (or org-prefix-category-length 0))
  5142. (setq category (copy-sequence category))
  5143. (org-add-props category nil
  5144. 'extra-space (make-string
  5145. (- org-prefix-category-length l 1) ?\ ))))
  5146. (if (and org-prefix-category-max-length
  5147. (>= (length category) org-prefix-category-max-length))
  5148. (setq category (substring category 0 (1- org-prefix-category-max-length)))))
  5149. ;; Evaluate the compiled format
  5150. (setq rtn (concat (eval org-prefix-format-compiled) txt))
  5151. ;; And finally add the text properties
  5152. (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
  5153. (org-add-props rtn nil
  5154. 'org-category (if thecategory (downcase thecategory) category)
  5155. 'tags (mapcar 'org-downcase-keep-props tags)
  5156. 'org-highest-priority org-highest-priority
  5157. 'org-lowest-priority org-lowest-priority
  5158. 'time-of-day time-of-day
  5159. 'duration duration
  5160. 'effort effort
  5161. 'effort-minutes neffort
  5162. 'txt txt
  5163. 'time time
  5164. 'extra extra
  5165. 'dotime dotime))))
  5166. (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
  5167. "Remove tags string from TXT, and add a modified list of tags.
  5168. The modified list may contain inherited tags, and tags matched by
  5169. `org-agenda-hide-tags-regexp' will be removed."
  5170. (when (or add-inherited hide-re)
  5171. (if (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") txt)
  5172. (setq txt (substring txt 0 (match-beginning 0))))
  5173. (setq tags
  5174. (delq nil
  5175. (mapcar (lambda (tg)
  5176. (if (or (and hide-re (string-match hide-re tg))
  5177. (and (not add-inherited)
  5178. (get-text-property 0 'inherited tg)))
  5179. nil
  5180. tg))
  5181. tags)))
  5182. (when tags
  5183. (let ((have-i (get-text-property 0 'inherited (car tags)))
  5184. i)
  5185. (setq txt (concat txt " :"
  5186. (mapconcat
  5187. (lambda (x)
  5188. (setq i (get-text-property 0 'inherited x))
  5189. (if (and have-i (not i))
  5190. (progn
  5191. (setq have-i nil)
  5192. (concat ":" x))
  5193. x))
  5194. tags ":")
  5195. (if have-i "::" ":"))))))
  5196. txt)
  5197. (defun org-downcase-keep-props (s)
  5198. (let ((props (text-properties-at 0 s)))
  5199. (setq s (downcase s))
  5200. (add-text-properties 0 (length s) props s)
  5201. s))
  5202. (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
  5203. (defvar org-agenda-sorting-strategy-selected nil)
  5204. (defun org-agenda-add-time-grid-maybe (list ndays todayp)
  5205. (catch 'exit
  5206. (cond ((not org-agenda-use-time-grid) (throw 'exit list))
  5207. ((and todayp (member 'today (car org-agenda-time-grid))))
  5208. ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
  5209. ((member 'weekly (car org-agenda-time-grid)))
  5210. (t (throw 'exit list)))
  5211. (let* ((have (delq nil (mapcar
  5212. (lambda (x) (get-text-property 1 'time-of-day x))
  5213. list)))
  5214. (string (nth 1 org-agenda-time-grid))
  5215. (gridtimes (nth 2 org-agenda-time-grid))
  5216. (req (car org-agenda-time-grid))
  5217. (remove (member 'remove-match req))
  5218. new time)
  5219. (if (and (member 'require-timed req) (not have))
  5220. ;; don't show empty grid
  5221. (throw 'exit list))
  5222. (while (setq time (pop gridtimes))
  5223. (unless (and remove (member time have))
  5224. (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
  5225. (push (org-format-agenda-item
  5226. nil string "" nil
  5227. (concat (substring time 0 -2) ":" (substring time -2)))
  5228. new)
  5229. (put-text-property
  5230. 2 (length (car new)) 'face 'org-time-grid (car new))))
  5231. (when (and todayp org-agenda-show-current-time-in-grid)
  5232. (push (org-format-agenda-item
  5233. nil
  5234. org-agenda-current-time-string
  5235. "" nil
  5236. (format-time-string "%H:%M "))
  5237. new)
  5238. (put-text-property
  5239. 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
  5240. (if (member 'time-up org-agenda-sorting-strategy-selected)
  5241. (append new list)
  5242. (append list new)))))
  5243. (defun org-compile-prefix-format (key)
  5244. "Compile the prefix format into a Lisp form that can be evaluated.
  5245. The resulting form is returned and stored in the variable
  5246. `org-prefix-format-compiled'."
  5247. (setq org-prefix-has-time nil org-prefix-has-tag nil
  5248. org-prefix-category-length nil org-prefix-has-effort nil)
  5249. (let ((s (cond
  5250. ((stringp org-agenda-prefix-format)
  5251. org-agenda-prefix-format)
  5252. ((assq key org-agenda-prefix-format)
  5253. (cdr (assq key org-agenda-prefix-format)))
  5254. (t " %-12:c%?-12t% s")))
  5255. (start 0)
  5256. varform vars var e c f opt)
  5257. (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([ctsei]\\|(.+)\\)"
  5258. s start)
  5259. (setq var (or (cdr (assoc (match-string 4 s)
  5260. '(("c" . category) ("t" . time) ("s" . extra)
  5261. ("i" . category-icon) ("T" . tag) ("e" . effort))))
  5262. 'eval)
  5263. c (or (match-string 3 s) "")
  5264. opt (match-beginning 1)
  5265. start (1+ (match-beginning 0)))
  5266. (if (equal var 'time) (setq org-prefix-has-time t))
  5267. (if (equal var 'tag) (setq org-prefix-has-tag t))
  5268. (if (equal var 'effort) (setq org-prefix-has-effort t))
  5269. (setq f (concat "%" (match-string 2 s) "s"))
  5270. (when (equal var 'category)
  5271. (setq org-prefix-category-length
  5272. (floor (abs (string-to-number (match-string 2 s)))))
  5273. (setq org-prefix-category-max-length
  5274. (let ((x (match-string 2 s)))
  5275. (save-match-data
  5276. (if (string-match "\\.[0-9]+" x)
  5277. (string-to-number (substring (match-string 0 x) 1)))))))
  5278. (if (eq var 'eval)
  5279. (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
  5280. (if opt
  5281. (setq varform
  5282. `(if (equal "" ,var)
  5283. ""
  5284. (format ,f (if (equal "" ,var) "" (concat ,var ,c)))))
  5285. (setq varform `(format ,f (if (equal ,var "") "" (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
  5286. (setq s (replace-match "%s" t nil s))
  5287. (push varform vars))
  5288. (setq vars (nreverse vars))
  5289. (setq org-prefix-format-compiled `(format ,s ,@vars))))
  5290. (defun org-set-sorting-strategy (key)
  5291. (if (symbolp (car org-agenda-sorting-strategy))
  5292. ;; the old format
  5293. (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
  5294. (setq org-agenda-sorting-strategy-selected
  5295. (or (cdr (assq key org-agenda-sorting-strategy))
  5296. (cdr (assq 'agenda org-agenda-sorting-strategy))
  5297. '(time-up category-keep priority-down)))))
  5298. (defun org-get-time-of-day (s &optional string mod24)
  5299. "Check string S for a time of day.
  5300. If found, return it as a military time number between 0 and 2400.
  5301. If not found, return nil.
  5302. The optional STRING argument forces conversion into a 5 character wide string
  5303. HH:MM."
  5304. (save-match-data
  5305. (when
  5306. (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
  5307. (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
  5308. (let* ((h (string-to-number (match-string 1 s)))
  5309. (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
  5310. (ampm (if (match-end 4) (downcase (match-string 4 s))))
  5311. (am-p (equal ampm "am"))
  5312. (h1 (cond ((not ampm) h)
  5313. ((= h 12) (if am-p 0 12))
  5314. (t (+ h (if am-p 0 12)))))
  5315. (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
  5316. (mod h1 24) h1))
  5317. (t0 (+ (* 100 h2) m))
  5318. (t1 (concat (if (>= h1 24) "+" " ")
  5319. (if (and org-agenda-time-leading-zero
  5320. (< t0 1000)) "0" "")
  5321. (if (< t0 100) "0" "")
  5322. (if (< t0 10) "0" "")
  5323. (int-to-string t0))))
  5324. (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
  5325. (defvar org-agenda-before-sorting-filter-function nil
  5326. "Function to be applied to agenda items prior to sorting.
  5327. Prior to sorting also means just before they are inserted into the agenda.
  5328. To aid sorting, you may revisit the original entries and add more text
  5329. properties which will later be used by the sorting functions.
  5330. The function should take a string argument, an agenda line.
  5331. It has access to the text properties in that line, which contain among
  5332. other things, the property `org-hd-marker' that points to the entry
  5333. where the line comes from. Note that not all lines going into the agenda
  5334. have this property, only most.
  5335. The function should return the modified string. It is probably best
  5336. to ONLY change text properties.
  5337. You can also use this function as a filter, by returning nil for lines
  5338. you don't want to have in the agenda at all. For this application, you
  5339. could bind the variable in the options section of a custom command.")
  5340. (defun org-finalize-agenda-entries (list &optional nosort)
  5341. "Sort and concatenate the agenda items."
  5342. (setq list (mapcar 'org-agenda-highlight-todo list))
  5343. (if nosort
  5344. list
  5345. (when org-agenda-before-sorting-filter-function
  5346. (setq list (delq nil (mapcar org-agenda-before-sorting-filter-function list))))
  5347. (mapconcat 'identity (sort list 'org-entries-lessp) "\n")))
  5348. (defun org-agenda-highlight-todo (x)
  5349. (let ((org-done-keywords org-done-keywords-for-agenda)
  5350. (case-fold-search nil)
  5351. re)
  5352. (if (eq x 'line)
  5353. (save-excursion
  5354. (beginning-of-line 1)
  5355. (setq re (org-get-at-bol 'org-todo-regexp))
  5356. (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
  5357. (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
  5358. (add-text-properties (match-beginning 0) (match-end 1)
  5359. (list 'face (org-get-todo-face 1)))
  5360. (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
  5361. (delete-region (match-beginning 1) (1- (match-end 0)))
  5362. (goto-char (match-beginning 1))
  5363. (insert (format org-agenda-todo-keyword-format s)))))
  5364. (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
  5365. (setq re (get-text-property 0 'org-todo-regexp x))
  5366. (when (and re
  5367. (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
  5368. x (or pl 0)) pl))
  5369. (add-text-properties
  5370. (or (match-end 1) (match-end 0)) (match-end 0)
  5371. (list 'face (org-get-todo-face (match-string 2 x)))
  5372. x)
  5373. (when (match-end 1)
  5374. (setq x (concat (substring x 0 (match-end 1))
  5375. (format org-agenda-todo-keyword-format
  5376. (match-string 2 x))
  5377. (org-add-props " " (text-properties-at 0 x))
  5378. (substring x (match-end 3)))))))
  5379. x)))
  5380. (defsubst org-cmp-priority (a b)
  5381. "Compare the priorities of string A and B."
  5382. (let ((pa (or (get-text-property 1 'priority a) 0))
  5383. (pb (or (get-text-property 1 'priority b) 0)))
  5384. (cond ((> pa pb) +1)
  5385. ((< pa pb) -1)
  5386. (t nil))))
  5387. (defsubst org-cmp-effort (a b)
  5388. "Compare the priorities of string A and B."
  5389. (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
  5390. (ea (or (get-text-property 1 'effort-minutes a) def))
  5391. (eb (or (get-text-property 1 'effort-minutes b) def)))
  5392. (cond ((> ea eb) +1)
  5393. ((< ea eb) -1)
  5394. (t nil))))
  5395. (defsubst org-cmp-category (a b)
  5396. "Compare the string values of categories of strings A and B."
  5397. (let ((ca (or (get-text-property 1 'org-category a) ""))
  5398. (cb (or (get-text-property 1 'org-category b) "")))
  5399. (cond ((string-lessp ca cb) -1)
  5400. ((string-lessp cb ca) +1)
  5401. (t nil))))
  5402. (defsubst org-cmp-todo-state (a b)
  5403. "Compare the todo states of strings A and B."
  5404. (let* ((ma (or (get-text-property 1 'org-marker a)
  5405. (get-text-property 1 'org-hd-marker a)))
  5406. (mb (or (get-text-property 1 'org-marker b)
  5407. (get-text-property 1 'org-hd-marker b)))
  5408. (fa (and ma (marker-buffer ma)))
  5409. (fb (and mb (marker-buffer mb)))
  5410. (todo-kwds
  5411. (or (and fa (with-current-buffer fa org-todo-keywords-1))
  5412. (and fb (with-current-buffer fb org-todo-keywords-1))))
  5413. (ta (or (get-text-property 1 'todo-state a) ""))
  5414. (tb (or (get-text-property 1 'todo-state b) ""))
  5415. (la (- (length (member ta todo-kwds))))
  5416. (lb (- (length (member tb todo-kwds))))
  5417. (donepa (member ta org-done-keywords-for-agenda))
  5418. (donepb (member tb org-done-keywords-for-agenda)))
  5419. (cond ((and donepa (not donepb)) -1)
  5420. ((and (not donepa) donepb) +1)
  5421. ((< la lb) -1)
  5422. ((< lb la) +1)
  5423. (t nil))))
  5424. (defsubst org-cmp-alpha (a b)
  5425. "Compare the headlines, alphabetically."
  5426. (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
  5427. (plb (text-property-any 0 (length b) 'org-heading t b))
  5428. (ta (and pla (substring a pla)))
  5429. (tb (and plb (substring b plb))))
  5430. (when pla
  5431. (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
  5432. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
  5433. (setq ta (substring ta (match-end 0))))
  5434. (setq ta (downcase ta)))
  5435. (when plb
  5436. (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
  5437. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
  5438. (setq tb (substring tb (match-end 0))))
  5439. (setq tb (downcase tb)))
  5440. (cond ((not ta) +1)
  5441. ((not tb) -1)
  5442. ((string-lessp ta tb) -1)
  5443. ((string-lessp tb ta) +1)
  5444. (t nil))))
  5445. (defsubst org-cmp-tag (a b)
  5446. "Compare the string values of the first tags of A and B."
  5447. (let ((ta (car (last (get-text-property 1 'tags a))))
  5448. (tb (car (last (get-text-property 1 'tags b)))))
  5449. (cond ((not ta) +1)
  5450. ((not tb) -1)
  5451. ((string-lessp ta tb) -1)
  5452. ((string-lessp tb ta) +1)
  5453. (t nil))))
  5454. (defsubst org-cmp-time (a b)
  5455. "Compare the time-of-day values of strings A and B."
  5456. (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
  5457. (ta (or (get-text-property 1 'time-of-day a) def))
  5458. (tb (or (get-text-property 1 'time-of-day b) def)))
  5459. (cond ((< ta tb) -1)
  5460. ((< tb ta) +1)
  5461. (t nil))))
  5462. (defsubst org-cmp-habit-p (a b)
  5463. "Compare the todo states of strings A and B."
  5464. (let ((ha (get-text-property 1 'org-habit-p a))
  5465. (hb (get-text-property 1 'org-habit-p b)))
  5466. (cond ((and ha (not hb)) -1)
  5467. ((and (not ha) hb) +1)
  5468. (t nil))))
  5469. (defsubst org-em (x y list) (or (memq x list) (memq y list)))
  5470. (defun org-entries-lessp (a b)
  5471. "Predicate for sorting agenda entries."
  5472. ;; The following variables will be used when the form is evaluated.
  5473. ;; So even though the compiler complains, keep them.
  5474. (let* ((ss org-agenda-sorting-strategy-selected)
  5475. (time-up (and (org-em 'time-up 'time-down ss)
  5476. (org-cmp-time a b)))
  5477. (time-down (if time-up (- time-up) nil))
  5478. (priority-up (and (org-em 'priority-up 'priority-down ss)
  5479. (org-cmp-priority a b)))
  5480. (priority-down (if priority-up (- priority-up) nil))
  5481. (effort-up (and (org-em 'effort-up 'effort-down ss)
  5482. (org-cmp-effort a b)))
  5483. (effort-down (if effort-up (- effort-up) nil))
  5484. (category-up (and (or (org-em 'category-up 'category-down ss)
  5485. (memq 'category-keep ss))
  5486. (org-cmp-category a b)))
  5487. (category-down (if category-up (- category-up) nil))
  5488. (category-keep (if category-up +1 nil))
  5489. (tag-up (and (org-em 'tag-up 'tag-down ss)
  5490. (org-cmp-tag a b)))
  5491. (tag-down (if tag-up (- tag-up) nil))
  5492. (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
  5493. (org-cmp-todo-state a b)))
  5494. (todo-state-down (if todo-state-up (- todo-state-up) nil))
  5495. (habit-up (and (org-em 'habit-up 'habit-down ss)
  5496. (org-cmp-habit-p a b)))
  5497. (habit-down (if habit-up (- habit-up) nil))
  5498. (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
  5499. (org-cmp-alpha a b)))
  5500. (alpha-down (if alpha-up (- alpha-up) nil))
  5501. (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
  5502. user-defined-up user-defined-down)
  5503. (if (and need-user-cmp org-agenda-cmp-user-defined
  5504. (functionp org-agenda-cmp-user-defined))
  5505. (setq user-defined-up
  5506. (funcall org-agenda-cmp-user-defined a b)
  5507. user-defined-down (if user-defined-up (- user-defined-up) nil)))
  5508. (cdr (assoc
  5509. (eval (cons 'or org-agenda-sorting-strategy-selected))
  5510. '((-1 . t) (1 . nil) (nil . nil))))))
  5511. ;;; Agenda restriction lock
  5512. (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
  5513. "Overlay to mark the headline to which agenda commands are restricted.")
  5514. (overlay-put org-agenda-restriction-lock-overlay
  5515. 'face 'org-agenda-restriction-lock)
  5516. (overlay-put org-agenda-restriction-lock-overlay
  5517. 'help-echo "Agendas are currently limited to this subtree.")
  5518. (org-detach-overlay org-agenda-restriction-lock-overlay)
  5519. (defun org-agenda-set-restriction-lock (&optional type)
  5520. "Set restriction lock for agenda, to current subtree or file.
  5521. Restriction will be the file if TYPE is `file', or if type is the
  5522. universal prefix '(4), or if the cursor is before the first headline
  5523. in the file. Otherwise, restriction will be to the current subtree."
  5524. (interactive "P")
  5525. (and (equal type '(4)) (setq type 'file))
  5526. (setq type (cond
  5527. (type type)
  5528. ((org-at-heading-p) 'subtree)
  5529. ((condition-case nil (org-back-to-heading t) (error nil))
  5530. 'subtree)
  5531. (t 'file)))
  5532. (if (eq type 'subtree)
  5533. (progn
  5534. (setq org-agenda-restrict t)
  5535. (setq org-agenda-overriding-restriction 'subtree)
  5536. (put 'org-agenda-files 'org-restrict
  5537. (list (buffer-file-name (buffer-base-buffer))))
  5538. (org-back-to-heading t)
  5539. (move-overlay org-agenda-restriction-lock-overlay (point) (point-at-eol))
  5540. (move-marker org-agenda-restrict-begin (point))
  5541. (move-marker org-agenda-restrict-end
  5542. (save-excursion (org-end-of-subtree t)))
  5543. (message "Locking agenda restriction to subtree"))
  5544. (put 'org-agenda-files 'org-restrict
  5545. (list (buffer-file-name (buffer-base-buffer))))
  5546. (setq org-agenda-restrict nil)
  5547. (setq org-agenda-overriding-restriction 'file)
  5548. (move-marker org-agenda-restrict-begin nil)
  5549. (move-marker org-agenda-restrict-end nil)
  5550. (message "Locking agenda restriction to file"))
  5551. (setq current-prefix-arg nil)
  5552. (org-agenda-maybe-redo))
  5553. (defun org-agenda-remove-restriction-lock (&optional noupdate)
  5554. "Remove the agenda restriction lock."
  5555. (interactive "P")
  5556. (org-detach-overlay org-agenda-restriction-lock-overlay)
  5557. (org-detach-overlay org-speedbar-restriction-lock-overlay)
  5558. (setq org-agenda-overriding-restriction nil)
  5559. (setq org-agenda-restrict nil)
  5560. (put 'org-agenda-files 'org-restrict nil)
  5561. (move-marker org-agenda-restrict-begin nil)
  5562. (move-marker org-agenda-restrict-end nil)
  5563. (setq current-prefix-arg nil)
  5564. (message "Agenda restriction lock removed")
  5565. (or noupdate (org-agenda-maybe-redo)))
  5566. (defun org-agenda-maybe-redo ()
  5567. "If there is any window showing the agenda view, update it."
  5568. (let ((w (get-buffer-window org-agenda-buffer-name t))
  5569. (w0 (selected-window)))
  5570. (when w
  5571. (select-window w)
  5572. (org-agenda-redo)
  5573. (select-window w0)
  5574. (if org-agenda-overriding-restriction
  5575. (message "Agenda view shifted to new %s restriction"
  5576. org-agenda-overriding-restriction)
  5577. (message "Agenda restriction lock removed")))))
  5578. ;;; Agenda commands
  5579. (defun org-agenda-check-type (error &rest types)
  5580. "Check if agenda buffer is of allowed type.
  5581. If ERROR is non-nil, throw an error, otherwise just return nil."
  5582. (if (memq org-agenda-type types)
  5583. t
  5584. (if error
  5585. (error "Not allowed in %s-type agenda buffers" org-agenda-type)
  5586. nil)))
  5587. (defun org-agenda-quit ()
  5588. "Exit agenda by removing the window or the buffer."
  5589. (interactive)
  5590. (if org-agenda-columns-active
  5591. (org-columns-quit)
  5592. (let ((buf (current-buffer)))
  5593. (if (eq org-agenda-window-setup 'other-frame)
  5594. (progn
  5595. (kill-buffer buf)
  5596. (org-agenda-reset-markers)
  5597. (org-columns-remove-overlays)
  5598. (setq org-agenda-archives-mode nil)
  5599. (delete-frame))
  5600. (and (not (eq org-agenda-window-setup 'current-window))
  5601. (not (one-window-p))
  5602. (delete-window))
  5603. (kill-buffer buf)
  5604. (org-agenda-reset-markers)
  5605. (org-columns-remove-overlays)
  5606. (setq org-agenda-archives-mode nil)))
  5607. ;; Maybe restore the pre-agenda window configuration.
  5608. (and org-agenda-restore-windows-after-quit
  5609. (not (eq org-agenda-window-setup 'other-frame))
  5610. org-pre-agenda-window-conf
  5611. (set-window-configuration org-pre-agenda-window-conf))))
  5612. (defun org-agenda-exit ()
  5613. "Exit agenda by removing the window or the buffer.
  5614. Also kill all Org-mode buffers which have been loaded by `org-agenda'.
  5615. Org-mode buffers visited directly by the user will not be touched."
  5616. (interactive)
  5617. (org-release-buffers org-agenda-new-buffers)
  5618. (setq org-agenda-new-buffers nil)
  5619. (org-agenda-quit))
  5620. (defun org-agenda-execute (arg)
  5621. "Execute another agenda command, keeping same window.
  5622. So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
  5623. in the agenda."
  5624. (interactive "P")
  5625. (let ((org-agenda-window-setup 'current-window))
  5626. (org-agenda arg)))
  5627. (defun org-agenda-redo ()
  5628. "Rebuild Agenda.
  5629. When this is the global TODO list, a prefix argument will be interpreted."
  5630. (interactive)
  5631. (let* ((org-agenda-keep-modes t)
  5632. (filter org-agenda-filter)
  5633. (preset (get 'org-agenda-filter :preset-filter))
  5634. (org-agenda-filter-while-redo (or filter preset))
  5635. (cols org-agenda-columns-active)
  5636. (line (org-current-line))
  5637. (window-line (- line (org-current-line (window-start))))
  5638. (lprops (get 'org-agenda-redo-command 'org-lprops)))
  5639. (put 'org-agenda-filter :preset-filter nil)
  5640. (and cols (org-columns-quit))
  5641. (message "Rebuilding agenda buffer...")
  5642. (org-let lprops '(eval org-agenda-redo-command))
  5643. (setq org-agenda-undo-list nil
  5644. org-agenda-pending-undo-list nil)
  5645. (message "Rebuilding agenda buffer...done")
  5646. (put 'org-agenda-filter :preset-filter preset)
  5647. (and (or filter preset) (org-agenda-filter-apply filter))
  5648. (and cols (org-called-interactively-p 'any) (org-agenda-columns))
  5649. (org-goto-line line)
  5650. (recenter window-line)))
  5651. (defvar org-global-tags-completion-table nil)
  5652. (defvar org-agenda-filter-form nil)
  5653. (defun org-agenda-filter-by-tag (strip &optional char narrow)
  5654. "Keep only those lines in the agenda buffer that have a specific tag.
  5655. The tag is selected with its fast selection letter, as configured.
  5656. With prefix argument STRIP, remove all lines that do have the tag.
  5657. A lisp caller can specify CHAR. NARROW means that the new tag should be
  5658. used to narrow the search - the interactive user can also press `-' or `+'
  5659. to switch to narrowing."
  5660. (interactive "P")
  5661. (let* ((alist org-tag-alist-for-agenda)
  5662. (tag-chars (mapconcat
  5663. (lambda (x) (if (and (not (symbolp (car x)))
  5664. (cdr x))
  5665. (char-to-string (cdr x))
  5666. ""))
  5667. alist ""))
  5668. (efforts (org-split-string
  5669. (or (cdr (assoc (concat org-effort-property "_ALL")
  5670. org-global-properties))
  5671. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00"
  5672. "")))
  5673. (effort-op org-agenda-filter-effort-default-operator)
  5674. (effort-prompt "")
  5675. (inhibit-read-only t)
  5676. (current org-agenda-filter)
  5677. maybe-refresh a n tag)
  5678. (unless char
  5679. (message
  5680. "%s by tag [%s ], [TAB], %s[/]:off, [+-]:narrow, [>=<?]:effort: "
  5681. (if narrow "Narrow" "Filter") tag-chars
  5682. (if org-agenda-auto-exclude-function "[RET], " ""))
  5683. (setq char (read-char)))
  5684. (when (member char '(?+ ?-))
  5685. ;; Narrowing down
  5686. (cond ((equal char ?-) (setq strip t narrow t))
  5687. ((equal char ?+) (setq strip nil narrow t)))
  5688. (message
  5689. "Narrow by tag [%s ], [TAB], [/]:off, [>=<]:effort: " tag-chars)
  5690. (setq char (read-char)))
  5691. (when (member char '(?< ?> ?= ??))
  5692. ;; An effort operator
  5693. (setq effort-op (char-to-string char))
  5694. (setq alist nil) ; to make sure it will be interpreted as effort.
  5695. (unless (equal char ??)
  5696. (loop for i from 0 to 9 do
  5697. (setq effort-prompt
  5698. (concat
  5699. effort-prompt " ["
  5700. (if (= i 9) "0" (int-to-string (1+ i)))
  5701. "]" (nth i efforts))))
  5702. (message "Effort%s: %s " effort-op effort-prompt)
  5703. (setq char (read-char))
  5704. (when (or (< char ?0) (> char ?9))
  5705. (error "Need 1-9,0 to select effort" ))))
  5706. (when (equal char ?\t)
  5707. (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
  5708. (org-set-local 'org-global-tags-completion-table
  5709. (org-global-tags-completion-table)))
  5710. (let ((completion-ignore-case t))
  5711. (setq tag (org-icompleting-read
  5712. "Tag: " org-global-tags-completion-table))))
  5713. (cond
  5714. ((equal char ?\r)
  5715. (org-agenda-filter-by-tag-show-all)
  5716. (when org-agenda-auto-exclude-function
  5717. (setq org-agenda-filter '())
  5718. (dolist (tag (org-agenda-get-represented-tags))
  5719. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  5720. (if modifier
  5721. (push modifier org-agenda-filter))))
  5722. (if (not (null org-agenda-filter))
  5723. (org-agenda-filter-apply org-agenda-filter)))
  5724. (setq maybe-refresh t))
  5725. ((equal char ?/)
  5726. (org-agenda-filter-by-tag-show-all)
  5727. (when (get 'org-agenda-filter :preset-filter)
  5728. (org-agenda-filter-apply org-agenda-filter))
  5729. (setq maybe-refresh t))
  5730. ((or (equal char ?\ )
  5731. (setq a (rassoc char alist))
  5732. (and (>= char ?0) (<= char ?9)
  5733. (setq n (if (= char ?0) 9 (- char ?0 1))
  5734. tag (concat effort-op (nth n efforts))
  5735. a (cons tag nil)))
  5736. (and (= char ??)
  5737. (setq tag "?eff")
  5738. a (cons tag nil))
  5739. (and tag (setq a (cons tag nil))))
  5740. (org-agenda-filter-by-tag-show-all)
  5741. (setq tag (car a))
  5742. (setq org-agenda-filter
  5743. (cons (concat (if strip "-" "+") tag)
  5744. (if narrow current nil)))
  5745. (org-agenda-filter-apply org-agenda-filter)
  5746. (setq maybe-refresh t))
  5747. (t (error "Invalid tag selection character %c" char)))
  5748. (when (and maybe-refresh
  5749. (eq org-agenda-clockreport-mode 'with-filter))
  5750. (org-agenda-redo))))
  5751. (defun org-agenda-get-represented-tags ()
  5752. "Get a list of all tags currently represented in the agenda."
  5753. (let (p tags)
  5754. (save-excursion
  5755. (goto-char (point-min))
  5756. (while (setq p (next-single-property-change (point) 'tags))
  5757. (goto-char p)
  5758. (mapc (lambda (x) (add-to-list 'tags x))
  5759. (get-text-property (point) 'tags))))
  5760. tags))
  5761. (defun org-agenda-filter-by-tag-refine (strip &optional char)
  5762. "Refine the current filter. See `org-agenda-filter-by-tag."
  5763. (interactive "P")
  5764. (org-agenda-filter-by-tag strip char 'refine))
  5765. (defun org-agenda-filter-make-matcher ()
  5766. "Create the form that tests a line for the agenda filter."
  5767. (let (f f1)
  5768. (dolist (x (append (get 'org-agenda-filter :preset-filter)
  5769. org-agenda-filter))
  5770. (if (member x '("-" "+"))
  5771. (setq f1 (if (equal x "-") 'tags '(not tags)))
  5772. (if (string-match "[<=>?]" x)
  5773. (setq f1 (org-agenda-filter-effort-form x))
  5774. (setq f1 (list 'member (downcase (substring x 1)) 'tags)))
  5775. (if (equal (string-to-char x) ?-)
  5776. (setq f1 (list 'not f1))))
  5777. (push f1 f))
  5778. (cons 'and (nreverse f))))
  5779. (defun org-agenda-filter-effort-form (e)
  5780. "Return the form to compare the effort of the current line with what E says.
  5781. E looks like \"+<2:25\"."
  5782. (let (op)
  5783. (setq e (substring e 1))
  5784. (setq op (string-to-char e) e (substring e 1))
  5785. (setq op (cond ((equal op ?<) '<=)
  5786. ((equal op ?>) '>=)
  5787. ((equal op ??) op)
  5788. (t '=)))
  5789. (list 'org-agenda-compare-effort (list 'quote op)
  5790. (org-duration-string-to-minutes e))))
  5791. (defun org-agenda-compare-effort (op value)
  5792. "Compare the effort of the current line with VALUE, using OP.
  5793. If the line does not have an effort defined, return nil."
  5794. (let ((eff (org-get-at-bol 'effort-minutes)))
  5795. (if (equal op ??)
  5796. (not eff)
  5797. (funcall op (or eff (if org-sort-agenda-noeffort-is-high 32767 0))
  5798. value))))
  5799. (defun org-agenda-filter-apply (filter)
  5800. "Set FILTER as the new agenda filter and apply it."
  5801. (let (tags)
  5802. (setq org-agenda-filter filter
  5803. org-agenda-filter-form (org-agenda-filter-make-matcher))
  5804. (org-agenda-set-mode-name)
  5805. (save-excursion
  5806. (goto-char (point-min))
  5807. (while (not (eobp))
  5808. (if (org-get-at-bol 'org-marker)
  5809. (progn
  5810. (setq tags (org-get-at-bol 'tags)) ; used in eval
  5811. (if (not (eval org-agenda-filter-form))
  5812. (org-agenda-filter-by-tag-hide-line))
  5813. (beginning-of-line 2))
  5814. (beginning-of-line 2))))
  5815. (if (get-char-property (point) 'invisible)
  5816. (org-agenda-previous-line))))
  5817. (defun org-agenda-filter-by-tag-hide-line ()
  5818. (let (ov)
  5819. (setq ov (make-overlay (max (point-min) (1- (point-at-bol)))
  5820. (point-at-eol)))
  5821. (overlay-put ov 'invisible t)
  5822. (overlay-put ov 'type 'tags-filter)
  5823. (push ov org-agenda-filter-overlays)))
  5824. (defun org-agenda-fix-tags-filter-overlays-at (&optional pos)
  5825. (setq pos (or pos (point)))
  5826. (save-excursion
  5827. (dolist (ov (overlays-at pos))
  5828. (when (and (overlay-get ov 'invisible)
  5829. (eq (overlay-get ov 'type) 'tags-filter))
  5830. (goto-char pos)
  5831. (if (< (overlay-start ov) (point-at-eol))
  5832. (move-overlay ov (point-at-eol)
  5833. (overlay-end ov)))))))
  5834. (defun org-agenda-filter-by-tag-show-all ()
  5835. (mapc 'delete-overlay org-agenda-filter-overlays)
  5836. (setq org-agenda-filter-overlays nil)
  5837. (setq org-agenda-filter nil)
  5838. (setq org-agenda-filter-form nil)
  5839. (org-agenda-set-mode-name))
  5840. (defun org-agenda-manipulate-query-add ()
  5841. "Manipulate the query by adding a search term with positive selection.
  5842. Positive selection means the term must be matched for selection of an entry."
  5843. (interactive)
  5844. (org-agenda-manipulate-query ?\[))
  5845. (defun org-agenda-manipulate-query-subtract ()
  5846. "Manipulate the query by adding a search term with negative selection.
  5847. Negative selection means term must not be matched for selection of an entry."
  5848. (interactive)
  5849. (org-agenda-manipulate-query ?\]))
  5850. (defun org-agenda-manipulate-query-add-re ()
  5851. "Manipulate the query by adding a search regexp with positive selection.
  5852. Positive selection means the regexp must match for selection of an entry."
  5853. (interactive)
  5854. (org-agenda-manipulate-query ?\{))
  5855. (defun org-agenda-manipulate-query-subtract-re ()
  5856. "Manipulate the query by adding a search regexp with negative selection.
  5857. Negative selection means regexp must not match for selection of an entry."
  5858. (interactive)
  5859. (org-agenda-manipulate-query ?\}))
  5860. (defun org-agenda-manipulate-query (char)
  5861. (cond
  5862. ((memq org-agenda-type '(timeline agenda))
  5863. (let ((org-agenda-include-inactive-timestamps t))
  5864. (org-agenda-redo))
  5865. (message "Display now includes inactive timestamps as well"))
  5866. ((eq org-agenda-type 'search)
  5867. (org-add-to-string
  5868. 'org-agenda-query-string
  5869. (if org-agenda-last-search-view-search-was-boolean
  5870. (cdr (assoc char '((?\[ . " +") (?\] . " -")
  5871. (?\{ . " +{}") (?\} . " -{}"))))
  5872. " "))
  5873. (setq org-agenda-redo-command
  5874. (list 'org-search-view
  5875. org-todo-only
  5876. org-agenda-query-string
  5877. (+ (length org-agenda-query-string)
  5878. (if (member char '(?\{ ?\})) 0 1))))
  5879. (set-register org-agenda-query-register org-agenda-query-string)
  5880. (org-agenda-redo))
  5881. (t (error "Cannot manipulate query for %s-type agenda buffers"
  5882. org-agenda-type))))
  5883. (defun org-add-to-string (var string)
  5884. (set var (concat (symbol-value var) string)))
  5885. (defun org-agenda-goto-date (date)
  5886. "Jump to DATE in agenda."
  5887. (interactive (list (let ((org-read-date-prefer-future
  5888. (eval org-agenda-jump-prefer-future)))
  5889. (org-read-date))))
  5890. (org-agenda-list nil date))
  5891. (defun org-agenda-goto-today ()
  5892. "Go to today."
  5893. (interactive)
  5894. (org-agenda-check-type t 'timeline 'agenda)
  5895. (let ((tdpos (text-property-any (point-min) (point-max) 'org-today t)))
  5896. (cond
  5897. (tdpos (goto-char tdpos))
  5898. ((eq org-agenda-type 'agenda)
  5899. (let* ((sd (org-agenda-compute-starting-span
  5900. (org-today) (or org-agenda-current-span org-agenda-ndays org-agenda-span)))
  5901. (org-agenda-overriding-arguments org-agenda-last-arguments))
  5902. (setf (nth 1 org-agenda-overriding-arguments) sd)
  5903. (org-agenda-redo)
  5904. (org-agenda-find-same-or-today-or-agenda)))
  5905. (t (error "Cannot find today")))))
  5906. (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
  5907. (goto-char
  5908. (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
  5909. (text-property-any (point-min) (point-max) 'org-today t)
  5910. (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
  5911. (point-min))))
  5912. (defun org-agenda-later (arg)
  5913. "Go forward in time by thee current span.
  5914. With prefix ARG, go forward that many times the current span."
  5915. (interactive "p")
  5916. (org-agenda-check-type t 'agenda)
  5917. (let* ((span org-agenda-current-span)
  5918. (sd org-starting-day)
  5919. (greg (calendar-gregorian-from-absolute sd))
  5920. (cnt (org-get-at-bol 'org-day-cnt))
  5921. greg2)
  5922. (cond
  5923. ((eq span 'day)
  5924. (setq sd (+ arg sd)))
  5925. ((eq span 'week)
  5926. (setq sd (+ (* 7 arg) sd)))
  5927. ((eq span 'month)
  5928. (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
  5929. sd (calendar-absolute-from-gregorian greg2))
  5930. (setcar greg2 (1+ (car greg2))))
  5931. ((eq span 'year)
  5932. (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
  5933. sd (calendar-absolute-from-gregorian greg2))
  5934. (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
  5935. (t
  5936. (setq sd (+ (* span arg) sd))))
  5937. (let ((org-agenda-overriding-arguments
  5938. (list (car org-agenda-last-arguments) sd span t)))
  5939. (org-agenda-redo)
  5940. (org-agenda-find-same-or-today-or-agenda cnt))))
  5941. (defun org-agenda-earlier (arg)
  5942. "Go backward in time by the current span.
  5943. With prefix ARG, go backward that many times the current span."
  5944. (interactive "p")
  5945. (org-agenda-later (- arg)))
  5946. (defun org-agenda-view-mode-dispatch ()
  5947. "Call one of the view mode commands."
  5948. (interactive)
  5949. (message "View: [d]ay [w]eek [m]onth [y]ear [SPC]reset [q]uit/abort
  5950. time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
  5951. [a]rch-trees [A]rch-files clock[R]eport include[D]iary
  5952. [E]ntryText")
  5953. (let ((a (read-char-exclusive)))
  5954. (case a
  5955. (?\ (call-interactively 'org-agenda-reset-view))
  5956. (?d (call-interactively 'org-agenda-day-view))
  5957. (?w (call-interactively 'org-agenda-week-view))
  5958. (?m (call-interactively 'org-agenda-month-view))
  5959. (?y (call-interactively 'org-agenda-year-view))
  5960. (?l (call-interactively 'org-agenda-log-mode))
  5961. (?L (org-agenda-log-mode '(4)))
  5962. (?c (org-agenda-log-mode 'clockcheck))
  5963. ((?F ?f) (call-interactively 'org-agenda-follow-mode))
  5964. (?a (call-interactively 'org-agenda-archives-mode))
  5965. (?A (org-agenda-archives-mode 'files))
  5966. ((?R ?r) (call-interactively 'org-agenda-clockreport-mode))
  5967. ((?E ?e) (call-interactively 'org-agenda-entry-text-mode))
  5968. (?G (call-interactively 'org-agenda-toggle-time-grid))
  5969. (?D (call-interactively 'org-agenda-toggle-diary))
  5970. (?\! (call-interactively 'org-agenda-toggle-deadlines))
  5971. (?\[ (let ((org-agenda-include-inactive-timestamps t))
  5972. (org-agenda-check-type t 'timeline 'agenda)
  5973. (org-agenda-redo))
  5974. (message "Display now includes inactive timestamps as well"))
  5975. (?q (message "Abort"))
  5976. (otherwise (error "Invalid key" )))))
  5977. (defun org-agenda-reset-view ()
  5978. "Switch to default view for agenda."
  5979. (interactive)
  5980. (org-agenda-change-time-span (or org-agenda-ndays org-agenda-span)))
  5981. (defun org-agenda-day-view (&optional day-of-year)
  5982. "Switch to daily view for agenda.
  5983. With argument DAY-OF-YEAR, switch to that day of the year."
  5984. (interactive "P")
  5985. (org-agenda-change-time-span 'day day-of-year))
  5986. (defun org-agenda-week-view (&optional iso-week)
  5987. "Switch to daily view for agenda.
  5988. With argument ISO-WEEK, switch to the corresponding ISO week.
  5989. If ISO-WEEK has more then 2 digits, only the last two encode the
  5990. week. Any digits before this encode a year. So 200712 means
  5991. week 12 of year 2007. Years in the range 1938-2037 can also be
  5992. written as 2-digit years."
  5993. (interactive "P")
  5994. (org-agenda-change-time-span 'week iso-week))
  5995. (defun org-agenda-month-view (&optional month)
  5996. "Switch to monthly view for agenda.
  5997. With argument MONTH, switch to that month."
  5998. (interactive "P")
  5999. (org-agenda-change-time-span 'month month))
  6000. (defun org-agenda-year-view (&optional year)
  6001. "Switch to yearly view for agenda.
  6002. With argument YEAR, switch to that year.
  6003. If MONTH has more then 2 digits, only the last two encode the
  6004. month. Any digits before this encode a year. So 200712 means
  6005. December year 2007. Years in the range 1938-2037 can also be
  6006. written as 2-digit years."
  6007. (interactive "P")
  6008. (when year
  6009. (setq year (org-small-year-to-year year)))
  6010. (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
  6011. (org-agenda-change-time-span 'year year)
  6012. (error "Abort")))
  6013. (defun org-agenda-change-time-span (span &optional n)
  6014. "Change the agenda view to SPAN.
  6015. SPAN may be `day', `week', `month', `year'."
  6016. (org-agenda-check-type t 'agenda)
  6017. (if (and (not n) (equal org-agenda-current-span span))
  6018. (error "Viewing span is already \"%s\"" span))
  6019. (let* ((sd (or (org-get-at-bol 'day)
  6020. org-starting-day))
  6021. (sd (org-agenda-compute-starting-span sd span n))
  6022. (org-agenda-overriding-arguments
  6023. (or org-agenda-overriding-arguments
  6024. (list (car org-agenda-last-arguments) sd span t))))
  6025. (org-agenda-redo)
  6026. (org-agenda-find-same-or-today-or-agenda))
  6027. (org-agenda-set-mode-name)
  6028. (message "Switched to %s view" span))
  6029. (defun org-agenda-compute-starting-span (sd span &optional n)
  6030. "Compute starting date for agenda.
  6031. SPAN may be `day', `week', `month', `year'. The return value
  6032. is a cons cell with the starting date and the number of days,
  6033. so that the date SD will be in that range."
  6034. (let* ((greg (calendar-gregorian-from-absolute sd))
  6035. (dg (nth 1 greg))
  6036. (mg (car greg))
  6037. (yg (nth 2 greg)))
  6038. (cond
  6039. ((eq span 'day)
  6040. (when n
  6041. (setq sd (+ (calendar-absolute-from-gregorian
  6042. (list mg 1 yg))
  6043. n -1))))
  6044. ((eq span 'week)
  6045. (let* ((nt (calendar-day-of-week
  6046. (calendar-gregorian-from-absolute sd)))
  6047. (d (if org-agenda-start-on-weekday
  6048. (- nt org-agenda-start-on-weekday)
  6049. 0))
  6050. y1)
  6051. (setq sd (- sd (+ (if (< d 0) 7 0) d)))
  6052. (when n
  6053. (require 'cal-iso)
  6054. (when (> n 99)
  6055. (setq y1 (org-small-year-to-year (/ n 100))
  6056. n (mod n 100)))
  6057. (setq sd
  6058. (calendar-absolute-from-iso
  6059. (list n 1
  6060. (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
  6061. ((eq span 'month)
  6062. (let (y1)
  6063. (when (and n (> n 99))
  6064. (setq y1 (org-small-year-to-year (/ n 100))
  6065. n (mod n 100)))
  6066. (setq sd (calendar-absolute-from-gregorian
  6067. (list (or n mg) 1 (or y1 yg))))))
  6068. ((eq span 'year)
  6069. (setq sd (calendar-absolute-from-gregorian
  6070. (list 1 1 (or n yg))))))
  6071. sd))
  6072. (defun org-agenda-next-date-line (&optional arg)
  6073. "Jump to the next line indicating a date in agenda buffer."
  6074. (interactive "p")
  6075. (org-agenda-check-type t 'agenda 'timeline)
  6076. (beginning-of-line 1)
  6077. ;; This does not work if user makes date format that starts with a blank
  6078. (if (looking-at "^\\S-") (forward-char 1))
  6079. (if (not (re-search-forward "^\\S-" nil t arg))
  6080. (progn
  6081. (backward-char 1)
  6082. (error "No next date after this line in this buffer")))
  6083. (goto-char (match-beginning 0)))
  6084. (defun org-agenda-previous-date-line (&optional arg)
  6085. "Jump to the previous line indicating a date in agenda buffer."
  6086. (interactive "p")
  6087. (org-agenda-check-type t 'agenda 'timeline)
  6088. (beginning-of-line 1)
  6089. (if (not (re-search-backward "^\\S-" nil t arg))
  6090. (error "No previous date before this line in this buffer")))
  6091. ;; Initialize the highlight
  6092. (defvar org-hl (make-overlay 1 1))
  6093. (overlay-put org-hl 'face 'highlight)
  6094. (defun org-highlight (begin end &optional buffer)
  6095. "Highlight a region with overlay."
  6096. (move-overlay org-hl begin end (or buffer (current-buffer))))
  6097. (defun org-unhighlight ()
  6098. "Detach overlay INDEX."
  6099. (org-detach-overlay org-hl))
  6100. ;; FIXME this is currently not used.
  6101. (defun org-highlight-until-next-command (beg end &optional buffer)
  6102. "Move the highlight overlay to BEG/END, remove it before the next command."
  6103. (org-highlight beg end buffer)
  6104. (add-hook 'pre-command-hook 'org-unhighlight-once))
  6105. (defun org-unhighlight-once ()
  6106. "Remove the highlight from its position, and this function from the hook."
  6107. (remove-hook 'pre-command-hook 'org-unhighlight-once)
  6108. (org-unhighlight))
  6109. (defun org-agenda-follow-mode ()
  6110. "Toggle follow mode in an agenda buffer."
  6111. (interactive)
  6112. (setq org-agenda-follow-mode (not org-agenda-follow-mode))
  6113. (org-agenda-set-mode-name)
  6114. (if (and org-agenda-follow-mode (org-get-at-bol 'org-marker))
  6115. (org-agenda-show))
  6116. (message "Follow mode is %s"
  6117. (if org-agenda-follow-mode "on" "off")))
  6118. (defun org-agenda-entry-text-mode (&optional arg)
  6119. "Toggle entry text mode in an agenda buffer."
  6120. (interactive "P")
  6121. (setq org-agenda-entry-text-mode (or (integerp arg)
  6122. (not org-agenda-entry-text-mode)))
  6123. (org-agenda-entry-text-hide)
  6124. (and org-agenda-entry-text-mode
  6125. (let ((org-agenda-entry-text-maxlines
  6126. (if (integerp arg) arg org-agenda-entry-text-maxlines)))
  6127. (org-agenda-entry-text-show)))
  6128. (org-agenda-set-mode-name)
  6129. (message "Entry text mode is %s. Maximum number of lines is %d"
  6130. (if org-agenda-entry-text-mode "on" "off")
  6131. (if (integerp arg) arg org-agenda-entry-text-maxlines)))
  6132. (defun org-agenda-clockreport-mode (&optional with-filter)
  6133. "Toggle clocktable mode in an agenda buffer.
  6134. With prefix arg WITH-FILTER, make the clocktable respect the current
  6135. agenda filter."
  6136. (interactive "P")
  6137. (org-agenda-check-type t 'agenda)
  6138. (if with-filter
  6139. (setq org-agenda-clockreport-mode 'with-filter)
  6140. (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode)))
  6141. (org-agenda-set-mode-name)
  6142. (org-agenda-redo)
  6143. (message "Clocktable mode is %s"
  6144. (if org-agenda-clockreport-mode "on" "off")))
  6145. (defun org-agenda-log-mode (&optional special)
  6146. "Toggle log mode in an agenda buffer.
  6147. With argument SPECIAL, show all possible log items, not only the ones
  6148. configured in `org-agenda-log-mode-items'.
  6149. With a double `C-u' prefix arg, show *only* log items, nothing else."
  6150. (interactive "P")
  6151. (org-agenda-check-type t 'agenda 'timeline)
  6152. (setq org-agenda-show-log
  6153. (cond
  6154. ((equal special '(16)) 'only)
  6155. ((eq special 'clockcheck)
  6156. (if (eq org-agenda-show-log 'clockcheck)
  6157. nil 'clockcheck))
  6158. (special '(closed clock state))
  6159. (t (not org-agenda-show-log))))
  6160. (org-agenda-set-mode-name)
  6161. (org-agenda-redo)
  6162. (message "Log mode is %s"
  6163. (if org-agenda-show-log "on" "off")))
  6164. (defun org-agenda-archives-mode (&optional with-files)
  6165. "Toggle inclusion of items in trees marked with :ARCHIVE:.
  6166. When called with a prefix argument, include all archive files as well."
  6167. (interactive "P")
  6168. (setq org-agenda-archives-mode
  6169. (if with-files t (if org-agenda-archives-mode nil 'trees)))
  6170. (org-agenda-set-mode-name)
  6171. (org-agenda-redo)
  6172. (message
  6173. "%s"
  6174. (cond
  6175. ((eq org-agenda-archives-mode nil)
  6176. "No archives are included")
  6177. ((eq org-agenda-archives-mode 'trees)
  6178. (format "Trees with :%s: tag are included" org-archive-tag))
  6179. ((eq org-agenda-archives-mode t)
  6180. (format "Trees with :%s: tag and all active archive files are included"
  6181. org-archive-tag)))))
  6182. (defun org-agenda-toggle-diary ()
  6183. "Toggle diary inclusion in an agenda buffer."
  6184. (interactive)
  6185. (org-agenda-check-type t 'agenda)
  6186. (setq org-agenda-include-diary (not org-agenda-include-diary))
  6187. (org-agenda-redo)
  6188. (org-agenda-set-mode-name)
  6189. (message "Diary inclusion turned %s"
  6190. (if org-agenda-include-diary "on" "off")))
  6191. (defun org-agenda-toggle-deadlines ()
  6192. "Toggle inclusion of entries with a deadline in an agenda buffer."
  6193. (interactive)
  6194. (org-agenda-check-type t 'agenda)
  6195. (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
  6196. (org-agenda-redo)
  6197. (org-agenda-set-mode-name)
  6198. (message "Deadlines inclusion turned %s"
  6199. (if org-agenda-include-deadlines "on" "off")))
  6200. (defun org-agenda-toggle-time-grid ()
  6201. "Toggle time grid in an agenda buffer."
  6202. (interactive)
  6203. (org-agenda-check-type t 'agenda)
  6204. (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
  6205. (org-agenda-redo)
  6206. (org-agenda-set-mode-name)
  6207. (message "Time-grid turned %s"
  6208. (if org-agenda-use-time-grid "on" "off")))
  6209. (defun org-agenda-set-mode-name ()
  6210. "Set the mode name to indicate all the small mode settings."
  6211. (setq mode-name
  6212. (list "Org-Agenda"
  6213. (if (get 'org-agenda-files 'org-restrict) " []" "")
  6214. " "
  6215. '(:eval (org-agenda-span-name org-agenda-current-span))
  6216. (if org-agenda-follow-mode " Follow" "")
  6217. (if org-agenda-entry-text-mode " ETxt" "")
  6218. (if org-agenda-include-diary " Diary" "")
  6219. (if org-agenda-include-deadlines " Ddl" "")
  6220. (if org-agenda-use-time-grid " Grid" "")
  6221. (if (and (boundp 'org-habit-show-habits)
  6222. org-habit-show-habits) " Habit" "")
  6223. (cond
  6224. ((consp org-agenda-show-log) " LogAll")
  6225. ((eq org-agenda-show-log 'clockcheck) " ClkCk")
  6226. (org-agenda-show-log " Log")
  6227. (t ""))
  6228. (if (or org-agenda-filter (get 'org-agenda-filter
  6229. :preset-filter))
  6230. (concat " {" (mapconcat
  6231. 'identity
  6232. (append (get 'org-agenda-filter
  6233. :preset-filter)
  6234. org-agenda-filter) "") "}")
  6235. "")
  6236. (if org-agenda-archives-mode
  6237. (if (eq org-agenda-archives-mode t)
  6238. " Archives"
  6239. (format " :%s:" org-archive-tag))
  6240. "")
  6241. (if org-agenda-clockreport-mode
  6242. (if (eq org-agenda-clockreport-mode 'with-filter)
  6243. " Clock{}" " Clock")
  6244. "")))
  6245. (force-mode-line-update))
  6246. (defun org-agenda-post-command-hook ()
  6247. (setq org-agenda-type
  6248. (or (get-text-property (point) 'org-agenda-type)
  6249. (get-text-property (max (point-min) (1- (point)))
  6250. 'org-agenda-type))))
  6251. (defun org-agenda-next-line ()
  6252. "Move cursor to the next line, and show if follow mode is active."
  6253. (interactive)
  6254. (call-interactively 'next-line)
  6255. (org-agenda-do-context-action))
  6256. (defun org-agenda-previous-line ()
  6257. "Move cursor to the previous line, and show if follow-mode is active."
  6258. (interactive)
  6259. (call-interactively 'previous-line)
  6260. (org-agenda-do-context-action))
  6261. (defun org-agenda-do-context-action ()
  6262. "Show outline path and, maybe, follow mode window."
  6263. (let ((m (org-get-at-bol 'org-marker)))
  6264. (if (and org-agenda-follow-mode m)
  6265. (org-agenda-show))
  6266. (if (and m org-agenda-show-outline-path)
  6267. (org-with-point-at m
  6268. (org-display-outline-path t)))))
  6269. (defun org-agenda-show-priority ()
  6270. "Show the priority of the current item.
  6271. This priority is composed of the main priority given with the [#A] cookies,
  6272. and by additional input from the age of a schedules or deadline entry."
  6273. (interactive)
  6274. (let* ((pri (org-get-at-bol 'priority)))
  6275. (message "Priority is %d" (if pri pri -1000))))
  6276. (defun org-agenda-show-tags ()
  6277. "Show the tags applicable to the current item."
  6278. (interactive)
  6279. (let* ((tags (org-get-at-bol 'tags)))
  6280. (if tags
  6281. (message "Tags are :%s:"
  6282. (org-no-properties (mapconcat 'identity tags ":")))
  6283. (message "No tags associated with this line"))))
  6284. (defun org-agenda-goto (&optional highlight)
  6285. "Go to the Org-mode file which contains the item at point."
  6286. (interactive)
  6287. (let* ((marker (or (org-get-at-bol 'org-marker)
  6288. (org-agenda-error)))
  6289. (buffer (marker-buffer marker))
  6290. (pos (marker-position marker)))
  6291. (switch-to-buffer-other-window buffer)
  6292. (widen)
  6293. (push-mark)
  6294. (goto-char pos)
  6295. (when (org-mode-p)
  6296. (org-show-context 'agenda)
  6297. (save-excursion
  6298. (and (outline-next-heading)
  6299. (org-flag-heading nil)))) ; show the next heading
  6300. (when (outline-invisible-p)
  6301. (show-entry)) ; display invisible text
  6302. (recenter (/ (window-height) 2))
  6303. (run-hooks 'org-agenda-after-show-hook)
  6304. (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
  6305. (defvar org-agenda-after-show-hook nil
  6306. "Normal hook run after an item has been shown from the agenda.
  6307. Point is in the buffer where the item originated.")
  6308. (defun org-agenda-kill ()
  6309. "Kill the entry or subtree belonging to the current agenda entry."
  6310. (interactive)
  6311. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  6312. (let* ((marker (or (org-get-at-bol 'org-marker)
  6313. (org-agenda-error)))
  6314. (buffer (marker-buffer marker))
  6315. (pos (marker-position marker))
  6316. (type (org-get-at-bol 'type))
  6317. dbeg dend (n 0) conf)
  6318. (org-with-remote-undo buffer
  6319. (with-current-buffer buffer
  6320. (save-excursion
  6321. (goto-char pos)
  6322. (if (and (org-mode-p) (not (member type '("sexp"))))
  6323. (setq dbeg (progn (org-back-to-heading t) (point))
  6324. dend (org-end-of-subtree t t))
  6325. (setq dbeg (point-at-bol)
  6326. dend (min (point-max) (1+ (point-at-eol)))))
  6327. (goto-char dbeg)
  6328. (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
  6329. (setq conf (or (eq t org-agenda-confirm-kill)
  6330. (and (numberp org-agenda-confirm-kill)
  6331. (> n org-agenda-confirm-kill))))
  6332. (and conf
  6333. (not (y-or-n-p
  6334. (format "Delete entry with %d lines in buffer \"%s\"? "
  6335. n (buffer-name buffer))))
  6336. (error "Abort"))
  6337. (org-remove-subtree-entries-from-agenda buffer dbeg dend)
  6338. (with-current-buffer buffer (delete-region dbeg dend))
  6339. (message "Agenda item and source killed"))))
  6340. (defvar org-archive-default-command)
  6341. (defun org-agenda-archive-default ()
  6342. "Archive the entry or subtree belonging to the current agenda entry."
  6343. (interactive)
  6344. (require 'org-archive)
  6345. (org-agenda-archive-with org-archive-default-command))
  6346. (defun org-agenda-archive-default-with-confirmation ()
  6347. "Archive the entry or subtree belonging to the current agenda entry."
  6348. (interactive)
  6349. (require 'org-archive)
  6350. (org-agenda-archive-with org-archive-default-command 'confirm))
  6351. (defun org-agenda-archive ()
  6352. "Archive the entry or subtree belonging to the current agenda entry."
  6353. (interactive)
  6354. (org-agenda-archive-with 'org-archive-subtree))
  6355. (defun org-agenda-archive-to-archive-sibling ()
  6356. "Move the entry to the archive sibling."
  6357. (interactive)
  6358. (org-agenda-archive-with 'org-archive-to-archive-sibling))
  6359. (defun org-agenda-archive-with (cmd &optional confirm)
  6360. "Move the entry to the archive sibling."
  6361. (interactive)
  6362. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  6363. (let* ((marker (or (org-get-at-bol 'org-marker)
  6364. (org-agenda-error)))
  6365. (buffer (marker-buffer marker))
  6366. (pos (marker-position marker)))
  6367. (org-with-remote-undo buffer
  6368. (with-current-buffer buffer
  6369. (if (org-mode-p)
  6370. (if (and confirm
  6371. (not (y-or-n-p "Archive this subtree or entry? ")))
  6372. (error "Abort")
  6373. (save-excursion
  6374. (goto-char pos)
  6375. (org-remove-subtree-entries-from-agenda)
  6376. (org-back-to-heading t)
  6377. (funcall cmd)))
  6378. (error "Archiving works only in Org-mode files"))))))
  6379. (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
  6380. "Remove all lines in the agenda that correspond to a given subtree.
  6381. The subtree is the one in buffer BUF, starting at BEG and ending at END.
  6382. If this information is not given, the function uses the tree at point."
  6383. (let ((buf (or buf (current-buffer))) m p)
  6384. (save-excursion
  6385. (unless (and beg end)
  6386. (org-back-to-heading t)
  6387. (setq beg (point))
  6388. (org-end-of-subtree t)
  6389. (setq end (point)))
  6390. (set-buffer (get-buffer org-agenda-buffer-name))
  6391. (save-excursion
  6392. (goto-char (point-max))
  6393. (beginning-of-line 1)
  6394. (while (not (bobp))
  6395. (when (and (setq m (org-get-at-bol 'org-marker))
  6396. (equal buf (marker-buffer m))
  6397. (setq p (marker-position m))
  6398. (>= p beg)
  6399. (< p end))
  6400. (let ((inhibit-read-only t))
  6401. (delete-region (point-at-bol) (1+ (point-at-eol)))))
  6402. (beginning-of-line 0))))))
  6403. (defun org-agenda-refile (&optional goto rfloc no-update)
  6404. "Refile the item at point."
  6405. (interactive "P")
  6406. (if (equal goto '(16))
  6407. (org-refile-goto-last-stored)
  6408. (let* ((marker (or (org-get-at-bol 'org-hd-marker)
  6409. (org-agenda-error)))
  6410. (buffer (marker-buffer marker))
  6411. (pos (marker-position marker))
  6412. (rfloc (or rfloc
  6413. (org-refile-get-location
  6414. (if goto "Goto" "Refile to") buffer
  6415. org-refile-allow-creating-parent-nodes))))
  6416. (with-current-buffer buffer
  6417. (save-excursion
  6418. (save-restriction
  6419. (widen)
  6420. (goto-char marker)
  6421. (org-remove-subtree-entries-from-agenda)
  6422. (org-refile goto buffer rfloc)))))
  6423. (unless no-update (org-agenda-redo))))
  6424. (defun org-agenda-open-link (&optional arg)
  6425. "Follow the link in the current line, if any.
  6426. This looks for a link in the displayed line in the agenda. It also looks
  6427. at the text of the entry itself."
  6428. (interactive "P")
  6429. (let* ((marker (or (org-get-at-bol 'org-hd-marker)
  6430. (org-get-at-bol 'org-marker)))
  6431. (buffer (and marker (marker-buffer marker)))
  6432. (prefix (buffer-substring
  6433. (point-at-bol) (point-at-eol))))
  6434. (cond
  6435. (buffer
  6436. (with-current-buffer buffer
  6437. (save-excursion
  6438. (save-restriction
  6439. (widen)
  6440. (goto-char marker)
  6441. (org-offer-links-in-entry arg prefix)))))
  6442. ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
  6443. (save-excursion
  6444. (beginning-of-line 1)
  6445. (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
  6446. (org-open-link-from-string (match-string 1)))
  6447. (t (error "No link to open here")))))
  6448. (defun org-agenda-copy-local-variable (var)
  6449. "Get a variable from a referenced buffer and install it here."
  6450. (let ((m (org-get-at-bol 'org-marker)))
  6451. (when (and m (buffer-live-p (marker-buffer m)))
  6452. (org-set-local var (with-current-buffer (marker-buffer m)
  6453. (symbol-value var))))))
  6454. (defun org-agenda-switch-to (&optional delete-other-windows)
  6455. "Go to the Org-mode file which contains the item at point."
  6456. (interactive)
  6457. (if (and org-return-follows-link
  6458. (not (org-get-at-bol 'org-marker))
  6459. (org-in-regexp org-bracket-link-regexp))
  6460. (org-open-link-from-string (match-string 0))
  6461. (let* ((marker (or (org-get-at-bol 'org-marker)
  6462. (org-agenda-error)))
  6463. (buffer (marker-buffer marker))
  6464. (pos (marker-position marker)))
  6465. (switch-to-buffer buffer)
  6466. (and delete-other-windows (delete-other-windows))
  6467. (widen)
  6468. (goto-char pos)
  6469. (when (org-mode-p)
  6470. (org-show-context 'agenda)
  6471. (save-excursion
  6472. (and (outline-next-heading)
  6473. (org-flag-heading nil))) ; show the next heading
  6474. (when (outline-invisible-p)
  6475. (show-entry)))))) ; display invisible text
  6476. (defun org-agenda-goto-mouse (ev)
  6477. "Go to the Org-mode file which contains the item at the mouse click."
  6478. (interactive "e")
  6479. (mouse-set-point ev)
  6480. (org-agenda-goto))
  6481. (defun org-agenda-show (&optional full-entry)
  6482. "Display the Org-mode file which contains the item at point.
  6483. With prefix argument FULL-ENTRY, make the entire entry visible
  6484. if it was hidden in the outline."
  6485. (interactive "P")
  6486. (let ((win (selected-window)))
  6487. (if full-entry
  6488. (let ((org-show-entry-below t))
  6489. (org-agenda-goto t))
  6490. (org-agenda-goto t))
  6491. (select-window win)))
  6492. (defvar org-agenda-show-window nil)
  6493. (defun org-agenda-show-and-scroll-up ()
  6494. "Display the Org-mode file which contains the item at point.
  6495. When called repeatedly, scroll the window that is displaying the buffer."
  6496. (interactive)
  6497. (let ((win (selected-window)))
  6498. (if (and (window-live-p org-agenda-show-window)
  6499. (eq this-command last-command))
  6500. (progn
  6501. (select-window org-agenda-show-window)
  6502. (ignore-errors (scroll-up)))
  6503. (org-agenda-goto t)
  6504. (show-subtree)
  6505. (setq org-agenda-show-window (selected-window)))
  6506. (select-window win)))
  6507. (defun org-agenda-show-scroll-down ()
  6508. "Scroll down the window showing the agenda."
  6509. (interactive)
  6510. (let ((win (selected-window)))
  6511. (when (window-live-p org-agenda-show-window)
  6512. (select-window org-agenda-show-window)
  6513. (ignore-errors (scroll-down))
  6514. (select-window win))))
  6515. (defun org-agenda-show-1 (&optional more)
  6516. "Display the Org-mode file which contains the item at point.
  6517. The prefix arg selects the amount of information to display:
  6518. 0 hide the subtree
  6519. 1 just show the entry according to defaults.
  6520. 2 show the children view
  6521. 3 show the subtree view
  6522. 4 show the entire subtree and any LOGBOOK drawers
  6523. 5 show the entire subtree and any drawers
  6524. With prefix argument FULL-ENTRY, make the entire entry visible
  6525. if it was hidden in the outline."
  6526. (interactive "p")
  6527. (let ((win (selected-window)))
  6528. (org-agenda-goto t)
  6529. (org-recenter-heading 1)
  6530. (cond
  6531. ((= more 0)
  6532. (hide-subtree)
  6533. (save-excursion
  6534. (org-back-to-heading)
  6535. (run-hook-with-args 'org-cycle-hook 'folded))
  6536. (message "Remote: FOLDED"))
  6537. ((and (org-called-interactively-p 'any) (= more 1))
  6538. (message "Remote: show with default settings"))
  6539. ((= more 2)
  6540. (show-entry)
  6541. (show-children)
  6542. (save-excursion
  6543. (org-back-to-heading)
  6544. (run-hook-with-args 'org-cycle-hook 'children))
  6545. (message "Remote: CHILDREN"))
  6546. ((= more 3)
  6547. (show-subtree)
  6548. (save-excursion
  6549. (org-back-to-heading)
  6550. (run-hook-with-args 'org-cycle-hook 'subtree))
  6551. (message "Remote: SUBTREE"))
  6552. ((= more 4)
  6553. (let* ((org-drawers (delete "LOGBOOK" (copy-sequence org-drawers)))
  6554. (org-drawer-regexp
  6555. (concat "^[ \t]*:\\("
  6556. (mapconcat 'regexp-quote org-drawers "\\|")
  6557. "\\):[ \t]*$")))
  6558. (show-subtree)
  6559. (save-excursion
  6560. (org-back-to-heading)
  6561. (org-cycle-hide-drawers 'subtree)))
  6562. (message "Remote: SUBTREE AND LOGBOOK"))
  6563. ((> more 4)
  6564. (show-subtree)
  6565. (message "Remote: SUBTREE AND ALL DRAWERS")))
  6566. (select-window win)))
  6567. (defun org-recenter-heading (n)
  6568. (save-excursion
  6569. (org-back-to-heading)
  6570. (recenter n)))
  6571. (defvar org-agenda-cycle-counter nil)
  6572. (defun org-agenda-cycle-show (&optional n)
  6573. "Show the current entry in another window, with default settings.
  6574. Default settings are taken from `org-show-hierarchy-above' and siblings.
  6575. When use repeatedly in immediate succession, the remote entry will cycle
  6576. through visibility
  6577. children -> subtree -> folded
  6578. When called with a numeric prefix arg, that arg will be passed through to
  6579. `org-agenda-show-1'. For the interpretation of that argument, see the
  6580. docstring of `org-agenda-show-1'."
  6581. (interactive "P")
  6582. (if (integerp n)
  6583. (setq org-agenda-cycle-counter n)
  6584. (if (not (eq last-command this-command))
  6585. (setq org-agenda-cycle-counter 1)
  6586. (if (equal org-agenda-cycle-counter 0)
  6587. (setq org-agenda-cycle-counter 2)
  6588. (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
  6589. (if (> org-agenda-cycle-counter 3)
  6590. (setq org-agenda-cycle-counter 0)))))
  6591. (org-agenda-show-1 org-agenda-cycle-counter))
  6592. (defun org-agenda-recenter (arg)
  6593. "Display the Org-mode file which contains the item at point and recenter."
  6594. (interactive "P")
  6595. (let ((win (selected-window)))
  6596. (org-agenda-goto t)
  6597. (recenter arg)
  6598. (select-window win)))
  6599. (defun org-agenda-show-mouse (ev)
  6600. "Display the Org-mode file which contains the item at the mouse click."
  6601. (interactive "e")
  6602. (mouse-set-point ev)
  6603. (org-agenda-show))
  6604. (defun org-agenda-check-no-diary ()
  6605. "Check if the entry is a diary link and abort if yes."
  6606. (if (org-get-at-bol 'org-agenda-diary-link)
  6607. (org-agenda-error)))
  6608. (defun org-agenda-error ()
  6609. (error "Command not allowed in this line"))
  6610. (defun org-agenda-tree-to-indirect-buffer ()
  6611. "Show the subtree corresponding to the current entry in an indirect buffer.
  6612. This calls the command `org-tree-to-indirect-buffer' from the original
  6613. Org-mode buffer.
  6614. With numerical prefix arg ARG, go up to this level and then take that tree.
  6615. With a \\[universal-argument] prefix, make a separate frame for this tree (i.e. don't
  6616. use the dedicated frame)."
  6617. (interactive)
  6618. (org-agenda-check-no-diary)
  6619. (let* ((marker (or (org-get-at-bol 'org-marker)
  6620. (org-agenda-error)))
  6621. (buffer (marker-buffer marker))
  6622. (pos (marker-position marker)))
  6623. (with-current-buffer buffer
  6624. (save-excursion
  6625. (goto-char pos)
  6626. (call-interactively 'org-tree-to-indirect-buffer)))))
  6627. (defvar org-last-heading-marker (make-marker)
  6628. "Marker pointing to the headline that last changed its TODO state
  6629. by a remote command from the agenda.")
  6630. (defun org-agenda-todo-nextset ()
  6631. "Switch TODO entry to next sequence."
  6632. (interactive)
  6633. (org-agenda-todo 'nextset))
  6634. (defun org-agenda-todo-previousset ()
  6635. "Switch TODO entry to previous sequence."
  6636. (interactive)
  6637. (org-agenda-todo 'previousset))
  6638. (defun org-agenda-todo (&optional arg)
  6639. "Cycle TODO state of line at point, also in Org-mode file.
  6640. This changes the line at point, all other lines in the agenda referring to
  6641. the same tree node, and the headline of the tree node in the Org-mode file."
  6642. (interactive "P")
  6643. (org-agenda-check-no-diary)
  6644. (let* ((col (current-column))
  6645. (marker (or (org-get-at-bol 'org-marker)
  6646. (org-agenda-error)))
  6647. (buffer (marker-buffer marker))
  6648. (pos (marker-position marker))
  6649. (hdmarker (org-get-at-bol 'org-hd-marker))
  6650. (todayp (org-agenda-todayp (org-get-at-bol 'day)))
  6651. (inhibit-read-only t)
  6652. org-agenda-headline-snapshot-before-repeat newhead just-one)
  6653. (org-with-remote-undo buffer
  6654. (with-current-buffer buffer
  6655. (widen)
  6656. (goto-char pos)
  6657. (org-show-context 'agenda)
  6658. (save-excursion
  6659. (and (outline-next-heading)
  6660. (org-flag-heading nil))) ; show the next heading
  6661. (let ((current-prefix-arg arg))
  6662. (call-interactively 'org-todo))
  6663. (and (bolp) (forward-char 1))
  6664. (setq newhead (org-get-heading))
  6665. (when (and (org-bound-and-true-p
  6666. org-agenda-headline-snapshot-before-repeat)
  6667. (not (equal org-agenda-headline-snapshot-before-repeat
  6668. newhead))
  6669. todayp)
  6670. (setq newhead org-agenda-headline-snapshot-before-repeat
  6671. just-one t))
  6672. (save-excursion
  6673. (org-back-to-heading)
  6674. (move-marker org-last-heading-marker (point))))
  6675. (beginning-of-line 1)
  6676. (save-excursion
  6677. (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
  6678. (org-move-to-column col))))
  6679. (defun org-agenda-add-note (&optional arg)
  6680. "Add a time-stamped note to the entry at point."
  6681. (interactive "P")
  6682. (org-agenda-check-no-diary)
  6683. (let* ((marker (or (org-get-at-bol 'org-marker)
  6684. (org-agenda-error)))
  6685. (buffer (marker-buffer marker))
  6686. (pos (marker-position marker))
  6687. (hdmarker (org-get-at-bol 'org-hd-marker))
  6688. (inhibit-read-only t))
  6689. (with-current-buffer buffer
  6690. (widen)
  6691. (goto-char pos)
  6692. (org-show-context 'agenda)
  6693. (save-excursion
  6694. (and (outline-next-heading)
  6695. (org-flag-heading nil))) ; show the next heading
  6696. (org-add-note))))
  6697. (defun org-agenda-change-all-lines (newhead hdmarker
  6698. &optional fixface just-this)
  6699. "Change all lines in the agenda buffer which match HDMARKER.
  6700. The new content of the line will be NEWHEAD (as modified by
  6701. `org-format-agenda-item'). HDMARKER is checked with
  6702. `equal' against all `org-hd-marker' text properties in the file.
  6703. If FIXFACE is non-nil, the face of each item is modified according to
  6704. the new TODO state.
  6705. If JUST-THIS is non-nil, change just the current line, not all.
  6706. If FORCE-TAGS is non nil, the car of it returns the new tags."
  6707. (let* ((inhibit-read-only t)
  6708. (line (org-current-line))
  6709. (thetags (with-current-buffer (marker-buffer hdmarker)
  6710. (save-excursion (save-restriction (widen)
  6711. (goto-char hdmarker)
  6712. (org-get-tags-at)))))
  6713. props m pl undone-face done-face finish new dotime cat tags)
  6714. (save-excursion
  6715. (goto-char (point-max))
  6716. (beginning-of-line 1)
  6717. (while (not finish)
  6718. (setq finish (bobp))
  6719. (when (and (setq m (org-get-at-bol 'org-hd-marker))
  6720. (or (not just-this) (= (org-current-line) line))
  6721. (equal m hdmarker))
  6722. (setq props (text-properties-at (point))
  6723. dotime (org-get-at-bol 'dotime)
  6724. cat (org-get-at-bol 'org-category)
  6725. tags thetags
  6726. new (org-format-agenda-item (org-get-at-bol 'extra)
  6727. newhead cat tags dotime)
  6728. pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
  6729. undone-face (org-get-at-bol 'undone-face)
  6730. done-face (org-get-at-bol 'done-face))
  6731. (beginning-of-line 1)
  6732. (cond
  6733. ((equal new "")
  6734. (and (looking-at ".*\n?") (replace-match "")))
  6735. ((looking-at ".*")
  6736. (replace-match new t t)
  6737. (beginning-of-line 1)
  6738. (add-text-properties (point-at-bol) (point-at-eol) props)
  6739. (when fixface
  6740. (add-text-properties
  6741. (point-at-bol) (point-at-eol)
  6742. (list 'face
  6743. (if org-last-todo-state-is-todo
  6744. undone-face done-face))))
  6745. (org-agenda-highlight-todo 'line)
  6746. (beginning-of-line 1))
  6747. (t (error "Line update did not work"))))
  6748. (beginning-of-line 0)))
  6749. (org-finalize-agenda)))
  6750. (defun org-agenda-align-tags (&optional line)
  6751. "Align all tags in agenda items to `org-agenda-tags-column'."
  6752. (let ((inhibit-read-only t) l c)
  6753. (save-excursion
  6754. (goto-char (if line (point-at-bol) (point-min)))
  6755. (while (re-search-forward (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
  6756. (if line (point-at-eol) nil) t)
  6757. (add-text-properties
  6758. (match-beginning 2) (match-end 2)
  6759. (list 'face (delq nil (let ((prop (get-text-property
  6760. (match-beginning 2) 'face)))
  6761. (or (listp prop) (setq prop (list prop)))
  6762. (if (memq 'org-tag prop)
  6763. prop
  6764. (cons 'org-tag prop))))))
  6765. (setq l (- (match-end 2) (match-beginning 2))
  6766. c (if (< org-agenda-tags-column 0)
  6767. (- (abs org-agenda-tags-column) l)
  6768. org-agenda-tags-column))
  6769. (delete-region (match-beginning 1) (match-end 1))
  6770. (goto-char (match-beginning 1))
  6771. (insert (org-add-props
  6772. (make-string (max 1 (- c (current-column))) ?\ )
  6773. (plist-put (copy-sequence (text-properties-at (point)))
  6774. 'face nil))))
  6775. (goto-char (point-min))
  6776. (org-font-lock-add-tag-faces (point-max)))))
  6777. (defun org-agenda-priority-up ()
  6778. "Increase the priority of line at point, also in Org-mode file."
  6779. (interactive)
  6780. (org-agenda-priority 'up))
  6781. (defun org-agenda-priority-down ()
  6782. "Decrease the priority of line at point, also in Org-mode file."
  6783. (interactive)
  6784. (org-agenda-priority 'down))
  6785. (defun org-agenda-priority (&optional force-direction)
  6786. "Set the priority of line at point, also in Org-mode file.
  6787. This changes the line at point, all other lines in the agenda referring to
  6788. the same tree node, and the headline of the tree node in the Org-mode file."
  6789. (interactive)
  6790. (unless org-enable-priority-commands
  6791. (error "Priority commands are disabled"))
  6792. (org-agenda-check-no-diary)
  6793. (let* ((marker (or (org-get-at-bol 'org-marker)
  6794. (org-agenda-error)))
  6795. (hdmarker (org-get-at-bol 'org-hd-marker))
  6796. (buffer (marker-buffer hdmarker))
  6797. (pos (marker-position hdmarker))
  6798. (inhibit-read-only t)
  6799. newhead)
  6800. (org-with-remote-undo buffer
  6801. (with-current-buffer buffer
  6802. (widen)
  6803. (goto-char pos)
  6804. (org-show-context 'agenda)
  6805. (save-excursion
  6806. (and (outline-next-heading)
  6807. (org-flag-heading nil))) ; show the next heading
  6808. (funcall 'org-priority force-direction)
  6809. (end-of-line 1)
  6810. (setq newhead (org-get-heading)))
  6811. (org-agenda-change-all-lines newhead hdmarker)
  6812. (beginning-of-line 1))))
  6813. ;; FIXME: should fix the tags property of the agenda line.
  6814. (defun org-agenda-set-tags (&optional tag onoff)
  6815. "Set tags for the current headline."
  6816. (interactive)
  6817. (org-agenda-check-no-diary)
  6818. (if (and (org-region-active-p) (org-called-interactively-p 'any))
  6819. (call-interactively 'org-change-tag-in-region)
  6820. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  6821. (org-agenda-error)))
  6822. (buffer (marker-buffer hdmarker))
  6823. (pos (marker-position hdmarker))
  6824. (inhibit-read-only t)
  6825. newhead)
  6826. (org-with-remote-undo buffer
  6827. (with-current-buffer buffer
  6828. (widen)
  6829. (goto-char pos)
  6830. (save-excursion
  6831. (org-show-context 'agenda))
  6832. (save-excursion
  6833. (and (outline-next-heading)
  6834. (org-flag-heading nil))) ; show the next heading
  6835. (goto-char pos)
  6836. (if tag
  6837. (org-toggle-tag tag onoff)
  6838. (call-interactively 'org-set-tags))
  6839. (end-of-line 1)
  6840. (setq newhead (org-get-heading)))
  6841. (org-agenda-change-all-lines newhead hdmarker)
  6842. (beginning-of-line 1)))))
  6843. (defun org-agenda-set-property ()
  6844. "Set a property for the current headline."
  6845. (interactive)
  6846. (org-agenda-check-no-diary)
  6847. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  6848. (org-agenda-error)))
  6849. (buffer (marker-buffer hdmarker))
  6850. (pos (marker-position hdmarker))
  6851. (inhibit-read-only t)
  6852. newhead)
  6853. (org-with-remote-undo buffer
  6854. (with-current-buffer buffer
  6855. (widen)
  6856. (goto-char pos)
  6857. (save-excursion
  6858. (org-show-context 'agenda))
  6859. (save-excursion
  6860. (and (outline-next-heading)
  6861. (org-flag-heading nil))) ; show the next heading
  6862. (goto-char pos)
  6863. (call-interactively 'org-set-property)))))
  6864. (defun org-agenda-set-effort ()
  6865. "Set the effort property for the current headline."
  6866. (interactive)
  6867. (org-agenda-check-no-diary)
  6868. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  6869. (org-agenda-error)))
  6870. (buffer (marker-buffer hdmarker))
  6871. (pos (marker-position hdmarker))
  6872. (inhibit-read-only t)
  6873. newhead)
  6874. (org-with-remote-undo buffer
  6875. (with-current-buffer buffer
  6876. (widen)
  6877. (goto-char pos)
  6878. (save-excursion
  6879. (org-show-context 'agenda))
  6880. (save-excursion
  6881. (and (outline-next-heading)
  6882. (org-flag-heading nil))) ; show the next heading
  6883. (goto-char pos)
  6884. (call-interactively 'org-set-effort)
  6885. (end-of-line 1)))))
  6886. (defun org-agenda-toggle-archive-tag ()
  6887. "Toggle the archive tag for the current entry."
  6888. (interactive)
  6889. (org-agenda-check-no-diary)
  6890. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  6891. (org-agenda-error)))
  6892. (buffer (marker-buffer hdmarker))
  6893. (pos (marker-position hdmarker))
  6894. (inhibit-read-only t)
  6895. newhead)
  6896. (org-with-remote-undo buffer
  6897. (with-current-buffer buffer
  6898. (widen)
  6899. (goto-char pos)
  6900. (org-show-context 'agenda)
  6901. (save-excursion
  6902. (and (outline-next-heading)
  6903. (org-flag-heading nil))) ; show the next heading
  6904. (call-interactively 'org-toggle-archive-tag)
  6905. (end-of-line 1)
  6906. (setq newhead (org-get-heading)))
  6907. (org-agenda-change-all-lines newhead hdmarker)
  6908. (beginning-of-line 1))))
  6909. (defun org-agenda-do-date-later (arg)
  6910. (interactive "P")
  6911. (cond
  6912. ((or (equal arg '(16))
  6913. (memq last-command
  6914. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  6915. (setq this-command 'org-agenda-date-later-minutes)
  6916. (org-agenda-date-later-minutes 1))
  6917. ((or (equal arg '(4))
  6918. (memq last-command
  6919. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  6920. (setq this-command 'org-agenda-date-later-hours)
  6921. (org-agenda-date-later-hours 1))
  6922. (t
  6923. (org-agenda-date-later (prefix-numeric-value arg)))))
  6924. (defun org-agenda-do-date-earlier (arg)
  6925. (interactive "P")
  6926. (cond
  6927. ((or (equal arg '(16))
  6928. (memq last-command
  6929. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  6930. (setq this-command 'org-agenda-date-earlier-minutes)
  6931. (org-agenda-date-earlier-minutes 1))
  6932. ((or (equal arg '(4))
  6933. (memq last-command
  6934. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  6935. (setq this-command 'org-agenda-date-earlier-hours)
  6936. (org-agenda-date-earlier-hours 1))
  6937. (t
  6938. (org-agenda-date-earlier (prefix-numeric-value arg)))))
  6939. (defun org-agenda-date-later (arg &optional what)
  6940. "Change the date of this item to ARG day(s) later."
  6941. (interactive "p")
  6942. (org-agenda-check-type t 'agenda 'timeline)
  6943. (org-agenda-check-no-diary)
  6944. (let* ((marker (or (org-get-at-bol 'org-marker)
  6945. (org-agenda-error)))
  6946. (buffer (marker-buffer marker))
  6947. (pos (marker-position marker)))
  6948. (org-with-remote-undo buffer
  6949. (with-current-buffer buffer
  6950. (widen)
  6951. (goto-char pos)
  6952. (if (not (org-at-timestamp-p))
  6953. (error "Cannot find time stamp"))
  6954. (org-timestamp-change arg (or what 'day)))
  6955. (org-agenda-show-new-time marker org-last-changed-timestamp))
  6956. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  6957. (defun org-agenda-date-earlier (arg &optional what)
  6958. "Change the date of this item to ARG day(s) earlier."
  6959. (interactive "p")
  6960. (org-agenda-date-later (- arg) what))
  6961. (defun org-agenda-date-later-minutes (arg)
  6962. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  6963. (interactive "p")
  6964. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  6965. (org-agenda-date-later arg 'minute))
  6966. (defun org-agenda-date-earlier-minutes (arg)
  6967. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  6968. (interactive "p")
  6969. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  6970. (org-agenda-date-earlier arg 'minute))
  6971. (defun org-agenda-date-later-hours (arg)
  6972. "Change the time of this item, in hour steps."
  6973. (interactive "p")
  6974. (org-agenda-date-later arg 'hour))
  6975. (defun org-agenda-date-earlier-hours (arg)
  6976. "Change the time of this item, in hour steps."
  6977. (interactive "p")
  6978. (org-agenda-date-earlier arg 'hour))
  6979. (defun org-agenda-show-new-time (marker stamp &optional prefix)
  6980. "Show new date stamp via text properties."
  6981. ;; We use text properties to make this undoable
  6982. (let ((inhibit-read-only t)
  6983. (buffer-invisibility-spec))
  6984. (setq stamp (concat " " prefix " => " stamp))
  6985. (save-excursion
  6986. (goto-char (point-max))
  6987. (while (not (bobp))
  6988. (when (equal marker (org-get-at-bol 'org-marker))
  6989. (org-move-to-column (- (window-width) (length stamp)) t)
  6990. (org-agenda-fix-tags-filter-overlays-at (point))
  6991. (if (featurep 'xemacs)
  6992. ;; Use `duplicable' property to trigger undo recording
  6993. (let ((ex (make-extent nil nil))
  6994. (gl (make-glyph stamp)))
  6995. (set-glyph-face gl 'secondary-selection)
  6996. (set-extent-properties
  6997. ex (list 'invisible t 'end-glyph gl 'duplicable t))
  6998. (insert-extent ex (1- (point)) (point-at-eol)))
  6999. (add-text-properties
  7000. (1- (point)) (point-at-eol)
  7001. (list 'display (org-add-props stamp nil
  7002. 'face 'secondary-selection))))
  7003. (beginning-of-line 1))
  7004. (beginning-of-line 0)))))
  7005. (defun org-agenda-date-prompt (arg)
  7006. "Change the date of this item. Date is prompted for, with default today.
  7007. The prefix ARG is passed to the `org-time-stamp' command and can therefore
  7008. be used to request time specification in the time stamp."
  7009. (interactive "P")
  7010. (org-agenda-check-type t 'agenda 'timeline)
  7011. (org-agenda-check-no-diary)
  7012. (let* ((marker (or (org-get-at-bol 'org-marker)
  7013. (org-agenda-error)))
  7014. (buffer (marker-buffer marker))
  7015. (pos (marker-position marker)))
  7016. (org-with-remote-undo buffer
  7017. (with-current-buffer buffer
  7018. (widen)
  7019. (goto-char pos)
  7020. (if (not (org-at-timestamp-p t))
  7021. (error "Cannot find time stamp"))
  7022. (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
  7023. (org-agenda-show-new-time marker org-last-changed-timestamp))
  7024. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  7025. (defun org-agenda-schedule (arg &optional time)
  7026. "Schedule the item at point.
  7027. Arg is passed through to `org-schedule'."
  7028. (interactive "P")
  7029. (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
  7030. (org-agenda-check-no-diary)
  7031. (let* ((marker (or (org-get-at-bol 'org-marker)
  7032. (org-agenda-error)))
  7033. (type (marker-insertion-type marker))
  7034. (buffer (marker-buffer marker))
  7035. (pos (marker-position marker))
  7036. (org-insert-labeled-timestamps-at-point nil)
  7037. ts)
  7038. (set-marker-insertion-type marker t)
  7039. (org-with-remote-undo buffer
  7040. (with-current-buffer buffer
  7041. (widen)
  7042. (goto-char pos)
  7043. (setq ts (org-schedule arg time)))
  7044. (org-agenda-show-new-time marker ts "S"))
  7045. (message "Item scheduled for %s" ts)))
  7046. (defun org-agenda-deadline (arg &optional time)
  7047. "Schedule the item at point.
  7048. Arg is passed through to `org-deadline'."
  7049. (interactive "P")
  7050. (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
  7051. (org-agenda-check-no-diary)
  7052. (let* ((marker (or (org-get-at-bol 'org-marker)
  7053. (org-agenda-error)))
  7054. (buffer (marker-buffer marker))
  7055. (pos (marker-position marker))
  7056. (org-insert-labeled-timestamps-at-point nil)
  7057. ts)
  7058. (org-with-remote-undo buffer
  7059. (with-current-buffer buffer
  7060. (widen)
  7061. (goto-char pos)
  7062. (setq ts (org-deadline arg time)))
  7063. (org-agenda-show-new-time marker ts "D"))
  7064. (message "Deadline for this item set to %s" ts)))
  7065. (defun org-agenda-action ()
  7066. "Select entry for agenda action, or execute an agenda action.
  7067. This command prompts for another letter. Valid inputs are:
  7068. m Mark the entry at point for an agenda action
  7069. s Schedule the marked entry to the date at the cursor
  7070. d Set the deadline of the marked entry to the date at the cursor
  7071. r Call `org-remember' with cursor date as the default date
  7072. c Call `org-capture' with cursor date as the default date
  7073. SPC Show marked entry in other window
  7074. TAB Visit marked entry in other window
  7075. The cursor may be at a date in the calendar, or in the Org agenda."
  7076. (interactive)
  7077. (let (ans)
  7078. (message "Select action: [m]ark | [s]chedule [d]eadline [r]emember [c]apture [ ]show")
  7079. (setq ans (read-char-exclusive))
  7080. (cond
  7081. ((equal ans ?m)
  7082. ;; Mark this entry
  7083. (if (eq major-mode 'org-agenda-mode)
  7084. (let ((m (or (org-get-at-bol 'org-hd-marker)
  7085. (org-get-at-bol 'org-marker))))
  7086. (if m
  7087. (progn
  7088. (move-marker org-agenda-action-marker
  7089. (marker-position m) (marker-buffer m))
  7090. (message "Entry marked for action; press `k' at desired date in agenda or calendar"))
  7091. (error "Don't know which entry to mark")))
  7092. (error "This command works only in the agenda")))
  7093. ((equal ans ?s)
  7094. (org-agenda-do-action '(org-schedule nil org-overriding-default-time)))
  7095. ((equal ans ?d)
  7096. (org-agenda-do-action '(org-deadline nil org-overriding-default-time)))
  7097. ((equal ans ?r)
  7098. (org-agenda-do-action '(org-remember) t))
  7099. ((equal ans ?c)
  7100. (org-agenda-do-action '(org-capture) t))
  7101. ((equal ans ?\ )
  7102. (let ((cw (selected-window)))
  7103. (org-switch-to-buffer-other-window
  7104. (marker-buffer org-agenda-action-marker))
  7105. (goto-char org-agenda-action-marker)
  7106. (org-show-context 'agenda)
  7107. (select-window cw)))
  7108. ((equal ans ?\C-i)
  7109. (org-switch-to-buffer-other-window
  7110. (marker-buffer org-agenda-action-marker))
  7111. (goto-char org-agenda-action-marker)
  7112. (org-show-context 'agenda))
  7113. (t (error "Invalid agenda action %c" ans)))))
  7114. (defun org-agenda-do-action (form &optional current-buffer)
  7115. "Evaluate FORM at the entry pointed to by `org-agenda-action-marker'."
  7116. (let ((org-overriding-default-time (org-get-cursor-date)))
  7117. (if current-buffer
  7118. (eval form)
  7119. (if (not (marker-buffer org-agenda-action-marker))
  7120. (error "No entry has been selected for agenda action")
  7121. (with-current-buffer (marker-buffer org-agenda-action-marker)
  7122. (save-excursion
  7123. (save-restriction
  7124. (widen)
  7125. (goto-char org-agenda-action-marker)
  7126. (eval form))))))))
  7127. (defun org-agenda-clock-in (&optional arg)
  7128. "Start the clock on the currently selected item."
  7129. (interactive "P")
  7130. (org-agenda-check-no-diary)
  7131. (if (equal arg '(4))
  7132. (org-clock-in arg)
  7133. (let* ((marker (or (org-get-at-bol 'org-marker)
  7134. (org-agenda-error)))
  7135. (hdmarker (or (org-get-at-bol 'org-hd-marker)
  7136. marker))
  7137. (pos (marker-position marker))
  7138. newhead)
  7139. (org-with-remote-undo (marker-buffer marker)
  7140. (with-current-buffer (marker-buffer marker)
  7141. (widen)
  7142. (goto-char pos)
  7143. (org-show-context 'agenda)
  7144. (org-show-entry)
  7145. (org-cycle-hide-drawers 'children)
  7146. (org-clock-in arg)
  7147. (setq newhead (org-get-heading)))
  7148. (org-agenda-change-all-lines newhead hdmarker)))))
  7149. (defun org-agenda-clock-out ()
  7150. "Stop the currently running clock."
  7151. (interactive)
  7152. (unless (marker-buffer org-clock-marker)
  7153. (error "No running clock"))
  7154. (let ((marker (make-marker)) newhead)
  7155. (org-with-remote-undo (marker-buffer org-clock-marker)
  7156. (with-current-buffer (marker-buffer org-clock-marker)
  7157. (save-excursion
  7158. (save-restriction
  7159. (widen)
  7160. (goto-char org-clock-marker)
  7161. (org-back-to-heading t)
  7162. (move-marker marker (point))
  7163. (org-clock-out)
  7164. (setq newhead (org-get-heading))))))
  7165. (org-agenda-change-all-lines newhead marker)
  7166. (move-marker marker nil)))
  7167. (defun org-agenda-clock-cancel (&optional arg)
  7168. "Cancel the currently running clock."
  7169. (interactive "P")
  7170. (unless (marker-buffer org-clock-marker)
  7171. (error "No running clock"))
  7172. (org-with-remote-undo (marker-buffer org-clock-marker)
  7173. (org-clock-cancel)))
  7174. (defun org-agenda-clock-goto ()
  7175. "Jump to the currently clocked in task within the agenda.
  7176. If the currently clocked in task is not listed in the agenda
  7177. buffer, display it in another window."
  7178. (interactive)
  7179. (let (pos)
  7180. (mapc (lambda (o)
  7181. (if (eq (overlay-get o 'type) 'org-agenda-clocking)
  7182. (setq pos (overlay-start o))))
  7183. (overlays-in (point-min) (point-max)))
  7184. (cond (pos (goto-char pos))
  7185. ;; If the currently clocked entry is not in the agenda
  7186. ;; buffer, we visit it in another window:
  7187. (org-clock-current-task
  7188. (org-switch-to-buffer-other-window (org-clock-goto)))
  7189. (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
  7190. (defun org-agenda-diary-entry-in-org-file ()
  7191. "Make a diary entry in the file `org-agenda-diary-file'."
  7192. (let (d1 d2 char (text "") dp1 dp2)
  7193. (if (equal (buffer-name) "*Calendar*")
  7194. (setq d1 (calendar-cursor-to-date t)
  7195. d2 (car calendar-mark-ring))
  7196. (setq dp1 (get-text-property (point-at-bol) 'day))
  7197. (unless dp1 (error "No date defined in current line"))
  7198. (setq d1 (calendar-gregorian-from-absolute dp1)
  7199. d2 (and (ignore-errors (mark))
  7200. (save-excursion
  7201. (goto-char (mark))
  7202. (setq dp2 (get-text-property (point-at-bol) 'day)))
  7203. (calendar-gregorian-from-absolute dp2))))
  7204. (message "Diary entry: [d]ay [a]nniversary [b]lock [j]ump to date tree")
  7205. (setq char (read-char-exclusive))
  7206. (cond
  7207. ((equal char ?d)
  7208. (setq text (read-string "Day entry: "))
  7209. (org-agenda-add-entry-to-org-agenda-diary-file 'day text d1)
  7210. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  7211. ((equal char ?a)
  7212. (setq d1 (list (car d1) (nth 1 d1)
  7213. (read-number (format "Reference year [%d]: " (nth 2 d1))
  7214. (nth 2 d1))))
  7215. (setq text (read-string "Anniversary (use %d to show years): "))
  7216. (org-agenda-add-entry-to-org-agenda-diary-file 'anniversary text d1)
  7217. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  7218. ((equal char ?b)
  7219. (setq text (read-string "Block entry: "))
  7220. (unless (and d1 d2 (not (equal d1 d2)))
  7221. (error "No block of days selected"))
  7222. (org-agenda-add-entry-to-org-agenda-diary-file 'block text d1 d2)
  7223. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  7224. ((equal char ?j)
  7225. (org-switch-to-buffer-other-window
  7226. (find-file-noselect org-agenda-diary-file))
  7227. (require 'org-datetree)
  7228. (org-datetree-find-date-create d1)
  7229. (org-reveal t))
  7230. (t (error "Invalid selection character `%c'" char)))))
  7231. (defcustom org-agenda-insert-diary-strategy 'date-tree
  7232. "Where in `org-agenda-diary-file' should new entries be added?
  7233. Valid values:
  7234. date-tree in the date tree, as child of the date
  7235. top-level as top-level entries at the end of the file."
  7236. :group 'org-agenda
  7237. :type '(choice
  7238. (const :tag "in a date tree" date-tree)
  7239. (const :tag "as top level at end of file" top-level)))
  7240. (defcustom org-agenda-insert-diary-extract-time nil
  7241. "Non-nil means extract any time specification from the diary entry."
  7242. :group 'org-agenda
  7243. :type 'boolean)
  7244. (defun org-agenda-add-entry-to-org-agenda-diary-file (type text &optional d1 d2)
  7245. "Add a diary entry with TYPE to `org-agenda-diary-file'.
  7246. If TEXT is not empty, it will become the headline of the new entry, and
  7247. the resulting entry will not be shown. When TEXT is empty, switch to
  7248. `org-agenda-diary-file' and let the user finish the entry there."
  7249. (let ((cw (current-window-configuration)))
  7250. (org-switch-to-buffer-other-window
  7251. (find-file-noselect org-agenda-diary-file))
  7252. (widen)
  7253. (goto-char (point-min))
  7254. (cond
  7255. ((eq type 'anniversary)
  7256. (or (re-search-forward "^*[ \t]+Anniversaries" nil t)
  7257. (progn
  7258. (or (org-on-heading-p t)
  7259. (progn
  7260. (outline-next-heading)
  7261. (insert "* Anniversaries\n\n")
  7262. (beginning-of-line -1)))))
  7263. (outline-next-heading)
  7264. (org-back-over-empty-lines)
  7265. (backward-char 1)
  7266. (insert "\n")
  7267. (insert (format "%%%%(org-anniversary %d %2d %2d) %s"
  7268. (nth 2 d1) (car d1) (nth 1 d1) text)))
  7269. ((eq type 'day)
  7270. (let ((org-prefix-has-time t)
  7271. (org-agenda-time-leading-zero t)
  7272. fmt time time2)
  7273. (if org-agenda-insert-diary-extract-time
  7274. ;; Use org-format-agenda-item to parse text for a time-range and
  7275. ;; remove it. FIXME: This is a hack, we should refactor
  7276. ;; that function to make time extraction available separately
  7277. (setq fmt (org-format-agenda-item nil text nil nil t)
  7278. time (get-text-property 0 'time fmt)
  7279. time2 (if (> (length time) 0)
  7280. ;; split-string removes trailing ...... if
  7281. ;; no end time given. First space
  7282. ;; separates time from date.
  7283. (concat " " (car (split-string time "\\.")))
  7284. nil)
  7285. text (get-text-property 0 'txt fmt)))
  7286. (if (eq org-agenda-insert-diary-strategy 'top-level)
  7287. (org-agenda-insert-diary-as-top-level text)
  7288. (require 'org-datetree)
  7289. (org-datetree-find-date-create d1)
  7290. (org-agenda-insert-diary-make-new-entry text))
  7291. (org-insert-time-stamp (org-time-from-absolute
  7292. (calendar-absolute-from-gregorian d1))
  7293. nil nil nil nil time2))
  7294. (end-of-line 0))
  7295. ((eq type 'block)
  7296. (if (> (calendar-absolute-from-gregorian d1)
  7297. (calendar-absolute-from-gregorian d2))
  7298. (setq d1 (prog1 d2 (setq d2 d1))))
  7299. (if (eq org-agenda-insert-diary-strategy 'top-level)
  7300. (org-agenda-insert-diary-as-top-level text)
  7301. (require 'org-datetree)
  7302. (org-datetree-find-date-create d1)
  7303. (org-agenda-insert-diary-make-new-entry text))
  7304. (org-insert-time-stamp (org-time-from-absolute
  7305. (calendar-absolute-from-gregorian d1)))
  7306. (insert "--")
  7307. (org-insert-time-stamp (org-time-from-absolute
  7308. (calendar-absolute-from-gregorian d2)))
  7309. (end-of-line 0)))
  7310. (if (string-match "\\S-" text)
  7311. (progn
  7312. (set-window-configuration cw)
  7313. (message "%s entry added to %s"
  7314. (capitalize (symbol-name type))
  7315. (abbreviate-file-name org-agenda-diary-file)))
  7316. (org-reveal t)
  7317. (message "Please finish entry here"))))
  7318. (defun org-agenda-insert-diary-as-top-level (text)
  7319. "Make new entry as a top-level entry at the end of the file.
  7320. Add TEXT as headline, and position the cursor in the second line so that
  7321. a timestamp can be added there."
  7322. (widen)
  7323. (goto-char (point-max))
  7324. (or (bolp) (insert "\n"))
  7325. (insert "* " text "\n")
  7326. (if org-adapt-indentation (org-indent-to-column 2)))
  7327. (defun org-agenda-insert-diary-make-new-entry (text)
  7328. "Make new entry as last child of current entry.
  7329. Add TEXT as headline, and position the cursor in the second line so that
  7330. a timestamp can be added there."
  7331. (let ((org-show-following-heading t)
  7332. (org-show-siblings t)
  7333. (org-show-hierarchy-above t)
  7334. (org-show-entry-below t)
  7335. col)
  7336. (outline-next-heading)
  7337. (org-back-over-empty-lines)
  7338. (or (looking-at "[ \t]*$")
  7339. (progn (insert "\n") (backward-char 1)))
  7340. (org-insert-heading nil t)
  7341. (org-do-demote)
  7342. (setq col (current-column))
  7343. (insert text "\n")
  7344. (if org-adapt-indentation (org-indent-to-column col))
  7345. (let ((org-show-following-heading t)
  7346. (org-show-siblings t)
  7347. (org-show-hierarchy-above t)
  7348. (org-show-entry-below t))
  7349. (org-show-context))))
  7350. (defun org-agenda-diary-entry ()
  7351. "Make a diary entry, like the `i' command from the calendar.
  7352. All the standard commands work: block, weekly etc.
  7353. When `org-agenda-diary-file' points to a file,
  7354. `org-agenda-diary-entry-in-org-file' is called instead to create
  7355. entries in that Org-mode file."
  7356. (interactive)
  7357. (org-agenda-check-type t 'agenda 'timeline)
  7358. (if (not (eq org-agenda-diary-file 'diary-file))
  7359. (org-agenda-diary-entry-in-org-file)
  7360. (require 'diary-lib)
  7361. (let* ((char (progn
  7362. (message "Diary entry: [d]ay [w]eekly [m]onthly [y]early [a]nniversary [b]lock [c]yclic")
  7363. (read-char-exclusive)))
  7364. (cmd (cdr (assoc char
  7365. '((?d . insert-diary-entry)
  7366. (?w . insert-weekly-diary-entry)
  7367. (?m . insert-monthly-diary-entry)
  7368. (?y . insert-yearly-diary-entry)
  7369. (?a . insert-anniversary-diary-entry)
  7370. (?b . insert-block-diary-entry)
  7371. (?c . insert-cyclic-diary-entry)))))
  7372. (oldf (symbol-function 'calendar-cursor-to-date))
  7373. ;; (buf (get-file-buffer (substitute-in-file-name diary-file)))
  7374. (point (point))
  7375. (mark (or (mark t) (point))))
  7376. (unless cmd
  7377. (error "No command associated with <%c>" char))
  7378. (unless (and (get-text-property point 'day)
  7379. (or (not (equal ?b char))
  7380. (get-text-property mark 'day)))
  7381. (error "Don't know which date to use for diary entry"))
  7382. ;; We implement this by hacking the `calendar-cursor-to-date' function
  7383. ;; and the `calendar-mark-ring' variable. Saves a lot of code.
  7384. (let ((calendar-mark-ring
  7385. (list (calendar-gregorian-from-absolute
  7386. (or (get-text-property mark 'day)
  7387. (get-text-property point 'day))))))
  7388. (unwind-protect
  7389. (progn
  7390. (fset 'calendar-cursor-to-date
  7391. (lambda (&optional error dummy)
  7392. (calendar-gregorian-from-absolute
  7393. (get-text-property point 'day))))
  7394. (call-interactively cmd))
  7395. (fset 'calendar-cursor-to-date oldf))))))
  7396. (defun org-agenda-execute-calendar-command (cmd)
  7397. "Execute a calendar command from the agenda, with the date associated to
  7398. the cursor position."
  7399. (org-agenda-check-type t 'agenda 'timeline)
  7400. (require 'diary-lib)
  7401. (unless (get-text-property (point) 'day)
  7402. (error "Don't know which date to use for calendar command"))
  7403. (let* ((oldf (symbol-function 'calendar-cursor-to-date))
  7404. (point (point))
  7405. (date (calendar-gregorian-from-absolute
  7406. (get-text-property point 'day)))
  7407. ;; the following 2 vars are needed in the calendar
  7408. (displayed-month (car date))
  7409. (displayed-year (nth 2 date)))
  7410. (unwind-protect
  7411. (progn
  7412. (fset 'calendar-cursor-to-date
  7413. (lambda (&optional error dummy)
  7414. (calendar-gregorian-from-absolute
  7415. (get-text-property point 'day))))
  7416. (call-interactively cmd))
  7417. (fset 'calendar-cursor-to-date oldf))))
  7418. (defun org-agenda-phases-of-moon ()
  7419. "Display the phases of the moon for the 3 months around the cursor date."
  7420. (interactive)
  7421. (org-agenda-execute-calendar-command 'calendar-phases-of-moon))
  7422. (defun org-agenda-holidays ()
  7423. "Display the holidays for the 3 months around the cursor date."
  7424. (interactive)
  7425. (org-agenda-execute-calendar-command 'list-calendar-holidays))
  7426. (defvar calendar-longitude)
  7427. (defvar calendar-latitude)
  7428. (defvar calendar-location-name)
  7429. (defun org-agenda-sunrise-sunset (arg)
  7430. "Display sunrise and sunset for the cursor date.
  7431. Latitude and longitude can be specified with the variables
  7432. `calendar-latitude' and `calendar-longitude'. When called with prefix
  7433. argument, latitude and longitude will be prompted for."
  7434. (interactive "P")
  7435. (require 'solar)
  7436. (let ((calendar-longitude (if arg nil calendar-longitude))
  7437. (calendar-latitude (if arg nil calendar-latitude))
  7438. (calendar-location-name
  7439. (if arg "the given coordinates" calendar-location-name)))
  7440. (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
  7441. (defun org-agenda-goto-calendar ()
  7442. "Open the Emacs calendar with the date at the cursor."
  7443. (interactive)
  7444. (org-agenda-check-type t 'agenda 'timeline)
  7445. (let* ((day (or (get-text-property (point) 'day)
  7446. (error "Don't know which date to open in calendar")))
  7447. (date (calendar-gregorian-from-absolute day))
  7448. (calendar-move-hook nil)
  7449. (calendar-view-holidays-initially-flag nil)
  7450. (calendar-view-diary-initially-flag nil))
  7451. (calendar)
  7452. (calendar-goto-date date)))
  7453. ;;;###autoload
  7454. (defun org-calendar-goto-agenda ()
  7455. "Compute the Org-mode agenda for the calendar date displayed at the cursor.
  7456. This is a command that has to be installed in `calendar-mode-map'."
  7457. (interactive)
  7458. (org-agenda-list nil (calendar-absolute-from-gregorian
  7459. (calendar-cursor-to-date))
  7460. nil))
  7461. (defun org-agenda-convert-date ()
  7462. (interactive)
  7463. (org-agenda-check-type t 'agenda 'timeline)
  7464. (let ((day (get-text-property (point) 'day))
  7465. date s)
  7466. (unless day
  7467. (error "Don't know which date to convert"))
  7468. (setq date (calendar-gregorian-from-absolute day))
  7469. (setq s (concat
  7470. "Gregorian: " (calendar-date-string date) "\n"
  7471. "ISO: " (calendar-iso-date-string date) "\n"
  7472. "Day of Yr: " (calendar-day-of-year-string date) "\n"
  7473. "Julian: " (calendar-julian-date-string date) "\n"
  7474. "Astron. JD: " (calendar-astro-date-string date)
  7475. " (Julian date number at noon UTC)\n"
  7476. "Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
  7477. "Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
  7478. "French: " (calendar-french-date-string date) "\n"
  7479. "Baha'i: " (calendar-bahai-date-string date) " (until sunset)\n"
  7480. "Mayan: " (calendar-mayan-date-string date) "\n"
  7481. "Coptic: " (calendar-coptic-date-string date) "\n"
  7482. "Ethiopic: " (calendar-ethiopic-date-string date) "\n"
  7483. "Persian: " (calendar-persian-date-string date) "\n"
  7484. "Chinese: " (calendar-chinese-date-string date) "\n"))
  7485. (with-output-to-temp-buffer "*Dates*"
  7486. (princ s))
  7487. (org-fit-window-to-buffer (get-buffer-window "*Dates*"))))
  7488. ;;; Bulk commands
  7489. (defvar org-agenda-bulk-marked-entries nil
  7490. "List of markers that refer to marked entries in the agenda.")
  7491. (defun org-agenda-bulk-marked-p ()
  7492. (eq (get-char-property (point-at-bol) 'type)
  7493. 'org-marked-entry-overlay))
  7494. (defun org-agenda-bulk-mark (&optional arg)
  7495. "Mark the entry at point for future bulk action."
  7496. (interactive "p")
  7497. (dotimes (i (max arg 1))
  7498. (unless (org-get-at-bol 'org-agenda-diary-link)
  7499. (let* ((m (org-get-at-bol 'org-hd-marker))
  7500. ov)
  7501. (unless (org-agenda-bulk-marked-p)
  7502. (unless m (error "Nothing to mark at point"))
  7503. (push m org-agenda-bulk-marked-entries)
  7504. (setq ov (make-overlay (point-at-bol) (+ 2 (point-at-bol))))
  7505. (org-overlay-display ov "> "
  7506. (org-get-todo-face "TODO")
  7507. 'evaporate)
  7508. (overlay-put ov 'type 'org-marked-entry-overlay))
  7509. (beginning-of-line 2)
  7510. (while (and (get-char-property (point) 'invisible) (not (eobp)))
  7511. (beginning-of-line 2))
  7512. (message "%d entries marked for bulk action"
  7513. (length org-agenda-bulk-marked-entries))))))
  7514. (defun org-agenda-bulk-mark-regexp (regexp)
  7515. "Mark entries match REGEXP."
  7516. (interactive "sMark entries matching regexp: ")
  7517. (let (entries-marked)
  7518. (save-excursion
  7519. (goto-char (point-min))
  7520. (goto-char (next-single-property-change (point) 'txt))
  7521. (while (re-search-forward regexp nil t)
  7522. (when (string-match regexp (get-text-property (point) 'txt))
  7523. (setq entries-marked (+ entries-marked 1))
  7524. (call-interactively 'org-agenda-bulk-mark))))
  7525. (if (not entries-marked)
  7526. (message "No entry matching this regexp."))))
  7527. (defun org-agenda-bulk-unmark ()
  7528. "Unmark the entry at point for future bulk action."
  7529. (interactive)
  7530. (when (org-agenda-bulk-marked-p)
  7531. (org-agenda-bulk-remove-overlays
  7532. (point-at-bol) (+ 2 (point-at-bol)))
  7533. (setq org-agenda-bulk-marked-entries
  7534. (delete (org-get-at-bol 'org-hd-marker)
  7535. org-agenda-bulk-marked-entries)))
  7536. (beginning-of-line 2)
  7537. (while (and (get-char-property (point) 'invisible) (not (eobp)))
  7538. (beginning-of-line 2))
  7539. (message "%d entries marked for bulk action"
  7540. (length org-agenda-bulk-marked-entries)))
  7541. (defun org-agenda-bulk-toggle ()
  7542. "Toggle marking the entry at point for bulk action."
  7543. (interactive)
  7544. (if (org-agenda-bulk-marked-p)
  7545. (org-agenda-bulk-unmark)
  7546. (org-agenda-bulk-mark)))
  7547. (defun org-agenda-bulk-remove-overlays (&optional beg end)
  7548. "Remove the mark overlays between BEG and END in the agenda buffer.
  7549. BEG and END default to the buffer limits.
  7550. This only removes the overlays, it does not remove the markers
  7551. from the list in `org-agenda-bulk-marked-entries'."
  7552. (interactive)
  7553. (mapc (lambda (ov)
  7554. (and (eq (overlay-get ov 'type) 'org-marked-entry-overlay)
  7555. (delete-overlay ov)))
  7556. (overlays-in (or beg (point-min)) (or end (point-max)))))
  7557. (defun org-agenda-bulk-remove-all-marks ()
  7558. "Remove all marks in the agenda buffer.
  7559. This will remove the markers, and the overlays."
  7560. (interactive)
  7561. (mapc (lambda (m) (move-marker m nil)) org-agenda-bulk-marked-entries)
  7562. (setq org-agenda-bulk-marked-entries nil)
  7563. (org-agenda-bulk-remove-overlays (point-min) (point-max)))
  7564. (defun org-agenda-bulk-action (&optional arg)
  7565. "Execute an remote-editing action on all marked entries.
  7566. The prefix arg is passed through to the command if possible."
  7567. (interactive "P")
  7568. ;; Make sure we have markers, and only valid ones
  7569. (unless org-agenda-bulk-marked-entries (error "No entries are marked"))
  7570. (mapc
  7571. (lambda (m)
  7572. (unless (and (markerp m)
  7573. (marker-buffer m)
  7574. (buffer-live-p (marker-buffer m))
  7575. (marker-position m))
  7576. (error "Marker %s for bulk command is invalid" m)))
  7577. org-agenda-bulk-marked-entries)
  7578. ;; Prompt for the bulk command
  7579. (message "Bulk: [r]efile [$]arch [A]rch->sib [t]odo [+/-]tag [s]chd [S]catter [d]eadline [f]unction")
  7580. (let* ((action (read-char-exclusive))
  7581. (org-log-refile (if org-log-refile 'time nil))
  7582. (entries (reverse org-agenda-bulk-marked-entries))
  7583. redo-at-end
  7584. cmd rfloc state e tag pos (cnt 0) (cntskip 0))
  7585. (cond
  7586. ((equal action ?$)
  7587. (setq cmd '(org-agenda-archive)))
  7588. ((equal action ?A)
  7589. (setq cmd '(org-agenda-archive-to-archive-sibling)))
  7590. ((member action '(?r ?w))
  7591. (setq rfloc (org-refile-get-location
  7592. "Refile to"
  7593. (marker-buffer (car org-agenda-bulk-marked-entries))
  7594. org-refile-allow-creating-parent-nodes))
  7595. (if (nth 3 rfloc)
  7596. (setcar (nthcdr 3 rfloc)
  7597. (move-marker (make-marker) (nth 3 rfloc)
  7598. (or (get-file-buffer (nth 1 rfloc))
  7599. (find-buffer-visiting (nth 1 rfloc))
  7600. (error "This should not happen")))))
  7601. (setq cmd (list 'org-agenda-refile nil (list 'quote rfloc) t)
  7602. redo-at-end t))
  7603. ((equal action ?t)
  7604. (setq state (org-icompleting-read
  7605. "Todo state: "
  7606. (with-current-buffer (marker-buffer (car entries))
  7607. (mapcar 'list org-todo-keywords-1))))
  7608. (setq cmd `(let ((org-inhibit-blocking t)
  7609. (org-inhibit-logging 'note))
  7610. (org-agenda-todo ,state))))
  7611. ((memq action '(?- ?+))
  7612. (setq tag (org-icompleting-read
  7613. (format "Tag to %s: " (if (eq action ?+) "add" "remove"))
  7614. (with-current-buffer (marker-buffer (car entries))
  7615. (delq nil
  7616. (mapcar (lambda (x)
  7617. (if (stringp (car x)) x)) org-tag-alist)))))
  7618. (setq cmd `(org-agenda-set-tags ,tag ,(if (eq action ?+) ''on ''off))))
  7619. ((memq action '(?s ?d))
  7620. (let* ((date (unless arg
  7621. (org-read-date
  7622. nil nil nil
  7623. (if (eq action ?s) "(Re)Schedule to" "Set Deadline to"))))
  7624. (ans (if arg nil org-read-date-final-answer))
  7625. (c1 (if (eq action ?s) 'org-agenda-schedule 'org-agenda-deadline)))
  7626. (setq cmd `(let* ((bound (fboundp 'read-string))
  7627. (old (and bound (symbol-function 'read-string))))
  7628. (unwind-protect
  7629. (progn
  7630. (fset 'read-string (lambda (&rest ignore) ,ans))
  7631. (eval '(,c1 arg)))
  7632. (if bound
  7633. (fset 'read-string old)
  7634. (fmakunbound 'read-string)))))))
  7635. ((equal action ?S)
  7636. (if (not (org-agenda-check-type nil 'agenda 'timeline 'todo))
  7637. (error "Can't scatter tasks in \"%s\" agenda view" org-agenda-type)
  7638. (let ((days (read-number
  7639. (format "Scatter tasks across how many %sdays: "
  7640. (if arg "week" "")) 7)))
  7641. (setq cmd
  7642. `(let ((distance (1+ (random ,days))))
  7643. (if arg
  7644. (let ((dist distance)
  7645. (day-of-week
  7646. (calendar-day-of-week
  7647. (calendar-gregorian-from-absolute (org-today)))))
  7648. (dotimes (i (1+ dist))
  7649. (while (member day-of-week org-agenda-weekend-days)
  7650. (incf distance)
  7651. (incf day-of-week)
  7652. (if (= day-of-week 7)
  7653. (setq day-of-week 0)))
  7654. (incf day-of-week)
  7655. (if (= day-of-week 7)
  7656. (setq day-of-week 0)))))
  7657. ;; silently fail when try to replan a sexp entry
  7658. (condition-case nil
  7659. (let* ((date (calendar-gregorian-from-absolute
  7660. (+ (org-today) distance)))
  7661. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date)
  7662. (nth 2 date))))
  7663. (org-agenda-schedule nil time))
  7664. (error nil)))))))
  7665. ((equal action ?f)
  7666. (setq cmd (list (intern
  7667. (org-icompleting-read "Function: "
  7668. obarray 'fboundp t nil nil)))))
  7669. (t (error "Invalid bulk action")))
  7670. ;; Sort the markers, to make sure that parents are handled before children
  7671. (setq entries (sort entries
  7672. (lambda (a b)
  7673. (cond
  7674. ((equal (marker-buffer a) (marker-buffer b))
  7675. (< (marker-position a) (marker-position b)))
  7676. (t
  7677. (string< (buffer-name (marker-buffer a))
  7678. (buffer-name (marker-buffer b))))))))
  7679. ;; Now loop over all markers and apply cmd
  7680. (while (setq e (pop entries))
  7681. (setq pos (text-property-any (point-min) (point-max) 'org-hd-marker e))
  7682. (if (not pos)
  7683. (progn (message "Skipping removed entry at %s" e)
  7684. (setq cntskip (1+ cntskip)))
  7685. (goto-char pos)
  7686. (eval cmd)
  7687. (setq org-agenda-bulk-marked-entries
  7688. (delete e org-agenda-bulk-marked-entries))
  7689. (setq cnt (1+ cnt))))
  7690. (setq org-agenda-bulk-marked-entries nil)
  7691. (org-agenda-bulk-remove-all-marks)
  7692. (when redo-at-end (org-agenda-redo))
  7693. (message "Acted on %d entries%s"
  7694. cnt
  7695. (if (= cntskip 0)
  7696. ""
  7697. (format ", skipped %d (disappeared before their turn)"
  7698. cntskip)))))
  7699. ;;; Flagging notes
  7700. (defun org-agenda-show-the-flagging-note ()
  7701. "Display the flagging note in the other window.
  7702. When called a second time in direct sequence, offer to remove the FLAGGING
  7703. tag and (if present) the flagging note."
  7704. (interactive)
  7705. (let ((hdmarker (org-get-at-bol 'org-hd-marker))
  7706. (win (selected-window))
  7707. note heading newhead)
  7708. (unless hdmarker
  7709. (error "No linked entry at point"))
  7710. (if (and (eq this-command last-command)
  7711. (y-or-n-p "Unflag and remove any flagging note? "))
  7712. (progn
  7713. (org-agenda-remove-flag hdmarker)
  7714. (let ((win (get-buffer-window "*Flagging Note*")))
  7715. (and win (delete-window win)))
  7716. (message "Entry unflaged"))
  7717. (setq note (org-entry-get hdmarker "THEFLAGGINGNOTE"))
  7718. (unless note
  7719. (error "No flagging note"))
  7720. (org-kill-new note)
  7721. (org-switch-to-buffer-other-window "*Flagging Note*")
  7722. (erase-buffer)
  7723. (insert note)
  7724. (goto-char (point-min))
  7725. (while (re-search-forward "\\\\n" nil t)
  7726. (replace-match "\n" t t))
  7727. (goto-char (point-min))
  7728. (select-window win)
  7729. (message "Flagging note pushed to kill ring. Press [?] again to remove tag and note"))))
  7730. (defun org-agenda-remove-flag (marker)
  7731. "Remove the FLAGGED tag and any flagging note in the entry."
  7732. (let (newhead)
  7733. (org-with-point-at marker
  7734. (org-toggle-tag "FLAGGED" 'off)
  7735. (org-entry-delete nil "THEFLAGGINGNOTE")
  7736. (setq newhead (org-get-heading)))
  7737. (org-agenda-change-all-lines newhead marker)
  7738. (message "Entry unflaged")))
  7739. (defun org-agenda-get-any-marker (&optional pos)
  7740. (or (get-text-property (or pos (point-at-bol)) 'org-hd-marker)
  7741. (get-text-property (or pos (point-at-bol)) 'org-marker)))
  7742. ;;; Appointment reminders
  7743. (defvar appt-time-msg-list)
  7744. ;;;###autoload
  7745. (defun org-agenda-to-appt (&optional refresh filter)
  7746. "Activate appointments found in `org-agenda-files'.
  7747. With a \\[universal-argument] prefix, refresh the list of
  7748. appointments.
  7749. If FILTER is t, interactively prompt the user for a regular
  7750. expression, and filter out entries that don't match it.
  7751. If FILTER is a string, use this string as a regular expression
  7752. for filtering entries out.
  7753. FILTER can also be an alist with the car of each cell being
  7754. either 'headline or 'category. For example:
  7755. '((headline \"IMPORTANT\")
  7756. (category \"Work\"))
  7757. will only add headlines containing IMPORTANT or headlines
  7758. belonging to the \"Work\" category."
  7759. (interactive "P")
  7760. (if refresh (setq appt-time-msg-list nil))
  7761. (if (eq filter t)
  7762. (setq filter (read-from-minibuffer "Regexp filter: ")))
  7763. (let* ((cnt 0) ; count added events
  7764. (org-agenda-new-buffers nil)
  7765. (org-deadline-warning-days 0)
  7766. ;; Do not use `org-today' here because appt only takes
  7767. ;; time and without date as argument, so it may pass wrong
  7768. ;; information otherwise
  7769. (today (org-date-to-gregorian
  7770. (time-to-days (current-time))))
  7771. (org-agenda-restrict nil)
  7772. (files (org-agenda-files 'unrestricted)) entries file)
  7773. ;; Get all entries which may contain an appt
  7774. (org-prepare-agenda-buffers files)
  7775. (while (setq file (pop files))
  7776. (setq entries
  7777. (append entries
  7778. (org-agenda-get-day-entries
  7779. file today :timestamp :scheduled :deadline))))
  7780. (setq entries (delq nil entries))
  7781. ;; Map thru entries and find if we should filter them out
  7782. (mapc
  7783. (lambda(x)
  7784. (let* ((evt (org-trim (or (get-text-property 1 'txt x) "")))
  7785. (cat (get-text-property 1 'org-category x))
  7786. (tod (get-text-property 1 'time-of-day x))
  7787. (ok (or (null filter)
  7788. (and (stringp filter) (string-match filter evt))
  7789. (and (listp filter)
  7790. (or (string-match
  7791. (cadr (assoc 'category filter)) cat)
  7792. (string-match
  7793. (cadr (assoc 'headline filter)) evt))))))
  7794. ;; FIXME: Shall we remove text-properties for the appt text?
  7795. ;; (setq evt (set-text-properties 0 (length evt) nil evt))
  7796. (when (and ok tod)
  7797. (setq tod (concat "00" (number-to-string tod))
  7798. tod (when (string-match
  7799. "\\([0-9]\\{1,2\\}\\)\\([0-9]\\{2\\}\\)\\'" tod)
  7800. (concat (match-string 1 tod) ":"
  7801. (match-string 2 tod))))
  7802. (appt-add tod evt)
  7803. (setq cnt (1+ cnt))))) entries)
  7804. (org-release-buffers org-agenda-new-buffers)
  7805. (if (eq cnt 0)
  7806. (message "No event to add")
  7807. (message "Added %d event%s for today" cnt (if (> cnt 1) "s" "")))))
  7808. (defun org-agenda-todayp (date)
  7809. "Does DATE mean today, when considering `org-extend-today-until'?"
  7810. (let ((today (org-today))
  7811. (date (if (and date (listp date)) (calendar-absolute-from-gregorian date)
  7812. date)))
  7813. (eq date today)))
  7814. (provide 'org-agenda)
  7815. ;; arch-tag: 77f7565d-7c4b-44af-a2df-9f6f7070cff1
  7816. ;;; org-agenda.el ends here