org-agenda.el 351 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141
  1. ;;; org-agenda.el --- Dynamic task and appointment lists for Org
  2. ;; Copyright (C) 2004-2012 Free Software Foundation, Inc.
  3. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; Homepage: http://orgmode.org
  6. ;;
  7. ;; This file is part of GNU Emacs.
  8. ;;
  9. ;; GNU Emacs is free software: you can redistribute it and/or modify
  10. ;; it under the terms of the GNU General Public License as published by
  11. ;; the Free Software Foundation, either version 3 of the License, or
  12. ;; (at your option) any later version.
  13. ;; GNU Emacs is distributed in the hope that it will be useful,
  14. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. ;; GNU General Public License for more details.
  17. ;; You should have received a copy of the GNU General Public License
  18. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  19. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  20. ;;
  21. ;;; Commentary:
  22. ;; This file contains the code for creating and using the Agenda for Org-mode.
  23. ;;
  24. ;; The functions `org-batch-agenda', `org-batch-agenda-csv', and
  25. ;; `org-batch-store-agenda-views' are implemented as macros to provide
  26. ;; a convenient way for extracting agenda information from the command
  27. ;; line. The Lisp does not evaluate parameters of a macro call; thus
  28. ;; it is not necessary to quote the parameters passed to one of those
  29. ;; functions. E.g. you can write:
  30. ;;
  31. ;; emacs -batch -l ~/.emacs -eval '(org-batch-agenda "a" org-agenda-span 7)'
  32. ;;
  33. ;; To export an agenda spanning 7 days. If `org-batch-agenda' would
  34. ;; have been implemented as a regular function you'd have to quote the
  35. ;; symbol org-agenda-span. Moreover: To use a symbol as parameter
  36. ;; value you would have to double quote the symbol.
  37. ;;
  38. ;; This is a hack, but it works even when running Org byte-compiled.
  39. ;;
  40. ;;; Code:
  41. (require 'org)
  42. (require 'org-macs)
  43. (eval-when-compile
  44. (require 'cl))
  45. (declare-function diary-add-to-list "diary-lib"
  46. (date string specifier &optional marker globcolor literal))
  47. (declare-function calendar-absolute-from-iso "cal-iso" (date))
  48. (declare-function calendar-astro-date-string "cal-julian" (&optional date))
  49. (declare-function calendar-bahai-date-string "cal-bahai" (&optional date))
  50. (declare-function calendar-chinese-date-string "cal-china" (&optional date))
  51. (declare-function calendar-coptic-date-string "cal-coptic" (&optional date))
  52. (declare-function calendar-ethiopic-date-string "cal-coptic" (&optional date))
  53. (declare-function calendar-french-date-string "cal-french" (&optional date))
  54. (declare-function calendar-goto-date "cal-move" (date))
  55. (declare-function calendar-hebrew-date-string "cal-hebrew" (&optional date))
  56. (declare-function calendar-islamic-date-string "cal-islam" (&optional date))
  57. (declare-function calendar-iso-date-string "cal-iso" (&optional date))
  58. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  59. (declare-function calendar-julian-date-string "cal-julian" (&optional date))
  60. (declare-function calendar-mayan-date-string "cal-mayan" (&optional date))
  61. (declare-function calendar-persian-date-string "cal-persia" (&optional date))
  62. (declare-function calendar-check-holidays "holidays" (date))
  63. (declare-function org-datetree-find-date-create "org-datetree"
  64. (date &optional keep-restriction))
  65. (declare-function org-columns-quit "org-colview" ())
  66. (declare-function diary-date-display-form "diary-lib" (&optional type))
  67. (declare-function org-mobile-write-agenda-for-mobile "org-mobile" (file))
  68. (declare-function org-habit-insert-consistency-graphs
  69. "org-habit" (&optional line))
  70. (declare-function org-is-habit-p "org-habit" (&optional pom))
  71. (declare-function org-habit-parse-todo "org-habit" (&optional pom))
  72. (declare-function org-habit-get-priority "org-habit" (habit &optional moment))
  73. (declare-function org-pop-to-buffer-same-window "org-compat"
  74. (&optional buffer-or-name norecord label))
  75. (declare-function org-agenda-columns "org-colview" ())
  76. (declare-function org-add-archive-files "org-archive" (files))
  77. (defvar calendar-mode-map)
  78. (defvar org-clock-current-task) ; defined in org-clock.el
  79. (defvar org-mobile-force-id-on-agenda-items) ; defined in org-mobile.el
  80. (defvar org-habit-show-habits)
  81. (defvar org-habit-show-habits-only-for-today)
  82. (defvar org-habit-show-all-today nil)
  83. ;; Defined somewhere in this file, but used before definition.
  84. (defvar org-agenda-buffer-name)
  85. (defvar org-agenda-overriding-header)
  86. (defvar org-agenda-title-append nil)
  87. (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  88. (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  89. (defvar org-agenda-undo-list)
  90. (defvar org-agenda-pending-undo-list)
  91. (defvar original-date) ; dynamically scoped, calendar.el does scope this
  92. (defcustom org-agenda-confirm-kill 1
  93. "When set, remote killing from the agenda buffer needs confirmation.
  94. When t, a confirmation is always needed. When a number N, confirmation is
  95. only needed when the text to be killed contains more than N non-white lines."
  96. :group 'org-agenda
  97. :type '(choice
  98. (const :tag "Never" nil)
  99. (const :tag "Always" t)
  100. (integer :tag "When more than N lines")))
  101. (defcustom org-agenda-compact-blocks nil
  102. "Non-nil means make the block agenda more compact.
  103. This is done globally by leaving out lines like the agenda span
  104. name and week number or the separator lines."
  105. :group 'org-agenda
  106. :type 'boolean)
  107. (defcustom org-agenda-block-separator ?=
  108. "The separator between blocks in the agenda.
  109. If this is a string, it will be used as the separator, with a newline added.
  110. If it is a character, it will be repeated to fill the window width.
  111. If nil the separator is disabled. In `org-agenda-custom-commands' this
  112. addresses the separator between the current and the previous block."
  113. :group 'org-agenda
  114. :type '(choice
  115. (const :tag "Disabled" nil)
  116. (character)
  117. (string)))
  118. (defgroup org-agenda-export nil
  119. "Options concerning exporting agenda views in Org-mode."
  120. :tag "Org Agenda Export"
  121. :group 'org-agenda)
  122. (defcustom org-agenda-with-colors t
  123. "Non-nil means use colors in agenda views."
  124. :group 'org-agenda-export
  125. :type 'boolean)
  126. (defcustom org-agenda-exporter-settings nil
  127. "Alist of variable/value pairs that should be active during agenda export.
  128. This is a good place to set options for ps-print and for htmlize.
  129. Note that the way this is implemented, the values will be evaluated
  130. before assigned to the variables. So make sure to quote values you do
  131. *not* want evaluated, for example
  132. (setq org-agenda-exporter-settings
  133. '((ps-print-color-p 'black-white)))"
  134. :group 'org-agenda-export
  135. :type '(repeat
  136. (list
  137. (variable)
  138. (sexp :tag "Value"))))
  139. (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
  140. "Hook run in temporary buffer before writing it to an export file.
  141. A useful function is `org-agenda-add-entry-text'."
  142. :group 'org-agenda-export
  143. :type 'hook
  144. :options '(org-agenda-add-entry-text))
  145. (defcustom org-agenda-add-entry-text-maxlines 0
  146. "Maximum number of entry text lines to be added to agenda.
  147. This is only relevant when `org-agenda-add-entry-text' is part of
  148. `org-agenda-before-write-hook', which it is by default.
  149. When this is 0, nothing will happen. When it is greater than 0, it
  150. specifies the maximum number of lines that will be added for each entry
  151. that is listed in the agenda view.
  152. Note that this variable is not used during display, only when exporting
  153. the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
  154. and `org-agenda-entry-text-maxlines'."
  155. :group 'org-agenda
  156. :type 'integer)
  157. (defcustom org-agenda-add-entry-text-descriptive-links t
  158. "Non-nil means export org-links as descriptive links in agenda added text.
  159. This variable applies to the text added to the agenda when
  160. `org-agenda-add-entry-text-maxlines' is larger than 0.
  161. When this variable nil, the URL will (also) be shown."
  162. :group 'org-agenda
  163. :type 'boolean)
  164. (defcustom org-agenda-export-html-style ""
  165. "The style specification for exported HTML Agenda files.
  166. If this variable contains a string, it will replace the default <style>
  167. section as produced by `htmlize'.
  168. Since there are different ways of setting style information, this variable
  169. needs to contain the full HTML structure to provide a style, including the
  170. surrounding HTML tags. The style specifications should include definitions
  171. the fonts used by the agenda, here is an example:
  172. <style type=\"text/css\">
  173. p { font-weight: normal; color: gray; }
  174. .org-agenda-structure {
  175. font-size: 110%;
  176. color: #003399;
  177. font-weight: 600;
  178. }
  179. .org-todo {
  180. color: #cc6666;
  181. font-weight: bold;
  182. }
  183. .org-agenda-done {
  184. color: #339933;
  185. }
  186. .org-done {
  187. color: #339933;
  188. }
  189. .title { text-align: center; }
  190. .todo, .deadline { color: red; }
  191. .done { color: green; }
  192. </style>
  193. or, if you want to keep the style in a file,
  194. <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
  195. As the value of this option simply gets inserted into the HTML <head> header,
  196. you can \"misuse\" it to also add other text to the header. However,
  197. <style>...</style> is required, if not present the variable will be ignored."
  198. :group 'org-agenda-export
  199. :group 'org-export-html
  200. :type 'string)
  201. (defcustom org-agenda-persistent-filter nil
  202. "When set, keep filters from one agenda view to the next."
  203. :group 'org-agenda
  204. :type 'boolean)
  205. (defgroup org-agenda-custom-commands nil
  206. "Options concerning agenda views in Org-mode."
  207. :tag "Org Agenda Custom Commands"
  208. :group 'org-agenda)
  209. (defconst org-sorting-choice
  210. '(choice
  211. (const time-up) (const time-down)
  212. (const category-keep) (const category-up) (const category-down)
  213. (const tag-down) (const tag-up)
  214. (const priority-up) (const priority-down)
  215. (const todo-state-up) (const todo-state-down)
  216. (const effort-up) (const effort-down)
  217. (const habit-up) (const habit-down)
  218. (const alpha-up) (const alpha-down)
  219. (const user-defined-up) (const user-defined-down))
  220. "Sorting choices.")
  221. ;; Keep custom values for `org-agenda-filter-preset' compatible with
  222. ;; the new variable `org-agenda-tag-filter-preset'.
  223. (if (fboundp 'defvaralias)
  224. (defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
  225. (defvaralias 'org-agenda-filter 'org-agenda-tag-filter))
  226. (defconst org-agenda-custom-commands-local-options
  227. `(repeat :tag "Local settings for this command. Remember to quote values"
  228. (choice :tag "Setting"
  229. (list :tag "Heading for this block"
  230. (const org-agenda-overriding-header)
  231. (string :tag "Headline"))
  232. (list :tag "Files to be searched"
  233. (const org-agenda-files)
  234. (list
  235. (const :format "" quote)
  236. (repeat (file))))
  237. (list :tag "Sorting strategy"
  238. (const org-agenda-sorting-strategy)
  239. (list
  240. (const :format "" quote)
  241. (repeat
  242. ,org-sorting-choice)))
  243. (list :tag "Prefix format"
  244. (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
  245. (string))
  246. (list :tag "Number of days in agenda"
  247. (const org-agenda-span)
  248. (choice (const :tag "Day" 'day)
  249. (const :tag "Week" 'week)
  250. (const :tag "Month" 'month)
  251. (const :tag "Year" 'year)
  252. (integer :tag "Custom")))
  253. (list :tag "Fixed starting date"
  254. (const org-agenda-start-day)
  255. (string :value "2007-11-01"))
  256. (list :tag "Start on day of week"
  257. (const org-agenda-start-on-weekday)
  258. (choice :value 1
  259. (const :tag "Today" nil)
  260. (integer :tag "Weekday No.")))
  261. (list :tag "Include data from diary"
  262. (const org-agenda-include-diary)
  263. (boolean))
  264. (list :tag "Deadline Warning days"
  265. (const org-deadline-warning-days)
  266. (integer :value 1))
  267. (list :tag "Category filter preset"
  268. (const org-agenda-category-filter-preset)
  269. (list
  270. (const :format "" quote)
  271. (repeat
  272. (string :tag "+category or -category"))))
  273. (list :tag "Tags filter preset"
  274. (const org-agenda-tag-filter-preset)
  275. (list
  276. (const :format "" quote)
  277. (repeat
  278. (string :tag "+tag or -tag"))))
  279. (list :tag "Set daily/weekly entry types"
  280. (const org-agenda-entry-types)
  281. (list
  282. (const :format "" quote)
  283. (set :greedy t :value (:deadline :scheduled :timestamp :sexp)
  284. (const :deadline)
  285. (const :scheduled)
  286. (const :timestamp)
  287. (const :sexp))))
  288. (list :tag "Standard skipping condition"
  289. :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
  290. (const org-agenda-skip-function)
  291. (list
  292. (const :format "" quote)
  293. (list
  294. (choice
  295. :tag "Skipping range"
  296. (const :tag "Skip entry" org-agenda-skip-entry-if)
  297. (const :tag "Skip subtree" org-agenda-skip-subtree-if))
  298. (repeat :inline t :tag "Conditions for skipping"
  299. (choice
  300. :tag "Condition type"
  301. (list :tag "Regexp matches" :inline t (const :format "" 'regexp) (regexp))
  302. (list :tag "Regexp does not match" :inline t (const :format "" 'notregexp) (regexp))
  303. (list :tag "TODO state is" :inline t
  304. (const 'todo)
  305. (choice
  306. (const :tag "any not-done state" 'todo)
  307. (const :tag "any done state" 'done)
  308. (const :tag "any state" 'any)
  309. (list :tag "Keyword list"
  310. (const :format "" quote)
  311. (repeat (string :tag "Keyword")))))
  312. (list :tag "TODO state is not" :inline t
  313. (const 'nottodo)
  314. (choice
  315. (const :tag "any not-done state" 'todo)
  316. (const :tag "any done state" 'done)
  317. (const :tag "any state" 'any)
  318. (list :tag "Keyword list"
  319. (const :format "" quote)
  320. (repeat (string :tag "Keyword")))))
  321. (const :tag "scheduled" 'scheduled)
  322. (const :tag "not scheduled" 'notscheduled)
  323. (const :tag "deadline" 'deadline)
  324. (const :tag "no deadline" 'notdeadline)
  325. (const :tag "timestamp" 'timestamp)
  326. (const :tag "no timestamp" 'nottimestamp))))))
  327. (list :tag "Non-standard skipping condition"
  328. :value (org-agenda-skip-function)
  329. (const org-agenda-skip-function)
  330. (sexp :tag "Function or form (quoted!)"))
  331. (list :tag "Any variable"
  332. (variable :tag "Variable")
  333. (sexp :tag "Value (sexp)"))))
  334. "Selection of examples for agenda command settings.
  335. This will be spliced into the custom type of
  336. `org-agenda-custom-commands'.")
  337. (defcustom org-agenda-custom-commands '(("n" "Agenda and all TODO's"
  338. ((agenda "") (alltodo))))
  339. "Custom commands for the agenda.
  340. These commands will be offered on the splash screen displayed by the
  341. agenda dispatcher \\[org-agenda]. Each entry is a list like this:
  342. (key desc type match settings files)
  343. key The key (one or more characters as a string) to be associated
  344. with the command.
  345. desc A description of the command, when omitted or nil, a default
  346. description is built using MATCH.
  347. type The command type, any of the following symbols:
  348. agenda The daily/weekly agenda.
  349. todo Entries with a specific TODO keyword, in all agenda files.
  350. search Entries containing search words entry or headline.
  351. tags Tags/Property/TODO match in all agenda files.
  352. tags-todo Tags/P/T match in all agenda files, TODO entries only.
  353. todo-tree Sparse tree of specific TODO keyword in *current* file.
  354. tags-tree Sparse tree with all tags matches in *current* file.
  355. occur-tree Occur sparse tree for *current* file.
  356. ... A user-defined function.
  357. match What to search for:
  358. - a single keyword for TODO keyword searches
  359. - a tags match expression for tags searches
  360. - a word search expression for text searches.
  361. - a regular expression for occur searches
  362. For all other commands, this should be the empty string.
  363. settings A list of option settings, similar to that in a let form, so like
  364. this: ((opt1 val1) (opt2 val2) ...). The values will be
  365. evaluated at the moment of execution, so quote them when needed.
  366. files A list of files file to write the produced agenda buffer to
  367. with the command `org-store-agenda-views'.
  368. If a file name ends in \".html\", an HTML version of the buffer
  369. is written out. If it ends in \".ps\", a postscript version is
  370. produced. Otherwise, only the plain text is written to the file.
  371. You can also define a set of commands, to create a composite agenda buffer.
  372. In this case, an entry looks like this:
  373. (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
  374. where
  375. desc A description string to be displayed in the dispatcher menu.
  376. cmd An agenda command, similar to the above. However, tree commands
  377. are not allowed, but instead you can get agenda and global todo list.
  378. So valid commands for a set are:
  379. (agenda \"\" settings)
  380. (alltodo \"\" settings)
  381. (stuck \"\" settings)
  382. (todo \"match\" settings files)
  383. (search \"match\" settings files)
  384. (tags \"match\" settings files)
  385. (tags-todo \"match\" settings files)
  386. Each command can carry a list of options, and another set of options can be
  387. given for the whole set of commands. Individual command options take
  388. precedence over the general options.
  389. When using several characters as key to a command, the first characters
  390. are prefix commands. For the dispatcher to display useful information, you
  391. should provide a description for the prefix, like
  392. (setq org-agenda-custom-commands
  393. '((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
  394. (\"hl\" tags \"+HOME+Lisa\")
  395. (\"hp\" tags \"+HOME+Peter\")
  396. (\"hk\" tags \"+HOME+Kim\")))"
  397. :group 'org-agenda-custom-commands
  398. :type `(repeat
  399. (choice :value ("x" "Describe command here" tags "" nil)
  400. (list :tag "Single command"
  401. (string :tag "Access Key(s) ")
  402. (option (string :tag "Description"))
  403. (choice
  404. (const :tag "Agenda" agenda)
  405. (const :tag "TODO list" alltodo)
  406. (const :tag "Search words" search)
  407. (const :tag "Stuck projects" stuck)
  408. (const :tag "Tags/Property match (all agenda files)" tags)
  409. (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
  410. (const :tag "TODO keyword search (all agenda files)" todo)
  411. (const :tag "Tags sparse tree (current buffer)" tags-tree)
  412. (const :tag "TODO keyword tree (current buffer)" todo-tree)
  413. (const :tag "Occur tree (current buffer)" occur-tree)
  414. (sexp :tag "Other, user-defined function"))
  415. (string :tag "Match (only for some commands)")
  416. ,org-agenda-custom-commands-local-options
  417. (option (repeat :tag "Export" (file :tag "Export to"))))
  418. (list :tag "Command series, all agenda files"
  419. (string :tag "Access Key(s)")
  420. (string :tag "Description ")
  421. (repeat :tag "Component"
  422. (choice
  423. (list :tag "Agenda"
  424. (const :format "" agenda)
  425. (const :tag "" :format "" "")
  426. ,org-agenda-custom-commands-local-options)
  427. (list :tag "TODO list (all keywords)"
  428. (const :format "" alltodo)
  429. (const :tag "" :format "" "")
  430. ,org-agenda-custom-commands-local-options)
  431. (list :tag "Search words"
  432. (const :format "" search)
  433. (string :tag "Match")
  434. ,org-agenda-custom-commands-local-options)
  435. (list :tag "Stuck projects"
  436. (const :format "" stuck)
  437. (const :tag "" :format "" "")
  438. ,org-agenda-custom-commands-local-options)
  439. (list :tag "Tags search"
  440. (const :format "" tags)
  441. (string :tag "Match")
  442. ,org-agenda-custom-commands-local-options)
  443. (list :tag "Tags search, TODO entries only"
  444. (const :format "" tags-todo)
  445. (string :tag "Match")
  446. ,org-agenda-custom-commands-local-options)
  447. (list :tag "TODO keyword search"
  448. (const :format "" todo)
  449. (string :tag "Match")
  450. ,org-agenda-custom-commands-local-options)
  451. (list :tag "Other, user-defined function"
  452. (symbol :tag "function")
  453. (string :tag "Match")
  454. ,org-agenda-custom-commands-local-options)))
  455. (repeat :tag "Settings for entire command set"
  456. (list (variable :tag "Any variable")
  457. (sexp :tag "Value")))
  458. (option (repeat :tag "Export" (file :tag "Export to"))))
  459. (cons :tag "Prefix key documentation"
  460. (string :tag "Access Key(s)")
  461. (string :tag "Description ")))))
  462. (defcustom org-agenda-query-register ?o
  463. "The register holding the current query string.
  464. The purpose of this is that if you construct a query string interactively,
  465. you can then use it to define a custom command."
  466. :group 'org-agenda-custom-commands
  467. :type 'character)
  468. (defcustom org-stuck-projects
  469. '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
  470. "How to identify stuck projects.
  471. This is a list of four items:
  472. 1. A tags/todo/property matcher string that is used to identify a project.
  473. See the manual for a description of tag and property searches.
  474. The entire tree below a headline matched by this is considered one project.
  475. 2. A list of TODO keywords identifying non-stuck projects.
  476. If the project subtree contains any headline with one of these todo
  477. keywords, the project is considered to be not stuck. If you specify
  478. \"*\" as a keyword, any TODO keyword will mark the project unstuck.
  479. 3. A list of tags identifying non-stuck projects.
  480. If the project subtree contains any headline with one of these tags,
  481. the project is considered to be not stuck. If you specify \"*\" as
  482. a tag, any tag will mark the project unstuck. Note that this is about
  483. the explicit presence of a tag somewhere in the subtree, inherited
  484. tags to not count here. If inherited tags make a project not stuck,
  485. use \"-TAG\" in the tags part of the matcher under (1.) above.
  486. 4. An arbitrary regular expression matching non-stuck projects.
  487. If the project turns out to be not stuck, search continues also in the
  488. subtree to see if any of the subtasks have project status.
  489. See also the variable `org-tags-match-list-sublevels' which applies
  490. to projects matched by this search as well.
  491. After defining this variable, you may use \\[org-agenda-list-stuck-projects]
  492. or `C-c a #' to produce the list."
  493. :group 'org-agenda-custom-commands
  494. :type '(list
  495. (string :tag "Tags/TODO match to identify a project")
  496. (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
  497. (repeat :tag "Projects are *not* stuck if they have an entry with TAG being any of" (string))
  498. (regexp :tag "Projects are *not* stuck if this regexp matches inside the subtree")))
  499. (defcustom org-agenda-filter-effort-default-operator "<"
  500. "The default operator for effort estimate filtering.
  501. If you select an effort estimate limit without first pressing an operator,
  502. this one will be used."
  503. :group 'org-agenda-custom-commands
  504. :type '(choice (const :tag "less or equal" "<")
  505. (const :tag "greater or equal"">")
  506. (const :tag "equal" "=")))
  507. (defgroup org-agenda-skip nil
  508. "Options concerning skipping parts of agenda files."
  509. :tag "Org Agenda Skip"
  510. :group 'org-agenda)
  511. (defcustom org-agenda-skip-function-global nil
  512. "Function to be called at each match during agenda construction.
  513. If this function returns nil, the current match should not be skipped.
  514. If the function decided to skip an agenda match, is must return the
  515. buffer position from which the search should be continued.
  516. This may also be a Lisp form, which will be evaluated.
  517. This variable will be applied to every agenda match, including
  518. tags/property searches and TODO lists. So try to make the test function
  519. do its checking as efficiently as possible. To implement a skipping
  520. condition just for specific agenda commands, use the variable
  521. `org-agenda-skip-function' which can be set in the options section
  522. of custom agenda commands."
  523. :group 'org-agenda-skip
  524. :type 'sexp)
  525. (defgroup org-agenda-daily/weekly nil
  526. "Options concerning the daily/weekly agenda."
  527. :tag "Org Agenda Daily/Weekly"
  528. :group 'org-agenda)
  529. (defgroup org-agenda-todo-list nil
  530. "Options concerning the global todo list agenda view."
  531. :tag "Org Agenda Todo List"
  532. :group 'org-agenda)
  533. (defgroup org-agenda-match-view nil
  534. "Options concerning the general tags/property/todo match agenda view."
  535. :tag "Org Agenda Match View"
  536. :group 'org-agenda)
  537. (defgroup org-agenda-search-view nil
  538. "Options concerning the general tags/property/todo match agenda view."
  539. :tag "Org Agenda Match View"
  540. :group 'org-agenda)
  541. (defvar org-agenda-archives-mode nil
  542. "Non-nil means the agenda will include archived items.
  543. If this is the symbol `trees', trees in the selected agenda scope
  544. that are marked with the ARCHIVE tag will be included anyway. When this is
  545. t, also all archive files associated with the current selection of agenda
  546. files will be included.")
  547. (defcustom org-agenda-skip-comment-trees t
  548. "Non-nil means skip trees that start with the COMMENT keyword.
  549. When nil, these trees are also scanned by agenda commands."
  550. :group 'org-agenda-skip
  551. :type 'boolean)
  552. (defcustom org-agenda-todo-list-sublevels t
  553. "Non-nil means check also the sublevels of a TODO entry for TODO entries.
  554. When nil, the sublevels of a TODO entry are not checked, resulting in
  555. potentially much shorter TODO lists."
  556. :group 'org-agenda-skip
  557. :group 'org-agenda-todo-list
  558. :type 'boolean)
  559. (defcustom org-agenda-todo-ignore-with-date nil
  560. "Non-nil means don't show entries with a date in the global todo list.
  561. You can use this if you prefer to mark mere appointments with a TODO keyword,
  562. but don't want them to show up in the TODO list.
  563. When this is set, it also covers deadlines and scheduled items, the settings
  564. of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
  565. will be ignored.
  566. See also the variable `org-agenda-tags-todo-honor-ignore-options'."
  567. :group 'org-agenda-skip
  568. :group 'org-agenda-todo-list
  569. :type 'boolean)
  570. (defcustom org-agenda-todo-ignore-timestamp nil
  571. "Non-nil means don't show entries with a timestamp.
  572. This applies when creating the global todo list.
  573. Valid values are:
  574. past Don't show entries for today or in the past.
  575. future Don't show entries with a timestamp in the future.
  576. The idea behind this is that if it has a future
  577. timestamp, you don't want to think about it until the
  578. date.
  579. all Don't show any entries with a timestamp in the global todo list.
  580. The idea behind this is that by setting a timestamp, you
  581. have already \"taken care\" of this item.
  582. This variable can also have an integer as a value. If positive (N),
  583. todos with a timestamp N or more days in the future will be ignored. If
  584. negative (-N), todos with a timestamp N or more days in the past will be
  585. ignored. If 0, todos with a timestamp either today or in the future will
  586. be ignored. For example, a value of -1 will exclude todos with a
  587. timestamp in the past (yesterday or earlier), while a value of 7 will
  588. exclude todos with a timestamp a week or more in the future.
  589. See also `org-agenda-todo-ignore-with-date'.
  590. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  591. to make his option also apply to the tags-todo list."
  592. :group 'org-agenda-skip
  593. :group 'org-agenda-todo-list
  594. :version "24.1"
  595. :type '(choice
  596. (const :tag "Ignore future timestamp todos" future)
  597. (const :tag "Ignore past or present timestamp todos" past)
  598. (const :tag "Ignore all timestamp todos" all)
  599. (const :tag "Show timestamp todos" nil)
  600. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  601. (defcustom org-agenda-todo-ignore-scheduled nil
  602. "Non-nil means, ignore some scheduled TODO items when making TODO list.
  603. This applies when creating the global todo list.
  604. Valid values are:
  605. past Don't show entries scheduled today or in the past.
  606. future Don't show entries scheduled in the future.
  607. The idea behind this is that by scheduling it, you don't want to
  608. think about it until the scheduled date.
  609. all Don't show any scheduled entries in the global todo list.
  610. The idea behind this is that by scheduling it, you have already
  611. \"taken care\" of this item.
  612. t Same as `all', for backward compatibility.
  613. This variable can also have an integer as a value. See
  614. `org-agenda-todo-ignore-timestamp' for more details.
  615. See also `org-agenda-todo-ignore-with-date'.
  616. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  617. to make his option also apply to the tags-todo list."
  618. :group 'org-agenda-skip
  619. :group 'org-agenda-todo-list
  620. :type '(choice
  621. (const :tag "Ignore future-scheduled todos" future)
  622. (const :tag "Ignore past- or present-scheduled todos" past)
  623. (const :tag "Ignore all scheduled todos" all)
  624. (const :tag "Ignore all scheduled todos (compatibility)" t)
  625. (const :tag "Show scheduled todos" nil)
  626. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  627. (defcustom org-agenda-todo-ignore-deadlines nil
  628. "Non-nil means ignore some deadlined TODO items when making TODO list.
  629. There are different motivations for using different values, please think
  630. carefully when configuring this variable.
  631. This applies when creating the global todo list.
  632. Valid values are:
  633. near Don't show near deadline entries. A deadline is near when it is
  634. closer than `org-deadline-warning-days' days. The idea behind this
  635. is that such items will appear in the agenda anyway.
  636. far Don't show TODO entries where a deadline has been defined, but
  637. the deadline is not near. This is useful if you don't want to
  638. use the todo list to figure out what to do now.
  639. past Don't show entries with a deadline timestamp for today or in the past.
  640. future Don't show entries with a deadline timestamp in the future, not even
  641. when they become `near' ones. Use it with caution.
  642. all Ignore all TODO entries that do have a deadline.
  643. t Same as `near', for backward compatibility.
  644. This variable can also have an integer as a value. See
  645. `org-agenda-todo-ignore-timestamp' for more details.
  646. See also `org-agenda-todo-ignore-with-date'.
  647. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  648. to make his option also apply to the tags-todo list."
  649. :group 'org-agenda-skip
  650. :group 'org-agenda-todo-list
  651. :type '(choice
  652. (const :tag "Ignore near deadlines" near)
  653. (const :tag "Ignore near deadlines (compatibility)" t)
  654. (const :tag "Ignore far deadlines" far)
  655. (const :tag "Ignore all TODOs with a deadlines" all)
  656. (const :tag "Show all TODOs, even if they have a deadline" nil)
  657. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  658. (defcustom org-agenda-tags-todo-honor-ignore-options nil
  659. "Non-nil means honor todo-list ...ignore options also in tags-todo search.
  660. The variables
  661. `org-agenda-todo-ignore-with-date',
  662. `org-agenda-todo-ignore-timestamp',
  663. `org-agenda-todo-ignore-scheduled',
  664. `org-agenda-todo-ignore-deadlines'
  665. make the global TODO list skip entries that have time stamps of certain
  666. kinds. If this option is set, the same options will also apply for the
  667. tags-todo search, which is the general tags/property matcher
  668. restricted to unfinished TODO entries only."
  669. :group 'org-agenda-skip
  670. :group 'org-agenda-todo-list
  671. :group 'org-agenda-match-view
  672. :type 'boolean)
  673. (defcustom org-agenda-skip-scheduled-if-done nil
  674. "Non-nil means don't show scheduled items in agenda when they are done.
  675. This is relevant for the daily/weekly agenda, not for the TODO list. And
  676. it applies only to the actual date of the scheduling. Warnings about
  677. an item with a past scheduling dates are always turned off when the item
  678. is DONE."
  679. :group 'org-agenda-skip
  680. :group 'org-agenda-daily/weekly
  681. :type 'boolean)
  682. (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
  683. "Non-nil means skip scheduling line if same entry shows because of deadline.
  684. In the agenda of today, an entry can show up multiple times because
  685. it is both scheduled and has a nearby deadline, and maybe a plain time
  686. stamp as well.
  687. When this variable is t, then only the deadline is shown and the fact that
  688. the entry is scheduled today or was scheduled previously is not shown.
  689. When this variable is nil, the entry will be shown several times. When
  690. the variable is the symbol `not-today', then skip scheduled previously,
  691. but not scheduled today."
  692. :group 'org-agenda-skip
  693. :group 'org-agenda-daily/weekly
  694. :type '(choice
  695. (const :tag "Never" nil)
  696. (const :tag "Always" t)
  697. (const :tag "Not when scheduled today" not-today)))
  698. (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
  699. "Non-nil means skip timestamp line if same entry shows because of deadline.
  700. In the agenda of today, an entry can show up multiple times
  701. because it has both a plain timestamp and has a nearby deadline.
  702. When this variable is t, then only the deadline is shown and the
  703. fact that the entry has a timestamp for or including today is not
  704. shown. When this variable is nil, the entry will be shown
  705. several times."
  706. :group 'org-agenda-skip
  707. :group 'org-agenda-daily/weekly
  708. :version "24.1"
  709. :type '(choice
  710. (const :tag "Never" nil)
  711. (const :tag "Always" t)))
  712. (defcustom org-agenda-skip-deadline-if-done nil
  713. "Non-nil means don't show deadlines when the corresponding item is done.
  714. When nil, the deadline is still shown and should give you a happy feeling.
  715. This is relevant for the daily/weekly agenda. And it applied only to the
  716. actually date of the deadline. Warnings about approaching and past-due
  717. deadlines are always turned off when the item is DONE."
  718. :group 'org-agenda-skip
  719. :group 'org-agenda-daily/weekly
  720. :type 'boolean)
  721. (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
  722. "Non-nil means skip deadline prewarning when entry is also scheduled.
  723. This will apply on all days where a prewarning for the deadline would
  724. be shown, but not at the day when the entry is actually due. On that day,
  725. the deadline will be shown anyway.
  726. This variable may be set to nil, t, or a number which will then give
  727. the number of days before the actual deadline when the prewarnings
  728. should resume.
  729. This can be used in a workflow where the first showing of the deadline will
  730. trigger you to schedule it, and then you don't want to be reminded of it
  731. because you will take care of it on the day when scheduled."
  732. :group 'org-agenda-skip
  733. :group 'org-agenda-daily/weekly
  734. :version "24.1"
  735. :type '(choice
  736. (const :tag "Alwas show prewarning" nil)
  737. (const :tag "Remove prewarning if entry is scheduled" t)
  738. (integer :tag "Restart prewarning N days before deadline")))
  739. (defcustom org-agenda-skip-additional-timestamps-same-entry nil
  740. "When nil, multiple same-day timestamps in entry make multiple agenda lines.
  741. When non-nil, after the search for timestamps has matched once in an
  742. entry, the rest of the entry will not be searched."
  743. :group 'org-agenda-skip
  744. :type 'boolean)
  745. (defcustom org-agenda-skip-timestamp-if-done nil
  746. "Non-nil means don't select item by timestamp or -range if it is DONE."
  747. :group 'org-agenda-skip
  748. :group 'org-agenda-daily/weekly
  749. :type 'boolean)
  750. (defcustom org-agenda-dim-blocked-tasks t
  751. "Non-nil means dim blocked tasks in the agenda display.
  752. This causes some overhead during agenda construction, but if you
  753. have turned on `org-enforce-todo-dependencies',
  754. `org-enforce-todo-checkbox-dependencies', or any other blocking
  755. mechanism, this will create useful feedback in the agenda.
  756. Instead of t, this variable can also have the value `invisible'.
  757. Then blocked tasks will be invisible and only become visible when
  758. they become unblocked. An exemption to this behavior is when a task is
  759. blocked because of unchecked checkboxes below it. Since checkboxes do
  760. not show up in the agenda views, making this task invisible you remove any
  761. trace from agenda views that there is something to do. Therefore, a task
  762. that is blocked because of checkboxes will never be made invisible, it
  763. will only be dimmed."
  764. :group 'org-agenda-daily/weekly
  765. :group 'org-agenda-todo-list
  766. :type '(choice
  767. (const :tag "Do not dim" nil)
  768. (const :tag "Dim to a gray face" t)
  769. (const :tag "Make invisible" invisible)))
  770. (defcustom org-timeline-show-empty-dates 3
  771. "Non-nil means `org-timeline' also shows dates without an entry.
  772. When nil, only the days which actually have entries are shown.
  773. When t, all days between the first and the last date are shown.
  774. When an integer, show also empty dates, but if there is a gap of more than
  775. N days, just insert a special line indicating the size of the gap."
  776. :group 'org-agenda-skip
  777. :type '(choice
  778. (const :tag "None" nil)
  779. (const :tag "All" t)
  780. (integer :tag "at most")))
  781. (defgroup org-agenda-startup nil
  782. "Options concerning initial settings in the Agenda in Org Mode."
  783. :tag "Org Agenda Startup"
  784. :group 'org-agenda)
  785. (defcustom org-agenda-menu-show-matcher t
  786. "Non-nil means show the match string in the agenda dispatcher menu.
  787. When nil, the matcher string is not shown, but is put into the help-echo
  788. property so than moving the mouse over the command shows it.
  789. Setting it to nil is good if matcher strings are very long and/or if
  790. you want to use two-columns display (see `org-agenda-menu-two-columns')."
  791. :group 'org-agenda
  792. :version "24.1"
  793. :type 'boolean)
  794. (make-obsolete-variable 'org-agenda-menu-two-column 'org-agenda-menu-two-columns "24.3")
  795. (defcustom org-agenda-menu-two-columns nil
  796. "Non-nil means, use two columns to show custom commands in the dispatcher.
  797. If you use this, you probably want to set `org-agenda-menu-show-matcher'
  798. to nil."
  799. :group 'org-agenda
  800. :version "24.1"
  801. :type 'boolean)
  802. (defcustom org-finalize-agenda-hook nil
  803. "Hook run just before displaying an agenda buffer."
  804. :group 'org-agenda-startup
  805. :type 'hook)
  806. (defcustom org-agenda-mouse-1-follows-link nil
  807. "Non-nil means mouse-1 on a link will follow the link in the agenda.
  808. A longer mouse click will still set point. Does not work on XEmacs.
  809. Needs to be set before org.el is loaded."
  810. :group 'org-agenda-startup
  811. :type 'boolean)
  812. (defcustom org-agenda-start-with-follow-mode nil
  813. "The initial value of follow mode in a newly created agenda window."
  814. :group 'org-agenda-startup
  815. :type 'boolean)
  816. (defcustom org-agenda-follow-indirect nil
  817. "Non-nil means `org-agenda-follow-mode' displays only the
  818. current item's tree, in an indirect buffer."
  819. :group 'org-agenda
  820. :version "24.1"
  821. :type 'boolean)
  822. (defcustom org-agenda-show-outline-path t
  823. "Non-nil means show outline path in echo area after line motion."
  824. :group 'org-agenda-startup
  825. :type 'boolean)
  826. (defcustom org-agenda-start-with-entry-text-mode nil
  827. "The initial value of entry-text-mode in a newly created agenda window."
  828. :group 'org-agenda-startup
  829. :type 'boolean)
  830. (defcustom org-agenda-entry-text-maxlines 5
  831. "Number of text lines to be added when `E' is pressed in the agenda.
  832. Note that this variable only used during agenda display. Add add entry text
  833. when exporting the agenda, configure the variable
  834. `org-agenda-add-entry-ext-maxlines'."
  835. :group 'org-agenda
  836. :type 'integer)
  837. (defcustom org-agenda-entry-text-exclude-regexps nil
  838. "List of regular expressions to clean up entry text.
  839. The complete matches of all regular expressions in this list will be
  840. removed from entry text before it is shown in the agenda."
  841. :group 'org-agenda
  842. :type '(repeat (regexp)))
  843. (defvar org-agenda-entry-text-cleanup-hook nil
  844. "Hook that is run after basic cleanup of entry text to be shown in agenda.
  845. This cleanup is done in a temporary buffer, so the function may inspect and
  846. change the entire buffer.
  847. Some default stuff like drawers and scheduling/deadline dates will already
  848. have been removed when this is called, as will any matches for regular
  849. expressions listed in `org-agenda-entry-text-exclude-regexps'.")
  850. (defvar org-agenda-include-inactive-timestamps nil
  851. "Non-nil means include inactive time stamps in agenda and timeline.
  852. Dynamically scoped.")
  853. (defgroup org-agenda-windows nil
  854. "Options concerning the windows used by the Agenda in Org Mode."
  855. :tag "Org Agenda Windows"
  856. :group 'org-agenda)
  857. (defcustom org-agenda-window-setup 'reorganize-frame
  858. "How the agenda buffer should be displayed.
  859. Possible values for this option are:
  860. current-window Show agenda in the current window, keeping all other windows.
  861. other-window Use `switch-to-buffer-other-window' to display agenda.
  862. reorganize-frame Show only two windows on the current frame, the current
  863. window and the agenda.
  864. other-frame Use `switch-to-buffer-other-frame' to display agenda.
  865. Also, when exiting the agenda, kill that frame.
  866. See also the variable `org-agenda-restore-windows-after-quit'."
  867. :group 'org-agenda-windows
  868. :type '(choice
  869. (const current-window)
  870. (const other-frame)
  871. (const other-window)
  872. (const reorganize-frame)))
  873. (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
  874. "The min and max height of the agenda window as a fraction of frame height.
  875. The value of the variable is a cons cell with two numbers between 0 and 1.
  876. It only matters if `org-agenda-window-setup' is `reorganize-frame'."
  877. :group 'org-agenda-windows
  878. :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
  879. (defcustom org-agenda-restore-windows-after-quit nil
  880. "Non-nil means restore window configuration upon exiting agenda.
  881. Before the window configuration is changed for displaying the agenda,
  882. the current status is recorded. When the agenda is exited with
  883. `q' or `x' and this option is set, the old state is restored. If
  884. `org-agenda-window-setup' is `other-frame', the value of this
  885. option will be ignored."
  886. :group 'org-agenda-windows
  887. :type 'boolean)
  888. (defcustom org-agenda-ndays nil
  889. "Number of days to include in overview display.
  890. Should be 1 or 7.
  891. Obsolete, see `org-agenda-span'."
  892. :group 'org-agenda-daily/weekly
  893. :type 'integer)
  894. (make-obsolete-variable 'org-agenda-ndays 'org-agenda-span "24.1")
  895. (defcustom org-agenda-span 'week
  896. "Number of days to include in overview display.
  897. Can be day, week, month, year, or any number of days.
  898. Custom commands can set this variable in the options section."
  899. :group 'org-agenda-daily/weekly
  900. :type '(choice (const :tag "Day" day)
  901. (const :tag "Week" week)
  902. (const :tag "Month" month)
  903. (const :tag "Year" year)
  904. (integer :tag "Custom")))
  905. (defcustom org-agenda-start-on-weekday 1
  906. "Non-nil means start the overview always on the specified weekday.
  907. 0 denotes Sunday, 1 denotes Monday etc.
  908. When nil, always start on the current day.
  909. Custom commands can set this variable in the options section."
  910. :group 'org-agenda-daily/weekly
  911. :type '(choice (const :tag "Today" nil)
  912. (integer :tag "Weekday No.")))
  913. (defcustom org-agenda-show-all-dates t
  914. "Non-nil means `org-agenda' shows every day in the selected range.
  915. When nil, only the days which actually have entries are shown."
  916. :group 'org-agenda-daily/weekly
  917. :type 'boolean)
  918. (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
  919. "Format string for displaying dates in the agenda.
  920. Used by the daily/weekly agenda and by the timeline. This should be
  921. a format string understood by `format-time-string', or a function returning
  922. the formatted date as a string. The function must take a single argument,
  923. a calendar-style date list like (month day year)."
  924. :group 'org-agenda-daily/weekly
  925. :type '(choice
  926. (string :tag "Format string")
  927. (function :tag "Function")))
  928. (defun org-agenda-format-date-aligned (date)
  929. "Format a date string for display in the daily/weekly agenda, or timeline.
  930. This function makes sure that dates are aligned for easy reading."
  931. (require 'cal-iso)
  932. (let* ((dayname (calendar-day-name date))
  933. (day (cadr date))
  934. (day-of-week (calendar-day-of-week date))
  935. (month (car date))
  936. (monthname (calendar-month-name month))
  937. (year (nth 2 date))
  938. (iso-week (org-days-to-iso-week
  939. (calendar-absolute-from-gregorian date)))
  940. (weekyear (cond ((and (= month 1) (>= iso-week 52))
  941. (1- year))
  942. ((and (= month 12) (<= iso-week 1))
  943. (1+ year))
  944. (t year)))
  945. (weekstring (if (= day-of-week 1)
  946. (format " W%02d" iso-week)
  947. "")))
  948. (format "%-10s %2d %s %4d%s"
  949. dayname day monthname year weekstring)))
  950. (defcustom org-agenda-time-leading-zero nil
  951. "Non-nil means use leading zero for military times in agenda.
  952. For example, 9:30am would become 09:30 rather than 9:30."
  953. :group 'org-agenda-daily/weekly
  954. :version "24.1"
  955. :type 'boolean)
  956. (defcustom org-agenda-timegrid-use-ampm nil
  957. "When set, show AM/PM style timestamps on the timegrid."
  958. :group 'org-agenda
  959. :version "24.1"
  960. :type 'boolean)
  961. (defun org-agenda-time-of-day-to-ampm (time)
  962. "Convert TIME of a string like '13:45' to an AM/PM style time string."
  963. (let* ((hour-number (string-to-number (substring time 0 -3)))
  964. (minute (substring time -2))
  965. (ampm "am"))
  966. (cond
  967. ((equal hour-number 12)
  968. (setq ampm "pm"))
  969. ((> hour-number 12)
  970. (setq ampm "pm")
  971. (setq hour-number (- hour-number 12))))
  972. (concat
  973. (if org-agenda-time-leading-zero
  974. (format "%02d" hour-number)
  975. (format "%02s" (number-to-string hour-number)))
  976. ":" minute ampm)))
  977. (defun org-agenda-time-of-day-to-ampm-maybe (time)
  978. "Conditionally convert TIME to AM/PM format
  979. based on `org-agenda-timegrid-use-ampm'"
  980. (if org-agenda-timegrid-use-ampm
  981. (org-agenda-time-of-day-to-ampm time)
  982. time))
  983. (defcustom org-agenda-weekend-days '(6 0)
  984. "Which days are weekend?
  985. These days get the special face `org-agenda-date-weekend' in the agenda
  986. and timeline buffers."
  987. :group 'org-agenda-daily/weekly
  988. :type '(set :greedy t
  989. (const :tag "Monday" 1)
  990. (const :tag "Tuesday" 2)
  991. (const :tag "Wednesday" 3)
  992. (const :tag "Thursday" 4)
  993. (const :tag "Friday" 5)
  994. (const :tag "Saturday" 6)
  995. (const :tag "Sunday" 0)))
  996. (defcustom org-agenda-move-date-from-past-immediately-to-today t
  997. "Non-nil means jump to today when moving a past date forward in time.
  998. When using S-right in the agenda to move a a date forward, and the date
  999. stamp currently points to the past, the first key press will move it
  1000. to today. WHen nil, just move one day forward even if the date stays
  1001. in the past."
  1002. :group 'org-agenda-daily/weekly
  1003. :version "24.1"
  1004. :type 'boolean)
  1005. (defcustom org-agenda-include-diary nil
  1006. "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
  1007. Custom commands can set this variable in the options section."
  1008. :group 'org-agenda-daily/weekly
  1009. :type 'boolean)
  1010. (defcustom org-agenda-include-deadlines t
  1011. "If non-nil, include entries within their deadline warning period.
  1012. Custom commands can set this variable in the options section."
  1013. :group 'org-agenda-daily/weekly
  1014. :version "24.1"
  1015. :type 'boolean)
  1016. (defcustom org-agenda-repeating-timestamp-show-all t
  1017. "Non-nil means show all occurrences of a repeating stamp in the agenda.
  1018. When set to a list of strings, only show occurrences of repeating
  1019. stamps for these TODO keywords. When nil, only one occurrence is
  1020. shown, either today or the nearest into the future."
  1021. :group 'org-agenda-daily/weekly
  1022. :type '(choice
  1023. (const :tag "Show repeating stamps" t)
  1024. (repeat :tag "Show repeating stamps for these TODO keywords"
  1025. (string :tag "TODO Keyword"))
  1026. (const :tag "Don't show repeating stamps" nil)))
  1027. (defcustom org-scheduled-past-days 10000
  1028. "No. of days to continue listing scheduled items that are not marked DONE.
  1029. When an item is scheduled on a date, it shows up in the agenda on this
  1030. day and will be listed until it is marked done for the number of days
  1031. given here."
  1032. :group 'org-agenda-daily/weekly
  1033. :type 'integer)
  1034. (defcustom org-agenda-log-mode-items '(closed clock)
  1035. "List of items that should be shown in agenda log mode.
  1036. This list may contain the following symbols:
  1037. closed Show entries that have been closed on that day.
  1038. clock Show entries that have received clocked time on that day.
  1039. state Show all logged state changes.
  1040. Note that instead of changing this variable, you can also press `C-u l' in
  1041. the agenda to display all available LOG items temporarily."
  1042. :group 'org-agenda-daily/weekly
  1043. :type '(set :greedy t (const closed) (const clock) (const state)))
  1044. (defcustom org-agenda-clock-consistency-checks
  1045. '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
  1046. :gap-ok-around ("4:00")
  1047. :default-face ((:background "DarkRed") (:foreground "white"))
  1048. :overlap-face nil :gap-face nil :no-end-time-face nil
  1049. :long-face nil :short-face nil)
  1050. "This is a property list, with the following keys:
  1051. :max-duration Mark clocking chunks that are longer than this time.
  1052. This is a time string like \"HH:MM\", or the number
  1053. of minutes as an integer.
  1054. :min-duration Mark clocking chunks that are shorter that this.
  1055. This is a time string like \"HH:MM\", or the number
  1056. of minutes as an integer.
  1057. :max-gap Mark gaps between clocking chunks that are longer than
  1058. this duration. A number of minutes, or a string
  1059. like \"HH:MM\".
  1060. :gap-ok-around List of times during the day which are usually not working
  1061. times. When a gap is detected, but the gap contains any
  1062. of these times, the gap is *not* reported. For example,
  1063. if this is (\"4:00\" \"13:00\") then gaps that contain
  1064. 4:00 in the morning (i.e. the night) and 13:00
  1065. (i.e. a typical lunch time) do not cause a warning.
  1066. You should have at least one time during the night in this
  1067. list, or otherwise the first task each morning will trigger
  1068. a warning because it follows a long gap.
  1069. Furthermore, the following properties can be used to define faces for
  1070. issue display.
  1071. :default-face the default face, if the specific face is undefined
  1072. :overlap-face face for overlapping clocks
  1073. :gap-face face for gaps between clocks
  1074. :no-end-time-face face for incomplete clocks
  1075. :long-face face for clock intervals that are too long
  1076. :short-face face for clock intervals that are too short"
  1077. :group 'org-agenda-daily/weekly
  1078. :group 'org-clock
  1079. :version "24.1"
  1080. :type 'plist)
  1081. (defcustom org-agenda-log-mode-add-notes t
  1082. "Non-nil means add first line of notes to log entries in agenda views.
  1083. If a log item like a state change or a clock entry is associated with
  1084. notes, the first line of these notes will be added to the entry in the
  1085. agenda display."
  1086. :group 'org-agenda-daily/weekly
  1087. :type 'boolean)
  1088. (defcustom org-agenda-start-with-log-mode nil
  1089. "The initial value of log-mode in a newly created agenda window.
  1090. See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
  1091. explanations on the possible values."
  1092. :group 'org-agenda-startup
  1093. :group 'org-agenda-daily/weekly
  1094. :type '(choice (const :tag "Don't show log items" nil)
  1095. (const :tag "Show only log items" 'only)
  1096. (const :tag "Show all possible log items" 'clockcheck)
  1097. (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
  1098. (choice (const :tag "Show closed log items" 'closed)
  1099. (const :tag "Show clocked log items" 'clock)
  1100. (const :tag "Show all logged state changes" 'state)))))
  1101. (defcustom org-agenda-start-with-clockreport-mode nil
  1102. "The initial value of clockreport-mode in a newly created agenda window."
  1103. :group 'org-agenda-startup
  1104. :group 'org-agenda-daily/weekly
  1105. :type 'boolean)
  1106. (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
  1107. "Property list with parameters for the clocktable in clockreport mode.
  1108. This is the display mode that shows a clock table in the daily/weekly
  1109. agenda, the properties for this dynamic block can be set here.
  1110. The usual clocktable parameters are allowed here, but you cannot set
  1111. the properties :name, :tstart, :tend, :block, and :scope - these will
  1112. be overwritten to make sure the content accurately reflects the
  1113. current display in the agenda."
  1114. :group 'org-agenda-daily/weekly
  1115. :type 'plist)
  1116. (defcustom org-agenda-search-view-always-boolean nil
  1117. "Non-nil means the search string is interpreted as individual parts.
  1118. The search string for search view can either be interpreted as a phrase,
  1119. or as a list of snippets that define a boolean search for a number of
  1120. strings.
  1121. When this is non-nil, the string will be split on whitespace, and each
  1122. snippet will be searched individually, and all must match in order to
  1123. select an entry. A snippet is then a single string of non-white
  1124. characters, or a string in double quotes, or a regexp in {} braces.
  1125. If a snippet is preceded by \"-\", the snippet must *not* match.
  1126. \"+\" is syntactic sugar for positive selection. Each snippet may
  1127. be found as a full word or a partial word, but see the variable
  1128. `org-agenda-search-view-force-full-words'.
  1129. When this is nil, search will look for the entire search phrase as one,
  1130. with each space character matching any amount of whitespace, including
  1131. line breaks.
  1132. Even when this is nil, you can still switch to Boolean search dynamically
  1133. by preceding the first snippet with \"+\" or \"-\". If the first snippet
  1134. is a regexp marked with braces like \"{abc}\", this will also switch to
  1135. boolean search."
  1136. :group 'org-agenda-search-view
  1137. :version "24.1"
  1138. :type 'boolean)
  1139. (if (fboundp 'defvaralias)
  1140. (defvaralias 'org-agenda-search-view-search-words-only
  1141. 'org-agenda-search-view-always-boolean))
  1142. (defcustom org-agenda-search-view-force-full-words nil
  1143. "Non-nil means, search words must be matches as complete words.
  1144. When nil, they may also match part of a word."
  1145. :group 'org-agenda-search-view
  1146. :version "24.1"
  1147. :type 'boolean)
  1148. (defgroup org-agenda-time-grid nil
  1149. "Options concerning the time grid in the Org-mode Agenda."
  1150. :tag "Org Agenda Time Grid"
  1151. :group 'org-agenda)
  1152. (defcustom org-agenda-search-headline-for-time t
  1153. "Non-nil means search headline for a time-of-day.
  1154. If the headline contains a time-of-day in one format or another, it will
  1155. be used to sort the entry into the time sequence of items for a day.
  1156. Some people have time stamps in the headline that refer to the creation
  1157. time or so, and then this produces an unwanted side effect. If this is
  1158. the case for your, use this variable to turn off searching the headline
  1159. for a time."
  1160. :group 'org-agenda-time-grid
  1161. :type 'boolean)
  1162. (defcustom org-agenda-use-time-grid t
  1163. "Non-nil means show a time grid in the agenda schedule.
  1164. A time grid is a set of lines for specific times (like every two hours between
  1165. 8:00 and 20:00). The items scheduled for a day at specific times are
  1166. sorted in between these lines.
  1167. For details about when the grid will be shown, and what it will look like, see
  1168. the variable `org-agenda-time-grid'."
  1169. :group 'org-agenda-time-grid
  1170. :type 'boolean)
  1171. (defcustom org-agenda-time-grid
  1172. '((daily today require-timed)
  1173. "----------------"
  1174. (800 1000 1200 1400 1600 1800 2000))
  1175. "The settings for time grid for agenda display.
  1176. This is a list of three items. The first item is again a list. It contains
  1177. symbols specifying conditions when the grid should be displayed:
  1178. daily if the agenda shows a single day
  1179. weekly if the agenda shows an entire week
  1180. today show grid on current date, independent of daily/weekly display
  1181. require-timed show grid only if at least one item has a time specification
  1182. The second item is a string which will be placed behind the grid time.
  1183. The third item is a list of integers, indicating the times that should have
  1184. a grid line."
  1185. :group 'org-agenda-time-grid
  1186. :type
  1187. '(list
  1188. (set :greedy t :tag "Grid Display Options"
  1189. (const :tag "Show grid in single day agenda display" daily)
  1190. (const :tag "Show grid in weekly agenda display" weekly)
  1191. (const :tag "Always show grid for today" today)
  1192. (const :tag "Show grid only if any timed entries are present"
  1193. require-timed)
  1194. (const :tag "Skip grid times already present in an entry"
  1195. remove-match))
  1196. (string :tag "Grid String")
  1197. (repeat :tag "Grid Times" (integer :tag "Time"))))
  1198. (defcustom org-agenda-show-current-time-in-grid t
  1199. "Non-nil means show the current time in the time grid."
  1200. :group 'org-agenda-time-grid
  1201. :version "24.1"
  1202. :type 'boolean)
  1203. (defcustom org-agenda-current-time-string
  1204. "now - - - - - - - - - - - - - - - - - - - - - - - - -"
  1205. "The string for the current time marker in the agenda."
  1206. :group 'org-agenda-time-grid
  1207. :version "24.1"
  1208. :type 'string)
  1209. (defgroup org-agenda-sorting nil
  1210. "Options concerning sorting in the Org-mode Agenda."
  1211. :tag "Org Agenda Sorting"
  1212. :group 'org-agenda)
  1213. (defcustom org-agenda-sorting-strategy
  1214. '((agenda habit-down time-up priority-down category-keep)
  1215. (todo priority-down category-keep)
  1216. (tags priority-down category-keep)
  1217. (search category-keep))
  1218. "Sorting structure for the agenda items of a single day.
  1219. This is a list of symbols which will be used in sequence to determine
  1220. if an entry should be listed before another entry. The following
  1221. symbols are recognized:
  1222. time-up Put entries with time-of-day indications first, early first
  1223. time-down Put entries with time-of-day indications first, late first
  1224. category-keep Keep the default order of categories, corresponding to the
  1225. sequence in `org-agenda-files'.
  1226. category-up Sort alphabetically by category, A-Z.
  1227. category-down Sort alphabetically by category, Z-A.
  1228. tag-up Sort alphabetically by last tag, A-Z.
  1229. tag-down Sort alphabetically by last tag, Z-A.
  1230. priority-up Sort numerically by priority, high priority last.
  1231. priority-down Sort numerically by priority, high priority first.
  1232. todo-state-up Sort by todo state, tasks that are done last.
  1233. todo-state-down Sort by todo state, tasks that are done first.
  1234. effort-up Sort numerically by estimated effort, high effort last.
  1235. effort-down Sort numerically by estimated effort, high effort first.
  1236. user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
  1237. user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
  1238. habit-up Put entries that are habits first
  1239. habit-down Put entries that are habits last
  1240. alpha-up Sort headlines alphabetically
  1241. alpha-down Sort headlines alphabetically, reversed
  1242. The different possibilities will be tried in sequence, and testing stops
  1243. if one comparison returns a \"not-equal\". For example, the default
  1244. '(time-up category-keep priority-down)
  1245. means: Pull out all entries having a specified time of day and sort them,
  1246. in order to make a time schedule for the current day the first thing in the
  1247. agenda listing for the day. Of the entries without a time indication, keep
  1248. the grouped in categories, don't sort the categories, but keep them in
  1249. the sequence given in `org-agenda-files'. Within each category sort by
  1250. priority.
  1251. Leaving out `category-keep' would mean that items will be sorted across
  1252. categories by priority.
  1253. Instead of a single list, this can also be a set of list for specific
  1254. contents, with a context symbol in the car of the list, any of
  1255. `agenda', `todo', `tags', `search' for the corresponding agenda views.
  1256. Custom commands can bind this variable in the options section."
  1257. :group 'org-agenda-sorting
  1258. :type `(choice
  1259. (repeat :tag "General" ,org-sorting-choice)
  1260. (list :tag "Individually"
  1261. (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
  1262. (repeat ,org-sorting-choice))
  1263. (cons (const :tag "Strategy for TODO lists" todo)
  1264. (repeat ,org-sorting-choice))
  1265. (cons (const :tag "Strategy for Tags matches" tags)
  1266. (repeat ,org-sorting-choice))
  1267. (cons (const :tag "Strategy for search matches" search)
  1268. (repeat ,org-sorting-choice)))))
  1269. (defcustom org-agenda-cmp-user-defined nil
  1270. "A function to define the comparison `user-defined'.
  1271. This function must receive two arguments, agenda entry a and b.
  1272. If a>b, return +1. If a<b, return -1. If they are equal as seen by
  1273. the user comparison, return nil.
  1274. When this is defined, you can make `user-defined-up' and `user-defined-down'
  1275. part of an agenda sorting strategy."
  1276. :group 'org-agenda-sorting
  1277. :type 'symbol)
  1278. (defcustom org-sort-agenda-notime-is-late t
  1279. "Non-nil means items without time are considered late.
  1280. This is only relevant for sorting. When t, items which have no explicit
  1281. time like 15:30 will be considered as 99:01, i.e. later than any items which
  1282. do have a time. When nil, the default time is before 0:00. You can use this
  1283. option to decide if the schedule for today should come before or after timeless
  1284. agenda entries."
  1285. :group 'org-agenda-sorting
  1286. :type 'boolean)
  1287. (defcustom org-sort-agenda-noeffort-is-high t
  1288. "Non-nil means items without effort estimate are sorted as high effort.
  1289. This also applies when filtering an agenda view with respect to the
  1290. < or > effort operator. Then, tasks with no effort defined will be treated
  1291. as tasks with high effort.
  1292. When nil, such items are sorted as 0 minutes effort."
  1293. :group 'org-agenda-sorting
  1294. :type 'boolean)
  1295. (defgroup org-agenda-line-format nil
  1296. "Options concerning the entry prefix in the Org-mode agenda display."
  1297. :tag "Org Agenda Line Format"
  1298. :group 'org-agenda)
  1299. (defcustom org-agenda-prefix-format
  1300. '((agenda . " %i %-12:c%?-12t% s")
  1301. (timeline . " % s")
  1302. (todo . " %i %-12:c")
  1303. (tags . " %i %-12:c")
  1304. (search . " %i %-12:c"))
  1305. "Format specifications for the prefix of items in the agenda views.
  1306. An alist with five entries, each for the different agenda types. The
  1307. keys of the sublists are `agenda', `timeline', `todo', `search' and `tags'.
  1308. The values are format strings.
  1309. This format works similar to a printf format, with the following meaning:
  1310. %c the category of the item, \"Diary\" for entries from the diary,
  1311. or as given by the CATEGORY keyword or derived from the file name
  1312. %e the effort required by the item
  1313. %i the icon category of the item, see `org-agenda-category-icon-alist'
  1314. %T the last tag of the item (ignore inherited tags, which come first)
  1315. %t the HH:MM time-of-day specification if one applies to the entry
  1316. %s Scheduling/Deadline information, a short string
  1317. %(expression) Eval EXPRESSION and replace the control string
  1318. by the result
  1319. All specifiers work basically like the standard `%s' of printf, but may
  1320. contain two additional characters: a question mark just after the `%'
  1321. and a whitespace/punctuation character just before the final letter.
  1322. If the first character after `%' is a question mark, the entire field
  1323. will only be included if the corresponding value applies to the current
  1324. entry. This is useful for fields which should have fixed width when
  1325. present, but zero width when absent. For example, \"%?-12t\" will
  1326. result in a 12 character time field if a time of the day is specified,
  1327. but will completely disappear in entries which do not contain a time.
  1328. If there is punctuation or whitespace character just before the final
  1329. format letter, this character will be appended to the field value if
  1330. the value is not empty. For example, the format \"%-12:c\" leads to
  1331. \"Diary: \" if the category is \"Diary\". If the category were be
  1332. empty, no additional colon would be inserted.
  1333. The default value for the agenda sublist is \" %-12:c%?-12t% s\",
  1334. which means:
  1335. - Indent the line with two space characters
  1336. - Give the category a 12 chars wide field, padded with whitespace on
  1337. the right (because of `-'). Append a colon if there is a category
  1338. (because of `:').
  1339. - If there is a time-of-day, put it into a 12 chars wide field. If no
  1340. time, don't put in an empty field, just skip it (because of '?').
  1341. - Finally, put the scheduling information.
  1342. See also the variables `org-agenda-remove-times-when-in-prefix' and
  1343. `org-agenda-remove-tags'.
  1344. Custom commands can set this variable in the options section."
  1345. :type '(choice
  1346. (string :tag "General format")
  1347. (list :greedy t :tag "View dependent"
  1348. (cons (const agenda) (string :tag "Format"))
  1349. (cons (const timeline) (string :tag "Format"))
  1350. (cons (const todo) (string :tag "Format"))
  1351. (cons (const tags) (string :tag "Format"))
  1352. (cons (const search) (string :tag "Format"))))
  1353. :group 'org-agenda-line-format)
  1354. (defvar org-prefix-format-compiled nil
  1355. "The compiled prefix format and associated variables.
  1356. This is a list where first element is a list of variable bindings, and second
  1357. element is the compiled format expression. See the variable
  1358. `org-agenda-prefix-format'.")
  1359. (defcustom org-agenda-todo-keyword-format "%-1s"
  1360. "Format for the TODO keyword in agenda lines.
  1361. Set this to something like \"%-12s\" if you want all TODO keywords
  1362. to occupy a fixed space in the agenda display."
  1363. :group 'org-agenda-line-format
  1364. :type 'string)
  1365. (defcustom org-agenda-diary-sexp-prefix nil
  1366. "A regexp that matches part of a diary sexp entry
  1367. which should be treated as scheduling/deadline information in
  1368. `org-agenda'.
  1369. For example, you can use this to extract the `diary-remind-message' from
  1370. `diary-remind' entries."
  1371. :group 'org-agenda-line-format
  1372. :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
  1373. (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
  1374. "Text preceding timerange entries in the agenda view.
  1375. This is a list with two strings. The first applies when the range
  1376. is entirely on one day. The second applies if the range spans several days.
  1377. The strings may have two \"%d\" format specifiers which will be filled
  1378. with the sequence number of the days, and the total number of days in the
  1379. range, respectively."
  1380. :group 'org-agenda-line-format
  1381. :type '(list
  1382. (string :tag "Deadline today ")
  1383. (choice :tag "Deadline relative"
  1384. (string :tag "Format string")
  1385. (function))))
  1386. (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
  1387. "Text preceding scheduled items in the agenda view.
  1388. This is a list with two strings. The first applies when the item is
  1389. scheduled on the current day. The second applies when it has been scheduled
  1390. previously, it may contain a %d indicating that this is the nth time that
  1391. this item is scheduled, due to automatic rescheduling of unfinished items
  1392. for the following day. So this number is one larger than the number of days
  1393. that passed since this item was scheduled first."
  1394. :group 'org-agenda-line-format
  1395. :type '(list
  1396. (string :tag "Scheduled today ")
  1397. (string :tag "Scheduled previously")))
  1398. (defcustom org-agenda-inactive-leader "["
  1399. "Text preceding item pulled into the agenda by inactive time stamps.
  1400. These entries are added to the agenda when pressing \"[\"."
  1401. :group 'org-agenda-line-format
  1402. :version "24.1"
  1403. :type '(list
  1404. (string :tag "Scheduled today ")
  1405. (string :tag "Scheduled previously")))
  1406. (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: ")
  1407. "Text preceding deadline items in the agenda view.
  1408. This is a list with two strings. The first applies when the item has its
  1409. deadline on the current day. The second applies when it is in the past or
  1410. in the future, it may contain %d to capture how many days away the deadline
  1411. is (was)."
  1412. :group 'org-agenda-line-format
  1413. :type '(list
  1414. (string :tag "Deadline today ")
  1415. (choice :tag "Deadline relative"
  1416. (string :tag "Format string")
  1417. (function))))
  1418. (defcustom org-agenda-remove-times-when-in-prefix t
  1419. "Non-nil means remove duplicate time specifications in agenda items.
  1420. When the format `org-agenda-prefix-format' contains a `%t' specifier, a
  1421. time-of-day specification in a headline or diary entry is extracted and
  1422. placed into the prefix. If this option is non-nil, the original specification
  1423. \(a timestamp or -range, or just a plain time(range) specification like
  1424. 11:30-4pm) will be removed for agenda display. This makes the agenda less
  1425. cluttered.
  1426. The option can be t or nil. It may also be the symbol `beg', indicating
  1427. that the time should only be removed when it is located at the beginning of
  1428. the headline/diary entry."
  1429. :group 'org-agenda-line-format
  1430. :type '(choice
  1431. (const :tag "Always" t)
  1432. (const :tag "Never" nil)
  1433. (const :tag "When at beginning of entry" beg)))
  1434. (defcustom org-agenda-remove-timeranges-from-blocks nil
  1435. "Non-nil means remove time ranges specifications in agenda
  1436. items that span on several days."
  1437. :group 'org-agenda-line-format
  1438. :version "24.1"
  1439. :type 'boolean)
  1440. (defcustom org-agenda-default-appointment-duration nil
  1441. "Default duration for appointments that only have a starting time.
  1442. When nil, no duration is specified in such cases.
  1443. When non-nil, this must be the number of minutes, e.g. 60 for one hour."
  1444. :group 'org-agenda-line-format
  1445. :type '(choice
  1446. (integer :tag "Minutes")
  1447. (const :tag "No default duration")))
  1448. (defcustom org-agenda-show-inherited-tags t
  1449. "Non-nil means show inherited tags in each agenda line."
  1450. :group 'org-agenda-line-format
  1451. :type 'boolean)
  1452. (defcustom org-agenda-hide-tags-regexp nil
  1453. "Regular expression used to filter away specific tags in agenda views.
  1454. This means that these tags will be present, but not be shown in the agenda
  1455. line. Secondary filtering will still work on the hidden tags.
  1456. Nil means don't hide any tags."
  1457. :group 'org-agenda-line-format
  1458. :type '(choice
  1459. (const :tag "Hide none" nil)
  1460. (string :tag "Regexp ")))
  1461. (defcustom org-agenda-remove-tags nil
  1462. "Non-nil means remove the tags from the headline copy in the agenda.
  1463. When this is the symbol `prefix', only remove tags when
  1464. `org-agenda-prefix-format' contains a `%T' specifier."
  1465. :group 'org-agenda-line-format
  1466. :type '(choice
  1467. (const :tag "Always" t)
  1468. (const :tag "Never" nil)
  1469. (const :tag "When prefix format contains %T" prefix)))
  1470. (if (fboundp 'defvaralias)
  1471. (defvaralias 'org-agenda-remove-tags-when-in-prefix
  1472. 'org-agenda-remove-tags))
  1473. (defcustom org-agenda-tags-column (if (featurep 'xemacs) -79 -80)
  1474. "Shift tags in agenda items to this column.
  1475. If this number is positive, it specifies the column. If it is negative,
  1476. it means that the tags should be flushright to that column. For example,
  1477. -80 works well for a normal 80 character screen."
  1478. :group 'org-agenda-line-format
  1479. :type 'integer)
  1480. (if (fboundp 'defvaralias)
  1481. (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column))
  1482. (defcustom org-agenda-fontify-priorities 'cookies
  1483. "Non-nil means highlight low and high priorities in agenda.
  1484. When t, the highest priority entries are bold, lowest priority italic.
  1485. However, settings in `org-priority-faces' will overrule these faces.
  1486. When this variable is the symbol `cookies', only fontify the
  1487. cookies, not the entire task.
  1488. This may also be an association list of priority faces, whose
  1489. keys are the character values of `org-highest-priority',
  1490. `org-default-priority', and `org-lowest-priority' (the default values
  1491. are ?A, ?B, and ?C, respectively). The face may be a named face, a
  1492. color as a string, or a list like `(:background \"Red\")'.
  1493. If it is a color, the variable `org-faces-easy-properties'
  1494. determines if it is a foreground or a background color."
  1495. :group 'org-agenda-line-format
  1496. :type '(choice
  1497. (const :tag "Never" nil)
  1498. (const :tag "Defaults" t)
  1499. (const :tag "Cookies only" cookies)
  1500. (repeat :tag "Specify"
  1501. (list (character :tag "Priority" :value ?A)
  1502. (choice :tag "Face "
  1503. (string :tag "Color")
  1504. (sexp :tag "Face"))))))
  1505. (defcustom org-agenda-day-face-function nil
  1506. "Function called to determine what face should be used to display a day.
  1507. The only argument passed to that function is the day. It should
  1508. returns a face, or nil if does not want to specify a face and let
  1509. the normal rules apply."
  1510. :group 'org-agenda-line-format
  1511. :version "24.1"
  1512. :type 'function)
  1513. (defcustom org-agenda-category-icon-alist nil
  1514. "Alist of category icon to be displayed in agenda views.
  1515. Each entry should have the following format:
  1516. (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
  1517. Where CATEGORY-REGEXP is a regexp matching the categories where
  1518. the icon should be displayed.
  1519. FILE-OR-DATA either a file path or a string containing image data.
  1520. The other fields can be omitted safely if not needed:
  1521. TYPE indicates the image type.
  1522. DATA-P is a boolean indicating whether the FILE-OR-DATA string is
  1523. image data.
  1524. PROPS are additional image attributes to assign to the image,
  1525. like, e.g. `:ascent center'.
  1526. (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
  1527. If you want to set the display properties yourself, just put a
  1528. list as second element:
  1529. (CATEGORY-REGEXP (MY PROPERTY LIST))
  1530. For example, to display a 16px horizontal space for Emacs
  1531. category, you can use:
  1532. (\"Emacs\" '(space . (:width (16))))"
  1533. :group 'org-agenda-line-format
  1534. :version "24.1"
  1535. :type '(alist :key-type (string :tag "Regexp matching category")
  1536. :value-type (choice (list :tag "Icon"
  1537. (string :tag "File or data")
  1538. (symbol :tag "Type")
  1539. (boolean :tag "Data?")
  1540. (repeat :tag "Extra image properties" :inline t symbol))
  1541. (list :tag "Display properties" sexp))))
  1542. (defgroup org-agenda-column-view nil
  1543. "Options concerning column view in the agenda."
  1544. :tag "Org Agenda Column View"
  1545. :group 'org-agenda)
  1546. (defcustom org-agenda-columns-show-summaries t
  1547. "Non-nil means show summaries for columns displayed in the agenda view."
  1548. :group 'org-agenda-column-view
  1549. :type 'boolean)
  1550. (defcustom org-agenda-columns-compute-summary-properties t
  1551. "Non-nil means recompute all summary properties before column view.
  1552. When column view in the agenda is listing properties that have a summary
  1553. operator, it can go to all relevant buffers and recompute the summaries
  1554. there. This can mean overhead for the agenda column view, but is necessary
  1555. to have thing up to date.
  1556. As a special case, a CLOCKSUM property also makes sure that the clock
  1557. computations are current."
  1558. :group 'org-agenda-column-view
  1559. :type 'boolean)
  1560. (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
  1561. "Non-nil means the duration of an appointment will add to day effort.
  1562. The property to which appointment durations will be added is the one given
  1563. in the option `org-effort-property'. If an appointment does not have
  1564. an end time, `org-agenda-default-appointment-duration' will be used. If that
  1565. is not set, an appointment without end time will not contribute to the time
  1566. estimate."
  1567. :group 'org-agenda-column-view
  1568. :type 'boolean)
  1569. (defcustom org-agenda-auto-exclude-function nil
  1570. "A function called with a tag to decide if it is filtered on '/ RET'.
  1571. The sole argument to the function, which is called once for each
  1572. possible tag, is a string giving the name of the tag. The
  1573. function should return either nil if the tag should be included
  1574. as normal, or \"-<TAG>\" to exclude the tag.
  1575. Note that for the purpose of tag filtering, only the lower-case version of
  1576. all tags will be considered, so that this function will only ever see
  1577. the lower-case version of all tags."
  1578. :group 'org-agenda
  1579. :type 'function)
  1580. (defcustom org-agenda-bulk-custom-functions nil
  1581. "Alist of characters and custom functions for bulk actions.
  1582. For example, this value makes those two functions available:
  1583. '((?R set-category)
  1584. (?C bulk-cut))
  1585. With selected entries in an agenda buffer, `B R' will call
  1586. the custom function `set-category' on the selected entries.
  1587. Note that functions in this alist don't need to be quoted."
  1588. :type 'alist
  1589. :version "24.1"
  1590. :group 'org-agenda)
  1591. (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
  1592. "Execute BODY with point at location given by `org-hd-marker' property.
  1593. If STRING is non-nil, the text property will be fetched from position 0
  1594. in that string. If STRING is nil, it will be fetched from the beginning
  1595. of the current line."
  1596. (org-with-gensyms (marker)
  1597. `(let ((,marker (get-text-property (if string 0 (point-at-bol))
  1598. 'org-hd-marker ,string)))
  1599. (with-current-buffer (marker-buffer ,marker)
  1600. (save-excursion
  1601. (goto-char ,marker)
  1602. ,@body)))))
  1603. (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
  1604. (defun org-add-agenda-custom-command (entry)
  1605. "Replace or add a command in `org-agenda-custom-commands'.
  1606. This is mostly for hacking and trying a new command - once the command
  1607. works you probably want to add it to `org-agenda-custom-commands' for good."
  1608. (let ((ass (assoc (car entry) org-agenda-custom-commands)))
  1609. (if ass
  1610. (setcdr ass (cdr entry))
  1611. (push entry org-agenda-custom-commands))))
  1612. ;;; Define the org-agenda-mode
  1613. (defvar org-agenda-mode-map (make-sparse-keymap)
  1614. "Keymap for `org-agenda-mode'.")
  1615. (if (fboundp 'defvaralias)
  1616. (defvaralias 'org-agenda-keymap 'org-agenda-mode-map))
  1617. (defvar org-agenda-menu) ; defined later in this file.
  1618. (defvar org-agenda-restrict) ; defined later in this file.
  1619. (defvar org-agenda-follow-mode nil)
  1620. (defvar org-agenda-entry-text-mode nil)
  1621. (defvar org-agenda-clockreport-mode nil)
  1622. (defvar org-agenda-show-log nil)
  1623. (defvar org-agenda-redo-command nil)
  1624. (defvar org-agenda-query-string nil)
  1625. (defvar org-agenda-mode-hook nil
  1626. "Hook for `org-agenda-mode', run after the mode is turned on.")
  1627. (defvar org-agenda-type nil)
  1628. (defvar org-agenda-force-single-file nil)
  1629. (defvar org-agenda-bulk-marked-entries) ;; Defined further down in this file
  1630. ;;; Multiple agenda buffers support
  1631. (defcustom org-agenda-sticky nil
  1632. "Non-nil means agenda q key will bury agenda buffers.
  1633. Agenda commands will then show existing buffer instead of generating new ones.
  1634. When nil, `q' will kill the single agenda buffer."
  1635. :group 'org-agenda
  1636. :type 'boolean
  1637. :set (lambda (var val)
  1638. (if (boundp var)
  1639. (org-toggle-sticky-agenda (if val 1 0))
  1640. (set var val))))
  1641. (defun org-toggle-sticky-agenda (&optional arg)
  1642. "Toggle `org-agenda-sticky'."
  1643. (interactive "P")
  1644. (let ((new-value (if arg
  1645. (> (prefix-numeric-value arg) 0)
  1646. (not org-agenda-sticky))))
  1647. (if (equal new-value org-agenda-sticky)
  1648. (and (org-called-interactively-p 'interactive)
  1649. (message "Sticky agenda was already %s"
  1650. (if org-agenda-sticky "enabled" "disabled")))
  1651. (setq org-agenda-sticky new-value)
  1652. (org-agenda-kill-all-agenda-buffers)
  1653. (and (org-called-interactively-p 'interactive)
  1654. (message "Sticky agenda was %s"
  1655. (if org-agenda-sticky "enabled" "disabled"))))))
  1656. (defvar org-agenda-buffer nil
  1657. "Agenda buffer currently being generated.")
  1658. (defvar org-agenda-last-prefix-arg nil)
  1659. (defvar org-agenda-this-buffer-name nil)
  1660. (defvar org-agenda-doing-sticky-redo nil)
  1661. (defvar org-agenda-this-buffer-is-sticky nil)
  1662. (defconst org-agenda-local-vars
  1663. '(org-agenda-this-buffer-name
  1664. org-agenda-undo-list
  1665. org-agenda-pending-undo-list
  1666. org-agenda-follow-mode
  1667. org-agenda-entry-text-mode
  1668. org-agenda-clockreport-mode
  1669. org-agenda-show-log
  1670. org-agenda-redo-command
  1671. org-agenda-query-string
  1672. org-agenda-type
  1673. org-agenda-bulk-marked-entries
  1674. org-agenda-undo-has-started-in
  1675. org-agenda-last-arguments
  1676. org-agenda-info
  1677. org-agenda-tag-filter-overlays
  1678. org-agenda-cat-filter-overlays
  1679. org-pre-agenda-window-conf
  1680. org-agenda-columns-active
  1681. org-agenda-tag-filter
  1682. org-agenda-category-filter
  1683. org-agenda-markers
  1684. org-agenda-last-search-view-search-was-boolean
  1685. org-agenda-filtered-by-category
  1686. org-agenda-filter-form
  1687. org-agenda-show-window
  1688. org-agenda-cycle-counter
  1689. org-agenda-last-prefix-arg)
  1690. "Variables that must be local in agenda buffers to allow multiple buffers.")
  1691. (defun org-agenda-mode ()
  1692. "Mode for time-sorted view on action items in Org-mode files.
  1693. The following commands are available:
  1694. \\{org-agenda-mode-map}"
  1695. (interactive)
  1696. (cond (org-agenda-doing-sticky-redo
  1697. ;; Refreshing sticky agenda-buffer
  1698. ;;
  1699. ;; Preserve the value of `org-agenda-local-vars' variables,
  1700. ;; while letting `kill-all-local-variables' kill the rest
  1701. (let ((save (buffer-local-variables)))
  1702. (kill-all-local-variables)
  1703. (mapc 'make-local-variable org-agenda-local-vars)
  1704. (dolist (elem save)
  1705. (let ((var (car elem))
  1706. (val (cdr elem)))
  1707. (when (and val
  1708. (member var org-agenda-local-vars))
  1709. (set var val)))))
  1710. (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
  1711. (org-agenda-sticky
  1712. ;; Creating a sticky Agenda buffer for the first time
  1713. (kill-all-local-variables)
  1714. (mapc 'make-local-variable org-agenda-local-vars)
  1715. (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
  1716. (t
  1717. ;; Creating a non-sticky agenda buffer
  1718. (kill-all-local-variables)
  1719. (set (make-local-variable 'org-agenda-this-buffer-is-sticky) nil)))
  1720. (setq org-agenda-undo-list nil
  1721. org-agenda-pending-undo-list nil
  1722. org-agenda-bulk-marked-entries nil)
  1723. (setq major-mode 'org-agenda-mode)
  1724. ;; Keep global-font-lock-mode from turning on font-lock-mode
  1725. (org-set-local 'font-lock-global-modes (list 'not major-mode))
  1726. (setq mode-name "Org-Agenda")
  1727. (use-local-map org-agenda-mode-map)
  1728. (easy-menu-add org-agenda-menu)
  1729. (if org-startup-truncated (setq truncate-lines t))
  1730. (org-set-local 'line-move-visual nil)
  1731. (org-add-hook 'post-command-hook 'org-agenda-post-command-hook nil 'local)
  1732. (org-add-hook 'pre-command-hook 'org-unhighlight nil 'local)
  1733. ;; Make sure properties are removed when copying text
  1734. (make-local-variable 'filter-buffer-substring-functions)
  1735. (add-hook 'filter-buffer-substring-functions
  1736. (lambda (fun start end delete)
  1737. (substring-no-properties (funcall fun start end delete))))
  1738. (unless org-agenda-keep-modes
  1739. (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
  1740. org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
  1741. org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode
  1742. org-agenda-show-log org-agenda-start-with-log-mode))
  1743. (easy-menu-change
  1744. '("Agenda") "Agenda Files"
  1745. (append
  1746. (list
  1747. (vector
  1748. (if (get 'org-agenda-files 'org-restrict)
  1749. "Restricted to single file"
  1750. "Edit File List")
  1751. '(org-edit-agenda-file-list)
  1752. (not (get 'org-agenda-files 'org-restrict)))
  1753. "--")
  1754. (mapcar 'org-file-menu-entry (org-agenda-files))))
  1755. (org-agenda-set-mode-name)
  1756. (apply
  1757. (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
  1758. (list 'org-agenda-mode-hook)))
  1759. (substitute-key-definition 'undo 'org-agenda-undo
  1760. org-agenda-mode-map global-map)
  1761. (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
  1762. (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
  1763. (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
  1764. (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
  1765. (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
  1766. (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
  1767. (org-defkey org-agenda-mode-map "*" 'org-agenda-bulk-mark-all)
  1768. (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
  1769. (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
  1770. (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-unmark-all)
  1771. (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
  1772. (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
  1773. (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
  1774. (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
  1775. (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
  1776. (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
  1777. (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
  1778. (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
  1779. (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
  1780. (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
  1781. (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
  1782. (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
  1783. (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
  1784. (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
  1785. (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
  1786. (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
  1787. (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
  1788. (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
  1789. (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
  1790. (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
  1791. (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
  1792. (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
  1793. (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
  1794. (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
  1795. (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
  1796. (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
  1797. (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
  1798. (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
  1799. (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
  1800. (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
  1801. (org-defkey org-agenda-mode-map "k" 'org-agenda-action)
  1802. (org-defkey org-agenda-mode-map "\C-c\C-x\C-k" 'org-agenda-action)
  1803. (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
  1804. (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
  1805. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
  1806. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
  1807. (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
  1808. (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
  1809. (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
  1810. (let ((l '(1 2 3 4 5 6 7 8 9 0)))
  1811. (while l (org-defkey org-agenda-mode-map
  1812. (int-to-string (pop l)) 'digit-argument)))
  1813. (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
  1814. (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
  1815. (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
  1816. (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
  1817. (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
  1818. (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
  1819. (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
  1820. (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
  1821. (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
  1822. (org-defkey org-agenda-mode-map "g" 'org-agenda-redo)
  1823. (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
  1824. (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
  1825. (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
  1826. 'org-clock-modify-effort-estimate)
  1827. (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
  1828. (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
  1829. (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
  1830. (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
  1831. (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
  1832. (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
  1833. (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
  1834. (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
  1835. (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
  1836. (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
  1837. (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
  1838. (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
  1839. (substitute-key-definition 'next-line 'org-agenda-next-line
  1840. org-agenda-mode-map global-map)
  1841. (substitute-key-definition 'previous-line 'org-agenda-previous-line
  1842. org-agenda-mode-map global-map)
  1843. (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
  1844. (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
  1845. (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
  1846. (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
  1847. (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-show-priority)
  1848. (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
  1849. (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
  1850. (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
  1851. (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
  1852. (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
  1853. (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
  1854. (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
  1855. (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
  1856. (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
  1857. (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
  1858. (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
  1859. (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
  1860. (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
  1861. (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  1862. (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
  1863. (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
  1864. (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
  1865. (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
  1866. (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
  1867. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
  1868. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
  1869. (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
  1870. (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
  1871. (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
  1872. (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  1873. (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
  1874. (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
  1875. (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
  1876. (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
  1877. (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
  1878. (org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag-refine)
  1879. (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
  1880. (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-category)
  1881. (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
  1882. (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
  1883. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  1884. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  1885. (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
  1886. (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
  1887. (when org-agenda-mouse-1-follows-link
  1888. (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
  1889. (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
  1890. '("Agenda"
  1891. ("Agenda Files")
  1892. "--"
  1893. ("Agenda Dates"
  1894. ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
  1895. ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
  1896. ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
  1897. ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
  1898. "--"
  1899. ("View"
  1900. ["Day View" org-agenda-day-view
  1901. :active (org-agenda-check-type nil 'agenda)
  1902. :style radio :selected (eq org-agenda-current-span 'day)
  1903. :keys "v d (or just d)"]
  1904. ["Week View" org-agenda-week-view
  1905. :active (org-agenda-check-type nil 'agenda)
  1906. :style radio :selected (eq org-agenda-current-span 'week)
  1907. :keys "v w (or just w)"]
  1908. ["Month View" org-agenda-month-view
  1909. :active (org-agenda-check-type nil 'agenda)
  1910. :style radio :selected (eq org-agenda-current-span 'month)
  1911. :keys "v m"]
  1912. ["Year View" org-agenda-year-view
  1913. :active (org-agenda-check-type nil 'agenda)
  1914. :style radio :selected (eq org-agenda-current-span 'year)
  1915. :keys "v y"]
  1916. "--"
  1917. ["Include Diary" org-agenda-toggle-diary
  1918. :style toggle :selected org-agenda-include-diary
  1919. :active (org-agenda-check-type nil 'agenda)]
  1920. ["Include Deadlines" org-agenda-toggle-deadlines
  1921. :style toggle :selected org-agenda-include-deadlines
  1922. :active (org-agenda-check-type nil 'agenda)]
  1923. ["Use Time Grid" org-agenda-toggle-time-grid
  1924. :style toggle :selected org-agenda-use-time-grid
  1925. :active (org-agenda-check-type nil 'agenda)]
  1926. "--"
  1927. ["Show clock report" org-agenda-clockreport-mode
  1928. :style toggle :selected org-agenda-clockreport-mode
  1929. :active (org-agenda-check-type nil 'agenda)]
  1930. ["Show some entry text" org-agenda-entry-text-mode
  1931. :style toggle :selected org-agenda-entry-text-mode
  1932. :active t]
  1933. "--"
  1934. ["Show Logbook entries" org-agenda-log-mode
  1935. :style toggle :selected org-agenda-show-log
  1936. :active (org-agenda-check-type nil 'agenda 'timeline)
  1937. :keys "v l (or just l)"]
  1938. ["Include archived trees" org-agenda-archives-mode
  1939. :style toggle :selected org-agenda-archives-mode :active t
  1940. :keys "v a"]
  1941. ["Include archive files" (org-agenda-archives-mode t)
  1942. :style toggle :selected (eq org-agenda-archives-mode t) :active t
  1943. :keys "v A"]
  1944. "--"
  1945. ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
  1946. ["Write view to file" org-agenda-write t]
  1947. ["Rebuild buffer" org-agenda-redo t]
  1948. ["Save all Org-mode Buffers" org-save-all-org-buffers t]
  1949. "--"
  1950. ["Show original entry" org-agenda-show t]
  1951. ["Go To (other window)" org-agenda-goto t]
  1952. ["Go To (this window)" org-agenda-switch-to t]
  1953. ["Follow Mode" org-agenda-follow-mode
  1954. :style toggle :selected org-agenda-follow-mode :active t]
  1955. ; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
  1956. "--"
  1957. ("TODO"
  1958. ["Cycle TODO" org-agenda-todo t]
  1959. ["Next TODO set" org-agenda-todo-nextset t]
  1960. ["Previous TODO set" org-agenda-todo-previousset t]
  1961. ["Add note" org-agenda-add-note t])
  1962. ("Archive/Refile/Delete"
  1963. ["Archive default" org-agenda-archive-default t]
  1964. ["Archive default" org-agenda-archive-default-with-confirmation t]
  1965. ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
  1966. ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
  1967. ["Archive subtree" org-agenda-archive t]
  1968. "--"
  1969. ["Refile" org-agenda-refile t]
  1970. "--"
  1971. ["Delete subtree" org-agenda-kill t])
  1972. ("Bulk action"
  1973. ["Mark entry" org-agenda-bulk-mark t]
  1974. ["Mark all" org-agenda-bulk-mark-all t]
  1975. ["Mark matching regexp" org-agenda-bulk-mark-regexp t]
  1976. ["Unmark entry" org-agenda-bulk-unmark t]
  1977. ["Unmark all entries" org-agenda-bulk-unmark-all :active t :keys "C-u s"])
  1978. ["Act on all marked" org-agenda-bulk-action t]
  1979. "--"
  1980. ("Tags and Properties"
  1981. ["Show all Tags" org-agenda-show-tags t]
  1982. ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
  1983. ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
  1984. "--"
  1985. ["Column View" org-columns t])
  1986. ("Deadline/Schedule"
  1987. ["Schedule" org-agenda-schedule t]
  1988. ["Set Deadline" org-agenda-deadline t]
  1989. "--"
  1990. ["Mark item" org-agenda-action :active t :keys "k m"]
  1991. ["Show mark item" org-agenda-action :active t :keys "k v"]
  1992. ["Schedule marked item" org-agenda-action :active t :keys "k s"]
  1993. ["Set Deadline for marked item" org-agenda-action :active t :keys "k d"]
  1994. "--"
  1995. ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
  1996. ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
  1997. ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
  1998. ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
  1999. ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
  2000. ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
  2001. ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
  2002. ("Clock and Effort"
  2003. ["Clock in" org-agenda-clock-in t]
  2004. ["Clock out" org-agenda-clock-out t]
  2005. ["Clock cancel" org-agenda-clock-cancel t]
  2006. ["Goto running clock" org-clock-goto t]
  2007. "--"
  2008. ["Set Effort" org-agenda-set-effort t]
  2009. ["Change clocked effort" org-clock-modify-effort-estimate
  2010. (org-clock-is-active)])
  2011. ("Priority"
  2012. ["Set Priority" org-agenda-priority t]
  2013. ["Increase Priority" org-agenda-priority-up t]
  2014. ["Decrease Priority" org-agenda-priority-down t]
  2015. ["Show Priority" org-agenda-show-priority t])
  2016. ("Calendar/Diary"
  2017. ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
  2018. ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
  2019. ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
  2020. ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
  2021. ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
  2022. ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
  2023. "--"
  2024. ["Create iCalendar File" org-export-icalendar-combine-agenda-files t])
  2025. "--"
  2026. ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
  2027. "--"
  2028. ("MobileOrg"
  2029. ["Push Files and Views" org-mobile-push t]
  2030. ["Get Captured and Flagged" org-mobile-pull t]
  2031. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
  2032. ["Show note / unflag" org-agenda-show-the-flagging-note t]
  2033. "--"
  2034. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  2035. "--"
  2036. ["Quit" org-agenda-quit t]
  2037. ["Exit and Release Buffers" org-agenda-exit t]
  2038. ))
  2039. ;;; Agenda undo
  2040. (defvar org-agenda-allow-remote-undo t
  2041. "Non-nil means allow remote undo from the agenda buffer.")
  2042. (defvar org-agenda-undo-list nil
  2043. "List of undoable operations in the agenda since last refresh.")
  2044. (defvar org-agenda-undo-has-started-in nil
  2045. "Buffers that have already seen `undo-start' in the current undo sequence.")
  2046. (defvar org-agenda-pending-undo-list nil
  2047. "In a series of undo commands, this is the list of remaining undo items.")
  2048. (defun org-agenda-undo ()
  2049. "Undo a remote editing step in the agenda.
  2050. This undoes changes both in the agenda buffer and in the remote buffer
  2051. that have been changed along."
  2052. (interactive)
  2053. (or org-agenda-allow-remote-undo
  2054. (error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
  2055. (if (not (eq this-command last-command))
  2056. (setq org-agenda-undo-has-started-in nil
  2057. org-agenda-pending-undo-list org-agenda-undo-list))
  2058. (if (not org-agenda-pending-undo-list)
  2059. (error "No further undo information"))
  2060. (let* ((entry (pop org-agenda-pending-undo-list))
  2061. buf line cmd rembuf)
  2062. (setq cmd (pop entry) line (pop entry))
  2063. (setq rembuf (nth 2 entry))
  2064. (org-with-remote-undo rembuf
  2065. (while (bufferp (setq buf (pop entry)))
  2066. (if (pop entry)
  2067. (with-current-buffer buf
  2068. (let ((last-undo-buffer buf)
  2069. (inhibit-read-only t))
  2070. (unless (memq buf org-agenda-undo-has-started-in)
  2071. (push buf org-agenda-undo-has-started-in)
  2072. (make-local-variable 'pending-undo-list)
  2073. (undo-start))
  2074. (while (and pending-undo-list
  2075. (listp pending-undo-list)
  2076. (not (car pending-undo-list)))
  2077. (pop pending-undo-list))
  2078. (undo-more 1))))))
  2079. (org-goto-line line)
  2080. (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
  2081. (defun org-verify-change-for-undo (l1 l2)
  2082. "Verify that a real change occurred between the undo lists L1 and L2."
  2083. (while (and l1 (listp l1) (null (car l1))) (pop l1))
  2084. (while (and l2 (listp l2) (null (car l2))) (pop l2))
  2085. (not (eq l1 l2)))
  2086. ;;; Agenda dispatch
  2087. (defvar org-agenda-restrict nil)
  2088. (defvar org-agenda-restrict-begin (make-marker))
  2089. (defvar org-agenda-restrict-end (make-marker))
  2090. (defvar org-agenda-last-dispatch-buffer nil)
  2091. (defvar org-agenda-overriding-restriction nil)
  2092. (defcustom org-agenda-custom-commands-contexts nil
  2093. "Alist of custom agenda commands and valid contexts.
  2094. For example, if you have a custom agenda command \"p\" and you
  2095. want this command to be accessible only from plain text files,
  2096. use this:
  2097. '((\"p\" \"p\" (in-file . \"\\.txt\")))
  2098. If you replace the second \"p\" by another key (say \"q\"), then
  2099. the \"p\" key will be associated with the \"q\" command in the
  2100. valid contexts. This is useful if you want to use the same key
  2101. to reach multiple commands depending on the context:
  2102. '((\"p\" \"q\" (in-file . \"\\.txt\"))
  2103. (\"p\" \"r\" (in-file . \"\\.el\"))
  2104. (\"p\" \"s\" (in-file . \"\\.c\")))
  2105. Here, the \"p\" key will be accessible from buffers visiting
  2106. .txt, .el and .c files, and it will be a synonym for \"q\", \"r\"
  2107. and \"s\" respectively.
  2108. Here are the available contexts definition:
  2109. in-file: command displayed only in matching files
  2110. in-mode: command displayed only in matching modes
  2111. not-in-file: command not displayed in matching files
  2112. not-in-mode: command not displayed in matching modes
  2113. If you define several checks, the agenda command will be
  2114. accessible if there is at least one valid check."
  2115. ;; :version "24.3"
  2116. :group 'org-agenda-custom-commands
  2117. :type '(repeat (list :tag "Rule"
  2118. (string :tag "Agenda key")
  2119. (string :tag "Replace by command")
  2120. (repeat :tag "Available when"
  2121. (cons :tag "Condition"
  2122. (choice
  2123. (const :tag "In file" in-file)
  2124. (const :tag "Not in file" not-in-file)
  2125. (const :tag "In mode" in-mode)
  2126. (const :tag "Not in mode" not-in-mode))
  2127. (regexp))))))
  2128. ;;;###autoload
  2129. (defun org-agenda (&optional arg keys restriction)
  2130. "Dispatch agenda commands to collect entries to the agenda buffer.
  2131. Prompts for a command to execute. Any prefix arg will be passed
  2132. on to the selected command. The default selections are:
  2133. a Call `org-agenda-list' to display the agenda for current day or week.
  2134. t Call `org-todo-list' to display the global todo list.
  2135. T Call `org-todo-list' to display the global todo list, select only
  2136. entries with a specific TODO keyword (the user gets a prompt).
  2137. m Call `org-tags-view' to display headlines with tags matching
  2138. a condition (the user is prompted for the condition).
  2139. M Like `m', but select only TODO entries, no ordinary headlines.
  2140. L Create a timeline for the current buffer.
  2141. e Export views to associated files.
  2142. s Search entries for keywords.
  2143. / Multi occur across all agenda files and also files listed
  2144. in `org-agenda-text-search-extra-files'.
  2145. < Restrict agenda commands to buffer, subtree, or region.
  2146. Press several times to get the desired effect.
  2147. > Remove a previous restriction.
  2148. # List \"stuck\" projects.
  2149. ! Configure what \"stuck\" means.
  2150. C Configure custom agenda commands.
  2151. More commands can be added by configuring the variable
  2152. `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
  2153. searches can be pre-defined in this way.
  2154. If the current buffer is in Org-mode and visiting a file, you can also
  2155. first press `<' once to indicate that the agenda should be temporarily
  2156. \(until the next use of \\[org-agenda]) restricted to the current file.
  2157. Pressing `<' twice means to restrict to the current subtree or region
  2158. \(if active)."
  2159. (interactive "P")
  2160. (catch 'exit
  2161. (let* ((prefix-descriptions nil)
  2162. (org-agenda-buffer-name org-agenda-buffer-name)
  2163. (org-agenda-window-setup (if (equal (buffer-name)
  2164. org-agenda-buffer-name)
  2165. 'current-window
  2166. org-agenda-window-setup))
  2167. (org-agenda-custom-commands-orig org-agenda-custom-commands)
  2168. (org-agenda-custom-commands
  2169. ;; normalize different versions
  2170. (delq nil
  2171. (mapcar
  2172. (lambda (x)
  2173. (cond ((stringp (cdr x))
  2174. (push x prefix-descriptions)
  2175. nil)
  2176. ((stringp (nth 1 x)) x)
  2177. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2178. (t (cons (car x) (cons "" (cdr x))))))
  2179. org-agenda-custom-commands)))
  2180. (org-agenda-custom-commands
  2181. (org-contextualize-agenda-or-capture
  2182. org-agenda-custom-commands org-agenda-custom-commands-contexts))
  2183. (buf (current-buffer))
  2184. (bfn (buffer-file-name (buffer-base-buffer)))
  2185. entry key type match lprops ans)
  2186. ;; Turn off restriction unless there is an overriding one,
  2187. (unless org-agenda-overriding-restriction
  2188. (unless (org-bound-and-true-p org-agenda-keep-restricted-file-list)
  2189. ;; There is a request to keep the file list in place
  2190. (put 'org-agenda-files 'org-restrict nil))
  2191. (setq org-agenda-restrict nil)
  2192. (move-marker org-agenda-restrict-begin nil)
  2193. (move-marker org-agenda-restrict-end nil))
  2194. ;; Delete old local properties
  2195. (put 'org-agenda-redo-command 'org-lprops nil)
  2196. ;; Delete previously set last-arguments
  2197. (put 'org-agenda-redo-command 'last-args nil)
  2198. ;; Remember where this call originated
  2199. (setq org-agenda-last-dispatch-buffer (current-buffer))
  2200. (unless keys
  2201. (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
  2202. keys (car ans)
  2203. restriction (cdr ans)))
  2204. ;; If we have sticky agenda buffers, set a name for the buffer,
  2205. ;; depending on the invoking keys. The user may still set this
  2206. ;; as a command option, which will overwrite what we do here.
  2207. (if org-agenda-sticky
  2208. (setq org-agenda-buffer-name (format "*Org Agenda(%s)*" keys)))
  2209. ;; Establish the restriction, if any
  2210. (when (and (not org-agenda-overriding-restriction) restriction)
  2211. (put 'org-agenda-files 'org-restrict (list bfn))
  2212. (cond
  2213. ((eq restriction 'region)
  2214. (setq org-agenda-restrict t)
  2215. (move-marker org-agenda-restrict-begin (region-beginning))
  2216. (move-marker org-agenda-restrict-end (region-end)))
  2217. ((eq restriction 'subtree)
  2218. (save-excursion
  2219. (setq org-agenda-restrict t)
  2220. (org-back-to-heading t)
  2221. (move-marker org-agenda-restrict-begin (point))
  2222. (move-marker org-agenda-restrict-end
  2223. (progn (org-end-of-subtree t)))))))
  2224. ;; For example the todo list should not need it (but does...)
  2225. (cond
  2226. ((setq entry (assoc keys org-agenda-custom-commands))
  2227. (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
  2228. (progn
  2229. (setq type (nth 2 entry) match (eval (nth 3 entry))
  2230. lprops (nth 4 entry))
  2231. (put 'org-agenda-redo-command 'org-lprops lprops)
  2232. (cond
  2233. ((eq type 'agenda)
  2234. (org-let lprops '(org-agenda-list current-prefix-arg)))
  2235. ((eq type 'alltodo)
  2236. (org-let lprops '(org-todo-list current-prefix-arg)))
  2237. ((eq type 'search)
  2238. (org-let lprops '(org-search-view current-prefix-arg match nil)))
  2239. ((eq type 'stuck)
  2240. (org-let lprops '(org-agenda-list-stuck-projects
  2241. current-prefix-arg)))
  2242. ((eq type 'tags)
  2243. (org-let lprops '(org-tags-view current-prefix-arg match)))
  2244. ((eq type 'tags-todo)
  2245. (org-let lprops '(org-tags-view '(4) match)))
  2246. ((eq type 'todo)
  2247. (org-let lprops '(org-todo-list match)))
  2248. ((eq type 'tags-tree)
  2249. (org-check-for-org-mode)
  2250. (org-let lprops '(org-match-sparse-tree current-prefix-arg match)))
  2251. ((eq type 'todo-tree)
  2252. (org-check-for-org-mode)
  2253. (org-let lprops
  2254. '(org-occur (concat "^" org-outline-regexp "[ \t]*"
  2255. (regexp-quote match) "\\>"))))
  2256. ((eq type 'occur-tree)
  2257. (org-check-for-org-mode)
  2258. (org-let lprops '(org-occur match)))
  2259. ((functionp type)
  2260. (org-let lprops '(funcall type match)))
  2261. ((fboundp type)
  2262. (org-let lprops '(funcall type match)))
  2263. (t (error "Invalid custom agenda command type %s" type))))
  2264. (org-agenda-run-series (nth 1 entry) (cddr entry))))
  2265. ((equal keys "C")
  2266. (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
  2267. (customize-variable 'org-agenda-custom-commands))
  2268. ((equal keys "a") (call-interactively 'org-agenda-list))
  2269. ((equal keys "s") (call-interactively 'org-search-view))
  2270. ((equal keys "t") (call-interactively 'org-todo-list))
  2271. ((equal keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
  2272. ((equal keys "m") (call-interactively 'org-tags-view))
  2273. ((equal keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
  2274. ((equal keys "e") (call-interactively 'org-store-agenda-views))
  2275. ((equal keys "?") (org-tags-view nil "+FLAGGED")
  2276. (org-add-hook
  2277. 'post-command-hook
  2278. (lambda ()
  2279. (unless (current-message)
  2280. (let* ((m (org-agenda-get-any-marker))
  2281. (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
  2282. (when note
  2283. (message (concat
  2284. "FLAGGING-NOTE ([?] for more info): "
  2285. (org-add-props
  2286. (replace-regexp-in-string
  2287. "\\\\n" "//"
  2288. (copy-sequence note))
  2289. nil 'face 'org-warning)))))))
  2290. t t))
  2291. ((equal keys "L")
  2292. (unless (derived-mode-p 'org-mode)
  2293. (error "This is not an Org-mode file"))
  2294. (unless restriction
  2295. (put 'org-agenda-files 'org-restrict (list bfn))
  2296. (org-call-with-arg 'org-timeline arg)))
  2297. ((equal keys "#") (call-interactively 'org-agenda-list-stuck-projects))
  2298. ((equal keys "/") (call-interactively 'org-occur-in-agenda-files))
  2299. ((equal keys "!") (customize-variable 'org-stuck-projects))
  2300. (t (error "Invalid agenda key"))))))
  2301. (defun org-agenda-append-agenda ()
  2302. "Append another agenda view to the current one.
  2303. This function allows interactive building of block agendas.
  2304. Agenda views are separated by `org-agenda-block-separator'."
  2305. (interactive)
  2306. (unless (string= (buffer-name) org-agenda-buffer-name)
  2307. (error "Can only append from within agenda buffer"))
  2308. (let ((org-agenda-multi t))
  2309. (org-agenda)
  2310. (widen)))
  2311. (defun org-agenda-normalize-custom-commands (cmds)
  2312. (delq nil
  2313. (mapcar
  2314. (lambda (x)
  2315. (cond ((stringp (cdr x)) nil)
  2316. ((stringp (nth 1 x)) x)
  2317. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2318. (t (cons (car x) (cons "" (cdr x))))))
  2319. cmds)))
  2320. (defun org-agenda-get-restriction-and-command (prefix-descriptions)
  2321. "The user interface for selecting an agenda command."
  2322. (catch 'exit
  2323. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  2324. (restrict-ok (and bfn (derived-mode-p 'org-mode)))
  2325. (region-p (org-region-active-p))
  2326. (custom org-agenda-custom-commands)
  2327. (selstring "")
  2328. restriction second-time
  2329. c entry key type match prefixes rmheader header-end custom1 desc
  2330. line lines left right n n1)
  2331. (save-window-excursion
  2332. (delete-other-windows)
  2333. (org-switch-to-buffer-other-window " *Agenda Commands*")
  2334. (erase-buffer)
  2335. (insert (eval-when-compile
  2336. (let ((header
  2337. "Press key for an agenda command: < Buffer, subtree/region restriction
  2338. -------------------------------- > Remove restriction
  2339. a Agenda for current week or day e Export agenda views
  2340. t List of all TODO entries T Entries with special TODO kwd
  2341. m Match a TAGS/PROP/TODO query M Like m, but only TODO entries
  2342. L Timeline for current buffer # List stuck projects (!=configure)
  2343. s Search for keywords * Toggle sticky agenda views
  2344. / Multi-occur ? Find :FLAGGED: entries
  2345. C Configure custom agenda commands
  2346. ")
  2347. (start 0))
  2348. (while (string-match
  2349. "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
  2350. header start)
  2351. (setq start (match-end 0))
  2352. (add-text-properties (match-beginning 2) (match-end 2)
  2353. '(face bold) header))
  2354. header)))
  2355. (setq header-end (move-marker (make-marker) (point)))
  2356. (while t
  2357. (setq custom1 custom)
  2358. (when (eq rmheader t)
  2359. (org-goto-line 1)
  2360. (re-search-forward ":" nil t)
  2361. (delete-region (match-end 0) (point-at-eol))
  2362. (forward-char 1)
  2363. (looking-at "-+")
  2364. (delete-region (match-end 0) (point-at-eol))
  2365. (move-marker header-end (match-end 0)))
  2366. (goto-char header-end)
  2367. (delete-region (point) (point-max))
  2368. ;; Produce all the lines that describe custom commands and prefixes
  2369. (setq lines nil)
  2370. (while (setq entry (pop custom1))
  2371. (setq key (car entry) desc (nth 1 entry)
  2372. type (nth 2 entry)
  2373. match (nth 3 entry))
  2374. (if (> (length key) 1)
  2375. (add-to-list 'prefixes (string-to-char key))
  2376. (setq line
  2377. (format
  2378. "%-4s%-14s"
  2379. (org-add-props (copy-sequence key)
  2380. '(face bold))
  2381. (cond
  2382. ((string-match "\\S-" desc) desc)
  2383. ((eq type 'agenda) "Agenda for current week or day")
  2384. ((eq type 'alltodo) "List of all TODO entries")
  2385. ((eq type 'search) "Word search")
  2386. ((eq type 'stuck) "List of stuck projects")
  2387. ((eq type 'todo) "TODO keyword")
  2388. ((eq type 'tags) "Tags query")
  2389. ((eq type 'tags-todo) "Tags (TODO)")
  2390. ((eq type 'tags-tree) "Tags tree")
  2391. ((eq type 'todo-tree) "TODO kwd tree")
  2392. ((eq type 'occur-tree) "Occur tree")
  2393. ((functionp type) (if (symbolp type)
  2394. (symbol-name type)
  2395. "Lambda expression"))
  2396. (t "???"))))
  2397. (if org-agenda-menu-show-matcher
  2398. (setq line
  2399. (concat line ": "
  2400. (cond
  2401. ((stringp match)
  2402. (setq match (copy-sequence match))
  2403. (org-add-props match nil 'face 'org-warning))
  2404. (match
  2405. (format "set of %d commands" (length match)))
  2406. (t ""))))
  2407. (if (org-string-nw-p match)
  2408. (add-text-properties
  2409. 0 (length line) (list 'help-echo
  2410. (concat "Matcher: "match)) line)))
  2411. (push line lines)))
  2412. (setq lines (nreverse lines))
  2413. (when prefixes
  2414. (mapc (lambda (x)
  2415. (push
  2416. (format "%s %s"
  2417. (org-add-props (char-to-string x)
  2418. nil 'face 'bold)
  2419. (or (cdr (assoc (concat selstring
  2420. (char-to-string x))
  2421. prefix-descriptions))
  2422. "Prefix key"))
  2423. lines))
  2424. prefixes))
  2425. ;; Check if we should display in two columns
  2426. (if org-agenda-menu-two-columns
  2427. (progn
  2428. (setq n (length lines)
  2429. n1 (+ (/ n 2) (mod n 2))
  2430. right (nthcdr n1 lines)
  2431. left (copy-sequence lines))
  2432. (setcdr (nthcdr (1- n1) left) nil))
  2433. (setq left lines right nil))
  2434. (while left
  2435. (insert "\n" (pop left))
  2436. (when right
  2437. (if (< (current-column) 40)
  2438. (move-to-column 40 t)
  2439. (insert " "))
  2440. (insert (pop right))))
  2441. ;; Make the window the right size
  2442. (goto-char (point-min))
  2443. (if second-time
  2444. (if (not (pos-visible-in-window-p (point-max)))
  2445. (org-fit-window-to-buffer))
  2446. (setq second-time t)
  2447. (org-fit-window-to-buffer))
  2448. ;; Ask for selection
  2449. (message "Press key for agenda command%s:"
  2450. (if (or restrict-ok org-agenda-overriding-restriction)
  2451. (if org-agenda-overriding-restriction
  2452. " (restriction lock active)"
  2453. (if restriction
  2454. (format " (restricted to %s)" restriction)
  2455. " (unrestricted)"))
  2456. ""))
  2457. (setq c (read-char-exclusive))
  2458. (message "")
  2459. (cond
  2460. ((assoc (char-to-string c) custom)
  2461. (setq selstring (concat selstring (char-to-string c)))
  2462. (throw 'exit (cons selstring restriction)))
  2463. ((memq c prefixes)
  2464. (setq selstring (concat selstring (char-to-string c))
  2465. prefixes nil
  2466. rmheader (or rmheader t)
  2467. custom (delq nil (mapcar
  2468. (lambda (x)
  2469. (if (or (= (length (car x)) 1)
  2470. (/= (string-to-char (car x)) c))
  2471. nil
  2472. (cons (substring (car x) 1) (cdr x))))
  2473. custom))))
  2474. ((eq c ?*)
  2475. (call-interactively 'org-toggle-sticky-agenda)
  2476. (sit-for 2))
  2477. ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
  2478. (message "Restriction is only possible in Org-mode buffers")
  2479. (ding) (sit-for 1))
  2480. ((eq c ?1)
  2481. (org-agenda-remove-restriction-lock 'noupdate)
  2482. (setq restriction 'buffer))
  2483. ((eq c ?0)
  2484. (org-agenda-remove-restriction-lock 'noupdate)
  2485. (setq restriction (if region-p 'region 'subtree)))
  2486. ((eq c ?<)
  2487. (org-agenda-remove-restriction-lock 'noupdate)
  2488. (setq restriction
  2489. (cond
  2490. ((eq restriction 'buffer)
  2491. (if region-p 'region 'subtree))
  2492. ((memq restriction '(subtree region))
  2493. nil)
  2494. (t 'buffer))))
  2495. ((eq c ?>)
  2496. (org-agenda-remove-restriction-lock 'noupdate)
  2497. (setq restriction nil))
  2498. ((and (equal selstring "") (memq c '(?s ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
  2499. (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
  2500. ((and (> (length selstring) 0) (eq c ?\d))
  2501. (delete-window)
  2502. (org-agenda-get-restriction-and-command prefix-descriptions))
  2503. ((equal c ?q) (error "Abort"))
  2504. (t (error "Invalid key %c" c))))))))
  2505. (defvar org-agenda-overriding-arguments nil) ; dynamically scoped parameter
  2506. (defvar org-agenda-last-arguments nil
  2507. "The arguments of the previous call to `org-agenda'.")
  2508. (defun org-agenda-run-series (name series)
  2509. (org-let (nth 1 series) '(org-prepare-agenda name))
  2510. ;; We need to reset agenda markers here, because when constructing a
  2511. ;; block agenda, the individual blocks do not do that.
  2512. (org-agenda-reset-markers)
  2513. (let* ((org-agenda-multi t)
  2514. (redo (list 'org-agenda-run-series name (list 'quote series)))
  2515. (org-agenda-overriding-arguments
  2516. (or org-agenda-overriding-arguments
  2517. (unless (null (delq nil (get 'org-agenda-redo-command 'last-args)))
  2518. (get 'org-agenda-redo-command 'last-args))))
  2519. (cmds (car series))
  2520. (gprops (nth 1 series))
  2521. match ;; The byte compiler incorrectly complains about this. Keep it!
  2522. cmd type lprops)
  2523. (while (setq cmd (pop cmds))
  2524. (setq type (car cmd) match (eval (nth 1 cmd)) lprops (nth 2 cmd))
  2525. (cond
  2526. ((eq type 'agenda)
  2527. (org-let2 gprops lprops
  2528. '(call-interactively 'org-agenda-list)))
  2529. ((eq type 'alltodo)
  2530. (org-let2 gprops lprops
  2531. '(call-interactively 'org-todo-list)))
  2532. ((eq type 'search)
  2533. (org-let2 gprops lprops
  2534. '(org-search-view current-prefix-arg match nil)))
  2535. ((eq type 'stuck)
  2536. (org-let2 gprops lprops
  2537. '(call-interactively 'org-agenda-list-stuck-projects)))
  2538. ((eq type 'tags)
  2539. (org-let2 gprops lprops
  2540. '(org-tags-view current-prefix-arg match)))
  2541. ((eq type 'tags-todo)
  2542. (org-let2 gprops lprops
  2543. '(org-tags-view '(4) match)))
  2544. ((eq type 'todo)
  2545. (org-let2 gprops lprops
  2546. '(org-todo-list match)))
  2547. ((fboundp type)
  2548. (org-let2 gprops lprops
  2549. '(funcall type match)))
  2550. (t (error "Invalid type in command series"))))
  2551. (widen)
  2552. (setq org-agenda-redo-command redo)
  2553. (put 'org-agenda-redo-command 'last-args org-agenda-last-arguments)
  2554. (goto-char (point-min)))
  2555. (org-fit-agenda-window)
  2556. (org-let (nth 1 series) '(org-finalize-agenda)))
  2557. ;;;###autoload
  2558. (defmacro org-batch-agenda (cmd-key &rest parameters)
  2559. "Run an agenda command in batch mode and send the result to STDOUT.
  2560. If CMD-KEY is a string of length 1, it is used as a key in
  2561. `org-agenda-custom-commands' and triggers this command. If it is a
  2562. longer string it is used as a tags/todo match string.
  2563. Parameters are alternating variable names and values that will be bound
  2564. before running the agenda command."
  2565. (org-eval-in-environment (org-make-parameter-alist parameters)
  2566. (if (> (length cmd-key) 2)
  2567. (org-tags-view nil cmd-key)
  2568. (org-agenda nil cmd-key)))
  2569. (set-buffer org-agenda-buffer-name)
  2570. (princ (buffer-string)))
  2571. (def-edebug-spec org-batch-agenda (form &rest sexp))
  2572. (defvar org-agenda-info nil)
  2573. ;;;###autoload
  2574. (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
  2575. "Run an agenda command in batch mode and send the result to STDOUT.
  2576. If CMD-KEY is a string of length 1, it is used as a key in
  2577. `org-agenda-custom-commands' and triggers this command. If it is a
  2578. longer string it is used as a tags/todo match string.
  2579. Parameters are alternating variable names and values that will be bound
  2580. before running the agenda command.
  2581. The output gives a line for each selected agenda item. Each
  2582. item is a list of comma-separated values, like this:
  2583. category,head,type,todo,tags,date,time,extra,priority-l,priority-n
  2584. category The category of the item
  2585. head The headline, without TODO kwd, TAGS and PRIORITY
  2586. type The type of the agenda entry, can be
  2587. todo selected in TODO match
  2588. tagsmatch selected in tags match
  2589. diary imported from diary
  2590. deadline a deadline on given date
  2591. scheduled scheduled on given date
  2592. timestamp entry has timestamp on given date
  2593. closed entry was closed on given date
  2594. upcoming-deadline warning about deadline
  2595. past-scheduled forwarded scheduled item
  2596. block entry has date block including g. date
  2597. todo The todo keyword, if any
  2598. tags All tags including inherited ones, separated by colons
  2599. date The relevant date, like 2007-2-14
  2600. time The time, like 15:00-16:50
  2601. extra Sting with extra planning info
  2602. priority-l The priority letter if any was given
  2603. priority-n The computed numerical priority
  2604. agenda-day The day in the agenda where this is listed"
  2605. (org-eval-in-environment (append '((org-agenda-remove-tags t))
  2606. (org-make-parameter-alist parameters))
  2607. (if (> (length cmd-key) 2)
  2608. (org-tags-view nil cmd-key)
  2609. (org-agenda nil cmd-key)))
  2610. (set-buffer org-agenda-buffer-name)
  2611. (let* ((lines (org-split-string (buffer-string) "\n"))
  2612. line)
  2613. (while (setq line (pop lines))
  2614. (catch 'next
  2615. (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
  2616. (setq org-agenda-info
  2617. (org-fix-agenda-info (text-properties-at 0 line)))
  2618. (princ
  2619. (mapconcat 'org-agenda-export-csv-mapper
  2620. '(org-category txt type todo tags date time extra
  2621. priority-letter priority agenda-day)
  2622. ","))
  2623. (princ "\n")))))
  2624. (def-edebug-spec org-batch-agenda-csv (form &rest sexp))
  2625. (defun org-fix-agenda-info (props)
  2626. "Make sure all properties on an agenda item have a canonical form.
  2627. This ensures the export commands can easily use it."
  2628. (let (tmp re)
  2629. (when (setq tmp (plist-get props 'tags))
  2630. (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
  2631. (when (setq tmp (plist-get props 'date))
  2632. (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2633. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2634. '((format "%4d, %9s %2s, %4s" dayname monthname day year))
  2635. (setq tmp (calendar-date-string tmp)))
  2636. (setq props (plist-put props 'date tmp)))
  2637. (when (setq tmp (plist-get props 'day))
  2638. (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2639. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2640. (setq tmp (calendar-date-string tmp)))
  2641. (setq props (plist-put props 'day tmp))
  2642. (setq props (plist-put props 'agenda-day tmp)))
  2643. (when (setq tmp (plist-get props 'txt))
  2644. (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
  2645. (plist-put props 'priority-letter (match-string 1 tmp))
  2646. (setq tmp (replace-match "" t t tmp)))
  2647. (when (and (setq re (plist-get props 'org-todo-regexp))
  2648. (setq re (concat "\\`\\.*" re " ?"))
  2649. (string-match re tmp))
  2650. (plist-put props 'todo (match-string 1 tmp))
  2651. (setq tmp (replace-match "" t t tmp)))
  2652. (plist-put props 'txt tmp)))
  2653. props)
  2654. (defun org-agenda-export-csv-mapper (prop)
  2655. (let ((res (plist-get org-agenda-info prop)))
  2656. (setq res
  2657. (cond
  2658. ((not res) "")
  2659. ((stringp res) res)
  2660. (t (prin1-to-string res))))
  2661. (while (string-match "," res)
  2662. (setq res (replace-match ";" t t res)))
  2663. (org-trim res)))
  2664. ;;;###autoload
  2665. (defun org-store-agenda-views (&rest parameters)
  2666. (interactive)
  2667. (eval (list 'org-batch-store-agenda-views)))
  2668. ;;;###autoload
  2669. (defmacro org-batch-store-agenda-views (&rest parameters)
  2670. "Run all custom agenda commands that have a file argument."
  2671. (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
  2672. (pop-up-frames nil)
  2673. (dir default-directory)
  2674. (pars (org-make-parameter-alist parameters))
  2675. cmd thiscmdkey files opts cmd-or-set bufname)
  2676. (save-window-excursion
  2677. (while cmds
  2678. (setq cmd (pop cmds)
  2679. thiscmdkey (car cmd)
  2680. bufname (if org-agenda-sticky (format "*Org Agenda(%s)*" thiscmdkey)
  2681. org-agenda-buffer-name)
  2682. cmd-or-set (nth 2 cmd)
  2683. opts (nth (if (listp cmd-or-set) 3 4) cmd)
  2684. files (nth (if (listp cmd-or-set) 4 5) cmd))
  2685. (if (stringp files) (setq files (list files)))
  2686. (when files
  2687. (org-eval-in-environment (append org-agenda-exporter-settings
  2688. opts pars)
  2689. (org-agenda nil thiscmdkey))
  2690. (set-buffer bufname)
  2691. (while files
  2692. (org-eval-in-environment (append org-agenda-exporter-settings
  2693. opts pars)
  2694. (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
  2695. (and (get-buffer bufname)
  2696. (kill-buffer bufname)))))))
  2697. (def-edebug-spec org-batch-store-agenda-views (&rest sexp))
  2698. (defun org-agenda-mark-header-line (pos)
  2699. "Mark the line at POS as an agenda structure header."
  2700. (save-excursion
  2701. (goto-char pos)
  2702. (put-text-property (point-at-bol) (point-at-eol)
  2703. 'org-agenda-structural-header t)
  2704. (when org-agenda-title-append
  2705. (put-text-property (point-at-bol) (point-at-eol)
  2706. 'org-agenda-title-append org-agenda-title-append))))
  2707. (defvar org-mobile-creating-agendas)
  2708. (defvar org-agenda-write-buffer-name "Agenda View")
  2709. (defun org-agenda-write (file &optional open nosettings agenda-bufname)
  2710. "Write the current buffer (an agenda view) as a file.
  2711. Depending on the extension of the file name, plain text (.txt),
  2712. HTML (.html or .htm) or Postscript (.ps) is produced.
  2713. If the extension is .ics, run icalendar export over all files used
  2714. to construct the agenda and limit the export to entries listed in the
  2715. agenda now.
  2716. With prefix argument OPEN, open the new file immediately.
  2717. If NOSETTINGS is given, do not scope the settings of
  2718. `org-agenda-exporter-settings' into the export commands. This is used when
  2719. the settings have already been scoped and we do not wish to overrule other,
  2720. higher priority settings.
  2721. If AGENDA-BUFFER-NAME, use this as the buffer name for the agenda to write."
  2722. (interactive "FWrite agenda to file: \nP")
  2723. (if (not (file-writable-p file))
  2724. (error "Cannot write agenda to file %s" file))
  2725. (org-let (if nosettings nil org-agenda-exporter-settings)
  2726. '(save-excursion
  2727. (save-window-excursion
  2728. (org-agenda-mark-filtered-text)
  2729. (let ((bs (copy-sequence (buffer-string))) beg)
  2730. (org-agenda-unmark-filtered-text)
  2731. (with-temp-buffer
  2732. (rename-buffer org-agenda-write-buffer-name t)
  2733. (set-buffer-modified-p nil)
  2734. (insert bs)
  2735. (org-agenda-remove-marked-text 'org-filtered)
  2736. (while (setq beg (text-property-any (point-min) (point-max)
  2737. 'org-filtered t))
  2738. (delete-region
  2739. beg (or (next-single-property-change beg 'org-filtered)
  2740. (point-max))))
  2741. (run-hooks 'org-agenda-before-write-hook)
  2742. (cond
  2743. ((org-bound-and-true-p org-mobile-creating-agendas)
  2744. (org-mobile-write-agenda-for-mobile file))
  2745. ((string-match "\\.html?\\'" file)
  2746. (require 'htmlize)
  2747. (set-buffer (htmlize-buffer (current-buffer)))
  2748. (when (and org-agenda-export-html-style
  2749. (string-match "<style>" org-agenda-export-html-style))
  2750. ;; replace <style> section with org-agenda-export-html-style
  2751. (goto-char (point-min))
  2752. (kill-region (- (search-forward "<style") 6)
  2753. (search-forward "</style>"))
  2754. (insert org-agenda-export-html-style))
  2755. (write-file file)
  2756. (kill-buffer (current-buffer))
  2757. (message "HTML written to %s" file))
  2758. ((string-match "\\.ps\\'" file)
  2759. (require 'ps-print)
  2760. (ps-print-buffer-with-faces file)
  2761. (message "Postscript written to %s" file))
  2762. ((string-match "\\.pdf\\'" file)
  2763. (require 'ps-print)
  2764. (ps-print-buffer-with-faces
  2765. (concat (file-name-sans-extension file) ".ps"))
  2766. (call-process "ps2pdf" nil nil nil
  2767. (expand-file-name
  2768. (concat (file-name-sans-extension file) ".ps"))
  2769. (expand-file-name file))
  2770. (delete-file (concat (file-name-sans-extension file) ".ps"))
  2771. (message "PDF written to %s" file))
  2772. ((string-match "\\.ics\\'" file)
  2773. (require 'org-icalendar)
  2774. (let ((org-agenda-marker-table
  2775. (org-create-marker-find-array
  2776. (org-agenda-collect-markers)))
  2777. (org-icalendar-verify-function 'org-check-agenda-marker-table)
  2778. (org-combined-agenda-icalendar-file file))
  2779. (apply 'org-export-icalendar 'combine
  2780. (org-agenda-files nil 'ifmode))))
  2781. (t
  2782. (let ((bs (buffer-string)))
  2783. (find-file file)
  2784. (erase-buffer)
  2785. (insert bs)
  2786. (save-buffer 0)
  2787. (kill-buffer (current-buffer))
  2788. (message "Plain text written to %s" file))))))))
  2789. (set-buffer (or agenda-bufname
  2790. (and (called-interactively-p 'any) (buffer-name))
  2791. org-agenda-buffer-name)))
  2792. (when open (org-open-file file)))
  2793. (defvar org-agenda-tag-filter-overlays nil)
  2794. (defvar org-agenda-cat-filter-overlays nil)
  2795. (defun org-agenda-mark-filtered-text ()
  2796. "Mark all text hidden by filtering with a text property."
  2797. (let ((inhibit-read-only t))
  2798. (mapc
  2799. (lambda (o)
  2800. (when (equal (overlay-buffer o) (current-buffer))
  2801. (put-text-property
  2802. (overlay-start o) (overlay-end o)
  2803. 'org-filtered t)))
  2804. (append org-agenda-tag-filter-overlays
  2805. org-agenda-cat-filter-overlays))))
  2806. (defun org-agenda-unmark-filtered-text ()
  2807. "Remove the filtering text property."
  2808. (let ((inhibit-read-only t))
  2809. (remove-text-properties (point-min) (point-max) '(org-filtered t))))
  2810. (defun org-agenda-remove-marked-text (property &optional value)
  2811. "Delete all text marked with VALUE of PROPERTY.
  2812. VALUE defaults to t."
  2813. (let (beg)
  2814. (setq value (or value t))
  2815. (while (setq beg (text-property-any (point-min) (point-max)
  2816. property value))
  2817. (delete-region
  2818. beg (or (next-single-property-change beg 'org-filtered)
  2819. (point-max))))))
  2820. (defun org-agenda-add-entry-text ()
  2821. "Add entry text to agenda lines.
  2822. This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
  2823. entry text following headings shown in the agenda.
  2824. Drawers will be excluded, also the line with scheduling/deadline info."
  2825. (when (and (> org-agenda-add-entry-text-maxlines 0)
  2826. (not (org-bound-and-true-p org-mobile-creating-agendas)))
  2827. (let (m txt)
  2828. (goto-char (point-min))
  2829. (while (not (eobp))
  2830. (if (not (setq m (org-get-at-bol 'org-hd-marker)))
  2831. (beginning-of-line 2)
  2832. (setq txt (org-agenda-get-some-entry-text
  2833. m org-agenda-add-entry-text-maxlines " > "))
  2834. (end-of-line 1)
  2835. (if (string-match "\\S-" txt)
  2836. (insert "\n" txt)
  2837. (or (eobp) (forward-char 1))))))))
  2838. (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
  2839. &rest keep)
  2840. "Extract entry text from MARKER, at most N-LINES lines.
  2841. This will ignore drawers etc, just get the text.
  2842. If INDENT is given, prefix every line with this string. If KEEP is
  2843. given, it is a list of symbols, defining stuff that should not be
  2844. removed from the entry content. Currently only `planning' is allowed here."
  2845. (let (txt drawer-re kwd-time-re ind)
  2846. (save-excursion
  2847. (with-current-buffer (marker-buffer marker)
  2848. (if (not (derived-mode-p 'org-mode))
  2849. (setq txt "")
  2850. (save-excursion
  2851. (save-restriction
  2852. (widen)
  2853. (goto-char marker)
  2854. (end-of-line 1)
  2855. (setq txt (buffer-substring
  2856. (min (1+ (point)) (point-max))
  2857. (progn (outline-next-heading) (point)))
  2858. drawer-re org-drawer-regexp
  2859. kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
  2860. ".*\n?"))
  2861. (with-temp-buffer
  2862. (insert txt)
  2863. (when org-agenda-add-entry-text-descriptive-links
  2864. (goto-char (point-min))
  2865. (while (org-activate-bracket-links (point-max))
  2866. (add-text-properties (match-beginning 0) (match-end 0)
  2867. '(face org-link))))
  2868. (goto-char (point-min))
  2869. (while (re-search-forward org-bracket-link-regexp (point-max) t)
  2870. (set-text-properties (match-beginning 0) (match-end 0)
  2871. nil))
  2872. (goto-char (point-min))
  2873. (while (re-search-forward drawer-re nil t)
  2874. (delete-region
  2875. (match-beginning 0)
  2876. (progn (re-search-forward
  2877. "^[ \t]*:END:.*\n?" nil 'move)
  2878. (point))))
  2879. (unless (member 'planning keep)
  2880. (goto-char (point-min))
  2881. (while (re-search-forward kwd-time-re nil t)
  2882. (replace-match "")))
  2883. (goto-char (point-min))
  2884. (when org-agenda-entry-text-exclude-regexps
  2885. (let ((re-list org-agenda-entry-text-exclude-regexps) re)
  2886. (while (setq re (pop re-list))
  2887. (goto-char (point-min))
  2888. (while (re-search-forward re nil t)
  2889. (replace-match "")))))
  2890. (goto-char (point-max))
  2891. (skip-chars-backward " \t\n")
  2892. (if (looking-at "[ \t\n]+\\'") (replace-match ""))
  2893. ;; find and remove min common indentation
  2894. (goto-char (point-min))
  2895. (untabify (point-min) (point-max))
  2896. (setq ind (org-get-indentation))
  2897. (while (not (eobp))
  2898. (unless (looking-at "[ \t]*$")
  2899. (setq ind (min ind (org-get-indentation))))
  2900. (beginning-of-line 2))
  2901. (goto-char (point-min))
  2902. (while (not (eobp))
  2903. (unless (looking-at "[ \t]*$")
  2904. (move-to-column ind)
  2905. (delete-region (point-at-bol) (point)))
  2906. (beginning-of-line 2))
  2907. (run-hooks 'org-agenda-entry-text-cleanup-hook)
  2908. (goto-char (point-min))
  2909. (when indent
  2910. (while (and (not (eobp)) (re-search-forward "^" nil t))
  2911. (replace-match indent t t)))
  2912. (goto-char (point-min))
  2913. (while (looking-at "[ \t]*\n") (replace-match ""))
  2914. (goto-char (point-max))
  2915. (when (> (org-current-line)
  2916. n-lines)
  2917. (org-goto-line (1+ n-lines))
  2918. (backward-char 1))
  2919. (setq txt (buffer-substring (point-min) (point)))))))))
  2920. txt))
  2921. (defun org-agenda-collect-markers ()
  2922. "Collect the markers pointing to entries in the agenda buffer."
  2923. (let (m markers)
  2924. (save-excursion
  2925. (goto-char (point-min))
  2926. (while (not (eobp))
  2927. (when (setq m (or (org-get-at-bol 'org-hd-marker)
  2928. (org-get-at-bol 'org-marker)))
  2929. (push m markers))
  2930. (beginning-of-line 2)))
  2931. (nreverse markers)))
  2932. (defun org-create-marker-find-array (marker-list)
  2933. "Create a alist of files names with all marker positions in that file."
  2934. (let (f tbl m a p)
  2935. (while (setq m (pop marker-list))
  2936. (setq p (marker-position m)
  2937. f (buffer-file-name (or (buffer-base-buffer
  2938. (marker-buffer m))
  2939. (marker-buffer m))))
  2940. (if (setq a (assoc f tbl))
  2941. (push (marker-position m) (cdr a))
  2942. (push (list f p) tbl)))
  2943. (mapcar (lambda (x) (setcdr x (sort (copy-sequence (cdr x)) '<)) x)
  2944. tbl)))
  2945. (defvar org-agenda-marker-table nil) ; dynamically scoped parameter
  2946. (defun org-check-agenda-marker-table ()
  2947. "Check of the current entry is on the marker list."
  2948. (let ((file (buffer-file-name (or (buffer-base-buffer) (current-buffer))))
  2949. a)
  2950. (and (setq a (assoc file org-agenda-marker-table))
  2951. (save-match-data
  2952. (save-excursion
  2953. (org-back-to-heading t)
  2954. (member (point) (cdr a)))))))
  2955. (defun org-check-for-org-mode ()
  2956. "Make sure current buffer is in org-mode. Error if not."
  2957. (or (derived-mode-p 'org-mode)
  2958. (error "Cannot execute org-mode agenda command on buffer in %s"
  2959. major-mode)))
  2960. (defun org-fit-agenda-window ()
  2961. "Fit the window to the buffer size."
  2962. (and (memq org-agenda-window-setup '(reorganize-frame))
  2963. (fboundp 'fit-window-to-buffer)
  2964. (org-fit-window-to-buffer
  2965. nil
  2966. (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
  2967. (floor (* (frame-height) (car org-agenda-window-frame-fractions))))))
  2968. ;;; Agenda prepare and finalize
  2969. (defvar org-agenda-multi nil) ; dynamically scoped
  2970. (defvar org-agenda-buffer-name "*Org Agenda*")
  2971. (defvar org-pre-agenda-window-conf nil)
  2972. (defvar org-agenda-columns-active nil)
  2973. (defvar org-agenda-name nil)
  2974. (defvar org-agenda-tag-filter nil)
  2975. (defvar org-agenda-category-filter nil)
  2976. (defvar org-agenda-top-category-filter nil)
  2977. (defvar org-agenda-tag-filter-while-redo nil)
  2978. (defvar org-agenda-tag-filter-preset nil
  2979. "A preset of the tags filter used for secondary agenda filtering.
  2980. This must be a list of strings, each string must be a single tag preceded
  2981. by \"+\" or \"-\".
  2982. This variable should not be set directly, but agenda custom commands can
  2983. bind it in the options section. The preset filter is a global property of
  2984. the entire agenda view. In a block agenda, it will not work reliably to
  2985. define a filter for one of the individual blocks. You need to set it in
  2986. the global options and expect it to be applied to the entire view.")
  2987. (defvar org-agenda-category-filter-preset nil
  2988. "A preset of the category filter used for secondary agenda filtering.
  2989. This must be a list of strings, each string must be a single category
  2990. preceded by \"+\" or \"-\".
  2991. This variable should not be set directly, but agenda custom commands can
  2992. bind it in the options section. The preset filter is a global property of
  2993. the entire agenda view. In a block agenda, it will not work reliably to
  2994. define a filter for one of the individual blocks. You need to set it in
  2995. the global options and expect it to be applied to the entire view.")
  2996. (defun org-agenda-use-sticky-p ()
  2997. "Return non-nil if an agenda buffer named
  2998. `org-agenda-buffer-name' exists and should be shown instead of
  2999. generating a new one."
  3000. (and
  3001. ;; turned off by user
  3002. org-agenda-sticky
  3003. ;; For multi-agenda buffer already exists
  3004. (not org-agenda-multi)
  3005. ;; buffer found
  3006. (get-buffer org-agenda-buffer-name)
  3007. ;; C-u parameter is same as last call
  3008. (with-current-buffer (get-buffer org-agenda-buffer-name)
  3009. (and
  3010. (equal current-prefix-arg
  3011. org-agenda-last-prefix-arg)
  3012. ;; In case user turned stickiness on, while having existing
  3013. ;; Agenda buffer active, don't reuse that buffer, because it
  3014. ;; does not have org variables local
  3015. org-agenda-this-buffer-is-sticky))))
  3016. (defun org-prepare-agenda-window (abuf)
  3017. "Setup agenda buffer in the window."
  3018. (let* ((awin (get-buffer-window abuf))
  3019. wconf)
  3020. (cond
  3021. ((equal (current-buffer) abuf) nil)
  3022. (awin (select-window awin))
  3023. ((not (setq wconf (current-window-configuration))))
  3024. ((equal org-agenda-window-setup 'current-window)
  3025. (org-pop-to-buffer-same-window abuf))
  3026. ((equal org-agenda-window-setup 'other-window)
  3027. (org-switch-to-buffer-other-window abuf))
  3028. ((equal org-agenda-window-setup 'other-frame)
  3029. (switch-to-buffer-other-frame abuf))
  3030. ((equal org-agenda-window-setup 'reorganize-frame)
  3031. (delete-other-windows)
  3032. (org-switch-to-buffer-other-window abuf)))
  3033. ;; additional test in case agenda is invoked from within agenda
  3034. ;; buffer via elisp link
  3035. (unless (equal (current-buffer) abuf)
  3036. (org-pop-to-buffer-same-window abuf))
  3037. (setq org-pre-agenda-window-conf wconf)))
  3038. (defun org-prepare-agenda (&optional name)
  3039. (if (org-agenda-use-sticky-p)
  3040. (progn
  3041. ;; Popup existing buffer
  3042. (org-prepare-agenda-window (get-buffer org-agenda-buffer-name))
  3043. (message "Sticky Agenda buffer, use `r' to refresh")
  3044. (throw 'exit nil))
  3045. (setq org-todo-keywords-for-agenda nil)
  3046. (setq org-drawers-for-agenda nil)
  3047. (unless org-agenda-persistent-filter
  3048. (setq org-agenda-tag-filter nil
  3049. org-agenda-category-filter nil))
  3050. (put 'org-agenda-tag-filter :preset-filter
  3051. org-agenda-tag-filter-preset)
  3052. (put 'org-agenda-category-filter :preset-filter
  3053. org-agenda-category-filter-preset)
  3054. (if org-agenda-multi
  3055. (progn
  3056. (setq buffer-read-only nil)
  3057. (goto-char (point-max))
  3058. (unless (or (bobp) org-agenda-compact-blocks
  3059. (not org-agenda-block-separator))
  3060. (insert "\n"
  3061. (if (stringp org-agenda-block-separator)
  3062. org-agenda-block-separator
  3063. (make-string (window-width) org-agenda-block-separator))
  3064. "\n"))
  3065. (narrow-to-region (point) (point-max)))
  3066. (setq org-done-keywords-for-agenda nil)
  3067. ;; Setting any org variables that are in org-agenda-local-vars
  3068. ;; list need to be done after the prepare call
  3069. (org-prepare-agenda-window (get-buffer-create org-agenda-buffer-name))
  3070. (setq buffer-read-only nil)
  3071. (org-agenda-reset-markers)
  3072. (let ((inhibit-read-only t)) (erase-buffer))
  3073. (org-agenda-mode)
  3074. (setq org-agenda-buffer (current-buffer))
  3075. (setq org-agenda-contributing-files nil)
  3076. (setq org-agenda-columns-active nil)
  3077. (org-prepare-agenda-buffers (org-agenda-files nil 'ifmode))
  3078. (setq org-todo-keywords-for-agenda
  3079. (org-uniquify org-todo-keywords-for-agenda))
  3080. (setq org-done-keywords-for-agenda
  3081. (org-uniquify org-done-keywords-for-agenda))
  3082. (setq org-drawers-for-agenda (org-uniquify org-drawers-for-agenda))
  3083. (setq org-agenda-last-prefix-arg current-prefix-arg)
  3084. (setq org-agenda-this-buffer-name org-agenda-buffer-name)
  3085. (and name (not org-agenda-name)
  3086. (org-set-local 'org-agenda-name name)))
  3087. (setq buffer-read-only nil)))
  3088. (defvar org-agenda-overriding-columns-format) ; From org-colview.el
  3089. (defun org-finalize-agenda ()
  3090. "Finishing touch for the agenda buffer, called just before displaying it."
  3091. (unless org-agenda-multi
  3092. (save-excursion
  3093. (let ((inhibit-read-only t))
  3094. (goto-char (point-min))
  3095. (while (org-activate-bracket-links (point-max))
  3096. (add-text-properties (match-beginning 0) (match-end 0)
  3097. '(face org-link)))
  3098. (org-agenda-align-tags)
  3099. (unless org-agenda-with-colors
  3100. (remove-text-properties (point-min) (point-max) '(face nil))))
  3101. (if (and (boundp 'org-agenda-overriding-columns-format)
  3102. org-agenda-overriding-columns-format)
  3103. (org-set-local 'org-agenda-overriding-columns-format
  3104. org-agenda-overriding-columns-format))
  3105. (if (and (boundp 'org-agenda-view-columns-initially)
  3106. org-agenda-view-columns-initially)
  3107. (org-agenda-columns))
  3108. (when org-agenda-fontify-priorities
  3109. (org-agenda-fontify-priorities))
  3110. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  3111. (org-agenda-dim-blocked-tasks))
  3112. (org-agenda-mark-clocking-task)
  3113. (when org-agenda-entry-text-mode
  3114. (org-agenda-entry-text-hide)
  3115. (org-agenda-entry-text-show))
  3116. (if (functionp 'org-habit-insert-consistency-graphs)
  3117. (org-habit-insert-consistency-graphs))
  3118. (run-hooks 'org-finalize-agenda-hook)
  3119. (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
  3120. (when (or org-agenda-tag-filter (get 'org-agenda-tag-filter :preset-filter))
  3121. (org-agenda-filter-apply org-agenda-tag-filter 'tag))
  3122. (when (or org-agenda-category-filter (get 'org-agenda-category-filter :preset-filter))
  3123. (org-agenda-filter-apply org-agenda-category-filter 'category))
  3124. (org-add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)
  3125. )))
  3126. (defun org-agenda-mark-clocking-task ()
  3127. "Mark the current clock entry in the agenda if it is present."
  3128. (mapc (lambda (o)
  3129. (if (eq (overlay-get o 'type) 'org-agenda-clocking)
  3130. (delete-overlay o)))
  3131. (overlays-in (point-min) (point-max)))
  3132. (when (marker-buffer org-clock-hd-marker)
  3133. (save-excursion
  3134. (goto-char (point-min))
  3135. (let (s ov)
  3136. (while (setq s (next-single-property-change (point) 'org-hd-marker))
  3137. (goto-char s)
  3138. (when (equal (org-get-at-bol 'org-hd-marker)
  3139. org-clock-hd-marker)
  3140. (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
  3141. (overlay-put ov 'type 'org-agenda-clocking)
  3142. (overlay-put ov 'face 'org-agenda-clocking)
  3143. (overlay-put ov 'help-echo
  3144. "The clock is running in this item")))))))
  3145. (defun org-agenda-fontify-priorities ()
  3146. "Make highest priority lines bold, and lowest italic."
  3147. (interactive)
  3148. (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
  3149. (delete-overlay o)))
  3150. (overlays-in (point-min) (point-max)))
  3151. (save-excursion
  3152. (let ((inhibit-read-only t)
  3153. b e p ov h l)
  3154. (goto-char (point-min))
  3155. (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
  3156. (setq h (or (get-char-property (point) 'org-highest-priority)
  3157. org-highest-priority)
  3158. l (or (get-char-property (point) 'org-lowest-priority)
  3159. org-lowest-priority)
  3160. p (string-to-char (match-string 1))
  3161. b (match-beginning 0)
  3162. e (if (eq org-agenda-fontify-priorities 'cookies)
  3163. (match-end 0)
  3164. (point-at-eol))
  3165. ov (make-overlay b e))
  3166. (overlay-put
  3167. ov 'face
  3168. (cond ((org-face-from-face-or-color
  3169. 'priority nil
  3170. (cdr (assoc p org-priority-faces))))
  3171. ((and (listp org-agenda-fontify-priorities)
  3172. (org-face-from-face-or-color
  3173. 'priority nil
  3174. (cdr (assoc p org-agenda-fontify-priorities)))))
  3175. ((equal p l) 'italic)
  3176. ((equal p h) 'bold)))
  3177. (overlay-put ov 'org-type 'org-priority)))))
  3178. (defun org-agenda-dim-blocked-tasks ()
  3179. "Dim currently blocked TODO's in the agenda display."
  3180. (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-blocked-todo)
  3181. (delete-overlay o)))
  3182. (overlays-in (point-min) (point-max)))
  3183. (save-excursion
  3184. (let ((inhibit-read-only t)
  3185. (org-depend-tag-blocked nil)
  3186. (invis (eq org-agenda-dim-blocked-tasks 'invisible))
  3187. org-blocked-by-checkboxes
  3188. invis1 b e p ov h l)
  3189. (goto-char (point-min))
  3190. (while (let ((pos (next-single-property-change (point) 'todo-state)))
  3191. (and pos (goto-char (1+ pos))))
  3192. (setq org-blocked-by-checkboxes nil invis1 invis)
  3193. (let ((marker (org-get-at-bol 'org-hd-marker)))
  3194. (when (and marker
  3195. (with-current-buffer (marker-buffer marker)
  3196. (save-excursion (goto-char marker)
  3197. (org-entry-blocked-p))))
  3198. (if org-blocked-by-checkboxes (setq invis1 nil))
  3199. (setq b (if invis1
  3200. (max (point-min) (1- (point-at-bol)))
  3201. (point-at-bol))
  3202. e (point-at-eol)
  3203. ov (make-overlay b e))
  3204. (if invis1
  3205. (overlay-put ov 'invisible t)
  3206. (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
  3207. (overlay-put ov 'org-type 'org-blocked-todo)))))))
  3208. (defvar org-agenda-skip-function nil
  3209. "Function to be called at each match during agenda construction.
  3210. If this function returns nil, the current match should not be skipped.
  3211. Otherwise, the function must return a position from where the search
  3212. should be continued.
  3213. This may also be a Lisp form, it will be evaluated.
  3214. Never set this variable using `setq' or so, because then it will apply
  3215. to all future agenda commands. If you do want a global skipping condition,
  3216. use the option `org-agenda-skip-function-global' instead.
  3217. The correct usage for `org-agenda-skip-function' is to bind it with
  3218. `let' to scope it dynamically into the agenda-constructing command.
  3219. A good way to set it is through options in `org-agenda-custom-commands'.")
  3220. (defun org-agenda-skip ()
  3221. "Throw to `:skip' in places that should be skipped.
  3222. Also moves point to the end of the skipped region, so that search can
  3223. continue from there."
  3224. (let ((p (point-at-bol)) to)
  3225. (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
  3226. (get-text-property p :org-archived)
  3227. (org-end-of-subtree t)
  3228. (throw :skip t))
  3229. (and org-agenda-skip-comment-trees
  3230. (get-text-property p :org-comment)
  3231. (org-end-of-subtree t)
  3232. (throw :skip t))
  3233. (if (equal (char-after p) ?#) (throw :skip t))
  3234. (when (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
  3235. (org-agenda-skip-eval org-agenda-skip-function)))
  3236. (goto-char to)
  3237. (throw :skip t))))
  3238. (defun org-agenda-skip-eval (form)
  3239. "If FORM is a function or a list, call (or eval) is and return result.
  3240. `save-excursion' and `save-match-data' are wrapped around the call, so point
  3241. and match data are returned to the previous state no matter what these
  3242. functions do."
  3243. (let (fp)
  3244. (and form
  3245. (or (setq fp (functionp form))
  3246. (consp form))
  3247. (save-excursion
  3248. (save-match-data
  3249. (if fp
  3250. (funcall form)
  3251. (eval form)))))))
  3252. (defvar org-agenda-markers nil
  3253. "List of all currently active markers created by `org-agenda'.")
  3254. (defvar org-agenda-last-marker-time (org-float-time)
  3255. "Creation time of the last agenda marker.")
  3256. (defun org-agenda-new-marker (&optional pos)
  3257. "Return a new agenda marker.
  3258. Org-mode keeps a list of these markers and resets them when they are
  3259. no longer in use."
  3260. (let ((m (copy-marker (or pos (point)))))
  3261. (setq org-agenda-last-marker-time (org-float-time))
  3262. (if org-agenda-buffer
  3263. (with-current-buffer org-agenda-buffer
  3264. (push m org-agenda-markers))
  3265. (push m org-agenda-markers))
  3266. m))
  3267. (defun org-agenda-reset-markers ()
  3268. "Reset markers created by `org-agenda'."
  3269. (while org-agenda-markers
  3270. (move-marker (pop org-agenda-markers) nil)))
  3271. (defun org-agenda-save-markers-for-cut-and-paste (beg end)
  3272. "Save relative positions of markers in region.
  3273. This check for agenda markers in all agenda buffers currently active."
  3274. (dolist (buf (buffer-list))
  3275. (with-current-buffer buf
  3276. (when (eq major-mode 'org-agenda-mode)
  3277. (mapc (lambda (m) (org-check-and-save-marker m beg end))
  3278. org-agenda-markers)))))
  3279. ;;; Entry text mode
  3280. (defun org-agenda-entry-text-show-here ()
  3281. "Add some text from the entry as context to the current line."
  3282. (let (m txt o)
  3283. (setq m (org-get-at-bol 'org-hd-marker))
  3284. (unless (marker-buffer m)
  3285. (error "No marker points to an entry here"))
  3286. (setq txt (concat "\n" (org-no-properties
  3287. (org-agenda-get-some-entry-text
  3288. m org-agenda-entry-text-maxlines " > "))))
  3289. (when (string-match "\\S-" txt)
  3290. (setq o (make-overlay (point-at-bol) (point-at-eol)))
  3291. (overlay-put o 'evaporate t)
  3292. (overlay-put o 'org-overlay-type 'agenda-entry-content)
  3293. (overlay-put o 'after-string txt))))
  3294. (defun org-agenda-entry-text-show ()
  3295. "Add entry context for all agenda lines."
  3296. (interactive)
  3297. (save-excursion
  3298. (goto-char (point-max))
  3299. (beginning-of-line 1)
  3300. (while (not (bobp))
  3301. (when (org-get-at-bol 'org-hd-marker)
  3302. (org-agenda-entry-text-show-here))
  3303. (beginning-of-line 0))))
  3304. (defun org-agenda-entry-text-hide ()
  3305. "Remove any shown entry context."
  3306. (delq nil
  3307. (mapcar (lambda (o)
  3308. (if (eq (overlay-get o 'org-overlay-type)
  3309. 'agenda-entry-content)
  3310. (progn (delete-overlay o) t)))
  3311. (overlays-in (point-min) (point-max)))))
  3312. (defun org-agenda-get-day-face (date)
  3313. "Return the face DATE should be displayed with."
  3314. (or (and (functionp org-agenda-day-face-function)
  3315. (funcall org-agenda-day-face-function date))
  3316. (cond ((org-agenda-todayp date)
  3317. 'org-agenda-date-today)
  3318. ((member (calendar-day-of-week date) org-agenda-weekend-days)
  3319. 'org-agenda-date-weekend)
  3320. (t 'org-agenda-date))))
  3321. ;;; Agenda timeline
  3322. (defvar org-agenda-only-exact-dates nil) ; dynamically scoped
  3323. (defun org-timeline (&optional dotodo)
  3324. "Show a time-sorted view of the entries in the current org file.
  3325. Only entries with a time stamp of today or later will be listed. With
  3326. \\[universal-argument] prefix, all unfinished TODO items will also be shown,
  3327. under the current date.
  3328. If the buffer contains an active region, only check the region for
  3329. dates."
  3330. (interactive "P")
  3331. (let* ((dopast t)
  3332. (org-agenda-show-log-scoped org-agenda-show-log)
  3333. (entry (buffer-file-name (or (buffer-base-buffer (current-buffer))
  3334. (current-buffer))))
  3335. (date (calendar-current-date))
  3336. (beg (if (org-region-active-p) (region-beginning) (point-min)))
  3337. (end (if (org-region-active-p) (region-end) (point-max)))
  3338. (day-numbers (org-get-all-dates
  3339. beg end 'no-ranges
  3340. t org-agenda-show-log-scoped ; always include today
  3341. org-timeline-show-empty-dates))
  3342. (org-deadline-warning-days 0)
  3343. (org-agenda-only-exact-dates t)
  3344. (today (org-today))
  3345. (past t)
  3346. args
  3347. s e rtn d emptyp)
  3348. (setq org-agenda-redo-command
  3349. (list 'progn
  3350. (list 'org-switch-to-buffer-other-window (current-buffer))
  3351. (list 'org-timeline (list 'quote dotodo))))
  3352. (if (not dopast)
  3353. ;; Remove past dates from the list of dates.
  3354. (setq day-numbers (delq nil (mapcar (lambda(x)
  3355. (if (>= x today) x nil))
  3356. day-numbers))))
  3357. (org-prepare-agenda (concat "Timeline " (file-name-nondirectory entry)))
  3358. (org-compile-prefix-format 'timeline)
  3359. (org-set-sorting-strategy 'timeline)
  3360. (if org-agenda-show-log-scoped (push :closed args))
  3361. (push :timestamp args)
  3362. (push :deadline args)
  3363. (push :scheduled args)
  3364. (push :sexp args)
  3365. (if dotodo (push :todo args))
  3366. (insert "Timeline of file " entry "\n")
  3367. (add-text-properties (point-min) (point)
  3368. (list 'face 'org-agenda-structure))
  3369. (org-agenda-mark-header-line (point-min))
  3370. (while (setq d (pop day-numbers))
  3371. (if (and (listp d) (eq (car d) :omitted))
  3372. (progn
  3373. (setq s (point))
  3374. (insert (format "\n[... %d empty days omitted]\n\n" (cdr d)))
  3375. (put-text-property s (1- (point)) 'face 'org-agenda-structure))
  3376. (if (listp d) (setq d (car d) emptyp t) (setq emptyp nil))
  3377. (if (and (>= d today)
  3378. dopast
  3379. past)
  3380. (progn
  3381. (setq past nil)
  3382. (insert (make-string 79 ?-) "\n")))
  3383. (setq date (calendar-gregorian-from-absolute d))
  3384. (setq s (point))
  3385. (setq rtn (and (not emptyp)
  3386. (apply 'org-agenda-get-day-entries entry
  3387. date args)))
  3388. (if (or rtn (equal d today) org-timeline-show-empty-dates)
  3389. (progn
  3390. (insert
  3391. (if (stringp org-agenda-format-date)
  3392. (format-time-string org-agenda-format-date
  3393. (org-time-from-absolute date))
  3394. (funcall org-agenda-format-date date))
  3395. "\n")
  3396. (put-text-property s (1- (point)) 'face
  3397. (org-agenda-get-day-face date))
  3398. (put-text-property s (1- (point)) 'org-date-line t)
  3399. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3400. (if (equal d today)
  3401. (put-text-property s (1- (point)) 'org-today t))
  3402. (and rtn (insert (org-finalize-agenda-entries rtn) "\n"))
  3403. (put-text-property s (1- (point)) 'day d)))))
  3404. (goto-char (point-min))
  3405. (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
  3406. (point-min)))
  3407. (add-text-properties (point-min) (point-max) '(org-agenda-type timeline))
  3408. (org-finalize-agenda)
  3409. (setq buffer-read-only t)))
  3410. (defun org-get-all-dates (beg end &optional no-ranges force-today inactive empty pre-re)
  3411. "Return a list of all relevant day numbers from BEG to END buffer positions.
  3412. If NO-RANGES is non-nil, include only the start and end dates of a range,
  3413. not every single day in the range. If FORCE-TODAY is non-nil, make
  3414. sure that TODAY is included in the list. If INACTIVE is non-nil, also
  3415. inactive time stamps (those in square brackets) are included.
  3416. When EMPTY is non-nil, also include days without any entries."
  3417. (let ((re (concat
  3418. (if pre-re pre-re "")
  3419. (if inactive org-ts-regexp-both org-ts-regexp)))
  3420. dates dates1 date day day1 day2 ts1 ts2 pos)
  3421. (if force-today
  3422. (setq dates (list (org-today))))
  3423. (save-excursion
  3424. (goto-char beg)
  3425. (while (re-search-forward re end t)
  3426. (setq day (time-to-days (org-time-string-to-time
  3427. (substring (match-string 1) 0 10)
  3428. (current-buffer) (match-beginning 0))))
  3429. (or (memq day dates) (push day dates)))
  3430. (unless no-ranges
  3431. (goto-char beg)
  3432. (while (re-search-forward org-tr-regexp end t)
  3433. (setq pos (match-beginning 0))
  3434. (setq ts1 (substring (match-string 1) 0 10)
  3435. ts2 (substring (match-string 2) 0 10)
  3436. day1 (time-to-days (org-time-string-to-time
  3437. ts1 (current-buffer) pos))
  3438. day2 (time-to-days (org-time-string-to-time
  3439. ts2 (current-buffer) pos)))
  3440. (while (< (setq day1 (1+ day1)) day2)
  3441. (or (memq day1 dates) (push day1 dates)))))
  3442. (setq dates (sort dates '<))
  3443. (when empty
  3444. (while (setq day (pop dates))
  3445. (setq day2 (car dates))
  3446. (push day dates1)
  3447. (when (and day2 empty)
  3448. (if (or (eq empty t)
  3449. (and (numberp empty) (<= (- day2 day) empty)))
  3450. (while (< (setq day (1+ day)) day2)
  3451. (push (list day) dates1))
  3452. (push (cons :omitted (- day2 day)) dates1))))
  3453. (setq dates (nreverse dates1)))
  3454. dates)))
  3455. ;;; Agenda Daily/Weekly
  3456. (defvar org-agenda-start-day nil ; dynamically scoped parameter
  3457. "Start day for the agenda view.
  3458. Custom commands can set this variable in the options section.")
  3459. (defvar org-starting-day nil) ; local variable in the agenda buffer
  3460. (defvar org-agenda-current-span nil
  3461. "The current span used in the agenda view.") ; local variable in the agenda buffer
  3462. (defvar org-arg-loc nil) ; local variable
  3463. (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
  3464. "List of types searched for when creating the daily/weekly agenda.
  3465. This variable is a list of symbols that controls the types of
  3466. items that appear in the daily/weekly agenda. Allowed symbols in this
  3467. list are are
  3468. :timestamp List items containing a date stamp or date range matching
  3469. the selected date. This includes sexp entries in
  3470. angular brackets.
  3471. :sexp List entries resulting from plain diary-like sexps.
  3472. :deadline List deadline due on that date. When the date is today,
  3473. also list any deadlines past due, or due within
  3474. `org-deadline-warning-days'. `:deadline' must appear before
  3475. `:scheduled' if the setting of
  3476. `org-agenda-skip-scheduled-if-deadline-is-shown' is to have
  3477. any effect.
  3478. :scheduled List all items which are scheduled for the given date.
  3479. The diary for *today* also contains items which were
  3480. scheduled earlier and are not yet marked DONE.
  3481. By default, all four types are turned on.
  3482. Never set this variable globally using `setq', because then it
  3483. will apply to all future agenda commands. Instead, bind it with
  3484. `let' to scope it dynamically into the agenda-constructing
  3485. command. A good way to set it is through options in
  3486. `org-agenda-custom-commands'. For a more flexible (though
  3487. somewhat less efficient) way of determining what is included in
  3488. the daily/weekly agenda, see `org-agenda-skip-function'.")
  3489. ;;;###autoload
  3490. (defun org-agenda-list (&optional arg start-day span)
  3491. "Produce a daily/weekly view from all files in variable `org-agenda-files'.
  3492. The view will be for the current day or week, but from the overview buffer
  3493. you will be able to go to other days/weeks.
  3494. With a numeric prefix argument in an interactive call, the agenda will
  3495. span ARG days. Lisp programs should instead specify SPAN to change
  3496. the number of days. SPAN defaults to `org-agenda-span'.
  3497. START-DAY defaults to TODAY, or to the most recent match for the weekday
  3498. given in `org-agenda-start-on-weekday'."
  3499. (interactive "P")
  3500. (if (and (integerp arg) (> arg 0))
  3501. (setq span arg arg nil))
  3502. (org-prepare-agenda "Day/Week")
  3503. (setq start-day (or start-day org-agenda-start-day))
  3504. (if org-agenda-overriding-arguments
  3505. (setq arg (car org-agenda-overriding-arguments)
  3506. start-day (nth 1 org-agenda-overriding-arguments)
  3507. span (nth 2 org-agenda-overriding-arguments)))
  3508. (if (stringp start-day)
  3509. ;; Convert to an absolute day number
  3510. (setq start-day (time-to-days (org-read-date nil t start-day))))
  3511. (setq org-agenda-last-arguments (list arg start-day span))
  3512. (org-compile-prefix-format 'agenda)
  3513. (org-set-sorting-strategy 'agenda)
  3514. (let* ((span (org-agenda-ndays-to-span
  3515. (or span org-agenda-ndays org-agenda-span)))
  3516. (today (org-today))
  3517. (sd (or start-day today))
  3518. (ndays (org-agenda-span-to-ndays span sd))
  3519. (org-agenda-start-on-weekday
  3520. (if (eq ndays 7)
  3521. org-agenda-start-on-weekday))
  3522. (thefiles (org-agenda-files nil 'ifmode))
  3523. (files thefiles)
  3524. (start (if (or (null org-agenda-start-on-weekday)
  3525. (< ndays 7))
  3526. sd
  3527. (let* ((nt (calendar-day-of-week
  3528. (calendar-gregorian-from-absolute sd)))
  3529. (n1 org-agenda-start-on-weekday)
  3530. (d (- nt n1)))
  3531. (- sd (+ (if (< d 0) 7 0) d)))))
  3532. (day-numbers (list start))
  3533. (day-cnt 0)
  3534. (inhibit-redisplay (not debug-on-error))
  3535. (org-agenda-show-log-scoped org-agenda-show-log)
  3536. s e rtn rtnall file date d start-pos end-pos todayp
  3537. clocktable-start clocktable-end filter)
  3538. (setq org-agenda-redo-command
  3539. (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span)))
  3540. (dotimes (n (1- ndays))
  3541. (push (1+ (car day-numbers)) day-numbers))
  3542. (setq day-numbers (nreverse day-numbers))
  3543. (setq clocktable-start (car day-numbers)
  3544. clocktable-end (1+ (or (org-last day-numbers) 0)))
  3545. (org-set-local 'org-starting-day (car day-numbers))
  3546. (org-set-local 'org-arg-loc arg)
  3547. (org-set-local 'org-agenda-current-span (org-agenda-ndays-to-span span))
  3548. (unless org-agenda-compact-blocks
  3549. (let* ((d1 (car day-numbers))
  3550. (d2 (org-last day-numbers))
  3551. (w1 (org-days-to-iso-week d1))
  3552. (w2 (org-days-to-iso-week d2)))
  3553. (setq s (point))
  3554. (if org-agenda-overriding-header
  3555. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  3556. nil 'face 'org-agenda-structure) "\n")
  3557. (insert (org-agenda-span-name span)
  3558. "-agenda"
  3559. (if (< (- d2 d1) 350)
  3560. (if (= w1 w2)
  3561. (format " (W%02d)" w1)
  3562. (format " (W%02d-W%02d)" w1 w2))
  3563. "")
  3564. ":\n")))
  3565. (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
  3566. 'org-date-line t))
  3567. (org-agenda-mark-header-line s))
  3568. (while (setq d (pop day-numbers))
  3569. (setq date (calendar-gregorian-from-absolute d)
  3570. s (point))
  3571. (if (or (setq todayp (= d today))
  3572. (and (not start-pos) (= d sd)))
  3573. (setq start-pos (point))
  3574. (if (and start-pos (not end-pos))
  3575. (setq end-pos (point))))
  3576. (setq files thefiles
  3577. rtnall nil)
  3578. (while (setq file (pop files))
  3579. (catch 'nextfile
  3580. (org-check-agenda-file file)
  3581. (let ((org-agenda-entry-types org-agenda-entry-types))
  3582. (unless org-agenda-include-deadlines
  3583. (setq org-agenda-entry-types
  3584. (delq :deadline org-agenda-entry-types)))
  3585. (cond
  3586. ((memq org-agenda-show-log-scoped '(only clockcheck))
  3587. (setq rtn (org-agenda-get-day-entries
  3588. file date :closed)))
  3589. (org-agenda-show-log-scoped
  3590. (setq rtn (apply 'org-agenda-get-day-entries
  3591. file date
  3592. (append '(:closed) org-agenda-entry-types))))
  3593. (t
  3594. (setq rtn (apply 'org-agenda-get-day-entries
  3595. file date
  3596. org-agenda-entry-types)))))
  3597. (setq rtnall (append rtnall rtn)))) ;; all entries
  3598. (if org-agenda-include-diary
  3599. (let ((org-agenda-search-headline-for-time t))
  3600. (require 'diary-lib)
  3601. (setq rtn (org-get-entries-from-diary date))
  3602. (setq rtnall (append rtnall rtn))))
  3603. (if (or rtnall org-agenda-show-all-dates)
  3604. (progn
  3605. (setq day-cnt (1+ day-cnt))
  3606. (insert
  3607. (if (stringp org-agenda-format-date)
  3608. (format-time-string org-agenda-format-date
  3609. (org-time-from-absolute date))
  3610. (funcall org-agenda-format-date date))
  3611. "\n")
  3612. (put-text-property s (1- (point)) 'face
  3613. (org-agenda-get-day-face date))
  3614. (put-text-property s (1- (point)) 'org-date-line t)
  3615. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3616. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
  3617. (when todayp
  3618. (put-text-property s (1- (point)) 'org-today t))
  3619. (setq rtnall
  3620. (org-agenda-add-time-grid-maybe rtnall ndays todayp))
  3621. (if rtnall (insert ;; all entries
  3622. (org-finalize-agenda-entries rtnall)
  3623. "\n"))
  3624. (put-text-property s (1- (point)) 'day d)
  3625. (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
  3626. (when (and org-agenda-clockreport-mode clocktable-start)
  3627. (let ((org-agenda-files (org-agenda-files nil 'ifmode))
  3628. ;; the above line is to ensure the restricted range!
  3629. (p (copy-sequence org-agenda-clockreport-parameter-plist))
  3630. tbl)
  3631. (setq p (org-plist-delete p :block))
  3632. (setq p (plist-put p :tstart clocktable-start))
  3633. (setq p (plist-put p :tend clocktable-end))
  3634. (setq p (plist-put p :scope 'agenda))
  3635. (when (and (eq org-agenda-clockreport-mode 'with-filter)
  3636. (setq filter (or org-agenda-tag-filter-while-redo
  3637. (get 'org-agenda-tag-filter :preset-filter))))
  3638. (setq p (plist-put p :tags (mapconcat (lambda (x)
  3639. (if (string-match "[<>=]" x)
  3640. ""
  3641. x))
  3642. filter ""))))
  3643. (setq tbl (apply 'org-get-clocktable p))
  3644. (insert tbl)))
  3645. (goto-char (point-min))
  3646. (or org-agenda-multi (org-fit-agenda-window))
  3647. (unless (and (pos-visible-in-window-p (point-min))
  3648. (pos-visible-in-window-p (point-max)))
  3649. (goto-char (1- (point-max)))
  3650. (recenter -1)
  3651. (if (not (pos-visible-in-window-p (or start-pos 1)))
  3652. (progn
  3653. (goto-char (or start-pos 1))
  3654. (recenter 1))))
  3655. (goto-char (or start-pos 1))
  3656. (add-text-properties (point-min) (point-max) '(org-agenda-type agenda))
  3657. (if (eq org-agenda-show-log-scoped 'clockcheck)
  3658. (org-agenda-show-clocking-issues))
  3659. (org-finalize-agenda)
  3660. (setq buffer-read-only t)
  3661. (message "")))
  3662. (defun org-agenda-ndays-to-span (n)
  3663. "Return a span symbol for a span of N days, or N if none matches."
  3664. (cond ((symbolp n) n)
  3665. ((= n 1) 'day)
  3666. ((= n 7) 'week)
  3667. (t n)))
  3668. (defun org-agenda-span-to-ndays (span start-day)
  3669. "Return ndays from SPAN starting at START-DAY."
  3670. (cond ((numberp span) span)
  3671. ((eq span 'day) 1)
  3672. ((eq span 'week) 7)
  3673. ((eq span 'month)
  3674. (let ((date (calendar-gregorian-from-absolute start-day)))
  3675. (calendar-last-day-of-month (car date) (caddr date))))
  3676. ((eq span 'year)
  3677. (let ((date (calendar-gregorian-from-absolute start-day)))
  3678. (if (calendar-leap-year-p (caddr date)) 366 365)))))
  3679. (defun org-agenda-span-name (span)
  3680. "Return a SPAN name."
  3681. (if (null span)
  3682. ""
  3683. (if (symbolp span)
  3684. (capitalize (symbol-name span))
  3685. (format "%d days" span))))
  3686. ;;; Agenda word search
  3687. (defvar org-agenda-search-history nil)
  3688. (defvar org-todo-only nil)
  3689. (defvar org-search-syntax-table nil
  3690. "Special syntax table for org-mode search.
  3691. In this table, we have single quotes not as word constituents, to
  3692. that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
  3693. (defvar org-mode-syntax-table) ; From org.el
  3694. (defun org-search-syntax-table ()
  3695. (unless org-search-syntax-table
  3696. (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
  3697. (modify-syntax-entry ?' "." org-search-syntax-table)
  3698. (modify-syntax-entry ?` "." org-search-syntax-table))
  3699. org-search-syntax-table)
  3700. (defvar org-agenda-last-search-view-search-was-boolean nil)
  3701. ;;;###autoload
  3702. (defun org-search-view (&optional todo-only string edit-at)
  3703. "Show all entries that contain a phrase or words or regular expressions.
  3704. With optional prefix argument TODO-ONLY, only consider entries that are
  3705. TODO entries. The argument STRING can be used to pass a default search
  3706. string into this function. If EDIT-AT is non-nil, it means that the
  3707. user should get a chance to edit this string, with cursor at position
  3708. EDIT-AT.
  3709. The search string can be viewed either as a phrase that should be found as
  3710. is, or it can be broken into a number of snippets, each of which must match
  3711. in a Boolean way to select an entry. The default depends on the variable
  3712. `org-agenda-search-view-always-boolean'.
  3713. Even if this is turned off (the default) you can always switch to
  3714. Boolean search dynamically by preceding the first word with \"+\" or \"-\".
  3715. The default is a direct search of the whole phrase, where each space in
  3716. the search string can expand to an arbitrary amount of whitespace,
  3717. including newlines.
  3718. If using a Boolean search, the search string is split on whitespace and
  3719. each snippet is searched separately, with logical AND to select an entry.
  3720. Words prefixed with a minus must *not* occur in the entry. Words without
  3721. a prefix or prefixed with a plus must occur in the entry. Matching is
  3722. case-insensitive. Words are enclosed by word delimiters (i.e. they must
  3723. match whole words, not parts of a word) if
  3724. `org-agenda-search-view-force-full-words' is set (default is nil).
  3725. Boolean search snippets enclosed by curly braces are interpreted as
  3726. regular expressions that must or (when preceded with \"-\") must not
  3727. match in the entry. Snippets enclosed into double quotes will be taken
  3728. as a whole, to include whitespace.
  3729. - If the search string starts with an asterisk, search only in headlines.
  3730. - If (possibly after the leading star) the search string starts with an
  3731. exclamation mark, this also means to look at TODO entries only, an effect
  3732. that can also be achieved with a prefix argument.
  3733. - If (possibly after star and exclamation mark) the search string starts
  3734. with a colon, this will mean that the (non-regexp) snippets of the
  3735. Boolean search must match as full words.
  3736. This command searches the agenda files, and in addition the files listed
  3737. in `org-agenda-text-search-extra-files'."
  3738. (interactive "P")
  3739. (org-prepare-agenda "SEARCH")
  3740. (org-compile-prefix-format 'search)
  3741. (org-set-sorting-strategy 'search)
  3742. (let* ((props (list 'face nil
  3743. 'done-face 'org-agenda-done
  3744. 'org-not-done-regexp org-not-done-regexp
  3745. 'org-todo-regexp org-todo-regexp
  3746. 'org-complex-heading-regexp org-complex-heading-regexp
  3747. 'mouse-face 'highlight
  3748. 'help-echo (format "mouse-2 or RET jump to location")))
  3749. (full-words org-agenda-search-view-force-full-words)
  3750. (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
  3751. regexp rtn rtnall files file pos
  3752. marker category category-pos tags c neg re boolean
  3753. ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
  3754. (unless (and (not edit-at)
  3755. (stringp string)
  3756. (string-match "\\S-" string))
  3757. (setq string (read-string
  3758. (if org-agenda-search-view-always-boolean
  3759. "[+-]Word/{Regexp} ...: "
  3760. "Phrase, or [+-]Word/{Regexp} ...: ")
  3761. (cond
  3762. ((integerp edit-at) (cons string edit-at))
  3763. (edit-at string))
  3764. 'org-agenda-search-history)))
  3765. (org-set-local 'org-todo-only todo-only)
  3766. (setq org-agenda-redo-command
  3767. (list 'org-search-view (if todo-only t nil) string
  3768. '(if current-prefix-arg 1 nil)))
  3769. (setq org-agenda-query-string string)
  3770. (if (equal (string-to-char string) ?*)
  3771. (setq hdl-only t
  3772. words (substring string 1))
  3773. (setq words string))
  3774. (when (equal (string-to-char words) ?!)
  3775. (setq todo-only t
  3776. words (substring words 1)))
  3777. (when (equal (string-to-char words) ?:)
  3778. (setq full-words t
  3779. words (substring words 1)))
  3780. (if (or org-agenda-search-view-always-boolean
  3781. (member (string-to-char words) '(?- ?+ ?\{)))
  3782. (setq boolean t))
  3783. (setq words (org-split-string words))
  3784. (let (www w)
  3785. (while (setq w (pop words))
  3786. (while (and (string-match "\\\\\\'" w) words)
  3787. (setq w (concat (substring w 0 -1) " " (pop words))))
  3788. (push w www))
  3789. (setq words (nreverse www) www nil)
  3790. (while (setq w (pop words))
  3791. (when (and (string-match "\\`[-+]?{" w)
  3792. (not (string-match "}\\'" w)))
  3793. (while (and words (not (string-match "}\\'" (car words))))
  3794. (setq w (concat w " " (pop words))))
  3795. (setq w (concat w " " (pop words))))
  3796. (push w www))
  3797. (setq words (nreverse www)))
  3798. (setq org-agenda-last-search-view-search-was-boolean boolean)
  3799. (when boolean
  3800. (let (wds w)
  3801. (while (setq w (pop words))
  3802. (if (or (equal (substring w 0 1) "\"")
  3803. (and (> (length w) 1)
  3804. (member (substring w 0 1) '("+" "-"))
  3805. (equal (substring w 1 2) "\"")))
  3806. (while (and words (not (equal (substring w -1) "\"")))
  3807. (setq w (concat w " " (pop words)))))
  3808. (and (string-match "\\`\\([-+]?\\)\"" w)
  3809. (setq w (replace-match "\\1" nil nil w)))
  3810. (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
  3811. (push w wds))
  3812. (setq words (nreverse wds))))
  3813. (if boolean
  3814. (mapc (lambda (w)
  3815. (setq c (string-to-char w))
  3816. (if (equal c ?-)
  3817. (setq neg t w (substring w 1))
  3818. (if (equal c ?+)
  3819. (setq neg nil w (substring w 1))
  3820. (setq neg nil)))
  3821. (if (string-match "\\`{.*}\\'" w)
  3822. (setq re (substring w 1 -1))
  3823. (if full-words
  3824. (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
  3825. (setq re (regexp-quote (downcase w)))))
  3826. (if neg (push re regexps-) (push re regexps+)))
  3827. words)
  3828. (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
  3829. regexps+))
  3830. (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
  3831. (if (not regexps+)
  3832. (setq regexp org-outline-regexp-bol)
  3833. (setq regexp (pop regexps+))
  3834. (if hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
  3835. regexp))))
  3836. (setq files (org-agenda-files nil 'ifmode))
  3837. (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
  3838. (pop org-agenda-text-search-extra-files)
  3839. (setq files (org-add-archive-files files)))
  3840. (setq files (append files org-agenda-text-search-extra-files)
  3841. rtnall nil)
  3842. (while (setq file (pop files))
  3843. (setq ee nil)
  3844. (catch 'nextfile
  3845. (org-check-agenda-file file)
  3846. (setq buffer (if (file-exists-p file)
  3847. (org-get-agenda-file-buffer file)
  3848. (error "No such file %s" file)))
  3849. (if (not buffer)
  3850. ;; If file does not exist, make sure an error message is sent
  3851. (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
  3852. file))))
  3853. (with-current-buffer buffer
  3854. (with-syntax-table (org-search-syntax-table)
  3855. (unless (derived-mode-p 'org-mode)
  3856. (error "Agenda file %s is not in `org-mode'" file))
  3857. (let ((case-fold-search t))
  3858. (save-excursion
  3859. (save-restriction
  3860. (if org-agenda-restrict
  3861. (narrow-to-region org-agenda-restrict-begin
  3862. org-agenda-restrict-end)
  3863. (widen))
  3864. (goto-char (point-min))
  3865. (unless (or (org-at-heading-p)
  3866. (outline-next-heading))
  3867. (throw 'nextfile t))
  3868. (goto-char (max (point-min) (1- (point))))
  3869. (while (re-search-forward regexp nil t)
  3870. (org-back-to-heading t)
  3871. (skip-chars-forward "* ")
  3872. (setq beg (point-at-bol)
  3873. beg1 (point)
  3874. end (progn (outline-next-heading) (point)))
  3875. (catch :skip
  3876. (goto-char beg)
  3877. (org-agenda-skip)
  3878. (setq str (buffer-substring-no-properties
  3879. (point-at-bol)
  3880. (if hdl-only (point-at-eol) end)))
  3881. (mapc (lambda (wr) (when (string-match wr str)
  3882. (goto-char (1- end))
  3883. (throw :skip t)))
  3884. regexps-)
  3885. (mapc (lambda (wr) (unless (string-match wr str)
  3886. (goto-char (1- end))
  3887. (throw :skip t)))
  3888. (if todo-only
  3889. (cons (concat "^\*+[ \t]+" org-not-done-regexp)
  3890. regexps+)
  3891. regexps+))
  3892. (goto-char beg)
  3893. (setq marker (org-agenda-new-marker (point))
  3894. category (org-get-category)
  3895. category-pos (get-text-property (point) 'org-category-position)
  3896. tags (org-get-tags-at (point))
  3897. txt (org-agenda-format-item
  3898. ""
  3899. (buffer-substring-no-properties
  3900. beg1 (point-at-eol))
  3901. category tags))
  3902. (org-add-props txt props
  3903. 'org-marker marker 'org-hd-marker marker
  3904. 'org-todo-regexp org-todo-regexp
  3905. 'org-complex-heading-regexp org-complex-heading-regexp
  3906. 'priority 1000 'org-category category
  3907. 'org-category-position category-pos
  3908. 'type "search")
  3909. (push txt ee)
  3910. (goto-char (1- end))))))))))
  3911. (setq rtn (nreverse ee))
  3912. (setq rtnall (append rtnall rtn)))
  3913. (if org-agenda-overriding-header
  3914. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  3915. nil 'face 'org-agenda-structure) "\n")
  3916. (insert "Search words: ")
  3917. (add-text-properties (point-min) (1- (point))
  3918. (list 'face 'org-agenda-structure))
  3919. (setq pos (point))
  3920. (insert string "\n")
  3921. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  3922. (setq pos (point))
  3923. (unless org-agenda-multi
  3924. (insert "Press `[', `]' to add/sub word, `{', `}' to add/sub regexp, `C-u r' to edit\n")
  3925. (add-text-properties pos (1- (point))
  3926. (list 'face 'org-agenda-structure))))
  3927. (org-agenda-mark-header-line (point-min))
  3928. (when rtnall
  3929. (insert (org-finalize-agenda-entries rtnall) "\n"))
  3930. (goto-char (point-min))
  3931. (or org-agenda-multi (org-fit-agenda-window))
  3932. (add-text-properties (point-min) (point-max) '(org-agenda-type search))
  3933. (org-finalize-agenda)
  3934. (setq buffer-read-only t)))
  3935. ;;; Agenda TODO list
  3936. (defvar org-select-this-todo-keyword nil)
  3937. (defvar org-last-arg nil)
  3938. ;;;###autoload
  3939. (defun org-todo-list (arg)
  3940. "Show all (not done) TODO entries from all agenda file in a single list.
  3941. The prefix arg can be used to select a specific TODO keyword and limit
  3942. the list to these. When using \\[universal-argument], you will be prompted
  3943. for a keyword. A numeric prefix directly selects the Nth keyword in
  3944. `org-todo-keywords-1'."
  3945. (interactive "P")
  3946. (org-prepare-agenda "TODO")
  3947. (org-compile-prefix-format 'todo)
  3948. (org-set-sorting-strategy 'todo)
  3949. (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
  3950. (let* ((today (org-today))
  3951. (date (calendar-gregorian-from-absolute today))
  3952. (kwds org-todo-keywords-for-agenda)
  3953. (completion-ignore-case t)
  3954. (org-select-this-todo-keyword
  3955. (if (stringp arg) arg
  3956. (and arg (integerp arg) (> arg 0)
  3957. (nth (1- arg) kwds))))
  3958. rtn rtnall files file pos)
  3959. (when (equal arg '(4))
  3960. (setq org-select-this-todo-keyword
  3961. (org-icompleting-read "Keyword (or KWD1|K2D2|...): "
  3962. (mapcar 'list kwds) nil nil)))
  3963. (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
  3964. (org-set-local 'org-last-arg arg)
  3965. (setq org-agenda-redo-command
  3966. '(org-todo-list (or current-prefix-arg org-last-arg)))
  3967. (setq files (org-agenda-files nil 'ifmode)
  3968. rtnall nil)
  3969. (while (setq file (pop files))
  3970. (catch 'nextfile
  3971. (org-check-agenda-file file)
  3972. (setq rtn (org-agenda-get-day-entries file date :todo))
  3973. (setq rtnall (append rtnall rtn))))
  3974. (if org-agenda-overriding-header
  3975. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  3976. nil 'face 'org-agenda-structure) "\n")
  3977. (insert "Global list of TODO items of type: ")
  3978. (add-text-properties (point-min) (1- (point))
  3979. (list 'face 'org-agenda-structure
  3980. 'short-heading
  3981. (concat "ToDo: "
  3982. (or org-select-this-todo-keyword "ALL"))))
  3983. (org-agenda-mark-header-line (point-min))
  3984. (setq pos (point))
  3985. (insert (or org-select-this-todo-keyword "ALL") "\n")
  3986. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  3987. (setq pos (point))
  3988. (unless org-agenda-multi
  3989. (insert "Available with `N r': (0)ALL")
  3990. (let ((n 0) s)
  3991. (mapc (lambda (x)
  3992. (setq s (format "(%d)%s" (setq n (1+ n)) x))
  3993. (if (> (+ (current-column) (string-width s) 1) (frame-width))
  3994. (insert "\n "))
  3995. (insert " " s))
  3996. kwds))
  3997. (insert "\n"))
  3998. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
  3999. (org-agenda-mark-header-line (point-min))
  4000. (when rtnall
  4001. (insert (org-finalize-agenda-entries rtnall) "\n"))
  4002. (goto-char (point-min))
  4003. (or org-agenda-multi (org-fit-agenda-window))
  4004. (add-text-properties (point-min) (point-max) '(org-agenda-type todo))
  4005. (org-finalize-agenda)
  4006. (setq buffer-read-only t)))
  4007. ;;; Agenda tags match
  4008. ;;;###autoload
  4009. (defun org-tags-view (&optional todo-only match)
  4010. "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
  4011. The prefix arg TODO-ONLY limits the search to TODO entries."
  4012. (interactive "P")
  4013. (let* ((org-tags-match-list-sublevels
  4014. org-tags-match-list-sublevels)
  4015. (completion-ignore-case t)
  4016. rtn rtnall files file pos matcher
  4017. buffer)
  4018. (when (and (stringp match) (not (string-match "\\S-" match)))
  4019. (setq match nil))
  4020. (setq matcher (org-make-tags-matcher match)
  4021. match (car matcher) matcher (cdr matcher))
  4022. (org-prepare-agenda (concat "TAGS " match))
  4023. (org-compile-prefix-format 'tags)
  4024. (org-set-sorting-strategy 'tags)
  4025. (setq org-agenda-query-string match)
  4026. (setq org-agenda-redo-command
  4027. (list 'org-tags-view (list 'quote todo-only)
  4028. (list 'if 'current-prefix-arg nil 'org-agenda-query-string)))
  4029. (setq files (org-agenda-files nil 'ifmode)
  4030. rtnall nil)
  4031. (while (setq file (pop files))
  4032. (catch 'nextfile
  4033. (org-check-agenda-file file)
  4034. (setq buffer (if (file-exists-p file)
  4035. (org-get-agenda-file-buffer file)
  4036. (error "No such file %s" file)))
  4037. (if (not buffer)
  4038. ;; If file does not exist, error message to agenda
  4039. (setq rtn (list
  4040. (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4041. rtnall (append rtnall rtn))
  4042. (with-current-buffer buffer
  4043. (unless (derived-mode-p 'org-mode)
  4044. (error "Agenda file %s is not in `org-mode'" file))
  4045. (save-excursion
  4046. (save-restriction
  4047. (if org-agenda-restrict
  4048. (narrow-to-region org-agenda-restrict-begin
  4049. org-agenda-restrict-end)
  4050. (widen))
  4051. (setq rtn (org-scan-tags 'agenda matcher todo-only))
  4052. (setq rtnall (append rtnall rtn))))))))
  4053. (if org-agenda-overriding-header
  4054. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4055. nil 'face 'org-agenda-structure) "\n")
  4056. (insert "Headlines with TAGS match: ")
  4057. (add-text-properties (point-min) (1- (point))
  4058. (list 'face 'org-agenda-structure
  4059. 'short-heading
  4060. (concat "Match: " match)))
  4061. (setq pos (point))
  4062. (insert match "\n")
  4063. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4064. (setq pos (point))
  4065. (unless org-agenda-multi
  4066. (insert "Press `C-u r' to search again with new search string\n"))
  4067. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
  4068. (org-agenda-mark-header-line (point-min))
  4069. (when rtnall
  4070. (insert (org-finalize-agenda-entries rtnall) "\n"))
  4071. (goto-char (point-min))
  4072. (or org-agenda-multi (org-fit-agenda-window))
  4073. (add-text-properties (point-min) (point-max) '(org-agenda-type tags))
  4074. (org-finalize-agenda)
  4075. (setq buffer-read-only t)))
  4076. ;;; Agenda Finding stuck projects
  4077. (defvar org-agenda-skip-regexp nil
  4078. "Regular expression used in skipping subtrees for the agenda.
  4079. This is basically a temporary global variable that can be set and then
  4080. used by user-defined selections using `org-agenda-skip-function'.")
  4081. (defvar org-agenda-overriding-header nil
  4082. "When set during agenda, todo and tags searches it replaces the header.
  4083. This variable should not be set directly, but custom commands can bind it
  4084. in the options section.")
  4085. (defun org-agenda-skip-entry-when-regexp-matches ()
  4086. "Check if the current entry contains match for `org-agenda-skip-regexp'.
  4087. If yes, it returns the end position of this entry, causing agenda commands
  4088. to skip the entry but continuing the search in the subtree. This is a
  4089. function that can be put into `org-agenda-skip-function' for the duration
  4090. of a command."
  4091. (let ((end (save-excursion (org-end-of-subtree t)))
  4092. skip)
  4093. (save-excursion
  4094. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  4095. (and skip end)))
  4096. (defun org-agenda-skip-subtree-when-regexp-matches ()
  4097. "Check if the current subtree contains match for `org-agenda-skip-regexp'.
  4098. If yes, it returns the end position of this tree, causing agenda commands
  4099. to skip this subtree. This is a function that can be put into
  4100. `org-agenda-skip-function' for the duration of a command."
  4101. (let ((end (save-excursion (org-end-of-subtree t)))
  4102. skip)
  4103. (save-excursion
  4104. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  4105. (and skip end)))
  4106. (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
  4107. "Check if the current subtree contains match for `org-agenda-skip-regexp'.
  4108. If yes, it returns the end position of the current entry (NOT the tree),
  4109. causing agenda commands to skip the entry but continuing the search in
  4110. the subtree. This is a function that can be put into
  4111. `org-agenda-skip-function' for the duration of a command. An important
  4112. use of this function is for the stuck project list."
  4113. (let ((end (save-excursion (org-end-of-subtree t)))
  4114. (entry-end (save-excursion (outline-next-heading) (1- (point))))
  4115. skip)
  4116. (save-excursion
  4117. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  4118. (and skip entry-end)))
  4119. (defun org-agenda-skip-entry-if (&rest conditions)
  4120. "Skip entry if any of CONDITIONS is true.
  4121. See `org-agenda-skip-if' for details."
  4122. (org-agenda-skip-if nil conditions))
  4123. (defun org-agenda-skip-subtree-if (&rest conditions)
  4124. "Skip entry if any of CONDITIONS is true.
  4125. See `org-agenda-skip-if' for details."
  4126. (org-agenda-skip-if t conditions))
  4127. (defun org-agenda-skip-if (subtree conditions)
  4128. "Checks current entity for CONDITIONS.
  4129. If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
  4130. the entry (i.e. the text before the next heading) is checked.
  4131. CONDITIONS is a list of symbols, boolean OR is used to combine the results
  4132. from different tests. Valid conditions are:
  4133. scheduled Check if there is a scheduled cookie
  4134. notscheduled Check if there is no scheduled cookie
  4135. deadline Check if there is a deadline
  4136. notdeadline Check if there is no deadline
  4137. timestamp Check if there is a timestamp (also deadline or scheduled)
  4138. nottimestamp Check if there is no timestamp (also deadline or scheduled)
  4139. regexp Check if regexp matches
  4140. notregexp Check if regexp does not match.
  4141. todo Check if TODO keyword matches
  4142. nottodo Check if TODO keyword does not match
  4143. The regexp is taken from the conditions list, it must come right after
  4144. the `regexp' or `notregexp' element.
  4145. `todo' and `nottodo' accept as an argument a list of todo
  4146. keywords, which may include \"*\" to match any todo keyword.
  4147. (org-agenda-skip-entry-if 'todo '(\"TODO\" \"WAITING\"))
  4148. would skip all entries with \"TODO\" or \"WAITING\" keywords.
  4149. Instead of a list, a keyword class may be given. For example:
  4150. (org-agenda-skip-entry-if 'nottodo 'done)
  4151. would skip entries that haven't been marked with any of \"DONE\"
  4152. keywords. Possible classes are: `todo', `done', `any'.
  4153. If any of these conditions is met, this function returns the end point of
  4154. the entity, causing the search to continue from there. This is a function
  4155. that can be put into `org-agenda-skip-function' for the duration of a command."
  4156. (let (beg end m)
  4157. (org-back-to-heading t)
  4158. (setq beg (point)
  4159. end (if subtree
  4160. (progn (org-end-of-subtree t) (point))
  4161. (progn (outline-next-heading) (1- (point)))))
  4162. (goto-char beg)
  4163. (and
  4164. (or
  4165. (and (memq 'scheduled conditions)
  4166. (re-search-forward org-scheduled-time-regexp end t))
  4167. (and (memq 'notscheduled conditions)
  4168. (not (re-search-forward org-scheduled-time-regexp end t)))
  4169. (and (memq 'deadline conditions)
  4170. (re-search-forward org-deadline-time-regexp end t))
  4171. (and (memq 'notdeadline conditions)
  4172. (not (re-search-forward org-deadline-time-regexp end t)))
  4173. (and (memq 'timestamp conditions)
  4174. (re-search-forward org-ts-regexp end t))
  4175. (and (memq 'nottimestamp conditions)
  4176. (not (re-search-forward org-ts-regexp end t)))
  4177. (and (setq m (memq 'regexp conditions))
  4178. (stringp (nth 1 m))
  4179. (re-search-forward (nth 1 m) end t))
  4180. (and (setq m (memq 'notregexp conditions))
  4181. (stringp (nth 1 m))
  4182. (not (re-search-forward (nth 1 m) end t)))
  4183. (and (or
  4184. (setq m (memq 'nottodo conditions))
  4185. (setq m (memq 'todo-unblocked conditions))
  4186. (setq m (memq 'nottodo-unblocked conditions))
  4187. (setq m (memq 'todo conditions)))
  4188. (org-agenda-skip-if-todo m end)))
  4189. end)))
  4190. (defun org-agenda-skip-if-todo (args end)
  4191. "Helper function for `org-agenda-skip-if', do not use it directly.
  4192. ARGS is a list with first element either `todo', `nottodo',
  4193. `todo-unblocked' or `nottodo-unblocked'. The remainder is either
  4194. a list of TODO keywords, or a state symbol `todo' or `done' or
  4195. `any'."
  4196. (let ((kw (car args))
  4197. (arg (cadr args))
  4198. todo-wds todo-re)
  4199. (setq todo-wds
  4200. (org-uniquify
  4201. (cond
  4202. ((listp arg) ;; list of keywords
  4203. (if (member "*" arg)
  4204. (mapcar 'substring-no-properties org-todo-keywords-1)
  4205. arg))
  4206. ((symbolp arg) ;; keyword class name
  4207. (cond
  4208. ((eq arg 'todo)
  4209. (org-delete-all org-done-keywords
  4210. (mapcar 'substring-no-properties
  4211. org-todo-keywords-1)))
  4212. ((eq arg 'done) org-done-keywords)
  4213. ((eq arg 'any)
  4214. (mapcar 'substring-no-properties org-todo-keywords-1)))))))
  4215. (setq todo-re
  4216. (concat "^\\*+[ \t]+\\<\\("
  4217. (mapconcat 'identity todo-wds "\\|")
  4218. "\\)\\>"))
  4219. (cond
  4220. ((eq kw 'todo) (re-search-forward todo-re end t))
  4221. ((eq kw 'nottodo) (not (re-search-forward todo-re end t)))
  4222. ((eq kw 'todo-unblocked)
  4223. (catch 'unblocked
  4224. (while (re-search-forward todo-re end t)
  4225. (or (org-entry-blocked-p) (throw 'unblocked t)))
  4226. nil))
  4227. ((eq kw 'nottodo-unblocked)
  4228. (catch 'unblocked
  4229. (while (re-search-forward todo-re end t)
  4230. (or (org-entry-blocked-p) (throw 'unblocked nil)))
  4231. t))
  4232. )))
  4233. ;;;###autoload
  4234. (defun org-agenda-list-stuck-projects (&rest ignore)
  4235. "Create agenda view for projects that are stuck.
  4236. Stuck projects are project that have no next actions. For the definitions
  4237. of what a project is and how to check if it stuck, customize the variable
  4238. `org-stuck-projects'."
  4239. (interactive)
  4240. (let* ((org-agenda-skip-function
  4241. 'org-agenda-skip-entry-when-regexp-matches-in-subtree)
  4242. ;; We could have used org-agenda-skip-if here.
  4243. (org-agenda-overriding-header
  4244. (or org-agenda-overriding-header "List of stuck projects: "))
  4245. (matcher (nth 0 org-stuck-projects))
  4246. (todo (nth 1 org-stuck-projects))
  4247. (todo-wds (if (member "*" todo)
  4248. (progn
  4249. (org-prepare-agenda-buffers (org-agenda-files
  4250. nil 'ifmode))
  4251. (org-delete-all
  4252. org-done-keywords-for-agenda
  4253. (copy-sequence org-todo-keywords-for-agenda)))
  4254. todo))
  4255. (todo-re (concat "^\\*+[ \t]+\\("
  4256. (mapconcat 'identity todo-wds "\\|")
  4257. "\\)\\>"))
  4258. (tags (nth 2 org-stuck-projects))
  4259. (tags-re (if (member "*" tags)
  4260. (concat org-outline-regexp-bol
  4261. (org-re ".*:[[:alnum:]_@#%]+:[ \t]*$"))
  4262. (if tags
  4263. (concat org-outline-regexp-bol
  4264. ".*:\\("
  4265. (mapconcat 'identity tags "\\|")
  4266. (org-re "\\):[[:alnum:]_@#%:]*[ \t]*$")))))
  4267. (gen-re (nth 3 org-stuck-projects))
  4268. (re-list
  4269. (delq nil
  4270. (list
  4271. (if todo todo-re)
  4272. (if tags tags-re)
  4273. (and gen-re (stringp gen-re) (string-match "\\S-" gen-re)
  4274. gen-re)))))
  4275. (setq org-agenda-skip-regexp
  4276. (if re-list
  4277. (mapconcat 'identity re-list "\\|")
  4278. (error "No information how to identify unstuck projects")))
  4279. (org-tags-view nil matcher)
  4280. (with-current-buffer org-agenda-buffer-name
  4281. (setq org-agenda-redo-command
  4282. '(org-agenda-list-stuck-projects
  4283. (or current-prefix-arg org-last-arg))))))
  4284. ;;; Diary integration
  4285. (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
  4286. (defvar diary-list-entries-hook)
  4287. (defvar diary-time-regexp)
  4288. (defun org-get-entries-from-diary (date)
  4289. "Get the (Emacs Calendar) diary entries for DATE."
  4290. (require 'diary-lib)
  4291. (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
  4292. (diary-display-hook '(fancy-diary-display))
  4293. (diary-display-function 'fancy-diary-display)
  4294. (pop-up-frames nil)
  4295. (diary-list-entries-hook
  4296. (cons 'org-diary-default-entry diary-list-entries-hook))
  4297. (diary-file-name-prefix-function nil) ; turn this feature off
  4298. (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
  4299. entries
  4300. (org-disable-agenda-to-diary t))
  4301. (save-excursion
  4302. (save-window-excursion
  4303. (funcall (if (fboundp 'diary-list-entries)
  4304. 'diary-list-entries 'list-diary-entries)
  4305. date 1)))
  4306. (if (not (get-buffer diary-fancy-buffer))
  4307. (setq entries nil)
  4308. (with-current-buffer diary-fancy-buffer
  4309. (setq buffer-read-only nil)
  4310. (if (zerop (buffer-size))
  4311. ;; No entries
  4312. (setq entries nil)
  4313. ;; Omit the date and other unnecessary stuff
  4314. (org-agenda-cleanup-fancy-diary)
  4315. ;; Add prefix to each line and extend the text properties
  4316. (if (zerop (buffer-size))
  4317. (setq entries nil)
  4318. (setq entries (buffer-substring (point-min) (- (point-max) 1)))
  4319. (setq entries
  4320. (with-temp-buffer
  4321. (insert entries) (goto-char (point-min))
  4322. (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
  4323. (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
  4324. (replace-match (concat "; " (match-string 1)))))
  4325. (buffer-string)))))
  4326. (set-buffer-modified-p nil)
  4327. (kill-buffer diary-fancy-buffer)))
  4328. (when entries
  4329. (setq entries (org-split-string entries "\n"))
  4330. (setq entries
  4331. (mapcar
  4332. (lambda (x)
  4333. (setq x (org-agenda-format-item "" x "Diary" nil 'time))
  4334. ;; Extend the text properties to the beginning of the line
  4335. (org-add-props x (text-properties-at (1- (length x)) x)
  4336. 'type "diary" 'date date 'face 'org-agenda-diary))
  4337. entries)))))
  4338. (defvar org-agenda-cleanup-fancy-diary-hook nil
  4339. "Hook run when the fancy diary buffer is cleaned up.")
  4340. (defun org-agenda-cleanup-fancy-diary ()
  4341. "Remove unwanted stuff in buffer created by `fancy-diary-display'.
  4342. This gets rid of the date, the underline under the date, and
  4343. the dummy entry installed by `org-mode' to ensure non-empty diary for each
  4344. date. It also removes lines that contain only whitespace."
  4345. (goto-char (point-min))
  4346. (if (looking-at ".*?:[ \t]*")
  4347. (progn
  4348. (replace-match "")
  4349. (re-search-forward "\n=+$" nil t)
  4350. (replace-match "")
  4351. (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
  4352. (re-search-forward "\n=+$" nil t)
  4353. (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
  4354. (goto-char (point-min))
  4355. (while (re-search-forward "^ +\n" nil t)
  4356. (replace-match ""))
  4357. (goto-char (point-min))
  4358. (if (re-search-forward "^Org-mode dummy\n?" nil t)
  4359. (replace-match ""))
  4360. (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
  4361. ;; Make sure entries from the diary have the right text properties.
  4362. (eval-after-load "diary-lib"
  4363. '(if (boundp 'diary-modify-entry-list-string-function)
  4364. ;; We can rely on the hook, nothing to do
  4365. nil
  4366. ;; Hook not available, must use advice to make this work
  4367. (defadvice add-to-diary-list (before org-mark-diary-entry activate)
  4368. "Make the position visible."
  4369. (if (and org-disable-agenda-to-diary ;; called from org-agenda
  4370. (stringp string)
  4371. buffer-file-name)
  4372. (setq string (org-modify-diary-entry-string string))))))
  4373. (defun org-modify-diary-entry-string (string)
  4374. "Add text properties to string, allowing org-mode to act on it."
  4375. (org-add-props string nil
  4376. 'mouse-face 'highlight
  4377. 'help-echo (if buffer-file-name
  4378. (format "mouse-2 or RET jump to diary file %s"
  4379. (abbreviate-file-name buffer-file-name))
  4380. "")
  4381. 'org-agenda-diary-link t
  4382. 'org-marker (org-agenda-new-marker (point-at-bol))))
  4383. (defun org-diary-default-entry ()
  4384. "Add a dummy entry to the diary.
  4385. Needed to avoid empty dates which mess up holiday display."
  4386. ;; Catch the error if dealing with the new add-to-diary-alist
  4387. (when org-disable-agenda-to-diary
  4388. (condition-case nil
  4389. (org-add-to-diary-list original-date "Org-mode dummy" "")
  4390. (error
  4391. (org-add-to-diary-list original-date "Org-mode dummy" "" nil)))))
  4392. (defun org-add-to-diary-list (&rest args)
  4393. (if (fboundp 'diary-add-to-list)
  4394. (apply 'diary-add-to-list args)
  4395. (apply 'add-to-diary-list args)))
  4396. (defvar org-diary-last-run-time nil)
  4397. ;;;###autoload
  4398. (defun org-diary (&rest args)
  4399. "Return diary information from org files.
  4400. This function can be used in a \"sexp\" diary entry in the Emacs calendar.
  4401. It accesses org files and extracts information from those files to be
  4402. listed in the diary. The function accepts arguments specifying what
  4403. items should be listed. For a list of arguments allowed here, see the
  4404. variable `org-agenda-entry-types'.
  4405. The call in the diary file should look like this:
  4406. &%%(org-diary) ~/path/to/some/orgfile.org
  4407. Use a separate line for each org file to check. Or, if you omit the file name,
  4408. all files listed in `org-agenda-files' will be checked automatically:
  4409. &%%(org-diary)
  4410. If you don't give any arguments (as in the example above), the default
  4411. arguments (:deadline :scheduled :timestamp :sexp) are used.
  4412. So the example above may also be written as
  4413. &%%(org-diary :deadline :timestamp :sexp :scheduled)
  4414. The function expects the lisp variables `entry' and `date' to be provided
  4415. by the caller, because this is how the calendar works. Don't use this
  4416. function from a program - use `org-agenda-get-day-entries' instead."
  4417. (when (> (- (org-float-time)
  4418. org-agenda-last-marker-time)
  4419. 5)
  4420. ;; I am not sure if this works with sticky agendas, because the marker
  4421. ;; list is then no longer a global variable.
  4422. (org-agenda-reset-markers))
  4423. ;; Prevent `org-compile-prefix-format' to fail when there is no agenda
  4424. (when (buffer-live-p org-agenda-buffer)
  4425. (org-compile-prefix-format 'agenda))
  4426. (org-set-sorting-strategy 'agenda)
  4427. (setq args (or args '(:deadline :scheduled :timestamp :sexp)))
  4428. (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
  4429. (list entry)
  4430. (org-agenda-files t)))
  4431. (time (org-float-time))
  4432. file rtn results)
  4433. (when (or (not org-diary-last-run-time)
  4434. (> (- time
  4435. org-diary-last-run-time)
  4436. 3))
  4437. (org-prepare-agenda-buffers files))
  4438. (setq org-diary-last-run-time time)
  4439. ;; If this is called during org-agenda, don't return any entries to
  4440. ;; the calendar. Org Agenda will list these entries itself.
  4441. (if org-disable-agenda-to-diary (setq files nil))
  4442. (while (setq file (pop files))
  4443. (setq rtn (apply 'org-agenda-get-day-entries file date args))
  4444. (setq results (append results rtn)))
  4445. (if results
  4446. (concat (org-finalize-agenda-entries results) "\n"))))
  4447. ;;; Agenda entry finders
  4448. (defun org-agenda-get-day-entries (file date &rest args)
  4449. "Does the work for `org-diary' and `org-agenda'.
  4450. FILE is the path to a file to be checked for entries. DATE is date like
  4451. the one returned by `calendar-current-date'. ARGS are symbols indicating
  4452. which kind of entries should be extracted. For details about these, see
  4453. the documentation of `org-diary'."
  4454. (setq args (or args '(:deadline :scheduled :timestamp :sexp)))
  4455. (let* ((org-startup-folded nil)
  4456. (org-startup-align-all-tables nil)
  4457. (buffer (if (file-exists-p file)
  4458. (org-get-agenda-file-buffer file)
  4459. (error "No such file %s" file)))
  4460. arg results rtn deadline-results)
  4461. (if (not buffer)
  4462. ;; If file does not exist, make sure an error message ends up in diary
  4463. (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4464. (with-current-buffer buffer
  4465. (unless (derived-mode-p 'org-mode)
  4466. (error "Agenda file %s is not in `org-mode'" file))
  4467. (let ((case-fold-search nil))
  4468. (save-excursion
  4469. (save-restriction
  4470. (if org-agenda-restrict
  4471. (narrow-to-region org-agenda-restrict-begin
  4472. org-agenda-restrict-end)
  4473. (widen))
  4474. ;; The way we repeatedly append to `results' makes it O(n^2) :-(
  4475. (while (setq arg (pop args))
  4476. (cond
  4477. ((and (eq arg :todo)
  4478. (equal date (calendar-gregorian-from-absolute
  4479. (org-today))))
  4480. (setq rtn (org-agenda-get-todos))
  4481. (setq results (append results rtn)))
  4482. ((eq arg :timestamp)
  4483. (setq rtn (org-agenda-get-blocks))
  4484. (setq results (append results rtn))
  4485. (setq rtn (org-agenda-get-timestamps deadline-results))
  4486. (setq results (append results rtn)))
  4487. ((eq arg :sexp)
  4488. (setq rtn (org-agenda-get-sexps))
  4489. (setq results (append results rtn)))
  4490. ((eq arg :scheduled)
  4491. (setq rtn (org-agenda-get-scheduled deadline-results))
  4492. (setq results (append results rtn)))
  4493. ((eq arg :closed)
  4494. (setq rtn (org-agenda-get-progress))
  4495. (setq results (append results rtn)))
  4496. ((eq arg :deadline)
  4497. (setq rtn (org-agenda-get-deadlines))
  4498. (setq deadline-results (copy-sequence rtn))
  4499. (setq results (append results rtn))))))))
  4500. results))))
  4501. (defvar org-heading-keyword-regexp-format) ; defined in org.el
  4502. (defun org-agenda-get-todos ()
  4503. "Return the TODO information for agenda display."
  4504. (let* ((props (list 'face nil
  4505. 'done-face 'org-agenda-done
  4506. 'org-not-done-regexp org-not-done-regexp
  4507. 'org-todo-regexp org-todo-regexp
  4508. 'org-complex-heading-regexp org-complex-heading-regexp
  4509. 'mouse-face 'highlight
  4510. 'help-echo
  4511. (format "mouse-2 or RET jump to org file %s"
  4512. (abbreviate-file-name buffer-file-name))))
  4513. (regexp (format org-heading-keyword-regexp-format
  4514. (cond
  4515. ((and org-select-this-todo-keyword
  4516. (equal org-select-this-todo-keyword "*"))
  4517. org-todo-regexp)
  4518. (org-select-this-todo-keyword
  4519. (concat "\\("
  4520. (mapconcat 'identity
  4521. (org-split-string
  4522. org-select-this-todo-keyword
  4523. "|")
  4524. "\\|") "\\)"))
  4525. (t org-not-done-regexp))))
  4526. marker priority category category-pos tags todo-state
  4527. ee txt beg end)
  4528. (goto-char (point-min))
  4529. (while (re-search-forward regexp nil t)
  4530. (catch :skip
  4531. (save-match-data
  4532. (beginning-of-line)
  4533. (org-agenda-skip)
  4534. (setq beg (point) end (save-excursion (outline-next-heading) (point)))
  4535. (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
  4536. (goto-char (1+ beg))
  4537. (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
  4538. (throw :skip nil)))
  4539. (goto-char (match-beginning 2))
  4540. (setq marker (org-agenda-new-marker (match-beginning 0))
  4541. category (org-get-category)
  4542. category-pos (get-text-property (point) 'org-category-position)
  4543. txt (org-trim
  4544. (buffer-substring (match-beginning 2) (match-end 0)))
  4545. tags (org-get-tags-at (point))
  4546. txt (org-agenda-format-item "" txt category tags)
  4547. priority (1+ (org-get-priority txt))
  4548. todo-state (org-get-todo-state))
  4549. (org-add-props txt props
  4550. 'org-marker marker 'org-hd-marker marker
  4551. 'priority priority 'org-category category
  4552. 'org-category-position category-pos
  4553. 'type "todo" 'todo-state todo-state)
  4554. (push txt ee)
  4555. (if org-agenda-todo-list-sublevels
  4556. (goto-char (match-end 2))
  4557. (org-end-of-subtree 'invisible))))
  4558. (nreverse ee)))
  4559. (defun org-agenda-todo-custom-ignore-p (time n)
  4560. "Check whether timestamp is farther away then n number of days.
  4561. This function is invoked if `org-agenda-todo-ignore-deadlines',
  4562. `org-agenda-todo-ignore-scheduled' or
  4563. `org-agenda-todo-ignore-timestamp' is set to an integer."
  4564. (let ((days (org-days-to-time time)))
  4565. (if (>= n 0)
  4566. (>= days n)
  4567. (<= days n))))
  4568. ;;;###autoload
  4569. (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  4570. (&optional end)
  4571. "Do we have a reason to ignore this TODO entry because it has a time stamp?"
  4572. (when (or org-agenda-todo-ignore-with-date
  4573. org-agenda-todo-ignore-scheduled
  4574. org-agenda-todo-ignore-deadlines
  4575. org-agenda-todo-ignore-timestamp)
  4576. (setq end (or end (save-excursion (outline-next-heading) (point))))
  4577. (save-excursion
  4578. (or (and org-agenda-todo-ignore-with-date
  4579. (re-search-forward org-ts-regexp end t))
  4580. (and org-agenda-todo-ignore-scheduled
  4581. (re-search-forward org-scheduled-time-regexp end t)
  4582. (cond
  4583. ((eq org-agenda-todo-ignore-scheduled 'future)
  4584. (> (org-days-to-time (match-string 1)) 0))
  4585. ((eq org-agenda-todo-ignore-scheduled 'past)
  4586. (<= (org-days-to-time (match-string 1)) 0))
  4587. ((numberp org-agenda-todo-ignore-scheduled)
  4588. (org-agenda-todo-custom-ignore-p
  4589. (match-string 1) org-agenda-todo-ignore-scheduled))
  4590. (t)))
  4591. (and org-agenda-todo-ignore-deadlines
  4592. (re-search-forward org-deadline-time-regexp end t)
  4593. (cond
  4594. ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
  4595. ((eq org-agenda-todo-ignore-deadlines 'far)
  4596. (not (org-deadline-close (match-string 1))))
  4597. ((eq org-agenda-todo-ignore-deadlines 'future)
  4598. (> (org-days-to-time (match-string 1)) 0))
  4599. ((eq org-agenda-todo-ignore-deadlines 'past)
  4600. (<= (org-days-to-time (match-string 1)) 0))
  4601. ((numberp org-agenda-todo-ignore-deadlines)
  4602. (org-agenda-todo-custom-ignore-p
  4603. (match-string 1) org-agenda-todo-ignore-deadlines))
  4604. (t (org-deadline-close (match-string 1)))))
  4605. (and org-agenda-todo-ignore-timestamp
  4606. (let ((buffer (current-buffer))
  4607. (regexp
  4608. (concat
  4609. org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
  4610. (start (point)))
  4611. ;; Copy current buffer into a temporary one
  4612. (with-temp-buffer
  4613. (insert-buffer-substring buffer start end)
  4614. (goto-char (point-min))
  4615. ;; Delete SCHEDULED and DEADLINE items
  4616. (while (re-search-forward regexp end t)
  4617. (delete-region (match-beginning 0) (match-end 0)))
  4618. (goto-char (point-min))
  4619. ;; No search for timestamp left
  4620. (when (re-search-forward org-ts-regexp nil t)
  4621. (cond
  4622. ((eq org-agenda-todo-ignore-timestamp 'future)
  4623. (> (org-days-to-time (match-string 1)) 0))
  4624. ((eq org-agenda-todo-ignore-timestamp 'past)
  4625. (<= (org-days-to-time (match-string 1)) 0))
  4626. ((numberp org-agenda-todo-ignore-timestamp)
  4627. (org-agenda-todo-custom-ignore-p
  4628. (match-string 1) org-agenda-todo-ignore-timestamp))
  4629. (t))))))))))
  4630. (defconst org-agenda-no-heading-message
  4631. "No heading for this item in buffer or region.")
  4632. (defun org-agenda-get-timestamps (&optional deadline-results)
  4633. "Return the date stamp information for agenda display."
  4634. (let* ((props (list 'face 'org-agenda-calendar-event
  4635. 'org-not-done-regexp org-not-done-regexp
  4636. 'org-todo-regexp org-todo-regexp
  4637. 'org-complex-heading-regexp org-complex-heading-regexp
  4638. 'mouse-face 'highlight
  4639. 'help-echo
  4640. (format "mouse-2 or RET jump to org file %s"
  4641. (abbreviate-file-name buffer-file-name))))
  4642. (d1 (calendar-absolute-from-gregorian date))
  4643. mm
  4644. (deadline-position-alist
  4645. (mapcar (lambda (a) (and (setq mm (get-text-property
  4646. 0 'org-hd-marker a))
  4647. (cons (marker-position mm) a)))
  4648. deadline-results))
  4649. (remove-re org-ts-regexp)
  4650. (regexp
  4651. (concat
  4652. (if org-agenda-include-inactive-timestamps "[[<]" "<")
  4653. (regexp-quote
  4654. (substring
  4655. (format-time-string
  4656. (car org-time-stamp-formats)
  4657. (apply 'encode-time ; DATE bound by calendar
  4658. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  4659. 1 11))
  4660. "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
  4661. "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
  4662. marker hdmarker deadlinep scheduledp clockp closedp inactivep
  4663. donep tmp priority category category-pos ee txt timestr tags
  4664. b0 b3 e3 head todo-state end-of-match show-all warntime)
  4665. (goto-char (point-min))
  4666. (while (setq end-of-match (re-search-forward regexp nil t))
  4667. (setq b0 (match-beginning 0)
  4668. b3 (match-beginning 3) e3 (match-end 3)
  4669. todo-state (save-match-data (ignore-errors (org-get-todo-state)))
  4670. show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  4671. (member todo-state
  4672. org-agenda-repeating-timestamp-show-all)))
  4673. (catch :skip
  4674. (and (org-at-date-range-p) (throw :skip nil))
  4675. (org-agenda-skip)
  4676. (if (and (match-end 1)
  4677. (not (= d1 (org-time-string-to-absolute
  4678. (match-string 1) d1 nil show-all
  4679. (current-buffer) b0))))
  4680. (throw :skip nil))
  4681. (if (and e3
  4682. (not (org-diary-sexp-entry (buffer-substring b3 e3) "" date)))
  4683. (throw :skip nil))
  4684. (setq tmp (buffer-substring (max (point-min)
  4685. (- b0 org-ds-keyword-length))
  4686. b0)
  4687. timestr (if b3 "" (buffer-substring b0 (point-at-eol)))
  4688. inactivep (= (char-after b0) ?\[)
  4689. deadlinep (string-match org-deadline-regexp tmp)
  4690. scheduledp (string-match org-scheduled-regexp tmp)
  4691. closedp (and org-agenda-include-inactive-timestamps
  4692. (string-match org-closed-string tmp))
  4693. clockp (and org-agenda-include-inactive-timestamps
  4694. (or (string-match org-clock-string tmp)
  4695. (string-match "]-+\\'" tmp)))
  4696. warntime (org-entry-get (point) "APPT_WARNTIME")
  4697. donep (member todo-state org-done-keywords))
  4698. (if (or scheduledp deadlinep closedp clockp
  4699. (and donep org-agenda-skip-timestamp-if-done))
  4700. (throw :skip t))
  4701. (if (string-match ">" timestr)
  4702. ;; substring should only run to end of time stamp
  4703. (setq timestr (substring timestr 0 (match-end 0))))
  4704. (setq marker (org-agenda-new-marker b0)
  4705. category (org-get-category b0)
  4706. category-pos (get-text-property b0 'org-category-position))
  4707. (save-excursion
  4708. (if (not (re-search-backward org-outline-regexp-bol nil t))
  4709. (setq txt org-agenda-no-heading-message)
  4710. (goto-char (match-beginning 0))
  4711. (if (and (eq t org-agenda-skip-timestamp-if-deadline-is-shown)
  4712. (assoc (point) deadline-position-alist))
  4713. (throw :skip nil))
  4714. (setq hdmarker (org-agenda-new-marker)
  4715. tags (org-get-tags-at))
  4716. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  4717. (setq head (or (match-string 1) ""))
  4718. (setq txt (org-agenda-format-item
  4719. (if inactivep org-agenda-inactive-leader nil)
  4720. head category tags timestr
  4721. remove-re)))
  4722. (setq priority (org-get-priority txt))
  4723. (org-add-props txt props
  4724. 'org-marker marker 'org-hd-marker hdmarker)
  4725. (org-add-props txt nil 'priority priority
  4726. 'org-category category 'date date
  4727. 'org-category-position category-pos
  4728. 'todo-state todo-state
  4729. 'warntime warntime
  4730. 'type "timestamp")
  4731. (push txt ee))
  4732. (if org-agenda-skip-additional-timestamps-same-entry
  4733. (outline-next-heading)
  4734. (goto-char end-of-match))))
  4735. (nreverse ee)))
  4736. (defun org-agenda-get-sexps ()
  4737. "Return the sexp information for agenda display."
  4738. (require 'diary-lib)
  4739. (let* ((props (list 'face 'org-agenda-calendar-sexp
  4740. 'mouse-face 'highlight
  4741. 'help-echo
  4742. (format "mouse-2 or RET jump to org file %s"
  4743. (abbreviate-file-name buffer-file-name))))
  4744. (regexp "^&?%%(")
  4745. marker category extra category-pos ee txt tags entry
  4746. result beg b sexp sexp-entry todo-state warntime)
  4747. (goto-char (point-min))
  4748. (while (re-search-forward regexp nil t)
  4749. (catch :skip
  4750. (org-agenda-skip)
  4751. (setq beg (match-beginning 0))
  4752. (goto-char (1- (match-end 0)))
  4753. (setq b (point))
  4754. (forward-sexp 1)
  4755. (setq sexp (buffer-substring b (point)))
  4756. (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
  4757. (org-trim (match-string 1))
  4758. ""))
  4759. (setq result (org-diary-sexp-entry sexp sexp-entry date))
  4760. (when result
  4761. (setq marker (org-agenda-new-marker beg)
  4762. category (org-get-category beg)
  4763. category-pos (get-text-property beg 'org-category-position)
  4764. tags (save-excursion (org-backward-heading-same-level 0)
  4765. (org-get-tags-at))
  4766. todo-state (org-get-todo-state)
  4767. warntime (org-entry-get (point) "APPT_WARNTIME"))
  4768. (dolist (r (if (stringp result)
  4769. (list result)
  4770. result)) ;; we expect a list here
  4771. (when (and org-agenda-diary-sexp-prefix
  4772. (string-match org-agenda-diary-sexp-prefix r))
  4773. (setq extra (match-string 0 r)
  4774. r (replace-match "" nil nil r)))
  4775. (if (string-match "\\S-" r)
  4776. (setq txt r)
  4777. (setq txt "SEXP entry returned empty string"))
  4778. (setq txt (org-agenda-format-item
  4779. extra txt category tags 'time))
  4780. (org-add-props txt props 'org-marker marker)
  4781. (org-add-props txt nil
  4782. 'org-category category 'date date 'todo-state todo-state
  4783. 'org-category-position category-pos 'tags tags
  4784. 'type "sexp" 'warntime warntime)
  4785. (push txt ee)))))
  4786. (nreverse ee)))
  4787. ;; Calendar sanity: define some functions that are independent of
  4788. ;; `calendar-date-style'.
  4789. ;; Normally I would like to use ISO format when calling the diary functions,
  4790. ;; but to make sure we still have Emacs 22 compatibility we bind
  4791. ;; also `european-calendar-style' and use european format
  4792. (defun org-anniversary (year month day &optional mark)
  4793. "Like `diary-anniversary', but with fixed (ISO) order of arguments."
  4794. (org-no-warnings
  4795. (let ((calendar-date-style 'european) (european-calendar-style t))
  4796. (diary-anniversary day month year mark))))
  4797. (defun org-cyclic (N year month day &optional mark)
  4798. "Like `diary-cyclic', but with fixed (ISO) order of arguments."
  4799. (org-no-warnings
  4800. (let ((calendar-date-style 'european) (european-calendar-style t))
  4801. (diary-cyclic N day month year mark))))
  4802. (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
  4803. "Like `diary-block', but with fixed (ISO) order of arguments."
  4804. (org-no-warnings
  4805. (let ((calendar-date-style 'european) (european-calendar-style t))
  4806. (diary-block D1 M1 Y1 D2 M2 Y2 mark))))
  4807. (defun org-date (year month day &optional mark)
  4808. "Like `diary-date', but with fixed (ISO) order of arguments."
  4809. (org-no-warnings
  4810. (let ((calendar-date-style 'european) (european-calendar-style t))
  4811. (diary-date day month year mark))))
  4812. (defalias 'org-float 'diary-float)
  4813. ;; Define the` org-class' function
  4814. (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
  4815. "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
  4816. DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
  4817. SKIP-WEEKS is any number of ISO weeks in the block period for which the
  4818. item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
  4819. `holidays', then any date that is known by the Emacs calendar to be a
  4820. holiday will also be skipped."
  4821. (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
  4822. (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
  4823. (d (calendar-absolute-from-gregorian date)))
  4824. (and
  4825. (<= date1 d)
  4826. (<= d date2)
  4827. (= (calendar-day-of-week date) dayname)
  4828. (or (not skip-weeks)
  4829. (progn
  4830. (require 'cal-iso)
  4831. (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
  4832. (not (and (memq 'holidays skip-weeks)
  4833. (calendar-check-holidays date)))
  4834. entry)))
  4835. (defun org-diary-class (m1 d1 y1 m2 d2 y2 dayname &rest skip-weeks)
  4836. "Like `org-class', but honor `calendar-date-style'.
  4837. The order of the first 2 times 3 arguments depends on the variable
  4838. `calendar-date-style' or, if that is not defined, on `european-calendar-style'.
  4839. So for American calendars, give this as MONTH DAY YEAR, for European as
  4840. DAY MONTH YEAR, and for ISO as YEAR MONTH DAY.
  4841. DAYNAME is a number between 0 (Sunday) and 6 (Saturday). SKIP-WEEKS
  4842. is any number of ISO weeks in the block period for which the item should
  4843. be skipped.
  4844. This function is here only for backward compatibility and it is deprecated,
  4845. please use `org-class' instead."
  4846. (let* ((date1 (org-order-calendar-date-args m1 d1 y1))
  4847. (date2 (org-order-calendar-date-args m2 d2 y2)))
  4848. (org-class
  4849. (nth 2 date1) (car date1) (nth 1 date1)
  4850. (nth 2 date2) (car date2) (nth 1 date2)
  4851. dayname skip-weeks)))
  4852. (make-obsolete 'org-diary-class 'org-class "")
  4853. (defvar org-agenda-show-log-scoped) ;; dynamically scope in ̀org-timeline' or`org-agenda-list'
  4854. (defalias 'org-get-closed 'org-agenda-get-progress)
  4855. (defun org-agenda-get-progress ()
  4856. "Return the logged TODO entries for agenda display."
  4857. (let* ((props (list 'mouse-face 'highlight
  4858. 'org-not-done-regexp org-not-done-regexp
  4859. 'org-todo-regexp org-todo-regexp
  4860. 'org-complex-heading-regexp org-complex-heading-regexp
  4861. 'help-echo
  4862. (format "mouse-2 or RET jump to org file %s"
  4863. (abbreviate-file-name buffer-file-name))))
  4864. (items (if (consp org-agenda-show-log-scoped)
  4865. org-agenda-show-log-scoped
  4866. (if (eq org-agenda-show-log-scoped 'clockcheck)
  4867. '(clock)
  4868. org-agenda-log-mode-items)))
  4869. (parts
  4870. (delq nil
  4871. (list
  4872. (if (memq 'closed items) (concat "\\<" org-closed-string))
  4873. (if (memq 'clock items) (concat "\\<" org-clock-string))
  4874. (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
  4875. (parts-re (if parts (mapconcat 'identity parts "\\|")
  4876. (error "`org-agenda-log-mode-items' is empty")))
  4877. (regexp (concat
  4878. "\\(" parts-re "\\)"
  4879. " *\\["
  4880. (regexp-quote
  4881. (substring
  4882. (format-time-string
  4883. (car org-time-stamp-formats)
  4884. (apply 'encode-time ; DATE bound by calendar
  4885. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  4886. 1 11))))
  4887. (org-agenda-search-headline-for-time nil)
  4888. marker hdmarker priority category category-pos tags closedp
  4889. statep clockp state ee txt extra timestr rest clocked)
  4890. (goto-char (point-min))
  4891. (while (re-search-forward regexp nil t)
  4892. (catch :skip
  4893. (org-agenda-skip)
  4894. (setq marker (org-agenda-new-marker (match-beginning 0))
  4895. closedp (equal (match-string 1) org-closed-string)
  4896. statep (equal (string-to-char (match-string 1)) ?-)
  4897. clockp (not (or closedp statep))
  4898. state (and statep (match-string 2))
  4899. category (org-get-category (match-beginning 0))
  4900. category-pos (get-text-property (match-beginning 0) 'org-category-position)
  4901. timestr (buffer-substring (match-beginning 0) (point-at-eol)))
  4902. (when (string-match "\\]" timestr)
  4903. ;; substring should only run to end of time stamp
  4904. (setq rest (substring timestr (match-end 0))
  4905. timestr (substring timestr 0 (match-end 0)))
  4906. (if (and (not closedp) (not statep)
  4907. (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
  4908. rest))
  4909. (progn (setq timestr (concat (substring timestr 0 -1)
  4910. "-" (match-string 1 rest) "]"))
  4911. (setq clocked (match-string 2 rest)))
  4912. (setq clocked "-")))
  4913. (save-excursion
  4914. (setq extra
  4915. (cond
  4916. ((not org-agenda-log-mode-add-notes) nil)
  4917. (statep
  4918. (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
  4919. (match-string 1)))
  4920. (clockp
  4921. (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
  4922. (match-string 1)))))
  4923. (if (not (re-search-backward org-outline-regexp-bol nil t))
  4924. (setq txt org-agenda-no-heading-message)
  4925. (goto-char (match-beginning 0))
  4926. (setq hdmarker (org-agenda-new-marker)
  4927. tags (org-get-tags-at))
  4928. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  4929. (setq txt (match-string 1))
  4930. (when extra
  4931. (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
  4932. (setq txt (concat (substring txt 0 (match-beginning 1))
  4933. " - " extra " " (match-string 2 txt)))
  4934. (setq txt (concat txt " - " extra))))
  4935. (setq txt (org-agenda-format-item
  4936. (cond
  4937. (closedp "Closed: ")
  4938. (statep (concat "State: (" state ")"))
  4939. (t (concat "Clocked: (" clocked ")")))
  4940. txt category tags timestr)))
  4941. (setq priority 100000)
  4942. (org-add-props txt props
  4943. 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
  4944. 'priority priority 'org-category category
  4945. 'org-category-position category-pos
  4946. 'type "closed" 'date date
  4947. 'undone-face 'org-warning 'done-face 'org-agenda-done)
  4948. (push txt ee))
  4949. (goto-char (point-at-eol))))
  4950. (nreverse ee)))
  4951. (defun org-agenda-show-clocking-issues ()
  4952. "Add overlays, showing issues with clocking.
  4953. See also the user option `org-agenda-clock-consistency-checks'."
  4954. (interactive)
  4955. (let* ((pl org-agenda-clock-consistency-checks)
  4956. (re (concat "^[ \t]*"
  4957. org-clock-string
  4958. "[ \t]+"
  4959. "\\(\\[.*?\\]\\)" ; group 1 is first stamp
  4960. "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
  4961. (tlstart 0.)
  4962. (tlend 0.)
  4963. (maxtime (org-hh:mm-string-to-minutes
  4964. (or (plist-get pl :max-duration) "24:00")))
  4965. (mintime (org-hh:mm-string-to-minutes
  4966. (or (plist-get pl :min-duration) 0)))
  4967. (maxgap (org-hh:mm-string-to-minutes
  4968. ;; default 30:00 means never complain
  4969. (or (plist-get pl :max-gap) "30:00")))
  4970. (gapok (mapcar 'org-hh:mm-string-to-minutes
  4971. (plist-get pl :gap-ok-around)))
  4972. (def-face (or (plist-get pl :default-face)
  4973. '((:background "DarkRed") (:foreground "white"))))
  4974. issue face m te ts dt ov)
  4975. (goto-char (point-min))
  4976. (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
  4977. (setq issue nil face def-face)
  4978. (catch 'next
  4979. (setq m (org-get-at-bol 'org-marker)
  4980. te nil ts nil)
  4981. (unless (and m (markerp m))
  4982. (setq issue "No valid clock line") (throw 'next t))
  4983. (org-with-point-at m
  4984. (save-excursion
  4985. (goto-char (point-at-bol))
  4986. (unless (looking-at re)
  4987. (error "No valid Clock line")
  4988. (throw 'next t))
  4989. (unless (match-end 3)
  4990. (setq issue "No end time"
  4991. face (or (plist-get pl :no-end-time-face) face))
  4992. (throw 'next t))
  4993. (setq ts (match-string 1)
  4994. te (match-string 3)
  4995. ts (org-float-time
  4996. (apply 'encode-time (org-parse-time-string ts)))
  4997. te (org-float-time
  4998. (apply 'encode-time (org-parse-time-string te)))
  4999. dt (- te ts))))
  5000. (cond
  5001. ((> dt (* 60 maxtime))
  5002. ;; a very long clocking chunk
  5003. (setq issue (format "Clocking interval is very long: %s"
  5004. (org-minutes-to-hh:mm-string
  5005. (floor (/ (float dt) 60.))))
  5006. face (or (plist-get pl :long-face) face)))
  5007. ((< dt (* 60 mintime))
  5008. ;; a very short clocking chunk
  5009. (setq issue (format "Clocking interval is very short: %s"
  5010. (org-minutes-to-hh:mm-string
  5011. (floor (/ (float dt) 60.))))
  5012. face (or (plist-get pl :short-face) face)))
  5013. ((and (> tlend 0) (< ts tlend))
  5014. ;; Two clock entries are overlapping
  5015. (setq issue (format "Clocking overlap: %d minutes"
  5016. (/ (- tlend ts) 60))
  5017. face (or (plist-get pl :overlap-face) face)))
  5018. ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
  5019. ;; There is a gap, lets see if we need to report it
  5020. (unless (org-agenda-check-clock-gap tlend ts gapok)
  5021. (setq issue (format "Clocking gap: %d minutes"
  5022. (/ (- ts tlend) 60))
  5023. face (or (plist-get pl :gap-face) face))))
  5024. (t nil)))
  5025. (setq tlend (or te tlend) tlstart (or ts tlstart))
  5026. (when issue
  5027. ;; OK, there was some issue, add an overlay to show the issue
  5028. (setq ov (make-overlay (point-at-bol) (point-at-eol)))
  5029. (overlay-put ov 'before-string
  5030. (concat
  5031. (org-add-props
  5032. (format "%-43s" (concat " " issue))
  5033. nil
  5034. 'face face)
  5035. "\n"))
  5036. (overlay-put ov 'evaporate t)))))
  5037. (defun org-agenda-check-clock-gap (t1 t2 ok-list)
  5038. "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
  5039. (catch 'exit
  5040. (unless ok-list
  5041. ;; there are no OK times for gaps...
  5042. (throw 'exit nil))
  5043. (if (> (- (/ t2 36000) (/ t1 36000)) 24)
  5044. ;; This is more than 24 hours, so it is OK.
  5045. ;; because we have at least one OK time, that must be in the
  5046. ;; 24 hour interval.
  5047. (throw 'exit t))
  5048. ;; We have a shorter gap.
  5049. ;; Now we have to get the minute of the day when these times are
  5050. (let* ((t1dec (decode-time (seconds-to-time t1)))
  5051. (t2dec (decode-time (seconds-to-time t2)))
  5052. ;; compute the minute on the day
  5053. (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
  5054. (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
  5055. (when (< min2 min1)
  5056. ;; if min2 is smaller than min1, this means it is on the next day.
  5057. ;; Wrap it to after midnight.
  5058. (setq min2 (+ min2 1440)))
  5059. ;; Now check if any of the OK times is in the gap
  5060. (mapc (lambda (x)
  5061. ;; Wrap the time to after midnight if necessary
  5062. (if (< x min1) (setq x (+ x 1440)))
  5063. ;; Check if in interval
  5064. (and (<= min1 x) (>= min2 x) (throw 'exit t)))
  5065. ok-list)
  5066. ;; Nope, this gap is not OK
  5067. nil)))
  5068. (defun org-agenda-get-deadlines ()
  5069. "Return the deadline information for agenda display."
  5070. (let* ((props (list 'mouse-face 'highlight
  5071. 'org-not-done-regexp org-not-done-regexp
  5072. 'org-todo-regexp org-todo-regexp
  5073. 'org-complex-heading-regexp org-complex-heading-regexp
  5074. 'help-echo
  5075. (format "mouse-2 or RET jump to org file %s"
  5076. (abbreviate-file-name buffer-file-name))))
  5077. (regexp org-deadline-time-regexp)
  5078. (todayp (org-agenda-todayp date)) ; DATE bound by calendar
  5079. (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
  5080. d2 diff dfrac wdays pos pos1 category category-pos
  5081. tags suppress-prewarning ee txt head face s todo-state
  5082. show-all upcomingp donep timestr warntime)
  5083. (goto-char (point-min))
  5084. (while (re-search-forward regexp nil t)
  5085. (setq suppress-prewarning nil)
  5086. (catch :skip
  5087. (org-agenda-skip)
  5088. (when (and org-agenda-skip-deadline-prewarning-if-scheduled
  5089. (save-match-data
  5090. (string-match org-scheduled-time-regexp
  5091. (buffer-substring (point-at-bol)
  5092. (point-at-eol)))))
  5093. (setq suppress-prewarning
  5094. (if (integerp org-agenda-skip-deadline-prewarning-if-scheduled)
  5095. org-agenda-skip-deadline-prewarning-if-scheduled
  5096. 0)))
  5097. (setq s (match-string 1)
  5098. txt nil
  5099. pos (1- (match-beginning 1))
  5100. todo-state (save-match-data (org-get-todo-state))
  5101. show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  5102. (member todo-state
  5103. org-agenda-repeating-timestamp-show-all))
  5104. d2 (org-time-string-to-absolute
  5105. (match-string 1) d1 'past show-all
  5106. (current-buffer) pos)
  5107. diff (- d2 d1)
  5108. wdays (if suppress-prewarning
  5109. (let ((org-deadline-warning-days suppress-prewarning))
  5110. (org-get-wdays s))
  5111. (org-get-wdays s))
  5112. dfrac (- 1 (/ (* 1.0 diff) (max wdays 1)))
  5113. upcomingp (and todayp (> diff 0)))
  5114. ;; When to show a deadline in the calendar:
  5115. ;; If the expiration is within wdays warning time.
  5116. ;; Past-due deadlines are only shown on the current date
  5117. (if (and (or (and (<= diff wdays)
  5118. (and todayp (not org-agenda-only-exact-dates)))
  5119. (= diff 0)))
  5120. (save-excursion
  5121. ;; (setq todo-state (org-get-todo-state))
  5122. (setq donep (member todo-state org-done-keywords))
  5123. (if (and donep
  5124. (or org-agenda-skip-deadline-if-done
  5125. (not (= diff 0))))
  5126. (setq txt nil)
  5127. (setq category (org-get-category)
  5128. warntime (org-entry-get (point) "APPT_WARNTIME")
  5129. category-pos (get-text-property (point) 'org-category-position))
  5130. (if (not (re-search-backward "^\\*+[ \t]+" nil t))
  5131. (setq txt org-agenda-no-heading-message)
  5132. (goto-char (match-end 0))
  5133. (setq pos1 (match-beginning 0))
  5134. (setq tags (org-get-tags-at pos1))
  5135. (setq head (buffer-substring-no-properties
  5136. (point)
  5137. (progn (skip-chars-forward "^\r\n")
  5138. (point))))
  5139. (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5140. (setq timestr
  5141. (concat (substring s (match-beginning 1)) " "))
  5142. (setq timestr 'time))
  5143. (setq txt (org-agenda-format-item
  5144. (if (= diff 0)
  5145. (car org-agenda-deadline-leaders)
  5146. (if (functionp
  5147. (nth 1 org-agenda-deadline-leaders))
  5148. (funcall
  5149. (nth 1 org-agenda-deadline-leaders)
  5150. diff date)
  5151. (format (nth 1 org-agenda-deadline-leaders)
  5152. diff)))
  5153. head category tags
  5154. (if (not (= diff 0)) nil timestr)))))
  5155. (when txt
  5156. (setq face (org-agenda-deadline-face dfrac))
  5157. (org-add-props txt props
  5158. 'org-marker (org-agenda-new-marker pos)
  5159. 'warntime warntime
  5160. 'org-hd-marker (org-agenda-new-marker pos1)
  5161. 'priority (+ (- diff)
  5162. (org-get-priority txt))
  5163. 'org-category category
  5164. 'org-category-position category-pos
  5165. 'todo-state todo-state
  5166. 'type (if upcomingp "upcoming-deadline" "deadline")
  5167. 'date (if upcomingp date d2)
  5168. 'face (if donep 'org-agenda-done face)
  5169. 'undone-face face 'done-face 'org-agenda-done)
  5170. (push txt ee))))))
  5171. (nreverse ee)))
  5172. (defun org-agenda-deadline-face (fraction)
  5173. "Return the face to displaying a deadline item.
  5174. FRACTION is what fraction of the head-warning time has passed."
  5175. (let ((faces org-agenda-deadline-faces) f)
  5176. (catch 'exit
  5177. (while (setq f (pop faces))
  5178. (if (>= fraction (car f)) (throw 'exit (cdr f)))))))
  5179. (defun org-agenda-get-scheduled (&optional deadline-results)
  5180. "Return the scheduled information for agenda display."
  5181. (let* ((props (list 'org-not-done-regexp org-not-done-regexp
  5182. 'org-todo-regexp org-todo-regexp
  5183. 'org-complex-heading-regexp org-complex-heading-regexp
  5184. 'done-face 'org-agenda-done
  5185. 'mouse-face 'highlight
  5186. 'help-echo
  5187. (format "mouse-2 or RET jump to org file %s"
  5188. (abbreviate-file-name buffer-file-name))))
  5189. (regexp org-scheduled-time-regexp)
  5190. (todayp (org-agenda-todayp date)) ; DATE bound by calendar
  5191. (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
  5192. mm
  5193. (deadline-position-alist
  5194. (mapcar (lambda (a) (and (setq mm (get-text-property
  5195. 0 'org-hd-marker a))
  5196. (cons (marker-position mm) a)))
  5197. deadline-results))
  5198. d2 diff pos pos1 category category-pos tags donep
  5199. ee txt head pastschedp todo-state face timestr s habitp show-all
  5200. did-habit-check-p warntime)
  5201. (goto-char (point-min))
  5202. (while (re-search-forward regexp nil t)
  5203. (catch :skip
  5204. (org-agenda-skip)
  5205. (setq s (match-string 1)
  5206. txt nil
  5207. pos (1- (match-beginning 1))
  5208. todo-state (save-match-data (org-get-todo-state))
  5209. show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  5210. (member todo-state
  5211. org-agenda-repeating-timestamp-show-all))
  5212. d2 (org-time-string-to-absolute
  5213. (match-string 1) d1 'past show-all
  5214. (current-buffer) pos)
  5215. diff (- d2 d1)
  5216. warntime (org-entry-get (point) "APPT_WARNTIME"))
  5217. (setq pastschedp (and todayp (< diff 0)))
  5218. (setq did-habit-check-p nil)
  5219. ;; When to show a scheduled item in the calendar:
  5220. ;; If it is on or past the date.
  5221. (when (or (and (< diff 0)
  5222. (< (abs diff) org-scheduled-past-days)
  5223. (and todayp (not org-agenda-only-exact-dates)))
  5224. (= diff 0)
  5225. ;; org-is-habit-p uses org-entry-get, which is expansive
  5226. ;; so we go extra mile to only call it once
  5227. (and todayp
  5228. org-habit-show-all-today
  5229. (setq did-habit-check-p t)
  5230. (setq habitp (and (functionp 'org-is-habit-p)
  5231. (org-is-habit-p)))))
  5232. (save-excursion
  5233. (setq donep (member todo-state org-done-keywords))
  5234. (if (and donep
  5235. (or org-agenda-skip-scheduled-if-done
  5236. (not (= diff 0))
  5237. (and (functionp 'org-is-habit-p)
  5238. (org-is-habit-p))))
  5239. (setq txt nil)
  5240. (setq habitp (if did-habit-check-p habitp
  5241. (and (functionp 'org-is-habit-p)
  5242. (org-is-habit-p))))
  5243. (setq category (org-get-category)
  5244. category-pos (get-text-property (point) 'org-category-position))
  5245. (if (not (re-search-backward "^\\*+[ \t]+" nil t))
  5246. (setq txt org-agenda-no-heading-message)
  5247. (goto-char (match-end 0))
  5248. (setq pos1 (match-beginning 0))
  5249. (if habitp
  5250. (if (or (not org-habit-show-habits)
  5251. (and (not todayp)
  5252. org-habit-show-habits-only-for-today))
  5253. (throw :skip nil))
  5254. (if (and
  5255. (or (eq t org-agenda-skip-scheduled-if-deadline-is-shown)
  5256. (and org-agenda-skip-scheduled-if-deadline-is-shown
  5257. pastschedp))
  5258. (setq mm (assoc pos1 deadline-position-alist)))
  5259. (throw :skip nil)))
  5260. (setq tags (org-get-tags-at))
  5261. (setq head (buffer-substring-no-properties
  5262. (point)
  5263. (progn (skip-chars-forward "^\r\n") (point))))
  5264. (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5265. (setq timestr
  5266. (concat (substring s (match-beginning 1)) " "))
  5267. (setq timestr 'time))
  5268. (setq txt (org-agenda-format-item
  5269. (if (= diff 0)
  5270. (car org-agenda-scheduled-leaders)
  5271. (format (nth 1 org-agenda-scheduled-leaders)
  5272. (- 1 diff)))
  5273. head category tags
  5274. (if (not (= diff 0)) nil timestr)
  5275. nil habitp))))
  5276. (when txt
  5277. (setq face
  5278. (cond
  5279. ((and (not habitp) pastschedp)
  5280. 'org-scheduled-previously)
  5281. (todayp 'org-scheduled-today)
  5282. (t 'org-scheduled))
  5283. habitp (and habitp (org-habit-parse-todo)))
  5284. (org-add-props txt props
  5285. 'undone-face face
  5286. 'face (if donep 'org-agenda-done face)
  5287. 'org-marker (org-agenda-new-marker pos)
  5288. 'org-hd-marker (org-agenda-new-marker pos1)
  5289. 'type (if pastschedp "past-scheduled" "scheduled")
  5290. 'date (if pastschedp d2 date)
  5291. 'warntime warntime
  5292. 'priority (if habitp
  5293. (org-habit-get-priority habitp)
  5294. (+ 94 (- 5 diff) (org-get-priority txt)))
  5295. 'org-category category
  5296. 'category-position category-pos
  5297. 'org-habit-p habitp
  5298. 'todo-state todo-state)
  5299. (push txt ee))))))
  5300. (nreverse ee)))
  5301. (defun org-agenda-get-blocks ()
  5302. "Return the date-range information for agenda display."
  5303. (let* ((props (list 'face nil
  5304. 'org-not-done-regexp org-not-done-regexp
  5305. 'org-todo-regexp org-todo-regexp
  5306. 'org-complex-heading-regexp org-complex-heading-regexp
  5307. 'mouse-face 'highlight
  5308. 'help-echo
  5309. (format "mouse-2 or RET jump to org file %s"
  5310. (abbreviate-file-name buffer-file-name))))
  5311. (regexp org-tr-regexp)
  5312. (d0 (calendar-absolute-from-gregorian date))
  5313. marker hdmarker ee txt d1 d2 s1 s2 category category-pos
  5314. todo-state tags pos head donep)
  5315. (goto-char (point-min))
  5316. (while (re-search-forward regexp nil t)
  5317. (catch :skip
  5318. (org-agenda-skip)
  5319. (setq pos (point))
  5320. (let ((start-time (match-string 1))
  5321. (end-time (match-string 2)))
  5322. (setq s1 (match-string 1)
  5323. s2 (match-string 2)
  5324. d1 (time-to-days (org-time-string-to-time s1 (current-buffer) pos))
  5325. d2 (time-to-days (org-time-string-to-time s2 (current-buffer) pos)))
  5326. (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
  5327. ;; Only allow days between the limits, because the normal
  5328. ;; date stamps will catch the limits.
  5329. (save-excursion
  5330. (setq todo-state (org-get-todo-state))
  5331. (setq donep (member todo-state org-done-keywords))
  5332. (if (and donep org-agenda-skip-timestamp-if-done)
  5333. (throw :skip t))
  5334. (setq marker (org-agenda-new-marker (point)))
  5335. (setq category (org-get-category)
  5336. category-pos (get-text-property (point) 'org-category-position))
  5337. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5338. (setq txt org-agenda-no-heading-message)
  5339. (goto-char (match-beginning 0))
  5340. (setq hdmarker (org-agenda-new-marker (point)))
  5341. (setq tags (org-get-tags-at))
  5342. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5343. (setq head (match-string 1))
  5344. (let ((remove-re
  5345. (if org-agenda-remove-timeranges-from-blocks
  5346. (concat
  5347. "<" (regexp-quote s1) ".*?>"
  5348. "--"
  5349. "<" (regexp-quote s2) ".*?>")
  5350. nil)))
  5351. (setq txt (org-agenda-format-item
  5352. (format
  5353. (nth (if (= d1 d2) 0 1)
  5354. org-agenda-timerange-leaders)
  5355. (1+ (- d0 d1)) (1+ (- d2 d1)))
  5356. head category tags
  5357. (cond ((and (= d1 d0) (= d2 d0))
  5358. (concat "<" start-time ">--<" end-time ">"))
  5359. ((= d1 d0)
  5360. (concat "<" start-time ">"))
  5361. ((= d2 d0)
  5362. (concat "<" end-time ">")))
  5363. remove-re))))
  5364. (org-add-props txt props
  5365. 'org-marker marker 'org-hd-marker hdmarker
  5366. 'type "block" 'date date
  5367. 'todo-state todo-state
  5368. 'priority (org-get-priority txt) 'org-category category
  5369. 'org-category-position category-pos)
  5370. (push txt ee))))
  5371. (goto-char pos)))
  5372. ;; Sort the entries by expiration date.
  5373. (nreverse ee)))
  5374. ;;; Agenda presentation and sorting
  5375. (defvar org-prefix-has-time nil
  5376. "A flag, set by `org-compile-prefix-format'.
  5377. The flag is set if the currently compiled format contains a `%t'.")
  5378. (defvar org-prefix-has-tag nil
  5379. "A flag, set by `org-compile-prefix-format'.
  5380. The flag is set if the currently compiled format contains a `%T'.")
  5381. (defvar org-prefix-has-effort nil
  5382. "A flag, set by `org-compile-prefix-format'.
  5383. The flag is set if the currently compiled format contains a `%e'.")
  5384. (defvar org-prefix-category-length nil
  5385. "Used by `org-compile-prefix-format' to remember the category field width.")
  5386. (defvar org-prefix-category-max-length nil
  5387. "Used by `org-compile-prefix-format' to remember the category field width.")
  5388. (defun org-agenda-get-category-icon (category)
  5389. "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
  5390. (dolist (entry org-agenda-category-icon-alist)
  5391. (when (org-string-match-p (car entry) category)
  5392. (if (listp (cadr entry))
  5393. (return (cadr entry))
  5394. (return (apply 'create-image (cdr entry)))))))
  5395. (defun org-agenda-format-item (extra txt &optional category tags dotime
  5396. remove-re habitp)
  5397. "Format TXT to be inserted into the agenda buffer.
  5398. In particular, it adds the prefix and corresponding text properties. EXTRA
  5399. must be a string and replaces the `%s' specifier in the prefix format.
  5400. CATEGORY (string, symbol or nil) may be used to overrule the default
  5401. category taken from local variable or file name. It will replace the `%c'
  5402. specifier in the format. DOTIME, when non-nil, indicates that a
  5403. time-of-day should be extracted from TXT for sorting of this entry, and for
  5404. the `%t' specifier in the format. When DOTIME is a string, this string is
  5405. searched for a time before TXT is. TAGS can be the tags of the headline.
  5406. Any match of REMOVE-RE will be removed from TXT."
  5407. ;; We keep the org-prefix-* variable values along with a compiled
  5408. ;; formatter, so that multiple agendas existing at the same time, do
  5409. ;; not step on each other toes.
  5410. ;;
  5411. ;; It was inconvenient to make these variables buffer local in
  5412. ;; Agenda buffers, because this function expects to be called with
  5413. ;; the buffer where item comes from being current, and not agenda
  5414. ;; buffer
  5415. (let* ((bindings (car org-prefix-format-compiled))
  5416. (formatter (cadr org-prefix-format-compiled)))
  5417. (loop for (var value) in bindings
  5418. do (set var value))
  5419. (save-match-data
  5420. ;; Diary entries sometimes have extra whitespace at the beginning
  5421. (if (string-match "^ +" txt) (setq txt (replace-match "" nil nil txt)))
  5422. ;; Fix the tags part in txt
  5423. (setq txt (org-agenda-fix-displayed-tags
  5424. txt tags
  5425. org-agenda-show-inherited-tags
  5426. org-agenda-hide-tags-regexp))
  5427. (let* ((category (or category
  5428. (if (stringp org-category)
  5429. org-category
  5430. (and org-category (symbol-name org-category)))
  5431. (if buffer-file-name
  5432. (file-name-sans-extension
  5433. (file-name-nondirectory buffer-file-name))
  5434. "")))
  5435. (category-icon (org-agenda-get-category-icon category))
  5436. (category-icon (if category-icon
  5437. (propertize " " 'display category-icon)
  5438. ""))
  5439. ;; time, tag, effort are needed for the eval of the prefix format
  5440. (tag (if tags (nth (1- (length tags)) tags) ""))
  5441. time effort neffort
  5442. (ts (if dotime (concat
  5443. (if (stringp dotime) dotime "")
  5444. (and org-agenda-search-headline-for-time txt))))
  5445. (time-of-day (and dotime (org-get-time-of-day ts)))
  5446. stamp plain s0 s1 s2 rtn srp l
  5447. duration thecategory)
  5448. (and (derived-mode-p 'org-mode) buffer-file-name
  5449. (add-to-list 'org-agenda-contributing-files buffer-file-name))
  5450. (when (and dotime time-of-day)
  5451. ;; Extract starting and ending time and move them to prefix
  5452. (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
  5453. (setq plain (string-match org-plain-time-of-day-regexp ts)))
  5454. (setq s0 (match-string 0 ts)
  5455. srp (and stamp (match-end 3))
  5456. s1 (match-string (if plain 1 2) ts)
  5457. s2 (match-string (if plain 8 (if srp 4 6)) ts))
  5458. ;; If the times are in TXT (not in DOTIMES), and the prefix will list
  5459. ;; them, we might want to remove them there to avoid duplication.
  5460. ;; The user can turn this off with a variable.
  5461. (if (and org-prefix-has-time
  5462. org-agenda-remove-times-when-in-prefix (or stamp plain)
  5463. (string-match (concat (regexp-quote s0) " *") txt)
  5464. (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
  5465. (if (eq org-agenda-remove-times-when-in-prefix 'beg)
  5466. (= (match-beginning 0) 0)
  5467. t))
  5468. (setq txt (replace-match "" nil nil txt))))
  5469. ;; Normalize the time(s) to 24 hour
  5470. (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
  5471. (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
  5472. ;; Try to set s2 if s1 and `org-agenda-default-appointment-duration' are set
  5473. (when (and s1 (not s2) org-agenda-default-appointment-duration)
  5474. (setq s2
  5475. (org-minutes-to-hh:mm-string
  5476. (+ (org-hh:mm-string-to-minutes s1) org-agenda-default-appointment-duration))))
  5477. ;; Compute the duration
  5478. (when s2
  5479. (setq duration (- (org-hh:mm-string-to-minutes s2)
  5480. (org-hh:mm-string-to-minutes s1)))))
  5481. (when (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
  5482. txt)
  5483. ;; Tags are in the string
  5484. (if (or (eq org-agenda-remove-tags t)
  5485. (and org-agenda-remove-tags
  5486. org-prefix-has-tag))
  5487. (setq txt (replace-match "" t t txt))
  5488. (setq txt (replace-match
  5489. (concat (make-string (max (- 50 (length txt)) 1) ?\ )
  5490. (match-string 2 txt))
  5491. t t txt))))
  5492. (when (derived-mode-p 'org-mode)
  5493. (setq effort
  5494. (condition-case nil
  5495. (org-get-effort
  5496. (or (get-text-property 0 'org-hd-marker txt)
  5497. (get-text-property 0 'org-marker txt)))
  5498. (error nil)))
  5499. (when effort
  5500. (setq neffort (org-duration-string-to-minutes effort)
  5501. effort (setq effort (concat "[" effort "]")))))
  5502. ;; prevent erroring out with %e format when there is no effort
  5503. (or effort (setq effort ""))
  5504. (when remove-re
  5505. (while (string-match remove-re txt)
  5506. (setq txt (replace-match "" t t txt))))
  5507. ;; Set org-heading property on `txt' to mark the start of the
  5508. ;; heading.
  5509. (add-text-properties 0 (length txt) '(org-heading t) txt)
  5510. ;; Prepare the variables needed in the eval of the compiled format
  5511. (setq time (cond (s2 (concat
  5512. (org-agenda-time-of-day-to-ampm-maybe s1)
  5513. "-" (org-agenda-time-of-day-to-ampm-maybe s2)
  5514. (if org-agenda-timegrid-use-ampm " ")))
  5515. (s1 (concat
  5516. (org-agenda-time-of-day-to-ampm-maybe s1)
  5517. (if org-agenda-timegrid-use-ampm
  5518. "........ "
  5519. "......")))
  5520. (t ""))
  5521. extra (or (and (not habitp) extra) "")
  5522. category (if (symbolp category) (symbol-name category) category)
  5523. thecategory (copy-sequence category))
  5524. (if (string-match org-bracket-link-regexp category)
  5525. (progn
  5526. (setq l (if (match-end 3)
  5527. (- (match-end 3) (match-beginning 3))
  5528. (- (match-end 1) (match-beginning 1))))
  5529. (when (< l (or org-prefix-category-length 0))
  5530. (setq category (copy-sequence category))
  5531. (org-add-props category nil
  5532. 'extra-space (make-string
  5533. (- org-prefix-category-length l 1) ?\ ))))
  5534. (if (and org-prefix-category-max-length
  5535. (>= (length category) org-prefix-category-max-length))
  5536. (setq category (substring category 0 (1- org-prefix-category-max-length)))))
  5537. ;; Evaluate the compiled format
  5538. (setq rtn (concat (eval formatter) txt))
  5539. ;; And finally add the text properties
  5540. (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
  5541. (org-add-props rtn nil
  5542. 'org-category (if thecategory (downcase thecategory) category)
  5543. 'tags (mapcar 'org-downcase-keep-props tags)
  5544. 'org-highest-priority org-highest-priority
  5545. 'org-lowest-priority org-lowest-priority
  5546. 'time-of-day time-of-day
  5547. 'duration duration
  5548. 'effort effort
  5549. 'effort-minutes neffort
  5550. 'txt txt
  5551. 'time time
  5552. 'extra extra
  5553. 'format org-prefix-format-compiled
  5554. 'dotime dotime)))))
  5555. (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
  5556. "Remove tags string from TXT, and add a modified list of tags.
  5557. The modified list may contain inherited tags, and tags matched by
  5558. `org-agenda-hide-tags-regexp' will be removed."
  5559. (when (or add-inherited hide-re)
  5560. (if (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") txt)
  5561. (setq txt (substring txt 0 (match-beginning 0))))
  5562. (setq tags
  5563. (delq nil
  5564. (mapcar (lambda (tg)
  5565. (if (or (and hide-re (string-match hide-re tg))
  5566. (and (not add-inherited)
  5567. (get-text-property 0 'inherited tg)))
  5568. nil
  5569. tg))
  5570. tags)))
  5571. (when tags
  5572. (let ((have-i (get-text-property 0 'inherited (car tags)))
  5573. i)
  5574. (setq txt (concat txt " :"
  5575. (mapconcat
  5576. (lambda (x)
  5577. (setq i (get-text-property 0 'inherited x))
  5578. (if (and have-i (not i))
  5579. (progn
  5580. (setq have-i nil)
  5581. (concat ":" x))
  5582. x))
  5583. tags ":")
  5584. (if have-i "::" ":"))))))
  5585. txt)
  5586. (defun org-downcase-keep-props (s)
  5587. (let ((props (text-properties-at 0 s)))
  5588. (setq s (downcase s))
  5589. (add-text-properties 0 (length s) props s)
  5590. s))
  5591. (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
  5592. (defvar org-agenda-sorting-strategy-selected nil)
  5593. (defun org-agenda-add-time-grid-maybe (list ndays todayp)
  5594. (catch 'exit
  5595. (cond ((not org-agenda-use-time-grid) (throw 'exit list))
  5596. ((and todayp (member 'today (car org-agenda-time-grid))))
  5597. ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
  5598. ((member 'weekly (car org-agenda-time-grid)))
  5599. (t (throw 'exit list)))
  5600. (let* ((have (delq nil (mapcar
  5601. (lambda (x) (get-text-property 1 'time-of-day x))
  5602. list)))
  5603. (string (nth 1 org-agenda-time-grid))
  5604. (gridtimes (nth 2 org-agenda-time-grid))
  5605. (req (car org-agenda-time-grid))
  5606. (remove (member 'remove-match req))
  5607. new time)
  5608. (if (and (member 'require-timed req) (not have))
  5609. ;; don't show empty grid
  5610. (throw 'exit list))
  5611. (while (setq time (pop gridtimes))
  5612. (unless (and remove (member time have))
  5613. (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
  5614. (push (org-agenda-format-item
  5615. nil string "" nil
  5616. (concat (substring time 0 -2) ":" (substring time -2)))
  5617. new)
  5618. (put-text-property
  5619. 2 (length (car new)) 'face 'org-time-grid (car new))))
  5620. (when (and todayp org-agenda-show-current-time-in-grid)
  5621. (push (org-agenda-format-item
  5622. nil
  5623. org-agenda-current-time-string
  5624. "" nil
  5625. (format-time-string "%H:%M "))
  5626. new)
  5627. (put-text-property
  5628. 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
  5629. (if (member 'time-up org-agenda-sorting-strategy-selected)
  5630. (append new list)
  5631. (append list new)))))
  5632. (defun org-compile-prefix-format (key)
  5633. "Compile the prefix format into a Lisp form that can be evaluated.
  5634. The resulting form and associated variable bindings is returned
  5635. and stored in the variable `org-prefix-format-compiled'."
  5636. (setq org-prefix-has-time nil org-prefix-has-tag nil
  5637. org-prefix-category-length nil
  5638. org-prefix-has-effort nil)
  5639. (let ((s (cond
  5640. ((stringp org-agenda-prefix-format)
  5641. org-agenda-prefix-format)
  5642. ((assq key org-agenda-prefix-format)
  5643. (cdr (assq key org-agenda-prefix-format)))
  5644. (t " %-12:c%?-12t% s")))
  5645. (start 0)
  5646. varform vars var e c f opt)
  5647. (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([ctsei]\\|(.+)\\)"
  5648. s start)
  5649. (setq var (or (cdr (assoc (match-string 4 s)
  5650. '(("c" . category) ("t" . time) ("s" . extra)
  5651. ("i" . category-icon) ("T" . tag) ("e" . effort))))
  5652. 'eval)
  5653. c (or (match-string 3 s) "")
  5654. opt (match-beginning 1)
  5655. start (1+ (match-beginning 0)))
  5656. (if (equal var 'time) (setq org-prefix-has-time t))
  5657. (if (equal var 'tag) (setq org-prefix-has-tag t))
  5658. (if (equal var 'effort) (setq org-prefix-has-effort t))
  5659. (setq f (concat "%" (match-string 2 s) "s"))
  5660. (when (equal var 'category)
  5661. (setq org-prefix-category-length
  5662. (floor (abs (string-to-number (match-string 2 s)))))
  5663. (setq org-prefix-category-max-length
  5664. (let ((x (match-string 2 s)))
  5665. (save-match-data
  5666. (if (string-match "\\.[0-9]+" x)
  5667. (string-to-number (substring (match-string 0 x) 1)))))))
  5668. (if (eq var 'eval)
  5669. (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
  5670. (if opt
  5671. (setq varform
  5672. `(if (equal "" ,var)
  5673. ""
  5674. (format ,f (if (equal "" ,var) "" (concat ,var ,c)))))
  5675. (setq varform `(format ,f (if (equal ,var "") "" (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
  5676. (setq s (replace-match "%s" t nil s))
  5677. (push varform vars))
  5678. (setq vars (nreverse vars))
  5679. (with-current-buffer org-agenda-buffer
  5680. (setq org-prefix-format-compiled
  5681. (list
  5682. `((org-prefix-has-time ,org-prefix-has-time)
  5683. (org-prefix-has-tag ,org-prefix-has-tag)
  5684. (org-prefix-category-length ,org-prefix-category-length)
  5685. (org-prefix-has-effort ,org-prefix-has-effort))
  5686. `(format ,s ,@vars))))))
  5687. (defun org-set-sorting-strategy (key)
  5688. (if (symbolp (car org-agenda-sorting-strategy))
  5689. ;; the old format
  5690. (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
  5691. (setq org-agenda-sorting-strategy-selected
  5692. (or (cdr (assq key org-agenda-sorting-strategy))
  5693. (cdr (assq 'agenda org-agenda-sorting-strategy))
  5694. '(time-up category-keep priority-down)))))
  5695. (defun org-get-time-of-day (s &optional string mod24)
  5696. "Check string S for a time of day.
  5697. If found, return it as a military time number between 0 and 2400.
  5698. If not found, return nil.
  5699. The optional STRING argument forces conversion into a 5 character wide string
  5700. HH:MM."
  5701. (save-match-data
  5702. (when
  5703. (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
  5704. (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
  5705. (let* ((h (string-to-number (match-string 1 s)))
  5706. (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
  5707. (ampm (if (match-end 4) (downcase (match-string 4 s))))
  5708. (am-p (equal ampm "am"))
  5709. (h1 (cond ((not ampm) h)
  5710. ((= h 12) (if am-p 0 12))
  5711. (t (+ h (if am-p 0 12)))))
  5712. (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
  5713. (mod h1 24) h1))
  5714. (t0 (+ (* 100 h2) m))
  5715. (t1 (concat (if (>= h1 24) "+" " ")
  5716. (if (and org-agenda-time-leading-zero
  5717. (< t0 1000)) "0" "")
  5718. (if (< t0 100) "0" "")
  5719. (if (< t0 10) "0" "")
  5720. (int-to-string t0))))
  5721. (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
  5722. (defvar org-agenda-before-sorting-filter-function nil
  5723. "Function to be applied to agenda items prior to sorting.
  5724. Prior to sorting also means just before they are inserted into the agenda.
  5725. To aid sorting, you may revisit the original entries and add more text
  5726. properties which will later be used by the sorting functions.
  5727. The function should take a string argument, an agenda line.
  5728. It has access to the text properties in that line, which contain among
  5729. other things, the property `org-hd-marker' that points to the entry
  5730. where the line comes from. Note that not all lines going into the agenda
  5731. have this property, only most.
  5732. The function should return the modified string. It is probably best
  5733. to ONLY change text properties.
  5734. You can also use this function as a filter, by returning nil for lines
  5735. you don't want to have in the agenda at all. For this application, you
  5736. could bind the variable in the options section of a custom command.")
  5737. (defun org-finalize-agenda-entries (list &optional nosort)
  5738. "Sort and concatenate the agenda items."
  5739. (setq list (mapcar 'org-agenda-highlight-todo list))
  5740. (if nosort
  5741. list
  5742. (when org-agenda-before-sorting-filter-function
  5743. (setq list (delq nil (mapcar org-agenda-before-sorting-filter-function list))))
  5744. (mapconcat 'identity (sort list 'org-entries-lessp) "\n")))
  5745. (defun org-agenda-highlight-todo (x)
  5746. (let ((org-done-keywords org-done-keywords-for-agenda)
  5747. (case-fold-search nil)
  5748. re)
  5749. (if (eq x 'line)
  5750. (save-excursion
  5751. (beginning-of-line 1)
  5752. (setq re (org-get-at-bol 'org-todo-regexp))
  5753. (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
  5754. (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
  5755. (add-text-properties (match-beginning 0) (match-end 1)
  5756. (list 'face (org-get-todo-face 1)))
  5757. (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
  5758. (delete-region (match-beginning 1) (1- (match-end 0)))
  5759. (goto-char (match-beginning 1))
  5760. (insert (format org-agenda-todo-keyword-format s)))))
  5761. (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
  5762. (setq re (get-text-property 0 'org-todo-regexp x))
  5763. (when (and re
  5764. ;; Test `pl' because if there's no heading content,
  5765. ;; there's no point matching to highlight. Note
  5766. ;; that if we didn't test `pl' first, and there
  5767. ;; happened to be no keyword from `org-todo-regexp'
  5768. ;; on this heading line, then the `equal' comparison
  5769. ;; afterwards would spuriously succeed in the case
  5770. ;; where `pl' is nil -- causing an args-out-of-range
  5771. ;; error when we try to add text properties to text
  5772. ;; that isn't there.
  5773. pl
  5774. (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
  5775. x pl) pl))
  5776. (add-text-properties
  5777. (or (match-end 1) (match-end 0)) (match-end 0)
  5778. (list 'face (org-get-todo-face (match-string 2 x)))
  5779. x)
  5780. (when (match-end 1)
  5781. (setq x (concat (substring x 0 (match-end 1))
  5782. (format org-agenda-todo-keyword-format
  5783. (match-string 2 x))
  5784. (org-add-props " " (text-properties-at 0 x))
  5785. (substring x (match-end 3)))))))
  5786. x)))
  5787. (defsubst org-cmp-priority (a b)
  5788. "Compare the priorities of string A and B."
  5789. (let ((pa (or (get-text-property 1 'priority a) 0))
  5790. (pb (or (get-text-property 1 'priority b) 0)))
  5791. (cond ((> pa pb) +1)
  5792. ((< pa pb) -1))))
  5793. (defsubst org-cmp-effort (a b)
  5794. "Compare the effort values of string A and B."
  5795. (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
  5796. (ea (or (get-text-property 1 'effort-minutes a) def))
  5797. (eb (or (get-text-property 1 'effort-minutes b) def)))
  5798. (cond ((> ea eb) +1)
  5799. ((< ea eb) -1))))
  5800. (defsubst org-cmp-category (a b)
  5801. "Compare the string values of categories of strings A and B."
  5802. (let ((ca (or (get-text-property 1 'org-category a) ""))
  5803. (cb (or (get-text-property 1 'org-category b) "")))
  5804. (cond ((string-lessp ca cb) -1)
  5805. ((string-lessp cb ca) +1))))
  5806. (defsubst org-cmp-todo-state (a b)
  5807. "Compare the todo states of strings A and B."
  5808. (let* ((ma (or (get-text-property 1 'org-marker a)
  5809. (get-text-property 1 'org-hd-marker a)))
  5810. (mb (or (get-text-property 1 'org-marker b)
  5811. (get-text-property 1 'org-hd-marker b)))
  5812. (fa (and ma (marker-buffer ma)))
  5813. (fb (and mb (marker-buffer mb)))
  5814. (todo-kwds
  5815. (or (and fa (with-current-buffer fa org-todo-keywords-1))
  5816. (and fb (with-current-buffer fb org-todo-keywords-1))))
  5817. (ta (or (get-text-property 1 'todo-state a) ""))
  5818. (tb (or (get-text-property 1 'todo-state b) ""))
  5819. (la (- (length (member ta todo-kwds))))
  5820. (lb (- (length (member tb todo-kwds))))
  5821. (donepa (member ta org-done-keywords-for-agenda))
  5822. (donepb (member tb org-done-keywords-for-agenda)))
  5823. (cond ((and donepa (not donepb)) -1)
  5824. ((and (not donepa) donepb) +1)
  5825. ((< la lb) -1)
  5826. ((< lb la) +1))))
  5827. (defsubst org-cmp-alpha (a b)
  5828. "Compare the headlines, alphabetically."
  5829. (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
  5830. (plb (text-property-any 0 (length b) 'org-heading t b))
  5831. (ta (and pla (substring a pla)))
  5832. (tb (and plb (substring b plb))))
  5833. (when pla
  5834. (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
  5835. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
  5836. (setq ta (substring ta (match-end 0))))
  5837. (setq ta (downcase ta)))
  5838. (when plb
  5839. (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
  5840. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
  5841. (setq tb (substring tb (match-end 0))))
  5842. (setq tb (downcase tb)))
  5843. (cond ((not ta) +1)
  5844. ((not tb) -1)
  5845. ((string-lessp ta tb) -1)
  5846. ((string-lessp tb ta) +1))))
  5847. (defsubst org-cmp-tag (a b)
  5848. "Compare the string values of the first tags of A and B."
  5849. (let ((ta (car (last (get-text-property 1 'tags a))))
  5850. (tb (car (last (get-text-property 1 'tags b)))))
  5851. (cond ((not ta) +1)
  5852. ((not tb) -1)
  5853. ((string-lessp ta tb) -1)
  5854. ((string-lessp tb ta) +1))))
  5855. (defsubst org-cmp-time (a b)
  5856. "Compare the time-of-day values of strings A and B."
  5857. (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
  5858. (ta (or (get-text-property 1 'time-of-day a) def))
  5859. (tb (or (get-text-property 1 'time-of-day b) def)))
  5860. (cond ((< ta tb) -1)
  5861. ((< tb ta) +1))))
  5862. (defsubst org-cmp-habit-p (a b)
  5863. "Compare the todo states of strings A and B."
  5864. (let ((ha (get-text-property 1 'org-habit-p a))
  5865. (hb (get-text-property 1 'org-habit-p b)))
  5866. (cond ((and ha (not hb)) -1)
  5867. ((and (not ha) hb) +1))))
  5868. (defsubst org-em (x y list) (or (memq x list) (memq y list)))
  5869. (defun org-entries-lessp (a b)
  5870. "Predicate for sorting agenda entries."
  5871. ;; The following variables will be used when the form is evaluated.
  5872. ;; So even though the compiler complains, keep them.
  5873. (let* ((ss org-agenda-sorting-strategy-selected)
  5874. (time-up (and (org-em 'time-up 'time-down ss)
  5875. (org-cmp-time a b)))
  5876. (time-down (if time-up (- time-up) nil))
  5877. (priority-up (and (org-em 'priority-up 'priority-down ss)
  5878. (org-cmp-priority a b)))
  5879. (priority-down (if priority-up (- priority-up) nil))
  5880. (effort-up (and (org-em 'effort-up 'effort-down ss)
  5881. (org-cmp-effort a b)))
  5882. (effort-down (if effort-up (- effort-up) nil))
  5883. (category-up (and (or (org-em 'category-up 'category-down ss)
  5884. (memq 'category-keep ss))
  5885. (org-cmp-category a b)))
  5886. (category-down (if category-up (- category-up) nil))
  5887. (category-keep (if category-up +1 nil))
  5888. (tag-up (and (org-em 'tag-up 'tag-down ss)
  5889. (org-cmp-tag a b)))
  5890. (tag-down (if tag-up (- tag-up) nil))
  5891. (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
  5892. (org-cmp-todo-state a b)))
  5893. (todo-state-down (if todo-state-up (- todo-state-up) nil))
  5894. (habit-up (and (org-em 'habit-up 'habit-down ss)
  5895. (org-cmp-habit-p a b)))
  5896. (habit-down (if habit-up (- habit-up) nil))
  5897. (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
  5898. (org-cmp-alpha a b)))
  5899. (alpha-down (if alpha-up (- alpha-up) nil))
  5900. (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
  5901. user-defined-up user-defined-down)
  5902. (if (and need-user-cmp org-agenda-cmp-user-defined
  5903. (functionp org-agenda-cmp-user-defined))
  5904. (setq user-defined-up
  5905. (funcall org-agenda-cmp-user-defined a b)
  5906. user-defined-down (if user-defined-up (- user-defined-up) nil)))
  5907. (cdr (assoc
  5908. (eval (cons 'or org-agenda-sorting-strategy-selected))
  5909. '((-1 . t) (1 . nil) (nil . nil))))))
  5910. ;;; Agenda restriction lock
  5911. (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
  5912. "Overlay to mark the headline to which agenda commands are restricted.")
  5913. (overlay-put org-agenda-restriction-lock-overlay
  5914. 'face 'org-agenda-restriction-lock)
  5915. (overlay-put org-agenda-restriction-lock-overlay
  5916. 'help-echo "Agendas are currently limited to this subtree.")
  5917. (org-detach-overlay org-agenda-restriction-lock-overlay)
  5918. (defun org-agenda-set-restriction-lock (&optional type)
  5919. "Set restriction lock for agenda, to current subtree or file.
  5920. Restriction will be the file if TYPE is `file', or if type is the
  5921. universal prefix '(4), or if the cursor is before the first headline
  5922. in the file. Otherwise, restriction will be to the current subtree."
  5923. (interactive "P")
  5924. (and (equal type '(4)) (setq type 'file))
  5925. (setq type (cond
  5926. (type type)
  5927. ((org-at-heading-p) 'subtree)
  5928. ((condition-case nil (org-back-to-heading t) (error nil))
  5929. 'subtree)
  5930. (t 'file)))
  5931. (if (eq type 'subtree)
  5932. (progn
  5933. (setq org-agenda-restrict t)
  5934. (setq org-agenda-overriding-restriction 'subtree)
  5935. (put 'org-agenda-files 'org-restrict
  5936. (list (buffer-file-name (buffer-base-buffer))))
  5937. (org-back-to-heading t)
  5938. (move-overlay org-agenda-restriction-lock-overlay (point) (point-at-eol))
  5939. (move-marker org-agenda-restrict-begin (point))
  5940. (move-marker org-agenda-restrict-end
  5941. (save-excursion (org-end-of-subtree t)))
  5942. (message "Locking agenda restriction to subtree"))
  5943. (put 'org-agenda-files 'org-restrict
  5944. (list (buffer-file-name (buffer-base-buffer))))
  5945. (setq org-agenda-restrict nil)
  5946. (setq org-agenda-overriding-restriction 'file)
  5947. (move-marker org-agenda-restrict-begin nil)
  5948. (move-marker org-agenda-restrict-end nil)
  5949. (message "Locking agenda restriction to file"))
  5950. (setq current-prefix-arg nil)
  5951. (org-agenda-maybe-redo))
  5952. (defun org-agenda-remove-restriction-lock (&optional noupdate)
  5953. "Remove the agenda restriction lock."
  5954. (interactive "P")
  5955. (org-detach-overlay org-agenda-restriction-lock-overlay)
  5956. (org-detach-overlay org-speedbar-restriction-lock-overlay)
  5957. (setq org-agenda-overriding-restriction nil)
  5958. (setq org-agenda-restrict nil)
  5959. (put 'org-agenda-files 'org-restrict nil)
  5960. (move-marker org-agenda-restrict-begin nil)
  5961. (move-marker org-agenda-restrict-end nil)
  5962. (setq current-prefix-arg nil)
  5963. (message "Agenda restriction lock removed")
  5964. (or noupdate (org-agenda-maybe-redo)))
  5965. (defun org-agenda-maybe-redo ()
  5966. "If there is any window showing the agenda view, update it."
  5967. (let ((w (get-buffer-window org-agenda-buffer-name t))
  5968. (w0 (selected-window)))
  5969. (when w
  5970. (select-window w)
  5971. (org-agenda-redo)
  5972. (select-window w0)
  5973. (if org-agenda-overriding-restriction
  5974. (message "Agenda view shifted to new %s restriction"
  5975. org-agenda-overriding-restriction)
  5976. (message "Agenda restriction lock removed")))))
  5977. ;;; Agenda commands
  5978. (defun org-agenda-check-type (error &rest types)
  5979. "Check if agenda buffer is of allowed type.
  5980. If ERROR is non-nil, throw an error, otherwise just return nil."
  5981. (if (not org-agenda-type)
  5982. (error "No Org agenda currently displayed")
  5983. (if (memq org-agenda-type types)
  5984. t
  5985. (if error
  5986. (error "Not allowed in %s-type agenda buffers" org-agenda-type)
  5987. nil))))
  5988. (defun org-agenda-Quit (&optional arg)
  5989. "Exit agenda by removing the window or the buffer."
  5990. (interactive)
  5991. (if org-agenda-columns-active
  5992. (org-columns-quit)
  5993. (let ((buf (current-buffer)))
  5994. (if (eq org-agenda-window-setup 'other-frame)
  5995. (progn
  5996. (org-agenda-reset-markers)
  5997. (kill-buffer buf)
  5998. (org-columns-remove-overlays)
  5999. (setq org-agenda-archives-mode nil)
  6000. (delete-frame))
  6001. (and (not (eq org-agenda-window-setup 'current-window))
  6002. (not (one-window-p))
  6003. (delete-window))
  6004. (org-agenda-reset-markers)
  6005. (kill-buffer buf)
  6006. (org-columns-remove-overlays)
  6007. (setq org-agenda-archives-mode nil)))
  6008. ;; Maybe restore the pre-agenda window configuration.
  6009. (and org-agenda-restore-windows-after-quit
  6010. (not (eq org-agenda-window-setup 'other-frame))
  6011. org-pre-agenda-window-conf
  6012. (set-window-configuration org-pre-agenda-window-conf))))
  6013. (defun org-agenda-quit ()
  6014. "Exit agenda by killing agenda buffer or burying it when
  6015. `org-agenda-sticky' is non-NIL"
  6016. (interactive)
  6017. (if org-agenda-columns-active
  6018. (org-columns-quit)
  6019. (if org-agenda-sticky
  6020. (let ((buf (current-buffer)))
  6021. (if (eq org-agenda-window-setup 'other-frame)
  6022. (progn
  6023. (delete-frame))
  6024. (and (not (eq org-agenda-window-setup 'current-window))
  6025. (not (one-window-p))
  6026. (delete-window)))
  6027. (with-current-buffer buf
  6028. (bury-buffer)
  6029. ;; Maybe restore the pre-agenda window configuration.
  6030. (and org-agenda-restore-windows-after-quit
  6031. (not (eq org-agenda-window-setup 'other-frame))
  6032. org-pre-agenda-window-conf
  6033. (set-window-configuration org-pre-agenda-window-conf))))
  6034. (org-agenda-Quit))))
  6035. (defun org-agenda-exit ()
  6036. "Exit agenda by removing the window or the buffer.
  6037. Also kill all Org-mode buffers which have been loaded by `org-agenda'.
  6038. Org-mode buffers visited directly by the user will not be touched."
  6039. (interactive)
  6040. (org-release-buffers org-agenda-new-buffers)
  6041. (setq org-agenda-new-buffers nil)
  6042. (org-agenda-Quit))
  6043. (defun org-agenda-kill-all-agenda-buffers ()
  6044. "Kill all buffers in `org-agena-mode'.
  6045. This is used when toggling sticky agendas. You can also explicitly invoke it
  6046. with `C-c a C-k'."
  6047. (interactive)
  6048. (let (blist)
  6049. (dolist (buf (buffer-list))
  6050. (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
  6051. (push buf blist)))
  6052. (mapc 'kill-buffer blist)))
  6053. (defun org-agenda-execute (arg)
  6054. "Execute another agenda command, keeping same window.
  6055. So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
  6056. in the agenda."
  6057. (interactive "P")
  6058. (let ((org-agenda-window-setup 'current-window))
  6059. (org-agenda arg)))
  6060. (defun org-agenda-redo ()
  6061. "Rebuild Agenda.
  6062. When this is the global TODO list, a prefix argument will be interpreted."
  6063. (interactive)
  6064. (let* ((org-agenda-doing-sticky-redo org-agenda-sticky)
  6065. (org-agenda-sticky nil)
  6066. (org-agenda-buffer-name (or org-agenda-this-buffer-name
  6067. org-agenda-buffer-name))
  6068. (org-agenda-keep-modes t)
  6069. (tag-filter org-agenda-tag-filter)
  6070. (tag-preset (get 'org-agenda-tag-filter :preset-filter))
  6071. (top-cat-filter org-agenda-top-category-filter)
  6072. (cat-filter org-agenda-category-filter)
  6073. (cat-preset (get 'org-agenda-category-filter :preset-filter))
  6074. (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
  6075. (cols org-agenda-columns-active)
  6076. (line (org-current-line))
  6077. (window-line (- line (org-current-line (window-start))))
  6078. (lprops (get 'org-agenda-redo-command 'org-lprops)))
  6079. (put 'org-agenda-tag-filter :preset-filter nil)
  6080. (put 'org-agenda-category-filter :preset-filter nil)
  6081. (and cols (org-columns-quit))
  6082. (message "Rebuilding agenda buffer...")
  6083. (org-let lprops '(eval org-agenda-redo-command))
  6084. (setq org-agenda-undo-list nil
  6085. org-agenda-pending-undo-list nil)
  6086. (message "Rebuilding agenda buffer...done")
  6087. (put 'org-agenda-tag-filter :preset-filter tag-preset)
  6088. (put 'org-agenda-category-filter :preset-filter cat-preset)
  6089. (and (or tag-filter tag-preset) (org-agenda-filter-apply tag-filter 'tag))
  6090. (and (or cat-filter cat-preset) (org-agenda-filter-apply cat-filter 'category))
  6091. (and top-cat-filter (org-agenda-filter-top-category-apply top-cat-filter))
  6092. (and cols (org-called-interactively-p 'any) (org-agenda-columns))
  6093. (org-goto-line line)
  6094. (recenter window-line)))
  6095. (defvar org-global-tags-completion-table nil)
  6096. (defvar org-agenda-filter-form nil)
  6097. (defvar org-agenda-filtered-by-category nil)
  6098. (defun org-agenda-filter-by-category (strip)
  6099. "Keep only those lines in the agenda buffer that have a specific category.
  6100. The category is that of the current line."
  6101. (interactive "P")
  6102. (if (and org-agenda-filtered-by-category
  6103. org-agenda-category-filter)
  6104. (org-agenda-filter-show-all-cat)
  6105. (let ((cat (org-no-properties (get-text-property (point) 'org-category))))
  6106. (if cat (org-agenda-filter-apply
  6107. (list (concat (if strip "-" "+") cat)) 'category)
  6108. (error "No category at point")))))
  6109. (defun org-find-top-category (&optional pos)
  6110. (save-excursion
  6111. (with-current-buffer (if pos (marker-buffer pos) (current-buffer))
  6112. (if pos (goto-char pos))
  6113. ;; Skip up to the topmost parent
  6114. (while (ignore-errors (outline-up-heading 1) t))
  6115. (ignore-errors
  6116. (nth 4 (org-heading-components))))))
  6117. (defvar org-agenda-filtered-by-top-category nil)
  6118. (defun org-agenda-filter-by-top-category (strip)
  6119. "Keep only those lines in the agenda buffer that have a specific category.
  6120. The category is that of the current line."
  6121. (interactive "P")
  6122. (if org-agenda-filtered-by-top-category
  6123. (progn
  6124. (setq org-agenda-filtered-by-top-category nil
  6125. org-agenda-top-category-filter nil)
  6126. (org-agenda-filter-show-all-cat))
  6127. (let ((cat (org-find-top-category (org-get-at-bol 'org-hd-marker))))
  6128. (if cat (org-agenda-filter-top-category-apply cat strip)
  6129. (error "No top-level category at point")))))
  6130. (defun org-agenda-filter-by-tag (strip &optional char narrow)
  6131. "Keep only those lines in the agenda buffer that have a specific tag.
  6132. The tag is selected with its fast selection letter, as configured.
  6133. With prefix argument STRIP, remove all lines that do have the tag.
  6134. A lisp caller can specify CHAR. NARROW means that the new tag should be
  6135. used to narrow the search - the interactive user can also press `-' or `+'
  6136. to switch to narrowing."
  6137. (interactive "P")
  6138. (let* ((alist org-tag-alist-for-agenda)
  6139. (tag-chars (mapconcat
  6140. (lambda (x) (if (and (not (symbolp (car x)))
  6141. (cdr x))
  6142. (char-to-string (cdr x))
  6143. ""))
  6144. alist ""))
  6145. (efforts (org-split-string
  6146. (or (cdr (assoc (concat org-effort-property "_ALL")
  6147. org-global-properties))
  6148. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00"
  6149. "")))
  6150. (effort-op org-agenda-filter-effort-default-operator)
  6151. (effort-prompt "")
  6152. (inhibit-read-only t)
  6153. (current org-agenda-tag-filter)
  6154. maybe-refresh a n tag)
  6155. (unless char
  6156. (message
  6157. "%s by tag [%s ], [TAB], %s[/]:off, [+-]:narrow, [>=<?]:effort: "
  6158. (if narrow "Narrow" "Filter") tag-chars
  6159. (if org-agenda-auto-exclude-function "[RET], " ""))
  6160. (setq char (read-char-exclusive)))
  6161. (when (member char '(?+ ?-))
  6162. ;; Narrowing down
  6163. (cond ((equal char ?-) (setq strip t narrow t))
  6164. ((equal char ?+) (setq strip nil narrow t)))
  6165. (message
  6166. "Narrow by tag [%s ], [TAB], [/]:off, [>=<]:effort: " tag-chars)
  6167. (setq char (read-char-exclusive)))
  6168. (when (member char '(?< ?> ?= ??))
  6169. ;; An effort operator
  6170. (setq effort-op (char-to-string char))
  6171. (setq alist nil) ; to make sure it will be interpreted as effort.
  6172. (unless (equal char ??)
  6173. (loop for i from 0 to 9 do
  6174. (setq effort-prompt
  6175. (concat
  6176. effort-prompt " ["
  6177. (if (= i 9) "0" (int-to-string (1+ i)))
  6178. "]" (nth i efforts))))
  6179. (message "Effort%s: %s " effort-op effort-prompt)
  6180. (setq char (read-char-exclusive))
  6181. (when (or (< char ?0) (> char ?9))
  6182. (error "Need 1-9,0 to select effort"))))
  6183. (when (equal char ?\t)
  6184. (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
  6185. (org-set-local 'org-global-tags-completion-table
  6186. (org-global-tags-completion-table)))
  6187. (let ((completion-ignore-case t))
  6188. (setq tag (org-icompleting-read
  6189. "Tag: " org-global-tags-completion-table))))
  6190. (cond
  6191. ((equal char ?\r)
  6192. (org-agenda-filter-show-all-tag)
  6193. (when org-agenda-auto-exclude-function
  6194. (setq org-agenda-tag-filter '())
  6195. (dolist (tag (org-agenda-get-represented-tags))
  6196. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  6197. (if modifier
  6198. (push modifier org-agenda-tag-filter))))
  6199. (if (not (null org-agenda-tag-filter))
  6200. (org-agenda-filter-apply org-agenda-tag-filter 'tag)))
  6201. (setq maybe-refresh t))
  6202. ((equal char ?/)
  6203. (org-agenda-filter-show-all-tag)
  6204. (when (get 'org-agenda-tag-filter :preset-filter)
  6205. (org-agenda-filter-apply org-agenda-tag-filter 'tag))
  6206. (setq maybe-refresh t))
  6207. ((equal char ?. )
  6208. (setq org-agenda-tag-filter
  6209. (mapcar (lambda(tag) (concat "+" tag))
  6210. (org-get-at-bol 'tags)))
  6211. (org-agenda-filter-apply org-agenda-tag-filter 'tag)
  6212. (setq maybe-refresh t))
  6213. ((or (equal char ?\ )
  6214. (setq a (rassoc char alist))
  6215. (and (>= char ?0) (<= char ?9)
  6216. (setq n (if (= char ?0) 9 (- char ?0 1))
  6217. tag (concat effort-op (nth n efforts))
  6218. a (cons tag nil)))
  6219. (and (= char ??)
  6220. (setq tag "?eff")
  6221. a (cons tag nil))
  6222. (and tag (setq a (cons tag nil))))
  6223. (org-agenda-filter-show-all-tag)
  6224. (setq tag (car a))
  6225. (setq org-agenda-tag-filter
  6226. (cons (concat (if strip "-" "+") tag)
  6227. (if narrow current nil)))
  6228. (org-agenda-filter-apply org-agenda-tag-filter 'tag)
  6229. (setq maybe-refresh t))
  6230. (t (error "Invalid tag selection character %c" char)))
  6231. (when (and maybe-refresh
  6232. (eq org-agenda-clockreport-mode 'with-filter))
  6233. (org-agenda-redo))))
  6234. (defun org-agenda-get-represented-tags ()
  6235. "Get a list of all tags currently represented in the agenda."
  6236. (let (p tags)
  6237. (save-excursion
  6238. (goto-char (point-min))
  6239. (while (setq p (next-single-property-change (point) 'tags))
  6240. (goto-char p)
  6241. (mapc (lambda (x) (add-to-list 'tags x))
  6242. (get-text-property (point) 'tags))))
  6243. tags))
  6244. (defun org-agenda-filter-by-tag-refine (strip &optional char)
  6245. "Refine the current filter. See `org-agenda-filter-by-tag'."
  6246. (interactive "P")
  6247. (org-agenda-filter-by-tag strip char 'refine))
  6248. (defun org-agenda-filter-make-matcher ()
  6249. "Create the form that tests a line for agenda filter."
  6250. (let (f f1)
  6251. ;; first compute the tag-filter matcher
  6252. (dolist (x (delete-dups
  6253. (append (get 'org-agenda-tag-filter
  6254. :preset-filter) org-agenda-tag-filter)))
  6255. (if (member x '("-" "+"))
  6256. (setq f1 (if (equal x "-") 'tags '(not tags)))
  6257. (if (string-match "[<=>?]" x)
  6258. (setq f1 (org-agenda-filter-effort-form x))
  6259. (setq f1 (list 'member (downcase (substring x 1)) 'tags)))
  6260. (if (equal (string-to-char x) ?-)
  6261. (setq f1 (list 'not f1))))
  6262. (push f1 f))
  6263. ;; then compute the category-filter matcher
  6264. (dolist (x (delete-dups
  6265. (append (get 'org-agenda-category-filter
  6266. :preset-filter) org-agenda-category-filter)))
  6267. (if (equal "-" (substring x 0 1))
  6268. (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
  6269. (setq f1 (list 'equal (substring x 1) 'cat)))
  6270. (push f1 f))
  6271. (cons 'and (nreverse f))))
  6272. (defun org-agenda-filter-effort-form (e)
  6273. "Return the form to compare the effort of the current line with what E says.
  6274. E looks like \"+<2:25\"."
  6275. (let (op)
  6276. (setq e (substring e 1))
  6277. (setq op (string-to-char e) e (substring e 1))
  6278. (setq op (cond ((equal op ?<) '<=)
  6279. ((equal op ?>) '>=)
  6280. ((equal op ??) op)
  6281. (t '=)))
  6282. (list 'org-agenda-compare-effort (list 'quote op)
  6283. (org-duration-string-to-minutes e))))
  6284. (defun org-agenda-compare-effort (op value)
  6285. "Compare the effort of the current line with VALUE, using OP.
  6286. If the line does not have an effort defined, return nil."
  6287. (let ((eff (org-get-at-bol 'effort-minutes)))
  6288. (if (equal op ??)
  6289. (not eff)
  6290. (funcall op (or eff (if org-sort-agenda-noeffort-is-high 32767 0))
  6291. value))))
  6292. (defun org-agenda-filter-apply (filter type)
  6293. "Set FILTER as the new agenda filter and apply it."
  6294. (let (tags cat)
  6295. (if (eq type 'tag)
  6296. (setq org-agenda-tag-filter filter)
  6297. (setq org-agenda-category-filter filter))
  6298. (setq org-agenda-filter-form (org-agenda-filter-make-matcher))
  6299. (if (and (eq type 'category)
  6300. (not (equal (substring (car filter) 0 1) "-")))
  6301. ;; Only set `org-agenda-filtered-by-category' to t
  6302. ;; when a unique category is used as the filter
  6303. (setq org-agenda-filtered-by-category t))
  6304. (org-agenda-set-mode-name)
  6305. (save-excursion
  6306. (goto-char (point-min))
  6307. (while (not (eobp))
  6308. (if (org-get-at-bol 'org-marker)
  6309. (progn
  6310. (setq tags (org-get-at-bol 'tags) ; used in eval
  6311. cat (get-text-property (point) 'org-category))
  6312. (if (not (eval org-agenda-filter-form))
  6313. (org-agenda-filter-hide-line type))
  6314. (beginning-of-line 2))
  6315. (beginning-of-line 2))))
  6316. (if (get-char-property (point) 'invisible)
  6317. (ignore-errors (org-agenda-previous-line)))))
  6318. (defun org-agenda-filter-top-category-apply (category &optional negative)
  6319. "Set FILTER as the new agenda filter and apply it."
  6320. (org-agenda-set-mode-name)
  6321. (save-excursion
  6322. (goto-char (point-min))
  6323. (while (not (eobp))
  6324. (let* ((pos (org-get-at-bol 'org-hd-marker))
  6325. (topcat (and pos (org-find-top-category pos))))
  6326. (if (and topcat (funcall (if negative 'identity 'not)
  6327. (string= category topcat)))
  6328. (org-agenda-filter-hide-line 'category)))
  6329. (beginning-of-line 2)))
  6330. (if (get-char-property (point) 'invisible)
  6331. (org-agenda-previous-line))
  6332. (setq org-agenda-top-category-filter category
  6333. org-agenda-filtered-by-top-category t))
  6334. (defun org-agenda-filter-hide-line (type)
  6335. (let (ov)
  6336. (setq ov (make-overlay (max (point-min) (1- (point-at-bol)))
  6337. (point-at-eol)))
  6338. (overlay-put ov 'invisible t)
  6339. (overlay-put ov 'type type)
  6340. (if (eq type 'tag)
  6341. (push ov org-agenda-tag-filter-overlays)
  6342. (push ov org-agenda-cat-filter-overlays))))
  6343. (defun org-agenda-fix-tags-filter-overlays-at (&optional pos)
  6344. (setq pos (or pos (point)))
  6345. (save-excursion
  6346. (dolist (ov (overlays-at pos))
  6347. (when (and (overlay-get ov 'invisible)
  6348. (eq (overlay-get ov 'type) 'tag))
  6349. (goto-char pos)
  6350. (if (< (overlay-start ov) (point-at-eol))
  6351. (move-overlay ov (point-at-eol)
  6352. (overlay-end ov)))))))
  6353. (defun org-agenda-filter-show-all-tag nil
  6354. (mapc 'delete-overlay org-agenda-tag-filter-overlays)
  6355. (setq org-agenda-tag-filter-overlays nil
  6356. org-agenda-tag-filter nil
  6357. org-agenda-filter-form nil)
  6358. (org-agenda-set-mode-name))
  6359. (defun org-agenda-filter-show-all-cat nil
  6360. (mapc 'delete-overlay org-agenda-cat-filter-overlays)
  6361. (setq org-agenda-cat-filter-overlays nil
  6362. org-agenda-filtered-by-category nil
  6363. org-agenda-category-filter nil
  6364. org-agenda-filter-form nil)
  6365. (org-agenda-set-mode-name))
  6366. (defun org-agenda-manipulate-query-add ()
  6367. "Manipulate the query by adding a search term with positive selection.
  6368. Positive selection means the term must be matched for selection of an entry."
  6369. (interactive)
  6370. (org-agenda-manipulate-query ?\[))
  6371. (defun org-agenda-manipulate-query-subtract ()
  6372. "Manipulate the query by adding a search term with negative selection.
  6373. Negative selection means term must not be matched for selection of an entry."
  6374. (interactive)
  6375. (org-agenda-manipulate-query ?\]))
  6376. (defun org-agenda-manipulate-query-add-re ()
  6377. "Manipulate the query by adding a search regexp with positive selection.
  6378. Positive selection means the regexp must match for selection of an entry."
  6379. (interactive)
  6380. (org-agenda-manipulate-query ?\{))
  6381. (defun org-agenda-manipulate-query-subtract-re ()
  6382. "Manipulate the query by adding a search regexp with negative selection.
  6383. Negative selection means regexp must not match for selection of an entry."
  6384. (interactive)
  6385. (org-agenda-manipulate-query ?\}))
  6386. (defun org-agenda-manipulate-query (char)
  6387. (cond
  6388. ((memq org-agenda-type '(timeline agenda))
  6389. (let ((org-agenda-include-inactive-timestamps t))
  6390. (org-agenda-redo))
  6391. (message "Display now includes inactive timestamps as well"))
  6392. ((eq org-agenda-type 'search)
  6393. (org-add-to-string
  6394. 'org-agenda-query-string
  6395. (if org-agenda-last-search-view-search-was-boolean
  6396. (cdr (assoc char '((?\[ . " +") (?\] . " -")
  6397. (?\{ . " +{}") (?\} . " -{}"))))
  6398. " "))
  6399. (setq org-agenda-redo-command
  6400. (list 'org-search-view
  6401. org-todo-only
  6402. org-agenda-query-string
  6403. (+ (length org-agenda-query-string)
  6404. (if (member char '(?\{ ?\})) 0 1))))
  6405. (set-register org-agenda-query-register org-agenda-query-string)
  6406. (org-agenda-redo))
  6407. (t (error "Cannot manipulate query for %s-type agenda buffers"
  6408. org-agenda-type))))
  6409. (defun org-add-to-string (var string)
  6410. (set var (concat (symbol-value var) string)))
  6411. (defun org-agenda-goto-date (date)
  6412. "Jump to DATE in agenda."
  6413. (interactive (list (let ((org-read-date-prefer-future
  6414. (eval org-agenda-jump-prefer-future)))
  6415. (org-read-date))))
  6416. (org-agenda-list nil date))
  6417. (defun org-agenda-goto-today ()
  6418. "Go to today."
  6419. (interactive)
  6420. (org-agenda-check-type t 'timeline 'agenda)
  6421. (let ((tdpos (text-property-any (point-min) (point-max) 'org-today t)))
  6422. (cond
  6423. (tdpos (goto-char tdpos))
  6424. ((eq org-agenda-type 'agenda)
  6425. (let* ((sd (org-agenda-compute-starting-span
  6426. (org-today) (or org-agenda-current-span org-agenda-ndays org-agenda-span)))
  6427. (org-agenda-overriding-arguments org-agenda-last-arguments))
  6428. (setf (nth 1 org-agenda-overriding-arguments) sd)
  6429. (org-agenda-redo)
  6430. (org-agenda-find-same-or-today-or-agenda)))
  6431. (t (error "Cannot find today")))))
  6432. (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
  6433. (goto-char
  6434. (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
  6435. (text-property-any (point-min) (point-max) 'org-today t)
  6436. (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
  6437. (point-min))))
  6438. (defun org-agenda-later (arg)
  6439. "Go forward in time by thee current span.
  6440. With prefix ARG, go forward that many times the current span."
  6441. (interactive "p")
  6442. (org-agenda-check-type t 'agenda)
  6443. (let* ((span org-agenda-current-span)
  6444. (sd org-starting-day)
  6445. (greg (calendar-gregorian-from-absolute sd))
  6446. (cnt (org-get-at-bol 'org-day-cnt))
  6447. greg2)
  6448. (cond
  6449. ((eq span 'day)
  6450. (setq sd (+ arg sd)))
  6451. ((eq span 'week)
  6452. (setq sd (+ (* 7 arg) sd)))
  6453. ((eq span 'month)
  6454. (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
  6455. sd (calendar-absolute-from-gregorian greg2))
  6456. (setcar greg2 (1+ (car greg2))))
  6457. ((eq span 'year)
  6458. (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
  6459. sd (calendar-absolute-from-gregorian greg2))
  6460. (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
  6461. (t
  6462. (setq sd (+ (* span arg) sd))))
  6463. (let ((org-agenda-overriding-arguments
  6464. (list (car org-agenda-last-arguments) sd span t)))
  6465. (org-agenda-redo)
  6466. (org-agenda-find-same-or-today-or-agenda cnt))))
  6467. (defun org-agenda-earlier (arg)
  6468. "Go backward in time by the current span.
  6469. With prefix ARG, go backward that many times the current span."
  6470. (interactive "p")
  6471. (org-agenda-later (- arg)))
  6472. (defun org-agenda-view-mode-dispatch ()
  6473. "Call one of the view mode commands."
  6474. (interactive)
  6475. (message "View: [d]ay [w]eek [m]onth [y]ear [SPC]reset [q]uit/abort
  6476. time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
  6477. [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
  6478. (let ((a (read-char-exclusive)))
  6479. (case a
  6480. (?\ (call-interactively 'org-agenda-reset-view))
  6481. (?d (call-interactively 'org-agenda-day-view))
  6482. (?w (call-interactively 'org-agenda-week-view))
  6483. (?m (call-interactively 'org-agenda-month-view))
  6484. (?y (call-interactively 'org-agenda-year-view))
  6485. (?l (call-interactively 'org-agenda-log-mode))
  6486. (?L (org-agenda-log-mode '(4)))
  6487. (?c (org-agenda-log-mode 'clockcheck))
  6488. ((?F ?f) (call-interactively 'org-agenda-follow-mode))
  6489. (?a (call-interactively 'org-agenda-archives-mode))
  6490. (?A (org-agenda-archives-mode 'files))
  6491. ((?R ?r) (call-interactively 'org-agenda-clockreport-mode))
  6492. ((?E ?e) (call-interactively 'org-agenda-entry-text-mode))
  6493. (?G (call-interactively 'org-agenda-toggle-time-grid))
  6494. (?D (call-interactively 'org-agenda-toggle-diary))
  6495. (?\! (call-interactively 'org-agenda-toggle-deadlines))
  6496. (?\[ (let ((org-agenda-include-inactive-timestamps t))
  6497. (org-agenda-check-type t 'timeline 'agenda)
  6498. (org-agenda-redo))
  6499. (message "Display now includes inactive timestamps as well"))
  6500. (?q (message "Abort"))
  6501. (otherwise (error "Invalid key" )))))
  6502. (defun org-agenda-reset-view ()
  6503. "Switch to default view for agenda."
  6504. (interactive)
  6505. (org-agenda-change-time-span (or org-agenda-ndays org-agenda-span)))
  6506. (defun org-agenda-day-view (&optional day-of-year)
  6507. "Switch to daily view for agenda.
  6508. With argument DAY-OF-YEAR, switch to that day of the year."
  6509. (interactive "P")
  6510. (org-agenda-change-time-span 'day day-of-year))
  6511. (defun org-agenda-week-view (&optional iso-week)
  6512. "Switch to daily view for agenda.
  6513. With argument ISO-WEEK, switch to the corresponding ISO week.
  6514. If ISO-WEEK has more then 2 digits, only the last two encode the
  6515. week. Any digits before this encode a year. So 200712 means
  6516. week 12 of year 2007. Years in the range 1938-2037 can also be
  6517. written as 2-digit years."
  6518. (interactive "P")
  6519. (org-agenda-change-time-span 'week iso-week))
  6520. (defun org-agenda-month-view (&optional month)
  6521. "Switch to monthly view for agenda.
  6522. With argument MONTH, switch to that month."
  6523. (interactive "P")
  6524. (org-agenda-change-time-span 'month month))
  6525. (defun org-agenda-year-view (&optional year)
  6526. "Switch to yearly view for agenda.
  6527. With argument YEAR, switch to that year.
  6528. If MONTH has more then 2 digits, only the last two encode the
  6529. month. Any digits before this encode a year. So 200712 means
  6530. December year 2007. Years in the range 1938-2037 can also be
  6531. written as 2-digit years."
  6532. (interactive "P")
  6533. (when year
  6534. (setq year (org-small-year-to-year year)))
  6535. (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
  6536. (org-agenda-change-time-span 'year year)
  6537. (error "Abort")))
  6538. (defun org-agenda-change-time-span (span &optional n)
  6539. "Change the agenda view to SPAN.
  6540. SPAN may be `day', `week', `month', `year'."
  6541. (org-agenda-check-type t 'agenda)
  6542. (if (and (not n) (equal org-agenda-current-span span))
  6543. (error "Viewing span is already \"%s\"" span))
  6544. (let* ((sd (or (org-get-at-bol 'day)
  6545. org-starting-day))
  6546. (sd (org-agenda-compute-starting-span sd span n))
  6547. (org-agenda-overriding-arguments
  6548. (or org-agenda-overriding-arguments
  6549. (list (car org-agenda-last-arguments) sd span t))))
  6550. (org-agenda-redo)
  6551. (org-agenda-find-same-or-today-or-agenda))
  6552. (org-agenda-set-mode-name)
  6553. (message "Switched to %s view" span))
  6554. (defun org-agenda-compute-starting-span (sd span &optional n)
  6555. "Compute starting date for agenda.
  6556. SPAN may be `day', `week', `month', `year'. The return value
  6557. is a cons cell with the starting date and the number of days,
  6558. so that the date SD will be in that range."
  6559. (let* ((greg (calendar-gregorian-from-absolute sd))
  6560. (dg (nth 1 greg))
  6561. (mg (car greg))
  6562. (yg (nth 2 greg)))
  6563. (cond
  6564. ((eq span 'day)
  6565. (when n
  6566. (setq sd (+ (calendar-absolute-from-gregorian
  6567. (list mg 1 yg))
  6568. n -1))))
  6569. ((eq span 'week)
  6570. (let* ((nt (calendar-day-of-week
  6571. (calendar-gregorian-from-absolute sd)))
  6572. (d (if org-agenda-start-on-weekday
  6573. (- nt org-agenda-start-on-weekday)
  6574. 0))
  6575. y1)
  6576. (setq sd (- sd (+ (if (< d 0) 7 0) d)))
  6577. (when n
  6578. (require 'cal-iso)
  6579. (when (> n 99)
  6580. (setq y1 (org-small-year-to-year (/ n 100))
  6581. n (mod n 100)))
  6582. (setq sd
  6583. (calendar-absolute-from-iso
  6584. (list n 1
  6585. (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
  6586. ((eq span 'month)
  6587. (let (y1)
  6588. (when (and n (> n 99))
  6589. (setq y1 (org-small-year-to-year (/ n 100))
  6590. n (mod n 100)))
  6591. (setq sd (calendar-absolute-from-gregorian
  6592. (list (or n mg) 1 (or y1 yg))))))
  6593. ((eq span 'year)
  6594. (setq sd (calendar-absolute-from-gregorian
  6595. (list 1 1 (or n yg))))))
  6596. sd))
  6597. (defun org-agenda-next-date-line (&optional arg)
  6598. "Jump to the next line indicating a date in agenda buffer."
  6599. (interactive "p")
  6600. (org-agenda-check-type t 'agenda 'timeline)
  6601. (beginning-of-line 1)
  6602. ;; This does not work if user makes date format that starts with a blank
  6603. (if (looking-at "^\\S-") (forward-char 1))
  6604. (if (not (re-search-forward "^\\S-" nil t arg))
  6605. (progn
  6606. (backward-char 1)
  6607. (error "No next date after this line in this buffer")))
  6608. (goto-char (match-beginning 0)))
  6609. (defun org-agenda-previous-date-line (&optional arg)
  6610. "Jump to the previous line indicating a date in agenda buffer."
  6611. (interactive "p")
  6612. (org-agenda-check-type t 'agenda 'timeline)
  6613. (beginning-of-line 1)
  6614. (if (not (re-search-backward "^\\S-" nil t arg))
  6615. (error "No previous date before this line in this buffer")))
  6616. ;; Initialize the highlight
  6617. (defvar org-hl (make-overlay 1 1))
  6618. (overlay-put org-hl 'face 'highlight)
  6619. (defun org-highlight (begin end &optional buffer)
  6620. "Highlight a region with overlay."
  6621. (move-overlay org-hl begin end (or buffer (current-buffer))))
  6622. (defun org-unhighlight ()
  6623. "Detach overlay INDEX."
  6624. (org-detach-overlay org-hl))
  6625. ;; FIXME this is currently not used.
  6626. (defun org-highlight-until-next-command (beg end &optional buffer)
  6627. "Move the highlight overlay to BEG/END, remove it before the next command."
  6628. (org-highlight beg end buffer)
  6629. (add-hook 'pre-command-hook 'org-unhighlight-once))
  6630. (defun org-unhighlight-once ()
  6631. "Remove the highlight from its position, and this function from the hook."
  6632. (remove-hook 'pre-command-hook 'org-unhighlight-once)
  6633. (org-unhighlight))
  6634. (defun org-agenda-follow-mode ()
  6635. "Toggle follow mode in an agenda buffer."
  6636. (interactive)
  6637. (setq org-agenda-follow-mode (not org-agenda-follow-mode))
  6638. (org-agenda-set-mode-name)
  6639. (org-agenda-do-context-action)
  6640. (message "Follow mode is %s"
  6641. (if org-agenda-follow-mode "on" "off")))
  6642. (defun org-agenda-entry-text-mode (&optional arg)
  6643. "Toggle entry text mode in an agenda buffer."
  6644. (interactive "P")
  6645. (setq org-agenda-entry-text-mode (or (integerp arg)
  6646. (not org-agenda-entry-text-mode)))
  6647. (org-agenda-entry-text-hide)
  6648. (and org-agenda-entry-text-mode
  6649. (let ((org-agenda-entry-text-maxlines
  6650. (if (integerp arg) arg org-agenda-entry-text-maxlines)))
  6651. (org-agenda-entry-text-show)))
  6652. (org-agenda-set-mode-name)
  6653. (message "Entry text mode is %s. Maximum number of lines is %d"
  6654. (if org-agenda-entry-text-mode "on" "off")
  6655. (if (integerp arg) arg org-agenda-entry-text-maxlines)))
  6656. (defun org-agenda-clockreport-mode (&optional with-filter)
  6657. "Toggle clocktable mode in an agenda buffer.
  6658. With prefix arg WITH-FILTER, make the clocktable respect the current
  6659. agenda filter."
  6660. (interactive "P")
  6661. (org-agenda-check-type t 'agenda)
  6662. (if with-filter
  6663. (setq org-agenda-clockreport-mode 'with-filter)
  6664. (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode)))
  6665. (org-agenda-set-mode-name)
  6666. (org-agenda-redo)
  6667. (message "Clocktable mode is %s"
  6668. (if org-agenda-clockreport-mode "on" "off")))
  6669. (defun org-agenda-log-mode (&optional special)
  6670. "Toggle log mode in an agenda buffer.
  6671. With argument SPECIAL, show all possible log items, not only the ones
  6672. configured in `org-agenda-log-mode-items'.
  6673. With a double `C-u' prefix arg, show *only* log items, nothing else."
  6674. (interactive "P")
  6675. (org-agenda-check-type t 'agenda 'timeline)
  6676. (setq org-agenda-show-log
  6677. (cond
  6678. ((equal special '(16)) 'only)
  6679. ((eq special 'clockcheck)
  6680. (if (eq org-agenda-show-log 'clockcheck)
  6681. nil 'clockcheck))
  6682. (special '(closed clock state))
  6683. (t (not org-agenda-show-log))))
  6684. (org-agenda-set-mode-name)
  6685. (org-agenda-redo)
  6686. (message "Log mode is %s"
  6687. (if org-agenda-show-log "on" "off")))
  6688. (defun org-agenda-archives-mode (&optional with-files)
  6689. "Toggle inclusion of items in trees marked with :ARCHIVE:.
  6690. When called with a prefix argument, include all archive files as well."
  6691. (interactive "P")
  6692. (setq org-agenda-archives-mode
  6693. (if with-files t (if org-agenda-archives-mode nil 'trees)))
  6694. (org-agenda-set-mode-name)
  6695. (org-agenda-redo)
  6696. (message
  6697. "%s"
  6698. (cond
  6699. ((eq org-agenda-archives-mode nil)
  6700. "No archives are included")
  6701. ((eq org-agenda-archives-mode 'trees)
  6702. (format "Trees with :%s: tag are included" org-archive-tag))
  6703. ((eq org-agenda-archives-mode t)
  6704. (format "Trees with :%s: tag and all active archive files are included"
  6705. org-archive-tag)))))
  6706. (defun org-agenda-toggle-diary ()
  6707. "Toggle diary inclusion in an agenda buffer."
  6708. (interactive)
  6709. (org-agenda-check-type t 'agenda)
  6710. (setq org-agenda-include-diary (not org-agenda-include-diary))
  6711. (org-agenda-redo)
  6712. (org-agenda-set-mode-name)
  6713. (message "Diary inclusion turned %s"
  6714. (if org-agenda-include-diary "on" "off")))
  6715. (defun org-agenda-toggle-deadlines ()
  6716. "Toggle inclusion of entries with a deadline in an agenda buffer."
  6717. (interactive)
  6718. (org-agenda-check-type t 'agenda)
  6719. (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
  6720. (org-agenda-redo)
  6721. (org-agenda-set-mode-name)
  6722. (message "Deadlines inclusion turned %s"
  6723. (if org-agenda-include-deadlines "on" "off")))
  6724. (defun org-agenda-toggle-time-grid ()
  6725. "Toggle time grid in an agenda buffer."
  6726. (interactive)
  6727. (org-agenda-check-type t 'agenda)
  6728. (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
  6729. (org-agenda-redo)
  6730. (org-agenda-set-mode-name)
  6731. (message "Time-grid turned %s"
  6732. (if org-agenda-use-time-grid "on" "off")))
  6733. (defun org-agenda-set-mode-name ()
  6734. "Set the mode name to indicate all the small mode settings."
  6735. (setq mode-name
  6736. (list "Org-Agenda"
  6737. (if (get 'org-agenda-files 'org-restrict) " []" "")
  6738. " "
  6739. '(:eval (org-agenda-span-name org-agenda-current-span))
  6740. (if org-agenda-follow-mode " Follow" "")
  6741. (if org-agenda-entry-text-mode " ETxt" "")
  6742. (if org-agenda-include-diary " Diary" "")
  6743. (if org-agenda-include-deadlines " Ddl" "")
  6744. (if org-agenda-use-time-grid " Grid" "")
  6745. (if (and (boundp 'org-habit-show-habits)
  6746. org-habit-show-habits) " Habit" "")
  6747. (cond
  6748. ((consp org-agenda-show-log) " LogAll")
  6749. ((eq org-agenda-show-log 'clockcheck) " ClkCk")
  6750. (org-agenda-show-log " Log")
  6751. (t ""))
  6752. (if (or org-agenda-category-filter (get 'org-agenda-category-filter
  6753. :preset-filter))
  6754. '(:eval (org-propertize
  6755. (concat " <"
  6756. (mapconcat
  6757. 'identity
  6758. (append
  6759. (get 'org-agenda-category-filter :preset-filter)
  6760. org-agenda-category-filter)
  6761. "")
  6762. ">")
  6763. 'face 'org-agenda-filter-category
  6764. 'help-echo "Category used in filtering"))
  6765. "")
  6766. (if (or org-agenda-tag-filter (get 'org-agenda-tag-filter
  6767. :preset-filter))
  6768. '(:eval (org-propertize
  6769. (concat " {"
  6770. (mapconcat
  6771. 'identity
  6772. (append
  6773. (get 'org-agenda-tag-filter :preset-filter)
  6774. org-agenda-tag-filter)
  6775. "")
  6776. "}")
  6777. 'face 'org-agenda-filter-tags
  6778. 'help-echo "Tags used in filtering"))
  6779. "")
  6780. (if org-agenda-archives-mode
  6781. (if (eq org-agenda-archives-mode t)
  6782. " Archives"
  6783. (format " :%s:" org-archive-tag))
  6784. "")
  6785. (if org-agenda-clockreport-mode
  6786. (if (eq org-agenda-clockreport-mode 'with-filter)
  6787. " Clock{}" " Clock")
  6788. "")))
  6789. (force-mode-line-update))
  6790. (defun org-agenda-post-command-hook ()
  6791. (setq org-agenda-type
  6792. (or (get-text-property (point) 'org-agenda-type)
  6793. (get-text-property (max (point-min) (1- (point)))
  6794. 'org-agenda-type))))
  6795. (defun org-agenda-next-line ()
  6796. "Move cursor to the next line, and show if follow mode is active."
  6797. (interactive)
  6798. (call-interactively 'next-line)
  6799. (org-agenda-do-context-action))
  6800. (defun org-agenda-previous-line ()
  6801. "Move cursor to the previous line, and show if follow-mode is active."
  6802. (interactive)
  6803. (call-interactively 'previous-line)
  6804. (org-agenda-do-context-action))
  6805. (defun org-agenda-next-item (n)
  6806. "Move cursor to next agenda item."
  6807. (interactive "p")
  6808. (let ((col (current-column)))
  6809. (dotimes (c n)
  6810. (when (next-single-property-change (point-at-eol) 'org-marker)
  6811. (move-end-of-line 1)
  6812. (goto-char (next-single-property-change (point) 'org-marker))))
  6813. (org-move-to-column col))
  6814. (org-agenda-do-context-action))
  6815. (defun org-agenda-previous-item (n)
  6816. "Move cursor to next agenda item."
  6817. (interactive "p")
  6818. (dotimes (c n)
  6819. (let ((col (current-column))
  6820. (goto (save-excursion
  6821. (move-end-of-line 0)
  6822. (previous-single-property-change (point) 'org-marker))))
  6823. (if goto (goto-char goto))
  6824. (org-move-to-column col)))
  6825. (org-agenda-do-context-action))
  6826. (defun org-agenda-do-context-action ()
  6827. "Show outline path and, maybe, follow mode window."
  6828. (let ((m (org-get-at-bol 'org-marker)))
  6829. (when (and (markerp m) (marker-buffer m))
  6830. (and org-agenda-follow-mode
  6831. (if org-agenda-follow-indirect
  6832. (org-agenda-tree-to-indirect-buffer)
  6833. (org-agenda-show)))
  6834. (and org-agenda-show-outline-path
  6835. (org-with-point-at m (org-display-outline-path t))))))
  6836. (defun org-agenda-show-priority ()
  6837. "Show the priority of the current item.
  6838. This priority is composed of the main priority given with the [#A] cookies,
  6839. and by additional input from the age of a schedules or deadline entry."
  6840. (interactive)
  6841. (let* ((pri (org-get-at-bol 'priority)))
  6842. (message "Priority is %d" (if pri pri -1000))))
  6843. (defun org-agenda-show-tags ()
  6844. "Show the tags applicable to the current item."
  6845. (interactive)
  6846. (let* ((tags (org-get-at-bol 'tags)))
  6847. (if tags
  6848. (message "Tags are :%s:"
  6849. (org-no-properties (mapconcat 'identity tags ":")))
  6850. (message "No tags associated with this line"))))
  6851. (defun org-agenda-goto (&optional highlight)
  6852. "Go to the Org-mode file which contains the item at point."
  6853. (interactive)
  6854. (let* ((marker (or (org-get-at-bol 'org-marker)
  6855. (org-agenda-error)))
  6856. (buffer (marker-buffer marker))
  6857. (pos (marker-position marker)))
  6858. (switch-to-buffer-other-window buffer)
  6859. (widen)
  6860. (push-mark)
  6861. (goto-char pos)
  6862. (when (derived-mode-p 'org-mode)
  6863. (org-show-context 'agenda)
  6864. (save-excursion
  6865. (and (outline-next-heading)
  6866. (org-flag-heading nil)))) ; show the next heading
  6867. (when (outline-invisible-p)
  6868. (show-entry)) ; display invisible text
  6869. (recenter (/ (window-height) 2))
  6870. (run-hooks 'org-agenda-after-show-hook)
  6871. (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
  6872. (defvar org-agenda-after-show-hook nil
  6873. "Normal hook run after an item has been shown from the agenda.
  6874. Point is in the buffer where the item originated.")
  6875. (defun org-agenda-kill ()
  6876. "Kill the entry or subtree belonging to the current agenda entry."
  6877. (interactive)
  6878. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  6879. (let* ((marker (or (org-get-at-bol 'org-marker)
  6880. (org-agenda-error)))
  6881. (buffer (marker-buffer marker))
  6882. (pos (marker-position marker))
  6883. (type (org-get-at-bol 'type))
  6884. dbeg dend (n 0) conf)
  6885. (org-with-remote-undo buffer
  6886. (with-current-buffer buffer
  6887. (save-excursion
  6888. (goto-char pos)
  6889. (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
  6890. (setq dbeg (progn (org-back-to-heading t) (point))
  6891. dend (org-end-of-subtree t t))
  6892. (setq dbeg (point-at-bol)
  6893. dend (min (point-max) (1+ (point-at-eol)))))
  6894. (goto-char dbeg)
  6895. (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
  6896. (setq conf (or (eq t org-agenda-confirm-kill)
  6897. (and (numberp org-agenda-confirm-kill)
  6898. (> n org-agenda-confirm-kill))))
  6899. (and conf
  6900. (not (y-or-n-p
  6901. (format "Delete entry with %d lines in buffer \"%s\"? "
  6902. n (buffer-name buffer))))
  6903. (error "Abort"))
  6904. (org-remove-subtree-entries-from-agenda buffer dbeg dend)
  6905. (with-current-buffer buffer (delete-region dbeg dend))
  6906. (message "Agenda item and source killed"))))
  6907. (defvar org-archive-default-command)
  6908. (defun org-agenda-archive-default ()
  6909. "Archive the entry or subtree belonging to the current agenda entry."
  6910. (interactive)
  6911. (require 'org-archive)
  6912. (org-agenda-archive-with org-archive-default-command))
  6913. (defun org-agenda-archive-default-with-confirmation ()
  6914. "Archive the entry or subtree belonging to the current agenda entry."
  6915. (interactive)
  6916. (require 'org-archive)
  6917. (org-agenda-archive-with org-archive-default-command 'confirm))
  6918. (defun org-agenda-archive ()
  6919. "Archive the entry or subtree belonging to the current agenda entry."
  6920. (interactive)
  6921. (org-agenda-archive-with 'org-archive-subtree))
  6922. (defun org-agenda-archive-to-archive-sibling ()
  6923. "Move the entry to the archive sibling."
  6924. (interactive)
  6925. (org-agenda-archive-with 'org-archive-to-archive-sibling))
  6926. (defun org-agenda-archive-with (cmd &optional confirm)
  6927. "Move the entry to the archive sibling."
  6928. (interactive)
  6929. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  6930. (let* ((marker (or (org-get-at-bol 'org-marker)
  6931. (org-agenda-error)))
  6932. (buffer (marker-buffer marker))
  6933. (pos (marker-position marker)))
  6934. (org-with-remote-undo buffer
  6935. (with-current-buffer buffer
  6936. (if (derived-mode-p 'org-mode)
  6937. (if (and confirm
  6938. (not (y-or-n-p "Archive this subtree or entry? ")))
  6939. (error "Abort")
  6940. (save-excursion
  6941. (goto-char pos)
  6942. (org-remove-subtree-entries-from-agenda)
  6943. (org-back-to-heading t)
  6944. (funcall cmd)))
  6945. (error "Archiving works only in Org-mode files"))))))
  6946. (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
  6947. "Remove all lines in the agenda that correspond to a given subtree.
  6948. The subtree is the one in buffer BUF, starting at BEG and ending at END.
  6949. If this information is not given, the function uses the tree at point."
  6950. (let ((buf (or buf (current-buffer))) m p)
  6951. (save-excursion
  6952. (unless (and beg end)
  6953. (org-back-to-heading t)
  6954. (setq beg (point))
  6955. (org-end-of-subtree t)
  6956. (setq end (point)))
  6957. (set-buffer (get-buffer org-agenda-buffer-name))
  6958. (save-excursion
  6959. (goto-char (point-max))
  6960. (beginning-of-line 1)
  6961. (while (not (bobp))
  6962. (when (and (setq m (org-get-at-bol 'org-marker))
  6963. (equal buf (marker-buffer m))
  6964. (setq p (marker-position m))
  6965. (>= p beg)
  6966. (< p end))
  6967. (let ((inhibit-read-only t))
  6968. (delete-region (point-at-bol) (1+ (point-at-eol)))))
  6969. (beginning-of-line 0))))))
  6970. (defun org-agenda-refile (&optional goto rfloc no-update)
  6971. "Refile the item at point."
  6972. (interactive "P")
  6973. (if (equal goto '(16))
  6974. (org-refile-goto-last-stored)
  6975. (let* ((marker (or (org-get-at-bol 'org-hd-marker)
  6976. (org-agenda-error)))
  6977. (buffer (marker-buffer marker))
  6978. (pos (marker-position marker))
  6979. (rfloc (or rfloc
  6980. (org-refile-get-location
  6981. (if goto "Goto" "Refile to") buffer
  6982. org-refile-allow-creating-parent-nodes))))
  6983. (with-current-buffer buffer
  6984. (save-excursion
  6985. (save-restriction
  6986. (widen)
  6987. (goto-char marker)
  6988. (org-remove-subtree-entries-from-agenda)
  6989. (org-refile goto buffer rfloc)))))
  6990. (unless no-update (org-agenda-redo))))
  6991. (defun org-agenda-open-link (&optional arg)
  6992. "Follow the link in the current line, if any.
  6993. This looks for a link in the displayed line in the agenda. It also looks
  6994. at the text of the entry itself."
  6995. (interactive "P")
  6996. (let* ((marker (or (org-get-at-bol 'org-hd-marker)
  6997. (org-get-at-bol 'org-marker)))
  6998. (buffer (and marker (marker-buffer marker)))
  6999. (prefix (buffer-substring
  7000. (point-at-bol) (point-at-eol))))
  7001. (cond
  7002. (buffer
  7003. (with-current-buffer buffer
  7004. (save-excursion
  7005. (save-restriction
  7006. (widen)
  7007. (goto-char marker)
  7008. (org-offer-links-in-entry arg prefix)))))
  7009. ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
  7010. (save-excursion
  7011. (beginning-of-line 1)
  7012. (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
  7013. (org-open-link-from-string (match-string 1)))
  7014. (t (error "No link to open here")))))
  7015. (defun org-agenda-copy-local-variable (var)
  7016. "Get a variable from a referenced buffer and install it here."
  7017. (let ((m (org-get-at-bol 'org-marker)))
  7018. (when (and m (buffer-live-p (marker-buffer m)))
  7019. (org-set-local var (with-current-buffer (marker-buffer m)
  7020. (symbol-value var))))))
  7021. (defun org-agenda-switch-to (&optional delete-other-windows)
  7022. "Go to the Org-mode file which contains the item at point."
  7023. (interactive)
  7024. (if (and org-return-follows-link
  7025. (not (org-get-at-bol 'org-marker))
  7026. (org-in-regexp org-bracket-link-regexp))
  7027. (org-open-link-from-string (match-string 0))
  7028. (let* ((marker (or (org-get-at-bol 'org-marker)
  7029. (org-agenda-error)))
  7030. (buffer (marker-buffer marker))
  7031. (pos (marker-position marker)))
  7032. (org-pop-to-buffer-same-window buffer)
  7033. (and delete-other-windows (delete-other-windows))
  7034. (widen)
  7035. (goto-char pos)
  7036. (when (derived-mode-p 'org-mode)
  7037. (org-show-context 'agenda)
  7038. (save-excursion
  7039. (and (outline-next-heading)
  7040. (org-flag-heading nil))) ; show the next heading
  7041. (when (outline-invisible-p)
  7042. (show-entry)) ; display invisible text
  7043. (run-hooks 'org-agenda-after-show-hook)))))
  7044. (defun org-agenda-goto-mouse (ev)
  7045. "Go to the Org-mode file which contains the item at the mouse click."
  7046. (interactive "e")
  7047. (mouse-set-point ev)
  7048. (org-agenda-goto))
  7049. (defun org-agenda-show (&optional full-entry)
  7050. "Display the Org-mode file which contains the item at point.
  7051. With prefix argument FULL-ENTRY, make the entire entry visible
  7052. if it was hidden in the outline."
  7053. (interactive "P")
  7054. (let ((win (selected-window)))
  7055. (if full-entry
  7056. (let ((org-show-entry-below t))
  7057. (org-agenda-goto t))
  7058. (org-agenda-goto t))
  7059. (select-window win)))
  7060. (defvar org-agenda-show-window nil)
  7061. (defun org-agenda-show-and-scroll-up (&optional arg)
  7062. "Display the Org-mode file which contains the item at point.
  7063. When called repeatedly, scroll the window that is displaying the buffer.
  7064. With a \\[universal-argument] prefix, use `org-show-entry' instead of
  7065. `show-subtree' to display the item, so that drawers and logbooks stay
  7066. folded."
  7067. (interactive "P")
  7068. (let ((win (selected-window)))
  7069. (if (and (window-live-p org-agenda-show-window)
  7070. (eq this-command last-command))
  7071. (progn
  7072. (select-window org-agenda-show-window)
  7073. (ignore-errors (scroll-up)))
  7074. (org-agenda-goto t)
  7075. (if arg (org-show-entry) (show-subtree))
  7076. (setq org-agenda-show-window (selected-window)))
  7077. (select-window win)))
  7078. (defun org-agenda-show-scroll-down ()
  7079. "Scroll down the window showing the agenda."
  7080. (interactive)
  7081. (let ((win (selected-window)))
  7082. (when (window-live-p org-agenda-show-window)
  7083. (select-window org-agenda-show-window)
  7084. (ignore-errors (scroll-down))
  7085. (select-window win))))
  7086. (defun org-agenda-show-1 (&optional more)
  7087. "Display the Org-mode file which contains the item at point.
  7088. The prefix arg selects the amount of information to display:
  7089. 0 hide the subtree
  7090. 1 just show the entry according to defaults.
  7091. 2 show the children view
  7092. 3 show the subtree view
  7093. 4 show the entire subtree and any LOGBOOK drawers
  7094. 5 show the entire subtree and any drawers
  7095. With prefix argument FULL-ENTRY, make the entire entry visible
  7096. if it was hidden in the outline."
  7097. (interactive "p")
  7098. (let ((win (selected-window)))
  7099. (org-agenda-goto t)
  7100. (org-recenter-heading 1)
  7101. (cond
  7102. ((= more 0)
  7103. (hide-subtree)
  7104. (save-excursion
  7105. (org-back-to-heading)
  7106. (run-hook-with-args 'org-cycle-hook 'folded))
  7107. (message "Remote: FOLDED"))
  7108. ((and (org-called-interactively-p 'any) (= more 1))
  7109. (message "Remote: show with default settings"))
  7110. ((= more 2)
  7111. (show-entry)
  7112. (show-children)
  7113. (save-excursion
  7114. (org-back-to-heading)
  7115. (run-hook-with-args 'org-cycle-hook 'children))
  7116. (message "Remote: CHILDREN"))
  7117. ((= more 3)
  7118. (show-subtree)
  7119. (save-excursion
  7120. (org-back-to-heading)
  7121. (run-hook-with-args 'org-cycle-hook 'subtree))
  7122. (message "Remote: SUBTREE"))
  7123. ((= more 4)
  7124. (let* ((org-drawers (delete "LOGBOOK" (copy-sequence org-drawers)))
  7125. (org-drawer-regexp
  7126. (concat "^[ \t]*:\\("
  7127. (mapconcat 'regexp-quote org-drawers "\\|")
  7128. "\\):[ \t]*$")))
  7129. (show-subtree)
  7130. (save-excursion
  7131. (org-back-to-heading)
  7132. (org-cycle-hide-drawers 'subtree)))
  7133. (message "Remote: SUBTREE AND LOGBOOK"))
  7134. ((> more 4)
  7135. (show-subtree)
  7136. (message "Remote: SUBTREE AND ALL DRAWERS")))
  7137. (select-window win)))
  7138. (defun org-recenter-heading (n)
  7139. (save-excursion
  7140. (org-back-to-heading)
  7141. (recenter n)))
  7142. (defvar org-agenda-cycle-counter nil)
  7143. (defun org-agenda-cycle-show (&optional n)
  7144. "Show the current entry in another window, with default settings.
  7145. Default settings are taken from `org-show-hierarchy-above' and siblings.
  7146. When use repeatedly in immediate succession, the remote entry will cycle
  7147. through visibility
  7148. children -> subtree -> folded
  7149. When called with a numeric prefix arg, that arg will be passed through to
  7150. `org-agenda-show-1'. For the interpretation of that argument, see the
  7151. docstring of `org-agenda-show-1'."
  7152. (interactive "P")
  7153. (if (integerp n)
  7154. (setq org-agenda-cycle-counter n)
  7155. (if (not (eq last-command this-command))
  7156. (setq org-agenda-cycle-counter 1)
  7157. (if (equal org-agenda-cycle-counter 0)
  7158. (setq org-agenda-cycle-counter 2)
  7159. (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
  7160. (if (> org-agenda-cycle-counter 3)
  7161. (setq org-agenda-cycle-counter 0)))))
  7162. (org-agenda-show-1 org-agenda-cycle-counter))
  7163. (defun org-agenda-recenter (arg)
  7164. "Display the Org-mode file which contains the item at point and recenter."
  7165. (interactive "P")
  7166. (let ((win (selected-window)))
  7167. (org-agenda-goto t)
  7168. (recenter arg)
  7169. (select-window win)))
  7170. (defun org-agenda-show-mouse (ev)
  7171. "Display the Org-mode file which contains the item at the mouse click."
  7172. (interactive "e")
  7173. (mouse-set-point ev)
  7174. (org-agenda-show))
  7175. (defun org-agenda-check-no-diary ()
  7176. "Check if the entry is a diary link and abort if yes."
  7177. (if (org-get-at-bol 'org-agenda-diary-link)
  7178. (org-agenda-error)))
  7179. (defun org-agenda-error ()
  7180. (error "Command not allowed in this line"))
  7181. (defun org-agenda-tree-to-indirect-buffer ()
  7182. "Show the subtree corresponding to the current entry in an indirect buffer.
  7183. This calls the command `org-tree-to-indirect-buffer' from the original
  7184. Org-mode buffer.
  7185. With numerical prefix arg ARG, go up to this level and then take that tree.
  7186. With a \\[universal-argument] prefix, make a separate frame for this tree (i.e. don't
  7187. use the dedicated frame)."
  7188. (interactive)
  7189. (if (and current-prefix-arg (listp current-prefix-arg))
  7190. (org-agenda-do-tree-to-indirect-buffer)
  7191. (let ((agenda-window (selected-window))
  7192. (indirect-window
  7193. (and org-last-indirect-buffer
  7194. (get-buffer-window org-last-indirect-buffer))))
  7195. (save-window-excursion (org-agenda-do-tree-to-indirect-buffer))
  7196. (unwind-protect
  7197. (progn
  7198. (unless (and indirect-window (window-live-p indirect-window))
  7199. (setq indirect-window (split-window agenda-window)))
  7200. (select-window indirect-window)
  7201. (switch-to-buffer org-last-indirect-buffer :norecord)
  7202. (fit-window-to-buffer indirect-window))
  7203. (select-window (get-buffer-window org-agenda-buffer-name))))))
  7204. (defun org-agenda-do-tree-to-indirect-buffer ()
  7205. "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
  7206. (org-agenda-check-no-diary)
  7207. (let* ((marker (or (org-get-at-bol 'org-marker)
  7208. (org-agenda-error)))
  7209. (buffer (marker-buffer marker))
  7210. (pos (marker-position marker)))
  7211. (with-current-buffer buffer
  7212. (save-excursion
  7213. (goto-char pos)
  7214. (call-interactively 'org-tree-to-indirect-buffer)))))
  7215. (defvar org-last-heading-marker (make-marker)
  7216. "Marker pointing to the headline that last changed its TODO state
  7217. by a remote command from the agenda.")
  7218. (defun org-agenda-todo-nextset ()
  7219. "Switch TODO entry to next sequence."
  7220. (interactive)
  7221. (org-agenda-todo 'nextset))
  7222. (defun org-agenda-todo-previousset ()
  7223. "Switch TODO entry to previous sequence."
  7224. (interactive)
  7225. (org-agenda-todo 'previousset))
  7226. (defun org-agenda-todo (&optional arg)
  7227. "Cycle TODO state of line at point, also in Org-mode file.
  7228. This changes the line at point, all other lines in the agenda referring to
  7229. the same tree node, and the headline of the tree node in the Org-mode file."
  7230. (interactive "P")
  7231. (org-agenda-check-no-diary)
  7232. (let* ((col (current-column))
  7233. (marker (or (org-get-at-bol 'org-marker)
  7234. (org-agenda-error)))
  7235. (buffer (marker-buffer marker))
  7236. (pos (marker-position marker))
  7237. (hdmarker (org-get-at-bol 'org-hd-marker))
  7238. (todayp (org-agenda-todayp (org-get-at-bol 'day)))
  7239. (inhibit-read-only t)
  7240. org-agenda-headline-snapshot-before-repeat newhead just-one)
  7241. (org-with-remote-undo buffer
  7242. (with-current-buffer buffer
  7243. (widen)
  7244. (goto-char pos)
  7245. (org-show-context 'agenda)
  7246. (save-excursion
  7247. (and (outline-next-heading)
  7248. (org-flag-heading nil))) ; show the next heading
  7249. (let ((current-prefix-arg arg))
  7250. (call-interactively 'org-todo))
  7251. (and (bolp) (forward-char 1))
  7252. (setq newhead (org-get-heading))
  7253. (when (and (org-bound-and-true-p
  7254. org-agenda-headline-snapshot-before-repeat)
  7255. (not (equal org-agenda-headline-snapshot-before-repeat
  7256. newhead))
  7257. todayp)
  7258. (setq newhead org-agenda-headline-snapshot-before-repeat
  7259. just-one t))
  7260. (save-excursion
  7261. (org-back-to-heading)
  7262. (move-marker org-last-heading-marker (point))))
  7263. (beginning-of-line 1)
  7264. (save-excursion
  7265. (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
  7266. (org-move-to-column col))))
  7267. (defun org-agenda-add-note (&optional arg)
  7268. "Add a time-stamped note to the entry at point."
  7269. (interactive "P")
  7270. (org-agenda-check-no-diary)
  7271. (let* ((marker (or (org-get-at-bol 'org-marker)
  7272. (org-agenda-error)))
  7273. (buffer (marker-buffer marker))
  7274. (pos (marker-position marker))
  7275. (hdmarker (org-get-at-bol 'org-hd-marker))
  7276. (inhibit-read-only t))
  7277. (with-current-buffer buffer
  7278. (widen)
  7279. (goto-char pos)
  7280. (org-show-context 'agenda)
  7281. (save-excursion
  7282. (and (outline-next-heading)
  7283. (org-flag-heading nil))) ; show the next heading
  7284. (org-add-note))))
  7285. (defun org-agenda-change-all-lines (newhead hdmarker
  7286. &optional fixface just-this)
  7287. "Change all lines in the agenda buffer which match HDMARKER.
  7288. The new content of the line will be NEWHEAD (as modified by
  7289. `org-agenda-format-item'). HDMARKER is checked with
  7290. `equal' against all `org-hd-marker' text properties in the file.
  7291. If FIXFACE is non-nil, the face of each item is modified according to
  7292. the new TODO state.
  7293. If JUST-THIS is non-nil, change just the current line, not all.
  7294. If FORCE-TAGS is non nil, the car of it returns the new tags."
  7295. (let* ((inhibit-read-only t)
  7296. (line (org-current-line))
  7297. (org-agenda-buffer (current-buffer))
  7298. (thetags (with-current-buffer (marker-buffer hdmarker)
  7299. (save-excursion (save-restriction (widen)
  7300. (goto-char hdmarker)
  7301. (org-get-tags-at)))))
  7302. props m pl undone-face done-face finish new dotime cat tags)
  7303. (save-excursion
  7304. (goto-char (point-max))
  7305. (beginning-of-line 1)
  7306. (while (not finish)
  7307. (setq finish (bobp))
  7308. (when (and (setq m (org-get-at-bol 'org-hd-marker))
  7309. (or (not just-this) (= (org-current-line) line))
  7310. (equal m hdmarker))
  7311. (setq props (text-properties-at (point))
  7312. dotime (org-get-at-bol 'dotime)
  7313. cat (org-get-at-bol 'org-category)
  7314. tags thetags
  7315. new
  7316. (let ((org-prefix-format-compiled
  7317. (or (get-text-property (point) 'format)
  7318. org-prefix-format-compiled))
  7319. (extra (org-get-at-bol 'extra)))
  7320. (with-current-buffer (marker-buffer hdmarker)
  7321. (save-excursion
  7322. (save-restriction
  7323. (widen)
  7324. (org-agenda-format-item extra newhead cat tags dotime)))))
  7325. pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
  7326. undone-face (org-get-at-bol 'undone-face)
  7327. done-face (org-get-at-bol 'done-face))
  7328. (beginning-of-line 1)
  7329. (cond
  7330. ((equal new "")
  7331. (and (looking-at ".*\n?") (replace-match "")))
  7332. ((looking-at ".*")
  7333. (replace-match new t t)
  7334. (beginning-of-line 1)
  7335. (add-text-properties (point-at-bol) (point-at-eol) props)
  7336. (when fixface
  7337. (add-text-properties
  7338. (point-at-bol) (point-at-eol)
  7339. (list 'face
  7340. (if org-last-todo-state-is-todo
  7341. undone-face done-face))))
  7342. (org-agenda-highlight-todo 'line)
  7343. (beginning-of-line 1))
  7344. (t (error "Line update did not work"))))
  7345. (beginning-of-line 0)))
  7346. (org-finalize-agenda)))
  7347. (defun org-agenda-align-tags (&optional line)
  7348. "Align all tags in agenda items to `org-agenda-tags-column'."
  7349. (let ((inhibit-read-only t) l c)
  7350. (save-excursion
  7351. (goto-char (if line (point-at-bol) (point-min)))
  7352. (while (re-search-forward (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
  7353. (if line (point-at-eol) nil) t)
  7354. (add-text-properties
  7355. (match-beginning 2) (match-end 2)
  7356. (list 'face (delq nil (let ((prop (get-text-property
  7357. (match-beginning 2) 'face)))
  7358. (or (listp prop) (setq prop (list prop)))
  7359. (if (memq 'org-tag prop)
  7360. prop
  7361. (cons 'org-tag prop))))))
  7362. (setq l (- (match-end 2) (match-beginning 2))
  7363. c (if (< org-agenda-tags-column 0)
  7364. (- (abs org-agenda-tags-column) l)
  7365. org-agenda-tags-column))
  7366. (delete-region (match-beginning 1) (match-end 1))
  7367. (goto-char (match-beginning 1))
  7368. (insert (org-add-props
  7369. (make-string (max 1 (- c (current-column))) ?\ )
  7370. (plist-put (copy-sequence (text-properties-at (point)))
  7371. 'face nil))))
  7372. (goto-char (point-min))
  7373. (org-font-lock-add-tag-faces (point-max)))))
  7374. (defun org-agenda-priority-up ()
  7375. "Increase the priority of line at point, also in Org-mode file."
  7376. (interactive)
  7377. (org-agenda-priority 'up))
  7378. (defun org-agenda-priority-down ()
  7379. "Decrease the priority of line at point, also in Org-mode file."
  7380. (interactive)
  7381. (org-agenda-priority 'down))
  7382. (defun org-agenda-priority (&optional force-direction)
  7383. "Set the priority of line at point, also in Org-mode file.
  7384. This changes the line at point, all other lines in the agenda referring to
  7385. the same tree node, and the headline of the tree node in the Org-mode file."
  7386. (interactive)
  7387. (unless org-enable-priority-commands
  7388. (error "Priority commands are disabled"))
  7389. (org-agenda-check-no-diary)
  7390. (let* ((marker (or (org-get-at-bol 'org-marker)
  7391. (org-agenda-error)))
  7392. (hdmarker (org-get-at-bol 'org-hd-marker))
  7393. (buffer (marker-buffer hdmarker))
  7394. (pos (marker-position hdmarker))
  7395. (inhibit-read-only t)
  7396. newhead)
  7397. (org-with-remote-undo buffer
  7398. (with-current-buffer buffer
  7399. (widen)
  7400. (goto-char pos)
  7401. (org-show-context 'agenda)
  7402. (save-excursion
  7403. (and (outline-next-heading)
  7404. (org-flag-heading nil))) ; show the next heading
  7405. (funcall 'org-priority force-direction)
  7406. (end-of-line 1)
  7407. (setq newhead (org-get-heading)))
  7408. (org-agenda-change-all-lines newhead hdmarker)
  7409. (beginning-of-line 1))))
  7410. ;; FIXME: should fix the tags property of the agenda line.
  7411. (defun org-agenda-set-tags (&optional tag onoff)
  7412. "Set tags for the current headline."
  7413. (interactive)
  7414. (org-agenda-check-no-diary)
  7415. (if (and (org-region-active-p) (org-called-interactively-p 'any))
  7416. (call-interactively 'org-change-tag-in-region)
  7417. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  7418. (org-agenda-error)))
  7419. (buffer (marker-buffer hdmarker))
  7420. (pos (marker-position hdmarker))
  7421. (inhibit-read-only t)
  7422. newhead)
  7423. (org-with-remote-undo buffer
  7424. (with-current-buffer buffer
  7425. (widen)
  7426. (goto-char pos)
  7427. (save-excursion
  7428. (org-show-context 'agenda))
  7429. (save-excursion
  7430. (and (outline-next-heading)
  7431. (org-flag-heading nil))) ; show the next heading
  7432. (goto-char pos)
  7433. (if tag
  7434. (org-toggle-tag tag onoff)
  7435. (call-interactively 'org-set-tags))
  7436. (end-of-line 1)
  7437. (setq newhead (org-get-heading)))
  7438. (org-agenda-change-all-lines newhead hdmarker)
  7439. (beginning-of-line 1)))))
  7440. (defun org-agenda-set-property ()
  7441. "Set a property for the current headline."
  7442. (interactive)
  7443. (org-agenda-check-no-diary)
  7444. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  7445. (org-agenda-error)))
  7446. (buffer (marker-buffer hdmarker))
  7447. (pos (marker-position hdmarker))
  7448. (inhibit-read-only t)
  7449. newhead)
  7450. (org-with-remote-undo buffer
  7451. (with-current-buffer buffer
  7452. (widen)
  7453. (goto-char pos)
  7454. (save-excursion
  7455. (org-show-context 'agenda))
  7456. (save-excursion
  7457. (and (outline-next-heading)
  7458. (org-flag-heading nil))) ; show the next heading
  7459. (goto-char pos)
  7460. (call-interactively 'org-set-property)))))
  7461. (defun org-agenda-set-effort ()
  7462. "Set the effort property for the current headline."
  7463. (interactive)
  7464. (org-agenda-check-no-diary)
  7465. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  7466. (org-agenda-error)))
  7467. (buffer (marker-buffer hdmarker))
  7468. (pos (marker-position hdmarker))
  7469. (inhibit-read-only t)
  7470. newhead)
  7471. (org-with-remote-undo buffer
  7472. (with-current-buffer buffer
  7473. (widen)
  7474. (goto-char pos)
  7475. (save-excursion
  7476. (org-show-context 'agenda))
  7477. (save-excursion
  7478. (and (outline-next-heading)
  7479. (org-flag-heading nil))) ; show the next heading
  7480. (goto-char pos)
  7481. (call-interactively 'org-set-effort)
  7482. (end-of-line 1)
  7483. (setq newhead (org-get-heading)))
  7484. (org-agenda-change-all-lines newhead hdmarker))))
  7485. (defun org-agenda-toggle-archive-tag ()
  7486. "Toggle the archive tag for the current entry."
  7487. (interactive)
  7488. (org-agenda-check-no-diary)
  7489. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  7490. (org-agenda-error)))
  7491. (buffer (marker-buffer hdmarker))
  7492. (pos (marker-position hdmarker))
  7493. (inhibit-read-only t)
  7494. newhead)
  7495. (org-with-remote-undo buffer
  7496. (with-current-buffer buffer
  7497. (widen)
  7498. (goto-char pos)
  7499. (org-show-context 'agenda)
  7500. (save-excursion
  7501. (and (outline-next-heading)
  7502. (org-flag-heading nil))) ; show the next heading
  7503. (call-interactively 'org-toggle-archive-tag)
  7504. (end-of-line 1)
  7505. (setq newhead (org-get-heading)))
  7506. (org-agenda-change-all-lines newhead hdmarker)
  7507. (beginning-of-line 1))))
  7508. (defun org-agenda-do-date-later (arg)
  7509. (interactive "P")
  7510. (cond
  7511. ((or (equal arg '(16))
  7512. (memq last-command
  7513. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  7514. (setq this-command 'org-agenda-date-later-minutes)
  7515. (org-agenda-date-later-minutes 1))
  7516. ((or (equal arg '(4))
  7517. (memq last-command
  7518. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  7519. (setq this-command 'org-agenda-date-later-hours)
  7520. (org-agenda-date-later-hours 1))
  7521. (t
  7522. (org-agenda-date-later (prefix-numeric-value arg)))))
  7523. (defun org-agenda-do-date-earlier (arg)
  7524. (interactive "P")
  7525. (cond
  7526. ((or (equal arg '(16))
  7527. (memq last-command
  7528. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  7529. (setq this-command 'org-agenda-date-earlier-minutes)
  7530. (org-agenda-date-earlier-minutes 1))
  7531. ((or (equal arg '(4))
  7532. (memq last-command
  7533. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  7534. (setq this-command 'org-agenda-date-earlier-hours)
  7535. (org-agenda-date-earlier-hours 1))
  7536. (t
  7537. (org-agenda-date-earlier (prefix-numeric-value arg)))))
  7538. (defun org-agenda-date-later (arg &optional what)
  7539. "Change the date of this item to ARG day(s) later."
  7540. (interactive "p")
  7541. (org-agenda-check-type t 'agenda 'timeline)
  7542. (org-agenda-check-no-diary)
  7543. (let* ((marker (or (org-get-at-bol 'org-marker)
  7544. (org-agenda-error)))
  7545. (buffer (marker-buffer marker))
  7546. (pos (marker-position marker))
  7547. cdate today)
  7548. (org-with-remote-undo buffer
  7549. (with-current-buffer buffer
  7550. (widen)
  7551. (goto-char pos)
  7552. (if (not (org-at-timestamp-p))
  7553. (error "Cannot find time stamp"))
  7554. (when (and org-agenda-move-date-from-past-immediately-to-today
  7555. (equal arg 1)
  7556. (or (not what) (eq what 'day))
  7557. (not (save-match-data (org-at-date-range-p))))
  7558. (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
  7559. cdate (calendar-absolute-from-gregorian
  7560. (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
  7561. today (org-today))
  7562. (if (> today cdate)
  7563. ;; immediately shift to today
  7564. (setq arg (- today cdate))))
  7565. (org-timestamp-change arg (or what 'day))
  7566. (when (and (org-at-date-range-p)
  7567. (re-search-backward org-tr-regexp-both (point-at-bol)))
  7568. (let ((end org-last-changed-timestamp))
  7569. (org-timestamp-change arg (or what 'day))
  7570. (setq org-last-changed-timestamp
  7571. (concat org-last-changed-timestamp "--" end)))))
  7572. (org-agenda-show-new-time marker org-last-changed-timestamp))
  7573. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  7574. (defun org-agenda-date-earlier (arg &optional what)
  7575. "Change the date of this item to ARG day(s) earlier."
  7576. (interactive "p")
  7577. (org-agenda-date-later (- arg) what))
  7578. (defun org-agenda-date-later-minutes (arg)
  7579. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  7580. (interactive "p")
  7581. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  7582. (org-agenda-date-later arg 'minute))
  7583. (defun org-agenda-date-earlier-minutes (arg)
  7584. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  7585. (interactive "p")
  7586. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  7587. (org-agenda-date-earlier arg 'minute))
  7588. (defun org-agenda-date-later-hours (arg)
  7589. "Change the time of this item, in hour steps."
  7590. (interactive "p")
  7591. (org-agenda-date-later arg 'hour))
  7592. (defun org-agenda-date-earlier-hours (arg)
  7593. "Change the time of this item, in hour steps."
  7594. (interactive "p")
  7595. (org-agenda-date-earlier arg 'hour))
  7596. (defun org-agenda-show-new-time (marker stamp &optional prefix)
  7597. "Show new date stamp via text properties."
  7598. ;; We use text properties to make this undoable
  7599. (let ((inhibit-read-only t)
  7600. (buffer-invisibility-spec))
  7601. (setq stamp (concat " " prefix " => " stamp))
  7602. (save-excursion
  7603. (goto-char (point-max))
  7604. (while (not (bobp))
  7605. (when (equal marker (org-get-at-bol 'org-marker))
  7606. (org-move-to-column (- (window-width) (length stamp)) t)
  7607. (org-agenda-fix-tags-filter-overlays-at (point))
  7608. (if (featurep 'xemacs)
  7609. ;; Use `duplicable' property to trigger undo recording
  7610. (let ((ex (make-extent nil nil))
  7611. (gl (make-glyph stamp)))
  7612. (set-glyph-face gl 'secondary-selection)
  7613. (set-extent-properties
  7614. ex (list 'invisible t 'end-glyph gl 'duplicable t))
  7615. (insert-extent ex (1- (point)) (point-at-eol)))
  7616. (add-text-properties
  7617. (1- (point)) (point-at-eol)
  7618. (list 'display (org-add-props stamp nil
  7619. 'face 'secondary-selection))))
  7620. (beginning-of-line 1))
  7621. (beginning-of-line 0)))))
  7622. (defun org-agenda-date-prompt (arg)
  7623. "Change the date of this item. Date is prompted for, with default today.
  7624. The prefix ARG is passed to the `org-time-stamp' command and can therefore
  7625. be used to request time specification in the time stamp."
  7626. (interactive "P")
  7627. (org-agenda-check-type t 'agenda 'timeline)
  7628. (org-agenda-check-no-diary)
  7629. (let* ((marker (or (org-get-at-bol 'org-marker)
  7630. (org-agenda-error)))
  7631. (buffer (marker-buffer marker))
  7632. (pos (marker-position marker)))
  7633. (org-with-remote-undo buffer
  7634. (with-current-buffer buffer
  7635. (widen)
  7636. (goto-char pos)
  7637. (if (not (org-at-timestamp-p t))
  7638. (error "Cannot find time stamp"))
  7639. (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
  7640. (org-agenda-show-new-time marker org-last-changed-timestamp))
  7641. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  7642. (defun org-agenda-schedule (arg &optional time)
  7643. "Schedule the item at point.
  7644. ARG is passed through to `org-schedule'."
  7645. (interactive "P")
  7646. (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
  7647. (org-agenda-check-no-diary)
  7648. (let* ((marker (or (org-get-at-bol 'org-marker)
  7649. (org-agenda-error)))
  7650. (type (marker-insertion-type marker))
  7651. (buffer (marker-buffer marker))
  7652. (pos (marker-position marker))
  7653. (org-insert-labeled-timestamps-at-point nil)
  7654. ts)
  7655. (set-marker-insertion-type marker t)
  7656. (org-with-remote-undo buffer
  7657. (with-current-buffer buffer
  7658. (widen)
  7659. (goto-char pos)
  7660. (setq ts (org-schedule arg time)))
  7661. (org-agenda-show-new-time marker ts "S"))
  7662. (message "Item scheduled for %s" ts)))
  7663. (defun org-agenda-deadline (arg &optional time)
  7664. "Schedule the item at point.
  7665. ARG is passed through to `org-deadline'."
  7666. (interactive "P")
  7667. (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
  7668. (org-agenda-check-no-diary)
  7669. (let* ((marker (or (org-get-at-bol 'org-marker)
  7670. (org-agenda-error)))
  7671. (buffer (marker-buffer marker))
  7672. (pos (marker-position marker))
  7673. (org-insert-labeled-timestamps-at-point nil)
  7674. ts)
  7675. (org-with-remote-undo buffer
  7676. (with-current-buffer buffer
  7677. (widen)
  7678. (goto-char pos)
  7679. (setq ts (org-deadline arg time)))
  7680. (org-agenda-show-new-time marker ts "D"))
  7681. (message "Deadline for this item set to %s" ts)))
  7682. (defun org-agenda-action ()
  7683. "Select entry for agenda action, or execute an agenda action.
  7684. This command prompts for another letter. Valid inputs are:
  7685. m Mark the entry at point for an agenda action
  7686. s Schedule the marked entry to the date at the cursor
  7687. d Set the deadline of the marked entry to the date at the cursor
  7688. r Call `org-remember' with cursor date as the default date
  7689. c Call `org-capture' with cursor date as the default date
  7690. SPC Show marked entry in other window
  7691. TAB Visit marked entry in other window
  7692. The cursor may be at a date in the calendar, or in the Org agenda."
  7693. (interactive)
  7694. (let (ans)
  7695. (message "Select action: [m]ark | [s]chedule [d]eadline [r]emember [c]apture [ ]show")
  7696. (setq ans (read-char-exclusive))
  7697. (cond
  7698. ((equal ans ?m)
  7699. ;; Mark this entry
  7700. (if (eq major-mode 'org-agenda-mode)
  7701. (let ((m (or (org-get-at-bol 'org-hd-marker)
  7702. (org-get-at-bol 'org-marker))))
  7703. (if m
  7704. (progn
  7705. (move-marker org-agenda-action-marker
  7706. (marker-position m) (marker-buffer m))
  7707. (message "Entry marked for action; press `k' at desired date in agenda or calendar"))
  7708. (error "Don't know which entry to mark")))
  7709. (error "This command works only in the agenda")))
  7710. ((equal ans ?s)
  7711. (org-agenda-do-action '(org-schedule nil org-overriding-default-time)))
  7712. ((equal ans ?d)
  7713. (org-agenda-do-action '(org-deadline nil org-overriding-default-time)))
  7714. ((equal ans ?r)
  7715. (org-agenda-do-action '(org-remember) t))
  7716. ((equal ans ?c)
  7717. (org-agenda-do-action '(org-capture) t))
  7718. ((equal ans ?\ )
  7719. (let ((cw (selected-window)))
  7720. (org-switch-to-buffer-other-window
  7721. (marker-buffer org-agenda-action-marker))
  7722. (goto-char org-agenda-action-marker)
  7723. (org-show-context 'agenda)
  7724. (select-window cw)))
  7725. ((equal ans ?\C-i)
  7726. (org-switch-to-buffer-other-window
  7727. (marker-buffer org-agenda-action-marker))
  7728. (goto-char org-agenda-action-marker)
  7729. (org-show-context 'agenda))
  7730. (t (error "Invalid agenda action %c" ans)))))
  7731. (defun org-agenda-do-action (form &optional current-buffer)
  7732. "Evaluate FORM at the entry pointed to by `org-agenda-action-marker'."
  7733. (let ((org-overriding-default-time (org-get-cursor-date)))
  7734. (if current-buffer
  7735. (eval form)
  7736. (if (not (marker-buffer org-agenda-action-marker))
  7737. (error "No entry has been selected for agenda action")
  7738. (with-current-buffer (marker-buffer org-agenda-action-marker)
  7739. (save-excursion
  7740. (save-restriction
  7741. (widen)
  7742. (goto-char org-agenda-action-marker)
  7743. (eval form))))))))
  7744. (defun org-agenda-clock-in (&optional arg)
  7745. "Start the clock on the currently selected item."
  7746. (interactive "P")
  7747. (org-agenda-check-no-diary)
  7748. (if (equal arg '(4))
  7749. (org-clock-in arg)
  7750. (let* ((marker (or (org-get-at-bol 'org-marker)
  7751. (org-agenda-error)))
  7752. (hdmarker (or (org-get-at-bol 'org-hd-marker)
  7753. marker))
  7754. (pos (marker-position marker))
  7755. newhead)
  7756. (org-with-remote-undo (marker-buffer marker)
  7757. (with-current-buffer (marker-buffer marker)
  7758. (widen)
  7759. (goto-char pos)
  7760. (org-show-context 'agenda)
  7761. (org-show-entry)
  7762. (org-cycle-hide-drawers 'children)
  7763. (org-clock-in arg)
  7764. (setq newhead (org-get-heading)))
  7765. (org-agenda-change-all-lines newhead hdmarker)))))
  7766. (defun org-agenda-clock-out ()
  7767. "Stop the currently running clock."
  7768. (interactive)
  7769. (unless (marker-buffer org-clock-marker)
  7770. (error "No running clock"))
  7771. (let ((marker (make-marker)) newhead)
  7772. (org-with-remote-undo (marker-buffer org-clock-marker)
  7773. (with-current-buffer (marker-buffer org-clock-marker)
  7774. (save-excursion
  7775. (save-restriction
  7776. (widen)
  7777. (goto-char org-clock-marker)
  7778. (org-back-to-heading t)
  7779. (move-marker marker (point))
  7780. (org-clock-out)
  7781. (setq newhead (org-get-heading))))))
  7782. (org-agenda-change-all-lines newhead marker)
  7783. (move-marker marker nil)))
  7784. (defun org-agenda-clock-cancel (&optional arg)
  7785. "Cancel the currently running clock."
  7786. (interactive "P")
  7787. (unless (marker-buffer org-clock-marker)
  7788. (error "No running clock"))
  7789. (org-with-remote-undo (marker-buffer org-clock-marker)
  7790. (org-clock-cancel)))
  7791. (defun org-agenda-clock-goto ()
  7792. "Jump to the currently clocked in task within the agenda.
  7793. If the currently clocked in task is not listed in the agenda
  7794. buffer, display it in another window."
  7795. (interactive)
  7796. (let (pos)
  7797. (mapc (lambda (o)
  7798. (if (eq (overlay-get o 'type) 'org-agenda-clocking)
  7799. (setq pos (overlay-start o))))
  7800. (overlays-in (point-min) (point-max)))
  7801. (cond (pos (goto-char pos))
  7802. ;; If the currently clocked entry is not in the agenda
  7803. ;; buffer, we visit it in another window:
  7804. (org-clock-current-task
  7805. (org-switch-to-buffer-other-window (org-clock-goto)))
  7806. (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
  7807. (defun org-agenda-diary-entry-in-org-file ()
  7808. "Make a diary entry in the file `org-agenda-diary-file'."
  7809. (let (d1 d2 char (text "") dp1 dp2)
  7810. (if (equal (buffer-name) "*Calendar*")
  7811. (setq d1 (calendar-cursor-to-date t)
  7812. d2 (car calendar-mark-ring))
  7813. (setq dp1 (get-text-property (point-at-bol) 'day))
  7814. (unless dp1 (error "No date defined in current line"))
  7815. (setq d1 (calendar-gregorian-from-absolute dp1)
  7816. d2 (and (ignore-errors (mark))
  7817. (save-excursion
  7818. (goto-char (mark))
  7819. (setq dp2 (get-text-property (point-at-bol) 'day)))
  7820. (calendar-gregorian-from-absolute dp2))))
  7821. (message "Diary entry: [d]ay [a]nniversary [b]lock [j]ump to date tree")
  7822. (setq char (read-char-exclusive))
  7823. (cond
  7824. ((equal char ?d)
  7825. (setq text (read-string "Day entry: "))
  7826. (org-agenda-add-entry-to-org-agenda-diary-file 'day text d1)
  7827. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  7828. ((equal char ?a)
  7829. (setq d1 (list (car d1) (nth 1 d1)
  7830. (read-number (format "Reference year [%d]: " (nth 2 d1))
  7831. (nth 2 d1))))
  7832. (setq text (read-string "Anniversary (use %d to show years): "))
  7833. (org-agenda-add-entry-to-org-agenda-diary-file 'anniversary text d1)
  7834. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  7835. ((equal char ?b)
  7836. (setq text (read-string "Block entry: "))
  7837. (unless (and d1 d2 (not (equal d1 d2)))
  7838. (error "No block of days selected"))
  7839. (org-agenda-add-entry-to-org-agenda-diary-file 'block text d1 d2)
  7840. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  7841. ((equal char ?j)
  7842. (org-switch-to-buffer-other-window
  7843. (find-file-noselect org-agenda-diary-file))
  7844. (require 'org-datetree)
  7845. (org-datetree-find-date-create d1)
  7846. (org-reveal t))
  7847. (t (error "Invalid selection character `%c'" char)))))
  7848. (defcustom org-agenda-insert-diary-strategy 'date-tree
  7849. "Where in `org-agenda-diary-file' should new entries be added?
  7850. Valid values:
  7851. date-tree in the date tree, as child of the date
  7852. top-level as top-level entries at the end of the file."
  7853. :group 'org-agenda
  7854. :type '(choice
  7855. (const :tag "in a date tree" date-tree)
  7856. (const :tag "as top level at end of file" top-level)))
  7857. (defcustom org-agenda-insert-diary-extract-time nil
  7858. "Non-nil means extract any time specification from the diary entry."
  7859. :group 'org-agenda
  7860. :version "24.1"
  7861. :type 'boolean)
  7862. (defcustom org-agenda-bulk-mark-char ">"
  7863. "A single-character string to be used as the bulk mark."
  7864. :group 'org-agenda
  7865. :version "24.1"
  7866. :type 'string)
  7867. (defun org-agenda-add-entry-to-org-agenda-diary-file (type text &optional d1 d2)
  7868. "Add a diary entry with TYPE to `org-agenda-diary-file'.
  7869. If TEXT is not empty, it will become the headline of the new entry, and
  7870. the resulting entry will not be shown. When TEXT is empty, switch to
  7871. `org-agenda-diary-file' and let the user finish the entry there."
  7872. (let ((cw (current-window-configuration)))
  7873. (org-switch-to-buffer-other-window
  7874. (find-file-noselect org-agenda-diary-file))
  7875. (widen)
  7876. (goto-char (point-min))
  7877. (cond
  7878. ((eq type 'anniversary)
  7879. (or (re-search-forward "^*[ \t]+Anniversaries" nil t)
  7880. (progn
  7881. (or (org-at-heading-p t)
  7882. (progn
  7883. (outline-next-heading)
  7884. (insert "* Anniversaries\n\n")
  7885. (beginning-of-line -1)))))
  7886. (outline-next-heading)
  7887. (org-back-over-empty-lines)
  7888. (backward-char 1)
  7889. (insert "\n")
  7890. (insert (format "%%%%(org-anniversary %d %2d %2d) %s"
  7891. (nth 2 d1) (car d1) (nth 1 d1) text)))
  7892. ((eq type 'day)
  7893. (let ((org-prefix-has-time t)
  7894. (org-agenda-time-leading-zero t)
  7895. fmt time time2)
  7896. (if org-agenda-insert-diary-extract-time
  7897. ;; Use org-agenda-format-item to parse text for a time-range and
  7898. ;; remove it. FIXME: This is a hack, we should refactor
  7899. ;; that function to make time extraction available separately
  7900. (setq fmt (org-agenda-format-item nil text nil nil t)
  7901. time (get-text-property 0 'time fmt)
  7902. time2 (if (> (length time) 0)
  7903. ;; split-string removes trailing ...... if
  7904. ;; no end time given. First space
  7905. ;; separates time from date.
  7906. (concat " " (car (split-string time "\\.")))
  7907. nil)
  7908. text (get-text-property 0 'txt fmt)))
  7909. (if (eq org-agenda-insert-diary-strategy 'top-level)
  7910. (org-agenda-insert-diary-as-top-level text)
  7911. (require 'org-datetree)
  7912. (org-datetree-find-date-create d1)
  7913. (org-agenda-insert-diary-make-new-entry text))
  7914. (org-insert-time-stamp (org-time-from-absolute
  7915. (calendar-absolute-from-gregorian d1))
  7916. nil nil nil nil time2))
  7917. (end-of-line 0))
  7918. ((eq type 'block)
  7919. (if (> (calendar-absolute-from-gregorian d1)
  7920. (calendar-absolute-from-gregorian d2))
  7921. (setq d1 (prog1 d2 (setq d2 d1))))
  7922. (if (eq org-agenda-insert-diary-strategy 'top-level)
  7923. (org-agenda-insert-diary-as-top-level text)
  7924. (require 'org-datetree)
  7925. (org-datetree-find-date-create d1)
  7926. (org-agenda-insert-diary-make-new-entry text))
  7927. (org-insert-time-stamp (org-time-from-absolute
  7928. (calendar-absolute-from-gregorian d1)))
  7929. (insert "--")
  7930. (org-insert-time-stamp (org-time-from-absolute
  7931. (calendar-absolute-from-gregorian d2)))
  7932. (end-of-line 0)))
  7933. (if (string-match "\\S-" text)
  7934. (progn
  7935. (set-window-configuration cw)
  7936. (message "%s entry added to %s"
  7937. (capitalize (symbol-name type))
  7938. (abbreviate-file-name org-agenda-diary-file)))
  7939. (org-reveal t)
  7940. (message "Please finish entry here"))))
  7941. (defun org-agenda-insert-diary-as-top-level (text)
  7942. "Make new entry as a top-level entry at the end of the file.
  7943. Add TEXT as headline, and position the cursor in the second line so that
  7944. a timestamp can be added there."
  7945. (widen)
  7946. (goto-char (point-max))
  7947. (or (bolp) (insert "\n"))
  7948. (insert "* " text "\n")
  7949. (if org-adapt-indentation (org-indent-to-column 2)))
  7950. (defun org-agenda-insert-diary-make-new-entry (text)
  7951. "Make new entry as last child of current entry.
  7952. Add TEXT as headline, and position the cursor in the second line so that
  7953. a timestamp can be added there."
  7954. (let ((org-show-following-heading t)
  7955. (org-show-siblings t)
  7956. (org-show-hierarchy-above t)
  7957. (org-show-entry-below t)
  7958. col)
  7959. (outline-next-heading)
  7960. (org-back-over-empty-lines)
  7961. (or (looking-at "[ \t]*$")
  7962. (progn (insert "\n") (backward-char 1)))
  7963. (org-insert-heading nil t)
  7964. (org-do-demote)
  7965. (setq col (current-column))
  7966. (insert text "\n")
  7967. (if org-adapt-indentation (org-indent-to-column col))
  7968. (let ((org-show-following-heading t)
  7969. (org-show-siblings t)
  7970. (org-show-hierarchy-above t)
  7971. (org-show-entry-below t))
  7972. (org-show-context))))
  7973. (defun org-agenda-diary-entry ()
  7974. "Make a diary entry, like the `i' command from the calendar.
  7975. All the standard commands work: block, weekly etc.
  7976. When `org-agenda-diary-file' points to a file,
  7977. `org-agenda-diary-entry-in-org-file' is called instead to create
  7978. entries in that Org-mode file."
  7979. (interactive)
  7980. (org-agenda-check-type t 'agenda 'timeline)
  7981. (if (not (eq org-agenda-diary-file 'diary-file))
  7982. (org-agenda-diary-entry-in-org-file)
  7983. (require 'diary-lib)
  7984. (let* ((char (progn
  7985. (message "Diary entry: [d]ay [w]eekly [m]onthly [y]early [a]nniversary [b]lock [c]yclic")
  7986. (read-char-exclusive)))
  7987. (cmd (cdr (assoc char
  7988. '((?d . insert-diary-entry)
  7989. (?w . insert-weekly-diary-entry)
  7990. (?m . insert-monthly-diary-entry)
  7991. (?y . insert-yearly-diary-entry)
  7992. (?a . insert-anniversary-diary-entry)
  7993. (?b . insert-block-diary-entry)
  7994. (?c . insert-cyclic-diary-entry)))))
  7995. (oldf (symbol-function 'calendar-cursor-to-date))
  7996. ;; (buf (get-file-buffer (substitute-in-file-name diary-file)))
  7997. (point (point))
  7998. (mark (or (mark t) (point))))
  7999. (unless cmd
  8000. (error "No command associated with <%c>" char))
  8001. (unless (and (get-text-property point 'day)
  8002. (or (not (equal ?b char))
  8003. (get-text-property mark 'day)))
  8004. (error "Don't know which date to use for diary entry"))
  8005. ;; We implement this by hacking the `calendar-cursor-to-date' function
  8006. ;; and the `calendar-mark-ring' variable. Saves a lot of code.
  8007. (let ((calendar-mark-ring
  8008. (list (calendar-gregorian-from-absolute
  8009. (or (get-text-property mark 'day)
  8010. (get-text-property point 'day))))))
  8011. (unwind-protect
  8012. (progn
  8013. (fset 'calendar-cursor-to-date
  8014. (lambda (&optional error dummy)
  8015. (calendar-gregorian-from-absolute
  8016. (get-text-property point 'day))))
  8017. (call-interactively cmd))
  8018. (fset 'calendar-cursor-to-date oldf))))))
  8019. (defun org-agenda-execute-calendar-command (cmd)
  8020. "Execute a calendar command from the agenda, with the date associated to
  8021. the cursor position."
  8022. (org-agenda-check-type t 'agenda 'timeline)
  8023. (require 'diary-lib)
  8024. (unless (get-text-property (point) 'day)
  8025. (error "Don't know which date to use for calendar command"))
  8026. (let* ((oldf (symbol-function 'calendar-cursor-to-date))
  8027. (point (point))
  8028. (date (calendar-gregorian-from-absolute
  8029. (get-text-property point 'day)))
  8030. ;; the following 2 vars are needed in the calendar
  8031. (displayed-month (car date))
  8032. (displayed-year (nth 2 date)))
  8033. (unwind-protect
  8034. (progn
  8035. (fset 'calendar-cursor-to-date
  8036. (lambda (&optional error dummy)
  8037. (calendar-gregorian-from-absolute
  8038. (get-text-property point 'day))))
  8039. (call-interactively cmd))
  8040. (fset 'calendar-cursor-to-date oldf))))
  8041. (defun org-agenda-phases-of-moon ()
  8042. "Display the phases of the moon for the 3 months around the cursor date."
  8043. (interactive)
  8044. (org-agenda-execute-calendar-command 'calendar-phases-of-moon))
  8045. (defun org-agenda-holidays ()
  8046. "Display the holidays for the 3 months around the cursor date."
  8047. (interactive)
  8048. (org-agenda-execute-calendar-command 'list-calendar-holidays))
  8049. (defvar calendar-longitude)
  8050. (defvar calendar-latitude)
  8051. (defvar calendar-location-name)
  8052. (defun org-agenda-sunrise-sunset (arg)
  8053. "Display sunrise and sunset for the cursor date.
  8054. Latitude and longitude can be specified with the variables
  8055. `calendar-latitude' and `calendar-longitude'. When called with prefix
  8056. argument, latitude and longitude will be prompted for."
  8057. (interactive "P")
  8058. (require 'solar)
  8059. (let ((calendar-longitude (if arg nil calendar-longitude))
  8060. (calendar-latitude (if arg nil calendar-latitude))
  8061. (calendar-location-name
  8062. (if arg "the given coordinates" calendar-location-name)))
  8063. (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
  8064. (defun org-agenda-goto-calendar ()
  8065. "Open the Emacs calendar with the date at the cursor."
  8066. (interactive)
  8067. (org-agenda-check-type t 'agenda 'timeline)
  8068. (let* ((day (or (get-text-property (point) 'day)
  8069. (error "Don't know which date to open in calendar")))
  8070. (date (calendar-gregorian-from-absolute day))
  8071. (calendar-move-hook nil)
  8072. (calendar-view-holidays-initially-flag nil)
  8073. (calendar-view-diary-initially-flag nil))
  8074. (calendar)
  8075. (calendar-goto-date date)))
  8076. ;;;###autoload
  8077. (defun org-calendar-goto-agenda ()
  8078. "Compute the Org-mode agenda for the calendar date displayed at the cursor.
  8079. This is a command that has to be installed in `calendar-mode-map'."
  8080. (interactive)
  8081. (org-agenda-list nil (calendar-absolute-from-gregorian
  8082. (calendar-cursor-to-date))
  8083. nil))
  8084. (defun org-agenda-convert-date ()
  8085. (interactive)
  8086. (org-agenda-check-type t 'agenda 'timeline)
  8087. (let ((day (get-text-property (point) 'day))
  8088. date s)
  8089. (unless day
  8090. (error "Don't know which date to convert"))
  8091. (setq date (calendar-gregorian-from-absolute day))
  8092. (setq s (concat
  8093. "Gregorian: " (calendar-date-string date) "\n"
  8094. "ISO: " (calendar-iso-date-string date) "\n"
  8095. "Day of Yr: " (calendar-day-of-year-string date) "\n"
  8096. "Julian: " (calendar-julian-date-string date) "\n"
  8097. "Astron. JD: " (calendar-astro-date-string date)
  8098. " (Julian date number at noon UTC)\n"
  8099. "Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
  8100. "Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
  8101. "French: " (calendar-french-date-string date) "\n"
  8102. "Baha'i: " (calendar-bahai-date-string date) " (until sunset)\n"
  8103. "Mayan: " (calendar-mayan-date-string date) "\n"
  8104. "Coptic: " (calendar-coptic-date-string date) "\n"
  8105. "Ethiopic: " (calendar-ethiopic-date-string date) "\n"
  8106. "Persian: " (calendar-persian-date-string date) "\n"
  8107. "Chinese: " (calendar-chinese-date-string date) "\n"))
  8108. (with-output-to-temp-buffer "*Dates*"
  8109. (princ s))
  8110. (org-fit-window-to-buffer (get-buffer-window "*Dates*"))))
  8111. ;;; Bulk commands
  8112. (defvar org-agenda-bulk-marked-entries nil
  8113. "List of markers that refer to marked entries in the agenda.")
  8114. (defun org-agenda-bulk-marked-p ()
  8115. (eq (get-char-property (point-at-bol) 'type)
  8116. 'org-marked-entry-overlay))
  8117. (defun org-agenda-bulk-mark (&optional arg)
  8118. "Mark the entry at point for future bulk action."
  8119. (interactive "p")
  8120. (dotimes (i (or arg 1))
  8121. (unless (org-get-at-bol 'org-agenda-diary-link)
  8122. (let* ((m (org-get-at-bol 'org-hd-marker))
  8123. ov)
  8124. (unless (org-agenda-bulk-marked-p)
  8125. (unless m (error "Nothing to mark at point"))
  8126. (push m org-agenda-bulk-marked-entries)
  8127. (setq ov (make-overlay (point-at-bol) (+ 2 (point-at-bol))))
  8128. (org-overlay-display ov (concat org-agenda-bulk-mark-char " ")
  8129. (org-get-todo-face "TODO")
  8130. 'evaporate)
  8131. (overlay-put ov 'type 'org-marked-entry-overlay))
  8132. (beginning-of-line 2)
  8133. (while (and (get-char-property (point) 'invisible) (not (eobp)))
  8134. (beginning-of-line 2))
  8135. (message "%d entries marked for bulk action"
  8136. (length org-agenda-bulk-marked-entries))))))
  8137. (defun org-agenda-bulk-mark-all ()
  8138. "Mark all entries for future agenda bulk action."
  8139. (interactive)
  8140. (org-agenda-bulk-mark-regexp "."))
  8141. (defun org-agenda-bulk-mark-regexp (regexp)
  8142. "Mark entries matching REGEXP for future agenda bulk action."
  8143. (interactive "sMark entries matching regexp: ")
  8144. (let ((entries-marked 0))
  8145. (save-excursion
  8146. (goto-char (point-min))
  8147. (goto-char (next-single-property-change (point) 'txt))
  8148. (while (re-search-forward regexp nil t)
  8149. (when (string-match regexp (get-text-property (point) 'txt))
  8150. (setq entries-marked (1+ entries-marked))
  8151. (call-interactively 'org-agenda-bulk-mark))))
  8152. (if (not entries-marked)
  8153. (message "No entry matching this regexp."))))
  8154. (defun org-agenda-bulk-unmark (&optional arg)
  8155. "Unmark the entry at point for future bulk action."
  8156. (interactive "P")
  8157. (if arg
  8158. (org-agenda-bulk-unmark-all)
  8159. (cond ((org-agenda-bulk-marked-p)
  8160. (org-agenda-bulk-remove-overlays
  8161. (point-at-bol) (+ 2 (point-at-bol)))
  8162. (setq org-agenda-bulk-marked-entries
  8163. (delete (org-get-at-bol 'org-hd-marker)
  8164. org-agenda-bulk-marked-entries))
  8165. (beginning-of-line 2)
  8166. (while (and (get-char-property (point) 'invisible) (not (eobp)))
  8167. (beginning-of-line 2))
  8168. (message "%d entries left marked for bulk action"
  8169. (length org-agenda-bulk-marked-entries)))
  8170. (t (message "No entry to unmark here")))))
  8171. (defun org-agenda-bulk-toggle ()
  8172. "Toggle marking the entry at point for bulk action."
  8173. (interactive)
  8174. (if (org-agenda-bulk-marked-p)
  8175. (org-agenda-bulk-unmark)
  8176. (org-agenda-bulk-mark)))
  8177. (defun org-agenda-bulk-remove-overlays (&optional beg end)
  8178. "Remove the mark overlays between BEG and END in the agenda buffer.
  8179. BEG and END default to the buffer limits.
  8180. This only removes the overlays, it does not remove the markers
  8181. from the list in `org-agenda-bulk-marked-entries'."
  8182. (interactive)
  8183. (mapc (lambda (ov)
  8184. (and (eq (overlay-get ov 'type) 'org-marked-entry-overlay)
  8185. (delete-overlay ov)))
  8186. (overlays-in (or beg (point-min)) (or end (point-max)))))
  8187. (defun org-agenda-bulk-unmark-all ()
  8188. "Remove all marks in the agenda buffer.
  8189. This will remove the markers and the overlays."
  8190. (interactive)
  8191. (if (null org-agenda-bulk-marked-entries)
  8192. (message "No entry to unmark")
  8193. (mapc (lambda (m) (move-marker m nil)) org-agenda-bulk-marked-entries)
  8194. (setq org-agenda-bulk-marked-entries nil)
  8195. (org-agenda-bulk-remove-overlays (point-min) (point-max))))
  8196. (defcustom org-agenda-persistent-marks nil
  8197. "Non-nil means marked items will stay marked after a bulk action.
  8198. You can toggle this interactively by typing `p' when prompted for a
  8199. bulk action."
  8200. :group 'org-agenda
  8201. :version "24.1"
  8202. :type 'boolean)
  8203. (defun org-agenda-bulk-action (&optional arg)
  8204. "Execute an remote-editing action on all marked entries.
  8205. The prefix arg is passed through to the command if possible."
  8206. (interactive "P")
  8207. ;; Make sure we have markers, and only valid ones
  8208. (unless org-agenda-bulk-marked-entries (error "No entries are marked"))
  8209. (mapc
  8210. (lambda (m)
  8211. (unless (and (markerp m)
  8212. (marker-buffer m)
  8213. (buffer-live-p (marker-buffer m))
  8214. (marker-position m))
  8215. (error "Marker %s for bulk command is invalid" m)))
  8216. org-agenda-bulk-marked-entries)
  8217. ;; Prompt for the bulk command
  8218. (let* ((msg (if org-agenda-persistent-marks "Bulk (persistent): " "Bulk: ")))
  8219. (message (concat msg "[r]efile [$]arch [A]rch->sib [t]odo"
  8220. " [+/-]tag [s]chd [S]catter [d]eadline [f]unction "
  8221. (when org-agenda-bulk-custom-functions
  8222. (concat " Custom: ["
  8223. (mapconcat (lambda(f) (char-to-string (car f)))
  8224. org-agenda-bulk-custom-functions "")
  8225. "]"))))
  8226. (catch 'exit
  8227. (let* ((action (read-char-exclusive))
  8228. (org-log-refile (if org-log-refile 'time nil))
  8229. (entries (reverse org-agenda-bulk-marked-entries))
  8230. redo-at-end
  8231. cmd rfloc state e tag pos (cnt 0) (cntskip 0))
  8232. (cond
  8233. ((equal action ?p)
  8234. (let ((org-agenda-persistent-marks
  8235. (not org-agenda-persistent-marks)))
  8236. (org-agenda-bulk-action)
  8237. (throw 'exit nil)))
  8238. ((equal action ?$)
  8239. (setq cmd '(org-agenda-archive)))
  8240. ((equal action ?A)
  8241. (setq cmd '(org-agenda-archive-to-archive-sibling)))
  8242. ((member action '(?r ?w))
  8243. (setq rfloc (org-refile-get-location
  8244. "Refile to"
  8245. (marker-buffer (car org-agenda-bulk-marked-entries))
  8246. org-refile-allow-creating-parent-nodes))
  8247. (if (nth 3 rfloc)
  8248. (setcar (nthcdr 3 rfloc)
  8249. (move-marker (make-marker) (nth 3 rfloc)
  8250. (or (get-file-buffer (nth 1 rfloc))
  8251. (find-buffer-visiting (nth 1 rfloc))
  8252. (error "This should not happen")))))
  8253. (setq cmd (list 'org-agenda-refile nil (list 'quote rfloc) t)
  8254. redo-at-end t))
  8255. ((equal action ?t)
  8256. (setq state (org-icompleting-read
  8257. "Todo state: "
  8258. (with-current-buffer (marker-buffer (car entries))
  8259. (mapcar 'list org-todo-keywords-1))))
  8260. (setq cmd `(let ((org-inhibit-blocking t)
  8261. (org-inhibit-logging 'note))
  8262. (org-agenda-todo ,state))))
  8263. ((memq action '(?- ?+))
  8264. (setq tag (org-icompleting-read
  8265. (format "Tag to %s: " (if (eq action ?+) "add" "remove"))
  8266. (with-current-buffer (marker-buffer (car entries))
  8267. (delq nil
  8268. (mapcar (lambda (x)
  8269. (if (stringp (car x)) x)) org-tag-alist)))))
  8270. (setq cmd `(org-agenda-set-tags ,tag ,(if (eq action ?+) ''on ''off))))
  8271. ((memq action '(?s ?d))
  8272. (let* ((date (unless arg
  8273. (org-read-date
  8274. nil nil nil
  8275. (if (eq action ?s) "(Re)Schedule to" "Set Deadline to"))))
  8276. (ans (if arg nil org-read-date-final-answer))
  8277. (c1 (if (eq action ?s) 'org-agenda-schedule 'org-agenda-deadline)))
  8278. (setq cmd `(let* ((bound (fboundp 'read-string))
  8279. (old (and bound (symbol-function 'read-string))))
  8280. (unwind-protect
  8281. (progn
  8282. (fset 'read-string (lambda (&rest ignore) ,ans))
  8283. (eval '(,c1 arg)))
  8284. (if bound
  8285. (fset 'read-string old)
  8286. (fmakunbound 'read-string)))))))
  8287. ((equal action ?S)
  8288. (if (not (org-agenda-check-type nil 'agenda 'timeline 'todo))
  8289. (error "Can't scatter tasks in \"%s\" agenda view" org-agenda-type)
  8290. (let ((days (read-number
  8291. (format "Scatter tasks across how many %sdays: "
  8292. (if arg "week" "")) 7)))
  8293. (setq cmd
  8294. `(let ((distance (1+ (random ,days))))
  8295. (if arg
  8296. (let ((dist distance)
  8297. (day-of-week
  8298. (calendar-day-of-week
  8299. (calendar-gregorian-from-absolute (org-today)))))
  8300. (dotimes (i (1+ dist))
  8301. (while (member day-of-week org-agenda-weekend-days)
  8302. (incf distance)
  8303. (incf day-of-week)
  8304. (if (= day-of-week 7)
  8305. (setq day-of-week 0)))
  8306. (incf day-of-week)
  8307. (if (= day-of-week 7)
  8308. (setq day-of-week 0)))))
  8309. ;; silently fail when try to replan a sexp entry
  8310. (condition-case nil
  8311. (let* ((date (calendar-gregorian-from-absolute
  8312. (+ (org-today) distance)))
  8313. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date)
  8314. (nth 2 date))))
  8315. (org-agenda-schedule nil time))
  8316. (error nil)))))))
  8317. ((assoc action org-agenda-bulk-custom-functions)
  8318. (setq cmd (list (cadr (assoc action org-agenda-bulk-custom-functions)))
  8319. redo-at-end t))
  8320. ((equal action ?f)
  8321. (setq cmd (list (intern
  8322. (org-icompleting-read "Function: "
  8323. obarray 'fboundp t nil nil)))))
  8324. (t (error "Invalid bulk action")))
  8325. ;; Sort the markers, to make sure that parents are handled before children
  8326. (setq entries (sort entries
  8327. (lambda (a b)
  8328. (cond
  8329. ((equal (marker-buffer a) (marker-buffer b))
  8330. (< (marker-position a) (marker-position b)))
  8331. (t
  8332. (string< (buffer-name (marker-buffer a))
  8333. (buffer-name (marker-buffer b))))))))
  8334. ;; Now loop over all markers and apply cmd
  8335. (while (setq e (pop entries))
  8336. (setq pos (text-property-any (point-min) (point-max) 'org-hd-marker e))
  8337. (if (not pos)
  8338. (progn (message "Skipping removed entry at %s" e)
  8339. (setq cntskip (1+ cntskip)))
  8340. (goto-char pos)
  8341. (let (org-loop-over-headlines-in-active-region)
  8342. (eval cmd))
  8343. (when (not org-agenda-persistent-marks)
  8344. (setq org-agenda-bulk-marked-entries
  8345. (delete e org-agenda-bulk-marked-entries)))
  8346. (setq cnt (1+ cnt))))
  8347. (when (not org-agenda-persistent-marks)
  8348. (org-agenda-bulk-unmark-all))
  8349. (when redo-at-end (org-agenda-redo))
  8350. (message "Acted on %d entries%s%s"
  8351. cnt
  8352. (if (= cntskip 0)
  8353. ""
  8354. (format ", skipped %d (disappeared before their turn)"
  8355. cntskip))
  8356. (if (not org-agenda-persistent-marks)
  8357. "" " (kept marked)"))))))
  8358. ;;; Flagging notes
  8359. (defun org-agenda-show-the-flagging-note ()
  8360. "Display the flagging note in the other window.
  8361. When called a second time in direct sequence, offer to remove the FLAGGING
  8362. tag and (if present) the flagging note."
  8363. (interactive)
  8364. (let ((hdmarker (org-get-at-bol 'org-hd-marker))
  8365. (win (selected-window))
  8366. note heading newhead)
  8367. (unless hdmarker
  8368. (error "No linked entry at point"))
  8369. (if (and (eq this-command last-command)
  8370. (y-or-n-p "Unflag and remove any flagging note? "))
  8371. (progn
  8372. (org-agenda-remove-flag hdmarker)
  8373. (let ((win (get-buffer-window "*Flagging Note*")))
  8374. (and win (delete-window win)))
  8375. (message "Entry unflagged"))
  8376. (setq note (org-entry-get hdmarker "THEFLAGGINGNOTE"))
  8377. (unless note
  8378. (error "No flagging note"))
  8379. (org-kill-new note)
  8380. (org-switch-to-buffer-other-window "*Flagging Note*")
  8381. (erase-buffer)
  8382. (insert note)
  8383. (goto-char (point-min))
  8384. (while (re-search-forward "\\\\n" nil t)
  8385. (replace-match "\n" t t))
  8386. (goto-char (point-min))
  8387. (select-window win)
  8388. (message "Flagging note pushed to kill ring. Press [?] again to remove tag and note"))))
  8389. (defun org-agenda-remove-flag (marker)
  8390. "Remove the FLAGGED tag and any flagging note in the entry."
  8391. (let (newhead)
  8392. (org-with-point-at marker
  8393. (org-toggle-tag "FLAGGED" 'off)
  8394. (org-entry-delete nil "THEFLAGGINGNOTE")
  8395. (setq newhead (org-get-heading)))
  8396. (org-agenda-change-all-lines newhead marker)
  8397. (message "Entry unflagged")))
  8398. (defun org-agenda-get-any-marker (&optional pos)
  8399. (or (get-text-property (or pos (point-at-bol)) 'org-hd-marker)
  8400. (get-text-property (or pos (point-at-bol)) 'org-marker)))
  8401. ;;; Appointment reminders
  8402. (defvar appt-time-msg-list)
  8403. ;;;###autoload
  8404. (defun org-agenda-to-appt (&optional refresh filter &rest args)
  8405. "Activate appointments found in `org-agenda-files'.
  8406. With a \\[universal-argument] prefix, refresh the list of
  8407. appointments.
  8408. If FILTER is t, interactively prompt the user for a regular
  8409. expression, and filter out entries that don't match it.
  8410. If FILTER is a string, use this string as a regular expression
  8411. for filtering entries out.
  8412. If FILTER is a function, filter out entries against which
  8413. calling the function returns nil. This function takes one
  8414. argument: an entry from `org-agenda-get-day-entries'.
  8415. FILTER can also be an alist with the car of each cell being
  8416. either 'headline or 'category. For example:
  8417. '((headline \"IMPORTANT\")
  8418. (category \"Work\"))
  8419. will only add headlines containing IMPORTANT or headlines
  8420. belonging to the \"Work\" category.
  8421. ARGS are symbols indicating what kind of entries to consider.
  8422. By default `org-agenda-to-appt' will use :deadline, :scheduled
  8423. and :timestamp entries. See the docstring of `org-diary' for
  8424. details and examples.
  8425. If an entry as a APPT_WARNTIME property, its value will be used
  8426. to override `appt-message-warning-time'."
  8427. (interactive "P")
  8428. (if refresh (setq appt-time-msg-list nil))
  8429. (if (eq filter t)
  8430. (setq filter (read-from-minibuffer "Regexp filter: ")))
  8431. (let* ((cnt 0) ; count added events
  8432. (scope (or args '(:deadline :scheduled :timestamp)))
  8433. (org-agenda-new-buffers nil)
  8434. (org-deadline-warning-days 0)
  8435. ;; Do not use `org-today' here because appt only takes
  8436. ;; time and without date as argument, so it may pass wrong
  8437. ;; information otherwise
  8438. (today (org-date-to-gregorian
  8439. (time-to-days (current-time))))
  8440. (org-agenda-restrict nil)
  8441. (files (org-agenda-files 'unrestricted)) entries file
  8442. (org-agenda-buffer nil))
  8443. ;; Get all entries which may contain an appt
  8444. (org-prepare-agenda-buffers files)
  8445. (while (setq file (pop files))
  8446. (setq entries
  8447. (delq nil
  8448. (append entries
  8449. (apply 'org-agenda-get-day-entries
  8450. file today scope)))))
  8451. ;; Map thru entries and find if we should filter them out
  8452. (mapc
  8453. (lambda(x)
  8454. (let* ((evt (org-trim (or (get-text-property 1 'txt x) "")))
  8455. (cat (get-text-property 1 'org-category x))
  8456. (tod (get-text-property 1 'time-of-day x))
  8457. (ok (or (null filter)
  8458. (and (stringp filter) (string-match filter evt))
  8459. (and (functionp filter) (funcall filter x))
  8460. (and (listp filter)
  8461. (let ((cat-filter (cadr (assoc 'category filter)))
  8462. (evt-filter (cadr (assoc 'headline filter))))
  8463. (or (and (stringp cat-filter)
  8464. (string-match cat-filter cat))
  8465. (and (stringp evt-filter)
  8466. (string-match evt-filter evt)))))))
  8467. (wrn (get-text-property 1 'warntime x)))
  8468. ;; FIXME: Shall we remove text-properties for the appt text?
  8469. ;; (setq evt (set-text-properties 0 (length evt) nil evt))
  8470. (when (and ok tod)
  8471. (setq tod (concat "00" (number-to-string tod))
  8472. tod (when (string-match
  8473. "\\([0-9]\\{1,2\\}\\)\\([0-9]\\{2\\}\\)\\'" tod)
  8474. (concat (match-string 1 tod) ":"
  8475. (match-string 2 tod))))
  8476. (if (version< emacs-version "23.3")
  8477. (appt-add tod evt)
  8478. (appt-add tod evt wrn))
  8479. (setq cnt (1+ cnt))))) entries)
  8480. (org-release-buffers org-agenda-new-buffers)
  8481. (if (eq cnt 0)
  8482. (message "No event to add")
  8483. (message "Added %d event%s for today" cnt (if (> cnt 1) "s" "")))))
  8484. (defun org-agenda-todayp (date)
  8485. "Does DATE mean today, when considering `org-extend-today-until'?"
  8486. (let ((today (org-today))
  8487. (date (if (and date (listp date)) (calendar-absolute-from-gregorian date)
  8488. date)))
  8489. (eq date today)))
  8490. (defun org-agenda-todo-yesterday (&optional arg)
  8491. "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday."
  8492. (interactive "P")
  8493. (let* ((hour (third (decode-time
  8494. (org-current-time))))
  8495. (org-extend-today-until (1+ hour)))
  8496. (org-agenda-todo arg)))
  8497. (provide 'org-agenda)
  8498. ;;; org-agenda.el ends here