org-agenda.el 394 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174
  1. ;;; org-agenda.el --- Dynamic task and appointment lists for Org
  2. ;; Copyright (C) 2004-2016 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 'cl-lib)
  42. (require 'org)
  43. (require 'org-macs)
  44. (declare-function diary-add-to-list "diary-lib"
  45. (date string specifier &optional marker globcolor literal))
  46. (declare-function calendar-iso-to-absolute "cal-iso" (date))
  47. (declare-function calendar-astro-date-string "cal-julian" (&optional date))
  48. (declare-function calendar-bahai-date-string "cal-bahai" (&optional date))
  49. (declare-function calendar-chinese-date-string "cal-china" (&optional date))
  50. (declare-function calendar-coptic-date-string "cal-coptic" (&optional date))
  51. (declare-function calendar-ethiopic-date-string "cal-coptic" (&optional date))
  52. (declare-function calendar-french-date-string "cal-french" (&optional date))
  53. (declare-function calendar-goto-date "cal-move" (date))
  54. (declare-function calendar-hebrew-date-string "cal-hebrew" (&optional date))
  55. (declare-function calendar-islamic-date-string "cal-islam" (&optional date))
  56. (declare-function calendar-iso-date-string "cal-iso" (&optional date))
  57. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  58. (declare-function calendar-julian-date-string "cal-julian" (&optional date))
  59. (declare-function calendar-mayan-date-string "cal-mayan" (&optional date))
  60. (declare-function calendar-persian-date-string "cal-persia" (&optional date))
  61. (declare-function calendar-check-holidays "holidays" (date))
  62. (declare-function org-columns-remove-overlays "org-colview" ())
  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-agenda-columns "org-colview" ())
  74. (declare-function org-add-archive-files "org-archive" (files))
  75. (declare-function org-capture "org-capture" (&optional goto keys))
  76. (defvar calendar-mode-map)
  77. (defvar org-clock-current-task)
  78. (defvar org-current-tag-alist)
  79. (defvar org-mobile-force-id-on-agenda-items)
  80. (defvar org-habit-show-habits)
  81. (defvar org-habit-show-habits-only-for-today)
  82. (defvar org-habit-show-all-today)
  83. ;; Defined somewhere in this file, but used before definition.
  84. (defvar org-agenda-buffer-name "*Org Agenda*")
  85. (defvar org-agenda-overriding-header nil)
  86. (defvar org-agenda-title-append nil)
  87. (with-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  88. (with-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  89. (defvar original-date) ; dynamically scoped, calendar.el does scope this
  90. (defvar org-agenda-undo-list nil
  91. "List of undoable operations in the agenda since last refresh.")
  92. (defvar org-agenda-pending-undo-list nil
  93. "In a series of undo commands, this is the list of remaining undo items.")
  94. (defcustom org-agenda-confirm-kill 1
  95. "When set, remote killing from the agenda buffer needs confirmation.
  96. When t, a confirmation is always needed. When a number N, confirmation is
  97. only needed when the text to be killed contains more than N non-white lines."
  98. :group 'org-agenda
  99. :type '(choice
  100. (const :tag "Never" nil)
  101. (const :tag "Always" t)
  102. (integer :tag "When more than N lines")))
  103. (defcustom org-agenda-compact-blocks nil
  104. "Non-nil means make the block agenda more compact.
  105. This is done globally by leaving out lines like the agenda span
  106. name and week number or the separator lines."
  107. :group 'org-agenda
  108. :type 'boolean)
  109. (defcustom org-agenda-block-separator ?=
  110. "The separator between blocks in the agenda.
  111. If this is a string, it will be used as the separator, with a newline added.
  112. If it is a character, it will be repeated to fill the window width.
  113. If nil the separator is disabled. In `org-agenda-custom-commands' this
  114. addresses the separator between the current and the previous block."
  115. :group 'org-agenda
  116. :type '(choice
  117. (const :tag "Disabled" nil)
  118. (character)
  119. (string)))
  120. (defgroup org-agenda-export nil
  121. "Options concerning exporting agenda views in Org-mode."
  122. :tag "Org Agenda Export"
  123. :group 'org-agenda)
  124. (defcustom org-agenda-with-colors t
  125. "Non-nil means use colors in agenda views."
  126. :group 'org-agenda-export
  127. :type 'boolean)
  128. (defcustom org-agenda-exporter-settings nil
  129. "Alist of variable/value pairs that should be active during agenda export.
  130. This is a good place to set options for ps-print and for htmlize.
  131. Note that the way this is implemented, the values will be evaluated
  132. before assigned to the variables. So make sure to quote values you do
  133. *not* want evaluated, for example
  134. (setq org-agenda-exporter-settings
  135. \\='((ps-print-color-p \\='black-white)))"
  136. :group 'org-agenda-export
  137. :type '(repeat
  138. (list
  139. (variable)
  140. (sexp :tag "Value"))))
  141. (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
  142. "Hook run in a temporary buffer before writing the agenda to an export file.
  143. A useful function for this hook is `org-agenda-add-entry-text'."
  144. :group 'org-agenda-export
  145. :type 'hook
  146. :options '(org-agenda-add-entry-text))
  147. (defcustom org-agenda-add-entry-text-maxlines 0
  148. "Maximum number of entry text lines to be added to agenda.
  149. This is only relevant when `org-agenda-add-entry-text' is part of
  150. `org-agenda-before-write-hook', which is the default.
  151. When this is 0, nothing will happen. When it is greater than 0, it
  152. specifies the maximum number of lines that will be added for each entry
  153. that is listed in the agenda view.
  154. Note that this variable is not used during display, only when exporting
  155. the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
  156. and `org-agenda-entry-text-maxlines'."
  157. :group 'org-agenda
  158. :type 'integer)
  159. (defcustom org-agenda-add-entry-text-descriptive-links t
  160. "Non-nil means export org-links as descriptive links in agenda added text.
  161. This variable applies to the text added to the agenda when
  162. `org-agenda-add-entry-text-maxlines' is larger than 0.
  163. When this variable nil, the URL will (also) be shown."
  164. :group 'org-agenda
  165. :type 'boolean)
  166. (defcustom org-agenda-export-html-style nil
  167. "The style specification for exported HTML Agenda files.
  168. If this variable contains a string, it will replace the default <style>
  169. section as produced by `htmlize'.
  170. Since there are different ways of setting style information, this variable
  171. needs to contain the full HTML structure to provide a style, including the
  172. surrounding HTML tags. The style specifications should include definitions
  173. the fonts used by the agenda, here is an example:
  174. <style type=\"text/css\">
  175. p { font-weight: normal; color: gray; }
  176. .org-agenda-structure {
  177. font-size: 110%;
  178. color: #003399;
  179. font-weight: 600;
  180. }
  181. .org-todo {
  182. color: #cc6666;
  183. font-weight: bold;
  184. }
  185. .org-agenda-done {
  186. color: #339933;
  187. }
  188. .org-done {
  189. color: #339933;
  190. }
  191. .title { text-align: center; }
  192. .todo, .deadline { color: red; }
  193. .done { color: green; }
  194. </style>
  195. or, if you want to keep the style in a file,
  196. <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
  197. As the value of this option simply gets inserted into the HTML <head> header,
  198. you can \"misuse\" it to also add other text to the header."
  199. :group 'org-agenda-export
  200. :group 'org-export-html
  201. :type '(choice
  202. (const nil)
  203. (string)))
  204. (defcustom org-agenda-persistent-filter nil
  205. "When set, keep filters from one agenda view to the next."
  206. :group 'org-agenda
  207. :type 'boolean)
  208. (defgroup org-agenda-custom-commands nil
  209. "Options concerning agenda views in Org-mode."
  210. :tag "Org Agenda Custom Commands"
  211. :group 'org-agenda)
  212. (defconst org-sorting-choice
  213. '(choice
  214. (const time-up) (const time-down)
  215. (const timestamp-up) (const timestamp-down)
  216. (const scheduled-up) (const scheduled-down)
  217. (const deadline-up) (const deadline-down)
  218. (const ts-up) (const ts-down)
  219. (const tsia-up) (const tsia-down)
  220. (const category-keep) (const category-up) (const category-down)
  221. (const tag-down) (const tag-up)
  222. (const priority-up) (const priority-down)
  223. (const todo-state-up) (const todo-state-down)
  224. (const effort-up) (const effort-down)
  225. (const habit-up) (const habit-down)
  226. (const alpha-up) (const alpha-down)
  227. (const user-defined-up) (const user-defined-down))
  228. "Sorting choices.")
  229. ;; Keep custom values for `org-agenda-filter-preset' compatible with
  230. ;; the new variable `org-agenda-tag-filter-preset'.
  231. (defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
  232. (defvaralias 'org-agenda-filter 'org-agenda-tag-filter)
  233. (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
  234. "List of types searched for when creating the daily/weekly agenda.
  235. This variable is a list of symbols that controls the types of
  236. items that appear in the daily/weekly agenda. Allowed symbols in this
  237. list are are
  238. :timestamp List items containing a date stamp or date range matching
  239. the selected date. This includes sexp entries in angular
  240. brackets.
  241. :sexp List entries resulting from plain diary-like sexps.
  242. :deadline List deadline due on that date. When the date is today,
  243. also list any deadlines past due, or due within
  244. `org-deadline-warning-days'. `:deadline' must appear before
  245. `:scheduled' if the setting of
  246. `org-agenda-skip-scheduled-if-deadline-is-shown' is to have
  247. any effect.
  248. :deadline* Same as above, but only include the deadline if it has an
  249. hour specification as [h]h:mm.
  250. :scheduled List all items which are scheduled for the given date.
  251. The diary for *today* also contains items which were
  252. scheduled earlier and are not yet marked DONE.
  253. :scheduled* Same as above, but only include the scheduled item if it
  254. has an hour specification as [h]h:mm.
  255. By default, all four non-starred types are turned on.
  256. When :scheduled* or :deadline* are included, :schedule or :deadline
  257. will be ignored.
  258. Never set this variable globally using `setq', because then it
  259. will apply to all future agenda commands. Instead, bind it with
  260. `let' to scope it dynamically into the agenda-constructing
  261. command. A good way to set it is through options in
  262. `org-agenda-custom-commands'. For a more flexible (though
  263. somewhat less efficient) way of determining what is included in
  264. the daily/weekly agenda, see `org-agenda-skip-function'.")
  265. (defconst org-agenda-custom-commands-local-options
  266. `(repeat :tag "Local settings for this command. Remember to quote values"
  267. (choice :tag "Setting"
  268. (list :tag "Heading for this block"
  269. (const org-agenda-overriding-header)
  270. (string :tag "Headline"))
  271. (list :tag "Files to be searched"
  272. (const org-agenda-files)
  273. (list
  274. (const :format "" quote)
  275. (repeat (file))))
  276. (list :tag "Sorting strategy"
  277. (const org-agenda-sorting-strategy)
  278. (list
  279. (const :format "" quote)
  280. (repeat
  281. ,org-sorting-choice)))
  282. (list :tag "Prefix format"
  283. (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
  284. (string))
  285. (list :tag "Number of days in agenda"
  286. (const org-agenda-span)
  287. (choice (const :tag "Day" day)
  288. (const :tag "Week" week)
  289. (const :tag "Fortnight" fortnight)
  290. (const :tag "Month" month)
  291. (const :tag "Year" year)
  292. (integer :tag "Custom")))
  293. (list :tag "Fixed starting date"
  294. (const org-agenda-start-day)
  295. (string :value "2007-11-01"))
  296. (list :tag "Start on day of week"
  297. (const org-agenda-start-on-weekday)
  298. (choice :value 1
  299. (const :tag "Today" nil)
  300. (integer :tag "Weekday No.")))
  301. (list :tag "Include data from diary"
  302. (const org-agenda-include-diary)
  303. (boolean))
  304. (list :tag "Deadline Warning days"
  305. (const org-deadline-warning-days)
  306. (integer :value 1))
  307. (list :tag "Category filter preset"
  308. (const org-agenda-category-filter-preset)
  309. (list
  310. (const :format "" quote)
  311. (repeat
  312. (string :tag "+category or -category"))))
  313. (list :tag "Tags filter preset"
  314. (const org-agenda-tag-filter-preset)
  315. (list
  316. (const :format "" quote)
  317. (repeat
  318. (string :tag "+tag or -tag"))))
  319. (list :tag "Effort filter preset"
  320. (const org-agenda-effort-filter-preset)
  321. (list
  322. (const :format "" quote)
  323. (repeat
  324. (string :tag "+=10 or -=10 or +<10 or ->10"))))
  325. (list :tag "Regexp filter preset"
  326. (const org-agenda-regexp-filter-preset)
  327. (list
  328. (const :format "" quote)
  329. (repeat
  330. (string :tag "+regexp or -regexp"))))
  331. (list :tag "Set daily/weekly entry types"
  332. (const org-agenda-entry-types)
  333. (list
  334. (const :format "" quote)
  335. (set :greedy t :value ,org-agenda-entry-types
  336. (const :deadline)
  337. (const :scheduled)
  338. (const :deadline*)
  339. (const :scheduled*)
  340. (const :timestamp)
  341. (const :sexp))))
  342. (list :tag "Standard skipping condition"
  343. :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
  344. (const org-agenda-skip-function)
  345. (list
  346. (const :format "" quote)
  347. (list
  348. (choice
  349. :tag "Skipping range"
  350. (const :tag "Skip entry" org-agenda-skip-entry-if)
  351. (const :tag "Skip subtree" org-agenda-skip-subtree-if))
  352. (repeat :inline t :tag "Conditions for skipping"
  353. (choice
  354. :tag "Condition type"
  355. (list :tag "Regexp matches" :inline t
  356. (const :format "" 'regexp)
  357. (regexp))
  358. (list :tag "Regexp does not match" :inline t
  359. (const :format "" 'notregexp)
  360. (regexp))
  361. (list :tag "TODO state is" :inline t
  362. (const 'todo)
  363. (choice
  364. (const :tag "Any not-done state" 'todo)
  365. (const :tag "Any done state" 'done)
  366. (const :tag "Any state" 'any)
  367. (list :tag "Keyword list"
  368. (const :format "" quote)
  369. (repeat (string :tag "Keyword")))))
  370. (list :tag "TODO state is not" :inline t
  371. (const 'nottodo)
  372. (choice
  373. (const :tag "Any not-done state" 'todo)
  374. (const :tag "Any done state" 'done)
  375. (const :tag "Any state" 'any)
  376. (list :tag "Keyword list"
  377. (const :format "" quote)
  378. (repeat (string :tag "Keyword")))))
  379. (const :tag "scheduled" 'scheduled)
  380. (const :tag "not scheduled" 'notscheduled)
  381. (const :tag "deadline" 'deadline)
  382. (const :tag "no deadline" 'notdeadline)
  383. (const :tag "timestamp" 'timestamp)
  384. (const :tag "no timestamp" 'nottimestamp))))))
  385. (list :tag "Non-standard skipping condition"
  386. :value (org-agenda-skip-function)
  387. (const org-agenda-skip-function)
  388. (sexp :tag "Function or form (quoted!)"))
  389. (list :tag "Any variable"
  390. (variable :tag "Variable")
  391. (sexp :tag "Value (sexp)"))))
  392. "Selection of examples for agenda command settings.
  393. This will be spliced into the custom type of
  394. `org-agenda-custom-commands'.")
  395. (defcustom org-agenda-custom-commands
  396. '(("n" "Agenda and all TODOs" ((agenda "") (alltodo ""))))
  397. "Custom commands for the agenda.
  398. These commands will be offered on the splash screen displayed by the
  399. agenda dispatcher \\[org-agenda]. Each entry is a list like this:
  400. (key desc type match settings files)
  401. key The key (one or more characters as a string) to be associated
  402. with the command.
  403. desc A description of the command, when omitted or nil, a default
  404. description is built using MATCH.
  405. type The command type, any of the following symbols:
  406. agenda The daily/weekly agenda.
  407. todo Entries with a specific TODO keyword, in all agenda files.
  408. search Entries containing search words entry or headline.
  409. tags Tags/Property/TODO match in all agenda files.
  410. tags-todo Tags/P/T match in all agenda files, TODO entries only.
  411. todo-tree Sparse tree of specific TODO keyword in *current* file.
  412. tags-tree Sparse tree with all tags matches in *current* file.
  413. occur-tree Occur sparse tree for *current* file.
  414. ... A user-defined function.
  415. match What to search for:
  416. - a single keyword for TODO keyword searches
  417. - a tags match expression for tags searches
  418. - a word search expression for text searches.
  419. - a regular expression for occur searches
  420. For all other commands, this should be the empty string.
  421. settings A list of option settings, similar to that in a let form, so like
  422. this: ((opt1 val1) (opt2 val2) ...). The values will be
  423. evaluated at the moment of execution, so quote them when needed.
  424. files A list of files file to write the produced agenda buffer to
  425. with the command `org-store-agenda-views'.
  426. If a file name ends in \".html\", an HTML version of the buffer
  427. is written out. If it ends in \".ps\", a postscript version is
  428. produced. Otherwise, only the plain text is written to the file.
  429. You can also define a set of commands, to create a composite agenda buffer.
  430. In this case, an entry looks like this:
  431. (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
  432. where
  433. desc A description string to be displayed in the dispatcher menu.
  434. cmd An agenda command, similar to the above. However, tree commands
  435. are not allowed, but instead you can get agenda and global todo list.
  436. So valid commands for a set are:
  437. (agenda \"\" settings)
  438. (alltodo \"\" settings)
  439. (stuck \"\" settings)
  440. (todo \"match\" settings files)
  441. (search \"match\" settings files)
  442. (tags \"match\" settings files)
  443. (tags-todo \"match\" settings files)
  444. Each command can carry a list of options, and another set of options can be
  445. given for the whole set of commands. Individual command options take
  446. precedence over the general options.
  447. When using several characters as key to a command, the first characters
  448. are prefix commands. For the dispatcher to display useful information, you
  449. should provide a description for the prefix, like
  450. (setq org-agenda-custom-commands
  451. \\='((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
  452. (\"hl\" tags \"+HOME+Lisa\")
  453. (\"hp\" tags \"+HOME+Peter\")
  454. (\"hk\" tags \"+HOME+Kim\")))"
  455. :group 'org-agenda-custom-commands
  456. :type `(repeat
  457. (choice :value ("x" "Describe command here" tags "" nil)
  458. (list :tag "Single command"
  459. (string :tag "Access Key(s) ")
  460. (option (string :tag "Description"))
  461. (choice
  462. (const :tag "Agenda" agenda)
  463. (const :tag "TODO list" alltodo)
  464. (const :tag "Search words" search)
  465. (const :tag "Stuck projects" stuck)
  466. (const :tag "Tags/Property match (all agenda files)" tags)
  467. (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
  468. (const :tag "TODO keyword search (all agenda files)" todo)
  469. (const :tag "Tags sparse tree (current buffer)" tags-tree)
  470. (const :tag "TODO keyword tree (current buffer)" todo-tree)
  471. (const :tag "Occur tree (current buffer)" occur-tree)
  472. (sexp :tag "Other, user-defined function"))
  473. (string :tag "Match (only for some commands)")
  474. ,org-agenda-custom-commands-local-options
  475. (option (repeat :tag "Export" (file :tag "Export to"))))
  476. (list :tag "Command series, all agenda files"
  477. (string :tag "Access Key(s)")
  478. (string :tag "Description ")
  479. (repeat :tag "Component"
  480. (choice
  481. (list :tag "Agenda"
  482. (const :format "" agenda)
  483. (const :tag "" :format "" "")
  484. ,org-agenda-custom-commands-local-options)
  485. (list :tag "TODO list (all keywords)"
  486. (const :format "" alltodo)
  487. (const :tag "" :format "" "")
  488. ,org-agenda-custom-commands-local-options)
  489. (list :tag "Search words"
  490. (const :format "" search)
  491. (string :tag "Match")
  492. ,org-agenda-custom-commands-local-options)
  493. (list :tag "Stuck projects"
  494. (const :format "" stuck)
  495. (const :tag "" :format "" "")
  496. ,org-agenda-custom-commands-local-options)
  497. (list :tag "Tags search"
  498. (const :format "" tags)
  499. (string :tag "Match")
  500. ,org-agenda-custom-commands-local-options)
  501. (list :tag "Tags search, TODO entries only"
  502. (const :format "" tags-todo)
  503. (string :tag "Match")
  504. ,org-agenda-custom-commands-local-options)
  505. (list :tag "TODO keyword search"
  506. (const :format "" todo)
  507. (string :tag "Match")
  508. ,org-agenda-custom-commands-local-options)
  509. (list :tag "Other, user-defined function"
  510. (symbol :tag "function")
  511. (string :tag "Match")
  512. ,org-agenda-custom-commands-local-options)))
  513. (repeat :tag "Settings for entire command set"
  514. (list (variable :tag "Any variable")
  515. (sexp :tag "Value")))
  516. (option (repeat :tag "Export" (file :tag "Export to"))))
  517. (cons :tag "Prefix key documentation"
  518. (string :tag "Access Key(s)")
  519. (string :tag "Description ")))))
  520. (defcustom org-agenda-query-register ?o
  521. "The register holding the current query string.
  522. The purpose of this is that if you construct a query string interactively,
  523. you can then use it to define a custom command."
  524. :group 'org-agenda-custom-commands
  525. :type 'character)
  526. (defcustom org-stuck-projects
  527. '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
  528. "How to identify stuck projects.
  529. This is a list of four items:
  530. 1. A tags/todo/property matcher string that is used to identify a project.
  531. See the manual for a description of tag and property searches.
  532. The entire tree below a headline matched by this is considered one project.
  533. 2. A list of TODO keywords identifying non-stuck projects.
  534. If the project subtree contains any headline with one of these todo
  535. keywords, the project is considered to be not stuck. If you specify
  536. \"*\" as a keyword, any TODO keyword will mark the project unstuck.
  537. 3. A list of tags identifying non-stuck projects.
  538. If the project subtree contains any headline with one of these tags,
  539. the project is considered to be not stuck. If you specify \"*\" as
  540. a tag, any tag will mark the project unstuck. Note that this is about
  541. the explicit presence of a tag somewhere in the subtree, inherited
  542. tags do not count here. If inherited tags make a project not stuck,
  543. use \"-TAG\" in the tags part of the matcher under (1.) above.
  544. 4. An arbitrary regular expression matching non-stuck projects.
  545. If the project turns out to be not stuck, search continues also in the
  546. subtree to see if any of the subtasks have project status.
  547. See also the variable `org-tags-match-list-sublevels' which applies
  548. to projects matched by this search as well.
  549. After defining this variable, you may use \\[org-agenda-list-stuck-projects]
  550. or `C-c a #' to produce the list."
  551. :group 'org-agenda-custom-commands
  552. :type '(list
  553. (string :tag "Tags/TODO match to identify a project")
  554. (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
  555. (repeat :tag "Projects are *not* stuck if they have an entry with TAG being any of" (string))
  556. (regexp :tag "Projects are *not* stuck if this regexp matches inside the subtree")))
  557. (defgroup org-agenda-skip nil
  558. "Options concerning skipping parts of agenda files."
  559. :tag "Org Agenda Skip"
  560. :group 'org-agenda)
  561. (defcustom org-agenda-skip-function-global nil
  562. "Function to be called at each match during agenda construction.
  563. If this function returns nil, the current match should not be skipped.
  564. If the function decided to skip an agenda match, is must return the
  565. buffer position from which the search should be continued.
  566. This may also be a Lisp form, which will be evaluated.
  567. This variable will be applied to every agenda match, including
  568. tags/property searches and TODO lists. So try to make the test function
  569. do its checking as efficiently as possible. To implement a skipping
  570. condition just for specific agenda commands, use the variable
  571. `org-agenda-skip-function' which can be set in the options section
  572. of custom agenda commands."
  573. :group 'org-agenda-skip
  574. :type 'sexp)
  575. (defgroup org-agenda-daily/weekly nil
  576. "Options concerning the daily/weekly agenda."
  577. :tag "Org Agenda Daily/Weekly"
  578. :group 'org-agenda)
  579. (defgroup org-agenda-todo-list nil
  580. "Options concerning the global todo list agenda view."
  581. :tag "Org Agenda Todo List"
  582. :group 'org-agenda)
  583. (defgroup org-agenda-match-view nil
  584. "Options concerning the general tags/property/todo match agenda view."
  585. :tag "Org Agenda Match View"
  586. :group 'org-agenda)
  587. (defgroup org-agenda-search-view nil
  588. "Options concerning the search agenda view."
  589. :tag "Org Agenda Search View"
  590. :group 'org-agenda)
  591. (defvar org-agenda-archives-mode nil
  592. "Non-nil means the agenda will include archived items.
  593. If this is the symbol `trees', trees in the selected agenda scope
  594. that are marked with the ARCHIVE tag will be included anyway. When this is
  595. t, also all archive files associated with the current selection of agenda
  596. files will be included.")
  597. (defcustom org-agenda-restriction-lock-highlight-subtree t
  598. "Non-nil means highlight the whole subtree when restriction is active.
  599. Otherwise only highlight the headline. Highlighting the whole subtree is
  600. useful to ensure no edits happen beyond the restricted region."
  601. :group 'org-agenda
  602. :type 'boolean)
  603. (defcustom org-agenda-skip-comment-trees t
  604. "Non-nil means skip trees that start with the COMMENT keyword.
  605. When nil, these trees are also scanned by agenda commands."
  606. :group 'org-agenda-skip
  607. :type 'boolean)
  608. (defcustom org-agenda-todo-list-sublevels t
  609. "Non-nil means check also the sublevels of a TODO entry for TODO entries.
  610. When nil, the sublevels of a TODO entry are not checked, resulting in
  611. potentially much shorter TODO lists."
  612. :group 'org-agenda-skip
  613. :group 'org-agenda-todo-list
  614. :type 'boolean)
  615. (defcustom org-agenda-todo-ignore-with-date nil
  616. "Non-nil means don't show entries with a date in the global todo list.
  617. You can use this if you prefer to mark mere appointments with a TODO keyword,
  618. but don't want them to show up in the TODO list.
  619. When this is set, it also covers deadlines and scheduled items, the settings
  620. of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
  621. will be ignored.
  622. See also the variable `org-agenda-tags-todo-honor-ignore-options'."
  623. :group 'org-agenda-skip
  624. :group 'org-agenda-todo-list
  625. :type 'boolean)
  626. (defcustom org-agenda-todo-ignore-timestamp nil
  627. "Non-nil means don't show entries with a timestamp.
  628. This applies when creating the global todo list.
  629. Valid values are:
  630. past Don't show entries for today or in the past.
  631. future Don't show entries with a timestamp in the future.
  632. The idea behind this is that if it has a future
  633. timestamp, you don't want to think about it until the
  634. date.
  635. all Don't show any entries with a timestamp in the global todo list.
  636. The idea behind this is that by setting a timestamp, you
  637. have already \"taken care\" of this item.
  638. This variable can also have an integer as a value. If positive (N),
  639. todos with a timestamp N or more days in the future will be ignored. If
  640. negative (-N), todos with a timestamp N or more days in the past will be
  641. ignored. If 0, todos with a timestamp either today or in the future will
  642. be ignored. For example, a value of -1 will exclude todos with a
  643. timestamp in the past (yesterday or earlier), while a value of 7 will
  644. exclude todos with a timestamp a week or more in the future.
  645. See also `org-agenda-todo-ignore-with-date'.
  646. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  647. to make his option also apply to the tags-todo list."
  648. :group 'org-agenda-skip
  649. :group 'org-agenda-todo-list
  650. :version "24.1"
  651. :type '(choice
  652. (const :tag "Ignore future timestamp todos" future)
  653. (const :tag "Ignore past or present timestamp todos" past)
  654. (const :tag "Ignore all timestamp todos" all)
  655. (const :tag "Show timestamp todos" nil)
  656. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  657. (defcustom org-agenda-todo-ignore-scheduled nil
  658. "Non-nil means, ignore some scheduled TODO items when making TODO list.
  659. This applies when creating the global todo list.
  660. Valid values are:
  661. past Don't show entries scheduled today or in the past.
  662. future Don't show entries scheduled in the future.
  663. The idea behind this is that by scheduling it, you don't want to
  664. think about it until the scheduled date.
  665. all Don't show any scheduled entries in the global todo list.
  666. The idea behind this is that by scheduling it, you have already
  667. \"taken care\" of this item.
  668. t Same as `all', for backward compatibility.
  669. This variable can also have an integer as a value. See
  670. `org-agenda-todo-ignore-timestamp' for more details.
  671. See also `org-agenda-todo-ignore-with-date'.
  672. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  673. to make his option also apply to the tags-todo list."
  674. :group 'org-agenda-skip
  675. :group 'org-agenda-todo-list
  676. :type '(choice
  677. (const :tag "Ignore future-scheduled todos" future)
  678. (const :tag "Ignore past- or present-scheduled todos" past)
  679. (const :tag "Ignore all scheduled todos" all)
  680. (const :tag "Ignore all scheduled todos (compatibility)" t)
  681. (const :tag "Show scheduled todos" nil)
  682. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  683. (defcustom org-agenda-todo-ignore-deadlines nil
  684. "Non-nil means ignore some deadline TODO items when making TODO list.
  685. There are different motivations for using different values, please think
  686. carefully when configuring this variable.
  687. This applies when creating the global todo list.
  688. Valid values are:
  689. near Don't show near deadline entries. A deadline is near when it is
  690. closer than `org-deadline-warning-days' days. The idea behind this
  691. is that such items will appear in the agenda anyway.
  692. far Don't show TODO entries where a deadline has been defined, but
  693. the deadline is not near. This is useful if you don't want to
  694. use the todo list to figure out what to do now.
  695. past Don't show entries with a deadline timestamp for today or in the past.
  696. future Don't show entries with a deadline timestamp in the future, not even
  697. when they become `near' ones. Use it with caution.
  698. all Ignore all TODO entries that do have a deadline.
  699. t Same as `near', for backward compatibility.
  700. This variable can also have an integer as a value. See
  701. `org-agenda-todo-ignore-timestamp' for more details.
  702. See also `org-agenda-todo-ignore-with-date'.
  703. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  704. to make his option also apply to the tags-todo list."
  705. :group 'org-agenda-skip
  706. :group 'org-agenda-todo-list
  707. :type '(choice
  708. (const :tag "Ignore near deadlines" near)
  709. (const :tag "Ignore near deadlines (compatibility)" t)
  710. (const :tag "Ignore far deadlines" far)
  711. (const :tag "Ignore all TODOs with a deadlines" all)
  712. (const :tag "Show all TODOs, even if they have a deadline" nil)
  713. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  714. (defcustom org-agenda-todo-ignore-time-comparison-use-seconds nil
  715. "Time unit to use when possibly ignoring an agenda item.
  716. See the docstring of various `org-agenda-todo-ignore-*' options.
  717. The default is to compare time stamps using days. An item is thus
  718. considered to be in the future if it is at least one day after today.
  719. Non-nil means to compare time stamps using seconds. An item is then
  720. considered future if it has a time value later than current time."
  721. :group 'org-agenda-skip
  722. :group 'org-agenda-todo-list
  723. :version "24.4"
  724. :package-version '(Org . "8.0")
  725. :type '(choice
  726. (const :tag "Compare time with days" nil)
  727. (const :tag "Compare time with seconds" t)))
  728. (defcustom org-agenda-tags-todo-honor-ignore-options nil
  729. "Non-nil means honor todo-list ignores options also in tags-todo search.
  730. The variables
  731. `org-agenda-todo-ignore-with-date',
  732. `org-agenda-todo-ignore-timestamp',
  733. `org-agenda-todo-ignore-scheduled',
  734. `org-agenda-todo-ignore-deadlines'
  735. make the global TODO list skip entries that have time stamps of certain
  736. kinds. If this option is set, the same options will also apply for the
  737. tags-todo search, which is the general tags/property matcher
  738. restricted to unfinished TODO entries only."
  739. :group 'org-agenda-skip
  740. :group 'org-agenda-todo-list
  741. :group 'org-agenda-match-view
  742. :type 'boolean)
  743. (defcustom org-agenda-skip-scheduled-if-done nil
  744. "Non-nil means don't show scheduled items in agenda when they are done.
  745. This is relevant for the daily/weekly agenda, not for the TODO list. And
  746. it applies only to the actual date of the scheduling. Warnings about
  747. an item with a past scheduling dates are always turned off when the item
  748. is DONE."
  749. :group 'org-agenda-skip
  750. :group 'org-agenda-daily/weekly
  751. :type 'boolean)
  752. (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
  753. "Non-nil means skip scheduling line if same entry shows because of deadline.
  754. In the agenda of today, an entry can show up multiple times
  755. because it is both scheduled and has a nearby deadline, and maybe
  756. a plain time stamp as well.
  757. When this variable is nil, the entry will be shown several times.
  758. When set to t, then only the deadline is shown and the fact that
  759. the entry is scheduled today or was scheduled previously is not
  760. shown.
  761. When set to the symbol `not-today', skip scheduled previously,
  762. but not scheduled today.
  763. When set to the symbol `repeated-after-deadline', skip scheduled
  764. items if they are repeated beyond the current deadline."
  765. :group 'org-agenda-skip
  766. :group 'org-agenda-daily/weekly
  767. :type '(choice
  768. (const :tag "Never" nil)
  769. (const :tag "Always" t)
  770. (const :tag "Not when scheduled today" not-today)
  771. (const :tag "When repeated past deadline" repeated-after-deadline)))
  772. (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
  773. "Non-nil means skip timestamp line if same entry shows because of deadline.
  774. In the agenda of today, an entry can show up multiple times
  775. because it has both a plain timestamp and has a nearby deadline.
  776. When this variable is t, then only the deadline is shown and the
  777. fact that the entry has a timestamp for or including today is not
  778. shown. When this variable is nil, the entry will be shown
  779. several times."
  780. :group 'org-agenda-skip
  781. :group 'org-agenda-daily/weekly
  782. :version "24.1"
  783. :type '(choice
  784. (const :tag "Never" nil)
  785. (const :tag "Always" t)))
  786. (defcustom org-agenda-skip-deadline-if-done nil
  787. "Non-nil means don't show deadlines when the corresponding item is done.
  788. When nil, the deadline is still shown and should give you a happy feeling.
  789. This is relevant for the daily/weekly agenda. And it applied only to the
  790. actually date of the deadline. Warnings about approaching and past-due
  791. deadlines are always turned off when the item is DONE."
  792. :group 'org-agenda-skip
  793. :group 'org-agenda-daily/weekly
  794. :type 'boolean)
  795. (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
  796. "Non-nil means skip deadline prewarning when entry is also scheduled.
  797. This will apply on all days where a prewarning for the deadline would
  798. be shown, but not at the day when the entry is actually due. On that day,
  799. the deadline will be shown anyway.
  800. This variable may be set to nil, t, the symbol `pre-scheduled',
  801. or a number which will then give the number of days before the actual
  802. deadline when the prewarnings should resume. The symbol `pre-scheduled'
  803. eliminates the deadline prewarning only prior to the scheduled date.
  804. This can be used in a workflow where the first showing of the deadline will
  805. trigger you to schedule it, and then you don't want to be reminded of it
  806. because you will take care of it on the day when scheduled."
  807. :group 'org-agenda-skip
  808. :group 'org-agenda-daily/weekly
  809. :version "24.1"
  810. :type '(choice
  811. (const :tag "Always show prewarning" nil)
  812. (const :tag "Remove prewarning prior to scheduled date" pre-scheduled)
  813. (const :tag "Remove prewarning if entry is scheduled" t)
  814. (integer :tag "Restart prewarning N days before deadline")))
  815. (defcustom org-agenda-skip-scheduled-delay-if-deadline nil
  816. "Non-nil means skip scheduled delay when entry also has a deadline.
  817. This variable may be set to nil, t, the symbol `post-deadline',
  818. or a number which will then give the number of days after the actual
  819. scheduled date when the delay should expire. The symbol `post-deadline'
  820. eliminates the schedule delay when the date is posterior to the deadline."
  821. :group 'org-agenda-skip
  822. :group 'org-agenda-daily/weekly
  823. :version "24.4"
  824. :package-version '(Org . "8.0")
  825. :type '(choice
  826. (const :tag "Always honor delay" nil)
  827. (const :tag "Ignore delay if posterior to the deadline" post-deadline)
  828. (const :tag "Ignore delay if entry has a deadline" t)
  829. (integer :tag "Honor delay up until N days after the scheduled date")))
  830. (defcustom org-agenda-skip-additional-timestamps-same-entry nil
  831. "When nil, multiple same-day timestamps in entry make multiple agenda lines.
  832. When non-nil, after the search for timestamps has matched once in an
  833. entry, the rest of the entry will not be searched."
  834. :group 'org-agenda-skip
  835. :type 'boolean)
  836. (defcustom org-agenda-skip-timestamp-if-done nil
  837. "Non-nil means don't select item by timestamp or -range if it is DONE."
  838. :group 'org-agenda-skip
  839. :group 'org-agenda-daily/weekly
  840. :type 'boolean)
  841. (defcustom org-agenda-dim-blocked-tasks t
  842. "Non-nil means dim blocked tasks in the agenda display.
  843. This causes some overhead during agenda construction, but if you
  844. have turned on `org-enforce-todo-dependencies',
  845. `org-enforce-todo-checkbox-dependencies', or any other blocking
  846. mechanism, this will create useful feedback in the agenda.
  847. Instead of t, this variable can also have the value `invisible'.
  848. Then blocked tasks will be invisible and only become visible when
  849. they become unblocked. An exemption to this behavior is when a task is
  850. blocked because of unchecked checkboxes below it. Since checkboxes do
  851. not show up in the agenda views, making this task invisible you remove any
  852. trace from agenda views that there is something to do. Therefore, a task
  853. that is blocked because of checkboxes will never be made invisible, it
  854. will only be dimmed."
  855. :group 'org-agenda-daily/weekly
  856. :group 'org-agenda-todo-list
  857. :version "24.3"
  858. :type '(choice
  859. (const :tag "Do not dim" nil)
  860. (const :tag "Dim to a gray face" t)
  861. (const :tag "Make invisible" invisible)))
  862. (defcustom org-timeline-show-empty-dates 3
  863. "Non-nil means `org-timeline' also shows dates without an entry.
  864. When nil, only the days which actually have entries are shown.
  865. When t, all days between the first and the last date are shown.
  866. When an integer, show also empty dates, but if there is a gap of more than
  867. N days, just insert a special line indicating the size of the gap."
  868. :group 'org-agenda-skip
  869. :type '(choice
  870. (const :tag "None" nil)
  871. (const :tag "All" t)
  872. (integer :tag "at most")))
  873. (defgroup org-agenda-startup nil
  874. "Options concerning initial settings in the Agenda in Org Mode."
  875. :tag "Org Agenda Startup"
  876. :group 'org-agenda)
  877. (defcustom org-agenda-menu-show-matcher t
  878. "Non-nil means show the match string in the agenda dispatcher menu.
  879. When nil, the matcher string is not shown, but is put into the help-echo
  880. property so than moving the mouse over the command shows it.
  881. Setting it to nil is good if matcher strings are very long and/or if
  882. you want to use two-columns display (see `org-agenda-menu-two-columns')."
  883. :group 'org-agenda
  884. :version "24.1"
  885. :type 'boolean)
  886. (defcustom org-agenda-menu-two-columns nil
  887. "Non-nil means, use two columns to show custom commands in the dispatcher.
  888. If you use this, you probably want to set `org-agenda-menu-show-matcher'
  889. to nil."
  890. :group 'org-agenda
  891. :version "24.1"
  892. :type 'boolean)
  893. (defcustom org-agenda-finalize-hook nil
  894. "Hook run just before displaying an agenda buffer.
  895. The buffer is still writable when the hook is called.
  896. You can modify some of the buffer substrings but you should be
  897. extra careful not to modify the text properties of the agenda
  898. headlines as the agenda display heavily relies on them."
  899. :group 'org-agenda-startup
  900. :type 'hook)
  901. (defcustom org-agenda-mouse-1-follows-link nil
  902. "Non-nil means mouse-1 on a link will follow the link in the agenda.
  903. A longer mouse click will still set point. Needs to be set
  904. before org.el is loaded."
  905. :group 'org-agenda-startup
  906. :type 'boolean)
  907. (defcustom org-agenda-start-with-follow-mode nil
  908. "The initial value of follow mode in a newly created agenda window."
  909. :group 'org-agenda-startup
  910. :type 'boolean)
  911. (defcustom org-agenda-follow-indirect nil
  912. "Non-nil means `org-agenda-follow-mode' displays only the
  913. current item's tree, in an indirect buffer."
  914. :group 'org-agenda
  915. :version "24.1"
  916. :type 'boolean)
  917. (defcustom org-agenda-show-outline-path t
  918. "Non-nil means show outline path in echo area after line motion."
  919. :group 'org-agenda-startup
  920. :type 'boolean)
  921. (defcustom org-agenda-start-with-entry-text-mode nil
  922. "The initial value of entry-text-mode in a newly created agenda window."
  923. :group 'org-agenda-startup
  924. :type 'boolean)
  925. (defcustom org-agenda-entry-text-maxlines 5
  926. "Number of text lines to be added when `E' is pressed in the agenda.
  927. Note that this variable only used during agenda display. To add entry text
  928. when exporting the agenda, configure the variable
  929. `org-agenda-add-entry-text-maxlines'."
  930. :group 'org-agenda
  931. :type 'integer)
  932. (defcustom org-agenda-entry-text-exclude-regexps nil
  933. "List of regular expressions to clean up entry text.
  934. The complete matches of all regular expressions in this list will be
  935. removed from entry text before it is shown in the agenda."
  936. :group 'org-agenda
  937. :type '(repeat (regexp)))
  938. (defcustom org-agenda-entry-text-leaders " > "
  939. "Text prepended to the entry text in agenda buffers."
  940. :version "24.4"
  941. :package-version '(Org . "8.0")
  942. :group 'org-agenda
  943. :type 'string)
  944. (defvar org-agenda-entry-text-cleanup-hook nil
  945. "Hook that is run after basic cleanup of entry text to be shown in agenda.
  946. This cleanup is done in a temporary buffer, so the function may inspect and
  947. change the entire buffer.
  948. Some default stuff like drawers and scheduling/deadline dates will already
  949. have been removed when this is called, as will any matches for regular
  950. expressions listed in `org-agenda-entry-text-exclude-regexps'.")
  951. (defvar org-agenda-include-inactive-timestamps nil
  952. "Non-nil means include inactive time stamps in agenda and timeline.
  953. Dynamically scoped.")
  954. (defgroup org-agenda-windows nil
  955. "Options concerning the windows used by the Agenda in Org Mode."
  956. :tag "Org Agenda Windows"
  957. :group 'org-agenda)
  958. (defcustom org-agenda-window-setup 'reorganize-frame
  959. "How the agenda buffer should be displayed.
  960. Possible values for this option are:
  961. current-window Show agenda in the current window, keeping all other windows.
  962. other-window Use `switch-to-buffer-other-window' to display agenda.
  963. only-window Show agenda, deleting all other windows.
  964. reorganize-frame Show only two windows on the current frame, the current
  965. window and the agenda.
  966. other-frame Use `switch-to-buffer-other-frame' to display agenda.
  967. Also, when exiting the agenda, kill that frame.
  968. See also the variable `org-agenda-restore-windows-after-quit'."
  969. :group 'org-agenda-windows
  970. :type '(choice
  971. (const current-window)
  972. (const other-frame)
  973. (const other-window)
  974. (const only-window)
  975. (const reorganize-frame)))
  976. (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
  977. "The min and max height of the agenda window as a fraction of frame height.
  978. The value of the variable is a cons cell with two numbers between 0 and 1.
  979. It only matters if `org-agenda-window-setup' is `reorganize-frame'."
  980. :group 'org-agenda-windows
  981. :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
  982. (defcustom org-agenda-restore-windows-after-quit nil
  983. "Non-nil means restore window configuration upon exiting agenda.
  984. Before the window configuration is changed for displaying the agenda,
  985. the current status is recorded. When the agenda is exited with
  986. `q' or `x' and this option is set, the old state is restored. If
  987. `org-agenda-window-setup' is `other-frame', the value of this
  988. option will be ignored."
  989. :group 'org-agenda-windows
  990. :type 'boolean)
  991. (defcustom org-agenda-span 'week
  992. "Number of days to include in overview display.
  993. Can be day, week, month, year, or any number of days.
  994. Custom commands can set this variable in the options section."
  995. :group 'org-agenda-daily/weekly
  996. :type '(choice (const :tag "Day" day)
  997. (const :tag "Week" week)
  998. (const :tag "Fortnight" fortnight)
  999. (const :tag "Month" month)
  1000. (const :tag "Year" year)
  1001. (integer :tag "Custom")))
  1002. (defcustom org-agenda-start-on-weekday 1
  1003. "Non-nil means start the overview always on the specified weekday.
  1004. 0 denotes Sunday, 1 denotes Monday, etc.
  1005. When nil, always start on the current day.
  1006. Custom commands can set this variable in the options section."
  1007. :group 'org-agenda-daily/weekly
  1008. :type '(choice (const :tag "Today" nil)
  1009. (integer :tag "Weekday No.")))
  1010. (defcustom org-agenda-show-all-dates t
  1011. "Non-nil means `org-agenda' shows every day in the selected range.
  1012. When nil, only the days which actually have entries are shown."
  1013. :group 'org-agenda-daily/weekly
  1014. :type 'boolean)
  1015. (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
  1016. "Format string for displaying dates in the agenda.
  1017. Used by the daily/weekly agenda and by the timeline. This should be
  1018. a format string understood by `format-time-string', or a function returning
  1019. the formatted date as a string. The function must take a single argument,
  1020. a calendar-style date list like (month day year)."
  1021. :group 'org-agenda-daily/weekly
  1022. :type '(choice
  1023. (string :tag "Format string")
  1024. (function :tag "Function")))
  1025. (defun org-agenda-format-date-aligned (date)
  1026. "Format a DATE string for display in the daily/weekly agenda, or timeline.
  1027. This function makes sure that dates are aligned for easy reading."
  1028. (require 'cal-iso)
  1029. (let* ((dayname (calendar-day-name date))
  1030. (day (cadr date))
  1031. (day-of-week (calendar-day-of-week date))
  1032. (month (car date))
  1033. (monthname (calendar-month-name month))
  1034. (year (nth 2 date))
  1035. (iso-week (org-days-to-iso-week
  1036. (calendar-absolute-from-gregorian date)))
  1037. (weekyear (cond ((and (= month 1) (>= iso-week 52))
  1038. (1- year))
  1039. ((and (= month 12) (<= iso-week 1))
  1040. (1+ year))
  1041. (t year)))
  1042. (weekstring (if (= day-of-week 1)
  1043. (format " W%02d" iso-week)
  1044. "")))
  1045. (format "%-10s %2d %s %4d%s"
  1046. dayname day monthname year weekstring)))
  1047. (defcustom org-agenda-time-leading-zero nil
  1048. "Non-nil means use leading zero for military times in agenda.
  1049. For example, 9:30am would become 09:30 rather than 9:30."
  1050. :group 'org-agenda-daily/weekly
  1051. :version "24.1"
  1052. :type 'boolean)
  1053. (defcustom org-agenda-timegrid-use-ampm nil
  1054. "When set, show AM/PM style timestamps on the timegrid."
  1055. :group 'org-agenda
  1056. :version "24.1"
  1057. :type 'boolean)
  1058. (defun org-agenda-time-of-day-to-ampm (time)
  1059. "Convert TIME of a string like \"13:45\" to an AM/PM style time string."
  1060. (let* ((hour-number (string-to-number (substring time 0 -3)))
  1061. (minute (substring time -2))
  1062. (ampm "am"))
  1063. (cond
  1064. ((equal hour-number 12)
  1065. (setq ampm "pm"))
  1066. ((> hour-number 12)
  1067. (setq ampm "pm")
  1068. (setq hour-number (- hour-number 12))))
  1069. (concat
  1070. (if org-agenda-time-leading-zero
  1071. (format "%02d" hour-number)
  1072. (format "%02s" (number-to-string hour-number)))
  1073. ":" minute ampm)))
  1074. (defun org-agenda-time-of-day-to-ampm-maybe (time)
  1075. "Conditionally convert TIME to AM/PM format based on `org-agenda-timegrid-use-ampm'."
  1076. (if org-agenda-timegrid-use-ampm
  1077. (org-agenda-time-of-day-to-ampm time)
  1078. time))
  1079. (defcustom org-agenda-weekend-days '(6 0)
  1080. "Which days are weekend?
  1081. These days get the special face `org-agenda-date-weekend' in the agenda
  1082. and timeline buffers."
  1083. :group 'org-agenda-daily/weekly
  1084. :type '(set :greedy t
  1085. (const :tag "Monday" 1)
  1086. (const :tag "Tuesday" 2)
  1087. (const :tag "Wednesday" 3)
  1088. (const :tag "Thursday" 4)
  1089. (const :tag "Friday" 5)
  1090. (const :tag "Saturday" 6)
  1091. (const :tag "Sunday" 0)))
  1092. (defcustom org-agenda-move-date-from-past-immediately-to-today t
  1093. "Non-nil means jump to today when moving a past date forward in time.
  1094. When using S-right in the agenda to move a a date forward, and the date
  1095. stamp currently points to the past, the first key press will move it
  1096. to today. WHen nil, just move one day forward even if the date stays
  1097. in the past."
  1098. :group 'org-agenda-daily/weekly
  1099. :version "24.1"
  1100. :type 'boolean)
  1101. (defcustom org-agenda-include-diary nil
  1102. "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
  1103. Custom commands can set this variable in the options section."
  1104. :group 'org-agenda-daily/weekly
  1105. :type 'boolean)
  1106. (defcustom org-agenda-include-deadlines t
  1107. "If non-nil, include entries within their deadline warning period.
  1108. Custom commands can set this variable in the options section."
  1109. :group 'org-agenda-daily/weekly
  1110. :version "24.1"
  1111. :type 'boolean)
  1112. (defcustom org-agenda-repeating-timestamp-show-all t
  1113. "Non-nil means show all occurrences of a repeating stamp in the agenda.
  1114. When set to a list of strings, only show occurrences of repeating
  1115. stamps for these TODO keywords. When nil, only one occurrence is
  1116. shown, either today or the nearest into the future."
  1117. :group 'org-agenda-daily/weekly
  1118. :type '(choice
  1119. (const :tag "Show repeating stamps" t)
  1120. (repeat :tag "Show repeating stamps for these TODO keywords"
  1121. (string :tag "TODO Keyword"))
  1122. (const :tag "Don't show repeating stamps" nil)))
  1123. (defcustom org-scheduled-past-days 10000
  1124. "Number of days to continue listing scheduled items not marked DONE.
  1125. When an item is scheduled on a date, it shows up in the agenda on
  1126. this day and will be listed until it is marked done or for the
  1127. number of days given here."
  1128. :group 'org-agenda-daily/weekly
  1129. :type 'integer)
  1130. (defcustom org-agenda-log-mode-items '(closed clock)
  1131. "List of items that should be shown in agenda log mode.
  1132. \\<org-agenda-mode-map>\
  1133. This list may contain the following symbols:
  1134. closed Show entries that have been closed on that day.
  1135. clock Show entries that have received clocked time on that day.
  1136. state Show all logged state changes.
  1137. Note that instead of changing this variable, you can also press \
  1138. `\\[universal-argument] \\[org-agenda-log-mode]' in
  1139. the agenda to display all available LOG items temporarily."
  1140. :group 'org-agenda-daily/weekly
  1141. :type '(set :greedy t (const closed) (const clock) (const state)))
  1142. (defcustom org-agenda-clock-consistency-checks
  1143. '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
  1144. :gap-ok-around ("4:00")
  1145. :default-face ((:background "DarkRed") (:foreground "white"))
  1146. :overlap-face nil :gap-face nil :no-end-time-face nil
  1147. :long-face nil :short-face nil)
  1148. "This is a property list, with the following keys:
  1149. :max-duration Mark clocking chunks that are longer than this time.
  1150. This is a time string like \"HH:MM\", or the number
  1151. of minutes as an integer.
  1152. :min-duration Mark clocking chunks that are shorter that this.
  1153. This is a time string like \"HH:MM\", or the number
  1154. of minutes as an integer.
  1155. :max-gap Mark gaps between clocking chunks that are longer than
  1156. this duration. A number of minutes, or a string
  1157. like \"HH:MM\".
  1158. :gap-ok-around List of times during the day which are usually not working
  1159. times. When a gap is detected, but the gap contains any
  1160. of these times, the gap is *not* reported. For example,
  1161. if this is (\"4:00\" \"13:00\") then gaps that contain
  1162. 4:00 in the morning (i.e. the night) and 13:00
  1163. (i.e. a typical lunch time) do not cause a warning.
  1164. You should have at least one time during the night in this
  1165. list, or otherwise the first task each morning will trigger
  1166. a warning because it follows a long gap.
  1167. Furthermore, the following properties can be used to define faces for
  1168. issue display.
  1169. :default-face the default face, if the specific face is undefined
  1170. :overlap-face face for overlapping clocks
  1171. :gap-face face for gaps between clocks
  1172. :no-end-time-face face for incomplete clocks
  1173. :long-face face for clock intervals that are too long
  1174. :short-face face for clock intervals that are too short"
  1175. :group 'org-agenda-daily/weekly
  1176. :group 'org-clock
  1177. :version "24.1"
  1178. :type 'plist)
  1179. (defcustom org-agenda-log-mode-add-notes t
  1180. "Non-nil means add first line of notes to log entries in agenda views.
  1181. If a log item like a state change or a clock entry is associated with
  1182. notes, the first line of these notes will be added to the entry in the
  1183. agenda display."
  1184. :group 'org-agenda-daily/weekly
  1185. :type 'boolean)
  1186. (defcustom org-agenda-start-with-log-mode nil
  1187. "The initial value of log-mode in a newly created agenda window.
  1188. See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
  1189. explanations on the possible values."
  1190. :group 'org-agenda-startup
  1191. :group 'org-agenda-daily/weekly
  1192. :type '(choice (const :tag "Don't show log items" nil)
  1193. (const :tag "Show only log items" only)
  1194. (const :tag "Show all possible log items" clockcheck)
  1195. (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
  1196. (choice (const :tag "Show closed log items" closed)
  1197. (const :tag "Show clocked log items" clock)
  1198. (const :tag "Show all logged state changes" state)))))
  1199. (defcustom org-agenda-start-with-clockreport-mode nil
  1200. "The initial value of clockreport-mode in a newly created agenda window."
  1201. :group 'org-agenda-startup
  1202. :group 'org-agenda-daily/weekly
  1203. :type 'boolean)
  1204. (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
  1205. "Property list with parameters for the clocktable in clockreport mode.
  1206. This is the display mode that shows a clock table in the daily/weekly
  1207. agenda, the properties for this dynamic block can be set here.
  1208. The usual clocktable parameters are allowed here, but you cannot set
  1209. the properties :name, :tstart, :tend, :block, and :scope - these will
  1210. be overwritten to make sure the content accurately reflects the
  1211. current display in the agenda."
  1212. :group 'org-agenda-daily/weekly
  1213. :type 'plist)
  1214. (defcustom org-agenda-search-view-always-boolean nil
  1215. "Non-nil means the search string is interpreted as individual parts.
  1216. The search string for search view can either be interpreted as a phrase,
  1217. or as a list of snippets that define a boolean search for a number of
  1218. strings.
  1219. When this is non-nil, the string will be split on whitespace, and each
  1220. snippet will be searched individually, and all must match in order to
  1221. select an entry. A snippet is then a single string of non-white
  1222. characters, or a string in double quotes, or a regexp in {} braces.
  1223. If a snippet is preceded by \"-\", the snippet must *not* match.
  1224. \"+\" is syntactic sugar for positive selection. Each snippet may
  1225. be found as a full word or a partial word, but see the variable
  1226. `org-agenda-search-view-force-full-words'.
  1227. When this is nil, search will look for the entire search phrase as one,
  1228. with each space character matching any amount of whitespace, including
  1229. line breaks.
  1230. Even when this is nil, you can still switch to Boolean search dynamically
  1231. by preceding the first snippet with \"+\" or \"-\". If the first snippet
  1232. is a regexp marked with braces like \"{abc}\", this will also switch to
  1233. boolean search."
  1234. :group 'org-agenda-search-view
  1235. :version "24.1"
  1236. :type 'boolean)
  1237. (defvaralias 'org-agenda-search-view-search-words-only
  1238. 'org-agenda-search-view-always-boolean)
  1239. (defcustom org-agenda-search-view-force-full-words nil
  1240. "Non-nil means, search words must be matches as complete words.
  1241. When nil, they may also match part of a word."
  1242. :group 'org-agenda-search-view
  1243. :version "24.1"
  1244. :type 'boolean)
  1245. (defcustom org-agenda-search-view-max-outline-level 0
  1246. "Maximum outline level to display in search view.
  1247. E.g. when this is set to 1, the search view will only
  1248. show headlines of level 1. When set to 0, the default
  1249. value, don't limit agenda view by outline level."
  1250. :group 'org-agenda-search-view
  1251. :version "24.4"
  1252. :package-version '(Org . "8.3")
  1253. :type 'integer)
  1254. (defgroup org-agenda-time-grid nil
  1255. "Options concerning the time grid in the Org Agenda."
  1256. :tag "Org Agenda Time Grid"
  1257. :group 'org-agenda)
  1258. (defcustom org-agenda-search-headline-for-time t
  1259. "Non-nil means search headline for a time-of-day.
  1260. If the headline contains a time-of-day in one format or another, it will
  1261. be used to sort the entry into the time sequence of items for a day.
  1262. Some people have time stamps in the headline that refer to the creation
  1263. time or so, and then this produces an unwanted side effect. If this is
  1264. the case for your, use this variable to turn off searching the headline
  1265. for a time."
  1266. :group 'org-agenda-time-grid
  1267. :type 'boolean)
  1268. (defcustom org-agenda-use-time-grid t
  1269. "Non-nil means show a time grid in the agenda schedule.
  1270. A time grid is a set of lines for specific times (like every two hours between
  1271. 8:00 and 20:00). The items scheduled for a day at specific times are
  1272. sorted in between these lines.
  1273. For details about when the grid will be shown, and what it will look like, see
  1274. the variable `org-agenda-time-grid'."
  1275. :group 'org-agenda-time-grid
  1276. :type 'boolean)
  1277. (defcustom org-agenda-time-grid
  1278. '((daily today require-timed)
  1279. "----------------"
  1280. (800 1000 1200 1400 1600 1800 2000))
  1281. "The settings for time grid for agenda display.
  1282. This is a list of three items. The first item is again a list. It contains
  1283. symbols specifying conditions when the grid should be displayed:
  1284. daily if the agenda shows a single day
  1285. weekly if the agenda shows an entire week
  1286. today show grid on current date, independent of daily/weekly display
  1287. require-timed show grid only if at least one item has a time specification
  1288. remove-match skip grid times already present in an entry
  1289. The second item is a string which will be placed behind the grid time.
  1290. The third item is a list of integers, indicating the times that should have
  1291. a grid line."
  1292. :group 'org-agenda-time-grid
  1293. :type
  1294. '(list
  1295. (set :greedy t :tag "Grid Display Options"
  1296. (const :tag "Show grid in single day agenda display" daily)
  1297. (const :tag "Show grid in weekly agenda display" weekly)
  1298. (const :tag "Always show grid for today" today)
  1299. (const :tag "Show grid only if any timed entries are present"
  1300. require-timed)
  1301. (const :tag "Skip grid times already present in an entry"
  1302. remove-match))
  1303. (string :tag "Grid String")
  1304. (repeat :tag "Grid Times" (integer :tag "Time"))))
  1305. (defcustom org-agenda-show-current-time-in-grid t
  1306. "Non-nil means show the current time in the time grid."
  1307. :group 'org-agenda-time-grid
  1308. :version "24.1"
  1309. :type 'boolean)
  1310. (defcustom org-agenda-current-time-string
  1311. "now - - - - - - - - - - - - - - - - - - - - - - - - -"
  1312. "The string for the current time marker in the agenda."
  1313. :group 'org-agenda-time-grid
  1314. :version "24.1"
  1315. :type 'string)
  1316. (defgroup org-agenda-sorting nil
  1317. "Options concerning sorting in the Org Agenda."
  1318. :tag "Org Agenda Sorting"
  1319. :group 'org-agenda)
  1320. (defcustom org-agenda-sorting-strategy
  1321. '((agenda habit-down time-up priority-down category-keep)
  1322. (todo priority-down category-keep)
  1323. (tags priority-down category-keep)
  1324. (search category-keep))
  1325. "Sorting structure for the agenda items of a single day.
  1326. This is a list of symbols which will be used in sequence to determine
  1327. if an entry should be listed before another entry. The following
  1328. symbols are recognized:
  1329. time-up Put entries with time-of-day indications first, early first
  1330. time-down Put entries with time-of-day indications first, late first
  1331. timestamp-up Sort by any timestamp, early first
  1332. timestamp-down Sort by any timestamp, late first
  1333. scheduled-up Sort by scheduled timestamp, early first
  1334. scheduled-down Sort by scheduled timestamp, late first
  1335. deadline-up Sort by deadline timestamp, early first
  1336. deadline-down Sort by deadline timestamp, late first
  1337. ts-up Sort by active timestamp, early first
  1338. ts-down Sort by active timestamp, late first
  1339. tsia-up Sort by inactive timestamp, early first
  1340. tsia-down Sort by inactive timestamp, late first
  1341. category-keep Keep the default order of categories, corresponding to the
  1342. sequence in `org-agenda-files'.
  1343. category-up Sort alphabetically by category, A-Z.
  1344. category-down Sort alphabetically by category, Z-A.
  1345. tag-up Sort alphabetically by last tag, A-Z.
  1346. tag-down Sort alphabetically by last tag, Z-A.
  1347. priority-up Sort numerically by priority, high priority last.
  1348. priority-down Sort numerically by priority, high priority first.
  1349. todo-state-up Sort by todo state, tasks that are done last.
  1350. todo-state-down Sort by todo state, tasks that are done first.
  1351. effort-up Sort numerically by estimated effort, high effort last.
  1352. effort-down Sort numerically by estimated effort, high effort first.
  1353. user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
  1354. user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
  1355. habit-up Put entries that are habits first
  1356. habit-down Put entries that are habits last
  1357. alpha-up Sort headlines alphabetically
  1358. alpha-down Sort headlines alphabetically, reversed
  1359. The different possibilities will be tried in sequence, and testing stops
  1360. if one comparison returns a \"not-equal\". For example, the default
  1361. '(time-up category-keep priority-down)
  1362. means: Pull out all entries having a specified time of day and sort them,
  1363. in order to make a time schedule for the current day the first thing in the
  1364. agenda listing for the day. Of the entries without a time indication, keep
  1365. the grouped in categories, don't sort the categories, but keep them in
  1366. the sequence given in `org-agenda-files'. Within each category sort by
  1367. priority.
  1368. Leaving out `category-keep' would mean that items will be sorted across
  1369. categories by priority.
  1370. Instead of a single list, this can also be a set of list for specific
  1371. contents, with a context symbol in the car of the list, any of
  1372. `agenda', `todo', `tags', `search' for the corresponding agenda views.
  1373. Custom commands can bind this variable in the options section."
  1374. :group 'org-agenda-sorting
  1375. :type `(choice
  1376. (repeat :tag "General" ,org-sorting-choice)
  1377. (list :tag "Individually"
  1378. (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
  1379. (repeat ,org-sorting-choice))
  1380. (cons (const :tag "Strategy for TODO lists" todo)
  1381. (repeat ,org-sorting-choice))
  1382. (cons (const :tag "Strategy for Tags matches" tags)
  1383. (repeat ,org-sorting-choice))
  1384. (cons (const :tag "Strategy for search matches" search)
  1385. (repeat ,org-sorting-choice)))))
  1386. (defcustom org-agenda-cmp-user-defined nil
  1387. "A function to define the comparison `user-defined'.
  1388. This function must receive two arguments, agenda entry a and b.
  1389. If a>b, return +1. If a<b, return -1. If they are equal as seen by
  1390. the user comparison, return nil.
  1391. When this is defined, you can make `user-defined-up' and `user-defined-down'
  1392. part of an agenda sorting strategy."
  1393. :group 'org-agenda-sorting
  1394. :type 'symbol)
  1395. (defcustom org-sort-agenda-notime-is-late t
  1396. "Non-nil means items without time are considered late.
  1397. This is only relevant for sorting. When t, items which have no explicit
  1398. time like 15:30 will be considered as 99:01, i.e. later than any items which
  1399. do have a time. When nil, the default time is before 0:00. You can use this
  1400. option to decide if the schedule for today should come before or after timeless
  1401. agenda entries."
  1402. :group 'org-agenda-sorting
  1403. :type 'boolean)
  1404. (defcustom org-sort-agenda-noeffort-is-high t
  1405. "Non-nil means items without effort estimate are sorted as high effort.
  1406. This also applies when filtering an agenda view with respect to the
  1407. < or > effort operator. Then, tasks with no effort defined will be treated
  1408. as tasks with high effort.
  1409. When nil, such items are sorted as 0 minutes effort."
  1410. :group 'org-agenda-sorting
  1411. :type 'boolean)
  1412. (defgroup org-agenda-line-format nil
  1413. "Options concerning the entry prefix in the Org agenda display."
  1414. :tag "Org Agenda Line Format"
  1415. :group 'org-agenda)
  1416. (defcustom org-agenda-prefix-format
  1417. '((agenda . " %i %-12:c%?-12t% s")
  1418. (timeline . " % s")
  1419. (todo . " %i %-12:c")
  1420. (tags . " %i %-12:c")
  1421. (search . " %i %-12:c"))
  1422. "Format specifications for the prefix of items in the agenda views.
  1423. An alist with five entries, each for the different agenda types. The
  1424. keys of the sublists are `agenda', `timeline', `todo', `search' and `tags'.
  1425. The values are format strings.
  1426. This format works similar to a printf format, with the following meaning:
  1427. %c the category of the item, \"Diary\" for entries from the diary,
  1428. or as given by the CATEGORY keyword or derived from the file name
  1429. %e the effort required by the item
  1430. %l the level of the item (insert X space(s) if item is of level X)
  1431. %i the icon category of the item, see `org-agenda-category-icon-alist'
  1432. %T the last tag of the item (ignore inherited tags, which come first)
  1433. %t the HH:MM time-of-day specification if one applies to the entry
  1434. %s Scheduling/Deadline information, a short string
  1435. %b show breadcrumbs, i.e., the names of the higher levels
  1436. %(expression) Eval EXPRESSION and replace the control string
  1437. by the result
  1438. All specifiers work basically like the standard `%s' of printf, but may
  1439. contain two additional characters: a question mark just after the `%'
  1440. and a whitespace/punctuation character just before the final letter.
  1441. If the first character after `%' is a question mark, the entire field
  1442. will only be included if the corresponding value applies to the current
  1443. entry. This is useful for fields which should have fixed width when
  1444. present, but zero width when absent. For example, \"%?-12t\" will
  1445. result in a 12 character time field if a time of the day is specified,
  1446. but will completely disappear in entries which do not contain a time.
  1447. If there is punctuation or whitespace character just before the
  1448. final format letter, this character will be appended to the field
  1449. value if the value is not empty. For example, the format
  1450. \"%-12:c\" leads to \"Diary: \" if the category is \"Diary\". If
  1451. the category is empty, no additional colon is inserted.
  1452. The default value for the agenda sublist is \" %-12:c%?-12t% s\",
  1453. which means:
  1454. - Indent the line with two space characters
  1455. - Give the category a 12 chars wide field, padded with whitespace on
  1456. the right (because of `-'). Append a colon if there is a category
  1457. (because of `:').
  1458. - If there is a time-of-day, put it into a 12 chars wide field. If no
  1459. time, don't put in an empty field, just skip it (because of '?').
  1460. - Finally, put the scheduling information.
  1461. See also the variables `org-agenda-remove-times-when-in-prefix' and
  1462. `org-agenda-remove-tags'.
  1463. Custom commands can set this variable in the options section."
  1464. :type '(choice
  1465. (string :tag "General format")
  1466. (list :greedy t :tag "View dependent"
  1467. (cons (const agenda) (string :tag "Format"))
  1468. (cons (const timeline) (string :tag "Format"))
  1469. (cons (const todo) (string :tag "Format"))
  1470. (cons (const tags) (string :tag "Format"))
  1471. (cons (const search) (string :tag "Format"))))
  1472. :group 'org-agenda-line-format)
  1473. (defvar org-prefix-format-compiled nil
  1474. "The compiled prefix format and associated variables.
  1475. This is a list where first element is a list of variable bindings, and second
  1476. element is the compiled format expression. See the variable
  1477. `org-agenda-prefix-format'.")
  1478. (defcustom org-agenda-todo-keyword-format "%-1s"
  1479. "Format for the TODO keyword in agenda lines.
  1480. Set this to something like \"%-12s\" if you want all TODO keywords
  1481. to occupy a fixed space in the agenda display."
  1482. :group 'org-agenda-line-format
  1483. :type 'string)
  1484. (defcustom org-agenda-diary-sexp-prefix nil
  1485. "A regexp that matches part of a diary sexp entry
  1486. which should be treated as scheduling/deadline information in
  1487. `org-agenda'.
  1488. For example, you can use this to extract the `diary-remind-message' from
  1489. `diary-remind' entries."
  1490. :group 'org-agenda-line-format
  1491. :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
  1492. (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
  1493. "Text preceding timerange entries in the agenda view.
  1494. This is a list with two strings. The first applies when the range
  1495. is entirely on one day. The second applies if the range spans several days.
  1496. The strings may have two \"%d\" format specifiers which will be filled
  1497. with the sequence number of the days, and the total number of days in the
  1498. range, respectively."
  1499. :group 'org-agenda-line-format
  1500. :type '(list
  1501. (string :tag "Deadline today ")
  1502. (choice :tag "Deadline relative"
  1503. (string :tag "Format string")
  1504. (function))))
  1505. (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
  1506. "Text preceding scheduled items in the agenda view.
  1507. This is a list with two strings. The first applies when the item is
  1508. scheduled on the current day. The second applies when it has been scheduled
  1509. previously, it may contain a %d indicating that this is the nth time that
  1510. this item is scheduled, due to automatic rescheduling of unfinished items
  1511. for the following day. So this number is one larger than the number of days
  1512. that passed since this item was scheduled first."
  1513. :group 'org-agenda-line-format
  1514. :version "24.4"
  1515. :package-version '(Org . "8.0")
  1516. :type '(list
  1517. (string :tag "Scheduled today ")
  1518. (string :tag "Scheduled previously")))
  1519. (defcustom org-agenda-inactive-leader "["
  1520. "Text preceding item pulled into the agenda by inactive time stamps.
  1521. These entries are added to the agenda when pressing \"[\"."
  1522. :group 'org-agenda-line-format
  1523. :version "24.1"
  1524. :type 'string)
  1525. (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: " "%2d d. ago: ")
  1526. "Text preceding deadline items in the agenda view.
  1527. This is a list with three strings. The first applies when the item has its
  1528. deadline on the current day. The second applies when the deadline is in the
  1529. future, the third one when it is in the past. The strings may contain %d
  1530. to capture the number of days."
  1531. :group 'org-agenda-line-format
  1532. :version "24.4"
  1533. :package-version '(Org . "8.0")
  1534. :type '(list
  1535. (string :tag "Deadline today ")
  1536. (string :tag "Deadline in the future ")
  1537. (string :tag "Deadline in the past ")))
  1538. (defcustom org-agenda-remove-times-when-in-prefix t
  1539. "Non-nil means remove duplicate time specifications in agenda items.
  1540. When the format `org-agenda-prefix-format' contains a `%t' specifier, a
  1541. time-of-day specification in a headline or diary entry is extracted and
  1542. placed into the prefix. If this option is non-nil, the original specification
  1543. \(a timestamp or -range, or just a plain time(range) specification like
  1544. 11:30-4pm) will be removed for agenda display. This makes the agenda less
  1545. cluttered.
  1546. The option can be t or nil. It may also be the symbol `beg', indicating
  1547. that the time should only be removed when it is located at the beginning of
  1548. the headline/diary entry."
  1549. :group 'org-agenda-line-format
  1550. :type '(choice
  1551. (const :tag "Always" t)
  1552. (const :tag "Never" nil)
  1553. (const :tag "When at beginning of entry" beg)))
  1554. (defcustom org-agenda-remove-timeranges-from-blocks nil
  1555. "Non-nil means remove time ranges specifications in agenda
  1556. items that span on several days."
  1557. :group 'org-agenda-line-format
  1558. :version "24.1"
  1559. :type 'boolean)
  1560. (defcustom org-agenda-default-appointment-duration nil
  1561. "Default duration for appointments that only have a starting time.
  1562. When nil, no duration is specified in such cases.
  1563. When non-nil, this must be the number of minutes, e.g. 60 for one hour."
  1564. :group 'org-agenda-line-format
  1565. :type '(choice
  1566. (integer :tag "Minutes")
  1567. (const :tag "No default duration")))
  1568. (defcustom org-agenda-show-inherited-tags t
  1569. "Non-nil means show inherited tags in each agenda line.
  1570. When this option is set to `always', it take precedences over
  1571. `org-agenda-use-tag-inheritance' and inherited tags are shown
  1572. in every agenda.
  1573. When this option is set to t (the default), inherited tags are
  1574. shown when they are available, i.e. when the value of
  1575. `org-agenda-use-tag-inheritance' has been taken into account.
  1576. This can be set to a list of agenda types in which the agenda
  1577. must display the inherited tags. Available types are `todo',
  1578. `agenda', `search' and `timeline'.
  1579. When set to nil, never show inherited tags in agenda lines."
  1580. :group 'org-agenda-line-format
  1581. :group 'org-agenda
  1582. :version "24.3"
  1583. :type '(choice
  1584. (const :tag "Show inherited tags when available" t)
  1585. (const :tag "Always show inherited tags" always)
  1586. (repeat :tag "Show inherited tags only in selected agenda types"
  1587. (symbol :tag "Agenda type"))))
  1588. (defcustom org-agenda-use-tag-inheritance '(todo search timeline agenda)
  1589. "List of agenda view types where to use tag inheritance.
  1590. In tags/tags-todo/tags-tree agenda views, tag inheritance is
  1591. controlled by `org-use-tag-inheritance'. In other agenda types,
  1592. `org-use-tag-inheritance' is not used for the selection of the
  1593. agenda entries. Still, you may want the agenda to be aware of
  1594. the inherited tags anyway, e.g. for later tag filtering.
  1595. Allowed value are `todo', `search', `timeline' and `agenda'.
  1596. This variable has no effect if `org-agenda-show-inherited-tags'
  1597. is set to `always'. In that case, the agenda is aware of those
  1598. tags.
  1599. The default value sets tags in every agenda type. Setting this
  1600. option to nil will speed up non-tags agenda view a lot."
  1601. :group 'org-agenda
  1602. :version "24.3"
  1603. :type '(choice
  1604. (const :tag "Use tag inheritance in all agenda types" t)
  1605. (repeat :tag "Use tag inheritance in selected agenda types"
  1606. (symbol :tag "Agenda type"))))
  1607. (defcustom org-agenda-hide-tags-regexp nil
  1608. "Regular expression used to filter away specific tags in agenda views.
  1609. This means that these tags will be present, but not be shown in the agenda
  1610. line. Secondary filtering will still work on the hidden tags.
  1611. Nil means don't hide any tags."
  1612. :group 'org-agenda-line-format
  1613. :type '(choice
  1614. (const :tag "Hide none" nil)
  1615. (string :tag "Regexp ")))
  1616. (defcustom org-agenda-remove-tags nil
  1617. "Non-nil means remove the tags from the headline copy in the agenda.
  1618. When this is the symbol `prefix', only remove tags when
  1619. `org-agenda-prefix-format' contains a `%T' specifier."
  1620. :group 'org-agenda-line-format
  1621. :type '(choice
  1622. (const :tag "Always" t)
  1623. (const :tag "Never" nil)
  1624. (const :tag "When prefix format contains %T" prefix)))
  1625. (defvaralias 'org-agenda-remove-tags-when-in-prefix
  1626. 'org-agenda-remove-tags)
  1627. (defcustom org-agenda-tags-column -80
  1628. "Shift tags in agenda items to this column.
  1629. If this number is positive, it specifies the column. If it is negative,
  1630. it means that the tags should be flushright to that column. For example,
  1631. -80 works well for a normal 80 character screen."
  1632. :group 'org-agenda-line-format
  1633. :type 'integer)
  1634. (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column)
  1635. (defcustom org-agenda-fontify-priorities 'cookies
  1636. "Non-nil means highlight low and high priorities in agenda.
  1637. When t, the highest priority entries are bold, lowest priority italic.
  1638. However, settings in `org-priority-faces' will overrule these faces.
  1639. When this variable is the symbol `cookies', only fontify the
  1640. cookies, not the entire task.
  1641. This may also be an association list of priority faces, whose
  1642. keys are the character values of `org-highest-priority',
  1643. `org-default-priority', and `org-lowest-priority' (the default values
  1644. are ?A, ?B, and ?C, respectively). The face may be a named face, a
  1645. color as a string, or a list like `(:background \"Red\")'.
  1646. If it is a color, the variable `org-faces-easy-properties'
  1647. determines if it is a foreground or a background color."
  1648. :group 'org-agenda-line-format
  1649. :type '(choice
  1650. (const :tag "Never" nil)
  1651. (const :tag "Defaults" t)
  1652. (const :tag "Cookies only" cookies)
  1653. (repeat :tag "Specify"
  1654. (list (character :tag "Priority" :value ?A)
  1655. (choice :tag "Face "
  1656. (string :tag "Color")
  1657. (sexp :tag "Face"))))))
  1658. (defcustom org-agenda-day-face-function nil
  1659. "Function called to determine what face should be used to display a day.
  1660. The only argument passed to that function is the day. It should
  1661. returns a face, or nil if does not want to specify a face and let
  1662. the normal rules apply."
  1663. :group 'org-agenda-line-format
  1664. :version "24.1"
  1665. :type '(choice (const nil) (function)))
  1666. (defcustom org-agenda-category-icon-alist nil
  1667. "Alist of category icon to be displayed in agenda views.
  1668. Each entry should have the following format:
  1669. (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
  1670. Where CATEGORY-REGEXP is a regexp matching the categories where
  1671. the icon should be displayed.
  1672. FILE-OR-DATA either a file path or a string containing image data.
  1673. The other fields can be omitted safely if not needed:
  1674. TYPE indicates the image type.
  1675. DATA-P is a boolean indicating whether the FILE-OR-DATA string is
  1676. image data.
  1677. PROPS are additional image attributes to assign to the image,
  1678. like, e.g. `:ascent center'.
  1679. (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
  1680. If you want to set the display properties yourself, just put a
  1681. list as second element:
  1682. (CATEGORY-REGEXP (MY PROPERTY LIST))
  1683. For example, to display a 16px horizontal space for Emacs
  1684. category, you can use:
  1685. (\"Emacs\" \\='(space . (:width (16))))"
  1686. :group 'org-agenda-line-format
  1687. :version "24.1"
  1688. :type '(alist :key-type (string :tag "Regexp matching category")
  1689. :value-type (choice (list :tag "Icon"
  1690. (string :tag "File or data")
  1691. (symbol :tag "Type")
  1692. (boolean :tag "Data?")
  1693. (repeat :tag "Extra image properties" :inline t symbol))
  1694. (list :tag "Display properties" sexp))))
  1695. (defgroup org-agenda-column-view nil
  1696. "Options concerning column view in the agenda."
  1697. :tag "Org Agenda Column View"
  1698. :group 'org-agenda)
  1699. (defcustom org-agenda-view-columns-initially nil
  1700. "When non-nil, switch to columns view right after creating the agenda."
  1701. :group 'org-agenda-column-view
  1702. :type 'boolean
  1703. :version "25.2"
  1704. :package-version '(Org . "9.0")
  1705. :safe #'booleanp)
  1706. (defcustom org-agenda-columns-show-summaries t
  1707. "Non-nil means show summaries for columns displayed in the agenda view."
  1708. :group 'org-agenda-column-view
  1709. :type 'boolean)
  1710. (defcustom org-agenda-columns-compute-summary-properties t
  1711. "Non-nil means recompute all summary properties before column view.
  1712. When column view in the agenda is listing properties that have a summary
  1713. operator, it can go to all relevant buffers and recompute the summaries
  1714. there. This can mean overhead for the agenda column view, but is necessary
  1715. to have thing up to date.
  1716. As a special case, a CLOCKSUM property also makes sure that the clock
  1717. computations are current."
  1718. :group 'org-agenda-column-view
  1719. :type 'boolean)
  1720. (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
  1721. "Non-nil means the duration of an appointment will add to day effort.
  1722. The property to which appointment durations will be added is the one given
  1723. in the option `org-effort-property'. If an appointment does not have
  1724. an end time, `org-agenda-default-appointment-duration' will be used. If that
  1725. is not set, an appointment without end time will not contribute to the time
  1726. estimate."
  1727. :group 'org-agenda-column-view
  1728. :type 'boolean)
  1729. (defcustom org-agenda-auto-exclude-function nil
  1730. "A function called with a tag to decide if it is filtered on \
  1731. \\<org-agenda-mode-map>`\\[org-agenda-filter-by-tag] RET'.
  1732. The sole argument to the function, which is called once for each
  1733. possible tag, is a string giving the name of the tag. The
  1734. function should return either nil if the tag should be included
  1735. as normal, or \"-<TAG>\" to exclude the tag.
  1736. Note that for the purpose of tag filtering, only the lower-case version of
  1737. all tags will be considered, so that this function will only ever see
  1738. the lower-case version of all tags."
  1739. :group 'org-agenda
  1740. :type '(choice (const nil) (function)))
  1741. (defcustom org-agenda-bulk-custom-functions nil
  1742. "Alist of characters and custom functions for bulk actions.
  1743. For example, this value makes those two functions available:
  1744. \\='((?R set-category)
  1745. (?C bulk-cut))
  1746. With selected entries in an agenda buffer, `B R' will call
  1747. the custom function `set-category' on the selected entries.
  1748. Note that functions in this alist don't need to be quoted."
  1749. :type '(alist :key-type character :value-type (group function))
  1750. :version "24.1"
  1751. :group 'org-agenda)
  1752. (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
  1753. "Execute BODY with point at location given by `org-hd-marker' property.
  1754. If STRING is non-nil, the text property will be fetched from position 0
  1755. in that string. If STRING is nil, it will be fetched from the beginning
  1756. of the current line."
  1757. (org-with-gensyms (marker)
  1758. `(let ((,marker (get-text-property (if ,string 0 (point-at-bol))
  1759. 'org-hd-marker ,string)))
  1760. (with-current-buffer (marker-buffer ,marker)
  1761. (save-excursion
  1762. (goto-char ,marker)
  1763. ,@body)))))
  1764. (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
  1765. (defun org-add-agenda-custom-command (entry)
  1766. "Replace or add a command in `org-agenda-custom-commands'.
  1767. This is mostly for hacking and trying a new command - once the command
  1768. works you probably want to add it to `org-agenda-custom-commands' for good."
  1769. (let ((ass (assoc (car entry) org-agenda-custom-commands)))
  1770. (if ass
  1771. (setcdr ass (cdr entry))
  1772. (push entry org-agenda-custom-commands))))
  1773. ;;; Define the org-agenda-mode
  1774. (defvar org-agenda-mode-map (make-sparse-keymap)
  1775. "Keymap for `org-agenda-mode'.")
  1776. (defvaralias 'org-agenda-keymap 'org-agenda-mode-map)
  1777. (defvar org-agenda-menu) ; defined later in this file.
  1778. (defvar org-agenda-restrict nil) ; defined later in this file.
  1779. (defvar org-agenda-follow-mode nil)
  1780. (defvar org-agenda-entry-text-mode nil)
  1781. (defvar org-agenda-clockreport-mode nil)
  1782. (defvar org-agenda-show-log nil)
  1783. (defvar org-agenda-redo-command nil)
  1784. (defvar org-agenda-query-string nil)
  1785. (defvar org-agenda-mode-hook nil
  1786. "Hook run after `org-agenda-mode' is turned on.
  1787. The buffer is still writable when this hook is called.")
  1788. (defvar org-agenda-type nil)
  1789. (defvar org-agenda-force-single-file nil)
  1790. (defvar org-agenda-bulk-marked-entries nil
  1791. "List of markers that refer to marked entries in the agenda.")
  1792. (defvar org-agenda-current-date nil
  1793. "Active date when building the agenda.")
  1794. ;;; Multiple agenda buffers support
  1795. (defcustom org-agenda-sticky nil
  1796. "Non-nil means agenda q key will bury agenda buffers.
  1797. Agenda commands will then show existing buffer instead of generating new ones.
  1798. When nil, `q' will kill the single agenda buffer."
  1799. :group 'org-agenda
  1800. :version "24.3"
  1801. :type 'boolean)
  1802. ;;;###autoload
  1803. (defun org-toggle-sticky-agenda (&optional arg)
  1804. "Toggle `org-agenda-sticky'."
  1805. (interactive "P")
  1806. (let ((new-value (if arg
  1807. (> (prefix-numeric-value arg) 0)
  1808. (not org-agenda-sticky))))
  1809. (if (equal new-value org-agenda-sticky)
  1810. (and (called-interactively-p 'interactive)
  1811. (message "Sticky agenda was already %s"
  1812. (if org-agenda-sticky "enabled" "disabled")))
  1813. (setq org-agenda-sticky new-value)
  1814. (org-agenda-kill-all-agenda-buffers)
  1815. (and (called-interactively-p 'interactive)
  1816. (message "Sticky agenda %s"
  1817. (if org-agenda-sticky "enabled" "disabled"))))))
  1818. (defvar org-agenda-buffer nil
  1819. "Agenda buffer currently being generated.")
  1820. (defvar org-agenda-last-prefix-arg nil)
  1821. (defvar org-agenda-this-buffer-name nil)
  1822. (defvar org-agenda-doing-sticky-redo nil)
  1823. (defvar org-agenda-this-buffer-is-sticky nil)
  1824. (defvar org-agenda-last-indirect-buffer nil
  1825. "Last buffer loaded by `org-agenda-tree-to-indirect-buffer'.")
  1826. (defconst org-agenda-local-vars
  1827. '(org-agenda-this-buffer-name
  1828. org-agenda-undo-list
  1829. org-agenda-pending-undo-list
  1830. org-agenda-follow-mode
  1831. org-agenda-entry-text-mode
  1832. org-agenda-clockreport-mode
  1833. org-agenda-show-log
  1834. org-agenda-redo-command
  1835. org-agenda-query-string
  1836. org-agenda-type
  1837. org-agenda-bulk-marked-entries
  1838. org-agenda-undo-has-started-in
  1839. org-agenda-info
  1840. org-agenda-pre-window-conf
  1841. org-agenda-columns-active
  1842. org-agenda-tag-filter
  1843. org-agenda-category-filter
  1844. org-agenda-top-headline-filter
  1845. org-agenda-regexp-filter
  1846. org-agenda-effort-filter
  1847. org-agenda-markers
  1848. org-agenda-last-search-view-search-was-boolean
  1849. org-agenda-last-indirect-buffer
  1850. org-agenda-filtered-by-category
  1851. org-agenda-filter-form
  1852. org-agenda-cycle-counter
  1853. org-agenda-last-prefix-arg)
  1854. "Variables that must be local in agenda buffers to allow multiple buffers.")
  1855. (defun org-agenda-mode ()
  1856. "Mode for time-sorted view on action items in Org files.
  1857. The following commands are available:
  1858. \\{org-agenda-mode-map}"
  1859. (interactive)
  1860. (cond (org-agenda-doing-sticky-redo
  1861. ;; Refreshing sticky agenda-buffer
  1862. ;;
  1863. ;; Preserve the value of `org-agenda-local-vars' variables,
  1864. ;; while letting `kill-all-local-variables' kill the rest
  1865. (let ((save (buffer-local-variables)))
  1866. (kill-all-local-variables)
  1867. (mapc 'make-local-variable org-agenda-local-vars)
  1868. (dolist (elem save)
  1869. (let ((var (car elem))
  1870. (val (cdr elem)))
  1871. (when (and val
  1872. (member var org-agenda-local-vars))
  1873. (set var val)))))
  1874. (setq-local org-agenda-this-buffer-is-sticky t))
  1875. (org-agenda-sticky
  1876. ;; Creating a sticky Agenda buffer for the first time
  1877. (kill-all-local-variables)
  1878. (mapc 'make-local-variable org-agenda-local-vars)
  1879. (setq-local org-agenda-this-buffer-is-sticky t))
  1880. (t
  1881. ;; Creating a non-sticky agenda buffer
  1882. (kill-all-local-variables)
  1883. (setq-local org-agenda-this-buffer-is-sticky nil)))
  1884. (setq org-agenda-undo-list nil
  1885. org-agenda-pending-undo-list nil
  1886. org-agenda-bulk-marked-entries nil)
  1887. (setq major-mode 'org-agenda-mode)
  1888. ;; Keep global-font-lock-mode from turning on font-lock-mode
  1889. (setq-local font-lock-global-modes (list 'not major-mode))
  1890. (setq mode-name "Org-Agenda")
  1891. (setq indent-tabs-mode nil)
  1892. (use-local-map org-agenda-mode-map)
  1893. (easy-menu-add org-agenda-menu)
  1894. (if org-startup-truncated (setq truncate-lines t))
  1895. (setq-local line-move-visual nil)
  1896. (add-hook 'post-command-hook 'org-agenda-update-agenda-type nil 'local)
  1897. (add-hook 'pre-command-hook 'org-unhighlight nil 'local)
  1898. ;; Make sure properties are removed when copying text
  1899. (add-hook 'filter-buffer-substring-functions
  1900. (lambda (fun start end delete)
  1901. (substring-no-properties (funcall fun start end delete)))
  1902. nil t)
  1903. (unless org-agenda-keep-modes
  1904. (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
  1905. org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode))
  1906. (setq org-agenda-show-log org-agenda-start-with-log-mode)
  1907. (setq org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode)
  1908. (add-to-invisibility-spec '(org-filtered))
  1909. (add-to-invisibility-spec '(org-link))
  1910. (easy-menu-change
  1911. '("Agenda") "Agenda Files"
  1912. (append
  1913. (list
  1914. (vector
  1915. (if (get 'org-agenda-files 'org-restrict)
  1916. "Restricted to single file"
  1917. "Edit File List")
  1918. '(org-edit-agenda-file-list)
  1919. (not (get 'org-agenda-files 'org-restrict)))
  1920. "--")
  1921. (mapcar 'org-file-menu-entry (org-agenda-files))))
  1922. (org-agenda-set-mode-name)
  1923. (apply
  1924. (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
  1925. (list 'org-agenda-mode-hook)))
  1926. (substitute-key-definition 'undo 'org-agenda-undo
  1927. org-agenda-mode-map global-map)
  1928. (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
  1929. (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
  1930. (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
  1931. (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
  1932. (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
  1933. (org-defkey org-agenda-mode-map [(meta down)] 'org-agenda-drag-line-forward)
  1934. (org-defkey org-agenda-mode-map [(meta up)] 'org-agenda-drag-line-backward)
  1935. (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
  1936. (org-defkey org-agenda-mode-map "\M-m" 'org-agenda-bulk-toggle)
  1937. (org-defkey org-agenda-mode-map "*" 'org-agenda-bulk-mark-all)
  1938. (org-defkey org-agenda-mode-map "\M-*" 'org-agenda-bulk-toggle-all)
  1939. (org-defkey org-agenda-mode-map "#" 'org-agenda-dim-blocked-tasks)
  1940. (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
  1941. (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
  1942. (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-unmark-all)
  1943. (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
  1944. (org-defkey org-agenda-mode-map "k" 'org-agenda-capture)
  1945. (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
  1946. (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
  1947. (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
  1948. (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
  1949. (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
  1950. (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
  1951. (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
  1952. (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
  1953. (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
  1954. (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
  1955. (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
  1956. (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
  1957. (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
  1958. (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
  1959. (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
  1960. (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
  1961. (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
  1962. (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
  1963. (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
  1964. (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
  1965. (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
  1966. (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
  1967. (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
  1968. (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
  1969. (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
  1970. (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
  1971. (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
  1972. (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
  1973. (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
  1974. (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
  1975. (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
  1976. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
  1977. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
  1978. (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
  1979. (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
  1980. (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
  1981. (let ((l '(1 2 3 4 5 6 7 8 9 0)))
  1982. (while l (org-defkey org-agenda-mode-map
  1983. (int-to-string (pop l)) 'digit-argument)))
  1984. (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
  1985. (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
  1986. (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
  1987. (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
  1988. (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
  1989. (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
  1990. (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
  1991. (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
  1992. (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
  1993. (org-defkey org-agenda-mode-map "g" (lambda () (interactive) (org-agenda-redo t)))
  1994. (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
  1995. (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
  1996. (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
  1997. 'org-clock-modify-effort-estimate)
  1998. (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
  1999. (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
  2000. (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
  2001. (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
  2002. (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
  2003. (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
  2004. (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
  2005. (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
  2006. (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
  2007. (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
  2008. (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
  2009. (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
  2010. (substitute-key-definition 'next-line 'org-agenda-next-line
  2011. org-agenda-mode-map global-map)
  2012. (substitute-key-definition 'previous-line 'org-agenda-previous-line
  2013. org-agenda-mode-map global-map)
  2014. (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
  2015. (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
  2016. (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
  2017. (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
  2018. (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
  2019. (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
  2020. (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
  2021. (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
  2022. (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
  2023. (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
  2024. (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
  2025. (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
  2026. (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
  2027. (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
  2028. (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
  2029. (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
  2030. (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
  2031. (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
  2032. (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  2033. (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
  2034. (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
  2035. (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
  2036. (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
  2037. (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
  2038. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
  2039. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
  2040. (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
  2041. (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
  2042. (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
  2043. (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  2044. (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
  2045. (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
  2046. (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
  2047. (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
  2048. (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
  2049. (org-defkey org-agenda-mode-map "_" 'org-agenda-filter-by-effort)
  2050. (org-defkey org-agenda-mode-map "=" 'org-agenda-filter-by-regexp)
  2051. (org-defkey org-agenda-mode-map "|" 'org-agenda-filter-remove-all)
  2052. (org-defkey org-agenda-mode-map "~" 'org-agenda-limit-interactively)
  2053. (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
  2054. (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-headline)
  2055. (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
  2056. (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
  2057. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  2058. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  2059. (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
  2060. (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
  2061. (define-key org-agenda-mode-map [remap forward-paragraph] 'org-agenda-forward-block)
  2062. (define-key org-agenda-mode-map [remap backward-paragraph] 'org-agenda-backward-block)
  2063. (when org-agenda-mouse-1-follows-link
  2064. (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
  2065. (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
  2066. '("Agenda"
  2067. ("Agenda Files")
  2068. "--"
  2069. ("Agenda Dates"
  2070. ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
  2071. ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
  2072. ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
  2073. ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
  2074. "--"
  2075. ("View"
  2076. ["Day View" org-agenda-day-view
  2077. :active (org-agenda-check-type nil 'agenda)
  2078. :style radio :selected (eq org-agenda-current-span 'day)
  2079. :keys "v d (or just d)"]
  2080. ["Week View" org-agenda-week-view
  2081. :active (org-agenda-check-type nil 'agenda)
  2082. :style radio :selected (eq org-agenda-current-span 'week)
  2083. :keys "v w"]
  2084. ["Fortnight View" org-agenda-fortnight-view
  2085. :active (org-agenda-check-type nil 'agenda)
  2086. :style radio :selected (eq org-agenda-current-span 'fortnight)
  2087. :keys "v f"]
  2088. ["Month View" org-agenda-month-view
  2089. :active (org-agenda-check-type nil 'agenda)
  2090. :style radio :selected (eq org-agenda-current-span 'month)
  2091. :keys "v m"]
  2092. ["Year View" org-agenda-year-view
  2093. :active (org-agenda-check-type nil 'agenda)
  2094. :style radio :selected (eq org-agenda-current-span 'year)
  2095. :keys "v y"]
  2096. "--"
  2097. ["Include Diary" org-agenda-toggle-diary
  2098. :style toggle :selected org-agenda-include-diary
  2099. :active (org-agenda-check-type nil 'agenda)]
  2100. ["Include Deadlines" org-agenda-toggle-deadlines
  2101. :style toggle :selected org-agenda-include-deadlines
  2102. :active (org-agenda-check-type nil 'agenda)]
  2103. ["Use Time Grid" org-agenda-toggle-time-grid
  2104. :style toggle :selected org-agenda-use-time-grid
  2105. :active (org-agenda-check-type nil 'agenda)]
  2106. "--"
  2107. ["Show clock report" org-agenda-clockreport-mode
  2108. :style toggle :selected org-agenda-clockreport-mode
  2109. :active (org-agenda-check-type nil 'agenda)]
  2110. ["Show some entry text" org-agenda-entry-text-mode
  2111. :style toggle :selected org-agenda-entry-text-mode
  2112. :active t]
  2113. "--"
  2114. ["Show Logbook entries" org-agenda-log-mode
  2115. :style toggle :selected org-agenda-show-log
  2116. :active (org-agenda-check-type nil 'agenda 'timeline)
  2117. :keys "v l (or just l)"]
  2118. ["Include archived trees" org-agenda-archives-mode
  2119. :style toggle :selected org-agenda-archives-mode :active t
  2120. :keys "v a"]
  2121. ["Include archive files" (org-agenda-archives-mode t)
  2122. :style toggle :selected (eq org-agenda-archives-mode t) :active t
  2123. :keys "v A"]
  2124. "--"
  2125. ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
  2126. ["Write view to file" org-agenda-write t]
  2127. ["Rebuild buffer" org-agenda-redo t]
  2128. ["Save all Org buffers" org-save-all-org-buffers t]
  2129. "--"
  2130. ["Show original entry" org-agenda-show t]
  2131. ["Go To (other window)" org-agenda-goto t]
  2132. ["Go To (this window)" org-agenda-switch-to t]
  2133. ["Capture with cursor date" org-agenda-capture t]
  2134. ["Follow Mode" org-agenda-follow-mode
  2135. :style toggle :selected org-agenda-follow-mode :active t]
  2136. ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
  2137. "--"
  2138. ("TODO"
  2139. ["Cycle TODO" org-agenda-todo t]
  2140. ["Next TODO set" org-agenda-todo-nextset t]
  2141. ["Previous TODO set" org-agenda-todo-previousset t]
  2142. ["Add note" org-agenda-add-note t])
  2143. ("Archive/Refile/Delete"
  2144. ["Archive default" org-agenda-archive-default t]
  2145. ["Archive default" org-agenda-archive-default-with-confirmation t]
  2146. ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
  2147. ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
  2148. ["Archive subtree" org-agenda-archive t]
  2149. "--"
  2150. ["Refile" org-agenda-refile t]
  2151. "--"
  2152. ["Delete subtree" org-agenda-kill t])
  2153. ("Bulk action"
  2154. ["Mark entry" org-agenda-bulk-mark t]
  2155. ["Mark all" org-agenda-bulk-mark-all t]
  2156. ["Unmark entry" org-agenda-bulk-unmark t]
  2157. ["Unmark all" org-agenda-bulk-unmark-all :active t :keys "U"]
  2158. ["Toggle mark" org-agenda-bulk-toggle t]
  2159. ["Toggle all" org-agenda-bulk-toggle-all t]
  2160. ["Mark regexp" org-agenda-bulk-mark-regexp t])
  2161. ["Act on all marked" org-agenda-bulk-action t]
  2162. "--"
  2163. ("Tags and Properties"
  2164. ["Show all Tags" org-agenda-show-tags t]
  2165. ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
  2166. ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
  2167. "--"
  2168. ["Column View" org-columns t])
  2169. ("Deadline/Schedule"
  2170. ["Schedule" org-agenda-schedule t]
  2171. ["Set Deadline" org-agenda-deadline t]
  2172. "--"
  2173. ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
  2174. ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
  2175. ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
  2176. ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
  2177. ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
  2178. ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
  2179. ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
  2180. ("Clock and Effort"
  2181. ["Clock in" org-agenda-clock-in t]
  2182. ["Clock out" org-agenda-clock-out t]
  2183. ["Clock cancel" org-agenda-clock-cancel t]
  2184. ["Goto running clock" org-clock-goto t]
  2185. "--"
  2186. ["Set Effort" org-agenda-set-effort t]
  2187. ["Change clocked effort" org-clock-modify-effort-estimate
  2188. (org-clock-is-active)])
  2189. ("Priority"
  2190. ["Set Priority" org-agenda-priority t]
  2191. ["Increase Priority" org-agenda-priority-up t]
  2192. ["Decrease Priority" org-agenda-priority-down t]
  2193. ["Show Priority" org-show-priority t])
  2194. ("Calendar/Diary"
  2195. ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
  2196. ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
  2197. ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
  2198. ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
  2199. ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
  2200. ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
  2201. "--"
  2202. ["Create iCalendar File" org-icalendar-combine-agenda-files t])
  2203. "--"
  2204. ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
  2205. "--"
  2206. ("MobileOrg"
  2207. ["Push Files and Views" org-mobile-push t]
  2208. ["Get Captured and Flagged" org-mobile-pull t]
  2209. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
  2210. ["Show note / unflag" org-agenda-show-the-flagging-note t]
  2211. "--"
  2212. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  2213. "--"
  2214. ["Quit" org-agenda-quit t]
  2215. ["Exit and Release Buffers" org-agenda-exit t]
  2216. ))
  2217. ;;; Agenda undo
  2218. (defvar org-agenda-allow-remote-undo t
  2219. "Non-nil means allow remote undo from the agenda buffer.")
  2220. (defvar org-agenda-undo-has-started-in nil
  2221. "Buffers that have already seen `undo-start' in the current undo sequence.")
  2222. (defun org-agenda-undo ()
  2223. "Undo a remote editing step in the agenda.
  2224. This undoes changes both in the agenda buffer and in the remote buffer
  2225. that have been changed along."
  2226. (interactive)
  2227. (or org-agenda-allow-remote-undo
  2228. (user-error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
  2229. (if (not (eq this-command last-command))
  2230. (setq org-agenda-undo-has-started-in nil
  2231. org-agenda-pending-undo-list org-agenda-undo-list))
  2232. (if (not org-agenda-pending-undo-list)
  2233. (user-error "No further undo information"))
  2234. (let* ((entry (pop org-agenda-pending-undo-list))
  2235. buf line cmd rembuf)
  2236. (setq cmd (pop entry) line (pop entry))
  2237. (setq rembuf (nth 2 entry))
  2238. (org-with-remote-undo rembuf
  2239. (while (bufferp (setq buf (pop entry)))
  2240. (if (pop entry)
  2241. (with-current-buffer buf
  2242. (let ((last-undo-buffer buf)
  2243. (inhibit-read-only t))
  2244. (unless (memq buf org-agenda-undo-has-started-in)
  2245. (push buf org-agenda-undo-has-started-in)
  2246. (make-local-variable 'pending-undo-list)
  2247. (undo-start))
  2248. (while (and pending-undo-list
  2249. (listp pending-undo-list)
  2250. (not (car pending-undo-list)))
  2251. (pop pending-undo-list))
  2252. (undo-more 1))))))
  2253. (org-goto-line line)
  2254. (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
  2255. (defun org-verify-change-for-undo (l1 l2)
  2256. "Verify that a real change occurred between the undo lists L1 and L2."
  2257. (while (and l1 (listp l1) (null (car l1))) (pop l1))
  2258. (while (and l2 (listp l2) (null (car l2))) (pop l2))
  2259. (not (eq l1 l2)))
  2260. ;;; Agenda dispatch
  2261. (defvar org-agenda-restrict-begin (make-marker))
  2262. (defvar org-agenda-restrict-end (make-marker))
  2263. (defvar org-agenda-last-dispatch-buffer nil)
  2264. (defvar org-agenda-overriding-restriction nil)
  2265. (defcustom org-agenda-custom-commands-contexts nil
  2266. "Alist of custom agenda keys and contextual rules.
  2267. For example, if you have a custom agenda command \"p\" and you
  2268. want this command to be accessible only from plain text files,
  2269. use this:
  2270. \\='((\"p\" ((in-file . \"\\\\.txt\\\\'\"))))
  2271. Here are the available contexts definitions:
  2272. in-file: command displayed only in matching files
  2273. in-mode: command displayed only in matching modes
  2274. not-in-file: command not displayed in matching files
  2275. not-in-mode: command not displayed in matching modes
  2276. in-buffer: command displayed only in matching buffers
  2277. not-in-buffer: command not displayed in matching buffers
  2278. [function]: a custom function taking no argument
  2279. If you define several checks, the agenda command will be
  2280. accessible if there is at least one valid check.
  2281. You can also bind a key to another agenda custom command
  2282. depending on contextual rules.
  2283. \\='((\"p\" \"q\" ((in-file . \"\\\\.txt\\\\'\"))))
  2284. Here it means: in .txt files, use \"p\" as the key for the
  2285. agenda command otherwise associated with \"q\". (The command
  2286. originally associated with \"q\" is not displayed to avoid
  2287. duplicates.)"
  2288. :version "24.3"
  2289. :group 'org-agenda-custom-commands
  2290. :type '(repeat (list :tag "Rule"
  2291. (string :tag " Agenda key")
  2292. (string :tag "Replace by command")
  2293. (repeat :tag "Available when"
  2294. (choice
  2295. (cons :tag "Condition"
  2296. (choice
  2297. (const :tag "In file" in-file)
  2298. (const :tag "Not in file" not-in-file)
  2299. (const :tag "In buffer" in-buffer)
  2300. (const :tag "Not in buffer" not-in-buffer)
  2301. (const :tag "In mode" in-mode)
  2302. (const :tag "Not in mode" not-in-mode))
  2303. (regexp))
  2304. (function :tag "Custom function"))))))
  2305. (defcustom org-agenda-max-entries nil
  2306. "Maximum number of entries to display in an agenda.
  2307. This can be nil (no limit) or an integer or an alist of agenda
  2308. types with an associated number of entries to display in this
  2309. type."
  2310. :version "24.4"
  2311. :package-version '(Org . "8.0")
  2312. :group 'org-agenda-custom-commands
  2313. :type '(choice (symbol :tag "No limit" nil)
  2314. (integer :tag "Max number of entries")
  2315. (repeat
  2316. (cons (choice :tag "Agenda type"
  2317. (const agenda)
  2318. (const todo)
  2319. (const tags)
  2320. (const search)
  2321. (const timeline))
  2322. (integer :tag "Max number of entries")))))
  2323. (defcustom org-agenda-max-todos nil
  2324. "Maximum number of TODOs to display in an agenda.
  2325. This can be nil (no limit) or an integer or an alist of agenda
  2326. types with an associated number of entries to display in this
  2327. type."
  2328. :version "24.4"
  2329. :package-version '(Org . "8.0")
  2330. :group 'org-agenda-custom-commands
  2331. :type '(choice (symbol :tag "No limit" nil)
  2332. (integer :tag "Max number of TODOs")
  2333. (repeat
  2334. (cons (choice :tag "Agenda type"
  2335. (const agenda)
  2336. (const todo)
  2337. (const tags)
  2338. (const search)
  2339. (const timeline))
  2340. (integer :tag "Max number of TODOs")))))
  2341. (defcustom org-agenda-max-tags nil
  2342. "Maximum number of tagged entries to display in an agenda.
  2343. This can be nil (no limit) or an integer or an alist of agenda
  2344. types with an associated number of entries to display in this
  2345. type."
  2346. :version "24.4"
  2347. :package-version '(Org . "8.0")
  2348. :group 'org-agenda-custom-commands
  2349. :type '(choice (symbol :tag "No limit" nil)
  2350. (integer :tag "Max number of tagged entries")
  2351. (repeat
  2352. (cons (choice :tag "Agenda type"
  2353. (const agenda)
  2354. (const todo)
  2355. (const tags)
  2356. (const search)
  2357. (const timeline))
  2358. (integer :tag "Max number of tagged entries")))))
  2359. (defcustom org-agenda-max-effort nil
  2360. "Maximum cumulated effort duration for the agenda.
  2361. This can be nil (no limit) or a number of minutes (as an integer)
  2362. or an alist of agenda types with an associated number of minutes
  2363. to limit entries to in this type."
  2364. :version "24.4"
  2365. :package-version '(Org . "8.0")
  2366. :group 'org-agenda-custom-commands
  2367. :type '(choice (symbol :tag "No limit" nil)
  2368. (integer :tag "Max number of minutes")
  2369. (repeat
  2370. (cons (choice :tag "Agenda type"
  2371. (const agenda)
  2372. (const todo)
  2373. (const tags)
  2374. (const search)
  2375. (const timeline))
  2376. (integer :tag "Max number of minutes")))))
  2377. (defvar org-agenda-keep-restricted-file-list nil)
  2378. (defvar org-keys nil)
  2379. (defvar org-match nil)
  2380. ;;;###autoload
  2381. (defun org-agenda (&optional arg org-keys restriction)
  2382. "Dispatch agenda commands to collect entries to the agenda buffer.
  2383. Prompts for a command to execute. Any prefix arg will be passed
  2384. on to the selected command. The default selections are:
  2385. a Call `org-agenda-list' to display the agenda for current day or week.
  2386. t Call `org-todo-list' to display the global todo list.
  2387. T Call `org-todo-list' to display the global todo list, select only
  2388. entries with a specific TODO keyword (the user gets a prompt).
  2389. m Call `org-tags-view' to display headlines with tags matching
  2390. a condition (the user is prompted for the condition).
  2391. M Like `m', but select only TODO entries, no ordinary headlines.
  2392. L Create a timeline for the current buffer.
  2393. e Export views to associated files.
  2394. s Search entries for keywords.
  2395. S Search entries for keywords, only with TODO keywords.
  2396. / Multi occur across all agenda files and also files listed
  2397. in `org-agenda-text-search-extra-files'.
  2398. < Restrict agenda commands to buffer, subtree, or region.
  2399. Press several times to get the desired effect.
  2400. > Remove a previous restriction.
  2401. # List \"stuck\" projects.
  2402. ! Configure what \"stuck\" means.
  2403. C Configure custom agenda commands.
  2404. More commands can be added by configuring the variable
  2405. `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
  2406. searches can be pre-defined in this way.
  2407. If the current buffer is in Org mode and visiting a file, you can also
  2408. first press `<' once to indicate that the agenda should be temporarily
  2409. \(until the next use of \\[org-agenda]) restricted to the current file.
  2410. Pressing `<' twice means to restrict to the current subtree or region
  2411. \(if active)."
  2412. (interactive "P")
  2413. (catch 'exit
  2414. (let* ((prefix-descriptions nil)
  2415. (org-agenda-buffer-name org-agenda-buffer-name)
  2416. (org-agenda-window-setup (if (equal (buffer-name)
  2417. org-agenda-buffer-name)
  2418. 'current-window
  2419. org-agenda-window-setup))
  2420. (org-agenda-custom-commands-orig org-agenda-custom-commands)
  2421. (org-agenda-custom-commands
  2422. ;; normalize different versions
  2423. (delq nil
  2424. (mapcar
  2425. (lambda (x)
  2426. (cond ((stringp (cdr x))
  2427. (push x prefix-descriptions)
  2428. nil)
  2429. ((stringp (nth 1 x)) x)
  2430. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2431. (t (cons (car x) (cons "" (cdr x))))))
  2432. org-agenda-custom-commands)))
  2433. (org-agenda-custom-commands
  2434. (org-contextualize-keys
  2435. org-agenda-custom-commands org-agenda-custom-commands-contexts))
  2436. (buf (current-buffer))
  2437. (bfn (buffer-file-name (buffer-base-buffer)))
  2438. entry key type org-match lprops ans)
  2439. ;; Turn off restriction unless there is an overriding one,
  2440. (unless org-agenda-overriding-restriction
  2441. (unless org-agenda-keep-restricted-file-list
  2442. ;; There is a request to keep the file list in place
  2443. (put 'org-agenda-files 'org-restrict nil))
  2444. (setq org-agenda-restrict nil)
  2445. (move-marker org-agenda-restrict-begin nil)
  2446. (move-marker org-agenda-restrict-end nil))
  2447. ;; Delete old local properties
  2448. (put 'org-agenda-redo-command 'org-lprops nil)
  2449. ;; Delete previously set last-arguments
  2450. (put 'org-agenda-redo-command 'last-args nil)
  2451. ;; Remember where this call originated
  2452. (setq org-agenda-last-dispatch-buffer (current-buffer))
  2453. (unless org-keys
  2454. (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
  2455. org-keys (car ans)
  2456. restriction (cdr ans)))
  2457. ;; If we have sticky agenda buffers, set a name for the buffer,
  2458. ;; depending on the invoking keys. The user may still set this
  2459. ;; as a command option, which will overwrite what we do here.
  2460. (if org-agenda-sticky
  2461. (setq org-agenda-buffer-name
  2462. (format "*Org Agenda(%s)*" org-keys)))
  2463. ;; Establish the restriction, if any
  2464. (when (and (not org-agenda-overriding-restriction) restriction)
  2465. (put 'org-agenda-files 'org-restrict (list bfn))
  2466. (cond
  2467. ((eq restriction 'region)
  2468. (setq org-agenda-restrict (current-buffer))
  2469. (move-marker org-agenda-restrict-begin (region-beginning))
  2470. (move-marker org-agenda-restrict-end (region-end)))
  2471. ((eq restriction 'subtree)
  2472. (save-excursion
  2473. (setq org-agenda-restrict (current-buffer))
  2474. (org-back-to-heading t)
  2475. (move-marker org-agenda-restrict-begin (point))
  2476. (move-marker org-agenda-restrict-end
  2477. (progn (org-end-of-subtree t)))))))
  2478. ;; For example the todo list should not need it (but does...)
  2479. (cond
  2480. ((setq entry (assoc org-keys org-agenda-custom-commands))
  2481. (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
  2482. (progn
  2483. (setq type (nth 2 entry) org-match (eval (nth 3 entry))
  2484. lprops (nth 4 entry))
  2485. (if org-agenda-sticky
  2486. (setq org-agenda-buffer-name
  2487. (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
  2488. (format "*Org Agenda(%s)*" org-keys))))
  2489. (put 'org-agenda-redo-command 'org-lprops lprops)
  2490. (cond
  2491. ((eq type 'agenda)
  2492. (org-let lprops '(org-agenda-list current-prefix-arg)))
  2493. ((eq type 'agenda*)
  2494. (org-let lprops '(org-agenda-list current-prefix-arg nil nil t)))
  2495. ((eq type 'alltodo)
  2496. (org-let lprops '(org-todo-list current-prefix-arg)))
  2497. ((eq type 'search)
  2498. (org-let lprops '(org-search-view current-prefix-arg org-match nil)))
  2499. ((eq type 'stuck)
  2500. (org-let lprops '(org-agenda-list-stuck-projects
  2501. current-prefix-arg)))
  2502. ((eq type 'tags)
  2503. (org-let lprops '(org-tags-view current-prefix-arg org-match)))
  2504. ((eq type 'tags-todo)
  2505. (org-let lprops '(org-tags-view '(4) org-match)))
  2506. ((eq type 'todo)
  2507. (org-let lprops '(org-todo-list org-match)))
  2508. ((eq type 'tags-tree)
  2509. (org-check-for-org-mode)
  2510. (org-let lprops '(org-match-sparse-tree current-prefix-arg org-match)))
  2511. ((eq type 'todo-tree)
  2512. (org-check-for-org-mode)
  2513. (org-let lprops
  2514. '(org-occur (concat "^" org-outline-regexp "[ \t]*"
  2515. (regexp-quote org-match) "\\>"))))
  2516. ((eq type 'occur-tree)
  2517. (org-check-for-org-mode)
  2518. (org-let lprops '(org-occur org-match)))
  2519. ((functionp type)
  2520. (org-let lprops '(funcall type org-match)))
  2521. ((fboundp type)
  2522. (org-let lprops '(funcall type org-match)))
  2523. (t (user-error "Invalid custom agenda command type %s" type))))
  2524. (org-agenda-run-series (nth 1 entry) (cddr entry))))
  2525. ((equal org-keys "C")
  2526. (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
  2527. (customize-variable 'org-agenda-custom-commands))
  2528. ((equal org-keys "a") (call-interactively 'org-agenda-list))
  2529. ((equal org-keys "s") (call-interactively 'org-search-view))
  2530. ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
  2531. ((equal org-keys "t") (call-interactively 'org-todo-list))
  2532. ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
  2533. ((equal org-keys "m") (call-interactively 'org-tags-view))
  2534. ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
  2535. ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
  2536. ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
  2537. (add-hook
  2538. 'post-command-hook
  2539. (lambda ()
  2540. (unless (current-message)
  2541. (let* ((m (org-agenda-get-any-marker))
  2542. (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
  2543. (when note
  2544. (message (concat
  2545. "FLAGGING-NOTE ([?] for more info): "
  2546. (org-add-props
  2547. (replace-regexp-in-string
  2548. "\\\\n" "//"
  2549. (copy-sequence note))
  2550. nil 'face 'org-warning)))))))
  2551. t t))
  2552. ((equal org-keys "L")
  2553. (unless (derived-mode-p 'org-mode)
  2554. (user-error "This is not an Org file"))
  2555. (unless restriction
  2556. (put 'org-agenda-files 'org-restrict (list bfn))
  2557. (org-call-with-arg 'org-timeline arg)))
  2558. ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
  2559. ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
  2560. ((equal org-keys "!") (customize-variable 'org-stuck-projects))
  2561. (t (user-error "Invalid agenda key"))))))
  2562. (defvar org-agenda-multi)
  2563. (defun org-agenda-append-agenda ()
  2564. "Append another agenda view to the current one.
  2565. This function allows interactive building of block agendas.
  2566. Agenda views are separated by `org-agenda-block-separator'."
  2567. (interactive)
  2568. (unless (derived-mode-p 'org-agenda-mode)
  2569. (user-error "Can only append from within agenda buffer"))
  2570. (let ((org-agenda-multi t))
  2571. (org-agenda)
  2572. (widen)
  2573. (org-agenda-finalize)
  2574. (setq buffer-read-only t)
  2575. (org-agenda-fit-window-to-buffer)))
  2576. (defun org-agenda-normalize-custom-commands (cmds)
  2577. "Normalize custom commands CMDS."
  2578. (delq nil
  2579. (mapcar
  2580. (lambda (x)
  2581. (cond ((stringp (cdr x)) nil)
  2582. ((stringp (nth 1 x)) x)
  2583. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2584. (t (cons (car x) (cons "" (cdr x))))))
  2585. cmds)))
  2586. (defun org-agenda-get-restriction-and-command (prefix-descriptions)
  2587. "The user interface for selecting an agenda command."
  2588. (catch 'exit
  2589. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  2590. (restrict-ok (and bfn (derived-mode-p 'org-mode)))
  2591. (region-p (org-region-active-p))
  2592. (custom org-agenda-custom-commands)
  2593. (selstring "")
  2594. restriction second-time
  2595. c entry key type match prefixes rmheader header-end custom1 desc
  2596. line lines left right n n1)
  2597. (save-window-excursion
  2598. (delete-other-windows)
  2599. (org-switch-to-buffer-other-window " *Agenda Commands*")
  2600. (erase-buffer)
  2601. (insert (eval-when-compile
  2602. (let ((header
  2603. "Press key for an agenda command: < Buffer, subtree/region restriction
  2604. -------------------------------- > Remove restriction
  2605. a Agenda for current week or day e Export agenda views
  2606. t List of all TODO entries T Entries with special TODO kwd
  2607. m Match a TAGS/PROP/TODO query M Like m, but only TODO entries
  2608. s Search for keywords S Like s, but only TODO entries
  2609. L Timeline for current buffer # List stuck projects (!=configure)
  2610. / Multi-occur C Configure custom agenda commands
  2611. ? Find :FLAGGED: entries * Toggle sticky agenda views
  2612. ")
  2613. (start 0))
  2614. (while (string-match
  2615. "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
  2616. header start)
  2617. (setq start (match-end 0))
  2618. (add-text-properties (match-beginning 2) (match-end 2)
  2619. '(face bold) header))
  2620. header)))
  2621. (setq header-end (point-marker))
  2622. (while t
  2623. (setq custom1 custom)
  2624. (when (eq rmheader t)
  2625. (org-goto-line 1)
  2626. (re-search-forward ":" nil t)
  2627. (delete-region (match-end 0) (point-at-eol))
  2628. (forward-char 1)
  2629. (looking-at "-+")
  2630. (delete-region (match-end 0) (point-at-eol))
  2631. (move-marker header-end (match-end 0)))
  2632. (goto-char header-end)
  2633. (delete-region (point) (point-max))
  2634. ;; Produce all the lines that describe custom commands and prefixes
  2635. (setq lines nil)
  2636. (while (setq entry (pop custom1))
  2637. (setq key (car entry) desc (nth 1 entry)
  2638. type (nth 2 entry)
  2639. match (nth 3 entry))
  2640. (if (> (length key) 1)
  2641. (add-to-list 'prefixes (string-to-char key))
  2642. (setq line
  2643. (format
  2644. "%-4s%-14s"
  2645. (org-add-props (copy-sequence key)
  2646. '(face bold))
  2647. (cond
  2648. ((string-match "\\S-" desc) desc)
  2649. ((eq type 'agenda) "Agenda for current week or day")
  2650. ((eq type 'agenda*) "Appointments for current week or day")
  2651. ((eq type 'alltodo) "List of all TODO entries")
  2652. ((eq type 'search) "Word search")
  2653. ((eq type 'stuck) "List of stuck projects")
  2654. ((eq type 'todo) "TODO keyword")
  2655. ((eq type 'tags) "Tags query")
  2656. ((eq type 'tags-todo) "Tags (TODO)")
  2657. ((eq type 'tags-tree) "Tags tree")
  2658. ((eq type 'todo-tree) "TODO kwd tree")
  2659. ((eq type 'occur-tree) "Occur tree")
  2660. ((functionp type) (if (symbolp type)
  2661. (symbol-name type)
  2662. "Lambda expression"))
  2663. (t "???"))))
  2664. (if org-agenda-menu-show-matcher
  2665. (setq line
  2666. (concat line ": "
  2667. (cond
  2668. ((stringp match)
  2669. (setq match (copy-sequence match))
  2670. (org-add-props match nil 'face 'org-warning))
  2671. ((listp type)
  2672. (format "set of %d commands" (length type))))))
  2673. (if (org-string-nw-p match)
  2674. (add-text-properties
  2675. 0 (length line) (list 'help-echo
  2676. (concat "Matcher: " match)) line)))
  2677. (push line lines)))
  2678. (setq lines (nreverse lines))
  2679. (when prefixes
  2680. (mapc (lambda (x)
  2681. (push
  2682. (format "%s %s"
  2683. (org-add-props (char-to-string x)
  2684. nil 'face 'bold)
  2685. (or (cdr (assoc (concat selstring
  2686. (char-to-string x))
  2687. prefix-descriptions))
  2688. "Prefix key"))
  2689. lines))
  2690. prefixes))
  2691. ;; Check if we should display in two columns
  2692. (if org-agenda-menu-two-columns
  2693. (progn
  2694. (setq n (length lines)
  2695. n1 (+ (/ n 2) (mod n 2))
  2696. right (nthcdr n1 lines)
  2697. left (copy-sequence lines))
  2698. (setcdr (nthcdr (1- n1) left) nil))
  2699. (setq left lines right nil))
  2700. (while left
  2701. (insert "\n" (pop left))
  2702. (when right
  2703. (if (< (current-column) 40)
  2704. (move-to-column 40 t)
  2705. (insert " "))
  2706. (insert (pop right))))
  2707. ;; Make the window the right size
  2708. (goto-char (point-min))
  2709. (if second-time
  2710. (if (not (pos-visible-in-window-p (point-max)))
  2711. (org-fit-window-to-buffer))
  2712. (setq second-time t)
  2713. (org-fit-window-to-buffer))
  2714. ;; Ask for selection
  2715. (message "Press key for agenda command%s:"
  2716. (if (or restrict-ok org-agenda-overriding-restriction)
  2717. (if org-agenda-overriding-restriction
  2718. " (restriction lock active)"
  2719. (if restriction
  2720. (format " (restricted to %s)" restriction)
  2721. " (unrestricted)"))
  2722. ""))
  2723. (setq c (read-char-exclusive))
  2724. (message "")
  2725. (cond
  2726. ((assoc (char-to-string c) custom)
  2727. (setq selstring (concat selstring (char-to-string c)))
  2728. (throw 'exit (cons selstring restriction)))
  2729. ((memq c prefixes)
  2730. (setq selstring (concat selstring (char-to-string c))
  2731. prefixes nil
  2732. rmheader (or rmheader t)
  2733. custom (delq nil (mapcar
  2734. (lambda (x)
  2735. (if (or (= (length (car x)) 1)
  2736. (/= (string-to-char (car x)) c))
  2737. nil
  2738. (cons (substring (car x) 1) (cdr x))))
  2739. custom))))
  2740. ((eq c ?*)
  2741. (call-interactively 'org-toggle-sticky-agenda)
  2742. (sit-for 2))
  2743. ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
  2744. (message "Restriction is only possible in Org buffers")
  2745. (ding) (sit-for 1))
  2746. ((eq c ?1)
  2747. (org-agenda-remove-restriction-lock 'noupdate)
  2748. (setq restriction 'buffer))
  2749. ((eq c ?0)
  2750. (org-agenda-remove-restriction-lock 'noupdate)
  2751. (setq restriction (if region-p 'region 'subtree)))
  2752. ((eq c ?<)
  2753. (org-agenda-remove-restriction-lock 'noupdate)
  2754. (setq restriction
  2755. (cond
  2756. ((eq restriction 'buffer)
  2757. (if region-p 'region 'subtree))
  2758. ((memq restriction '(subtree region))
  2759. nil)
  2760. (t 'buffer))))
  2761. ((eq c ?>)
  2762. (org-agenda-remove-restriction-lock 'noupdate)
  2763. (setq restriction nil))
  2764. ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
  2765. (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
  2766. ((and (> (length selstring) 0) (eq c ?\d))
  2767. (delete-window)
  2768. (org-agenda-get-restriction-and-command prefix-descriptions))
  2769. ((equal c ?q) (error "Abort"))
  2770. (t (user-error "Invalid key %c" c))))))))
  2771. (defun org-agenda-fit-window-to-buffer ()
  2772. "Fit the window to the buffer size."
  2773. (and (memq org-agenda-window-setup '(reorganize-frame))
  2774. (fboundp 'fit-window-to-buffer)
  2775. (if (and (= (cdr org-agenda-window-frame-fractions) 1.0)
  2776. (= (car org-agenda-window-frame-fractions) 1.0))
  2777. (delete-other-windows)
  2778. (org-fit-window-to-buffer
  2779. nil
  2780. (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
  2781. (floor (* (frame-height) (car org-agenda-window-frame-fractions)))))))
  2782. (defvar org-cmd nil)
  2783. (defvar org-agenda-overriding-cmd nil)
  2784. (defvar org-agenda-overriding-arguments nil)
  2785. (defvar org-agenda-overriding-cmd-arguments nil)
  2786. (defun org-agenda-run-series (name series)
  2787. "Run agenda NAME as a SERIES of agenda commands."
  2788. (org-let (nth 1 series) '(org-agenda-prepare name))
  2789. ;; We need to reset agenda markers here, because when constructing a
  2790. ;; block agenda, the individual blocks do not do that.
  2791. (org-agenda-reset-markers)
  2792. (let* ((org-agenda-multi t)
  2793. (redo (list 'org-agenda-run-series name (list 'quote series)))
  2794. (cmds (car series))
  2795. (gprops (nth 1 series))
  2796. match ;; The byte compiler incorrectly complains about this. Keep it!
  2797. org-cmd type lprops)
  2798. (while (setq org-cmd (pop cmds))
  2799. (setq type (car org-cmd))
  2800. (setq match (eval (nth 1 org-cmd)))
  2801. (setq lprops (nth 2 org-cmd))
  2802. (let ((org-agenda-overriding-arguments
  2803. (if (eq org-agenda-overriding-cmd org-cmd)
  2804. (or org-agenda-overriding-arguments
  2805. org-agenda-overriding-cmd-arguments))))
  2806. (cond
  2807. ((eq type 'agenda)
  2808. (org-let2 gprops lprops
  2809. '(call-interactively 'org-agenda-list)))
  2810. ((eq type 'agenda*)
  2811. (org-let2 gprops lprops
  2812. '(funcall 'org-agenda-list nil nil t)))
  2813. ((eq type 'alltodo)
  2814. (org-let2 gprops lprops
  2815. '(call-interactively 'org-todo-list)))
  2816. ((eq type 'search)
  2817. (org-let2 gprops lprops
  2818. '(org-search-view current-prefix-arg match nil)))
  2819. ((eq type 'stuck)
  2820. (org-let2 gprops lprops
  2821. '(call-interactively 'org-agenda-list-stuck-projects)))
  2822. ((eq type 'tags)
  2823. (org-let2 gprops lprops
  2824. '(org-tags-view current-prefix-arg match)))
  2825. ((eq type 'tags-todo)
  2826. (org-let2 gprops lprops
  2827. '(org-tags-view '(4) match)))
  2828. ((eq type 'todo)
  2829. (org-let2 gprops lprops
  2830. '(org-todo-list match)))
  2831. ((fboundp type)
  2832. (org-let2 gprops lprops
  2833. '(funcall type match)))
  2834. (t (error "Invalid type in command series")))))
  2835. (widen)
  2836. (let ((inhibit-read-only t))
  2837. (add-text-properties (point-min) (point-max)
  2838. `(org-series t org-series-redo-cmd ,redo)))
  2839. (setq org-agenda-redo-command redo)
  2840. (goto-char (point-min)))
  2841. (org-agenda-fit-window-to-buffer)
  2842. (org-let (nth 1 series) '(org-agenda-finalize)))
  2843. ;;;###autoload
  2844. (defmacro org-batch-agenda (cmd-key &rest parameters)
  2845. "Run an agenda command in batch mode and send the result to STDOUT.
  2846. If CMD-KEY is a string of length 1, it is used as a key in
  2847. `org-agenda-custom-commands' and triggers this command. If it is a
  2848. longer string it is used as a tags/todo match string.
  2849. Parameters are alternating variable names and values that will be bound
  2850. before running the agenda command."
  2851. (org-eval-in-environment (org-make-parameter-alist parameters)
  2852. (let (org-agenda-sticky)
  2853. (if (> (length cmd-key) 1)
  2854. (org-tags-view nil cmd-key)
  2855. (org-agenda nil cmd-key))))
  2856. (set-buffer org-agenda-buffer-name)
  2857. (princ (buffer-string)))
  2858. (defvar org-agenda-info nil)
  2859. ;;;###autoload
  2860. (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
  2861. "Run an agenda command in batch mode and send the result to STDOUT.
  2862. If CMD-KEY is a string of length 1, it is used as a key in
  2863. `org-agenda-custom-commands' and triggers this command. If it is a
  2864. longer string it is used as a tags/todo match string.
  2865. Parameters are alternating variable names and values that will be bound
  2866. before running the agenda command.
  2867. The output gives a line for each selected agenda item. Each
  2868. item is a list of comma-separated values, like this:
  2869. category,head,type,todo,tags,date,time,extra,priority-l,priority-n
  2870. category The category of the item
  2871. head The headline, without TODO kwd, TAGS and PRIORITY
  2872. type The type of the agenda entry, can be
  2873. todo selected in TODO match
  2874. tagsmatch selected in tags match
  2875. diary imported from diary
  2876. deadline a deadline on given date
  2877. scheduled scheduled on given date
  2878. timestamp entry has timestamp on given date
  2879. closed entry was closed on given date
  2880. upcoming-deadline warning about deadline
  2881. past-scheduled forwarded scheduled item
  2882. block entry has date block including g. date
  2883. todo The todo keyword, if any
  2884. tags All tags including inherited ones, separated by colons
  2885. date The relevant date, like 2007-2-14
  2886. time The time, like 15:00-16:50
  2887. extra Sting with extra planning info
  2888. priority-l The priority letter if any was given
  2889. priority-n The computed numerical priority
  2890. agenda-day The day in the agenda where this is listed"
  2891. (org-eval-in-environment (append '((org-agenda-remove-tags t))
  2892. (org-make-parameter-alist parameters))
  2893. (if (> (length cmd-key) 2)
  2894. (org-tags-view nil cmd-key)
  2895. (org-agenda nil cmd-key)))
  2896. (set-buffer org-agenda-buffer-name)
  2897. (let* ((lines (org-split-string (buffer-string) "\n"))
  2898. line)
  2899. (while (setq line (pop lines))
  2900. (catch 'next
  2901. (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
  2902. (setq org-agenda-info
  2903. (org-fix-agenda-info (text-properties-at 0 line)))
  2904. (princ
  2905. (mapconcat 'org-agenda-export-csv-mapper
  2906. '(org-category txt type todo tags date time extra
  2907. priority-letter priority agenda-day)
  2908. ","))
  2909. (princ "\n")))))
  2910. (defun org-fix-agenda-info (props)
  2911. "Make sure all properties on an agenda item have a canonical form.
  2912. This ensures the export commands can easily use it."
  2913. (let (tmp re)
  2914. (when (setq tmp (plist-get props 'tags))
  2915. (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
  2916. (when (setq tmp (plist-get props 'date))
  2917. (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2918. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2919. '((format "%4d, %9s %2s, %4s" dayname monthname day year))
  2920. (setq tmp (calendar-date-string tmp)))
  2921. (setq props (plist-put props 'date tmp)))
  2922. (when (setq tmp (plist-get props 'day))
  2923. (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2924. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2925. (setq tmp (calendar-date-string tmp)))
  2926. (setq props (plist-put props 'day tmp))
  2927. (setq props (plist-put props 'agenda-day tmp)))
  2928. (when (setq tmp (plist-get props 'txt))
  2929. (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
  2930. (plist-put props 'priority-letter (match-string 1 tmp))
  2931. (setq tmp (replace-match "" t t tmp)))
  2932. (when (and (setq re (plist-get props 'org-todo-regexp))
  2933. (setq re (concat "\\`\\.*" re " ?"))
  2934. (string-match re tmp))
  2935. (plist-put props 'todo (match-string 1 tmp))
  2936. (setq tmp (replace-match "" t t tmp)))
  2937. (plist-put props 'txt tmp)))
  2938. props)
  2939. (defun org-agenda-export-csv-mapper (prop)
  2940. (let ((res (plist-get org-agenda-info prop)))
  2941. (setq res
  2942. (cond
  2943. ((not res) "")
  2944. ((stringp res) res)
  2945. (t (prin1-to-string res))))
  2946. (org-trim (replace-regexp-in-string "," ";" res nil t))))
  2947. ;;;###autoload
  2948. (defun org-store-agenda-views (&rest parameters)
  2949. "Store agenda views."
  2950. (interactive)
  2951. (eval (list 'org-batch-store-agenda-views)))
  2952. ;;;###autoload
  2953. (defmacro org-batch-store-agenda-views (&rest parameters)
  2954. "Run all custom agenda commands that have a file argument."
  2955. (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
  2956. (pop-up-frames nil)
  2957. (dir default-directory)
  2958. (pars (org-make-parameter-alist parameters))
  2959. cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
  2960. (save-window-excursion
  2961. (while cmds
  2962. (setq cmd (pop cmds)
  2963. thiscmdkey (car cmd)
  2964. thiscmdcmd (cdr cmd)
  2965. match (nth 2 thiscmdcmd)
  2966. bufname (if org-agenda-sticky
  2967. (or (and (stringp match)
  2968. (format "*Org Agenda(%s:%s)*" thiscmdkey match))
  2969. (format "*Org Agenda(%s)*" thiscmdkey))
  2970. org-agenda-buffer-name)
  2971. cmd-or-set (nth 2 cmd)
  2972. opts (nth (if (listp cmd-or-set) 3 4) cmd)
  2973. files (nth (if (listp cmd-or-set) 4 5) cmd))
  2974. (if (stringp files) (setq files (list files)))
  2975. (when files
  2976. (org-eval-in-environment (append org-agenda-exporter-settings
  2977. opts pars)
  2978. (org-agenda nil thiscmdkey))
  2979. (set-buffer bufname)
  2980. (while files
  2981. (org-eval-in-environment (append org-agenda-exporter-settings
  2982. opts pars)
  2983. (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
  2984. (and (get-buffer bufname)
  2985. (kill-buffer bufname)))))))
  2986. (defvar org-agenda-current-span nil
  2987. "The current span used in the agenda view.") ; local variable in the agenda buffer
  2988. (defun org-agenda-mark-header-line (pos)
  2989. "Mark the line at POS as an agenda structure header."
  2990. (save-excursion
  2991. (goto-char pos)
  2992. (put-text-property (point-at-bol) (point-at-eol)
  2993. 'org-agenda-structural-header t)
  2994. (when org-agenda-title-append
  2995. (put-text-property (point-at-bol) (point-at-eol)
  2996. 'org-agenda-title-append org-agenda-title-append))))
  2997. (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
  2998. (defvar org-agenda-write-buffer-name "Agenda View")
  2999. (defun org-agenda-write (file &optional open nosettings agenda-bufname)
  3000. "Write the current buffer (an agenda view) as a file.
  3001. Depending on the extension of the file name, plain text (.txt),
  3002. HTML (.html or .htm), PDF (.pdf) or Postscript (.ps) is produced.
  3003. If the extension is .ics, translate visible agenda into iCalendar
  3004. format. If the extension is .org, collect all subtrees
  3005. corresponding to the agenda entries and add them in an .org file.
  3006. With prefix argument OPEN, open the new file immediately. If
  3007. NOSETTINGS is given, do not scope the settings of
  3008. `org-agenda-exporter-settings' into the export commands. This is
  3009. used when the settings have already been scoped and we do not
  3010. wish to overrule other, higher priority settings. If
  3011. AGENDA-BUFFER-NAME is provided, use this as the buffer name for
  3012. the agenda to write."
  3013. (interactive "FWrite agenda to file: \nP")
  3014. (if (or (not (file-writable-p file))
  3015. (and (file-exists-p file)
  3016. (if (called-interactively-p 'any)
  3017. (not (y-or-n-p (format "Overwrite existing file %s? " file))))))
  3018. (user-error "Cannot write agenda to file %s" file))
  3019. (org-let (if nosettings nil org-agenda-exporter-settings)
  3020. '(save-excursion
  3021. (save-window-excursion
  3022. (let ((bs (copy-sequence (buffer-string)))
  3023. (extension (file-name-extension file))
  3024. beg content)
  3025. (with-temp-buffer
  3026. (rename-buffer org-agenda-write-buffer-name t)
  3027. (set-buffer-modified-p nil)
  3028. (insert bs)
  3029. (org-agenda-remove-marked-text 'invisible 'org-filtered)
  3030. (run-hooks 'org-agenda-before-write-hook)
  3031. (cond
  3032. ((bound-and-true-p org-mobile-creating-agendas)
  3033. (org-mobile-write-agenda-for-mobile file))
  3034. ((string= "org" extension)
  3035. (let (content p m message-log-max)
  3036. (goto-char (point-min))
  3037. (while (setq p (next-single-property-change (point) 'org-hd-marker nil))
  3038. (goto-char p)
  3039. (setq m (get-text-property (point) 'org-hd-marker))
  3040. (when m
  3041. (push (save-excursion
  3042. (set-buffer (marker-buffer m))
  3043. (goto-char m)
  3044. (org-copy-subtree 1 nil t t)
  3045. org-subtree-clip)
  3046. content)))
  3047. (find-file file)
  3048. (erase-buffer)
  3049. (dolist (s content) (org-paste-subtree 1 s))
  3050. (write-file file)
  3051. (kill-buffer (current-buffer))
  3052. (message "Org file written to %s" file)))
  3053. ((member extension '("html" "htm"))
  3054. (require 'htmlize)
  3055. (set-buffer (htmlize-buffer (current-buffer)))
  3056. (when org-agenda-export-html-style
  3057. ;; replace <style> section with org-agenda-export-html-style
  3058. (goto-char (point-min))
  3059. (kill-region (- (search-forward "<style") 6)
  3060. (search-forward "</style>"))
  3061. (insert org-agenda-export-html-style))
  3062. (write-file file)
  3063. (kill-buffer (current-buffer))
  3064. (message "HTML written to %s" file))
  3065. ((string= "ps" extension)
  3066. (require 'ps-print)
  3067. (ps-print-buffer-with-faces file)
  3068. (message "Postscript written to %s" file))
  3069. ((string= "pdf" extension)
  3070. (require 'ps-print)
  3071. (ps-print-buffer-with-faces
  3072. (concat (file-name-sans-extension file) ".ps"))
  3073. (call-process "ps2pdf" nil nil nil
  3074. (expand-file-name
  3075. (concat (file-name-sans-extension file) ".ps"))
  3076. (expand-file-name file))
  3077. (delete-file (concat (file-name-sans-extension file) ".ps"))
  3078. (message "PDF written to %s" file))
  3079. ((string= "ics" extension)
  3080. (require 'ox-icalendar)
  3081. (org-icalendar-export-current-agenda (expand-file-name file)))
  3082. (t
  3083. (let ((bs (buffer-string)))
  3084. (find-file file)
  3085. (erase-buffer)
  3086. (insert bs)
  3087. (save-buffer 0)
  3088. (kill-buffer (current-buffer))
  3089. (message "Plain text written to %s" file))))))))
  3090. (set-buffer (or agenda-bufname
  3091. (and (called-interactively-p 'any) (buffer-name))
  3092. org-agenda-buffer-name)))
  3093. (when open (org-open-file file)))
  3094. (defun org-agenda-remove-marked-text (property &optional value)
  3095. "Delete all text marked with VALUE of PROPERTY.
  3096. VALUE defaults to t."
  3097. (let (beg)
  3098. (setq value (or value t))
  3099. (while (setq beg (text-property-any (point-min) (point-max)
  3100. property value))
  3101. (delete-region
  3102. beg (or (next-single-property-change beg property)
  3103. (point-max))))))
  3104. (defun org-agenda-add-entry-text ()
  3105. "Add entry text to agenda lines.
  3106. This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
  3107. entry text following headings shown in the agenda.
  3108. Drawers will be excluded, also the line with scheduling/deadline info."
  3109. (when (and (> org-agenda-add-entry-text-maxlines 0)
  3110. (not (bound-and-true-p org-mobile-creating-agendas)))
  3111. (let (m txt)
  3112. (goto-char (point-min))
  3113. (while (not (eobp))
  3114. (if (not (setq m (org-get-at-bol 'org-hd-marker)))
  3115. (beginning-of-line 2)
  3116. (setq txt (org-agenda-get-some-entry-text
  3117. m org-agenda-add-entry-text-maxlines " > "))
  3118. (end-of-line 1)
  3119. (if (string-match "\\S-" txt)
  3120. (insert "\n" txt)
  3121. (or (eobp) (forward-char 1))))))))
  3122. (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
  3123. &rest keep)
  3124. "Extract entry text from MARKER, at most N-LINES lines.
  3125. This will ignore drawers etc, just get the text.
  3126. If INDENT is given, prefix every line with this string. If KEEP is
  3127. given, it is a list of symbols, defining stuff that should not be
  3128. removed from the entry content. Currently only `planning' is allowed here."
  3129. (let (txt drawer-re kwd-time-re ind)
  3130. (save-excursion
  3131. (with-current-buffer (marker-buffer marker)
  3132. (if (not (derived-mode-p 'org-mode))
  3133. (setq txt "")
  3134. (org-with-wide-buffer
  3135. (goto-char marker)
  3136. (end-of-line 1)
  3137. (setq txt (buffer-substring
  3138. (min (1+ (point)) (point-max))
  3139. (progn (outline-next-heading) (point)))
  3140. drawer-re org-drawer-regexp
  3141. kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
  3142. ".*\n?"))
  3143. (with-temp-buffer
  3144. (insert txt)
  3145. (when org-agenda-add-entry-text-descriptive-links
  3146. (goto-char (point-min))
  3147. (while (org-activate-bracket-links (point-max))
  3148. (add-text-properties (match-beginning 0) (match-end 0)
  3149. '(face org-link))))
  3150. (goto-char (point-min))
  3151. (while (re-search-forward org-bracket-link-regexp (point-max) t)
  3152. (set-text-properties (match-beginning 0) (match-end 0)
  3153. nil))
  3154. (goto-char (point-min))
  3155. (while (re-search-forward drawer-re nil t)
  3156. (delete-region
  3157. (match-beginning 0)
  3158. (progn (re-search-forward
  3159. "^[ \t]*:END:.*\n?" nil 'move)
  3160. (point))))
  3161. (unless (member 'planning keep)
  3162. (goto-char (point-min))
  3163. (while (re-search-forward kwd-time-re nil t)
  3164. (replace-match "")))
  3165. (goto-char (point-min))
  3166. (when org-agenda-entry-text-exclude-regexps
  3167. (let ((re-list org-agenda-entry-text-exclude-regexps) re)
  3168. (while (setq re (pop re-list))
  3169. (goto-char (point-min))
  3170. (while (re-search-forward re nil t)
  3171. (replace-match "")))))
  3172. (goto-char (point-max))
  3173. (skip-chars-backward " \t\n")
  3174. (if (looking-at "[ \t\n]+\\'") (replace-match ""))
  3175. ;; find and remove min common indentation
  3176. (goto-char (point-min))
  3177. (untabify (point-min) (point-max))
  3178. (setq ind (org-get-indentation))
  3179. (while (not (eobp))
  3180. (unless (looking-at "[ \t]*$")
  3181. (setq ind (min ind (org-get-indentation))))
  3182. (beginning-of-line 2))
  3183. (goto-char (point-min))
  3184. (while (not (eobp))
  3185. (unless (looking-at "[ \t]*$")
  3186. (move-to-column ind)
  3187. (delete-region (point-at-bol) (point)))
  3188. (beginning-of-line 2))
  3189. (run-hooks 'org-agenda-entry-text-cleanup-hook)
  3190. (goto-char (point-min))
  3191. (when indent
  3192. (while (and (not (eobp)) (re-search-forward "^" nil t))
  3193. (replace-match indent t t)))
  3194. (goto-char (point-min))
  3195. (while (looking-at "[ \t]*\n") (replace-match ""))
  3196. (goto-char (point-max))
  3197. (when (> (org-current-line)
  3198. n-lines)
  3199. (org-goto-line (1+ n-lines))
  3200. (backward-char 1))
  3201. (setq txt (buffer-substring (point-min) (point))))))))
  3202. txt))
  3203. (defun org-check-for-org-mode ()
  3204. "Make sure current buffer is in org-mode. Error if not."
  3205. (or (derived-mode-p 'org-mode)
  3206. (error "Cannot execute Org agenda command on buffer in %s"
  3207. major-mode)))
  3208. ;;; Agenda prepare and finalize
  3209. (defvar org-agenda-multi nil) ; dynamically scoped
  3210. (defvar org-agenda-pre-window-conf nil)
  3211. (defvar org-agenda-columns-active nil)
  3212. (defvar org-agenda-name nil)
  3213. (defvar org-agenda-tag-filter nil)
  3214. (defvar org-agenda-category-filter nil)
  3215. (defvar org-agenda-regexp-filter nil)
  3216. (defvar org-agenda-effort-filter nil)
  3217. (defvar org-agenda-top-headline-filter nil)
  3218. (defvar org-agenda-tag-filter-preset nil
  3219. "A preset of the tags filter used for secondary agenda filtering.
  3220. This must be a list of strings, each string must be a single tag preceded
  3221. by \"+\" or \"-\".
  3222. This variable should not be set directly, but agenda custom commands can
  3223. bind it in the options section. The preset filter is a global property of
  3224. the entire agenda view. In a block agenda, it will not work reliably to
  3225. define a filter for one of the individual blocks. You need to set it in
  3226. the global options and expect it to be applied to the entire view.")
  3227. (defvar org-agenda-category-filter-preset nil
  3228. "A preset of the category filter used for secondary agenda filtering.
  3229. This must be a list of strings, each string must be a single category
  3230. preceded by \"+\" or \"-\".
  3231. This variable should not be set directly, but agenda custom commands can
  3232. bind it in the options section. The preset filter is a global property of
  3233. the entire agenda view. In a block agenda, it will not work reliably to
  3234. define a filter for one of the individual blocks. You need to set it in
  3235. the global options and expect it to be applied to the entire view.")
  3236. (defvar org-agenda-regexp-filter-preset nil
  3237. "A preset of the regexp filter used for secondary agenda filtering.
  3238. This must be a list of strings, each string must be a single regexp
  3239. preceded by \"+\" or \"-\".
  3240. This variable should not be set directly, but agenda custom commands can
  3241. bind it in the options section. The preset filter is a global property of
  3242. the entire agenda view. In a block agenda, it will not work reliably to
  3243. define a filter for one of the individual blocks. You need to set it in
  3244. the global options and expect it to be applied to the entire view.")
  3245. (defvar org-agenda-effort-filter-preset nil
  3246. "A preset of the effort condition used for secondary agenda filtering.
  3247. This must be a list of strings, each string must be a single regexp
  3248. preceded by \"+\" or \"-\".
  3249. This variable should not be set directly, but agenda custom commands can
  3250. bind it in the options section. The preset filter is a global property of
  3251. the entire agenda view. In a block agenda, it will not work reliably to
  3252. define a filter for one of the individual blocks. You need to set it in
  3253. the global options and expect it to be applied to the entire view.")
  3254. (defun org-agenda-use-sticky-p ()
  3255. "Return non-nil if an agenda buffer named
  3256. `org-agenda-buffer-name' exists and should be shown instead of
  3257. generating a new one."
  3258. (and
  3259. ;; turned off by user
  3260. org-agenda-sticky
  3261. ;; For multi-agenda buffer already exists
  3262. (not org-agenda-multi)
  3263. ;; buffer found
  3264. (get-buffer org-agenda-buffer-name)
  3265. ;; C-u parameter is same as last call
  3266. (with-current-buffer (get-buffer org-agenda-buffer-name)
  3267. (and
  3268. (equal current-prefix-arg
  3269. org-agenda-last-prefix-arg)
  3270. ;; In case user turned stickiness on, while having existing
  3271. ;; Agenda buffer active, don't reuse that buffer, because it
  3272. ;; does not have org variables local
  3273. org-agenda-this-buffer-is-sticky))))
  3274. (defun org-agenda-prepare-window (abuf filter-alist)
  3275. "Setup agenda buffer in the window.
  3276. ABUF is the buffer for the agenda window.
  3277. FILTER-ALIST is an alist of filters we need to apply when
  3278. `org-agenda-persistent-filter' is non-nil."
  3279. (let* ((awin (get-buffer-window abuf)) wconf)
  3280. (cond
  3281. ((equal (current-buffer) abuf) nil)
  3282. (awin (select-window awin))
  3283. ((not (setq wconf (current-window-configuration))))
  3284. ((eq org-agenda-window-setup 'current-window)
  3285. (pop-to-buffer-same-window abuf))
  3286. ((eq org-agenda-window-setup 'other-window)
  3287. (org-switch-to-buffer-other-window abuf))
  3288. ((eq org-agenda-window-setup 'other-frame)
  3289. (switch-to-buffer-other-frame abuf))
  3290. ((eq org-agenda-window-setup 'only-window)
  3291. (delete-other-windows)
  3292. (pop-to-buffer-same-window abuf))
  3293. ((eq org-agenda-window-setup 'reorganize-frame)
  3294. (delete-other-windows)
  3295. (org-switch-to-buffer-other-window abuf)))
  3296. (setq org-agenda-tag-filter (cdr (assq 'tag filter-alist)))
  3297. (setq org-agenda-category-filter (cdr (assq 'cat filter-alist)))
  3298. (setq org-agenda-effort-filter (cdr (assq 'effort filter-alist)))
  3299. (setq org-agenda-regexp-filter (cdr (assq 're filter-alist)))
  3300. ;; Additional test in case agenda is invoked from within agenda
  3301. ;; buffer via elisp link.
  3302. (unless (equal (current-buffer) abuf)
  3303. (pop-to-buffer-same-window abuf))
  3304. (setq org-agenda-pre-window-conf
  3305. (or wconf org-agenda-pre-window-conf))))
  3306. (defun org-agenda-prepare (&optional name)
  3307. (let ((filter-alist (if org-agenda-persistent-filter
  3308. (with-current-buffer
  3309. (get-buffer-create org-agenda-buffer-name)
  3310. (list `(tag . ,org-agenda-tag-filter)
  3311. `(re . ,org-agenda-regexp-filter)
  3312. `(effort . ,org-agenda-effort-filter)
  3313. `(cat . ,org-agenda-category-filter))))))
  3314. (if (org-agenda-use-sticky-p)
  3315. (progn
  3316. (put 'org-agenda-tag-filter :preset-filter nil)
  3317. (put 'org-agenda-category-filter :preset-filter nil)
  3318. (put 'org-agenda-regexp-filter :preset-filter nil)
  3319. ;; Popup existing buffer
  3320. (org-agenda-prepare-window (get-buffer org-agenda-buffer-name)
  3321. filter-alist)
  3322. (message "Sticky Agenda buffer, use `r' to refresh")
  3323. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3324. (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
  3325. (setq org-todo-keywords-for-agenda nil)
  3326. (put 'org-agenda-tag-filter :preset-filter
  3327. org-agenda-tag-filter-preset)
  3328. (put 'org-agenda-category-filter :preset-filter
  3329. org-agenda-category-filter-preset)
  3330. (put 'org-agenda-regexp-filter :preset-filter
  3331. org-agenda-regexp-filter-preset)
  3332. (put 'org-agenda-effort-filter :preset-filter
  3333. org-agenda-effort-filter-preset)
  3334. (if org-agenda-multi
  3335. (progn
  3336. (setq buffer-read-only nil)
  3337. (goto-char (point-max))
  3338. (unless (or (bobp) org-agenda-compact-blocks
  3339. (not org-agenda-block-separator))
  3340. (insert "\n"
  3341. (if (stringp org-agenda-block-separator)
  3342. org-agenda-block-separator
  3343. (make-string (window-width) org-agenda-block-separator))
  3344. "\n"))
  3345. (narrow-to-region (point) (point-max)))
  3346. (setq org-done-keywords-for-agenda nil)
  3347. ;; Setting any org variables that are in org-agenda-local-vars
  3348. ;; list need to be done after the prepare call
  3349. (org-agenda-prepare-window
  3350. (get-buffer-create org-agenda-buffer-name) filter-alist)
  3351. (setq buffer-read-only nil)
  3352. (org-agenda-reset-markers)
  3353. (let ((inhibit-read-only t)) (erase-buffer))
  3354. (org-agenda-mode)
  3355. (setq org-agenda-buffer (current-buffer))
  3356. (setq org-agenda-contributing-files nil)
  3357. (setq org-agenda-columns-active nil)
  3358. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  3359. (setq org-todo-keywords-for-agenda
  3360. (org-uniquify org-todo-keywords-for-agenda))
  3361. (setq org-done-keywords-for-agenda
  3362. (org-uniquify org-done-keywords-for-agenda))
  3363. (setq org-agenda-last-prefix-arg current-prefix-arg)
  3364. (setq org-agenda-this-buffer-name org-agenda-buffer-name)
  3365. (and name (not org-agenda-name)
  3366. (setq-local org-agenda-name name)))
  3367. (setq buffer-read-only nil))))
  3368. (defvar org-agenda-overriding-columns-format) ; From org-colview.el
  3369. (defun org-agenda-finalize ()
  3370. "Finishing touch for the agenda buffer, called just before displaying it."
  3371. (unless org-agenda-multi
  3372. (save-excursion
  3373. (let ((inhibit-read-only t))
  3374. (goto-char (point-min))
  3375. (save-excursion
  3376. (while (org-activate-bracket-links (point-max))
  3377. (add-text-properties (match-beginning 0) (match-end 0)
  3378. '(face org-link))))
  3379. (save-excursion
  3380. (while (org-activate-plain-links (point-max))
  3381. (add-text-properties (match-beginning 0) (match-end 0)
  3382. '(face org-link))))
  3383. (unless (eq org-agenda-remove-tags t)
  3384. (org-agenda-align-tags))
  3385. (unless org-agenda-with-colors
  3386. (remove-text-properties (point-min) (point-max) '(face nil)))
  3387. (if (and (boundp 'org-agenda-overriding-columns-format)
  3388. org-agenda-overriding-columns-format)
  3389. (setq-local org-agenda-overriding-columns-format
  3390. org-agenda-overriding-columns-format))
  3391. (if (and (boundp 'org-agenda-view-columns-initially)
  3392. org-agenda-view-columns-initially)
  3393. (org-agenda-columns))
  3394. (when org-agenda-fontify-priorities
  3395. (org-agenda-fontify-priorities))
  3396. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  3397. (org-agenda-dim-blocked-tasks))
  3398. (org-agenda-mark-clocking-task)
  3399. (when org-agenda-entry-text-mode
  3400. (org-agenda-entry-text-hide)
  3401. (org-agenda-entry-text-show))
  3402. (if (and (functionp 'org-habit-insert-consistency-graphs)
  3403. (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
  3404. (org-habit-insert-consistency-graphs))
  3405. (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
  3406. (unless (or (eq org-agenda-show-inherited-tags 'always)
  3407. (and (listp org-agenda-show-inherited-tags)
  3408. (memq org-agenda-type org-agenda-show-inherited-tags))
  3409. (and (eq org-agenda-show-inherited-tags t)
  3410. (or (eq org-agenda-use-tag-inheritance t)
  3411. (and (listp org-agenda-use-tag-inheritance)
  3412. (not (memq org-agenda-type
  3413. org-agenda-use-tag-inheritance))))))
  3414. (let (mrk)
  3415. (save-excursion
  3416. (goto-char (point-min))
  3417. (while (equal (forward-line) 0)
  3418. (when (setq mrk (get-text-property (point) 'org-hd-marker))
  3419. (put-text-property (point-at-bol) (point-at-eol)
  3420. 'tags (org-with-point-at mrk
  3421. (delete-dups
  3422. (mapcar 'downcase (org-get-tags-at))))))))))
  3423. (run-hooks 'org-agenda-finalize-hook)
  3424. (when org-agenda-top-headline-filter
  3425. (org-agenda-filter-top-headline-apply
  3426. org-agenda-top-headline-filter))
  3427. (when org-agenda-tag-filter
  3428. (org-agenda-filter-apply org-agenda-tag-filter 'tag t))
  3429. (when (get 'org-agenda-tag-filter :preset-filter)
  3430. (org-agenda-filter-apply
  3431. (get 'org-agenda-tag-filter :preset-filter) 'tag t))
  3432. (when org-agenda-category-filter
  3433. (org-agenda-filter-apply org-agenda-category-filter 'category))
  3434. (when (get 'org-agenda-category-filter :preset-filter)
  3435. (org-agenda-filter-apply
  3436. (get 'org-agenda-category-filter :preset-filter) 'category))
  3437. (when org-agenda-regexp-filter
  3438. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
  3439. (when (get 'org-agenda-regexp-filter :preset-filter)
  3440. (org-agenda-filter-apply
  3441. (get 'org-agenda-regexp-filter :preset-filter) 'regexp))
  3442. (when org-agenda-effort-filter
  3443. (org-agenda-filter-apply org-agenda-effort-filter 'effort))
  3444. (when (get 'org-agenda-effort-filter :preset-filter)
  3445. (org-agenda-filter-apply
  3446. (get 'org-agenda-effort-filter :preset-filter) 'effort))
  3447. (add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)))))
  3448. (defun org-agenda-mark-clocking-task ()
  3449. "Mark the current clock entry in the agenda if it is present."
  3450. ;; We need to widen when `org-agenda-finalize' is called from
  3451. ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in')
  3452. (when (bound-and-true-p org-clock-current-task)
  3453. (save-restriction
  3454. (widen)
  3455. (org-agenda-unmark-clocking-task)
  3456. (when (marker-buffer org-clock-hd-marker)
  3457. (save-excursion
  3458. (goto-char (point-min))
  3459. (let (s ov)
  3460. (while (setq s (next-single-property-change (point) 'org-hd-marker))
  3461. (goto-char s)
  3462. (when (equal (org-get-at-bol 'org-hd-marker)
  3463. org-clock-hd-marker)
  3464. (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
  3465. (overlay-put ov 'type 'org-agenda-clocking)
  3466. (overlay-put ov 'face 'org-agenda-clocking)
  3467. (overlay-put ov 'help-echo
  3468. "The clock is running in this item")))))))))
  3469. (defun org-agenda-unmark-clocking-task ()
  3470. "Unmark the current clocking task."
  3471. (mapc (lambda (o)
  3472. (if (eq (overlay-get o 'type) 'org-agenda-clocking)
  3473. (delete-overlay o)))
  3474. (overlays-in (point-min) (point-max))))
  3475. (defun org-agenda-fontify-priorities ()
  3476. "Make highest priority lines bold, and lowest italic."
  3477. (interactive)
  3478. (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
  3479. (delete-overlay o)))
  3480. (overlays-in (point-min) (point-max)))
  3481. (save-excursion
  3482. (let (b e p ov h l)
  3483. (goto-char (point-min))
  3484. (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
  3485. (setq h (or (get-char-property (point) 'org-highest-priority)
  3486. org-highest-priority)
  3487. l (or (get-char-property (point) 'org-lowest-priority)
  3488. org-lowest-priority)
  3489. p (string-to-char (match-string 1))
  3490. b (match-beginning 0)
  3491. e (if (eq org-agenda-fontify-priorities 'cookies)
  3492. (match-end 0)
  3493. (point-at-eol))
  3494. ov (make-overlay b e))
  3495. (overlay-put
  3496. ov 'face
  3497. (let ((special-face
  3498. (cond ((org-face-from-face-or-color
  3499. 'priority nil
  3500. (cdr (assoc p org-priority-faces))))
  3501. ((and (listp org-agenda-fontify-priorities)
  3502. (org-face-from-face-or-color
  3503. 'priority nil
  3504. (cdr (assoc p org-agenda-fontify-priorities)))))
  3505. ((equal p l) 'italic)
  3506. ((equal p h) 'bold))))
  3507. (if special-face (list special-face 'org-priority) 'org-priority)))
  3508. (overlay-put ov 'org-type 'org-priority)))))
  3509. (defvar org-depend-tag-blocked)
  3510. (defun org-agenda-dim-blocked-tasks (&optional invisible)
  3511. "Dim currently blocked TODOs in the agenda display.
  3512. When INVISIBLE is non-nil, hide currently blocked TODO instead of
  3513. dimming them."
  3514. (interactive "P")
  3515. (when (called-interactively-p 'interactive)
  3516. (message "Dim or hide blocked tasks..."))
  3517. (dolist (o (overlays-in (point-min) (point-max)))
  3518. (when (eq (overlay-get o 'org-type) 'org-blocked-todo)
  3519. (delete-overlay o)))
  3520. (save-excursion
  3521. (let ((inhibit-read-only t)
  3522. (org-depend-tag-blocked nil)
  3523. org-blocked-by-checkboxes)
  3524. (goto-char (point-min))
  3525. (while (let ((pos (text-property-not-all
  3526. (point) (point-max) 'todo-state nil)))
  3527. (when pos (goto-char pos)))
  3528. (setq org-blocked-by-checkboxes nil)
  3529. (let ((marker (org-get-at-bol 'org-hd-marker)))
  3530. (when (and (markerp marker)
  3531. (with-current-buffer (marker-buffer marker)
  3532. (save-excursion (goto-char marker)
  3533. (org-entry-blocked-p))))
  3534. ;; Entries blocked by checkboxes cannot be made invisible.
  3535. ;; See `org-agenda-dim-blocked-tasks' for details.
  3536. (let* ((really-invisible
  3537. (and (not org-blocked-by-checkboxes)
  3538. (or invisible (eq org-agenda-dim-blocked-tasks
  3539. 'invisible))))
  3540. (ov (make-overlay (if really-invisible (line-end-position 0)
  3541. (line-beginning-position))
  3542. (line-end-position))))
  3543. (if really-invisible (overlay-put ov 'invisible t)
  3544. (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
  3545. (overlay-put ov 'org-type 'org-blocked-todo))))
  3546. (forward-line))))
  3547. (when (called-interactively-p 'interactive)
  3548. (message "Dim or hide blocked tasks...done")))
  3549. (defvar org-agenda-skip-function nil
  3550. "Function to be called at each match during agenda construction.
  3551. If this function returns nil, the current match should not be skipped.
  3552. Otherwise, the function must return a position from where the search
  3553. should be continued.
  3554. This may also be a Lisp form, it will be evaluated.
  3555. Never set this variable using `setq' or so, because then it will apply
  3556. to all future agenda commands. If you do want a global skipping condition,
  3557. use the option `org-agenda-skip-function-global' instead.
  3558. The correct usage for `org-agenda-skip-function' is to bind it with
  3559. `let' to scope it dynamically into the agenda-constructing command.
  3560. A good way to set it is through options in `org-agenda-custom-commands'.")
  3561. (defun org-agenda-skip ()
  3562. "Throw to `:skip' in places that should be skipped.
  3563. Also moves point to the end of the skipped region, so that search can
  3564. continue from there."
  3565. (let ((p (point-at-bol)) to)
  3566. (when (or
  3567. (save-excursion (goto-char p) (looking-at comment-start-skip))
  3568. (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
  3569. (get-text-property p :org-archived)
  3570. (org-end-of-subtree t))
  3571. (and org-agenda-skip-comment-trees
  3572. (get-text-property p :org-comment)
  3573. (org-end-of-subtree t))
  3574. (and (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
  3575. (org-agenda-skip-eval org-agenda-skip-function)))
  3576. (goto-char to))
  3577. (org-in-src-block-p t))
  3578. (throw :skip t))))
  3579. (defun org-agenda-skip-eval (form)
  3580. "If FORM is a function or a list, call (or eval) it and return the result.
  3581. `save-excursion' and `save-match-data' are wrapped around the call, so point
  3582. and match data are returned to the previous state no matter what these
  3583. functions do."
  3584. (let (fp)
  3585. (and form
  3586. (or (setq fp (functionp form))
  3587. (consp form))
  3588. (save-excursion
  3589. (save-match-data
  3590. (if fp
  3591. (funcall form)
  3592. (eval form)))))))
  3593. (defvar org-agenda-markers nil
  3594. "List of all currently active markers created by `org-agenda'.")
  3595. (defvar org-agenda-last-marker-time (float-time)
  3596. "Creation time of the last agenda marker.")
  3597. (defun org-agenda-new-marker (&optional pos)
  3598. "Return a new agenda marker.
  3599. Maker is at point, or at POS if non-nil. Org mode keeps a list of
  3600. these markers and resets them when they are no longer in use."
  3601. (let ((m (copy-marker (or pos (point)) t)))
  3602. (setq org-agenda-last-marker-time (float-time))
  3603. (if org-agenda-buffer
  3604. (with-current-buffer org-agenda-buffer
  3605. (push m org-agenda-markers))
  3606. (push m org-agenda-markers))
  3607. m))
  3608. (defun org-agenda-reset-markers ()
  3609. "Reset markers created by `org-agenda'."
  3610. (while org-agenda-markers
  3611. (move-marker (pop org-agenda-markers) nil)))
  3612. (defun org-agenda-save-markers-for-cut-and-paste (beg end)
  3613. "Save relative positions of markers in region.
  3614. This check for agenda markers in all agenda buffers currently active."
  3615. (dolist (buf (buffer-list))
  3616. (with-current-buffer buf
  3617. (when (eq major-mode 'org-agenda-mode)
  3618. (mapc (lambda (m) (org-check-and-save-marker m beg end))
  3619. org-agenda-markers)))))
  3620. ;;; Entry text mode
  3621. (defun org-agenda-entry-text-show-here ()
  3622. "Add some text from the entry as context to the current line."
  3623. (let (m txt o)
  3624. (setq m (org-get-at-bol 'org-hd-marker))
  3625. (unless (marker-buffer m)
  3626. (error "No marker points to an entry here"))
  3627. (setq txt (concat "\n" (org-no-properties
  3628. (org-agenda-get-some-entry-text
  3629. m org-agenda-entry-text-maxlines
  3630. org-agenda-entry-text-leaders))))
  3631. (when (string-match "\\S-" txt)
  3632. (setq o (make-overlay (point-at-bol) (point-at-eol)))
  3633. (overlay-put o 'evaporate t)
  3634. (overlay-put o 'org-overlay-type 'agenda-entry-content)
  3635. (overlay-put o 'after-string txt))))
  3636. (defun org-agenda-entry-text-show ()
  3637. "Add entry context for all agenda lines."
  3638. (interactive)
  3639. (save-excursion
  3640. (goto-char (point-max))
  3641. (beginning-of-line 1)
  3642. (while (not (bobp))
  3643. (when (org-get-at-bol 'org-hd-marker)
  3644. (org-agenda-entry-text-show-here))
  3645. (beginning-of-line 0))))
  3646. (defun org-agenda-entry-text-hide ()
  3647. "Remove any shown entry context."
  3648. (delq nil
  3649. (mapcar (lambda (o)
  3650. (if (eq (overlay-get o 'org-overlay-type)
  3651. 'agenda-entry-content)
  3652. (progn (delete-overlay o) t)))
  3653. (overlays-in (point-min) (point-max)))))
  3654. (defun org-agenda-get-day-face (date)
  3655. "Return the face DATE should be displayed with."
  3656. (cond ((and (functionp org-agenda-day-face-function)
  3657. (funcall org-agenda-day-face-function date)))
  3658. ((org-agenda-today-p date) 'org-agenda-date-today)
  3659. ((memq (calendar-day-of-week date) org-agenda-weekend-days)
  3660. 'org-agenda-date-weekend)
  3661. (t 'org-agenda-date)))
  3662. ;;; Agenda timeline
  3663. (defvar org-agenda-only-exact-dates nil) ; dynamically scoped
  3664. (defvar org-agenda-show-log-scoped) ;; dynamically scope in `org-timeline' or `org-agenda-list'
  3665. (defun org-timeline (&optional dotodo)
  3666. "Show a time-sorted view of the entries in the current org file.
  3667. Only entries with a time stamp of today or later will be listed. With
  3668. \\[universal-argument] prefix, all unfinished TODO items will also be shown,
  3669. under the current date.
  3670. If the buffer contains an active region, only check the region for
  3671. dates."
  3672. (interactive "P")
  3673. (let* ((dopast t)
  3674. (org-agenda-show-log-scoped org-agenda-show-log)
  3675. (org-agenda-show-log org-agenda-show-log-scoped)
  3676. (entry (buffer-file-name (or (buffer-base-buffer (current-buffer))
  3677. (current-buffer))))
  3678. (date (calendar-current-date))
  3679. (beg (if (org-region-active-p) (region-beginning) (point-min)))
  3680. (end (if (org-region-active-p) (region-end) (point-max)))
  3681. (day-numbers (org-get-all-dates
  3682. beg end 'no-ranges
  3683. t org-agenda-show-log-scoped ; always include today
  3684. org-timeline-show-empty-dates))
  3685. (org-deadline-warning-days 0)
  3686. (org-agenda-only-exact-dates t)
  3687. (today (org-today))
  3688. (past t)
  3689. args
  3690. s e rtn d emptyp)
  3691. (setq org-agenda-redo-command
  3692. (list 'let
  3693. (list (list 'org-agenda-show-log 'org-agenda-show-log))
  3694. (list 'org-switch-to-buffer-other-window (current-buffer))
  3695. (list 'org-timeline (list 'quote dotodo))))
  3696. (put 'org-agenda-redo-command 'org-lprops nil)
  3697. (if (not dopast)
  3698. ;; Remove past dates from the list of dates.
  3699. (setq day-numbers (delq nil (mapcar (lambda(x)
  3700. (if (>= x today) x nil))
  3701. day-numbers))))
  3702. (org-agenda-prepare (concat "Timeline " (file-name-nondirectory entry)))
  3703. (org-compile-prefix-format 'timeline)
  3704. (org-set-sorting-strategy 'timeline)
  3705. (if org-agenda-show-log-scoped (push :closed args))
  3706. (push :timestamp args)
  3707. (push :deadline args)
  3708. (push :scheduled args)
  3709. (push :sexp args)
  3710. (if dotodo (push :todo args))
  3711. (insert "Timeline of file " entry "\n")
  3712. (add-text-properties (point-min) (point)
  3713. (list 'face 'org-agenda-structure))
  3714. (org-agenda-mark-header-line (point-min))
  3715. (while (setq d (pop day-numbers))
  3716. (if (and (listp d) (eq (car d) :omitted))
  3717. (progn
  3718. (setq s (point))
  3719. (insert (format "\n[... %d empty days omitted]\n\n" (cdr d)))
  3720. (put-text-property s (1- (point)) 'face 'org-agenda-structure))
  3721. (if (listp d) (setq d (car d) emptyp t) (setq emptyp nil))
  3722. (if (and (>= d today)
  3723. dopast
  3724. past)
  3725. (progn
  3726. (setq past nil)
  3727. (insert (make-string 79 ?-) "\n")))
  3728. (setq date (calendar-gregorian-from-absolute d))
  3729. (setq s (point))
  3730. (setq rtn (and (not emptyp)
  3731. (apply 'org-agenda-get-day-entries entry
  3732. date args)))
  3733. (if (or rtn (equal d today) org-timeline-show-empty-dates)
  3734. (progn
  3735. (insert
  3736. (if (stringp org-agenda-format-date)
  3737. (format-time-string org-agenda-format-date
  3738. (org-time-from-absolute date))
  3739. (funcall org-agenda-format-date date))
  3740. "\n")
  3741. (put-text-property s (1- (point)) 'face
  3742. (org-agenda-get-day-face date))
  3743. (put-text-property s (1- (point)) 'org-date-line t)
  3744. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3745. (if (equal d today)
  3746. (put-text-property s (1- (point)) 'org-today t))
  3747. (and rtn (insert (org-agenda-finalize-entries rtn 'timeline) "\n"))
  3748. (put-text-property s (1- (point)) 'day d)))))
  3749. (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
  3750. (point-min)))
  3751. (add-text-properties
  3752. (point-min) (point-max)
  3753. `(org-agenda-type timeline org-redo-cmd ,org-agenda-redo-command))
  3754. (org-agenda-finalize)
  3755. (setq buffer-read-only t)))
  3756. (defun org-get-all-dates (beg end &optional no-ranges force-today inactive empty pre-re)
  3757. "Return a list of all relevant day numbers from BEG to END buffer positions.
  3758. If NO-RANGES is non-nil, include only the start and end dates of a range,
  3759. not every single day in the range. If FORCE-TODAY is non-nil, make
  3760. sure that TODAY is included in the list. If INACTIVE is non-nil, also
  3761. inactive time stamps (those in square brackets) are included.
  3762. When EMPTY is non-nil, also include days without any entries."
  3763. (let ((re (concat
  3764. (if pre-re pre-re "")
  3765. (if inactive org-ts-regexp-both org-ts-regexp)))
  3766. dates dates1 date day day1 day2 ts1 ts2 pos)
  3767. (if force-today
  3768. (setq dates (list (org-today))))
  3769. (save-excursion
  3770. (goto-char beg)
  3771. (while (re-search-forward re end t)
  3772. (setq day (time-to-days (org-time-string-to-time
  3773. (substring (match-string 1) 0 10)
  3774. (current-buffer) (match-beginning 0))))
  3775. (or (memq day dates) (push day dates)))
  3776. (unless no-ranges
  3777. (goto-char beg)
  3778. (while (re-search-forward org-tr-regexp end t)
  3779. (setq pos (match-beginning 0))
  3780. (setq ts1 (substring (match-string 1) 0 10)
  3781. ts2 (substring (match-string 2) 0 10)
  3782. day1 (time-to-days (org-time-string-to-time
  3783. ts1 (current-buffer) pos))
  3784. day2 (time-to-days (org-time-string-to-time
  3785. ts2 (current-buffer) pos)))
  3786. (while (< (setq day1 (1+ day1)) day2)
  3787. (or (memq day1 dates) (push day1 dates)))))
  3788. (setq dates (sort dates '<))
  3789. (when empty
  3790. (while (setq day (pop dates))
  3791. (setq day2 (car dates))
  3792. (push day dates1)
  3793. (when (and day2 empty)
  3794. (if (or (eq empty t)
  3795. (and (numberp empty) (<= (- day2 day) empty)))
  3796. (while (< (setq day (1+ day)) day2)
  3797. (push (list day) dates1))
  3798. (push (cons :omitted (- day2 day)) dates1))))
  3799. (setq dates (nreverse dates1)))
  3800. dates)))
  3801. ;;; Agenda Daily/Weekly
  3802. (defvar org-agenda-start-day nil ; dynamically scoped parameter
  3803. "Start day for the agenda view.
  3804. Custom commands can set this variable in the options section.
  3805. This is usually a string like \"2007-11-01\", \"+2d\" or any other
  3806. input allowed when reading a date through the Org calendar.
  3807. See the docstring of `org-read-date' for details.")
  3808. (defvar org-starting-day nil) ; local variable in the agenda buffer
  3809. (defvar org-arg-loc nil) ; local variable
  3810. (defvar org-agenda-buffer-tmp-name nil)
  3811. ;;;###autoload
  3812. (defun org-agenda-list (&optional arg start-day span with-hour)
  3813. "Produce a daily/weekly view from all files in variable `org-agenda-files'.
  3814. The view will be for the current day or week, but from the overview buffer
  3815. you will be able to go to other days/weeks.
  3816. With a numeric prefix argument in an interactive call, the agenda will
  3817. span ARG days. Lisp programs should instead specify SPAN to change
  3818. the number of days. SPAN defaults to `org-agenda-span'.
  3819. START-DAY defaults to TODAY, or to the most recent match for the weekday
  3820. given in `org-agenda-start-on-weekday'.
  3821. When WITH-HOUR is non-nil, only include scheduled and deadline
  3822. items if they have an hour specification like [h]h:mm."
  3823. (interactive "P")
  3824. (if org-agenda-overriding-arguments
  3825. (setq arg (car org-agenda-overriding-arguments)
  3826. start-day (nth 1 org-agenda-overriding-arguments)
  3827. span (nth 2 org-agenda-overriding-arguments)))
  3828. (if (and (integerp arg) (> arg 0))
  3829. (setq span arg arg nil))
  3830. (catch 'exit
  3831. (setq org-agenda-buffer-name
  3832. (or org-agenda-buffer-tmp-name
  3833. (if org-agenda-sticky
  3834. (cond ((and org-keys (stringp org-match))
  3835. (format "*Org Agenda(%s:%s)*" org-keys org-match))
  3836. (org-keys
  3837. (format "*Org Agenda(%s)*" org-keys))
  3838. (t "*Org Agenda(a)*")))
  3839. org-agenda-buffer-name))
  3840. (org-agenda-prepare "Day/Week")
  3841. (setq start-day (or start-day org-agenda-start-day))
  3842. (if (stringp start-day)
  3843. ;; Convert to an absolute day number
  3844. (setq start-day (time-to-days (org-read-date nil t start-day))))
  3845. (org-compile-prefix-format 'agenda)
  3846. (org-set-sorting-strategy 'agenda)
  3847. (let* ((span (org-agenda-ndays-to-span (or span org-agenda-span)))
  3848. (today (org-today))
  3849. (sd (or start-day today))
  3850. (ndays (org-agenda-span-to-ndays span sd))
  3851. (org-agenda-start-on-weekday
  3852. (if (or (eq ndays 7) (eq ndays 14))
  3853. org-agenda-start-on-weekday))
  3854. (thefiles (org-agenda-files nil 'ifmode))
  3855. (files thefiles)
  3856. (start (if (or (null org-agenda-start-on-weekday)
  3857. (< ndays 7))
  3858. sd
  3859. (let* ((nt (calendar-day-of-week
  3860. (calendar-gregorian-from-absolute sd)))
  3861. (n1 org-agenda-start-on-weekday)
  3862. (d (- nt n1)))
  3863. (- sd (+ (if (< d 0) 7 0) d)))))
  3864. (day-numbers (list start))
  3865. (day-cnt 0)
  3866. (inhibit-redisplay (not debug-on-error))
  3867. (org-agenda-show-log-scoped org-agenda-show-log)
  3868. s e rtn rtnall file date d start-pos end-pos todayp
  3869. clocktable-start clocktable-end filter)
  3870. (setq org-agenda-redo-command
  3871. (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span) with-hour))
  3872. (dotimes (n (1- ndays))
  3873. (push (1+ (car day-numbers)) day-numbers))
  3874. (setq day-numbers (nreverse day-numbers))
  3875. (setq clocktable-start (car day-numbers)
  3876. clocktable-end (1+ (or (org-last day-numbers) 0)))
  3877. (setq-local org-starting-day (car day-numbers))
  3878. (setq-local org-arg-loc arg)
  3879. (setq-local org-agenda-current-span (org-agenda-ndays-to-span span))
  3880. (unless org-agenda-compact-blocks
  3881. (let* ((d1 (car day-numbers))
  3882. (d2 (org-last day-numbers))
  3883. (w1 (org-days-to-iso-week d1))
  3884. (w2 (org-days-to-iso-week d2)))
  3885. (setq s (point))
  3886. (if org-agenda-overriding-header
  3887. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  3888. nil 'face 'org-agenda-structure) "\n")
  3889. (insert (org-agenda-span-name span)
  3890. "-agenda"
  3891. (if (< (- d2 d1) 350)
  3892. (if (= w1 w2)
  3893. (format " (W%02d)" w1)
  3894. (format " (W%02d-W%02d)" w1 w2))
  3895. "")
  3896. ":\n")))
  3897. (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
  3898. 'org-date-line t))
  3899. (org-agenda-mark-header-line s))
  3900. (while (setq d (pop day-numbers))
  3901. (setq date (calendar-gregorian-from-absolute d)
  3902. s (point))
  3903. (if (or (setq todayp (= d today))
  3904. (and (not start-pos) (= d sd)))
  3905. (setq start-pos (point))
  3906. (if (and start-pos (not end-pos))
  3907. (setq end-pos (point))))
  3908. (setq files thefiles
  3909. rtnall nil)
  3910. (while (setq file (pop files))
  3911. (catch 'nextfile
  3912. (org-check-agenda-file file)
  3913. (let ((org-agenda-entry-types org-agenda-entry-types))
  3914. ;; Starred types override non-starred equivalents
  3915. (when (member :deadline* org-agenda-entry-types)
  3916. (setq org-agenda-entry-types
  3917. (delq :deadline org-agenda-entry-types)))
  3918. (when (member :scheduled* org-agenda-entry-types)
  3919. (setq org-agenda-entry-types
  3920. (delq :scheduled org-agenda-entry-types)))
  3921. ;; Honor with-hour
  3922. (when with-hour
  3923. (when (member :deadline org-agenda-entry-types)
  3924. (setq org-agenda-entry-types
  3925. (delq :deadline org-agenda-entry-types))
  3926. (push :deadline* org-agenda-entry-types))
  3927. (when (member :scheduled org-agenda-entry-types)
  3928. (setq org-agenda-entry-types
  3929. (delq :scheduled org-agenda-entry-types))
  3930. (push :scheduled* org-agenda-entry-types)))
  3931. (unless org-agenda-include-deadlines
  3932. (setq org-agenda-entry-types
  3933. (delq :deadline* (delq :deadline org-agenda-entry-types))))
  3934. (cond
  3935. ((memq org-agenda-show-log-scoped '(only clockcheck))
  3936. (setq rtn (org-agenda-get-day-entries
  3937. file date :closed)))
  3938. (org-agenda-show-log-scoped
  3939. (setq rtn (apply 'org-agenda-get-day-entries
  3940. file date
  3941. (append '(:closed) org-agenda-entry-types))))
  3942. (t
  3943. (setq rtn (apply 'org-agenda-get-day-entries
  3944. file date
  3945. org-agenda-entry-types)))))
  3946. (setq rtnall (append rtnall rtn)))) ;; all entries
  3947. (if org-agenda-include-diary
  3948. (let ((org-agenda-search-headline-for-time t))
  3949. (require 'diary-lib)
  3950. (setq rtn (org-get-entries-from-diary date))
  3951. (setq rtnall (append rtnall rtn))))
  3952. (if (or rtnall org-agenda-show-all-dates)
  3953. (progn
  3954. (setq day-cnt (1+ day-cnt))
  3955. (insert
  3956. (if (stringp org-agenda-format-date)
  3957. (format-time-string org-agenda-format-date
  3958. (org-time-from-absolute date))
  3959. (funcall org-agenda-format-date date))
  3960. "\n")
  3961. (put-text-property s (1- (point)) 'face
  3962. (org-agenda-get-day-face date))
  3963. (put-text-property s (1- (point)) 'org-date-line t)
  3964. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3965. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
  3966. (when todayp
  3967. (put-text-property s (1- (point)) 'org-today t))
  3968. (setq rtnall
  3969. (org-agenda-add-time-grid-maybe rtnall ndays todayp))
  3970. (if rtnall (insert ;; all entries
  3971. (org-agenda-finalize-entries rtnall 'agenda)
  3972. "\n"))
  3973. (put-text-property s (1- (point)) 'day d)
  3974. (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
  3975. (when (and org-agenda-clockreport-mode clocktable-start)
  3976. (let ((org-agenda-files (org-agenda-files nil 'ifmode))
  3977. ;; the above line is to ensure the restricted range!
  3978. (p (copy-sequence org-agenda-clockreport-parameter-plist))
  3979. tbl)
  3980. (setq p (org-plist-delete p :block))
  3981. (setq p (plist-put p :tstart clocktable-start))
  3982. (setq p (plist-put p :tend clocktable-end))
  3983. (setq p (plist-put p :scope 'agenda))
  3984. (setq tbl (apply 'org-clock-get-clocktable p))
  3985. (insert tbl)))
  3986. (goto-char (point-min))
  3987. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3988. (unless (and (pos-visible-in-window-p (point-min))
  3989. (pos-visible-in-window-p (point-max)))
  3990. (goto-char (1- (point-max)))
  3991. (recenter -1)
  3992. (if (not (pos-visible-in-window-p (or start-pos 1)))
  3993. (progn
  3994. (goto-char (or start-pos 1))
  3995. (recenter 1))))
  3996. (goto-char (or start-pos 1))
  3997. (add-text-properties (point-min) (point-max)
  3998. `(org-agenda-type agenda
  3999. org-last-args (,arg ,start-day ,span)
  4000. org-redo-cmd ,org-agenda-redo-command
  4001. org-series-cmd ,org-cmd))
  4002. (if (eq org-agenda-show-log-scoped 'clockcheck)
  4003. (org-agenda-show-clocking-issues))
  4004. (org-agenda-finalize)
  4005. (setq buffer-read-only t)
  4006. (message ""))))
  4007. (defun org-agenda-ndays-to-span (n)
  4008. "Return a span symbol for a span of N days, or N if none matches."
  4009. (cond ((symbolp n) n)
  4010. ((= n 1) 'day)
  4011. ((= n 7) 'week)
  4012. ((= n 14) 'fortnight)
  4013. (t n)))
  4014. (defun org-agenda-span-to-ndays (span &optional start-day)
  4015. "Return ndays from SPAN, possibly starting at START-DAY.
  4016. START-DAY is an absolute time value."
  4017. (cond ((numberp span) span)
  4018. ((eq span 'day) 1)
  4019. ((eq span 'week) 7)
  4020. ((eq span 'fortnight) 14)
  4021. ((eq span 'month)
  4022. (let ((date (calendar-gregorian-from-absolute start-day)))
  4023. (calendar-last-day-of-month (car date) (cl-caddr date))))
  4024. ((eq span 'year)
  4025. (let ((date (calendar-gregorian-from-absolute start-day)))
  4026. (if (calendar-leap-year-p (cl-caddr date)) 366 365)))))
  4027. (defun org-agenda-span-name (span)
  4028. "Return a SPAN name."
  4029. (if (null span)
  4030. ""
  4031. (if (symbolp span)
  4032. (capitalize (symbol-name span))
  4033. (format "%d days" span))))
  4034. ;;; Agenda word search
  4035. (defvar org-agenda-search-history nil)
  4036. (defvar org-search-syntax-table nil
  4037. "Special syntax table for Org search.
  4038. In this table, we have single quotes not as word constituents, to
  4039. that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
  4040. (defvar org-mode-syntax-table) ; From org.el
  4041. (defun org-search-syntax-table ()
  4042. (unless org-search-syntax-table
  4043. (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
  4044. (modify-syntax-entry ?' "." org-search-syntax-table)
  4045. (modify-syntax-entry ?` "." org-search-syntax-table))
  4046. org-search-syntax-table)
  4047. (defvar org-agenda-last-search-view-search-was-boolean nil)
  4048. ;;;###autoload
  4049. (defun org-search-view (&optional todo-only string edit-at)
  4050. "Show all entries that contain a phrase or words or regular expressions.
  4051. With optional prefix argument TODO-ONLY, only consider entries that are
  4052. TODO entries. The argument STRING can be used to pass a default search
  4053. string into this function. If EDIT-AT is non-nil, it means that the
  4054. user should get a chance to edit this string, with cursor at position
  4055. EDIT-AT.
  4056. The search string can be viewed either as a phrase that should be found as
  4057. is, or it can be broken into a number of snippets, each of which must match
  4058. in a Boolean way to select an entry. The default depends on the variable
  4059. `org-agenda-search-view-always-boolean'.
  4060. Even if this is turned off (the default) you can always switch to
  4061. Boolean search dynamically by preceding the first word with \"+\" or \"-\".
  4062. The default is a direct search of the whole phrase, where each space in
  4063. the search string can expand to an arbitrary amount of whitespace,
  4064. including newlines.
  4065. If using a Boolean search, the search string is split on whitespace and
  4066. each snippet is searched separately, with logical AND to select an entry.
  4067. Words prefixed with a minus must *not* occur in the entry. Words without
  4068. a prefix or prefixed with a plus must occur in the entry. Matching is
  4069. case-insensitive. Words are enclosed by word delimiters (i.e. they must
  4070. match whole words, not parts of a word) if
  4071. `org-agenda-search-view-force-full-words' is set (default is nil).
  4072. Boolean search snippets enclosed by curly braces are interpreted as
  4073. regular expressions that must or (when preceded with \"-\") must not
  4074. match in the entry. Snippets enclosed into double quotes will be taken
  4075. as a whole, to include whitespace.
  4076. - If the search string starts with an asterisk, search only in headlines.
  4077. - If (possibly after the leading star) the search string starts with an
  4078. exclamation mark, this also means to look at TODO entries only, an effect
  4079. that can also be achieved with a prefix argument.
  4080. - If (possibly after star and exclamation mark) the search string starts
  4081. with a colon, this will mean that the (non-regexp) snippets of the
  4082. Boolean search must match as full words.
  4083. This command searches the agenda files, and in addition the files listed
  4084. in `org-agenda-text-search-extra-files'."
  4085. (interactive "P")
  4086. (if org-agenda-overriding-arguments
  4087. (setq todo-only (car org-agenda-overriding-arguments)
  4088. string (nth 1 org-agenda-overriding-arguments)
  4089. edit-at (nth 2 org-agenda-overriding-arguments)))
  4090. (let* ((props (list 'face nil
  4091. 'done-face 'org-agenda-done
  4092. 'org-not-done-regexp org-not-done-regexp
  4093. 'org-todo-regexp org-todo-regexp
  4094. 'org-complex-heading-regexp org-complex-heading-regexp
  4095. 'mouse-face 'highlight
  4096. 'help-echo (format "mouse-2 or RET jump to location")))
  4097. (full-words org-agenda-search-view-force-full-words)
  4098. (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
  4099. regexp rtn rtnall files file pos inherited-tags
  4100. marker category level tags c neg re boolean
  4101. ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
  4102. (unless (and (not edit-at)
  4103. (stringp string)
  4104. (string-match "\\S-" string))
  4105. (setq string (read-string
  4106. (if org-agenda-search-view-always-boolean
  4107. "[+-]Word/{Regexp} ...: "
  4108. "Phrase or [+-]Word/{Regexp} ...: ")
  4109. (cond
  4110. ((integerp edit-at) (cons string edit-at))
  4111. (edit-at string))
  4112. 'org-agenda-search-history)))
  4113. (catch 'exit
  4114. (if org-agenda-sticky
  4115. (setq org-agenda-buffer-name
  4116. (if (stringp string)
  4117. (format "*Org Agenda(%s:%s)*"
  4118. (or org-keys (or (and todo-only "S") "s")) string)
  4119. (format "*Org Agenda(%s)*" (or (and todo-only "S") "s")))))
  4120. (org-agenda-prepare "SEARCH")
  4121. (org-compile-prefix-format 'search)
  4122. (org-set-sorting-strategy 'search)
  4123. (setq org-agenda-redo-command
  4124. (list 'org-search-view (if todo-only t nil)
  4125. (list 'if 'current-prefix-arg nil string)))
  4126. (setq org-agenda-query-string string)
  4127. (if (equal (string-to-char string) ?*)
  4128. (setq hdl-only t
  4129. words (substring string 1))
  4130. (setq words string))
  4131. (when (equal (string-to-char words) ?!)
  4132. (setq todo-only t
  4133. words (substring words 1)))
  4134. (when (equal (string-to-char words) ?:)
  4135. (setq full-words t
  4136. words (substring words 1)))
  4137. (if (or org-agenda-search-view-always-boolean
  4138. (member (string-to-char words) '(?- ?+ ?\{)))
  4139. (setq boolean t))
  4140. (setq words (org-split-string words))
  4141. (let (www w)
  4142. (while (setq w (pop words))
  4143. (while (and (string-match "\\\\\\'" w) words)
  4144. (setq w (concat (substring w 0 -1) " " (pop words))))
  4145. (push w www))
  4146. (setq words (nreverse www) www nil)
  4147. (while (setq w (pop words))
  4148. (when (and (string-match "\\`[-+]?{" w)
  4149. (not (string-match "}\\'" w)))
  4150. (while (and words (not (string-match "}\\'" (car words))))
  4151. (setq w (concat w " " (pop words))))
  4152. (setq w (concat w " " (pop words))))
  4153. (push w www))
  4154. (setq words (nreverse www)))
  4155. (setq org-agenda-last-search-view-search-was-boolean boolean)
  4156. (when boolean
  4157. (let (wds w)
  4158. (while (setq w (pop words))
  4159. (if (or (equal (substring w 0 1) "\"")
  4160. (and (> (length w) 1)
  4161. (member (substring w 0 1) '("+" "-"))
  4162. (equal (substring w 1 2) "\"")))
  4163. (while (and words (not (equal (substring w -1) "\"")))
  4164. (setq w (concat w " " (pop words)))))
  4165. (and (string-match "\\`\\([-+]?\\)\"" w)
  4166. (setq w (replace-match "\\1" nil nil w)))
  4167. (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
  4168. (push w wds))
  4169. (setq words (nreverse wds))))
  4170. (if boolean
  4171. (mapc (lambda (w)
  4172. (setq c (string-to-char w))
  4173. (if (equal c ?-)
  4174. (setq neg t w (substring w 1))
  4175. (if (equal c ?+)
  4176. (setq neg nil w (substring w 1))
  4177. (setq neg nil)))
  4178. (if (string-match "\\`{.*}\\'" w)
  4179. (setq re (substring w 1 -1))
  4180. (if full-words
  4181. (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
  4182. (setq re (regexp-quote (downcase w)))))
  4183. (if neg (push re regexps-) (push re regexps+)))
  4184. words)
  4185. (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
  4186. regexps+))
  4187. (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
  4188. (if (not regexps+)
  4189. (setq regexp org-outline-regexp-bol)
  4190. (setq regexp (pop regexps+))
  4191. (if hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
  4192. regexp))))
  4193. (setq files (org-agenda-files nil 'ifmode))
  4194. (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
  4195. (pop org-agenda-text-search-extra-files)
  4196. (setq files (org-add-archive-files files)))
  4197. (setq files (append files org-agenda-text-search-extra-files)
  4198. rtnall nil)
  4199. (while (setq file (pop files))
  4200. (setq ee nil)
  4201. (catch 'nextfile
  4202. (org-check-agenda-file file)
  4203. (setq buffer (if (file-exists-p file)
  4204. (org-get-agenda-file-buffer file)
  4205. (error "No such file %s" file)))
  4206. (if (not buffer)
  4207. ;; If file does not exist, make sure an error message is sent
  4208. (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
  4209. file))))
  4210. (with-current-buffer buffer
  4211. (with-syntax-table (org-search-syntax-table)
  4212. (unless (derived-mode-p 'org-mode)
  4213. (error "Agenda file %s is not in `org-mode'" file))
  4214. (let ((case-fold-search t))
  4215. (save-excursion
  4216. (save-restriction
  4217. (if (eq buffer org-agenda-restrict)
  4218. (narrow-to-region org-agenda-restrict-begin
  4219. org-agenda-restrict-end)
  4220. (widen))
  4221. (goto-char (point-min))
  4222. (unless (or (org-at-heading-p)
  4223. (outline-next-heading))
  4224. (throw 'nextfile t))
  4225. (goto-char (max (point-min) (1- (point))))
  4226. (while (re-search-forward regexp nil t)
  4227. (org-back-to-heading t)
  4228. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4229. (> (org-reduced-level (org-outline-level))
  4230. org-agenda-search-view-max-outline-level)
  4231. (forward-line -1)
  4232. (org-back-to-heading t)))
  4233. (skip-chars-forward "* ")
  4234. (setq beg (point-at-bol)
  4235. beg1 (point)
  4236. end (progn
  4237. (outline-next-heading)
  4238. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4239. (> (org-reduced-level (org-outline-level))
  4240. org-agenda-search-view-max-outline-level)
  4241. (forward-line 1)
  4242. (outline-next-heading)))
  4243. (point)))
  4244. (catch :skip
  4245. (goto-char beg)
  4246. (org-agenda-skip)
  4247. (setq str (buffer-substring-no-properties
  4248. (point-at-bol)
  4249. (if hdl-only (point-at-eol) end)))
  4250. (mapc (lambda (wr) (when (string-match wr str)
  4251. (goto-char (1- end))
  4252. (throw :skip t)))
  4253. regexps-)
  4254. (mapc (lambda (wr) (unless (string-match wr str)
  4255. (goto-char (1- end))
  4256. (throw :skip t)))
  4257. (if todo-only
  4258. (cons (concat "^\\*+[ \t]+"
  4259. org-not-done-regexp)
  4260. regexps+)
  4261. regexps+))
  4262. (goto-char beg)
  4263. (setq marker (org-agenda-new-marker (point))
  4264. category (org-get-category)
  4265. level (make-string (org-reduced-level (org-outline-level)) ? )
  4266. inherited-tags
  4267. (or (eq org-agenda-show-inherited-tags 'always)
  4268. (and (listp org-agenda-show-inherited-tags)
  4269. (memq 'todo org-agenda-show-inherited-tags))
  4270. (and (eq org-agenda-show-inherited-tags t)
  4271. (or (eq org-agenda-use-tag-inheritance t)
  4272. (memq 'todo org-agenda-use-tag-inheritance))))
  4273. tags (org-get-tags-at nil (not inherited-tags))
  4274. txt (org-agenda-format-item
  4275. ""
  4276. (buffer-substring-no-properties
  4277. beg1 (point-at-eol))
  4278. level category tags t))
  4279. (org-add-props txt props
  4280. 'org-marker marker 'org-hd-marker marker
  4281. 'org-todo-regexp org-todo-regexp
  4282. 'level level
  4283. 'org-complex-heading-regexp org-complex-heading-regexp
  4284. 'priority 1000
  4285. 'type "search")
  4286. (push txt ee)
  4287. (goto-char (1- end))))))))))
  4288. (setq rtn (nreverse ee))
  4289. (setq rtnall (append rtnall rtn)))
  4290. (if org-agenda-overriding-header
  4291. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4292. nil 'face 'org-agenda-structure) "\n")
  4293. (insert "Search words: ")
  4294. (add-text-properties (point-min) (1- (point))
  4295. (list 'face 'org-agenda-structure))
  4296. (setq pos (point))
  4297. (insert string "\n")
  4298. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4299. (setq pos (point))
  4300. (unless org-agenda-multi
  4301. (insert (substitute-command-keys "\
  4302. Press `\\[org-agenda-manipulate-query-add]', \
  4303. `\\[org-agenda-manipulate-query-subtract]' to add/sub word, \
  4304. `\\[org-agenda-manipulate-query-add-re]', \
  4305. `\\[org-agenda-manipulate-query-subtract-re]' to add/sub regexp, \
  4306. `\\[universal-argument] \\[org-agenda-redo]' to edit\n"))
  4307. (add-text-properties pos (1- (point))
  4308. (list 'face 'org-agenda-structure))))
  4309. (org-agenda-mark-header-line (point-min))
  4310. (when rtnall
  4311. (insert (org-agenda-finalize-entries rtnall 'search) "\n"))
  4312. (goto-char (point-min))
  4313. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4314. (add-text-properties (point-min) (point-max)
  4315. `(org-agenda-type search
  4316. org-last-args (,todo-only ,string ,edit-at)
  4317. org-redo-cmd ,org-agenda-redo-command
  4318. org-series-cmd ,org-cmd))
  4319. (org-agenda-finalize)
  4320. (setq buffer-read-only t))))
  4321. ;;; Agenda TODO list
  4322. (defun org-agenda-propertize-selected-todo-keywords (keywords)
  4323. "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
  4324. (concat
  4325. (if (or (equal keywords "ALL") (not keywords))
  4326. (propertize "ALL" 'face 'warning)
  4327. (mapconcat
  4328. (lambda (kw)
  4329. (propertize kw 'face (org-get-todo-face kw)))
  4330. (org-split-string keywords "|")
  4331. "|"))
  4332. "\n"))
  4333. (defvar org-select-this-todo-keyword nil)
  4334. (defvar org-last-arg nil)
  4335. ;;;###autoload
  4336. (defun org-todo-list (&optional arg)
  4337. "Show all (not done) TODO entries from all agenda file in a single list.
  4338. The prefix arg can be used to select a specific TODO keyword and limit
  4339. the list to these. When using \\[universal-argument], you will be prompted
  4340. for a keyword. A numeric prefix directly selects the Nth keyword in
  4341. `org-todo-keywords-1'."
  4342. (interactive "P")
  4343. (if org-agenda-overriding-arguments
  4344. (setq arg org-agenda-overriding-arguments))
  4345. (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
  4346. (let* ((today (org-today))
  4347. (date (calendar-gregorian-from-absolute today))
  4348. (kwds org-todo-keywords-for-agenda)
  4349. (completion-ignore-case t)
  4350. (org-select-this-todo-keyword
  4351. (if (stringp arg) arg
  4352. (and arg (integerp arg) (> arg 0)
  4353. (nth (1- arg) kwds))))
  4354. rtn rtnall files file pos)
  4355. (when (equal arg '(4))
  4356. (setq org-select-this-todo-keyword
  4357. (completing-read "Keyword (or KWD1|K2D2|...): "
  4358. (mapcar #'list kwds) nil nil)))
  4359. (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
  4360. (catch 'exit
  4361. (if org-agenda-sticky
  4362. (setq org-agenda-buffer-name
  4363. (if (stringp org-select-this-todo-keyword)
  4364. (format "*Org Agenda(%s:%s)*" (or org-keys "t")
  4365. org-select-this-todo-keyword)
  4366. (format "*Org Agenda(%s)*" (or org-keys "t")))))
  4367. (org-agenda-prepare "TODO")
  4368. (org-compile-prefix-format 'todo)
  4369. (org-set-sorting-strategy 'todo)
  4370. (setq org-agenda-redo-command
  4371. `(org-todo-list (or (and (numberp current-prefix-arg)
  4372. current-prefix-arg)
  4373. ,org-select-this-todo-keyword
  4374. current-prefix-arg ,arg)))
  4375. (setq files (org-agenda-files nil 'ifmode)
  4376. rtnall nil)
  4377. (while (setq file (pop files))
  4378. (catch 'nextfile
  4379. (org-check-agenda-file file)
  4380. (setq rtn (org-agenda-get-day-entries file date :todo))
  4381. (setq rtnall (append rtnall rtn))))
  4382. (if org-agenda-overriding-header
  4383. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4384. nil 'face 'org-agenda-structure) "\n")
  4385. (insert "Global list of TODO items of type: ")
  4386. (add-text-properties (point-min) (1- (point))
  4387. (list 'face 'org-agenda-structure
  4388. 'short-heading
  4389. (concat "ToDo: "
  4390. (or org-select-this-todo-keyword "ALL"))))
  4391. (org-agenda-mark-header-line (point-min))
  4392. (insert (org-agenda-propertize-selected-todo-keywords
  4393. org-select-this-todo-keyword))
  4394. (setq pos (point))
  4395. (unless org-agenda-multi
  4396. (insert (substitute-command-keys "Available with \
  4397. `N \\[org-agenda-redo]': (0)[ALL]"))
  4398. (let ((n 0) s)
  4399. (mapc (lambda (x)
  4400. (setq s (format "(%d)%s" (setq n (1+ n)) x))
  4401. (if (> (+ (current-column) (string-width s) 1) (frame-width))
  4402. (insert "\n "))
  4403. (insert " " s))
  4404. kwds))
  4405. (insert "\n"))
  4406. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
  4407. (org-agenda-mark-header-line (point-min))
  4408. (when rtnall
  4409. (insert (org-agenda-finalize-entries rtnall 'todo) "\n"))
  4410. (goto-char (point-min))
  4411. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4412. (add-text-properties (point-min) (point-max)
  4413. `(org-agenda-type todo
  4414. org-last-args ,arg
  4415. org-redo-cmd ,org-agenda-redo-command
  4416. org-series-cmd ,org-cmd))
  4417. (org-agenda-finalize)
  4418. (setq buffer-read-only t))))
  4419. ;;; Agenda tags match
  4420. ;;;###autoload
  4421. (defun org-tags-view (&optional todo-only match)
  4422. "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
  4423. The prefix arg TODO-ONLY limits the search to TODO entries."
  4424. (interactive "P")
  4425. (if org-agenda-overriding-arguments
  4426. (setq todo-only (car org-agenda-overriding-arguments)
  4427. match (nth 1 org-agenda-overriding-arguments)))
  4428. (let* ((org-tags-match-list-sublevels
  4429. org-tags-match-list-sublevels)
  4430. (completion-ignore-case t)
  4431. rtn rtnall files file pos matcher
  4432. buffer)
  4433. (when (and (stringp match) (not (string-match "\\S-" match)))
  4434. (setq match nil))
  4435. (catch 'exit
  4436. (if org-agenda-sticky
  4437. (setq org-agenda-buffer-name
  4438. (if (stringp match)
  4439. (format "*Org Agenda(%s:%s)*"
  4440. (or org-keys (or (and todo-only "M") "m")) match)
  4441. (format "*Org Agenda(%s)*" (or (and todo-only "M") "m")))))
  4442. ;; Prepare agendas (and `org-tag-alist-for-agenda') before
  4443. ;; expanding tags within `org-make-tags-matcher'
  4444. (org-agenda-prepare (concat "TAGS " match))
  4445. (setq org--matcher-tags-todo-only todo-only
  4446. matcher (org-make-tags-matcher match)
  4447. match (car matcher)
  4448. matcher (cdr matcher))
  4449. (org-compile-prefix-format 'tags)
  4450. (org-set-sorting-strategy 'tags)
  4451. (setq org-agenda-query-string match)
  4452. (setq org-agenda-redo-command
  4453. (list 'org-tags-view
  4454. `(quote ,org--matcher-tags-todo-only)
  4455. `(if current-prefix-arg nil ,org-agenda-query-string)))
  4456. (setq files (org-agenda-files nil 'ifmode)
  4457. rtnall nil)
  4458. (while (setq file (pop files))
  4459. (catch 'nextfile
  4460. (org-check-agenda-file file)
  4461. (setq buffer (if (file-exists-p file)
  4462. (org-get-agenda-file-buffer file)
  4463. (error "No such file %s" file)))
  4464. (if (not buffer)
  4465. ;; If file does not exist, error message to agenda
  4466. (setq rtn (list
  4467. (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4468. rtnall (append rtnall rtn))
  4469. (with-current-buffer buffer
  4470. (unless (derived-mode-p 'org-mode)
  4471. (error "Agenda file %s is not in `org-mode'" file))
  4472. (save-excursion
  4473. (save-restriction
  4474. (if (eq buffer org-agenda-restrict)
  4475. (narrow-to-region org-agenda-restrict-begin
  4476. org-agenda-restrict-end)
  4477. (widen))
  4478. (setq rtn (org-scan-tags 'agenda
  4479. matcher
  4480. org--matcher-tags-todo-only))
  4481. (setq rtnall (append rtnall rtn))))))))
  4482. (if org-agenda-overriding-header
  4483. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4484. nil 'face 'org-agenda-structure) "\n")
  4485. (insert "Headlines with TAGS match: ")
  4486. (add-text-properties (point-min) (1- (point))
  4487. (list 'face 'org-agenda-structure
  4488. 'short-heading
  4489. (concat "Match: " match)))
  4490. (setq pos (point))
  4491. (insert match "\n")
  4492. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4493. (setq pos (point))
  4494. (unless org-agenda-multi
  4495. (insert (substitute-command-keys
  4496. "Press `\\[universal-argument] \\[org-agenda-redo]' \
  4497. to search again with new search string\n")))
  4498. (add-text-properties pos (1- (point))
  4499. (list 'face 'org-agenda-structure)))
  4500. (org-agenda-mark-header-line (point-min))
  4501. (when rtnall
  4502. (insert (org-agenda-finalize-entries rtnall 'tags) "\n"))
  4503. (goto-char (point-min))
  4504. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4505. (add-text-properties
  4506. (point-min) (point-max)
  4507. `(org-agenda-type tags
  4508. org-last-args (,org--matcher-tags-todo-only ,match)
  4509. org-redo-cmd ,org-agenda-redo-command
  4510. org-series-cmd ,org-cmd))
  4511. (org-agenda-finalize)
  4512. (setq buffer-read-only t))))
  4513. ;;; Agenda Finding stuck projects
  4514. (defvar org-agenda-skip-regexp nil
  4515. "Regular expression used in skipping subtrees for the agenda.
  4516. This is basically a temporary global variable that can be set and then
  4517. used by user-defined selections using `org-agenda-skip-function'.")
  4518. (defvar org-agenda-overriding-header nil
  4519. "When set during agenda, todo and tags searches it replaces the header.
  4520. This variable should not be set directly, but custom commands can bind it
  4521. in the options section.")
  4522. (defun org-agenda-skip-entry-when-regexp-matches ()
  4523. "Check if the current entry contains match for `org-agenda-skip-regexp'.
  4524. If yes, it returns the end position of this entry, causing agenda commands
  4525. to skip the entry but continuing the search in the subtree. This is a
  4526. function that can be put into `org-agenda-skip-function' for the duration
  4527. of a command."
  4528. (let ((end (save-excursion (org-end-of-subtree t)))
  4529. skip)
  4530. (save-excursion
  4531. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  4532. (and skip end)))
  4533. (defun org-agenda-skip-subtree-when-regexp-matches ()
  4534. "Check if the current subtree contains match for `org-agenda-skip-regexp'.
  4535. If yes, it returns the end position of this tree, causing agenda commands
  4536. to skip this subtree. This is a function that can be put into
  4537. `org-agenda-skip-function' for the duration of a command."
  4538. (let ((end (save-excursion (org-end-of-subtree t)))
  4539. skip)
  4540. (save-excursion
  4541. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  4542. (and skip end)))
  4543. (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
  4544. "Check if the current subtree contains match for `org-agenda-skip-regexp'.
  4545. If yes, it returns the end position of the current entry (NOT the tree),
  4546. causing agenda commands to skip the entry but continuing the search in
  4547. the subtree. This is a function that can be put into
  4548. `org-agenda-skip-function' for the duration of a command. An important
  4549. use of this function is for the stuck project list."
  4550. (let ((end (save-excursion (org-end-of-subtree t)))
  4551. (entry-end (save-excursion (outline-next-heading) (1- (point))))
  4552. skip)
  4553. (save-excursion
  4554. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  4555. (and skip entry-end)))
  4556. (defun org-agenda-skip-entry-if (&rest conditions)
  4557. "Skip entry if any of CONDITIONS is true.
  4558. See `org-agenda-skip-if' for details."
  4559. (org-agenda-skip-if nil conditions))
  4560. (defun org-agenda-skip-subtree-if (&rest conditions)
  4561. "Skip subtree if any of CONDITIONS is true.
  4562. See `org-agenda-skip-if' for details."
  4563. (org-agenda-skip-if t conditions))
  4564. (defun org-agenda-skip-if (subtree conditions)
  4565. "Checks current entity for CONDITIONS.
  4566. If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
  4567. the entry (i.e. the text before the next heading) is checked.
  4568. CONDITIONS is a list of symbols, boolean OR is used to combine the results
  4569. from different tests. Valid conditions are:
  4570. scheduled Check if there is a scheduled cookie
  4571. notscheduled Check if there is no scheduled cookie
  4572. deadline Check if there is a deadline
  4573. notdeadline Check if there is no deadline
  4574. timestamp Check if there is a timestamp (also deadline or scheduled)
  4575. nottimestamp Check if there is no timestamp (also deadline or scheduled)
  4576. regexp Check if regexp matches
  4577. notregexp Check if regexp does not match.
  4578. todo Check if TODO keyword matches
  4579. nottodo Check if TODO keyword does not match
  4580. The regexp is taken from the conditions list, it must come right after
  4581. the `regexp' or `notregexp' element.
  4582. `todo' and `nottodo' accept as an argument a list of todo
  4583. keywords, which may include \"*\" to match any todo keyword.
  4584. (org-agenda-skip-entry-if \\='todo \\='(\"TODO\" \"WAITING\"))
  4585. would skip all entries with \"TODO\" or \"WAITING\" keywords.
  4586. Instead of a list, a keyword class may be given. For example:
  4587. (org-agenda-skip-entry-if \\='nottodo \\='done)
  4588. would skip entries that haven't been marked with any of \"DONE\"
  4589. keywords. Possible classes are: `todo', `done', `any'.
  4590. If any of these conditions is met, this function returns the end point of
  4591. the entity, causing the search to continue from there. This is a function
  4592. that can be put into `org-agenda-skip-function' for the duration of a command."
  4593. (let (beg end m)
  4594. (org-back-to-heading t)
  4595. (setq beg (point)
  4596. end (if subtree
  4597. (progn (org-end-of-subtree t) (point))
  4598. (progn (outline-next-heading) (1- (point)))))
  4599. (goto-char beg)
  4600. (and
  4601. (or
  4602. (and (memq 'scheduled conditions)
  4603. (re-search-forward org-scheduled-time-regexp end t))
  4604. (and (memq 'notscheduled conditions)
  4605. (not (re-search-forward org-scheduled-time-regexp end t)))
  4606. (and (memq 'deadline conditions)
  4607. (re-search-forward org-deadline-time-regexp end t))
  4608. (and (memq 'notdeadline conditions)
  4609. (not (re-search-forward org-deadline-time-regexp end t)))
  4610. (and (memq 'timestamp conditions)
  4611. (re-search-forward org-ts-regexp end t))
  4612. (and (memq 'nottimestamp conditions)
  4613. (not (re-search-forward org-ts-regexp end t)))
  4614. (and (setq m (memq 'regexp conditions))
  4615. (stringp (nth 1 m))
  4616. (re-search-forward (nth 1 m) end t))
  4617. (and (setq m (memq 'notregexp conditions))
  4618. (stringp (nth 1 m))
  4619. (not (re-search-forward (nth 1 m) end t)))
  4620. (and (or
  4621. (setq m (memq 'nottodo conditions))
  4622. (setq m (memq 'todo-unblocked conditions))
  4623. (setq m (memq 'nottodo-unblocked conditions))
  4624. (setq m (memq 'todo conditions)))
  4625. (org-agenda-skip-if-todo m end)))
  4626. end)))
  4627. (defun org-agenda-skip-if-todo (args end)
  4628. "Helper function for `org-agenda-skip-if', do not use it directly.
  4629. ARGS is a list with first element either `todo', `nottodo',
  4630. `todo-unblocked' or `nottodo-unblocked'. The remainder is either
  4631. a list of TODO keywords, or a state symbol `todo' or `done' or
  4632. `any'."
  4633. (let ((kw (car args))
  4634. (arg (cadr args))
  4635. todo-wds todo-re)
  4636. (setq todo-wds
  4637. (org-uniquify
  4638. (cond
  4639. ((listp arg) ;; list of keywords
  4640. (if (member "*" arg)
  4641. (mapcar 'substring-no-properties org-todo-keywords-1)
  4642. arg))
  4643. ((symbolp arg) ;; keyword class name
  4644. (cond
  4645. ((eq arg 'todo)
  4646. (org-delete-all org-done-keywords
  4647. (mapcar 'substring-no-properties
  4648. org-todo-keywords-1)))
  4649. ((eq arg 'done) org-done-keywords)
  4650. ((eq arg 'any)
  4651. (mapcar 'substring-no-properties org-todo-keywords-1)))))))
  4652. (setq todo-re
  4653. (concat "^\\*+[ \t]+\\<\\("
  4654. (mapconcat 'identity todo-wds "\\|")
  4655. "\\)\\>"))
  4656. (cond
  4657. ((eq kw 'todo) (re-search-forward todo-re end t))
  4658. ((eq kw 'nottodo) (not (re-search-forward todo-re end t)))
  4659. ((eq kw 'todo-unblocked)
  4660. (catch 'unblocked
  4661. (while (re-search-forward todo-re end t)
  4662. (or (org-entry-blocked-p) (throw 'unblocked t)))
  4663. nil))
  4664. ((eq kw 'nottodo-unblocked)
  4665. (catch 'unblocked
  4666. (while (re-search-forward todo-re end t)
  4667. (or (org-entry-blocked-p) (throw 'unblocked nil)))
  4668. t))
  4669. )))
  4670. ;;;###autoload
  4671. (defun org-agenda-list-stuck-projects (&rest ignore)
  4672. "Create agenda view for projects that are stuck.
  4673. Stuck projects are project that have no next actions. For the definitions
  4674. of what a project is and how to check if it stuck, customize the variable
  4675. `org-stuck-projects'."
  4676. (interactive)
  4677. (let* ((org-agenda-skip-function
  4678. 'org-agenda-skip-entry-when-regexp-matches-in-subtree)
  4679. ;; We could have used org-agenda-skip-if here.
  4680. (org-agenda-overriding-header
  4681. (or org-agenda-overriding-header "List of stuck projects: "))
  4682. (matcher (nth 0 org-stuck-projects))
  4683. (todo (nth 1 org-stuck-projects))
  4684. (todo-wds (if (member "*" todo)
  4685. (progn
  4686. (org-agenda-prepare-buffers (org-agenda-files
  4687. nil 'ifmode))
  4688. (org-delete-all
  4689. org-done-keywords-for-agenda
  4690. (copy-sequence org-todo-keywords-for-agenda)))
  4691. todo))
  4692. (todo-re (concat "^\\*+[ \t]+\\("
  4693. (mapconcat 'identity todo-wds "\\|")
  4694. "\\)\\>"))
  4695. (tags (nth 2 org-stuck-projects))
  4696. (tags-re (if (member "*" tags)
  4697. (concat org-outline-regexp-bol
  4698. ".*:[[:alnum:]_@#%]+:[ \t]*$")
  4699. (if tags
  4700. (concat org-outline-regexp-bol
  4701. ".*:\\("
  4702. (mapconcat #'identity tags "\\|")
  4703. "\\):[[:alnum:]_@#%:]*[ \t]*$"))))
  4704. (gen-re (nth 3 org-stuck-projects))
  4705. (re-list
  4706. (delq nil
  4707. (list
  4708. (if todo todo-re)
  4709. (if tags tags-re)
  4710. (and gen-re (stringp gen-re) (string-match "\\S-" gen-re)
  4711. gen-re)))))
  4712. (setq org-agenda-skip-regexp
  4713. (if re-list
  4714. (mapconcat 'identity re-list "\\|")
  4715. (error "No information how to identify unstuck projects")))
  4716. (org-tags-view nil matcher)
  4717. (setq org-agenda-buffer-name (buffer-name))
  4718. (with-current-buffer org-agenda-buffer-name
  4719. (setq org-agenda-redo-command
  4720. `(org-agenda-list-stuck-projects ,current-prefix-arg)))))
  4721. ;;; Diary integration
  4722. (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
  4723. (defvar diary-list-entries-hook)
  4724. (defvar diary-time-regexp)
  4725. (defun org-get-entries-from-diary (date)
  4726. "Get the (Emacs Calendar) diary entries for DATE."
  4727. (require 'diary-lib)
  4728. (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
  4729. (diary-display-function 'diary-fancy-display)
  4730. (pop-up-frames nil)
  4731. (diary-list-entries-hook
  4732. (cons 'org-diary-default-entry diary-list-entries-hook))
  4733. (diary-file-name-prefix nil) ; turn this feature off
  4734. (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
  4735. entries
  4736. (org-disable-agenda-to-diary t))
  4737. (save-excursion
  4738. (save-window-excursion
  4739. (funcall (if (fboundp 'diary-list-entries)
  4740. 'diary-list-entries 'list-diary-entries)
  4741. date 1)))
  4742. (if (not (get-buffer diary-fancy-buffer))
  4743. (setq entries nil)
  4744. (with-current-buffer diary-fancy-buffer
  4745. (setq buffer-read-only nil)
  4746. (if (zerop (buffer-size))
  4747. ;; No entries
  4748. (setq entries nil)
  4749. ;; Omit the date and other unnecessary stuff
  4750. (org-agenda-cleanup-fancy-diary)
  4751. ;; Add prefix to each line and extend the text properties
  4752. (if (zerop (buffer-size))
  4753. (setq entries nil)
  4754. (setq entries (buffer-substring (point-min) (- (point-max) 1)))
  4755. (setq entries
  4756. (with-temp-buffer
  4757. (insert entries) (goto-char (point-min))
  4758. (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
  4759. (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
  4760. (replace-match (concat "; " (match-string 1)))))
  4761. (buffer-string)))))
  4762. (set-buffer-modified-p nil)
  4763. (kill-buffer diary-fancy-buffer)))
  4764. (when entries
  4765. (setq entries (org-split-string entries "\n"))
  4766. (setq entries
  4767. (mapcar
  4768. (lambda (x)
  4769. (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
  4770. ;; Extend the text properties to the beginning of the line
  4771. (org-add-props x (text-properties-at (1- (length x)) x)
  4772. 'type "diary" 'date date 'face 'org-agenda-diary))
  4773. entries)))))
  4774. (defvar org-agenda-cleanup-fancy-diary-hook nil
  4775. "Hook run when the fancy diary buffer is cleaned up.")
  4776. (defun org-agenda-cleanup-fancy-diary ()
  4777. "Remove unwanted stuff in buffer created by `fancy-diary-display'.
  4778. This gets rid of the date, the underline under the date, and
  4779. the dummy entry installed by `org-mode' to ensure non-empty diary for each
  4780. date. It also removes lines that contain only whitespace."
  4781. (goto-char (point-min))
  4782. (if (looking-at ".*?:[ \t]*")
  4783. (progn
  4784. (replace-match "")
  4785. (re-search-forward "\n=+$" nil t)
  4786. (replace-match "")
  4787. (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
  4788. (re-search-forward "\n=+$" nil t)
  4789. (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
  4790. (goto-char (point-min))
  4791. (while (re-search-forward "^ +\n" nil t)
  4792. (replace-match ""))
  4793. (goto-char (point-min))
  4794. (if (re-search-forward "^Org-mode dummy\n?" nil t)
  4795. (replace-match ""))
  4796. (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
  4797. ;; Make sure entries from the diary have the right text properties.
  4798. (eval-after-load "diary-lib"
  4799. '(if (boundp 'diary-modify-entry-list-string-function)
  4800. ;; We can rely on the hook, nothing to do
  4801. nil
  4802. ;; Hook not available, must use advice to make this work
  4803. (defadvice add-to-diary-list (before org-mark-diary-entry activate)
  4804. "Make the position visible."
  4805. (if (and org-disable-agenda-to-diary ;; called from org-agenda
  4806. (stringp string)
  4807. buffer-file-name)
  4808. (setq string (org-modify-diary-entry-string string))))))
  4809. (defun org-modify-diary-entry-string (string)
  4810. "Add text properties to string, allowing Org to act on it."
  4811. (org-add-props string nil
  4812. 'mouse-face 'highlight
  4813. 'help-echo (if buffer-file-name
  4814. (format "mouse-2 or RET jump to diary file %s"
  4815. (abbreviate-file-name buffer-file-name))
  4816. "")
  4817. 'org-agenda-diary-link t
  4818. 'org-marker (org-agenda-new-marker (point-at-bol))))
  4819. (defun org-diary-default-entry ()
  4820. "Add a dummy entry to the diary.
  4821. Needed to avoid empty dates which mess up holiday display."
  4822. ;; Catch the error if dealing with the new add-to-diary-alist
  4823. (when org-disable-agenda-to-diary
  4824. (condition-case nil
  4825. (org-add-to-diary-list original-date "Org-mode dummy" "")
  4826. (error
  4827. (org-add-to-diary-list original-date "Org-mode dummy" "" nil)))))
  4828. (defun org-add-to-diary-list (&rest args)
  4829. (if (fboundp 'diary-add-to-list)
  4830. (apply 'diary-add-to-list args)
  4831. (apply 'add-to-diary-list args)))
  4832. (defvar org-diary-last-run-time nil)
  4833. ;;;###autoload
  4834. (defun org-diary (&rest args)
  4835. "Return diary information from org files.
  4836. This function can be used in a \"sexp\" diary entry in the Emacs calendar.
  4837. It accesses org files and extracts information from those files to be
  4838. listed in the diary. The function accepts arguments specifying what
  4839. items should be listed. For a list of arguments allowed here, see the
  4840. variable `org-agenda-entry-types'.
  4841. The call in the diary file should look like this:
  4842. &%%(org-diary) ~/path/to/some/orgfile.org
  4843. Use a separate line for each org file to check. Or, if you omit the file name,
  4844. all files listed in `org-agenda-files' will be checked automatically:
  4845. &%%(org-diary)
  4846. If you don't give any arguments (as in the example above), the default value
  4847. of `org-agenda-entry-types' is used: (:deadline :scheduled :timestamp :sexp).
  4848. So the example above may also be written as
  4849. &%%(org-diary :deadline :timestamp :sexp :scheduled)
  4850. The function expects the lisp variables `entry' and `date' to be provided
  4851. by the caller, because this is how the calendar works. Don't use this
  4852. function from a program - use `org-agenda-get-day-entries' instead."
  4853. (when (> (- (float-time)
  4854. org-agenda-last-marker-time)
  4855. 5)
  4856. ;; I am not sure if this works with sticky agendas, because the marker
  4857. ;; list is then no longer a global variable.
  4858. (org-agenda-reset-markers))
  4859. (org-compile-prefix-format 'agenda)
  4860. (org-set-sorting-strategy 'agenda)
  4861. (setq args (or args org-agenda-entry-types))
  4862. (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
  4863. (list entry)
  4864. (org-agenda-files t)))
  4865. (time (float-time))
  4866. file rtn results)
  4867. (when (or (not org-diary-last-run-time)
  4868. (> (- time
  4869. org-diary-last-run-time)
  4870. 3))
  4871. (org-agenda-prepare-buffers files))
  4872. (setq org-diary-last-run-time time)
  4873. ;; If this is called during org-agenda, don't return any entries to
  4874. ;; the calendar. Org Agenda will list these entries itself.
  4875. (if org-disable-agenda-to-diary (setq files nil))
  4876. (while (setq file (pop files))
  4877. (setq rtn (apply 'org-agenda-get-day-entries file date args))
  4878. (setq results (append results rtn)))
  4879. (when results
  4880. (setq results
  4881. (mapcar (lambda (i) (replace-regexp-in-string
  4882. org-bracket-link-regexp "\\3" i)) results))
  4883. (concat (org-agenda-finalize-entries results) "\n"))))
  4884. ;;; Agenda entry finders
  4885. (defun org-agenda--timestamp-to-absolute (&rest args)
  4886. "Call `org-time-string-to-absolute' with ARGS.
  4887. However, throw `:skip' whenever an error is raised."
  4888. (condition-case e
  4889. (apply #'org-time-string-to-absolute args)
  4890. (org-diary-sexp-no-match (throw :skip nil))
  4891. (error
  4892. (message "%s; Skipping entry" (error-message-string e))
  4893. (throw :skip nil))))
  4894. (defun org-agenda-get-day-entries (file date &rest args)
  4895. "Does the work for `org-diary' and `org-agenda'.
  4896. FILE is the path to a file to be checked for entries. DATE is date like
  4897. the one returned by `calendar-current-date'. ARGS are symbols indicating
  4898. which kind of entries should be extracted. For details about these, see
  4899. the documentation of `org-diary'."
  4900. (let* ((org-startup-folded nil)
  4901. (org-startup-align-all-tables nil)
  4902. (buffer (if (file-exists-p file) (org-get-agenda-file-buffer file)
  4903. (error "No such file %s" file))))
  4904. (if (not buffer)
  4905. ;; If file does not exist, signal it in diary nonetheless.
  4906. (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4907. (with-current-buffer buffer
  4908. (unless (derived-mode-p 'org-mode)
  4909. (error "Agenda file %s is not in `org-mode'" file))
  4910. (setq org-agenda-buffer (or org-agenda-buffer buffer))
  4911. (setf org-agenda-current-date date)
  4912. (save-excursion
  4913. (save-restriction
  4914. (if (eq buffer org-agenda-restrict)
  4915. (narrow-to-region org-agenda-restrict-begin
  4916. org-agenda-restrict-end)
  4917. (widen))
  4918. ;; Rationalize ARGS. Also make sure `:deadline' comes
  4919. ;; first in order to populate DEADLINES before passing it.
  4920. ;;
  4921. ;; We use `delq' since `org-uniquify' duplicates ARGS,
  4922. ;; guarding us from modifying `org-agenda-entry-types'.
  4923. (setf args (org-uniquify (or args org-agenda-entry-types)))
  4924. (when (and (memq :scheduled args) (memq :scheduled* args))
  4925. (setf args (delq :scheduled* args)))
  4926. (cond
  4927. ((memq :deadline args)
  4928. (setf args (cons :deadline
  4929. (delq :deadline (delq :deadline* args)))))
  4930. ((memq :deadline* args)
  4931. (setf args (cons :deadline* (delq :deadline* args)))))
  4932. ;; Collect list of headlines. Return them flattened.
  4933. (let ((case-fold-search nil) results deadlines)
  4934. (dolist (arg args (apply #'nconc (nreverse results)))
  4935. (pcase arg
  4936. ((and :todo (guard (org-agenda-today-p date)))
  4937. (push (org-agenda-get-todos) results))
  4938. (:timestamp
  4939. (push (org-agenda-get-blocks) results)
  4940. (push (org-agenda-get-timestamps deadlines) results))
  4941. (:sexp
  4942. (push (org-agenda-get-sexps) results))
  4943. (:scheduled
  4944. (push (org-agenda-get-scheduled deadlines) results))
  4945. (:scheduled*
  4946. (push (org-agenda-get-scheduled deadlines t) results))
  4947. (:closed
  4948. (push (org-agenda-get-progress) results))
  4949. (:deadline
  4950. (setf deadlines (org-agenda-get-deadlines))
  4951. (push deadlines results))
  4952. (:deadline*
  4953. (setf deadlines (org-agenda-get-deadlines t))
  4954. (push deadlines results)))))))))))
  4955. (defsubst org-em (x y list)
  4956. "Is X or Y a member of LIST?"
  4957. (or (memq x list) (memq y list)))
  4958. (defvar org-heading-keyword-regexp-format) ; defined in org.el
  4959. (defvar org-agenda-sorting-strategy-selected nil)
  4960. (defun org-agenda-entry-get-agenda-timestamp (pom)
  4961. "Retrieve timestamp information for sorting agenda views.
  4962. Given a point or marker POM, returns a cons cell of the timestamp
  4963. and the timestamp type relevant for the sorting strategy in
  4964. `org-agenda-sorting-strategy-selected'."
  4965. (let (ts ts-date-type)
  4966. (save-match-data
  4967. (cond ((org-em 'scheduled-up 'scheduled-down
  4968. org-agenda-sorting-strategy-selected)
  4969. (setq ts (org-entry-get pom "SCHEDULED")
  4970. ts-date-type " scheduled"))
  4971. ((org-em 'deadline-up 'deadline-down
  4972. org-agenda-sorting-strategy-selected)
  4973. (setq ts (org-entry-get pom "DEADLINE")
  4974. ts-date-type " deadline"))
  4975. ((org-em 'ts-up 'ts-down
  4976. org-agenda-sorting-strategy-selected)
  4977. (setq ts (org-entry-get pom "TIMESTAMP")
  4978. ts-date-type " timestamp"))
  4979. ((org-em 'tsia-up 'tsia-down
  4980. org-agenda-sorting-strategy-selected)
  4981. (setq ts (org-entry-get pom "TIMESTAMP_IA")
  4982. ts-date-type " timestamp_ia"))
  4983. ((org-em 'timestamp-up 'timestamp-down
  4984. org-agenda-sorting-strategy-selected)
  4985. (setq ts (or (org-entry-get pom "SCHEDULED")
  4986. (org-entry-get pom "DEADLINE")
  4987. (org-entry-get pom "TIMESTAMP")
  4988. (org-entry-get pom "TIMESTAMP_IA"))
  4989. ts-date-type ""))
  4990. (t (setq ts-date-type "")))
  4991. (cons (when ts (ignore-errors (org-time-string-to-absolute ts)))
  4992. ts-date-type))))
  4993. (defun org-agenda-get-todos ()
  4994. "Return the TODO information for agenda display."
  4995. (let* ((props (list 'face nil
  4996. 'done-face 'org-agenda-done
  4997. 'org-not-done-regexp org-not-done-regexp
  4998. 'org-todo-regexp org-todo-regexp
  4999. 'org-complex-heading-regexp org-complex-heading-regexp
  5000. 'mouse-face 'highlight
  5001. 'help-echo
  5002. (format "mouse-2 or RET jump to org file %s"
  5003. (abbreviate-file-name buffer-file-name))))
  5004. (regexp (format org-heading-keyword-regexp-format
  5005. (cond
  5006. ((and org-select-this-todo-keyword
  5007. (equal org-select-this-todo-keyword "*"))
  5008. org-todo-regexp)
  5009. (org-select-this-todo-keyword
  5010. (concat "\\("
  5011. (mapconcat 'identity
  5012. (org-split-string
  5013. org-select-this-todo-keyword
  5014. "|")
  5015. "\\|") "\\)"))
  5016. (t org-not-done-regexp))))
  5017. marker priority category level tags todo-state
  5018. ts-date ts-date-type ts-date-pair
  5019. ee txt beg end inherited-tags todo-state-end-pos)
  5020. (goto-char (point-min))
  5021. (while (re-search-forward regexp nil t)
  5022. (catch :skip
  5023. (save-match-data
  5024. (beginning-of-line)
  5025. (org-agenda-skip)
  5026. (setq beg (point) end (save-excursion (outline-next-heading) (point)))
  5027. (unless (and (setq todo-state (org-get-todo-state))
  5028. (setq todo-state-end-pos (match-end 2)))
  5029. (goto-char end)
  5030. (throw :skip nil))
  5031. (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
  5032. (goto-char (1+ beg))
  5033. (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
  5034. (throw :skip nil)))
  5035. (goto-char (match-beginning 2))
  5036. (setq marker (org-agenda-new-marker (match-beginning 0))
  5037. category (org-get-category)
  5038. ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
  5039. ts-date (car ts-date-pair)
  5040. ts-date-type (cdr ts-date-pair)
  5041. txt (org-trim (buffer-substring (match-beginning 2) (match-end 0)))
  5042. inherited-tags
  5043. (or (eq org-agenda-show-inherited-tags 'always)
  5044. (and (listp org-agenda-show-inherited-tags)
  5045. (memq 'todo org-agenda-show-inherited-tags))
  5046. (and (eq org-agenda-show-inherited-tags t)
  5047. (or (eq org-agenda-use-tag-inheritance t)
  5048. (memq 'todo org-agenda-use-tag-inheritance))))
  5049. tags (org-get-tags-at nil (not inherited-tags))
  5050. level (make-string (org-reduced-level (org-outline-level)) ? )
  5051. txt (org-agenda-format-item "" txt level category tags t)
  5052. priority (1+ (org-get-priority txt)))
  5053. (org-add-props txt props
  5054. 'org-marker marker 'org-hd-marker marker
  5055. 'priority priority
  5056. 'level level
  5057. 'ts-date ts-date
  5058. 'type (concat "todo" ts-date-type) 'todo-state todo-state)
  5059. (push txt ee)
  5060. (if org-agenda-todo-list-sublevels
  5061. (goto-char todo-state-end-pos)
  5062. (org-end-of-subtree 'invisible))))
  5063. (nreverse ee)))
  5064. (defun org-agenda-todo-custom-ignore-p (time n)
  5065. "Check whether timestamp is farther away than n number of days.
  5066. This function is invoked if `org-agenda-todo-ignore-deadlines',
  5067. `org-agenda-todo-ignore-scheduled' or
  5068. `org-agenda-todo-ignore-timestamp' is set to an integer."
  5069. (let ((days (org-time-stamp-to-now
  5070. time org-agenda-todo-ignore-time-comparison-use-seconds)))
  5071. (if (>= n 0)
  5072. (>= days n)
  5073. (<= days n))))
  5074. ;;;###autoload
  5075. (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  5076. (&optional end)
  5077. "Do we have a reason to ignore this TODO entry because it has a time stamp?"
  5078. (when (or org-agenda-todo-ignore-with-date
  5079. org-agenda-todo-ignore-scheduled
  5080. org-agenda-todo-ignore-deadlines
  5081. org-agenda-todo-ignore-timestamp)
  5082. (setq end (or end (save-excursion (outline-next-heading) (point))))
  5083. (save-excursion
  5084. (or (and org-agenda-todo-ignore-with-date
  5085. (re-search-forward org-ts-regexp end t))
  5086. (and org-agenda-todo-ignore-scheduled
  5087. (re-search-forward org-scheduled-time-regexp end t)
  5088. (cond
  5089. ((eq org-agenda-todo-ignore-scheduled 'future)
  5090. (> (org-time-stamp-to-now
  5091. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5092. ((eq org-agenda-todo-ignore-scheduled 'past)
  5093. (<= (org-time-stamp-to-now
  5094. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5095. ((numberp org-agenda-todo-ignore-scheduled)
  5096. (org-agenda-todo-custom-ignore-p
  5097. (match-string 1) org-agenda-todo-ignore-scheduled))
  5098. (t)))
  5099. (and org-agenda-todo-ignore-deadlines
  5100. (re-search-forward org-deadline-time-regexp end t)
  5101. (cond
  5102. ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
  5103. ((eq org-agenda-todo-ignore-deadlines 'far)
  5104. (not (org-deadline-close-p (match-string 1))))
  5105. ((eq org-agenda-todo-ignore-deadlines 'future)
  5106. (> (org-time-stamp-to-now
  5107. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5108. ((eq org-agenda-todo-ignore-deadlines 'past)
  5109. (<= (org-time-stamp-to-now
  5110. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5111. ((numberp org-agenda-todo-ignore-deadlines)
  5112. (org-agenda-todo-custom-ignore-p
  5113. (match-string 1) org-agenda-todo-ignore-deadlines))
  5114. (t (org-deadline-close-p (match-string 1)))))
  5115. (and org-agenda-todo-ignore-timestamp
  5116. (let ((buffer (current-buffer))
  5117. (regexp
  5118. (concat
  5119. org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
  5120. (start (point)))
  5121. ;; Copy current buffer into a temporary one
  5122. (with-temp-buffer
  5123. (insert-buffer-substring buffer start end)
  5124. (goto-char (point-min))
  5125. ;; Delete SCHEDULED and DEADLINE items
  5126. (while (re-search-forward regexp end t)
  5127. (delete-region (match-beginning 0) (match-end 0)))
  5128. (goto-char (point-min))
  5129. ;; No search for timestamp left
  5130. (when (re-search-forward org-ts-regexp nil t)
  5131. (cond
  5132. ((eq org-agenda-todo-ignore-timestamp 'future)
  5133. (> (org-time-stamp-to-now
  5134. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5135. ((eq org-agenda-todo-ignore-timestamp 'past)
  5136. (<= (org-time-stamp-to-now
  5137. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5138. ((numberp org-agenda-todo-ignore-timestamp)
  5139. (org-agenda-todo-custom-ignore-p
  5140. (match-string 1) org-agenda-todo-ignore-timestamp))
  5141. (t))))))))))
  5142. (defun org-agenda-get-timestamps (&optional deadline-results)
  5143. "Return the date stamp information for agenda display."
  5144. (let* ((props (list 'face 'org-agenda-calendar-event
  5145. 'org-not-done-regexp org-not-done-regexp
  5146. 'org-todo-regexp org-todo-regexp
  5147. 'org-complex-heading-regexp org-complex-heading-regexp
  5148. 'mouse-face 'highlight
  5149. 'help-echo
  5150. (format "mouse-2 or RET jump to org file %s"
  5151. (abbreviate-file-name buffer-file-name))))
  5152. (d1 (calendar-absolute-from-gregorian date))
  5153. mm
  5154. (deadline-position-alist
  5155. (mapcar (lambda (a) (and (setq mm (get-text-property
  5156. 0 'org-hd-marker a))
  5157. (cons (marker-position mm) a)))
  5158. deadline-results))
  5159. (remove-re org-ts-regexp)
  5160. (regexp
  5161. (concat
  5162. (if org-agenda-include-inactive-timestamps "[[<]" "<")
  5163. (regexp-quote
  5164. (substring
  5165. (format-time-string
  5166. (car org-time-stamp-formats)
  5167. (apply 'encode-time ; DATE bound by calendar
  5168. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  5169. 1 11))
  5170. "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
  5171. "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
  5172. marker hdmarker deadlinep scheduledp clockp closedp inactivep
  5173. donep tmp priority category level ee txt timestr tags
  5174. b0 b3 e3 head todo-state end-of-match show-all warntime habitp
  5175. inherited-tags ts-date)
  5176. (goto-char (point-min))
  5177. (while (setq end-of-match (re-search-forward regexp nil t))
  5178. (setq b0 (match-beginning 0)
  5179. b3 (match-beginning 3) e3 (match-end 3)
  5180. todo-state (save-match-data (ignore-errors (org-get-todo-state)))
  5181. habitp (and (functionp 'org-is-habit-p) (save-match-data (org-is-habit-p)))
  5182. show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  5183. (member todo-state
  5184. org-agenda-repeating-timestamp-show-all)))
  5185. (catch :skip
  5186. (and (org-at-date-range-p) (throw :skip nil))
  5187. (org-agenda-skip)
  5188. (if (and (match-end 1)
  5189. (not (= d1 (org-agenda--timestamp-to-absolute
  5190. (match-string 1) d1 nil show-all
  5191. (current-buffer) b0))))
  5192. (throw :skip nil))
  5193. (if (and e3
  5194. (not (org-diary-sexp-entry (buffer-substring b3 e3) "" date)))
  5195. (throw :skip nil))
  5196. (setq tmp (buffer-substring (max (point-min)
  5197. (- b0 org-ds-keyword-length))
  5198. b0)
  5199. timestr (if b3 "" (buffer-substring b0 (point-at-eol)))
  5200. inactivep (= (char-after b0) ?\[)
  5201. deadlinep (string-match org-deadline-regexp tmp)
  5202. scheduledp (string-match org-scheduled-regexp tmp)
  5203. closedp (and org-agenda-include-inactive-timestamps
  5204. (string-match org-closed-string tmp))
  5205. clockp (and org-agenda-include-inactive-timestamps
  5206. (or (string-match org-clock-string tmp)
  5207. (string-match "]-+\\'" tmp)))
  5208. warntime (get-text-property (point) 'org-appt-warntime)
  5209. donep (member todo-state org-done-keywords))
  5210. (if (or scheduledp deadlinep closedp clockp
  5211. (and donep org-agenda-skip-timestamp-if-done))
  5212. (throw :skip t))
  5213. (if (string-match ">" timestr)
  5214. ;; substring should only run to end of time stamp
  5215. (setq timestr (substring timestr 0 (match-end 0))))
  5216. (setq marker (org-agenda-new-marker b0)
  5217. category (org-get-category b0))
  5218. (save-excursion
  5219. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5220. (throw :skip nil)
  5221. (goto-char (match-beginning 0))
  5222. (if (and (eq t org-agenda-skip-timestamp-if-deadline-is-shown)
  5223. (assoc (point) deadline-position-alist))
  5224. (throw :skip nil))
  5225. (setq hdmarker (org-agenda-new-marker)
  5226. inherited-tags
  5227. (or (eq org-agenda-show-inherited-tags 'always)
  5228. (and (listp org-agenda-show-inherited-tags)
  5229. (memq 'agenda org-agenda-show-inherited-tags))
  5230. (and (eq org-agenda-show-inherited-tags t)
  5231. (or (eq org-agenda-use-tag-inheritance t)
  5232. (memq 'agenda org-agenda-use-tag-inheritance))))
  5233. tags (org-get-tags-at nil (not inherited-tags))
  5234. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5235. (looking-at "\\*+[ \t]+\\(.*\\)")
  5236. (setq head (match-string 1))
  5237. (setq txt (org-agenda-format-item
  5238. (if inactivep org-agenda-inactive-leader nil)
  5239. head level category tags timestr
  5240. remove-re habitp)))
  5241. (setq priority (org-get-priority txt))
  5242. (org-add-props txt props 'priority priority
  5243. 'org-marker marker 'org-hd-marker hdmarker
  5244. 'date date
  5245. 'level level
  5246. 'ts-date
  5247. (ignore-errors (org-time-string-to-absolute timestr))
  5248. 'todo-state todo-state
  5249. 'warntime warntime
  5250. 'type "timestamp")
  5251. (push txt ee))
  5252. (if org-agenda-skip-additional-timestamps-same-entry
  5253. (outline-next-heading)
  5254. (goto-char end-of-match))))
  5255. (nreverse ee)))
  5256. (defun org-agenda-get-sexps ()
  5257. "Return the sexp information for agenda display."
  5258. (require 'diary-lib)
  5259. (let* ((props (list 'face 'org-agenda-calendar-sexp
  5260. 'mouse-face 'highlight
  5261. 'help-echo
  5262. (format "mouse-2 or RET jump to org file %s"
  5263. (abbreviate-file-name buffer-file-name))))
  5264. (regexp "^&?%%(")
  5265. marker category extra level ee txt tags entry
  5266. result beg b sexp sexp-entry todo-state warntime inherited-tags)
  5267. (goto-char (point-min))
  5268. (while (re-search-forward regexp nil t)
  5269. (catch :skip
  5270. (org-agenda-skip)
  5271. (setq beg (match-beginning 0))
  5272. (goto-char (1- (match-end 0)))
  5273. (setq b (point))
  5274. (forward-sexp 1)
  5275. (setq sexp (buffer-substring b (point)))
  5276. (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
  5277. (org-trim (match-string 1))
  5278. ""))
  5279. (setq result (org-diary-sexp-entry sexp sexp-entry date))
  5280. (when result
  5281. (setq marker (org-agenda-new-marker beg)
  5282. level (make-string (org-reduced-level (org-outline-level)) ? )
  5283. category (org-get-category beg)
  5284. inherited-tags
  5285. (or (eq org-agenda-show-inherited-tags 'always)
  5286. (and (listp org-agenda-show-inherited-tags)
  5287. (memq 'agenda org-agenda-show-inherited-tags))
  5288. (and (eq org-agenda-show-inherited-tags t)
  5289. (or (eq org-agenda-use-tag-inheritance t)
  5290. (memq 'agenda org-agenda-use-tag-inheritance))))
  5291. tags (org-get-tags-at nil (not inherited-tags))
  5292. todo-state (org-get-todo-state)
  5293. warntime (get-text-property (point) 'org-appt-warntime)
  5294. extra nil)
  5295. (dolist (r (if (stringp result)
  5296. (list result)
  5297. result)) ;; we expect a list here
  5298. (when (and org-agenda-diary-sexp-prefix
  5299. (string-match org-agenda-diary-sexp-prefix r))
  5300. (setq extra (match-string 0 r)
  5301. r (replace-match "" nil nil r)))
  5302. (if (string-match "\\S-" r)
  5303. (setq txt r)
  5304. (setq txt "SEXP entry returned empty string"))
  5305. (setq txt (org-agenda-format-item extra txt level category tags 'time))
  5306. (org-add-props txt props 'org-marker marker
  5307. 'date date 'todo-state todo-state
  5308. 'level level 'type "sexp" 'warntime warntime)
  5309. (push txt ee)))))
  5310. (nreverse ee)))
  5311. ;; Calendar sanity: define some functions that are independent of
  5312. ;; `calendar-date-style'.
  5313. (defun org-anniversary (year month day &optional mark)
  5314. "Like `diary-anniversary', but with fixed (ISO) order of arguments."
  5315. (with-no-warnings
  5316. (let ((calendar-date-style 'iso))
  5317. (diary-anniversary year month day mark))))
  5318. (defun org-cyclic (N year month day &optional mark)
  5319. "Like `diary-cyclic', but with fixed (ISO) order of arguments."
  5320. (with-no-warnings
  5321. (let ((calendar-date-style 'iso))
  5322. (diary-cyclic N year month day mark))))
  5323. (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
  5324. "Like `diary-block', but with fixed (ISO) order of arguments."
  5325. (with-no-warnings
  5326. (let ((calendar-date-style 'iso))
  5327. (diary-block Y1 M1 D1 Y2 M2 D2 mark))))
  5328. (defun org-date (year month day &optional mark)
  5329. "Like `diary-date', but with fixed (ISO) order of arguments."
  5330. (with-no-warnings
  5331. (let ((calendar-date-style 'iso))
  5332. (diary-date year month day mark))))
  5333. ;; Define the `org-class' function
  5334. (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
  5335. "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
  5336. DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
  5337. SKIP-WEEKS is any number of ISO weeks in the block period for which the
  5338. item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
  5339. `holidays', then any date that is known by the Emacs calendar to be a
  5340. holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
  5341. then those holidays will be skipped."
  5342. (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
  5343. (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
  5344. (d (calendar-absolute-from-gregorian date))
  5345. (h (when skip-weeks (calendar-check-holidays date))))
  5346. (and
  5347. (<= date1 d)
  5348. (<= d date2)
  5349. (= (calendar-day-of-week date) dayname)
  5350. (or (not skip-weeks)
  5351. (progn
  5352. (require 'cal-iso)
  5353. (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
  5354. (not (or (and h (memq 'holidays skip-weeks))
  5355. (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
  5356. entry)))
  5357. (defalias 'org-get-closed 'org-agenda-get-progress)
  5358. (defun org-agenda-get-progress ()
  5359. "Return the logged TODO entries for agenda display."
  5360. (let* ((props (list 'mouse-face 'highlight
  5361. 'org-not-done-regexp org-not-done-regexp
  5362. 'org-todo-regexp org-todo-regexp
  5363. 'org-complex-heading-regexp org-complex-heading-regexp
  5364. 'help-echo
  5365. (format "mouse-2 or RET jump to org file %s"
  5366. (abbreviate-file-name buffer-file-name))))
  5367. (items (if (consp org-agenda-show-log-scoped)
  5368. org-agenda-show-log-scoped
  5369. (if (eq org-agenda-show-log-scoped 'clockcheck)
  5370. '(clock)
  5371. org-agenda-log-mode-items)))
  5372. (parts
  5373. (delq nil
  5374. (list
  5375. (if (memq 'closed items) (concat "\\<" org-closed-string))
  5376. (if (memq 'clock items) (concat "\\<" org-clock-string))
  5377. (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
  5378. (parts-re (if parts (mapconcat 'identity parts "\\|")
  5379. (error "`org-agenda-log-mode-items' is empty")))
  5380. (regexp (concat
  5381. "\\(" parts-re "\\)"
  5382. " *\\["
  5383. (regexp-quote
  5384. (substring
  5385. (format-time-string
  5386. (car org-time-stamp-formats)
  5387. (apply 'encode-time ; DATE bound by calendar
  5388. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  5389. 1 11))))
  5390. (org-agenda-search-headline-for-time nil)
  5391. marker hdmarker priority category level tags closedp
  5392. statep clockp state ee txt extra timestr rest clocked inherited-tags)
  5393. (goto-char (point-min))
  5394. (while (re-search-forward regexp nil t)
  5395. (catch :skip
  5396. (org-agenda-skip)
  5397. (setq marker (org-agenda-new-marker (match-beginning 0))
  5398. closedp (equal (match-string 1) org-closed-string)
  5399. statep (equal (string-to-char (match-string 1)) ?-)
  5400. clockp (not (or closedp statep))
  5401. state (and statep (match-string 2))
  5402. category (org-get-category (match-beginning 0))
  5403. timestr (buffer-substring (match-beginning 0) (point-at-eol)))
  5404. (when (string-match "\\]" timestr)
  5405. ;; substring should only run to end of time stamp
  5406. (setq rest (substring timestr (match-end 0))
  5407. timestr (substring timestr 0 (match-end 0)))
  5408. (if (and (not closedp) (not statep)
  5409. (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
  5410. rest))
  5411. (progn (setq timestr (concat (substring timestr 0 -1)
  5412. "-" (match-string 1 rest) "]"))
  5413. (setq clocked (match-string 2 rest)))
  5414. (setq clocked "-")))
  5415. (save-excursion
  5416. (setq extra
  5417. (cond
  5418. ((not org-agenda-log-mode-add-notes) nil)
  5419. (statep
  5420. (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
  5421. (match-string 1)))
  5422. (clockp
  5423. (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
  5424. (match-string 1)))))
  5425. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5426. (throw :skip nil)
  5427. (goto-char (match-beginning 0))
  5428. (setq hdmarker (org-agenda-new-marker)
  5429. inherited-tags
  5430. (or (eq org-agenda-show-inherited-tags 'always)
  5431. (and (listp org-agenda-show-inherited-tags)
  5432. (memq 'todo org-agenda-show-inherited-tags))
  5433. (and (eq org-agenda-show-inherited-tags t)
  5434. (or (eq org-agenda-use-tag-inheritance t)
  5435. (memq 'todo org-agenda-use-tag-inheritance))))
  5436. tags (org-get-tags-at nil (not inherited-tags))
  5437. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5438. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5439. (setq txt (match-string 1))
  5440. (when extra
  5441. (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
  5442. (setq txt (concat (substring txt 0 (match-beginning 1))
  5443. " - " extra " " (match-string 2 txt)))
  5444. (setq txt (concat txt " - " extra))))
  5445. (setq txt (org-agenda-format-item
  5446. (cond
  5447. (closedp "Closed: ")
  5448. (statep (concat "State: (" state ")"))
  5449. (t (concat "Clocked: (" clocked ")")))
  5450. txt level category tags timestr)))
  5451. (setq priority 100000)
  5452. (org-add-props txt props
  5453. 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
  5454. 'priority priority 'level level
  5455. 'type "closed" 'date date
  5456. 'undone-face 'org-warning 'done-face 'org-agenda-done)
  5457. (push txt ee))
  5458. (goto-char (point-at-eol))))
  5459. (nreverse ee)))
  5460. (defun org-agenda-show-clocking-issues ()
  5461. "Add overlays, showing issues with clocking.
  5462. See also the user option `org-agenda-clock-consistency-checks'."
  5463. (interactive)
  5464. (let* ((org-time-clocksum-use-effort-durations nil)
  5465. (pl org-agenda-clock-consistency-checks)
  5466. (re (concat "^[ \t]*"
  5467. org-clock-string
  5468. "[ \t]+"
  5469. "\\(\\[.*?\\]\\)" ; group 1 is first stamp
  5470. "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
  5471. (tlstart 0.)
  5472. (tlend 0.)
  5473. (maxtime (org-hh:mm-string-to-minutes
  5474. (or (plist-get pl :max-duration) "24:00")))
  5475. (mintime (org-hh:mm-string-to-minutes
  5476. (or (plist-get pl :min-duration) 0)))
  5477. (maxgap (org-hh:mm-string-to-minutes
  5478. ;; default 30:00 means never complain
  5479. (or (plist-get pl :max-gap) "30:00")))
  5480. (gapok (mapcar 'org-hh:mm-string-to-minutes
  5481. (plist-get pl :gap-ok-around)))
  5482. (def-face (or (plist-get pl :default-face)
  5483. '((:background "DarkRed") (:foreground "white"))))
  5484. issue face m te ts dt ov)
  5485. (goto-char (point-min))
  5486. (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
  5487. (setq issue nil face def-face)
  5488. (catch 'next
  5489. (setq m (org-get-at-bol 'org-marker)
  5490. te nil ts nil)
  5491. (unless (and m (markerp m))
  5492. (setq issue "No valid clock line") (throw 'next t))
  5493. (org-with-point-at m
  5494. (save-excursion
  5495. (goto-char (point-at-bol))
  5496. (unless (looking-at re)
  5497. (error "No valid Clock line")
  5498. (throw 'next t))
  5499. (unless (match-end 3)
  5500. (setq issue "No end time"
  5501. face (or (plist-get pl :no-end-time-face) face))
  5502. (throw 'next t))
  5503. (setq ts (match-string 1)
  5504. te (match-string 3)
  5505. ts (float-time
  5506. (apply #'encode-time (org-parse-time-string ts)))
  5507. te (float-time
  5508. (apply #'encode-time (org-parse-time-string te)))
  5509. dt (- te ts))))
  5510. (cond
  5511. ((> dt (* 60 maxtime))
  5512. ;; a very long clocking chunk
  5513. (setq issue (format "Clocking interval is very long: %s"
  5514. (org-minutes-to-clocksum-string
  5515. (floor (/ (float dt) 60.))))
  5516. face (or (plist-get pl :long-face) face)))
  5517. ((< dt (* 60 mintime))
  5518. ;; a very short clocking chunk
  5519. (setq issue (format "Clocking interval is very short: %s"
  5520. (org-minutes-to-clocksum-string
  5521. (floor (/ (float dt) 60.))))
  5522. face (or (plist-get pl :short-face) face)))
  5523. ((and (> tlend 0) (< ts tlend))
  5524. ;; Two clock entries are overlapping
  5525. (setq issue (format "Clocking overlap: %d minutes"
  5526. (/ (- tlend ts) 60))
  5527. face (or (plist-get pl :overlap-face) face)))
  5528. ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
  5529. ;; There is a gap, lets see if we need to report it
  5530. (unless (org-agenda-check-clock-gap tlend ts gapok)
  5531. (setq issue (format "Clocking gap: %d minutes"
  5532. (/ (- ts tlend) 60))
  5533. face (or (plist-get pl :gap-face) face))))
  5534. (t nil)))
  5535. (setq tlend (or te tlend) tlstart (or ts tlstart))
  5536. (when issue
  5537. ;; OK, there was some issue, add an overlay to show the issue
  5538. (setq ov (make-overlay (point-at-bol) (point-at-eol)))
  5539. (overlay-put ov 'before-string
  5540. (concat
  5541. (org-add-props
  5542. (format "%-43s" (concat " " issue))
  5543. nil
  5544. 'face face)
  5545. "\n"))
  5546. (overlay-put ov 'evaporate t)))))
  5547. (defun org-agenda-check-clock-gap (t1 t2 ok-list)
  5548. "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
  5549. (catch 'exit
  5550. (unless ok-list
  5551. ;; there are no OK times for gaps...
  5552. (throw 'exit nil))
  5553. (if (> (- (/ t2 36000) (/ t1 36000)) 24)
  5554. ;; This is more than 24 hours, so it is OK.
  5555. ;; because we have at least one OK time, that must be in the
  5556. ;; 24 hour interval.
  5557. (throw 'exit t))
  5558. ;; We have a shorter gap.
  5559. ;; Now we have to get the minute of the day when these times are
  5560. (let* ((t1dec (decode-time (seconds-to-time t1)))
  5561. (t2dec (decode-time (seconds-to-time t2)))
  5562. ;; compute the minute on the day
  5563. (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
  5564. (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
  5565. (when (< min2 min1)
  5566. ;; if min2 is smaller than min1, this means it is on the next day.
  5567. ;; Wrap it to after midnight.
  5568. (setq min2 (+ min2 1440)))
  5569. ;; Now check if any of the OK times is in the gap
  5570. (mapc (lambda (x)
  5571. ;; Wrap the time to after midnight if necessary
  5572. (if (< x min1) (setq x (+ x 1440)))
  5573. ;; Check if in interval
  5574. (and (<= min1 x) (>= min2 x) (throw 'exit t)))
  5575. ok-list)
  5576. ;; Nope, this gap is not OK
  5577. nil)))
  5578. (defun org-agenda-get-deadlines (&optional with-hour)
  5579. "Return the deadline information for agenda display.
  5580. When WITH-HOUR is non-nil, only return deadlines with an hour
  5581. specification like [h]h:mm."
  5582. (let* ((props (list 'mouse-face 'highlight
  5583. 'org-not-done-regexp org-not-done-regexp
  5584. 'org-todo-regexp org-todo-regexp
  5585. 'org-complex-heading-regexp org-complex-heading-regexp
  5586. 'help-echo
  5587. (format "mouse-2 or RET jump to org file %s"
  5588. (abbreviate-file-name buffer-file-name))))
  5589. (regexp (if with-hour
  5590. org-deadline-time-hour-regexp
  5591. org-deadline-time-regexp))
  5592. (todayp (org-agenda-today-p date)) ; DATE bound by calendar.
  5593. (current (calendar-absolute-from-gregorian date))
  5594. deadline-items)
  5595. (goto-char (point-min))
  5596. (while (re-search-forward regexp nil t)
  5597. (catch :skip
  5598. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5599. (org-agenda-skip)
  5600. (let* ((s (match-string 1))
  5601. (pos (1- (match-beginning 1)))
  5602. (todo-state (save-match-data (org-get-todo-state)))
  5603. (donep (member todo-state org-done-keywords))
  5604. (show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  5605. (member todo-state
  5606. org-agenda-repeating-timestamp-show-all)))
  5607. ;; DEADLINE is the current scheduled date. When it
  5608. ;; contains a repeater and SHOW-ALL is non-nil,
  5609. ;; LAST-REPEAT is the repeat closest to CURRENT.
  5610. ;; Otherwise, LAST-REPEAT is equal to DEADLINE.
  5611. (last-repeat (org-agenda--timestamp-to-absolute
  5612. s current 'past show-all (current-buffer) pos))
  5613. (deadline (org-agenda--timestamp-to-absolute s current))
  5614. (diff (- last-repeat current))
  5615. (suppress-prewarning
  5616. (let ((scheduled
  5617. (and org-agenda-skip-deadline-prewarning-if-scheduled
  5618. (org-entry-get nil "SCHEDULED"))))
  5619. (cond
  5620. ((not scheduled) nil)
  5621. ;; The current item has a scheduled date, so
  5622. ;; evaluate its prewarning lead time.
  5623. ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
  5624. ;; Use global prewarning-restart lead time.
  5625. org-agenda-skip-deadline-prewarning-if-scheduled)
  5626. ((eq org-agenda-skip-deadline-prewarning-if-scheduled
  5627. 'pre-scheduled)
  5628. ;; Set pre-warning to no earlier than SCHEDULED.
  5629. (min (- last-repeat
  5630. (org-agenda--timestamp-to-absolute
  5631. scheduled current 'past show-all
  5632. (current-buffer)
  5633. (save-excursion
  5634. (beginning-of-line)
  5635. (1+ (search-forward org-deadline-string)))))
  5636. org-deadline-warning-days))
  5637. ;; Set pre-warning to deadline.
  5638. (t 0))))
  5639. (wdays (if suppress-prewarning
  5640. (let ((org-deadline-warning-days suppress-prewarning))
  5641. (org-get-wdays s))
  5642. (org-get-wdays s))))
  5643. ;; When to show a deadline in the calendar: if the
  5644. ;; expiration is within WDAYS warning time. Past-due
  5645. ;; deadlines are only shown on the current date
  5646. (unless (or (and (<= diff wdays)
  5647. (and todayp (not org-agenda-only-exact-dates)))
  5648. (= diff 0))
  5649. (throw :skip nil))
  5650. ;; Skip done tasks if `org-agenda-skip-deadline-if-done' is
  5651. ;; non-nil or if it isn't applicable to CURRENT deadline.
  5652. (when (and donep
  5653. (or org-agenda-skip-deadline-if-done
  5654. (/= deadline current)))
  5655. (throw :skip nil))
  5656. (save-excursion
  5657. (re-search-backward "^\\*+[ \t]+" nil t)
  5658. (goto-char (match-end 0))
  5659. (let* ((category (org-get-category))
  5660. (level
  5661. (make-string (org-reduced-level (org-outline-level)) ?\s))
  5662. (head (buffer-substring (point) (line-end-position)))
  5663. (inherited-tags
  5664. (or (eq org-agenda-show-inherited-tags 'always)
  5665. (and (listp org-agenda-show-inherited-tags)
  5666. (memq 'agenda org-agenda-show-inherited-tags))
  5667. (and (eq org-agenda-show-inherited-tags t)
  5668. (or (eq org-agenda-use-tag-inheritance t)
  5669. (memq 'agenda
  5670. org-agenda-use-tag-inheritance)))))
  5671. (tags (org-get-tags-at nil (not inherited-tags)))
  5672. (timestr
  5673. (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5674. (concat (substring s (match-beginning 1)) " ")
  5675. 'time))
  5676. (item
  5677. (org-agenda-format-item
  5678. ;; For past deadlines, make sure to report time
  5679. ;; difference since date S, not since closest
  5680. ;; repeater.
  5681. (let ((diff (if (< (org-today) current) diff
  5682. (- deadline current))))
  5683. (if (= diff 0) (car org-agenda-deadline-leaders)
  5684. (let ((future (nth 1 org-agenda-deadline-leaders))
  5685. (past (nth 2 org-agenda-deadline-leaders)))
  5686. (cond ((> diff 0) (format future diff))
  5687. ((string= future past) (format past diff))
  5688. (t (format past (abs diff)))))))
  5689. head level category tags
  5690. (and (= diff 0) timestr)))
  5691. (face (org-agenda-deadline-face
  5692. (- 1 (/ (float (- deadline current)) (max wdays 1)))))
  5693. (upcomingp (and todayp (> diff 0)))
  5694. (warntime (get-text-property (point) 'org-appt-warntime)))
  5695. (org-add-props item props
  5696. 'org-marker (org-agenda-new-marker pos)
  5697. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  5698. 'warntime warntime
  5699. 'level level
  5700. 'ts-date deadline
  5701. 'priority (- (org-get-priority item) diff)
  5702. 'todo-state todo-state
  5703. 'type (if upcomingp "upcoming-deadline" "deadline")
  5704. 'date (if upcomingp date deadline)
  5705. 'face (if donep 'org-agenda-done face)
  5706. 'undone-face face
  5707. 'done-face 'org-agenda-done)
  5708. (push item deadline-items))))))
  5709. (nreverse deadline-items)))
  5710. (defun org-agenda-deadline-face (fraction)
  5711. "Return the face to displaying a deadline item.
  5712. FRACTION is what fraction of the head-warning time has passed."
  5713. (let ((faces org-agenda-deadline-faces) f)
  5714. (catch 'exit
  5715. (while (setq f (pop faces))
  5716. (if (>= fraction (car f)) (throw 'exit (cdr f)))))))
  5717. (defun org-agenda-get-scheduled (&optional deadlines with-hour)
  5718. "Return the scheduled information for agenda display.
  5719. Optional argument DEADLINES is a list of deadline items to be
  5720. displayed in agenda view. When WITH-HOUR is non-nil, only return
  5721. scheduled items with an hour specification like [h]h:mm."
  5722. (let* ((props (list 'org-not-done-regexp org-not-done-regexp
  5723. 'org-todo-regexp org-todo-regexp
  5724. 'org-complex-heading-regexp org-complex-heading-regexp
  5725. 'done-face 'org-agenda-done
  5726. 'mouse-face 'highlight
  5727. 'help-echo
  5728. (format "mouse-2 or RET jump to org file %s"
  5729. (abbreviate-file-name buffer-file-name))))
  5730. (regexp (if with-hour
  5731. org-scheduled-time-hour-regexp
  5732. org-scheduled-time-regexp))
  5733. (todayp (org-agenda-today-p date)) ; DATE bound by calendar.
  5734. (current (calendar-absolute-from-gregorian date))
  5735. (deadline-pos
  5736. (mapcar (lambda (d)
  5737. (let ((m (get-text-property 0 'org-hd-marker d)))
  5738. (and m (marker-position m))))
  5739. deadlines))
  5740. scheduled-items)
  5741. (goto-char (point-min))
  5742. (while (re-search-forward regexp nil t)
  5743. (catch :skip
  5744. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5745. (org-agenda-skip)
  5746. (let* ((s (match-string 1))
  5747. (pos (1- (match-beginning 1)))
  5748. (todo-state (save-match-data (org-get-todo-state)))
  5749. (donep (member todo-state org-done-keywords))
  5750. (show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  5751. (member todo-state
  5752. org-agenda-repeating-timestamp-show-all)))
  5753. ;; SCHEDULE is the current scheduled date. When it
  5754. ;; contains a repeater and SHOW-ALL is non-nil,
  5755. ;; LAST-REPEAT is the repeat closest to CURRENT.
  5756. ;; Otherwise, LAST-REPEAT is equal to SCHEDULE.
  5757. (last-repeat (org-agenda--timestamp-to-absolute
  5758. s current 'past show-all (current-buffer) pos))
  5759. (schedule (org-agenda--timestamp-to-absolute s current))
  5760. (diff (- last-repeat current))
  5761. (warntime (get-text-property (point) 'org-appt-warntime))
  5762. (pastschedp (< schedule (org-today)))
  5763. (habitp (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  5764. (suppress-delay
  5765. (let ((deadline (and org-agenda-skip-scheduled-delay-if-deadline
  5766. (org-entry-get nil "DEADLINE"))))
  5767. (cond
  5768. ((not deadline) nil)
  5769. ;; The current item has a deadline date, so
  5770. ;; evaluate its delay time.
  5771. ((integerp org-agenda-skip-scheduled-delay-if-deadline)
  5772. ;; Use global delay time.
  5773. (- org-agenda-skip-scheduled-delay-if-deadline))
  5774. ((eq org-agenda-skip-scheduled-delay-if-deadline
  5775. 'post-deadline)
  5776. ;; Set delay to no later than DEADLINE. If
  5777. ;; DEADLINE has a repeater, compare last schedule
  5778. ;; repeat and last deadline repeat.
  5779. (min (- last-repeat
  5780. (org-agenda--timestamp-to-absolute
  5781. deadline current 'past show-all
  5782. (current-buffer)
  5783. (save-excursion
  5784. (beginning-of-line)
  5785. (1+ (search-forward org-deadline-string)))))
  5786. org-scheduled-delay-days))
  5787. (t 0))))
  5788. (ddays
  5789. (cond
  5790. ;; Nullify delay when a repeater triggered already
  5791. ;; and the delay is of the form --Xd.
  5792. ((and (save-match-data (string-match "--[0-9]+[hdwmy]" s))
  5793. (/= schedule last-repeat))
  5794. 0)
  5795. (suppress-delay
  5796. (let ((org-scheduled-delay-days suppress-delay))
  5797. (org-get-wdays s t t)))
  5798. (t (org-get-wdays s t)))))
  5799. ;; Only show a scheduled item in the calendar if it is on or
  5800. ;; past the current date. Skip it if it has been displayed
  5801. ;; for more than `org-scheduled-past-days'.
  5802. (unless (or (and (>= ddays 0) (= diff (- ddays)))
  5803. (and (< (+ diff ddays) 0)
  5804. (< (abs diff) org-scheduled-past-days)
  5805. (and todayp (not org-agenda-only-exact-dates)))
  5806. (and todayp
  5807. habitp
  5808. (bound-and-true-p org-habit-show-all-today)))
  5809. (throw :skip nil))
  5810. ;; Skip done habits, or tasks if
  5811. ;; `org-agenda-skip-deadline-if-done' is non-nil or if it
  5812. ;; was scheduled in the past anyway.
  5813. (when (and donep
  5814. (or org-agenda-skip-scheduled-if-done
  5815. (/= schedule current)
  5816. habitp))
  5817. (throw :skip nil))
  5818. ;; Skip entry if it already appears as a deadline, per
  5819. ;; `org-agenda-skip-scheduled-if-deadline-is-shown'. This
  5820. ;; doesn't apply to habits.
  5821. (when (pcase org-agenda-skip-scheduled-if-deadline-is-shown
  5822. ((guard
  5823. (or (not (assq (line-beginning-position 0) deadline-pos))
  5824. habitp))
  5825. nil)
  5826. (`repeated-after-deadline
  5827. (>= last-repeat
  5828. (time-to-days (org-get-deadline-time (point)))))
  5829. (`not-today pastschedp)
  5830. (`t t)
  5831. (_ nil))
  5832. (throw :skip nil))
  5833. ;; Skip habits if `org-habit-show-habits' is nil, or if we
  5834. ;; only show them for today.
  5835. (when (and habitp
  5836. (or (not (bound-and-true-p org-habit-show-habits))
  5837. (and (not todayp)
  5838. (bound-and-true-p
  5839. org-habit-show-habits-only-for-today))))
  5840. (throw :skip nil))
  5841. (save-excursion
  5842. (re-search-backward "^\\*+[ \t]+" nil t)
  5843. (goto-char (match-end 0))
  5844. (let* ((category (org-get-category))
  5845. (inherited-tags
  5846. (or (eq org-agenda-show-inherited-tags 'always)
  5847. (and (listp org-agenda-show-inherited-tags)
  5848. (memq 'agenda org-agenda-show-inherited-tags))
  5849. (and (eq org-agenda-show-inherited-tags t)
  5850. (or (eq org-agenda-use-tag-inheritance t)
  5851. (memq 'agenda
  5852. org-agenda-use-tag-inheritance)))))
  5853. (tags (org-get-tags-at nil (not inherited-tags)))
  5854. (level
  5855. (make-string (org-reduced-level (org-outline-level)) ?\s))
  5856. (head (buffer-substring (point) (line-end-position)))
  5857. (timestr
  5858. (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5859. (concat (substring s (match-beginning 1)) " ")
  5860. 'time))
  5861. (item (org-agenda-format-item
  5862. ;; For past scheduled dates, make sure to
  5863. ;; report time difference since SCHEDULE,
  5864. ;; not since closest repeater.
  5865. (let ((diff (if (< (org-today) current) diff
  5866. (- schedule current))))
  5867. (if (= diff 0) (car org-agenda-scheduled-leaders)
  5868. (format (nth 1 org-agenda-scheduled-leaders)
  5869. (- 1 diff))))
  5870. head level category tags
  5871. (and (= diff 0) timestr)
  5872. nil habitp))
  5873. (face (cond ((and (not habitp) pastschedp)
  5874. 'org-scheduled-previously)
  5875. (todayp 'org-scheduled-today)
  5876. (t 'org-scheduled)))
  5877. (habitp (and habitp (org-habit-parse-todo))))
  5878. (org-add-props item props
  5879. 'undone-face face
  5880. 'face (if donep 'org-agenda-done face)
  5881. 'org-marker (org-agenda-new-marker pos)
  5882. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  5883. 'type (if pastschedp "past-scheduled" "scheduled")
  5884. 'date (if pastschedp schedule date)
  5885. 'ts-date schedule
  5886. 'warntime warntime
  5887. 'level level
  5888. 'priority (if habitp (org-habit-get-priority habitp)
  5889. (+ 94 (- 5 diff) (org-get-priority item)))
  5890. 'org-habit-p habitp
  5891. 'todo-state todo-state)
  5892. (push item scheduled-items))))))
  5893. (nreverse scheduled-items)))
  5894. (defun org-agenda-get-blocks ()
  5895. "Return the date-range information for agenda display."
  5896. (let* ((props (list 'face nil
  5897. 'org-not-done-regexp org-not-done-regexp
  5898. 'org-todo-regexp org-todo-regexp
  5899. 'org-complex-heading-regexp org-complex-heading-regexp
  5900. 'mouse-face 'highlight
  5901. 'help-echo
  5902. (format "mouse-2 or RET jump to org file %s"
  5903. (abbreviate-file-name buffer-file-name))))
  5904. (regexp org-tr-regexp)
  5905. (d0 (calendar-absolute-from-gregorian date))
  5906. marker hdmarker ee txt d1 d2 s1 s2 category
  5907. level todo-state tags pos head donep inherited-tags)
  5908. (goto-char (point-min))
  5909. (while (re-search-forward regexp nil t)
  5910. (catch :skip
  5911. (org-agenda-skip)
  5912. (setq pos (point))
  5913. (let ((start-time (match-string 1))
  5914. (end-time (match-string 2)))
  5915. (setq s1 (match-string 1)
  5916. s2 (match-string 2)
  5917. d1 (time-to-days (org-time-string-to-time s1 (current-buffer) pos))
  5918. d2 (time-to-days (org-time-string-to-time s2 (current-buffer) pos)))
  5919. (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
  5920. ;; Only allow days between the limits, because the normal
  5921. ;; date stamps will catch the limits.
  5922. (save-excursion
  5923. (setq todo-state (org-get-todo-state))
  5924. (setq donep (member todo-state org-done-keywords))
  5925. (if (and donep org-agenda-skip-timestamp-if-done)
  5926. (throw :skip t))
  5927. (setq marker (org-agenda-new-marker (point))
  5928. category (org-get-category))
  5929. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5930. (throw :skip nil)
  5931. (goto-char (match-beginning 0))
  5932. (setq hdmarker (org-agenda-new-marker (point))
  5933. inherited-tags
  5934. (or (eq org-agenda-show-inherited-tags 'always)
  5935. (and (listp org-agenda-show-inherited-tags)
  5936. (memq 'agenda org-agenda-show-inherited-tags))
  5937. (and (eq org-agenda-show-inherited-tags t)
  5938. (or (eq org-agenda-use-tag-inheritance t)
  5939. (memq 'agenda org-agenda-use-tag-inheritance))))
  5940. tags (org-get-tags-at nil (not inherited-tags)))
  5941. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  5942. (looking-at "\\*+[ \t]+\\(.*\\)")
  5943. (setq head (match-string 1))
  5944. (let ((remove-re
  5945. (if org-agenda-remove-timeranges-from-blocks
  5946. (concat
  5947. "<" (regexp-quote s1) ".*?>"
  5948. "--"
  5949. "<" (regexp-quote s2) ".*?>")
  5950. nil)))
  5951. (setq txt (org-agenda-format-item
  5952. (format
  5953. (nth (if (= d1 d2) 0 1)
  5954. org-agenda-timerange-leaders)
  5955. (1+ (- d0 d1)) (1+ (- d2 d1)))
  5956. head level category tags
  5957. (cond ((and (= d1 d0) (= d2 d0))
  5958. (concat "<" start-time ">--<" end-time ">"))
  5959. ((= d1 d0)
  5960. (concat "<" start-time ">"))
  5961. ((= d2 d0)
  5962. (concat "<" end-time ">")))
  5963. remove-re))))
  5964. (org-add-props txt props
  5965. 'org-marker marker 'org-hd-marker hdmarker
  5966. 'type "block" 'date date
  5967. 'level level
  5968. 'todo-state todo-state
  5969. 'priority (org-get-priority txt))
  5970. (push txt ee))))
  5971. (goto-char pos)))
  5972. ;; Sort the entries by expiration date.
  5973. (nreverse ee)))
  5974. ;;; Agenda presentation and sorting
  5975. (defvar org-prefix-has-time nil
  5976. "A flag, set by `org-compile-prefix-format'.
  5977. The flag is set if the currently compiled format contains a `%t'.")
  5978. (defvar org-prefix-has-tag nil
  5979. "A flag, set by `org-compile-prefix-format'.
  5980. The flag is set if the currently compiled format contains a `%T'.")
  5981. (defvar org-prefix-has-effort nil
  5982. "A flag, set by `org-compile-prefix-format'.
  5983. The flag is set if the currently compiled format contains a `%e'.")
  5984. (defvar org-prefix-has-breadcrumbs nil
  5985. "A flag, set by `org-compile-prefix-format'.
  5986. The flag is set if the currently compiled format contains a `%b'.")
  5987. (defvar org-prefix-category-length nil
  5988. "Used by `org-compile-prefix-format' to remember the category field width.")
  5989. (defvar org-prefix-category-max-length nil
  5990. "Used by `org-compile-prefix-format' to remember the category field width.")
  5991. (defun org-agenda-get-category-icon (category)
  5992. "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
  5993. (dolist (entry org-agenda-category-icon-alist)
  5994. (when (string-match-p (car entry) category)
  5995. (if (listp (cadr entry))
  5996. (cl-return (cadr entry))
  5997. (cl-return (apply #'create-image (cdr entry)))))))
  5998. (defun org-agenda-format-item (extra txt &optional level category tags dotime
  5999. remove-re habitp)
  6000. "Format TXT to be inserted into the agenda buffer.
  6001. In particular, add the prefix and corresponding text properties.
  6002. EXTRA must be a string to replace the `%s' specifier in the prefix format.
  6003. LEVEL may be a string to replace the `%l' specifier.
  6004. CATEGORY (a string, a symbol or nil) may be used to overrule the default
  6005. category taken from local variable or file name. It will replace the `%c'
  6006. specifier in the format.
  6007. DOTIME, when non-nil, indicates that a time-of-day should be extracted from
  6008. TXT for sorting of this entry, and for the `%t' specifier in the format.
  6009. When DOTIME is a string, this string is searched for a time before TXT is.
  6010. TAGS can be the tags of the headline.
  6011. Any match of REMOVE-RE will be removed from TXT."
  6012. ;; We keep the org-prefix-* variable values along with a compiled
  6013. ;; formatter, so that multiple agendas existing at the same time do
  6014. ;; not step on each other toes.
  6015. ;;
  6016. ;; It was inconvenient to make these variables buffer local in
  6017. ;; Agenda buffers, because this function expects to be called with
  6018. ;; the buffer where item comes from being current, and not agenda
  6019. ;; buffer
  6020. (let* ((bindings (car org-prefix-format-compiled))
  6021. (formatter (cadr org-prefix-format-compiled)))
  6022. (cl-loop for (var value) in bindings
  6023. do (set var value))
  6024. (save-match-data
  6025. ;; Diary entries sometimes have extra whitespace at the beginning
  6026. (setq txt (org-trim txt))
  6027. ;; Fix the tags part in txt
  6028. (setq txt (org-agenda-fix-displayed-tags
  6029. txt tags
  6030. org-agenda-show-inherited-tags
  6031. org-agenda-hide-tags-regexp))
  6032. (let* ((category (or category
  6033. (if buffer-file-name
  6034. (file-name-sans-extension
  6035. (file-name-nondirectory buffer-file-name))
  6036. "")))
  6037. (category-icon (org-agenda-get-category-icon category))
  6038. (category-icon (if category-icon
  6039. (propertize " " 'display category-icon)
  6040. ""))
  6041. (effort (and (not (string= txt ""))
  6042. (get-text-property 1 'effort txt)))
  6043. ;; time, tag, effort are needed for the eval of the prefix format
  6044. (tag (if tags (nth (1- (length tags)) tags) ""))
  6045. time
  6046. (ts (if dotime (concat
  6047. (if (stringp dotime) dotime "")
  6048. (and org-agenda-search-headline-for-time txt))))
  6049. (time-of-day (and dotime (org-get-time-of-day ts)))
  6050. stamp plain s0 s1 s2 rtn srp l
  6051. duration breadcrumbs)
  6052. (and (derived-mode-p 'org-mode) buffer-file-name
  6053. (add-to-list 'org-agenda-contributing-files buffer-file-name))
  6054. (when (and dotime time-of-day)
  6055. ;; Extract starting and ending time and move them to prefix
  6056. (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
  6057. (setq plain (string-match org-plain-time-of-day-regexp ts)))
  6058. (setq s0 (match-string 0 ts)
  6059. srp (and stamp (match-end 3))
  6060. s1 (match-string (if plain 1 2) ts)
  6061. s2 (match-string (if plain 8 (if srp 4 6)) ts))
  6062. ;; If the times are in TXT (not in DOTIMES), and the prefix will list
  6063. ;; them, we might want to remove them there to avoid duplication.
  6064. ;; The user can turn this off with a variable.
  6065. (if (and org-prefix-has-time
  6066. org-agenda-remove-times-when-in-prefix (or stamp plain)
  6067. (string-match (concat (regexp-quote s0) " *") txt)
  6068. (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
  6069. (if (eq org-agenda-remove-times-when-in-prefix 'beg)
  6070. (= (match-beginning 0) 0)
  6071. t))
  6072. (setq txt (replace-match "" nil nil txt))))
  6073. ;; Normalize the time(s) to 24 hour
  6074. (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
  6075. (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
  6076. ;; Try to set s2 if s1 and `org-agenda-default-appointment-duration' are set
  6077. (let (org-time-clocksum-use-effort-durations)
  6078. (when (and s1 (not s2) org-agenda-default-appointment-duration)
  6079. (setq s2
  6080. (org-minutes-to-clocksum-string
  6081. (+ (org-hh:mm-string-to-minutes s1)
  6082. org-agenda-default-appointment-duration)))))
  6083. ;; Compute the duration
  6084. (when s2
  6085. (setq duration (- (org-hh:mm-string-to-minutes s2)
  6086. (org-hh:mm-string-to-minutes s1)))))
  6087. (when (string-match "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$" txt)
  6088. ;; Tags are in the string
  6089. (if (or (eq org-agenda-remove-tags t)
  6090. (and org-agenda-remove-tags
  6091. org-prefix-has-tag))
  6092. (setq txt (replace-match "" t t txt))
  6093. (setq txt (replace-match
  6094. (concat (make-string (max (- 50 (length txt)) 1) ?\ )
  6095. (match-string 2 txt))
  6096. t t txt))))
  6097. (when remove-re
  6098. (while (string-match remove-re txt)
  6099. (setq txt (replace-match "" t t txt))))
  6100. ;; Set org-heading property on `txt' to mark the start of the
  6101. ;; heading.
  6102. (add-text-properties 0 (length txt) '(org-heading t) txt)
  6103. ;; Prepare the variables needed in the eval of the compiled format
  6104. (if org-prefix-has-breadcrumbs
  6105. (setq breadcrumbs (org-with-point-at (org-get-at-bol 'org-marker)
  6106. (let ((s (org-display-outline-path nil nil "->" t)))
  6107. (if (eq "" s) "" (concat s "->"))))))
  6108. (setq time (cond (s2 (concat
  6109. (org-agenda-time-of-day-to-ampm-maybe s1)
  6110. "-" (org-agenda-time-of-day-to-ampm-maybe s2)
  6111. (if org-agenda-timegrid-use-ampm " ")))
  6112. (s1 (concat
  6113. (org-agenda-time-of-day-to-ampm-maybe s1)
  6114. (if org-agenda-timegrid-use-ampm
  6115. "........ "
  6116. "......")))
  6117. (t ""))
  6118. extra (or (and (not habitp) extra) "")
  6119. category (if (symbolp category) (symbol-name category) category)
  6120. level (or level ""))
  6121. (if (string-match org-bracket-link-regexp category)
  6122. (progn
  6123. (setq l (if (match-end 3)
  6124. (- (match-end 3) (match-beginning 3))
  6125. (- (match-end 1) (match-beginning 1))))
  6126. (when (< l (or org-prefix-category-length 0))
  6127. (setq category (copy-sequence category))
  6128. (org-add-props category nil
  6129. 'extra-space (make-string
  6130. (- org-prefix-category-length l 1) ?\ ))))
  6131. (if (and org-prefix-category-max-length
  6132. (>= (length category) org-prefix-category-max-length))
  6133. (setq category (substring category 0 (1- org-prefix-category-max-length)))))
  6134. ;; Evaluate the compiled format
  6135. (setq rtn (concat (eval formatter) txt))
  6136. ;; And finally add the text properties
  6137. (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
  6138. (org-add-props rtn nil
  6139. 'org-category category
  6140. 'tags (mapcar 'org-downcase-keep-props tags)
  6141. 'org-highest-priority org-highest-priority
  6142. 'org-lowest-priority org-lowest-priority
  6143. 'time-of-day time-of-day
  6144. 'duration duration
  6145. 'breadcrumbs breadcrumbs
  6146. 'txt txt
  6147. 'level level
  6148. 'time time
  6149. 'extra extra
  6150. 'format org-prefix-format-compiled
  6151. 'dotime dotime)))))
  6152. (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
  6153. "Remove tags string from TXT, and add a modified list of tags.
  6154. The modified list may contain inherited tags, and tags matched by
  6155. `org-agenda-hide-tags-regexp' will be removed."
  6156. (when (or add-inherited hide-re)
  6157. (if (string-match "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$" txt)
  6158. (setq txt (substring txt 0 (match-beginning 0))))
  6159. (setq tags
  6160. (delq nil
  6161. (mapcar (lambda (tg)
  6162. (if (or (and hide-re (string-match hide-re tg))
  6163. (and (not add-inherited)
  6164. (get-text-property 0 'inherited tg)))
  6165. nil
  6166. tg))
  6167. tags)))
  6168. (when tags
  6169. (let ((have-i (get-text-property 0 'inherited (car tags)))
  6170. i)
  6171. (setq txt (concat txt " :"
  6172. (mapconcat
  6173. (lambda (x)
  6174. (setq i (get-text-property 0 'inherited x))
  6175. (if (and have-i (not i))
  6176. (progn
  6177. (setq have-i nil)
  6178. (concat ":" x))
  6179. x))
  6180. tags ":")
  6181. (if have-i "::" ":"))))))
  6182. txt)
  6183. (defun org-downcase-keep-props (s)
  6184. (let ((props (text-properties-at 0 s)))
  6185. (setq s (downcase s))
  6186. (add-text-properties 0 (length s) props s)
  6187. s))
  6188. (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
  6189. (defun org-agenda-add-time-grid-maybe (list ndays todayp)
  6190. "Add a time-grid for agenda items which need it.
  6191. LIST is the list of agenda items formatted by `org-agenda-list'.
  6192. NDAYS is the span of the current agenda view.
  6193. TODAYP is t when the current agenda view is on today."
  6194. (catch 'exit
  6195. (cond ((not org-agenda-use-time-grid) (throw 'exit list))
  6196. ((and todayp (member 'today (car org-agenda-time-grid))))
  6197. ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
  6198. ((member 'weekly (car org-agenda-time-grid)))
  6199. (t (throw 'exit list)))
  6200. (let* ((have (delq nil (mapcar
  6201. (lambda (x) (get-text-property 1 'time-of-day x))
  6202. list)))
  6203. (string (nth 1 org-agenda-time-grid))
  6204. (gridtimes (nth 2 org-agenda-time-grid))
  6205. (req (car org-agenda-time-grid))
  6206. (remove (member 'remove-match req))
  6207. new time)
  6208. (if (and (member 'require-timed req) (not have))
  6209. ;; don't show empty grid
  6210. (throw 'exit list))
  6211. (while (setq time (pop gridtimes))
  6212. (unless (and remove (member time have))
  6213. (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
  6214. (push (org-agenda-format-item
  6215. nil string nil "" nil
  6216. (concat (substring time 0 -2) ":" (substring time -2)))
  6217. new)
  6218. (put-text-property
  6219. 2 (length (car new)) 'face 'org-time-grid (car new))))
  6220. (when (and todayp org-agenda-show-current-time-in-grid)
  6221. (push (org-agenda-format-item
  6222. nil org-agenda-current-time-string nil "" nil
  6223. (format-time-string "%H:%M "))
  6224. new)
  6225. (put-text-property
  6226. 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
  6227. (if (member 'time-up org-agenda-sorting-strategy-selected)
  6228. (append new list)
  6229. (append list new)))))
  6230. (defun org-compile-prefix-format (key)
  6231. "Compile the prefix format into a Lisp form that can be evaluated.
  6232. The resulting form and associated variable bindings is returned
  6233. and stored in the variable `org-prefix-format-compiled'."
  6234. (setq org-prefix-has-time nil
  6235. org-prefix-has-tag nil
  6236. org-prefix-category-length nil
  6237. org-prefix-has-effort nil
  6238. org-prefix-has-breadcrumbs nil)
  6239. (let ((s (cond
  6240. ((stringp org-agenda-prefix-format)
  6241. org-agenda-prefix-format)
  6242. ((assq key org-agenda-prefix-format)
  6243. (cdr (assq key org-agenda-prefix-format)))
  6244. (t " %-12:c%?-12t% s")))
  6245. (start 0)
  6246. varform vars var e c f opt)
  6247. (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cltseib]\\|(.+)\\)"
  6248. s start)
  6249. (setq var (or (cdr (assoc (match-string 4 s)
  6250. '(("c" . category) ("t" . time) ("l" . level) ("s" . extra)
  6251. ("i" . category-icon) ("T" . tag) ("e" . effort) ("b" . breadcrumbs))))
  6252. 'eval)
  6253. c (or (match-string 3 s) "")
  6254. opt (match-beginning 1)
  6255. start (1+ (match-beginning 0)))
  6256. (if (eq var 'time) (setq org-prefix-has-time t))
  6257. (if (eq var 'tag) (setq org-prefix-has-tag t))
  6258. (if (eq var 'effort) (setq org-prefix-has-effort t))
  6259. (if (eq var 'breadcrumbs) (setq org-prefix-has-breadcrumbs t))
  6260. (setq f (concat "%" (match-string 2 s) "s"))
  6261. (when (eq var 'category)
  6262. (setq org-prefix-category-length
  6263. (floor (abs (string-to-number (match-string 2 s)))))
  6264. (setq org-prefix-category-max-length
  6265. (let ((x (match-string 2 s)))
  6266. (save-match-data
  6267. (if (string-match "\\.[0-9]+" x)
  6268. (string-to-number (substring (match-string 0 x) 1)))))))
  6269. (if (eq var 'eval)
  6270. (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
  6271. (if opt
  6272. (setq varform
  6273. `(if (or (equal "" ,var) (equal nil ,var))
  6274. ""
  6275. (format ,f (concat ,var ,c))))
  6276. (setq varform
  6277. `(format ,f (if (or (equal ,var "")
  6278. (equal ,var nil)) ""
  6279. (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
  6280. (setq s (replace-match "%s" t nil s))
  6281. (push varform vars))
  6282. (setq vars (nreverse vars))
  6283. (with-current-buffer (or org-agenda-buffer (current-buffer))
  6284. (setq org-prefix-format-compiled
  6285. (list
  6286. `((org-prefix-has-time ,org-prefix-has-time)
  6287. (org-prefix-has-tag ,org-prefix-has-tag)
  6288. (org-prefix-category-length ,org-prefix-category-length)
  6289. (org-prefix-has-effort ,org-prefix-has-effort)
  6290. (org-prefix-has-breadcrumbs ,org-prefix-has-breadcrumbs))
  6291. `(format ,s ,@vars))))))
  6292. (defun org-set-sorting-strategy (key)
  6293. (if (symbolp (car org-agenda-sorting-strategy))
  6294. ;; the old format
  6295. (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
  6296. (setq org-agenda-sorting-strategy-selected
  6297. (or (cdr (assq key org-agenda-sorting-strategy))
  6298. (cdr (assq 'agenda org-agenda-sorting-strategy))
  6299. '(time-up category-keep priority-down)))))
  6300. (defun org-get-time-of-day (s &optional string mod24)
  6301. "Check string S for a time of day.
  6302. If found, return it as a military time number between 0 and 2400.
  6303. If not found, return nil.
  6304. The optional STRING argument forces conversion into a 5 character wide string
  6305. HH:MM."
  6306. (save-match-data
  6307. (when
  6308. (and
  6309. (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
  6310. (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
  6311. (not (eq (get-text-property 1 'face s) 'org-link)))
  6312. (let* ((h (string-to-number (match-string 1 s)))
  6313. (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
  6314. (ampm (if (match-end 4) (downcase (match-string 4 s))))
  6315. (am-p (equal ampm "am"))
  6316. (h1 (cond ((not ampm) h)
  6317. ((= h 12) (if am-p 0 12))
  6318. (t (+ h (if am-p 0 12)))))
  6319. (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
  6320. (mod h1 24) h1))
  6321. (t0 (+ (* 100 h2) m))
  6322. (t1 (concat (if (>= h1 24) "+" " ")
  6323. (if (and org-agenda-time-leading-zero
  6324. (< t0 1000)) "0" "")
  6325. (if (< t0 100) "0" "")
  6326. (if (< t0 10) "0" "")
  6327. (int-to-string t0))))
  6328. (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
  6329. (defvar org-agenda-before-sorting-filter-function nil
  6330. "Function to be applied to agenda items prior to sorting.
  6331. Prior to sorting also means just before they are inserted into the agenda.
  6332. To aid sorting, you may revisit the original entries and add more text
  6333. properties which will later be used by the sorting functions.
  6334. The function should take a string argument, an agenda line.
  6335. It has access to the text properties in that line, which contain among
  6336. other things, the property `org-hd-marker' that points to the entry
  6337. where the line comes from. Note that not all lines going into the agenda
  6338. have this property, only most.
  6339. The function should return the modified string. It is probably best
  6340. to ONLY change text properties.
  6341. You can also use this function as a filter, by returning nil for lines
  6342. you don't want to have in the agenda at all. For this application, you
  6343. could bind the variable in the options section of a custom command.")
  6344. (defun org-agenda-finalize-entries (list &optional type)
  6345. "Sort, limit and concatenate the LIST of agenda items.
  6346. The optional argument TYPE tells the agenda type."
  6347. (let ((max-effort (cond ((listp org-agenda-max-effort)
  6348. (cdr (assoc type org-agenda-max-effort)))
  6349. (t org-agenda-max-effort)))
  6350. (max-todo (cond ((listp org-agenda-max-todos)
  6351. (cdr (assoc type org-agenda-max-todos)))
  6352. (t org-agenda-max-todos)))
  6353. (max-tags (cond ((listp org-agenda-max-tags)
  6354. (cdr (assoc type org-agenda-max-tags)))
  6355. (t org-agenda-max-tags)))
  6356. (max-entries (cond ((listp org-agenda-max-entries)
  6357. (cdr (assoc type org-agenda-max-entries)))
  6358. (t org-agenda-max-entries))))
  6359. (when org-agenda-before-sorting-filter-function
  6360. (setq list
  6361. (delq nil
  6362. (mapcar
  6363. org-agenda-before-sorting-filter-function list))))
  6364. (setq list (mapcar 'org-agenda-highlight-todo list)
  6365. list (mapcar 'identity (sort list 'org-entries-lessp)))
  6366. (when max-effort
  6367. (setq list (org-agenda-limit-entries
  6368. list 'effort-minutes max-effort
  6369. (lambda (e) (or e (if org-sort-agenda-noeffort-is-high
  6370. 32767 -1))))))
  6371. (when max-todo
  6372. (setq list (org-agenda-limit-entries list 'todo-state max-todo)))
  6373. (when max-tags
  6374. (setq list (org-agenda-limit-entries list 'tags max-tags)))
  6375. (when max-entries
  6376. (setq list (org-agenda-limit-entries list 'org-hd-marker max-entries)))
  6377. (mapconcat 'identity list "\n")))
  6378. (defun org-agenda-limit-entries (list prop limit &optional fn)
  6379. "Limit the number of agenda entries."
  6380. (let ((include (and limit (< limit 0))))
  6381. (if limit
  6382. (let ((fun (or fn (lambda (p) (if p 1))))
  6383. (lim 0))
  6384. (delq nil
  6385. (mapcar
  6386. (lambda (e)
  6387. (let ((pval (funcall
  6388. fun (get-text-property (1- (length e))
  6389. prop e))))
  6390. (if pval (setq lim (+ lim pval)))
  6391. (cond ((and pval (<= lim (abs limit))) e)
  6392. ((and include (not pval)) e))))
  6393. list)))
  6394. list)))
  6395. (defun org-agenda-limit-interactively (remove)
  6396. "In agenda, interactively limit entries to various maximums."
  6397. (interactive "P")
  6398. (if remove
  6399. (progn (setq org-agenda-max-entries nil
  6400. org-agenda-max-todos nil
  6401. org-agenda-max-tags nil
  6402. org-agenda-max-effort nil)
  6403. (org-agenda-redo))
  6404. (let* ((max (read-char "Number of [e]ntries [t]odos [T]ags [E]ffort? "))
  6405. (msg (cond ((= max ?E) "How many minutes? ")
  6406. ((= max ?e) "How many entries? ")
  6407. ((= max ?t) "How many TODO entries? ")
  6408. ((= max ?T) "How many tagged entries? ")
  6409. (t (user-error "Wrong input"))))
  6410. (num (string-to-number (read-from-minibuffer msg))))
  6411. (cond ((equal max ?e)
  6412. (let ((org-agenda-max-entries num)) (org-agenda-redo)))
  6413. ((equal max ?t)
  6414. (let ((org-agenda-max-todos num)) (org-agenda-redo)))
  6415. ((equal max ?T)
  6416. (let ((org-agenda-max-tags num)) (org-agenda-redo)))
  6417. ((equal max ?E)
  6418. (let ((org-agenda-max-effort num)) (org-agenda-redo))))))
  6419. (org-agenda-fit-window-to-buffer))
  6420. (defun org-agenda-highlight-todo (x)
  6421. (let ((org-done-keywords org-done-keywords-for-agenda)
  6422. (case-fold-search nil)
  6423. re)
  6424. (if (eq x 'line)
  6425. (save-excursion
  6426. (beginning-of-line 1)
  6427. (setq re (org-get-at-bol 'org-todo-regexp))
  6428. (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
  6429. (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
  6430. (add-text-properties (match-beginning 0) (match-end 1)
  6431. (list 'face (org-get-todo-face 1)))
  6432. (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
  6433. (delete-region (match-beginning 1) (1- (match-end 0)))
  6434. (goto-char (match-beginning 1))
  6435. (insert (format org-agenda-todo-keyword-format s)))))
  6436. (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
  6437. (setq re (get-text-property 0 'org-todo-regexp x))
  6438. (when (and re
  6439. ;; Test `pl' because if there's no heading content,
  6440. ;; there's no point matching to highlight. Note
  6441. ;; that if we didn't test `pl' first, and there
  6442. ;; happened to be no keyword from `org-todo-regexp'
  6443. ;; on this heading line, then the `equal' comparison
  6444. ;; afterwards would spuriously succeed in the case
  6445. ;; where `pl' is nil -- causing an args-out-of-range
  6446. ;; error when we try to add text properties to text
  6447. ;; that isn't there.
  6448. pl
  6449. (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
  6450. x pl) pl))
  6451. (add-text-properties
  6452. (or (match-end 1) (match-end 0)) (match-end 0)
  6453. (list 'face (org-get-todo-face (match-string 2 x)))
  6454. x)
  6455. (when (match-end 1)
  6456. (setq x (concat (substring x 0 (match-end 1))
  6457. (format org-agenda-todo-keyword-format
  6458. (match-string 2 x))
  6459. (org-add-props " " (text-properties-at 0 x))
  6460. (substring x (match-end 3)))))))
  6461. x)))
  6462. (defsubst org-cmp-values (a b property)
  6463. "Compare the numeric value of text PROPERTY for string A and B."
  6464. (let ((pa (or (get-text-property (1- (length a)) property a) 0))
  6465. (pb (or (get-text-property (1- (length b)) property b) 0)))
  6466. (cond ((> pa pb) +1)
  6467. ((< pa pb) -1))))
  6468. (defsubst org-cmp-effort (a b)
  6469. "Compare the effort values of string A and B."
  6470. (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
  6471. (ea (or (get-text-property (1- (length a)) 'effort-minutes a) def))
  6472. (eb (or (get-text-property (1- (length b)) 'effort-minutes b) def)))
  6473. (cond ((> ea eb) +1)
  6474. ((< ea eb) -1))))
  6475. (defsubst org-cmp-category (a b)
  6476. "Compare the string values of categories of strings A and B."
  6477. (let ((ca (or (get-text-property (1- (length a)) 'org-category a) ""))
  6478. (cb (or (get-text-property (1- (length b)) 'org-category b) "")))
  6479. (cond ((string-lessp ca cb) -1)
  6480. ((string-lessp cb ca) +1))))
  6481. (defsubst org-cmp-todo-state (a b)
  6482. "Compare the todo states of strings A and B."
  6483. (let* ((ma (or (get-text-property 1 'org-marker a)
  6484. (get-text-property 1 'org-hd-marker a)))
  6485. (mb (or (get-text-property 1 'org-marker b)
  6486. (get-text-property 1 'org-hd-marker b)))
  6487. (fa (and ma (marker-buffer ma)))
  6488. (fb (and mb (marker-buffer mb)))
  6489. (todo-kwds
  6490. (or (and fa (with-current-buffer fa org-todo-keywords-1))
  6491. (and fb (with-current-buffer fb org-todo-keywords-1))))
  6492. (ta (or (get-text-property 1 'todo-state a) ""))
  6493. (tb (or (get-text-property 1 'todo-state b) ""))
  6494. (la (- (length (member ta todo-kwds))))
  6495. (lb (- (length (member tb todo-kwds))))
  6496. (donepa (member ta org-done-keywords-for-agenda))
  6497. (donepb (member tb org-done-keywords-for-agenda)))
  6498. (cond ((and donepa (not donepb)) -1)
  6499. ((and (not donepa) donepb) +1)
  6500. ((< la lb) -1)
  6501. ((< lb la) +1))))
  6502. (defsubst org-cmp-alpha (a b)
  6503. "Compare the headlines, alphabetically."
  6504. (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
  6505. (plb (text-property-any 0 (length b) 'org-heading t b))
  6506. (ta (and pla (substring a pla)))
  6507. (tb (and plb (substring b plb))))
  6508. (when pla
  6509. (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
  6510. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
  6511. (setq ta (substring ta (match-end 0))))
  6512. (setq ta (downcase ta)))
  6513. (when plb
  6514. (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
  6515. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
  6516. (setq tb (substring tb (match-end 0))))
  6517. (setq tb (downcase tb)))
  6518. (cond ((not ta) +1)
  6519. ((not tb) -1)
  6520. ((string-lessp ta tb) -1)
  6521. ((string-lessp tb ta) +1))))
  6522. (defsubst org-cmp-tag (a b)
  6523. "Compare the string values of the first tags of A and B."
  6524. (let ((ta (car (last (get-text-property 1 'tags a))))
  6525. (tb (car (last (get-text-property 1 'tags b)))))
  6526. (cond ((not ta) +1)
  6527. ((not tb) -1)
  6528. ((string-lessp ta tb) -1)
  6529. ((string-lessp tb ta) +1))))
  6530. (defsubst org-cmp-time (a b)
  6531. "Compare the time-of-day values of strings A and B."
  6532. (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
  6533. (ta (or (get-text-property 1 'time-of-day a) def))
  6534. (tb (or (get-text-property 1 'time-of-day b) def)))
  6535. (cond ((< ta tb) -1)
  6536. ((< tb ta) +1))))
  6537. (defsubst org-cmp-ts (a b type)
  6538. "Compare the timestamps values of entries A and B.
  6539. When TYPE is \"scheduled\", \"deadline\", \"timestamp\" or
  6540. \"timestamp_ia\", compare within each of these type. When TYPE
  6541. is the empty string, compare all timestamps without respect of
  6542. their type."
  6543. (let* ((def (if org-sort-agenda-notime-is-late most-positive-fixnum -1))
  6544. (ta (or (and (string-match type (or (get-text-property 1 'type a) ""))
  6545. (get-text-property 1 'ts-date a))
  6546. def))
  6547. (tb (or (and (string-match type (or (get-text-property 1 'type b) ""))
  6548. (get-text-property 1 'ts-date b))
  6549. def)))
  6550. (cond ((< ta tb) -1)
  6551. ((< tb ta) +1))))
  6552. (defsubst org-cmp-habit-p (a b)
  6553. "Compare the todo states of strings A and B."
  6554. (let ((ha (get-text-property 1 'org-habit-p a))
  6555. (hb (get-text-property 1 'org-habit-p b)))
  6556. (cond ((and ha (not hb)) -1)
  6557. ((and (not ha) hb) +1))))
  6558. (defun org-entries-lessp (a b)
  6559. "Predicate for sorting agenda entries."
  6560. ;; The following variables will be used when the form is evaluated.
  6561. ;; So even though the compiler complains, keep them.
  6562. (let* ((ss org-agenda-sorting-strategy-selected)
  6563. (timestamp-up (and (org-em 'timestamp-up 'timestamp-down ss)
  6564. (org-cmp-ts a b "")))
  6565. (timestamp-down (if timestamp-up (- timestamp-up) nil))
  6566. (scheduled-up (and (org-em 'scheduled-up 'scheduled-down ss)
  6567. (org-cmp-ts a b "scheduled")))
  6568. (scheduled-down (if scheduled-up (- scheduled-up) nil))
  6569. (deadline-up (and (org-em 'deadline-up 'deadline-down ss)
  6570. (org-cmp-ts a b "deadline")))
  6571. (deadline-down (if deadline-up (- deadline-up) nil))
  6572. (tsia-up (and (org-em 'tsia-up 'tsia-down ss)
  6573. (org-cmp-ts a b "timestamp_ia")))
  6574. (tsia-down (if tsia-up (- tsia-up) nil))
  6575. (ts-up (and (org-em 'ts-up 'ts-down ss)
  6576. (org-cmp-ts a b "timestamp")))
  6577. (ts-down (if ts-up (- ts-up) nil))
  6578. (time-up (and (org-em 'time-up 'time-down ss)
  6579. (org-cmp-time a b)))
  6580. (time-down (if time-up (- time-up) nil))
  6581. (stats-up (and (org-em 'stats-up 'stats-down ss)
  6582. (org-cmp-values a b 'org-stats)))
  6583. (stats-down (if stats-up (- stats-up) nil))
  6584. (priority-up (and (org-em 'priority-up 'priority-down ss)
  6585. (org-cmp-values a b 'priority)))
  6586. (priority-down (if priority-up (- priority-up) nil))
  6587. (effort-up (and (org-em 'effort-up 'effort-down ss)
  6588. (org-cmp-effort a b)))
  6589. (effort-down (if effort-up (- effort-up) nil))
  6590. (category-up (and (or (org-em 'category-up 'category-down ss)
  6591. (memq 'category-keep ss))
  6592. (org-cmp-category a b)))
  6593. (category-down (if category-up (- category-up) nil))
  6594. (category-keep (if category-up +1 nil))
  6595. (tag-up (and (org-em 'tag-up 'tag-down ss)
  6596. (org-cmp-tag a b)))
  6597. (tag-down (if tag-up (- tag-up) nil))
  6598. (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
  6599. (org-cmp-todo-state a b)))
  6600. (todo-state-down (if todo-state-up (- todo-state-up) nil))
  6601. (habit-up (and (org-em 'habit-up 'habit-down ss)
  6602. (org-cmp-habit-p a b)))
  6603. (habit-down (if habit-up (- habit-up) nil))
  6604. (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
  6605. (org-cmp-alpha a b)))
  6606. (alpha-down (if alpha-up (- alpha-up) nil))
  6607. (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
  6608. user-defined-up user-defined-down)
  6609. (if (and need-user-cmp org-agenda-cmp-user-defined
  6610. (functionp org-agenda-cmp-user-defined))
  6611. (setq user-defined-up
  6612. (funcall org-agenda-cmp-user-defined a b)
  6613. user-defined-down (if user-defined-up (- user-defined-up) nil)))
  6614. (cdr (assoc
  6615. (eval (cons 'or org-agenda-sorting-strategy-selected))
  6616. '((-1 . t) (1 . nil) (nil . nil))))))
  6617. ;;; Agenda restriction lock
  6618. (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
  6619. "Overlay to mark the headline to which agenda commands are restricted.")
  6620. (overlay-put org-agenda-restriction-lock-overlay
  6621. 'face 'org-agenda-restriction-lock)
  6622. (overlay-put org-agenda-restriction-lock-overlay
  6623. 'help-echo "Agendas are currently limited to this subtree.")
  6624. (delete-overlay org-agenda-restriction-lock-overlay)
  6625. ;;;###autoload
  6626. (defun org-agenda-set-restriction-lock (&optional type)
  6627. "Set restriction lock for agenda, to current subtree or file.
  6628. Restriction will be the file if TYPE is `file', or if type is the
  6629. universal prefix \\='(4), or if the cursor is before the first headline
  6630. in the file. Otherwise, restriction will be to the current subtree."
  6631. (interactive "P")
  6632. (org-agenda-remove-restriction-lock 'noupdate)
  6633. (and (equal type '(4)) (setq type 'file))
  6634. (setq type (cond
  6635. (type type)
  6636. ((org-at-heading-p) 'subtree)
  6637. ((condition-case nil (org-back-to-heading t) (error nil))
  6638. 'subtree)
  6639. (t 'file)))
  6640. (if (eq type 'subtree)
  6641. (progn
  6642. (setq org-agenda-restrict (current-buffer))
  6643. (setq org-agenda-overriding-restriction 'subtree)
  6644. (put 'org-agenda-files 'org-restrict
  6645. (list (buffer-file-name (buffer-base-buffer))))
  6646. (org-back-to-heading t)
  6647. (move-overlay org-agenda-restriction-lock-overlay
  6648. (point)
  6649. (if org-agenda-restriction-lock-highlight-subtree
  6650. (save-excursion (org-end-of-subtree t t) (point))
  6651. (point-at-eol)))
  6652. (move-marker org-agenda-restrict-begin (point))
  6653. (move-marker org-agenda-restrict-end
  6654. (save-excursion (org-end-of-subtree t t)))
  6655. (message "Locking agenda restriction to subtree"))
  6656. (put 'org-agenda-files 'org-restrict
  6657. (list (buffer-file-name (buffer-base-buffer))))
  6658. (setq org-agenda-restrict nil)
  6659. (setq org-agenda-overriding-restriction 'file)
  6660. (move-marker org-agenda-restrict-begin nil)
  6661. (move-marker org-agenda-restrict-end nil)
  6662. (message "Locking agenda restriction to file"))
  6663. (setq current-prefix-arg nil)
  6664. (org-agenda-maybe-redo))
  6665. (defun org-agenda-remove-restriction-lock (&optional noupdate)
  6666. "Remove the agenda restriction lock."
  6667. (interactive "P")
  6668. (delete-overlay org-agenda-restriction-lock-overlay)
  6669. (delete-overlay org-speedbar-restriction-lock-overlay)
  6670. (setq org-agenda-overriding-restriction nil)
  6671. (setq org-agenda-restrict nil)
  6672. (put 'org-agenda-files 'org-restrict nil)
  6673. (move-marker org-agenda-restrict-begin nil)
  6674. (move-marker org-agenda-restrict-end nil)
  6675. (setq current-prefix-arg nil)
  6676. (message "Agenda restriction lock removed")
  6677. (or noupdate (org-agenda-maybe-redo)))
  6678. (defun org-agenda-maybe-redo ()
  6679. "If there is any window showing the agenda view, update it."
  6680. (let ((w (get-buffer-window (or org-agenda-this-buffer-name
  6681. org-agenda-buffer-name)
  6682. t))
  6683. (w0 (selected-window)))
  6684. (when w
  6685. (select-window w)
  6686. (org-agenda-redo)
  6687. (select-window w0)
  6688. (if org-agenda-overriding-restriction
  6689. (message "Agenda view shifted to new %s restriction"
  6690. org-agenda-overriding-restriction)
  6691. (message "Agenda restriction lock removed")))))
  6692. ;;; Agenda commands
  6693. (defun org-agenda-check-type (error &rest types)
  6694. "Check if agenda buffer is of allowed type.
  6695. If ERROR is non-nil, throw an error, otherwise just return nil.
  6696. Allowed types are `agenda' `timeline' `todo' `tags' `search'."
  6697. (if (not org-agenda-type)
  6698. (error "No Org agenda currently displayed")
  6699. (if (memq org-agenda-type types)
  6700. t
  6701. (if error
  6702. (error "Not allowed in %s-type agenda buffers" org-agenda-type)
  6703. nil))))
  6704. (defun org-agenda-Quit ()
  6705. "Exit the agenda, killing the agenda buffer.
  6706. Like `org-agenda-quit', but kill the buffer even when
  6707. `org-agenda-sticky' is non-nil."
  6708. (interactive)
  6709. (org-agenda--quit))
  6710. (defun org-agenda-quit ()
  6711. "Exit the agenda.
  6712. When `org-agenda-sticky' is non-nil, bury the agenda buffer
  6713. instead of killing it.
  6714. When `org-agenda-restore-windows-after-quit' is non-nil, restore
  6715. the pre-agenda window configuration.
  6716. When column view is active, exit column view instead of the
  6717. agenda."
  6718. (interactive)
  6719. (org-agenda--quit org-agenda-sticky))
  6720. (defun org-agenda--quit (&optional bury)
  6721. (if org-agenda-columns-active
  6722. (org-columns-quit)
  6723. (let ((wconf org-agenda-pre-window-conf)
  6724. (buf (current-buffer))
  6725. (org-agenda-last-indirect-window
  6726. (and (eq org-indirect-buffer-display 'other-window)
  6727. org-agenda-last-indirect-buffer
  6728. (get-buffer-window org-agenda-last-indirect-buffer))))
  6729. (cond
  6730. ((eq org-agenda-window-setup 'other-frame)
  6731. (delete-frame))
  6732. ((and org-agenda-restore-windows-after-quit
  6733. wconf)
  6734. ;; Maybe restore the pre-agenda window configuration. Reset
  6735. ;; `org-agenda-pre-window-conf' before running
  6736. ;; `set-window-configuration', which loses the current buffer.
  6737. (setq org-agenda-pre-window-conf nil)
  6738. (set-window-configuration wconf))
  6739. (t
  6740. (when org-agenda-last-indirect-window
  6741. (delete-window org-agenda-last-indirect-window))
  6742. (and (not (eq org-agenda-window-setup 'current-window))
  6743. (not (one-window-p))
  6744. (delete-window))))
  6745. (if bury
  6746. ;; Set the agenda buffer as the current buffer instead of
  6747. ;; passing it as an argument to `bury-buffer' so that
  6748. ;; `bury-buffer' removes it from the window.
  6749. (with-current-buffer buf
  6750. (bury-buffer))
  6751. (kill-buffer buf)
  6752. (setq org-agenda-archives-mode nil
  6753. org-agenda-buffer nil)))))
  6754. (defun org-agenda-exit ()
  6755. "Exit the agenda, killing Org buffers loaded by the agenda.
  6756. Like `org-agenda-Quit', but kill any buffers that were created by
  6757. the agenda. Org buffers visited directly by the user will not be
  6758. touched. Also, exit the agenda even if it is in column view."
  6759. (interactive)
  6760. (when org-agenda-columns-active
  6761. (org-columns-quit))
  6762. (org-release-buffers org-agenda-new-buffers)
  6763. (setq org-agenda-new-buffers nil)
  6764. (org-agenda-Quit))
  6765. (defun org-agenda-kill-all-agenda-buffers ()
  6766. "Kill all buffers in `org-agenda-mode'.
  6767. This is used when toggling sticky agendas."
  6768. (interactive)
  6769. (let (blist)
  6770. (dolist (buf (buffer-list))
  6771. (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
  6772. (push buf blist)))
  6773. (mapc 'kill-buffer blist)))
  6774. (defun org-agenda-execute (arg)
  6775. "Execute another agenda command, keeping same window.
  6776. So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
  6777. in the agenda."
  6778. (interactive "P")
  6779. (let ((org-agenda-window-setup 'current-window))
  6780. (org-agenda arg)))
  6781. (defun org-agenda-redo (&optional all)
  6782. "Rebuild possibly ALL agenda view(s) in the current buffer."
  6783. (interactive "P")
  6784. (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
  6785. (cpa (unless (eq all t) current-prefix-arg))
  6786. (org-agenda-doing-sticky-redo org-agenda-sticky)
  6787. (org-agenda-sticky nil)
  6788. (org-agenda-buffer-name (or org-agenda-this-buffer-name
  6789. org-agenda-buffer-name))
  6790. (org-agenda-keep-modes t)
  6791. (tag-filter org-agenda-tag-filter)
  6792. (tag-preset (get 'org-agenda-tag-filter :preset-filter))
  6793. (top-hl-filter org-agenda-top-headline-filter)
  6794. (cat-filter org-agenda-category-filter)
  6795. (cat-preset (get 'org-agenda-category-filter :preset-filter))
  6796. (re-filter org-agenda-regexp-filter)
  6797. (re-preset (get 'org-agenda-regexp-filter :preset-filter))
  6798. (effort-filter org-agenda-effort-filter)
  6799. (effort-preset (get 'org-agenda-effort-filter :preset-filter))
  6800. (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
  6801. (cols org-agenda-columns-active)
  6802. (line (org-current-line))
  6803. (window-line (- line (org-current-line (window-start))))
  6804. (lprops (get 'org-agenda-redo-command 'org-lprops))
  6805. (redo-cmd (get-text-property p 'org-redo-cmd))
  6806. (last-args (get-text-property p 'org-last-args))
  6807. (org-agenda-overriding-cmd (get-text-property p 'org-series-cmd))
  6808. (org-agenda-overriding-cmd-arguments
  6809. (unless (eq all t)
  6810. (cond ((listp last-args)
  6811. (cons (or cpa (car last-args)) (cdr last-args)))
  6812. ((stringp last-args)
  6813. last-args))))
  6814. (series-redo-cmd (get-text-property p 'org-series-redo-cmd)))
  6815. (put 'org-agenda-tag-filter :preset-filter nil)
  6816. (put 'org-agenda-category-filter :preset-filter nil)
  6817. (put 'org-agenda-regexp-filter :preset-filter nil)
  6818. (put 'org-agenda-effort-filter :preset-filter nil)
  6819. (and cols (org-columns-quit))
  6820. (message "Rebuilding agenda buffer...")
  6821. (if series-redo-cmd
  6822. (eval series-redo-cmd)
  6823. (org-let lprops redo-cmd))
  6824. (setq org-agenda-undo-list nil
  6825. org-agenda-pending-undo-list nil
  6826. org-agenda-tag-filter tag-filter
  6827. org-agenda-category-filter cat-filter
  6828. org-agenda-regexp-filter re-filter
  6829. org-agenda-effort-filter effort-filter
  6830. org-agenda-top-headline-filter top-hl-filter)
  6831. (message "Rebuilding agenda buffer...done")
  6832. (put 'org-agenda-tag-filter :preset-filter tag-preset)
  6833. (put 'org-agenda-category-filter :preset-filter cat-preset)
  6834. (put 'org-agenda-regexp-filter :preset-filter re-preset)
  6835. (put 'org-agenda-effort-filter :preset-filter effort-preset)
  6836. (let ((tag (or tag-filter tag-preset))
  6837. (cat (or cat-filter cat-preset))
  6838. (effort (or effort-filter effort-preset))
  6839. (re (or re-filter re-preset)))
  6840. (when tag (org-agenda-filter-apply tag 'tag t))
  6841. (when cat (org-agenda-filter-apply cat 'category))
  6842. (when effort (org-agenda-filter-apply effort 'effort))
  6843. (when re (org-agenda-filter-apply re 'regexp)))
  6844. (and top-hl-filter (org-agenda-filter-top-headline-apply top-hl-filter))
  6845. (and cols (called-interactively-p 'any) (org-agenda-columns))
  6846. (org-goto-line line)
  6847. (recenter window-line)))
  6848. (defvar org-global-tags-completion-table nil)
  6849. (defvar org-agenda-filter-form nil)
  6850. (defvar org-agenda-filtered-by-category nil)
  6851. (defun org-agenda-filter-by-category (strip)
  6852. "Filter lines in the agenda buffer that have a specific category.
  6853. The category is that of the current line.
  6854. Without prefix argument, keep only the lines of that category.
  6855. With a prefix argument, exclude the lines of that category.
  6856. "
  6857. (interactive "P")
  6858. (if (and org-agenda-filtered-by-category
  6859. org-agenda-category-filter)
  6860. (org-agenda-filter-show-all-cat)
  6861. (let ((cat (org-no-properties (org-get-at-eol 'org-category 1))))
  6862. (cond
  6863. ((and cat strip)
  6864. (org-agenda-filter-apply
  6865. (push (concat "-" cat) org-agenda-category-filter) 'category))
  6866. (cat
  6867. (org-agenda-filter-apply
  6868. (setq org-agenda-category-filter
  6869. (list (concat "+" cat))) 'category))
  6870. (t (error "No category at point"))))))
  6871. (defun org-find-top-headline (&optional pos)
  6872. "Find the topmost parent headline and return it."
  6873. (save-excursion
  6874. (with-current-buffer (if pos (marker-buffer pos) (current-buffer))
  6875. (if pos (goto-char pos))
  6876. ;; Skip up to the topmost parent
  6877. (while (ignore-errors (outline-up-heading 1) t))
  6878. (ignore-errors
  6879. (nth 4 (org-heading-components))))))
  6880. (defvar org-agenda-filtered-by-top-headline nil)
  6881. (defun org-agenda-filter-by-top-headline (strip)
  6882. "Keep only those lines that are descendants from the same top headline.
  6883. The top headline is that of the current line."
  6884. (interactive "P")
  6885. (if org-agenda-filtered-by-top-headline
  6886. (progn
  6887. (setq org-agenda-filtered-by-top-headline nil
  6888. org-agenda-top-headline-filter nil)
  6889. (org-agenda-filter-show-all-top-filter))
  6890. (let ((toph (org-find-top-headline (org-get-at-bol 'org-hd-marker))))
  6891. (if toph (org-agenda-filter-top-headline-apply toph strip)
  6892. (error "No top-level headline at point")))))
  6893. (defvar org-agenda-regexp-filter nil)
  6894. (defun org-agenda-filter-by-regexp (strip)
  6895. "Filter agenda entries by a regular expression.
  6896. Regexp filters are cumulative.
  6897. With no prefix argument, keep entries matching the regexp.
  6898. With one prefix argument, filter out entries matching the regexp.
  6899. With two prefix arguments, remove the regexp filters."
  6900. (interactive "P")
  6901. (if (not (equal strip '(16)))
  6902. (let ((flt (concat (if (equal strip '(4)) "-" "+")
  6903. (read-from-minibuffer
  6904. (if (equal strip '(4))
  6905. "Filter out entries matching regexp: "
  6906. "Narrow to entries matching regexp: ")))))
  6907. (push flt org-agenda-regexp-filter)
  6908. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
  6909. (org-agenda-filter-show-all-re)
  6910. (message "Regexp filter removed")))
  6911. (defvar org-agenda-effort-filter nil)
  6912. (defun org-agenda-filter-by-effort (strip)
  6913. "Filter agenda entries by effort.
  6914. With no prefix argument, keep entries matching the effort condition.
  6915. With one prefix argument, filter out entries matching the condition.
  6916. With two prefix arguments, remove the effort filters."
  6917. (interactive "P")
  6918. (cond ((member strip '(nil 4))
  6919. (let ((efforts (org-split-string
  6920. (or (cdr (assoc (concat org-effort-property "_ALL")
  6921. org-global-properties))
  6922. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00"
  6923. "")))
  6924. (eff -1)
  6925. effort-prompt op)
  6926. (while (not (member op '(?< ?> ?=)))
  6927. (setq op (read-char-exclusive "Effort operator? (> = or <)")))
  6928. (cl-loop for i from 0 to 9 do
  6929. (setq effort-prompt
  6930. (concat
  6931. effort-prompt " ["
  6932. (if (= i 9) "0" (int-to-string (1+ i)))
  6933. "]" (nth i efforts))))
  6934. (message "Effort %s%s" (char-to-string op) effort-prompt)
  6935. (while (or (< eff 0) (> eff 9))
  6936. (setq eff (string-to-number (char-to-string (read-char-exclusive)))))
  6937. (setq org-agenda-effort-filter
  6938. (list (concat (if strip "-" "+")
  6939. (char-to-string op) (nth (1- eff) efforts))))
  6940. (org-agenda-filter-apply org-agenda-effort-filter 'effort)))
  6941. (t (org-agenda-filter-show-all-effort)
  6942. (message "Effort filter removed"))))
  6943. (defun org-agenda-filter-remove-all ()
  6944. "Remove all filters from the current agenda buffer."
  6945. (interactive)
  6946. (when org-agenda-tag-filter
  6947. (org-agenda-filter-show-all-tag))
  6948. (when org-agenda-category-filter
  6949. (org-agenda-filter-show-all-cat))
  6950. (when org-agenda-regexp-filter
  6951. (org-agenda-filter-show-all-re))
  6952. (when org-agenda-top-headline-filter
  6953. (org-agenda-filter-show-all-top-filter))
  6954. (when org-agenda-effort-filter
  6955. (org-agenda-filter-show-all-effort))
  6956. (org-agenda-finalize))
  6957. (defun org-agenda-filter-by-tag (arg &optional char exclude)
  6958. "Keep only those lines in the agenda buffer that have a specific tag.
  6959. The tag is selected with its fast selection letter, as configured.
  6960. With a single \\[universal-argument] prefix ARG, exclude the agenda search.
  6961. With a double \\[universal-argument] prefix ARG, filter the literal tag, \
  6962. i.e. don't
  6963. filter on all its group members.
  6964. A lisp caller can specify CHAR. EXCLUDE means that the new tag
  6965. should be used to exclude the search - the interactive user can
  6966. also press `-' or `+' to switch between filtering and excluding."
  6967. (interactive "P")
  6968. (let* ((alist org-tag-alist-for-agenda)
  6969. (tag-chars (mapconcat
  6970. (lambda (x) (if (and (not (symbolp (car x)))
  6971. (cdr x))
  6972. (char-to-string (cdr x))
  6973. ""))
  6974. org-tag-alist-for-agenda ""))
  6975. (valid-char-list (append '(?\t ?\r ?/ ?. ?\s ?q)
  6976. (string-to-list tag-chars)))
  6977. (exclude (or exclude (equal arg '(4))))
  6978. (expand (not (equal arg '(16))))
  6979. (inhibit-read-only t)
  6980. (current org-agenda-tag-filter)
  6981. a n tag)
  6982. (unless char
  6983. (while (not (memq char valid-char-list))
  6984. (message
  6985. "%s by tag [%s ], [TAB], %s[/]:off, [+/-]:filter/exclude%s, [q]:quit"
  6986. (if exclude "Exclude" "Filter") tag-chars
  6987. (if org-agenda-auto-exclude-function "[RET], " "")
  6988. (if expand "" ", no grouptag expand"))
  6989. (setq char (read-char-exclusive))
  6990. ;; Excluding or filtering down
  6991. (cond ((eq char ?-) (setq exclude t))
  6992. ((eq char ?+) (setq exclude nil)))))
  6993. (when (eq char ?\t)
  6994. (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
  6995. (setq-local org-global-tags-completion-table
  6996. (org-global-tags-completion-table)))
  6997. (let ((completion-ignore-case t))
  6998. (setq tag (completing-read
  6999. "Tag: " org-global-tags-completion-table))))
  7000. (cond
  7001. ((eq char ?\r)
  7002. (org-agenda-filter-show-all-tag)
  7003. (when org-agenda-auto-exclude-function
  7004. (setq org-agenda-tag-filter nil)
  7005. (dolist (tag (org-agenda-get-represented-tags))
  7006. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  7007. (if modifier
  7008. (push modifier org-agenda-tag-filter))))
  7009. (if (not (null org-agenda-tag-filter))
  7010. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))))
  7011. ((eq char ?/)
  7012. (org-agenda-filter-show-all-tag)
  7013. (when (get 'org-agenda-tag-filter :preset-filter)
  7014. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand)))
  7015. ((eq char ?.)
  7016. (setq org-agenda-tag-filter
  7017. (mapcar (lambda(tag) (concat "+" tag))
  7018. (org-get-at-bol 'tags)))
  7019. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  7020. ((eq char ?q)) ;If q, abort (even if there is a q-key for a tag...)
  7021. ((or (eq char ?\s)
  7022. (setq a (rassoc char alist))
  7023. (and tag (setq a (cons tag nil))))
  7024. (org-agenda-filter-show-all-tag)
  7025. (setq tag (car a))
  7026. (setq org-agenda-tag-filter
  7027. (cons (concat (if exclude "-" "+") tag)
  7028. current))
  7029. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  7030. (t (error "Invalid tag selection character %c" char)))))
  7031. (defun org-agenda-get-represented-tags ()
  7032. "Get a list of all tags currently represented in the agenda."
  7033. (let (p tags)
  7034. (save-excursion
  7035. (goto-char (point-min))
  7036. (while (setq p (next-single-property-change (point) 'tags))
  7037. (goto-char p)
  7038. (mapc (lambda (x) (add-to-list 'tags x))
  7039. (get-text-property (point) 'tags))))
  7040. tags))
  7041. (defun org-agenda-filter-make-matcher (filter type &optional expand)
  7042. "Create the form that tests a line for agenda filter. Optional
  7043. argument EXPAND can be used for the TYPE tag and will expand the
  7044. tags in the FILTER if any of the tags in FILTER are grouptags."
  7045. (let (f f1)
  7046. (cond
  7047. ;; Tag filter
  7048. ((eq type 'tag)
  7049. (setq filter
  7050. (delete-dups
  7051. (append (get 'org-agenda-tag-filter :preset-filter)
  7052. filter)))
  7053. (dolist (x filter)
  7054. (let ((op (string-to-char x)))
  7055. (if expand (setq x (org-agenda-filter-expand-tags (list x) t))
  7056. (setq x (list x)))
  7057. (setq f1 (org-agenda-filter-make-matcher-tag-exp x op))
  7058. (push f1 f))))
  7059. ;; Category filter
  7060. ((eq type 'category)
  7061. (setq filter
  7062. (delete-dups
  7063. (append (get 'org-agenda-category-filter :preset-filter)
  7064. filter)))
  7065. (dolist (x filter)
  7066. (if (equal "-" (substring x 0 1))
  7067. (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
  7068. (setq f1 (list 'equal (substring x 1) 'cat)))
  7069. (push f1 f)))
  7070. ;; Regexp filter
  7071. ((eq type 'regexp)
  7072. (setq filter
  7073. (delete-dups
  7074. (append (get 'org-agenda-regexp-filter :preset-filter)
  7075. filter)))
  7076. (dolist (x filter)
  7077. (if (equal "-" (substring x 0 1))
  7078. (setq f1 (list 'not (list 'string-match (substring x 1) 'txt)))
  7079. (setq f1 (list 'string-match (substring x 1) 'txt)))
  7080. (push f1 f)))
  7081. ;; Effort filter
  7082. ((eq type 'effort)
  7083. (setq filter
  7084. (delete-dups
  7085. (append (get 'org-agenda-effort-filter :preset-filter)
  7086. filter)))
  7087. (dolist (x filter)
  7088. (push (org-agenda-filter-effort-form x) f))))
  7089. (cons 'and (nreverse f))))
  7090. (defun org-agenda-filter-make-matcher-tag-exp (tags op)
  7091. "Return a form associated to tag-expression TAGS.
  7092. Build a form testing a line for agenda filter for
  7093. tag-expressions. OP is an operator of type CHAR that allows the
  7094. function to set the right switches in the returned form."
  7095. (let (form)
  7096. ;; Any of the expressions can match if OP is +, all must match if
  7097. ;; the operator is -.
  7098. (dolist (x tags (cons (if (eq op ?-) 'and 'or) form))
  7099. (let* ((tag (substring x 1))
  7100. (f (cond
  7101. ((string= "" tag) '(not tags))
  7102. ((and (string-match-p "\\`{" tag) (string-match-p "}\\'" tag))
  7103. ;; TAG is a regexp.
  7104. (list 'org-match-any-p (substring tag 1 -1) 'tags))
  7105. (t (list 'member (downcase tag) 'tags)))))
  7106. (push (if (eq op ?-) (list 'not f) f) form)))))
  7107. (defun org-agenda-filter-effort-form (e)
  7108. "Return the form to compare the effort of the current line with what E says.
  7109. E looks like \"+<2:25\"."
  7110. (let (op)
  7111. (setq e (substring e 1))
  7112. (setq op (string-to-char e) e (substring e 1))
  7113. (setq op (cond ((equal op ?<) '<=)
  7114. ((equal op ?>) '>=)
  7115. ((equal op ??) op)
  7116. (t '=)))
  7117. (list 'org-agenda-compare-effort (list 'quote op)
  7118. (org-duration-string-to-minutes e))))
  7119. (defun org-agenda-compare-effort (op value)
  7120. "Compare the effort of the current line with VALUE, using OP.
  7121. If the line does not have an effort defined, return nil."
  7122. (let ((eff (org-get-at-eol 'effort-minutes 1)))
  7123. (funcall op (or eff (if org-sort-agenda-noeffort-is-high 32767 -1))
  7124. value)))
  7125. (defun org-agenda-filter-expand-tags (filter &optional no-operator)
  7126. "Expand group tags in FILTER for the agenda.
  7127. When NO-OPERATOR is non-nil, do not add the + operator to returned tags."
  7128. (if org-group-tags
  7129. (let ((case-fold-search t) rtn)
  7130. (mapc
  7131. (lambda (f)
  7132. (let (f0 dir)
  7133. (if (string-match "^\\([+-]\\)\\(.+\\)" f)
  7134. (setq dir (match-string 1 f) f0 (match-string 2 f))
  7135. (setq dir (if no-operator "" "+") f0 f))
  7136. (setq rtn (append (mapcar (lambda(f1) (concat dir f1))
  7137. (org-tags-expand f0 t t))
  7138. rtn))))
  7139. filter)
  7140. (reverse rtn))
  7141. filter))
  7142. (defun org-agenda-filter-apply (filter type &optional expand)
  7143. "Set FILTER as the new agenda filter and apply it. Optional
  7144. argument EXPAND can be used for the TYPE tag and will expand the
  7145. tags in the FILTER if any of the tags in FILTER are grouptags."
  7146. ;; Deactivate `org-agenda-entry-text-mode' when filtering
  7147. (if org-agenda-entry-text-mode (org-agenda-entry-text-mode))
  7148. (let (tags cat txt)
  7149. (setq org-agenda-filter-form (org-agenda-filter-make-matcher filter type expand))
  7150. ;; Only set `org-agenda-filtered-by-category' to t when a unique
  7151. ;; category is used as the filter:
  7152. (setq org-agenda-filtered-by-category
  7153. (and (eq type 'category)
  7154. (not (equal (substring (car filter) 0 1) "-"))))
  7155. (org-agenda-set-mode-name)
  7156. (save-excursion
  7157. (goto-char (point-min))
  7158. (while (not (eobp))
  7159. (if (org-get-at-bol 'org-marker)
  7160. (progn
  7161. (setq tags (org-get-at-bol 'tags)
  7162. cat (org-get-at-eol 'org-category 1)
  7163. txt (org-get-at-bol 'txt))
  7164. (if (not (eval org-agenda-filter-form))
  7165. (org-agenda-filter-hide-line type))
  7166. (beginning-of-line 2))
  7167. (beginning-of-line 2))))
  7168. (if (get-char-property (point) 'invisible)
  7169. (ignore-errors (org-agenda-previous-line)))))
  7170. (defun org-agenda-filter-top-headline-apply (hl &optional negative)
  7171. "Filter by top headline HL."
  7172. (org-agenda-set-mode-name)
  7173. (save-excursion
  7174. (goto-char (point-min))
  7175. (while (not (eobp))
  7176. (let* ((pos (org-get-at-bol 'org-hd-marker))
  7177. (tophl (and pos (org-find-top-headline pos))))
  7178. (if (and tophl (funcall (if negative 'identity 'not)
  7179. (string= hl tophl)))
  7180. (org-agenda-filter-hide-line 'top-headline)))
  7181. (beginning-of-line 2)))
  7182. (if (get-char-property (point) 'invisible)
  7183. (org-agenda-previous-line))
  7184. (setq org-agenda-top-headline-filter hl
  7185. org-agenda-filtered-by-top-headline t))
  7186. (defun org-agenda-filter-hide-line (type)
  7187. "Hide lines with TYPE in the agenda buffer."
  7188. (let* ((b (max (point-min) (1- (point-at-bol))))
  7189. (e (point-at-eol)))
  7190. (let ((inhibit-read-only t))
  7191. (add-text-properties
  7192. b e `(invisible org-filtered org-filter-type ,type)))))
  7193. (defun org-agenda-remove-filter (type)
  7194. (interactive)
  7195. "Remove filter of type TYPE from the agenda buffer."
  7196. (save-excursion
  7197. (goto-char (point-min))
  7198. (let ((inhibit-read-only t) pos)
  7199. (while (setq pos (text-property-any (point) (point-max) 'org-filter-type type))
  7200. (goto-char pos)
  7201. (remove-text-properties
  7202. (point) (next-single-property-change (point) 'org-filter-type)
  7203. `(invisible org-filtered org-filter-type ,type))))
  7204. (set (intern (format "org-agenda-%s-filter" (intern-soft type))) nil)
  7205. (setq org-agenda-filter-form nil)
  7206. (org-agenda-set-mode-name)
  7207. (org-agenda-finalize)))
  7208. (defun org-agenda-filter-show-all-tag nil
  7209. (org-agenda-remove-filter 'tag))
  7210. (defun org-agenda-filter-show-all-re nil
  7211. (org-agenda-remove-filter 'regexp))
  7212. (defun org-agenda-filter-show-all-effort nil
  7213. (org-agenda-remove-filter 'effort))
  7214. (defun org-agenda-filter-show-all-cat nil
  7215. (org-agenda-remove-filter 'category))
  7216. (defun org-agenda-filter-show-all-top-filter nil
  7217. (org-agenda-remove-filter 'top-headline))
  7218. (defun org-agenda-manipulate-query-add ()
  7219. "Manipulate the query by adding a search term with positive selection.
  7220. Positive selection means the term must be matched for selection of an entry."
  7221. (interactive)
  7222. (org-agenda-manipulate-query ?\[))
  7223. (defun org-agenda-manipulate-query-subtract ()
  7224. "Manipulate the query by adding a search term with negative selection.
  7225. Negative selection means term must not be matched for selection of an entry."
  7226. (interactive)
  7227. (org-agenda-manipulate-query ?\]))
  7228. (defun org-agenda-manipulate-query-add-re ()
  7229. "Manipulate the query by adding a search regexp with positive selection.
  7230. Positive selection means the regexp must match for selection of an entry."
  7231. (interactive)
  7232. (org-agenda-manipulate-query ?\{))
  7233. (defun org-agenda-manipulate-query-subtract-re ()
  7234. "Manipulate the query by adding a search regexp with negative selection.
  7235. Negative selection means regexp must not match for selection of an entry."
  7236. (interactive)
  7237. (org-agenda-manipulate-query ?\}))
  7238. (defun org-agenda-manipulate-query (char)
  7239. (cond
  7240. ((memq org-agenda-type '(timeline agenda))
  7241. (let ((org-agenda-include-inactive-timestamps t))
  7242. (org-agenda-redo))
  7243. (message "Display now includes inactive timestamps as well"))
  7244. ((eq org-agenda-type 'search)
  7245. (org-add-to-string
  7246. 'org-agenda-query-string
  7247. (if org-agenda-last-search-view-search-was-boolean
  7248. (cdr (assoc char '((?\[ . " +") (?\] . " -")
  7249. (?\{ . " +{}") (?\} . " -{}"))))
  7250. " "))
  7251. (setq org-agenda-redo-command
  7252. (list 'org-search-view
  7253. (car (get-text-property (min (1- (point-max)) (point))
  7254. 'org-last-args))
  7255. org-agenda-query-string
  7256. (+ (length org-agenda-query-string)
  7257. (if (member char '(?\{ ?\})) 0 1))))
  7258. (set-register org-agenda-query-register org-agenda-query-string)
  7259. (let ((org-agenda-overriding-arguments
  7260. (cdr org-agenda-redo-command)))
  7261. (org-agenda-redo)))
  7262. (t (error "Cannot manipulate query for %s-type agenda buffers"
  7263. org-agenda-type))))
  7264. (defun org-add-to-string (var string)
  7265. (set var (concat (symbol-value var) string)))
  7266. (defun org-agenda-goto-date (span)
  7267. "Jump to DATE in agenda."
  7268. (interactive "P")
  7269. (let* ((org-read-date-prefer-future
  7270. (eval org-agenda-jump-prefer-future))
  7271. (date (org-read-date))
  7272. (day (time-to-days (org-time-string-to-time date)))
  7273. (org-agenda-sticky-orig org-agenda-sticky)
  7274. (org-agenda-buffer-tmp-name (buffer-name))
  7275. (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7276. (0-arg (or current-prefix-arg (car args)))
  7277. (2-arg (nth 2 args))
  7278. (with-hour-p (nth 4 org-agenda-redo-command))
  7279. (newcmd (list 'org-agenda-list 0-arg date
  7280. (org-agenda-span-to-ndays
  7281. 2-arg (org-time-string-to-absolute date))
  7282. with-hour-p))
  7283. (newargs (cdr newcmd))
  7284. (inhibit-read-only t)
  7285. org-agenda-sticky)
  7286. (if (not (org-agenda-check-type t 'agenda))
  7287. (error "Not available in non-agenda views")
  7288. (add-text-properties (point-min) (point-max)
  7289. `(org-redo-cmd ,newcmd org-last-args ,newargs))
  7290. (org-agenda-redo)
  7291. (goto-char (point-min))
  7292. (while (not (or (= (or (get-text-property (point) 'day) 0) day)
  7293. (save-excursion (move-beginning-of-line 2) (eobp))))
  7294. (move-beginning-of-line 2))
  7295. (setq org-agenda-sticky org-agenda-sticky-orig
  7296. org-agenda-this-buffer-is-sticky org-agenda-sticky))))
  7297. (defun org-agenda-goto-today ()
  7298. "Go to today."
  7299. (interactive)
  7300. (org-agenda-check-type t 'timeline 'agenda)
  7301. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7302. (curspan (nth 2 args))
  7303. (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
  7304. (cond
  7305. (tdpos (goto-char tdpos))
  7306. ((eq org-agenda-type 'agenda)
  7307. (let* ((sd (org-agenda-compute-starting-span
  7308. (org-today) (or curspan org-agenda-span)))
  7309. (org-agenda-overriding-arguments args))
  7310. (setf (nth 1 org-agenda-overriding-arguments) sd)
  7311. (org-agenda-redo)
  7312. (org-agenda-find-same-or-today-or-agenda)))
  7313. (t (error "Cannot find today")))))
  7314. (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
  7315. (goto-char
  7316. (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
  7317. (text-property-any (point-min) (point-max) 'org-today t)
  7318. (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
  7319. (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
  7320. (org-agenda-backward-block))
  7321. (point-min))))
  7322. (defun org-agenda-backward-block ()
  7323. "Move backward by one agenda block."
  7324. (interactive)
  7325. (org-agenda-forward-block 'backward))
  7326. (defun org-agenda-forward-block (&optional backward)
  7327. "Move forward by one agenda block.
  7328. When optional argument BACKWARD is set, go backward"
  7329. (interactive)
  7330. (cond ((not (derived-mode-p 'org-agenda-mode))
  7331. (user-error
  7332. "Cannot execute this command outside of org-agenda-mode buffers"))
  7333. ((looking-at (if backward "\\`" "\\'"))
  7334. (message "Already at the %s block" (if backward "first" "last")))
  7335. (t (let ((pos (prog1 (point)
  7336. (ignore-errors (if backward (backward-char 1)
  7337. (move-end-of-line 1)))))
  7338. (f (if backward
  7339. 'previous-single-property-change
  7340. 'next-single-property-change))
  7341. moved dest)
  7342. (while (and (setq dest (funcall
  7343. f (point) 'org-agenda-structural-header))
  7344. (not (get-text-property
  7345. (point) 'org-agenda-structural-header)))
  7346. (setq moved t)
  7347. (goto-char dest))
  7348. (if moved (move-beginning-of-line 1)
  7349. (goto-char (if backward (point-min) (point-max)))
  7350. (move-beginning-of-line 1)
  7351. (message "No %s block" (if backward "previous" "further")))))))
  7352. (defun org-agenda-later (arg)
  7353. "Go forward in time by the current span.
  7354. With prefix ARG, go forward that many times the current span."
  7355. (interactive "p")
  7356. (org-agenda-check-type t 'agenda)
  7357. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7358. (span (or (nth 2 args) org-agenda-current-span))
  7359. (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
  7360. (greg (calendar-gregorian-from-absolute sd))
  7361. (cnt (org-get-at-bol 'org-day-cnt))
  7362. greg2)
  7363. (cond
  7364. ((numberp span)
  7365. (setq sd (+ (* span arg) sd)))
  7366. ((eq span 'day)
  7367. (setq sd (+ arg sd)))
  7368. ((eq span 'week)
  7369. (setq sd (+ (* 7 arg) sd)))
  7370. ((eq span 'fortnight)
  7371. (setq sd (+ (* 14 arg) sd)))
  7372. ((eq span 'month)
  7373. (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
  7374. sd (calendar-absolute-from-gregorian greg2))
  7375. (setcar greg2 (1+ (car greg2))))
  7376. ((eq span 'year)
  7377. (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
  7378. sd (calendar-absolute-from-gregorian greg2))
  7379. (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
  7380. (t
  7381. (setq sd (+ (* span arg) sd))))
  7382. (let ((org-agenda-overriding-cmd
  7383. ;; `cmd' may have been set by `org-agenda-run-series' which
  7384. ;; uses `org-agenda-overriding-cmd' to decide whether
  7385. ;; overriding is allowed for `cmd'
  7386. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7387. (org-agenda-overriding-arguments
  7388. (list (car args) sd span)))
  7389. (org-agenda-redo)
  7390. (org-agenda-find-same-or-today-or-agenda cnt))))
  7391. (defun org-agenda-earlier (arg)
  7392. "Go backward in time by the current span.
  7393. With prefix ARG, go backward that many times the current span."
  7394. (interactive "p")
  7395. (org-agenda-later (- arg)))
  7396. (defun org-agenda-view-mode-dispatch ()
  7397. "Call one of the view mode commands."
  7398. (interactive)
  7399. (message "View: [d]ay [w]eek for[t]night [m]onth [y]ear [SPC]reset [q]uit/abort
  7400. time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
  7401. [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
  7402. (pcase (read-char-exclusive)
  7403. (?\ (call-interactively 'org-agenda-reset-view))
  7404. (?d (call-interactively 'org-agenda-day-view))
  7405. (?w (call-interactively 'org-agenda-week-view))
  7406. (?t (call-interactively 'org-agenda-fortnight-view))
  7407. (?m (call-interactively 'org-agenda-month-view))
  7408. (?y (call-interactively 'org-agenda-year-view))
  7409. (?l (call-interactively 'org-agenda-log-mode))
  7410. (?L (org-agenda-log-mode '(4)))
  7411. (?c (org-agenda-log-mode 'clockcheck))
  7412. ((or ?F ?f) (call-interactively 'org-agenda-follow-mode))
  7413. (?a (call-interactively 'org-agenda-archives-mode))
  7414. (?A (org-agenda-archives-mode 'files))
  7415. ((or ?R ?r) (call-interactively 'org-agenda-clockreport-mode))
  7416. ((or ?E ?e) (call-interactively 'org-agenda-entry-text-mode))
  7417. (?G (call-interactively 'org-agenda-toggle-time-grid))
  7418. (?D (call-interactively 'org-agenda-toggle-diary))
  7419. (?\! (call-interactively 'org-agenda-toggle-deadlines))
  7420. (?\[ (let ((org-agenda-include-inactive-timestamps t))
  7421. (org-agenda-check-type t 'timeline 'agenda)
  7422. (org-agenda-redo))
  7423. (message "Display now includes inactive timestamps as well"))
  7424. (?q (message "Abort"))
  7425. (key (user-error "Invalid key: %s" key))))
  7426. (defun org-agenda-reset-view ()
  7427. "Switch to default view for agenda."
  7428. (interactive)
  7429. (org-agenda-change-time-span org-agenda-span))
  7430. (defun org-agenda-day-view (&optional day-of-month)
  7431. "Switch to daily view for agenda.
  7432. With argument DAY-OF-MONTH, switch to that day of the month."
  7433. (interactive "P")
  7434. (org-agenda-change-time-span 'day day-of-month))
  7435. (defun org-agenda-week-view (&optional iso-week)
  7436. "Switch to daily view for agenda.
  7437. With argument ISO-WEEK, switch to the corresponding ISO week.
  7438. If ISO-WEEK has more then 2 digits, only the last two encode the
  7439. week. Any digits before this encode a year. So 200712 means
  7440. week 12 of year 2007. Years in the range 1938-2037 can also be
  7441. written as 2-digit years."
  7442. (interactive "P")
  7443. (org-agenda-change-time-span 'week iso-week))
  7444. (defun org-agenda-fortnight-view (&optional iso-week)
  7445. "Switch to daily view for agenda.
  7446. With argument ISO-WEEK, switch to the corresponding ISO week.
  7447. If ISO-WEEK has more then 2 digits, only the last two encode the
  7448. week. Any digits before this encode a year. So 200712 means
  7449. week 12 of year 2007. Years in the range 1938-2037 can also be
  7450. written as 2-digit years."
  7451. (interactive "P")
  7452. (org-agenda-change-time-span 'fortnight iso-week))
  7453. (defun org-agenda-month-view (&optional month)
  7454. "Switch to monthly view for agenda.
  7455. With argument MONTH, switch to that month."
  7456. (interactive "P")
  7457. (org-agenda-change-time-span 'month month))
  7458. (defun org-agenda-year-view (&optional year)
  7459. "Switch to yearly view for agenda.
  7460. With argument YEAR, switch to that year.
  7461. If MONTH has more then 2 digits, only the last two encode the
  7462. month. Any digits before this encode a year. So 200712 means
  7463. December year 2007. Years in the range 1938-2037 can also be
  7464. written as 2-digit years."
  7465. (interactive "P")
  7466. (when year
  7467. (setq year (org-small-year-to-year year)))
  7468. (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
  7469. (org-agenda-change-time-span 'year year)
  7470. (error "Abort")))
  7471. (defun org-agenda-change-time-span (span &optional n)
  7472. "Change the agenda view to SPAN.
  7473. SPAN may be `day', `week', `fortnight', `month', `year'."
  7474. (org-agenda-check-type t 'agenda)
  7475. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7476. (curspan (nth 2 args)))
  7477. (if (and (not n) (equal curspan span))
  7478. (error "Viewing span is already \"%s\"" span))
  7479. (let* ((sd (or (org-get-at-bol 'day)
  7480. (nth 1 args)
  7481. org-starting-day))
  7482. (sd (org-agenda-compute-starting-span sd span n))
  7483. (org-agenda-overriding-cmd
  7484. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7485. (org-agenda-overriding-arguments
  7486. (list (car args) sd span)))
  7487. (org-agenda-redo)
  7488. (org-agenda-find-same-or-today-or-agenda))
  7489. (org-agenda-set-mode-name)
  7490. (message "Switched to %s view" span)))
  7491. (defun org-agenda-compute-starting-span (sd span &optional n)
  7492. "Compute starting date for agenda.
  7493. SPAN may be `day', `week', `fortnight', `month', `year'. The return value
  7494. is a cons cell with the starting date and the number of days,
  7495. so that the date SD will be in that range."
  7496. (let* ((greg (calendar-gregorian-from-absolute sd))
  7497. (dg (nth 1 greg))
  7498. (mg (car greg))
  7499. (yg (nth 2 greg)))
  7500. (cond
  7501. ((eq span 'day)
  7502. (when n
  7503. (setq sd (+ (calendar-absolute-from-gregorian
  7504. (list mg 1 yg))
  7505. n -1))))
  7506. ((or (eq span 'week) (eq span 'fortnight))
  7507. (let* ((nt (calendar-day-of-week
  7508. (calendar-gregorian-from-absolute sd)))
  7509. (d (if org-agenda-start-on-weekday
  7510. (- nt org-agenda-start-on-weekday)
  7511. 0))
  7512. y1)
  7513. (setq sd (- sd (+ (if (< d 0) 7 0) d)))
  7514. (when n
  7515. (require 'cal-iso)
  7516. (when (> n 99)
  7517. (setq y1 (org-small-year-to-year (/ n 100))
  7518. n (mod n 100)))
  7519. (setq sd
  7520. (calendar-iso-to-absolute
  7521. (list n 1
  7522. (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
  7523. ((eq span 'month)
  7524. (let (y1)
  7525. (when (and n (> n 99))
  7526. (setq y1 (org-small-year-to-year (/ n 100))
  7527. n (mod n 100)))
  7528. (setq sd (calendar-absolute-from-gregorian
  7529. (list (or n mg) 1 (or y1 yg))))))
  7530. ((eq span 'year)
  7531. (setq sd (calendar-absolute-from-gregorian
  7532. (list 1 1 (or n yg))))))
  7533. sd))
  7534. (defun org-agenda-next-date-line (&optional arg)
  7535. "Jump to the next line indicating a date in agenda buffer."
  7536. (interactive "p")
  7537. (org-agenda-check-type t 'agenda 'timeline)
  7538. (beginning-of-line 1)
  7539. ;; This does not work if user makes date format that starts with a blank
  7540. (if (looking-at "^\\S-") (forward-char 1))
  7541. (if (not (re-search-forward "^\\S-" nil t arg))
  7542. (progn
  7543. (backward-char 1)
  7544. (error "No next date after this line in this buffer")))
  7545. (goto-char (match-beginning 0)))
  7546. (defun org-agenda-previous-date-line (&optional arg)
  7547. "Jump to the previous line indicating a date in agenda buffer."
  7548. (interactive "p")
  7549. (org-agenda-check-type t 'agenda 'timeline)
  7550. (beginning-of-line 1)
  7551. (if (not (re-search-backward "^\\S-" nil t arg))
  7552. (error "No previous date before this line in this buffer")))
  7553. ;; Initialize the highlight
  7554. (defvar org-hl (make-overlay 1 1))
  7555. (overlay-put org-hl 'face 'highlight)
  7556. (defun org-highlight (begin end &optional buffer)
  7557. "Highlight a region with overlay."
  7558. (move-overlay org-hl begin end (or buffer (current-buffer))))
  7559. (defun org-unhighlight ()
  7560. "Detach overlay INDEX."
  7561. (delete-overlay org-hl))
  7562. (defun org-unhighlight-once ()
  7563. "Remove the highlight from its position, and this function from the hook."
  7564. (remove-hook 'pre-command-hook 'org-unhighlight-once)
  7565. (org-unhighlight))
  7566. (defvar org-agenda-pre-follow-window-conf nil)
  7567. (defun org-agenda-follow-mode ()
  7568. "Toggle follow mode in an agenda buffer."
  7569. (interactive)
  7570. (unless org-agenda-follow-mode
  7571. (setq org-agenda-pre-follow-window-conf
  7572. (current-window-configuration)))
  7573. (setq org-agenda-follow-mode (not org-agenda-follow-mode))
  7574. (unless org-agenda-follow-mode
  7575. (set-window-configuration org-agenda-pre-follow-window-conf))
  7576. (org-agenda-set-mode-name)
  7577. (org-agenda-do-context-action)
  7578. (message "Follow mode is %s"
  7579. (if org-agenda-follow-mode "on" "off")))
  7580. (defun org-agenda-entry-text-mode (&optional arg)
  7581. "Toggle entry text mode in an agenda buffer."
  7582. (interactive "P")
  7583. (if (or org-agenda-tag-filter
  7584. org-agenda-category-filter
  7585. org-agenda-regexp-filter
  7586. org-agenda-top-headline-filter)
  7587. (user-error "Can't show entry text in filtered views")
  7588. (setq org-agenda-entry-text-mode (or (integerp arg)
  7589. (not org-agenda-entry-text-mode)))
  7590. (org-agenda-entry-text-hide)
  7591. (and org-agenda-entry-text-mode
  7592. (let ((org-agenda-entry-text-maxlines
  7593. (if (integerp arg) arg org-agenda-entry-text-maxlines)))
  7594. (org-agenda-entry-text-show)))
  7595. (org-agenda-set-mode-name)
  7596. (message "Entry text mode is %s%s"
  7597. (if org-agenda-entry-text-mode "on" "off")
  7598. (if (not org-agenda-entry-text-mode) ""
  7599. (format " (maximum number of lines is %d)"
  7600. (if (integerp arg) arg org-agenda-entry-text-maxlines))))))
  7601. (defun org-agenda-clockreport-mode ()
  7602. "Toggle clocktable mode in an agenda buffer."
  7603. (interactive)
  7604. (org-agenda-check-type t 'agenda)
  7605. (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode))
  7606. (setq org-agenda-start-with-clockreport-mode org-agenda-clockreport-mode)
  7607. (org-agenda-set-mode-name)
  7608. (org-agenda-redo)
  7609. (message "Clocktable mode is %s"
  7610. (if org-agenda-clockreport-mode "on" "off")))
  7611. (defun org-agenda-log-mode (&optional special)
  7612. "Toggle log mode in an agenda buffer.
  7613. With argument SPECIAL, show all possible log items, not only the ones
  7614. configured in `org-agenda-log-mode-items'.
  7615. With a double \\[universal-argument] prefix arg, show *only* \
  7616. log items, nothing else."
  7617. (interactive "P")
  7618. (org-agenda-check-type t 'agenda 'timeline)
  7619. (setq org-agenda-show-log
  7620. (cond
  7621. ((equal special '(16)) 'only)
  7622. ((eq special 'clockcheck)
  7623. (if (eq org-agenda-show-log 'clockcheck)
  7624. nil 'clockcheck))
  7625. (special '(closed clock state))
  7626. (t (not org-agenda-show-log))))
  7627. (setq org-agenda-start-with-log-mode org-agenda-show-log)
  7628. (org-agenda-set-mode-name)
  7629. (org-agenda-redo)
  7630. (message "Log mode is %s"
  7631. (if org-agenda-show-log "on" "off")))
  7632. (defun org-agenda-archives-mode (&optional with-files)
  7633. "Toggle inclusion of items in trees marked with :ARCHIVE:.
  7634. When called with a prefix argument, include all archive files as well."
  7635. (interactive "P")
  7636. (setq org-agenda-archives-mode
  7637. (if with-files t (if org-agenda-archives-mode nil 'trees)))
  7638. (org-agenda-set-mode-name)
  7639. (org-agenda-redo)
  7640. (message
  7641. "%s"
  7642. (cond
  7643. ((eq org-agenda-archives-mode nil)
  7644. "No archives are included")
  7645. ((eq org-agenda-archives-mode 'trees)
  7646. (format "Trees with :%s: tag are included" org-archive-tag))
  7647. ((eq org-agenda-archives-mode t)
  7648. (format "Trees with :%s: tag and all active archive files are included"
  7649. org-archive-tag)))))
  7650. (defun org-agenda-toggle-diary ()
  7651. "Toggle diary inclusion in an agenda buffer."
  7652. (interactive)
  7653. (org-agenda-check-type t 'agenda)
  7654. (setq org-agenda-include-diary (not org-agenda-include-diary))
  7655. (org-agenda-redo)
  7656. (org-agenda-set-mode-name)
  7657. (message "Diary inclusion turned %s"
  7658. (if org-agenda-include-diary "on" "off")))
  7659. (defun org-agenda-toggle-deadlines ()
  7660. "Toggle inclusion of entries with a deadline in an agenda buffer."
  7661. (interactive)
  7662. (org-agenda-check-type t 'agenda)
  7663. (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
  7664. (org-agenda-redo)
  7665. (org-agenda-set-mode-name)
  7666. (message "Deadlines inclusion turned %s"
  7667. (if org-agenda-include-deadlines "on" "off")))
  7668. (defun org-agenda-toggle-time-grid ()
  7669. "Toggle time grid in an agenda buffer."
  7670. (interactive)
  7671. (org-agenda-check-type t 'agenda)
  7672. (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
  7673. (org-agenda-redo)
  7674. (org-agenda-set-mode-name)
  7675. (message "Time-grid turned %s"
  7676. (if org-agenda-use-time-grid "on" "off")))
  7677. (defun org-agenda-set-mode-name ()
  7678. "Set the mode name to indicate all the small mode settings."
  7679. (setq mode-name
  7680. (list "Org-Agenda"
  7681. (if (get 'org-agenda-files 'org-restrict) " []" "")
  7682. " "
  7683. '(:eval (org-agenda-span-name org-agenda-current-span))
  7684. (if org-agenda-follow-mode " Follow" "")
  7685. (if org-agenda-entry-text-mode " ETxt" "")
  7686. (if org-agenda-include-diary " Diary" "")
  7687. (if org-agenda-include-deadlines " Ddl" "")
  7688. (if org-agenda-use-time-grid " Grid" "")
  7689. (if (and (boundp 'org-habit-show-habits)
  7690. org-habit-show-habits) " Habit" "")
  7691. (cond
  7692. ((consp org-agenda-show-log) " LogAll")
  7693. ((eq org-agenda-show-log 'clockcheck) " ClkCk")
  7694. (org-agenda-show-log " Log")
  7695. (t ""))
  7696. (if (or org-agenda-category-filter
  7697. (get 'org-agenda-category-filter :preset-filter))
  7698. '(:eval (propertize
  7699. (concat " <"
  7700. (mapconcat
  7701. 'identity
  7702. (append
  7703. (get 'org-agenda-category-filter :preset-filter)
  7704. org-agenda-category-filter)
  7705. "")
  7706. ">")
  7707. 'face 'org-agenda-filter-category
  7708. 'help-echo "Category used in filtering")) "")
  7709. (if (or org-agenda-tag-filter
  7710. (get 'org-agenda-tag-filter :preset-filter))
  7711. '(:eval (propertize
  7712. (concat " {"
  7713. (mapconcat
  7714. 'identity
  7715. (append
  7716. (get 'org-agenda-tag-filter :preset-filter)
  7717. org-agenda-tag-filter)
  7718. "")
  7719. "}")
  7720. 'face 'org-agenda-filter-tags
  7721. 'help-echo "Tags used in filtering")) "")
  7722. (if (or org-agenda-effort-filter
  7723. (get 'org-agenda-effort-filter :preset-filter))
  7724. '(:eval (propertize
  7725. (concat " {"
  7726. (mapconcat
  7727. 'identity
  7728. (append
  7729. (get 'org-agenda-effort-filter :preset-filter)
  7730. org-agenda-effort-filter)
  7731. "")
  7732. "}")
  7733. 'face 'org-agenda-filter-effort
  7734. 'help-echo "Effort conditions used in filtering")) "")
  7735. (if (or org-agenda-regexp-filter
  7736. (get 'org-agenda-regexp-filter :preset-filter))
  7737. '(:eval (propertize
  7738. (concat " ["
  7739. (mapconcat
  7740. 'identity
  7741. (append
  7742. (get 'org-agenda-regexp-filter :preset-filter)
  7743. org-agenda-regexp-filter)
  7744. "")
  7745. "]")
  7746. 'face 'org-agenda-filter-regexp
  7747. 'help-echo "Regexp used in filtering")) "")
  7748. (if org-agenda-archives-mode
  7749. (if (eq org-agenda-archives-mode t)
  7750. " Archives"
  7751. (format " :%s:" org-archive-tag))
  7752. "")
  7753. (if org-agenda-clockreport-mode " Clock" "")))
  7754. (force-mode-line-update))
  7755. (defun org-agenda-update-agenda-type ()
  7756. "Update the agenda type after each command."
  7757. (setq org-agenda-type
  7758. (or (get-text-property (point) 'org-agenda-type)
  7759. (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
  7760. (defun org-agenda-next-line ()
  7761. "Move cursor to the next line, and show if follow mode is active."
  7762. (interactive)
  7763. (call-interactively 'next-line)
  7764. (org-agenda-do-context-action))
  7765. (defun org-agenda-previous-line ()
  7766. "Move cursor to the previous line, and show if follow-mode is active."
  7767. (interactive)
  7768. (call-interactively 'previous-line)
  7769. (org-agenda-do-context-action))
  7770. (defun org-agenda-next-item (n)
  7771. "Move cursor to next agenda item."
  7772. (interactive "p")
  7773. (let ((col (current-column)))
  7774. (dotimes (c n)
  7775. (when (next-single-property-change (point-at-eol) 'org-marker)
  7776. (move-end-of-line 1)
  7777. (goto-char (next-single-property-change (point) 'org-marker))))
  7778. (org-move-to-column col))
  7779. (org-agenda-do-context-action))
  7780. (defun org-agenda-previous-item (n)
  7781. "Move cursor to next agenda item."
  7782. (interactive "p")
  7783. (dotimes (c n)
  7784. (let ((col (current-column))
  7785. (goto (save-excursion
  7786. (move-end-of-line 0)
  7787. (previous-single-property-change (point) 'org-marker))))
  7788. (if goto (goto-char goto))
  7789. (org-move-to-column col)))
  7790. (org-agenda-do-context-action))
  7791. (defun org-agenda-do-context-action ()
  7792. "Show outline path and, maybe, follow mode window."
  7793. (let ((m (org-get-at-bol 'org-marker)))
  7794. (when (and (markerp m) (marker-buffer m))
  7795. (and org-agenda-follow-mode
  7796. (if org-agenda-follow-indirect
  7797. (org-agenda-tree-to-indirect-buffer nil)
  7798. (org-agenda-show)))
  7799. (and org-agenda-show-outline-path
  7800. (org-with-point-at m (org-display-outline-path t))))))
  7801. (defun org-agenda-show-tags ()
  7802. "Show the tags applicable to the current item."
  7803. (interactive)
  7804. (let* ((tags (org-get-at-bol 'tags)))
  7805. (if tags
  7806. (message "Tags are :%s:"
  7807. (org-no-properties (mapconcat 'identity tags ":")))
  7808. (message "No tags associated with this line"))))
  7809. (defun org-agenda-goto (&optional highlight)
  7810. "Go to the entry at point in the corresponding Org file."
  7811. (interactive)
  7812. (let* ((marker (or (org-get-at-bol 'org-marker)
  7813. (org-agenda-error)))
  7814. (buffer (marker-buffer marker))
  7815. (pos (marker-position marker)))
  7816. (switch-to-buffer-other-window buffer)
  7817. (widen)
  7818. (push-mark)
  7819. (goto-char pos)
  7820. (when (derived-mode-p 'org-mode)
  7821. (org-show-context 'agenda)
  7822. (recenter (/ (window-height) 2))
  7823. (org-back-to-heading t)
  7824. (if (re-search-forward org-complex-heading-regexp nil t)
  7825. (goto-char (match-beginning 4))))
  7826. (run-hooks 'org-agenda-after-show-hook)
  7827. (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
  7828. (defvar org-agenda-after-show-hook nil
  7829. "Normal hook run after an item has been shown from the agenda.
  7830. Point is in the buffer where the item originated.")
  7831. (defun org-agenda-kill ()
  7832. "Kill the entry or subtree belonging to the current agenda entry."
  7833. (interactive)
  7834. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  7835. (let* ((bufname-orig (buffer-name))
  7836. (marker (or (org-get-at-bol 'org-marker)
  7837. (org-agenda-error)))
  7838. (buffer (marker-buffer marker))
  7839. (pos (marker-position marker))
  7840. (type (org-get-at-bol 'type))
  7841. dbeg dend (n 0) conf)
  7842. (org-with-remote-undo buffer
  7843. (with-current-buffer buffer
  7844. (save-excursion
  7845. (goto-char pos)
  7846. (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
  7847. (setq dbeg (progn (org-back-to-heading t) (point))
  7848. dend (org-end-of-subtree t t))
  7849. (setq dbeg (point-at-bol)
  7850. dend (min (point-max) (1+ (point-at-eol)))))
  7851. (goto-char dbeg)
  7852. (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
  7853. (setq conf (or (eq t org-agenda-confirm-kill)
  7854. (and (numberp org-agenda-confirm-kill)
  7855. (> n org-agenda-confirm-kill))))
  7856. (and conf
  7857. (not (y-or-n-p
  7858. (format "Delete entry with %d lines in buffer \"%s\"? "
  7859. n (buffer-name buffer))))
  7860. (error "Abort"))
  7861. (let ((org-agenda-buffer-name bufname-orig))
  7862. (org-remove-subtree-entries-from-agenda buffer dbeg dend))
  7863. (with-current-buffer buffer (delete-region dbeg dend))
  7864. (message "Agenda item and source killed"))))
  7865. (defvar org-archive-default-command) ; defined in org-archive.el
  7866. (defun org-agenda-archive-default ()
  7867. "Archive the entry or subtree belonging to the current agenda entry."
  7868. (interactive)
  7869. (require 'org-archive)
  7870. (org-agenda-archive-with org-archive-default-command))
  7871. (defun org-agenda-archive-default-with-confirmation ()
  7872. "Archive the entry or subtree belonging to the current agenda entry."
  7873. (interactive)
  7874. (require 'org-archive)
  7875. (org-agenda-archive-with org-archive-default-command 'confirm))
  7876. (defun org-agenda-archive ()
  7877. "Archive the entry or subtree belonging to the current agenda entry."
  7878. (interactive)
  7879. (org-agenda-archive-with 'org-archive-subtree))
  7880. (defun org-agenda-archive-to-archive-sibling ()
  7881. "Move the entry to the archive sibling."
  7882. (interactive)
  7883. (org-agenda-archive-with 'org-archive-to-archive-sibling))
  7884. (defun org-agenda-archive-with (cmd &optional confirm)
  7885. "Move the entry to the archive sibling."
  7886. (interactive)
  7887. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  7888. (let* ((bufname-orig (buffer-name))
  7889. (marker (or (org-get-at-bol 'org-marker)
  7890. (org-agenda-error)))
  7891. (buffer (marker-buffer marker))
  7892. (pos (marker-position marker)))
  7893. (org-with-remote-undo buffer
  7894. (with-current-buffer buffer
  7895. (if (derived-mode-p 'org-mode)
  7896. (if (and confirm
  7897. (not (y-or-n-p "Archive this subtree or entry? ")))
  7898. (error "Abort")
  7899. (save-window-excursion
  7900. (goto-char pos)
  7901. (let ((org-agenda-buffer-name bufname-orig))
  7902. (org-remove-subtree-entries-from-agenda))
  7903. (org-back-to-heading t)
  7904. (funcall cmd)))
  7905. (error "Archiving works only in Org files"))))))
  7906. (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
  7907. "Remove all lines in the agenda that correspond to a given subtree.
  7908. The subtree is the one in buffer BUF, starting at BEG and ending at END.
  7909. If this information is not given, the function uses the tree at point."
  7910. (let ((buf (or buf (current-buffer))) m p)
  7911. (save-excursion
  7912. (unless (and beg end)
  7913. (org-back-to-heading t)
  7914. (setq beg (point))
  7915. (org-end-of-subtree t)
  7916. (setq end (point)))
  7917. (set-buffer (get-buffer org-agenda-buffer-name))
  7918. (save-excursion
  7919. (goto-char (point-max))
  7920. (beginning-of-line 1)
  7921. (while (not (bobp))
  7922. (when (and (setq m (org-get-at-bol 'org-marker))
  7923. (equal buf (marker-buffer m))
  7924. (setq p (marker-position m))
  7925. (>= p beg)
  7926. (< p end))
  7927. (let ((inhibit-read-only t))
  7928. (delete-region (point-at-bol) (1+ (point-at-eol)))))
  7929. (beginning-of-line 0))))))
  7930. (defun org-agenda-refile (&optional goto rfloc no-update)
  7931. "Refile the item at point.
  7932. When GOTO is 0 or \\='(64) or a triple \\[universal-argument] prefix argument,
  7933. clear the refile cache.
  7934. When GOTO is \\='(16) or a double \\[universal-argument] prefix argument,
  7935. go to the location of the last refiled item.
  7936. RFLOC can be a refile location obtained in a different way.
  7937. When NO-UPDATE is non-nil, don't redo the agenda buffer."
  7938. (interactive "P")
  7939. (cond
  7940. ((member goto '(0 (64)))
  7941. (org-refile-cache-clear))
  7942. ((equal goto '(16))
  7943. (org-refile-goto-last-stored))
  7944. (t
  7945. (let* ((buffer-orig (buffer-name))
  7946. (marker (or (org-get-at-bol 'org-hd-marker)
  7947. (org-agenda-error)))
  7948. (buffer (marker-buffer marker))
  7949. (pos (marker-position marker))
  7950. (rfloc (or rfloc
  7951. (org-refile-get-location
  7952. (if goto "Goto" "Refile to") buffer
  7953. org-refile-allow-creating-parent-nodes))))
  7954. (with-current-buffer buffer
  7955. (org-with-wide-buffer
  7956. (goto-char marker)
  7957. (let ((org-agenda-buffer-name buffer-orig))
  7958. (org-remove-subtree-entries-from-agenda))
  7959. (org-refile goto buffer rfloc))))
  7960. (unless no-update (org-agenda-redo)))))
  7961. (defun org-agenda-open-link (&optional arg)
  7962. "Open the link(s) in the current entry, if any.
  7963. This looks for a link in the displayed line in the agenda.
  7964. It also looks at the text of the entry itself."
  7965. (interactive "P")
  7966. (let* ((marker (or (org-get-at-bol 'org-hd-marker)
  7967. (org-get-at-bol 'org-marker)))
  7968. (buffer (and marker (marker-buffer marker)))
  7969. (prefix (buffer-substring (point-at-bol) (point-at-eol)))
  7970. (lkall (and buffer (org-offer-links-in-entry
  7971. buffer marker arg prefix)))
  7972. (lk0 (car lkall))
  7973. (lk (if (stringp lk0) (list lk0) lk0))
  7974. (lkend (cdr lkall))
  7975. trg)
  7976. (cond
  7977. ((and buffer lk)
  7978. (mapcar (lambda(l)
  7979. (with-current-buffer buffer
  7980. (setq trg (and (string-match org-bracket-link-regexp l)
  7981. (match-string 1 l)))
  7982. (if (or (not trg) (string-match org-any-link-re trg))
  7983. (org-with-wide-buffer
  7984. (goto-char marker)
  7985. (when (search-forward l nil lkend)
  7986. (goto-char (match-beginning 0))
  7987. (org-open-at-point)))
  7988. ;; This is an internal link, widen the buffer
  7989. (switch-to-buffer-other-window buffer)
  7990. (widen)
  7991. (goto-char marker)
  7992. (when (search-forward l nil lkend)
  7993. (goto-char (match-beginning 0))
  7994. (org-open-at-point)))))
  7995. lk))
  7996. ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
  7997. (save-excursion
  7998. (beginning-of-line 1)
  7999. (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
  8000. (org-open-link-from-string (match-string 1)))
  8001. (t (message "No link to open here")))))
  8002. (defun org-agenda-copy-local-variable (var)
  8003. "Get a variable from a referenced buffer and install it here."
  8004. (let ((m (org-get-at-bol 'org-marker)))
  8005. (when (and m (buffer-live-p (marker-buffer m)))
  8006. (set (make-local-variable var)
  8007. (with-current-buffer (marker-buffer m)
  8008. (symbol-value var))))))
  8009. (defun org-agenda-switch-to (&optional delete-other-windows)
  8010. "Go to the Org mode file which contains the item at point.
  8011. When optional argument DELETE-OTHER-WINDOWS is non-nil, the
  8012. displayed Org file fills the frame."
  8013. (interactive)
  8014. (if (and org-return-follows-link
  8015. (not (org-get-at-bol 'org-marker))
  8016. (org-in-regexp org-bracket-link-regexp))
  8017. (org-open-link-from-string (match-string 0))
  8018. (let* ((marker (or (org-get-at-bol 'org-marker)
  8019. (org-agenda-error)))
  8020. (buffer (marker-buffer marker))
  8021. (pos (marker-position marker)))
  8022. (unless buffer (user-error "Trying to switch to non-existent buffer"))
  8023. (pop-to-buffer-same-window buffer)
  8024. (when delete-other-windows (delete-other-windows))
  8025. (widen)
  8026. (goto-char pos)
  8027. (when (derived-mode-p 'org-mode)
  8028. (org-show-context 'agenda)
  8029. (run-hooks 'org-agenda-after-show-hook)))))
  8030. (defun org-agenda-goto-mouse (ev)
  8031. "Go to the Org file which contains the item at the mouse click."
  8032. (interactive "e")
  8033. (mouse-set-point ev)
  8034. (org-agenda-goto))
  8035. (defun org-agenda-show (&optional full-entry)
  8036. "Display the Org file which contains the item at point.
  8037. With prefix argument FULL-ENTRY, make the entire entry visible
  8038. if it was hidden in the outline."
  8039. (interactive "P")
  8040. (let ((win (selected-window)))
  8041. (org-agenda-goto t)
  8042. (when full-entry (org-show-entry))
  8043. (select-window win)))
  8044. (defvar org-agenda-show-window nil)
  8045. (defun org-agenda-show-and-scroll-up (&optional arg)
  8046. "Display the Org file which contains the item at point.
  8047. When called repeatedly, scroll the window that is displaying the buffer.
  8048. With a \\[universal-argument] prefix, use `org-show-entry' instead of \
  8049. `outline-show-subtree'
  8050. to display the item, so that drawers and logbooks stay folded."
  8051. (interactive "P")
  8052. (let ((win (selected-window)))
  8053. (if (and (window-live-p org-agenda-show-window)
  8054. (eq this-command last-command))
  8055. (progn
  8056. (select-window org-agenda-show-window)
  8057. (ignore-errors (scroll-up)))
  8058. (org-agenda-goto t)
  8059. (if arg (org-show-entry) (outline-show-subtree))
  8060. (setq org-agenda-show-window (selected-window)))
  8061. (select-window win)))
  8062. (defun org-agenda-show-scroll-down ()
  8063. "Scroll down the window showing the agenda."
  8064. (interactive)
  8065. (let ((win (selected-window)))
  8066. (when (window-live-p org-agenda-show-window)
  8067. (select-window org-agenda-show-window)
  8068. (ignore-errors (scroll-down))
  8069. (select-window win))))
  8070. (defun org-agenda-show-1 (&optional more)
  8071. "Display the Org file which contains the item at point.
  8072. The prefix arg selects the amount of information to display:
  8073. 0 hide the subtree
  8074. 1 just show the entry according to defaults.
  8075. 2 show the children view
  8076. 3 show the subtree view
  8077. 4 show the entire subtree and any LOGBOOK drawers
  8078. 5 show the entire subtree and any drawers
  8079. With prefix argument FULL-ENTRY, make the entire entry visible
  8080. if it was hidden in the outline."
  8081. (interactive "p")
  8082. (let ((win (selected-window)))
  8083. (org-agenda-goto t)
  8084. (org-back-to-heading)
  8085. (set-window-start (selected-window) (point-at-bol))
  8086. (cond
  8087. ((= more 0)
  8088. (outline-hide-subtree)
  8089. (save-excursion
  8090. (org-back-to-heading)
  8091. (run-hook-with-args 'org-cycle-hook 'folded))
  8092. (message "Remote: FOLDED"))
  8093. ((and (called-interactively-p 'any) (= more 1))
  8094. (message "Remote: show with default settings"))
  8095. ((= more 2)
  8096. (outline-show-entry)
  8097. (org-show-children)
  8098. (save-excursion
  8099. (org-back-to-heading)
  8100. (run-hook-with-args 'org-cycle-hook 'children))
  8101. (message "Remote: CHILDREN"))
  8102. ((= more 3)
  8103. (outline-show-subtree)
  8104. (save-excursion
  8105. (org-back-to-heading)
  8106. (run-hook-with-args 'org-cycle-hook 'subtree))
  8107. (message "Remote: SUBTREE"))
  8108. ((= more 4)
  8109. (outline-show-subtree)
  8110. (save-excursion
  8111. (org-back-to-heading)
  8112. (org-cycle-hide-drawers 'subtree '("LOGBOOK")))
  8113. (message "Remote: SUBTREE AND LOGBOOK"))
  8114. ((> more 4)
  8115. (outline-show-subtree)
  8116. (message "Remote: SUBTREE AND ALL DRAWERS")))
  8117. (select-window win)))
  8118. (defvar org-agenda-cycle-counter nil)
  8119. (defun org-agenda-cycle-show (&optional n)
  8120. "Show the current entry in another window, with default settings.
  8121. Default settings are taken from `org-show-context-detail'. When
  8122. use repeatedly in immediate succession, the remote entry will
  8123. cycle through visibility
  8124. children -> subtree -> folded
  8125. When called with a numeric prefix arg, that arg will be passed through to
  8126. `org-agenda-show-1'. For the interpretation of that argument, see the
  8127. docstring of `org-agenda-show-1'."
  8128. (interactive "P")
  8129. (if (integerp n)
  8130. (setq org-agenda-cycle-counter n)
  8131. (if (not (eq last-command this-command))
  8132. (setq org-agenda-cycle-counter 1)
  8133. (if (equal org-agenda-cycle-counter 0)
  8134. (setq org-agenda-cycle-counter 2)
  8135. (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
  8136. (if (> org-agenda-cycle-counter 3)
  8137. (setq org-agenda-cycle-counter 0)))))
  8138. (org-agenda-show-1 org-agenda-cycle-counter))
  8139. (defun org-agenda-recenter (arg)
  8140. "Display the Org file which contains the item at point and recenter."
  8141. (interactive "P")
  8142. (let ((win (selected-window)))
  8143. (org-agenda-goto t)
  8144. (recenter arg)
  8145. (select-window win)))
  8146. (defun org-agenda-show-mouse (ev)
  8147. "Display the Org file which contains the item at the mouse click."
  8148. (interactive "e")
  8149. (mouse-set-point ev)
  8150. (org-agenda-show))
  8151. (defun org-agenda-check-no-diary ()
  8152. "Check if the entry is a diary link and abort if yes."
  8153. (if (org-get-at-bol 'org-agenda-diary-link)
  8154. (org-agenda-error)))
  8155. (defun org-agenda-error ()
  8156. "Throw an error when a command is not allowed in the agenda."
  8157. (user-error "Command not allowed in this line"))
  8158. (defun org-agenda-tree-to-indirect-buffer (arg)
  8159. "Show the subtree corresponding to the current entry in an indirect buffer.
  8160. This calls the command `org-tree-to-indirect-buffer' from the original buffer.
  8161. With a numerical prefix ARG, go up to this level and then take that tree.
  8162. With a negative numeric ARG, go up by this number of levels.
  8163. With a \\[universal-argument] prefix, make a separate frame for this tree (i.e. don't
  8164. use the dedicated frame)."
  8165. (interactive "P")
  8166. (if current-prefix-arg
  8167. (org-agenda-do-tree-to-indirect-buffer arg)
  8168. (let ((agenda-buffer (buffer-name))
  8169. (agenda-window (selected-window))
  8170. (indirect-window
  8171. (and org-last-indirect-buffer
  8172. (get-buffer-window org-last-indirect-buffer))))
  8173. (save-window-excursion (org-agenda-do-tree-to-indirect-buffer arg))
  8174. (unless (or (eq org-indirect-buffer-display 'new-frame)
  8175. (eq org-indirect-buffer-display 'dedicated-frame))
  8176. (unwind-protect
  8177. (unless (and indirect-window (window-live-p indirect-window))
  8178. (setq indirect-window (split-window agenda-window)))
  8179. (and indirect-window (select-window indirect-window))
  8180. (switch-to-buffer org-last-indirect-buffer :norecord)
  8181. (fit-window-to-buffer indirect-window)))
  8182. (select-window (get-buffer-window agenda-buffer))
  8183. (setq org-agenda-last-indirect-buffer org-last-indirect-buffer))))
  8184. (defun org-agenda-do-tree-to-indirect-buffer (arg)
  8185. "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
  8186. (org-agenda-check-no-diary)
  8187. (let* ((marker (or (org-get-at-bol 'org-marker)
  8188. (org-agenda-error)))
  8189. (buffer (marker-buffer marker))
  8190. (pos (marker-position marker)))
  8191. (with-current-buffer buffer
  8192. (save-excursion
  8193. (goto-char pos)
  8194. (funcall 'org-tree-to-indirect-buffer arg)))))
  8195. (defvar org-last-heading-marker (make-marker)
  8196. "Marker pointing to the headline that last changed its TODO state
  8197. by a remote command from the agenda.")
  8198. (defun org-agenda-todo-nextset ()
  8199. "Switch TODO entry to next sequence."
  8200. (interactive)
  8201. (org-agenda-todo 'nextset))
  8202. (defun org-agenda-todo-previousset ()
  8203. "Switch TODO entry to previous sequence."
  8204. (interactive)
  8205. (org-agenda-todo 'previousset))
  8206. (defun org-agenda-todo (&optional arg)
  8207. "Cycle TODO state of line at point, also in Org file.
  8208. This changes the line at point, all other lines in the agenda referring to
  8209. the same tree node, and the headline of the tree node in the Org file."
  8210. (interactive "P")
  8211. (org-agenda-check-no-diary)
  8212. (let* ((col (current-column))
  8213. (marker (or (org-get-at-bol 'org-marker)
  8214. (org-agenda-error)))
  8215. (buffer (marker-buffer marker))
  8216. (pos (marker-position marker))
  8217. (hdmarker (org-get-at-bol 'org-hd-marker))
  8218. (todayp (org-agenda-today-p (org-get-at-bol 'day)))
  8219. (inhibit-read-only t)
  8220. org-agenda-headline-snapshot-before-repeat newhead just-one)
  8221. (org-with-remote-undo buffer
  8222. (with-current-buffer buffer
  8223. (widen)
  8224. (goto-char pos)
  8225. (org-show-context 'agenda)
  8226. (let ((current-prefix-arg arg))
  8227. (call-interactively 'org-todo))
  8228. (and (bolp) (forward-char 1))
  8229. (setq newhead (org-get-heading))
  8230. (when (and (bound-and-true-p
  8231. org-agenda-headline-snapshot-before-repeat)
  8232. (not (equal org-agenda-headline-snapshot-before-repeat
  8233. newhead))
  8234. todayp)
  8235. (setq newhead org-agenda-headline-snapshot-before-repeat
  8236. just-one t))
  8237. (save-excursion
  8238. (org-back-to-heading)
  8239. (move-marker org-last-heading-marker (point))))
  8240. (beginning-of-line 1)
  8241. (save-window-excursion
  8242. (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
  8243. (when (bound-and-true-p org-clock-out-when-done)
  8244. (string-match (concat "^" (regexp-opt org-done-keywords-for-agenda))
  8245. newhead)
  8246. (org-agenda-unmark-clocking-task))
  8247. (org-move-to-column col)
  8248. (org-agenda-mark-clocking-task))))
  8249. (defun org-agenda-add-note (&optional arg)
  8250. "Add a time-stamped note to the entry at point."
  8251. (interactive "P")
  8252. (org-agenda-check-no-diary)
  8253. (let* ((marker (or (org-get-at-bol 'org-marker)
  8254. (org-agenda-error)))
  8255. (buffer (marker-buffer marker))
  8256. (pos (marker-position marker))
  8257. (hdmarker (org-get-at-bol 'org-hd-marker))
  8258. (inhibit-read-only t))
  8259. (with-current-buffer buffer
  8260. (widen)
  8261. (goto-char pos)
  8262. (org-show-context 'agenda)
  8263. (org-add-note))))
  8264. (defun org-agenda-change-all-lines (newhead hdmarker
  8265. &optional fixface just-this)
  8266. "Change all lines in the agenda buffer which match HDMARKER.
  8267. The new content of the line will be NEWHEAD (as modified by
  8268. `org-agenda-format-item'). HDMARKER is checked with
  8269. `equal' against all `org-hd-marker' text properties in the file.
  8270. If FIXFACE is non-nil, the face of each item is modified according to
  8271. the new TODO state.
  8272. If JUST-THIS is non-nil, change just the current line, not all.
  8273. If FORCE-TAGS is non nil, the car of it returns the new tags."
  8274. (let* ((inhibit-read-only t)
  8275. (line (org-current-line))
  8276. (org-agenda-buffer (current-buffer))
  8277. (thetags (with-current-buffer (marker-buffer hdmarker)
  8278. (org-with-wide-buffer
  8279. (goto-char hdmarker)
  8280. (org-get-tags-at))))
  8281. props m pl undone-face done-face finish new dotime level cat tags)
  8282. (save-excursion
  8283. (goto-char (point-max))
  8284. (beginning-of-line 1)
  8285. (while (not finish)
  8286. (setq finish (bobp))
  8287. (when (and (setq m (org-get-at-bol 'org-hd-marker))
  8288. (or (not just-this) (= (org-current-line) line))
  8289. (equal m hdmarker))
  8290. (setq props (text-properties-at (point))
  8291. dotime (org-get-at-bol 'dotime)
  8292. cat (org-get-at-eol 'org-category 1)
  8293. level (org-get-at-bol 'level)
  8294. tags thetags
  8295. new
  8296. (let ((org-prefix-format-compiled
  8297. (or (get-text-property (min (1- (point-max)) (point)) 'format)
  8298. org-prefix-format-compiled))
  8299. (extra (org-get-at-bol 'extra)))
  8300. (with-current-buffer (marker-buffer hdmarker)
  8301. (org-with-wide-buffer
  8302. (org-agenda-format-item extra newhead level cat tags dotime))))
  8303. pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
  8304. undone-face (org-get-at-bol 'undone-face)
  8305. done-face (org-get-at-bol 'done-face))
  8306. (beginning-of-line 1)
  8307. (cond
  8308. ((equal new "") (delete-region (point) (line-beginning-position 2)))
  8309. ((looking-at ".*")
  8310. ;; When replacing the whole line, preserve bulk mark
  8311. ;; overlay, if any.
  8312. (let ((mark (catch :overlay
  8313. (dolist (o (overlays-in (point) (+ 2 (point))))
  8314. (when (eq (overlay-get o 'type)
  8315. 'org-marked-entry-overlay)
  8316. (throw :overlay o))))))
  8317. (replace-match new t t)
  8318. (beginning-of-line)
  8319. (when mark (move-overlay mark (point) (+ 2 (point)))))
  8320. (add-text-properties (point-at-bol) (point-at-eol) props)
  8321. (when fixface
  8322. (add-text-properties
  8323. (point-at-bol) (point-at-eol)
  8324. (list 'face
  8325. (if org-last-todo-state-is-todo
  8326. undone-face done-face))))
  8327. (org-agenda-highlight-todo 'line)
  8328. (beginning-of-line 1))
  8329. (t (error "Line update did not work")))
  8330. (save-restriction
  8331. (narrow-to-region (point-at-bol) (point-at-eol))
  8332. (org-agenda-finalize)))
  8333. (beginning-of-line 0)))))
  8334. (defun org-agenda-align-tags (&optional line)
  8335. "Align all tags in agenda items to `org-agenda-tags-column'."
  8336. (let ((inhibit-read-only t) l c)
  8337. (save-excursion
  8338. (goto-char (if line (point-at-bol) (point-min)))
  8339. (while (re-search-forward "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"
  8340. (if line (point-at-eol) nil) t)
  8341. (add-text-properties
  8342. (match-beginning 2) (match-end 2)
  8343. (list 'face (delq nil (let ((prop (get-text-property
  8344. (match-beginning 2) 'face)))
  8345. (or (listp prop) (setq prop (list prop)))
  8346. (if (memq 'org-tag prop)
  8347. prop
  8348. (cons 'org-tag prop))))))
  8349. (setq l (- (match-end 2) (match-beginning 2))
  8350. c (if (< org-agenda-tags-column 0)
  8351. (- (abs org-agenda-tags-column) l)
  8352. org-agenda-tags-column))
  8353. (delete-region (match-beginning 1) (match-end 1))
  8354. (goto-char (match-beginning 1))
  8355. (insert (org-add-props
  8356. (make-string (max 1 (- c (current-column))) ?\ )
  8357. (plist-put (copy-sequence (text-properties-at (point)))
  8358. 'face nil))))
  8359. (goto-char (point-min))
  8360. (org-font-lock-add-tag-faces (point-max)))))
  8361. (defun org-agenda-priority-up ()
  8362. "Increase the priority of line at point, also in Org file."
  8363. (interactive)
  8364. (org-agenda-priority 'up))
  8365. (defun org-agenda-priority-down ()
  8366. "Decrease the priority of line at point, also in Org file."
  8367. (interactive)
  8368. (org-agenda-priority 'down))
  8369. (defun org-agenda-priority (&optional force-direction)
  8370. "Set the priority of line at point, also in Org file.
  8371. This changes the line at point, all other lines in the agenda referring to
  8372. the same tree node, and the headline of the tree node in the Org file.
  8373. Called with a universal prefix arg, show the priority instead of setting it."
  8374. (interactive "P")
  8375. (if (equal force-direction '(4))
  8376. (org-show-priority)
  8377. (unless org-enable-priority-commands
  8378. (error "Priority commands are disabled"))
  8379. (org-agenda-check-no-diary)
  8380. (let* ((col (current-column))
  8381. (marker (or (org-get-at-bol 'org-marker)
  8382. (org-agenda-error)))
  8383. (hdmarker (org-get-at-bol 'org-hd-marker))
  8384. (buffer (marker-buffer hdmarker))
  8385. (pos (marker-position hdmarker))
  8386. (inhibit-read-only t)
  8387. newhead)
  8388. (org-with-remote-undo buffer
  8389. (with-current-buffer buffer
  8390. (widen)
  8391. (goto-char pos)
  8392. (org-show-context 'agenda)
  8393. (funcall 'org-priority force-direction)
  8394. (end-of-line 1)
  8395. (setq newhead (org-get-heading)))
  8396. (org-agenda-change-all-lines newhead hdmarker)
  8397. (org-move-to-column col)))))
  8398. ;; FIXME: should fix the tags property of the agenda line.
  8399. (defun org-agenda-set-tags (&optional tag onoff)
  8400. "Set tags for the current headline."
  8401. (interactive)
  8402. (org-agenda-check-no-diary)
  8403. (if (and (org-region-active-p) (called-interactively-p 'any))
  8404. (call-interactively 'org-change-tag-in-region)
  8405. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8406. (org-agenda-error)))
  8407. (buffer (marker-buffer hdmarker))
  8408. (pos (marker-position hdmarker))
  8409. (inhibit-read-only t)
  8410. newhead)
  8411. (org-with-remote-undo buffer
  8412. (with-current-buffer buffer
  8413. (widen)
  8414. (goto-char pos)
  8415. (org-show-context 'agenda)
  8416. (if tag
  8417. (org-toggle-tag tag onoff)
  8418. (call-interactively 'org-set-tags))
  8419. (end-of-line 1)
  8420. (setq newhead (org-get-heading)))
  8421. (org-agenda-change-all-lines newhead hdmarker)
  8422. (beginning-of-line 1)))))
  8423. (defun org-agenda-set-property ()
  8424. "Set a property for the current headline."
  8425. (interactive)
  8426. (org-agenda-check-no-diary)
  8427. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8428. (org-agenda-error)))
  8429. (buffer (marker-buffer hdmarker))
  8430. (pos (marker-position hdmarker))
  8431. (inhibit-read-only t)
  8432. newhead)
  8433. (org-with-remote-undo buffer
  8434. (with-current-buffer buffer
  8435. (widen)
  8436. (goto-char pos)
  8437. (org-show-context 'agenda)
  8438. (call-interactively 'org-set-property)))))
  8439. (defun org-agenda-set-effort ()
  8440. "Set the effort property for the current headline."
  8441. (interactive)
  8442. (org-agenda-check-no-diary)
  8443. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8444. (org-agenda-error)))
  8445. (buffer (marker-buffer hdmarker))
  8446. (pos (marker-position hdmarker))
  8447. (inhibit-read-only t)
  8448. newhead)
  8449. (org-with-remote-undo buffer
  8450. (with-current-buffer buffer
  8451. (widen)
  8452. (goto-char pos)
  8453. (org-show-context 'agenda)
  8454. (call-interactively 'org-set-effort)
  8455. (end-of-line 1)
  8456. (setq newhead (org-get-heading)))
  8457. (org-agenda-change-all-lines newhead hdmarker))))
  8458. (defun org-agenda-toggle-archive-tag ()
  8459. "Toggle the archive tag for the current entry."
  8460. (interactive)
  8461. (org-agenda-check-no-diary)
  8462. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8463. (org-agenda-error)))
  8464. (buffer (marker-buffer hdmarker))
  8465. (pos (marker-position hdmarker))
  8466. (inhibit-read-only t)
  8467. newhead)
  8468. (org-with-remote-undo buffer
  8469. (with-current-buffer buffer
  8470. (widen)
  8471. (goto-char pos)
  8472. (org-show-context 'agenda)
  8473. (call-interactively 'org-toggle-archive-tag)
  8474. (end-of-line 1)
  8475. (setq newhead (org-get-heading)))
  8476. (org-agenda-change-all-lines newhead hdmarker)
  8477. (beginning-of-line 1))))
  8478. (defun org-agenda-do-date-later (arg)
  8479. (interactive "P")
  8480. (cond
  8481. ((or (equal arg '(16))
  8482. (memq last-command
  8483. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  8484. (setq this-command 'org-agenda-date-later-minutes)
  8485. (org-agenda-date-later-minutes 1))
  8486. ((or (equal arg '(4))
  8487. (memq last-command
  8488. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  8489. (setq this-command 'org-agenda-date-later-hours)
  8490. (org-agenda-date-later-hours 1))
  8491. (t
  8492. (org-agenda-date-later (prefix-numeric-value arg)))))
  8493. (defun org-agenda-do-date-earlier (arg)
  8494. (interactive "P")
  8495. (cond
  8496. ((or (equal arg '(16))
  8497. (memq last-command
  8498. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  8499. (setq this-command 'org-agenda-date-earlier-minutes)
  8500. (org-agenda-date-earlier-minutes 1))
  8501. ((or (equal arg '(4))
  8502. (memq last-command
  8503. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  8504. (setq this-command 'org-agenda-date-earlier-hours)
  8505. (org-agenda-date-earlier-hours 1))
  8506. (t
  8507. (org-agenda-date-earlier (prefix-numeric-value arg)))))
  8508. (defun org-agenda-date-later (arg &optional what)
  8509. "Change the date of this item to ARG day(s) later."
  8510. (interactive "p")
  8511. (org-agenda-check-type t 'agenda 'timeline)
  8512. (org-agenda-check-no-diary)
  8513. (let* ((marker (or (org-get-at-bol 'org-marker)
  8514. (org-agenda-error)))
  8515. (buffer (marker-buffer marker))
  8516. (pos (marker-position marker))
  8517. cdate today)
  8518. (org-with-remote-undo buffer
  8519. (with-current-buffer buffer
  8520. (widen)
  8521. (goto-char pos)
  8522. (if (not (org-at-timestamp-p))
  8523. (error "Cannot find time stamp"))
  8524. (when (and org-agenda-move-date-from-past-immediately-to-today
  8525. (equal arg 1)
  8526. (or (not what) (eq what 'day))
  8527. (not (save-match-data (org-at-date-range-p))))
  8528. (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
  8529. cdate (calendar-absolute-from-gregorian
  8530. (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
  8531. today (org-today))
  8532. (if (> today cdate)
  8533. ;; immediately shift to today
  8534. (setq arg (- today cdate))))
  8535. (org-timestamp-change arg (or what 'day))
  8536. (when (and (org-at-date-range-p)
  8537. (re-search-backward org-tr-regexp-both (point-at-bol)))
  8538. (let ((end org-last-changed-timestamp))
  8539. (org-timestamp-change arg (or what 'day))
  8540. (setq org-last-changed-timestamp
  8541. (concat org-last-changed-timestamp "--" end)))))
  8542. (org-agenda-show-new-time marker org-last-changed-timestamp))
  8543. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  8544. (defun org-agenda-date-earlier (arg &optional what)
  8545. "Change the date of this item to ARG day(s) earlier."
  8546. (interactive "p")
  8547. (org-agenda-date-later (- arg) what))
  8548. (defun org-agenda-date-later-minutes (arg)
  8549. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  8550. (interactive "p")
  8551. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  8552. (org-agenda-date-later arg 'minute))
  8553. (defun org-agenda-date-earlier-minutes (arg)
  8554. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  8555. (interactive "p")
  8556. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  8557. (org-agenda-date-earlier arg 'minute))
  8558. (defun org-agenda-date-later-hours (arg)
  8559. "Change the time of this item, in hour steps."
  8560. (interactive "p")
  8561. (org-agenda-date-later arg 'hour))
  8562. (defun org-agenda-date-earlier-hours (arg)
  8563. "Change the time of this item, in hour steps."
  8564. (interactive "p")
  8565. (org-agenda-date-earlier arg 'hour))
  8566. (defun org-agenda-show-new-time (marker stamp &optional prefix)
  8567. "Show new date stamp via text properties."
  8568. ;; We use text properties to make this undoable
  8569. (let ((inhibit-read-only t))
  8570. (setq stamp (concat prefix " => " stamp " "))
  8571. (save-excursion
  8572. (goto-char (point-max))
  8573. (while (not (bobp))
  8574. (when (equal marker (org-get-at-bol 'org-marker))
  8575. (remove-text-properties (point-at-bol) (point-at-eol) '(display))
  8576. (org-move-to-column (- (window-width) (length stamp)) t)
  8577. (add-text-properties
  8578. (1- (point)) (point-at-eol)
  8579. (list 'display (org-add-props stamp nil
  8580. 'face '(secondary-selection default))))
  8581. (beginning-of-line 1))
  8582. (beginning-of-line 0)))))
  8583. (defun org-agenda-date-prompt (arg)
  8584. "Change the date of this item. Date is prompted for, with default today.
  8585. The prefix ARG is passed to the `org-time-stamp' command and can therefore
  8586. be used to request time specification in the time stamp."
  8587. (interactive "P")
  8588. (org-agenda-check-type t 'agenda 'timeline)
  8589. (org-agenda-check-no-diary)
  8590. (let* ((marker (or (org-get-at-bol 'org-marker)
  8591. (org-agenda-error)))
  8592. (buffer (marker-buffer marker))
  8593. (pos (marker-position marker)))
  8594. (org-with-remote-undo buffer
  8595. (with-current-buffer buffer
  8596. (widen)
  8597. (goto-char pos)
  8598. (if (not (org-at-timestamp-p t))
  8599. (error "Cannot find time stamp"))
  8600. (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
  8601. (org-agenda-show-new-time marker org-last-changed-timestamp))
  8602. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  8603. (defun org-agenda-schedule (arg &optional time)
  8604. "Schedule the item at point.
  8605. ARG is passed through to `org-schedule'."
  8606. (interactive "P")
  8607. (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
  8608. (org-agenda-check-no-diary)
  8609. (let* ((marker (or (org-get-at-bol 'org-marker)
  8610. (org-agenda-error)))
  8611. (type (marker-insertion-type marker))
  8612. (buffer (marker-buffer marker))
  8613. (pos (marker-position marker))
  8614. ts)
  8615. (set-marker-insertion-type marker t)
  8616. (org-with-remote-undo buffer
  8617. (with-current-buffer buffer
  8618. (widen)
  8619. (goto-char pos)
  8620. (setq ts (org-schedule arg time)))
  8621. (org-agenda-show-new-time marker ts " S"))
  8622. (message "%s" ts)))
  8623. (defun org-agenda-deadline (arg &optional time)
  8624. "Schedule the item at point.
  8625. ARG is passed through to `org-deadline'."
  8626. (interactive "P")
  8627. (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
  8628. (org-agenda-check-no-diary)
  8629. (let* ((marker (or (org-get-at-bol 'org-marker)
  8630. (org-agenda-error)))
  8631. (buffer (marker-buffer marker))
  8632. (pos (marker-position marker))
  8633. ts)
  8634. (org-with-remote-undo buffer
  8635. (with-current-buffer buffer
  8636. (widen)
  8637. (goto-char pos)
  8638. (setq ts (org-deadline arg time)))
  8639. (org-agenda-show-new-time marker ts " D"))
  8640. (message "%s" ts)))
  8641. (defun org-agenda-clock-in (&optional arg)
  8642. "Start the clock on the currently selected item."
  8643. (interactive "P")
  8644. (org-agenda-check-no-diary)
  8645. (if (equal arg '(4))
  8646. (org-clock-in arg)
  8647. (let* ((marker (or (org-get-at-bol 'org-marker)
  8648. (org-agenda-error)))
  8649. (hdmarker (or (org-get-at-bol 'org-hd-marker) marker))
  8650. (pos (marker-p