org-agenda.el 447 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416
  1. ;;; org-agenda.el --- Dynamic task and appointment lists for Org -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2004-2022 Free Software Foundation, Inc.
  3. ;; Author: Carsten Dominik <carsten.dominik@gmail.com>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; URL: https://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 <https://www.gnu.org/licenses/>.
  19. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  20. ;;
  21. ;;; Commentary:
  22. ;; This file contains the code for creating and using the Agenda for Org.
  23. ;;
  24. ;; The functions `org-batch-agenda', `org-batch-agenda-csv', and
  25. ;; `org-batch-store-agenda-views' are implemented as macros to provide
  26. ;; a convenient way for extracting agenda information from the command
  27. ;; line. The Lisp does not evaluate parameters of a macro call; thus
  28. ;; it is not necessary to quote the parameters passed to one of those
  29. ;; functions. E.g. you can write:
  30. ;;
  31. ;; emacs -batch -l ~/.emacs -eval '(org-batch-agenda "a" org-agenda-span 7)'
  32. ;;
  33. ;; To export an agenda spanning 7 days. If `org-batch-agenda' would
  34. ;; have been implemented as a regular function you'd have to quote the
  35. ;; symbol org-agenda-span. Moreover: To use a symbol as parameter
  36. ;; value you would have to double quote the symbol.
  37. ;;
  38. ;; This is a hack, but it works even when running Org byte-compiled.
  39. ;;
  40. ;;; Code:
  41. (require 'org-macs)
  42. (org-assert-version)
  43. (require 'cl-lib)
  44. (require 'ol)
  45. (require 'org-fold-core)
  46. (require 'org)
  47. (require 'org-macs)
  48. (require 'org-refile)
  49. (declare-function diary-add-to-list "diary-lib"
  50. (date string specifier &optional marker globcolor literal))
  51. (declare-function calendar-iso-to-absolute "cal-iso" (date))
  52. (declare-function calendar-astro-date-string "cal-julian" (&optional date))
  53. (declare-function calendar-bahai-date-string "cal-bahai" (&optional date))
  54. (declare-function calendar-chinese-date-string "cal-china" (&optional date))
  55. (declare-function calendar-coptic-date-string "cal-coptic" (&optional date))
  56. (declare-function calendar-ethiopic-date-string "cal-coptic" (&optional date))
  57. (declare-function calendar-french-date-string "cal-french" (&optional date))
  58. (declare-function calendar-goto-date "cal-move" (date))
  59. (declare-function calendar-hebrew-date-string "cal-hebrew" (&optional date))
  60. (declare-function calendar-islamic-date-string "cal-islam" (&optional date))
  61. (declare-function calendar-iso-date-string "cal-iso" (&optional date))
  62. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  63. (declare-function calendar-julian-date-string "cal-julian" (&optional date))
  64. (declare-function calendar-mayan-date-string "cal-mayan" (&optional date))
  65. (declare-function calendar-persian-date-string "cal-persia" (&optional date))
  66. (declare-function calendar-check-holidays "holidays" (date))
  67. (declare-function org-columns-remove-overlays "org-colview" ())
  68. (declare-function org-datetree-find-date-create "org-datetree"
  69. (date &optional keep-restriction))
  70. (declare-function org-columns-quit "org-colview" ())
  71. (declare-function diary-date-display-form "diary-lib" (&optional type))
  72. (declare-function org-mobile-write-agenda-for-mobile "org-mobile" (file))
  73. (declare-function org-element-property "org-element" (property element))
  74. (declare-function org-element--cache-active-p "org-element"
  75. (&optional called-from-cache-change-func-p))
  76. (declare-function org-element-lineage "org-element"
  77. (datum &optional types with-self))
  78. (declare-function org-habit-insert-consistency-graphs
  79. "org-habit" (&optional line))
  80. (declare-function org-is-habit-p "org-habit" (&optional pom))
  81. (declare-function org-habit-parse-todo "org-habit" (&optional pom))
  82. (declare-function org-habit-get-priority "org-habit" (habit &optional moment))
  83. (declare-function org-agenda-columns "org-colview" ())
  84. (declare-function org-add-archive-files "org-archive" (files))
  85. (declare-function org-capture "org-capture" (&optional goto keys))
  86. (declare-function org-clock-modify-effort-estimate "org-clock" (&optional value))
  87. (declare-function org-element-type "org-element" (&optional element))
  88. (defvar calendar-mode-map)
  89. (defvar org-clock-current-task)
  90. (defvar org-current-tag-alist)
  91. (defvar org-mobile-force-id-on-agenda-items)
  92. (defvar org-habit-show-habits)
  93. (defvar org-habit-show-habits-only-for-today)
  94. (defvar org-habit-show-all-today)
  95. (defvar org-habit-scheduled-past-days)
  96. ;; Defined somewhere in this file, but used before definition.
  97. (defvar org-agenda-buffer-name "*Org Agenda*")
  98. (defvar org-agenda-title-append nil)
  99. (defvar org-agenda-overriding-header)
  100. ;; (with-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  101. ;; (with-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  102. (defvar original-date) ; dynamically scoped, calendar.el does scope this
  103. (defvar org-agenda-undo-list nil
  104. "List of undoable operations in the agenda since last refresh.")
  105. (defvar org-agenda-pending-undo-list nil
  106. "In a series of undo commands, this is the list of remaining undo items.")
  107. (defcustom org-agenda-confirm-kill 1
  108. "When set, remote killing from the agenda buffer needs confirmation.
  109. When t, a confirmation is always needed. When a number N, confirmation is
  110. only needed when the text to be killed contains more than N non-white lines."
  111. :group 'org-agenda
  112. :type '(choice
  113. (const :tag "Never" nil)
  114. (const :tag "Always" t)
  115. (integer :tag "When more than N lines")))
  116. (defcustom org-agenda-compact-blocks nil
  117. "Non-nil means make the block agenda more compact.
  118. This is done globally by leaving out lines like the agenda span
  119. name and week number or the separator lines."
  120. :group 'org-agenda
  121. :type 'boolean)
  122. (defcustom org-agenda-block-separator
  123. (if (and (display-graphic-p)
  124. (char-displayable-p ?─))
  125. ?─
  126. ?=)
  127. "The separator between blocks in the agenda.
  128. If this is a string, it will be used as the separator, with a newline added.
  129. If it is a character, it will be repeated to fill the window width.
  130. If nil the separator is disabled. In `org-agenda-custom-commands' this
  131. addresses the separator between the current and the previous block."
  132. :group 'org-agenda
  133. :version "29.1"
  134. :type '(choice
  135. (const :tag "Disabled" nil)
  136. (character)
  137. (string)))
  138. (defgroup org-agenda-export nil
  139. "Options concerning exporting agenda views in Org mode."
  140. :tag "Org Agenda Export"
  141. :group 'org-agenda)
  142. (defcustom org-agenda-with-colors t
  143. "Non-nil means use colors in agenda views."
  144. :group 'org-agenda-export
  145. :type 'boolean)
  146. (defcustom org-agenda-exporter-settings nil
  147. ;; FIXME: Do we really want to evaluate those settings and thus force
  148. ;; the user to use `quote' all the time?
  149. "Alist of variable/value pairs that should be active during agenda export.
  150. This is a good place to set options for ps-print and for htmlize.
  151. Note that the way this is implemented, the values will be evaluated
  152. before assigned to the variables. So make sure to quote values you do
  153. *not* want evaluated, for example
  154. (setq org-agenda-exporter-settings
  155. \\='((ps-print-color-p \\='black-white)))"
  156. :group 'org-agenda-export
  157. :type '(repeat
  158. (list
  159. (variable)
  160. (sexp :tag "Value"))))
  161. (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
  162. "Hook run in a temporary buffer before writing the agenda to an export file.
  163. A useful function for this hook is `org-agenda-add-entry-text'."
  164. :group 'org-agenda-export
  165. :type 'hook
  166. :options '(org-agenda-add-entry-text))
  167. (defcustom org-agenda-add-entry-text-maxlines 0
  168. "Maximum number of entry text lines to be added to agenda.
  169. This is only relevant when `org-agenda-add-entry-text' is part of
  170. `org-agenda-before-write-hook', which is the default.
  171. When this is 0, nothing will happen. When it is greater than 0, it
  172. specifies the maximum number of lines that will be added for each entry
  173. that is listed in the agenda view.
  174. Note that this variable is not used during display, only when exporting
  175. the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
  176. and `org-agenda-entry-text-maxlines'."
  177. :group 'org-agenda
  178. :type 'integer)
  179. (defcustom org-agenda-add-entry-text-descriptive-links t
  180. "Non-nil means export org-links as descriptive links in agenda added text.
  181. This variable applies to the text added to the agenda when
  182. `org-agenda-add-entry-text-maxlines' is larger than 0.
  183. When this variable is nil, the URL will (also) be shown."
  184. :group 'org-agenda
  185. :type 'boolean)
  186. (defcustom org-agenda-export-html-style nil
  187. "The style specification for exported HTML Agenda files.
  188. If this variable contains a string, it will replace the default <style>
  189. section as produced by `htmlize'.
  190. Since there are different ways of setting style information, this variable
  191. needs to contain the full HTML structure to provide a style, including the
  192. surrounding HTML tags. The style specifications should include definitions
  193. the fonts used by the agenda, here is an example:
  194. <style type=\"text/css\">
  195. p { font-weight: normal; color: gray; }
  196. .org-agenda-structure {
  197. font-size: 110%;
  198. color: #003399;
  199. font-weight: 600;
  200. }
  201. .org-todo {
  202. color: #cc6666;
  203. font-weight: bold;
  204. }
  205. .org-agenda-done {
  206. color: #339933;
  207. }
  208. .org-done {
  209. color: #339933;
  210. }
  211. .title { text-align: center; }
  212. .todo, .deadline { color: red; }
  213. .done { color: green; }
  214. </style>
  215. or, if you want to keep the style in a file,
  216. <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
  217. As the value of this option simply gets inserted into the HTML <head> header,
  218. you can \"misuse\" it to also add other text to the header."
  219. :group 'org-agenda-export
  220. :group 'org-export-html
  221. :type '(choice
  222. (const nil)
  223. (string)))
  224. (defcustom org-agenda-persistent-filter nil
  225. "When set, keep filters from one agenda view to the next."
  226. :group 'org-agenda
  227. :type 'boolean)
  228. (defgroup org-agenda-custom-commands nil
  229. "Options concerning agenda views in Org mode."
  230. :tag "Org Agenda Custom Commands"
  231. :group 'org-agenda)
  232. (defconst org-sorting-choice
  233. '(choice
  234. (const time-up) (const time-down)
  235. (const timestamp-up) (const timestamp-down)
  236. (const scheduled-up) (const scheduled-down)
  237. (const deadline-up) (const deadline-down)
  238. (const ts-up) (const ts-down)
  239. (const tsia-up) (const tsia-down)
  240. (const category-keep) (const category-up) (const category-down)
  241. (const tag-down) (const tag-up)
  242. (const priority-up) (const priority-down)
  243. (const todo-state-up) (const todo-state-down)
  244. (const effort-up) (const effort-down)
  245. (const habit-up) (const habit-down)
  246. (const alpha-up) (const alpha-down)
  247. (const user-defined-up) (const user-defined-down))
  248. "Sorting choices.")
  249. ;; Keep custom values for `org-agenda-filter-preset' compatible with
  250. ;; the new variable `org-agenda-tag-filter-preset'.
  251. (defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
  252. (defvaralias 'org-agenda-filter 'org-agenda-tag-filter)
  253. (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
  254. "List of types searched for when creating the daily/weekly agenda.
  255. This variable is a list of symbols that controls the types of
  256. items that appear in the daily/weekly agenda. Allowed symbols in this
  257. list are
  258. :timestamp List items containing a date stamp or date range matching
  259. the selected date. This includes sexp entries in angular
  260. brackets.
  261. :sexp List entries resulting from plain diary-like sexps.
  262. :deadline List deadline due on that date. When the date is today,
  263. also list any deadlines past due, or due within
  264. `org-deadline-warning-days'.
  265. :deadline* Same as above, but only include the deadline if it has an
  266. hour specification as [h]h:mm.
  267. :scheduled List all items which are scheduled for the given date.
  268. The diary for *today* also contains items which were
  269. scheduled earlier and are not yet marked DONE.
  270. :scheduled* Same as above, but only include the scheduled item if it
  271. has an hour specification as [h]h:mm.
  272. By default, all four non-starred types are turned on.
  273. When :scheduled* or :deadline* are included, :schedule or :deadline
  274. will be ignored.
  275. Never set this variable globally using `setq', because then it
  276. will apply to all future agenda commands. Instead, bind it with
  277. `let' to scope it dynamically into the agenda-constructing
  278. command. A good way to set it is through options in
  279. `org-agenda-custom-commands'. For a more flexible (though
  280. somewhat less efficient) way of determining what is included in
  281. the daily/weekly agenda, see `org-agenda-skip-function'.")
  282. (defconst org-agenda-custom-commands-local-options
  283. `(repeat :tag "Local settings for this command. Remember to quote values"
  284. (choice :tag "Setting"
  285. (list :tag "Heading for this block"
  286. (const org-agenda-overriding-header)
  287. (string :tag "Headline"))
  288. (list :tag "Files to be searched"
  289. (const org-agenda-files)
  290. (list
  291. (const :format "" quote)
  292. (repeat (file))))
  293. (list :tag "Sorting strategy"
  294. (const org-agenda-sorting-strategy)
  295. (list
  296. (const :format "" quote)
  297. (repeat
  298. ,org-sorting-choice)))
  299. (list :tag "Prefix format"
  300. (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
  301. (string))
  302. (list :tag "Number of days in agenda"
  303. (const org-agenda-span)
  304. (list
  305. (const :format "" quote)
  306. (choice (const :tag "Day" day)
  307. (const :tag "Week" week)
  308. (const :tag "Fortnight" fortnight)
  309. (const :tag "Month" month)
  310. (const :tag "Year" year)
  311. (integer :tag "Custom"))))
  312. (list :tag "Fixed starting date"
  313. (const org-agenda-start-day)
  314. (string :value "2007-11-01"))
  315. (list :tag "Start on day of week"
  316. (const org-agenda-start-on-weekday)
  317. (choice :value 1
  318. (const :tag "Today" nil)
  319. (integer :tag "Weekday No.")))
  320. (list :tag "Include data from diary"
  321. (const org-agenda-include-diary)
  322. (boolean))
  323. (list :tag "Deadline Warning days"
  324. (const org-deadline-warning-days)
  325. (integer :value 1))
  326. (list :tag "Category filter preset"
  327. (const org-agenda-category-filter-preset)
  328. (list
  329. (const :format "" quote)
  330. (repeat
  331. (string :tag "+category or -category"))))
  332. (list :tag "Tags filter preset"
  333. (const org-agenda-tag-filter-preset)
  334. (list
  335. (const :format "" quote)
  336. (repeat
  337. (string :tag "+tag or -tag"))))
  338. (list :tag "Effort filter preset"
  339. (const org-agenda-effort-filter-preset)
  340. (list
  341. (const :format "" quote)
  342. (repeat
  343. (string :tag "+=10 or -=10 or +<10 or ->10"))))
  344. (list :tag "Regexp filter preset"
  345. (const org-agenda-regexp-filter-preset)
  346. (list
  347. (const :format "" quote)
  348. (repeat
  349. (string :tag "+regexp or -regexp"))))
  350. (list :tag "Set daily/weekly entry types"
  351. (const org-agenda-entry-types)
  352. (list
  353. (const :format "" quote)
  354. (set :greedy t :value ,org-agenda-entry-types
  355. (const :deadline)
  356. (const :scheduled)
  357. (const :deadline*)
  358. (const :scheduled*)
  359. (const :timestamp)
  360. (const :sexp))))
  361. (list :tag "Columns format"
  362. (const org-overriding-columns-format)
  363. (string :tag "Format"))
  364. (list :tag "Standard skipping condition"
  365. :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
  366. (const org-agenda-skip-function)
  367. (list
  368. (const :format "" quote)
  369. (list
  370. (choice
  371. :tag "Skipping range"
  372. (const :tag "Skip entry" org-agenda-skip-entry-if)
  373. (const :tag "Skip subtree" org-agenda-skip-subtree-if))
  374. (repeat :inline t :tag "Conditions for skipping"
  375. (choice
  376. :tag "Condition type"
  377. (list :tag "Regexp matches" :inline t
  378. (const :format "" regexp)
  379. (regexp))
  380. (list :tag "Regexp does not match" :inline t
  381. (const :format "" notregexp)
  382. (regexp))
  383. (list :tag "TODO state is" :inline t
  384. (const todo)
  385. (choice
  386. (const :tag "Any not-done state" todo)
  387. (const :tag "Any done state" done)
  388. (const :tag "Any state" any)
  389. (list :tag "Keyword list"
  390. (const :format "" quote)
  391. (repeat (string :tag "Keyword")))))
  392. (list :tag "TODO state is not" :inline t
  393. (const nottodo)
  394. (choice
  395. (const :tag "Any not-done state" todo)
  396. (const :tag "Any done state" done)
  397. (const :tag "Any state" any)
  398. (list :tag "Keyword list"
  399. (const :format "" quote)
  400. (repeat (string :tag "Keyword")))))
  401. (const :tag "scheduled" scheduled)
  402. (const :tag "not scheduled" notscheduled)
  403. (const :tag "deadline" deadline)
  404. (const :tag "no deadline" notdeadline)
  405. (const :tag "timestamp" timestamp)
  406. (const :tag "no timestamp" nottimestamp))))))
  407. (list :tag "Non-standard skipping condition"
  408. :value (org-agenda-skip-function)
  409. (const org-agenda-skip-function)
  410. (sexp :tag "Function or form (quoted!)"))
  411. (list :tag "Any variable"
  412. (variable :tag "Variable")
  413. (sexp :tag "Value (sexp)"))))
  414. "Selection of examples for agenda command settings.
  415. This will be spliced into the custom type of
  416. `org-agenda-custom-commands'.")
  417. (defcustom org-agenda-custom-commands
  418. '(("n" "Agenda and all TODOs" ((agenda "") (alltodo ""))))
  419. "Custom commands for the agenda.
  420. \\<org-mode-map>
  421. These commands will be offered on the splash screen displayed by the
  422. agenda dispatcher `\\[org-agenda]'. Each entry is a list like this:
  423. (key desc type match settings files)
  424. key The key (one or more characters as a string) to be associated
  425. with the command.
  426. desc A description of the command. When omitted or nil, a default
  427. description is built using MATCH.
  428. type The command type, any of the following symbols:
  429. agenda The daily/weekly agenda.
  430. agenda* Appointments for current week/day.
  431. todo Entries with a specific TODO keyword, in all agenda files.
  432. search Entries containing search words entry or headline.
  433. tags Tags/Property/TODO match in all agenda files.
  434. tags-todo Tags/P/T match in all agenda files, TODO entries only.
  435. todo-tree Sparse tree of specific TODO keyword in *current* file.
  436. tags-tree Sparse tree with all tags matches in *current* file.
  437. occur-tree Occur sparse tree for *current* file.
  438. alltodo The global TODO list.
  439. stuck Stuck projects.
  440. ... A user-defined function.
  441. match What to search for:
  442. - a single keyword for TODO keyword searches
  443. - a tags/property/todo match expression for searches
  444. - a word search expression for text searches.
  445. - a regular expression for occur searches
  446. For all other commands, this should be the empty string.
  447. settings A list of option settings, similar to that in a let form, so like
  448. this: ((opt1 val1) (opt2 val2) ...). The values will be
  449. evaluated at the moment of execution, so quote them when needed.
  450. files A list of files to write the produced agenda buffer to with
  451. the command `org-store-agenda-views'.
  452. If a file name ends in \".html\", an HTML version of the buffer
  453. is written out. If it ends in \".ps\", a PostScript version is
  454. produced. Otherwise, only the plain text is written to the file.
  455. You can also define a set of commands, to create a composite agenda buffer.
  456. In this case, an entry looks like this:
  457. (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
  458. where
  459. desc A description string to be displayed in the dispatcher menu.
  460. cmd An agenda command, similar to the above. However, tree commands
  461. are not allowed. Valid commands for a set are:
  462. (agenda \"\" settings)
  463. (agenda* \"\" settings)
  464. (alltodo \"\" settings)
  465. (stuck \"\" settings)
  466. (todo \"match\" settings files)
  467. (search \"match\" settings files)
  468. (tags \"match\" settings files)
  469. (tags-todo \"match\" settings files)
  470. Each command can carry a list of options, and another set of options can be
  471. given for the whole set of commands. Individual command options take
  472. precedence over the general options.
  473. When using several characters as key to a command, the first characters
  474. are prefix commands. For the dispatcher to display useful information, you
  475. should provide a description for the prefix, like
  476. (setq org-agenda-custom-commands
  477. \\='((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
  478. (\"hl\" tags \"+HOME+Lisa\")
  479. (\"hp\" tags \"+HOME+Peter\")
  480. (\"hk\" tags \"+HOME+Kim\")))
  481. See also Info node `(org) Custom Agenda Views'."
  482. :group 'org-agenda-custom-commands
  483. :type `(repeat
  484. (choice :value ("x" "Describe command here" tags "" nil)
  485. (list :tag "Single command"
  486. (string :tag "Access Key(s) ")
  487. (option (string :tag "Description"))
  488. (choice
  489. (const :tag "Agenda" agenda)
  490. (const :tag "TODO list" alltodo)
  491. (const :tag "Search words" search)
  492. (const :tag "Stuck projects" stuck)
  493. (const :tag "Tags/Property match (all agenda files)" tags)
  494. (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
  495. (const :tag "TODO keyword search (all agenda files)" todo)
  496. (const :tag "Tags sparse tree (current buffer)" tags-tree)
  497. (const :tag "TODO keyword tree (current buffer)" todo-tree)
  498. (const :tag "Occur tree (current buffer)" occur-tree)
  499. (sexp :tag "Other, user-defined function"))
  500. (string :tag "Match (only for some commands)")
  501. ,org-agenda-custom-commands-local-options
  502. (option (repeat :tag "Export" (file :tag "Export to"))))
  503. (list :tag "Command series, all agenda files"
  504. (string :tag "Access Key(s)")
  505. (string :tag "Description ")
  506. (repeat :tag "Component"
  507. (choice
  508. (list :tag "Agenda"
  509. (const :format "" agenda)
  510. (const :tag "" :format "" "")
  511. ,org-agenda-custom-commands-local-options)
  512. (list :tag "TODO list (all keywords)"
  513. (const :format "" alltodo)
  514. (const :tag "" :format "" "")
  515. ,org-agenda-custom-commands-local-options)
  516. (list :tag "Search words"
  517. (const :format "" search)
  518. (string :tag "Match")
  519. ,org-agenda-custom-commands-local-options)
  520. (list :tag "Stuck projects"
  521. (const :format "" stuck)
  522. (const :tag "" :format "" "")
  523. ,org-agenda-custom-commands-local-options)
  524. (list :tag "Tags/Property match (all agenda files)"
  525. (const :format "" tags)
  526. (string :tag "Match")
  527. ,org-agenda-custom-commands-local-options)
  528. (list :tag "Tags/Property match of TODO entries (all agenda files)"
  529. (const :format "" tags-todo)
  530. (string :tag "Match")
  531. ,org-agenda-custom-commands-local-options)
  532. (list :tag "TODO keyword search"
  533. (const :format "" todo)
  534. (string :tag "Match")
  535. ,org-agenda-custom-commands-local-options)
  536. (list :tag "Other, user-defined function"
  537. (symbol :tag "function")
  538. (string :tag "Match")
  539. ,org-agenda-custom-commands-local-options)))
  540. (repeat :tag "Settings for entire command set"
  541. (list (variable :tag "Any variable")
  542. (sexp :tag "Value")))
  543. (option (repeat :tag "Export" (file :tag "Export to"))))
  544. (cons :tag "Prefix key documentation"
  545. (string :tag "Access Key(s)")
  546. (string :tag "Description ")))))
  547. (defcustom org-agenda-query-register ?o
  548. "The register holding the current query string.
  549. The purpose of this is that if you construct a query string interactively,
  550. you can then use it to define a custom command."
  551. :group 'org-agenda-custom-commands
  552. :type 'character)
  553. (defcustom org-stuck-projects
  554. '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
  555. "How to identify stuck projects.
  556. This is a list of four items:
  557. 1. A tags/todo/property matcher string that is used to identify a project.
  558. See the manual for a description of tag and property searches.
  559. The entire tree below a headline matched by this is considered one project.
  560. 2. A list of TODO keywords identifying non-stuck projects.
  561. If the project subtree contains any headline with one of these todo
  562. keywords, the project is considered to be not stuck. If you specify
  563. \"*\" as a keyword, any TODO keyword will mark the project unstuck.
  564. 3. A list of tags identifying non-stuck projects.
  565. If the project subtree contains any headline with one of these tags,
  566. the project is considered to be not stuck. If you specify \"*\" as
  567. a tag, any tag will mark the project unstuck. Note that this is about
  568. the explicit presence of a tag somewhere in the subtree, inherited
  569. tags do not count here. If inherited tags make a project not stuck,
  570. use \"-TAG\" in the tags part of the matcher under (1.) above.
  571. 4. An arbitrary regular expression matching non-stuck projects.
  572. If the project turns out to be not stuck, search continues also in the
  573. subtree to see if any of the subtasks have project status.
  574. See also the variable `org-tags-match-list-sublevels' which applies
  575. to projects matched by this search as well.
  576. After defining this variable, you may use `org-agenda-list-stuck-projects'
  577. \(bound to `\\[org-agenda] #') to produce the list."
  578. :group 'org-agenda-custom-commands
  579. :type '(list
  580. (string :tag "Tags/TODO match to identify a project")
  581. (repeat :tag "Projects are *not* stuck if they have an entry with \
  582. TODO keyword any of" (string))
  583. (repeat :tag "Projects are *not* stuck if they have an entry with \
  584. TAG being any of" (string))
  585. (regexp :tag "Projects are *not* stuck if this regexp matches inside \
  586. the subtree")))
  587. (defgroup org-agenda-skip nil
  588. "Options concerning skipping parts of agenda files."
  589. :tag "Org Agenda Skip"
  590. :group 'org-agenda)
  591. (defcustom org-agenda-skip-function-global nil
  592. "Function to be called at each match during agenda construction.
  593. If this function returns nil, the current match should not be skipped.
  594. If the function decided to skip an agenda match, is must return the
  595. buffer position from which the search should be continued.
  596. This may also be a Lisp form, which will be evaluated.
  597. This variable will be applied to every agenda match, including
  598. tags/property searches and TODO lists. So try to make the test function
  599. do its checking as efficiently as possible. To implement a skipping
  600. condition just for specific agenda commands, use the variable
  601. `org-agenda-skip-function' which can be set in the options section
  602. of custom agenda commands."
  603. :group 'org-agenda-skip
  604. :type 'sexp)
  605. (defgroup org-agenda-daily/weekly nil
  606. "Options concerning the daily/weekly agenda."
  607. :tag "Org Agenda Daily/Weekly"
  608. :group 'org-agenda)
  609. (defgroup org-agenda-todo-list nil
  610. "Options concerning the global todo list agenda view."
  611. :tag "Org Agenda Todo List"
  612. :group 'org-agenda)
  613. (defgroup org-agenda-match-view nil
  614. "Options concerning the general tags/property/todo match agenda view."
  615. :tag "Org Agenda Match View"
  616. :group 'org-agenda)
  617. (defgroup org-agenda-search-view nil
  618. "Options concerning the search agenda view."
  619. :tag "Org Agenda Search View"
  620. :group 'org-agenda)
  621. (defvar org-agenda-archives-mode nil
  622. "Non-nil means the agenda will include archived items.
  623. If this is the symbol `trees', trees in the selected agenda scope
  624. that are marked with the ARCHIVE tag will be included anyway. When this is
  625. t, also all archive files associated with the current selection of agenda
  626. files will be included.")
  627. (defcustom org-agenda-restriction-lock-highlight-subtree t
  628. "Non-nil means highlight the whole subtree when restriction is active.
  629. Otherwise only highlight the headline. Highlighting the whole subtree is
  630. useful to ensure no edits happen beyond the restricted region."
  631. :group 'org-agenda
  632. :type 'boolean)
  633. (defcustom org-agenda-skip-comment-trees t
  634. "Non-nil means skip trees that start with the COMMENT keyword.
  635. When nil, these trees are also scanned by agenda commands."
  636. :group 'org-agenda-skip
  637. :type 'boolean)
  638. (defcustom org-agenda-todo-list-sublevels t
  639. "Non-nil means check also the sublevels of a TODO entry for TODO entries.
  640. When nil, the sublevels of a TODO entry are not checked, resulting in
  641. potentially much shorter TODO lists."
  642. :group 'org-agenda-skip
  643. :group 'org-agenda-todo-list
  644. :type 'boolean)
  645. (defcustom org-agenda-todo-ignore-with-date nil
  646. "Non-nil means don't show entries with a date in the global todo list.
  647. You can use this if you prefer to mark mere appointments with a TODO keyword,
  648. but don't want them to show up in the TODO list.
  649. When this is set, it also covers deadlines and scheduled items, the settings
  650. of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
  651. will be ignored.
  652. See also the variable `org-agenda-tags-todo-honor-ignore-options'."
  653. :group 'org-agenda-skip
  654. :group 'org-agenda-todo-list
  655. :type 'boolean)
  656. (defcustom org-agenda-todo-ignore-timestamp nil
  657. "Non-nil means don't show entries with a timestamp.
  658. This applies when creating the global todo list.
  659. Valid values are:
  660. past Don't show entries for today or in the past.
  661. future Don't show entries with a timestamp in the future.
  662. The idea behind this is that if it has a future
  663. timestamp, you don't want to think about it until the
  664. date.
  665. all Don't show any entries with a timestamp in the global todo list.
  666. The idea behind this is that by setting a timestamp, you
  667. have already \"taken care\" of this item.
  668. This variable can also have an integer as a value. If positive (N),
  669. todos with a timestamp N or more days in the future will be ignored. If
  670. negative (-N), todos with a timestamp N or more days in the past will be
  671. ignored. If 0, todos with a timestamp either today or in the future will
  672. be ignored. For example, a value of -1 will exclude todos with a
  673. timestamp in the past (yesterday or earlier), while a value of 7 will
  674. exclude todos with a timestamp a week or more in the future.
  675. See also `org-agenda-todo-ignore-with-date'.
  676. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  677. to make his option also apply to the tags-todo list."
  678. :group 'org-agenda-skip
  679. :group 'org-agenda-todo-list
  680. :version "24.1"
  681. :type '(choice
  682. (const :tag "Ignore future timestamp todos" future)
  683. (const :tag "Ignore past or present timestamp todos" past)
  684. (const :tag "Ignore all timestamp todos" all)
  685. (const :tag "Show timestamp todos" nil)
  686. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  687. (defcustom org-agenda-todo-ignore-scheduled nil
  688. "Non-nil means, ignore some scheduled TODO items when making TODO list.
  689. This applies when creating the global todo list.
  690. Valid values are:
  691. past Don't show entries scheduled today or in the past.
  692. future Don't show entries scheduled in the future.
  693. The idea behind this is that by scheduling it, you don't want to
  694. think about it until the scheduled date.
  695. all Don't show any scheduled entries in the global todo list.
  696. The idea behind this is that by scheduling it, you have already
  697. \"taken care\" of this item.
  698. t Same as `all', for backward compatibility.
  699. This variable can also have an integer as a value. See
  700. `org-agenda-todo-ignore-timestamp' for more details.
  701. See also `org-agenda-todo-ignore-with-date'.
  702. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  703. to make his option also apply to the tags-todo list."
  704. :group 'org-agenda-skip
  705. :group 'org-agenda-todo-list
  706. :type '(choice
  707. (const :tag "Ignore future-scheduled todos" future)
  708. (const :tag "Ignore past- or present-scheduled todos" past)
  709. (const :tag "Ignore all scheduled todos" all)
  710. (const :tag "Ignore all scheduled todos (compatibility)" t)
  711. (const :tag "Show scheduled todos" nil)
  712. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  713. (defcustom org-agenda-todo-ignore-deadlines nil
  714. "Non-nil means ignore some deadline TODO items when making TODO list.
  715. There are different motivations for using different values, please think
  716. carefully when configuring this variable.
  717. This applies when creating the global TODO list.
  718. Valid values are:
  719. near Don't show near deadline entries. A deadline is near when it is
  720. closer than `org-deadline-warning-days' days. The idea behind this
  721. is that such items will appear in the agenda anyway.
  722. far Don't show TODO entries where a deadline has been defined, but
  723. is not going to happen anytime soon. This is useful if you want to use
  724. the TODO list to figure out what to do now.
  725. past Don't show entries with a deadline timestamp for today or in the past.
  726. future Don't show entries with a deadline timestamp in the future, not even
  727. when they become `near' ones. Use it with caution.
  728. all Ignore all TODO entries that do have a deadline.
  729. t Same as `near', for backward compatibility.
  730. This variable can also have an integer as a value. See
  731. `org-agenda-todo-ignore-timestamp' for more details.
  732. See also `org-agenda-todo-ignore-with-date'.
  733. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  734. to make his option also apply to the tags-todo list."
  735. :group 'org-agenda-skip
  736. :group 'org-agenda-todo-list
  737. :type '(choice
  738. (const :tag "Ignore near deadlines" near)
  739. (const :tag "Ignore near deadlines (compatibility)" t)
  740. (const :tag "Ignore far deadlines" far)
  741. (const :tag "Ignore all TODOs with a deadlines" all)
  742. (const :tag "Show all TODOs, even if they have a deadline" nil)
  743. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  744. (defcustom org-agenda-todo-ignore-time-comparison-use-seconds nil
  745. "Time unit to use when possibly ignoring an agenda item.
  746. See the docstring of various `org-agenda-todo-ignore-*' options.
  747. The default is to compare time stamps using days. An item is thus
  748. considered to be in the future if it is at least one day after today.
  749. Non-nil means to compare time stamps using seconds. An item is then
  750. considered future if it has a time value later than current time."
  751. :group 'org-agenda-skip
  752. :group 'org-agenda-todo-list
  753. :version "24.4"
  754. :package-version '(Org . "8.0")
  755. :type '(choice
  756. (const :tag "Compare time with days" nil)
  757. (const :tag "Compare time with seconds" t)))
  758. (defcustom org-agenda-tags-todo-honor-ignore-options nil
  759. "Non-nil means honor todo-list ignores options also in tags-todo search.
  760. The variables
  761. `org-agenda-todo-ignore-with-date',
  762. `org-agenda-todo-ignore-timestamp',
  763. `org-agenda-todo-ignore-scheduled',
  764. `org-agenda-todo-ignore-deadlines'
  765. make the global TODO list skip entries that have time stamps of certain
  766. kinds. If this option is set, the same options will also apply for the
  767. tags-todo search, which is the general tags/property matcher
  768. restricted to unfinished TODO entries only."
  769. :group 'org-agenda-skip
  770. :group 'org-agenda-todo-list
  771. :group 'org-agenda-match-view
  772. :type 'boolean)
  773. (defcustom org-agenda-skip-scheduled-if-done nil
  774. "Non-nil means don't show scheduled items in agenda when they are done.
  775. This is relevant for the daily/weekly agenda, not for the TODO list. It
  776. applies only to the actual date of the scheduling. Warnings about an item
  777. with a past scheduling dates are always turned off when the item is DONE."
  778. :group 'org-agenda-skip
  779. :group 'org-agenda-daily/weekly
  780. :type 'boolean)
  781. (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
  782. "Non-nil means skip scheduling line if same entry shows because of deadline.
  783. In the agenda of today, an entry can show up multiple times
  784. because it is both scheduled and has a nearby deadline, and maybe
  785. a plain time stamp as well.
  786. When this variable is nil, the entry will be shown several times.
  787. When set to t, then only the deadline is shown and the fact that
  788. the entry is scheduled today or was scheduled previously is not
  789. shown.
  790. When set to the symbol `not-today', skip scheduled previously,
  791. but not scheduled today.
  792. When set to the symbol `repeated-after-deadline', skip scheduled
  793. items if they are repeated beyond the current deadline."
  794. :group 'org-agenda-skip
  795. :group 'org-agenda-daily/weekly
  796. :type '(choice
  797. (const :tag "Never" nil)
  798. (const :tag "Always" t)
  799. (const :tag "Not when scheduled today" not-today)
  800. (const :tag "When repeated past deadline" repeated-after-deadline)))
  801. (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
  802. "Non-nil means skip timestamp line if same entry shows because of deadline.
  803. In the agenda of today, an entry can show up multiple times
  804. because it has both a plain timestamp and has a nearby deadline.
  805. When this variable is t, then only the deadline is shown and the
  806. fact that the entry has a timestamp for or including today is not
  807. shown. When this variable is nil, the entry will be shown
  808. several times."
  809. :group 'org-agenda-skip
  810. :group 'org-agenda-daily/weekly
  811. :version "24.1"
  812. :type '(choice
  813. (const :tag "Never" nil)
  814. (const :tag "Always" t)))
  815. (defcustom org-agenda-skip-deadline-if-done nil
  816. "Non-nil means don't show deadlines when the corresponding item is done.
  817. When nil, the deadline is still shown and should give you a happy feeling.
  818. This is relevant for the daily/weekly agenda. It applies only to the
  819. actual date of the deadline. Warnings about approaching and past-due
  820. deadlines are always turned off when the item is DONE."
  821. :group 'org-agenda-skip
  822. :group 'org-agenda-daily/weekly
  823. :type 'boolean)
  824. (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
  825. "Non-nil means skip deadline prewarning when entry is also scheduled.
  826. This will apply on all days where a prewarning for the deadline would
  827. be shown, but not at the day when the entry is actually due. On that day,
  828. the deadline will be shown anyway.
  829. This variable may be set to nil, t, the symbol `pre-scheduled',
  830. or a number which will then give the number of days before the actual
  831. deadline when the prewarnings should resume. The symbol `pre-scheduled'
  832. eliminates the deadline prewarning only prior to the scheduled date.
  833. This can be used in a workflow where the first showing of the deadline will
  834. trigger you to schedule it, and then you don't want to be reminded of it
  835. because you will take care of it on the day when scheduled."
  836. :group 'org-agenda-skip
  837. :group 'org-agenda-daily/weekly
  838. :version "24.1"
  839. :type '(choice
  840. (const :tag "Always show prewarning" nil)
  841. (const :tag "Remove prewarning prior to scheduled date" pre-scheduled)
  842. (const :tag "Remove prewarning if entry is scheduled" t)
  843. (integer :tag "Restart prewarning N days before deadline")))
  844. (defcustom org-agenda-skip-scheduled-delay-if-deadline nil
  845. "Non-nil means skip scheduled delay when entry also has a deadline.
  846. This variable may be set to nil, t, the symbol `post-deadline',
  847. or a number which will then give the number of days after the actual
  848. scheduled date when the delay should expire. The symbol `post-deadline'
  849. eliminates the schedule delay when the date is posterior to the deadline."
  850. :group 'org-agenda-skip
  851. :group 'org-agenda-daily/weekly
  852. :version "24.4"
  853. :package-version '(Org . "8.0")
  854. :type '(choice
  855. (const :tag "Always honor delay" nil)
  856. (const :tag "Ignore delay if posterior to the deadline" post-deadline)
  857. (const :tag "Ignore delay if entry has a deadline" t)
  858. (integer :tag "Honor delay up until N days after the scheduled date")))
  859. (defcustom org-agenda-skip-additional-timestamps-same-entry nil
  860. "When nil, multiple same-day timestamps in entry make multiple agenda lines.
  861. When non-nil, after the search for timestamps has matched once in an
  862. entry, the rest of the entry will not be searched."
  863. :group 'org-agenda-skip
  864. :type 'boolean)
  865. (defcustom org-agenda-skip-timestamp-if-done nil
  866. "Non-nil means don't select item by timestamp or -range if it is DONE."
  867. :group 'org-agenda-skip
  868. :group 'org-agenda-daily/weekly
  869. :type 'boolean)
  870. (defcustom org-agenda-dim-blocked-tasks t
  871. "Non-nil means dim blocked tasks in the agenda display.
  872. This causes some overhead during agenda construction, but if you
  873. have turned on `org-enforce-todo-dependencies',
  874. `org-enforce-todo-checkbox-dependencies', or any other blocking
  875. mechanism, this will create useful feedback in the agenda.
  876. Instead of t, this variable can also have the value `invisible'.
  877. Then blocked tasks will be invisible and only become visible when
  878. they become unblocked. An exemption to this behavior is when a task is
  879. blocked because of unchecked checkboxes below it. Since checkboxes do
  880. not show up in the agenda views, making this task invisible you remove any
  881. trace from agenda views that there is something to do. Therefore, a task
  882. that is blocked because of checkboxes will never be made invisible, it
  883. will only be dimmed."
  884. :group 'org-agenda-daily/weekly
  885. :group 'org-agenda-todo-list
  886. :version "24.3"
  887. :type '(choice
  888. (const :tag "Do not dim" nil)
  889. (const :tag "Dim to a gray face" t)
  890. (const :tag "Make invisible" invisible)))
  891. (defgroup org-agenda-startup nil
  892. "Options concerning initial settings in the Agenda in Org Mode."
  893. :tag "Org Agenda Startup"
  894. :group 'org-agenda)
  895. (defcustom org-agenda-menu-show-matcher t
  896. "Non-nil means show the match string in the agenda dispatcher menu.
  897. When nil, the matcher string is not shown, but is put into the help-echo
  898. property so than moving the mouse over the command shows it.
  899. Setting it to nil is good if matcher strings are very long and/or if
  900. you want to use two-columns display (see `org-agenda-menu-two-columns')."
  901. :group 'org-agenda
  902. :version "24.1"
  903. :type 'boolean)
  904. (defcustom org-agenda-menu-two-columns nil
  905. "Non-nil means, use two columns to show custom commands in the dispatcher.
  906. If you use this, you probably want to set `org-agenda-menu-show-matcher'
  907. to nil."
  908. :group 'org-agenda
  909. :version "24.1"
  910. :type 'boolean)
  911. (defcustom org-agenda-finalize-hook nil
  912. "Hook run just before displaying an agenda buffer.
  913. The buffer is still writable when the hook is called.
  914. You can modify some of the buffer substrings but you should be
  915. extra careful not to modify the text properties of the agenda
  916. headlines as the agenda display heavily relies on them."
  917. :group 'org-agenda-startup
  918. :type 'hook)
  919. (defcustom org-agenda-filter-hook nil
  920. "Hook run just after filtering with `org-agenda-filter'."
  921. :group 'org-agenda-startup
  922. :package-version '(Org . "9.4")
  923. :type 'hook)
  924. (defcustom org-agenda-mouse-1-follows-link nil
  925. "Non-nil means mouse-1 on a link will follow the link in the agenda.
  926. A longer mouse click will still set point. Needs to be set
  927. before org.el is loaded."
  928. :group 'org-agenda-startup
  929. :type 'boolean)
  930. (defcustom org-agenda-start-with-follow-mode nil
  931. "The initial value of follow mode in a newly created agenda window."
  932. :group 'org-agenda-startup
  933. :type 'boolean)
  934. (defcustom org-agenda-follow-indirect nil
  935. "Non-nil means `org-agenda-follow-mode' displays only the
  936. current item's tree, in an indirect buffer."
  937. :group 'org-agenda
  938. :version "24.1"
  939. :type 'boolean)
  940. (defcustom org-agenda-show-outline-path t
  941. "Non-nil means show outline path in echo area after line motion."
  942. :group 'org-agenda-startup
  943. :type 'boolean)
  944. (defcustom org-agenda-start-with-entry-text-mode nil
  945. "The initial value of entry-text-mode in a newly created agenda window."
  946. :group 'org-agenda-startup
  947. :type 'boolean)
  948. (defcustom org-agenda-entry-text-maxlines 5
  949. "Number of text lines to be added when `E' is pressed in the agenda.
  950. Note that this variable only used during agenda display. To add entry text
  951. when exporting the agenda, configure the variable
  952. `org-agenda-add-entry-text-maxlines'."
  953. :group 'org-agenda
  954. :type 'integer)
  955. (defcustom org-agenda-entry-text-exclude-regexps nil
  956. "List of regular expressions to clean up entry text.
  957. The complete matches of all regular expressions in this list will be
  958. removed from entry text before it is shown in the agenda."
  959. :group 'org-agenda
  960. :type '(repeat (regexp)))
  961. (defcustom org-agenda-entry-text-leaders " > "
  962. "Text prepended to the entry text in agenda buffers."
  963. :version "24.4"
  964. :package-version '(Org . "8.0")
  965. :group 'org-agenda
  966. :type 'string)
  967. (defvar org-agenda-entry-text-cleanup-hook nil
  968. "Hook that is run after basic cleanup of entry text to be shown in agenda.
  969. This cleanup is done in a temporary buffer, so the function may inspect and
  970. change the entire buffer.
  971. Some default stuff like drawers and scheduling/deadline dates will already
  972. have been removed when this is called, as will any matches for regular
  973. expressions listed in `org-agenda-entry-text-exclude-regexps'.")
  974. (defvar org-agenda-include-inactive-timestamps nil
  975. "Non-nil means include inactive time stamps in agenda.
  976. Dynamically scoped.")
  977. (defgroup org-agenda-windows nil
  978. "Options concerning the windows used by the Agenda in Org Mode."
  979. :tag "Org Agenda Windows"
  980. :group 'org-agenda)
  981. (defcustom org-agenda-window-setup 'reorganize-frame
  982. "How the agenda buffer should be displayed.
  983. Possible values for this option are:
  984. current-window Show agenda in the current window, keeping all other windows.
  985. other-window Use `switch-to-buffer-other-window' to display agenda.
  986. only-window Show agenda, deleting all other windows.
  987. reorganize-frame Show only two windows on the current frame, the current
  988. window and the agenda.
  989. other-frame Use `switch-to-buffer-other-frame' to display agenda.
  990. Also, when exiting the agenda, kill that frame.
  991. other-tab Use `switch-to-buffer-other-tab' to display the
  992. agenda, making use of the `tab-bar-mode' introduced
  993. in Emacs version 27.1. Also, kill that tab when
  994. exiting the agenda view.
  995. See also the variable `org-agenda-restore-windows-after-quit'."
  996. :group 'org-agenda-windows
  997. :type '(choice
  998. (const current-window)
  999. (const other-frame)
  1000. (const other-tab)
  1001. (const other-window)
  1002. (const only-window)
  1003. (const reorganize-frame))
  1004. :package-version '(Org . "9.4"))
  1005. (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
  1006. "The min and max height of the agenda window as a fraction of frame height.
  1007. The value of the variable is a cons cell with two numbers between 0 and 1.
  1008. It only matters if `org-agenda-window-setup' is `reorganize-frame'."
  1009. :group 'org-agenda-windows
  1010. :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
  1011. (defcustom org-agenda-restore-windows-after-quit nil
  1012. "Non-nil means restore window configuration upon exiting agenda.
  1013. Before the window configuration is changed for displaying the
  1014. agenda, the current status is recorded. When the agenda is
  1015. exited with `q' or `x' and this option is set, the old state is
  1016. restored. If `org-agenda-window-setup' is `other-frame' or
  1017. `other-tab', the value of this option will be ignored."
  1018. :group 'org-agenda-windows
  1019. :type 'boolean)
  1020. (defcustom org-agenda-span 'week
  1021. "Number of days to include in overview display.
  1022. Can be day, week, month, year, or any number of days.
  1023. Custom commands can set this variable in the options section."
  1024. :group 'org-agenda-daily/weekly
  1025. :type '(choice (const :tag "Day" day)
  1026. (const :tag "Week" week)
  1027. (const :tag "Fortnight" fortnight)
  1028. (const :tag "Month" month)
  1029. (const :tag "Year" year)
  1030. (integer :tag "Custom")))
  1031. (defcustom org-agenda-start-on-weekday 1
  1032. "Non-nil means start the overview always on the specified weekday.
  1033. 0 denotes Sunday, 1 denotes Monday, etc.
  1034. When nil, always start on the current day.
  1035. Custom commands can set this variable in the options section."
  1036. :group 'org-agenda-daily/weekly
  1037. :type '(choice (const :tag "Today" nil)
  1038. (integer :tag "Weekday No.")))
  1039. (defcustom org-agenda-show-all-dates t
  1040. "Non-nil means `org-agenda' shows every day in the selected range.
  1041. When nil, only the days which actually have entries are shown."
  1042. :group 'org-agenda-daily/weekly
  1043. :type 'boolean)
  1044. (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
  1045. "Format string for displaying dates in the agenda.
  1046. Used by the daily/weekly agenda. This should be a format string
  1047. understood by `format-time-string', or a function returning the
  1048. formatted date as a string. The function must take a single
  1049. argument, a calendar-style date list like (month day year)."
  1050. :group 'org-agenda-daily/weekly
  1051. :type '(choice
  1052. (string :tag "Format string")
  1053. (function :tag "Function")))
  1054. (defun org-agenda-end-of-line ()
  1055. "Go to the end of visible line."
  1056. (interactive)
  1057. (goto-char (line-end-position)))
  1058. (defun org-agenda-format-date-aligned (date)
  1059. "Format a DATE string for display in the daily/weekly agenda.
  1060. This function makes sure that dates are aligned for easy reading."
  1061. (require 'cal-iso)
  1062. (let* ((dayname (calendar-day-name date))
  1063. (day (cadr date))
  1064. (day-of-week (calendar-day-of-week date))
  1065. (month (car date))
  1066. (monthname (calendar-month-name month))
  1067. (year (nth 2 date))
  1068. (iso-week (org-days-to-iso-week
  1069. (calendar-absolute-from-gregorian date)))
  1070. ;; (weekyear (cond ((and (= month 1) (>= iso-week 52))
  1071. ;; (1- year))
  1072. ;; ((and (= month 12) (<= iso-week 1))
  1073. ;; (1+ year))
  1074. ;; (t year)))
  1075. (weekstring (if (= day-of-week 1)
  1076. (format " W%02d" iso-week)
  1077. "")))
  1078. (format "%-10s %2d %s %4d%s"
  1079. dayname day monthname year weekstring)))
  1080. (defcustom org-agenda-time-leading-zero nil
  1081. "Non-nil means use leading zero for military times in agenda.
  1082. For example, 9:30am would become 09:30 rather than 9:30."
  1083. :group 'org-agenda-daily/weekly
  1084. :version "24.1"
  1085. :type 'boolean)
  1086. (defcustom org-agenda-timegrid-use-ampm nil
  1087. "When set, show AM/PM style timestamps on the timegrid."
  1088. :group 'org-agenda
  1089. :version "24.1"
  1090. :type 'boolean)
  1091. (defcustom org-agenda-clock-report-header nil
  1092. "Header inserted before the table in Org agenda clock report mode.
  1093. See Info node `(org) Agenda Commands' for more details."
  1094. :group 'org-agenda
  1095. :type '(choice
  1096. (string :tag "Header")
  1097. (const :tag "No header" nil))
  1098. :safe #'stringp
  1099. :package-version '(Org . "9.6"))
  1100. (defun org-agenda-time-of-day-to-ampm (time)
  1101. "Convert TIME of a string like \"13:45\" to an AM/PM style time string."
  1102. (let* ((hour-number (string-to-number (substring time 0 -3)))
  1103. (minute (substring time -2))
  1104. (ampm "am"))
  1105. (cond
  1106. ((equal hour-number 12)
  1107. (setq ampm "pm"))
  1108. ((> hour-number 12)
  1109. (setq ampm "pm")
  1110. (setq hour-number (- hour-number 12))))
  1111. (concat
  1112. (if org-agenda-time-leading-zero
  1113. (format "%02d" hour-number)
  1114. (format "%02s" (number-to-string hour-number)))
  1115. ":" minute ampm)))
  1116. (defun org-agenda-time-of-day-to-ampm-maybe (time)
  1117. "Conditionally convert TIME to AM/PM format.
  1118. This is based on `org-agenda-timegrid-use-ampm'."
  1119. (if org-agenda-timegrid-use-ampm
  1120. (org-agenda-time-of-day-to-ampm time)
  1121. time))
  1122. (defcustom org-agenda-weekend-days '(6 0)
  1123. "Which days are weekend?
  1124. These days get the special face `org-agenda-date-weekend' in the agenda."
  1125. :group 'org-agenda-daily/weekly
  1126. :type '(set :greedy t
  1127. (const :tag "Monday" 1)
  1128. (const :tag "Tuesday" 2)
  1129. (const :tag "Wednesday" 3)
  1130. (const :tag "Thursday" 4)
  1131. (const :tag "Friday" 5)
  1132. (const :tag "Saturday" 6)
  1133. (const :tag "Sunday" 0)))
  1134. (defcustom org-agenda-move-date-from-past-immediately-to-today t
  1135. "Non-nil means jump to today when moving a past date forward in time.
  1136. When using S-right in the agenda to move a date forward, and the date
  1137. stamp currently points to the past, the first key press will move it
  1138. to today. When nil, just move one day forward even if the date stays
  1139. in the past."
  1140. :group 'org-agenda-daily/weekly
  1141. :version "24.1"
  1142. :type 'boolean)
  1143. (defcustom org-agenda-diary-file 'diary-file
  1144. "File to which to add new entries with the `i' key in agenda and calendar.
  1145. When this is the symbol `diary-file', the functionality in the Emacs
  1146. calendar will be used to add entries to the `diary-file'. But when this
  1147. points to a file, `org-agenda-diary-entry' will be used instead."
  1148. :group 'org-agenda
  1149. :type '(choice
  1150. (const :tag "The standard Emacs diary file" diary-file)
  1151. (file :tag "Special Org file diary entries")))
  1152. (defcustom org-agenda-include-diary nil
  1153. "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
  1154. Custom commands can set this variable in the options section."
  1155. :group 'org-agenda-daily/weekly
  1156. :type 'boolean)
  1157. (defcustom org-agenda-include-deadlines t
  1158. "If non-nil, include entries within their deadline warning period.
  1159. Custom commands can set this variable in the options section."
  1160. :group 'org-agenda-daily/weekly
  1161. :version "24.1"
  1162. :type 'boolean)
  1163. (defcustom org-agenda-show-future-repeats t
  1164. "Non-nil shows repeated entries in the future part of the agenda.
  1165. When set to the symbol `next' only the first future repeat is shown."
  1166. :group 'org-agenda-daily/weekly
  1167. :type '(choice
  1168. (const :tag "Show all repeated entries" t)
  1169. (const :tag "Show next repeated entry" next)
  1170. (const :tag "Do not show repeated entries" nil))
  1171. :version "26.1"
  1172. :package-version '(Org . "9.1")
  1173. :safe #'symbolp)
  1174. (defcustom org-agenda-prefer-last-repeat nil
  1175. "Non-nil sets date for repeated entries to their last repeat.
  1176. When nil, display SCHEDULED and DEADLINE dates at their base
  1177. date, and in today's agenda, as a reminder. Display plain
  1178. time-stamps, on the other hand, at every repeat date in the past
  1179. in addition to the base date.
  1180. When non-nil, show a repeated entry at its latest repeat date,
  1181. possibly being today even if it wasn't marked as done. This
  1182. setting is useful if you do not always mark repeated entries as
  1183. done and, yet, consider that reaching repeat date starts the task
  1184. anew.
  1185. When set to a list of strings, prefer last repeats only for
  1186. entries with these TODO keywords."
  1187. :group 'org-agenda-daily/weekly
  1188. :type '(choice
  1189. (const :tag "Prefer last repeat" t)
  1190. (const :tag "Prefer base date" nil)
  1191. (repeat :tag "Prefer last repeat for entries with these TODO keywords"
  1192. (string :tag "TODO keyword")))
  1193. :version "26.1"
  1194. :package-version '(Org . "9.1")
  1195. :safe (lambda (x) (or (booleanp x) (consp x))))
  1196. (defcustom org-scheduled-past-days 10000
  1197. "Number of days to continue listing scheduled items not marked DONE.
  1198. When an item is scheduled on a date, it shows up in the agenda on
  1199. this day and will be listed until it is marked done or for the
  1200. number of days given here."
  1201. :group 'org-agenda-daily/weekly
  1202. :type 'integer
  1203. :safe 'integerp)
  1204. (defcustom org-deadline-past-days 10000
  1205. "Number of days to warn about missed deadlines.
  1206. When an item has deadline on a date, it shows up in the agenda on
  1207. this day and will appear as a reminder until it is marked DONE or
  1208. for the number of days given here."
  1209. :group 'org-agenda-daily/weekly
  1210. :type 'integer
  1211. :version "26.1"
  1212. :package-version '(Org . "9.1")
  1213. :safe 'integerp)
  1214. (defcustom org-agenda-log-mode-items '(closed clock)
  1215. "List of items that should be shown in agenda log mode.
  1216. \\<org-agenda-mode-map>\
  1217. This list may contain the following symbols:
  1218. closed Show entries that have been closed on that day.
  1219. clock Show entries that have received clocked time on that day.
  1220. state Show all logged state changes.
  1221. Note that instead of changing this variable, you can also press \
  1222. `\\[universal-argument] \\[org-agenda-log-mode]' in
  1223. the agenda to display all available LOG items temporarily."
  1224. :group 'org-agenda-daily/weekly
  1225. :type '(set :greedy t (const closed) (const clock) (const state)))
  1226. (defcustom org-agenda-clock-consistency-checks
  1227. '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
  1228. :gap-ok-around ("4:00")
  1229. :default-face ((:background "DarkRed") (:foreground "white"))
  1230. :overlap-face nil :gap-face nil :no-end-time-face nil
  1231. :long-face nil :short-face nil)
  1232. "This is a property list, with the following keys:
  1233. :max-duration Mark clocking chunks that are longer than this time.
  1234. This is a time string like \"HH:MM\", or the number
  1235. of minutes as an integer.
  1236. :min-duration Mark clocking chunks that are shorter that this.
  1237. This is a time string like \"HH:MM\", or the number
  1238. of minutes as an integer.
  1239. :max-gap Mark gaps between clocking chunks that are longer than
  1240. this duration. A number of minutes, or a string
  1241. like \"HH:MM\".
  1242. :gap-ok-around List of times during the day which are usually not working
  1243. times. When a gap is detected, but the gap contains any
  1244. of these times, the gap is *not* reported. For example,
  1245. if this is (\"4:00\" \"13:00\") then gaps that contain
  1246. 4:00 in the morning (i.e. the night) and 13:00
  1247. (i.e. a typical lunch time) do not cause a warning.
  1248. You should have at least one time during the night in this
  1249. list, or otherwise the first task each morning will trigger
  1250. a warning because it follows a long gap.
  1251. Furthermore, the following properties can be used to define faces for
  1252. issue display.
  1253. :default-face the default face, if the specific face is undefined
  1254. :overlap-face face for overlapping clocks
  1255. :gap-face face for gaps between clocks
  1256. :no-end-time-face face for incomplete clocks
  1257. :long-face face for clock intervals that are too long
  1258. :short-face face for clock intervals that are too short"
  1259. :group 'org-agenda-daily/weekly
  1260. :group 'org-clock
  1261. :version "24.1"
  1262. :type 'plist)
  1263. (defcustom org-agenda-log-mode-add-notes t
  1264. "Non-nil means add first line of notes to log entries in agenda views.
  1265. If a log item like a state change or a clock entry is associated with
  1266. notes, the first line of these notes will be added to the entry in the
  1267. agenda display."
  1268. :group 'org-agenda-daily/weekly
  1269. :type 'boolean)
  1270. (defcustom org-agenda-start-with-log-mode nil
  1271. "The initial value of log-mode in a newly created agenda window.
  1272. See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
  1273. explanations on the possible values."
  1274. :group 'org-agenda-startup
  1275. :group 'org-agenda-daily/weekly
  1276. :type '(choice (const :tag "Don't show log items" nil)
  1277. (const :tag "Show only log items" only)
  1278. (const :tag "Show all possible log items" clockcheck)
  1279. (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
  1280. (choice (const :tag "Show closed log items" closed)
  1281. (const :tag "Show clocked log items" clock)
  1282. (const :tag "Show all logged state changes" state)))))
  1283. (defcustom org-agenda-start-with-clockreport-mode nil
  1284. "The initial value of clockreport-mode in a newly created agenda window."
  1285. :group 'org-agenda-startup
  1286. :group 'org-agenda-daily/weekly
  1287. :type 'boolean)
  1288. (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
  1289. "Property list with parameters for the clocktable in clockreport mode.
  1290. This is the display mode that shows a clock table in the daily/weekly
  1291. agenda, the properties for this dynamic block can be set here.
  1292. The usual clocktable parameters are allowed here, but you cannot set
  1293. the properties :name, :tstart, :tend, :block, and :scope - these will
  1294. be overwritten to make sure the content accurately reflects the
  1295. current display in the agenda."
  1296. :group 'org-agenda-daily/weekly
  1297. :type 'plist)
  1298. (defvaralias 'org-agenda-search-view-search-words-only
  1299. 'org-agenda-search-view-always-boolean)
  1300. (defcustom org-agenda-search-view-always-boolean nil
  1301. "Non-nil means the search string is interpreted as individual parts.
  1302. The search string for search view can either be interpreted as a phrase,
  1303. or as a list of snippets that define a boolean search for a number of
  1304. strings.
  1305. When this is non-nil, the string will be split on whitespace, and each
  1306. snippet will be searched individually, and all must match in order to
  1307. select an entry. A snippet is then a single string of non-white
  1308. characters, or a string in double quotes, or a regexp in {} braces.
  1309. If a snippet is preceded by \"-\", the snippet must *not* match.
  1310. \"+\" is syntactic sugar for positive selection. Each snippet may
  1311. be found as a full word or a partial word, but see the variable
  1312. `org-agenda-search-view-force-full-words'.
  1313. When this is nil, search will look for the entire search phrase as one,
  1314. with each space character matching any amount of whitespace, including
  1315. line breaks.
  1316. Even when this is nil, you can still switch to Boolean search dynamically
  1317. by preceding the first snippet with \"+\" or \"-\". If the first snippet
  1318. is a regexp marked with braces like \"{abc}\", this will also switch to
  1319. boolean search."
  1320. :group 'org-agenda-search-view
  1321. :version "24.1"
  1322. :type 'boolean)
  1323. (defcustom org-agenda-search-view-force-full-words nil
  1324. "Non-nil means, search words must be matches as complete words.
  1325. When nil, they may also match part of a word."
  1326. :group 'org-agenda-search-view
  1327. :version "24.1"
  1328. :type 'boolean)
  1329. (defcustom org-agenda-search-view-max-outline-level 0
  1330. "Maximum outline level to display in search view.
  1331. E.g. when this is set to 1, the search view will only
  1332. show headlines of level 1. When set to 0, the default
  1333. value, don't limit agenda view by outline level."
  1334. :group 'org-agenda-search-view
  1335. :version "26.1"
  1336. :package-version '(Org . "8.3")
  1337. :type 'integer)
  1338. (defgroup org-agenda-time-grid nil
  1339. "Options concerning the time grid in the Org Agenda."
  1340. :tag "Org Agenda Time Grid"
  1341. :group 'org-agenda)
  1342. (defcustom org-agenda-search-headline-for-time t
  1343. "Non-nil means search headline for a time-of-day.
  1344. If the headline contains a time-of-day in one format or another, it will
  1345. be used to sort the entry into the time sequence of items for a day.
  1346. Some people have time stamps in the headline that refer to the creation
  1347. time or so, and then this produces an unwanted side effect. If this is
  1348. the case for your, use this variable to turn off searching the headline
  1349. for a time."
  1350. :group 'org-agenda-time-grid
  1351. :type 'boolean)
  1352. (defcustom org-agenda-use-time-grid t
  1353. "Non-nil means show a time grid in the agenda schedule.
  1354. A time grid is a set of lines for specific times (like every two hours between
  1355. 8:00 and 20:00). The items scheduled for a day at specific times are
  1356. sorted in between these lines.
  1357. For details about when the grid will be shown, and what it will look like, see
  1358. the variable `org-agenda-time-grid'."
  1359. :group 'org-agenda-time-grid
  1360. :type 'boolean)
  1361. (defcustom org-agenda-time-grid
  1362. (let ((graphical (and (display-graphic-p)
  1363. (char-displayable-p ?┄))))
  1364. `((daily today require-timed)
  1365. (800 1000 1200 1400 1600 1800 2000)
  1366. ,(if graphical " ┄┄┄┄┄ " "......")
  1367. ,(if graphical "┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄" "----------------")))
  1368. "The settings for time grid for agenda display.
  1369. This is a list of four items. The first item is again a list. It contains
  1370. symbols specifying conditions when the grid should be displayed:
  1371. daily if the agenda shows a single day
  1372. weekly if the agenda shows an entire week
  1373. today show grid on current date, independent of daily/weekly display
  1374. require-timed show grid only if at least one item has a time specification
  1375. remove-match skip grid times already present in an entry
  1376. The second item is a list of integers, indicating the times that
  1377. should have a grid line.
  1378. The third item is a string which will be placed right after the
  1379. times that have a grid line.
  1380. The fourth item is a string placed after the grid times. This
  1381. will align with agenda items."
  1382. :group 'org-agenda-time-grid
  1383. :version "29.1"
  1384. :type
  1385. '(list
  1386. (set :greedy t :tag "Grid Display Options"
  1387. (const :tag "Show grid in single day agenda display" daily)
  1388. (const :tag "Show grid in weekly agenda display" weekly)
  1389. (const :tag "Always show grid for today" today)
  1390. (const :tag "Show grid only if any timed entries are present"
  1391. require-timed)
  1392. (const :tag "Skip grid times already present in an entry"
  1393. remove-match))
  1394. (repeat :tag "Grid Times" (integer :tag "Time"))
  1395. (string :tag "Grid String (after agenda times)")
  1396. (string :tag "Grid String (aligns with agenda items)")))
  1397. (defcustom org-agenda-show-current-time-in-grid t
  1398. "Non-nil means show the current time in the time grid."
  1399. :group 'org-agenda-time-grid
  1400. :version "24.1"
  1401. :type 'boolean)
  1402. (defcustom org-agenda-current-time-string
  1403. (if (and (display-graphic-p)
  1404. (char-displayable-p ?←)
  1405. (char-displayable-p ?─))
  1406. "← now ───────────────────────────────────────────────"
  1407. "now - - - - - - - - - - - - - - - - - - - - - - - - -")
  1408. "The string for the current time marker in the agenda."
  1409. :group 'org-agenda-time-grid
  1410. :version "29.1"
  1411. :type 'string)
  1412. (defgroup org-agenda-sorting nil
  1413. "Options concerning sorting in the Org Agenda."
  1414. :tag "Org Agenda Sorting"
  1415. :group 'org-agenda)
  1416. (defcustom org-agenda-sorting-strategy
  1417. '((agenda habit-down time-up priority-down category-keep)
  1418. (todo priority-down category-keep)
  1419. (tags priority-down category-keep)
  1420. (search category-keep))
  1421. "Sorting structure for the agenda items of a single day.
  1422. This is a list of symbols which will be used in sequence to determine
  1423. if an entry should be listed before another entry. The following
  1424. symbols are recognized:
  1425. time-up Put entries with time-of-day indications first, early first.
  1426. time-down Put entries with time-of-day indications first, late first.
  1427. timestamp-up Sort by any timestamp, early first.
  1428. timestamp-down Sort by any timestamp, late first.
  1429. scheduled-up Sort by scheduled timestamp, early first.
  1430. scheduled-down Sort by scheduled timestamp, late first.
  1431. deadline-up Sort by deadline timestamp, early first.
  1432. deadline-down Sort by deadline timestamp, late first.
  1433. ts-up Sort by active timestamp, early first.
  1434. ts-down Sort by active timestamp, late first.
  1435. tsia-up Sort by inactive timestamp, early first.
  1436. tsia-down Sort by inactive timestamp, late first.
  1437. category-keep Keep the default order of categories, corresponding to the
  1438. sequence in `org-agenda-files'.
  1439. category-up Sort alphabetically by category, A-Z.
  1440. category-down Sort alphabetically by category, Z-A.
  1441. tag-up Sort alphabetically by last tag, A-Z.
  1442. tag-down Sort alphabetically by last tag, Z-A.
  1443. priority-up Sort numerically by priority, high priority last.
  1444. priority-down Sort numerically by priority, high priority first.
  1445. todo-state-up Sort by todo state, tasks that are done last.
  1446. todo-state-down Sort by todo state, tasks that are done first.
  1447. effort-up Sort numerically by estimated effort, high effort last.
  1448. effort-down Sort numerically by estimated effort, high effort first.
  1449. user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
  1450. user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
  1451. habit-up Put entries that are habits first.
  1452. habit-down Put entries that are habits last.
  1453. alpha-up Sort headlines alphabetically.
  1454. alpha-down Sort headlines alphabetically, reversed.
  1455. The different possibilities will be tried in sequence, and testing stops
  1456. if one comparison returns a \"not-equal\". For example,
  1457. (setq org-agenda-sorting-strategy
  1458. \\='(time-up category-keep priority-down))
  1459. means: Pull out all entries having a specified time of day and sort them,
  1460. in order to make a time schedule for the current day the first thing in the
  1461. agenda listing for the day. Of the entries without a time indication, keep
  1462. the grouped in categories, don't sort the categories, but keep them in
  1463. the sequence given in `org-agenda-files'. Within each category sort by
  1464. priority.
  1465. Leaving out `category-keep' would mean that items will be sorted across
  1466. categories by priority.
  1467. Instead of a single list, this can also be a set of list for specific
  1468. contents, with a context symbol in the car of the list, any of
  1469. `agenda', `todo', `tags', `search' for the corresponding agenda views.
  1470. Custom commands can bind this variable in the options section."
  1471. :group 'org-agenda-sorting
  1472. :type `(choice
  1473. (repeat :tag "General" ,org-sorting-choice)
  1474. (list :tag "Individually"
  1475. (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
  1476. (repeat ,org-sorting-choice))
  1477. (cons (const :tag "Strategy for TODO lists" todo)
  1478. (repeat ,org-sorting-choice))
  1479. (cons (const :tag "Strategy for Tags matches" tags)
  1480. (repeat ,org-sorting-choice))
  1481. (cons (const :tag "Strategy for search matches" search)
  1482. (repeat ,org-sorting-choice)))))
  1483. (defcustom org-agenda-cmp-user-defined nil
  1484. "A function to define the comparison `user-defined'.
  1485. This function must receive two arguments, agenda entry a and b.
  1486. If a>b, return +1. If a<b, return -1. If they are equal as seen by
  1487. the user comparison, return nil.
  1488. When this is defined, you can make `user-defined-up' and `user-defined-down'
  1489. part of an agenda sorting strategy."
  1490. :group 'org-agenda-sorting
  1491. :type 'symbol)
  1492. (defcustom org-agenda-sort-notime-is-late t
  1493. "Non-nil means items without time are considered late.
  1494. This is only relevant for sorting. When t, items which have no explicit
  1495. time like 15:30 will be considered as 99:01, i.e. later than any items which
  1496. do have a time. When nil, the default time is before 0:00. You can use this
  1497. option to decide if the schedule for today should come before or after timeless
  1498. agenda entries."
  1499. :group 'org-agenda-sorting
  1500. :type 'boolean)
  1501. (defcustom org-agenda-sort-noeffort-is-high t
  1502. "Non-nil means items without effort estimate are sorted as high effort.
  1503. This also applies when filtering an agenda view with respect to the
  1504. < or > effort operator. Then, tasks with no effort defined will be treated
  1505. as tasks with high effort.
  1506. When nil, such items are sorted as 0 minutes effort."
  1507. :group 'org-agenda-sorting
  1508. :type 'boolean)
  1509. (defgroup org-agenda-line-format nil
  1510. "Options concerning the entry prefix in the Org agenda display."
  1511. :tag "Org Agenda Line Format"
  1512. :group 'org-agenda)
  1513. (defcustom org-agenda-prefix-format
  1514. '((agenda . " %i %-12:c%?-12t% s")
  1515. (todo . " %i %-12:c")
  1516. (tags . " %i %-12:c")
  1517. (search . " %i %-12:c"))
  1518. "Format specifications for the prefix of items in the agenda views.
  1519. An alist with one entry per agenda type. The keys of the
  1520. sublists are `agenda', `todo', `search' and `tags'. The values
  1521. are format strings.
  1522. This format works similar to a printf format, with the following meaning:
  1523. %c the category of the item, \"Diary\" for entries from the diary,
  1524. or as given by the CATEGORY keyword or derived from the file name
  1525. %e the effort required by the item
  1526. %l the level of the item (insert X space(s) if item is of level X)
  1527. %i the icon category of the item, see `org-agenda-category-icon-alist'
  1528. %T the last tag of the item (ignore inherited tags, which come first)
  1529. %t the HH:MM time-of-day specification if one applies to the entry
  1530. %s Scheduling/Deadline information, a short string
  1531. %b show breadcrumbs, i.e., the names of the higher levels
  1532. %(expression) Eval EXPRESSION and replace the control string
  1533. by the result
  1534. All specifiers work basically like the standard `%s' of printf, but may
  1535. contain two additional characters: a question mark just after the `%'
  1536. and a whitespace/punctuation character just before the final letter.
  1537. If the first character after `%' is a question mark, the entire field
  1538. will only be included if the corresponding value applies to the current
  1539. entry. This is useful for fields which should have fixed width when
  1540. present, but zero width when absent. For example, \"%?-12t\" will
  1541. result in a 12 character time field if a time of the day is specified,
  1542. but will completely disappear in entries which do not contain a time.
  1543. If there is punctuation or whitespace character just before the
  1544. final format letter, this character will be appended to the field
  1545. value if the value is not empty. For example, the format
  1546. \"%-12:c\" leads to \"Diary: \" if the category is \"Diary\". If
  1547. the category is empty, no additional colon is inserted.
  1548. The default value for the agenda sublist is \" %-12:c%?-12t% s\",
  1549. which means:
  1550. - Indent the line with two space characters
  1551. - Give the category a 12 chars wide field, padded with whitespace on
  1552. the right (because of `-'). Append a colon if there is a category
  1553. (because of `:').
  1554. - If there is a time-of-day, put it into a 12 chars wide field. If no
  1555. time, don't put in an empty field, just skip it (because of '?').
  1556. - Finally, put the scheduling information.
  1557. See also the variables `org-agenda-remove-times-when-in-prefix' and
  1558. `org-agenda-remove-tags'.
  1559. Custom commands can set this variable in the options section."
  1560. :type '(choice
  1561. (string :tag "General format")
  1562. (list :greedy t :tag "View dependent"
  1563. (cons (const agenda) (string :tag "Format"))
  1564. (cons (const todo) (string :tag "Format"))
  1565. (cons (const tags) (string :tag "Format"))
  1566. (cons (const search) (string :tag "Format"))))
  1567. :group 'org-agenda-line-format
  1568. :version "26.1"
  1569. :package-version '(Org . "9.1"))
  1570. (defcustom org-agenda-breadcrumbs-separator "->"
  1571. "The separator of breadcrumbs in agenda lines."
  1572. :group 'org-agenda-line-format
  1573. :package-version '(Org . "9.3")
  1574. :type 'string
  1575. :safe #'stringp)
  1576. (defvar org-prefix-format-compiled nil
  1577. "The compiled prefix format and associated variables.
  1578. This is a list where first element is a list of variable bindings, and second
  1579. element is the compiled format expression. See the variable
  1580. `org-agenda-prefix-format'.")
  1581. (defcustom org-agenda-todo-keyword-format "%-1s"
  1582. "Format for the TODO keyword in agenda lines.
  1583. Set this to something like \"%-12s\" if you want all TODO keywords
  1584. to occupy a fixed space in the agenda display."
  1585. :group 'org-agenda-line-format
  1586. :type 'string)
  1587. (defcustom org-agenda-diary-sexp-prefix nil
  1588. "A regexp that matches part of a diary sexp entry
  1589. which should be treated as scheduling/deadline information in
  1590. `org-agenda'.
  1591. For example, you can use this to extract the `diary-remind-message' from
  1592. `diary-remind' entries."
  1593. :group 'org-agenda-line-format
  1594. :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
  1595. (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
  1596. "Text preceding timerange entries in the agenda view.
  1597. This is a list with two strings. The first applies when the range
  1598. is entirely on one day. The second applies if the range spans several days.
  1599. The strings may have two \"%d\" format specifiers which will be filled
  1600. with the sequence number of the days, and the total number of days in the
  1601. range, respectively."
  1602. :group 'org-agenda-line-format
  1603. :type '(list
  1604. (string :tag "Deadline today ")
  1605. (choice :tag "Deadline relative"
  1606. (string :tag "Format string")
  1607. (function))))
  1608. (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
  1609. "Text preceding scheduled items in the agenda view.
  1610. This is a list with two strings. The first applies when the item is
  1611. scheduled on the current day. The second applies when it has been scheduled
  1612. previously, it may contain a %d indicating that this is the nth time that
  1613. this item is scheduled, due to automatic rescheduling of unfinished items
  1614. for the following day. So this number is one larger than the number of days
  1615. that passed since this item was scheduled first."
  1616. :group 'org-agenda-line-format
  1617. :version "24.4"
  1618. :package-version '(Org . "8.0")
  1619. :type '(list
  1620. (string :tag "Scheduled today ")
  1621. (string :tag "Scheduled previously")))
  1622. (defcustom org-agenda-inactive-leader "["
  1623. "Text preceding item pulled into the agenda by inactive time stamps.
  1624. These entries are added to the agenda when pressing \"[\"."
  1625. :group 'org-agenda-line-format
  1626. :version "24.1"
  1627. :type 'string)
  1628. (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: " "%2d d. ago: ")
  1629. "Text preceding deadline items in the agenda view.
  1630. This is a list with three strings. The first applies when the item has its
  1631. deadline on the current day. The second applies when the deadline is in the
  1632. future, the third one when it is in the past. The strings may contain %d
  1633. to capture the number of days."
  1634. :group 'org-agenda-line-format
  1635. :version "24.4"
  1636. :package-version '(Org . "8.0")
  1637. :type '(list
  1638. (string :tag "Deadline today ")
  1639. (string :tag "Deadline in the future ")
  1640. (string :tag "Deadline in the past ")))
  1641. (defcustom org-agenda-remove-times-when-in-prefix t
  1642. "Non-nil means remove duplicate time specifications in agenda items.
  1643. When the format `org-agenda-prefix-format' contains a `%t' specifier, a
  1644. time-of-day specification in a headline or diary entry is extracted and
  1645. placed into the prefix. If this option is non-nil, the original specification
  1646. \(a timestamp or -range, or just a plain time(range) specification like
  1647. 11:30-4pm) will be removed for agenda display. This makes the agenda less
  1648. cluttered.
  1649. The option can be t or nil. It may also be the symbol `beg', indicating
  1650. that the time should only be removed when it is located at the beginning of
  1651. the headline/diary entry."
  1652. :group 'org-agenda-line-format
  1653. :type '(choice
  1654. (const :tag "Always" t)
  1655. (const :tag "Never" nil)
  1656. (const :tag "When at beginning of entry" beg)))
  1657. (defcustom org-agenda-remove-timeranges-from-blocks nil
  1658. "Non-nil means remove time ranges specifications in agenda
  1659. items that span on several days."
  1660. :group 'org-agenda-line-format
  1661. :version "24.1"
  1662. :type 'boolean)
  1663. (defcustom org-agenda-default-appointment-duration nil
  1664. "Default duration for appointments that only have a starting time.
  1665. When nil, no duration is specified in such cases.
  1666. When non-nil, this must be the number of minutes, e.g. 60 for one hour."
  1667. :group 'org-agenda-line-format
  1668. :type '(choice
  1669. (integer :tag "Minutes")
  1670. (const :tag "No default duration")))
  1671. (defcustom org-agenda-show-inherited-tags t
  1672. "Non-nil means show inherited tags in each agenda line.
  1673. When this option is set to `always', it takes precedence over
  1674. `org-agenda-use-tag-inheritance' and inherited tags are shown
  1675. in every agenda.
  1676. When this option is set to t (the default), inherited tags are
  1677. shown when they are available, i.e. when the value of
  1678. `org-agenda-use-tag-inheritance' enables tag inheritance for the
  1679. given agenda type.
  1680. This can be set to a list of agenda types in which the agenda
  1681. must display the inherited tags. Available types are `todo',
  1682. `agenda' and `search'.
  1683. When set to nil, never show inherited tags in agenda lines."
  1684. :group 'org-agenda-line-format
  1685. :group 'org-agenda
  1686. :version "24.3"
  1687. :type '(choice
  1688. (const :tag "Show inherited tags when available" t)
  1689. (const :tag "Always show inherited tags" always)
  1690. (repeat :tag "Show inherited tags only in selected agenda types"
  1691. (symbol :tag "Agenda type"))))
  1692. (defcustom org-agenda-use-tag-inheritance '(todo search agenda)
  1693. "List of agenda view types where to use tag inheritance.
  1694. In tags/tags-todo/tags-tree agenda views, tag inheritance is
  1695. controlled by `org-use-tag-inheritance'. In other agenda types,
  1696. `org-use-tag-inheritance' is not used for the selection of the
  1697. agenda entries. Still, you may want the agenda to be aware of
  1698. the inherited tags anyway, e.g. for later tag filtering.
  1699. Allowed value are `todo', `search' and `agenda'.
  1700. This variable has no effect if `org-agenda-show-inherited-tags'
  1701. is set to `always'. In that case, the agenda is aware of those
  1702. tags.
  1703. The default value sets tags in every agenda type. Setting this
  1704. option to nil will speed up non-tags agenda view a lot."
  1705. :group 'org-agenda
  1706. :version "26.1"
  1707. :package-version '(Org . "9.1")
  1708. :type '(choice
  1709. (const :tag "Use tag inheritance in all agenda types" t)
  1710. (repeat :tag "Use tag inheritance in selected agenda types"
  1711. (symbol :tag "Agenda type"))))
  1712. (defcustom org-agenda-hide-tags-regexp nil
  1713. "Regular expression used to filter away specific tags in agenda views.
  1714. This means that these tags will be present, but not be shown in the agenda
  1715. line. Secondary filtering will still work on the hidden tags.
  1716. Nil means don't hide any tags."
  1717. :group 'org-agenda-line-format
  1718. :type '(choice
  1719. (const :tag "Hide none" nil)
  1720. (regexp :tag "Regexp ")))
  1721. (defvaralias 'org-agenda-remove-tags-when-in-prefix
  1722. 'org-agenda-remove-tags)
  1723. (defcustom org-agenda-remove-tags nil
  1724. "Non-nil means remove the tags from the headline copy in the agenda.
  1725. When this is the symbol `prefix', only remove tags when
  1726. `org-agenda-prefix-format' contains a `%T' specifier."
  1727. :group 'org-agenda-line-format
  1728. :type '(choice
  1729. (const :tag "Always" t)
  1730. (const :tag "Never" nil)
  1731. (const :tag "When prefix format contains %T" prefix)))
  1732. (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column)
  1733. (defcustom org-agenda-tags-column 'auto
  1734. "Shift tags in agenda items to this column.
  1735. If set to `auto', tags will be automatically aligned to the right
  1736. edge of the window.
  1737. If set to a positive number, tags will be left-aligned to that
  1738. column. If set to a negative number, tags will be right-aligned
  1739. to that column. For example, -80 works well for a normal 80
  1740. character screen."
  1741. :group 'org-agenda-line-format
  1742. :type '(choice
  1743. (const :tag "Automatically align to right edge of window" auto)
  1744. (integer :tag "Specific column" -80))
  1745. :package-version '(Org . "9.1")
  1746. :version "26.1")
  1747. (defcustom org-agenda-fontify-priorities 'cookies
  1748. "Non-nil means highlight low and high priorities in agenda.
  1749. When t, the highest priority entries are bold, lowest priority italic.
  1750. However, settings in `org-priority-faces' will overrule these faces.
  1751. When this variable is the symbol `cookies', only fontify the
  1752. cookies, not the entire task.
  1753. This may also be an association list of priority faces, whose
  1754. keys are the character values of `org-priority-highest',
  1755. `org-priority-default', and `org-priority-lowest' (the default values
  1756. are ?A, ?B, and ?C, respectively). The face may be a named face, a
  1757. color as a string, or a list like `(:background \"Red\")'.
  1758. If it is a color, the variable `org-faces-easy-properties'
  1759. determines if it is a foreground or a background color."
  1760. :group 'org-agenda-line-format
  1761. :type '(choice
  1762. (const :tag "Never" nil)
  1763. (const :tag "Defaults" t)
  1764. (const :tag "Cookies only" cookies)
  1765. (repeat :tag "Specify"
  1766. (list (character :tag "Priority" :value ?A)
  1767. (choice :tag "Face "
  1768. (string :tag "Color")
  1769. (sexp :tag "Face"))))))
  1770. (defcustom org-agenda-day-face-function nil
  1771. "Function called to determine what face should be used to display a day.
  1772. The only argument passed to that function is the day. It should
  1773. returns a face, or nil if does not want to specify a face and let
  1774. the normal rules apply."
  1775. :group 'org-agenda-line-format
  1776. :version "24.1"
  1777. :type '(choice (const nil) (function)))
  1778. (defcustom org-agenda-category-icon-alist nil
  1779. "Alist of category icon to be displayed in agenda views.
  1780. Each entry should have the following format:
  1781. (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
  1782. Where CATEGORY-REGEXP is a regexp matching the categories where
  1783. the icon should be displayed.
  1784. FILE-OR-DATA either a file path or a string containing image data.
  1785. The other fields can be omitted safely if not needed:
  1786. TYPE indicates the image type.
  1787. DATA-P is a boolean indicating whether the FILE-OR-DATA string is
  1788. image data.
  1789. PROPS are additional image attributes to assign to the image,
  1790. like, e.g. `:ascent center'.
  1791. (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
  1792. If you want to set the display properties yourself, just put a
  1793. list as second element:
  1794. (CATEGORY-REGEXP (MY PROPERTY LIST))
  1795. For example, to display a 16px horizontal space for Emacs
  1796. category, you can use:
  1797. (\"Emacs\" \\='(space . (:width (16))))"
  1798. :group 'org-agenda-line-format
  1799. :version "24.1"
  1800. :type '(alist :key-type (regexp :tag "Regexp matching category")
  1801. :value-type (choice (list :tag "Icon"
  1802. (string :tag "File or data")
  1803. (symbol :tag "Type")
  1804. (boolean :tag "Data?")
  1805. (repeat :tag "Extra image properties" :inline t sexp))
  1806. (list :tag "Display properties" sexp))))
  1807. (defgroup org-agenda-column-view nil
  1808. "Options concerning column view in the agenda."
  1809. :tag "Org Agenda Column View"
  1810. :group 'org-agenda)
  1811. (defcustom org-agenda-view-columns-initially nil
  1812. "When non-nil, switch to columns view right after creating the agenda."
  1813. :group 'org-agenda-column-view
  1814. :type 'boolean
  1815. :version "26.1"
  1816. :package-version '(Org . "9.0")
  1817. :safe #'booleanp)
  1818. (defcustom org-agenda-columns-show-summaries t
  1819. "Non-nil means show summaries for columns displayed in the agenda view."
  1820. :group 'org-agenda-column-view
  1821. :type 'boolean)
  1822. (defcustom org-agenda-columns-compute-summary-properties t
  1823. "Non-nil means recompute all summary properties before column view.
  1824. When column view in the agenda is listing properties that have a summary
  1825. operator, it can go to all relevant buffers and recompute the summaries
  1826. there. This can mean overhead for the agenda column view, but is necessary
  1827. to have thing up to date.
  1828. As a special case, a CLOCKSUM property also makes sure that the clock
  1829. computations are current."
  1830. :group 'org-agenda-column-view
  1831. :type 'boolean)
  1832. (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
  1833. "Non-nil means the duration of an appointment will add to day effort.
  1834. The property to which appointment durations will be added is the one given
  1835. in the option `org-effort-property'. If an appointment does not have
  1836. an end time, `org-agenda-default-appointment-duration' will be used. If that
  1837. is not set, an appointment without end time will not contribute to the time
  1838. estimate."
  1839. :group 'org-agenda-column-view
  1840. :type 'boolean)
  1841. (defcustom org-agenda-auto-exclude-function nil
  1842. "A function called with a tag to decide if it is filtered on \
  1843. \\<org-agenda-mode-map>`\\[org-agenda-filter-by-tag] RET'.
  1844. The sole argument to the function, which is called once for each
  1845. possible tag, is a string giving the name of the tag. The
  1846. function should return either nil if the tag should be included
  1847. as normal, \"-<TAG>\" to exclude the tag, or \"+<TAG>\" to exclude
  1848. lines not carrying this tag.
  1849. Note that for the purpose of tag filtering, only the lower-case version of
  1850. all tags will be considered, so that this function will only ever see
  1851. the lower-case version of all tags."
  1852. :group 'org-agenda
  1853. :type '(choice (const nil) (function)))
  1854. (defcustom org-agenda-bulk-custom-functions nil
  1855. "Alist of characters and custom functions for bulk actions.
  1856. For example, this makes those two functions available:
  1857. (setq org-agenda-bulk-custom-functions
  1858. \\='((?R set-category)
  1859. (?C bulk-cut)))
  1860. With selected entries in an agenda buffer, `B R' will call
  1861. the custom function `set-category' on the selected entries.
  1862. Note that functions in this alist don't need to be quoted.
  1863. You can also specify a function which collects arguments to be
  1864. used for each call to your bulk custom function. The argument
  1865. collecting function will be run once and should return a list of
  1866. arguments to pass to the bulk function. For example:
  1867. (setq org-agenda-bulk-custom-functions
  1868. \\='((?R set-category get-category)))
  1869. Now, `B R' will call the custom `get-category' which would prompt
  1870. the user once for a category. That category is then passed as an
  1871. argument to `set-category' for each entry it's called against."
  1872. :type
  1873. '(alist :key-type character
  1874. :value-type
  1875. (group (function :tag "Bulk Custom Function")
  1876. (choice (function :tag "Bulk Custom Argument Function")
  1877. (const :tag "No Bulk Custom Argument Function" nil))))
  1878. :package-version '(Org . "9.5")
  1879. :group 'org-agenda)
  1880. (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
  1881. "Execute BODY with point at location given by `org-hd-marker' property.
  1882. If STRING is non-nil, the text property will be fetched from position 0
  1883. in that string. If STRING is nil, it will be fetched from the beginning
  1884. of the current line."
  1885. (declare (debug t) (indent 1))
  1886. (org-with-gensyms (marker)
  1887. `(let ((,marker (get-text-property (if ,string 0 (line-beginning-position))
  1888. 'org-hd-marker ,string)))
  1889. (with-current-buffer (marker-buffer ,marker)
  1890. (save-excursion
  1891. (goto-char ,marker)
  1892. ,@body)))))
  1893. (defun org-add-agenda-custom-command (entry)
  1894. "Replace or add a command in `org-agenda-custom-commands'.
  1895. This is mostly for hacking and trying a new command - once the command
  1896. works you probably want to add it to `org-agenda-custom-commands' for good."
  1897. (let ((ass (assoc (car entry) org-agenda-custom-commands)))
  1898. (if ass
  1899. (setcdr ass (cdr entry))
  1900. (push entry org-agenda-custom-commands))))
  1901. (defmacro org-agenda--insert-overriding-header (default)
  1902. "Insert header into agenda view.
  1903. The inserted header depends on `org-agenda-overriding-header'.
  1904. If the empty string, don't insert a header. If any other string,
  1905. insert it as a header. If nil, insert DEFAULT, which should
  1906. evaluate to a string. If a function, call it and insert the
  1907. string that it returns."
  1908. (declare (debug (form)) (indent defun))
  1909. `(cond
  1910. ((not org-agenda-overriding-header) (insert ,default))
  1911. ((equal org-agenda-overriding-header "") nil)
  1912. ((stringp org-agenda-overriding-header)
  1913. (insert (propertize org-agenda-overriding-header
  1914. 'face 'org-agenda-structure)
  1915. "\n"))
  1916. ((functionp org-agenda-overriding-header)
  1917. (insert (funcall org-agenda-overriding-header)))
  1918. (t (user-error "Invalid value for `org-agenda-overriding-header': %S"
  1919. org-agenda-overriding-header))))
  1920. ;;; Define the org-agenda-mode
  1921. (defvaralias 'org-agenda-keymap 'org-agenda-mode-map)
  1922. (defvar org-agenda-mode-map (make-sparse-keymap)
  1923. "Keymap for `org-agenda-mode'.")
  1924. (org-remap org-agenda-mode-map 'move-end-of-line 'org-agenda-end-of-line)
  1925. (defvar org-agenda-menu) ; defined later in this file.
  1926. (defvar org-agenda-restrict nil)
  1927. (defvar org-agenda-follow-mode nil)
  1928. (defvar org-agenda-entry-text-mode nil)
  1929. (defvar org-agenda-clockreport-mode nil)
  1930. (defvar org-agenda-show-log nil
  1931. "When non-nil, show the log in the agenda.
  1932. Do not set this directly; instead use
  1933. `org-agenda-start-with-log-mode', which see.")
  1934. (defvar org-agenda-redo-command nil)
  1935. (defvar org-agenda-query-string nil)
  1936. (defvar org-agenda-mode-hook nil
  1937. "Hook run after `org-agenda-mode' is turned on.
  1938. The buffer is still writable when this hook is called.")
  1939. (defvar org-agenda-type nil)
  1940. (defvar org-agenda-force-single-file nil)
  1941. (defvar org-agenda-bulk-marked-entries nil
  1942. "List of markers that refer to marked entries in the agenda.")
  1943. (defvar org-agenda-current-date nil
  1944. "Active date when building the agenda.")
  1945. ;;; Multiple agenda buffers support
  1946. (defcustom org-agenda-sticky nil
  1947. "Non-nil means agenda q key will bury agenda buffers.
  1948. Agenda commands will then show existing buffer instead of generating new ones.
  1949. When nil, `q' will kill the single agenda buffer."
  1950. :group 'org-agenda
  1951. :version "24.3"
  1952. :type 'boolean)
  1953. ;;;###autoload
  1954. (defun org-toggle-sticky-agenda (&optional arg)
  1955. "Toggle `org-agenda-sticky'."
  1956. (interactive "P")
  1957. (let ((new-value (if arg
  1958. (> (prefix-numeric-value arg) 0)
  1959. (not org-agenda-sticky))))
  1960. (if (equal new-value org-agenda-sticky)
  1961. (and (called-interactively-p 'interactive)
  1962. (message "Sticky agenda was already %s"
  1963. (if org-agenda-sticky "enabled" "disabled")))
  1964. (setq org-agenda-sticky new-value)
  1965. (org-agenda-kill-all-agenda-buffers)
  1966. (and (called-interactively-p 'interactive)
  1967. (message "Sticky agenda %s"
  1968. (if org-agenda-sticky "enabled" "disabled"))))))
  1969. (defvar org-agenda-buffer nil
  1970. "Agenda buffer currently being generated.")
  1971. (defvar org-agenda-last-prefix-arg nil)
  1972. (defvar org-agenda-this-buffer-name nil)
  1973. (defvar org-agenda-doing-sticky-redo nil)
  1974. (defvar org-agenda-this-buffer-is-sticky nil)
  1975. (defvar org-agenda-last-indirect-buffer nil
  1976. "Last buffer loaded by `org-agenda-tree-to-indirect-buffer'.")
  1977. (defconst org-agenda-local-vars
  1978. '(org-agenda-this-buffer-name
  1979. org-agenda-undo-list
  1980. org-agenda-pending-undo-list
  1981. org-agenda-follow-mode
  1982. org-agenda-entry-text-mode
  1983. org-agenda-clockreport-mode
  1984. org-agenda-show-log
  1985. org-agenda-redo-command
  1986. org-agenda-query-string
  1987. org-agenda-type
  1988. org-agenda-bulk-marked-entries
  1989. org-agenda-undo-has-started-in
  1990. org-agenda-info
  1991. org-agenda-pre-window-conf
  1992. org-agenda-columns-active
  1993. org-agenda-tag-filter
  1994. org-agenda-category-filter
  1995. org-agenda-top-headline-filter
  1996. org-agenda-regexp-filter
  1997. org-agenda-effort-filter
  1998. org-agenda-markers
  1999. org-agenda-last-search-view-search-was-boolean
  2000. org-agenda-last-indirect-buffer
  2001. org-agenda-filtered-by-category
  2002. org-agenda-filter-form
  2003. org-agenda-cycle-counter
  2004. org-agenda-last-prefix-arg)
  2005. "Variables that must be local in agenda buffers to allow multiple buffers.")
  2006. (defun org-agenda-mode ()
  2007. "Mode for time-sorted view on action items in Org files.
  2008. The following commands are available:
  2009. \\{org-agenda-mode-map}"
  2010. (interactive)
  2011. (ignore-errors (require 'face-remap))
  2012. (let ((agenda-local-vars-to-keep
  2013. '(text-scale-mode-amount
  2014. text-scale-mode
  2015. text-scale-mode-lighter
  2016. face-remapping-alist))
  2017. (save (buffer-local-variables)))
  2018. (kill-all-local-variables)
  2019. (cl-flet ((reset-saved (var-set)
  2020. "Reset variables in VAR-SET to possibly stored value in SAVE."
  2021. (dolist (elem save)
  2022. (pcase elem
  2023. (`(,var . ,val) ;ignore unbound variables
  2024. (when (and val (memq var var-set))
  2025. (set var val)))))))
  2026. (cond (org-agenda-doing-sticky-redo
  2027. ;; Refreshing sticky agenda-buffer
  2028. ;;
  2029. ;; Preserve the value of `org-agenda-local-vars' variables.
  2030. (mapc #'make-local-variable org-agenda-local-vars)
  2031. (reset-saved org-agenda-local-vars)
  2032. (setq-local org-agenda-this-buffer-is-sticky t))
  2033. (org-agenda-sticky
  2034. ;; Creating a sticky Agenda buffer for the first time
  2035. (mapc #'make-local-variable org-agenda-local-vars)
  2036. (setq-local org-agenda-this-buffer-is-sticky t))
  2037. (t
  2038. ;; Creating a non-sticky agenda buffer
  2039. (setq-local org-agenda-this-buffer-is-sticky nil)))
  2040. (mapc #'make-local-variable agenda-local-vars-to-keep)
  2041. (reset-saved agenda-local-vars-to-keep)))
  2042. (setq org-agenda-undo-list nil
  2043. org-agenda-pending-undo-list nil
  2044. org-agenda-bulk-marked-entries nil)
  2045. (setq major-mode 'org-agenda-mode)
  2046. ;; Keep global-font-lock-mode from turning on font-lock-mode
  2047. (setq-local font-lock-global-modes (list 'not major-mode))
  2048. (setq mode-name "Org-Agenda")
  2049. (setq indent-tabs-mode nil)
  2050. (use-local-map org-agenda-mode-map)
  2051. (when org-startup-truncated (setq truncate-lines t))
  2052. (setq-local line-move-visual nil)
  2053. (add-hook 'post-command-hook #'org-agenda-update-agenda-type nil 'local)
  2054. (add-hook 'pre-command-hook #'org-unhighlight nil 'local)
  2055. ;; Make sure properties are removed when copying text
  2056. (if (boundp 'filter-buffer-substring-functions)
  2057. (add-hook 'filter-buffer-substring-functions
  2058. (lambda (fun start end delete)
  2059. (substring-no-properties (funcall fun start end delete)))
  2060. nil t)
  2061. ;; Emacs >= 24.4.
  2062. (add-function :filter-return (local 'filter-buffer-substring-function)
  2063. #'substring-no-properties))
  2064. (unless org-agenda-keep-modes
  2065. (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
  2066. org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
  2067. org-agenda-show-log org-agenda-start-with-log-mode
  2068. org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode))
  2069. (add-to-invisibility-spec '(org-filtered))
  2070. (org-fold-core-initialize `(,org-link--description-folding-spec
  2071. ,org-link--link-folding-spec))
  2072. (easy-menu-change
  2073. '("Agenda") "Agenda Files"
  2074. (append
  2075. (list
  2076. (vector
  2077. (if (get 'org-agenda-files 'org-restrict)
  2078. "Restricted to single file"
  2079. "Edit File List")
  2080. '(org-edit-agenda-file-list)
  2081. (not (get 'org-agenda-files 'org-restrict)))
  2082. "--")
  2083. (mapcar #'org-file-menu-entry (org-agenda-files))))
  2084. (org-agenda-set-mode-name)
  2085. (run-mode-hooks 'org-agenda-mode-hook))
  2086. (substitute-key-definition #'undo #'org-agenda-undo
  2087. org-agenda-mode-map global-map)
  2088. (org-defkey org-agenda-mode-map "\C-i" #'org-agenda-goto)
  2089. (org-defkey org-agenda-mode-map [(tab)] #'org-agenda-goto)
  2090. (org-defkey org-agenda-mode-map "\C-m" #'org-agenda-switch-to)
  2091. (org-defkey org-agenda-mode-map "\C-k" #'org-agenda-kill)
  2092. (org-defkey org-agenda-mode-map "\C-c\C-w" #'org-agenda-refile)
  2093. (org-defkey org-agenda-mode-map [(meta down)] #'org-agenda-drag-line-forward)
  2094. (org-defkey org-agenda-mode-map [(meta up)] #'org-agenda-drag-line-backward)
  2095. (org-defkey org-agenda-mode-map "m" #'org-agenda-bulk-mark)
  2096. (org-defkey org-agenda-mode-map "\M-m" #'org-agenda-bulk-toggle)
  2097. (org-defkey org-agenda-mode-map "*" #'org-agenda-bulk-mark-all)
  2098. (org-defkey org-agenda-mode-map "\M-*" #'org-agenda-bulk-toggle-all)
  2099. (org-defkey org-agenda-mode-map "#" #'org-agenda-dim-blocked-tasks)
  2100. (org-defkey org-agenda-mode-map "%" #'org-agenda-bulk-mark-regexp)
  2101. (org-defkey org-agenda-mode-map "u" #'org-agenda-bulk-unmark)
  2102. (org-defkey org-agenda-mode-map "U" #'org-agenda-bulk-unmark-all)
  2103. (org-defkey org-agenda-mode-map "B" #'org-agenda-bulk-action)
  2104. (org-defkey org-agenda-mode-map "k" #'org-agenda-capture)
  2105. (org-defkey org-agenda-mode-map "A" #'org-agenda-append-agenda)
  2106. (org-defkey org-agenda-mode-map "\C-c\C-x!" #'org-reload)
  2107. (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" #'org-agenda-archive-default)
  2108. (org-defkey org-agenda-mode-map "\C-c\C-xa" #'org-agenda-toggle-archive-tag)
  2109. (org-defkey org-agenda-mode-map "\C-c\C-xA" #'org-agenda-archive-to-archive-sibling)
  2110. (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" #'org-agenda-archive)
  2111. (org-defkey org-agenda-mode-map "\C-c$" #'org-agenda-archive)
  2112. (org-defkey org-agenda-mode-map "$" #'org-agenda-archive)
  2113. (org-defkey org-agenda-mode-map "\C-c\C-o" #'org-agenda-open-link)
  2114. (org-defkey org-agenda-mode-map " " #'org-agenda-show-and-scroll-up)
  2115. (org-defkey org-agenda-mode-map [backspace] #'org-agenda-show-scroll-down)
  2116. (org-defkey org-agenda-mode-map "\d" #'org-agenda-show-scroll-down)
  2117. (org-defkey org-agenda-mode-map [(control shift right)] #'org-agenda-todo-nextset)
  2118. (org-defkey org-agenda-mode-map [(control shift left)] #'org-agenda-todo-previousset)
  2119. (org-defkey org-agenda-mode-map "\C-c\C-xb" #'org-agenda-tree-to-indirect-buffer)
  2120. (org-defkey org-agenda-mode-map "o" #'delete-other-windows)
  2121. (org-defkey org-agenda-mode-map "L" #'org-agenda-recenter)
  2122. (org-defkey org-agenda-mode-map "\C-c\C-t" #'org-agenda-todo)
  2123. (org-defkey org-agenda-mode-map "t" #'org-agenda-todo)
  2124. (org-defkey org-agenda-mode-map "a" #'org-agenda-archive-default-with-confirmation)
  2125. (org-defkey org-agenda-mode-map ":" #'org-agenda-set-tags)
  2126. (org-defkey org-agenda-mode-map "\C-c\C-q" #'org-agenda-set-tags)
  2127. (org-defkey org-agenda-mode-map "." #'org-agenda-goto-today)
  2128. (org-defkey org-agenda-mode-map "j" #'org-agenda-goto-date)
  2129. (org-defkey org-agenda-mode-map "d" #'org-agenda-day-view)
  2130. (org-defkey org-agenda-mode-map "w" #'org-agenda-week-view)
  2131. (org-defkey org-agenda-mode-map "y" #'org-agenda-year-view)
  2132. (org-defkey org-agenda-mode-map "\C-c\C-z" #'org-agenda-add-note)
  2133. (org-defkey org-agenda-mode-map "z" #'org-agenda-add-note)
  2134. (org-defkey org-agenda-mode-map [(shift right)] #'org-agenda-do-date-later)
  2135. (org-defkey org-agenda-mode-map [(shift left)] #'org-agenda-do-date-earlier)
  2136. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] #'org-agenda-do-date-later)
  2137. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] #'org-agenda-do-date-earlier)
  2138. (org-defkey org-agenda-mode-map ">" #'org-agenda-date-prompt)
  2139. (org-defkey org-agenda-mode-map "\C-c\C-s" #'org-agenda-schedule)
  2140. (org-defkey org-agenda-mode-map "\C-c\C-d" #'org-agenda-deadline)
  2141. (let ((l '(1 2 3 4 5 6 7 8 9 0)))
  2142. (while l (org-defkey org-agenda-mode-map
  2143. (number-to-string (pop l)) #'digit-argument)))
  2144. (org-defkey org-agenda-mode-map "F" #'org-agenda-follow-mode)
  2145. (org-defkey org-agenda-mode-map "R" #'org-agenda-clockreport-mode)
  2146. (org-defkey org-agenda-mode-map "E" #'org-agenda-entry-text-mode)
  2147. (org-defkey org-agenda-mode-map "l" #'org-agenda-log-mode)
  2148. (org-defkey org-agenda-mode-map "v" #'org-agenda-view-mode-dispatch)
  2149. (org-defkey org-agenda-mode-map "D" #'org-agenda-toggle-diary)
  2150. (org-defkey org-agenda-mode-map "!" #'org-agenda-toggle-deadlines)
  2151. (org-defkey org-agenda-mode-map "G" #'org-agenda-toggle-time-grid)
  2152. (org-defkey org-agenda-mode-map "r" #'org-agenda-redo)
  2153. (org-defkey org-agenda-mode-map "g" #'org-agenda-redo-all)
  2154. (org-defkey org-agenda-mode-map "e" #'org-agenda-set-effort)
  2155. (org-defkey org-agenda-mode-map "\C-c\C-xe" #'org-agenda-set-effort)
  2156. (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
  2157. #'org-clock-modify-effort-estimate)
  2158. (org-defkey org-agenda-mode-map "\C-c\C-xp" #'org-agenda-set-property)
  2159. (org-defkey org-agenda-mode-map "q" #'org-agenda-quit)
  2160. (org-defkey org-agenda-mode-map "Q" #'org-agenda-Quit)
  2161. (org-defkey org-agenda-mode-map "x" #'org-agenda-exit)
  2162. (org-defkey org-agenda-mode-map "\C-x\C-w" #'org-agenda-write)
  2163. (org-defkey org-agenda-mode-map "\C-x\C-s" #'org-save-all-org-buffers)
  2164. (org-defkey org-agenda-mode-map "s" #'org-save-all-org-buffers)
  2165. (org-defkey org-agenda-mode-map "T" #'org-agenda-show-tags)
  2166. (org-defkey org-agenda-mode-map "n" #'org-agenda-next-line)
  2167. (org-defkey org-agenda-mode-map "p" #'org-agenda-previous-line)
  2168. (org-defkey org-agenda-mode-map "N" #'org-agenda-next-item)
  2169. (org-defkey org-agenda-mode-map "P" #'org-agenda-previous-item)
  2170. (substitute-key-definition #'next-line #'org-agenda-next-line
  2171. org-agenda-mode-map global-map)
  2172. (substitute-key-definition #'previous-line #'org-agenda-previous-line
  2173. org-agenda-mode-map global-map)
  2174. (org-defkey org-agenda-mode-map "\C-c\C-a" #'org-attach)
  2175. (org-defkey org-agenda-mode-map "\C-c\C-n" #'org-agenda-next-date-line)
  2176. (org-defkey org-agenda-mode-map "\C-c\C-p" #'org-agenda-previous-date-line)
  2177. (org-defkey org-agenda-mode-map "\C-c," #'org-agenda-priority)
  2178. (org-defkey org-agenda-mode-map "," #'org-agenda-priority)
  2179. (org-defkey org-agenda-mode-map "i" #'org-agenda-diary-entry)
  2180. (org-defkey org-agenda-mode-map "c" #'org-agenda-goto-calendar)
  2181. (org-defkey org-agenda-mode-map "C" #'org-agenda-convert-date)
  2182. (org-defkey org-agenda-mode-map "M" #'org-agenda-phases-of-moon)
  2183. (org-defkey org-agenda-mode-map "S" #'org-agenda-sunrise-sunset)
  2184. (org-defkey org-agenda-mode-map "h" #'org-agenda-holidays)
  2185. (org-defkey org-agenda-mode-map "H" #'org-agenda-holidays)
  2186. (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" #'org-agenda-clock-in)
  2187. (org-defkey org-agenda-mode-map "I" #'org-agenda-clock-in)
  2188. (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" #'org-agenda-clock-out)
  2189. (org-defkey org-agenda-mode-map "O" #'org-agenda-clock-out)
  2190. (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" #'org-agenda-clock-cancel)
  2191. (org-defkey org-agenda-mode-map "X" #'org-agenda-clock-cancel)
  2192. (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" #'org-clock-goto)
  2193. (org-defkey org-agenda-mode-map "J" #'org-agenda-clock-goto)
  2194. (org-defkey org-agenda-mode-map "+" #'org-agenda-priority-up)
  2195. (org-defkey org-agenda-mode-map "-" #'org-agenda-priority-down)
  2196. (org-defkey org-agenda-mode-map [(shift up)] #'org-agenda-priority-up)
  2197. (org-defkey org-agenda-mode-map [(shift down)] #'org-agenda-priority-down)
  2198. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] #'org-agenda-priority-up)
  2199. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] #'org-agenda-priority-down)
  2200. (org-defkey org-agenda-mode-map "f" #'org-agenda-later)
  2201. (org-defkey org-agenda-mode-map "b" #'org-agenda-earlier)
  2202. (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" #'org-agenda-columns)
  2203. (org-defkey org-agenda-mode-map "\C-c\C-x>" #'org-agenda-remove-restriction-lock)
  2204. (org-defkey org-agenda-mode-map "\C-c\C-x<" #'org-agenda-set-restriction-lock-from-agenda)
  2205. (org-defkey org-agenda-mode-map "[" #'org-agenda-manipulate-query-add)
  2206. (org-defkey org-agenda-mode-map "]" #'org-agenda-manipulate-query-subtract)
  2207. (org-defkey org-agenda-mode-map "{" #'org-agenda-manipulate-query-add-re)
  2208. (org-defkey org-agenda-mode-map "}" #'org-agenda-manipulate-query-subtract-re)
  2209. (org-defkey org-agenda-mode-map "\\" #'org-agenda-filter-by-tag)
  2210. (org-defkey org-agenda-mode-map "_" #'org-agenda-filter-by-effort)
  2211. (org-defkey org-agenda-mode-map "=" #'org-agenda-filter-by-regexp)
  2212. (org-defkey org-agenda-mode-map "/" #'org-agenda-filter)
  2213. (org-defkey org-agenda-mode-map "|" #'org-agenda-filter-remove-all)
  2214. (org-defkey org-agenda-mode-map "~" #'org-agenda-limit-interactively)
  2215. (org-defkey org-agenda-mode-map "<" #'org-agenda-filter-by-category)
  2216. (org-defkey org-agenda-mode-map "^" #'org-agenda-filter-by-top-headline)
  2217. (org-defkey org-agenda-mode-map ";" #'org-timer-set-timer)
  2218. (org-defkey org-agenda-mode-map "\C-c\C-x_" #'org-timer-stop)
  2219. (org-defkey org-agenda-mode-map "?" #'org-agenda-show-the-flagging-note)
  2220. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" #'org-mobile-pull)
  2221. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" #'org-mobile-push)
  2222. (org-defkey org-agenda-mode-map "\C-c\C-xI" #'org-info-find-node)
  2223. (org-defkey org-agenda-mode-map [mouse-2] #'org-agenda-goto-mouse)
  2224. (org-defkey org-agenda-mode-map [mouse-3] #'org-agenda-show-mouse)
  2225. (org-defkey org-agenda-mode-map [remap forward-paragraph] #'org-agenda-forward-block)
  2226. (org-defkey org-agenda-mode-map [remap backward-paragraph] #'org-agenda-backward-block)
  2227. (org-defkey org-agenda-mode-map "\C-c\C-c" #'org-agenda-ctrl-c-ctrl-c)
  2228. (when org-agenda-mouse-1-follows-link
  2229. (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
  2230. (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu."
  2231. '("Agenda"
  2232. ("Agenda Files")
  2233. "--"
  2234. ("Agenda Dates"
  2235. ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda)]
  2236. ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
  2237. ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
  2238. ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
  2239. "--"
  2240. ("View"
  2241. ["Day View" org-agenda-day-view
  2242. :active (org-agenda-check-type nil 'agenda)
  2243. :style radio :selected (eq org-agenda-current-span 'day)
  2244. :keys "v d (or just d)"]
  2245. ["Week View" org-agenda-week-view
  2246. :active (org-agenda-check-type nil 'agenda)
  2247. :style radio :selected (eq org-agenda-current-span 'week)
  2248. :keys "v w"]
  2249. ["Fortnight View" org-agenda-fortnight-view
  2250. :active (org-agenda-check-type nil 'agenda)
  2251. :style radio :selected (eq org-agenda-current-span 'fortnight)
  2252. :keys "v t"]
  2253. ["Month View" org-agenda-month-view
  2254. :active (org-agenda-check-type nil 'agenda)
  2255. :style radio :selected (eq org-agenda-current-span 'month)
  2256. :keys "v m"]
  2257. ["Year View" org-agenda-year-view
  2258. :active (org-agenda-check-type nil 'agenda)
  2259. :style radio :selected (eq org-agenda-current-span 'year)
  2260. :keys "v y"]
  2261. "--"
  2262. ["Include Diary" org-agenda-toggle-diary
  2263. :style toggle :selected org-agenda-include-diary
  2264. :active (org-agenda-check-type nil 'agenda)]
  2265. ["Include Deadlines" org-agenda-toggle-deadlines
  2266. :style toggle :selected org-agenda-include-deadlines
  2267. :active (org-agenda-check-type nil 'agenda)]
  2268. ["Use Time Grid" org-agenda-toggle-time-grid
  2269. :style toggle :selected org-agenda-use-time-grid
  2270. :active (org-agenda-check-type nil 'agenda)]
  2271. "--"
  2272. ["Show clock report" org-agenda-clockreport-mode
  2273. :style toggle :selected org-agenda-clockreport-mode
  2274. :active (org-agenda-check-type nil 'agenda)]
  2275. ["Show some entry text" org-agenda-entry-text-mode
  2276. :style toggle :selected org-agenda-entry-text-mode
  2277. :active t]
  2278. "--"
  2279. ["Show Logbook entries" org-agenda-log-mode
  2280. :style toggle :selected org-agenda-show-log
  2281. :active (org-agenda-check-type nil 'agenda)
  2282. :keys "v l (or just l)"]
  2283. ["Include archived trees" org-agenda-archives-mode
  2284. :style toggle :selected org-agenda-archives-mode :active t
  2285. :keys "v a"]
  2286. ["Include archive files" (org-agenda-archives-mode t)
  2287. :style toggle :selected (eq org-agenda-archives-mode t) :active t
  2288. :keys "v A"]
  2289. "--"
  2290. ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
  2291. ("Filter current view"
  2292. ["with generic interface" org-agenda-filter t]
  2293. "--"
  2294. ["by category at cursor" org-agenda-filter-by-category t]
  2295. ["by tag" org-agenda-filter-by-tag t]
  2296. ["by effort" org-agenda-filter-by-effort t]
  2297. ["by regexp" org-agenda-filter-by-regexp t]
  2298. ["by top-level headline" org-agenda-filter-by-top-headline t]
  2299. "--"
  2300. ["Remove all filtering" org-agenda-filter-remove-all t]
  2301. "--"
  2302. ["limit" org-agenda-limit-interactively t])
  2303. ["Rebuild buffer" org-agenda-redo t]
  2304. ["Write view to file" org-agenda-write t]
  2305. ["Save all Org buffers" org-save-all-org-buffers t]
  2306. "--"
  2307. ["Show original entry" org-agenda-show t]
  2308. ["Go To (other window)" org-agenda-goto t]
  2309. ["Go To (this window)" org-agenda-switch-to t]
  2310. ["Capture with cursor date" org-agenda-capture t]
  2311. ["Follow Mode" org-agenda-follow-mode
  2312. :style toggle :selected org-agenda-follow-mode :active t]
  2313. ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
  2314. "--"
  2315. ("TODO"
  2316. ["Cycle TODO" org-agenda-todo t]
  2317. ["Next TODO set" org-agenda-todo-nextset t]
  2318. ["Previous TODO set" org-agenda-todo-previousset t]
  2319. ["Add note" org-agenda-add-note t])
  2320. ("Archive/Refile/Delete"
  2321. ["Archive default" org-agenda-archive-default t]
  2322. ["Archive default" org-agenda-archive-default-with-confirmation t]
  2323. ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
  2324. ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
  2325. ["Archive subtree" org-agenda-archive t]
  2326. "--"
  2327. ["Refile" org-agenda-refile t]
  2328. "--"
  2329. ["Delete subtree" org-agenda-kill t])
  2330. ("Bulk action"
  2331. ["Mark entry" org-agenda-bulk-mark t]
  2332. ["Mark all" org-agenda-bulk-mark-all t]
  2333. ["Unmark entry" org-agenda-bulk-unmark t]
  2334. ["Unmark all" org-agenda-bulk-unmark-all :active t :keys "U"]
  2335. ["Toggle mark" org-agenda-bulk-toggle t]
  2336. ["Toggle all" org-agenda-bulk-toggle-all t]
  2337. ["Mark regexp" org-agenda-bulk-mark-regexp t])
  2338. ["Act on all marked" org-agenda-bulk-action t]
  2339. "--"
  2340. ("Tags and Properties"
  2341. ["Show all Tags" org-agenda-show-tags t]
  2342. ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
  2343. ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
  2344. "--"
  2345. ["Column View" org-columns t])
  2346. ("Deadline/Schedule"
  2347. ["Schedule" org-agenda-schedule t]
  2348. ["Set Deadline" org-agenda-deadline t]
  2349. "--"
  2350. ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda)]
  2351. ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda)]
  2352. ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda) :keys "C-u S-right"]
  2353. ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda) :keys "C-u S-left"]
  2354. ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda) :keys "C-u C-u S-right"]
  2355. ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda) :keys "C-u C-u S-left"]
  2356. ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda)])
  2357. ("Clock and Effort"
  2358. ["Clock in" org-agenda-clock-in t]
  2359. ["Clock out" org-agenda-clock-out t]
  2360. ["Clock cancel" org-agenda-clock-cancel t]
  2361. ["Goto running clock" org-clock-goto t]
  2362. "--"
  2363. ["Set Effort" org-agenda-set-effort t]
  2364. ["Change clocked effort" org-clock-modify-effort-estimate
  2365. (org-clock-is-active)])
  2366. ("Priority"
  2367. ["Set Priority" org-agenda-priority t]
  2368. ["Increase Priority" org-agenda-priority-up t]
  2369. ["Decrease Priority" org-agenda-priority-down t]
  2370. ["Show Priority" org-priority-show t])
  2371. ("Calendar/Diary"
  2372. ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda)]
  2373. ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda)]
  2374. ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda)]
  2375. ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda)]
  2376. ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda)]
  2377. ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda)]
  2378. "--"
  2379. ["Create iCalendar File" org-icalendar-combine-agenda-files t])
  2380. "--"
  2381. ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
  2382. "--"
  2383. ("MobileOrg"
  2384. ["Push Files and Views" org-mobile-push t]
  2385. ["Get Captured and Flagged" org-mobile-pull t]
  2386. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "\\[org-agenda] ?"]
  2387. ["Show note / unflag" org-agenda-show-the-flagging-note t]
  2388. "--"
  2389. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  2390. "--"
  2391. ["Quit" org-agenda-quit t]
  2392. ["Exit and Release Buffers" org-agenda-exit t]
  2393. ))
  2394. ;;; Agenda undo
  2395. (defvar org-agenda-allow-remote-undo t
  2396. "Non-nil means allow remote undo from the agenda buffer.")
  2397. (defvar org-agenda-undo-has-started-in nil
  2398. "Buffers that have already seen `undo-start' in the current undo sequence.")
  2399. (defun org-agenda-undo ()
  2400. "Undo a remote editing step in the agenda.
  2401. This undoes changes both in the agenda buffer and in the remote buffer
  2402. that have been changed along."
  2403. (interactive)
  2404. (or org-agenda-allow-remote-undo
  2405. (user-error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
  2406. (when (not (eq this-command last-command))
  2407. (setq org-agenda-undo-has-started-in nil
  2408. org-agenda-pending-undo-list org-agenda-undo-list))
  2409. (when (not org-agenda-pending-undo-list)
  2410. (user-error "No further undo information"))
  2411. (let* ((entry (pop org-agenda-pending-undo-list))
  2412. buf line cmd rembuf)
  2413. (setq cmd (pop entry) line (pop entry))
  2414. (setq rembuf (nth 2 entry))
  2415. (org-with-remote-undo rembuf
  2416. (while (bufferp (setq buf (pop entry)))
  2417. (when (pop entry)
  2418. (with-current-buffer buf
  2419. (let (;; (last-undo-buffer buf)
  2420. (inhibit-read-only t))
  2421. (unless (memq buf org-agenda-undo-has-started-in)
  2422. (push buf org-agenda-undo-has-started-in)
  2423. (make-local-variable 'pending-undo-list)
  2424. (undo-start))
  2425. (while (and pending-undo-list
  2426. (listp pending-undo-list)
  2427. (not (car pending-undo-list)))
  2428. (pop pending-undo-list))
  2429. (undo-more 1))))))
  2430. (org-goto-line line)
  2431. (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
  2432. (defun org-verify-change-for-undo (l1 l2)
  2433. "Verify that a real change occurred between the undo lists L1 and L2."
  2434. (while (and l1 (listp l1) (null (car l1))) (pop l1))
  2435. (while (and l2 (listp l2) (null (car l2))) (pop l2))
  2436. (not (eq l1 l2)))
  2437. ;;; Agenda dispatch
  2438. (defvar org-agenda-restrict-begin (make-marker))
  2439. (defvar org-agenda-restrict-end (make-marker))
  2440. (defvar org-agenda-last-dispatch-buffer nil)
  2441. (defvar org-agenda-overriding-restriction nil)
  2442. (defcustom org-agenda-custom-commands-contexts nil
  2443. "Alist of custom agenda keys and contextual rules.
  2444. For example, if you have a custom agenda command \"p\" and you
  2445. want this command to be accessible only from plain text files,
  2446. use this:
  2447. (setq org-agenda-custom-commands-contexts
  2448. \\='((\"p\" ((in-file . \"\\\\.txt\\\\'\")))))
  2449. Here are the available contexts definitions:
  2450. in-file: command displayed only in matching files
  2451. in-mode: command displayed only in matching modes
  2452. not-in-file: command not displayed in matching files
  2453. not-in-mode: command not displayed in matching modes
  2454. in-buffer: command displayed only in matching buffers
  2455. not-in-buffer: command not displayed in matching buffers
  2456. [function]: a custom function taking no argument
  2457. If you define several checks, the agenda command will be
  2458. accessible if there is at least one valid check.
  2459. You can also bind a key to another agenda custom command
  2460. depending on contextual rules.
  2461. (setq org-agenda-custom-commands-contexts
  2462. \\='((\"p\" \"q\" ((in-file . \"\\\\.txt\\\\'\")))))
  2463. Here it means: in .txt files, use \"p\" as the key for the
  2464. agenda command otherwise associated with \"q\". (The command
  2465. originally associated with \"q\" is not displayed to avoid
  2466. duplicates.)"
  2467. :version "24.3"
  2468. :group 'org-agenda-custom-commands
  2469. :type '(repeat (list :tag "Rule"
  2470. (string :tag " Agenda key")
  2471. (string :tag "Replace by command")
  2472. (repeat :tag "Available when"
  2473. (choice
  2474. (cons :tag "Condition"
  2475. (choice
  2476. (const :tag "In file" in-file)
  2477. (const :tag "Not in file" not-in-file)
  2478. (const :tag "In buffer" in-buffer)
  2479. (const :tag "Not in buffer" not-in-buffer)
  2480. (const :tag "In mode" in-mode)
  2481. (const :tag "Not in mode" not-in-mode))
  2482. (regexp))
  2483. (function :tag "Custom function"))))))
  2484. (defcustom org-agenda-max-entries nil
  2485. "Maximum number of entries to display in an agenda.
  2486. This can be nil (no limit) or an integer or an alist of agenda
  2487. types with an associated number of entries to display in this
  2488. type."
  2489. :version "24.4"
  2490. :package-version '(Org . "8.0")
  2491. :group 'org-agenda-custom-commands
  2492. :type '(choice (symbol :tag "No limit" nil)
  2493. (integer :tag "Max number of entries")
  2494. (repeat
  2495. (cons (choice :tag "Agenda type"
  2496. (const agenda)
  2497. (const todo)
  2498. (const tags)
  2499. (const search))
  2500. (integer :tag "Max number of entries")))))
  2501. (defcustom org-agenda-max-todos nil
  2502. "Maximum number of TODOs to display in an agenda.
  2503. This can be nil (no limit) or an integer or an alist of agenda
  2504. types with an associated number of entries to display in this
  2505. type."
  2506. :version "24.4"
  2507. :package-version '(Org . "8.0")
  2508. :group 'org-agenda-custom-commands
  2509. :type '(choice (symbol :tag "No limit" nil)
  2510. (integer :tag "Max number of TODOs")
  2511. (repeat
  2512. (cons (choice :tag "Agenda type"
  2513. (const agenda)
  2514. (const todo)
  2515. (const tags)
  2516. (const search))
  2517. (integer :tag "Max number of TODOs")))))
  2518. (defcustom org-agenda-max-tags nil
  2519. "Maximum number of tagged entries to display in an agenda.
  2520. This can be nil (no limit) or an integer or an alist of agenda
  2521. types with an associated number of entries to display in this
  2522. type."
  2523. :version "24.4"
  2524. :package-version '(Org . "8.0")
  2525. :group 'org-agenda-custom-commands
  2526. :type '(choice (symbol :tag "No limit" nil)
  2527. (integer :tag "Max number of tagged entries")
  2528. (repeat
  2529. (cons (choice :tag "Agenda type"
  2530. (const agenda)
  2531. (const todo)
  2532. (const tags)
  2533. (const search))
  2534. (integer :tag "Max number of tagged entries")))))
  2535. (defcustom org-agenda-max-effort nil
  2536. "Maximum cumulated effort duration for the agenda.
  2537. This can be nil (no limit) or a number of minutes (as an integer)
  2538. or an alist of agenda types with an associated number of minutes
  2539. to limit entries to in this type."
  2540. :version "24.4"
  2541. :package-version '(Org . "8.0")
  2542. :group 'org-agenda-custom-commands
  2543. :type '(choice (symbol :tag "No limit" nil)
  2544. (integer :tag "Max number of minutes")
  2545. (repeat
  2546. (cons (choice :tag "Agenda type"
  2547. (const agenda)
  2548. (const todo)
  2549. (const tags)
  2550. (const search))
  2551. (integer :tag "Max number of minutes")))))
  2552. (defvar org-agenda-keep-restricted-file-list nil)
  2553. (defvar org-keys nil)
  2554. (defvar org-match nil)
  2555. ;;;###autoload
  2556. (defun org-agenda (&optional arg keys restriction)
  2557. "Dispatch agenda commands to collect entries to the agenda buffer.
  2558. Prompts for a command to execute. Any prefix arg will be passed
  2559. on to the selected command. The default selections are:
  2560. a Call `org-agenda-list' to display the agenda for current day or week.
  2561. t Call `org-todo-list' to display the global todo list.
  2562. T Call `org-todo-list' to display the global todo list, select only
  2563. entries with a specific TODO keyword (the user gets a prompt).
  2564. m Call `org-tags-view' to display headlines with tags matching
  2565. a condition (the user is prompted for the condition).
  2566. M Like `m', but select only TODO entries, no ordinary headlines.
  2567. e Export views to associated files.
  2568. s Search entries for keywords.
  2569. S Search entries for keywords, only with TODO keywords.
  2570. / Multi occur across all agenda files and also files listed
  2571. in `org-agenda-text-search-extra-files'.
  2572. < Restrict agenda commands to buffer, subtree, or region.
  2573. Press several times to get the desired effect.
  2574. > Remove a previous restriction.
  2575. # List \"stuck\" projects.
  2576. ! Configure what \"stuck\" means.
  2577. C Configure custom agenda commands.
  2578. More commands can be added by configuring the variable
  2579. `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
  2580. searches can be pre-defined in this way.
  2581. If the current buffer is in Org mode and visiting a file, you can also
  2582. first press `<' once to indicate that the agenda should be temporarily
  2583. \(until the next use of `\\[org-agenda]') restricted to the current file.
  2584. Pressing `<' twice means to restrict to the current subtree or region
  2585. \(if active)."
  2586. (interactive "P")
  2587. (catch 'exit
  2588. (let* ((org-keys keys)
  2589. (prefix-descriptions nil)
  2590. (org-agenda-buffer-name org-agenda-buffer-name)
  2591. (org-agenda-window-setup (if (equal (buffer-name)
  2592. org-agenda-buffer-name)
  2593. 'current-window
  2594. org-agenda-window-setup))
  2595. (org-agenda-custom-commands-orig org-agenda-custom-commands)
  2596. (org-agenda-custom-commands
  2597. ;; normalize different versions
  2598. (delq nil
  2599. (mapcar
  2600. (lambda (x)
  2601. (cond ((stringp (cdr x))
  2602. (push x prefix-descriptions)
  2603. nil)
  2604. ((stringp (nth 1 x)) x)
  2605. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2606. (t (cons (car x) (cons "" (cdr x))))))
  2607. org-agenda-custom-commands)))
  2608. (org-agenda-custom-commands
  2609. (org-contextualize-keys
  2610. org-agenda-custom-commands org-agenda-custom-commands-contexts))
  2611. ;; (buf (current-buffer))
  2612. (bfn (buffer-file-name (buffer-base-buffer)))
  2613. entry type org-match lprops ans) ;; key
  2614. ;; Turn off restriction unless there is an overriding one,
  2615. (unless org-agenda-overriding-restriction
  2616. (unless org-agenda-keep-restricted-file-list
  2617. ;; There is a request to keep the file list in place
  2618. (put 'org-agenda-files 'org-restrict nil))
  2619. (setq org-agenda-restrict nil)
  2620. (move-marker org-agenda-restrict-begin nil)
  2621. (move-marker org-agenda-restrict-end nil))
  2622. ;; Delete old local properties
  2623. (put 'org-agenda-redo-command 'org-lprops nil)
  2624. ;; Delete previously set last-arguments
  2625. (put 'org-agenda-redo-command 'last-args nil)
  2626. ;; Remember where this call originated
  2627. (setq org-agenda-last-dispatch-buffer (current-buffer))
  2628. (unless org-keys
  2629. (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
  2630. org-keys (car ans)
  2631. restriction (cdr ans)))
  2632. ;; If we have sticky agenda buffers, set a name for the buffer,
  2633. ;; depending on the invoking keys. The user may still set this
  2634. ;; as a command option, which will overwrite what we do here.
  2635. (when org-agenda-sticky
  2636. (setq org-agenda-buffer-name
  2637. (format "*Org Agenda(%s)*" org-keys)))
  2638. ;; Establish the restriction, if any
  2639. (when (and (not org-agenda-overriding-restriction) restriction)
  2640. (put 'org-agenda-files 'org-restrict (list bfn))
  2641. (cond
  2642. ((eq restriction 'region)
  2643. (setq org-agenda-restrict (current-buffer))
  2644. (move-marker org-agenda-restrict-begin (region-beginning))
  2645. (move-marker org-agenda-restrict-end (region-end)))
  2646. ((eq restriction 'subtree)
  2647. (save-excursion
  2648. (setq org-agenda-restrict (current-buffer))
  2649. (org-back-to-heading t)
  2650. (move-marker org-agenda-restrict-begin (point))
  2651. (move-marker org-agenda-restrict-end
  2652. (progn (org-end-of-subtree t)))))
  2653. ((and (eq restriction 'buffer)
  2654. (or (< 1 (point-min))
  2655. (< (point-max) (1+ (buffer-size)))))
  2656. (setq org-agenda-restrict (current-buffer))
  2657. (move-marker org-agenda-restrict-begin (point-min))
  2658. (move-marker org-agenda-restrict-end (point-max)))))
  2659. ;; For example the todo list should not need it (but does...)
  2660. (cond
  2661. ((setq entry (assoc org-keys org-agenda-custom-commands))
  2662. (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
  2663. (progn
  2664. ;; FIXME: Is (nth 3 entry) supposed to have access (via dynvars)
  2665. ;; to some of the local variables? There's no doc about
  2666. ;; that for `org-agenda-custom-commands'.
  2667. (setq type (nth 2 entry) org-match (eval (nth 3 entry) t)
  2668. lprops (nth 4 entry))
  2669. (when org-agenda-sticky
  2670. (setq org-agenda-buffer-name
  2671. (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
  2672. (format "*Org Agenda(%s)*" org-keys))))
  2673. (put 'org-agenda-redo-command 'org-lprops lprops)
  2674. (cl-progv
  2675. (mapcar #'car lprops)
  2676. (mapcar (lambda (binding) (eval (cadr binding) t)) lprops)
  2677. (pcase type
  2678. (`agenda
  2679. (org-agenda-list arg))
  2680. (`agenda*
  2681. (org-agenda-list arg nil nil t))
  2682. (`alltodo
  2683. (org-todo-list arg))
  2684. (`search
  2685. (org-search-view arg org-match nil))
  2686. (`stuck
  2687. (org-agenda-list-stuck-projects arg))
  2688. (`tags
  2689. (org-tags-view arg org-match))
  2690. (`tags-todo
  2691. (org-tags-view '(4) org-match))
  2692. (`todo
  2693. (org-todo-list org-match))
  2694. (`tags-tree
  2695. (org-check-for-org-mode)
  2696. (org-match-sparse-tree arg org-match))
  2697. (`todo-tree
  2698. (org-check-for-org-mode)
  2699. (org-occur (concat "^" org-outline-regexp "[ \t]*"
  2700. (regexp-quote org-match) "\\>")))
  2701. (`occur-tree
  2702. (org-check-for-org-mode)
  2703. (org-occur org-match))
  2704. ((pred functionp)
  2705. (funcall type org-match))
  2706. ;; FIXME: Will signal an error since it's not `functionp'!
  2707. ((pred fboundp) (funcall type org-match))
  2708. (_ (user-error "Invalid custom agenda command type %s" type)))))
  2709. (org-agenda-run-series (nth 1 entry) (cddr entry))))
  2710. ((equal org-keys "C")
  2711. (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
  2712. (customize-variable 'org-agenda-custom-commands))
  2713. ((equal org-keys "a") (call-interactively 'org-agenda-list))
  2714. ((equal org-keys "s") (call-interactively 'org-search-view))
  2715. ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
  2716. ((equal org-keys "t") (call-interactively 'org-todo-list))
  2717. ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
  2718. ((equal org-keys "m") (call-interactively 'org-tags-view))
  2719. ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
  2720. ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
  2721. ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
  2722. (add-hook
  2723. 'post-command-hook
  2724. (lambda ()
  2725. (unless (current-message)
  2726. (let* ((m (org-agenda-get-any-marker))
  2727. (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
  2728. (when note
  2729. (message "FLAGGING-NOTE ([?] for more info): %s"
  2730. (org-add-props
  2731. (replace-regexp-in-string
  2732. "\\\\n" "//"
  2733. (copy-sequence note))
  2734. nil 'face 'org-warning))))))
  2735. t t))
  2736. ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
  2737. ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
  2738. ((equal org-keys "!") (customize-variable 'org-stuck-projects))
  2739. (t (user-error "Invalid agenda key"))))))
  2740. (defvar org-agenda-multi)
  2741. (defun org-agenda-append-agenda ()
  2742. "Append another agenda view to the current one.
  2743. This function allows interactive building of block agendas.
  2744. Agenda views are separated by `org-agenda-block-separator'."
  2745. (interactive)
  2746. (unless (derived-mode-p 'org-agenda-mode)
  2747. (user-error "Can only append from within agenda buffer"))
  2748. (let ((org-agenda-multi t))
  2749. (org-agenda)
  2750. (widen)
  2751. (org-agenda-finalize)
  2752. (setq buffer-read-only t)
  2753. (org-agenda-fit-window-to-buffer)))
  2754. (defun org-agenda-normalize-custom-commands (cmds)
  2755. "Normalize custom commands CMDS."
  2756. (delq nil
  2757. (mapcar
  2758. (lambda (x)
  2759. (cond ((stringp (cdr x)) nil)
  2760. ((stringp (nth 1 x)) x)
  2761. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2762. (t (cons (car x) (cons "" (cdr x))))))
  2763. cmds)))
  2764. (defun org-agenda-get-restriction-and-command (prefix-descriptions)
  2765. "The user interface for selecting an agenda command."
  2766. (catch 'exit
  2767. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  2768. (restrict-ok (and bfn (derived-mode-p 'org-mode)))
  2769. (region-p (org-region-active-p))
  2770. (custom org-agenda-custom-commands)
  2771. (selstring "")
  2772. restriction second-time
  2773. c entry key type match prefixes rmheader header-end custom1 desc
  2774. line lines left right n n1)
  2775. (save-window-excursion
  2776. (delete-other-windows)
  2777. (org-switch-to-buffer-other-window " *Agenda Commands*")
  2778. (erase-buffer)
  2779. (insert (eval-when-compile
  2780. (let ((header
  2781. (copy-sequence
  2782. "Press key for an agenda command:
  2783. -------------------------------- < Buffer, subtree/region restriction
  2784. a Agenda for current week or day > Remove restriction
  2785. t List of all TODO entries e Export agenda views
  2786. m Match a TAGS/PROP/TODO query T Entries with special TODO kwd
  2787. s Search for keywords M Like m, but only TODO entries
  2788. / Multi-occur S Like s, but only TODO entries
  2789. ? Find :FLAGGED: entries C Configure custom agenda commands
  2790. * Toggle sticky agenda views # List stuck projects (!=configure)
  2791. "))
  2792. (start 0))
  2793. (while (string-match
  2794. "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
  2795. header start)
  2796. (setq start (match-end 0))
  2797. (add-text-properties (match-beginning 2) (match-end 2)
  2798. '(face bold) header))
  2799. header)))
  2800. (setq header-end (point-marker))
  2801. (while t
  2802. (setq custom1 custom)
  2803. (when (eq rmheader t)
  2804. (org-goto-line 1)
  2805. (re-search-forward ":" nil t)
  2806. (delete-region (match-end 0) (line-end-position))
  2807. (forward-char 1)
  2808. (looking-at "-+")
  2809. (delete-region (match-end 0) (line-end-position))
  2810. (move-marker header-end (match-end 0)))
  2811. (goto-char header-end)
  2812. (delete-region (point) (point-max))
  2813. ;; Produce all the lines that describe custom commands and prefixes
  2814. (setq lines nil)
  2815. (while (setq entry (pop custom1))
  2816. (setq key (car entry) desc (nth 1 entry)
  2817. type (nth 2 entry)
  2818. match (nth 3 entry))
  2819. (if (> (length key) 1)
  2820. (cl-pushnew (string-to-char key) prefixes :test #'equal)
  2821. (setq line
  2822. (format
  2823. "%-4s%-14s"
  2824. (org-add-props (copy-sequence key)
  2825. '(face bold))
  2826. (cond
  2827. ((string-match "\\S-" desc) desc)
  2828. ((eq type 'agenda) "Agenda for current week or day")
  2829. ((eq type 'agenda*) "Appointments for current week or day")
  2830. ((eq type 'alltodo) "List of all TODO entries")
  2831. ((eq type 'search) "Word search")
  2832. ((eq type 'stuck) "List of stuck projects")
  2833. ((eq type 'todo) "TODO keyword")
  2834. ((eq type 'tags) "Tags query")
  2835. ((eq type 'tags-todo) "Tags (TODO)")
  2836. ((eq type 'tags-tree) "Tags tree")
  2837. ((eq type 'todo-tree) "TODO kwd tree")
  2838. ((eq type 'occur-tree) "Occur tree")
  2839. ((functionp type) (if (symbolp type)
  2840. (symbol-name type)
  2841. "Lambda expression"))
  2842. (t "???"))))
  2843. (cond
  2844. ((not (org-string-nw-p match)) nil)
  2845. (org-agenda-menu-show-matcher
  2846. (setq line
  2847. (concat line ": "
  2848. (cond
  2849. ((stringp match)
  2850. (propertize match 'face 'org-warning))
  2851. ((listp type)
  2852. (format "set of %d commands" (length type)))))))
  2853. (t
  2854. (org-add-props line nil 'help-echo (concat "Matcher: " match))))
  2855. (push line lines)))
  2856. (setq lines (nreverse lines))
  2857. (when prefixes
  2858. (mapc (lambda (x)
  2859. (push
  2860. (format "%s %s"
  2861. (org-add-props (char-to-string x)
  2862. nil 'face 'bold)
  2863. (or (cdr (assoc (concat selstring
  2864. (char-to-string x))
  2865. prefix-descriptions))
  2866. "Prefix key"))
  2867. lines))
  2868. prefixes))
  2869. ;; Check if we should display in two columns
  2870. (if org-agenda-menu-two-columns
  2871. (progn
  2872. (setq n (length lines)
  2873. n1 (+ (/ n 2) (mod n 2))
  2874. right (nthcdr n1 lines)
  2875. left (copy-sequence lines))
  2876. (setcdr (nthcdr (1- n1) left) nil))
  2877. (setq left lines right nil))
  2878. (while left
  2879. (insert "\n" (pop left))
  2880. (when right
  2881. (if (< (current-column) 40)
  2882. (move-to-column 40 t)
  2883. (insert " "))
  2884. (insert (pop right))))
  2885. ;; Make the window the right size
  2886. (goto-char (point-min))
  2887. (if second-time
  2888. (when (not (pos-visible-in-window-p (point-max)))
  2889. (org-fit-window-to-buffer))
  2890. (setq second-time t)
  2891. (org-fit-window-to-buffer))
  2892. ;; Hint to navigation if window too small for all information
  2893. (setq header-line-format
  2894. (when (not (pos-visible-in-window-p (point-max)))
  2895. "Use C-v, M-v, C-n or C-p to navigate."))
  2896. ;; Ask for selection
  2897. (cl-loop
  2898. do (progn
  2899. (message "Press key for agenda command%s:"
  2900. (if (or restrict-ok org-agenda-overriding-restriction)
  2901. (if org-agenda-overriding-restriction
  2902. " (restriction lock active)"
  2903. (if restriction
  2904. (format " (restricted to %s)" restriction)
  2905. " (unrestricted)"))
  2906. ""))
  2907. (setq c (read-char-exclusive)))
  2908. until (not (memq c '(14 16 22 134217846)))
  2909. do (org-scroll c))
  2910. (message "")
  2911. (cond
  2912. ((assoc (char-to-string c) custom)
  2913. (setq selstring (concat selstring (char-to-string c)))
  2914. (throw 'exit (cons selstring restriction)))
  2915. ((memq c prefixes)
  2916. (setq selstring (concat selstring (char-to-string c))
  2917. prefixes nil
  2918. rmheader (or rmheader t)
  2919. custom (delq nil (mapcar
  2920. (lambda (x)
  2921. (if (or (= (length (car x)) 1)
  2922. (/= (string-to-char (car x)) c))
  2923. nil
  2924. (cons (substring (car x) 1) (cdr x))))
  2925. custom))))
  2926. ((eq c ?*)
  2927. (call-interactively 'org-toggle-sticky-agenda)
  2928. (sit-for 2))
  2929. ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
  2930. (message "Restriction is only possible in Org buffers")
  2931. (ding) (sit-for 1))
  2932. ((eq c ?1)
  2933. (org-agenda-remove-restriction-lock 'noupdate)
  2934. (setq restriction 'buffer))
  2935. ((eq c ?0)
  2936. (org-agenda-remove-restriction-lock 'noupdate)
  2937. (setq restriction (if region-p 'region 'subtree)))
  2938. ((eq c ?<)
  2939. (org-agenda-remove-restriction-lock 'noupdate)
  2940. (setq restriction
  2941. (cond
  2942. ((eq restriction 'buffer)
  2943. (if region-p 'region 'subtree))
  2944. ((memq restriction '(subtree region))
  2945. nil)
  2946. (t 'buffer))))
  2947. ((eq c ?>)
  2948. (org-agenda-remove-restriction-lock 'noupdate)
  2949. (setq restriction nil))
  2950. ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
  2951. (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
  2952. ((and (> (length selstring) 0) (eq c ?\d))
  2953. (delete-window)
  2954. (org-agenda-get-restriction-and-command prefix-descriptions))
  2955. ((equal c ?q) (user-error "Abort"))
  2956. (t (user-error "Invalid key %c" c))))))))
  2957. (defun org-agenda-fit-window-to-buffer ()
  2958. "Fit the window to the buffer size."
  2959. (and (memq org-agenda-window-setup '(reorganize-frame))
  2960. (fboundp 'fit-window-to-buffer)
  2961. (if (and (= (cdr org-agenda-window-frame-fractions) 1.0)
  2962. (= (car org-agenda-window-frame-fractions) 1.0))
  2963. (delete-other-windows)
  2964. (org-fit-window-to-buffer
  2965. nil
  2966. (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
  2967. (floor (* (frame-height) (car org-agenda-window-frame-fractions)))))))
  2968. (defvar org-cmd nil)
  2969. (defvar org-agenda-overriding-cmd nil)
  2970. (defvar org-agenda-overriding-arguments nil)
  2971. (defvar org-agenda-overriding-cmd-arguments nil)
  2972. (defun org-let (list &rest body) ;FIXME: So many kittens are suffering here.
  2973. (declare (indent 1) (obsolete cl-progv "2021"))
  2974. (eval (cons 'let (cons list body))))
  2975. (defun org-let2 (list1 list2 &rest body) ;FIXME: Where did our karma go?
  2976. (declare (indent 2) (obsolete cl-progv "2021"))
  2977. (eval (cons 'let (cons list1 (list (cons 'let (cons list2 body)))))))
  2978. (defun org-agenda-run-series (name series)
  2979. "Run agenda NAME as a SERIES of agenda commands."
  2980. (let* ((gprops (nth 1 series))
  2981. (gvars (mapcar #'car gprops))
  2982. (gvals (mapcar (lambda (binding) (eval (cadr binding) t)) gprops)))
  2983. (cl-progv gvars gvals (org-agenda-prepare name))
  2984. ;; We need to reset agenda markers here, because when constructing a
  2985. ;; block agenda, the individual blocks do not do that.
  2986. (org-agenda-reset-markers)
  2987. (with-no-warnings
  2988. (defvar match)) ;Used via the `eval' below.
  2989. (let* ((org-agenda-multi t)
  2990. ;; FIXME: Redo should contain lists of (FUNS . ARGS) rather
  2991. ;; than expressions, so you don't need to `quote' the args
  2992. ;; and you just need to `apply' instead of `eval' when using it.
  2993. (redo (list 'org-agenda-run-series name (list 'quote series)))
  2994. (cmds (car series))
  2995. match
  2996. org-cmd type lprops)
  2997. (while (setq org-cmd (pop cmds))
  2998. (setq type (car org-cmd))
  2999. (setq match (eval (nth 1 org-cmd) t))
  3000. (setq lprops (nth 2 org-cmd))
  3001. (let ((org-agenda-overriding-arguments
  3002. (if (eq org-agenda-overriding-cmd org-cmd)
  3003. (or org-agenda-overriding-arguments
  3004. org-agenda-overriding-cmd-arguments)))
  3005. (lvars (mapcar #'car lprops))
  3006. (lvals (mapcar (lambda (binding) (eval (cadr binding) t)) lprops)))
  3007. (cl-progv (append gvars lvars) (append gvals lvals)
  3008. (pcase type
  3009. (`agenda
  3010. (call-interactively 'org-agenda-list))
  3011. (`agenda*
  3012. (funcall 'org-agenda-list nil nil t))
  3013. (`alltodo
  3014. (call-interactively 'org-todo-list))
  3015. (`search
  3016. (org-search-view current-prefix-arg match nil))
  3017. (`stuck
  3018. (call-interactively 'org-agenda-list-stuck-projects))
  3019. (`tags
  3020. (org-tags-view current-prefix-arg match))
  3021. (`tags-todo
  3022. (org-tags-view '(4) match))
  3023. (`todo
  3024. (org-todo-list match))
  3025. ((pred fboundp)
  3026. (funcall type match))
  3027. (_ (error "Invalid type in command series"))))))
  3028. (widen)
  3029. (let ((inhibit-read-only t))
  3030. (add-text-properties (point-min) (point-max)
  3031. `(org-series t org-series-redo-cmd ,redo)))
  3032. (setq org-agenda-redo-command redo)
  3033. (goto-char (point-min)))
  3034. (org-agenda-fit-window-to-buffer)
  3035. (cl-progv gvars gvals (org-agenda-finalize))))
  3036. (defun org-agenda--split-plist (plist)
  3037. ;; We could/should arguably use `map-keys' and `map-values'.
  3038. (let (keys vals)
  3039. (while plist
  3040. (push (pop plist) keys)
  3041. (push (pop plist) vals))
  3042. (cons (nreverse keys) (nreverse vals))))
  3043. ;;;###autoload
  3044. (defmacro org-batch-agenda (cmd-key &rest parameters)
  3045. "Run an agenda command in batch mode and send the result to STDOUT.
  3046. If CMD-KEY is a string of length 1, it is used as a key in
  3047. `org-agenda-custom-commands' and triggers this command. If it is a
  3048. longer string it is used as a tags/todo match string.
  3049. Parameters are alternating variable names and values that will be bound
  3050. before running the agenda command."
  3051. (pcase-let ((`(,vars . ,exps) (org-agenda--split-plist parameters)))
  3052. `(org--batch-agenda ,cmd-key ',vars (list ,@exps))))
  3053. (defun org--batch-agenda (cmd-key vars vals)
  3054. ;; `org-batch-agenda' is a macro because every other "parameter" is
  3055. ;; a variable name rather than an expression to evaluate. Yuck!
  3056. (cl-progv vars vals
  3057. (let (org-agenda-sticky)
  3058. (if (> (length cmd-key) 1)
  3059. (org-tags-view nil cmd-key)
  3060. (org-agenda nil cmd-key))))
  3061. (set-buffer org-agenda-buffer-name)
  3062. (princ (buffer-string)))
  3063. (defvar org-agenda-info nil)
  3064. ;;;###autoload
  3065. (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
  3066. "Run an agenda command in batch mode and send the result to STDOUT.
  3067. If CMD-KEY is a string of length 1, it is used as a key in
  3068. `org-agenda-custom-commands' and triggers this command. If it is a
  3069. longer string it is used as a tags/todo match string.
  3070. Parameters are alternating variable names and values that will be bound
  3071. before running the agenda command.
  3072. The output gives a line for each selected agenda item. Each
  3073. item is a list of comma-separated values, like this:
  3074. category,head,type,todo,tags,date,time,extra,priority-l,priority-n
  3075. category The category of the item
  3076. head The headline, without TODO kwd, TAGS and PRIORITY
  3077. type The type of the agenda entry, can be
  3078. todo selected in TODO match
  3079. tagsmatch selected in tags match
  3080. diary imported from diary
  3081. deadline a deadline on given date
  3082. scheduled scheduled on given date
  3083. timestamp entry has timestamp on given date
  3084. closed entry was closed on given date
  3085. upcoming-deadline warning about deadline
  3086. past-scheduled forwarded scheduled item
  3087. block entry has date block including g. date
  3088. todo The todo keyword, if any
  3089. tags All tags including inherited ones, separated by colons
  3090. date The relevant date, like 2007-2-14
  3091. time The time, like 15:00-16:50
  3092. extra String with extra planning info
  3093. priority-l The priority letter if any was given
  3094. priority-n The computed numerical priority
  3095. agenda-day The day in the agenda where this is listed"
  3096. (pcase-let ((`(,vars . ,exps) (org-agenda--split-plist parameters)))
  3097. `(org--batch-agenda-csv ,cmd-key ',vars (list ,@exps))))
  3098. (defun org--batch-agenda-csv (cmd-key vars vals)
  3099. ;; `org-batch-agenda-csv' is a macro because every other "parameter" is
  3100. ;; a variable name rather than an expression to evaluate. Yuck!
  3101. (let ((org-agenda-remove-tags t))
  3102. (cl-progv vars vals
  3103. ;; FIXME: Shouldn't this be 1 (see commit 10173ad6d610b)?
  3104. (if (> (length cmd-key) 2)
  3105. (org-tags-view nil cmd-key)
  3106. (org-agenda nil cmd-key))))
  3107. (set-buffer org-agenda-buffer-name)
  3108. (let ((lines (org-split-string (buffer-string) "\n")))
  3109. (dolist (line lines)
  3110. (when (get-text-property 0 'org-category line)
  3111. (setq org-agenda-info
  3112. (org-fix-agenda-info (text-properties-at 0 line)))
  3113. (princ
  3114. (mapconcat #'org-agenda-export-csv-mapper
  3115. '(org-category txt type todo tags date time extra
  3116. priority-letter priority agenda-day)
  3117. ","))
  3118. (princ "\n")))))
  3119. (defun org-fix-agenda-info (props)
  3120. "Make sure all properties on an agenda item have a canonical form.
  3121. This ensures the export commands can easily use it."
  3122. (let (tmp re)
  3123. (when (setq tmp (plist-get props 'tags))
  3124. (setq props (plist-put props 'tags (mapconcat #'identity tmp ":"))))
  3125. (when (setq tmp (plist-get props 'date))
  3126. (when (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  3127. (let ((calendar-date-display-form '(year "-" month "-" day)))
  3128. '((format "%4d, %9s %2s, %4s" dayname monthname day year))
  3129. (setq tmp (calendar-date-string tmp)))
  3130. (setq props (plist-put props 'date tmp)))
  3131. (when (setq tmp (plist-get props 'day))
  3132. (when (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  3133. (let ((calendar-date-display-form '(year "-" month "-" day)))
  3134. (setq tmp (calendar-date-string tmp)))
  3135. (setq props (plist-put props 'day tmp))
  3136. (setq props (plist-put props 'agenda-day tmp)))
  3137. (when (setq tmp (plist-get props 'txt))
  3138. (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
  3139. (plist-put props 'priority-letter (match-string 1 tmp))
  3140. (setq tmp (replace-match "" t t tmp)))
  3141. (when (and (setq re (plist-get props 'org-todo-regexp))
  3142. (setq re (concat "\\`\\.*" re " ?"))
  3143. (let ((case-fold-search nil)) (string-match re tmp)))
  3144. (plist-put props 'todo (match-string 1 tmp))
  3145. (setq tmp (replace-match "" t t tmp)))
  3146. (plist-put props 'txt tmp)))
  3147. props)
  3148. (defun org-agenda-export-csv-mapper (prop)
  3149. (let ((res (plist-get org-agenda-info prop)))
  3150. (setq res
  3151. (cond
  3152. ((not res) "")
  3153. ((stringp res) res)
  3154. (t (prin1-to-string res))))
  3155. (org-trim (replace-regexp-in-string "," ";" res nil t))))
  3156. ;;;###autoload
  3157. (defun org-store-agenda-views (&rest _parameters)
  3158. "Store agenda views."
  3159. (interactive)
  3160. (org--batch-store-agenda-views nil nil))
  3161. ;;;###autoload
  3162. (defmacro org-batch-store-agenda-views (&rest parameters)
  3163. "Run all custom agenda commands that have a file argument."
  3164. (pcase-let ((`(,vars . ,exps) (org-agenda--split-plist parameters)))
  3165. `(org--batch-store-agenda-views ',vars (list ,@exps))))
  3166. (defun org--batch-store-agenda-views (vars vals)
  3167. (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
  3168. (pop-up-frames nil)
  3169. (dir default-directory)
  3170. cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
  3171. (save-window-excursion
  3172. (while cmds
  3173. (setq cmd (pop cmds)
  3174. thiscmdkey (car cmd)
  3175. thiscmdcmd (cdr cmd)
  3176. match (nth 2 thiscmdcmd)
  3177. bufname (if org-agenda-sticky
  3178. (or (and (stringp match)
  3179. (format "*Org Agenda(%s:%s)*" thiscmdkey match))
  3180. (format "*Org Agenda(%s)*" thiscmdkey))
  3181. org-agenda-buffer-name)
  3182. cmd-or-set (nth 2 cmd)
  3183. opts (nth (if (listp cmd-or-set) 3 4) cmd)
  3184. files (nth (if (listp cmd-or-set) 4 5) cmd))
  3185. (if (stringp files) (setq files (list files)))
  3186. (when files
  3187. (let* ((opts (append org-agenda-exporter-settings opts))
  3188. (vars (append (mapcar #'car opts) vars))
  3189. (vals (append (mapcar (lambda (binding) (eval (cadr binding) t))
  3190. opts)
  3191. vals)))
  3192. (cl-progv vars vals
  3193. (org-agenda nil thiscmdkey))
  3194. (set-buffer bufname)
  3195. (while files
  3196. (cl-progv vars vals
  3197. (org-agenda-write (expand-file-name (pop files) dir)
  3198. nil t bufname))))
  3199. (and (get-buffer bufname)
  3200. (kill-buffer bufname)))))))
  3201. (defvar org-agenda-current-span nil
  3202. "The current span used in the agenda view.") ; local variable in the agenda buffer
  3203. (defun org-agenda-mark-header-line (pos)
  3204. "Mark the line at POS as an agenda structure header."
  3205. (save-excursion
  3206. (goto-char pos)
  3207. (put-text-property (line-beginning-position) (line-end-position)
  3208. 'org-agenda-structural-header t)
  3209. (when org-agenda-title-append
  3210. (put-text-property (line-beginning-position) (line-end-position)
  3211. 'org-agenda-title-append org-agenda-title-append))))
  3212. (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
  3213. (defvar org-agenda-write-buffer-name "Agenda View")
  3214. (defun org-agenda-write (file &optional open nosettings agenda-bufname)
  3215. "Write the current buffer (an agenda view) as a file.
  3216. Depending on the extension of the file name, plain text (.txt),
  3217. HTML (.html or .htm), PDF (.pdf) or Postscript (.ps) is produced.
  3218. If the extension is .ics, translate visible agenda into iCalendar
  3219. format. If the extension is .org, collect all subtrees
  3220. corresponding to the agenda entries and add them in an .org file.
  3221. With prefix argument OPEN, open the new file immediately. If
  3222. NOSETTINGS is given, do not scope the settings of
  3223. `org-agenda-exporter-settings' into the export commands. This is
  3224. used when the settings have already been scoped and we do not
  3225. wish to overrule other, higher priority settings. If
  3226. AGENDA-BUFFER-NAME is provided, use this as the buffer name for
  3227. the agenda to write."
  3228. (interactive "FWrite agenda to file: \nP")
  3229. (if (or (not (file-writable-p file))
  3230. (and (file-exists-p file)
  3231. (if (called-interactively-p 'any)
  3232. (not (y-or-n-p (format "Overwrite existing file %s? " file))))))
  3233. (user-error "Cannot write agenda to file %s" file))
  3234. (cl-progv
  3235. (if nosettings nil (mapcar #'car org-agenda-exporter-settings))
  3236. (if nosettings nil (mapcar (lambda (binding) (eval (cadr binding) t))
  3237. org-agenda-exporter-settings))
  3238. (save-excursion
  3239. (save-window-excursion
  3240. (let ((bs (copy-sequence (buffer-string)))
  3241. (extension (file-name-extension file))
  3242. (default-directory (file-name-directory file))
  3243. ) ;; beg content
  3244. (with-temp-buffer
  3245. (rename-buffer org-agenda-write-buffer-name t)
  3246. (set-buffer-modified-p nil)
  3247. (insert bs)
  3248. (org-agenda-remove-marked-text 'invisible 'org-filtered)
  3249. (run-hooks 'org-agenda-before-write-hook)
  3250. (cond
  3251. ((bound-and-true-p org-mobile-creating-agendas)
  3252. (org-mobile-write-agenda-for-mobile file))
  3253. ((string= "org" extension)
  3254. (let (content p m message-log-max)
  3255. (goto-char (point-min))
  3256. (while (setq p (next-single-property-change (point) 'org-hd-marker nil))
  3257. (goto-char p)
  3258. (setq m (get-text-property (point) 'org-hd-marker))
  3259. (when m
  3260. (push (with-current-buffer (marker-buffer m)
  3261. (goto-char m)
  3262. (org-copy-subtree 1 nil t t)
  3263. org-subtree-clip)
  3264. content)))
  3265. (find-file file)
  3266. (erase-buffer)
  3267. (dolist (s content) (org-paste-subtree 1 s))
  3268. (write-file file)
  3269. (kill-buffer (current-buffer))
  3270. (message "Org file written to %s" file)))
  3271. ((member extension '("html" "htm"))
  3272. (or (require 'htmlize nil t)
  3273. (error "Please install htmlize from https://github.com/hniksic/emacs-htmlize"))
  3274. (declare-function htmlize-buffer "htmlize" (&optional buffer))
  3275. (set-buffer (htmlize-buffer (current-buffer)))
  3276. (when org-agenda-export-html-style
  3277. ;; replace <style> section with org-agenda-export-html-style
  3278. (goto-char (point-min))
  3279. (kill-region (- (search-forward "<style") 6)
  3280. (search-forward "</style>"))
  3281. (insert org-agenda-export-html-style))
  3282. (write-file file)
  3283. (kill-buffer (current-buffer))
  3284. (message "HTML written to %s" file))
  3285. ((string= "ps" extension)
  3286. (require 'ps-print)
  3287. (ps-print-buffer-with-faces file)
  3288. (message "Postscript written to %s" file))
  3289. ((string= "pdf" extension)
  3290. (require 'ps-print)
  3291. (ps-print-buffer-with-faces
  3292. (concat (file-name-sans-extension file) ".ps"))
  3293. (call-process "ps2pdf" nil nil nil
  3294. (expand-file-name
  3295. (concat (file-name-sans-extension file) ".ps"))
  3296. (expand-file-name file))
  3297. (delete-file (concat (file-name-sans-extension file) ".ps"))
  3298. (message "PDF written to %s" file))
  3299. ((string= "ics" extension)
  3300. (require 'ox-icalendar)
  3301. (declare-function org-icalendar-export-current-agenda
  3302. "ox-icalendar" (file))
  3303. (org-icalendar-export-current-agenda (expand-file-name file)))
  3304. (t
  3305. (let ((bs (buffer-string)))
  3306. (find-file file)
  3307. (erase-buffer)
  3308. (insert bs)
  3309. (save-buffer 0)
  3310. (kill-buffer (current-buffer))
  3311. (message "Plain text written to %s" file))))))))
  3312. (set-buffer (or agenda-bufname
  3313. ;; FIXME: I'm pretty sure called-interactively-p
  3314. ;; doesn't do what we want here!
  3315. (and (called-interactively-p 'any) (buffer-name))
  3316. org-agenda-buffer-name)))
  3317. (when open (org-open-file file)))
  3318. (defun org-agenda-remove-marked-text (property &optional value)
  3319. "Delete all text marked with VALUE of PROPERTY.
  3320. VALUE defaults to t."
  3321. (let (beg)
  3322. (setq value (or value t))
  3323. (while (setq beg (text-property-any (point-min) (point-max)
  3324. property value))
  3325. (delete-region
  3326. beg (or (next-single-property-change beg property)
  3327. (point-max))))))
  3328. (defun org-agenda-add-entry-text ()
  3329. "Add entry text to agenda lines.
  3330. This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
  3331. entry text following headings shown in the agenda.
  3332. Drawers will be excluded, also the line with scheduling/deadline info."
  3333. (when (and (> org-agenda-add-entry-text-maxlines 0)
  3334. (not (bound-and-true-p org-mobile-creating-agendas)))
  3335. (let (m txt)
  3336. (goto-char (point-min))
  3337. (while (not (eobp))
  3338. (if (not (setq m (org-get-at-bol 'org-hd-marker)))
  3339. (beginning-of-line 2)
  3340. (setq txt (org-agenda-get-some-entry-text
  3341. m org-agenda-add-entry-text-maxlines " > "))
  3342. (end-of-line 1)
  3343. (if (string-match "\\S-" txt)
  3344. (insert "\n" txt)
  3345. (or (eobp) (forward-char 1))))))))
  3346. (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
  3347. &rest keep)
  3348. "Extract entry text from MARKER, at most N-LINES lines.
  3349. This will ignore drawers etc, just get the text.
  3350. If INDENT is given, prefix every line with this string. If KEEP is
  3351. given, it is a list of symbols, defining stuff that should not be
  3352. removed from the entry content. Currently only `planning' is allowed here."
  3353. (let (txt drawer-re kwd-time-re ind)
  3354. (save-excursion
  3355. (with-current-buffer (marker-buffer marker)
  3356. (if (not (derived-mode-p 'org-mode))
  3357. (setq txt "")
  3358. (org-with-wide-buffer
  3359. (goto-char marker)
  3360. (end-of-line 1)
  3361. (setq txt (buffer-substring
  3362. (min (1+ (point)) (point-max))
  3363. (progn (outline-next-heading) (point)))
  3364. drawer-re org-drawer-regexp
  3365. kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
  3366. ".*\n?"))
  3367. (with-temp-buffer
  3368. (insert txt)
  3369. (when org-agenda-add-entry-text-descriptive-links
  3370. (goto-char (point-min))
  3371. (while (org-activate-links (point-max))
  3372. (goto-char (match-end 0))))
  3373. (goto-char (point-min))
  3374. (while (re-search-forward org-link-bracket-re (point-max) t)
  3375. (set-text-properties (match-beginning 0) (match-end 0)
  3376. nil))
  3377. (goto-char (point-min))
  3378. (while (re-search-forward drawer-re nil t)
  3379. (delete-region
  3380. (match-beginning 0)
  3381. (progn (re-search-forward
  3382. "^[ \t]*:END:.*\n?" nil 'move)
  3383. (point))))
  3384. (unless (member 'planning keep)
  3385. (goto-char (point-min))
  3386. (while (re-search-forward kwd-time-re nil t)
  3387. (replace-match "")))
  3388. (goto-char (point-min))
  3389. (when org-agenda-entry-text-exclude-regexps
  3390. (let ((re-list org-agenda-entry-text-exclude-regexps) re)
  3391. (while (setq re (pop re-list))
  3392. (goto-char (point-min))
  3393. (while (re-search-forward re nil t)
  3394. (replace-match "")))))
  3395. (goto-char (point-max))
  3396. (skip-chars-backward " \t\n")
  3397. (when (looking-at "[ \t\n]+\\'") (replace-match ""))
  3398. ;; find and remove min common indentation
  3399. (goto-char (point-min))
  3400. (untabify (point-min) (point-max))
  3401. (setq ind (current-indentation))
  3402. (while (not (eobp))
  3403. (unless (looking-at "[ \t]*$")
  3404. (setq ind (min ind (current-indentation))))
  3405. (beginning-of-line 2))
  3406. (goto-char (point-min))
  3407. (while (not (eobp))
  3408. (unless (looking-at "[ \t]*$")
  3409. (move-to-column ind)
  3410. (delete-region (line-beginning-position) (point)))
  3411. (beginning-of-line 2))
  3412. (run-hooks 'org-agenda-entry-text-cleanup-hook)
  3413. (goto-char (point-min))
  3414. (when indent
  3415. (while (and (not (eobp)) (re-search-forward "^" nil t))
  3416. (replace-match indent t t)))
  3417. (goto-char (point-min))
  3418. (while (looking-at "[ \t]*\n") (replace-match ""))
  3419. (goto-char (point-max))
  3420. (when (> (org-current-line)
  3421. n-lines)
  3422. (org-goto-line (1+ n-lines))
  3423. (backward-char 1))
  3424. (setq txt (buffer-substring (point-min) (point))))))))
  3425. txt))
  3426. (defun org-check-for-org-mode ()
  3427. "Make sure current buffer is in Org mode. Error if not."
  3428. (or (derived-mode-p 'org-mode)
  3429. (error "Cannot execute Org agenda command on buffer in %s"
  3430. major-mode)))
  3431. ;;; Agenda prepare and finalize
  3432. (defvar org-agenda-multi nil) ; dynamically scoped
  3433. (defvar org-agenda-pre-window-conf nil)
  3434. (defvar org-agenda-columns-active nil)
  3435. (defvar org-agenda-name nil)
  3436. (defvar org-agenda-tag-filter nil)
  3437. (defvar org-agenda-category-filter nil)
  3438. (defvar org-agenda-regexp-filter nil)
  3439. (defvar org-agenda-effort-filter nil)
  3440. (defvar org-agenda-top-headline-filter nil)
  3441. (defvar org-agenda-represented-categories nil
  3442. "Cache for the list of all categories in the agenda.")
  3443. (defvar org-agenda-represented-tags nil
  3444. "Cache for the list of all categories in the agenda.")
  3445. (defvar org-agenda-tag-filter-preset nil
  3446. "A preset of the tags filter used for secondary agenda filtering.
  3447. This must be a list of strings, each string must be a single tag preceded
  3448. by \"+\" or \"-\".
  3449. This variable should not be set directly, but agenda custom commands can
  3450. bind it in the options section. The preset filter is a global property of
  3451. the entire agenda view. In a block agenda, it will not work reliably to
  3452. define a filter for one of the individual blocks. You need to set it in
  3453. the global options and expect it to be applied to the entire view.")
  3454. (defconst org-agenda-filter-variables
  3455. '((category . org-agenda-category-filter)
  3456. (tag . org-agenda-tag-filter)
  3457. (effort . org-agenda-effort-filter)
  3458. (regexp . org-agenda-regexp-filter))
  3459. "Alist of filter types and associated variables.")
  3460. (defun org-agenda-filter-any ()
  3461. "Is any filter active?"
  3462. (cl-some (lambda (x)
  3463. (or (symbol-value (cdr x))
  3464. (get :preset-filter x)))
  3465. org-agenda-filter-variables))
  3466. (defvar org-agenda-category-filter-preset nil
  3467. "A preset of the category filter used for secondary agenda filtering.
  3468. This must be a list of strings, each string must be a single category
  3469. preceded by \"+\" or \"-\".
  3470. This variable should not be set directly, but agenda custom commands can
  3471. bind it in the options section. The preset filter is a global property of
  3472. the entire agenda view. In a block agenda, it will not work reliably to
  3473. define a filter for one of the individual blocks. You need to set it in
  3474. the global options and expect it to be applied to the entire view.")
  3475. (defvar org-agenda-regexp-filter-preset nil
  3476. "A preset of the regexp filter used for secondary agenda filtering.
  3477. This must be a list of strings, each string must be a single regexp
  3478. preceded by \"+\" or \"-\".
  3479. This variable should not be set directly, but agenda custom commands can
  3480. bind it in the options section. The preset filter is a global property of
  3481. the entire agenda view. In a block agenda, it will not work reliably to
  3482. define a filter for one of the individual blocks. You need to set it in
  3483. the global options and expect it to be applied to the entire view.")
  3484. (defvar org-agenda-effort-filter-preset nil
  3485. "A preset of the effort condition used for secondary agenda filtering.
  3486. This must be a list of strings, each string must be a single regexp
  3487. preceded by \"+\" or \"-\".
  3488. This variable should not be set directly, but agenda custom commands can
  3489. bind it in the options section. The preset filter is a global property of
  3490. the entire agenda view. In a block agenda, it will not work reliably to
  3491. define a filter for one of the individual blocks. You need to set it in
  3492. the global options and expect it to be applied to the entire view.")
  3493. (defun org-agenda-use-sticky-p ()
  3494. "Return non-nil if an agenda buffer named
  3495. `org-agenda-buffer-name' exists and should be shown instead of
  3496. generating a new one."
  3497. (and
  3498. ;; turned off by user
  3499. org-agenda-sticky
  3500. ;; For multi-agenda buffer already exists
  3501. (not org-agenda-multi)
  3502. ;; buffer found
  3503. (get-buffer org-agenda-buffer-name)
  3504. ;; C-u parameter is same as last call
  3505. (with-current-buffer (get-buffer org-agenda-buffer-name)
  3506. (and
  3507. (equal current-prefix-arg
  3508. org-agenda-last-prefix-arg)
  3509. ;; In case user turned stickiness on, while having existing
  3510. ;; Agenda buffer active, don't reuse that buffer, because it
  3511. ;; does not have org variables local
  3512. org-agenda-this-buffer-is-sticky))))
  3513. (defvar org-agenda-buffer-tmp-name nil)
  3514. (defun org-agenda--get-buffer-name (sticky-name)
  3515. (or org-agenda-buffer-tmp-name
  3516. (and org-agenda-doing-sticky-redo org-agenda-buffer-name)
  3517. sticky-name
  3518. "*Org Agenda*"))
  3519. (defun org-agenda-prepare-window (abuf filter-alist)
  3520. "Setup agenda buffer in the window.
  3521. ABUF is the buffer for the agenda window.
  3522. FILTER-ALIST is an alist of filters we need to apply when
  3523. `org-agenda-persistent-filter' is non-nil."
  3524. (let* ((awin (get-buffer-window abuf)) wconf)
  3525. (cond
  3526. ((equal (current-buffer) abuf) nil)
  3527. (awin (select-window awin))
  3528. ((not (setq wconf (current-window-configuration))))
  3529. ((eq org-agenda-window-setup 'current-window)
  3530. (pop-to-buffer-same-window abuf))
  3531. ((eq org-agenda-window-setup 'other-window)
  3532. (org-switch-to-buffer-other-window abuf))
  3533. ((eq org-agenda-window-setup 'other-frame)
  3534. (switch-to-buffer-other-frame abuf))
  3535. ((eq org-agenda-window-setup 'other-tab)
  3536. (if (fboundp 'switch-to-buffer-other-tab)
  3537. (switch-to-buffer-other-tab abuf)
  3538. (user-error "Your version of Emacs does not have tab bar support")))
  3539. ((eq org-agenda-window-setup 'only-window)
  3540. (delete-other-windows)
  3541. (pop-to-buffer-same-window abuf))
  3542. ((eq org-agenda-window-setup 'reorganize-frame)
  3543. (delete-other-windows)
  3544. (org-switch-to-buffer-other-window abuf)))
  3545. (setq org-agenda-tag-filter (cdr (assq 'tag filter-alist)))
  3546. (setq org-agenda-category-filter (cdr (assq 'cat filter-alist)))
  3547. (setq org-agenda-effort-filter (cdr (assq 'effort filter-alist)))
  3548. (setq org-agenda-regexp-filter (cdr (assq 're filter-alist)))
  3549. ;; Additional test in case agenda is invoked from within agenda
  3550. ;; buffer via elisp link.
  3551. (unless (equal (current-buffer) abuf)
  3552. (pop-to-buffer-same-window abuf))
  3553. (setq org-agenda-pre-window-conf
  3554. (or wconf org-agenda-pre-window-conf))))
  3555. (defun org-agenda-prepare (&optional name)
  3556. (let ((filter-alist (when org-agenda-persistent-filter
  3557. (with-current-buffer
  3558. (get-buffer-create org-agenda-buffer-name)
  3559. `((tag . ,org-agenda-tag-filter)
  3560. (re . ,org-agenda-regexp-filter)
  3561. (effort . ,org-agenda-effort-filter)
  3562. (cat . ,org-agenda-category-filter))))))
  3563. (if (org-agenda-use-sticky-p)
  3564. (progn
  3565. (put 'org-agenda-tag-filter :preset-filter nil)
  3566. (put 'org-agenda-category-filter :preset-filter nil)
  3567. (put 'org-agenda-regexp-filter :preset-filter nil)
  3568. (put 'org-agenda-effort-filter :preset-filter nil)
  3569. ;; Popup existing buffer
  3570. (org-agenda-prepare-window (get-buffer org-agenda-buffer-name)
  3571. filter-alist)
  3572. (message "Sticky Agenda buffer, use `r' to refresh")
  3573. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3574. (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
  3575. (setq org-todo-keywords-for-agenda nil)
  3576. (put 'org-agenda-tag-filter :preset-filter
  3577. org-agenda-tag-filter-preset)
  3578. (put 'org-agenda-category-filter :preset-filter
  3579. org-agenda-category-filter-preset)
  3580. (put 'org-agenda-regexp-filter :preset-filter
  3581. org-agenda-regexp-filter-preset)
  3582. (put 'org-agenda-effort-filter :preset-filter
  3583. org-agenda-effort-filter-preset)
  3584. (if org-agenda-multi
  3585. (progn
  3586. (setq buffer-read-only nil)
  3587. (goto-char (point-max))
  3588. (unless (or (bobp) org-agenda-compact-blocks
  3589. (not org-agenda-block-separator))
  3590. (insert "\n"
  3591. (if (stringp org-agenda-block-separator)
  3592. org-agenda-block-separator
  3593. (make-string (window-max-chars-per-line) org-agenda-block-separator))
  3594. "\n"))
  3595. (narrow-to-region (point) (point-max)))
  3596. (setq org-done-keywords-for-agenda nil)
  3597. ;; Setting any org variables that are in org-agenda-local-vars
  3598. ;; list need to be done after the prepare call
  3599. (org-agenda-prepare-window
  3600. (get-buffer-create org-agenda-buffer-name) filter-alist)
  3601. (setq buffer-read-only nil)
  3602. (org-agenda-reset-markers)
  3603. (let ((inhibit-read-only t)) (erase-buffer))
  3604. (org-agenda-mode)
  3605. (setq org-agenda-buffer (current-buffer))
  3606. (setq org-agenda-contributing-files nil)
  3607. (setq org-agenda-columns-active nil)
  3608. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  3609. (setq org-todo-keywords-for-agenda
  3610. (org-uniquify org-todo-keywords-for-agenda))
  3611. (setq org-done-keywords-for-agenda
  3612. (org-uniquify org-done-keywords-for-agenda))
  3613. (setq org-agenda-last-prefix-arg current-prefix-arg)
  3614. (setq org-agenda-this-buffer-name org-agenda-buffer-name)
  3615. (and name (not org-agenda-name)
  3616. (setq-local org-agenda-name name)))
  3617. (setq buffer-read-only nil))))
  3618. (defvar org-overriding-columns-format)
  3619. (defvar org-local-columns-format)
  3620. (defun org-agenda-finalize ()
  3621. "Finishing touch for the agenda buffer.
  3622. This function is called just before displaying the agenda. If
  3623. you want to add your own functions to the finalization of the
  3624. agenda display, configure `org-agenda-finalize-hook'."
  3625. (unless org-agenda-multi
  3626. (let ((inhibit-read-only t))
  3627. (save-excursion
  3628. (goto-char (point-min))
  3629. (save-excursion
  3630. (while (org-activate-links (point-max))
  3631. (goto-char (match-end 0))))
  3632. (unless (eq org-agenda-remove-tags t)
  3633. (org-agenda-align-tags))
  3634. (unless org-agenda-with-colors
  3635. (remove-text-properties (point-min) (point-max) '(face nil)))
  3636. (when (bound-and-true-p org-overriding-columns-format)
  3637. (setq-local org-local-columns-format
  3638. org-overriding-columns-format))
  3639. (when org-agenda-view-columns-initially
  3640. (org-agenda-columns))
  3641. (when org-agenda-fontify-priorities
  3642. (org-agenda-fontify-priorities))
  3643. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  3644. (org-agenda-dim-blocked-tasks))
  3645. (org-agenda-mark-clocking-task)
  3646. (when org-agenda-entry-text-mode
  3647. (org-agenda-entry-text-hide)
  3648. (org-agenda-entry-text-show))
  3649. (when (and (featurep 'org-habit)
  3650. (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
  3651. (org-habit-insert-consistency-graphs))
  3652. (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
  3653. (unless (or (eq org-agenda-show-inherited-tags 'always)
  3654. (and (listp org-agenda-show-inherited-tags)
  3655. (memq org-agenda-type org-agenda-show-inherited-tags))
  3656. (and (eq org-agenda-show-inherited-tags t)
  3657. (or (eq org-agenda-use-tag-inheritance t)
  3658. (and (listp org-agenda-use-tag-inheritance)
  3659. (not (memq org-agenda-type
  3660. org-agenda-use-tag-inheritance))))))
  3661. (let (mrk)
  3662. (save-excursion
  3663. (goto-char (point-min))
  3664. (while (equal (forward-line) 0)
  3665. (when (setq mrk (get-text-property (point) 'org-hd-marker))
  3666. (put-text-property (line-beginning-position) (line-end-position)
  3667. 'tags
  3668. (org-with-point-at mrk
  3669. (org-get-tags))))))))
  3670. (setq org-agenda-represented-tags nil
  3671. org-agenda-represented-categories nil)
  3672. (when org-agenda-top-headline-filter
  3673. (org-agenda-filter-top-headline-apply
  3674. org-agenda-top-headline-filter))
  3675. (when org-agenda-tag-filter
  3676. (org-agenda-filter-apply org-agenda-tag-filter 'tag t))
  3677. (when (get 'org-agenda-tag-filter :preset-filter)
  3678. (org-agenda-filter-apply
  3679. (get 'org-agenda-tag-filter :preset-filter) 'tag t))
  3680. (when org-agenda-category-filter
  3681. (org-agenda-filter-apply org-agenda-category-filter 'category))
  3682. (when (get 'org-agenda-category-filter :preset-filter)
  3683. (org-agenda-filter-apply
  3684. (get 'org-agenda-category-filter :preset-filter) 'category))
  3685. (when org-agenda-regexp-filter
  3686. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
  3687. (when (get 'org-agenda-regexp-filter :preset-filter)
  3688. (org-agenda-filter-apply
  3689. (get 'org-agenda-regexp-filter :preset-filter) 'regexp))
  3690. (when org-agenda-effort-filter
  3691. (org-agenda-filter-apply org-agenda-effort-filter 'effort))
  3692. (when (get 'org-agenda-effort-filter :preset-filter)
  3693. (org-agenda-filter-apply
  3694. (get 'org-agenda-effort-filter :preset-filter) 'effort))
  3695. (add-hook 'kill-buffer-hook #'org-agenda-reset-markers 'append 'local))
  3696. (run-hooks 'org-agenda-finalize-hook))))
  3697. (defun org-agenda-mark-clocking-task ()
  3698. "Mark the current clock entry in the agenda if it is present."
  3699. ;; We need to widen when `org-agenda-finalize' is called from
  3700. ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in').
  3701. (when (bound-and-true-p org-clock-current-task)
  3702. (save-restriction
  3703. (widen)
  3704. (org-agenda-unmark-clocking-task)
  3705. (when (marker-buffer org-clock-hd-marker)
  3706. (save-excursion
  3707. (goto-char (point-min))
  3708. (let (s ov)
  3709. (while (setq s (next-single-property-change (point) 'org-hd-marker))
  3710. (goto-char s)
  3711. (when (equal (org-get-at-bol 'org-hd-marker)
  3712. org-clock-hd-marker)
  3713. (setq ov (make-overlay (line-beginning-position) (1+ (line-end-position))))
  3714. (overlay-put ov 'type 'org-agenda-clocking)
  3715. (overlay-put ov 'face 'org-agenda-clocking)
  3716. (overlay-put ov 'help-echo
  3717. "The clock is running in this item")))))))))
  3718. (defun org-agenda-unmark-clocking-task ()
  3719. "Unmark the current clocking task."
  3720. (mapc (lambda (o)
  3721. (when (eq (overlay-get o 'type) 'org-agenda-clocking)
  3722. (delete-overlay o)))
  3723. (overlays-in (point-min) (point-max))))
  3724. (defun org-agenda-fontify-priorities ()
  3725. "Make highest priority lines bold, and lowest italic."
  3726. (interactive)
  3727. (mapc (lambda (o) (when (eq (overlay-get o 'org-type) 'org-priority)
  3728. (delete-overlay o)))
  3729. (overlays-in (point-min) (point-max)))
  3730. (save-excursion
  3731. (let (b e p ov h l)
  3732. (goto-char (point-min))
  3733. (while (re-search-forward org-priority-regexp nil t)
  3734. (setq h (or (get-char-property (point) 'org-priority-highest)
  3735. org-priority-highest)
  3736. l (or (get-char-property (point) 'org-priority-lowest)
  3737. org-priority-lowest)
  3738. p (string-to-char (match-string 2))
  3739. b (match-beginning 1)
  3740. e (if (eq org-agenda-fontify-priorities 'cookies)
  3741. (1+ (match-end 2))
  3742. (line-end-position))
  3743. ov (make-overlay b e))
  3744. (overlay-put
  3745. ov 'face
  3746. (let ((special-face
  3747. (cond ((org-face-from-face-or-color
  3748. 'priority 'org-priority
  3749. (cdr (assoc p org-priority-faces))))
  3750. ((and (listp org-agenda-fontify-priorities)
  3751. (org-face-from-face-or-color
  3752. 'priority 'org-priority
  3753. (cdr (assoc p org-agenda-fontify-priorities)))))
  3754. ((equal p l) 'italic)
  3755. ((equal p h) 'bold))))
  3756. (if special-face (list special-face 'org-priority) 'org-priority)))
  3757. (overlay-put ov 'org-type 'org-priority)))))
  3758. (defvar org-depend-tag-blocked)
  3759. (defun org-agenda-dim-blocked-tasks (&optional _invisible)
  3760. "Dim currently blocked TODOs in the agenda display.
  3761. When INVISIBLE is non-nil, hide currently blocked TODO instead of
  3762. dimming them." ;FIXME: The arg isn't used, actually!
  3763. (interactive "P")
  3764. (when (called-interactively-p 'interactive)
  3765. (message "Dim or hide blocked tasks..."))
  3766. (dolist (o (overlays-in (point-min) (point-max)))
  3767. (when (eq (overlay-get o 'face) 'org-agenda-dimmed-todo-face)
  3768. (delete-overlay o)))
  3769. (save-excursion
  3770. (let ((inhibit-read-only t))
  3771. (goto-char (point-min))
  3772. (while (let ((pos (text-property-not-all
  3773. (point) (point-max) 'org-todo-blocked nil)))
  3774. (when pos (goto-char pos)))
  3775. (let* ((invisible
  3776. (eq (org-get-at-bol 'org-todo-blocked) 'invisible))
  3777. (todo-blocked
  3778. (eq (org-get-at-bol 'org-filter-type) 'todo-blocked))
  3779. (ov (make-overlay (if invisible
  3780. (line-end-position 0)
  3781. (line-beginning-position))
  3782. (line-end-position))))
  3783. (when todo-blocked
  3784. (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
  3785. (when invisible
  3786. (org-agenda-filter-hide-line 'todo-blocked)))
  3787. (if (= (point-max) (line-end-position))
  3788. (goto-char (point-max))
  3789. (move-beginning-of-line 2)))))
  3790. (when (called-interactively-p 'interactive)
  3791. (message "Dim or hide blocked tasks...done")))
  3792. (defun org-agenda--mark-blocked-entry (entry)
  3793. "If ENTRY is blocked, mark it for fontification or invisibility.
  3794. If the header at `org-hd-marker' is blocked according to
  3795. `org-entry-blocked-p', then if `org-agenda-dim-blocked-tasks' is
  3796. `invisible' and the header is not blocked by checkboxes, set the
  3797. text property `org-todo-blocked' to `invisible', otherwise set it
  3798. to t."
  3799. (when (get-text-property 0 'todo-state entry)
  3800. (let ((entry-marker (get-text-property 0 'org-hd-marker entry))
  3801. (org-blocked-by-checkboxes nil)
  3802. ;; Necessary so that `org-entry-blocked-p' does not change
  3803. ;; the buffer.
  3804. (org-depend-tag-blocked nil))
  3805. (when entry-marker
  3806. (let ((blocked
  3807. (with-current-buffer (marker-buffer entry-marker)
  3808. (save-excursion
  3809. (goto-char entry-marker)
  3810. (org-entry-blocked-p)))))
  3811. (when blocked
  3812. (let ((really-invisible
  3813. (and (not org-blocked-by-checkboxes)
  3814. (eq org-agenda-dim-blocked-tasks 'invisible))))
  3815. (put-text-property
  3816. 0 (length entry) 'org-todo-blocked
  3817. (if really-invisible 'invisible t)
  3818. entry)
  3819. (put-text-property
  3820. 0 (length entry) 'org-filter-type 'todo-blocked entry)))))))
  3821. entry)
  3822. (defvar org-agenda-skip-function nil
  3823. "Function to be called at each match during agenda construction.
  3824. If this function returns nil, the current match should not be skipped.
  3825. Otherwise, the function must return a position from where the search
  3826. should be continued.
  3827. This may also be a Lisp form, it will be evaluated.
  3828. Never set this variable using `setq' or so, because then it will apply
  3829. to all future agenda commands. If you do want a global skipping condition,
  3830. use the option `org-agenda-skip-function-global' instead.
  3831. The correct usage for `org-agenda-skip-function' is to bind it with
  3832. `let' to scope it dynamically into the agenda-constructing command.
  3833. A good way to set it is through options in `org-agenda-custom-commands'.")
  3834. (defun org-agenda-skip (&optional element)
  3835. "Throw to `:skip' in places that should be skipped.
  3836. Also moves point to the end of the skipped region, so that search can
  3837. continue from there.
  3838. Optional argument ELEMENT contains element at point."
  3839. (let ((p (line-beginning-position)) to)
  3840. (when (or
  3841. (save-excursion (goto-char p) (looking-at comment-start-skip))
  3842. (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
  3843. (or (and (save-match-data (org-in-archived-heading-p nil element))
  3844. (org-end-of-subtree t element))
  3845. (and (member org-archive-tag org-file-tags)
  3846. (goto-char (point-max)))))
  3847. (and org-agenda-skip-comment-trees
  3848. (org-in-commented-heading-p nil element)
  3849. (org-end-of-subtree t element))
  3850. (and (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
  3851. (org-agenda-skip-eval org-agenda-skip-function)))
  3852. (goto-char to))
  3853. (org-in-src-block-p t element))
  3854. (throw :skip t))))
  3855. (defun org-agenda-skip-eval (form)
  3856. "If FORM is a function or a list, call (or eval) it and return the result.
  3857. `save-excursion' and `save-match-data' are wrapped around the call, so point
  3858. and match data are returned to the previous state no matter what these
  3859. functions do."
  3860. (let (fp)
  3861. (and form
  3862. (or (setq fp (functionp form))
  3863. (consp form))
  3864. (save-excursion
  3865. (save-match-data
  3866. (if fp
  3867. (funcall form)
  3868. (eval form t)))))))
  3869. (defvar org-agenda-markers nil
  3870. "List of all currently active markers created by `org-agenda'.")
  3871. (defvar org-agenda-last-marker-time (float-time)
  3872. "Creation time of the last agenda marker.")
  3873. (defun org-agenda-new-marker (&optional pos)
  3874. "Return a new agenda marker.
  3875. Marker is at point, or at POS if non-nil. Org mode keeps a list
  3876. of these markers and resets them when they are no longer in use."
  3877. (let ((m (copy-marker (or pos (point)) t)))
  3878. (setq org-agenda-last-marker-time (float-time))
  3879. (if org-agenda-buffer
  3880. (with-current-buffer org-agenda-buffer
  3881. (push m org-agenda-markers))
  3882. (push m org-agenda-markers))
  3883. m))
  3884. (defun org-agenda-reset-markers ()
  3885. "Reset markers created by `org-agenda'."
  3886. (while org-agenda-markers
  3887. (move-marker (pop org-agenda-markers) nil)))
  3888. (defun org-agenda-save-markers-for-cut-and-paste (beg end)
  3889. "Save relative positions of markers in region.
  3890. This check for agenda markers in all agenda buffers currently active."
  3891. (dolist (buf (buffer-list))
  3892. (with-current-buffer buf
  3893. (when (eq major-mode 'org-agenda-mode)
  3894. (mapc (lambda (m) (org-check-and-save-marker m beg end))
  3895. org-agenda-markers)))))
  3896. ;;; Entry text mode
  3897. (defun org-agenda-entry-text-show-here ()
  3898. "Add some text from the entry as context to the current line."
  3899. (let (m txt o)
  3900. (setq m (org-get-at-bol 'org-hd-marker))
  3901. (unless (marker-buffer m)
  3902. (error "No marker points to an entry here"))
  3903. (setq txt (concat "\n" (org-no-properties
  3904. (org-agenda-get-some-entry-text
  3905. m org-agenda-entry-text-maxlines
  3906. org-agenda-entry-text-leaders))))
  3907. (when (string-match "\\S-" txt)
  3908. (setq o (make-overlay (line-beginning-position) (line-end-position)))
  3909. (overlay-put o 'evaporate t)
  3910. (overlay-put o 'org-overlay-type 'agenda-entry-content)
  3911. (overlay-put o 'after-string txt))))
  3912. (defun org-agenda-entry-text-show ()
  3913. "Add entry context for all agenda lines."
  3914. (interactive)
  3915. (save-excursion
  3916. (goto-char (point-max))
  3917. (beginning-of-line 1)
  3918. (while (not (bobp))
  3919. (when (org-get-at-bol 'org-hd-marker)
  3920. (org-agenda-entry-text-show-here))
  3921. (beginning-of-line 0))))
  3922. (defun org-agenda-entry-text-hide ()
  3923. "Remove any shown entry context."
  3924. (mapc (lambda (o)
  3925. (when (eq (overlay-get o 'org-overlay-type)
  3926. 'agenda-entry-content)
  3927. (delete-overlay o)))
  3928. (overlays-in (point-min) (point-max))))
  3929. (defun org-agenda-get-day-face (date)
  3930. "Return the face DATE should be displayed with."
  3931. (cond ((and (functionp org-agenda-day-face-function)
  3932. (funcall org-agenda-day-face-function date)))
  3933. ((and (org-agenda-today-p date)
  3934. (memq (calendar-day-of-week date) org-agenda-weekend-days))
  3935. 'org-agenda-date-weekend-today)
  3936. ((org-agenda-today-p date) 'org-agenda-date-today)
  3937. ((memq (calendar-day-of-week date) org-agenda-weekend-days)
  3938. 'org-agenda-date-weekend)
  3939. (t 'org-agenda-date)))
  3940. (defvar org-agenda-show-log-scoped)
  3941. ;;; Agenda Daily/Weekly
  3942. (defvar org-agenda-start-day nil ; dynamically scoped parameter
  3943. "Start day for the agenda view.
  3944. Custom commands can set this variable in the options section.
  3945. This is usually a string like \"2007-11-01\", \"+2d\" or any other
  3946. input allowed when reading a date through the Org calendar.
  3947. See the docstring of `org-read-date' for details.")
  3948. (defvar org-starting-day nil) ; local variable in the agenda buffer
  3949. (defvar org-arg-loc nil) ; local variable
  3950. ;;;###autoload
  3951. (defun org-agenda-list (&optional arg start-day span with-hour)
  3952. "Produce a daily/weekly view from all files in variable `org-agenda-files'.
  3953. The view will be for the current day or week, but from the overview buffer
  3954. you will be able to go to other days/weeks.
  3955. With a numeric prefix argument in an interactive call, the agenda will
  3956. span ARG days. Lisp programs should instead specify SPAN to change
  3957. the number of days. SPAN defaults to `org-agenda-span'.
  3958. START-DAY defaults to TODAY, or to the most recent match for the weekday
  3959. given in `org-agenda-start-on-weekday'.
  3960. When WITH-HOUR is non-nil, only include scheduled and deadline
  3961. items if they have an hour specification like [h]h:mm."
  3962. (interactive "P")
  3963. (when org-agenda-overriding-arguments
  3964. (setq arg (car org-agenda-overriding-arguments)
  3965. start-day (nth 1 org-agenda-overriding-arguments)
  3966. span (nth 2 org-agenda-overriding-arguments)))
  3967. (when (and (integerp arg) (> arg 0))
  3968. (setq span arg arg nil))
  3969. (when (numberp span)
  3970. (unless (< 0 span)
  3971. (user-error "Agenda creation impossible for this span(=%d days)" span)))
  3972. (catch 'exit
  3973. (setq org-agenda-buffer-name
  3974. (org-agenda--get-buffer-name
  3975. (and org-agenda-sticky
  3976. (cond ((and org-keys (stringp org-match))
  3977. (format "*Org Agenda(%s:%s)*" org-keys org-match))
  3978. (org-keys
  3979. (format "*Org Agenda(%s)*" org-keys))
  3980. (t "*Org Agenda(a)*")))))
  3981. (org-agenda-prepare "Day/Week")
  3982. (setq start-day (or start-day org-agenda-start-day))
  3983. (when (stringp start-day)
  3984. ;; Convert to an absolute day number
  3985. (setq start-day (time-to-days (org-read-date nil t start-day))))
  3986. (org-compile-prefix-format 'agenda)
  3987. (org-set-sorting-strategy 'agenda)
  3988. (let* ((span (org-agenda-ndays-to-span (or span org-agenda-span)))
  3989. (today (org-today))
  3990. (sd (or start-day today))
  3991. (ndays (org-agenda-span-to-ndays span sd))
  3992. (org-agenda-start-on-weekday
  3993. (and (or (eq ndays 7) (eq ndays 14))
  3994. org-agenda-start-on-weekday))
  3995. (thefiles (org-agenda-files nil 'ifmode))
  3996. (files thefiles)
  3997. (start (if (or (null org-agenda-start-on-weekday)
  3998. (< ndays 7))
  3999. sd
  4000. (let* ((nt (calendar-day-of-week
  4001. (calendar-gregorian-from-absolute sd)))
  4002. (n1 org-agenda-start-on-weekday)
  4003. (d (- nt n1)))
  4004. (- sd (+ (if (< d 0) 7 0) d)))))
  4005. (day-numbers (list start))
  4006. (day-cnt 0)
  4007. (inhibit-redisplay (not debug-on-error))
  4008. (org-agenda-show-log-scoped org-agenda-show-log)
  4009. s rtn rtnall file date d start-pos end-pos todayp ;; e
  4010. clocktable-start clocktable-end) ;; filter
  4011. (setq org-agenda-redo-command
  4012. (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span) with-hour))
  4013. (dotimes (_ (1- ndays))
  4014. (push (1+ (car day-numbers)) day-numbers))
  4015. (setq day-numbers (nreverse day-numbers))
  4016. (setq clocktable-start (car day-numbers)
  4017. clocktable-end (1+ (or (org-last day-numbers) 0)))
  4018. (setq-local org-starting-day (car day-numbers))
  4019. (setq-local org-arg-loc arg)
  4020. (setq-local org-agenda-current-span (org-agenda-ndays-to-span span))
  4021. (unless org-agenda-compact-blocks
  4022. (let* ((d1 (car day-numbers))
  4023. (d2 (org-last day-numbers))
  4024. (w1 (org-days-to-iso-week d1))
  4025. (w2 (org-days-to-iso-week d2)))
  4026. (setq s (point))
  4027. (org-agenda--insert-overriding-header
  4028. (concat (org-agenda-span-name span)
  4029. "-agenda"
  4030. (cond ((<= 350 (- d2 d1)) "")
  4031. ((= w1 w2) (format " (W%02d)" w1))
  4032. (t (format " (W%02d-W%02d)" w1 w2)))
  4033. ":\n")))
  4034. ;; Add properties if we actually inserted a header.
  4035. (when (> (point) s)
  4036. (add-text-properties s (1- (point))
  4037. (list 'face 'org-agenda-structure
  4038. 'org-date-line t))
  4039. (org-agenda-mark-header-line s)))
  4040. (while (setq d (pop day-numbers))
  4041. (setq date (calendar-gregorian-from-absolute d)
  4042. s (point))
  4043. (if (or (setq todayp (= d today))
  4044. (and (not start-pos) (= d sd)))
  4045. (setq start-pos (point))
  4046. (when (and start-pos (not end-pos))
  4047. (setq end-pos (point))))
  4048. (setq files thefiles
  4049. rtnall nil)
  4050. (while (setq file (pop files))
  4051. (catch 'nextfile
  4052. (org-check-agenda-file file)
  4053. (let ((org-agenda-entry-types org-agenda-entry-types))
  4054. ;; Starred types override non-starred equivalents
  4055. (when (member :deadline* org-agenda-entry-types)
  4056. (setq org-agenda-entry-types
  4057. (delq :deadline org-agenda-entry-types)))
  4058. (when (member :scheduled* org-agenda-entry-types)
  4059. (setq org-agenda-entry-types
  4060. (delq :scheduled org-agenda-entry-types)))
  4061. ;; Honor with-hour
  4062. (when with-hour
  4063. (when (member :deadline org-agenda-entry-types)
  4064. (setq org-agenda-entry-types
  4065. (delq :deadline org-agenda-entry-types))
  4066. (push :deadline* org-agenda-entry-types))
  4067. (when (member :scheduled org-agenda-entry-types)
  4068. (setq org-agenda-entry-types
  4069. (delq :scheduled org-agenda-entry-types))
  4070. (push :scheduled* org-agenda-entry-types)))
  4071. (unless org-agenda-include-deadlines
  4072. (setq org-agenda-entry-types
  4073. (delq :deadline* (delq :deadline org-agenda-entry-types))))
  4074. (cond
  4075. ((memq org-agenda-show-log-scoped '(only clockcheck))
  4076. (setq rtn (org-agenda-get-day-entries
  4077. file date :closed)))
  4078. (org-agenda-show-log-scoped
  4079. (setq rtn (apply #'org-agenda-get-day-entries
  4080. file date
  4081. (append '(:closed) org-agenda-entry-types))))
  4082. (t
  4083. (setq rtn (apply #'org-agenda-get-day-entries
  4084. file date
  4085. org-agenda-entry-types)))))
  4086. (setq rtnall (append rtnall rtn)))) ;; all entries
  4087. (when org-agenda-include-diary
  4088. (let ((org-agenda-search-headline-for-time t))
  4089. (require 'diary-lib)
  4090. (setq rtn (org-get-entries-from-diary date))
  4091. (setq rtnall (append rtnall rtn))))
  4092. (when (or rtnall org-agenda-show-all-dates)
  4093. (setq day-cnt (1+ day-cnt))
  4094. (insert
  4095. (if (stringp org-agenda-format-date)
  4096. (format-time-string org-agenda-format-date
  4097. (org-time-from-absolute date))
  4098. (funcall org-agenda-format-date date))
  4099. "\n")
  4100. (put-text-property s (1- (point)) 'face
  4101. (org-agenda-get-day-face date))
  4102. (put-text-property s (1- (point)) 'org-date-line t)
  4103. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  4104. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
  4105. (when todayp
  4106. (put-text-property s (1- (point)) 'org-today t))
  4107. (setq rtnall
  4108. (org-agenda-add-time-grid-maybe rtnall ndays todayp))
  4109. (when rtnall (insert ;; all entries
  4110. (org-agenda-finalize-entries rtnall 'agenda)
  4111. "\n"))
  4112. (put-text-property s (1- (point)) 'day d)
  4113. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)))
  4114. (when (and org-agenda-clockreport-mode clocktable-start)
  4115. (let ((org-agenda-files (org-agenda-files nil 'ifmode))
  4116. ;; the above line is to ensure the restricted range!
  4117. (p (copy-sequence org-agenda-clockreport-parameter-plist))
  4118. tbl)
  4119. (setq p (org-plist-delete p :block))
  4120. (setq p (plist-put p :tstart clocktable-start))
  4121. (setq p (plist-put p :tend clocktable-end))
  4122. (setq p (plist-put p :scope 'agenda))
  4123. (setq tbl (apply #'org-clock-get-clocktable p))
  4124. (when org-agenda-clock-report-header
  4125. (insert (propertize org-agenda-clock-report-header 'face 'org-agenda-structure))
  4126. (unless (string-suffix-p "\n" org-agenda-clock-report-header)
  4127. (insert "\n")))
  4128. (insert tbl)))
  4129. (goto-char (point-min))
  4130. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4131. (unless (or (not (get-buffer-window org-agenda-buffer-name))
  4132. (and (pos-visible-in-window-p (point-min))
  4133. (pos-visible-in-window-p (point-max))))
  4134. (goto-char (1- (point-max)))
  4135. (recenter -1)
  4136. (when (not (pos-visible-in-window-p (or start-pos 1)))
  4137. (goto-char (or start-pos 1))
  4138. (recenter 1)))
  4139. (goto-char (or start-pos 1))
  4140. (add-text-properties (point-min) (point-max)
  4141. `(org-agenda-type agenda
  4142. org-last-args (,arg ,start-day ,span)
  4143. org-redo-cmd ,org-agenda-redo-command
  4144. org-series-cmd ,org-cmd))
  4145. (when (eq org-agenda-show-log-scoped 'clockcheck)
  4146. (org-agenda-show-clocking-issues))
  4147. (org-agenda-finalize)
  4148. (setq buffer-read-only t)
  4149. (message ""))))
  4150. (defun org-agenda-ndays-to-span (n)
  4151. "Return a span symbol for a span of N days, or N if none matches."
  4152. (cond ((symbolp n) n)
  4153. ((= n 1) 'day)
  4154. ((= n 7) 'week)
  4155. ((= n 14) 'fortnight)
  4156. (t n)))
  4157. (defun org-agenda-span-to-ndays (span &optional start-day)
  4158. "Return ndays from SPAN, possibly starting at START-DAY.
  4159. START-DAY is an absolute time value."
  4160. (cond ((numberp span) span)
  4161. ((eq span 'day) 1)
  4162. ((eq span 'week) 7)
  4163. ((eq span 'fortnight) 14)
  4164. ((eq span 'month)
  4165. (let ((date (calendar-gregorian-from-absolute start-day)))
  4166. (calendar-last-day-of-month (car date) (cl-caddr date))))
  4167. ((eq span 'year)
  4168. (let ((date (calendar-gregorian-from-absolute start-day)))
  4169. (if (calendar-leap-year-p (cl-caddr date)) 366 365)))))
  4170. (defun org-agenda-span-name (span)
  4171. "Return a SPAN name."
  4172. (if (null span)
  4173. ""
  4174. (if (symbolp span)
  4175. (capitalize (symbol-name span))
  4176. (format "%d days" span))))
  4177. ;;; Agenda word search
  4178. (defvar org-agenda-search-history nil)
  4179. (defvar org-search-syntax-table nil
  4180. "Special syntax table for Org search.
  4181. In this table, we have single quotes not as word constituents, to
  4182. that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
  4183. (defvar org-mode-syntax-table) ; From org.el
  4184. (defun org-search-syntax-table ()
  4185. (unless org-search-syntax-table
  4186. (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
  4187. (modify-syntax-entry ?' "." org-search-syntax-table)
  4188. (modify-syntax-entry ?` "." org-search-syntax-table))
  4189. org-search-syntax-table)
  4190. (defvar org-agenda-last-search-view-search-was-boolean nil)
  4191. ;;;###autoload
  4192. (defun org-search-view (&optional todo-only string edit-at)
  4193. "Show all entries that contain a phrase or words or regular expressions.
  4194. With optional prefix argument TODO-ONLY, only consider entries that are
  4195. TODO entries. The argument STRING can be used to pass a default search
  4196. string into this function. If EDIT-AT is non-nil, it means that the
  4197. user should get a chance to edit this string, with cursor at position
  4198. EDIT-AT.
  4199. The search string can be viewed either as a phrase that should be found as
  4200. is, or it can be broken into a number of snippets, each of which must match
  4201. in a Boolean way to select an entry. The default depends on the variable
  4202. `org-agenda-search-view-always-boolean'.
  4203. Even if this is turned off (the default) you can always switch to
  4204. Boolean search dynamically by preceding the first word with \"+\" or \"-\".
  4205. The default is a direct search of the whole phrase, where each space in
  4206. the search string can expand to an arbitrary amount of whitespace,
  4207. including newlines.
  4208. If using a Boolean search, the search string is split on whitespace and
  4209. each snippet is searched separately, with logical AND to select an entry.
  4210. Words prefixed with a minus must *not* occur in the entry. Words without
  4211. a prefix or prefixed with a plus must occur in the entry. Matching is
  4212. case-insensitive. Words are enclosed by word delimiters (i.e. they must
  4213. match whole words, not parts of a word) if
  4214. `org-agenda-search-view-force-full-words' is set (default is nil).
  4215. Boolean search snippets enclosed by curly braces are interpreted as
  4216. regular expressions that must or (when preceded with \"-\") must not
  4217. match in the entry. Snippets enclosed into double quotes will be taken
  4218. as a whole, to include whitespace.
  4219. - If the search string starts with an asterisk, search only in headlines.
  4220. - If (possibly after the leading star) the search string starts with an
  4221. exclamation mark, this also means to look at TODO entries only, an effect
  4222. that can also be achieved with a prefix argument.
  4223. - If (possibly after star and exclamation mark) the search string starts
  4224. with a colon, this will mean that the (non-regexp) snippets of the
  4225. Boolean search must match as full words.
  4226. This command searches the agenda files, and in addition the files
  4227. listed in `org-agenda-text-search-extra-files' unless a restriction lock
  4228. is active."
  4229. (interactive "P")
  4230. (when org-agenda-overriding-arguments
  4231. (setq todo-only (car org-agenda-overriding-arguments)
  4232. string (nth 1 org-agenda-overriding-arguments)
  4233. edit-at (nth 2 org-agenda-overriding-arguments)))
  4234. (let* ((props (list 'face nil
  4235. 'done-face 'org-agenda-done
  4236. 'org-not-done-regexp org-not-done-regexp
  4237. 'org-todo-regexp org-todo-regexp
  4238. 'org-complex-heading-regexp org-complex-heading-regexp
  4239. 'mouse-face 'highlight
  4240. 'help-echo "mouse-2 or RET jump to location"))
  4241. (full-words org-agenda-search-view-force-full-words)
  4242. (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
  4243. regexp rtn rtnall files file pos inherited-tags
  4244. marker category level tags c neg re boolean
  4245. ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
  4246. (unless (and (not edit-at)
  4247. (stringp string)
  4248. (string-match "\\S-" string))
  4249. (setq string (read-string
  4250. (if org-agenda-search-view-always-boolean
  4251. "[+-]Word/{Regexp} ...: "
  4252. "Phrase or [+-]Word/{Regexp} ...: ")
  4253. (cond
  4254. ((integerp edit-at) (cons string edit-at))
  4255. (edit-at string))
  4256. 'org-agenda-search-history)))
  4257. (catch 'exit
  4258. (setq org-agenda-buffer-name
  4259. (org-agenda--get-buffer-name
  4260. (and org-agenda-sticky
  4261. (if (stringp string)
  4262. (format "*Org Agenda(%s:%s)*"
  4263. (or org-keys (or (and todo-only "S") "s"))
  4264. string)
  4265. (format "*Org Agenda(%s)*"
  4266. (or (and todo-only "S") "s"))))))
  4267. (org-agenda-prepare "SEARCH")
  4268. (org-compile-prefix-format 'search)
  4269. (org-set-sorting-strategy 'search)
  4270. (setq org-agenda-redo-command
  4271. (list 'org-search-view (if todo-only t nil)
  4272. (list 'if 'current-prefix-arg nil string)))
  4273. (setq org-agenda-query-string string)
  4274. (if (equal (string-to-char string) ?*)
  4275. (setq hdl-only t
  4276. words (substring string 1))
  4277. (setq words string))
  4278. (when (equal (string-to-char words) ?!)
  4279. (setq todo-only t
  4280. words (substring words 1)))
  4281. (when (equal (string-to-char words) ?:)
  4282. (setq full-words t
  4283. words (substring words 1)))
  4284. (when (or org-agenda-search-view-always-boolean
  4285. (member (string-to-char words) '(?- ?+ ?\{)))
  4286. (setq boolean t))
  4287. (setq words (split-string words))
  4288. (let (www w)
  4289. (while (setq w (pop words))
  4290. (while (and (string-match "\\\\\\'" w) words)
  4291. (setq w (concat (substring w 0 -1) " " (pop words))))
  4292. (push w www))
  4293. (setq words (nreverse www) www nil)
  4294. (while (setq w (pop words))
  4295. (when (and (string-match "\\`[-+]?{" w)
  4296. (not (string-match "}\\'" w)))
  4297. (while (and words (not (string-match "}\\'" (car words))))
  4298. (setq w (concat w " " (pop words))))
  4299. (setq w (concat w " " (pop words))))
  4300. (push w www))
  4301. (setq words (nreverse www)))
  4302. (setq org-agenda-last-search-view-search-was-boolean boolean)
  4303. (when boolean
  4304. (let (wds w)
  4305. (while (setq w (pop words))
  4306. (when (or (equal (substring w 0 1) "\"")
  4307. (and (> (length w) 1)
  4308. (member (substring w 0 1) '("+" "-"))
  4309. (equal (substring w 1 2) "\"")))
  4310. (while (and words (not (equal (substring w -1) "\"")))
  4311. (setq w (concat w " " (pop words)))))
  4312. (and (string-match "\\`\\([-+]?\\)\"" w)
  4313. (setq w (replace-match "\\1" nil nil w)))
  4314. (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
  4315. (push w wds))
  4316. (setq words (nreverse wds))))
  4317. (if boolean
  4318. (mapc (lambda (w)
  4319. (setq c (string-to-char w))
  4320. (if (equal c ?-)
  4321. (setq neg t w (substring w 1))
  4322. (if (equal c ?+)
  4323. (setq neg nil w (substring w 1))
  4324. (setq neg nil)))
  4325. (if (string-match "\\`{.*}\\'" w)
  4326. (setq re (substring w 1 -1))
  4327. (if full-words
  4328. (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
  4329. (setq re (regexp-quote (downcase w)))))
  4330. (if neg (push re regexps-) (push re regexps+)))
  4331. words)
  4332. (push (mapconcat #'regexp-quote words "\\s-+")
  4333. regexps+))
  4334. (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
  4335. (if (not regexps+)
  4336. (setq regexp org-outline-regexp-bol)
  4337. (setq regexp (pop regexps+))
  4338. (when hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
  4339. regexp))))
  4340. (setq files (org-agenda-files nil 'ifmode))
  4341. ;; Add `org-agenda-text-search-extra-files' unless there is some
  4342. ;; restriction.
  4343. (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
  4344. (pop org-agenda-text-search-extra-files)
  4345. (unless (get 'org-agenda-files 'org-restrict)
  4346. (setq files (org-add-archive-files files))))
  4347. ;; Uniquify files. However, let `org-check-agenda-file' handle
  4348. ;; non-existent ones.
  4349. (setq files (cl-remove-duplicates
  4350. (append files org-agenda-text-search-extra-files)
  4351. :test (lambda (a b)
  4352. (and (file-exists-p a)
  4353. (file-exists-p b)
  4354. (file-equal-p a b))))
  4355. rtnall nil)
  4356. (while (setq file (pop files))
  4357. (setq ee nil)
  4358. (catch 'nextfile
  4359. (org-check-agenda-file file)
  4360. (setq buffer (if (file-exists-p file)
  4361. (org-get-agenda-file-buffer file)
  4362. (error "No such file %s" file)))
  4363. (unless buffer
  4364. ;; If file does not exist, make sure an error message is sent
  4365. (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
  4366. file))))
  4367. (with-current-buffer buffer
  4368. (with-syntax-table (org-search-syntax-table)
  4369. (unless (derived-mode-p 'org-mode)
  4370. (error "Agenda file %s is not in Org mode" file))
  4371. (let ((case-fold-search t))
  4372. (save-excursion
  4373. (save-restriction
  4374. (if (eq buffer org-agenda-restrict)
  4375. (narrow-to-region org-agenda-restrict-begin
  4376. org-agenda-restrict-end)
  4377. (widen))
  4378. (goto-char (point-min))
  4379. (unless (or (org-at-heading-p)
  4380. (outline-next-heading))
  4381. (throw 'nextfile t))
  4382. (goto-char (max (point-min) (1- (point))))
  4383. (while (re-search-forward regexp nil t)
  4384. (org-back-to-heading t)
  4385. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4386. (> (org-reduced-level (org-outline-level))
  4387. org-agenda-search-view-max-outline-level)
  4388. (forward-line -1)
  4389. (org-back-to-heading t)))
  4390. (skip-chars-forward "* ")
  4391. (setq beg (line-beginning-position)
  4392. beg1 (point)
  4393. end (progn
  4394. (outline-next-heading)
  4395. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4396. (> (org-reduced-level (org-outline-level))
  4397. org-agenda-search-view-max-outline-level)
  4398. (forward-line 1)
  4399. (outline-next-heading)))
  4400. (point)))
  4401. (catch :skip
  4402. (goto-char beg)
  4403. (org-agenda-skip)
  4404. (setq str (buffer-substring-no-properties
  4405. (line-beginning-position)
  4406. (if hdl-only (line-end-position) end)))
  4407. (mapc (lambda (wr) (when (string-match wr str)
  4408. (goto-char (1- end))
  4409. (throw :skip t)))
  4410. regexps-)
  4411. (mapc (lambda (wr) (unless (string-match wr str)
  4412. (goto-char (1- end))
  4413. (throw :skip t)))
  4414. (if todo-only
  4415. (cons (concat "^\\*+[ \t]+"
  4416. org-not-done-regexp)
  4417. regexps+)
  4418. regexps+))
  4419. (goto-char beg)
  4420. (setq marker (org-agenda-new-marker (point))
  4421. category (org-get-category)
  4422. level (make-string (org-reduced-level (org-outline-level)) ? )
  4423. inherited-tags
  4424. (or (eq org-agenda-show-inherited-tags 'always)
  4425. (and (listp org-agenda-show-inherited-tags)
  4426. (memq 'todo org-agenda-show-inherited-tags))
  4427. (and (eq org-agenda-show-inherited-tags t)
  4428. (or (eq org-agenda-use-tag-inheritance t)
  4429. (memq 'todo org-agenda-use-tag-inheritance))))
  4430. tags (org-get-tags nil (not inherited-tags))
  4431. txt (org-agenda-format-item
  4432. ""
  4433. (buffer-substring-no-properties
  4434. beg1 (line-end-position))
  4435. level category tags t))
  4436. (org-add-props txt props
  4437. 'org-marker marker 'org-hd-marker marker
  4438. 'org-todo-regexp org-todo-regexp
  4439. 'level level
  4440. 'org-complex-heading-regexp org-complex-heading-regexp
  4441. 'priority 1000
  4442. 'type "search")
  4443. (push txt ee)
  4444. (goto-char (1- end))))))))))
  4445. (setq rtn (nreverse ee))
  4446. (setq rtnall (append rtnall rtn)))
  4447. (org-agenda--insert-overriding-header
  4448. (with-temp-buffer
  4449. (insert "Search words: ")
  4450. (add-text-properties (point-min) (1- (point))
  4451. (list 'face 'org-agenda-structure))
  4452. (setq pos (point))
  4453. (insert string "\n")
  4454. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure-filter))
  4455. (setq pos (point))
  4456. (unless org-agenda-multi
  4457. (insert (substitute-command-keys "\\<org-agenda-mode-map>\
  4458. Press `\\[org-agenda-manipulate-query-add]', \
  4459. `\\[org-agenda-manipulate-query-subtract]' to add/sub word, \
  4460. `\\[org-agenda-manipulate-query-add-re]', \
  4461. `\\[org-agenda-manipulate-query-subtract-re]' to add/sub regexp, \
  4462. `\\[universal-argument] \\[org-agenda-redo]' for a fresh search\n"))
  4463. (add-text-properties pos (1- (point))
  4464. (list 'face 'org-agenda-structure-secondary)))
  4465. (buffer-string)))
  4466. (org-agenda-mark-header-line (point-min))
  4467. (when rtnall
  4468. (insert (org-agenda-finalize-entries rtnall 'search) "\n"))
  4469. (goto-char (point-min))
  4470. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4471. (add-text-properties (point-min) (point-max)
  4472. `(org-agenda-type search
  4473. org-last-args (,todo-only ,string ,edit-at)
  4474. org-redo-cmd ,org-agenda-redo-command
  4475. org-series-cmd ,org-cmd))
  4476. (org-agenda-finalize)
  4477. (setq buffer-read-only t))))
  4478. ;;; Agenda TODO list
  4479. (defun org-agenda-propertize-selected-todo-keywords (keywords)
  4480. "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
  4481. (concat
  4482. (if (or (equal keywords "ALL") (not keywords))
  4483. (propertize "ALL" 'face 'org-agenda-structure-filter)
  4484. (mapconcat
  4485. (lambda (kw)
  4486. (propertize kw 'face (list (org-get-todo-face kw) 'org-agenda-structure)))
  4487. (org-split-string keywords "|")
  4488. "|"))
  4489. "\n"))
  4490. (defvar org-select-this-todo-keyword nil)
  4491. (defvar org-last-arg nil)
  4492. (defvar crm-separator)
  4493. ;;;###autoload
  4494. (defun org-todo-list (&optional arg)
  4495. "Show all (not done) TODO entries from all agenda files in a single list.
  4496. The prefix arg can be used to select a specific TODO keyword and limit
  4497. the list to these. When using `\\[universal-argument]', you will be prompted
  4498. for a keyword. A numeric prefix directly selects the Nth keyword in
  4499. `org-todo-keywords-1'."
  4500. (interactive "P")
  4501. (when org-agenda-overriding-arguments
  4502. (setq arg org-agenda-overriding-arguments))
  4503. (when (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
  4504. (let* ((today (org-today))
  4505. (date (calendar-gregorian-from-absolute today))
  4506. (completion-ignore-case t)
  4507. kwds org-select-this-todo-keyword rtn rtnall files file pos)
  4508. (catch 'exit
  4509. (setq org-agenda-buffer-name
  4510. (org-agenda--get-buffer-name
  4511. (and org-agenda-sticky
  4512. (if (stringp org-select-this-todo-keyword)
  4513. (format "*Org Agenda(%s:%s)*" (or org-keys "t")
  4514. org-select-this-todo-keyword)
  4515. (format "*Org Agenda(%s)*" (or org-keys "t"))))))
  4516. (org-agenda-prepare "TODO")
  4517. (setq kwds org-todo-keywords-for-agenda
  4518. org-select-this-todo-keyword (if (stringp arg) arg
  4519. (and (integerp arg)
  4520. (> arg 0)
  4521. (nth (1- arg) kwds))))
  4522. (when (equal arg '(4))
  4523. (setq org-select-this-todo-keyword
  4524. (mapconcat #'identity
  4525. (let ((crm-separator "|"))
  4526. (completing-read-multiple
  4527. "Keyword (or KWD1|KWD2|...): "
  4528. (mapcar #'list kwds) nil nil))
  4529. "|")))
  4530. (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
  4531. (org-compile-prefix-format 'todo)
  4532. (org-set-sorting-strategy 'todo)
  4533. (setq org-agenda-redo-command
  4534. `(org-todo-list (or (and (numberp current-prefix-arg)
  4535. current-prefix-arg)
  4536. ,org-select-this-todo-keyword
  4537. current-prefix-arg ,arg)))
  4538. (setq files (org-agenda-files nil 'ifmode)
  4539. rtnall nil)
  4540. (while (setq file (pop files))
  4541. (catch 'nextfile
  4542. (org-check-agenda-file file)
  4543. (setq rtn (org-agenda-get-day-entries file date :todo))
  4544. (setq rtnall (append rtnall rtn))))
  4545. (org-agenda--insert-overriding-header
  4546. (with-temp-buffer
  4547. (insert "Global list of TODO items of type: ")
  4548. (add-text-properties (point-min) (1- (point))
  4549. (list 'face 'org-agenda-structure
  4550. 'short-heading
  4551. (concat "ToDo: "
  4552. (or org-select-this-todo-keyword "ALL"))))
  4553. (org-agenda-mark-header-line (point-min))
  4554. (insert (org-agenda-propertize-selected-todo-keywords
  4555. org-select-this-todo-keyword))
  4556. (setq pos (point))
  4557. (unless org-agenda-multi
  4558. (insert (substitute-command-keys "Press \
  4559. \\<org-agenda-mode-map>`N \\[org-agenda-redo]' (e.g. `0 \\[org-agenda-redo]') \
  4560. to search again: (0)[ALL]"))
  4561. (let ((n 0))
  4562. (dolist (k kwds)
  4563. (let ((s (format "(%d)%s" (cl-incf n) k)))
  4564. (when (> (+ (current-column) (string-width s) 1) (window-max-chars-per-line))
  4565. (insert "\n "))
  4566. (insert " " s))))
  4567. (insert "\n"))
  4568. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure-secondary))
  4569. (buffer-string)))
  4570. (org-agenda-mark-header-line (point-min))
  4571. (when rtnall
  4572. (insert (org-agenda-finalize-entries rtnall 'todo) "\n"))
  4573. (goto-char (point-min))
  4574. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4575. (add-text-properties (point-min) (point-max)
  4576. `(org-agenda-type todo
  4577. org-last-args ,arg
  4578. org-redo-cmd ,org-agenda-redo-command
  4579. org-series-cmd ,org-cmd))
  4580. (org-agenda-finalize)
  4581. (setq buffer-read-only t))))
  4582. ;;; Agenda tags match
  4583. ;;;###autoload
  4584. (defun org-tags-view (&optional todo-only match)
  4585. "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
  4586. The prefix arg TODO-ONLY limits the search to TODO entries."
  4587. (interactive "P")
  4588. (when org-agenda-overriding-arguments
  4589. (setq todo-only (car org-agenda-overriding-arguments)
  4590. match (nth 1 org-agenda-overriding-arguments)))
  4591. (let* ((org-tags-match-list-sublevels
  4592. org-tags-match-list-sublevels)
  4593. (completion-ignore-case t)
  4594. (org--matcher-tags-todo-only todo-only)
  4595. rtn rtnall files file pos matcher
  4596. buffer)
  4597. (when (and (stringp match) (not (string-match "\\S-" match)))
  4598. (setq match nil))
  4599. (catch 'exit
  4600. (setq org-agenda-buffer-name
  4601. (org-agenda--get-buffer-name
  4602. (and org-agenda-sticky
  4603. (if (stringp match)
  4604. (format "*Org Agenda(%s:%s)*"
  4605. (or org-keys (or (and todo-only "M") "m"))
  4606. match)
  4607. (format "*Org Agenda(%s)*"
  4608. (or (and todo-only "M") "m"))))))
  4609. (setq matcher (org-make-tags-matcher match))
  4610. ;; Prepare agendas (and `org-tag-alist-for-agenda') before
  4611. ;; expanding tags within `org-make-tags-matcher'
  4612. (org-agenda-prepare (concat "TAGS " match))
  4613. (setq match (car matcher)
  4614. matcher (cdr matcher))
  4615. (org-compile-prefix-format 'tags)
  4616. (org-set-sorting-strategy 'tags)
  4617. (setq org-agenda-query-string match)
  4618. (setq org-agenda-redo-command
  4619. (list 'org-tags-view
  4620. `(quote ,org--matcher-tags-todo-only)
  4621. `(if current-prefix-arg nil ,org-agenda-query-string)))
  4622. (setq files (org-agenda-files nil 'ifmode)
  4623. rtnall nil)
  4624. (while (setq file (pop files))
  4625. (catch 'nextfile
  4626. (org-check-agenda-file file)
  4627. (setq buffer (if (file-exists-p file)
  4628. (org-get-agenda-file-buffer file)
  4629. (error "No such file %s" file)))
  4630. (if (not buffer)
  4631. ;; If file does not exist, error message to agenda
  4632. (setq rtn (list
  4633. (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4634. rtnall (append rtnall rtn))
  4635. (with-current-buffer buffer
  4636. (unless (derived-mode-p 'org-mode)
  4637. (error "Agenda file %s is not in Org mode" file))
  4638. (save-excursion
  4639. (save-restriction
  4640. (if (eq buffer org-agenda-restrict)
  4641. (narrow-to-region org-agenda-restrict-begin
  4642. org-agenda-restrict-end)
  4643. (widen))
  4644. (setq rtn (org-scan-tags 'agenda
  4645. matcher
  4646. org--matcher-tags-todo-only))
  4647. (setq rtnall (append rtnall rtn))))))))
  4648. (org-agenda--insert-overriding-header
  4649. (with-temp-buffer
  4650. (insert "Headlines with TAGS match: ")
  4651. (add-text-properties (point-min) (1- (point))
  4652. (list 'face 'org-agenda-structure
  4653. 'short-heading
  4654. (concat "Match: " match)))
  4655. (setq pos (point))
  4656. (insert match "\n")
  4657. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure-filter))
  4658. (setq pos (point))
  4659. (unless org-agenda-multi
  4660. (insert (substitute-command-keys
  4661. "Press \
  4662. \\<org-agenda-mode-map>`\\[universal-argument] \\[org-agenda-redo]' \
  4663. to search again\n")))
  4664. (add-text-properties pos (1- (point))
  4665. (list 'face 'org-agenda-structure-secondary))
  4666. (buffer-string)))
  4667. (org-agenda-mark-header-line (point-min))
  4668. (when rtnall
  4669. (insert (org-agenda-finalize-entries rtnall 'tags) "\n"))
  4670. (goto-char (point-min))
  4671. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4672. (add-text-properties
  4673. (point-min) (point-max)
  4674. `(org-agenda-type tags
  4675. org-last-args (,org--matcher-tags-todo-only ,match)
  4676. org-redo-cmd ,org-agenda-redo-command
  4677. org-series-cmd ,org-cmd))
  4678. (org-agenda-finalize)
  4679. (setq buffer-read-only t))))
  4680. ;;; Agenda Finding stuck projects
  4681. (defvar org-agenda-skip-regexp nil
  4682. "Regular expression used in skipping subtrees for the agenda.
  4683. This is basically a temporary global variable that can be set and then
  4684. used by user-defined selections using `org-agenda-skip-function'.")
  4685. (defvar org-agenda-overriding-header nil
  4686. "When set during agenda, todo and tags searches it replaces the header.
  4687. If an empty string, no header will be inserted. If any other
  4688. string, it will be inserted as a header. If a function, insert
  4689. the string returned by the function as a header. If nil, a
  4690. header will be generated automatically according to the command.
  4691. This variable should not be set directly, but custom commands can
  4692. bind it in the options section.")
  4693. (defun org-agenda-skip-entry-if (&rest conditions)
  4694. "Skip entry if any of CONDITIONS is true.
  4695. See `org-agenda-skip-if' for details."
  4696. (org-agenda-skip-if nil conditions))
  4697. (defun org-agenda-skip-subtree-if (&rest conditions)
  4698. "Skip subtree if any of CONDITIONS is true.
  4699. See `org-agenda-skip-if' for details."
  4700. (org-agenda-skip-if t conditions))
  4701. (defun org-agenda-skip-if (subtree conditions)
  4702. "Check current entity for CONDITIONS.
  4703. If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
  4704. the entry (i.e. the text before the next heading) is checked.
  4705. CONDITIONS is a list of symbols, boolean OR is used to combine the results
  4706. from different tests. Valid conditions are:
  4707. scheduled Check if there is a scheduled cookie
  4708. notscheduled Check if there is no scheduled cookie
  4709. deadline Check if there is a deadline
  4710. notdeadline Check if there is no deadline
  4711. timestamp Check if there is a timestamp (also deadline or scheduled)
  4712. nottimestamp Check if there is no timestamp (also deadline or scheduled)
  4713. regexp Check if regexp matches
  4714. notregexp Check if regexp does not match.
  4715. todo Check if TODO keyword matches
  4716. nottodo Check if TODO keyword does not match
  4717. The regexp is taken from the conditions list, it must come right after
  4718. the `regexp' or `notregexp' element.
  4719. `todo' and `nottodo' accept as an argument a list of todo
  4720. keywords, which may include \"*\" to match any todo keyword.
  4721. (org-agenda-skip-entry-if \\='todo \\='(\"TODO\" \"WAITING\"))
  4722. would skip all entries with \"TODO\" or \"WAITING\" keywords.
  4723. Instead of a list, a keyword class may be given. For example:
  4724. (org-agenda-skip-entry-if \\='nottodo \\='done)
  4725. would skip entries that haven't been marked with any of \"DONE\"
  4726. keywords. Possible classes are: `todo', `done', `any'.
  4727. If any of these conditions is met, this function returns the end point of
  4728. the entity, causing the search to continue from there. This is a function
  4729. that can be put into `org-agenda-skip-function' for the duration of a command."
  4730. (org-back-to-heading t)
  4731. (let* (;; (beg (point))
  4732. (end (if subtree (save-excursion (org-end-of-subtree t) (point))
  4733. (org-entry-end-position)))
  4734. (planning-end (if subtree end (line-end-position 2)))
  4735. m)
  4736. (and
  4737. (or (and (memq 'scheduled conditions)
  4738. (re-search-forward org-scheduled-time-regexp planning-end t))
  4739. (and (memq 'notscheduled conditions)
  4740. (not
  4741. (save-excursion
  4742. (re-search-forward org-scheduled-time-regexp planning-end t))))
  4743. (and (memq 'deadline conditions)
  4744. (re-search-forward org-deadline-time-regexp planning-end t))
  4745. (and (memq 'notdeadline conditions)
  4746. (not
  4747. (save-excursion
  4748. (re-search-forward org-deadline-time-regexp planning-end t))))
  4749. (and (memq 'timestamp conditions)
  4750. (re-search-forward org-ts-regexp end t))
  4751. (and (memq 'nottimestamp conditions)
  4752. (not (save-excursion (re-search-forward org-ts-regexp end t))))
  4753. (and (setq m (memq 'regexp conditions))
  4754. (stringp (nth 1 m))
  4755. (re-search-forward (nth 1 m) end t))
  4756. (and (setq m (memq 'notregexp conditions))
  4757. (stringp (nth 1 m))
  4758. (not (save-excursion (re-search-forward (nth 1 m) end t))))
  4759. (and (or
  4760. (setq m (memq 'nottodo conditions))
  4761. (setq m (memq 'todo-unblocked conditions))
  4762. (setq m (memq 'nottodo-unblocked conditions))
  4763. (setq m (memq 'todo conditions)))
  4764. (org-agenda-skip-if-todo m end)))
  4765. end)))
  4766. (defun org-agenda-skip-if-todo (args end)
  4767. "Helper function for `org-agenda-skip-if', do not use it directly.
  4768. ARGS is a list with first element either `todo', `nottodo',
  4769. `todo-unblocked' or `nottodo-unblocked'. The remainder is either
  4770. a list of TODO keywords, or a state symbol `todo' or `done' or
  4771. `any'."
  4772. (let ((todo-re
  4773. (concat "^\\*+[ \t]+"
  4774. (regexp-opt
  4775. (pcase args
  4776. (`(,_ todo)
  4777. (org-delete-all org-done-keywords
  4778. (copy-sequence org-todo-keywords-1)))
  4779. (`(,_ done) org-done-keywords)
  4780. (`(,_ any) org-todo-keywords-1)
  4781. (`(,_ ,(pred atom))
  4782. (error "Invalid TODO class or type: %S" args))
  4783. (`(,_ ,(pred (member "*"))) org-todo-keywords-1)
  4784. (`(,_ ,todo-list) todo-list))
  4785. 'words))))
  4786. (pcase args
  4787. (`(todo . ,_)
  4788. (let (case-fold-search) (re-search-forward todo-re end t)))
  4789. (`(nottodo . ,_)
  4790. (not (let (case-fold-search) (re-search-forward todo-re end t))))
  4791. (`(todo-unblocked . ,_)
  4792. (catch :unblocked
  4793. (while (let (case-fold-search) (re-search-forward todo-re end t))
  4794. (when (org-entry-blocked-p) (throw :unblocked t)))
  4795. nil))
  4796. (`(nottodo-unblocked . ,_)
  4797. (catch :unblocked
  4798. (while (let (case-fold-search) (re-search-forward todo-re end t))
  4799. (when (org-entry-blocked-p) (throw :unblocked nil)))
  4800. t))
  4801. (`(,type . ,_) (error "Unknown TODO skip type: %S" type)))))
  4802. ;;;###autoload
  4803. (defun org-agenda-list-stuck-projects (&rest _ignore)
  4804. "Create agenda view for projects that are stuck.
  4805. Stuck projects are project that have no next actions. For the definitions
  4806. of what a project is and how to check if it stuck, customize the variable
  4807. `org-stuck-projects'."
  4808. (interactive)
  4809. (let* ((org-agenda-overriding-header
  4810. (or org-agenda-overriding-header "List of stuck projects: "))
  4811. (matcher (nth 0 org-stuck-projects))
  4812. (todo (nth 1 org-stuck-projects))
  4813. (tags (nth 2 org-stuck-projects))
  4814. (gen-re (org-string-nw-p (nth 3 org-stuck-projects)))
  4815. (todo-wds
  4816. (if (not (member "*" todo)) todo
  4817. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  4818. (org-delete-all org-done-keywords-for-agenda
  4819. (copy-sequence org-todo-keywords-for-agenda))))
  4820. (todo-re (and todo
  4821. (format "^\\*+[ \t]+\\(%s\\)\\>"
  4822. (mapconcat #'identity todo-wds "\\|"))))
  4823. (tags-re (cond ((null tags) nil)
  4824. ((member "*" tags) org-tag-line-re)
  4825. (tags
  4826. (let ((other-tags (format "\\(?:%s:\\)*" org-tag-re)))
  4827. (concat org-outline-regexp-bol
  4828. ".*?[ \t]:"
  4829. other-tags
  4830. (regexp-opt tags t)
  4831. ":" other-tags "[ \t]*$")))
  4832. (t nil)))
  4833. (re-list (delq nil (list todo-re tags-re gen-re)))
  4834. (skip-re
  4835. (if (null re-list)
  4836. (error "Missing information to identify unstuck projects")
  4837. (mapconcat #'identity re-list "\\|")))
  4838. (org-agenda-skip-function
  4839. ;; Skip entry if `org-agenda-skip-regexp' matches anywhere
  4840. ;; in the subtree.
  4841. (lambda ()
  4842. (and (save-excursion
  4843. (let ((case-fold-search nil))
  4844. (re-search-forward
  4845. skip-re (save-excursion (org-end-of-subtree t)) t)))
  4846. (progn (outline-next-heading) (point))))))
  4847. (org-tags-view nil matcher)
  4848. (setq org-agenda-buffer-name (buffer-name))
  4849. (with-current-buffer org-agenda-buffer-name
  4850. (setq org-agenda-redo-command
  4851. `(org-agenda-list-stuck-projects ,current-prefix-arg))
  4852. (let ((inhibit-read-only t))
  4853. (add-text-properties
  4854. (point-min) (point-max)
  4855. `(org-redo-cmd ,org-agenda-redo-command))))))
  4856. ;;; Diary integration
  4857. (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
  4858. (defvar diary-list-entries-hook)
  4859. (defvar diary-time-regexp)
  4860. (defvar diary-modify-entry-list-string-function)
  4861. (defvar diary-file-name-prefix)
  4862. (defvar diary-display-function)
  4863. (defun org-get-entries-from-diary (date)
  4864. "Get the (Emacs Calendar) diary entries for DATE."
  4865. (require 'diary-lib)
  4866. (declare-function diary-fancy-display "diary-lib" ())
  4867. (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
  4868. (diary-display-function #'diary-fancy-display)
  4869. (pop-up-frames nil)
  4870. (diary-list-entries-hook
  4871. (cons 'org-diary-default-entry diary-list-entries-hook))
  4872. (diary-file-name-prefix nil) ; turn this feature off
  4873. (diary-modify-entry-list-string-function
  4874. #'org-modify-diary-entry-string)
  4875. (diary-time-regexp (concat "^" diary-time-regexp))
  4876. entries
  4877. (org-disable-agenda-to-diary t))
  4878. (save-excursion
  4879. (save-window-excursion
  4880. (diary-list-entries date 1)))
  4881. (if (not (get-buffer diary-fancy-buffer))
  4882. (setq entries nil)
  4883. (with-current-buffer diary-fancy-buffer
  4884. (setq buffer-read-only nil)
  4885. (if (zerop (buffer-size))
  4886. ;; No entries
  4887. (setq entries nil)
  4888. ;; Omit the date and other unnecessary stuff
  4889. (org-agenda-cleanup-fancy-diary)
  4890. ;; Add prefix to each line and extend the text properties
  4891. (if (zerop (buffer-size))
  4892. (setq entries nil)
  4893. (setq entries (buffer-substring (point-min) (- (point-max) 1)))
  4894. (setq entries
  4895. (with-temp-buffer
  4896. (insert entries) (goto-char (point-min))
  4897. (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
  4898. (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
  4899. (replace-match (concat "; " (match-string 1)))))
  4900. (buffer-string)))))
  4901. (set-buffer-modified-p nil)
  4902. (kill-buffer diary-fancy-buffer)))
  4903. (when entries
  4904. (setq entries (org-split-string entries "\n"))
  4905. (setq entries
  4906. (mapcar
  4907. (lambda (x)
  4908. (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
  4909. ;; Extend the text properties to the beginning of the line
  4910. (org-add-props x (text-properties-at (1- (length x)) x)
  4911. 'type "diary" 'date date 'face 'org-agenda-diary))
  4912. entries)))))
  4913. (defvar org-agenda-cleanup-fancy-diary-hook nil
  4914. "Hook run when the fancy diary buffer is cleaned up.")
  4915. (defun org-agenda-cleanup-fancy-diary ()
  4916. "Remove unwanted stuff in buffer created by `fancy-diary-display'.
  4917. This gets rid of the date, the underline under the date, and the
  4918. dummy entry installed by Org mode to ensure non-empty diary for
  4919. each date. It also removes lines that contain only whitespace."
  4920. (goto-char (point-min))
  4921. (if (looking-at ".*?:[ \t]*")
  4922. (progn
  4923. (replace-match "")
  4924. (re-search-forward "\n=+$" nil t)
  4925. (replace-match "")
  4926. (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
  4927. (re-search-forward "\n=+$" nil t)
  4928. (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
  4929. (goto-char (point-min))
  4930. (while (re-search-forward "^ +\n" nil t)
  4931. (replace-match ""))
  4932. (goto-char (point-min))
  4933. (when (re-search-forward "^Org mode dummy\n?" nil t)
  4934. (replace-match ""))
  4935. (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
  4936. (defun org-modify-diary-entry-string (string)
  4937. "Add text properties to string, allowing Org to act on it."
  4938. (org-add-props string nil
  4939. 'mouse-face 'highlight
  4940. 'help-echo (if buffer-file-name
  4941. (format "mouse-2 or RET jump to diary file %s"
  4942. (abbreviate-file-name buffer-file-name))
  4943. "")
  4944. 'org-agenda-diary-link t
  4945. 'org-marker (org-agenda-new-marker (line-beginning-position))))
  4946. (defun org-diary-default-entry ()
  4947. "Add a dummy entry to the diary.
  4948. Needed to avoid empty dates which mess up holiday display."
  4949. ;; Catch the error if dealing with the new add-to-diary-alist
  4950. (when org-disable-agenda-to-diary
  4951. (diary-add-to-list original-date "Org mode dummy" "")))
  4952. (defvar org-diary-last-run-time nil)
  4953. ;;;###autoload
  4954. (defun org-diary (&rest args)
  4955. "Return diary information from org files.
  4956. This function can be used in a \"sexp\" diary entry in the Emacs calendar.
  4957. It accesses org files and extracts information from those files to be
  4958. listed in the diary. The function accepts arguments specifying what
  4959. items should be listed. For a list of arguments allowed here, see the
  4960. variable `org-agenda-entry-types'.
  4961. The call in the diary file should look like this:
  4962. &%%(org-diary) ~/path/to/some/orgfile.org
  4963. Use a separate line for each org file to check. Or, if you omit the file name,
  4964. all files listed in `org-agenda-files' will be checked automatically:
  4965. &%%(org-diary)
  4966. If you don't give any arguments (as in the example above), the default value
  4967. of `org-agenda-entry-types' is used: (:deadline :scheduled :timestamp :sexp).
  4968. So the example above may also be written as
  4969. &%%(org-diary :deadline :timestamp :sexp :scheduled)
  4970. The function expects the lisp variables `entry' and `date' to be provided
  4971. by the caller, because this is how the calendar works. Don't use this
  4972. function from a program - use `org-agenda-get-day-entries' instead."
  4973. (with-no-warnings (defvar date) (defvar entry))
  4974. (when (> (- (float-time)
  4975. org-agenda-last-marker-time)
  4976. 5)
  4977. ;; I am not sure if this works with sticky agendas, because the marker
  4978. ;; list is then no longer a global variable.
  4979. (org-agenda-reset-markers))
  4980. (org-compile-prefix-format 'agenda)
  4981. (org-set-sorting-strategy 'agenda)
  4982. (setq args (or args org-agenda-entry-types))
  4983. (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
  4984. (list entry)
  4985. (org-agenda-files t)))
  4986. (time (float-time))
  4987. file rtn results)
  4988. (when (or (not org-diary-last-run-time)
  4989. (> (- time
  4990. org-diary-last-run-time)
  4991. 3))
  4992. (org-agenda-prepare-buffers files))
  4993. (setq org-diary-last-run-time time)
  4994. ;; If this is called during org-agenda, don't return any entries to
  4995. ;; the calendar. Org Agenda will list these entries itself.
  4996. (when org-disable-agenda-to-diary (setq files nil))
  4997. (while (setq file (pop files))
  4998. (setq rtn (apply #'org-agenda-get-day-entries file date args))
  4999. (setq results (append results rtn)))
  5000. (when results
  5001. (setq results
  5002. (mapcar (lambda (i) (replace-regexp-in-string
  5003. org-link-bracket-re "\\2" i))
  5004. results))
  5005. (concat (org-agenda-finalize-entries results) "\n"))))
  5006. ;;; Agenda entry finders
  5007. (defun org-agenda--timestamp-to-absolute (&rest args)
  5008. "Call `org-time-string-to-absolute' with ARGS.
  5009. However, throw `:skip' whenever an error is raised."
  5010. (condition-case e
  5011. (apply #'org-time-string-to-absolute args)
  5012. (org-diary-sexp-no-match (throw :skip nil))
  5013. (error
  5014. (message "%s; Skipping entry" (error-message-string e))
  5015. (throw :skip nil))))
  5016. (defun org-agenda-get-day-entries (file date &rest args)
  5017. "Does the work for `org-diary' and `org-agenda'.
  5018. FILE is the path to a file to be checked for entries. DATE is date like
  5019. the one returned by `calendar-current-date'. ARGS are symbols indicating
  5020. which kind of entries should be extracted. For details about these, see
  5021. the documentation of `org-diary'."
  5022. (let* ((org-startup-folded nil)
  5023. (org-startup-align-all-tables nil)
  5024. (buffer (if (file-exists-p file) (org-get-agenda-file-buffer file)
  5025. (error "No such file %s" file))))
  5026. (if (not buffer)
  5027. ;; If file does not exist, signal it in diary nonetheless.
  5028. (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  5029. (with-current-buffer buffer
  5030. (unless (derived-mode-p 'org-mode)
  5031. (error "Agenda file %s is not in Org mode" file))
  5032. (setq org-agenda-buffer (or org-agenda-buffer buffer))
  5033. (setf org-agenda-current-date date)
  5034. (save-excursion
  5035. (save-restriction
  5036. (if (eq buffer org-agenda-restrict)
  5037. (narrow-to-region org-agenda-restrict-begin
  5038. org-agenda-restrict-end)
  5039. (widen))
  5040. ;; Rationalize ARGS. Also make sure `:deadline' comes
  5041. ;; first in order to populate DEADLINES before passing it.
  5042. ;;
  5043. ;; We use `delq' since `org-uniquify' duplicates ARGS,
  5044. ;; guarding us from modifying `org-agenda-entry-types'.
  5045. (setf args (org-uniquify (or args org-agenda-entry-types)))
  5046. (when (and (memq :scheduled args) (memq :scheduled* args))
  5047. (setf args (delq :scheduled* args)))
  5048. (cond
  5049. ((memq :deadline args)
  5050. (setf args (cons :deadline
  5051. (delq :deadline (delq :deadline* args)))))
  5052. ((memq :deadline* args)
  5053. (setf args (cons :deadline* (delq :deadline* args)))))
  5054. ;; Collect list of headlines. Return them flattened.
  5055. (let ((case-fold-search nil) results deadlines)
  5056. (org-dlet
  5057. ((date date))
  5058. (dolist (arg args (apply #'nconc (nreverse results)))
  5059. (pcase arg
  5060. ((and :todo (guard (org-agenda-today-p date)))
  5061. (push (org-agenda-get-todos) results))
  5062. (:timestamp
  5063. (push (org-agenda-get-blocks) results)
  5064. (push (org-agenda-get-timestamps deadlines) results))
  5065. (:sexp
  5066. (push (org-agenda-get-sexps) results))
  5067. (:scheduled
  5068. (push (org-agenda-get-scheduled deadlines) results))
  5069. (:scheduled*
  5070. (push (org-agenda-get-scheduled deadlines t) results))
  5071. (:closed
  5072. (push (org-agenda-get-progress) results))
  5073. (:deadline
  5074. (setf deadlines (org-agenda-get-deadlines))
  5075. (push deadlines results))
  5076. (:deadline*
  5077. (setf deadlines (org-agenda-get-deadlines t))
  5078. (push deadlines results))))))))))))
  5079. (defsubst org-em (x y list)
  5080. "Is X or Y a member of LIST?"
  5081. (or (memq x list) (memq y list)))
  5082. (defvar org-heading-keyword-regexp-format) ; defined in org.el
  5083. (defvar org-agenda-sorting-strategy-selected nil)
  5084. (defun org-agenda-entry-get-agenda-timestamp (pom)
  5085. "Retrieve timestamp information for sorting agenda views.
  5086. Given a point or marker POM, returns a cons cell of the timestamp
  5087. and the timestamp type relevant for the sorting strategy in
  5088. `org-agenda-sorting-strategy-selected'."
  5089. (let (ts ts-date-type)
  5090. (save-match-data
  5091. (cond ((org-em 'scheduled-up 'scheduled-down
  5092. org-agenda-sorting-strategy-selected)
  5093. (setq ts (org-entry-get pom "SCHEDULED")
  5094. ts-date-type " scheduled"))
  5095. ((org-em 'deadline-up 'deadline-down
  5096. org-agenda-sorting-strategy-selected)
  5097. (setq ts (org-entry-get pom "DEADLINE")
  5098. ts-date-type " deadline"))
  5099. ((org-em 'ts-up 'ts-down
  5100. org-agenda-sorting-strategy-selected)
  5101. (setq ts (org-entry-get pom "TIMESTAMP")
  5102. ts-date-type " timestamp"))
  5103. ((org-em 'tsia-up 'tsia-down
  5104. org-agenda-sorting-strategy-selected)
  5105. (setq ts (org-entry-get pom "TIMESTAMP_IA")
  5106. ts-date-type " timestamp_ia"))
  5107. ((org-em 'timestamp-up 'timestamp-down
  5108. org-agenda-sorting-strategy-selected)
  5109. (setq ts (or (org-entry-get pom "SCHEDULED")
  5110. (org-entry-get pom "DEADLINE")
  5111. (org-entry-get pom "TIMESTAMP")
  5112. (org-entry-get pom "TIMESTAMP_IA"))
  5113. ts-date-type ""))
  5114. (t (setq ts-date-type "")))
  5115. (cons (when ts (ignore-errors (org-time-string-to-absolute ts)))
  5116. ts-date-type))))
  5117. (defun org-agenda-get-todos ()
  5118. "Return the TODO information for agenda display."
  5119. (let* ((props (list 'face nil
  5120. 'done-face 'org-agenda-done
  5121. 'org-not-done-regexp org-not-done-regexp
  5122. 'org-todo-regexp org-todo-regexp
  5123. 'org-complex-heading-regexp org-complex-heading-regexp
  5124. 'mouse-face 'highlight
  5125. 'help-echo
  5126. (format "mouse-2 or RET jump to org file %s"
  5127. (abbreviate-file-name buffer-file-name))))
  5128. (case-fold-search nil)
  5129. (regexp (format org-heading-keyword-regexp-format
  5130. (cond
  5131. ((and org-select-this-todo-keyword
  5132. (equal org-select-this-todo-keyword "*"))
  5133. org-todo-regexp)
  5134. (org-select-this-todo-keyword
  5135. (concat "\\("
  5136. (mapconcat #'identity
  5137. (org-split-string
  5138. org-select-this-todo-keyword
  5139. "|")
  5140. "\\|")
  5141. "\\)"))
  5142. (t org-not-done-regexp))))
  5143. marker priority category level tags todo-state
  5144. ts-date ts-date-type ts-date-pair
  5145. ee txt beg end inherited-tags todo-state-end-pos
  5146. effort effort-minutes)
  5147. (goto-char (point-min))
  5148. (while (re-search-forward regexp nil t)
  5149. (catch :skip
  5150. (save-match-data
  5151. (beginning-of-line)
  5152. (org-agenda-skip)
  5153. (setq beg (point) end (save-excursion (outline-next-heading) (point)))
  5154. (unless (and (setq todo-state (org-get-todo-state))
  5155. (setq todo-state-end-pos (match-end 2)))
  5156. (goto-char end)
  5157. (throw :skip nil))
  5158. (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
  5159. (goto-char (1+ beg))
  5160. (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
  5161. (throw :skip nil)))
  5162. (goto-char (match-beginning 2))
  5163. (setq marker (org-agenda-new-marker (match-beginning 0))
  5164. category (org-get-category)
  5165. effort (save-match-data (or (get-text-property (point) 'effort)
  5166. (org-entry-get (point) org-effort-property)))
  5167. effort-minutes (when effort (save-match-data (org-duration-to-minutes effort)))
  5168. ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
  5169. ts-date (car ts-date-pair)
  5170. ts-date-type (cdr ts-date-pair)
  5171. txt (org-trim (buffer-substring (match-beginning 2) (match-end 0)))
  5172. inherited-tags
  5173. (or (eq org-agenda-show-inherited-tags 'always)
  5174. (and (listp org-agenda-show-inherited-tags)
  5175. (memq 'todo org-agenda-show-inherited-tags))
  5176. (and (eq org-agenda-show-inherited-tags t)
  5177. (or (eq org-agenda-use-tag-inheritance t)
  5178. (memq 'todo org-agenda-use-tag-inheritance))))
  5179. tags (org-get-tags nil (not inherited-tags))
  5180. level (make-string (org-reduced-level (org-outline-level)) ? )
  5181. txt (org-agenda-format-item ""
  5182. (org-add-props txt nil
  5183. 'effort effort
  5184. 'effort-minutes effort-minutes)
  5185. level category tags t)
  5186. priority (1+ (org-get-priority txt)))
  5187. (org-add-props txt props
  5188. 'org-marker marker 'org-hd-marker marker
  5189. 'priority priority
  5190. 'effort effort 'effort-minutes effort-minutes
  5191. 'level level
  5192. 'ts-date ts-date
  5193. 'type (concat "todo" ts-date-type) 'todo-state todo-state)
  5194. (push txt ee)
  5195. (if org-agenda-todo-list-sublevels
  5196. (goto-char todo-state-end-pos)
  5197. (org-end-of-subtree 'invisible))))
  5198. (nreverse ee)))
  5199. (defun org-agenda-todo-custom-ignore-p (time n)
  5200. "Check whether timestamp is farther away than n number of days.
  5201. This function is invoked if `org-agenda-todo-ignore-deadlines',
  5202. `org-agenda-todo-ignore-scheduled' or
  5203. `org-agenda-todo-ignore-timestamp' is set to an integer."
  5204. (let ((days (org-time-stamp-to-now
  5205. time org-agenda-todo-ignore-time-comparison-use-seconds)))
  5206. (if (>= n 0)
  5207. (>= days n)
  5208. (<= days n))))
  5209. ;;;###autoload
  5210. (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  5211. (&optional end)
  5212. "Do we have a reason to ignore this TODO entry because it has a time stamp?"
  5213. (when (or org-agenda-todo-ignore-with-date
  5214. org-agenda-todo-ignore-scheduled
  5215. org-agenda-todo-ignore-deadlines
  5216. org-agenda-todo-ignore-timestamp)
  5217. (setq end (or end (save-excursion (outline-next-heading) (point))))
  5218. (save-excursion
  5219. (or (and org-agenda-todo-ignore-with-date
  5220. (re-search-forward org-ts-regexp end t))
  5221. (and org-agenda-todo-ignore-scheduled
  5222. (re-search-forward org-scheduled-time-regexp end t)
  5223. (cond
  5224. ((eq org-agenda-todo-ignore-scheduled 'future)
  5225. (> (org-time-stamp-to-now
  5226. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5227. 0))
  5228. ((eq org-agenda-todo-ignore-scheduled 'past)
  5229. (<= (org-time-stamp-to-now
  5230. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5231. 0))
  5232. ((numberp org-agenda-todo-ignore-scheduled)
  5233. (org-agenda-todo-custom-ignore-p
  5234. (match-string 1) org-agenda-todo-ignore-scheduled))
  5235. (t)))
  5236. (and org-agenda-todo-ignore-deadlines
  5237. (re-search-forward org-deadline-time-regexp end t)
  5238. (cond
  5239. ((eq org-agenda-todo-ignore-deadlines 'all) t)
  5240. ((eq org-agenda-todo-ignore-deadlines 'far)
  5241. (not (org-deadline-close-p (match-string 1))))
  5242. ((eq org-agenda-todo-ignore-deadlines 'future)
  5243. (> (org-time-stamp-to-now
  5244. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5245. 0))
  5246. ((eq org-agenda-todo-ignore-deadlines 'past)
  5247. (<= (org-time-stamp-to-now
  5248. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5249. 0))
  5250. ((numberp org-agenda-todo-ignore-deadlines)
  5251. (org-agenda-todo-custom-ignore-p
  5252. (match-string 1) org-agenda-todo-ignore-deadlines))
  5253. (t (org-deadline-close-p (match-string 1)))))
  5254. (and org-agenda-todo-ignore-timestamp
  5255. (let ((buffer (current-buffer))
  5256. (regexp
  5257. (concat
  5258. org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
  5259. (start (point)))
  5260. ;; Copy current buffer into a temporary one
  5261. (with-temp-buffer
  5262. (insert-buffer-substring buffer start end)
  5263. (goto-char (point-min))
  5264. ;; Delete SCHEDULED and DEADLINE items
  5265. (while (re-search-forward regexp end t)
  5266. (delete-region (match-beginning 0) (match-end 0)))
  5267. (goto-char (point-min))
  5268. ;; No search for timestamp left
  5269. (when (re-search-forward org-ts-regexp nil t)
  5270. (cond
  5271. ((eq org-agenda-todo-ignore-timestamp 'future)
  5272. (> (org-time-stamp-to-now
  5273. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5274. 0))
  5275. ((eq org-agenda-todo-ignore-timestamp 'past)
  5276. (<= (org-time-stamp-to-now
  5277. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5278. 0))
  5279. ((numberp org-agenda-todo-ignore-timestamp)
  5280. (org-agenda-todo-custom-ignore-p
  5281. (match-string 1) org-agenda-todo-ignore-timestamp))
  5282. (t))))))))))
  5283. (defun org-agenda-get-timestamps (&optional deadlines)
  5284. "Return the date stamp information for agenda display.
  5285. Optional argument DEADLINES is a list of deadline items to be
  5286. displayed in agenda view."
  5287. (with-no-warnings (defvar date))
  5288. (let* ((props (list 'face 'org-agenda-calendar-event
  5289. 'org-not-done-regexp org-not-done-regexp
  5290. 'org-todo-regexp org-todo-regexp
  5291. 'org-complex-heading-regexp org-complex-heading-regexp
  5292. 'mouse-face 'highlight
  5293. 'help-echo
  5294. (format "mouse-2 or RET jump to Org file %s"
  5295. (abbreviate-file-name buffer-file-name))))
  5296. (current (calendar-absolute-from-gregorian date))
  5297. (today (org-today))
  5298. (deadline-position-alist
  5299. (mapcar (lambda (d)
  5300. (let ((m (get-text-property 0 'org-hd-marker d)))
  5301. (and m (marker-position m))))
  5302. deadlines))
  5303. ;; Match time-stamps set to current date, time-stamps with
  5304. ;; a repeater, and S-exp time-stamps.
  5305. (regexp
  5306. (concat
  5307. (if org-agenda-include-inactive-timestamps "[[<]" "<")
  5308. (regexp-quote
  5309. (substring
  5310. (format-time-string
  5311. (car org-time-stamp-formats)
  5312. (org-encode-time ; DATE bound by calendar
  5313. 0 0 0 (nth 1 date) (car date) (nth 2 date)))
  5314. 1 11))
  5315. "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
  5316. "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
  5317. timestamp-items)
  5318. (goto-char (point-min))
  5319. (while (re-search-forward regexp nil t)
  5320. ;; Skip date ranges, scheduled and deadlines, which are handled
  5321. ;; specially. Also skip time-stamps before first headline as
  5322. ;; there would be no entry to add to the agenda. Eventually,
  5323. ;; ignore clock entries.
  5324. (catch :skip
  5325. (save-match-data
  5326. (when (or (org-at-date-range-p)
  5327. (org-at-planning-p)
  5328. (org-before-first-heading-p)
  5329. (and org-agenda-include-inactive-timestamps
  5330. (org-at-clock-log-p))
  5331. (not (org-at-timestamp-p 'agenda)))
  5332. (throw :skip nil))
  5333. (org-agenda-skip))
  5334. (let* ((pos (match-beginning 0))
  5335. (repeat (match-string 1))
  5336. (sexp-entry (match-string 3))
  5337. (time-stamp (if (or repeat sexp-entry) (match-string 0)
  5338. (save-excursion
  5339. (goto-char pos)
  5340. (looking-at org-ts-regexp-both)
  5341. (match-string 0))))
  5342. (todo-state (org-get-todo-state))
  5343. (warntime (get-text-property (point) 'org-appt-warntime))
  5344. (done? (member todo-state org-done-keywords)))
  5345. ;; Possibly skip done tasks.
  5346. (when (and done? org-agenda-skip-timestamp-if-done)
  5347. (throw :skip t))
  5348. ;; S-exp entry doesn't match current day: skip it.
  5349. (when (and sexp-entry (not (org-diary-sexp-entry sexp-entry "" date)))
  5350. (throw :skip nil))
  5351. (when repeat
  5352. (let* ((past
  5353. ;; A repeating time stamp is shown at its base
  5354. ;; date and every repeated date up to TODAY. If
  5355. ;; `org-agenda-prefer-last-repeat' is non-nil,
  5356. ;; however, only the last repeat before today
  5357. ;; (inclusive) is shown.
  5358. (org-agenda--timestamp-to-absolute
  5359. repeat
  5360. (if (or (> current today)
  5361. (eq org-agenda-prefer-last-repeat t)
  5362. (member todo-state org-agenda-prefer-last-repeat))
  5363. today
  5364. current)
  5365. 'past (current-buffer) pos))
  5366. (future
  5367. ;; Display every repeated date past TODAY
  5368. ;; (exclusive) unless
  5369. ;; `org-agenda-show-future-repeats' is nil. If
  5370. ;; this variable is set to `next', only display
  5371. ;; the first repeated date after TODAY
  5372. ;; (exclusive).
  5373. (cond
  5374. ((<= current today) past)
  5375. ((not org-agenda-show-future-repeats) past)
  5376. (t
  5377. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5378. (1+ today)
  5379. current)))
  5380. (org-agenda--timestamp-to-absolute
  5381. repeat base 'future (current-buffer) pos))))))
  5382. (when (and (/= current past) (/= current future))
  5383. (throw :skip nil))))
  5384. (save-excursion
  5385. (re-search-backward org-outline-regexp-bol nil t)
  5386. ;; Possibly skip time-stamp when a deadline is set.
  5387. (when (and org-agenda-skip-timestamp-if-deadline-is-shown
  5388. (assq (point) deadline-position-alist))
  5389. (throw :skip nil))
  5390. (let* ((category (org-get-category pos))
  5391. (effort (org-entry-get pos org-effort-property))
  5392. (effort-minutes (when effort (save-match-data (org-duration-to-minutes effort))))
  5393. (inherited-tags
  5394. (or (eq org-agenda-show-inherited-tags 'always)
  5395. (and (consp org-agenda-show-inherited-tags)
  5396. (memq 'agenda org-agenda-show-inherited-tags))
  5397. (and (eq org-agenda-show-inherited-tags t)
  5398. (or (eq org-agenda-use-tag-inheritance t)
  5399. (memq 'agenda
  5400. org-agenda-use-tag-inheritance)))))
  5401. (tags (org-get-tags nil (not inherited-tags)))
  5402. (level (make-string (org-reduced-level (org-outline-level))
  5403. ?\s))
  5404. (head (and (looking-at "\\*+[ \t]+\\(.*\\)")
  5405. (match-string 1)))
  5406. (inactive? (= (char-after pos) ?\[))
  5407. (habit? (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  5408. (item
  5409. (org-agenda-format-item
  5410. (and inactive? org-agenda-inactive-leader)
  5411. (org-add-props head nil
  5412. 'effort effort
  5413. 'effort-minutes effort-minutes)
  5414. level category tags time-stamp org-ts-regexp habit?)))
  5415. (org-add-props item props
  5416. 'priority (if habit?
  5417. (org-habit-get-priority (org-habit-parse-todo))
  5418. (org-get-priority item))
  5419. 'org-marker (org-agenda-new-marker pos)
  5420. 'org-hd-marker (org-agenda-new-marker)
  5421. 'date date
  5422. 'level level
  5423. 'effort effort 'effort-minutes effort-minutes
  5424. 'ts-date (if repeat (org-agenda--timestamp-to-absolute repeat)
  5425. current)
  5426. 'todo-state todo-state
  5427. 'warntime warntime
  5428. 'type "timestamp")
  5429. (push item timestamp-items))))
  5430. (when org-agenda-skip-additional-timestamps-same-entry
  5431. (outline-next-heading))))
  5432. (nreverse timestamp-items)))
  5433. (defun org-agenda-get-sexps ()
  5434. "Return the sexp information for agenda display."
  5435. (require 'diary-lib)
  5436. (with-no-warnings (defvar date) (defvar entry))
  5437. (let* ((props (list 'face 'org-agenda-calendar-sexp
  5438. 'mouse-face 'highlight
  5439. 'help-echo
  5440. (format "mouse-2 or RET jump to org file %s"
  5441. (abbreviate-file-name buffer-file-name))))
  5442. (regexp "^&?%%(")
  5443. ;; FIXME: Is this `entry' binding intended to be dynamic,
  5444. ;; so as to "hide" any current binding for it?
  5445. marker category extra level ee txt tags entry
  5446. result beg b sexp sexp-entry todo-state warntime inherited-tags
  5447. effort effort-minutes)
  5448. (goto-char (point-min))
  5449. (while (re-search-forward regexp nil t)
  5450. (catch :skip
  5451. (org-agenda-skip (org-element-at-point))
  5452. (setq beg (match-beginning 0))
  5453. (goto-char (1- (match-end 0)))
  5454. (setq b (point))
  5455. (forward-sexp 1)
  5456. (setq sexp (buffer-substring b (point)))
  5457. (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
  5458. (org-trim (match-string 1))
  5459. ""))
  5460. (setq result (org-diary-sexp-entry sexp sexp-entry date))
  5461. (when result
  5462. (setq marker (org-agenda-new-marker beg)
  5463. level (make-string (org-reduced-level (org-outline-level)) ? )
  5464. category (org-get-category beg)
  5465. effort (save-match-data (or (get-text-property (point) 'effort)
  5466. (org-entry-get (point) org-effort-property)))
  5467. inherited-tags
  5468. (or (eq org-agenda-show-inherited-tags 'always)
  5469. (and (listp org-agenda-show-inherited-tags)
  5470. (memq 'agenda org-agenda-show-inherited-tags))
  5471. (and (eq org-agenda-show-inherited-tags t)
  5472. (or (eq org-agenda-use-tag-inheritance t)
  5473. (memq 'agenda org-agenda-use-tag-inheritance))))
  5474. tags (org-get-tags nil (not inherited-tags))
  5475. todo-state (org-get-todo-state)
  5476. warntime (get-text-property (point) 'org-appt-warntime)
  5477. extra nil)
  5478. (setq effort-minutes (when effort (save-match-data (org-duration-to-minutes effort))))
  5479. (dolist (r (if (stringp result)
  5480. (list result)
  5481. result)) ;; we expect a list here
  5482. (when (and org-agenda-diary-sexp-prefix
  5483. (string-match org-agenda-diary-sexp-prefix r))
  5484. (setq extra (match-string 0 r)
  5485. r (replace-match "" nil nil r)))
  5486. (if (string-match "\\S-" r)
  5487. (setq txt r)
  5488. (setq txt "SEXP entry returned empty string"))
  5489. (setq txt (org-agenda-format-item extra
  5490. (org-add-props txt nil
  5491. 'effort effort
  5492. 'effort-minutes effort-minutes)
  5493. level category tags 'time))
  5494. (org-add-props txt props 'org-marker marker
  5495. 'date date 'todo-state todo-state
  5496. 'effort effort 'effort-minutes effort-minutes
  5497. 'level level 'type "sexp" 'warntime warntime)
  5498. (push txt ee)))))
  5499. (nreverse ee)))
  5500. ;; Calendar sanity: define some functions that are independent of
  5501. ;; `calendar-date-style'.
  5502. (defun org-anniversary (year month day &optional mark)
  5503. "Like `diary-anniversary', but with fixed (ISO) order of arguments."
  5504. (with-no-warnings
  5505. (let ((calendar-date-style 'iso))
  5506. (diary-anniversary year month day mark))))
  5507. (defun org-cyclic (N year month day &optional mark)
  5508. "Like `diary-cyclic', but with fixed (ISO) order of arguments."
  5509. (with-no-warnings
  5510. (let ((calendar-date-style 'iso))
  5511. (diary-cyclic N year month day mark))))
  5512. (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
  5513. "Like `diary-block', but with fixed (ISO) order of arguments."
  5514. (with-no-warnings
  5515. (let ((calendar-date-style 'iso))
  5516. (diary-block Y1 M1 D1 Y2 M2 D2 mark))))
  5517. (defun org-date (year month day &optional mark)
  5518. "Like `diary-date', but with fixed (ISO) order of arguments."
  5519. (with-no-warnings
  5520. (let ((calendar-date-style 'iso))
  5521. (diary-date year month day mark))))
  5522. ;; Define the `org-class' function
  5523. (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
  5524. "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
  5525. DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
  5526. SKIP-WEEKS is any number of ISO weeks in the block period for which the
  5527. item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
  5528. `holidays', then any date that is known by the Emacs calendar to be a
  5529. holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
  5530. then those holidays will be skipped."
  5531. (with-no-warnings (defvar date) (defvar entry))
  5532. (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
  5533. (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
  5534. (d (calendar-absolute-from-gregorian date))
  5535. (h (when skip-weeks (calendar-check-holidays date))))
  5536. (and
  5537. (<= date1 d)
  5538. (<= d date2)
  5539. (= (calendar-day-of-week date) dayname)
  5540. (or (not skip-weeks)
  5541. (progn
  5542. (require 'cal-iso)
  5543. (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
  5544. (not (or (and h (memq 'holidays skip-weeks))
  5545. (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
  5546. entry)))
  5547. (defalias 'org-get-closed #'org-agenda-get-progress)
  5548. (defun org-agenda-get-progress ()
  5549. "Return the logged TODO entries for agenda display."
  5550. (with-no-warnings (defvar date))
  5551. (let* ((props (list 'mouse-face 'highlight
  5552. 'org-not-done-regexp org-not-done-regexp
  5553. 'org-todo-regexp org-todo-regexp
  5554. 'org-complex-heading-regexp org-complex-heading-regexp
  5555. 'help-echo
  5556. (format "mouse-2 or RET jump to org file %s"
  5557. (abbreviate-file-name buffer-file-name))))
  5558. (items (if (consp org-agenda-show-log-scoped)
  5559. org-agenda-show-log-scoped
  5560. (if (eq org-agenda-show-log-scoped 'clockcheck)
  5561. '(clock)
  5562. org-agenda-log-mode-items)))
  5563. (parts
  5564. (delq nil
  5565. (list
  5566. (when (memq 'closed items) (concat "\\<" org-closed-string))
  5567. (when (memq 'clock items) (concat "\\<" org-clock-string))
  5568. (when (memq 'state items)
  5569. (format "- +State \"%s\".*?" org-todo-regexp)))))
  5570. (parts-re (if parts (mapconcat #'identity parts "\\|")
  5571. (error "`org-agenda-log-mode-items' is empty")))
  5572. (regexp (concat
  5573. "\\(" parts-re "\\)"
  5574. " *\\["
  5575. (regexp-quote
  5576. (substring
  5577. (format-time-string
  5578. (car org-time-stamp-formats)
  5579. (org-encode-time ; DATE bound by calendar
  5580. 0 0 0 (nth 1 date) (car date) (nth 2 date)))
  5581. 1 11))))
  5582. (org-agenda-search-headline-for-time nil)
  5583. marker hdmarker priority category level tags closedp type
  5584. statep clockp state ee txt extra timestr rest clocked inherited-tags
  5585. effort effort-minutes)
  5586. (goto-char (point-min))
  5587. (while (re-search-forward regexp nil t)
  5588. (catch :skip
  5589. (org-agenda-skip)
  5590. (setq marker (org-agenda-new-marker (match-beginning 0))
  5591. closedp (equal (match-string 1) org-closed-string)
  5592. statep (equal (string-to-char (match-string 1)) ?-)
  5593. clockp (not (or closedp statep))
  5594. state (and statep (match-string 2))
  5595. category (org-get-category (match-beginning 0))
  5596. timestr (buffer-substring (match-beginning 0) (line-end-position))
  5597. effort (save-match-data (or (get-text-property (point) 'effort)
  5598. (org-entry-get (point) org-effort-property))))
  5599. (setq effort-minutes (when effort (save-match-data (org-duration-to-minutes effort))))
  5600. (when (string-match "\\]" timestr)
  5601. ;; substring should only run to end of time stamp
  5602. (setq rest (substring timestr (match-end 0))
  5603. timestr (substring timestr 0 (match-end 0)))
  5604. (if (and (not closedp) (not statep)
  5605. (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
  5606. rest))
  5607. (progn (setq timestr (concat (substring timestr 0 -1)
  5608. "-" (match-string 1 rest) "]"))
  5609. (setq clocked (match-string 2 rest)))
  5610. (setq clocked "-")))
  5611. (save-excursion
  5612. (setq extra
  5613. (cond
  5614. ((not org-agenda-log-mode-add-notes) nil)
  5615. (statep
  5616. (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
  5617. (match-string 1)))
  5618. (clockp
  5619. (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
  5620. (match-string 1)))))
  5621. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5622. (throw :skip nil)
  5623. (goto-char (match-beginning 0))
  5624. (setq hdmarker (org-agenda-new-marker)
  5625. inherited-tags
  5626. (or (eq org-agenda-show-inherited-tags 'always)
  5627. (and (listp org-agenda-show-inherited-tags)
  5628. (memq 'todo org-agenda-show-inherited-tags))
  5629. (and (eq org-agenda-show-inherited-tags t)
  5630. (or (eq org-agenda-use-tag-inheritance t)
  5631. (memq 'todo org-agenda-use-tag-inheritance))))
  5632. tags (org-get-tags nil (not inherited-tags))
  5633. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5634. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5635. (setq txt (match-string 1))
  5636. (when extra
  5637. (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
  5638. (setq txt (concat (substring txt 0 (match-beginning 1))
  5639. " - " extra " " (match-string 2 txt)))
  5640. (setq txt (concat txt " - " extra))))
  5641. (setq txt (org-agenda-format-item
  5642. (cond
  5643. (closedp "Closed: ")
  5644. (statep (concat "State: (" state ")"))
  5645. (t (concat "Clocked: (" clocked ")")))
  5646. (org-add-props txt nil
  5647. 'effort effort
  5648. 'effort-minutes effort-minutes)
  5649. level category tags timestr)))
  5650. (setq type (cond (closedp "closed")
  5651. (statep "state")
  5652. (t "clock")))
  5653. (setq priority 100000)
  5654. (org-add-props txt props
  5655. 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
  5656. 'priority priority 'level level
  5657. 'effort effort 'effort-minutes effort-minutes
  5658. 'type type 'date date
  5659. 'undone-face 'org-warning 'done-face 'org-agenda-done)
  5660. (push txt ee))
  5661. (goto-char (line-end-position))))
  5662. (nreverse ee)))
  5663. (defun org-agenda-show-clocking-issues ()
  5664. "Add overlays, showing issues with clocking.
  5665. See also the user option `org-agenda-clock-consistency-checks'."
  5666. (interactive)
  5667. (let* ((pl org-agenda-clock-consistency-checks)
  5668. (re (concat "^[ \t]*"
  5669. org-clock-string
  5670. "[ \t]+"
  5671. "\\(\\[.*?\\]\\)" ; group 1 is first stamp
  5672. "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
  5673. (tlstart 0.)
  5674. (tlend 0.)
  5675. (maxtime (org-duration-to-minutes
  5676. (or (plist-get pl :max-duration) "24:00")))
  5677. (mintime (org-duration-to-minutes
  5678. (or (plist-get pl :min-duration) 0)))
  5679. (maxgap (org-duration-to-minutes
  5680. ;; default 30:00 means never complain
  5681. (or (plist-get pl :max-gap) "30:00")))
  5682. (gapok (mapcar #'org-duration-to-minutes
  5683. (plist-get pl :gap-ok-around)))
  5684. (def-face (or (plist-get pl :default-face)
  5685. '((:background "DarkRed") (:foreground "white"))))
  5686. issue face m te ts dt ov)
  5687. (goto-char (point-min))
  5688. (while (re-search-forward " Clocked: +(\\(?:-\\|\\([0-9]+:[0-9]+\\)\\))" nil t)
  5689. (setq issue nil face def-face)
  5690. (catch 'next
  5691. (setq m (org-get-at-bol 'org-marker)
  5692. te nil ts nil)
  5693. (unless (and m (markerp m))
  5694. (setq issue "No valid clock line") (throw 'next t))
  5695. (org-with-point-at m
  5696. (save-excursion
  5697. (goto-char (line-beginning-position))
  5698. (unless (looking-at re)
  5699. (error "No valid Clock line")
  5700. (throw 'next t))
  5701. (unless (match-end 3)
  5702. (setq issue
  5703. (format
  5704. "No end time: (%s)"
  5705. (org-duration-from-minutes
  5706. (floor
  5707. (- (float-time (org-current-time))
  5708. (float-time (org-time-string-to-time (match-string 1))))
  5709. 60)))
  5710. face (or (plist-get pl :no-end-time-face) face))
  5711. (throw 'next t))
  5712. (setq ts (match-string 1)
  5713. te (match-string 3)
  5714. ts (float-time (org-time-string-to-time ts))
  5715. te (float-time (org-time-string-to-time te))
  5716. dt (- te ts))))
  5717. (cond
  5718. ((> dt (* 60 maxtime))
  5719. ;; a very long clocking chunk
  5720. (setq issue (format "Clocking interval is very long: %s"
  5721. (org-duration-from-minutes (floor dt 60)))
  5722. face (or (plist-get pl :long-face) face)))
  5723. ((< dt (* 60 mintime))
  5724. ;; a very short clocking chunk
  5725. (setq issue (format "Clocking interval is very short: %s"
  5726. (org-duration-from-minutes (floor dt 60)))
  5727. face (or (plist-get pl :short-face) face)))
  5728. ((and (> tlend 0) (< ts tlend))
  5729. ;; Two clock entries are overlapping
  5730. (setq issue (format "Clocking overlap: %d minutes"
  5731. (/ (- tlend ts) 60))
  5732. face (or (plist-get pl :overlap-face) face)))
  5733. ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
  5734. ;; There is a gap, lets see if we need to report it
  5735. (unless (org-agenda-check-clock-gap tlend ts gapok)
  5736. (setq issue (format "Clocking gap: %d minutes"
  5737. (/ (- ts tlend) 60))
  5738. face (or (plist-get pl :gap-face) face))))
  5739. (t nil)))
  5740. (setq tlend (or te tlend) tlstart (or ts tlstart))
  5741. (when issue
  5742. ;; OK, there was some issue, add an overlay to show the issue
  5743. (setq ov (make-overlay (line-beginning-position) (line-end-position)))
  5744. (overlay-put ov 'before-string
  5745. (concat
  5746. (org-add-props
  5747. (format "%-43s" (concat " " issue))
  5748. nil
  5749. 'face face)
  5750. "\n"))
  5751. (overlay-put ov 'evaporate t)))))
  5752. (defun org-agenda-check-clock-gap (t1 t2 ok-list)
  5753. "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
  5754. (catch 'exit
  5755. (unless ok-list
  5756. ;; there are no OK times for gaps...
  5757. (throw 'exit nil))
  5758. (when (> (- (/ t2 36000) (/ t1 36000)) 24)
  5759. ;; This is more than 24 hours, so it is OK.
  5760. ;; because we have at least one OK time, that must be in the
  5761. ;; 24 hour interval.
  5762. (throw 'exit t))
  5763. ;; We have a shorter gap.
  5764. ;; Now we have to get the minute of the day when these times are
  5765. (let* ((t1dec (decode-time t1))
  5766. (t2dec (decode-time t2))
  5767. ;; compute the minute on the day
  5768. (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
  5769. (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
  5770. (when (< min2 min1)
  5771. ;; if min2 is smaller than min1, this means it is on the next day.
  5772. ;; Wrap it to after midnight.
  5773. (setq min2 (+ min2 1440)))
  5774. ;; Now check if any of the OK times is in the gap
  5775. (mapc (lambda (x)
  5776. ;; Wrap the time to after midnight if necessary
  5777. (when (< x min1) (setq x (+ x 1440)))
  5778. ;; Check if in interval
  5779. (and (<= min1 x) (>= min2 x) (throw 'exit t)))
  5780. ok-list)
  5781. ;; Nope, this gap is not OK
  5782. nil)))
  5783. (defun org-agenda-get-deadlines (&optional with-hour)
  5784. "Return the deadline information for agenda display.
  5785. When WITH-HOUR is non-nil, only return deadlines with an hour
  5786. specification like [h]h:mm."
  5787. (with-no-warnings (defvar date))
  5788. (let* ((props (list 'mouse-face 'highlight
  5789. 'org-not-done-regexp org-not-done-regexp
  5790. 'org-todo-regexp org-todo-regexp
  5791. 'org-complex-heading-regexp org-complex-heading-regexp
  5792. 'help-echo
  5793. (format "mouse-2 or RET jump to org file %s"
  5794. (abbreviate-file-name buffer-file-name))))
  5795. (regexp (if with-hour
  5796. org-deadline-time-hour-regexp
  5797. org-deadline-time-regexp))
  5798. (today (org-today))
  5799. (today? (org-agenda-today-p date)) ; DATE bound by calendar.
  5800. (current (calendar-absolute-from-gregorian date))
  5801. deadline-items)
  5802. (goto-char (point-min))
  5803. (if (org-element--cache-active-p)
  5804. (org-element-cache-map
  5805. (lambda (el)
  5806. (when (and (org-element-property :deadline el)
  5807. (or (not with-hour)
  5808. (org-element-property
  5809. :hour-start
  5810. (org-element-property :deadline el))
  5811. (org-element-property
  5812. :hour-end
  5813. (org-element-property :deadline el))))
  5814. (goto-char (org-element-property :contents-begin el))
  5815. (catch :skip
  5816. (org-agenda-skip el)
  5817. (let* ((s (substring (org-element-property
  5818. :raw-value
  5819. (org-element-property :deadline el))
  5820. 1 -1))
  5821. (pos (save-excursion
  5822. (goto-char (org-element-property :contents-begin el))
  5823. ;; We intentionally leave NOERROR
  5824. ;; argument in `re-search-forward' nil. If
  5825. ;; the search fails here, something went
  5826. ;; wrong and we are looking at
  5827. ;; non-matching headline.
  5828. (re-search-forward regexp (line-end-position))
  5829. (1- (match-beginning 1))))
  5830. (todo-state (org-element-property :todo-keyword el))
  5831. (done? (eq 'done (org-element-property :todo-type el)))
  5832. (sexp? (eq 'diary
  5833. (org-element-property
  5834. :type (org-element-property :deadline el))))
  5835. ;; DEADLINE is the deadline date for the entry. It is
  5836. ;; either the base date or the last repeat, according
  5837. ;; to `org-agenda-prefer-last-repeat'.
  5838. (deadline
  5839. (cond
  5840. (sexp? (org-agenda--timestamp-to-absolute s current))
  5841. ((or (eq org-agenda-prefer-last-repeat t)
  5842. (member todo-state org-agenda-prefer-last-repeat))
  5843. (org-agenda--timestamp-to-absolute
  5844. s today 'past (current-buffer) pos))
  5845. (t (org-agenda--timestamp-to-absolute s))))
  5846. ;; REPEAT is the future repeat closest from CURRENT,
  5847. ;; according to `org-agenda-show-future-repeats'. If
  5848. ;; the latter is nil, or if the time stamp has no
  5849. ;; repeat part, default to DEADLINE.
  5850. (repeat
  5851. (cond
  5852. (sexp? deadline)
  5853. ((<= current today) deadline)
  5854. ((not org-agenda-show-future-repeats) deadline)
  5855. (t
  5856. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5857. (1+ today)
  5858. current)))
  5859. (org-agenda--timestamp-to-absolute
  5860. s base 'future (current-buffer) pos)))))
  5861. (diff (- deadline current))
  5862. (suppress-prewarning
  5863. (let ((scheduled
  5864. (and org-agenda-skip-deadline-prewarning-if-scheduled
  5865. (org-element-property
  5866. :raw-value
  5867. (org-element-property :scheduled el)))))
  5868. (cond
  5869. ((not scheduled) nil)
  5870. ;; The current item has a scheduled date, so
  5871. ;; evaluate its prewarning lead time.
  5872. ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
  5873. ;; Use global prewarning-restart lead time.
  5874. org-agenda-skip-deadline-prewarning-if-scheduled)
  5875. ((eq org-agenda-skip-deadline-prewarning-if-scheduled
  5876. 'pre-scheduled)
  5877. ;; Set pre-warning to no earlier than SCHEDULED.
  5878. (min (- deadline
  5879. (org-agenda--timestamp-to-absolute scheduled))
  5880. org-deadline-warning-days))
  5881. ;; Set pre-warning to deadline.
  5882. (t 0))))
  5883. (wdays (or suppress-prewarning (org-get-wdays s))))
  5884. (cond
  5885. ;; Only display deadlines at their base date, at future
  5886. ;; repeat occurrences or in today agenda.
  5887. ((= current deadline) nil)
  5888. ((= current repeat) nil)
  5889. ((not today?) (throw :skip nil))
  5890. ;; Upcoming deadline: display within warning period WDAYS.
  5891. ((> deadline current) (when (> diff wdays) (throw :skip nil)))
  5892. ;; Overdue deadline: warn about it for
  5893. ;; `org-deadline-past-days' duration.
  5894. (t (when (< org-deadline-past-days (- diff)) (throw :skip nil))))
  5895. ;; Possibly skip done tasks.
  5896. (when (and done?
  5897. (or org-agenda-skip-deadline-if-done
  5898. (/= deadline current)))
  5899. (throw :skip nil))
  5900. (save-excursion
  5901. (goto-char (org-element-property :begin el))
  5902. (let* ((category (org-get-category))
  5903. (effort (save-match-data (or (get-text-property (point) 'effort)
  5904. (org-element-property (intern (concat ":" (upcase org-effort-property))) el))))
  5905. (effort-minutes (when effort (save-match-data (org-duration-to-minutes effort))))
  5906. (level (make-string (org-element-property :level el)
  5907. ?\s))
  5908. (head (save-excursion
  5909. (goto-char (org-element-property :begin el))
  5910. (re-search-forward org-outline-regexp-bol)
  5911. (buffer-substring-no-properties (point) (line-end-position))))
  5912. (inherited-tags
  5913. (or (eq org-agenda-show-inherited-tags 'always)
  5914. (and (listp org-agenda-show-inherited-tags)
  5915. (memq 'agenda org-agenda-show-inherited-tags))
  5916. (and (eq org-agenda-show-inherited-tags t)
  5917. (or (eq org-agenda-use-tag-inheritance t)
  5918. (memq 'agenda
  5919. org-agenda-use-tag-inheritance)))))
  5920. (tags (org-get-tags el (not inherited-tags)))
  5921. (time
  5922. (cond
  5923. ;; No time of day designation if it is only
  5924. ;; a reminder.
  5925. ((and (/= current deadline) (/= current repeat)) nil)
  5926. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5927. (concat (substring s (match-beginning 1)) " "))
  5928. (t 'time)))
  5929. (item
  5930. (org-agenda-format-item
  5931. ;; Insert appropriate suffixes before deadlines.
  5932. ;; Those only apply to today agenda.
  5933. (pcase-let ((`(,now ,future ,past)
  5934. org-agenda-deadline-leaders))
  5935. (cond
  5936. ((and today? (< deadline today)) (format past (- diff)))
  5937. ((and today? (> deadline today)) (format future diff))
  5938. (t now)))
  5939. (org-add-props head nil
  5940. 'effort effort
  5941. 'effort-minutes effort-minutes)
  5942. level category tags time))
  5943. (face (org-agenda-deadline-face
  5944. (- 1 (/ (float diff) (max wdays 1)))))
  5945. (upcoming? (and today? (> deadline today)))
  5946. (warntime (get-text-property (point) 'org-appt-warntime)))
  5947. (org-add-props item props
  5948. 'org-marker (org-agenda-new-marker pos)
  5949. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  5950. 'warntime warntime
  5951. 'level level
  5952. 'effort effort 'effort-minutes effort-minutes
  5953. 'ts-date deadline
  5954. 'priority
  5955. ;; Adjust priority to today reminders about deadlines.
  5956. ;; Overdue deadlines get the highest priority
  5957. ;; increase, then imminent deadlines and eventually
  5958. ;; more distant deadlines.
  5959. (let ((adjust (if today? (- diff) 0)))
  5960. (+ adjust (org-get-priority item)))
  5961. 'todo-state todo-state
  5962. 'type (if upcoming? "upcoming-deadline" "deadline")
  5963. 'date (if upcoming? date deadline)
  5964. 'face (if done? 'org-agenda-done face)
  5965. 'undone-face face
  5966. 'done-face 'org-agenda-done)
  5967. (push item deadline-items)))))))
  5968. :next-re regexp
  5969. :fail-re regexp
  5970. :narrow t)
  5971. (while (re-search-forward regexp nil t)
  5972. (catch :skip
  5973. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5974. (org-agenda-skip)
  5975. (let* ((s (match-string 1))
  5976. (pos (1- (match-beginning 1)))
  5977. (todo-state (save-match-data (org-get-todo-state)))
  5978. (done? (member todo-state org-done-keywords))
  5979. (sexp? (string-prefix-p "%%" s))
  5980. ;; DEADLINE is the deadline date for the entry. It is
  5981. ;; either the base date or the last repeat, according
  5982. ;; to `org-agenda-prefer-last-repeat'.
  5983. (deadline
  5984. (cond
  5985. (sexp? (org-agenda--timestamp-to-absolute s current))
  5986. ((or (eq org-agenda-prefer-last-repeat t)
  5987. (member todo-state org-agenda-prefer-last-repeat))
  5988. (org-agenda--timestamp-to-absolute
  5989. s today 'past (current-buffer) pos))
  5990. (t (org-agenda--timestamp-to-absolute s))))
  5991. ;; REPEAT is the future repeat closest from CURRENT,
  5992. ;; according to `org-agenda-show-future-repeats'. If
  5993. ;; the latter is nil, or if the time stamp has no
  5994. ;; repeat part, default to DEADLINE.
  5995. (repeat
  5996. (cond
  5997. (sexp? deadline)
  5998. ((<= current today) deadline)
  5999. ((not org-agenda-show-future-repeats) deadline)
  6000. (t
  6001. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  6002. (1+ today)
  6003. current)))
  6004. (org-agenda--timestamp-to-absolute
  6005. s base 'future (current-buffer) pos)))))
  6006. (diff (- deadline current))
  6007. (suppress-prewarning
  6008. (let ((scheduled
  6009. (and org-agenda-skip-deadline-prewarning-if-scheduled
  6010. (org-entry-get nil "SCHEDULED"))))
  6011. (cond
  6012. ((not scheduled) nil)
  6013. ;; The current item has a scheduled date, so
  6014. ;; evaluate its prewarning lead time.
  6015. ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
  6016. ;; Use global prewarning-restart lead time.
  6017. org-agenda-skip-deadline-prewarning-if-scheduled)
  6018. ((eq org-agenda-skip-deadline-prewarning-if-scheduled
  6019. 'pre-scheduled)
  6020. ;; Set pre-warning to no earlier than SCHEDULED.
  6021. (min (- deadline
  6022. (org-agenda--timestamp-to-absolute scheduled))
  6023. org-deadline-warning-days))
  6024. ;; Set pre-warning to deadline.
  6025. (t 0))))
  6026. (wdays (or suppress-prewarning (org-get-wdays s))))
  6027. (cond
  6028. ;; Only display deadlines at their base date, at future
  6029. ;; repeat occurrences or in today agenda.
  6030. ((= current deadline) nil)
  6031. ((= current repeat) nil)
  6032. ((not today?) (throw :skip nil))
  6033. ;; Upcoming deadline: display within warning period WDAYS.
  6034. ((> deadline current) (when (> diff wdays) (throw :skip nil)))
  6035. ;; Overdue deadline: warn about it for
  6036. ;; `org-deadline-past-days' duration.
  6037. (t (when (< org-deadline-past-days (- diff)) (throw :skip nil))))
  6038. ;; Possibly skip done tasks.
  6039. (when (and done?
  6040. (or org-agenda-skip-deadline-if-done
  6041. (/= deadline current)))
  6042. (throw :skip nil))
  6043. (save-excursion
  6044. (re-search-backward "^\\*+[ \t]+" nil t)
  6045. (goto-char (match-end 0))
  6046. (let* ((category (org-get-category))
  6047. (effort (save-match-data (or (get-text-property (point) 'effort)
  6048. (org-entry-get (point) org-effort-property))))
  6049. (effort-minutes (when effort (save-match-data (org-duration-to-minutes effort))))
  6050. (level (make-string (org-reduced-level (org-outline-level))
  6051. ?\s))
  6052. (head (buffer-substring-no-properties
  6053. (point) (line-end-position)))
  6054. (inherited-tags
  6055. (or (eq org-agenda-show-inherited-tags 'always)
  6056. (and (listp org-agenda-show-inherited-tags)
  6057. (memq 'agenda org-agenda-show-inherited-tags))
  6058. (and (eq org-agenda-show-inherited-tags t)
  6059. (or (eq org-agenda-use-tag-inheritance t)
  6060. (memq 'agenda
  6061. org-agenda-use-tag-inheritance)))))
  6062. (tags (org-get-tags nil (not inherited-tags)))
  6063. (time
  6064. (cond
  6065. ;; No time of day designation if it is only
  6066. ;; a reminder.
  6067. ((and (/= current deadline) (/= current repeat)) nil)
  6068. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  6069. (concat (substring s (match-beginning 1)) " "))
  6070. (t 'time)))
  6071. (item
  6072. (org-agenda-format-item
  6073. ;; Insert appropriate suffixes before deadlines.
  6074. ;; Those only apply to today agenda.
  6075. (pcase-let ((`(,now ,future ,past)
  6076. org-agenda-deadline-leaders))
  6077. (cond
  6078. ((and today? (< deadline today)) (format past (- diff)))
  6079. ((and today? (> deadline today)) (format future diff))
  6080. (t now)))
  6081. (org-add-props head nil
  6082. 'effort effort
  6083. 'effort-minutes effort-minutes)
  6084. level category tags time))
  6085. (face (org-agenda-deadline-face
  6086. (- 1 (/ (float diff) (max wdays 1)))))
  6087. (upcoming? (and today? (> deadline today)))
  6088. (warntime (get-text-property (point) 'org-appt-warntime)))
  6089. (org-add-props item props
  6090. 'org-marker (org-agenda-new-marker pos)
  6091. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  6092. 'warntime warntime
  6093. 'level level
  6094. 'effort effort 'effort-minutes effort-minutes
  6095. 'ts-date deadline
  6096. 'priority
  6097. ;; Adjust priority to today reminders about deadlines.
  6098. ;; Overdue deadlines get the highest priority
  6099. ;; increase, then imminent deadlines and eventually
  6100. ;; more distant deadlines.
  6101. (let ((adjust (if today? (- diff) 0)))
  6102. (+ adjust (org-get-priority item)))
  6103. 'todo-state todo-state
  6104. 'type (if upcoming? "upcoming-deadline" "deadline")
  6105. 'date (if upcoming? date deadline)
  6106. 'face (if done? 'org-agenda-done face)
  6107. 'undone-face face
  6108. 'done-face 'org-agenda-done)
  6109. (push item deadline-items)))))))
  6110. (nreverse deadline-items)))
  6111. (defun org-agenda-deadline-face (fraction)
  6112. "Return the face to displaying a deadline item.
  6113. FRACTION is what fraction of the head-warning time has passed."
  6114. (assoc-default fraction org-agenda-deadline-faces #'<=))
  6115. (defun org-agenda-get-scheduled (&optional deadlines with-hour)
  6116. "Return the scheduled information for agenda display.
  6117. Optional argument DEADLINES is a list of deadline items to be
  6118. displayed in agenda view. When WITH-HOUR is non-nil, only return
  6119. scheduled items with an hour specification like [h]h:mm."
  6120. (with-no-warnings (defvar date))
  6121. (let* ((props (list 'org-not-done-regexp org-not-done-regexp
  6122. 'org-todo-regexp org-todo-regexp
  6123. 'org-complex-heading-regexp org-complex-heading-regexp
  6124. 'done-face 'org-agenda-done
  6125. 'mouse-face 'highlight
  6126. 'help-echo
  6127. (format "mouse-2 or RET jump to Org file %s"
  6128. (abbreviate-file-name buffer-file-name))))
  6129. (regexp (if with-hour
  6130. org-scheduled-time-hour-regexp
  6131. org-scheduled-time-regexp))
  6132. (today (org-today))
  6133. (todayp (org-agenda-today-p date)) ; DATE bound by calendar.
  6134. (current (calendar-absolute-from-gregorian date))
  6135. (deadline-pos
  6136. (mapcar (lambda (d)
  6137. (let ((m (get-text-property 0 'org-hd-marker d)))
  6138. (and m (marker-position m))))
  6139. deadlines))
  6140. scheduled-items)
  6141. (goto-char (point-min))
  6142. (if (org-element--cache-active-p)
  6143. (org-element-cache-map
  6144. (lambda (el)
  6145. (when (and (org-element-property :scheduled el)
  6146. (or (not with-hour)
  6147. (org-element-property
  6148. :hour-start
  6149. (org-element-property :scheduled el))
  6150. (org-element-property
  6151. :hour-end
  6152. (org-element-property :scheduled el))))
  6153. (goto-char (org-element-property :contents-begin el))
  6154. (catch :skip
  6155. (org-agenda-skip el)
  6156. (let* ((s (substring (org-element-property
  6157. :raw-value
  6158. (org-element-property :scheduled el))
  6159. 1 -1))
  6160. (pos (save-excursion
  6161. (goto-char (org-element-property :contents-begin el))
  6162. ;; We intentionally leave NOERROR
  6163. ;; argument in `re-search-forward' nil. If
  6164. ;; the search fails here, something went
  6165. ;; wrong and we are looking at
  6166. ;; non-matching headline.
  6167. (re-search-forward regexp (line-end-position))
  6168. (1- (match-beginning 1))))
  6169. (todo-state (org-element-property :todo-keyword el))
  6170. (donep (eq 'done (org-element-property :todo-type el)))
  6171. (sexp? (eq 'diary
  6172. (org-element-property
  6173. :type (org-element-property :scheduled el))))
  6174. ;; SCHEDULE is the scheduled date for the entry. It is
  6175. ;; either the bare date or the last repeat, according
  6176. ;; to `org-agenda-prefer-last-repeat'.
  6177. (schedule
  6178. (cond
  6179. (sexp? (org-agenda--timestamp-to-absolute s current))
  6180. ((or (eq org-agenda-prefer-last-repeat t)
  6181. (member todo-state org-agenda-prefer-last-repeat))
  6182. (org-agenda--timestamp-to-absolute
  6183. s today 'past (current-buffer) pos))
  6184. (t (org-agenda--timestamp-to-absolute s))))
  6185. ;; REPEAT is the future repeat closest from CURRENT,
  6186. ;; according to `org-agenda-show-future-repeats'. If
  6187. ;; the latter is nil, or if the time stamp has no
  6188. ;; repeat part, default to SCHEDULE.
  6189. (repeat
  6190. (cond
  6191. (sexp? schedule)
  6192. ((<= current today) schedule)
  6193. ((not org-agenda-show-future-repeats) schedule)
  6194. (t
  6195. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  6196. (1+ today)
  6197. current)))
  6198. (org-agenda--timestamp-to-absolute
  6199. s base 'future (current-buffer) pos)))))
  6200. (diff (- current schedule))
  6201. (warntime (get-text-property (point) 'org-appt-warntime))
  6202. (pastschedp (< schedule today))
  6203. (futureschedp (> schedule today))
  6204. (habitp (and (fboundp 'org-is-habit-p)
  6205. (string= "habit" (org-element-property :STYLE el))))
  6206. (suppress-delay
  6207. (let ((deadline (and org-agenda-skip-scheduled-delay-if-deadline
  6208. (org-element-property
  6209. :raw-value
  6210. (org-element-property :deadline el)))))
  6211. (cond
  6212. ((not deadline) nil)
  6213. ;; The current item has a deadline date, so
  6214. ;; evaluate its delay time.
  6215. ((integerp org-agenda-skip-scheduled-delay-if-deadline)
  6216. ;; Use global delay time.
  6217. (- org-agenda-skip-scheduled-delay-if-deadline))
  6218. ((eq org-agenda-skip-scheduled-delay-if-deadline
  6219. 'post-deadline)
  6220. ;; Set delay to no later than DEADLINE.
  6221. (min (- schedule
  6222. (org-agenda--timestamp-to-absolute deadline))
  6223. org-scheduled-delay-days))
  6224. (t 0))))
  6225. (ddays
  6226. (cond
  6227. ;; Nullify delay when a repeater triggered already
  6228. ;; and the delay is of the form --Xd.
  6229. ((and (string-match-p "--[0-9]+[hdwmy]" s)
  6230. (> schedule (org-agenda--timestamp-to-absolute s)))
  6231. 0)
  6232. (suppress-delay
  6233. (let ((org-scheduled-delay-days suppress-delay))
  6234. (org-get-wdays s t t)))
  6235. (t (org-get-wdays s t)))))
  6236. ;; Display scheduled items at base date (SCHEDULE), today if
  6237. ;; scheduled before the current date, and at any repeat past
  6238. ;; today. However, skip delayed items and items that have
  6239. ;; been displayed for more than `org-scheduled-past-days'.
  6240. (unless (and todayp
  6241. habitp
  6242. (bound-and-true-p org-habit-show-all-today))
  6243. (when (or (and (> ddays 0) (< diff ddays))
  6244. (> diff (or (and habitp org-habit-scheduled-past-days)
  6245. org-scheduled-past-days))
  6246. (> schedule current)
  6247. (and (/= current schedule)
  6248. (/= current today)
  6249. (/= current repeat)))
  6250. (throw :skip nil)))
  6251. ;; Possibly skip done tasks.
  6252. (when (and donep
  6253. (or org-agenda-skip-scheduled-if-done
  6254. (/= schedule current)))
  6255. (throw :skip nil))
  6256. ;; Skip entry if it already appears as a deadline, per
  6257. ;; `org-agenda-skip-scheduled-if-deadline-is-shown'. This
  6258. ;; doesn't apply to habits.
  6259. (when (pcase org-agenda-skip-scheduled-if-deadline-is-shown
  6260. ((guard
  6261. (or (not (memq (line-beginning-position 0) deadline-pos))
  6262. habitp))
  6263. nil)
  6264. (`repeated-after-deadline
  6265. (let ((deadline (time-to-days
  6266. (when (org-element-property :deadline el)
  6267. (org-time-string-to-time
  6268. (org-element-property :deadline el))))))
  6269. (and (<= schedule deadline) (> current deadline))))
  6270. (`not-today pastschedp)
  6271. (`t t)
  6272. (_ nil))
  6273. (throw :skip nil))
  6274. ;; Skip habits if `org-habit-show-habits' is nil, or if we
  6275. ;; only show them for today. Also skip done habits.
  6276. (when (and habitp
  6277. (or donep
  6278. (not (bound-and-true-p org-habit-show-habits))
  6279. (and (not todayp)
  6280. (bound-and-true-p
  6281. org-habit-show-habits-only-for-today))))
  6282. (throw :skip nil))
  6283. (save-excursion
  6284. (goto-char (org-element-property :begin el))
  6285. (let* ((category (org-get-category))
  6286. (effort (save-match-data
  6287. (or (get-text-property (point) 'effort)
  6288. (org-element-property (intern (concat ":" (upcase org-effort-property))) el))))
  6289. (effort-minutes (when effort (save-match-data (org-duration-to-minutes effort))))
  6290. (inherited-tags
  6291. (or (eq org-agenda-show-inherited-tags 'always)
  6292. (and (listp org-agenda-show-inherited-tags)
  6293. (memq 'agenda org-agenda-show-inherited-tags))
  6294. (and (eq org-agenda-show-inherited-tags t)
  6295. (or (eq org-agenda-use-tag-inheritance t)
  6296. (memq 'agenda
  6297. org-agenda-use-tag-inheritance)))))
  6298. (tags (org-get-tags el (not inherited-tags)))
  6299. (level (make-string (org-element-property :level el)
  6300. ?\s))
  6301. (head (save-excursion
  6302. (goto-char (org-element-property :begin el))
  6303. (re-search-forward org-outline-regexp-bol)
  6304. (buffer-substring (point) (line-end-position))))
  6305. (time
  6306. (cond
  6307. ;; No time of day designation if it is only a
  6308. ;; reminder, except for habits, which always show
  6309. ;; the time of day. Habits are an exception
  6310. ;; because if there is a time of day, that is
  6311. ;; interpreted to mean they should usually happen
  6312. ;; then, even if doing the habit was missed.
  6313. ((and
  6314. (not habitp)
  6315. (/= current schedule)
  6316. (/= current repeat))
  6317. nil)
  6318. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  6319. (concat (substring s (match-beginning 1)) " "))
  6320. (t 'time)))
  6321. (item
  6322. (org-agenda-format-item
  6323. (pcase-let ((`(,first ,past) org-agenda-scheduled-leaders))
  6324. ;; Show a reminder of a past scheduled today.
  6325. (if (and todayp pastschedp)
  6326. (format past diff)
  6327. first))
  6328. (org-add-props head nil
  6329. 'effort effort
  6330. 'effort-minutes effort-minutes)
  6331. level category tags time nil habitp))
  6332. (face (cond ((and (not habitp) pastschedp)
  6333. 'org-scheduled-previously)
  6334. ((and habitp futureschedp)
  6335. 'org-agenda-done)
  6336. (todayp 'org-scheduled-today)
  6337. (t 'org-scheduled)))
  6338. (habitp (and habitp (org-habit-parse-todo (org-element-property :begin el)))))
  6339. (org-add-props item props
  6340. 'undone-face face
  6341. 'face (if donep 'org-agenda-done face)
  6342. 'org-marker (org-agenda-new-marker pos)
  6343. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  6344. 'type (if pastschedp "past-scheduled" "scheduled")
  6345. 'date (if pastschedp schedule date)
  6346. 'ts-date schedule
  6347. 'warntime warntime
  6348. 'level level
  6349. 'effort effort 'effort-minutes effort-minutes
  6350. 'priority (if habitp (org-habit-get-priority habitp)
  6351. (+ 99 diff (org-get-priority item)))
  6352. 'org-habit-p habitp
  6353. 'todo-state todo-state)
  6354. (push item scheduled-items)))))))
  6355. :next-re regexp
  6356. :fail-re regexp
  6357. :narrow t)
  6358. (while (re-search-forward regexp nil t)
  6359. (catch :skip
  6360. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  6361. (org-agenda-skip)
  6362. (let* ((s (match-string 1))
  6363. (pos (1- (match-beginning 1)))
  6364. (todo-state (save-match-data (org-get-todo-state)))
  6365. (donep (member todo-state org-done-keywords))
  6366. (sexp? (string-prefix-p "%%" s))
  6367. ;; SCHEDULE is the scheduled date for the entry. It is
  6368. ;; either the bare date or the last repeat, according
  6369. ;; to `org-agenda-prefer-last-repeat'.
  6370. (schedule
  6371. (cond
  6372. (sexp? (org-agenda--timestamp-to-absolute s current))
  6373. ((or (eq org-agenda-prefer-last-repeat t)
  6374. (member todo-state org-agenda-prefer-last-repeat))
  6375. (org-agenda--timestamp-to-absolute
  6376. s today 'past (current-buffer) pos))
  6377. (t (org-agenda--timestamp-to-absolute s))))
  6378. ;; REPEAT is the future repeat closest from CURRENT,
  6379. ;; according to `org-agenda-show-future-repeats'. If
  6380. ;; the latter is nil, or if the time stamp has no
  6381. ;; repeat part, default to SCHEDULE.
  6382. (repeat
  6383. (cond
  6384. (sexp? schedule)
  6385. ((<= current today) schedule)
  6386. ((not org-agenda-show-future-repeats) schedule)
  6387. (t
  6388. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  6389. (1+ today)
  6390. current)))
  6391. (org-agenda--timestamp-to-absolute
  6392. s base 'future (current-buffer) pos)))))
  6393. (diff (- current schedule))
  6394. (warntime (get-text-property (point) 'org-appt-warntime))
  6395. (pastschedp (< schedule today))
  6396. (futureschedp (> schedule today))
  6397. (habitp (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  6398. (suppress-delay
  6399. (let ((deadline (and org-agenda-skip-scheduled-delay-if-deadline
  6400. (org-entry-get nil "DEADLINE"))))
  6401. (cond
  6402. ((not deadline) nil)
  6403. ;; The current item has a deadline date, so
  6404. ;; evaluate its delay time.
  6405. ((integerp org-agenda-skip-scheduled-delay-if-deadline)
  6406. ;; Use global delay time.
  6407. (- org-agenda-skip-scheduled-delay-if-deadline))
  6408. ((eq org-agenda-skip-scheduled-delay-if-deadline
  6409. 'post-deadline)
  6410. ;; Set delay to no later than DEADLINE.
  6411. (min (- schedule
  6412. (org-agenda--timestamp-to-absolute deadline))
  6413. org-scheduled-delay-days))
  6414. (t 0))))
  6415. (ddays
  6416. (cond
  6417. ;; Nullify delay when a repeater triggered already
  6418. ;; and the delay is of the form --Xd.
  6419. ((and (string-match-p "--[0-9]+[hdwmy]" s)
  6420. (> schedule (org-agenda--timestamp-to-absolute s)))
  6421. 0)
  6422. (suppress-delay
  6423. (let ((org-scheduled-delay-days suppress-delay))
  6424. (org-get-wdays s t t)))
  6425. (t (org-get-wdays s t)))))
  6426. ;; Display scheduled items at base date (SCHEDULE), today if
  6427. ;; scheduled before the current date, and at any repeat past
  6428. ;; today. However, skip delayed items and items that have
  6429. ;; been displayed for more than `org-scheduled-past-days'.
  6430. (unless (and todayp
  6431. habitp
  6432. (bound-and-true-p org-habit-show-all-today))
  6433. (when (or (and (> ddays 0) (< diff ddays))
  6434. (> diff (or (and habitp org-habit-scheduled-past-days)
  6435. org-scheduled-past-days))
  6436. (> schedule current)
  6437. (and (/= current schedule)
  6438. (/= current today)
  6439. (/= current repeat)))
  6440. (throw :skip nil)))
  6441. ;; Possibly skip done tasks.
  6442. (when (and donep
  6443. (or org-agenda-skip-scheduled-if-done
  6444. (/= schedule current)))
  6445. (throw :skip nil))
  6446. ;; Skip entry if it already appears as a deadline, per
  6447. ;; `org-agenda-skip-scheduled-if-deadline-is-shown'. This
  6448. ;; doesn't apply to habits.
  6449. (when (pcase org-agenda-skip-scheduled-if-deadline-is-shown
  6450. ((guard
  6451. (or (not (memq (line-beginning-position 0) deadline-pos))
  6452. habitp))
  6453. nil)
  6454. (`repeated-after-deadline
  6455. (let ((deadline (time-to-days
  6456. (org-get-deadline-time (point)))))
  6457. (and (<= schedule deadline) (> current deadline))))
  6458. (`not-today pastschedp)
  6459. (`t t)
  6460. (_ nil))
  6461. (throw :skip nil))
  6462. ;; Skip habits if `org-habit-show-habits' is nil, or if we
  6463. ;; only show them for today. Also skip done habits.
  6464. (when (and habitp
  6465. (or donep
  6466. (not (bound-and-true-p org-habit-show-habits))
  6467. (and (not todayp)
  6468. (bound-and-true-p
  6469. org-habit-show-habits-only-for-today))))
  6470. (throw :skip nil))
  6471. (save-excursion
  6472. (re-search-backward "^\\*+[ \t]+" nil t)
  6473. (goto-char (match-end 0))
  6474. (let* ((category (org-get-category))
  6475. (effort (save-match-data (or (get-text-property (point) 'effort)
  6476. (org-entry-get (point) org-effort-property))))
  6477. (effort-minutes (when effort (save-match-data (org-duration-to-minutes effort))))
  6478. (inherited-tags
  6479. (or (eq org-agenda-show-inherited-tags 'always)
  6480. (and (listp org-agenda-show-inherited-tags)
  6481. (memq 'agenda org-agenda-show-inherited-tags))
  6482. (and (eq org-agenda-show-inherited-tags t)
  6483. (or (eq org-agenda-use-tag-inheritance t)
  6484. (memq 'agenda
  6485. org-agenda-use-tag-inheritance)))))
  6486. (tags (org-get-tags nil (not inherited-tags)))
  6487. (level (make-string (org-reduced-level (org-outline-level))
  6488. ?\s))
  6489. (head (buffer-substring (point) (line-end-position)))
  6490. (time
  6491. (cond
  6492. ;; No time of day designation if it is only a
  6493. ;; reminder, except for habits, which always show
  6494. ;; the time of day. Habits are an exception
  6495. ;; because if there is a time of day, that is
  6496. ;; interpreted to mean they should usually happen
  6497. ;; then, even if doing the habit was missed.
  6498. ((and
  6499. (not habitp)
  6500. (/= current schedule)
  6501. (/= current repeat))
  6502. nil)
  6503. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  6504. (concat (substring s (match-beginning 1)) " "))
  6505. (t 'time)))
  6506. (item
  6507. (org-agenda-format-item
  6508. (pcase-let ((`(,first ,past) org-agenda-scheduled-leaders))
  6509. ;; Show a reminder of a past scheduled today.
  6510. (if (and todayp pastschedp)
  6511. (format past diff)
  6512. first))
  6513. (org-add-props head nil
  6514. 'effort effort
  6515. 'effort-minutes effort-minutes)
  6516. level category tags time nil habitp))
  6517. (face (cond ((and (not habitp) pastschedp)
  6518. 'org-scheduled-previously)
  6519. ((and habitp futureschedp)
  6520. 'org-agenda-done)
  6521. (todayp 'org-scheduled-today)
  6522. (t 'org-scheduled)))
  6523. (habitp (and habitp (org-habit-parse-todo))))
  6524. (org-add-props item props
  6525. 'undone-face face
  6526. 'face (if donep 'org-agenda-done face)
  6527. 'org-marker (org-agenda-new-marker pos)
  6528. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  6529. 'type (if pastschedp "past-scheduled" "scheduled")
  6530. 'date (if pastschedp schedule date)
  6531. 'ts-date schedule
  6532. 'warntime warntime
  6533. 'level level
  6534. 'effort effort 'effort-minutes effort-minutes
  6535. 'priority (if habitp (org-habit-get-priority habitp)
  6536. (+ 99 diff (org-get-priority item)))
  6537. 'org-habit-p habitp
  6538. 'todo-state todo-state)
  6539. (push item scheduled-items)))))))
  6540. (nreverse scheduled-items)))
  6541. (defun org-agenda-get-blocks ()
  6542. "Return the date-range information for agenda display."
  6543. (with-no-warnings (defvar date))
  6544. (let* ((props (list 'face nil
  6545. 'org-not-done-regexp org-not-done-regexp
  6546. 'org-todo-regexp org-todo-regexp
  6547. 'org-complex-heading-regexp org-complex-heading-regexp
  6548. 'mouse-face 'highlight
  6549. 'help-echo
  6550. (format "mouse-2 or RET jump to org file %s"
  6551. (abbreviate-file-name buffer-file-name))))
  6552. (regexp org-tr-regexp)
  6553. (d0 (calendar-absolute-from-gregorian date))
  6554. marker hdmarker ee txt d1 d2 s1 s2 category
  6555. level todo-state tags pos head donep inherited-tags
  6556. effort effort-minutes)
  6557. (goto-char (point-min))
  6558. (while (re-search-forward regexp nil t)
  6559. (catch :skip
  6560. (org-agenda-skip)
  6561. (setq pos (point))
  6562. (let ((start-time (match-string 1))
  6563. (end-time (match-string 2)))
  6564. (setq s1 (match-string 1)
  6565. s2 (match-string 2)
  6566. d1 (time-to-days
  6567. (condition-case err
  6568. (org-time-string-to-time s1)
  6569. (error
  6570. (error
  6571. "Bad timestamp %S at %d in buffer %S\nError was: %s"
  6572. s1
  6573. pos
  6574. (current-buffer)
  6575. (error-message-string err)))))
  6576. d2 (time-to-days
  6577. (condition-case err
  6578. (org-time-string-to-time s2)
  6579. (error
  6580. (error
  6581. "Bad timestamp %S at %d in buffer %S\nError was: %s"
  6582. s2
  6583. pos
  6584. (current-buffer)
  6585. (error-message-string err))))))
  6586. (when (and (> (- d0 d1) -1) (> (- d2 d0) -1))
  6587. ;; Only allow days between the limits, because the normal
  6588. ;; date stamps will catch the limits.
  6589. (save-excursion
  6590. (setq todo-state (org-get-todo-state))
  6591. (setq donep (member todo-state org-done-keywords))
  6592. (when (and donep org-agenda-skip-timestamp-if-done)
  6593. (throw :skip t))
  6594. (setq marker (org-agenda-new-marker (point))
  6595. category (org-get-category))
  6596. (setq effort (save-match-data (or (get-text-property (point) 'effort)
  6597. (org-entry-get (point) org-effort-property))))
  6598. (setq effort-minutes (when effort (save-match-data (org-duration-to-minutes effort))))
  6599. (if (not (re-search-backward org-outline-regexp-bol nil t))
  6600. (throw :skip nil)
  6601. (goto-char (match-beginning 0))
  6602. (setq hdmarker (org-agenda-new-marker (point))
  6603. inherited-tags
  6604. (or (eq org-agenda-show-inherited-tags 'always)
  6605. (and (listp org-agenda-show-inherited-tags)
  6606. (memq 'agenda org-agenda-show-inherited-tags))
  6607. (and (eq org-agenda-show-inherited-tags t)
  6608. (or (eq org-agenda-use-tag-inheritance t)
  6609. (memq 'agenda org-agenda-use-tag-inheritance))))
  6610. tags (org-get-tags nil (not inherited-tags)))
  6611. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  6612. (looking-at "\\*+[ \t]+\\(.*\\)")
  6613. (setq head (match-string 1))
  6614. (let ((remove-re
  6615. (if org-agenda-remove-timeranges-from-blocks
  6616. (concat
  6617. "<" (regexp-quote s1) ".*?>"
  6618. "--"
  6619. "<" (regexp-quote s2) ".*?>")
  6620. nil)))
  6621. (setq txt (org-agenda-format-item
  6622. (format
  6623. (nth (if (= d1 d2) 0 1)
  6624. org-agenda-timerange-leaders)
  6625. (1+ (- d0 d1)) (1+ (- d2 d1)))
  6626. (org-add-props head nil
  6627. 'effort effort
  6628. 'effort-minutes effort-minutes)
  6629. level category tags
  6630. (save-match-data
  6631. (let ((hhmm1 (and (string-match org-ts-regexp1 s1)
  6632. (match-string 6 s1)))
  6633. (hhmm2 (and (string-match org-ts-regexp1 s2)
  6634. (match-string 6 s2))))
  6635. (cond ((string= hhmm1 hhmm2)
  6636. (concat "<" start-time ">--<" end-time ">"))
  6637. ((and (= d1 d0) (= d2 d0))
  6638. (concat "<" start-time ">--<" end-time ">"))
  6639. ((= d1 d0)
  6640. (concat "<" start-time ">"))
  6641. ((= d2 d0)
  6642. (concat "<" end-time ">")))))
  6643. remove-re))))
  6644. (org-add-props txt props
  6645. 'org-marker marker 'org-hd-marker hdmarker
  6646. 'type "block" 'date date
  6647. 'level level
  6648. 'effort effort 'effort-minutes effort-minutes
  6649. 'todo-state todo-state
  6650. 'priority (org-get-priority txt))
  6651. (push txt ee))))
  6652. (goto-char pos)))
  6653. ;; Sort the entries by expiration date.
  6654. (nreverse ee)))
  6655. ;;; Agenda presentation and sorting
  6656. (defvar org-prefix-has-time nil
  6657. "A flag, set by `org-compile-prefix-format'.
  6658. The flag is set if the currently compiled format contains a `%t'.")
  6659. (defvar org-prefix-has-tag nil
  6660. "A flag, set by `org-compile-prefix-format'.
  6661. The flag is set if the currently compiled format contains a `%T'.")
  6662. (defvar org-prefix-has-effort nil
  6663. "A flag, set by `org-compile-prefix-format'.
  6664. The flag is set if the currently compiled format contains a `%e'.")
  6665. (defvar org-prefix-has-breadcrumbs nil
  6666. "A flag, set by `org-compile-prefix-format'.
  6667. The flag is set if the currently compiled format contains a `%b'.")
  6668. (defvar org-prefix-category-length nil
  6669. "Used by `org-compile-prefix-format' to remember the category field width.")
  6670. (defvar org-prefix-category-max-length nil
  6671. "Used by `org-compile-prefix-format' to remember the category field width.")
  6672. (defun org-agenda-get-category-icon (category)
  6673. "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
  6674. (cl-dolist (entry org-agenda-category-icon-alist)
  6675. (when (string-match-p (car entry) category)
  6676. (if (listp (cadr entry))
  6677. (cl-return (cadr entry))
  6678. (cl-return (apply #'create-image (cdr entry)))))))
  6679. (defun org-agenda-format-item (extra txt &optional with-level with-category tags dotime
  6680. remove-re habitp)
  6681. "Format TXT to be inserted into the agenda buffer.
  6682. In particular, add the prefix and corresponding text properties.
  6683. EXTRA must be a string to replace the `%s' specifier in the prefix format.
  6684. WITH-LEVEL may be a string to replace the `%l' specifier.
  6685. WITH-CATEGORY (a string, a symbol or nil) may be used to overrule the default
  6686. category taken from local variable or file name. It will replace the `%c'
  6687. specifier in the format.
  6688. DOTIME, when non-nil, indicates that a time-of-day should be extracted from
  6689. TXT for sorting of this entry, and for the `%t' specifier in the format.
  6690. When DOTIME is a string, this string is searched for a time before TXT is.
  6691. TAGS can be the tags of the headline.
  6692. Any match of REMOVE-RE will be removed from TXT."
  6693. ;; We keep the org-prefix-* variable values along with a compiled
  6694. ;; formatter, so that multiple agendas existing at the same time do
  6695. ;; not step on each other toes.
  6696. ;;
  6697. ;; It was inconvenient to make these variables buffer local in
  6698. ;; Agenda buffers, because this function expects to be called with
  6699. ;; the buffer where item comes from being current, and not agenda
  6700. ;; buffer
  6701. (let* ((bindings (car org-prefix-format-compiled))
  6702. (formatter (cadr org-prefix-format-compiled)))
  6703. (cl-loop for (var value) in bindings
  6704. do (set var value))
  6705. (save-match-data
  6706. ;; Diary entries sometimes have extra whitespace at the beginning
  6707. (setq txt (org-trim txt))
  6708. ;; Fix the tags part in txt
  6709. (setq txt (org-agenda-fix-displayed-tags
  6710. txt tags
  6711. org-agenda-show-inherited-tags
  6712. org-agenda-hide-tags-regexp))
  6713. (with-no-warnings
  6714. ;; `time', `tag', `effort' are needed for the eval of the prefix format.
  6715. ;; Based on what I see in `org-compile-prefix-format', I added
  6716. ;; a few more.
  6717. (defvar breadcrumbs) (defvar category) (defvar category-icon)
  6718. (defvar effort) (defvar extra)
  6719. (defvar level) (defvar tag) (defvar time))
  6720. (let* ((category (or with-category
  6721. (if buffer-file-name
  6722. (file-name-sans-extension
  6723. (file-name-nondirectory buffer-file-name))
  6724. "")))
  6725. (category-icon (org-agenda-get-category-icon category))
  6726. (category-icon (if category-icon
  6727. (propertize " " 'display category-icon)
  6728. ""))
  6729. (effort (and (not (string= txt ""))
  6730. (get-text-property 1 'effort txt)))
  6731. (tag (if tags (nth (1- (length tags)) tags) ""))
  6732. (time-grid-trailing-characters (nth 2 org-agenda-time-grid))
  6733. (extra (or (and (not habitp) extra) ""))
  6734. time
  6735. (ts (when dotime (concat
  6736. (if (stringp dotime) dotime "")
  6737. (and org-agenda-search-headline-for-time txt))))
  6738. (time-of-day (and dotime (org-get-time-of-day ts)))
  6739. stamp plain s0 s1 s2 rtn srp l
  6740. duration breadcrumbs)
  6741. (and (derived-mode-p 'org-mode) buffer-file-name
  6742. (add-to-list 'org-agenda-contributing-files buffer-file-name))
  6743. (when (and dotime time-of-day)
  6744. ;; Extract starting and ending time and move them to prefix
  6745. (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
  6746. (setq plain (string-match org-plain-time-of-day-regexp ts)))
  6747. (setq s0 (match-string 0 ts)
  6748. srp (and stamp (match-end 3))
  6749. s1 (match-string (if plain 1 2) ts)
  6750. s2 (match-string (if plain 8 (if srp 4 6)) ts))
  6751. ;; If the times are in TXT (not in DOTIMES), and the prefix will list
  6752. ;; them, we might want to remove them there to avoid duplication.
  6753. ;; The user can turn this off with a variable.
  6754. (when (and org-prefix-has-time
  6755. org-agenda-remove-times-when-in-prefix (or stamp plain)
  6756. (string-match (concat (regexp-quote s0) " *") txt)
  6757. (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
  6758. (if (eq org-agenda-remove-times-when-in-prefix 'beg)
  6759. (= (match-beginning 0) 0)
  6760. t))
  6761. (setq txt (replace-match "" nil nil txt))))
  6762. ;; Normalize the time(s) to 24 hour.
  6763. (when s1 (setq s1 (org-get-time-of-day s1 t)))
  6764. (when s2 (setq s2 (org-get-time-of-day s2 t)))
  6765. ;; Try to set s2 if s1 and
  6766. ;; `org-agenda-default-appointment-duration' are set
  6767. (when (and s1 (not s2) org-agenda-default-appointment-duration)
  6768. (setq s2
  6769. (org-duration-from-minutes
  6770. (+ (org-duration-to-minutes s1 t)
  6771. org-agenda-default-appointment-duration)
  6772. nil t)))
  6773. ;; Compute the duration
  6774. (when s2
  6775. (setq duration (- (org-duration-to-minutes s2)
  6776. (org-duration-to-minutes s1))))
  6777. ;; Format S1 and S2 for display.
  6778. (when s1 (setq s1 (format "%5s" (org-get-time-of-day s1 'overtime))))
  6779. (when s2 (setq s2 (org-get-time-of-day s2 'overtime))))
  6780. (when (string-match org-tag-group-re txt)
  6781. ;; Tags are in the string
  6782. (if (or (eq org-agenda-remove-tags t)
  6783. (and org-agenda-remove-tags
  6784. org-prefix-has-tag))
  6785. (setq txt (replace-match "" t t txt))
  6786. (setq txt (replace-match
  6787. (concat (make-string (max (- 50 (length txt)) 1) ?\ )
  6788. (match-string 1 txt))
  6789. t t txt))))
  6790. (when remove-re
  6791. (while (string-match remove-re txt)
  6792. (setq txt (replace-match "" t t txt))))
  6793. ;; Set org-heading property on `txt' to mark the start of the
  6794. ;; heading.
  6795. (add-text-properties 0 (length txt) '(org-heading t) txt)
  6796. ;; Prepare the variables needed in the eval of the compiled format
  6797. (when org-prefix-has-breadcrumbs
  6798. (setq breadcrumbs (org-with-point-at (org-get-at-bol 'org-marker)
  6799. (let ((s (org-format-outline-path (org-get-outline-path)
  6800. (1- (frame-width))
  6801. nil org-agenda-breadcrumbs-separator)))
  6802. (if (eq "" s) "" (concat s org-agenda-breadcrumbs-separator))))))
  6803. (setq time (cond (s2 (concat
  6804. (org-agenda-time-of-day-to-ampm-maybe s1)
  6805. "-" (org-agenda-time-of-day-to-ampm-maybe s2)
  6806. (when org-agenda-timegrid-use-ampm " ")))
  6807. (s1 (concat
  6808. (org-agenda-time-of-day-to-ampm-maybe s1)
  6809. (if org-agenda-timegrid-use-ampm
  6810. (concat time-grid-trailing-characters " ")
  6811. time-grid-trailing-characters)))
  6812. (t ""))
  6813. category (if (symbolp category) (symbol-name category) category)
  6814. level (or with-level ""))
  6815. (if (string-match org-link-bracket-re category)
  6816. (progn
  6817. (setq l (string-width (or (match-string 2) (match-string 1))))
  6818. (when (< l (or org-prefix-category-length 0))
  6819. (setq category (copy-sequence category))
  6820. (org-add-props category nil
  6821. 'extra-space (make-string
  6822. (- org-prefix-category-length l 1) ?\ ))))
  6823. (when (and org-prefix-category-max-length
  6824. (>= (length category) org-prefix-category-max-length))
  6825. (setq category (substring category 0 (1- org-prefix-category-max-length)))))
  6826. ;; Evaluate the compiled format
  6827. (setq rtn (concat (eval formatter t) txt))
  6828. ;; And finally add the text properties
  6829. (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
  6830. (org-add-props rtn nil
  6831. 'org-category category
  6832. 'tags tags
  6833. 'org-priority-highest org-priority-highest
  6834. 'org-priority-lowest org-priority-lowest
  6835. 'time-of-day time-of-day
  6836. 'duration duration
  6837. 'breadcrumbs breadcrumbs
  6838. 'txt txt
  6839. 'level level
  6840. 'time time
  6841. 'extra extra
  6842. 'format org-prefix-format-compiled
  6843. 'dotime dotime)))))
  6844. (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
  6845. "Remove tags string from TXT, and add a modified list of tags.
  6846. The modified list may contain inherited tags, and tags matched by
  6847. `org-agenda-hide-tags-regexp' will be removed."
  6848. (when (or add-inherited hide-re)
  6849. (when (string-match org-tag-group-re txt)
  6850. (setq txt (substring txt 0 (match-beginning 0))))
  6851. (setq tags
  6852. (delq nil
  6853. (mapcar (lambda (tg)
  6854. (if (or (and hide-re (string-match hide-re tg))
  6855. (and (not add-inherited)
  6856. (get-text-property 0 'inherited tg)))
  6857. nil
  6858. tg))
  6859. tags)))
  6860. (when tags
  6861. (let ((have-i (get-text-property 0 'inherited (car tags)))
  6862. i)
  6863. (setq txt (concat txt " :"
  6864. (mapconcat
  6865. (lambda (x)
  6866. (setq i (get-text-property 0 'inherited x))
  6867. (if (and have-i (not i))
  6868. (progn
  6869. (setq have-i nil)
  6870. (concat ":" x))
  6871. x))
  6872. tags ":")
  6873. (if have-i "::" ":"))))))
  6874. txt)
  6875. (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
  6876. (defun org-agenda-add-time-grid-maybe (list ndays todayp)
  6877. "Add a time-grid for agenda items which need it.
  6878. LIST is the list of agenda items formatted by `org-agenda-list'.
  6879. NDAYS is the span of the current agenda view.
  6880. TODAYP is t when the current agenda view is on today."
  6881. (catch 'exit
  6882. (cond ((not org-agenda-use-time-grid) (throw 'exit list))
  6883. ((and todayp (member 'today (car org-agenda-time-grid))))
  6884. ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
  6885. ((member 'weekly (car org-agenda-time-grid)))
  6886. (t (throw 'exit list)))
  6887. (let* ((have (delq nil (mapcar
  6888. (lambda (x) (get-text-property 1 'time-of-day x))
  6889. list)))
  6890. (string (nth 3 org-agenda-time-grid))
  6891. (gridtimes (nth 1 org-agenda-time-grid))
  6892. (req (car org-agenda-time-grid))
  6893. (remove (member 'remove-match req))
  6894. new time)
  6895. (when (and (member 'require-timed req) (not have))
  6896. ;; don't show empty grid
  6897. (throw 'exit list))
  6898. (while (setq time (pop gridtimes))
  6899. (unless (and remove (member time have))
  6900. (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
  6901. (push (org-agenda-format-item
  6902. nil string nil "" nil
  6903. (concat (substring time 0 -2) ":" (substring time -2)))
  6904. new)
  6905. (put-text-property
  6906. 2 (length (car new)) 'face 'org-time-grid (car new))))
  6907. (when (and todayp org-agenda-show-current-time-in-grid)
  6908. (push (org-agenda-format-item
  6909. nil org-agenda-current-time-string nil "" nil
  6910. (format-time-string "%H:%M "))
  6911. new)
  6912. (put-text-property
  6913. 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
  6914. (if (member 'time-up org-agenda-sorting-strategy-selected)
  6915. (append new list)
  6916. (append list new)))))
  6917. (defun org-compile-prefix-format (key)
  6918. "Compile the prefix format into a Lisp form that can be evaluated.
  6919. KEY is the agenda type (see `org-agenda-prefix-format').
  6920. The resulting form and associated variable bindings is returned
  6921. and stored in the variable `org-prefix-format-compiled'."
  6922. (setq org-prefix-has-time nil
  6923. org-prefix-has-tag nil
  6924. org-prefix-category-length nil
  6925. org-prefix-has-effort nil
  6926. org-prefix-has-breadcrumbs nil)
  6927. (let ((s (cond
  6928. ((stringp org-agenda-prefix-format)
  6929. org-agenda-prefix-format)
  6930. ((assq key org-agenda-prefix-format)
  6931. (cdr (assq key org-agenda-prefix-format)))
  6932. (t " %-12:c%?-12t% s")))
  6933. (start 0)
  6934. varform vars var c f opt) ;; e
  6935. (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cltseib]\\|(.+?)\\)"
  6936. s start)
  6937. (setq var (or (cdr (assoc (match-string 4 s)
  6938. '(("c" . category) ("t" . time) ("l" . level) ("s" . extra)
  6939. ("i" . category-icon) ("T" . tag) ("e" . effort) ("b" . breadcrumbs))))
  6940. 'eval)
  6941. c (or (match-string 3 s) "")
  6942. opt (match-beginning 1)
  6943. start (1+ (match-beginning 0)))
  6944. (cl-case var
  6945. (time (setq org-prefix-has-time t))
  6946. (tag (setq org-prefix-has-tag t))
  6947. (effort (setq org-prefix-has-effort t))
  6948. (breadcrumbs (setq org-prefix-has-breadcrumbs t)))
  6949. (setq f (concat "%" (match-string 2 s) "s"))
  6950. (when (eq var 'category)
  6951. (setq org-prefix-category-length
  6952. (floor (abs (string-to-number (match-string 2 s)))))
  6953. (setq org-prefix-category-max-length
  6954. (let ((x (match-string 2 s)))
  6955. (save-match-data
  6956. (and (string-match "\\.[0-9]+" x)
  6957. (string-to-number (substring (match-string 0 x) 1)))))))
  6958. (if (eq var 'eval)
  6959. (setq varform `(format ,f (org-eval ,(read (substring s (match-beginning 4))))))
  6960. (if opt
  6961. (setq varform
  6962. `(if (member ,var '("" nil))
  6963. ""
  6964. (format ,f (concat ,var ,c))))
  6965. (setq varform
  6966. `(format ,f (if (member ,var '("" nil)) ""
  6967. (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
  6968. (if (eq var 'eval)
  6969. (setf (substring s (match-beginning 0)
  6970. (+ (match-beginning 4)
  6971. (length (format "%S" (read (substring s (match-beginning 4)))))))
  6972. "%s")
  6973. (setq s (replace-match "%s" t nil s)))
  6974. (push varform vars))
  6975. (setq vars (nreverse vars))
  6976. (with-current-buffer (or org-agenda-buffer (current-buffer))
  6977. (setq org-prefix-format-compiled
  6978. (list
  6979. `((org-prefix-has-time ,org-prefix-has-time)
  6980. (org-prefix-has-tag ,org-prefix-has-tag)
  6981. (org-prefix-category-length ,org-prefix-category-length)
  6982. (org-prefix-has-effort ,org-prefix-has-effort)
  6983. (org-prefix-has-breadcrumbs ,org-prefix-has-breadcrumbs))
  6984. `(format ,s ,@vars))))))
  6985. (defun org-set-sorting-strategy (key)
  6986. (setq org-agenda-sorting-strategy-selected
  6987. (if (symbolp (car org-agenda-sorting-strategy))
  6988. ;; the old format
  6989. org-agenda-sorting-strategy
  6990. (or (cdr (assq key org-agenda-sorting-strategy))
  6991. (cdr (assq 'agenda org-agenda-sorting-strategy))
  6992. '(time-up category-keep priority-down)))))
  6993. (defun org-get-time-of-day (s &optional string)
  6994. "Check string S for a time of day.
  6995. If found, return it as a military time number between 0 and 2400.
  6996. If not found, return nil.
  6997. The optional STRING argument forces conversion into a 5 character wide string
  6998. HH:MM. When it is `overtime', any time above 24:00 is turned into \"+H:MM\"
  6999. where H:MM is the duration above midnight."
  7000. (let ((case-fold-search t)
  7001. (time-regexp
  7002. (rx word-start
  7003. (group (opt (any "012")) digit) ;group 1: hours
  7004. (or (and ":" (group (any "012345") digit) ;group 2: minutes
  7005. (opt (group (or "am" "pm")))) ;group 3: am/pm
  7006. ;; Special "HHam/pm" case.
  7007. (group-n 3 (or "am" "pm")))
  7008. word-end)))
  7009. (save-match-data
  7010. (when (and (string-match time-regexp s)
  7011. (not (eq 'org-link (get-text-property 1 'face s))))
  7012. (let ((hours
  7013. (let* ((ampm (and (match-end 3) (downcase (match-string 3 s))))
  7014. (am-p (equal ampm "am")))
  7015. (pcase (string-to-number (match-string 1 s))
  7016. ((and (guard (not ampm)) h) h)
  7017. (12 (if am-p 0 12))
  7018. (h (+ h (if am-p 0 12))))))
  7019. (minutes
  7020. (if (match-end 2)
  7021. (string-to-number (match-string 2 s))
  7022. 0)))
  7023. (pcase string
  7024. (`nil (+ minutes (* hours 100)))
  7025. ((and `overtime
  7026. (guard (or (> hours 24)
  7027. (and (= hours 24)
  7028. (> minutes 0)))))
  7029. (format "+%d:%02d" (- hours 24) minutes))
  7030. ((guard org-agenda-time-leading-zero)
  7031. (format "%02d:%02d" hours minutes))
  7032. (_
  7033. (format "%d:%02d" hours minutes))))))))
  7034. (defvar org-agenda-before-sorting-filter-function nil
  7035. "Function to be applied to agenda items prior to sorting.
  7036. Prior to sorting also means just before they are inserted into the agenda.
  7037. To aid sorting, you may revisit the original entries and add more text
  7038. properties which will later be used by the sorting functions.
  7039. The function should take a string argument, an agenda line.
  7040. It has access to the text properties in that line, which contain among
  7041. other things, the property `org-hd-marker' that points to the entry
  7042. where the line comes from. Note that not all lines going into the agenda
  7043. have this property, only most.
  7044. The function should return the modified string. It is probably best
  7045. to ONLY change text properties.
  7046. You can also use this function as a filter, by returning nil for lines
  7047. you don't want to have in the agenda at all. For this application, you
  7048. could bind the variable in the options section of a custom command.")
  7049. (defun org-agenda-finalize-entries (list &optional type)
  7050. "Sort, limit and concatenate the LIST of agenda items.
  7051. The optional argument TYPE tells the agenda type."
  7052. (let ((max-effort (cond ((listp org-agenda-max-effort)
  7053. (cdr (assoc type org-agenda-max-effort)))
  7054. (t org-agenda-max-effort)))
  7055. (max-todo (cond ((listp org-agenda-max-todos)
  7056. (cdr (assoc type org-agenda-max-todos)))
  7057. (t org-agenda-max-todos)))
  7058. (max-tags (cond ((listp org-agenda-max-tags)
  7059. (cdr (assoc type org-agenda-max-tags)))
  7060. (t org-agenda-max-tags)))
  7061. (max-entries (cond ((listp org-agenda-max-entries)
  7062. (cdr (assoc type org-agenda-max-entries)))
  7063. (t org-agenda-max-entries))))
  7064. (when org-agenda-before-sorting-filter-function
  7065. (setq list
  7066. (delq nil
  7067. (mapcar
  7068. org-agenda-before-sorting-filter-function list))))
  7069. (setq list (mapcar #'org-agenda-highlight-todo list)
  7070. list (mapcar #'identity (sort list #'org-entries-lessp)))
  7071. (when max-effort
  7072. (setq list (org-agenda-limit-entries
  7073. list 'effort-minutes max-effort
  7074. (lambda (e) (or e (if org-agenda-sort-noeffort-is-high
  7075. 32767 -1))))))
  7076. (when max-todo
  7077. (setq list (org-agenda-limit-entries list 'todo-state max-todo)))
  7078. (when max-tags
  7079. (setq list (org-agenda-limit-entries list 'tags max-tags)))
  7080. (when max-entries
  7081. (setq list (org-agenda-limit-entries list 'org-hd-marker max-entries)))
  7082. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  7083. (setq list (mapcar #'org-agenda--mark-blocked-entry list)))
  7084. (mapconcat #'identity list "\n")))
  7085. (defun org-agenda-limit-entries (list prop limit &optional fn)
  7086. "Limit the number of agenda entries."
  7087. (let ((include (and limit (< limit 0))))
  7088. (if limit
  7089. (let ((fun (or fn (lambda (p) (when p 1))))
  7090. (lim 0))
  7091. (delq nil
  7092. (mapcar
  7093. (lambda (e)
  7094. (let ((pval (funcall
  7095. fun (get-text-property (1- (length e))
  7096. prop e))))
  7097. (when pval (setq lim (+ lim pval)))
  7098. (cond ((and pval (<= lim (abs limit))) e)
  7099. ((and include (not pval)) e))))
  7100. list)))
  7101. list)))
  7102. (defun org-agenda-limit-interactively (remove)
  7103. "In agenda, interactively limit entries to various maximums."
  7104. (interactive "P")
  7105. (if remove
  7106. (progn (setq org-agenda-max-entries nil
  7107. org-agenda-max-todos nil
  7108. org-agenda-max-tags nil
  7109. org-agenda-max-effort nil)
  7110. (org-agenda-redo))
  7111. (let* ((max (read-char "Number of [e]ntries [t]odos [T]ags [E]ffort? "))
  7112. (msg (cond ((= max ?E) "How many minutes? ")
  7113. ((= max ?e) "How many entries? ")
  7114. ((= max ?t) "How many TODO entries? ")
  7115. ((= max ?T) "How many tagged entries? ")
  7116. (t (user-error "Wrong input"))))
  7117. (num (string-to-number (read-from-minibuffer msg))))
  7118. (cond ((equal max ?e)
  7119. (let ((org-agenda-max-entries num)) (org-agenda-redo)))
  7120. ((equal max ?t)
  7121. (let ((org-agenda-max-todos num)) (org-agenda-redo)))
  7122. ((equal max ?T)
  7123. (let ((org-agenda-max-tags num)) (org-agenda-redo)))
  7124. ((equal max ?E)
  7125. (let ((org-agenda-max-effort num)) (org-agenda-redo))))))
  7126. (org-agenda-fit-window-to-buffer))
  7127. (defun org-agenda-highlight-todo (x)
  7128. (let ((org-done-keywords org-done-keywords-for-agenda)
  7129. (case-fold-search nil)
  7130. re)
  7131. (if (eq x 'line)
  7132. (save-excursion
  7133. (beginning-of-line 1)
  7134. (setq re (org-get-at-bol 'org-todo-regexp))
  7135. (goto-char (or (text-property-any (line-beginning-position) (line-end-position) 'org-heading t) (point)))
  7136. (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
  7137. (add-text-properties (match-beginning 0) (match-end 1)
  7138. (list 'face (org-get-todo-face 1)))
  7139. (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
  7140. (delete-region (match-beginning 1) (1- (match-end 0)))
  7141. (goto-char (match-beginning 1))
  7142. (insert (format org-agenda-todo-keyword-format s)))))
  7143. (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
  7144. (setq re (get-text-property 0 'org-todo-regexp x))
  7145. (when (and re
  7146. ;; Test `pl' because if there's no heading content,
  7147. ;; there's no point matching to highlight. Note
  7148. ;; that if we didn't test `pl' first, and there
  7149. ;; happened to be no keyword from `org-todo-regexp'
  7150. ;; on this heading line, then the `equal' comparison
  7151. ;; afterwards would spuriously succeed in the case
  7152. ;; where `pl' is nil -- causing an args-out-of-range
  7153. ;; error when we try to add text properties to text
  7154. ;; that isn't there.
  7155. pl
  7156. (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
  7157. x pl)
  7158. pl))
  7159. (add-text-properties
  7160. (or (match-end 1) (match-end 0)) (match-end 0)
  7161. (list 'face (org-get-todo-face (match-string 2 x)))
  7162. x)
  7163. (when (match-end 1)
  7164. (setq x
  7165. (concat
  7166. (substring x 0 (match-end 1))
  7167. (unless (string= org-agenda-todo-keyword-format "")
  7168. (format org-agenda-todo-keyword-format
  7169. (match-string 2 x)))
  7170. (unless (string= org-agenda-todo-keyword-format "")
  7171. ;; Remove `display' property as the icon could leak
  7172. ;; on the white space.
  7173. (org-add-props " " (org-plist-delete (text-properties-at 0 x)
  7174. 'display)))
  7175. (substring x (match-end 3)))))))
  7176. x)))
  7177. (defsubst org-cmp-values (a b property)
  7178. "Compare the numeric value of text PROPERTY for string A and B."
  7179. (let ((pa (or (get-text-property (1- (length a)) property a) 0))
  7180. (pb (or (get-text-property (1- (length b)) property b) 0)))
  7181. (cond ((> pa pb) +1)
  7182. ((< pa pb) -1))))
  7183. (defsubst org-cmp-effort (a b)
  7184. "Compare the effort values of string A and B."
  7185. (let* ((def (if org-agenda-sort-noeffort-is-high 32767 -1))
  7186. ;; `effort-minutes' property is not directly accessible from
  7187. ;; the strings, but is stored as a property in `txt'.
  7188. (ea (or (get-text-property
  7189. 0 'effort-minutes (get-text-property 0 'txt a))
  7190. def))
  7191. (eb (or (get-text-property
  7192. 0 'effort-minutes (get-text-property 0 'txt b))
  7193. def)))
  7194. (cond ((> ea eb) +1)
  7195. ((< ea eb) -1))))
  7196. (defsubst org-cmp-category (a b)
  7197. "Compare the string values of categories of strings A and B."
  7198. (let ((ca (or (get-text-property (1- (length a)) 'org-category a) ""))
  7199. (cb (or (get-text-property (1- (length b)) 'org-category b) "")))
  7200. (cond ((string-lessp ca cb) -1)
  7201. ((string-lessp cb ca) +1))))
  7202. (defsubst org-cmp-todo-state (a b)
  7203. "Compare the todo states of strings A and B."
  7204. (let* ((ma (or (get-text-property 1 'org-marker a)
  7205. (get-text-property 1 'org-hd-marker a)))
  7206. (mb (or (get-text-property 1 'org-marker b)
  7207. (get-text-property 1 'org-hd-marker b)))
  7208. (fa (and ma (marker-buffer ma)))
  7209. (fb (and mb (marker-buffer mb)))
  7210. (todo-kwds
  7211. (or (and fa (with-current-buffer fa org-todo-keywords-1))
  7212. (and fb (with-current-buffer fb org-todo-keywords-1))))
  7213. (ta (or (get-text-property 1 'todo-state a) ""))
  7214. (tb (or (get-text-property 1 'todo-state b) ""))
  7215. (la (- (length (member ta todo-kwds))))
  7216. (lb (- (length (member tb todo-kwds))))
  7217. (donepa (member ta org-done-keywords-for-agenda))
  7218. (donepb (member tb org-done-keywords-for-agenda)))
  7219. (cond ((and donepa (not donepb)) -1)
  7220. ((and (not donepa) donepb) +1)
  7221. ((< la lb) -1)
  7222. ((< lb la) +1))))
  7223. (defsubst org-cmp-alpha (a b)
  7224. "Compare the headlines, alphabetically."
  7225. (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
  7226. (plb (text-property-any 0 (length b) 'org-heading t b))
  7227. (ta (and pla (substring a pla)))
  7228. (tb (and plb (substring b plb)))
  7229. (case-fold-search nil))
  7230. (when pla
  7231. (when (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
  7232. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *")
  7233. ta)
  7234. (setq ta (substring ta (match-end 0))))
  7235. (setq ta (downcase ta)))
  7236. (when plb
  7237. (when (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
  7238. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *")
  7239. tb)
  7240. (setq tb (substring tb (match-end 0))))
  7241. (setq tb (downcase tb)))
  7242. (cond ((not (or ta tb)) nil)
  7243. ((not ta) +1)
  7244. ((not tb) -1)
  7245. ((string-lessp ta tb) -1)
  7246. ((string-lessp tb ta) +1))))
  7247. (defsubst org-cmp-tag (a b)
  7248. "Compare the string values of the first tags of A and B."
  7249. (let ((ta (car (last (get-text-property 1 'tags a))))
  7250. (tb (car (last (get-text-property 1 'tags b)))))
  7251. (cond ((not (or ta tb)) nil)
  7252. ((not ta) +1)
  7253. ((not tb) -1)
  7254. ((string-lessp ta tb) -1)
  7255. ((string-lessp tb ta) +1))))
  7256. (defsubst org-cmp-time (a b)
  7257. "Compare the time-of-day values of strings A and B."
  7258. (let* ((def (if org-agenda-sort-notime-is-late 9901 -1))
  7259. (ta (or (get-text-property 1 'time-of-day a) def))
  7260. (tb (or (get-text-property 1 'time-of-day b) def)))
  7261. (cond ((< ta tb) -1)
  7262. ((< tb ta) +1))))
  7263. (defsubst org-cmp-ts (a b type)
  7264. "Compare the timestamps values of entries A and B.
  7265. When TYPE is \"scheduled\", \"deadline\", \"timestamp\" or
  7266. \"timestamp_ia\", compare within each of these type. When TYPE
  7267. is the empty string, compare all timestamps without respect of
  7268. their type."
  7269. (let* ((def (if org-agenda-sort-notime-is-late 99999999 -1))
  7270. (ta (or (and (string-match type (or (get-text-property 1 'type a) ""))
  7271. (get-text-property 1 'ts-date a))
  7272. def))
  7273. (tb (or (and (string-match type (or (get-text-property 1 'type b) ""))
  7274. (get-text-property 1 'ts-date b))
  7275. def)))
  7276. (cond ((if ta (and tb (< ta tb)) tb) -1)
  7277. ((if tb (and ta (< tb ta)) ta) +1))))
  7278. (defsubst org-cmp-habit-p (a b)
  7279. "Compare the todo states of strings A and B."
  7280. (let ((ha (get-text-property 1 'org-habit-p a))
  7281. (hb (get-text-property 1 'org-habit-p b)))
  7282. (cond ((and ha (not hb)) -1)
  7283. ((and (not ha) hb) +1))))
  7284. (defun org-entries-lessp (a b)
  7285. "Predicate for sorting agenda entries."
  7286. ;; The following variables will be used when the form is evaluated.
  7287. ;; So even though the compiler complains, keep them.
  7288. (let ((ss org-agenda-sorting-strategy-selected))
  7289. (org-dlet
  7290. ((timestamp-up (and (org-em 'timestamp-up 'timestamp-down ss)
  7291. (org-cmp-ts a b "")))
  7292. (timestamp-down (if timestamp-up (- timestamp-up) nil))
  7293. (scheduled-up (and (org-em 'scheduled-up 'scheduled-down ss)
  7294. (org-cmp-ts a b "scheduled")))
  7295. (scheduled-down (if scheduled-up (- scheduled-up) nil))
  7296. (deadline-up (and (org-em 'deadline-up 'deadline-down ss)
  7297. (org-cmp-ts a b "deadline")))
  7298. (deadline-down (if deadline-up (- deadline-up) nil))
  7299. (tsia-up (and (org-em 'tsia-up 'tsia-down ss)
  7300. (org-cmp-ts a b "timestamp_ia")))
  7301. (tsia-down (if tsia-up (- tsia-up) nil))
  7302. (ts-up (and (org-em 'ts-up 'ts-down ss)
  7303. (org-cmp-ts a b "timestamp")))
  7304. (ts-down (if ts-up (- ts-up) nil))
  7305. (time-up (and (org-em 'time-up 'time-down ss)
  7306. (org-cmp-time a b)))
  7307. (time-down (if time-up (- time-up) nil))
  7308. (stats-up (and (org-em 'stats-up 'stats-down ss)
  7309. (org-cmp-values a b 'org-stats)))
  7310. (stats-down (if stats-up (- stats-up) nil))
  7311. (priority-up (and (org-em 'priority-up 'priority-down ss)
  7312. (org-cmp-values a b 'priority)))
  7313. (priority-down (if priority-up (- priority-up) nil))
  7314. (effort-up (and (org-em 'effort-up 'effort-down ss)
  7315. (org-cmp-effort a b)))
  7316. (effort-down (if effort-up (- effort-up) nil))
  7317. (category-up (and (or (org-em 'category-up 'category-down ss)
  7318. (memq 'category-keep ss))
  7319. (org-cmp-category a b)))
  7320. (category-down (if category-up (- category-up) nil))
  7321. (category-keep (if category-up +1 nil))
  7322. (tag-up (and (org-em 'tag-up 'tag-down ss)
  7323. (org-cmp-tag a b)))
  7324. (tag-down (if tag-up (- tag-up) nil))
  7325. (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
  7326. (org-cmp-todo-state a b)))
  7327. (todo-state-down (if todo-state-up (- todo-state-up) nil))
  7328. (habit-up (and (org-em 'habit-up 'habit-down ss)
  7329. (org-cmp-habit-p a b)))
  7330. (habit-down (if habit-up (- habit-up) nil))
  7331. (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
  7332. (org-cmp-alpha a b)))
  7333. (alpha-down (if alpha-up (- alpha-up) nil))
  7334. (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
  7335. user-defined-up user-defined-down)
  7336. (when (and need-user-cmp org-agenda-cmp-user-defined
  7337. (functionp org-agenda-cmp-user-defined))
  7338. (setq user-defined-up
  7339. (funcall org-agenda-cmp-user-defined a b)
  7340. user-defined-down (if user-defined-up (- user-defined-up) nil)))
  7341. (cdr (assoc
  7342. (eval (cons 'or org-agenda-sorting-strategy-selected) t)
  7343. '((-1 . t) (1 . nil) (nil . nil)))))))
  7344. ;;; Agenda restriction lock
  7345. (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
  7346. "Overlay to mark the headline to which agenda commands are restricted.")
  7347. (overlay-put org-agenda-restriction-lock-overlay
  7348. 'face 'org-agenda-restriction-lock)
  7349. (overlay-put org-agenda-restriction-lock-overlay
  7350. 'help-echo "Agendas are currently limited to this subtree.")
  7351. (delete-overlay org-agenda-restriction-lock-overlay)
  7352. (defun org-agenda-set-restriction-lock-from-agenda (arg)
  7353. "Set the restriction lock to the agenda item at point from within the agenda.
  7354. When called with a `\\[universal-argument]' prefix, restrict to
  7355. the file which contains the item.
  7356. Argument ARG is the prefix argument."
  7357. (interactive "P")
  7358. (unless (derived-mode-p 'org-agenda-mode)
  7359. (user-error "Not in an Org agenda buffer"))
  7360. (let* ((marker (or (org-get-at-bol 'org-marker)
  7361. (org-agenda-error)))
  7362. (buffer (marker-buffer marker))
  7363. (pos (marker-position marker)))
  7364. (with-current-buffer buffer
  7365. (goto-char pos)
  7366. (org-agenda-set-restriction-lock arg))))
  7367. ;;;###autoload
  7368. (defun org-agenda-set-restriction-lock (&optional type)
  7369. "Set restriction lock for agenda to current subtree or file.
  7370. When in a restricted subtree, remove it.
  7371. The restriction will span over the entire file if TYPE is `file',
  7372. or if TYPE is (4), or if the cursor is before the first headline
  7373. in the file. Otherwise, only apply the restriction to the current
  7374. subtree."
  7375. (interactive "P")
  7376. (if (and org-agenda-overriding-restriction
  7377. (member org-agenda-restriction-lock-overlay
  7378. (overlays-at (point)))
  7379. (equal (overlay-start org-agenda-restriction-lock-overlay)
  7380. (point)))
  7381. (org-agenda-remove-restriction-lock 'noupdate)
  7382. (org-agenda-remove-restriction-lock 'noupdate)
  7383. (and (equal type '(4)) (setq type 'file))
  7384. (setq type (cond
  7385. (type type)
  7386. ((org-at-heading-p) 'subtree)
  7387. ((condition-case nil (org-back-to-heading t) (error nil))
  7388. 'subtree)
  7389. (t 'file)))
  7390. (if (eq type 'subtree)
  7391. (progn
  7392. (setq org-agenda-restrict (current-buffer))
  7393. (setq org-agenda-overriding-restriction 'subtree)
  7394. (put 'org-agenda-files 'org-restrict
  7395. (list (buffer-file-name (buffer-base-buffer))))
  7396. (org-back-to-heading t)
  7397. (move-overlay org-agenda-restriction-lock-overlay
  7398. (point)
  7399. (if org-agenda-restriction-lock-highlight-subtree
  7400. (save-excursion (org-end-of-subtree t t) (point))
  7401. (line-end-position)))
  7402. (move-marker org-agenda-restrict-begin (point))
  7403. (move-marker org-agenda-restrict-end
  7404. (save-excursion (org-end-of-subtree t t)))
  7405. (message "Locking agenda restriction to subtree"))
  7406. (put 'org-agenda-files 'org-restrict
  7407. (list (buffer-file-name (buffer-base-buffer))))
  7408. (setq org-agenda-restrict nil)
  7409. (setq org-agenda-overriding-restriction 'file)
  7410. (move-marker org-agenda-restrict-begin nil)
  7411. (move-marker org-agenda-restrict-end nil)
  7412. (message "Locking agenda restriction to file"))
  7413. (setq current-prefix-arg nil))
  7414. (org-agenda-maybe-redo))
  7415. (defun org-agenda-remove-restriction-lock (&optional noupdate)
  7416. "Remove agenda restriction lock."
  7417. (interactive "P")
  7418. (if (not (or org-agenda-restrict org-agenda-overriding-restriction))
  7419. (message "No agenda restriction to remove.")
  7420. (delete-overlay org-agenda-restriction-lock-overlay)
  7421. (delete-overlay org-speedbar-restriction-lock-overlay)
  7422. (setq org-agenda-overriding-restriction nil)
  7423. (unless org-agenda-keep-restricted-file-list
  7424. ;; There is a request to keep the file list in place
  7425. (put 'org-agenda-files 'org-restrict nil))
  7426. (setq org-agenda-restrict nil)
  7427. (put 'org-agenda-files 'org-restrict nil)
  7428. (move-marker org-agenda-restrict-begin nil)
  7429. (move-marker org-agenda-restrict-end nil)
  7430. (setq current-prefix-arg nil)
  7431. (message "Agenda restriction lock removed")
  7432. (or noupdate (org-agenda-maybe-redo))))
  7433. (defun org-agenda-maybe-redo ()
  7434. "If there is any window showing the agenda view, update it."
  7435. (let ((w (get-buffer-window (or org-agenda-this-buffer-name
  7436. org-agenda-buffer-name)
  7437. t))
  7438. (w0 (selected-window)))
  7439. (when w
  7440. (select-window w)
  7441. (org-agenda-redo)
  7442. (select-window w0)
  7443. (if org-agenda-overriding-restriction
  7444. (message "Agenda view shifted to new %s restriction"
  7445. org-agenda-overriding-restriction)
  7446. (message "Agenda restriction lock removed")))))
  7447. ;;; Agenda commands
  7448. (defun org-agenda-check-type (error &rest types)
  7449. "Check if agenda buffer or component is of allowed type.
  7450. If ERROR is non-nil, throw an error, otherwise just return nil.
  7451. Allowed types are `agenda' `todo' `tags' `search'."
  7452. (cond ((not org-agenda-type)
  7453. (error "No Org agenda currently displayed"))
  7454. ((memq org-agenda-type types) t)
  7455. (error
  7456. (error "Not allowed in '%s'-type agenda buffer or component" org-agenda-type))
  7457. (t nil)))
  7458. (defun org-agenda-Quit ()
  7459. "Exit the agenda, killing the agenda buffer.
  7460. Like `org-agenda-quit', but kill the buffer even when
  7461. `org-agenda-sticky' is non-nil."
  7462. (interactive)
  7463. (org-agenda--quit))
  7464. (defun org-agenda-quit ()
  7465. "Exit the agenda.
  7466. When `org-agenda-sticky' is non-nil, bury the agenda buffer
  7467. instead of killing it.
  7468. When `org-agenda-restore-windows-after-quit' is non-nil, restore
  7469. the pre-agenda window configuration.
  7470. When column view is active, exit column view instead of the
  7471. agenda."
  7472. (interactive)
  7473. (org-agenda--quit org-agenda-sticky))
  7474. (defun org-agenda--quit (&optional bury)
  7475. (if org-agenda-columns-active
  7476. (org-columns-quit)
  7477. (let ((wconf org-agenda-pre-window-conf)
  7478. (buf (current-buffer))
  7479. (org-agenda-last-indirect-window
  7480. (and (eq org-indirect-buffer-display 'other-window)
  7481. org-agenda-last-indirect-buffer
  7482. (get-buffer-window org-agenda-last-indirect-buffer))))
  7483. (cond
  7484. ((eq org-agenda-window-setup 'other-frame)
  7485. (delete-frame))
  7486. ((eq org-agenda-window-setup 'other-tab)
  7487. (if (fboundp 'tab-bar-close-tab)
  7488. (tab-bar-close-tab)
  7489. (user-error "Your version of Emacs does not have tab bar mode support")))
  7490. ((and org-agenda-restore-windows-after-quit
  7491. wconf)
  7492. ;; Maybe restore the pre-agenda window configuration. Reset
  7493. ;; `org-agenda-pre-window-conf' before running
  7494. ;; `set-window-configuration', which loses the current buffer.
  7495. (setq org-agenda-pre-window-conf nil)
  7496. (set-window-configuration wconf))
  7497. (t
  7498. (when org-agenda-last-indirect-window
  7499. (delete-window org-agenda-last-indirect-window))
  7500. (and (not (eq org-agenda-window-setup 'current-window))
  7501. (not (one-window-p))
  7502. (delete-window))))
  7503. (if bury
  7504. ;; Set the agenda buffer as the current buffer instead of
  7505. ;; passing it as an argument to `bury-buffer' so that
  7506. ;; `bury-buffer' removes it from the window.
  7507. (with-current-buffer buf
  7508. (bury-buffer))
  7509. (kill-buffer buf)
  7510. (setq org-agenda-archives-mode nil
  7511. org-agenda-buffer nil)))))
  7512. (defun org-agenda-exit ()
  7513. "Exit the agenda, killing Org buffers loaded by the agenda.
  7514. Like `org-agenda-Quit', but kill any buffers that were created by
  7515. the agenda. Org buffers visited directly by the user will not be
  7516. touched. Also, exit the agenda even if it is in column view."
  7517. (interactive)
  7518. (when org-agenda-columns-active
  7519. (org-columns-quit))
  7520. (org-release-buffers org-agenda-new-buffers)
  7521. (setq org-agenda-new-buffers nil)
  7522. (org-agenda-Quit))
  7523. (defun org-agenda-kill-all-agenda-buffers ()
  7524. "Kill all buffers in `org-agenda-mode'.
  7525. This is used when toggling sticky agendas."
  7526. (interactive)
  7527. (let (blist)
  7528. (dolist (buf (buffer-list))
  7529. (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
  7530. (push buf blist)))
  7531. (mapc #'kill-buffer blist)))
  7532. (defun org-agenda-execute (arg)
  7533. "Execute another agenda command, keeping same window.
  7534. So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
  7535. in the agenda."
  7536. (interactive "P")
  7537. (let ((org-agenda-window-setup 'current-window))
  7538. (org-agenda arg)))
  7539. (defun org-agenda-redo (&optional all)
  7540. "Rebuild possibly ALL agenda view(s) in the current buffer."
  7541. (interactive "P")
  7542. (defvar org-agenda-tag-filter-while-redo) ;FIXME: Where is this var used?
  7543. (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
  7544. (cpa (unless (eq all t) current-prefix-arg))
  7545. (org-agenda-doing-sticky-redo org-agenda-sticky)
  7546. (org-agenda-sticky nil)
  7547. (org-agenda-buffer-name (or org-agenda-this-buffer-name
  7548. org-agenda-buffer-name))
  7549. (org-agenda-keep-modes t)
  7550. (tag-filter org-agenda-tag-filter)
  7551. (tag-preset (get 'org-agenda-tag-filter :preset-filter))
  7552. (top-hl-filter org-agenda-top-headline-filter)
  7553. (cat-filter org-agenda-category-filter)
  7554. (cat-preset (get 'org-agenda-category-filter :preset-filter))
  7555. (re-filter org-agenda-regexp-filter)
  7556. (re-preset (get 'org-agenda-regexp-filter :preset-filter))
  7557. (effort-filter org-agenda-effort-filter)
  7558. (effort-preset (get 'org-agenda-effort-filter :preset-filter))
  7559. (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
  7560. (cols org-agenda-columns-active)
  7561. (line (org-current-line))
  7562. (window-line (- line (org-current-line (window-start))))
  7563. (lprops (get 'org-agenda-redo-command 'org-lprops))
  7564. (redo-cmd (get-text-property p 'org-redo-cmd))
  7565. (last-args (get-text-property p 'org-last-args))
  7566. (org-agenda-overriding-cmd (get-text-property p 'org-series-cmd))
  7567. (org-agenda-overriding-cmd-arguments
  7568. (unless (eq all t)
  7569. (cond ((listp last-args)
  7570. (cons (or cpa (car last-args)) (cdr last-args)))
  7571. ((stringp last-args)
  7572. last-args))))
  7573. (series-redo-cmd (get-text-property p 'org-series-redo-cmd)))
  7574. (put 'org-agenda-tag-filter :preset-filter nil)
  7575. (put 'org-agenda-category-filter :preset-filter nil)
  7576. (put 'org-agenda-regexp-filter :preset-filter nil)
  7577. (put 'org-agenda-effort-filter :preset-filter nil)
  7578. (and cols (org-columns-quit))
  7579. (message "Rebuilding agenda buffer...")
  7580. (if series-redo-cmd
  7581. (eval series-redo-cmd t)
  7582. (cl-progv
  7583. (mapcar #'car lprops)
  7584. (mapcar (lambda (binding) (eval (cadr binding) t)) lprops)
  7585. (eval redo-cmd t)))
  7586. (setq org-agenda-undo-list nil
  7587. org-agenda-pending-undo-list nil
  7588. org-agenda-tag-filter tag-filter
  7589. org-agenda-category-filter cat-filter
  7590. org-agenda-regexp-filter re-filter
  7591. org-agenda-effort-filter effort-filter
  7592. org-agenda-top-headline-filter top-hl-filter)
  7593. (message "Rebuilding agenda buffer...done")
  7594. (put 'org-agenda-tag-filter :preset-filter tag-preset)
  7595. (put 'org-agenda-category-filter :preset-filter cat-preset)
  7596. (put 'org-agenda-regexp-filter :preset-filter re-preset)
  7597. (put 'org-agenda-effort-filter :preset-filter effort-preset)
  7598. (let ((tag (or tag-filter tag-preset))
  7599. (cat (or cat-filter cat-preset))
  7600. (effort (or effort-filter effort-preset))
  7601. (re (or re-filter re-preset)))
  7602. (when tag (org-agenda-filter-apply tag 'tag t))
  7603. (when cat (org-agenda-filter-apply cat 'category))
  7604. (when effort (org-agenda-filter-apply effort 'effort))
  7605. (when re (org-agenda-filter-apply re 'regexp)))
  7606. (and top-hl-filter (org-agenda-filter-top-headline-apply top-hl-filter))
  7607. (and cols (called-interactively-p 'any) (org-agenda-columns))
  7608. (org-goto-line line)
  7609. (when (called-interactively-p 'any) (recenter window-line))))
  7610. (defun org-agenda-redo-all (&optional exhaustive)
  7611. "Rebuild all agenda views in the current buffer.
  7612. With a prefix argument, do so in all agenda buffers."
  7613. (interactive "P")
  7614. (if exhaustive
  7615. (dolist (buffer (buffer-list))
  7616. (with-current-buffer buffer
  7617. (when (derived-mode-p 'org-agenda-mode)
  7618. (org-agenda-redo t))))
  7619. (org-agenda-redo t)))
  7620. (defvar org-global-tags-completion-table nil)
  7621. (defvar org-agenda-filter-form nil)
  7622. (defvar org-agenda-filtered-by-category nil)
  7623. (defsubst org-agenda-get-category ()
  7624. "Return the category of the agenda line."
  7625. (org-get-at-bol 'org-category))
  7626. (defun org-agenda-filter-by-category (strip)
  7627. "Filter lines in the agenda buffer that have a specific category.
  7628. The category is that of the current line.
  7629. With a `\\[universal-argument]' prefix argument, exclude the lines of that category.
  7630. When there is already a category filter in place, this command removes the
  7631. filter."
  7632. (interactive "P")
  7633. (if (and org-agenda-filtered-by-category
  7634. org-agenda-category-filter)
  7635. (org-agenda-filter-show-all-cat)
  7636. (let ((cat (org-no-properties (org-get-at-eol 'org-category 1))))
  7637. (cond
  7638. ((and cat strip)
  7639. (org-agenda-filter-apply
  7640. (push (concat "-" cat) org-agenda-category-filter) 'category))
  7641. (cat
  7642. (org-agenda-filter-apply
  7643. (setq org-agenda-category-filter
  7644. (list (concat "+" cat)))
  7645. 'category))
  7646. (t (error "No category at point"))))))
  7647. (defun org-find-top-headline (&optional pos)
  7648. "Find the topmost parent headline and return it.
  7649. POS when non-nil is the marker or buffer position to start the
  7650. search from."
  7651. (save-excursion
  7652. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  7653. (when pos (goto-char pos))
  7654. ;; Skip up to the topmost parent.
  7655. (while (org-up-heading-safe))
  7656. (ignore-errors
  7657. (replace-regexp-in-string
  7658. "^\\[[0-9]+/[0-9]+\\] *\\|^\\[%[0-9]+\\] *" ""
  7659. (nth 4 (org-heading-components)))))))
  7660. (defvar org-agenda-filtered-by-top-headline nil)
  7661. (defun org-agenda-filter-by-top-headline (strip)
  7662. "Keep only those lines that are descendants from the same top headline.
  7663. The top headline is that of the current line. With prefix arg STRIP, hide
  7664. all lines of the category at point."
  7665. (interactive "P")
  7666. (if org-agenda-filtered-by-top-headline
  7667. (progn
  7668. (setq org-agenda-filtered-by-top-headline nil
  7669. org-agenda-top-headline-filter nil)
  7670. (org-agenda-filter-show-all-top-filter))
  7671. (let ((toph (org-find-top-headline (org-get-at-bol 'org-hd-marker))))
  7672. (if toph (org-agenda-filter-top-headline-apply toph strip)
  7673. (error "No top-level headline at point")))))
  7674. (defvar org-agenda-regexp-filter nil)
  7675. (defun org-agenda-filter-by-regexp (strip-or-accumulate)
  7676. "Filter agenda entries by a regular expressions.
  7677. You will be prompted for the regular expression, and the agenda
  7678. view will only show entries that are matched by that expression.
  7679. With one `\\[universal-argument]' prefix argument, hide entries matching the regexp.
  7680. When there is already a regexp filter active, this command removed the
  7681. filter. However, with two `\\[universal-argument]' prefix arguments, add a new condition to
  7682. an already existing regexp filter."
  7683. (interactive "P")
  7684. (let* ((strip (equal strip-or-accumulate '(4)))
  7685. (accumulate (equal strip-or-accumulate '(16))))
  7686. (cond
  7687. ((and org-agenda-regexp-filter (not accumulate))
  7688. (org-agenda-filter-show-all-re)
  7689. (message "Regexp filter removed"))
  7690. (t (let ((flt (concat (if strip "-" "+")
  7691. (read-from-minibuffer
  7692. (if strip
  7693. "Hide entries matching regexp: "
  7694. "Narrow to entries matching regexp: ")))))
  7695. (push flt org-agenda-regexp-filter)
  7696. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))))))
  7697. (defvar org-agenda-effort-filter nil)
  7698. (defun org-agenda-filter-by-effort (strip-or-accumulate)
  7699. "Filter agenda entries by effort.
  7700. With no `\\[universal-argument]' prefix argument, keep entries matching the effort condition.
  7701. With one `\\[universal-argument]' prefix argument, filter out entries matching the condition.
  7702. With two `\\[universal-argument]' prefix arguments, add a second condition to the existing filter.
  7703. This last option is in practice not very useful, but it is available for
  7704. consistency with the other filter commands."
  7705. (interactive "P")
  7706. (let* ((efforts (split-string
  7707. (or (cdr (assoc-string (concat org-effort-property "_ALL")
  7708. org-global-properties
  7709. t))
  7710. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00")))
  7711. ;; XXX: the following handles only up to 10 different
  7712. ;; effort values.
  7713. (allowed-keys (if (null efforts) nil
  7714. (mapcar (lambda (n) (mod n 10)) ;turn 10 into 0
  7715. (number-sequence 1 (length efforts)))))
  7716. (keep (equal strip-or-accumulate '(16)))
  7717. (negative (equal strip-or-accumulate '(4)))
  7718. (current org-agenda-effort-filter)
  7719. (op nil))
  7720. (while (not (memq op '(?< ?> ?= ?_)))
  7721. (setq op (read-char-exclusive
  7722. "Effort operator? (> = or <) or press `_' again to remove filter")))
  7723. ;; Select appropriate duration. Ignore non-digit characters.
  7724. (if (eq op ?_)
  7725. (progn
  7726. (org-agenda-filter-show-all-effort)
  7727. (message "Effort filter removed"))
  7728. (let ((prompt
  7729. (apply #'format
  7730. (concat "Effort %c "
  7731. (mapconcat (lambda (s) (concat "[%d]" s))
  7732. efforts
  7733. " "))
  7734. op allowed-keys))
  7735. (eff -1))
  7736. (while (not (memq eff allowed-keys))
  7737. (message prompt)
  7738. (setq eff (- (read-char-exclusive) 48)))
  7739. (org-agenda-filter-show-all-effort)
  7740. (setq org-agenda-effort-filter
  7741. (append
  7742. (list (concat (if negative "-" "+")
  7743. (char-to-string op)
  7744. ;; Numbering is 1 2 3 ... 9 0, but we want
  7745. ;; 0 1 2 ... 8 9.
  7746. (nth (mod (1- eff) 10) efforts)))
  7747. (if keep current nil)))
  7748. (org-agenda-filter-apply org-agenda-effort-filter 'effort)))))
  7749. (defun org-agenda-filter (&optional strip-or-accumulate)
  7750. "Prompt for a general filter string and apply it to the agenda.
  7751. The string may contain filter elements like
  7752. +category
  7753. +tag
  7754. +<effort > and = are also allowed as effort operators
  7755. +/regexp/
  7756. Instead of `+', `-' is allowed to strip the agenda of matching entries.
  7757. `+' is optional if it is not required to separate two string parts.
  7758. Multiple filter elements can be concatenated without spaces, for example
  7759. +work-John<0:10-/plot/
  7760. selects entries with category `work' and effort estimates below 10 minutes,
  7761. and deselects entries with tag `John' or matching the regexp `plot'.
  7762. During entry of the filter, completion for tags, categories and effort
  7763. values is offered. Since the syntax for categories and tags is identical
  7764. there should be no overlap between categories and tags. If there is, tags
  7765. get priority.
  7766. A single `\\[universal-argument]' prefix arg STRIP-OR-ACCUMULATE will negate the
  7767. entire filter, which can be useful in connection with the prompt history.
  7768. A double `\\[universal-argument] \\[universal-argument]' prefix arg will add the new filter elements to the
  7769. existing ones. A shortcut for this is to add an additional `+' at the
  7770. beginning of the string, like `+-John'.
  7771. With a triple prefix argument, execute the computed filtering defined in
  7772. the variable `org-agenda-auto-exclude-function'."
  7773. (interactive "P")
  7774. (if (equal strip-or-accumulate '(64))
  7775. ;; Execute the auto-exclude action
  7776. (if (not org-agenda-auto-exclude-function)
  7777. (user-error "`org-agenda-auto-exclude-function' is undefined")
  7778. (org-agenda-filter-show-all-tag)
  7779. (setq org-agenda-tag-filter nil)
  7780. (dolist (tag (org-agenda-get-represented-tags))
  7781. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  7782. (when modifier
  7783. (push modifier org-agenda-tag-filter))))
  7784. (unless (null org-agenda-tag-filter)
  7785. (org-agenda-filter-apply org-agenda-tag-filter 'tag 'expand)))
  7786. ;; Prompt for a filter and act
  7787. (let* ((tag-list (org-agenda-get-represented-tags))
  7788. (category-list (org-agenda-get-represented-categories))
  7789. (negate (equal strip-or-accumulate '(4)))
  7790. (cf (mapconcat #'identity org-agenda-category-filter ""))
  7791. (tf (mapconcat #'identity org-agenda-tag-filter ""))
  7792. ;; (rpl-fn (lambda (c) (replace-regexp-in-string "^\\+" "" (or (car c) ""))))
  7793. (ef (replace-regexp-in-string "^\\+" "" (or (car org-agenda-effort-filter) "")))
  7794. (rf (replace-regexp-in-string "^\\+" "" (or (car org-agenda-regexp-filter) "")))
  7795. (ff (concat cf tf ef (when (not (equal rf "")) (concat "/" rf "/"))))
  7796. (f-string (completing-read
  7797. (concat
  7798. (if negate "Negative filter" "Filter")
  7799. " [+cat-tag<0:10-/regexp/]: ")
  7800. #'org-agenda-filter-completion-function
  7801. nil nil ff))
  7802. (keep (or (if (string-match "^\\+[+-]" f-string)
  7803. (progn (setq f-string (substring f-string 1)) t))
  7804. (equal strip-or-accumulate '(16))))
  7805. (fc (if keep org-agenda-category-filter))
  7806. (ft (if keep org-agenda-tag-filter))
  7807. (fe (if keep org-agenda-effort-filter))
  7808. (fr (if keep org-agenda-regexp-filter))
  7809. pm s)
  7810. ;; If the filter contains a double-quoted string, replace a
  7811. ;; single hyphen by the arbitrary and temporary string "~~~"
  7812. ;; to disambiguate such hyphens from syntactic ones.
  7813. (setq f-string (replace-regexp-in-string
  7814. "\"\\([^\"]*\\)-\\([^\"]*\\)\"" "\"\\1~~~\\2\"" f-string))
  7815. (while (string-match "^[ \t]*\\([-+]\\)?\\(\\([^-+<>=/ \t]+\\)\\|\\([<>=][0-9:]+\\)\\|\\(/\\([^/]+\\)/?\\)\\)" f-string)
  7816. (setq pm (if (match-beginning 1) (match-string 1 f-string) "+"))
  7817. (when negate
  7818. (setq pm (if (equal pm "+") "-" "+")))
  7819. (cond
  7820. ((match-beginning 3)
  7821. ;; category or tag
  7822. (setq s (replace-regexp-in-string ; Remove the temporary special string.
  7823. "~~~" "-" (match-string 3 f-string)))
  7824. (cond
  7825. ((member s tag-list)
  7826. (org-pushnew-to-end (concat pm s) ft))
  7827. ((member s category-list)
  7828. (org-pushnew-to-end (concat pm ; Remove temporary double quotes.
  7829. (replace-regexp-in-string "\"\\(.*\\)\"" "\\1" s))
  7830. fc))
  7831. (t (message
  7832. "`%s%s' filter ignored because tag/category is not represented"
  7833. pm s))))
  7834. ((match-beginning 4)
  7835. ;; effort
  7836. (org-pushnew-to-end (concat pm (match-string 4 f-string)) fe))
  7837. ((match-beginning 5)
  7838. ;; regexp
  7839. (org-pushnew-to-end (concat pm (match-string 6 f-string)) fr)))
  7840. (setq f-string (substring f-string (match-end 0))))
  7841. (org-agenda-filter-remove-all)
  7842. (and fc (org-agenda-filter-apply
  7843. (setq org-agenda-category-filter fc) 'category))
  7844. (and ft (org-agenda-filter-apply
  7845. (setq org-agenda-tag-filter ft) 'tag 'expand))
  7846. (and fe (org-agenda-filter-apply
  7847. (setq org-agenda-effort-filter fe) 'effort))
  7848. (and fr (org-agenda-filter-apply
  7849. (setq org-agenda-regexp-filter fr) 'regexp))
  7850. (run-hooks 'org-agenda-filter-hook))))
  7851. (defun org-agenda-filter-completion-function (string _predicate &optional flag)
  7852. "Complete a complex filter string.
  7853. FLAG specifies the type of completion operation to perform. This
  7854. function is passed as a collection function to `completing-read',
  7855. which see."
  7856. (let ((completion-ignore-case t) ;tags are case-sensitive
  7857. (confirm (lambda (x) (stringp x)))
  7858. (prefix "")
  7859. (operator "")
  7860. table)
  7861. (when (string-match "^\\(.*\\([-+<>=]\\)\\)\\([^-+<>=]*\\)$" string)
  7862. (setq prefix (match-string 1 string)
  7863. operator (match-string 2 string)
  7864. string (match-string 3 string)))
  7865. (cond
  7866. ((member operator '("+" "-" "" nil))
  7867. (setq table (append (org-agenda-get-represented-categories)
  7868. (org-agenda-get-represented-tags))))
  7869. ((member operator '("<" ">" "="))
  7870. (setq table (split-string
  7871. (or (cdr (assoc-string (concat org-effort-property "_ALL")
  7872. org-global-properties
  7873. t))
  7874. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00")
  7875. " +")))
  7876. (t (setq table nil)))
  7877. (pcase flag
  7878. (`t (all-completions string table confirm))
  7879. (`lambda (assoc string table)) ;exact match?
  7880. (`nil
  7881. (pcase (try-completion string table confirm)
  7882. ((and completion (pred stringp))
  7883. (concat prefix completion))
  7884. (completion completion)))
  7885. (_ nil))))
  7886. (defun org-agenda-filter-remove-all ()
  7887. "Remove all filters from the current agenda buffer."
  7888. (interactive)
  7889. (when org-agenda-tag-filter
  7890. (org-agenda-filter-show-all-tag))
  7891. (when org-agenda-category-filter
  7892. (org-agenda-filter-show-all-cat))
  7893. (when org-agenda-regexp-filter
  7894. (org-agenda-filter-show-all-re))
  7895. (when org-agenda-top-headline-filter
  7896. (org-agenda-filter-show-all-top-filter))
  7897. (when org-agenda-effort-filter
  7898. (org-agenda-filter-show-all-effort))
  7899. (org-agenda-finalize)
  7900. (when (called-interactively-p 'interactive)
  7901. (message "All agenda filters removed")))
  7902. (defun org-agenda-filter-by-tag (strip-or-accumulate &optional char exclude)
  7903. "Keep only those lines in the agenda buffer that have a specific tag.
  7904. The tag is selected with its fast selection letter, as configured.
  7905. With a `\\[universal-argument]' prefix, apply the filter negatively, stripping all matches.
  7906. With a `\\[universal-argument] \\[universal-argument]' prefix, add the new tag to the existing filter
  7907. instead of replacing it.
  7908. With a `\\[universal-argument] \\[universal-argument] \\[universal-argument]' prefix, filter the literal tag, \
  7909. i.e. don't
  7910. filter on all its group members.
  7911. A Lisp caller can specify CHAR. EXCLUDE means that the new tag
  7912. should be used to exclude the search - the interactive user can
  7913. also press `-' or `+' to switch between filtering and excluding."
  7914. (interactive "P")
  7915. (let* ((alist org-tag-alist-for-agenda)
  7916. (seen-chars nil)
  7917. (tag-chars (mapconcat
  7918. (lambda (x) (if (and (not (symbolp (car x)))
  7919. (cdr x)
  7920. (not (member (cdr x) seen-chars)))
  7921. (progn
  7922. (push (cdr x) seen-chars)
  7923. (char-to-string (cdr x)))
  7924. ""))
  7925. org-tag-alist-for-agenda ""))
  7926. (valid-char-list (append '(?\t ?\r ?\\ ?. ?\s ?q)
  7927. (string-to-list tag-chars)))
  7928. (exclude (or exclude (equal strip-or-accumulate '(4))))
  7929. (accumulate (equal strip-or-accumulate '(16)))
  7930. (expand (not (equal strip-or-accumulate '(64))))
  7931. (inhibit-read-only t)
  7932. (current org-agenda-tag-filter)
  7933. a tag) ;; n
  7934. (unless char
  7935. (while (not (memq char valid-char-list))
  7936. (org-unlogged-message
  7937. "%s by tag%s: [%s ]tag-char [TAB]tag %s[\\]off [q]uit"
  7938. (if exclude "Exclude[+]" "Filter[-]")
  7939. (if expand "" " (no grouptag expand)")
  7940. tag-chars
  7941. (if org-agenda-auto-exclude-function "[RET] " ""))
  7942. (setq char (read-char-exclusive))
  7943. ;; Excluding or filtering down
  7944. (cond ((eq char ?-) (setq exclude t))
  7945. ((eq char ?+) (setq exclude nil)))))
  7946. (when (eq char ?\t)
  7947. (unless (local-variable-p 'org-global-tags-completion-table)
  7948. (setq-local org-global-tags-completion-table
  7949. (org-global-tags-completion-table)))
  7950. (let ((completion-ignore-case t))
  7951. (setq tag (completing-read
  7952. "Tag: " org-global-tags-completion-table nil t))))
  7953. (cond
  7954. ((eq char ?\r)
  7955. (org-agenda-filter-show-all-tag)
  7956. (when org-agenda-auto-exclude-function
  7957. (setq org-agenda-tag-filter nil)
  7958. (dolist (tag (org-agenda-get-represented-tags))
  7959. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  7960. (when modifier
  7961. (push modifier org-agenda-tag-filter))))
  7962. (unless (null org-agenda-tag-filter)
  7963. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))))
  7964. ((eq char ?\\)
  7965. (org-agenda-filter-show-all-tag)
  7966. (when (get 'org-agenda-tag-filter :preset-filter)
  7967. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand)))
  7968. ((eq char ?.)
  7969. (setq org-agenda-tag-filter
  7970. (mapcar (lambda(tag) (concat "+" tag))
  7971. (org-get-at-bol 'tags)))
  7972. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  7973. ((eq char ?q)) ;If q, abort (even if there is a q-key for a tag...)
  7974. ((or (eq char ?\s)
  7975. (setq a (rassoc char alist))
  7976. (and tag (setq a (cons tag nil))))
  7977. (org-agenda-filter-show-all-tag)
  7978. (setq tag (car a))
  7979. (setq org-agenda-tag-filter
  7980. (cons (concat (if exclude "-" "+") tag)
  7981. (if accumulate current nil)))
  7982. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  7983. (t (error "Invalid tag selection character %c" char)))))
  7984. (defun org-agenda-get-represented-categories ()
  7985. "Return a list of all categories used in this agenda buffer."
  7986. (or org-agenda-represented-categories
  7987. (when (derived-mode-p 'org-agenda-mode)
  7988. (let ((pos (point-min)) categories)
  7989. (while (and (< pos (point-max))
  7990. (setq pos (next-single-property-change
  7991. pos 'org-category nil (point-max))))
  7992. (push (get-text-property pos 'org-category) categories))
  7993. (setq org-agenda-represented-categories
  7994. ;; Enclose category names with a hyphen in double
  7995. ;; quotes to process them specially in `org-agenda-filter'.
  7996. (mapcar (lambda (s) (if (string-match-p "-" s) (format "\"%s\"" s) s))
  7997. (nreverse (org-uniquify (delq nil categories)))))))))
  7998. (defvar org-tag-groups-alist-for-agenda)
  7999. (defun org-agenda-get-represented-tags ()
  8000. "Return a list of all tags used in this agenda buffer.
  8001. These will be lower-case, for filtering."
  8002. (or org-agenda-represented-tags
  8003. (when (derived-mode-p 'org-agenda-mode)
  8004. (let ((pos (point-min)) tags-lists tt)
  8005. (while (and (< pos (point-max))
  8006. (setq pos (next-single-property-change
  8007. pos 'tags nil (point-max))))
  8008. (setq tt (get-text-property pos 'tags))
  8009. (if tt (push tt tags-lists)))
  8010. (setq tags-lists
  8011. (nreverse (org-uniquify
  8012. (delq nil (apply #'append tags-lists)))))
  8013. (dolist (tag tags-lists)
  8014. (mapc
  8015. (lambda (group)
  8016. (when (member tag group)
  8017. (push (car group) tags-lists)))
  8018. org-tag-groups-alist-for-agenda))
  8019. (setq org-agenda-represented-tags tags-lists)))))
  8020. (defun org-agenda-filter-make-matcher (filter type &optional expand)
  8021. "Create the form that tests a line for agenda filter.
  8022. Optional argument EXPAND can be used for the TYPE tag and will
  8023. expand the tags in the FILTER if any of the tags in FILTER are
  8024. grouptags."
  8025. (let ((multi-pos-cats
  8026. (and (eq type 'category)
  8027. (string-match-p "\\+.*\\+"
  8028. (mapconcat (lambda (cat) (substring cat 0 1))
  8029. filter ""))))
  8030. f f1)
  8031. (cond
  8032. ;; Tag filter
  8033. ((eq type 'tag)
  8034. (setq filter
  8035. (delete-dups
  8036. (append (get 'org-agenda-tag-filter :preset-filter)
  8037. filter)))
  8038. (dolist (x filter)
  8039. (let ((op (string-to-char x)))
  8040. (if expand (setq x (org-agenda-filter-expand-tags (list x) t))
  8041. (setq x (list x)))
  8042. (setq f1 (org-agenda-filter-make-matcher-tag-exp x op))
  8043. (push f1 f))))
  8044. ;; Category filter
  8045. ((eq type 'category)
  8046. (setq filter
  8047. (delete-dups
  8048. (append (get 'org-agenda-category-filter :preset-filter)
  8049. filter)))
  8050. (dolist (x filter)
  8051. (if (equal "-" (substring x 0 1))
  8052. (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
  8053. (setq f1 (list 'equal (substring x 1) 'cat)))
  8054. (push f1 f)))
  8055. ;; Regexp filter
  8056. ((eq type 'regexp)
  8057. (setq filter
  8058. (delete-dups
  8059. (append (get 'org-agenda-regexp-filter :preset-filter)
  8060. filter)))
  8061. (dolist (x filter)
  8062. (if (equal "-" (substring x 0 1))
  8063. (setq f1 (list 'not (list 'string-match (substring x 1) 'txt)))
  8064. (setq f1 (list 'string-match (substring x 1) 'txt)))
  8065. (push f1 f)))
  8066. ;; Effort filter
  8067. ((eq type 'effort)
  8068. (setq filter
  8069. (delete-dups
  8070. (append (get 'org-agenda-effort-filter :preset-filter)
  8071. filter)))
  8072. (dolist (x filter)
  8073. (push (org-agenda-filter-effort-form x) f))))
  8074. (cons (if multi-pos-cats 'or 'and) (nreverse f))))
  8075. (defun org-agenda-filter-make-matcher-tag-exp (tags op)
  8076. "Return a form associated to tag-expression TAGS.
  8077. Build a form testing a line for agenda filter for
  8078. tag-expressions. OP is an operator of type CHAR that allows the
  8079. function to set the right switches in the returned form."
  8080. (let (form)
  8081. ;; Any of the expressions can match if OP is +, all must match if
  8082. ;; the operator is -.
  8083. (dolist (x tags (cons (if (eq op ?-) 'and 'or) form))
  8084. (let* ((tag (substring x 1))
  8085. (f (cond
  8086. ((string= "" tag) 'tags)
  8087. ((and (string-match-p "\\`{" tag) (string-match-p "}\\'" tag))
  8088. ;; TAG is a regexp.
  8089. (list 'org-match-any-p (substring tag 1 -1) 'tags))
  8090. (t (list 'member tag 'tags)))))
  8091. (push (if (eq op ?-) (list 'not f) f) form)))))
  8092. (defun org-agenda-filter-effort-form (e)
  8093. "Return the form to compare the effort of the current line with what E says.
  8094. E looks like \"+<2:25\"."
  8095. (let (op)
  8096. (setq e (substring e 1))
  8097. (setq op (string-to-char e) e (substring e 1))
  8098. (setq op (cond ((equal op ?<) '<=)
  8099. ((equal op ?>) '>=)
  8100. ((equal op ??) op)
  8101. (t '=)))
  8102. (list 'org-agenda-compare-effort (list 'quote op)
  8103. (org-duration-to-minutes e))))
  8104. (defun org-agenda-compare-effort (op value)
  8105. "Compare the effort of the current line with VALUE, using OP.
  8106. If the line does not have an effort defined, return nil."
  8107. ;; `effort-minutes' property cannot be extracted directly from
  8108. ;; current line but is stored as a property in `txt'.
  8109. (let ((effort (get-text-property 0 'effort-minutes (org-get-at-bol 'txt))))
  8110. (funcall op
  8111. (or effort (if org-agenda-sort-noeffort-is-high 32767 -1))
  8112. value)))
  8113. (defun org-agenda-filter-expand-tags (filter &optional no-operator)
  8114. "Expand group tags in FILTER for the agenda.
  8115. When NO-OPERATOR is non-nil, do not add the + operator to
  8116. returned tags."
  8117. (if org-group-tags
  8118. (let (case-fold-search rtn)
  8119. (mapc
  8120. (lambda (f)
  8121. (let (f0 dir)
  8122. (if (string-match "^\\([+-]\\)\\(.+\\)" f)
  8123. (setq dir (match-string 1 f) f0 (match-string 2 f))
  8124. (setq dir (if no-operator "" "+") f0 f))
  8125. (setq rtn (append (mapcar (lambda(f1) (concat dir f1))
  8126. (org-tags-expand f0 t))
  8127. rtn))))
  8128. filter)
  8129. (reverse rtn))
  8130. filter))
  8131. (defun org-agenda-filter-apply (filter type &optional expand)
  8132. "Set FILTER as the new agenda filter and apply it.
  8133. Optional argument EXPAND can be used for the TYPE tag and will
  8134. expand the tags in the FILTER if any of the tags in FILTER are
  8135. grouptags."
  8136. ;; Deactivate `org-agenda-entry-text-mode' when filtering
  8137. (when org-agenda-entry-text-mode (org-agenda-entry-text-mode))
  8138. (setq org-agenda-filter-form (org-agenda-filter-make-matcher
  8139. filter type expand))
  8140. ;; Only set `org-agenda-filtered-by-category' to t when a unique
  8141. ;; category is used as the filter:
  8142. (setq org-agenda-filtered-by-category
  8143. (and (eq type 'category)
  8144. (not (equal (substring (car filter) 0 1) "-"))))
  8145. (org-agenda-set-mode-name)
  8146. (save-excursion
  8147. (goto-char (point-min))
  8148. (while (not (eobp))
  8149. (when (or (org-get-at-bol 'org-hd-marker)
  8150. (org-get-at-bol 'org-marker))
  8151. (org-dlet
  8152. ((tags (org-get-at-bol 'tags))
  8153. (cat (org-agenda-get-category))
  8154. (txt (or (org-get-at-bol 'txt) "")))
  8155. (unless (eval org-agenda-filter-form t)
  8156. (org-agenda-filter-hide-line type))))
  8157. (beginning-of-line 2)))
  8158. (when (get-char-property (point) 'invisible)
  8159. (ignore-errors (org-agenda-previous-line))))
  8160. (defun org-agenda-filter-top-headline-apply (hl &optional negative)
  8161. "Filter by top headline HL."
  8162. (org-agenda-set-mode-name)
  8163. (save-excursion
  8164. (goto-char (point-min))
  8165. (while (not (eobp))
  8166. (let* ((pos (org-get-at-bol 'org-hd-marker))
  8167. (tophl (and pos (org-find-top-headline pos))))
  8168. (when (and tophl (funcall (if negative 'identity 'not)
  8169. (string= hl tophl)))
  8170. (org-agenda-filter-hide-line 'top-headline)))
  8171. (beginning-of-line 2)))
  8172. (when (get-char-property (point) 'invisible)
  8173. (org-agenda-previous-line))
  8174. (setq org-agenda-top-headline-filter hl
  8175. org-agenda-filtered-by-top-headline t))
  8176. (defun org-agenda-filter-hide-line (type)
  8177. "If current line is TYPE, hide it in the agenda buffer."
  8178. (let* (buffer-invisibility-spec
  8179. (beg (max (point-min) (1- (line-beginning-position))))
  8180. (end (line-end-position)))
  8181. (let ((inhibit-read-only t))
  8182. (add-text-properties
  8183. beg end `(invisible org-filtered org-filter-type ,type)))))
  8184. (defun org-agenda-remove-filter (type)
  8185. "Remove filter of type TYPE from the agenda buffer."
  8186. (interactive)
  8187. (save-excursion
  8188. (goto-char (point-min))
  8189. (let ((inhibit-read-only t) pos)
  8190. (while (setq pos (text-property-any (point) (point-max)
  8191. 'org-filter-type type))
  8192. (goto-char pos)
  8193. (remove-text-properties
  8194. (point) (next-single-property-change (point) 'org-filter-type)
  8195. `(invisible org-filtered org-filter-type ,type))))
  8196. (set (intern (format "org-agenda-%s-filter" (intern-soft type))) nil)
  8197. (setq org-agenda-filter-form nil)
  8198. (org-agenda-set-mode-name)
  8199. (org-agenda-finalize)))
  8200. (defun org-agenda-filter-show-all-tag nil
  8201. (org-agenda-remove-filter 'tag))
  8202. (defun org-agenda-filter-show-all-re nil
  8203. (org-agenda-remove-filter 'regexp))
  8204. (defun org-agenda-filter-show-all-effort nil
  8205. (org-agenda-remove-filter 'effort))
  8206. (defun org-agenda-filter-show-all-cat nil
  8207. (org-agenda-remove-filter 'category))
  8208. (defun org-agenda-filter-show-all-top-filter nil
  8209. (org-agenda-remove-filter 'top-headline))
  8210. (defun org-agenda-manipulate-query-add ()
  8211. "Manipulate the query by adding a search term with positive selection.
  8212. Positive selection means the term must be matched for selection of an entry."
  8213. (interactive)
  8214. (org-agenda-manipulate-query ?\[))
  8215. (defun org-agenda-manipulate-query-subtract ()
  8216. "Manipulate the query by adding a search term with negative selection.
  8217. Negative selection means term must not be matched for selection of an entry."
  8218. (interactive)
  8219. (org-agenda-manipulate-query ?\]))
  8220. (defun org-agenda-manipulate-query-add-re ()
  8221. "Manipulate the query by adding a search regexp with positive selection.
  8222. Positive selection means the regexp must match for selection of an entry."
  8223. (interactive)
  8224. (org-agenda-manipulate-query ?\{))
  8225. (defun org-agenda-manipulate-query-subtract-re ()
  8226. "Manipulate the query by adding a search regexp with negative selection.
  8227. Negative selection means regexp must not match for selection of an entry."
  8228. (interactive)
  8229. (org-agenda-manipulate-query ?\}))
  8230. (defun org-agenda-manipulate-query (char)
  8231. (cond
  8232. ((eq org-agenda-type 'agenda)
  8233. (let ((org-agenda-include-inactive-timestamps t))
  8234. (org-agenda-redo))
  8235. (message "Display now includes inactive timestamps as well"))
  8236. ((eq org-agenda-type 'search)
  8237. (org-add-to-string
  8238. 'org-agenda-query-string
  8239. (if org-agenda-last-search-view-search-was-boolean
  8240. (cdr (assoc char '((?\[ . " +") (?\] . " -")
  8241. (?\{ . " +{}") (?\} . " -{}"))))
  8242. " "))
  8243. (setq org-agenda-redo-command
  8244. (list 'org-search-view
  8245. (car (get-text-property (min (1- (point-max)) (point))
  8246. 'org-last-args))
  8247. org-agenda-query-string
  8248. (+ (length org-agenda-query-string)
  8249. (if (member char '(?\{ ?\})) 0 1))))
  8250. (set-register org-agenda-query-register org-agenda-query-string)
  8251. (let ((org-agenda-overriding-arguments
  8252. (cdr org-agenda-redo-command)))
  8253. (org-agenda-redo)))
  8254. (t (error "Cannot manipulate query for %s-type agenda buffers"
  8255. org-agenda-type))))
  8256. (defun org-add-to-string (var string)
  8257. (set var (concat (symbol-value var) string)))
  8258. (defun org-agenda-goto-date (date)
  8259. "Jump to DATE in the agenda buffer.
  8260. When called interactively, prompt for the date.
  8261. When called from Lisp, DATE should be a date as returned by
  8262. `org-read-date'.
  8263. See also:
  8264. `org-agenda-earlier' (\\[org-agenda-earlier])
  8265. `org-agenda-later' (\\[org-agenda-later])
  8266. `org-agenda-goto-today' (\\[org-agenda-goto-today])"
  8267. (interactive
  8268. (list
  8269. (let ((org-read-date-prefer-future org-agenda-jump-prefer-future))
  8270. (org-read-date))))
  8271. (let* ((day (time-to-days (org-time-string-to-time date)))
  8272. (org-agenda-sticky-orig org-agenda-sticky)
  8273. (org-agenda-buffer-tmp-name (buffer-name))
  8274. (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  8275. (0-arg (or current-prefix-arg (car args)))
  8276. (2-arg (nth 2 args))
  8277. (with-hour-p (nth 4 org-agenda-redo-command))
  8278. (newcmd (list 'org-agenda-list 0-arg date
  8279. (org-agenda-span-to-ndays
  8280. 2-arg (org-time-string-to-absolute date))
  8281. with-hour-p))
  8282. (newargs (cdr newcmd))
  8283. (inhibit-read-only t)
  8284. org-agenda-sticky)
  8285. (if (not (org-agenda-check-type t 'agenda))
  8286. (error "Not available in non-agenda views")
  8287. (add-text-properties (point-min) (point-max)
  8288. `(org-redo-cmd ,newcmd org-last-args ,newargs))
  8289. (org-agenda-redo)
  8290. (goto-char (point-min))
  8291. (while (not (or (= (or (get-text-property (point) 'day) 0) day)
  8292. (save-excursion (move-beginning-of-line 2) (eobp))))
  8293. (move-beginning-of-line 2))
  8294. (setq org-agenda-sticky org-agenda-sticky-orig
  8295. org-agenda-this-buffer-is-sticky org-agenda-sticky))))
  8296. (defun org-agenda-goto-today ()
  8297. "Go to today's date in the agenda buffer.
  8298. See also:
  8299. `org-agenda-later' (\\[org-agenda-later])
  8300. `org-agenda-earlier' (\\[org-agenda-earlier])
  8301. `org-agenda-goto-date' (\\[org-agenda-goto-date])"
  8302. (interactive)
  8303. (org-agenda-check-type t 'agenda)
  8304. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  8305. (curspan (nth 2 args))
  8306. (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
  8307. (cond
  8308. (tdpos (goto-char tdpos))
  8309. ((eq org-agenda-type 'agenda)
  8310. (let* ((sd (org-agenda-compute-starting-span
  8311. (org-today) (or curspan org-agenda-span)))
  8312. (org-agenda-overriding-arguments args))
  8313. (setf (nth 1 org-agenda-overriding-arguments) sd)
  8314. (org-agenda-redo)
  8315. (org-agenda-find-same-or-today-or-agenda)))
  8316. (t (error "Cannot find today")))))
  8317. (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
  8318. (goto-char
  8319. (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
  8320. (text-property-any (point-min) (point-max) 'org-today t)
  8321. (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
  8322. (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
  8323. (org-agenda-backward-block))
  8324. (point-min))))
  8325. (defun org-agenda-backward-block ()
  8326. "Move backward by one agenda block."
  8327. (interactive)
  8328. (org-agenda-forward-block 'backward))
  8329. (defun org-agenda-forward-block (&optional backward)
  8330. "Move forward by one agenda block.
  8331. When optional argument BACKWARD is set, go backward."
  8332. (interactive)
  8333. (cond ((not (derived-mode-p 'org-agenda-mode))
  8334. (user-error
  8335. "Cannot execute this command outside of org-agenda-mode buffers"))
  8336. ((looking-at (if backward "\\`" "\\'"))
  8337. (message "Already at the %s block" (if backward "first" "last")))
  8338. (t (let ((_pos (prog1 (point)
  8339. (ignore-errors (if backward (backward-char 1)
  8340. (move-end-of-line 1)))))
  8341. (f (if backward
  8342. #'previous-single-property-change
  8343. #'next-single-property-change))
  8344. moved dest)
  8345. (while (and (setq dest (funcall
  8346. f (point) 'org-agenda-structural-header))
  8347. (not (get-text-property
  8348. (point) 'org-agenda-structural-header)))
  8349. (setq moved t)
  8350. (goto-char dest))
  8351. (if moved (move-beginning-of-line 1)
  8352. (goto-char (if backward (point-min) (point-max)))
  8353. (move-beginning-of-line 1)
  8354. (message "No %s block" (if backward "previous" "further")))))))
  8355. (defun org-agenda-later (arg)
  8356. "Go forward in time by the current span in the agenda buffer.
  8357. With prefix ARG, go forward that many times the current span.
  8358. See also:
  8359. `org-agenda-earlier' (\\[org-agenda-earlier])
  8360. `org-agenda-goto-today' (\\[org-agenda-goto-today])
  8361. `org-agenda-goto-date' (\\[org-agenda-goto-date])"
  8362. (interactive "p")
  8363. (org-agenda-check-type t 'agenda)
  8364. (let* ((wstart (window-start))
  8365. (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  8366. (span (or (nth 2 args) org-agenda-current-span))
  8367. (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
  8368. (greg (calendar-gregorian-from-absolute sd))
  8369. (cnt (org-get-at-bol 'org-day-cnt))
  8370. greg2)
  8371. (cond
  8372. ((numberp span)
  8373. (setq sd (+ (* span arg) sd)))
  8374. ((eq span 'day)
  8375. (setq sd (+ arg sd)))
  8376. ((eq span 'week)
  8377. (setq sd (+ (* 7 arg) sd)))
  8378. ((eq span 'fortnight)
  8379. (setq sd (+ (* 14 arg) sd)))
  8380. ((eq span 'month)
  8381. (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
  8382. sd (calendar-absolute-from-gregorian greg2))
  8383. (setcar greg2 (1+ (car greg2))))
  8384. ((eq span 'year)
  8385. (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
  8386. sd (calendar-absolute-from-gregorian greg2))
  8387. (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
  8388. (t
  8389. (setq sd (+ (* span arg) sd))))
  8390. (let ((org-agenda-overriding-cmd
  8391. ;; `cmd' may have been set by `org-agenda-run-series' which
  8392. ;; uses `org-agenda-overriding-cmd' to decide whether
  8393. ;; overriding is allowed for `cmd'
  8394. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  8395. (org-agenda-overriding-arguments
  8396. (list (car args) sd span)))
  8397. (org-agenda-redo)
  8398. (org-agenda-find-same-or-today-or-agenda cnt))
  8399. (set-window-start nil wstart)))
  8400. (defun org-agenda-earlier (arg)
  8401. "Go backward in time by the current span in the agenda buffer.
  8402. With prefix ARG, go backward that many times the current span.
  8403. See also:
  8404. `org-agenda-later' (\\[org-agenda-later])
  8405. `org-agenda-goto-today' (\\[org-agenda-goto-today])
  8406. `org-agenda-goto-date' (\\[org-agenda-goto-date])"
  8407. (interactive "p")
  8408. (org-agenda-later (- arg)))
  8409. (defun org-agenda-view-mode-dispatch ()
  8410. "Call one of the view mode commands."
  8411. (interactive)
  8412. (org-unlogged-message
  8413. "View: [d]ay [w]eek for[t]night [m]onth [y]ear [SPC]reset [q]uit/abort
  8414. time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
  8415. [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
  8416. (pcase (read-char-exclusive)
  8417. (?\ (call-interactively 'org-agenda-reset-view))
  8418. (?d (call-interactively 'org-agenda-day-view))
  8419. (?w (call-interactively 'org-agenda-week-view))
  8420. (?t (call-interactively 'org-agenda-fortnight-view))
  8421. (?m (call-interactively 'org-agenda-month-view))
  8422. (?y (call-interactively 'org-agenda-year-view))
  8423. (?l (call-interactively 'org-agenda-log-mode))
  8424. (?L (org-agenda-log-mode '(4)))
  8425. (?c (org-agenda-log-mode 'clockcheck))
  8426. ((or ?F ?f) (call-interactively 'org-agenda-follow-mode))
  8427. (?a (call-interactively 'org-agenda-archives-mode))
  8428. (?A (org-agenda-archives-mode 'files))
  8429. ((or ?R ?r) (call-interactively 'org-agenda-clockreport-mode))
  8430. ((or ?E ?e) (call-interactively 'org-agenda-entry-text-mode))
  8431. (?G (call-interactively 'org-agenda-toggle-time-grid))
  8432. (?D (call-interactively 'org-agenda-toggle-diary))
  8433. (?\! (call-interactively 'org-agenda-toggle-deadlines))
  8434. (?\[ (let ((org-agenda-include-inactive-timestamps t))
  8435. (org-agenda-check-type t 'agenda)
  8436. (org-agenda-redo))
  8437. (message "Display now includes inactive timestamps as well"))
  8438. (?q (message "Abort"))
  8439. (key (user-error "Invalid key: %s" key))))
  8440. (defun org-agenda-reset-view ()
  8441. "Switch to default view for agenda."
  8442. (interactive)
  8443. (org-agenda-change-time-span org-agenda-span))
  8444. (defun org-agenda-day-view (&optional day-of-month)
  8445. "Switch to daily view for agenda.
  8446. With argument DAY-OF-MONTH, switch to that day of the month."
  8447. (interactive "P")
  8448. (org-agenda-change-time-span 'day day-of-month))
  8449. (defun org-agenda-week-view (&optional iso-week)
  8450. "Switch to weekly view for agenda.
  8451. With argument ISO-WEEK, switch to the corresponding ISO week.
  8452. If ISO-WEEK has more then 2 digits, only the last two encode
  8453. the week. Any digits before this encode a year. So 200712
  8454. means week 12 of year 2007. Years ranging from 70 years ago
  8455. to 30 years in the future can also be written as 2-digit years."
  8456. (interactive "P")
  8457. (org-agenda-change-time-span 'week iso-week))
  8458. (defun org-agenda-fortnight-view (&optional iso-week)
  8459. "Switch to fortnightly view for agenda.
  8460. With argument ISO-WEEK, switch to the corresponding ISO week.
  8461. If ISO-WEEK has more then 2 digits, only the last two encode
  8462. the week. Any digits before this encode a year. So 200712
  8463. means week 12 of year 2007. Years ranging from 70 years ago
  8464. to 30 years in the future can also be written as 2-digit years."
  8465. (interactive "P")
  8466. (org-agenda-change-time-span 'fortnight iso-week))
  8467. (defun org-agenda-month-view (&optional month)
  8468. "Switch to monthly view for agenda.
  8469. With argument MONTH, switch to that month. If MONTH has more
  8470. then 2 digits, only the last two encode the month. Any digits
  8471. before this encode a year. So 200712 means December year 2007.
  8472. Years ranging from 70 years ago to 30 years in the future can
  8473. also be written as 2-digit years."
  8474. (interactive "P")
  8475. (org-agenda-change-time-span 'month month))
  8476. (defun org-agenda-year-view (&optional year)
  8477. "Switch to yearly view for agenda.
  8478. With argument YEAR, switch to that year. Years ranging from 70
  8479. years ago to 30 years in the future can also be written as
  8480. 2-digit years."
  8481. (interactive "P")
  8482. (when year
  8483. (setq year (org-small-year-to-year year)))
  8484. (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
  8485. (org-agenda-change-time-span 'year year)
  8486. (error "Abort")))
  8487. (defun org-agenda-change-time-span (span &optional n)
  8488. "Change the agenda view to SPAN.
  8489. SPAN may be `day', `week', `fortnight', `month', `year'."
  8490. (org-agenda-check-type t 'agenda)
  8491. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  8492. (curspan (nth 2 args)))
  8493. (when (and (not n) (equal curspan span))
  8494. (error "Viewing span is already \"%s\"" span))
  8495. (let* ((sd (or (org-get-at-bol 'day)
  8496. (nth 1 args)
  8497. org-starting-day))
  8498. (sd (org-agenda-compute-starting-span sd span n))
  8499. (org-agenda-overriding-cmd
  8500. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  8501. (org-agenda-overriding-arguments
  8502. (list (car args) sd span)))
  8503. (org-agenda-redo)
  8504. (org-agenda-find-same-or-today-or-agenda))
  8505. (org-agenda-set-mode-name)
  8506. (message "Switched to %s view" span)))
  8507. (defun org-agenda-compute-starting-span (sd span &optional n)
  8508. "Compute starting date for agenda.
  8509. SPAN may be `day', `week', `fortnight', `month', `year'. The return value
  8510. is a cons cell with the starting date and the number of days,
  8511. so that the date SD will be in that range."
  8512. (let* ((greg (calendar-gregorian-from-absolute sd))
  8513. ;; (dg (nth 1 greg))
  8514. (mg (car greg))
  8515. (yg (nth 2 greg)))
  8516. (cond
  8517. ((eq span 'day)
  8518. (when n
  8519. (setq sd (+ (calendar-absolute-from-gregorian
  8520. (list mg 1 yg))
  8521. n -1))))
  8522. ((or (eq span 'week) (eq span 'fortnight))
  8523. (let* ((nt (calendar-day-of-week
  8524. (calendar-gregorian-from-absolute sd)))
  8525. (d (if org-agenda-start-on-weekday
  8526. (- nt org-agenda-start-on-weekday)
  8527. 0))
  8528. y1)
  8529. (setq sd (- sd (+ (if (< d 0) 7 0) d)))
  8530. (when n
  8531. (require 'cal-iso)
  8532. (when (> n 99)
  8533. (setq y1 (org-small-year-to-year (/ n 100))
  8534. n (mod n 100)))
  8535. (setq sd
  8536. (calendar-iso-to-absolute
  8537. (list n 1
  8538. (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
  8539. ((eq span 'month)
  8540. (let (y1)
  8541. (when (and n (> n 99))
  8542. (setq y1 (org-small-year-to-year (/ n 100))
  8543. n (mod n 100)))
  8544. (setq sd (calendar-absolute-from-gregorian
  8545. (list (or n mg) 1 (or y1 yg))))))
  8546. ((eq span 'year)
  8547. (setq sd (calendar-absolute-from-gregorian
  8548. (list 1 1 (or n yg))))))
  8549. sd))
  8550. (defun org-agenda-next-date-line (&optional arg)
  8551. "Jump to the next line indicating a date in agenda buffer."
  8552. (interactive "p")
  8553. (org-agenda-check-type t 'agenda)
  8554. (beginning-of-line 1)
  8555. ;; This does not work if user makes date format that starts with a blank
  8556. (when (looking-at-p "^\\S-") (forward-char 1))
  8557. (unless (re-search-forward "^\\S-" nil t arg)
  8558. (backward-char 1)
  8559. (error "No next date after this line in this buffer"))
  8560. (goto-char (match-beginning 0)))
  8561. (defun org-agenda-previous-date-line (&optional arg)
  8562. "Jump to the previous line indicating a date in agenda buffer."
  8563. (interactive "p")
  8564. (org-agenda-check-type t 'agenda)
  8565. (beginning-of-line 1)
  8566. (unless (re-search-backward "^\\S-" nil t arg)
  8567. (error "No previous date before this line in this buffer")))
  8568. ;; Initialize the highlight
  8569. (defvar org-hl (make-overlay 1 1))
  8570. (overlay-put org-hl 'face 'highlight)
  8571. (defun org-highlight (begin end &optional buffer)
  8572. "Highlight a region with overlay."
  8573. (move-overlay org-hl begin end (or buffer (current-buffer))))
  8574. (defun org-unhighlight ()
  8575. "Detach overlay INDEX."
  8576. (delete-overlay org-hl))
  8577. (defun org-unhighlight-once ()
  8578. "Remove the highlight from its position, and this function from the hook."
  8579. (remove-hook 'pre-command-hook #'org-unhighlight-once)
  8580. (org-unhighlight))
  8581. (defvar org-agenda-pre-follow-window-conf nil)
  8582. (defun org-agenda-follow-mode ()
  8583. "Toggle follow mode in an agenda buffer."
  8584. (interactive)
  8585. (unless org-agenda-follow-mode
  8586. (setq org-agenda-pre-follow-window-conf
  8587. (current-window-configuration)))
  8588. (setq org-agenda-follow-mode (not org-agenda-follow-mode))
  8589. (unless org-agenda-follow-mode
  8590. (set-window-configuration org-agenda-pre-follow-window-conf))
  8591. (org-agenda-set-mode-name)
  8592. (org-agenda-do-context-action)
  8593. (message "Follow mode is %s"
  8594. (if org-agenda-follow-mode "on" "off")))
  8595. (defun org-agenda-entry-text-mode (&optional arg)
  8596. "Toggle entry text mode in an agenda buffer."
  8597. (interactive "P")
  8598. (if (or org-agenda-tag-filter
  8599. org-agenda-category-filter
  8600. org-agenda-regexp-filter
  8601. org-agenda-top-headline-filter)
  8602. (user-error "Can't show entry text in filtered views")
  8603. (setq org-agenda-entry-text-mode (or (integerp arg)
  8604. (not org-agenda-entry-text-mode)))
  8605. (org-agenda-entry-text-hide)
  8606. (and org-agenda-entry-text-mode
  8607. (let ((org-agenda-entry-text-maxlines
  8608. (if (integerp arg) arg org-agenda-entry-text-maxlines)))
  8609. (org-agenda-entry-text-show)))
  8610. (org-agenda-set-mode-name)
  8611. (message "Entry text mode is %s%s"
  8612. (if org-agenda-entry-text-mode "on" "off")
  8613. (if (not org-agenda-entry-text-mode) ""
  8614. (format " (maximum number of lines is %d)"
  8615. (if (integerp arg) arg org-agenda-entry-text-maxlines))))))
  8616. (defun org-agenda-clockreport-mode ()
  8617. "Toggle clocktable mode in an agenda buffer."
  8618. (interactive)
  8619. (org-agenda-check-type t 'agenda)
  8620. (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode))
  8621. (org-agenda-set-mode-name)
  8622. (org-agenda-redo)
  8623. (message "Clocktable mode is %s"
  8624. (if org-agenda-clockreport-mode "on" "off")))
  8625. (defun org-agenda-log-mode (&optional special)
  8626. "Toggle log mode in an agenda buffer.
  8627. With argument SPECIAL, show all possible log items, not only the ones
  8628. configured in `org-agenda-log-mode-items'.
  8629. With a `\\[universal-argument] \\[universal-argument]' prefix, show *only* \
  8630. log items, nothing else."
  8631. (interactive "P")
  8632. (org-agenda-check-type t 'agenda)
  8633. (setq org-agenda-show-log
  8634. (cond
  8635. ((equal special '(16)) 'only)
  8636. ((eq special 'clockcheck)
  8637. (if (eq org-agenda-show-log 'clockcheck)
  8638. nil 'clockcheck))
  8639. (special '(closed clock state))
  8640. (t (not org-agenda-show-log))))
  8641. (org-agenda-set-mode-name)
  8642. (org-agenda-redo)
  8643. (message "Log mode is %s" (if org-agenda-show-log "on" "off")))
  8644. (defun org-agenda-archives-mode (&optional with-files)
  8645. "Toggle inclusion of items in trees marked with :ARCHIVE:.
  8646. When called with a prefix argument, include all archive files as well."
  8647. (interactive "P")
  8648. (setq org-agenda-archives-mode
  8649. (cond ((and with-files (eq org-agenda-archives-mode t)) nil)
  8650. (with-files t)
  8651. (org-agenda-archives-mode nil)
  8652. (t 'trees)))
  8653. (org-agenda-set-mode-name)
  8654. (org-agenda-redo)
  8655. (message
  8656. "%s"
  8657. (cond
  8658. ((eq org-agenda-archives-mode nil)
  8659. "No archives are included")
  8660. ((eq org-agenda-archives-mode 'trees)
  8661. (format "Trees with :%s: tag are included" org-archive-tag))
  8662. ((eq org-agenda-archives-mode t)
  8663. (format "Trees with :%s: tag and all active archive files are included"
  8664. org-archive-tag)))))
  8665. (defun org-agenda-toggle-diary ()
  8666. "Toggle diary inclusion in an agenda buffer."
  8667. (interactive)
  8668. (org-agenda-check-type t 'agenda)
  8669. (setq org-agenda-include-diary (not org-agenda-include-diary))
  8670. (org-agenda-redo)
  8671. (org-agenda-set-mode-name)
  8672. (message "Diary inclusion turned %s"
  8673. (if org-agenda-include-diary "on" "off")))
  8674. (defun org-agenda-toggle-deadlines ()
  8675. "Toggle inclusion of entries with a deadline in an agenda buffer."
  8676. (interactive)
  8677. (org-agenda-check-type t 'agenda)
  8678. (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
  8679. (org-agenda-redo)
  8680. (org-agenda-set-mode-name)
  8681. (message "Deadlines inclusion turned %s"
  8682. (if org-agenda-include-deadlines "on" "off")))
  8683. (defun org-agenda-toggle-time-grid ()
  8684. "Toggle time grid in an agenda buffer."
  8685. (interactive)
  8686. (org-agenda-check-type t 'agenda)
  8687. (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
  8688. (org-agenda-redo)
  8689. (org-agenda-set-mode-name)
  8690. (message "Time-grid turned %s"
  8691. (if org-agenda-use-time-grid "on" "off")))
  8692. (defun org-agenda-set-mode-name ()
  8693. "Set the mode name to indicate all the small mode settings."
  8694. (setq mode-name
  8695. (list "Org-Agenda"
  8696. (if (get 'org-agenda-files 'org-restrict) " []" "")
  8697. " "
  8698. '(:eval (org-agenda-span-name org-agenda-current-span))
  8699. (if org-agenda-follow-mode " Follow" "")
  8700. (if org-agenda-entry-text-mode " ETxt" "")
  8701. (if org-agenda-include-diary " Diary" "")
  8702. (if org-agenda-include-deadlines " Ddl" "")
  8703. (if org-agenda-use-time-grid " Grid" "")
  8704. (if (and (boundp 'org-habit-show-habits)
  8705. org-habit-show-habits)
  8706. " Habit" "")
  8707. (cond
  8708. ((consp org-agenda-show-log) " LogAll")
  8709. ((eq org-agenda-show-log 'clockcheck) " ClkCk")
  8710. (org-agenda-show-log " Log")
  8711. (t ""))
  8712. (if (org-agenda-filter-any) " " "")
  8713. (if (or org-agenda-category-filter
  8714. (get 'org-agenda-category-filter :preset-filter))
  8715. '(:eval (propertize
  8716. (concat "["
  8717. (mapconcat
  8718. #'identity
  8719. (append
  8720. (get 'org-agenda-category-filter :preset-filter)
  8721. org-agenda-category-filter)
  8722. "")
  8723. "]")
  8724. 'face 'org-agenda-filter-category
  8725. 'help-echo "Category used in filtering"))
  8726. "")
  8727. (if (or org-agenda-tag-filter
  8728. (get 'org-agenda-tag-filter :preset-filter))
  8729. '(:eval (propertize
  8730. (concat (mapconcat
  8731. #'identity
  8732. (append
  8733. (get 'org-agenda-tag-filter :preset-filter)
  8734. org-agenda-tag-filter)
  8735. ""))
  8736. 'face 'org-agenda-filter-tags
  8737. 'help-echo "Tags used in filtering"))
  8738. "")
  8739. (if (or org-agenda-effort-filter
  8740. (get 'org-agenda-effort-filter :preset-filter))
  8741. '(:eval (propertize
  8742. (concat (mapconcat
  8743. #'identity
  8744. (append
  8745. (get 'org-agenda-effort-filter :preset-filter)
  8746. org-agenda-effort-filter)
  8747. ""))
  8748. 'face 'org-agenda-filter-effort
  8749. 'help-echo "Effort conditions used in filtering"))
  8750. "")
  8751. (if (or org-agenda-regexp-filter
  8752. (get 'org-agenda-regexp-filter :preset-filter))
  8753. '(:eval (propertize
  8754. (concat (mapconcat
  8755. (lambda (x) (concat (substring x 0 1) "/" (substring x 1) "/"))
  8756. (append
  8757. (get 'org-agenda-regexp-filter :preset-filter)
  8758. org-agenda-regexp-filter)
  8759. ""))
  8760. 'face 'org-agenda-filter-regexp
  8761. 'help-echo "Regexp used in filtering"))
  8762. "")
  8763. (if org-agenda-archives-mode
  8764. (if (eq org-agenda-archives-mode t)
  8765. " Archives"
  8766. (format " :%s:" org-archive-tag))
  8767. "")
  8768. (if org-agenda-clockreport-mode " Clock" "")))
  8769. (force-mode-line-update))
  8770. (defun org-agenda-update-agenda-type ()
  8771. "Update the agenda type after each command."
  8772. (setq org-agenda-type
  8773. (or (get-text-property (point) 'org-agenda-type)
  8774. (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
  8775. (defun org-agenda-next-line ()
  8776. "Move cursor to the next line, and show if follow mode is active."
  8777. (interactive)
  8778. (call-interactively 'next-line)
  8779. (org-agenda-do-context-action))
  8780. (defun org-agenda-previous-line ()
  8781. "Move cursor to the previous line, and show if follow-mode is active."
  8782. (interactive)
  8783. (call-interactively 'previous-line)
  8784. (org-agenda-do-context-action))
  8785. (defun org-agenda-next-item (n)
  8786. "Move cursor to next agenda item."
  8787. (interactive "p")
  8788. (let ((col (current-column)))
  8789. (dotimes (_ n)
  8790. (when (next-single-property-change (line-end-position) 'org-marker)
  8791. (move-end-of-line 1)
  8792. (goto-char (next-single-property-change (point) 'org-marker))))
  8793. (org-move-to-column col))
  8794. (org-agenda-do-context-action))
  8795. (defun org-agenda-previous-item (n)
  8796. "Move cursor to next agenda item."
  8797. (interactive "p")
  8798. (dotimes (_ n)
  8799. (let ((col (current-column))
  8800. (goto (save-excursion
  8801. (move-end-of-line 0)
  8802. (previous-single-property-change (point) 'org-marker))))
  8803. (when goto (goto-char goto))
  8804. (org-move-to-column col)))
  8805. (org-agenda-do-context-action))
  8806. (defun org-agenda-do-context-action ()
  8807. "Show outline path and, maybe, follow mode window."
  8808. (let ((m (org-get-at-bol 'org-marker)))
  8809. (when (and (markerp m) (marker-buffer m))
  8810. (and org-agenda-follow-mode
  8811. (if org-agenda-follow-indirect
  8812. (org-agenda-tree-to-indirect-buffer nil)
  8813. (org-agenda-show)))
  8814. (and org-agenda-show-outline-path
  8815. (org-with-point-at m (org-display-outline-path t))))))
  8816. (defun org-agenda-show-tags ()
  8817. "Show the tags applicable to the current item."
  8818. (interactive)
  8819. (let* ((tags (org-get-at-bol 'tags)))
  8820. (if tags
  8821. (message "Tags are :%s:"
  8822. (org-no-properties (mapconcat #'identity tags ":")))
  8823. (message "No tags associated with this line"))))
  8824. (defun org-agenda-goto (&optional highlight)
  8825. "Go to the entry at point in the corresponding Org file."
  8826. (interactive)
  8827. (let* ((marker (or (org-get-at-bol 'org-marker)
  8828. (org-agenda-error)))
  8829. (buffer (marker-buffer marker))
  8830. (pos (marker-position marker)))
  8831. ;; FIXME: use `org-switch-to-buffer-other-window'?
  8832. (switch-to-buffer-other-window buffer)
  8833. (widen)
  8834. (push-mark)
  8835. (goto-char pos)
  8836. (when (derived-mode-p 'org-mode)
  8837. (org-fold-show-context 'agenda)
  8838. (recenter (/ (window-height) 2))
  8839. (org-back-to-heading t)
  8840. (let ((case-fold-search nil))
  8841. (when (re-search-forward org-complex-heading-regexp nil t)
  8842. (goto-char (match-beginning 4)))))
  8843. (run-hooks 'org-agenda-after-show-hook)
  8844. (and highlight (org-highlight (line-beginning-position) (line-end-position)))))
  8845. (defvar org-agenda-after-show-hook nil
  8846. "Normal hook run after an item has been shown from the agenda.
  8847. Point is in the buffer where the item originated.")
  8848. ;; Defined later in org-agenda.el
  8849. (defvar org-agenda-loop-over-headlines-in-active-region nil)
  8850. (defun org-agenda-do-in-region (beg end cmd &optional arg force-arg delete)
  8851. "Between region BEG and END, call agenda command CMD.
  8852. When optional argument ARG is non-nil or FORCE-ARG is t, pass
  8853. ARG to CMD. When optional argument DELETE is non-nil, assume CMD
  8854. deletes the agenda entry and don't move to the next entry."
  8855. (save-excursion
  8856. (goto-char beg)
  8857. (let ((mend (move-marker (make-marker) end))
  8858. (all (eq org-agenda-loop-over-headlines-in-active-region t))
  8859. (match (and (stringp org-agenda-loop-over-headlines-in-active-region)
  8860. org-agenda-loop-over-headlines-in-active-region))
  8861. (level (and (eq org-agenda-loop-over-headlines-in-active-region 'start-level)
  8862. (org-get-at-bol 'level))))
  8863. (while (< (point) mend)
  8864. (let ((ov (make-overlay (point) (line-end-position))))
  8865. (if (not (or all
  8866. (and match (looking-at-p match))
  8867. (eq level (org-get-at-bol 'level))))
  8868. (org-agenda-next-item 1)
  8869. (overlay-put ov 'face 'region)
  8870. (if (or arg force-arg) (funcall cmd arg) (funcall cmd))
  8871. (when (not delete) (org-agenda-next-item 1))
  8872. (delete-overlay ov)))))))
  8873. ;; org-agenda-[schedule,deadline,date-prompt,todo,[toggle]archive*,
  8874. ;; kill,set-property,set-effort] commands may loop over agenda
  8875. ;; entries. Commands `org-agenda-set-tags' and `org-agenda-bulk-mark'
  8876. ;; use their own mechanisms on active regions.
  8877. (defmacro org-agenda-maybe-loop (cmd arg force-arg delete &rest body)
  8878. "Maybe loop over agenda entries and perform CMD.
  8879. Pass ARG, FORCE-ARG, DELETE and BODY to `org-agenda-do-in-region'."
  8880. (declare (debug t))
  8881. `(if (and (called-interactively-p 'any)
  8882. org-agenda-loop-over-headlines-in-active-region
  8883. (org-region-active-p))
  8884. (org-agenda-do-in-region
  8885. (region-beginning) (region-end) ,cmd ,arg ,force-arg ,delete)
  8886. ,@body))
  8887. (defun org-agenda-kill ()
  8888. "Kill the entry or subtree belonging to the current agenda entry."
  8889. (interactive)
  8890. (or (eq major-mode 'org-agenda-mode) (user-error "Not in agenda"))
  8891. (org-agenda-maybe-loop
  8892. #'org-agenda-kill nil nil t
  8893. (let* ((bufname-orig (buffer-name))
  8894. (marker (or (org-get-at-bol 'org-marker)
  8895. (org-agenda-error)))
  8896. (buffer (marker-buffer marker))
  8897. (pos (marker-position marker))
  8898. (type (org-get-at-bol 'type))
  8899. dbeg dend (n 0))
  8900. (org-with-remote-undo buffer
  8901. (with-current-buffer buffer
  8902. (save-excursion
  8903. (goto-char pos)
  8904. (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
  8905. (setq dbeg (progn (org-back-to-heading t) (point))
  8906. dend (org-end-of-subtree t t))
  8907. (setq dbeg (line-beginning-position)
  8908. dend (min (point-max) (1+ (line-end-position)))))
  8909. (goto-char dbeg)
  8910. (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
  8911. (when (or (eq t org-agenda-confirm-kill)
  8912. (and (numberp org-agenda-confirm-kill)
  8913. (> n org-agenda-confirm-kill)))
  8914. (let ((win-conf (current-window-configuration)))
  8915. (unwind-protect
  8916. (and
  8917. (prog2
  8918. (org-agenda-tree-to-indirect-buffer nil)
  8919. (not (y-or-n-p
  8920. (format "Delete entry with %d lines in buffer \"%s\"? "
  8921. n (buffer-name buffer))))
  8922. (kill-buffer org-last-indirect-buffer))
  8923. (error "Abort"))
  8924. (set-window-configuration win-conf))))
  8925. (let ((org-agenda-buffer-name bufname-orig))
  8926. (org-remove-subtree-entries-from-agenda buffer dbeg dend))
  8927. (with-current-buffer buffer (delete-region dbeg dend))
  8928. (message "Agenda item and source killed")))))
  8929. (defvar org-archive-default-command) ; defined in org-archive.el
  8930. (defun org-agenda-archive-default ()
  8931. "Archive the entry or subtree belonging to the current agenda entry."
  8932. (interactive)
  8933. (require 'org-archive)
  8934. (funcall-interactively
  8935. #'org-agenda-archive-with org-archive-default-command))
  8936. (defun org-agenda-archive-default-with-confirmation ()
  8937. "Archive the entry or subtree belonging to the current agenda entry."
  8938. (interactive)
  8939. (require 'org-archive)
  8940. (funcall-interactively
  8941. #'org-agenda-archive-with org-archive-default-command 'confirm))
  8942. (defun org-agenda-archive ()
  8943. "Archive the entry or subtree belonging to the current agenda entry."
  8944. (interactive)
  8945. (funcall-interactively
  8946. #'org-agenda-archive-with 'org-archive-subtree))
  8947. (defun org-agenda-archive-to-archive-sibling ()
  8948. "Move the entry to the archive sibling."
  8949. (interactive)
  8950. (funcall-interactively
  8951. #'org-agenda-archive-with 'org-archive-to-archive-sibling))
  8952. (defvar org-archive-from-agenda)
  8953. (defun org-agenda-archive-with (cmd &optional confirm)
  8954. "Move the entry to the archive sibling."
  8955. (interactive)
  8956. (or (eq major-mode 'org-agenda-mode) (user-error "Not in agenda"))
  8957. (org-agenda-maybe-loop
  8958. #'org-agenda-archive-with cmd nil t
  8959. (let* ((bufname-orig (buffer-name))
  8960. (marker (or (org-get-at-bol 'org-marker)
  8961. (org-agenda-error)))
  8962. (buffer (marker-buffer marker))
  8963. (pos (marker-position marker)))
  8964. (org-with-remote-undo buffer
  8965. (with-current-buffer buffer
  8966. (if (derived-mode-p 'org-mode)
  8967. (if (and confirm
  8968. (not (y-or-n-p "Archive this subtree or entry? ")))
  8969. (error "Abort")
  8970. (save-window-excursion
  8971. (goto-char pos)
  8972. (let ((org-agenda-buffer-name bufname-orig))
  8973. (org-remove-subtree-entries-from-agenda))
  8974. (org-back-to-heading t)
  8975. (let ((org-archive-from-agenda t))
  8976. (funcall cmd))))
  8977. (error "Archiving works only in Org files")))))))
  8978. (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
  8979. "Remove all lines in the agenda that correspond to a given subtree.
  8980. The subtree is the one in buffer BUF, starting at BEG and ending at END.
  8981. If this information is not given, the function uses the tree at point."
  8982. (let ((buf (or buf (current-buffer))) m p)
  8983. (save-excursion
  8984. (unless (and beg end)
  8985. (org-back-to-heading t)
  8986. (setq beg (point))
  8987. (org-end-of-subtree t)
  8988. (setq end (point)))
  8989. (set-buffer (get-buffer org-agenda-buffer-name))
  8990. (save-excursion
  8991. (goto-char (point-max))
  8992. (beginning-of-line 1)
  8993. (while (not (bobp))
  8994. (when (and (setq m (org-get-at-bol 'org-marker))
  8995. (equal buf (marker-buffer m))
  8996. (setq p (marker-position m))
  8997. (>= p beg)
  8998. (< p end))
  8999. (let ((inhibit-read-only t))
  9000. (delete-region (line-beginning-position) (1+ (line-end-position)))))
  9001. (beginning-of-line 0))))))
  9002. (defun org-agenda-refile (&optional goto rfloc no-update)
  9003. "Refile the item at point.
  9004. When called with `\\[universal-argument] \\[universal-argument]', \
  9005. go to the location of the last
  9006. refiled item.
  9007. When called with `\\[universal-argument] \\[universal-argument] \
  9008. \\[universal-argument]' prefix or when GOTO is 0, clear
  9009. the refile cache.
  9010. RFLOC can be a refile location obtained in a different way.
  9011. When NO-UPDATE is non-nil, don't redo the agenda buffer."
  9012. (interactive "P")
  9013. (cond
  9014. ((member goto '(0 (64)))
  9015. (org-refile-cache-clear))
  9016. ((equal goto '(16))
  9017. (org-refile-goto-last-stored))
  9018. (t
  9019. (let* ((buffer-orig (buffer-name))
  9020. (marker (or (org-get-at-bol 'org-hd-marker)
  9021. (org-agenda-error)))
  9022. (buffer (marker-buffer marker))
  9023. ;; (pos (marker-position marker))
  9024. (rfloc (or rfloc
  9025. (org-refile-get-location
  9026. (if goto "Goto" "Refile to") buffer
  9027. org-refile-allow-creating-parent-nodes))))
  9028. (with-current-buffer buffer
  9029. (org-with-wide-buffer
  9030. (goto-char marker)
  9031. (let ((org-agenda-buffer-name buffer-orig))
  9032. (org-remove-subtree-entries-from-agenda))
  9033. (org-refile goto buffer rfloc))))
  9034. (unless no-update (org-agenda-redo)))))
  9035. (defun org-agenda-open-link (&optional arg)
  9036. "Open the link(s) in the current entry, if any.
  9037. This looks for a link in the displayed line in the agenda.
  9038. It also looks at the text of the entry itself."
  9039. (interactive "P")
  9040. (let* ((marker (or (org-get-at-bol 'org-hd-marker)
  9041. (org-get-at-bol 'org-marker)))
  9042. (buffer (and marker (marker-buffer marker)))
  9043. (prefix (buffer-substring (line-beginning-position) (line-end-position)))
  9044. (lkall (and buffer (org-offer-links-in-entry
  9045. buffer marker arg prefix)))
  9046. (lk0 (car lkall))
  9047. (lk (if (stringp lk0) (list lk0) lk0))
  9048. (lkend (cdr lkall))
  9049. trg)
  9050. (cond
  9051. ((and buffer lk)
  9052. (mapcar (lambda(l)
  9053. (with-current-buffer buffer
  9054. (setq trg (and (string-match org-link-bracket-re l)
  9055. (match-string 1 l)))
  9056. (if (or (not trg) (string-match org-link-any-re trg))
  9057. ;; Don't use `org-with-wide-buffer' here as
  9058. ;; opening the link may result in moving the point
  9059. (save-restriction
  9060. (widen)
  9061. (goto-char marker)
  9062. (when (search-forward l nil lkend)
  9063. (goto-char (match-beginning 0))
  9064. (org-open-at-point)))
  9065. ;; This is an internal link, widen the buffer
  9066. ;; FIXME: use `org-switch-to-buffer-other-window'?
  9067. (switch-to-buffer-other-window buffer)
  9068. (widen)
  9069. (goto-char marker)
  9070. (when (search-forward l nil lkend)
  9071. (goto-char (match-beginning 0))
  9072. (org-open-at-point)))))
  9073. lk))
  9074. ((or (org-in-regexp (concat "\\(" org-link-bracket-re "\\)"))
  9075. (save-excursion
  9076. (beginning-of-line 1)
  9077. (looking-at (concat ".*?\\(" org-link-bracket-re "\\)"))))
  9078. (org-link-open-from-string (match-string 1)))
  9079. (t (message "No link to open here")))))
  9080. (defun org-agenda-copy-local-variable (var)
  9081. "Get a variable from a referenced buffer and install it here."
  9082. (let ((m (org-get-at-bol 'org-marker)))
  9083. (when (and m (buffer-live-p (marker-buffer m)))
  9084. (set (make-local-variable var)
  9085. (with-current-buffer (marker-buffer m)
  9086. (symbol-value var))))))
  9087. (defun org-agenda-switch-to (&optional delete-other-windows)
  9088. "Go to the Org mode file which contains the item at point.
  9089. When optional argument DELETE-OTHER-WINDOWS is non-nil, the
  9090. displayed Org file fills the frame."
  9091. (interactive)
  9092. (if (and org-return-follows-link
  9093. (not (org-get-at-bol 'org-marker))
  9094. (org-in-regexp org-link-bracket-re))
  9095. (org-link-open-from-string (match-string 0))
  9096. (let* ((marker (or (org-get-at-bol 'org-marker)
  9097. (org-agenda-error)))
  9098. (buffer (marker-buffer marker))
  9099. (pos (marker-position marker)))
  9100. (unless buffer (user-error "Trying to switch to non-existent buffer"))
  9101. (pop-to-buffer-same-window buffer)
  9102. (when delete-other-windows (delete-other-windows))
  9103. (widen)
  9104. (goto-char pos)
  9105. (when (derived-mode-p 'org-mode)
  9106. (org-fold-show-context 'agenda)
  9107. (run-hooks 'org-agenda-after-show-hook)))))
  9108. (defun org-agenda-goto-mouse (ev)
  9109. "Go to the Org file which contains the item at the mouse click."
  9110. (interactive "e")
  9111. (mouse-set-point ev)
  9112. (org-agenda-goto))
  9113. (defun org-agenda-show (&optional full-entry)
  9114. "Display the Org file which contains the item at point.
  9115. With prefix argument FULL-ENTRY, make the entire entry visible
  9116. if it was hidden in the outline."
  9117. (interactive "P")
  9118. (let ((win (selected-window)))
  9119. (org-agenda-goto t)
  9120. (when full-entry (org-fold-show-entry 'hide-drawers))
  9121. (select-window win)))
  9122. (defvar org-agenda-show-window nil)
  9123. (defun org-agenda-show-and-scroll-up (&optional arg)
  9124. "Display the Org file which contains the item at point.
  9125. When called repeatedly, scroll the window that is displaying the buffer.
  9126. With a `\\[universal-argument]' prefix argument, display the item, but \
  9127. fold drawers."
  9128. (interactive "P")
  9129. (let ((win (selected-window)))
  9130. (if (and (window-live-p org-agenda-show-window)
  9131. (eq this-command last-command))
  9132. (progn
  9133. (select-window org-agenda-show-window)
  9134. (ignore-errors (scroll-up)))
  9135. (org-agenda-goto t)
  9136. (org-fold-show-entry 'hide-drawers)
  9137. (if arg (org-cycle-hide-drawers 'children)
  9138. (org-with-wide-buffer
  9139. (narrow-to-region (org-entry-beginning-position)
  9140. (org-entry-end-position))
  9141. (org-fold-show-all '(drawers))))
  9142. (setq org-agenda-show-window (selected-window)))
  9143. (select-window win)))
  9144. (defun org-agenda-show-scroll-down ()
  9145. "Scroll down the window showing the agenda."
  9146. (interactive)
  9147. (let ((win (selected-window)))
  9148. (when (window-live-p org-agenda-show-window)
  9149. (select-window org-agenda-show-window)
  9150. (ignore-errors (scroll-down))
  9151. (select-window win))))
  9152. (defun org-agenda-show-1 (&optional more)
  9153. "Display the Org file which contains the item at point.
  9154. The prefix arg selects the amount of information to display:
  9155. 0 hide the subtree
  9156. 1 just show the entry according to defaults.
  9157. 2 show the children view
  9158. 3 show the subtree view
  9159. 4 show the entire subtree and any drawers
  9160. With prefix argument FULL-ENTRY, make the entire entry visible
  9161. if it was hidden in the outline."
  9162. (interactive "p")
  9163. (let ((win (selected-window)))
  9164. (org-agenda-goto t)
  9165. (org-back-to-heading)
  9166. (set-window-start (selected-window) (line-beginning-position))
  9167. (cond
  9168. ((= more 0)
  9169. (org-fold-subtree t)
  9170. (save-excursion
  9171. (org-back-to-heading)
  9172. (run-hook-with-args 'org-cycle-hook 'folded))
  9173. (message "Remote: FOLDED"))
  9174. ((and (called-interactively-p 'any) (= more 1))
  9175. (message "Remote: show with default settings"))
  9176. ((= more 2)
  9177. (org-fold-show-entry 'hide-drawers)
  9178. (org-fold-show-children)
  9179. (save-excursion
  9180. (org-back-to-heading)
  9181. (run-hook-with-args 'org-cycle-hook 'children))
  9182. (message "Remote: CHILDREN"))
  9183. ((= more 3)
  9184. (org-fold-show-subtree)
  9185. (save-excursion
  9186. (org-back-to-heading)
  9187. (run-hook-with-args 'org-cycle-hook 'subtree))
  9188. (message "Remote: SUBTREE"))
  9189. ((> more 3)
  9190. (org-fold-show-subtree)
  9191. (message "Remote: SUBTREE AND ALL DRAWERS")))
  9192. (select-window win)))
  9193. (defvar org-agenda-cycle-counter nil)
  9194. (defun org-agenda-cycle-show (&optional n)
  9195. "Show the current entry in another window, with default settings.
  9196. Default settings are taken from `org-show-context-detail'. When
  9197. use repeatedly in immediate succession, the remote entry will
  9198. cycle through visibility
  9199. children -> subtree -> folded
  9200. When called with a numeric prefix arg, that arg will be passed through to
  9201. `org-agenda-show-1'. For the interpretation of that argument, see the
  9202. docstring of `org-agenda-show-1'."
  9203. (interactive "P")
  9204. (if (integerp n)
  9205. (setq org-agenda-cycle-counter n)
  9206. (if (not (eq last-command this-command))
  9207. (setq org-agenda-cycle-counter 1)
  9208. (if (equal org-agenda-cycle-counter 0)
  9209. (setq org-agenda-cycle-counter 2)
  9210. (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
  9211. (when (> org-agenda-cycle-counter 3)
  9212. (setq org-agenda-cycle-counter 0)))))
  9213. (org-agenda-show-1 org-agenda-cycle-counter))
  9214. (defun org-agenda-recenter (arg)
  9215. "Display the Org file which contains the item at point and recenter."
  9216. (interactive "P")
  9217. (let ((win (selected-window)))
  9218. (org-agenda-goto t)
  9219. (recenter arg)
  9220. (select-window win)))
  9221. (defun org-agenda-show-mouse (ev)
  9222. "Display the Org file which contains the item at the mouse click."
  9223. (interactive "e")
  9224. (mouse-set-point ev)
  9225. (org-agenda-show))
  9226. (defun org-agenda-check-no-diary ()
  9227. "Check if the entry is a diary link and abort if yes."
  9228. (when (org-get-at-bol 'org-agenda-diary-link)
  9229. (org-agenda-error)))
  9230. (defun org-agenda-error ()
  9231. "Throw an error when a command is not allowed in the agenda."
  9232. (user-error "Command not allowed in this line"))
  9233. (defun org-agenda-tree-to-indirect-buffer (arg)
  9234. "Show the subtree corresponding to the current entry in an indirect buffer.
  9235. This calls the command `org-tree-to-indirect-buffer' from the original buffer.
  9236. With a numerical prefix ARG, go up to this level and then take that tree.
  9237. With a negative numeric ARG, go up by this number of levels.
  9238. With a `\\[universal-argument]' prefix, make a separate frame for this tree, \
  9239. i.e. don't use
  9240. the dedicated frame."
  9241. (interactive "P")
  9242. (if current-prefix-arg
  9243. (org-agenda-do-tree-to-indirect-buffer arg)
  9244. (let ((agenda-buffer (buffer-name))
  9245. (agenda-window (selected-window))
  9246. (indirect-window
  9247. (and org-last-indirect-buffer
  9248. (get-buffer-window org-last-indirect-buffer))))
  9249. (save-window-excursion (org-agenda-do-tree-to-indirect-buffer arg))
  9250. (unless (or (eq org-indirect-buffer-display 'new-frame)
  9251. (eq org-indirect-buffer-display 'dedicated-frame))
  9252. (unwind-protect
  9253. (unless (and indirect-window (window-live-p indirect-window))
  9254. (setq indirect-window (split-window agenda-window)))
  9255. (and indirect-window (select-window indirect-window))
  9256. (switch-to-buffer org-last-indirect-buffer :norecord)
  9257. (fit-window-to-buffer indirect-window)))
  9258. (select-window (get-buffer-window agenda-buffer))
  9259. (setq org-agenda-last-indirect-buffer org-last-indirect-buffer))))
  9260. (defun org-agenda-do-tree-to-indirect-buffer (arg)
  9261. "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
  9262. (org-agenda-check-no-diary)
  9263. (let* ((marker (or (org-get-at-bol 'org-marker)
  9264. (org-agenda-error)))
  9265. (buffer (marker-buffer marker))
  9266. (pos (marker-position marker)))
  9267. (with-current-buffer buffer
  9268. (save-excursion
  9269. (goto-char pos)
  9270. (org-tree-to-indirect-buffer arg)))))
  9271. (defvar org-last-heading-marker (make-marker)
  9272. "Marker pointing to the headline that last changed its TODO state
  9273. by a remote command from the agenda.")
  9274. (defun org-agenda-todo-nextset ()
  9275. "Switch TODO entry to next sequence."
  9276. (interactive)
  9277. (org-agenda-todo 'nextset))
  9278. (defun org-agenda-todo-previousset ()
  9279. "Switch TODO entry to previous sequence."
  9280. (interactive)
  9281. (org-agenda-todo 'previousset))
  9282. (defvar org-agenda-headline-snapshot-before-repeat)
  9283. (defun org-agenda-todo (&optional arg)
  9284. "Cycle TODO state of line at point, also in Org file.
  9285. This changes the line at point, all other lines in the agenda referring to
  9286. the same tree node, and the headline of the tree node in the Org file."
  9287. (interactive "P")
  9288. (org-agenda-check-no-diary)
  9289. (org-agenda-maybe-loop
  9290. #'org-agenda-todo arg nil nil
  9291. (let* ((col (current-column))
  9292. (marker (or (org-get-at-bol 'org-marker)
  9293. (org-agenda-error)))
  9294. (buffer (marker-buffer marker))
  9295. (pos (marker-position marker))
  9296. (hdmarker (org-get-at-bol 'org-hd-marker))
  9297. (todayp (org-agenda-today-p (org-get-at-bol 'day)))
  9298. (inhibit-read-only t)
  9299. org-loop-over-headlines-in-active-region
  9300. org-agenda-headline-snapshot-before-repeat newhead just-one)
  9301. (org-with-remote-undo buffer
  9302. (with-current-buffer buffer
  9303. (widen)
  9304. (goto-char pos)
  9305. (org-fold-show-context 'agenda)
  9306. (let ((current-prefix-arg arg))
  9307. (call-interactively 'org-todo)
  9308. ;; Make sure that log is recorded in current undo.
  9309. (when (and org-log-setup
  9310. (not (eq org-log-note-how 'note)))
  9311. (org-add-log-note)))
  9312. (and (bolp) (forward-char 1))
  9313. (setq newhead (org-get-heading))
  9314. (when (and org-agenda-headline-snapshot-before-repeat
  9315. (not (equal org-agenda-headline-snapshot-before-repeat
  9316. newhead))
  9317. todayp)
  9318. (setq newhead org-agenda-headline-snapshot-before-repeat
  9319. just-one t))
  9320. (save-excursion
  9321. (org-back-to-heading)
  9322. (move-marker org-last-heading-marker (point))))
  9323. (beginning-of-line 1)
  9324. (save-window-excursion
  9325. (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
  9326. (when (bound-and-true-p org-clock-out-when-done)
  9327. (string-match (concat "^" (regexp-opt org-done-keywords-for-agenda))
  9328. newhead)
  9329. (org-agenda-unmark-clocking-task))
  9330. (org-move-to-column col)
  9331. (org-agenda-mark-clocking-task)))))
  9332. (defun org-agenda-add-note (&optional _arg)
  9333. "Add a time-stamped note to the entry at point."
  9334. (interactive) ;; "P"
  9335. (org-agenda-check-no-diary)
  9336. (let* ((marker (or (org-get-at-bol 'org-marker)
  9337. (org-agenda-error)))
  9338. (buffer (marker-buffer marker))
  9339. (pos (marker-position marker))
  9340. (_hdmarker (org-get-at-bol 'org-hd-marker))
  9341. (inhibit-read-only t))
  9342. (with-current-buffer buffer
  9343. (widen)
  9344. (goto-char pos)
  9345. (org-fold-show-context 'agenda)
  9346. (org-add-note))))
  9347. (defun org-agenda-change-all-lines (newhead hdmarker
  9348. &optional fixface just-this)
  9349. "Change all lines in the agenda buffer which match HDMARKER.
  9350. The new content of the line will be NEWHEAD (as modified by
  9351. `org-agenda-format-item'). HDMARKER is checked with
  9352. `equal' against all `org-hd-marker' text properties in the file.
  9353. If FIXFACE is non-nil, the face of each item is modified according to
  9354. the new TODO state.
  9355. If JUST-THIS is non-nil, change just the current line, not all.
  9356. If FORCE-TAGS is non-nil, the car of it returns the new tags."
  9357. (let* ((inhibit-read-only t)
  9358. (line (org-current-line))
  9359. (org-agenda-buffer (current-buffer))
  9360. (thetags (with-current-buffer (marker-buffer hdmarker)
  9361. (org-get-tags hdmarker)))
  9362. props m undone-face done-face finish new dotime level cat tags
  9363. effort effort-minutes) ;; pl
  9364. (save-excursion
  9365. (goto-char (point-max))
  9366. (beginning-of-line 1)
  9367. (while (not finish)
  9368. (setq finish (bobp))
  9369. (when (and (setq m (org-get-at-bol 'org-hd-marker))
  9370. (or (not just-this) (= (org-current-line) line))
  9371. (equal m hdmarker))
  9372. (setq props (text-properties-at (point))
  9373. dotime (org-get-at-bol 'dotime)
  9374. cat (org-agenda-get-category)
  9375. level (org-get-at-bol 'level)
  9376. tags thetags
  9377. effort (org-get-at-bol 'effort)
  9378. effort-minutes (org-get-at-bol 'effort-minutes)
  9379. new
  9380. (let ((org-prefix-format-compiled
  9381. (or (get-text-property (min (1- (point-max)) (point)) 'format)
  9382. org-prefix-format-compiled))
  9383. (extra (org-get-at-bol 'extra)))
  9384. (with-current-buffer (marker-buffer hdmarker)
  9385. (org-with-wide-buffer
  9386. (org-agenda-format-item extra
  9387. (org-add-props newhead nil
  9388. 'effort effort
  9389. 'effort-minutes effort-minutes)
  9390. level cat tags dotime))))
  9391. ;; pl (text-property-any (line-beginning-position) (line-end-position) 'org-heading t)
  9392. undone-face (org-get-at-bol 'undone-face)
  9393. done-face (org-get-at-bol 'done-face))
  9394. (beginning-of-line 1)
  9395. (cond
  9396. ((equal new "") (delete-region (point) (line-beginning-position 2)))
  9397. ((looking-at ".*")
  9398. ;; When replacing the whole line, preserve bulk mark
  9399. ;; overlay, if any.
  9400. (let ((mark (catch :overlay
  9401. (dolist (o (overlays-in (point) (+ 2 (point))))
  9402. (when (eq (overlay-get o 'type)
  9403. 'org-marked-entry-overlay)
  9404. (throw :overlay o))))))
  9405. (replace-match new t t)
  9406. (beginning-of-line)
  9407. (when mark (move-overlay mark (point) (+ 2 (point)))))
  9408. (add-text-properties (line-beginning-position) (line-end-position) props)
  9409. (when fixface
  9410. (add-text-properties
  9411. (line-beginning-position) (line-end-position)
  9412. (list 'face
  9413. (if org-last-todo-state-is-todo
  9414. undone-face done-face))))
  9415. (org-agenda-highlight-todo 'line)
  9416. (beginning-of-line 1))
  9417. (t (error "Line update did not work")))
  9418. (save-restriction
  9419. (narrow-to-region (line-beginning-position) (line-end-position))
  9420. (org-agenda-finalize)))
  9421. (beginning-of-line 0)))))
  9422. (defun org-agenda-align-tags (&optional line)
  9423. "Align all tags in agenda items to `org-agenda-tags-column'.
  9424. When optional argument LINE is non-nil, align tags only on the
  9425. current line."
  9426. (let ((inhibit-read-only t)
  9427. (org-agenda-tags-column (if (eq 'auto org-agenda-tags-column)
  9428. (- (window-max-chars-per-line))
  9429. org-agenda-tags-column))
  9430. (end (and line (line-end-position)))
  9431. l c)
  9432. (org-fold-core-ignore-modifications
  9433. (save-excursion
  9434. (goto-char (if line (line-beginning-position) (point-min)))
  9435. (while (re-search-forward org-tag-group-re end t)
  9436. (add-text-properties
  9437. (match-beginning 1) (match-end 1)
  9438. (list 'face (delq nil (let ((prop (get-text-property
  9439. (match-beginning 1) 'face)))
  9440. (or (listp prop) (setq prop (list prop)))
  9441. (if (memq 'org-tag prop)
  9442. prop
  9443. (cons 'org-tag prop))))))
  9444. (setq l (string-width (match-string 1))
  9445. c (if (< org-agenda-tags-column 0)
  9446. (- (abs org-agenda-tags-column) l)
  9447. org-agenda-tags-column))
  9448. (goto-char (match-beginning 1))
  9449. (delete-region (save-excursion (skip-chars-backward " \t") (point))
  9450. (point))
  9451. (insert (org-add-props
  9452. (make-string (max 1 (- c (current-column))) ?\s)
  9453. (plist-put (copy-sequence (text-properties-at (point)))
  9454. 'face nil))))
  9455. (goto-char (point-min))
  9456. (org-font-lock-add-tag-faces (point-max))))))
  9457. (defun org-agenda-priority-up ()
  9458. "Increase the priority of line at point, also in Org file."
  9459. (interactive)
  9460. (org-agenda-priority 'up))
  9461. (defun org-agenda-priority-down ()
  9462. "Decrease the priority of line at point, also in Org file."
  9463. (interactive)
  9464. (org-agenda-priority 'down))
  9465. (defun org-agenda-priority (&optional force-direction)
  9466. "Set the priority of line at point, also in Org file.
  9467. This changes the line at point, all other lines in the agenda
  9468. referring to the same tree node, and the headline of the tree
  9469. node in the Org file.
  9470. Called with one universal prefix arg, show the priority instead
  9471. of setting it.
  9472. When called programmatically, FORCE-DIRECTION can be `set', `up',
  9473. `down', or a character."
  9474. (interactive "P")
  9475. (unless org-priority-enable-commands
  9476. (user-error "Priority commands are disabled"))
  9477. (org-agenda-check-no-diary)
  9478. (let* ((col (current-column))
  9479. (hdmarker (org-get-at-bol 'org-hd-marker))
  9480. (buffer (marker-buffer hdmarker))
  9481. (pos (marker-position hdmarker))
  9482. (inhibit-read-only t)
  9483. newhead)
  9484. (org-with-remote-undo buffer
  9485. (with-current-buffer buffer
  9486. (widen)
  9487. (goto-char pos)
  9488. (org-fold-show-context 'agenda)
  9489. (org-priority force-direction)
  9490. (end-of-line 1)
  9491. (setq newhead (org-get-heading)))
  9492. (org-agenda-change-all-lines newhead hdmarker)
  9493. (org-move-to-column col))))
  9494. ;; FIXME: should fix the tags property of the agenda line.
  9495. (defun org-agenda-set-tags (&optional tag onoff)
  9496. "Set tags for the current headline."
  9497. (interactive)
  9498. (org-agenda-check-no-diary)
  9499. (if (and (org-region-active-p) (called-interactively-p 'any))
  9500. (call-interactively 'org-change-tag-in-region)
  9501. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  9502. (org-agenda-error)))
  9503. (buffer (marker-buffer hdmarker))
  9504. (pos (marker-position hdmarker))
  9505. (inhibit-read-only t)
  9506. newhead)
  9507. (org-with-remote-undo buffer
  9508. (with-current-buffer buffer
  9509. (widen)
  9510. (goto-char pos)
  9511. (org-fold-show-context 'agenda)
  9512. (if tag
  9513. (org-toggle-tag tag onoff)
  9514. (call-interactively #'org-set-tags-command))
  9515. (end-of-line 1)
  9516. (setq newhead (org-get-heading)))
  9517. (org-agenda-change-all-lines newhead hdmarker)
  9518. (beginning-of-line 1)))))
  9519. (defun org-agenda-set-property ()
  9520. "Set a property for the current headline."
  9521. (interactive)
  9522. (org-agenda-check-no-diary)
  9523. (org-agenda-maybe-loop
  9524. #'org-agenda-set-property nil nil nil
  9525. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  9526. (org-agenda-error)))
  9527. (buffer (marker-buffer hdmarker))
  9528. (pos (marker-position hdmarker))
  9529. (inhibit-read-only t)
  9530. ) ;; newhead
  9531. (org-with-remote-undo buffer
  9532. (with-current-buffer buffer
  9533. (widen)
  9534. (goto-char pos)
  9535. (org-fold-show-context 'agenda)
  9536. (call-interactively 'org-set-property))))))
  9537. (defun org-agenda-set-effort ()
  9538. "Set the effort property for the current headline."
  9539. (interactive)
  9540. (org-agenda-check-no-diary)
  9541. (org-agenda-maybe-loop
  9542. #'org-agenda-set-effort nil nil nil
  9543. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  9544. (org-agenda-error)))
  9545. (buffer (marker-buffer hdmarker))
  9546. (pos (marker-position hdmarker))
  9547. (inhibit-read-only t)
  9548. newhead)
  9549. (org-with-remote-undo buffer
  9550. (with-current-buffer buffer
  9551. (widen)
  9552. (goto-char pos)
  9553. (org-fold-show-context 'agenda)
  9554. (call-interactively 'org-set-effort)
  9555. (end-of-line 1)
  9556. (setq newhead (org-get-heading)))
  9557. (org-agenda-change-all-lines newhead hdmarker)))))
  9558. (defun org-agenda-toggle-archive-tag ()
  9559. "Toggle the archive tag for the current entry."
  9560. (interactive)
  9561. (org-agenda-check-no-diary)
  9562. (org-agenda-maybe-loop
  9563. #'org-agenda-toggle-archive-tag nil nil nil
  9564. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  9565. (org-agenda-error)))
  9566. (buffer (marker-buffer hdmarker))
  9567. (pos (marker-position hdmarker))
  9568. (inhibit-read-only t)
  9569. newhead)
  9570. (org-with-remote-undo buffer
  9571. (with-current-buffer buffer
  9572. (widen)
  9573. (goto-char pos)
  9574. (org-fold-show-context 'agenda)
  9575. (call-interactively 'org-toggle-archive-tag)
  9576. (end-of-line 1)
  9577. (setq newhead (org-get-heading)))
  9578. (org-agenda-change-all-lines newhead hdmarker)
  9579. (beginning-of-line 1)))))
  9580. (defun org-agenda-do-date-later (arg)
  9581. (interactive "P")
  9582. (cond
  9583. ((or (equal arg '(16))
  9584. (memq last-command
  9585. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  9586. (setq this-command 'org-agenda-date-later-minutes)
  9587. (org-agenda-date-later-minutes 1))
  9588. ((or (equal arg '(4))
  9589. (memq last-command
  9590. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  9591. (setq this-command 'org-agenda-date-later-hours)
  9592. (org-agenda-date-later-hours 1))
  9593. (t
  9594. (org-agenda-date-later (prefix-numeric-value arg)))))
  9595. (defun org-agenda-do-date-earlier (arg)
  9596. (interactive "P")
  9597. (cond
  9598. ((or (equal arg '(16))
  9599. (memq last-command
  9600. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  9601. (setq this-command 'org-agenda-date-earlier-minutes)
  9602. (org-agenda-date-earlier-minutes 1))
  9603. ((or (equal arg '(4))
  9604. (memq last-command
  9605. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  9606. (setq this-command 'org-agenda-date-earlier-hours)
  9607. (org-agenda-date-earlier-hours 1))
  9608. (t
  9609. (org-agenda-date-earlier (prefix-numeric-value arg)))))
  9610. (defun org-agenda-date-later (arg &optional what)
  9611. "Change the date of this item to ARG day(s) later."
  9612. (interactive "p")
  9613. (org-agenda-check-type t 'agenda)
  9614. (org-agenda-check-no-diary)
  9615. (let* ((marker (or (org-get-at-bol 'org-marker)
  9616. (org-agenda-error)))
  9617. (buffer (marker-buffer marker))
  9618. (pos (marker-position marker))
  9619. cdate today)
  9620. (org-with-remote-undo buffer
  9621. (with-current-buffer buffer
  9622. (widen)
  9623. (goto-char pos)
  9624. (unless (org-at-timestamp-p 'lax) (error "Cannot find time stamp"))
  9625. (when (and org-agenda-move-date-from-past-immediately-to-today
  9626. (equal arg 1)
  9627. (or (not what) (eq what 'day))
  9628. (not (save-match-data (org-at-date-range-p))))
  9629. (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
  9630. cdate (calendar-absolute-from-gregorian
  9631. (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
  9632. today (org-today))
  9633. (when (> today cdate)
  9634. ;; immediately shift to today
  9635. (setq arg (- today cdate))))
  9636. (org-timestamp-change arg (or what 'day))
  9637. (when (and (org-at-date-range-p)
  9638. (re-search-backward org-tr-regexp-both (line-beginning-position)))
  9639. (let ((end org-last-changed-timestamp))
  9640. (org-timestamp-change arg (or what 'day))
  9641. (setq org-last-changed-timestamp
  9642. (concat org-last-changed-timestamp "--" end)))))
  9643. (org-agenda-show-new-time marker org-last-changed-timestamp))
  9644. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  9645. (defun org-agenda-date-earlier (arg &optional what)
  9646. "Change the date of this item to ARG day(s) earlier."
  9647. (interactive "p")
  9648. (org-agenda-date-later (- arg) what))
  9649. (defun org-agenda-date-later-minutes (arg)
  9650. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  9651. (interactive "p")
  9652. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  9653. (org-agenda-date-later arg 'minute))
  9654. (defun org-agenda-date-earlier-minutes (arg)
  9655. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  9656. (interactive "p")
  9657. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  9658. (org-agenda-date-earlier arg 'minute))
  9659. (defun org-agenda-date-later-hours (arg)
  9660. "Change the time of this item, in hour steps."
  9661. (interactive "p")
  9662. (org-agenda-date-later arg 'hour))
  9663. (defun org-agenda-date-earlier-hours (arg)
  9664. "Change the time of this item, in hour steps."
  9665. (interactive "p")
  9666. (org-agenda-date-earlier arg 'hour))
  9667. (defun org-agenda-show-new-time (marker stamp &optional prefix)
  9668. "Show new date stamp via text properties."
  9669. ;; We use text properties to make this undoable
  9670. (let ((inhibit-read-only t))
  9671. (setq stamp (concat prefix " => " stamp " "))
  9672. (save-excursion
  9673. (goto-char (point-max))
  9674. (while (not (bobp))
  9675. (when (equal marker (org-get-at-bol 'org-marker))
  9676. (remove-text-properties (line-beginning-position)
  9677. (line-end-position)
  9678. '(display nil))
  9679. (org-move-to-column
  9680. (- (window-max-chars-per-line)
  9681. (length stamp))
  9682. t)
  9683. (add-text-properties
  9684. (1- (point)) (line-end-position)
  9685. (list 'display (org-add-props stamp nil
  9686. 'face '(secondary-selection default))))
  9687. (beginning-of-line 1))
  9688. (beginning-of-line 0)))))
  9689. (defun org-agenda-date-prompt (arg)
  9690. "Change the date of this item. Date is prompted for, with default today.
  9691. The prefix ARG is passed to the `org-time-stamp' command and can therefore
  9692. be used to request time specification in the time stamp."
  9693. (interactive "P")
  9694. (org-agenda-check-type t 'agenda)
  9695. (org-agenda-check-no-diary)
  9696. (org-agenda-maybe-loop
  9697. #'org-agenda-date-prompt arg t nil
  9698. (let* ((marker (or (org-get-at-bol 'org-marker)
  9699. (org-agenda-error)))
  9700. (buffer (marker-buffer marker))
  9701. (pos (marker-position marker)))
  9702. (org-with-remote-undo buffer
  9703. (with-current-buffer buffer
  9704. (widen)
  9705. (goto-char pos)
  9706. (unless (org-at-timestamp-p 'lax) (error "Cannot find time stamp"))
  9707. (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
  9708. (org-agenda-show-new-time marker org-last-changed-timestamp))
  9709. (message "Time stamp changed to %s" org-last-changed-timestamp))))
  9710. (defun org-agenda-schedule (arg &optional time)
  9711. "Schedule the item at point.
  9712. ARG is passed through to `org-schedule'."
  9713. (interactive "P")
  9714. (org-agenda-check-type t 'agenda 'todo 'tags 'search)
  9715. (org-agenda-check-no-diary)
  9716. (org-agenda-maybe-loop
  9717. #'org-agenda-schedule arg t nil
  9718. (let* ((marker (or (org-get-at-bol 'org-marker)
  9719. (org-agenda-error)))
  9720. ;; (type (marker-insertion-type marker))
  9721. (buffer (marker-buffer marker))
  9722. (pos (marker-position marker))
  9723. ts)
  9724. (set-marker-insertion-type marker t)
  9725. (org-with-remote-undo buffer
  9726. (with-current-buffer buffer
  9727. (widen)
  9728. (goto-char pos)
  9729. (setq ts (org-schedule arg time)))
  9730. (org-agenda-show-new-time marker ts " S"))
  9731. (message "%s" ts))))
  9732. (defun org-agenda-deadline (arg &optional time)
  9733. "Schedule the item at point.
  9734. ARG is passed through to `org-deadline'."
  9735. (interactive "P")
  9736. (org-agenda-check-type t 'agenda 'todo 'tags 'search)
  9737. (org-agenda-check-no-diary)
  9738. (org-agenda-maybe-loop
  9739. #'org-agenda-deadline arg t nil
  9740. (let* ((marker (or (org-get-at-bol 'org-marker)
  9741. (org-agenda-error)))
  9742. (buffer (marker-buffer marker))
  9743. (pos (marker-position marker))
  9744. ts)
  9745. (org-with-remote-undo buffer
  9746. (with-current-buffer buffer
  9747. (widen)
  9748. (goto-char pos)
  9749. (setq ts (org-deadline arg time)))
  9750. (org-agenda-show-new-time marker ts " D"))
  9751. (message "%s" ts))))
  9752. (defun org-agenda-clock-in (&optional arg)
  9753. "Start the clock on the currently selected item."
  9754. (interactive "P")
  9755. (org-agenda-check-no-diary)
  9756. (if (equal arg '(4))
  9757. (org-clock-in arg)
  9758. (let* ((marker (or (org-get-at-bol 'org-marker)
  9759. (org-agenda-error)))
  9760. (hdmarker (or (org-get-at-bol 'org-hd-marker) marker))
  9761. (pos (marker-position marker))
  9762. (col (current-column))
  9763. newhead)
  9764. (org-with-remote-undo (marker-buffer marker)
  9765. (with-current-buffer (marker-buffer marker)
  9766. (widen)
  9767. (goto-char pos)
  9768. (org-fold-show-context 'agenda)
  9769. (org-clock-in arg)
  9770. (setq newhead (org-get-heading)))
  9771. (org-agenda-change-all-lines newhead hdmarker))
  9772. (org-move-to-column col))))
  9773. (defun org-agenda-clock-out ()
  9774. "Stop the currently running clock."
  9775. (interactive)
  9776. (unless (marker-buffer org-clock-marker)
  9777. (user-error "No running clock"))
  9778. (let ((marker (make-marker)) (col (current-column)) newhead)
  9779. (org-with-remote-undo (marker-buffer org-clock-marker)
  9780. (with-current-buffer (marker-buffer org-clock-marker)
  9781. (org-with-wide-buffer
  9782. (goto-char org-clock-marker)
  9783. (org-back-to-heading t)
  9784. (move-marker marker (point))
  9785. (org-clock-out)
  9786. (setq newhead (org-get-heading)))))
  9787. (org-agenda-change-all-lines newhead marker)
  9788. (move-marker marker nil)
  9789. (org-move-to-column col)
  9790. (org-agenda-unmark-clocking-task)))
  9791. (defun org-agenda-clock-cancel (&optional _arg)
  9792. "Cancel the currently running clock."
  9793. (interactive) ;; "P"
  9794. (unless (marker-buffer org-clock-marker)
  9795. (user-error "No running clock"))
  9796. (org-with-remote-undo (marker-buffer org-clock-marker)
  9797. (org-clock-cancel)))
  9798. (defun org-agenda-clock-goto ()
  9799. "Jump to the currently clocked in task within the agenda.
  9800. If the currently clocked in task is not listed in the agenda
  9801. buffer, display it in another window."
  9802. (interactive)
  9803. (let (pos)
  9804. (mapc (lambda (o)
  9805. (when (eq (overlay-get o 'type) 'org-agenda-clocking)
  9806. (setq pos (overlay-start o))))
  9807. (overlays-in (point-min) (point-max)))
  9808. (cond (pos (goto-char pos))
  9809. ;; If the currently clocked entry is not in the agenda
  9810. ;; buffer, we visit it in another window:
  9811. ((bound-and-true-p org-clock-current-task)
  9812. (org-switch-to-buffer-other-window (org-clock-goto)))
  9813. (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
  9814. (defun org-agenda-diary-entry-in-org-file ()
  9815. "Make a diary entry in the file `org-agenda-diary-file'."
  9816. (let (d1 d2 char (text "") dp1 dp2)
  9817. (if (equal (buffer-name) "*Calendar*")
  9818. (setq d1 (calendar-cursor-to-date t)
  9819. d2 (car calendar-mark-ring))
  9820. (setq dp1 (get-text-property (line-beginning-position) 'day))
  9821. (unless dp1 (user-error "No date defined in current line"))
  9822. (setq d1 (calendar-gregorian-from-absolute dp1)
  9823. d2 (and (ignore-errors (mark))
  9824. (save-excursion
  9825. (goto-char (mark))
  9826. (setq dp2 (get-text-property (line-beginning-position) 'day)))
  9827. (calendar-gregorian-from-absolute dp2))))
  9828. (message "Diary entry: [d]ay [a]nniversary [b]lock [j]ump to date tree")
  9829. (setq char (read-char-exclusive))
  9830. (cond
  9831. ((equal char ?d)
  9832. (setq text (read-string "Day entry: "))
  9833. (org-agenda-add-entry-to-org-agenda-diary-file 'day text d1)
  9834. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  9835. ((equal char ?a)
  9836. (setq d1 (list (car d1) (nth 1 d1)
  9837. (read-number (format "Reference year [%d]: " (nth 2 d1))
  9838. (nth 2 d1))))
  9839. (setq text (read-string "Anniversary (use %d to show years): "))
  9840. (org-agenda-add-entry-to-org-agenda-diary-file 'anniversary text d1)
  9841. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  9842. ((equal char ?b)
  9843. (setq text (read-string "Block entry: "))
  9844. (unless (and d1 d2 (not (equal d1 d2)))
  9845. (user-error "No block of days selected"))
  9846. (org-agenda-add-entry-to-org-agenda-diary-file 'block text d1 d2)
  9847. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  9848. ((equal char ?j)
  9849. (org-switch-to-buffer-other-window
  9850. (find-file-noselect org-agenda-diary-file))
  9851. (require 'org-datetree)
  9852. (org-datetree-find-date-create d1)
  9853. (org-fold-reveal t))
  9854. (t (user-error "Invalid selection character `%c'" char)))))
  9855. (defcustom org-agenda-insert-diary-strategy 'date-tree
  9856. "Where in `org-agenda-diary-file' should new entries be added?
  9857. Valid values:
  9858. date-tree in the date tree, as first child of the date
  9859. date-tree-last in the date tree, as last child of the date
  9860. top-level as top-level entries at the end of the file."
  9861. :group 'org-agenda
  9862. :type '(choice
  9863. (const :tag "first in a date tree" date-tree)
  9864. (const :tag "last in a date tree" date-tree-last)
  9865. (const :tag "as top level at end of file" top-level)))
  9866. (defcustom org-agenda-insert-diary-extract-time nil
  9867. "Non-nil means extract any time specification from the diary entry."
  9868. :group 'org-agenda
  9869. :version "24.1"
  9870. :type 'boolean)
  9871. (defcustom org-agenda-bulk-mark-char ">"
  9872. "A single-character string to be used as the bulk mark."
  9873. :group 'org-agenda
  9874. :version "24.1"
  9875. :type 'string)
  9876. (defun org-agenda-add-entry-to-org-agenda-diary-file (type text &optional d1 d2)
  9877. "Add a diary entry with TYPE to `org-agenda-diary-file'.
  9878. If TEXT is not empty, it will become the headline of the new entry, and
  9879. the resulting entry will not be shown. When TEXT is empty, switch to
  9880. `org-agenda-diary-file' and let the user finish the entry there."
  9881. (let ((cw (current-window-configuration)))
  9882. (org-switch-to-buffer-other-window
  9883. (find-file-noselect org-agenda-diary-file))
  9884. (widen)
  9885. (goto-char (point-min))
  9886. (cl-case type
  9887. (anniversary
  9888. (or (re-search-forward "^\\*[ \t]+Anniversaries" nil t)
  9889. (progn
  9890. (or (org-at-heading-p)
  9891. (progn
  9892. (outline-next-heading)
  9893. (insert "* Anniversaries\n\n")
  9894. (beginning-of-line -1)))))
  9895. (outline-next-heading)
  9896. (org-back-over-empty-lines)
  9897. (backward-char 1)
  9898. (insert "\n")
  9899. (insert (format "%%%%(org-anniversary %d %2d %2d) %s"
  9900. (nth 2 d1) (car d1) (nth 1 d1) text)))
  9901. (day
  9902. (let ((org-prefix-has-time t)
  9903. (org-agenda-time-leading-zero t)
  9904. fmt time time2)
  9905. (when org-agenda-insert-diary-extract-time
  9906. ;; Use org-agenda-format-item to parse text for a time-range and
  9907. ;; remove it. FIXME: This is a hack, we should refactor
  9908. ;; that function to make time extraction available separately
  9909. (setq fmt (org-agenda-format-item nil text nil nil nil t)
  9910. time (get-text-property 0 'time fmt)
  9911. time2 (if (> (length time) 0)
  9912. ;; split-string removes trailing ...... if
  9913. ;; no end time given. First space
  9914. ;; separates time from date.
  9915. (concat " " (car (split-string time "\\.")))
  9916. nil)
  9917. text (get-text-property 0 'txt fmt)))
  9918. (if (eq org-agenda-insert-diary-strategy 'top-level)
  9919. (org-agenda-insert-diary-as-top-level text)
  9920. (require 'org-datetree)
  9921. (org-datetree-find-date-create d1)
  9922. (org-agenda-insert-diary-make-new-entry text))
  9923. (org-insert-time-stamp (org-time-from-absolute
  9924. (calendar-absolute-from-gregorian d1))
  9925. nil nil nil nil time2))
  9926. (end-of-line 0))
  9927. ((block) ;; Wrap this in (strictly unnecessary) parens because
  9928. ;; otherwise the indentation gets confused by the
  9929. ;; special meaning of 'block
  9930. (when (> (calendar-absolute-from-gregorian d1)
  9931. (calendar-absolute-from-gregorian d2))
  9932. (setq d1 (prog1 d2 (setq d2 d1))))
  9933. (if (eq org-agenda-insert-diary-strategy 'top-level)
  9934. (org-agenda-insert-diary-as-top-level text)
  9935. (require 'org-datetree)
  9936. (org-datetree-find-date-create d1)
  9937. (org-agenda-insert-diary-make-new-entry text))
  9938. (org-insert-time-stamp (org-time-from-absolute
  9939. (calendar-absolute-from-gregorian d1)))
  9940. (insert "--")
  9941. (org-insert-time-stamp (org-time-from-absolute
  9942. (calendar-absolute-from-gregorian d2)))
  9943. (end-of-line 0)))
  9944. (if (string-match "\\S-" text)
  9945. (progn
  9946. (set-window-configuration cw)
  9947. (message "%s entry added to %s"
  9948. (capitalize (symbol-name type))
  9949. (abbreviate-file-name org-agenda-diary-file)))
  9950. (org-fold-reveal t)
  9951. (message "Please finish entry here"))))
  9952. (defun org-agenda-insert-diary-as-top-level (text)
  9953. "Make new entry as a top-level entry at the end of the file.
  9954. Add TEXT as headline, and position the cursor in the second line so that
  9955. a timestamp can be added there."
  9956. (widen)
  9957. (goto-char (point-max))
  9958. (unless (bolp) (insert "\n"))
  9959. (org-insert-heading nil t t)
  9960. (insert text)
  9961. (org-end-of-meta-data)
  9962. (unless (bolp) (insert "\n"))
  9963. (when org-adapt-indentation (indent-to-column 2)))
  9964. (defun org-agenda-insert-diary-make-new-entry (text)
  9965. "Make a new entry with TEXT as a child of the current subtree.
  9966. Position the point in the heading's first body line so that
  9967. a timestamp can be added there."
  9968. (cond
  9969. ((eq org-agenda-insert-diary-strategy 'date-tree-last)
  9970. (end-of-line)
  9971. (org-insert-heading '(4) t)
  9972. (org-do-demote))
  9973. (t
  9974. (outline-next-heading)
  9975. (org-back-over-empty-lines)
  9976. (unless (looking-at "[ \t]*$") (save-excursion (insert "\n")))
  9977. (org-insert-heading nil t)
  9978. (org-do-demote)))
  9979. (let ((col (current-column)))
  9980. (insert text)
  9981. (org-end-of-meta-data)
  9982. ;; Ensure point is left on a blank line, at proper indentation.
  9983. (unless (bolp) (insert "\n"))
  9984. (unless (looking-at-p "^[ \t]*$") (save-excursion (insert "\n")))
  9985. (when org-adapt-indentation (indent-to-column col)))
  9986. (org-fold-show-set-visibility 'lineage))
  9987. (defun org-agenda-diary-entry ()
  9988. "Make a diary entry, like the `i' command from the calendar.
  9989. All the standard commands work: block, weekly etc.
  9990. When `org-agenda-diary-file' points to a file,
  9991. `org-agenda-diary-entry-in-org-file' is called instead to create
  9992. entries in that Org file."
  9993. (interactive)
  9994. (if (not (eq org-agenda-diary-file 'diary-file))
  9995. (org-agenda-diary-entry-in-org-file)
  9996. (require 'diary-lib)
  9997. (let* ((char (read-char-exclusive
  9998. "Diary entry: [d]ay [w]eekly [m]onthly [y]early\
  9999. [a]nniversary [b]lock [c]yclic"))
  10000. (cmd (cdr (assoc char
  10001. '((?d . diary-insert-entry)
  10002. (?w . diary-insert-weekly-entry)
  10003. (?m . diary-insert-monthly-entry)
  10004. (?y . diary-insert-yearly-entry)
  10005. (?a . diary-insert-anniversary-entry)
  10006. (?b . diary-insert-block-entry)
  10007. (?c . diary-insert-cyclic-entry)))))
  10008. (oldf (symbol-function 'calendar-cursor-to-date))
  10009. ;; (buf (get-file-buffer (substitute-in-file-name diary-file)))
  10010. (point (point))
  10011. (mark (or (mark t) (point))))
  10012. (unless cmd
  10013. (user-error "No command associated with <%c>" char))
  10014. (unless (and (get-text-property point 'day)
  10015. (or (not (equal ?b char))
  10016. (get-text-property mark 'day)))
  10017. (user-error "Don't know which date to use for diary entry"))
  10018. ;; We implement this by hacking the `calendar-cursor-to-date' function
  10019. ;; and the `calendar-mark-ring' variable. Saves a lot of code.
  10020. (let ((calendar-mark-ring
  10021. (list (calendar-gregorian-from-absolute
  10022. (or (get-text-property mark 'day)
  10023. (get-text-property point 'day))))))
  10024. (unwind-protect
  10025. (progn
  10026. (fset 'calendar-cursor-to-date
  10027. (lambda (&optional _error _dummy)
  10028. (calendar-gregorian-from-absolute
  10029. (get-text-property point 'day))))
  10030. (call-interactively cmd))
  10031. (fset 'calendar-cursor-to-date oldf))))))
  10032. (defun org-agenda-execute-calendar-command (cmd)
  10033. "Execute a calendar command from the agenda with date from cursor."
  10034. (org-agenda-check-type t 'agenda)
  10035. (require 'diary-lib)
  10036. (unless (get-text-property (min (1- (point-max)) (point)) 'day)
  10037. (user-error "Don't know which date to use for the calendar command"))
  10038. (let* ((oldf (symbol-function 'calendar-cursor-to-date))
  10039. (point (point))
  10040. (date (calendar-gregorian-from-absolute
  10041. (get-text-property point 'day))))
  10042. ;; the following 2 vars are needed in the calendar
  10043. (org-dlet
  10044. ((displayed-month (car date))
  10045. (displayed-year (nth 2 date)))
  10046. (unwind-protect
  10047. (progn
  10048. (fset 'calendar-cursor-to-date
  10049. (lambda (&optional _error _dummy)
  10050. (calendar-gregorian-from-absolute
  10051. (get-text-property point 'day))))
  10052. (call-interactively cmd))
  10053. (fset 'calendar-cursor-to-date oldf)))))
  10054. (defun org-agenda-phases-of-moon ()
  10055. "Display the phases of the moon for the 3 months around the cursor date."
  10056. (interactive)
  10057. (org-agenda-execute-calendar-command 'calendar-lunar-phases))
  10058. (defun org-agenda-holidays ()
  10059. "Display the holidays for the 3 months around the cursor date."
  10060. (interactive)
  10061. (org-agenda-execute-calendar-command 'calendar-list-holidays))
  10062. (defvar calendar-longitude) ; defined in calendar.el
  10063. (defvar calendar-latitude) ; defined in calendar.el
  10064. (defvar calendar-location-name) ; defined in calendar.el
  10065. (defun org-agenda-sunrise-sunset (arg)
  10066. "Display sunrise and sunset for the cursor date.
  10067. Latitude and longitude can be specified with the variables
  10068. `calendar-latitude' and `calendar-longitude'. When called with prefix
  10069. argument, latitude and longitude will be prompted for."
  10070. (interactive "P")
  10071. (require 'solar)
  10072. (let ((calendar-longitude (if arg nil calendar-longitude))
  10073. (calendar-latitude (if arg nil calendar-latitude))
  10074. (calendar-location-name
  10075. (if arg "the given coordinates" calendar-location-name)))
  10076. (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
  10077. (defun org-agenda-goto-calendar ()
  10078. "Open the Emacs calendar with the date at the cursor."
  10079. (interactive)
  10080. (org-agenda-check-type t 'agenda)
  10081. (let* ((day (or (get-text-property (min (1- (point-max)) (point)) 'day)
  10082. (user-error "Don't know which date to open in calendar")))
  10083. (date (calendar-gregorian-from-absolute day))
  10084. (calendar-move-hook nil)
  10085. (calendar-view-holidays-initially-flag nil)
  10086. (calendar-view-diary-initially-flag nil))
  10087. (calendar)
  10088. (calendar-goto-date date)))
  10089. ;;;###autoload
  10090. (defun org-calendar-goto-agenda ()
  10091. "Compute the Org agenda for the calendar date displayed at the cursor.
  10092. This is a command that has to be installed in `calendar-mode-map'."
  10093. (interactive)
  10094. ;; Temporarily disable sticky agenda since user clearly wants to
  10095. ;; refresh view anyway.
  10096. (let ((org-agenda-buffer-tmp-name "*Org Agenda(a)*")
  10097. (org-agenda-sticky nil))
  10098. (org-agenda-list nil (calendar-absolute-from-gregorian
  10099. (calendar-cursor-to-date))
  10100. nil)))
  10101. (defun org-agenda-convert-date ()
  10102. (interactive)
  10103. (org-agenda-check-type t 'agenda)
  10104. (let ((day (get-text-property (min (1- (point-max)) (point)) 'day))
  10105. date s)
  10106. (unless day
  10107. (user-error "Don't know which date to convert"))
  10108. (setq date (calendar-gregorian-from-absolute day))
  10109. (setq s (concat
  10110. "Gregorian: " (calendar-date-string date) "\n"
  10111. "ISO: " (calendar-iso-date-string date) "\n"
  10112. "Day of Yr: " (calendar-day-of-year-string date) "\n"
  10113. "Julian: " (calendar-julian-date-string date) "\n"
  10114. "Astron. JD: " (calendar-astro-date-string date)
  10115. " (Julian date number at noon UTC)\n"
  10116. "Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
  10117. "Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
  10118. "French: " (calendar-french-date-string date) "\n"
  10119. "Bahá’í: " (calendar-bahai-date-string date) " (until sunset)\n"
  10120. "Mayan: " (calendar-mayan-date-string date) "\n"
  10121. "Coptic: " (calendar-coptic-date-string date) "\n"
  10122. "Ethiopic: " (calendar-ethiopic-date-string date) "\n"
  10123. "Persian: " (calendar-persian-date-string date) "\n"
  10124. "Chinese: " (calendar-chinese-date-string date) "\n"))
  10125. (with-output-to-temp-buffer "*Dates*"
  10126. (princ s))
  10127. (org-fit-window-to-buffer (get-buffer-window "*Dates*"))))
  10128. ;;; Bulk commands
  10129. (defun org-agenda-bulk-marked-p ()
  10130. "Non-nil when current entry is marked for bulk action."
  10131. (eq (get-char-property (line-beginning-position) 'type)
  10132. 'org-marked-entry-overlay))
  10133. (defun org-agenda-bulk-mark (&optional arg)
  10134. "Mark entries for future bulk action.
  10135. When ARG is nil or one and region is not active then mark the
  10136. entry at point.
  10137. When ARG is nil or one and region is active then mark the entries
  10138. in the region.
  10139. When ARG is greater than one mark ARG lines."
  10140. (interactive "p")
  10141. (when (and (or (not arg) (= arg 1)) (use-region-p))
  10142. (setq arg (count-lines (region-beginning) (region-end)))
  10143. (goto-char (region-beginning))
  10144. (deactivate-mark))
  10145. (dotimes (_ (or arg 1))
  10146. (unless (org-get-at-bol 'org-agenda-diary-link)
  10147. (let* ((m (org-get-at-bol 'org-hd-marker))
  10148. ov)
  10149. (unless (org-agenda-bulk-marked-p)
  10150. (unless m (user-error "Nothing to mark at point"))
  10151. (push m org-agenda-bulk-marked-entries)
  10152. (setq ov (make-overlay (line-beginning-position) (+ 2 (line-beginning-position))))
  10153. (org-overlay-display ov (concat org-agenda-bulk-mark-char " ")
  10154. (org-get-todo-face "TODO")
  10155. 'evaporate)
  10156. (overlay-put ov 'type 'org-marked-entry-overlay))
  10157. (end-of-line 1)
  10158. (or (ignore-errors
  10159. (goto-char (next-single-property-change (point) 'org-hd-marker)))
  10160. (beginning-of-line 2))
  10161. (while (and (get-char-property (point) 'invisible) (not (eobp)))
  10162. (beginning-of-line 2)))))
  10163. (message "%d entries marked for bulk action"
  10164. (length org-agenda-bulk-marked-entries)))
  10165. (defun org-agenda-bulk-mark-all ()
  10166. "Mark all entries for future agenda bulk action."
  10167. (interactive)
  10168. (org-agenda-bulk-mark-regexp "."))
  10169. (defun org-agenda-bulk-mark-regexp (regexp)
  10170. "Mark entries matching REGEXP for future agenda bulk action."
  10171. (interactive "sMark entries matching regexp: ")
  10172. (let ((entries-marked 0) txt-at-point)
  10173. (save-excursion
  10174. (goto-char (point-min))
  10175. (goto-char (next-single-property-change (point) 'org-hd-marker))
  10176. (while (and (re-search-forward regexp nil t)
  10177. (setq txt-at-point
  10178. (get-text-property (match-beginning 0) 'txt)))
  10179. (if (get-char-property (point) 'invisible)
  10180. (beginning-of-line 2)
  10181. (when (string-match-p regexp txt-at-point)
  10182. (setq entries-marked (1+ entries-marked))
  10183. (call-interactively 'org-agenda-bulk-mark)))))
  10184. (unless entries-marked
  10185. (message "No entry matching this regexp."))))
  10186. (defun org-agenda-bulk-unmark (&optional arg)
  10187. "Unmark the entry at point for future bulk action."
  10188. (interactive "P")
  10189. (if arg
  10190. (org-agenda-bulk-unmark-all)
  10191. (cond ((org-agenda-bulk-marked-p)
  10192. (org-agenda-bulk-remove-overlays
  10193. (line-beginning-position) (+ 2 (line-beginning-position)))
  10194. (setq org-agenda-bulk-marked-entries
  10195. (delete (org-get-at-bol 'org-hd-marker)
  10196. org-agenda-bulk-marked-entries))
  10197. (end-of-line 1)
  10198. (or (ignore-errors
  10199. (goto-char (next-single-property-change (point) 'txt)))
  10200. (beginning-of-line 2))
  10201. (while (and (get-char-property (point) 'invisible) (not (eobp)))
  10202. (beginning-of-line 2))
  10203. (message "%d entries left marked for bulk action"
  10204. (length org-agenda-bulk-marked-entries)))
  10205. (t (message "No entry to unmark here")))))
  10206. (defun org-agenda-bulk-toggle-all ()
  10207. "Toggle all marks for bulk action."
  10208. (interactive)
  10209. (save-excursion
  10210. (goto-char (point-min))
  10211. (while (ignore-errors
  10212. (goto-char (next-single-property-change (point) 'org-hd-marker)))
  10213. (org-agenda-bulk-toggle))))
  10214. (defun org-agenda-bulk-toggle ()
  10215. "Toggle the mark at point for bulk action."
  10216. (interactive)
  10217. (if (org-agenda-bulk-marked-p)
  10218. (org-agenda-bulk-unmark)
  10219. (org-agenda-bulk-mark)))
  10220. (defun org-agenda-bulk-remove-overlays (&optional beg end)
  10221. "Remove the mark overlays between BEG and END in the agenda buffer.
  10222. BEG and END default to the buffer limits.
  10223. This only removes the overlays, it does not remove the markers
  10224. from the list in `org-agenda-bulk-marked-entries'."
  10225. (interactive)
  10226. (mapc (lambda (ov)
  10227. (and (eq (overlay-get ov 'type) 'org-marked-entry-overlay)
  10228. (delete-overlay ov)))
  10229. (overlays-in (or beg (point-min)) (or end (point-max)))))
  10230. (defun org-agenda-bulk-unmark-all ()
  10231. "Remove all marks in the agenda buffer.
  10232. This will remove the markers and the overlays."
  10233. (interactive)
  10234. (if (null org-agenda-bulk-marked-entries)
  10235. (message "No entry to unmark")
  10236. (setq org-agenda-bulk-marked-entries nil)
  10237. (org-agenda-bulk-remove-overlays (point-min) (point-max))))
  10238. (defcustom org-agenda-persistent-marks nil
  10239. "Non-nil means marked items will stay marked after a bulk action.
  10240. You can toggle this interactively by typing `p' when prompted for a
  10241. bulk action."
  10242. :group 'org-agenda
  10243. :version "24.1"
  10244. :type 'boolean)
  10245. (defcustom org-agenda-loop-over-headlines-in-active-region t
  10246. "Shall some commands act upon headlines in the active region?
  10247. When set to t, some commands will be performed in all headlines
  10248. within the active region.
  10249. When set to `start-level', some commands will be performed in all
  10250. headlines within the active region, provided that these headlines
  10251. are of the same level than the first one.
  10252. When set to a regular expression, those commands will be
  10253. performed on the matching headlines within the active region.
  10254. The list of commands is: `org-agenda-schedule',
  10255. `org-agenda-deadline', `org-agenda-date-prompt',
  10256. `org-agenda-todo', `org-agenda-archive*', `org-agenda-kill'.
  10257. See `org-loop-over-headlines-in-active-region' for the equivalent
  10258. option for Org buffers."
  10259. :type '(choice (const :tag "Don't loop" nil)
  10260. (const :tag "All headlines in active region" t)
  10261. (const :tag "In active region, headlines at the same level than the first one" start-level)
  10262. (regexp :tag "Regular expression matcher"))
  10263. :version "27.1"
  10264. :package-version '(Org . "9.4")
  10265. :group 'org-agenda)
  10266. (defun org-agenda-bulk-action (&optional arg)
  10267. "Execute an remote-editing action on all marked entries.
  10268. The prefix arg is passed through to the command if possible."
  10269. (interactive "P")
  10270. ;; When there is no mark, act on the agenda entry at point.
  10271. (if (not org-agenda-bulk-marked-entries)
  10272. (save-excursion (org-agenda-bulk-mark)))
  10273. (dolist (m org-agenda-bulk-marked-entries)
  10274. (unless (and (markerp m)
  10275. (marker-buffer m)
  10276. (buffer-live-p (marker-buffer m))
  10277. (marker-position m))
  10278. (user-error "Marker %s for bulk command is invalid" m)))
  10279. ;; Prompt for the bulk command.
  10280. (org-unlogged-message
  10281. (concat "Bulk (" (if org-agenda-persistent-marks "" "don't ") "[p]ersist marks): "
  10282. "[$]arch [A]rch->sib [t]odo [+/-]tag [s]chd [d]eadline [r]efile "
  10283. "[S]catter [f]unction "
  10284. (and org-agenda-bulk-custom-functions
  10285. (format " Custom: [%s]"
  10286. (mapconcat (lambda (f) (char-to-string (car f)))
  10287. org-agenda-bulk-custom-functions
  10288. "")))))
  10289. (catch 'exit
  10290. (let* ((org-log-refile (if org-log-refile 'time nil))
  10291. (entries (reverse org-agenda-bulk-marked-entries))
  10292. (org-overriding-default-time
  10293. (and (get-text-property (point) 'org-agenda-date-header)
  10294. (org-get-cursor-date)))
  10295. redo-at-end
  10296. cmd)
  10297. (pcase (read-char-exclusive)
  10298. (?p
  10299. (let ((org-agenda-persistent-marks
  10300. (not org-agenda-persistent-marks)))
  10301. (org-agenda-bulk-action)
  10302. (throw 'exit nil)))
  10303. (?$
  10304. (setq cmd #'org-agenda-archive))
  10305. (?A
  10306. (setq cmd #'org-agenda-archive-to-archive-sibling))
  10307. ((or ?r ?w)
  10308. (let ((refile-location
  10309. (org-refile-get-location
  10310. "Refile to"
  10311. (marker-buffer (car entries))
  10312. org-refile-allow-creating-parent-nodes)))
  10313. (when (nth 3 refile-location)
  10314. (setcar (nthcdr 3 refile-location)
  10315. (move-marker
  10316. (make-marker)
  10317. (nth 3 refile-location)
  10318. (or (get-file-buffer (nth 1 refile-location))
  10319. (find-buffer-visiting (nth 1 refile-location))
  10320. (error "This should not happen")))))
  10321. (setq cmd (lambda () (org-agenda-refile nil refile-location t)))
  10322. (setq redo-at-end t)))
  10323. (?t
  10324. (let ((state (completing-read
  10325. "Todo state: "
  10326. (with-current-buffer (marker-buffer (car entries))
  10327. (mapcar #'list org-todo-keywords-1)))))
  10328. (setq cmd (lambda ()
  10329. (let ((org-inhibit-blocking t)
  10330. (org-inhibit-logging 'note))
  10331. (org-agenda-todo state))))))
  10332. ((and (or ?- ?+) action)
  10333. (let ((tag (completing-read
  10334. (format "Tag to %s: " (if (eq action ?+) "add" "remove"))
  10335. (with-current-buffer (marker-buffer (car entries))
  10336. (delq nil
  10337. (mapcar (lambda (x) (and (stringp (car x)) x))
  10338. org-current-tag-alist))))))
  10339. (setq cmd
  10340. (lambda ()
  10341. (org-agenda-set-tags tag
  10342. (if (eq action ?+) 'on 'off))))))
  10343. ((and (or ?s ?d) c)
  10344. (let* ((schedule? (eq c ?s))
  10345. (prompt (if schedule? "(Re)Schedule to" "(Re)Set Deadline to"))
  10346. (time
  10347. (and (not arg)
  10348. (let ((new (org-read-date
  10349. nil nil nil prompt org-overriding-default-time)))
  10350. ;; A "double plus" answer applies to every
  10351. ;; scheduled time. Do not turn it into
  10352. ;; a fixed date yet.
  10353. (if (string-match-p "\\`[ \t]*\\+\\+"
  10354. org-read-date-final-answer)
  10355. org-read-date-final-answer
  10356. new)))))
  10357. ;; Make sure to not prompt for a note when bulk
  10358. ;; rescheduling/resetting deadline as Org cannot cope with
  10359. ;; simultaneous notes. Besides, it could be annoying
  10360. ;; depending on the number of marked items.
  10361. (setq cmd
  10362. (if schedule?
  10363. (lambda ()
  10364. (let ((org-log-reschedule
  10365. (and org-log-reschedule 'time)))
  10366. (org-agenda-schedule arg time)))
  10367. (lambda ()
  10368. (let ((org-log-redeadline (and org-log-redeadline 'time)))
  10369. (org-agenda-deadline arg time)))))))
  10370. (?S
  10371. (unless (org-agenda-check-type nil 'agenda 'todo)
  10372. (user-error "Can't scatter tasks in \"%s\" agenda view" org-agenda-type))
  10373. (let ((days (read-number
  10374. (format "Scatter tasks across how many %sdays: "
  10375. (if arg "week" ""))
  10376. 7)))
  10377. (setq cmd
  10378. (lambda ()
  10379. (let ((distance (1+ (random days))))
  10380. (when arg
  10381. (let ((dist distance)
  10382. (day-of-week
  10383. (calendar-day-of-week
  10384. (calendar-gregorian-from-absolute (org-today)))))
  10385. (dotimes (_ (1+ dist))
  10386. (while (member day-of-week org-agenda-weekend-days)
  10387. (cl-incf distance)
  10388. (cl-incf day-of-week)
  10389. (when (= day-of-week 7)
  10390. (setq day-of-week 0)))
  10391. (cl-incf day-of-week)
  10392. (when (= day-of-week 7)
  10393. (setq day-of-week 0)))))
  10394. ;; Silently fail when try to replan a sexp entry.
  10395. (ignore-errors
  10396. (let* ((date (calendar-gregorian-from-absolute
  10397. (+ (org-today) distance)))
  10398. (time (org-encode-time
  10399. 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  10400. (org-agenda-schedule nil time))))))))
  10401. (?f
  10402. (setq cmd
  10403. (intern
  10404. (completing-read "Function: " obarray #'fboundp t nil nil))))
  10405. (action
  10406. (setq cmd
  10407. (pcase (assoc action org-agenda-bulk-custom-functions)
  10408. (`(,_ ,fn)
  10409. fn)
  10410. (`(,_ ,fn ,arg-fn)
  10411. (apply #'apply-partially fn (funcall arg-fn)))
  10412. (_
  10413. (user-error "Invalid bulk action: %c" action))))
  10414. (setq redo-at-end t)))
  10415. ;; Sort the markers, to make sure that parents are handled
  10416. ;; before children.
  10417. (setq entries (sort entries
  10418. (lambda (a b)
  10419. (cond
  10420. ((eq (marker-buffer a) (marker-buffer b))
  10421. (< (marker-position a) (marker-position b)))
  10422. (t
  10423. (string< (buffer-name (marker-buffer a))
  10424. (buffer-name (marker-buffer b))))))))
  10425. ;; Now loop over all markers and apply CMD.
  10426. (let ((processed 0)
  10427. (skipped 0))
  10428. (dolist (e entries)
  10429. (let ((pos (text-property-any (point-min) (point-max) 'org-hd-marker e)))
  10430. (if (not pos)
  10431. (progn (message "Skipping removed entry at %s" e)
  10432. (cl-incf skipped))
  10433. (goto-char pos)
  10434. (let (org-loop-over-headlines-in-active-region) (funcall cmd))
  10435. ;; `post-command-hook' is not run yet. We make sure any
  10436. ;; pending log note is processed.
  10437. (when org-log-setup (org-add-log-note))
  10438. (cl-incf processed))))
  10439. (when redo-at-end (org-agenda-redo))
  10440. (unless org-agenda-persistent-marks (org-agenda-bulk-unmark-all))
  10441. (message "Acted on %d entries%s%s"
  10442. processed
  10443. (if (= skipped 0)
  10444. ""
  10445. (format ", skipped %d (disappeared before their turn)"
  10446. skipped))
  10447. (if (not org-agenda-persistent-marks) "" " (kept marked)"))))))
  10448. (defun org-agenda-capture (&optional with-time)
  10449. "Call `org-capture' with the date at point.
  10450. With a `C-1' prefix, use the HH:MM value at point (if any) or the
  10451. current HH:MM time."
  10452. (interactive "P")
  10453. (if (not (eq major-mode 'org-agenda-mode))
  10454. (user-error "You cannot do this outside of agenda buffers")
  10455. (let ((org-overriding-default-time
  10456. (org-get-cursor-date (equal with-time 1))))
  10457. (call-interactively 'org-capture))))
  10458. ;;; Dragging agenda lines forward/backward
  10459. (defun org-agenda-reapply-filters ()
  10460. "Re-apply all agenda filters."
  10461. (mapcar
  10462. (lambda(f) (when (car f) (org-agenda-filter-apply (car f) (cadr f) t)))
  10463. `((,org-agenda-tag-filter tag)
  10464. (,org-agenda-category-filter category)
  10465. (,org-agenda-regexp-filter regexp)
  10466. (,org-agenda-effort-filter effort)
  10467. (,(get 'org-agenda-tag-filter :preset-filter) tag)
  10468. (,(get 'org-agenda-category-filter :preset-filter) category)
  10469. (,(get 'org-agenda-effort-filter :preset-filter) effort)
  10470. (,(get 'org-agenda-regexp-filter :preset-filter) regexp))))
  10471. (defun org-agenda-drag-line-forward (arg &optional backward)
  10472. "Drag an agenda line forward by ARG lines.
  10473. When the optional argument `backward' is non-nil, move backward."
  10474. (interactive "p")
  10475. (let ((inhibit-read-only t) lst line)
  10476. (if (or (not (get-text-property (point) 'txt))
  10477. (save-excursion
  10478. (dotimes (_ arg)
  10479. (move-beginning-of-line (if backward 0 2))
  10480. (push (not (get-text-property (point) 'txt)) lst))
  10481. (delq nil lst)))
  10482. (message "Cannot move line forward")
  10483. (let ((end (save-excursion (move-beginning-of-line 2) (point))))
  10484. (move-beginning-of-line 1)
  10485. (setq line (buffer-substring (point) end))
  10486. (delete-region (point) end)
  10487. (move-beginning-of-line (funcall (if backward '1- '1+) arg))
  10488. (insert line)
  10489. (org-agenda-reapply-filters)
  10490. (org-agenda-mark-clocking-task)
  10491. (move-beginning-of-line 0)))))
  10492. (defun org-agenda-drag-line-backward (arg)
  10493. "Drag an agenda line backward by ARG lines."
  10494. (interactive "p")
  10495. (org-agenda-drag-line-forward arg t))
  10496. ;;; Flagging notes
  10497. (defun org-agenda-show-the-flagging-note ()
  10498. "Display the flagging note in the other window.
  10499. When called a second time in direct sequence, offer to remove the FLAGGING
  10500. tag and (if present) the flagging note."
  10501. (interactive)
  10502. (let ((hdmarker (org-get-at-bol 'org-hd-marker))
  10503. (win (selected-window))
  10504. note) ;; heading newhead
  10505. (unless hdmarker
  10506. (user-error "No linked entry at point"))
  10507. (if (and (eq this-command last-command)
  10508. (y-or-n-p "Unflag and remove any flagging note? "))
  10509. (progn
  10510. (org-agenda-remove-flag hdmarker)
  10511. (let ((win (get-buffer-window "*Flagging Note*")))
  10512. (and win (delete-window win)))
  10513. (message "Entry unflagged"))
  10514. (setq note (org-entry-get hdmarker "THEFLAGGINGNOTE"))
  10515. (unless note
  10516. (user-error "No flagging note"))
  10517. (org-kill-new note)
  10518. (org-switch-to-buffer-other-window "*Flagging Note*")
  10519. (erase-buffer)
  10520. (insert note)
  10521. (goto-char (point-min))
  10522. (while (re-search-forward "\\\\n" nil t)
  10523. (replace-match "\n" t t))
  10524. (goto-char (point-min))
  10525. (select-window win)
  10526. (message "%s" (substitute-command-keys "Flagging note pushed to \
  10527. kill ring. Press `\\[org-agenda-show-the-flagging-note]' again to remove \
  10528. tag and note")))))
  10529. (defun org-agenda-remove-flag (marker)
  10530. "Remove the FLAGGED tag and any flagging note in the entry."
  10531. (let ((newhead
  10532. (org-with-point-at marker
  10533. (org-toggle-tag "FLAGGED" 'off)
  10534. (org-entry-delete nil "THEFLAGGINGNOTE")
  10535. (org-get-heading))))
  10536. (org-agenda-change-all-lines newhead marker)
  10537. (message "Entry unflagged")))
  10538. (defun org-agenda-get-any-marker (&optional pos)
  10539. (or (get-text-property (or pos (line-beginning-position)) 'org-hd-marker)
  10540. (get-text-property (or pos (line-beginning-position)) 'org-marker)))
  10541. ;;; Appointment reminders
  10542. (defvar appt-time-msg-list) ; defined in appt.el
  10543. ;;;###autoload
  10544. (defun org-agenda-to-appt (&optional refresh filter &rest args)
  10545. "Activate appointments found in `org-agenda-files'.
  10546. With a `\\[universal-argument]' prefix, refresh the list of \
  10547. appointments.
  10548. If FILTER is t, interactively prompt the user for a regular
  10549. expression, and filter out entries that don't match it.
  10550. If FILTER is a string, use this string as a regular expression
  10551. for filtering entries out.
  10552. If FILTER is a function, filter out entries against which
  10553. calling the function returns nil. This function takes one
  10554. argument: an entry from `org-agenda-get-day-entries'.
  10555. FILTER can also be an alist with the car of each cell being
  10556. either `headline' or `category'. For example:
  10557. ((headline \"IMPORTANT\")
  10558. (category \"Work\"))
  10559. will only add headlines containing IMPORTANT or headlines
  10560. belonging to the \"Work\" category.
  10561. ARGS are symbols indicating what kind of entries to consider.
  10562. By default `org-agenda-to-appt' will use :deadline*, :scheduled*
  10563. \(i.e., deadlines and scheduled items with a hh:mm specification)
  10564. and :timestamp entries. See the docstring of `org-diary' for
  10565. details and examples.
  10566. If an entry has a APPT_WARNTIME property, its value will be used
  10567. to override `appt-message-warning-time'."
  10568. (interactive "P")
  10569. (when refresh (setq appt-time-msg-list nil))
  10570. (when (eq filter t)
  10571. (setq filter (read-from-minibuffer "Regexp filter: ")))
  10572. (let* ((cnt 0) ; count added events
  10573. (scope (or args '(:deadline* :scheduled* :timestamp)))
  10574. (org-agenda-new-buffers nil)
  10575. (org-deadline-warning-days 0)
  10576. ;; Do not use `org-today' here because appt only takes
  10577. ;; time and without date as argument, so it may pass wrong
  10578. ;; information otherwise
  10579. (today (org-date-to-gregorian
  10580. (time-to-days nil)))
  10581. (org-agenda-restrict nil)
  10582. (files (org-agenda-files 'unrestricted)) entries file
  10583. (org-agenda-buffer nil))
  10584. ;; Get all entries which may contain an appt
  10585. (org-agenda-prepare-buffers files)
  10586. (while (setq file (pop files))
  10587. (setq entries
  10588. (delq nil
  10589. (append entries
  10590. (apply #'org-agenda-get-day-entries
  10591. file today scope)))))
  10592. ;; Map through entries and find if we should filter them out
  10593. (mapc
  10594. (lambda (x)
  10595. (let* ((evt (org-trim
  10596. (replace-regexp-in-string
  10597. org-link-bracket-re "\\2"
  10598. (or (get-text-property 1 'txt x) ""))))
  10599. (cat (get-text-property (1- (length x)) 'org-category x))
  10600. (tod (get-text-property 1 'time-of-day x))
  10601. (ok (or (null filter)
  10602. (and (stringp filter) (string-match filter evt))
  10603. (and (functionp filter) (funcall filter x))
  10604. (and (listp filter)
  10605. (let ((cat-filter (cadr (assq 'category filter)))
  10606. (evt-filter (cadr (assq 'headline filter))))
  10607. (or (and (stringp cat-filter)
  10608. (string-match cat-filter cat))
  10609. (and (stringp evt-filter)
  10610. (string-match evt-filter evt)))))))
  10611. (wrn (get-text-property 1 'warntime x)))
  10612. ;; FIXME: Shall we remove text-properties for the appt text?
  10613. ;; (setq evt (set-text-properties 0 (length evt) nil evt))
  10614. (when (and ok tod (not (string-match "\\`DONE\\|CANCELLED" evt)))
  10615. (setq tod (concat "00" (number-to-string tod)))
  10616. (setq tod (when (string-match
  10617. "\\([0-9]\\{1,2\\}\\)\\([0-9]\\{2\\}\\)\\'" tod)
  10618. (concat (match-string 1 tod) ":"
  10619. (match-string 2 tod))))
  10620. (when (appt-add tod evt wrn)
  10621. (setq cnt (1+ cnt))))))
  10622. entries)
  10623. (org-release-buffers org-agenda-new-buffers)
  10624. (if (eq cnt 0)
  10625. (message "No event to add")
  10626. (message "Added %d event%s for today" cnt (if (> cnt 1) "s" "")))))
  10627. (defun org-agenda-today-p (date)
  10628. "Non-nil when DATE means today.
  10629. DATE is either a list of the form (month day year) or a number of
  10630. days as returned by `calendar-absolute-from-gregorian' or
  10631. `org-today'. This function considers `org-extend-today-until'
  10632. when defining today."
  10633. (eq (org-today)
  10634. (if (consp date) (calendar-absolute-from-gregorian date) date)))
  10635. (defun org-agenda-todo-yesterday (&optional arg)
  10636. "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday."
  10637. (interactive "P")
  10638. (let* ((org-use-effective-time t)
  10639. (hour (nth 2 (decode-time (org-current-time))))
  10640. (org-extend-today-until (1+ hour)))
  10641. (org-agenda-todo arg)))
  10642. (defun org-agenda-ctrl-c-ctrl-c ()
  10643. "Set tags in agenda buffer."
  10644. (interactive)
  10645. (org-agenda-set-tags))
  10646. (provide 'org-agenda)
  10647. ;;; org-agenda.el ends here