org-agenda.el 420 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888
  1. ;;; org-agenda.el --- Dynamic task and appointment lists for Org -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2004-2021 Free Software Foundation, Inc.
  3. ;; Author: Carsten Dominik <carsten.dominik@gmail.com>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; Homepage: 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 'cl-lib)
  42. (require 'ol)
  43. (require 'org)
  44. (require 'org-macs)
  45. (require 'org-refile)
  46. (declare-function diary-add-to-list "diary-lib"
  47. (date string specifier &optional marker globcolor literal))
  48. (declare-function calendar-iso-to-absolute "cal-iso" (date))
  49. (declare-function calendar-astro-date-string "cal-julian" (&optional date))
  50. (declare-function calendar-bahai-date-string "cal-bahai" (&optional date))
  51. (declare-function calendar-chinese-date-string "cal-china" (&optional date))
  52. (declare-function calendar-coptic-date-string "cal-coptic" (&optional date))
  53. (declare-function calendar-ethiopic-date-string "cal-coptic" (&optional date))
  54. (declare-function calendar-french-date-string "cal-french" (&optional date))
  55. (declare-function calendar-goto-date "cal-move" (date))
  56. (declare-function calendar-hebrew-date-string "cal-hebrew" (&optional date))
  57. (declare-function calendar-islamic-date-string "cal-islam" (&optional date))
  58. (declare-function calendar-iso-date-string "cal-iso" (&optional date))
  59. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  60. (declare-function calendar-julian-date-string "cal-julian" (&optional date))
  61. (declare-function calendar-mayan-date-string "cal-mayan" (&optional date))
  62. (declare-function calendar-persian-date-string "cal-persia" (&optional date))
  63. (declare-function calendar-check-holidays "holidays" (date))
  64. (declare-function org-columns-remove-overlays "org-colview" ())
  65. (declare-function org-datetree-find-date-create "org-datetree"
  66. (date &optional keep-restriction))
  67. (declare-function org-columns-quit "org-colview" ())
  68. (declare-function diary-date-display-form "diary-lib" (&optional type))
  69. (declare-function org-mobile-write-agenda-for-mobile "org-mobile" (file))
  70. (declare-function org-habit-insert-consistency-graphs
  71. "org-habit" (&optional line))
  72. (declare-function org-is-habit-p "org-habit" (&optional pom))
  73. (declare-function org-habit-parse-todo "org-habit" (&optional pom))
  74. (declare-function org-habit-get-priority "org-habit" (habit &optional moment))
  75. (declare-function org-agenda-columns "org-colview" ())
  76. (declare-function org-add-archive-files "org-archive" (files))
  77. (declare-function org-capture "org-capture" (&optional goto keys))
  78. (declare-function org-clock-modify-effort-estimate "org-clock" (&optional value))
  79. (defvar calendar-mode-map)
  80. (defvar org-clock-current-task)
  81. (defvar org-current-tag-alist)
  82. (defvar org-mobile-force-id-on-agenda-items)
  83. (defvar org-habit-show-habits)
  84. (defvar org-habit-show-habits-only-for-today)
  85. (defvar org-habit-show-all-today)
  86. (defvar org-habit-scheduled-past-days)
  87. ;; Defined somewhere in this file, but used before definition.
  88. (defvar org-agenda-buffer-name "*Org Agenda*")
  89. (defvar org-agenda-overriding-header nil)
  90. (defvar org-agenda-title-append nil)
  91. ;; (with-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  92. ;; (with-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  93. (defvar original-date) ; dynamically scoped, calendar.el does scope this
  94. (defvar org-agenda-undo-list nil
  95. "List of undoable operations in the agenda since last refresh.")
  96. (defvar org-agenda-pending-undo-list nil
  97. "In a series of undo commands, this is the list of remaining undo items.")
  98. (defcustom org-agenda-confirm-kill 1
  99. "When set, remote killing from the agenda buffer needs confirmation.
  100. When t, a confirmation is always needed. When a number N, confirmation is
  101. only needed when the text to be killed contains more than N non-white lines."
  102. :group 'org-agenda
  103. :type '(choice
  104. (const :tag "Never" nil)
  105. (const :tag "Always" t)
  106. (integer :tag "When more than N lines")))
  107. (defcustom org-agenda-compact-blocks nil
  108. "Non-nil means make the block agenda more compact.
  109. This is done globally by leaving out lines like the agenda span
  110. name and week number or the separator lines."
  111. :group 'org-agenda
  112. :type 'boolean)
  113. (defcustom org-agenda-block-separator ?=
  114. "The separator between blocks in the agenda.
  115. If this is a string, it will be used as the separator, with a newline added.
  116. If it is a character, it will be repeated to fill the window width.
  117. If nil the separator is disabled. In `org-agenda-custom-commands' this
  118. addresses the separator between the current and the previous block."
  119. :group 'org-agenda
  120. :type '(choice
  121. (const :tag "Disabled" nil)
  122. (character)
  123. (string)))
  124. (defgroup org-agenda-export nil
  125. "Options concerning exporting agenda views in Org mode."
  126. :tag "Org Agenda Export"
  127. :group 'org-agenda)
  128. (defcustom org-agenda-with-colors t
  129. "Non-nil means use colors in agenda views."
  130. :group 'org-agenda-export
  131. :type 'boolean)
  132. (defcustom org-agenda-exporter-settings nil
  133. ;; FIXME: Do we really want to evaluate those settings and thus force
  134. ;; the user to use `quote' all the time?
  135. "Alist of variable/value pairs that should be active during agenda export.
  136. This is a good place to set options for ps-print and for htmlize.
  137. Note that the way this is implemented, the values will be evaluated
  138. before assigned to the variables. So make sure to quote values you do
  139. *not* want evaluated, for example
  140. (setq org-agenda-exporter-settings
  141. \\='((ps-print-color-p \\='black-white)))"
  142. :group 'org-agenda-export
  143. :type '(repeat
  144. (list
  145. (variable)
  146. (sexp :tag "Value"))))
  147. (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
  148. "Hook run in a temporary buffer before writing the agenda to an export file.
  149. A useful function for this hook is `org-agenda-add-entry-text'."
  150. :group 'org-agenda-export
  151. :type 'hook
  152. :options '(org-agenda-add-entry-text))
  153. (defcustom org-agenda-add-entry-text-maxlines 0
  154. "Maximum number of entry text lines to be added to agenda.
  155. This is only relevant when `org-agenda-add-entry-text' is part of
  156. `org-agenda-before-write-hook', which is the default.
  157. When this is 0, nothing will happen. When it is greater than 0, it
  158. specifies the maximum number of lines that will be added for each entry
  159. that is listed in the agenda view.
  160. Note that this variable is not used during display, only when exporting
  161. the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
  162. and `org-agenda-entry-text-maxlines'."
  163. :group 'org-agenda
  164. :type 'integer)
  165. (defcustom org-agenda-add-entry-text-descriptive-links t
  166. "Non-nil means export org-links as descriptive links in agenda added text.
  167. This variable applies to the text added to the agenda when
  168. `org-agenda-add-entry-text-maxlines' is larger than 0.
  169. When this variable is nil, the URL will (also) be shown."
  170. :group 'org-agenda
  171. :type 'boolean)
  172. (defcustom org-agenda-export-html-style nil
  173. "The style specification for exported HTML Agenda files.
  174. If this variable contains a string, it will replace the default <style>
  175. section as produced by `htmlize'.
  176. Since there are different ways of setting style information, this variable
  177. needs to contain the full HTML structure to provide a style, including the
  178. surrounding HTML tags. The style specifications should include definitions
  179. the fonts used by the agenda, here is an example:
  180. <style type=\"text/css\">
  181. p { font-weight: normal; color: gray; }
  182. .org-agenda-structure {
  183. font-size: 110%;
  184. color: #003399;
  185. font-weight: 600;
  186. }
  187. .org-todo {
  188. color: #cc6666;
  189. font-weight: bold;
  190. }
  191. .org-agenda-done {
  192. color: #339933;
  193. }
  194. .org-done {
  195. color: #339933;
  196. }
  197. .title { text-align: center; }
  198. .todo, .deadline { color: red; }
  199. .done { color: green; }
  200. </style>
  201. or, if you want to keep the style in a file,
  202. <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
  203. As the value of this option simply gets inserted into the HTML <head> header,
  204. you can \"misuse\" it to also add other text to the header."
  205. :group 'org-agenda-export
  206. :group 'org-export-html
  207. :type '(choice
  208. (const nil)
  209. (string)))
  210. (defcustom org-agenda-persistent-filter nil
  211. "When set, keep filters from one agenda view to the next."
  212. :group 'org-agenda
  213. :type 'boolean)
  214. (defgroup org-agenda-custom-commands nil
  215. "Options concerning agenda views in Org mode."
  216. :tag "Org Agenda Custom Commands"
  217. :group 'org-agenda)
  218. (defconst org-sorting-choice
  219. '(choice
  220. (const time-up) (const time-down)
  221. (const timestamp-up) (const timestamp-down)
  222. (const scheduled-up) (const scheduled-down)
  223. (const deadline-up) (const deadline-down)
  224. (const ts-up) (const ts-down)
  225. (const tsia-up) (const tsia-down)
  226. (const category-keep) (const category-up) (const category-down)
  227. (const tag-down) (const tag-up)
  228. (const priority-up) (const priority-down)
  229. (const todo-state-up) (const todo-state-down)
  230. (const effort-up) (const effort-down)
  231. (const habit-up) (const habit-down)
  232. (const alpha-up) (const alpha-down)
  233. (const user-defined-up) (const user-defined-down))
  234. "Sorting choices.")
  235. ;; Keep custom values for `org-agenda-filter-preset' compatible with
  236. ;; the new variable `org-agenda-tag-filter-preset'.
  237. (defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
  238. (defvaralias 'org-agenda-filter 'org-agenda-tag-filter)
  239. (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
  240. "List of types searched for when creating the daily/weekly agenda.
  241. This variable is a list of symbols that controls the types of
  242. items that appear in the daily/weekly agenda. Allowed symbols in this
  243. list are
  244. :timestamp List items containing a date stamp or date range matching
  245. the selected date. This includes sexp entries in angular
  246. brackets.
  247. :sexp List entries resulting from plain diary-like sexps.
  248. :deadline List deadline due on that date. When the date is today,
  249. also list any deadlines past due, or due within
  250. `org-deadline-warning-days'.
  251. :deadline* Same as above, but only include the deadline if it has an
  252. hour specification as [h]h:mm.
  253. :scheduled List all items which are scheduled for the given date.
  254. The diary for *today* also contains items which were
  255. scheduled earlier and are not yet marked DONE.
  256. :scheduled* Same as above, but only include the scheduled item if it
  257. has an hour specification as [h]h:mm.
  258. By default, all four non-starred types are turned on.
  259. When :scheduled* or :deadline* are included, :schedule or :deadline
  260. will be ignored.
  261. Never set this variable globally using `setq', because then it
  262. will apply to all future agenda commands. Instead, bind it with
  263. `let' to scope it dynamically into the agenda-constructing
  264. command. A good way to set it is through options in
  265. `org-agenda-custom-commands'. For a more flexible (though
  266. somewhat less efficient) way of determining what is included in
  267. the daily/weekly agenda, see `org-agenda-skip-function'.")
  268. (defconst org-agenda-custom-commands-local-options
  269. `(repeat :tag "Local settings for this command. Remember to quote values"
  270. (choice :tag "Setting"
  271. (list :tag "Heading for this block"
  272. (const org-agenda-overriding-header)
  273. (string :tag "Headline"))
  274. (list :tag "Files to be searched"
  275. (const org-agenda-files)
  276. (list
  277. (const :format "" quote)
  278. (repeat (file))))
  279. (list :tag "Sorting strategy"
  280. (const org-agenda-sorting-strategy)
  281. (list
  282. (const :format "" quote)
  283. (repeat
  284. ,org-sorting-choice)))
  285. (list :tag "Prefix format"
  286. (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
  287. (string))
  288. (list :tag "Number of days in agenda"
  289. (const org-agenda-span)
  290. (list
  291. (const :format "" quote)
  292. (choice (const :tag "Day" day)
  293. (const :tag "Week" week)
  294. (const :tag "Fortnight" fortnight)
  295. (const :tag "Month" month)
  296. (const :tag "Year" year)
  297. (integer :tag "Custom"))))
  298. (list :tag "Fixed starting date"
  299. (const org-agenda-start-day)
  300. (string :value "2007-11-01"))
  301. (list :tag "Start on day of week"
  302. (const org-agenda-start-on-weekday)
  303. (choice :value 1
  304. (const :tag "Today" nil)
  305. (integer :tag "Weekday No.")))
  306. (list :tag "Include data from diary"
  307. (const org-agenda-include-diary)
  308. (boolean))
  309. (list :tag "Deadline Warning days"
  310. (const org-deadline-warning-days)
  311. (integer :value 1))
  312. (list :tag "Category filter preset"
  313. (const org-agenda-category-filter-preset)
  314. (list
  315. (const :format "" quote)
  316. (repeat
  317. (string :tag "+category or -category"))))
  318. (list :tag "Tags filter preset"
  319. (const org-agenda-tag-filter-preset)
  320. (list
  321. (const :format "" quote)
  322. (repeat
  323. (string :tag "+tag or -tag"))))
  324. (list :tag "Effort filter preset"
  325. (const org-agenda-effort-filter-preset)
  326. (list
  327. (const :format "" quote)
  328. (repeat
  329. (string :tag "+=10 or -=10 or +<10 or ->10"))))
  330. (list :tag "Regexp filter preset"
  331. (const org-agenda-regexp-filter-preset)
  332. (list
  333. (const :format "" quote)
  334. (repeat
  335. (string :tag "+regexp or -regexp"))))
  336. (list :tag "Set daily/weekly entry types"
  337. (const org-agenda-entry-types)
  338. (list
  339. (const :format "" quote)
  340. (set :greedy t :value ,org-agenda-entry-types
  341. (const :deadline)
  342. (const :scheduled)
  343. (const :deadline*)
  344. (const :scheduled*)
  345. (const :timestamp)
  346. (const :sexp))))
  347. (list :tag "Columns format"
  348. (const org-overriding-columns-format)
  349. (string :tag "Format"))
  350. (list :tag "Standard skipping condition"
  351. :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
  352. (const org-agenda-skip-function)
  353. (list
  354. (const :format "" quote)
  355. (list
  356. (choice
  357. :tag "Skipping range"
  358. (const :tag "Skip entry" org-agenda-skip-entry-if)
  359. (const :tag "Skip subtree" org-agenda-skip-subtree-if))
  360. (repeat :inline t :tag "Conditions for skipping"
  361. (choice
  362. :tag "Condition type"
  363. (list :tag "Regexp matches" :inline t
  364. (const :format "" regexp)
  365. (regexp))
  366. (list :tag "Regexp does not match" :inline t
  367. (const :format "" notregexp)
  368. (regexp))
  369. (list :tag "TODO state is" :inline t
  370. (const todo)
  371. (choice
  372. (const :tag "Any not-done state" todo)
  373. (const :tag "Any done state" done)
  374. (const :tag "Any state" any)
  375. (list :tag "Keyword list"
  376. (const :format "" quote)
  377. (repeat (string :tag "Keyword")))))
  378. (list :tag "TODO state is not" :inline t
  379. (const nottodo)
  380. (choice
  381. (const :tag "Any not-done state" todo)
  382. (const :tag "Any done state" done)
  383. (const :tag "Any state" any)
  384. (list :tag "Keyword list"
  385. (const :format "" quote)
  386. (repeat (string :tag "Keyword")))))
  387. (const :tag "scheduled" scheduled)
  388. (const :tag "not scheduled" notscheduled)
  389. (const :tag "deadline" deadline)
  390. (const :tag "no deadline" notdeadline)
  391. (const :tag "timestamp" timestamp)
  392. (const :tag "no timestamp" nottimestamp))))))
  393. (list :tag "Non-standard skipping condition"
  394. :value (org-agenda-skip-function)
  395. (const org-agenda-skip-function)
  396. (sexp :tag "Function or form (quoted!)"))
  397. (list :tag "Any variable"
  398. (variable :tag "Variable")
  399. (sexp :tag "Value (sexp)"))))
  400. "Selection of examples for agenda command settings.
  401. This will be spliced into the custom type of
  402. `org-agenda-custom-commands'.")
  403. (defcustom org-agenda-custom-commands
  404. '(("n" "Agenda and all TODOs" ((agenda "") (alltodo ""))))
  405. "Custom commands for the agenda.
  406. \\<org-mode-map>
  407. These commands will be offered on the splash screen displayed by the
  408. agenda dispatcher `\\[org-agenda]'. Each entry is a list like this:
  409. (key desc type match settings files)
  410. key The key (one or more characters as a string) to be associated
  411. with the command.
  412. desc A description of the command, when omitted or nil, a default
  413. description is built using MATCH.
  414. type The command type, any of the following symbols:
  415. agenda The daily/weekly agenda.
  416. todo Entries with a specific TODO keyword, in all agenda files.
  417. search Entries containing search words entry or headline.
  418. tags Tags/Property/TODO match in all agenda files.
  419. tags-todo Tags/P/T match in all agenda files, TODO entries only.
  420. todo-tree Sparse tree of specific TODO keyword in *current* file.
  421. tags-tree Sparse tree with all tags matches in *current* file.
  422. occur-tree Occur sparse tree for *current* file.
  423. ... A user-defined function.
  424. match What to search for:
  425. - a single keyword for TODO keyword searches
  426. - a tags/property/todo match expression for searches
  427. - a word search expression for text searches.
  428. - a regular expression for occur searches
  429. For all other commands, this should be the empty string.
  430. settings A list of option settings, similar to that in a let form, so like
  431. this: ((opt1 val1) (opt2 val2) ...). The values will be
  432. evaluated at the moment of execution, so quote them when needed.
  433. files A list of files to write the produced agenda buffer to with
  434. the command `org-store-agenda-views'.
  435. If a file name ends in \".html\", an HTML version of the buffer
  436. is written out. If it ends in \".ps\", a postscript version is
  437. produced. Otherwise, only the plain text is written to the file.
  438. You can also define a set of commands, to create a composite agenda buffer.
  439. In this case, an entry looks like this:
  440. (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
  441. where
  442. desc A description string to be displayed in the dispatcher menu.
  443. cmd An agenda command, similar to the above. However, tree commands
  444. are not allowed, but instead you can get agenda and global todo list.
  445. So valid commands for a set are:
  446. (agenda \"\" settings)
  447. (alltodo \"\" settings)
  448. (stuck \"\" settings)
  449. (todo \"match\" settings files)
  450. (search \"match\" settings files)
  451. (tags \"match\" settings files)
  452. (tags-todo \"match\" settings files)
  453. Each command can carry a list of options, and another set of options can be
  454. given for the whole set of commands. Individual command options take
  455. precedence over the general options.
  456. When using several characters as key to a command, the first characters
  457. are prefix commands. For the dispatcher to display useful information, you
  458. should provide a description for the prefix, like
  459. (setq org-agenda-custom-commands
  460. \\='((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
  461. (\"hl\" tags \"+HOME+Lisa\")
  462. (\"hp\" tags \"+HOME+Peter\")
  463. (\"hk\" tags \"+HOME+Kim\")))"
  464. :group 'org-agenda-custom-commands
  465. :type `(repeat
  466. (choice :value ("x" "Describe command here" tags "" nil)
  467. (list :tag "Single command"
  468. (string :tag "Access Key(s) ")
  469. (option (string :tag "Description"))
  470. (choice
  471. (const :tag "Agenda" agenda)
  472. (const :tag "TODO list" alltodo)
  473. (const :tag "Search words" search)
  474. (const :tag "Stuck projects" stuck)
  475. (const :tag "Tags/Property match (all agenda files)" tags)
  476. (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
  477. (const :tag "TODO keyword search (all agenda files)" todo)
  478. (const :tag "Tags sparse tree (current buffer)" tags-tree)
  479. (const :tag "TODO keyword tree (current buffer)" todo-tree)
  480. (const :tag "Occur tree (current buffer)" occur-tree)
  481. (sexp :tag "Other, user-defined function"))
  482. (string :tag "Match (only for some commands)")
  483. ,org-agenda-custom-commands-local-options
  484. (option (repeat :tag "Export" (file :tag "Export to"))))
  485. (list :tag "Command series, all agenda files"
  486. (string :tag "Access Key(s)")
  487. (string :tag "Description ")
  488. (repeat :tag "Component"
  489. (choice
  490. (list :tag "Agenda"
  491. (const :format "" agenda)
  492. (const :tag "" :format "" "")
  493. ,org-agenda-custom-commands-local-options)
  494. (list :tag "TODO list (all keywords)"
  495. (const :format "" alltodo)
  496. (const :tag "" :format "" "")
  497. ,org-agenda-custom-commands-local-options)
  498. (list :tag "Search words"
  499. (const :format "" search)
  500. (string :tag "Match")
  501. ,org-agenda-custom-commands-local-options)
  502. (list :tag "Stuck projects"
  503. (const :format "" stuck)
  504. (const :tag "" :format "" "")
  505. ,org-agenda-custom-commands-local-options)
  506. (list :tag "Tags/Property match (all agenda files)"
  507. (const :format "" tags)
  508. (string :tag "Match")
  509. ,org-agenda-custom-commands-local-options)
  510. (list :tag "Tags/Property match of TODO entries (all agenda files)"
  511. (const :format "" tags-todo)
  512. (string :tag "Match")
  513. ,org-agenda-custom-commands-local-options)
  514. (list :tag "TODO keyword search"
  515. (const :format "" todo)
  516. (string :tag "Match")
  517. ,org-agenda-custom-commands-local-options)
  518. (list :tag "Other, user-defined function"
  519. (symbol :tag "function")
  520. (string :tag "Match")
  521. ,org-agenda-custom-commands-local-options)))
  522. (repeat :tag "Settings for entire command set"
  523. (list (variable :tag "Any variable")
  524. (sexp :tag "Value")))
  525. (option (repeat :tag "Export" (file :tag "Export to"))))
  526. (cons :tag "Prefix key documentation"
  527. (string :tag "Access Key(s)")
  528. (string :tag "Description ")))))
  529. (defcustom org-agenda-query-register ?o
  530. "The register holding the current query string.
  531. The purpose of this is that if you construct a query string interactively,
  532. you can then use it to define a custom command."
  533. :group 'org-agenda-custom-commands
  534. :type 'character)
  535. (defcustom org-stuck-projects
  536. '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
  537. "How to identify stuck projects.
  538. This is a list of four items:
  539. 1. A tags/todo/property matcher string that is used to identify a project.
  540. See the manual for a description of tag and property searches.
  541. The entire tree below a headline matched by this is considered one project.
  542. 2. A list of TODO keywords identifying non-stuck projects.
  543. If the project subtree contains any headline with one of these todo
  544. keywords, the project is considered to be not stuck. If you specify
  545. \"*\" as a keyword, any TODO keyword will mark the project unstuck.
  546. 3. A list of tags identifying non-stuck projects.
  547. If the project subtree contains any headline with one of these tags,
  548. the project is considered to be not stuck. If you specify \"*\" as
  549. a tag, any tag will mark the project unstuck. Note that this is about
  550. the explicit presence of a tag somewhere in the subtree, inherited
  551. tags do not count here. If inherited tags make a project not stuck,
  552. use \"-TAG\" in the tags part of the matcher under (1.) above.
  553. 4. An arbitrary regular expression matching non-stuck projects.
  554. If the project turns out to be not stuck, search continues also in the
  555. subtree to see if any of the subtasks have project status.
  556. See also the variable `org-tags-match-list-sublevels' which applies
  557. to projects matched by this search as well.
  558. After defining this variable, you may use `org-agenda-list-stuck-projects'
  559. \(bound to `\\[org-agenda] #') to produce the list."
  560. :group 'org-agenda-custom-commands
  561. :type '(list
  562. (string :tag "Tags/TODO match to identify a project")
  563. (repeat :tag "Projects are *not* stuck if they have an entry with \
  564. TODO keyword any of" (string))
  565. (repeat :tag "Projects are *not* stuck if they have an entry with \
  566. TAG being any of" (string))
  567. (regexp :tag "Projects are *not* stuck if this regexp matches inside \
  568. the subtree")))
  569. (defgroup org-agenda-skip nil
  570. "Options concerning skipping parts of agenda files."
  571. :tag "Org Agenda Skip"
  572. :group 'org-agenda)
  573. (defcustom org-agenda-skip-function-global nil
  574. "Function to be called at each match during agenda construction.
  575. If this function returns nil, the current match should not be skipped.
  576. If the function decided to skip an agenda match, is must return the
  577. buffer position from which the search should be continued.
  578. This may also be a Lisp form, which will be evaluated.
  579. This variable will be applied to every agenda match, including
  580. tags/property searches and TODO lists. So try to make the test function
  581. do its checking as efficiently as possible. To implement a skipping
  582. condition just for specific agenda commands, use the variable
  583. `org-agenda-skip-function' which can be set in the options section
  584. of custom agenda commands."
  585. :group 'org-agenda-skip
  586. :type 'sexp)
  587. (defgroup org-agenda-daily/weekly nil
  588. "Options concerning the daily/weekly agenda."
  589. :tag "Org Agenda Daily/Weekly"
  590. :group 'org-agenda)
  591. (defgroup org-agenda-todo-list nil
  592. "Options concerning the global todo list agenda view."
  593. :tag "Org Agenda Todo List"
  594. :group 'org-agenda)
  595. (defgroup org-agenda-match-view nil
  596. "Options concerning the general tags/property/todo match agenda view."
  597. :tag "Org Agenda Match View"
  598. :group 'org-agenda)
  599. (defgroup org-agenda-search-view nil
  600. "Options concerning the search agenda view."
  601. :tag "Org Agenda Search View"
  602. :group 'org-agenda)
  603. (defvar org-agenda-archives-mode nil
  604. "Non-nil means the agenda will include archived items.
  605. If this is the symbol `trees', trees in the selected agenda scope
  606. that are marked with the ARCHIVE tag will be included anyway. When this is
  607. t, also all archive files associated with the current selection of agenda
  608. files will be included.")
  609. (defcustom org-agenda-restriction-lock-highlight-subtree t
  610. "Non-nil means highlight the whole subtree when restriction is active.
  611. Otherwise only highlight the headline. Highlighting the whole subtree is
  612. useful to ensure no edits happen beyond the restricted region."
  613. :group 'org-agenda
  614. :type 'boolean)
  615. (defcustom org-agenda-skip-comment-trees t
  616. "Non-nil means skip trees that start with the COMMENT keyword.
  617. When nil, these trees are also scanned by agenda commands."
  618. :group 'org-agenda-skip
  619. :type 'boolean)
  620. (defcustom org-agenda-todo-list-sublevels t
  621. "Non-nil means check also the sublevels of a TODO entry for TODO entries.
  622. When nil, the sublevels of a TODO entry are not checked, resulting in
  623. potentially much shorter TODO lists."
  624. :group 'org-agenda-skip
  625. :group 'org-agenda-todo-list
  626. :type 'boolean)
  627. (defcustom org-agenda-todo-ignore-with-date nil
  628. "Non-nil means don't show entries with a date in the global todo list.
  629. You can use this if you prefer to mark mere appointments with a TODO keyword,
  630. but don't want them to show up in the TODO list.
  631. When this is set, it also covers deadlines and scheduled items, the settings
  632. of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
  633. will be ignored.
  634. See also the variable `org-agenda-tags-todo-honor-ignore-options'."
  635. :group 'org-agenda-skip
  636. :group 'org-agenda-todo-list
  637. :type 'boolean)
  638. (defcustom org-agenda-todo-ignore-timestamp nil
  639. "Non-nil means don't show entries with a timestamp.
  640. This applies when creating the global todo list.
  641. Valid values are:
  642. past Don't show entries for today or in the past.
  643. future Don't show entries with a timestamp in the future.
  644. The idea behind this is that if it has a future
  645. timestamp, you don't want to think about it until the
  646. date.
  647. all Don't show any entries with a timestamp in the global todo list.
  648. The idea behind this is that by setting a timestamp, you
  649. have already \"taken care\" of this item.
  650. This variable can also have an integer as a value. If positive (N),
  651. todos with a timestamp N or more days in the future will be ignored. If
  652. negative (-N), todos with a timestamp N or more days in the past will be
  653. ignored. If 0, todos with a timestamp either today or in the future will
  654. be ignored. For example, a value of -1 will exclude todos with a
  655. timestamp in the past (yesterday or earlier), while a value of 7 will
  656. exclude todos with a timestamp a week or more in the future.
  657. See also `org-agenda-todo-ignore-with-date'.
  658. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  659. to make his option also apply to the tags-todo list."
  660. :group 'org-agenda-skip
  661. :group 'org-agenda-todo-list
  662. :version "24.1"
  663. :type '(choice
  664. (const :tag "Ignore future timestamp todos" future)
  665. (const :tag "Ignore past or present timestamp todos" past)
  666. (const :tag "Ignore all timestamp todos" all)
  667. (const :tag "Show timestamp todos" nil)
  668. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  669. (defcustom org-agenda-todo-ignore-scheduled nil
  670. "Non-nil means, ignore some scheduled TODO items when making TODO list.
  671. This applies when creating the global todo list.
  672. Valid values are:
  673. past Don't show entries scheduled today or in the past.
  674. future Don't show entries scheduled in the future.
  675. The idea behind this is that by scheduling it, you don't want to
  676. think about it until the scheduled date.
  677. all Don't show any scheduled entries in the global todo list.
  678. The idea behind this is that by scheduling it, you have already
  679. \"taken care\" of this item.
  680. t Same as `all', for backward compatibility.
  681. This variable can also have an integer as a value. See
  682. `org-agenda-todo-ignore-timestamp' for more details.
  683. See also `org-agenda-todo-ignore-with-date'.
  684. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  685. to make his option also apply to the tags-todo list."
  686. :group 'org-agenda-skip
  687. :group 'org-agenda-todo-list
  688. :type '(choice
  689. (const :tag "Ignore future-scheduled todos" future)
  690. (const :tag "Ignore past- or present-scheduled todos" past)
  691. (const :tag "Ignore all scheduled todos" all)
  692. (const :tag "Ignore all scheduled todos (compatibility)" t)
  693. (const :tag "Show scheduled todos" nil)
  694. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  695. (defcustom org-agenda-todo-ignore-deadlines nil
  696. "Non-nil means ignore some deadline TODO items when making TODO list.
  697. There are different motivations for using different values, please think
  698. carefully when configuring this variable.
  699. This applies when creating the global TODO list.
  700. Valid values are:
  701. near Don't show near deadline entries. A deadline is near when it is
  702. closer than `org-deadline-warning-days' days. The idea behind this
  703. is that such items will appear in the agenda anyway.
  704. far Don't show TODO entries where a deadline has been defined, but
  705. is not going to happen anytime soon. This is useful if you want to use
  706. the TODO list to figure out what to do now.
  707. past Don't show entries with a deadline timestamp for today or in the past.
  708. future Don't show entries with a deadline timestamp in the future, not even
  709. when they become `near' ones. Use it with caution.
  710. all Ignore all TODO entries that do have a deadline.
  711. t Same as `near', for backward compatibility.
  712. This variable can also have an integer as a value. See
  713. `org-agenda-todo-ignore-timestamp' for more details.
  714. See also `org-agenda-todo-ignore-with-date'.
  715. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  716. to make his option also apply to the tags-todo list."
  717. :group 'org-agenda-skip
  718. :group 'org-agenda-todo-list
  719. :type '(choice
  720. (const :tag "Ignore near deadlines" near)
  721. (const :tag "Ignore near deadlines (compatibility)" t)
  722. (const :tag "Ignore far deadlines" far)
  723. (const :tag "Ignore all TODOs with a deadlines" all)
  724. (const :tag "Show all TODOs, even if they have a deadline" nil)
  725. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  726. (defcustom org-agenda-todo-ignore-time-comparison-use-seconds nil
  727. "Time unit to use when possibly ignoring an agenda item.
  728. See the docstring of various `org-agenda-todo-ignore-*' options.
  729. The default is to compare time stamps using days. An item is thus
  730. considered to be in the future if it is at least one day after today.
  731. Non-nil means to compare time stamps using seconds. An item is then
  732. considered future if it has a time value later than current time."
  733. :group 'org-agenda-skip
  734. :group 'org-agenda-todo-list
  735. :version "24.4"
  736. :package-version '(Org . "8.0")
  737. :type '(choice
  738. (const :tag "Compare time with days" nil)
  739. (const :tag "Compare time with seconds" t)))
  740. (defcustom org-agenda-tags-todo-honor-ignore-options nil
  741. "Non-nil means honor todo-list ignores options also in tags-todo search.
  742. The variables
  743. `org-agenda-todo-ignore-with-date',
  744. `org-agenda-todo-ignore-timestamp',
  745. `org-agenda-todo-ignore-scheduled',
  746. `org-agenda-todo-ignore-deadlines'
  747. make the global TODO list skip entries that have time stamps of certain
  748. kinds. If this option is set, the same options will also apply for the
  749. tags-todo search, which is the general tags/property matcher
  750. restricted to unfinished TODO entries only."
  751. :group 'org-agenda-skip
  752. :group 'org-agenda-todo-list
  753. :group 'org-agenda-match-view
  754. :type 'boolean)
  755. (defcustom org-agenda-skip-scheduled-if-done nil
  756. "Non-nil means don't show scheduled items in agenda when they are done.
  757. This is relevant for the daily/weekly agenda, not for the TODO list. It
  758. applies only to the actual date of the scheduling. Warnings about an item
  759. with a past scheduling dates are always turned off when the item is DONE."
  760. :group 'org-agenda-skip
  761. :group 'org-agenda-daily/weekly
  762. :type 'boolean)
  763. (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
  764. "Non-nil means skip scheduling line if same entry shows because of deadline.
  765. In the agenda of today, an entry can show up multiple times
  766. because it is both scheduled and has a nearby deadline, and maybe
  767. a plain time stamp as well.
  768. When this variable is nil, the entry will be shown several times.
  769. When set to t, then only the deadline is shown and the fact that
  770. the entry is scheduled today or was scheduled previously is not
  771. shown.
  772. When set to the symbol `not-today', skip scheduled previously,
  773. but not scheduled today.
  774. When set to the symbol `repeated-after-deadline', skip scheduled
  775. items if they are repeated beyond the current deadline."
  776. :group 'org-agenda-skip
  777. :group 'org-agenda-daily/weekly
  778. :type '(choice
  779. (const :tag "Never" nil)
  780. (const :tag "Always" t)
  781. (const :tag "Not when scheduled today" not-today)
  782. (const :tag "When repeated past deadline" repeated-after-deadline)))
  783. (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
  784. "Non-nil means skip timestamp line if same entry shows because of deadline.
  785. In the agenda of today, an entry can show up multiple times
  786. because it has both a plain timestamp and has a nearby deadline.
  787. When this variable is t, then only the deadline is shown and the
  788. fact that the entry has a timestamp for or including today is not
  789. shown. When this variable is nil, the entry will be shown
  790. several times."
  791. :group 'org-agenda-skip
  792. :group 'org-agenda-daily/weekly
  793. :version "24.1"
  794. :type '(choice
  795. (const :tag "Never" nil)
  796. (const :tag "Always" t)))
  797. (defcustom org-agenda-skip-deadline-if-done nil
  798. "Non-nil means don't show deadlines when the corresponding item is done.
  799. When nil, the deadline is still shown and should give you a happy feeling.
  800. This is relevant for the daily/weekly agenda. It applies only to the
  801. actual date of the deadline. Warnings about approaching and past-due
  802. deadlines are always turned off when the item is DONE."
  803. :group 'org-agenda-skip
  804. :group 'org-agenda-daily/weekly
  805. :type 'boolean)
  806. (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
  807. "Non-nil means skip deadline prewarning when entry is also scheduled.
  808. This will apply on all days where a prewarning for the deadline would
  809. be shown, but not at the day when the entry is actually due. On that day,
  810. the deadline will be shown anyway.
  811. This variable may be set to nil, t, the symbol `pre-scheduled',
  812. or a number which will then give the number of days before the actual
  813. deadline when the prewarnings should resume. The symbol `pre-scheduled'
  814. eliminates the deadline prewarning only prior to the scheduled date.
  815. This can be used in a workflow where the first showing of the deadline will
  816. trigger you to schedule it, and then you don't want to be reminded of it
  817. because you will take care of it on the day when scheduled."
  818. :group 'org-agenda-skip
  819. :group 'org-agenda-daily/weekly
  820. :version "24.1"
  821. :type '(choice
  822. (const :tag "Always show prewarning" nil)
  823. (const :tag "Remove prewarning prior to scheduled date" pre-scheduled)
  824. (const :tag "Remove prewarning if entry is scheduled" t)
  825. (integer :tag "Restart prewarning N days before deadline")))
  826. (defcustom org-agenda-skip-scheduled-delay-if-deadline nil
  827. "Non-nil means skip scheduled delay when entry also has a deadline.
  828. This variable may be set to nil, t, the symbol `post-deadline',
  829. or a number which will then give the number of days after the actual
  830. scheduled date when the delay should expire. The symbol `post-deadline'
  831. eliminates the schedule delay when the date is posterior to the deadline."
  832. :group 'org-agenda-skip
  833. :group 'org-agenda-daily/weekly
  834. :version "24.4"
  835. :package-version '(Org . "8.0")
  836. :type '(choice
  837. (const :tag "Always honor delay" nil)
  838. (const :tag "Ignore delay if posterior to the deadline" post-deadline)
  839. (const :tag "Ignore delay if entry has a deadline" t)
  840. (integer :tag "Honor delay up until N days after the scheduled date")))
  841. (defcustom org-agenda-skip-additional-timestamps-same-entry nil
  842. "When nil, multiple same-day timestamps in entry make multiple agenda lines.
  843. When non-nil, after the search for timestamps has matched once in an
  844. entry, the rest of the entry will not be searched."
  845. :group 'org-agenda-skip
  846. :type 'boolean)
  847. (defcustom org-agenda-skip-timestamp-if-done nil
  848. "Non-nil means don't select item by timestamp or -range if it is DONE."
  849. :group 'org-agenda-skip
  850. :group 'org-agenda-daily/weekly
  851. :type 'boolean)
  852. (defcustom org-agenda-dim-blocked-tasks t
  853. "Non-nil means dim blocked tasks in the agenda display.
  854. This causes some overhead during agenda construction, but if you
  855. have turned on `org-enforce-todo-dependencies',
  856. `org-enforce-todo-checkbox-dependencies', or any other blocking
  857. mechanism, this will create useful feedback in the agenda.
  858. Instead of t, this variable can also have the value `invisible'.
  859. Then blocked tasks will be invisible and only become visible when
  860. they become unblocked. An exemption to this behavior is when a task is
  861. blocked because of unchecked checkboxes below it. Since checkboxes do
  862. not show up in the agenda views, making this task invisible you remove any
  863. trace from agenda views that there is something to do. Therefore, a task
  864. that is blocked because of checkboxes will never be made invisible, it
  865. will only be dimmed."
  866. :group 'org-agenda-daily/weekly
  867. :group 'org-agenda-todo-list
  868. :version "24.3"
  869. :type '(choice
  870. (const :tag "Do not dim" nil)
  871. (const :tag "Dim to a gray face" t)
  872. (const :tag "Make invisible" invisible)))
  873. (defgroup org-agenda-startup nil
  874. "Options concerning initial settings in the Agenda in Org Mode."
  875. :tag "Org Agenda Startup"
  876. :group 'org-agenda)
  877. (defcustom org-agenda-menu-show-matcher t
  878. "Non-nil means show the match string in the agenda dispatcher menu.
  879. When nil, the matcher string is not shown, but is put into the help-echo
  880. property so than moving the mouse over the command shows it.
  881. Setting it to nil is good if matcher strings are very long and/or if
  882. you want to use two-columns display (see `org-agenda-menu-two-columns')."
  883. :group 'org-agenda
  884. :version "24.1"
  885. :type 'boolean)
  886. (defcustom org-agenda-menu-two-columns nil
  887. "Non-nil means, use two columns to show custom commands in the dispatcher.
  888. If you use this, you probably want to set `org-agenda-menu-show-matcher'
  889. to nil."
  890. :group 'org-agenda
  891. :version "24.1"
  892. :type 'boolean)
  893. (defcustom org-agenda-finalize-hook nil
  894. "Hook run just before displaying an agenda buffer.
  895. The buffer is still writable when the hook is called.
  896. You can modify some of the buffer substrings but you should be
  897. extra careful not to modify the text properties of the agenda
  898. headlines as the agenda display heavily relies on them."
  899. :group 'org-agenda-startup
  900. :type 'hook)
  901. (defcustom org-agenda-filter-hook nil
  902. "Hook run just after filtering with `org-agenda-filter'."
  903. :group 'org-agenda-startup
  904. :package-version '(Org . "9.4")
  905. :type 'hook)
  906. (defcustom org-agenda-mouse-1-follows-link nil
  907. "Non-nil means mouse-1 on a link will follow the link in the agenda.
  908. A longer mouse click will still set point. Needs to be set
  909. before org.el is loaded."
  910. :group 'org-agenda-startup
  911. :type 'boolean)
  912. (defcustom org-agenda-start-with-follow-mode nil
  913. "The initial value of follow mode in a newly created agenda window."
  914. :group 'org-agenda-startup
  915. :type 'boolean)
  916. (defcustom org-agenda-follow-indirect nil
  917. "Non-nil means `org-agenda-follow-mode' displays only the
  918. current item's tree, in an indirect buffer."
  919. :group 'org-agenda
  920. :version "24.1"
  921. :type 'boolean)
  922. (defcustom org-agenda-show-outline-path t
  923. "Non-nil means show outline path in echo area after line motion."
  924. :group 'org-agenda-startup
  925. :type 'boolean)
  926. (defcustom org-agenda-start-with-entry-text-mode nil
  927. "The initial value of entry-text-mode in a newly created agenda window."
  928. :group 'org-agenda-startup
  929. :type 'boolean)
  930. (defcustom org-agenda-entry-text-maxlines 5
  931. "Number of text lines to be added when `E' is pressed in the agenda.
  932. Note that this variable only used during agenda display. To add entry text
  933. when exporting the agenda, configure the variable
  934. `org-agenda-add-entry-text-maxlines'."
  935. :group 'org-agenda
  936. :type 'integer)
  937. (defcustom org-agenda-entry-text-exclude-regexps nil
  938. "List of regular expressions to clean up entry text.
  939. The complete matches of all regular expressions in this list will be
  940. removed from entry text before it is shown in the agenda."
  941. :group 'org-agenda
  942. :type '(repeat (regexp)))
  943. (defcustom org-agenda-entry-text-leaders " > "
  944. "Text prepended to the entry text in agenda buffers."
  945. :version "24.4"
  946. :package-version '(Org . "8.0")
  947. :group 'org-agenda
  948. :type 'string)
  949. (defvar org-agenda-entry-text-cleanup-hook nil
  950. "Hook that is run after basic cleanup of entry text to be shown in agenda.
  951. This cleanup is done in a temporary buffer, so the function may inspect and
  952. change the entire buffer.
  953. Some default stuff like drawers and scheduling/deadline dates will already
  954. have been removed when this is called, as will any matches for regular
  955. expressions listed in `org-agenda-entry-text-exclude-regexps'.")
  956. (defvar org-agenda-include-inactive-timestamps nil
  957. "Non-nil means include inactive time stamps in agenda.
  958. Dynamically scoped.")
  959. (defgroup org-agenda-windows nil
  960. "Options concerning the windows used by the Agenda in Org Mode."
  961. :tag "Org Agenda Windows"
  962. :group 'org-agenda)
  963. (defcustom org-agenda-window-setup 'reorganize-frame
  964. "How the agenda buffer should be displayed.
  965. Possible values for this option are:
  966. current-window Show agenda in the current window, keeping all other windows.
  967. other-window Use `switch-to-buffer-other-window' to display agenda.
  968. only-window Show agenda, deleting all other windows.
  969. reorganize-frame Show only two windows on the current frame, the current
  970. window and the agenda.
  971. other-frame Use `switch-to-buffer-other-frame' to display agenda.
  972. Also, when exiting the agenda, kill that frame.
  973. other-tab Use `switch-to-buffer-other-tab' to display the
  974. agenda, making use of the `tab-bar-mode' introduced
  975. in Emacs version 27.1. Also, kill that tab when
  976. exiting the agenda view.
  977. See also the variable `org-agenda-restore-windows-after-quit'."
  978. :group 'org-agenda-windows
  979. :type '(choice
  980. (const current-window)
  981. (const other-frame)
  982. (const other-tab)
  983. (const other-window)
  984. (const only-window)
  985. (const reorganize-frame))
  986. :package-version '(Org . "9.4"))
  987. (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
  988. "The min and max height of the agenda window as a fraction of frame height.
  989. The value of the variable is a cons cell with two numbers between 0 and 1.
  990. It only matters if `org-agenda-window-setup' is `reorganize-frame'."
  991. :group 'org-agenda-windows
  992. :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
  993. (defcustom org-agenda-restore-windows-after-quit nil
  994. "Non-nil means restore window configuration upon exiting agenda.
  995. Before the window configuration is changed for displaying the
  996. agenda, the current status is recorded. When the agenda is
  997. exited with `q' or `x' and this option is set, the old state is
  998. restored. If `org-agenda-window-setup' is `other-frame' or
  999. `other-tab', the value of this option will be ignored."
  1000. :group 'org-agenda-windows
  1001. :type 'boolean)
  1002. (defcustom org-agenda-span 'week
  1003. "Number of days to include in overview display.
  1004. Can be day, week, month, year, or any number of days.
  1005. Custom commands can set this variable in the options section."
  1006. :group 'org-agenda-daily/weekly
  1007. :type '(choice (const :tag "Day" day)
  1008. (const :tag "Week" week)
  1009. (const :tag "Fortnight" fortnight)
  1010. (const :tag "Month" month)
  1011. (const :tag "Year" year)
  1012. (integer :tag "Custom")))
  1013. (defcustom org-agenda-start-on-weekday 1
  1014. "Non-nil means start the overview always on the specified weekday.
  1015. 0 denotes Sunday, 1 denotes Monday, etc.
  1016. When nil, always start on the current day.
  1017. Custom commands can set this variable in the options section."
  1018. :group 'org-agenda-daily/weekly
  1019. :type '(choice (const :tag "Today" nil)
  1020. (integer :tag "Weekday No.")))
  1021. (defcustom org-agenda-show-all-dates t
  1022. "Non-nil means `org-agenda' shows every day in the selected range.
  1023. When nil, only the days which actually have entries are shown."
  1024. :group 'org-agenda-daily/weekly
  1025. :type 'boolean)
  1026. (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
  1027. "Format string for displaying dates in the agenda.
  1028. Used by the daily/weekly agenda. This should be a format string
  1029. understood by `format-time-string', or a function returning the
  1030. formatted date as a string. The function must take a single
  1031. argument, a calendar-style date list like (month day year)."
  1032. :group 'org-agenda-daily/weekly
  1033. :type '(choice
  1034. (string :tag "Format string")
  1035. (function :tag "Function")))
  1036. (defun org-agenda-end-of-line ()
  1037. "Go to the end of visible line."
  1038. (interactive)
  1039. (goto-char (line-end-position)))
  1040. (defun org-agenda-format-date-aligned (date)
  1041. "Format a DATE string for display in the daily/weekly agenda.
  1042. This function makes sure that dates are aligned for easy reading."
  1043. (require 'cal-iso)
  1044. (let* ((dayname (calendar-day-name date))
  1045. (day (cadr date))
  1046. (day-of-week (calendar-day-of-week date))
  1047. (month (car date))
  1048. (monthname (calendar-month-name month))
  1049. (year (nth 2 date))
  1050. (iso-week (org-days-to-iso-week
  1051. (calendar-absolute-from-gregorian date)))
  1052. ;; (weekyear (cond ((and (= month 1) (>= iso-week 52))
  1053. ;; (1- year))
  1054. ;; ((and (= month 12) (<= iso-week 1))
  1055. ;; (1+ year))
  1056. ;; (t year)))
  1057. (weekstring (if (= day-of-week 1)
  1058. (format " W%02d" iso-week)
  1059. "")))
  1060. (format "%-10s %2d %s %4d%s"
  1061. dayname day monthname year weekstring)))
  1062. (defcustom org-agenda-time-leading-zero nil
  1063. "Non-nil means use leading zero for military times in agenda.
  1064. For example, 9:30am would become 09:30 rather than 9:30."
  1065. :group 'org-agenda-daily/weekly
  1066. :version "24.1"
  1067. :type 'boolean)
  1068. (defcustom org-agenda-timegrid-use-ampm nil
  1069. "When set, show AM/PM style timestamps on the timegrid."
  1070. :group 'org-agenda
  1071. :version "24.1"
  1072. :type 'boolean)
  1073. (defun org-agenda-time-of-day-to-ampm (time)
  1074. "Convert TIME of a string like \"13:45\" to an AM/PM style time string."
  1075. (let* ((hour-number (string-to-number (substring time 0 -3)))
  1076. (minute (substring time -2))
  1077. (ampm "am"))
  1078. (cond
  1079. ((equal hour-number 12)
  1080. (setq ampm "pm"))
  1081. ((> hour-number 12)
  1082. (setq ampm "pm")
  1083. (setq hour-number (- hour-number 12))))
  1084. (concat
  1085. (if org-agenda-time-leading-zero
  1086. (format "%02d" hour-number)
  1087. (format "%02s" (number-to-string hour-number)))
  1088. ":" minute ampm)))
  1089. (defun org-agenda-time-of-day-to-ampm-maybe (time)
  1090. "Conditionally convert TIME to AM/PM format.
  1091. This is based on `org-agenda-timegrid-use-ampm'."
  1092. (if org-agenda-timegrid-use-ampm
  1093. (org-agenda-time-of-day-to-ampm time)
  1094. time))
  1095. (defcustom org-agenda-weekend-days '(6 0)
  1096. "Which days are weekend?
  1097. These days get the special face `org-agenda-date-weekend' in the agenda."
  1098. :group 'org-agenda-daily/weekly
  1099. :type '(set :greedy t
  1100. (const :tag "Monday" 1)
  1101. (const :tag "Tuesday" 2)
  1102. (const :tag "Wednesday" 3)
  1103. (const :tag "Thursday" 4)
  1104. (const :tag "Friday" 5)
  1105. (const :tag "Saturday" 6)
  1106. (const :tag "Sunday" 0)))
  1107. (defcustom org-agenda-move-date-from-past-immediately-to-today t
  1108. "Non-nil means jump to today when moving a past date forward in time.
  1109. When using S-right in the agenda to move a date forward, and the date
  1110. stamp currently points to the past, the first key press will move it
  1111. to today. When nil, just move one day forward even if the date stays
  1112. in the past."
  1113. :group 'org-agenda-daily/weekly
  1114. :version "24.1"
  1115. :type 'boolean)
  1116. (defcustom org-agenda-diary-file 'diary-file
  1117. "File to which to add new entries with the `i' key in agenda and calendar.
  1118. When this is the symbol `diary-file', the functionality in the Emacs
  1119. calendar will be used to add entries to the `diary-file'. But when this
  1120. points to a file, `org-agenda-diary-entry' will be used instead."
  1121. :group 'org-agenda
  1122. :type '(choice
  1123. (const :tag "The standard Emacs diary file" diary-file)
  1124. (file :tag "Special Org file diary entries")))
  1125. (defcustom org-agenda-include-diary nil
  1126. "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
  1127. Custom commands can set this variable in the options section."
  1128. :group 'org-agenda-daily/weekly
  1129. :type 'boolean)
  1130. (defcustom org-agenda-include-deadlines t
  1131. "If non-nil, include entries within their deadline warning period.
  1132. Custom commands can set this variable in the options section."
  1133. :group 'org-agenda-daily/weekly
  1134. :version "24.1"
  1135. :type 'boolean)
  1136. (defcustom org-agenda-show-future-repeats t
  1137. "Non-nil shows repeated entries in the future part of the agenda.
  1138. When set to the symbol `next' only the first future repeat is shown."
  1139. :group 'org-agenda-daily/weekly
  1140. :type '(choice
  1141. (const :tag "Show all repeated entries" t)
  1142. (const :tag "Show next repeated entry" next)
  1143. (const :tag "Do not show repeated entries" nil))
  1144. :version "26.1"
  1145. :package-version '(Org . "9.1")
  1146. :safe #'symbolp)
  1147. (defcustom org-agenda-prefer-last-repeat nil
  1148. "Non-nil sets date for repeated entries to their last repeat.
  1149. When nil, display SCHEDULED and DEADLINE dates at their base
  1150. date, and in today's agenda, as a reminder. Display plain
  1151. time-stamps, on the other hand, at every repeat date in the past
  1152. in addition to the base date.
  1153. When non-nil, show a repeated entry at its latest repeat date,
  1154. possibly being today even if it wasn't marked as done. This
  1155. setting is useful if you do not always mark repeated entries as
  1156. done and, yet, consider that reaching repeat date starts the task
  1157. anew.
  1158. When set to a list of strings, prefer last repeats only for
  1159. entries with these TODO keywords."
  1160. :group 'org-agenda-daily/weekly
  1161. :type '(choice
  1162. (const :tag "Prefer last repeat" t)
  1163. (const :tag "Prefer base date" nil)
  1164. (repeat :tag "Prefer last repeat for entries with these TODO keywords"
  1165. (string :tag "TODO keyword")))
  1166. :version "26.1"
  1167. :package-version '(Org . "9.1")
  1168. :safe (lambda (x) (or (booleanp x) (consp x))))
  1169. (defcustom org-scheduled-past-days 10000
  1170. "Number of days to continue listing scheduled items not marked DONE.
  1171. When an item is scheduled on a date, it shows up in the agenda on
  1172. this day and will be listed until it is marked done or for the
  1173. number of days given here."
  1174. :group 'org-agenda-daily/weekly
  1175. :type 'integer
  1176. :safe 'integerp)
  1177. (defcustom org-deadline-past-days 10000
  1178. "Number of days to warn about missed deadlines.
  1179. When an item has deadline on a date, it shows up in the agenda on
  1180. this day and will appear as a reminder until it is marked DONE or
  1181. for the number of days given here."
  1182. :group 'org-agenda-daily/weekly
  1183. :type 'integer
  1184. :version "26.1"
  1185. :package-version '(Org . "9.1")
  1186. :safe 'integerp)
  1187. (defcustom org-agenda-log-mode-items '(closed clock)
  1188. "List of items that should be shown in agenda log mode.
  1189. \\<org-agenda-mode-map>\
  1190. This list may contain the following symbols:
  1191. closed Show entries that have been closed on that day.
  1192. clock Show entries that have received clocked time on that day.
  1193. state Show all logged state changes.
  1194. Note that instead of changing this variable, you can also press \
  1195. `\\[universal-argument] \\[org-agenda-log-mode]' in
  1196. the agenda to display all available LOG items temporarily."
  1197. :group 'org-agenda-daily/weekly
  1198. :type '(set :greedy t (const closed) (const clock) (const state)))
  1199. (defcustom org-agenda-clock-consistency-checks
  1200. '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
  1201. :gap-ok-around ("4:00")
  1202. :default-face ((:background "DarkRed") (:foreground "white"))
  1203. :overlap-face nil :gap-face nil :no-end-time-face nil
  1204. :long-face nil :short-face nil)
  1205. "This is a property list, with the following keys:
  1206. :max-duration Mark clocking chunks that are longer than this time.
  1207. This is a time string like \"HH:MM\", or the number
  1208. of minutes as an integer.
  1209. :min-duration Mark clocking chunks that are shorter that this.
  1210. This is a time string like \"HH:MM\", or the number
  1211. of minutes as an integer.
  1212. :max-gap Mark gaps between clocking chunks that are longer than
  1213. this duration. A number of minutes, or a string
  1214. like \"HH:MM\".
  1215. :gap-ok-around List of times during the day which are usually not working
  1216. times. When a gap is detected, but the gap contains any
  1217. of these times, the gap is *not* reported. For example,
  1218. if this is (\"4:00\" \"13:00\") then gaps that contain
  1219. 4:00 in the morning (i.e. the night) and 13:00
  1220. (i.e. a typical lunch time) do not cause a warning.
  1221. You should have at least one time during the night in this
  1222. list, or otherwise the first task each morning will trigger
  1223. a warning because it follows a long gap.
  1224. Furthermore, the following properties can be used to define faces for
  1225. issue display.
  1226. :default-face the default face, if the specific face is undefined
  1227. :overlap-face face for overlapping clocks
  1228. :gap-face face for gaps between clocks
  1229. :no-end-time-face face for incomplete clocks
  1230. :long-face face for clock intervals that are too long
  1231. :short-face face for clock intervals that are too short"
  1232. :group 'org-agenda-daily/weekly
  1233. :group 'org-clock
  1234. :version "24.1"
  1235. :type 'plist)
  1236. (defcustom org-agenda-log-mode-add-notes t
  1237. "Non-nil means add first line of notes to log entries in agenda views.
  1238. If a log item like a state change or a clock entry is associated with
  1239. notes, the first line of these notes will be added to the entry in the
  1240. agenda display."
  1241. :group 'org-agenda-daily/weekly
  1242. :type 'boolean)
  1243. (defcustom org-agenda-start-with-log-mode nil
  1244. "The initial value of log-mode in a newly created agenda window.
  1245. See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
  1246. explanations on the possible values."
  1247. :group 'org-agenda-startup
  1248. :group 'org-agenda-daily/weekly
  1249. :type '(choice (const :tag "Don't show log items" nil)
  1250. (const :tag "Show only log items" only)
  1251. (const :tag "Show all possible log items" clockcheck)
  1252. (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
  1253. (choice (const :tag "Show closed log items" closed)
  1254. (const :tag "Show clocked log items" clock)
  1255. (const :tag "Show all logged state changes" state)))))
  1256. (defcustom org-agenda-start-with-clockreport-mode nil
  1257. "The initial value of clockreport-mode in a newly created agenda window."
  1258. :group 'org-agenda-startup
  1259. :group 'org-agenda-daily/weekly
  1260. :type 'boolean)
  1261. (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
  1262. "Property list with parameters for the clocktable in clockreport mode.
  1263. This is the display mode that shows a clock table in the daily/weekly
  1264. agenda, the properties for this dynamic block can be set here.
  1265. The usual clocktable parameters are allowed here, but you cannot set
  1266. the properties :name, :tstart, :tend, :block, and :scope - these will
  1267. be overwritten to make sure the content accurately reflects the
  1268. current display in the agenda."
  1269. :group 'org-agenda-daily/weekly
  1270. :type 'plist)
  1271. (defvaralias 'org-agenda-search-view-search-words-only
  1272. 'org-agenda-search-view-always-boolean)
  1273. (defcustom org-agenda-search-view-always-boolean nil
  1274. "Non-nil means the search string is interpreted as individual parts.
  1275. The search string for search view can either be interpreted as a phrase,
  1276. or as a list of snippets that define a boolean search for a number of
  1277. strings.
  1278. When this is non-nil, the string will be split on whitespace, and each
  1279. snippet will be searched individually, and all must match in order to
  1280. select an entry. A snippet is then a single string of non-white
  1281. characters, or a string in double quotes, or a regexp in {} braces.
  1282. If a snippet is preceded by \"-\", the snippet must *not* match.
  1283. \"+\" is syntactic sugar for positive selection. Each snippet may
  1284. be found as a full word or a partial word, but see the variable
  1285. `org-agenda-search-view-force-full-words'.
  1286. When this is nil, search will look for the entire search phrase as one,
  1287. with each space character matching any amount of whitespace, including
  1288. line breaks.
  1289. Even when this is nil, you can still switch to Boolean search dynamically
  1290. by preceding the first snippet with \"+\" or \"-\". If the first snippet
  1291. is a regexp marked with braces like \"{abc}\", this will also switch to
  1292. boolean search."
  1293. :group 'org-agenda-search-view
  1294. :version "24.1"
  1295. :type 'boolean)
  1296. (defcustom org-agenda-search-view-force-full-words nil
  1297. "Non-nil means, search words must be matches as complete words.
  1298. When nil, they may also match part of a word."
  1299. :group 'org-agenda-search-view
  1300. :version "24.1"
  1301. :type 'boolean)
  1302. (defcustom org-agenda-search-view-max-outline-level 0
  1303. "Maximum outline level to display in search view.
  1304. E.g. when this is set to 1, the search view will only
  1305. show headlines of level 1. When set to 0, the default
  1306. value, don't limit agenda view by outline level."
  1307. :group 'org-agenda-search-view
  1308. :version "26.1"
  1309. :package-version '(Org . "8.3")
  1310. :type 'integer)
  1311. (defgroup org-agenda-time-grid nil
  1312. "Options concerning the time grid in the Org Agenda."
  1313. :tag "Org Agenda Time Grid"
  1314. :group 'org-agenda)
  1315. (defcustom org-agenda-search-headline-for-time t
  1316. "Non-nil means search headline for a time-of-day.
  1317. If the headline contains a time-of-day in one format or another, it will
  1318. be used to sort the entry into the time sequence of items for a day.
  1319. Some people have time stamps in the headline that refer to the creation
  1320. time or so, and then this produces an unwanted side effect. If this is
  1321. the case for your, use this variable to turn off searching the headline
  1322. for a time."
  1323. :group 'org-agenda-time-grid
  1324. :type 'boolean)
  1325. (defcustom org-agenda-use-time-grid t
  1326. "Non-nil means show a time grid in the agenda schedule.
  1327. A time grid is a set of lines for specific times (like every two hours between
  1328. 8:00 and 20:00). The items scheduled for a day at specific times are
  1329. sorted in between these lines.
  1330. For details about when the grid will be shown, and what it will look like, see
  1331. the variable `org-agenda-time-grid'."
  1332. :group 'org-agenda-time-grid
  1333. :type 'boolean)
  1334. (defcustom org-agenda-time-grid
  1335. '((daily today require-timed)
  1336. (800 1000 1200 1400 1600 1800 2000)
  1337. "......"
  1338. "----------------")
  1339. "The settings for time grid for agenda display.
  1340. This is a list of four items. The first item is again a list. It contains
  1341. symbols specifying conditions when the grid should be displayed:
  1342. daily if the agenda shows a single day
  1343. weekly if the agenda shows an entire week
  1344. today show grid on current date, independent of daily/weekly display
  1345. require-timed show grid only if at least one item has a time specification
  1346. remove-match skip grid times already present in an entry
  1347. The second item is a list of integers, indicating the times that
  1348. should have a grid line.
  1349. The third item is a string which will be placed right after the
  1350. times that have a grid line.
  1351. The fourth item is a string placed after the grid times. This
  1352. will align with agenda items."
  1353. :group 'org-agenda-time-grid
  1354. :type
  1355. '(list
  1356. (set :greedy t :tag "Grid Display Options"
  1357. (const :tag "Show grid in single day agenda display" daily)
  1358. (const :tag "Show grid in weekly agenda display" weekly)
  1359. (const :tag "Always show grid for today" today)
  1360. (const :tag "Show grid only if any timed entries are present"
  1361. require-timed)
  1362. (const :tag "Skip grid times already present in an entry"
  1363. remove-match))
  1364. (repeat :tag "Grid Times" (integer :tag "Time"))
  1365. (string :tag "Grid String (after agenda times)")
  1366. (string :tag "Grid String (aligns with agenda items)")))
  1367. (defcustom org-agenda-show-current-time-in-grid t
  1368. "Non-nil means show the current time in the time grid."
  1369. :group 'org-agenda-time-grid
  1370. :version "24.1"
  1371. :type 'boolean)
  1372. (defcustom org-agenda-current-time-string
  1373. "now - - - - - - - - - - - - - - - - - - - - - - - - -"
  1374. "The string for the current time marker in the agenda."
  1375. :group 'org-agenda-time-grid
  1376. :version "24.1"
  1377. :type 'string)
  1378. (defgroup org-agenda-sorting nil
  1379. "Options concerning sorting in the Org Agenda."
  1380. :tag "Org Agenda Sorting"
  1381. :group 'org-agenda)
  1382. (defcustom org-agenda-sorting-strategy
  1383. '((agenda habit-down time-up priority-down category-keep)
  1384. (todo priority-down category-keep)
  1385. (tags priority-down category-keep)
  1386. (search category-keep))
  1387. "Sorting structure for the agenda items of a single day.
  1388. This is a list of symbols which will be used in sequence to determine
  1389. if an entry should be listed before another entry. The following
  1390. symbols are recognized:
  1391. time-up Put entries with time-of-day indications first, early first.
  1392. time-down Put entries with time-of-day indications first, late first.
  1393. timestamp-up Sort by any timestamp, early first.
  1394. timestamp-down Sort by any timestamp, late first.
  1395. scheduled-up Sort by scheduled timestamp, early first.
  1396. scheduled-down Sort by scheduled timestamp, late first.
  1397. deadline-up Sort by deadline timestamp, early first.
  1398. deadline-down Sort by deadline timestamp, late first.
  1399. ts-up Sort by active timestamp, early first.
  1400. ts-down Sort by active timestamp, late first.
  1401. tsia-up Sort by inactive timestamp, early first.
  1402. tsia-down Sort by inactive timestamp, late first.
  1403. category-keep Keep the default order of categories, corresponding to the
  1404. sequence in `org-agenda-files'.
  1405. category-up Sort alphabetically by category, A-Z.
  1406. category-down Sort alphabetically by category, Z-A.
  1407. tag-up Sort alphabetically by last tag, A-Z.
  1408. tag-down Sort alphabetically by last tag, Z-A.
  1409. priority-up Sort numerically by priority, high priority last.
  1410. priority-down Sort numerically by priority, high priority first.
  1411. todo-state-up Sort by todo state, tasks that are done last.
  1412. todo-state-down Sort by todo state, tasks that are done first.
  1413. effort-up Sort numerically by estimated effort, high effort last.
  1414. effort-down Sort numerically by estimated effort, high effort first.
  1415. user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
  1416. user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
  1417. habit-up Put entries that are habits first.
  1418. habit-down Put entries that are habits last.
  1419. alpha-up Sort headlines alphabetically.
  1420. alpha-down Sort headlines alphabetically, reversed.
  1421. The different possibilities will be tried in sequence, and testing stops
  1422. if one comparison returns a \"not-equal\". For example, the default
  1423. '(time-up category-keep priority-down)
  1424. means: Pull out all entries having a specified time of day and sort them,
  1425. in order to make a time schedule for the current day the first thing in the
  1426. agenda listing for the day. Of the entries without a time indication, keep
  1427. the grouped in categories, don't sort the categories, but keep them in
  1428. the sequence given in `org-agenda-files'. Within each category sort by
  1429. priority.
  1430. Leaving out `category-keep' would mean that items will be sorted across
  1431. categories by priority.
  1432. Instead of a single list, this can also be a set of list for specific
  1433. contents, with a context symbol in the car of the list, any of
  1434. `agenda', `todo', `tags', `search' for the corresponding agenda views.
  1435. Custom commands can bind this variable in the options section."
  1436. :group 'org-agenda-sorting
  1437. :type `(choice
  1438. (repeat :tag "General" ,org-sorting-choice)
  1439. (list :tag "Individually"
  1440. (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
  1441. (repeat ,org-sorting-choice))
  1442. (cons (const :tag "Strategy for TODO lists" todo)
  1443. (repeat ,org-sorting-choice))
  1444. (cons (const :tag "Strategy for Tags matches" tags)
  1445. (repeat ,org-sorting-choice))
  1446. (cons (const :tag "Strategy for search matches" search)
  1447. (repeat ,org-sorting-choice)))))
  1448. (defcustom org-agenda-cmp-user-defined nil
  1449. "A function to define the comparison `user-defined'.
  1450. This function must receive two arguments, agenda entry a and b.
  1451. If a>b, return +1. If a<b, return -1. If they are equal as seen by
  1452. the user comparison, return nil.
  1453. When this is defined, you can make `user-defined-up' and `user-defined-down'
  1454. part of an agenda sorting strategy."
  1455. :group 'org-agenda-sorting
  1456. :type 'symbol)
  1457. (defcustom org-agenda-sort-notime-is-late t
  1458. "Non-nil means items without time are considered late.
  1459. This is only relevant for sorting. When t, items which have no explicit
  1460. time like 15:30 will be considered as 99:01, i.e. later than any items which
  1461. do have a time. When nil, the default time is before 0:00. You can use this
  1462. option to decide if the schedule for today should come before or after timeless
  1463. agenda entries."
  1464. :group 'org-agenda-sorting
  1465. :type 'boolean)
  1466. (defcustom org-agenda-sort-noeffort-is-high t
  1467. "Non-nil means items without effort estimate are sorted as high effort.
  1468. This also applies when filtering an agenda view with respect to the
  1469. < or > effort operator. Then, tasks with no effort defined will be treated
  1470. as tasks with high effort.
  1471. When nil, such items are sorted as 0 minutes effort."
  1472. :group 'org-agenda-sorting
  1473. :type 'boolean)
  1474. (defgroup org-agenda-line-format nil
  1475. "Options concerning the entry prefix in the Org agenda display."
  1476. :tag "Org Agenda Line Format"
  1477. :group 'org-agenda)
  1478. (defcustom org-agenda-prefix-format
  1479. '((agenda . " %i %-12:c%?-12t% s")
  1480. (todo . " %i %-12:c")
  1481. (tags . " %i %-12:c")
  1482. (search . " %i %-12:c"))
  1483. "Format specifications for the prefix of items in the agenda views.
  1484. An alist with one entry per agenda type. The keys of the
  1485. sublists are `agenda', `todo', `search' and `tags'. The values
  1486. are format strings.
  1487. This format works similar to a printf format, with the following meaning:
  1488. %c the category of the item, \"Diary\" for entries from the diary,
  1489. or as given by the CATEGORY keyword or derived from the file name
  1490. %e the effort required by the item
  1491. %l the level of the item (insert X space(s) if item is of level X)
  1492. %i the icon category of the item, see `org-agenda-category-icon-alist'
  1493. %T the last tag of the item (ignore inherited tags, which come first)
  1494. %t the HH:MM time-of-day specification if one applies to the entry
  1495. %s Scheduling/Deadline information, a short string
  1496. %b show breadcrumbs, i.e., the names of the higher levels
  1497. %(expression) Eval EXPRESSION and replace the control string
  1498. by the result
  1499. All specifiers work basically like the standard `%s' of printf, but may
  1500. contain two additional characters: a question mark just after the `%'
  1501. and a whitespace/punctuation character just before the final letter.
  1502. If the first character after `%' is a question mark, the entire field
  1503. will only be included if the corresponding value applies to the current
  1504. entry. This is useful for fields which should have fixed width when
  1505. present, but zero width when absent. For example, \"%?-12t\" will
  1506. result in a 12 character time field if a time of the day is specified,
  1507. but will completely disappear in entries which do not contain a time.
  1508. If there is punctuation or whitespace character just before the
  1509. final format letter, this character will be appended to the field
  1510. value if the value is not empty. For example, the format
  1511. \"%-12:c\" leads to \"Diary: \" if the category is \"Diary\". If
  1512. the category is empty, no additional colon is inserted.
  1513. The default value for the agenda sublist is \" %-12:c%?-12t% s\",
  1514. which means:
  1515. - Indent the line with two space characters
  1516. - Give the category a 12 chars wide field, padded with whitespace on
  1517. the right (because of `-'). Append a colon if there is a category
  1518. (because of `:').
  1519. - If there is a time-of-day, put it into a 12 chars wide field. If no
  1520. time, don't put in an empty field, just skip it (because of '?').
  1521. - Finally, put the scheduling information.
  1522. See also the variables `org-agenda-remove-times-when-in-prefix' and
  1523. `org-agenda-remove-tags'.
  1524. Custom commands can set this variable in the options section."
  1525. :type '(choice
  1526. (string :tag "General format")
  1527. (list :greedy t :tag "View dependent"
  1528. (cons (const agenda) (string :tag "Format"))
  1529. (cons (const todo) (string :tag "Format"))
  1530. (cons (const tags) (string :tag "Format"))
  1531. (cons (const search) (string :tag "Format"))))
  1532. :group 'org-agenda-line-format
  1533. :version "26.1"
  1534. :package-version '(Org . "9.1"))
  1535. (defcustom org-agenda-breadcrumbs-separator "->"
  1536. "The separator of breadcrumbs in agenda lines."
  1537. :group 'org-agenda-line-format
  1538. :package-version '(Org . "9.3")
  1539. :type 'string
  1540. :safe #'stringp)
  1541. (defvar org-prefix-format-compiled nil
  1542. "The compiled prefix format and associated variables.
  1543. This is a list where first element is a list of variable bindings, and second
  1544. element is the compiled format expression. See the variable
  1545. `org-agenda-prefix-format'.")
  1546. (defcustom org-agenda-todo-keyword-format "%-1s"
  1547. "Format for the TODO keyword in agenda lines.
  1548. Set this to something like \"%-12s\" if you want all TODO keywords
  1549. to occupy a fixed space in the agenda display."
  1550. :group 'org-agenda-line-format
  1551. :type 'string)
  1552. (defcustom org-agenda-diary-sexp-prefix nil
  1553. "A regexp that matches part of a diary sexp entry
  1554. which should be treated as scheduling/deadline information in
  1555. `org-agenda'.
  1556. For example, you can use this to extract the `diary-remind-message' from
  1557. `diary-remind' entries."
  1558. :group 'org-agenda-line-format
  1559. :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
  1560. (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
  1561. "Text preceding timerange entries in the agenda view.
  1562. This is a list with two strings. The first applies when the range
  1563. is entirely on one day. The second applies if the range spans several days.
  1564. The strings may have two \"%d\" format specifiers which will be filled
  1565. with the sequence number of the days, and the total number of days in the
  1566. range, respectively."
  1567. :group 'org-agenda-line-format
  1568. :type '(list
  1569. (string :tag "Deadline today ")
  1570. (choice :tag "Deadline relative"
  1571. (string :tag "Format string")
  1572. (function))))
  1573. (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
  1574. "Text preceding scheduled items in the agenda view.
  1575. This is a list with two strings. The first applies when the item is
  1576. scheduled on the current day. The second applies when it has been scheduled
  1577. previously, it may contain a %d indicating that this is the nth time that
  1578. this item is scheduled, due to automatic rescheduling of unfinished items
  1579. for the following day. So this number is one larger than the number of days
  1580. that passed since this item was scheduled first."
  1581. :group 'org-agenda-line-format
  1582. :version "24.4"
  1583. :package-version '(Org . "8.0")
  1584. :type '(list
  1585. (string :tag "Scheduled today ")
  1586. (string :tag "Scheduled previously")))
  1587. (defcustom org-agenda-inactive-leader "["
  1588. "Text preceding item pulled into the agenda by inactive time stamps.
  1589. These entries are added to the agenda when pressing \"[\"."
  1590. :group 'org-agenda-line-format
  1591. :version "24.1"
  1592. :type 'string)
  1593. (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: " "%2d d. ago: ")
  1594. "Text preceding deadline items in the agenda view.
  1595. This is a list with three strings. The first applies when the item has its
  1596. deadline on the current day. The second applies when the deadline is in the
  1597. future, the third one when it is in the past. The strings may contain %d
  1598. to capture the number of days."
  1599. :group 'org-agenda-line-format
  1600. :version "24.4"
  1601. :package-version '(Org . "8.0")
  1602. :type '(list
  1603. (string :tag "Deadline today ")
  1604. (string :tag "Deadline in the future ")
  1605. (string :tag "Deadline in the past ")))
  1606. (defcustom org-agenda-remove-times-when-in-prefix t
  1607. "Non-nil means remove duplicate time specifications in agenda items.
  1608. When the format `org-agenda-prefix-format' contains a `%t' specifier, a
  1609. time-of-day specification in a headline or diary entry is extracted and
  1610. placed into the prefix. If this option is non-nil, the original specification
  1611. \(a timestamp or -range, or just a plain time(range) specification like
  1612. 11:30-4pm) will be removed for agenda display. This makes the agenda less
  1613. cluttered.
  1614. The option can be t or nil. It may also be the symbol `beg', indicating
  1615. that the time should only be removed when it is located at the beginning of
  1616. the headline/diary entry."
  1617. :group 'org-agenda-line-format
  1618. :type '(choice
  1619. (const :tag "Always" t)
  1620. (const :tag "Never" nil)
  1621. (const :tag "When at beginning of entry" beg)))
  1622. (defcustom org-agenda-remove-timeranges-from-blocks nil
  1623. "Non-nil means remove time ranges specifications in agenda
  1624. items that span on several days."
  1625. :group 'org-agenda-line-format
  1626. :version "24.1"
  1627. :type 'boolean)
  1628. (defcustom org-agenda-default-appointment-duration nil
  1629. "Default duration for appointments that only have a starting time.
  1630. When nil, no duration is specified in such cases.
  1631. When non-nil, this must be the number of minutes, e.g. 60 for one hour."
  1632. :group 'org-agenda-line-format
  1633. :type '(choice
  1634. (integer :tag "Minutes")
  1635. (const :tag "No default duration")))
  1636. (defcustom org-agenda-show-inherited-tags t
  1637. "Non-nil means show inherited tags in each agenda line.
  1638. When this option is set to `always', it takes precedence over
  1639. `org-agenda-use-tag-inheritance' and inherited tags are shown
  1640. in every agenda.
  1641. When this option is set to t (the default), inherited tags are
  1642. shown when they are available, i.e. when the value of
  1643. `org-agenda-use-tag-inheritance' enables tag inheritance for the
  1644. given agenda type.
  1645. This can be set to a list of agenda types in which the agenda
  1646. must display the inherited tags. Available types are `todo',
  1647. `agenda' and `search'.
  1648. When set to nil, never show inherited tags in agenda lines."
  1649. :group 'org-agenda-line-format
  1650. :group 'org-agenda
  1651. :version "24.3"
  1652. :type '(choice
  1653. (const :tag "Show inherited tags when available" t)
  1654. (const :tag "Always show inherited tags" always)
  1655. (repeat :tag "Show inherited tags only in selected agenda types"
  1656. (symbol :tag "Agenda type"))))
  1657. (defcustom org-agenda-use-tag-inheritance '(todo search agenda)
  1658. "List of agenda view types where to use tag inheritance.
  1659. In tags/tags-todo/tags-tree agenda views, tag inheritance is
  1660. controlled by `org-use-tag-inheritance'. In other agenda types,
  1661. `org-use-tag-inheritance' is not used for the selection of the
  1662. agenda entries. Still, you may want the agenda to be aware of
  1663. the inherited tags anyway, e.g. for later tag filtering.
  1664. Allowed value are `todo', `search' and `agenda'.
  1665. This variable has no effect if `org-agenda-show-inherited-tags'
  1666. is set to `always'. In that case, the agenda is aware of those
  1667. tags.
  1668. The default value sets tags in every agenda type. Setting this
  1669. option to nil will speed up non-tags agenda view a lot."
  1670. :group 'org-agenda
  1671. :version "26.1"
  1672. :package-version '(Org . "9.1")
  1673. :type '(choice
  1674. (const :tag "Use tag inheritance in all agenda types" t)
  1675. (repeat :tag "Use tag inheritance in selected agenda types"
  1676. (symbol :tag "Agenda type"))))
  1677. (defcustom org-agenda-hide-tags-regexp nil
  1678. "Regular expression used to filter away specific tags in agenda views.
  1679. This means that these tags will be present, but not be shown in the agenda
  1680. line. Secondary filtering will still work on the hidden tags.
  1681. Nil means don't hide any tags."
  1682. :group 'org-agenda-line-format
  1683. :type '(choice
  1684. (const :tag "Hide none" nil)
  1685. (regexp :tag "Regexp ")))
  1686. (defvaralias 'org-agenda-remove-tags-when-in-prefix
  1687. 'org-agenda-remove-tags)
  1688. (defcustom org-agenda-remove-tags nil
  1689. "Non-nil means remove the tags from the headline copy in the agenda.
  1690. When this is the symbol `prefix', only remove tags when
  1691. `org-agenda-prefix-format' contains a `%T' specifier."
  1692. :group 'org-agenda-line-format
  1693. :type '(choice
  1694. (const :tag "Always" t)
  1695. (const :tag "Never" nil)
  1696. (const :tag "When prefix format contains %T" prefix)))
  1697. (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column)
  1698. (defcustom org-agenda-tags-column 'auto
  1699. "Shift tags in agenda items to this column.
  1700. If set to `auto', tags will be automatically aligned to the right
  1701. edge of the window.
  1702. If set to a positive number, tags will be left-aligned to that
  1703. column. If set to a negative number, tags will be right-aligned
  1704. to that column. For example, -80 works well for a normal 80
  1705. character screen."
  1706. :group 'org-agenda-line-format
  1707. :type '(choice
  1708. (const :tag "Automatically align to right edge of window" auto)
  1709. (integer :tag "Specific column" -80))
  1710. :package-version '(Org . "9.1")
  1711. :version "26.1")
  1712. (defcustom org-agenda-fontify-priorities 'cookies
  1713. "Non-nil means highlight low and high priorities in agenda.
  1714. When t, the highest priority entries are bold, lowest priority italic.
  1715. However, settings in `org-priority-faces' will overrule these faces.
  1716. When this variable is the symbol `cookies', only fontify the
  1717. cookies, not the entire task.
  1718. This may also be an association list of priority faces, whose
  1719. keys are the character values of `org-priority-highest',
  1720. `org-priority-default', and `org-priority-lowest' (the default values
  1721. are ?A, ?B, and ?C, respectively). The face may be a named face, a
  1722. color as a string, or a list like `(:background \"Red\")'.
  1723. If it is a color, the variable `org-faces-easy-properties'
  1724. determines if it is a foreground or a background color."
  1725. :group 'org-agenda-line-format
  1726. :type '(choice
  1727. (const :tag "Never" nil)
  1728. (const :tag "Defaults" t)
  1729. (const :tag "Cookies only" cookies)
  1730. (repeat :tag "Specify"
  1731. (list (character :tag "Priority" :value ?A)
  1732. (choice :tag "Face "
  1733. (string :tag "Color")
  1734. (sexp :tag "Face"))))))
  1735. (defcustom org-agenda-day-face-function nil
  1736. "Function called to determine what face should be used to display a day.
  1737. The only argument passed to that function is the day. It should
  1738. returns a face, or nil if does not want to specify a face and let
  1739. the normal rules apply."
  1740. :group 'org-agenda-line-format
  1741. :version "24.1"
  1742. :type '(choice (const nil) (function)))
  1743. (defcustom org-agenda-category-icon-alist nil
  1744. "Alist of category icon to be displayed in agenda views.
  1745. Each entry should have the following format:
  1746. (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
  1747. Where CATEGORY-REGEXP is a regexp matching the categories where
  1748. the icon should be displayed.
  1749. FILE-OR-DATA either a file path or a string containing image data.
  1750. The other fields can be omitted safely if not needed:
  1751. TYPE indicates the image type.
  1752. DATA-P is a boolean indicating whether the FILE-OR-DATA string is
  1753. image data.
  1754. PROPS are additional image attributes to assign to the image,
  1755. like, e.g. `:ascent center'.
  1756. (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
  1757. If you want to set the display properties yourself, just put a
  1758. list as second element:
  1759. (CATEGORY-REGEXP (MY PROPERTY LIST))
  1760. For example, to display a 16px horizontal space for Emacs
  1761. category, you can use:
  1762. (\"Emacs\" \\='(space . (:width (16))))"
  1763. :group 'org-agenda-line-format
  1764. :version "24.1"
  1765. :type '(alist :key-type (regexp :tag "Regexp matching category")
  1766. :value-type (choice (list :tag "Icon"
  1767. (string :tag "File or data")
  1768. (symbol :tag "Type")
  1769. (boolean :tag "Data?")
  1770. (repeat :tag "Extra image properties" :inline t sexp))
  1771. (list :tag "Display properties" sexp))))
  1772. (defgroup org-agenda-column-view nil
  1773. "Options concerning column view in the agenda."
  1774. :tag "Org Agenda Column View"
  1775. :group 'org-agenda)
  1776. (defcustom org-agenda-view-columns-initially nil
  1777. "When non-nil, switch to columns view right after creating the agenda."
  1778. :group 'org-agenda-column-view
  1779. :type 'boolean
  1780. :version "26.1"
  1781. :package-version '(Org . "9.0")
  1782. :safe #'booleanp)
  1783. (defcustom org-agenda-columns-show-summaries t
  1784. "Non-nil means show summaries for columns displayed in the agenda view."
  1785. :group 'org-agenda-column-view
  1786. :type 'boolean)
  1787. (defcustom org-agenda-columns-compute-summary-properties t
  1788. "Non-nil means recompute all summary properties before column view.
  1789. When column view in the agenda is listing properties that have a summary
  1790. operator, it can go to all relevant buffers and recompute the summaries
  1791. there. This can mean overhead for the agenda column view, but is necessary
  1792. to have thing up to date.
  1793. As a special case, a CLOCKSUM property also makes sure that the clock
  1794. computations are current."
  1795. :group 'org-agenda-column-view
  1796. :type 'boolean)
  1797. (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
  1798. "Non-nil means the duration of an appointment will add to day effort.
  1799. The property to which appointment durations will be added is the one given
  1800. in the option `org-effort-property'. If an appointment does not have
  1801. an end time, `org-agenda-default-appointment-duration' will be used. If that
  1802. is not set, an appointment without end time will not contribute to the time
  1803. estimate."
  1804. :group 'org-agenda-column-view
  1805. :type 'boolean)
  1806. (defcustom org-agenda-auto-exclude-function nil
  1807. "A function called with a tag to decide if it is filtered on \
  1808. \\<org-agenda-mode-map>`\\[org-agenda-filter-by-tag] RET'.
  1809. The sole argument to the function, which is called once for each
  1810. possible tag, is a string giving the name of the tag. The
  1811. function should return either nil if the tag should be included
  1812. as normal, \"-<TAG>\" to exclude the tag, or \"+<TAG>\" to exclude
  1813. lines not carrying this tag.
  1814. Note that for the purpose of tag filtering, only the lower-case version of
  1815. all tags will be considered, so that this function will only ever see
  1816. the lower-case version of all tags."
  1817. :group 'org-agenda
  1818. :type '(choice (const nil) (function)))
  1819. (defcustom org-agenda-bulk-custom-functions nil
  1820. "Alist of characters and custom functions for bulk actions.
  1821. For example, this value makes those two functions available:
  1822. \\='((?R set-category)
  1823. (?C bulk-cut))
  1824. With selected entries in an agenda buffer, `B R' will call
  1825. the custom function `set-category' on the selected entries.
  1826. Note that functions in this alist don't need to be quoted.
  1827. You can also specify a function which collects arguments to be
  1828. used for each call to your bulk custom function. The argument
  1829. collecting function will be run once and should return a list of
  1830. arguments to pass to the bulk function. For example:
  1831. \\='((?R set-category get-category))
  1832. Now, `B R' will call the custom `get-category' which would prompt
  1833. the user once for a category. That category is then passed as an
  1834. argument to `set-category' for each entry it's called against."
  1835. :type
  1836. '(alist :key-type character
  1837. :value-type
  1838. (group (function :tag "Bulk Custom Function")
  1839. (choice (function :tag "Bulk Custom Argument Function")
  1840. (const :tag "No Bulk Custom Argument Function" nil))))
  1841. :package-version '(Org . "9.5")
  1842. :group 'org-agenda)
  1843. (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
  1844. "Execute BODY with point at location given by `org-hd-marker' property.
  1845. If STRING is non-nil, the text property will be fetched from position 0
  1846. in that string. If STRING is nil, it will be fetched from the beginning
  1847. of the current line."
  1848. (declare (debug t))
  1849. (org-with-gensyms (marker)
  1850. `(let ((,marker (get-text-property (if ,string 0 (point-at-bol))
  1851. 'org-hd-marker ,string)))
  1852. (with-current-buffer (marker-buffer ,marker)
  1853. (save-excursion
  1854. (goto-char ,marker)
  1855. ,@body)))))
  1856. (defun org-add-agenda-custom-command (entry)
  1857. "Replace or add a command in `org-agenda-custom-commands'.
  1858. This is mostly for hacking and trying a new command - once the command
  1859. works you probably want to add it to `org-agenda-custom-commands' for good."
  1860. (let ((ass (assoc (car entry) org-agenda-custom-commands)))
  1861. (if ass
  1862. (setcdr ass (cdr entry))
  1863. (push entry org-agenda-custom-commands))))
  1864. (defmacro org-agenda--insert-overriding-header (default)
  1865. "Insert header into agenda view.
  1866. The inserted header depends on `org-agenda-overriding-header'.
  1867. If the empty string, don't insert a header. If any other string,
  1868. insert it as a header. If nil, insert DEFAULT, which should
  1869. evaluate to a string."
  1870. (declare (debug (form)) (indent defun))
  1871. `(cond
  1872. ((not org-agenda-overriding-header) (insert ,default))
  1873. ((equal org-agenda-overriding-header "") nil)
  1874. ((stringp org-agenda-overriding-header)
  1875. (insert (propertize org-agenda-overriding-header
  1876. 'face 'org-agenda-structure)
  1877. "\n"))
  1878. (t (user-error "Invalid value for `org-agenda-overriding-header': %S"
  1879. org-agenda-overriding-header))))
  1880. ;;; Define the org-agenda-mode
  1881. (defvaralias 'org-agenda-keymap 'org-agenda-mode-map)
  1882. (defvar org-agenda-mode-map (make-sparse-keymap)
  1883. "Keymap for `org-agenda-mode'.")
  1884. (org-remap org-agenda-mode-map 'move-end-of-line 'org-agenda-end-of-line)
  1885. (defvar org-agenda-menu) ; defined later in this file.
  1886. (defvar org-agenda-restrict nil) ; defined later in this file.
  1887. (defvar org-agenda-follow-mode nil)
  1888. (defvar org-agenda-entry-text-mode nil)
  1889. (defvar org-agenda-clockreport-mode nil)
  1890. (defvar org-agenda-show-log nil
  1891. "When non-nil, show the log in the agenda.
  1892. Do not set this directly; instead use
  1893. `org-agenda-start-with-log-mode', which see.")
  1894. (defvar org-agenda-redo-command nil)
  1895. (defvar org-agenda-query-string nil)
  1896. (defvar org-agenda-mode-hook nil
  1897. "Hook run after `org-agenda-mode' is turned on.
  1898. The buffer is still writable when this hook is called.")
  1899. (defvar org-agenda-type nil)
  1900. (defvar org-agenda-force-single-file nil)
  1901. (defvar org-agenda-bulk-marked-entries nil
  1902. "List of markers that refer to marked entries in the agenda.")
  1903. (defvar org-agenda-current-date nil
  1904. "Active date when building the agenda.")
  1905. ;;; Multiple agenda buffers support
  1906. (defcustom org-agenda-sticky nil
  1907. "Non-nil means agenda q key will bury agenda buffers.
  1908. Agenda commands will then show existing buffer instead of generating new ones.
  1909. When nil, `q' will kill the single agenda buffer."
  1910. :group 'org-agenda
  1911. :version "24.3"
  1912. :type 'boolean)
  1913. ;;;###autoload
  1914. (defun org-toggle-sticky-agenda (&optional arg)
  1915. "Toggle `org-agenda-sticky'."
  1916. (interactive "P")
  1917. (let ((new-value (if arg
  1918. (> (prefix-numeric-value arg) 0)
  1919. (not org-agenda-sticky))))
  1920. (if (equal new-value org-agenda-sticky)
  1921. (and (called-interactively-p 'interactive)
  1922. (message "Sticky agenda was already %s"
  1923. (if org-agenda-sticky "enabled" "disabled")))
  1924. (setq org-agenda-sticky new-value)
  1925. (org-agenda-kill-all-agenda-buffers)
  1926. (and (called-interactively-p 'interactive)
  1927. (message "Sticky agenda %s"
  1928. (if org-agenda-sticky "enabled" "disabled"))))))
  1929. (defvar org-agenda-buffer nil
  1930. "Agenda buffer currently being generated.")
  1931. (defvar org-agenda-last-prefix-arg nil)
  1932. (defvar org-agenda-this-buffer-name nil)
  1933. (defvar org-agenda-doing-sticky-redo nil)
  1934. (defvar org-agenda-this-buffer-is-sticky nil)
  1935. (defvar org-agenda-last-indirect-buffer nil
  1936. "Last buffer loaded by `org-agenda-tree-to-indirect-buffer'.")
  1937. (defconst org-agenda-local-vars
  1938. '(org-agenda-this-buffer-name
  1939. org-agenda-undo-list
  1940. org-agenda-pending-undo-list
  1941. org-agenda-follow-mode
  1942. org-agenda-entry-text-mode
  1943. org-agenda-clockreport-mode
  1944. org-agenda-show-log
  1945. org-agenda-redo-command
  1946. org-agenda-query-string
  1947. org-agenda-type
  1948. org-agenda-bulk-marked-entries
  1949. org-agenda-undo-has-started-in
  1950. org-agenda-info
  1951. org-agenda-pre-window-conf
  1952. org-agenda-columns-active
  1953. org-agenda-tag-filter
  1954. org-agenda-category-filter
  1955. org-agenda-top-headline-filter
  1956. org-agenda-regexp-filter
  1957. org-agenda-effort-filter
  1958. org-agenda-markers
  1959. org-agenda-last-search-view-search-was-boolean
  1960. org-agenda-last-indirect-buffer
  1961. org-agenda-filtered-by-category
  1962. org-agenda-filter-form
  1963. org-agenda-cycle-counter
  1964. org-agenda-last-prefix-arg)
  1965. "Variables that must be local in agenda buffers to allow multiple buffers.")
  1966. (defun org-agenda-mode ()
  1967. "Mode for time-sorted view on action items in Org files.
  1968. The following commands are available:
  1969. \\{org-agenda-mode-map}"
  1970. (interactive)
  1971. (ignore-errors (require 'face-remap))
  1972. (let ((agenda-local-vars-to-keep
  1973. '(text-scale-mode-amount
  1974. text-scale-mode
  1975. text-scale-mode-lighter
  1976. face-remapping-alist))
  1977. (save (buffer-local-variables)))
  1978. (kill-all-local-variables)
  1979. (cl-flet ((reset-saved (var-set)
  1980. "Reset variables in VAR-SET to possibly stored value in SAVE."
  1981. (dolist (elem save)
  1982. (pcase elem
  1983. (`(,var . ,val) ;ignore unbound variables
  1984. (when (and val (memq var var-set))
  1985. (set var val)))))))
  1986. (cond (org-agenda-doing-sticky-redo
  1987. ;; Refreshing sticky agenda-buffer
  1988. ;;
  1989. ;; Preserve the value of `org-agenda-local-vars' variables.
  1990. (mapc #'make-local-variable org-agenda-local-vars)
  1991. (reset-saved org-agenda-local-vars)
  1992. (setq-local org-agenda-this-buffer-is-sticky t))
  1993. (org-agenda-sticky
  1994. ;; Creating a sticky Agenda buffer for the first time
  1995. (mapc #'make-local-variable org-agenda-local-vars)
  1996. (setq-local org-agenda-this-buffer-is-sticky t))
  1997. (t
  1998. ;; Creating a non-sticky agenda buffer
  1999. (setq-local org-agenda-this-buffer-is-sticky nil)))
  2000. (mapc #'make-local-variable agenda-local-vars-to-keep)
  2001. (reset-saved agenda-local-vars-to-keep)))
  2002. (setq org-agenda-undo-list nil
  2003. org-agenda-pending-undo-list nil
  2004. org-agenda-bulk-marked-entries nil)
  2005. (setq major-mode 'org-agenda-mode)
  2006. ;; Keep global-font-lock-mode from turning on font-lock-mode
  2007. (setq-local font-lock-global-modes (list 'not major-mode))
  2008. (setq mode-name "Org-Agenda")
  2009. (setq indent-tabs-mode nil)
  2010. (use-local-map org-agenda-mode-map)
  2011. (when org-startup-truncated (setq truncate-lines t))
  2012. (setq-local line-move-visual nil)
  2013. (add-hook 'post-command-hook #'org-agenda-update-agenda-type nil 'local)
  2014. (add-hook 'pre-command-hook #'org-unhighlight nil 'local)
  2015. ;; Make sure properties are removed when copying text
  2016. (if (boundp 'filter-buffer-substring-functions)
  2017. (add-hook 'filter-buffer-substring-functions
  2018. (lambda (fun start end delete)
  2019. (substring-no-properties (funcall fun start end delete)))
  2020. nil t)
  2021. ;; Emacs >= 24.4.
  2022. (add-function :filter-return (local 'filter-buffer-substring-function)
  2023. #'substring-no-properties))
  2024. (unless org-agenda-keep-modes
  2025. (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
  2026. org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
  2027. org-agenda-show-log org-agenda-start-with-log-mode
  2028. org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode))
  2029. (add-to-invisibility-spec '(org-filtered))
  2030. (add-to-invisibility-spec '(org-link))
  2031. (easy-menu-change
  2032. '("Agenda") "Agenda Files"
  2033. (append
  2034. (list
  2035. (vector
  2036. (if (get 'org-agenda-files 'org-restrict)
  2037. "Restricted to single file"
  2038. "Edit File List")
  2039. '(org-edit-agenda-file-list)
  2040. (not (get 'org-agenda-files 'org-restrict)))
  2041. "--")
  2042. (mapcar #'org-file-menu-entry (org-agenda-files))))
  2043. (org-agenda-set-mode-name)
  2044. (run-mode-hooks 'org-agenda-mode-hook))
  2045. (substitute-key-definition #'undo #'org-agenda-undo
  2046. org-agenda-mode-map global-map)
  2047. (org-defkey org-agenda-mode-map "\C-i" #'org-agenda-goto)
  2048. (org-defkey org-agenda-mode-map [(tab)] #'org-agenda-goto)
  2049. (org-defkey org-agenda-mode-map "\C-m" #'org-agenda-switch-to)
  2050. (org-defkey org-agenda-mode-map "\C-k" #'org-agenda-kill)
  2051. (org-defkey org-agenda-mode-map "\C-c\C-w" #'org-agenda-refile)
  2052. (org-defkey org-agenda-mode-map [(meta down)] #'org-agenda-drag-line-forward)
  2053. (org-defkey org-agenda-mode-map [(meta up)] #'org-agenda-drag-line-backward)
  2054. (org-defkey org-agenda-mode-map "m" #'org-agenda-bulk-mark)
  2055. (org-defkey org-agenda-mode-map "\M-m" #'org-agenda-bulk-toggle)
  2056. (org-defkey org-agenda-mode-map "*" #'org-agenda-bulk-mark-all)
  2057. (org-defkey org-agenda-mode-map "\M-*" #'org-agenda-bulk-toggle-all)
  2058. (org-defkey org-agenda-mode-map "#" #'org-agenda-dim-blocked-tasks)
  2059. (org-defkey org-agenda-mode-map "%" #'org-agenda-bulk-mark-regexp)
  2060. (org-defkey org-agenda-mode-map "u" #'org-agenda-bulk-unmark)
  2061. (org-defkey org-agenda-mode-map "U" #'org-agenda-bulk-unmark-all)
  2062. (org-defkey org-agenda-mode-map "B" #'org-agenda-bulk-action)
  2063. (org-defkey org-agenda-mode-map "k" #'org-agenda-capture)
  2064. (org-defkey org-agenda-mode-map "A" #'org-agenda-append-agenda)
  2065. (org-defkey org-agenda-mode-map "\C-c\C-x!" #'org-reload)
  2066. (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" #'org-agenda-archive-default)
  2067. (org-defkey org-agenda-mode-map "\C-c\C-xa" #'org-agenda-toggle-archive-tag)
  2068. (org-defkey org-agenda-mode-map "\C-c\C-xA" #'org-agenda-archive-to-archive-sibling)
  2069. (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" #'org-agenda-archive)
  2070. (org-defkey org-agenda-mode-map "\C-c$" #'org-agenda-archive)
  2071. (org-defkey org-agenda-mode-map "$" #'org-agenda-archive)
  2072. (org-defkey org-agenda-mode-map "\C-c\C-o" #'org-agenda-open-link)
  2073. (org-defkey org-agenda-mode-map " " #'org-agenda-show-and-scroll-up)
  2074. (org-defkey org-agenda-mode-map [backspace] #'org-agenda-show-scroll-down)
  2075. (org-defkey org-agenda-mode-map "\d" #'org-agenda-show-scroll-down)
  2076. (org-defkey org-agenda-mode-map [(control shift right)] #'org-agenda-todo-nextset)
  2077. (org-defkey org-agenda-mode-map [(control shift left)] #'org-agenda-todo-previousset)
  2078. (org-defkey org-agenda-mode-map "\C-c\C-xb" #'org-agenda-tree-to-indirect-buffer)
  2079. (org-defkey org-agenda-mode-map "o" #'delete-other-windows)
  2080. (org-defkey org-agenda-mode-map "L" #'org-agenda-recenter)
  2081. (org-defkey org-agenda-mode-map "\C-c\C-t" #'org-agenda-todo)
  2082. (org-defkey org-agenda-mode-map "t" #'org-agenda-todo)
  2083. (org-defkey org-agenda-mode-map "a" #'org-agenda-archive-default-with-confirmation)
  2084. (org-defkey org-agenda-mode-map ":" #'org-agenda-set-tags)
  2085. (org-defkey org-agenda-mode-map "\C-c\C-q" #'org-agenda-set-tags)
  2086. (org-defkey org-agenda-mode-map "." #'org-agenda-goto-today)
  2087. (org-defkey org-agenda-mode-map "j" #'org-agenda-goto-date)
  2088. (org-defkey org-agenda-mode-map "d" #'org-agenda-day-view)
  2089. (org-defkey org-agenda-mode-map "w" #'org-agenda-week-view)
  2090. (org-defkey org-agenda-mode-map "y" #'org-agenda-year-view)
  2091. (org-defkey org-agenda-mode-map "\C-c\C-z" #'org-agenda-add-note)
  2092. (org-defkey org-agenda-mode-map "z" #'org-agenda-add-note)
  2093. (org-defkey org-agenda-mode-map [(shift right)] #'org-agenda-do-date-later)
  2094. (org-defkey org-agenda-mode-map [(shift left)] #'org-agenda-do-date-earlier)
  2095. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] #'org-agenda-do-date-later)
  2096. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] #'org-agenda-do-date-earlier)
  2097. (org-defkey org-agenda-mode-map ">" #'org-agenda-date-prompt)
  2098. (org-defkey org-agenda-mode-map "\C-c\C-s" #'org-agenda-schedule)
  2099. (org-defkey org-agenda-mode-map "\C-c\C-d" #'org-agenda-deadline)
  2100. (let ((l '(1 2 3 4 5 6 7 8 9 0)))
  2101. (while l (org-defkey org-agenda-mode-map
  2102. (number-to-string (pop l)) #'digit-argument)))
  2103. (org-defkey org-agenda-mode-map "F" #'org-agenda-follow-mode)
  2104. (org-defkey org-agenda-mode-map "R" #'org-agenda-clockreport-mode)
  2105. (org-defkey org-agenda-mode-map "E" #'org-agenda-entry-text-mode)
  2106. (org-defkey org-agenda-mode-map "l" #'org-agenda-log-mode)
  2107. (org-defkey org-agenda-mode-map "v" #'org-agenda-view-mode-dispatch)
  2108. (org-defkey org-agenda-mode-map "D" #'org-agenda-toggle-diary)
  2109. (org-defkey org-agenda-mode-map "!" #'org-agenda-toggle-deadlines)
  2110. (org-defkey org-agenda-mode-map "G" #'org-agenda-toggle-time-grid)
  2111. (org-defkey org-agenda-mode-map "r" #'org-agenda-redo)
  2112. (org-defkey org-agenda-mode-map "g" #'org-agenda-redo-all)
  2113. (org-defkey org-agenda-mode-map "e" #'org-agenda-set-effort)
  2114. (org-defkey org-agenda-mode-map "\C-c\C-xe" #'org-agenda-set-effort)
  2115. (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
  2116. #'org-clock-modify-effort-estimate)
  2117. (org-defkey org-agenda-mode-map "\C-c\C-xp" #'org-agenda-set-property)
  2118. (org-defkey org-agenda-mode-map "q" #'org-agenda-quit)
  2119. (org-defkey org-agenda-mode-map "Q" #'org-agenda-Quit)
  2120. (org-defkey org-agenda-mode-map "x" #'org-agenda-exit)
  2121. (org-defkey org-agenda-mode-map "\C-x\C-w" #'org-agenda-write)
  2122. (org-defkey org-agenda-mode-map "\C-x\C-s" #'org-save-all-org-buffers)
  2123. (org-defkey org-agenda-mode-map "s" #'org-save-all-org-buffers)
  2124. (org-defkey org-agenda-mode-map "T" #'org-agenda-show-tags)
  2125. (org-defkey org-agenda-mode-map "n" #'org-agenda-next-line)
  2126. (org-defkey org-agenda-mode-map "p" #'org-agenda-previous-line)
  2127. (org-defkey org-agenda-mode-map "N" #'org-agenda-next-item)
  2128. (org-defkey org-agenda-mode-map "P" #'org-agenda-previous-item)
  2129. (substitute-key-definition #'next-line #'org-agenda-next-line
  2130. org-agenda-mode-map global-map)
  2131. (substitute-key-definition #'previous-line #'org-agenda-previous-line
  2132. org-agenda-mode-map global-map)
  2133. (org-defkey org-agenda-mode-map "\C-c\C-a" #'org-attach)
  2134. (org-defkey org-agenda-mode-map "\C-c\C-n" #'org-agenda-next-date-line)
  2135. (org-defkey org-agenda-mode-map "\C-c\C-p" #'org-agenda-previous-date-line)
  2136. (org-defkey org-agenda-mode-map "\C-c," #'org-agenda-priority)
  2137. (org-defkey org-agenda-mode-map "," #'org-agenda-priority)
  2138. (org-defkey org-agenda-mode-map "i" #'org-agenda-diary-entry)
  2139. (org-defkey org-agenda-mode-map "c" #'org-agenda-goto-calendar)
  2140. (org-defkey org-agenda-mode-map "C" #'org-agenda-convert-date)
  2141. (org-defkey org-agenda-mode-map "M" #'org-agenda-phases-of-moon)
  2142. (org-defkey org-agenda-mode-map "S" #'org-agenda-sunrise-sunset)
  2143. (org-defkey org-agenda-mode-map "h" #'org-agenda-holidays)
  2144. (org-defkey org-agenda-mode-map "H" #'org-agenda-holidays)
  2145. (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" #'org-agenda-clock-in)
  2146. (org-defkey org-agenda-mode-map "I" #'org-agenda-clock-in)
  2147. (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" #'org-agenda-clock-out)
  2148. (org-defkey org-agenda-mode-map "O" #'org-agenda-clock-out)
  2149. (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" #'org-agenda-clock-cancel)
  2150. (org-defkey org-agenda-mode-map "X" #'org-agenda-clock-cancel)
  2151. (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" #'org-clock-goto)
  2152. (org-defkey org-agenda-mode-map "J" #'org-agenda-clock-goto)
  2153. (org-defkey org-agenda-mode-map "+" #'org-agenda-priority-up)
  2154. (org-defkey org-agenda-mode-map "-" #'org-agenda-priority-down)
  2155. (org-defkey org-agenda-mode-map [(shift up)] #'org-agenda-priority-up)
  2156. (org-defkey org-agenda-mode-map [(shift down)] #'org-agenda-priority-down)
  2157. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] #'org-agenda-priority-up)
  2158. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] #'org-agenda-priority-down)
  2159. (org-defkey org-agenda-mode-map "f" #'org-agenda-later)
  2160. (org-defkey org-agenda-mode-map "b" #'org-agenda-earlier)
  2161. (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" #'org-agenda-columns)
  2162. (org-defkey org-agenda-mode-map "\C-c\C-x>" #'org-agenda-remove-restriction-lock)
  2163. (org-defkey org-agenda-mode-map "\C-c\C-x<" #'org-agenda-set-restriction-lock-from-agenda)
  2164. (org-defkey org-agenda-mode-map "[" #'org-agenda-manipulate-query-add)
  2165. (org-defkey org-agenda-mode-map "]" #'org-agenda-manipulate-query-subtract)
  2166. (org-defkey org-agenda-mode-map "{" #'org-agenda-manipulate-query-add-re)
  2167. (org-defkey org-agenda-mode-map "}" #'org-agenda-manipulate-query-subtract-re)
  2168. (org-defkey org-agenda-mode-map "\\" #'org-agenda-filter-by-tag)
  2169. (org-defkey org-agenda-mode-map "_" #'org-agenda-filter-by-effort)
  2170. (org-defkey org-agenda-mode-map "=" #'org-agenda-filter-by-regexp)
  2171. (org-defkey org-agenda-mode-map "/" #'org-agenda-filter)
  2172. (org-defkey org-agenda-mode-map "|" #'org-agenda-filter-remove-all)
  2173. (org-defkey org-agenda-mode-map "~" #'org-agenda-limit-interactively)
  2174. (org-defkey org-agenda-mode-map "<" #'org-agenda-filter-by-category)
  2175. (org-defkey org-agenda-mode-map "^" #'org-agenda-filter-by-top-headline)
  2176. (org-defkey org-agenda-mode-map ";" #'org-timer-set-timer)
  2177. (org-defkey org-agenda-mode-map "\C-c\C-x_" #'org-timer-stop)
  2178. (org-defkey org-agenda-mode-map "?" #'org-agenda-show-the-flagging-note)
  2179. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" #'org-mobile-pull)
  2180. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" #'org-mobile-push)
  2181. (org-defkey org-agenda-mode-map "\C-c\C-xI" #'org-info-find-node)
  2182. (org-defkey org-agenda-mode-map [mouse-2] #'org-agenda-goto-mouse)
  2183. (org-defkey org-agenda-mode-map [mouse-3] #'org-agenda-show-mouse)
  2184. (org-defkey org-agenda-mode-map [remap forward-paragraph] #'org-agenda-forward-block)
  2185. (org-defkey org-agenda-mode-map [remap backward-paragraph] #'org-agenda-backward-block)
  2186. (org-defkey org-agenda-mode-map "\C-c\C-c" #'org-agenda-ctrl-c-ctrl-c)
  2187. (when org-agenda-mouse-1-follows-link
  2188. (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
  2189. (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu."
  2190. '("Agenda"
  2191. ("Agenda Files")
  2192. "--"
  2193. ("Agenda Dates"
  2194. ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda)]
  2195. ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
  2196. ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
  2197. ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
  2198. "--"
  2199. ("View"
  2200. ["Day View" org-agenda-day-view
  2201. :active (org-agenda-check-type nil 'agenda)
  2202. :style radio :selected (eq org-agenda-current-span 'day)
  2203. :keys "v d (or just d)"]
  2204. ["Week View" org-agenda-week-view
  2205. :active (org-agenda-check-type nil 'agenda)
  2206. :style radio :selected (eq org-agenda-current-span 'week)
  2207. :keys "v w"]
  2208. ["Fortnight View" org-agenda-fortnight-view
  2209. :active (org-agenda-check-type nil 'agenda)
  2210. :style radio :selected (eq org-agenda-current-span 'fortnight)
  2211. :keys "v t"]
  2212. ["Month View" org-agenda-month-view
  2213. :active (org-agenda-check-type nil 'agenda)
  2214. :style radio :selected (eq org-agenda-current-span 'month)
  2215. :keys "v m"]
  2216. ["Year View" org-agenda-year-view
  2217. :active (org-agenda-check-type nil 'agenda)
  2218. :style radio :selected (eq org-agenda-current-span 'year)
  2219. :keys "v y"]
  2220. "--"
  2221. ["Include Diary" org-agenda-toggle-diary
  2222. :style toggle :selected org-agenda-include-diary
  2223. :active (org-agenda-check-type nil 'agenda)]
  2224. ["Include Deadlines" org-agenda-toggle-deadlines
  2225. :style toggle :selected org-agenda-include-deadlines
  2226. :active (org-agenda-check-type nil 'agenda)]
  2227. ["Use Time Grid" org-agenda-toggle-time-grid
  2228. :style toggle :selected org-agenda-use-time-grid
  2229. :active (org-agenda-check-type nil 'agenda)]
  2230. "--"
  2231. ["Show clock report" org-agenda-clockreport-mode
  2232. :style toggle :selected org-agenda-clockreport-mode
  2233. :active (org-agenda-check-type nil 'agenda)]
  2234. ["Show some entry text" org-agenda-entry-text-mode
  2235. :style toggle :selected org-agenda-entry-text-mode
  2236. :active t]
  2237. "--"
  2238. ["Show Logbook entries" org-agenda-log-mode
  2239. :style toggle :selected org-agenda-show-log
  2240. :active (org-agenda-check-type nil 'agenda)
  2241. :keys "v l (or just l)"]
  2242. ["Include archived trees" org-agenda-archives-mode
  2243. :style toggle :selected org-agenda-archives-mode :active t
  2244. :keys "v a"]
  2245. ["Include archive files" (org-agenda-archives-mode t)
  2246. :style toggle :selected (eq org-agenda-archives-mode t) :active t
  2247. :keys "v A"]
  2248. "--"
  2249. ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
  2250. ("Filter current view"
  2251. ["with generic interface" org-agenda-filter t]
  2252. "--"
  2253. ["by category at cursor" org-agenda-filter-by-category t]
  2254. ["by tag" org-agenda-filter-by-tag t]
  2255. ["by effort" org-agenda-filter-by-effort t]
  2256. ["by regexp" org-agenda-filter-by-regexp t]
  2257. ["by top-level headline" org-agenda-filter-by-top-headline t]
  2258. "--"
  2259. ["Remove all filtering" org-agenda-filter-remove-all t]
  2260. "--"
  2261. ["limit" org-agenda-limit-interactively t])
  2262. ["Rebuild buffer" org-agenda-redo t]
  2263. ["Write view to file" org-agenda-write t]
  2264. ["Save all Org buffers" org-save-all-org-buffers t]
  2265. "--"
  2266. ["Show original entry" org-agenda-show t]
  2267. ["Go To (other window)" org-agenda-goto t]
  2268. ["Go To (this window)" org-agenda-switch-to t]
  2269. ["Capture with cursor date" org-agenda-capture t]
  2270. ["Follow Mode" org-agenda-follow-mode
  2271. :style toggle :selected org-agenda-follow-mode :active t]
  2272. ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
  2273. "--"
  2274. ("TODO"
  2275. ["Cycle TODO" org-agenda-todo t]
  2276. ["Next TODO set" org-agenda-todo-nextset t]
  2277. ["Previous TODO set" org-agenda-todo-previousset t]
  2278. ["Add note" org-agenda-add-note t])
  2279. ("Archive/Refile/Delete"
  2280. ["Archive default" org-agenda-archive-default t]
  2281. ["Archive default" org-agenda-archive-default-with-confirmation t]
  2282. ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
  2283. ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
  2284. ["Archive subtree" org-agenda-archive t]
  2285. "--"
  2286. ["Refile" org-agenda-refile t]
  2287. "--"
  2288. ["Delete subtree" org-agenda-kill t])
  2289. ("Bulk action"
  2290. ["Mark entry" org-agenda-bulk-mark t]
  2291. ["Mark all" org-agenda-bulk-mark-all t]
  2292. ["Unmark entry" org-agenda-bulk-unmark t]
  2293. ["Unmark all" org-agenda-bulk-unmark-all :active t :keys "U"]
  2294. ["Toggle mark" org-agenda-bulk-toggle t]
  2295. ["Toggle all" org-agenda-bulk-toggle-all t]
  2296. ["Mark regexp" org-agenda-bulk-mark-regexp t])
  2297. ["Act on all marked" org-agenda-bulk-action t]
  2298. "--"
  2299. ("Tags and Properties"
  2300. ["Show all Tags" org-agenda-show-tags t]
  2301. ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
  2302. ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
  2303. "--"
  2304. ["Column View" org-columns t])
  2305. ("Deadline/Schedule"
  2306. ["Schedule" org-agenda-schedule t]
  2307. ["Set Deadline" org-agenda-deadline t]
  2308. "--"
  2309. ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda)]
  2310. ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda)]
  2311. ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda) :keys "C-u S-right"]
  2312. ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda) :keys "C-u S-left"]
  2313. ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda) :keys "C-u C-u S-right"]
  2314. ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda) :keys "C-u C-u S-left"]
  2315. ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda)])
  2316. ("Clock and Effort"
  2317. ["Clock in" org-agenda-clock-in t]
  2318. ["Clock out" org-agenda-clock-out t]
  2319. ["Clock cancel" org-agenda-clock-cancel t]
  2320. ["Goto running clock" org-clock-goto t]
  2321. "--"
  2322. ["Set Effort" org-agenda-set-effort t]
  2323. ["Change clocked effort" org-clock-modify-effort-estimate
  2324. (org-clock-is-active)])
  2325. ("Priority"
  2326. ["Set Priority" org-agenda-priority t]
  2327. ["Increase Priority" org-agenda-priority-up t]
  2328. ["Decrease Priority" org-agenda-priority-down t]
  2329. ["Show Priority" org-priority-show t])
  2330. ("Calendar/Diary"
  2331. ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda)]
  2332. ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda)]
  2333. ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda)]
  2334. ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda)]
  2335. ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda)]
  2336. ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda)]
  2337. "--"
  2338. ["Create iCalendar File" org-icalendar-combine-agenda-files t])
  2339. "--"
  2340. ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
  2341. "--"
  2342. ("MobileOrg"
  2343. ["Push Files and Views" org-mobile-push t]
  2344. ["Get Captured and Flagged" org-mobile-pull t]
  2345. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "\\[org-agenda] ?"]
  2346. ["Show note / unflag" org-agenda-show-the-flagging-note t]
  2347. "--"
  2348. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  2349. "--"
  2350. ["Quit" org-agenda-quit t]
  2351. ["Exit and Release Buffers" org-agenda-exit t]
  2352. ))
  2353. ;;; Agenda undo
  2354. (defvar org-agenda-allow-remote-undo t
  2355. "Non-nil means allow remote undo from the agenda buffer.")
  2356. (defvar org-agenda-undo-has-started-in nil
  2357. "Buffers that have already seen `undo-start' in the current undo sequence.")
  2358. (defun org-agenda-undo ()
  2359. "Undo a remote editing step in the agenda.
  2360. This undoes changes both in the agenda buffer and in the remote buffer
  2361. that have been changed along."
  2362. (interactive)
  2363. (or org-agenda-allow-remote-undo
  2364. (user-error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
  2365. (when (not (eq this-command last-command))
  2366. (setq org-agenda-undo-has-started-in nil
  2367. org-agenda-pending-undo-list org-agenda-undo-list))
  2368. (when (not org-agenda-pending-undo-list)
  2369. (user-error "No further undo information"))
  2370. (let* ((entry (pop org-agenda-pending-undo-list))
  2371. buf line cmd rembuf)
  2372. (setq cmd (pop entry) line (pop entry))
  2373. (setq rembuf (nth 2 entry))
  2374. (org-with-remote-undo rembuf
  2375. (while (bufferp (setq buf (pop entry)))
  2376. (when (pop entry)
  2377. (with-current-buffer buf
  2378. (let (;; (last-undo-buffer buf)
  2379. (inhibit-read-only t))
  2380. (unless (memq buf org-agenda-undo-has-started-in)
  2381. (push buf org-agenda-undo-has-started-in)
  2382. (make-local-variable 'pending-undo-list)
  2383. (undo-start))
  2384. (while (and pending-undo-list
  2385. (listp pending-undo-list)
  2386. (not (car pending-undo-list)))
  2387. (pop pending-undo-list))
  2388. (undo-more 1))))))
  2389. (org-goto-line line)
  2390. (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
  2391. (defun org-verify-change-for-undo (l1 l2)
  2392. "Verify that a real change occurred between the undo lists L1 and L2."
  2393. (while (and l1 (listp l1) (null (car l1))) (pop l1))
  2394. (while (and l2 (listp l2) (null (car l2))) (pop l2))
  2395. (not (eq l1 l2)))
  2396. ;;; Agenda dispatch
  2397. (defvar org-agenda-restrict-begin (make-marker))
  2398. (defvar org-agenda-restrict-end (make-marker))
  2399. (defvar org-agenda-last-dispatch-buffer nil)
  2400. (defvar org-agenda-overriding-restriction nil)
  2401. (defcustom org-agenda-custom-commands-contexts nil
  2402. "Alist of custom agenda keys and contextual rules.
  2403. For example, if you have a custom agenda command \"p\" and you
  2404. want this command to be accessible only from plain text files,
  2405. use this:
  2406. \\='((\"p\" ((in-file . \"\\\\.txt\\\\'\"))))
  2407. Here are the available contexts definitions:
  2408. in-file: command displayed only in matching files
  2409. in-mode: command displayed only in matching modes
  2410. not-in-file: command not displayed in matching files
  2411. not-in-mode: command not displayed in matching modes
  2412. in-buffer: command displayed only in matching buffers
  2413. not-in-buffer: command not displayed in matching buffers
  2414. [function]: a custom function taking no argument
  2415. If you define several checks, the agenda command will be
  2416. accessible if there is at least one valid check.
  2417. You can also bind a key to another agenda custom command
  2418. depending on contextual rules.
  2419. \\='((\"p\" \"q\" ((in-file . \"\\\\.txt\\\\'\"))))
  2420. Here it means: in .txt files, use \"p\" as the key for the
  2421. agenda command otherwise associated with \"q\". (The command
  2422. originally associated with \"q\" is not displayed to avoid
  2423. duplicates.)"
  2424. :version "24.3"
  2425. :group 'org-agenda-custom-commands
  2426. :type '(repeat (list :tag "Rule"
  2427. (string :tag " Agenda key")
  2428. (string :tag "Replace by command")
  2429. (repeat :tag "Available when"
  2430. (choice
  2431. (cons :tag "Condition"
  2432. (choice
  2433. (const :tag "In file" in-file)
  2434. (const :tag "Not in file" not-in-file)
  2435. (const :tag "In buffer" in-buffer)
  2436. (const :tag "Not in buffer" not-in-buffer)
  2437. (const :tag "In mode" in-mode)
  2438. (const :tag "Not in mode" not-in-mode))
  2439. (regexp))
  2440. (function :tag "Custom function"))))))
  2441. (defcustom org-agenda-max-entries nil
  2442. "Maximum number of entries to display in an agenda.
  2443. This can be nil (no limit) or an integer or an alist of agenda
  2444. types with an associated number of entries to display in this
  2445. type."
  2446. :version "24.4"
  2447. :package-version '(Org . "8.0")
  2448. :group 'org-agenda-custom-commands
  2449. :type '(choice (symbol :tag "No limit" nil)
  2450. (integer :tag "Max number of entries")
  2451. (repeat
  2452. (cons (choice :tag "Agenda type"
  2453. (const agenda)
  2454. (const todo)
  2455. (const tags)
  2456. (const search))
  2457. (integer :tag "Max number of entries")))))
  2458. (defcustom org-agenda-max-todos nil
  2459. "Maximum number of TODOs to display in an agenda.
  2460. This can be nil (no limit) or an integer or an alist of agenda
  2461. types with an associated number of entries to display in this
  2462. type."
  2463. :version "24.4"
  2464. :package-version '(Org . "8.0")
  2465. :group 'org-agenda-custom-commands
  2466. :type '(choice (symbol :tag "No limit" nil)
  2467. (integer :tag "Max number of TODOs")
  2468. (repeat
  2469. (cons (choice :tag "Agenda type"
  2470. (const agenda)
  2471. (const todo)
  2472. (const tags)
  2473. (const search))
  2474. (integer :tag "Max number of TODOs")))))
  2475. (defcustom org-agenda-max-tags nil
  2476. "Maximum number of tagged entries to display in an agenda.
  2477. This can be nil (no limit) or an integer or an alist of agenda
  2478. types with an associated number of entries to display in this
  2479. type."
  2480. :version "24.4"
  2481. :package-version '(Org . "8.0")
  2482. :group 'org-agenda-custom-commands
  2483. :type '(choice (symbol :tag "No limit" nil)
  2484. (integer :tag "Max number of tagged entries")
  2485. (repeat
  2486. (cons (choice :tag "Agenda type"
  2487. (const agenda)
  2488. (const todo)
  2489. (const tags)
  2490. (const search))
  2491. (integer :tag "Max number of tagged entries")))))
  2492. (defcustom org-agenda-max-effort nil
  2493. "Maximum cumulated effort duration for the agenda.
  2494. This can be nil (no limit) or a number of minutes (as an integer)
  2495. or an alist of agenda types with an associated number of minutes
  2496. to limit entries to in this type."
  2497. :version "24.4"
  2498. :package-version '(Org . "8.0")
  2499. :group 'org-agenda-custom-commands
  2500. :type '(choice (symbol :tag "No limit" nil)
  2501. (integer :tag "Max number of minutes")
  2502. (repeat
  2503. (cons (choice :tag "Agenda type"
  2504. (const agenda)
  2505. (const todo)
  2506. (const tags)
  2507. (const search))
  2508. (integer :tag "Max number of minutes")))))
  2509. (defvar org-agenda-keep-restricted-file-list nil)
  2510. (defvar org-keys nil)
  2511. (defvar org-match nil)
  2512. ;;;###autoload
  2513. (defun org-agenda (&optional arg keys restriction)
  2514. "Dispatch agenda commands to collect entries to the agenda buffer.
  2515. Prompts for a command to execute. Any prefix arg will be passed
  2516. on to the selected command. The default selections are:
  2517. a Call `org-agenda-list' to display the agenda for current day or week.
  2518. t Call `org-todo-list' to display the global todo list.
  2519. T Call `org-todo-list' to display the global todo list, select only
  2520. entries with a specific TODO keyword (the user gets a prompt).
  2521. m Call `org-tags-view' to display headlines with tags matching
  2522. a condition (the user is prompted for the condition).
  2523. M Like `m', but select only TODO entries, no ordinary headlines.
  2524. e Export views to associated files.
  2525. s Search entries for keywords.
  2526. S Search entries for keywords, only with TODO keywords.
  2527. / Multi occur across all agenda files and also files listed
  2528. in `org-agenda-text-search-extra-files'.
  2529. < Restrict agenda commands to buffer, subtree, or region.
  2530. Press several times to get the desired effect.
  2531. > Remove a previous restriction.
  2532. # List \"stuck\" projects.
  2533. ! Configure what \"stuck\" means.
  2534. C Configure custom agenda commands.
  2535. More commands can be added by configuring the variable
  2536. `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
  2537. searches can be pre-defined in this way.
  2538. If the current buffer is in Org mode and visiting a file, you can also
  2539. first press `<' once to indicate that the agenda should be temporarily
  2540. \(until the next use of `\\[org-agenda]') restricted to the current file.
  2541. Pressing `<' twice means to restrict to the current subtree or region
  2542. \(if active)."
  2543. (interactive "P")
  2544. (catch 'exit
  2545. (let* ((org-keys keys)
  2546. (prefix-descriptions nil)
  2547. (org-agenda-buffer-name org-agenda-buffer-name)
  2548. (org-agenda-window-setup (if (equal (buffer-name)
  2549. org-agenda-buffer-name)
  2550. 'current-window
  2551. org-agenda-window-setup))
  2552. (org-agenda-custom-commands-orig org-agenda-custom-commands)
  2553. (org-agenda-custom-commands
  2554. ;; normalize different versions
  2555. (delq nil
  2556. (mapcar
  2557. (lambda (x)
  2558. (cond ((stringp (cdr x))
  2559. (push x prefix-descriptions)
  2560. nil)
  2561. ((stringp (nth 1 x)) x)
  2562. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2563. (t (cons (car x) (cons "" (cdr x))))))
  2564. org-agenda-custom-commands)))
  2565. (org-agenda-custom-commands
  2566. (org-contextualize-keys
  2567. org-agenda-custom-commands org-agenda-custom-commands-contexts))
  2568. ;; (buf (current-buffer))
  2569. (bfn (buffer-file-name (buffer-base-buffer)))
  2570. entry type org-match lprops ans) ;; key
  2571. ;; Turn off restriction unless there is an overriding one,
  2572. (unless org-agenda-overriding-restriction
  2573. (unless org-agenda-keep-restricted-file-list
  2574. ;; There is a request to keep the file list in place
  2575. (put 'org-agenda-files 'org-restrict nil))
  2576. (setq org-agenda-restrict nil)
  2577. (move-marker org-agenda-restrict-begin nil)
  2578. (move-marker org-agenda-restrict-end nil))
  2579. ;; Delete old local properties
  2580. (put 'org-agenda-redo-command 'org-lprops nil)
  2581. ;; Delete previously set last-arguments
  2582. (put 'org-agenda-redo-command 'last-args nil)
  2583. ;; Remember where this call originated
  2584. (setq org-agenda-last-dispatch-buffer (current-buffer))
  2585. (unless org-keys
  2586. (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
  2587. org-keys (car ans)
  2588. restriction (cdr ans)))
  2589. ;; If we have sticky agenda buffers, set a name for the buffer,
  2590. ;; depending on the invoking keys. The user may still set this
  2591. ;; as a command option, which will overwrite what we do here.
  2592. (when org-agenda-sticky
  2593. (setq org-agenda-buffer-name
  2594. (format "*Org Agenda(%s)*" org-keys)))
  2595. ;; Establish the restriction, if any
  2596. (when (and (not org-agenda-overriding-restriction) restriction)
  2597. (put 'org-agenda-files 'org-restrict (list bfn))
  2598. (cond
  2599. ((eq restriction 'region)
  2600. (setq org-agenda-restrict (current-buffer))
  2601. (move-marker org-agenda-restrict-begin (region-beginning))
  2602. (move-marker org-agenda-restrict-end (region-end)))
  2603. ((eq restriction 'subtree)
  2604. (save-excursion
  2605. (setq org-agenda-restrict (current-buffer))
  2606. (org-back-to-heading t)
  2607. (move-marker org-agenda-restrict-begin (point))
  2608. (move-marker org-agenda-restrict-end
  2609. (progn (org-end-of-subtree t)))))
  2610. ((and (eq restriction 'buffer)
  2611. (or (< 1 (point-min))
  2612. (< (point-max) (1+ (buffer-size)))))
  2613. (setq org-agenda-restrict (current-buffer))
  2614. (move-marker org-agenda-restrict-begin (point-min))
  2615. (move-marker org-agenda-restrict-end (point-max)))))
  2616. ;; For example the todo list should not need it (but does...)
  2617. (cond
  2618. ((setq entry (assoc org-keys org-agenda-custom-commands))
  2619. (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
  2620. (progn
  2621. ;; FIXME: Is (nth 3 entry) supposed to have access (via dynvars)
  2622. ;; to some of the local variables? There's no doc about
  2623. ;; that for `org-agenda-custom-commands'.
  2624. (setq type (nth 2 entry) org-match (eval (nth 3 entry) t)
  2625. lprops (nth 4 entry))
  2626. (when org-agenda-sticky
  2627. (setq org-agenda-buffer-name
  2628. (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
  2629. (format "*Org Agenda(%s)*" org-keys))))
  2630. (put 'org-agenda-redo-command 'org-lprops lprops)
  2631. (cl-progv
  2632. (mapcar #'car lprops)
  2633. (mapcar (lambda (binding) (eval (cadr binding) t)) lprops)
  2634. (pcase type
  2635. (`agenda
  2636. (org-agenda-list current-prefix-arg))
  2637. (`agenda*
  2638. (org-agenda-list current-prefix-arg nil nil t))
  2639. (`alltodo
  2640. (org-todo-list current-prefix-arg))
  2641. (`search
  2642. (org-search-view current-prefix-arg org-match nil))
  2643. (`stuck
  2644. (org-agenda-list-stuck-projects current-prefix-arg))
  2645. (`tags
  2646. (org-tags-view current-prefix-arg org-match))
  2647. (`tags-todo
  2648. (org-tags-view '(4) org-match))
  2649. (`todo
  2650. (org-todo-list org-match))
  2651. (`tags-tree
  2652. (org-check-for-org-mode)
  2653. (org-match-sparse-tree current-prefix-arg org-match))
  2654. (`todo-tree
  2655. (org-check-for-org-mode)
  2656. (org-occur (concat "^" org-outline-regexp "[ \t]*"
  2657. (regexp-quote org-match) "\\>")))
  2658. (`occur-tree
  2659. (org-check-for-org-mode)
  2660. (org-occur org-match))
  2661. ((pred functionp)
  2662. (funcall type org-match))
  2663. ;; FIXME: Will signal an error since it's not `functionp'!
  2664. ((pred fboundp) (funcall type org-match))
  2665. (_ (user-error "Invalid custom agenda command type %s" type)))))
  2666. (org-agenda-run-series (nth 1 entry) (cddr entry))))
  2667. ((equal org-keys "C")
  2668. (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
  2669. (customize-variable 'org-agenda-custom-commands))
  2670. ((equal org-keys "a") (call-interactively 'org-agenda-list))
  2671. ((equal org-keys "s") (call-interactively 'org-search-view))
  2672. ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
  2673. ((equal org-keys "t") (call-interactively 'org-todo-list))
  2674. ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
  2675. ((equal org-keys "m") (call-interactively 'org-tags-view))
  2676. ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
  2677. ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
  2678. ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
  2679. (add-hook
  2680. 'post-command-hook
  2681. (lambda ()
  2682. (unless (current-message)
  2683. (let* ((m (org-agenda-get-any-marker))
  2684. (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
  2685. (when note
  2686. (message "FLAGGING-NOTE ([?] for more info): %s"
  2687. (org-add-props
  2688. (replace-regexp-in-string
  2689. "\\\\n" "//"
  2690. (copy-sequence note))
  2691. nil 'face 'org-warning))))))
  2692. t t))
  2693. ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
  2694. ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
  2695. ((equal org-keys "!") (customize-variable 'org-stuck-projects))
  2696. (t (user-error "Invalid agenda key"))))))
  2697. (defvar org-agenda-multi)
  2698. (defun org-agenda-append-agenda ()
  2699. "Append another agenda view to the current one.
  2700. This function allows interactive building of block agendas.
  2701. Agenda views are separated by `org-agenda-block-separator'."
  2702. (interactive)
  2703. (unless (derived-mode-p 'org-agenda-mode)
  2704. (user-error "Can only append from within agenda buffer"))
  2705. (let ((org-agenda-multi t))
  2706. (org-agenda)
  2707. (widen)
  2708. (org-agenda-finalize)
  2709. (setq buffer-read-only t)
  2710. (org-agenda-fit-window-to-buffer)))
  2711. (defun org-agenda-normalize-custom-commands (cmds)
  2712. "Normalize custom commands CMDS."
  2713. (delq nil
  2714. (mapcar
  2715. (lambda (x)
  2716. (cond ((stringp (cdr x)) nil)
  2717. ((stringp (nth 1 x)) x)
  2718. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2719. (t (cons (car x) (cons "" (cdr x))))))
  2720. cmds)))
  2721. (defun org-agenda-get-restriction-and-command (prefix-descriptions)
  2722. "The user interface for selecting an agenda command."
  2723. (catch 'exit
  2724. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  2725. (restrict-ok (and bfn (derived-mode-p 'org-mode)))
  2726. (region-p (org-region-active-p))
  2727. (custom org-agenda-custom-commands)
  2728. (selstring "")
  2729. restriction second-time
  2730. c entry key type match prefixes rmheader header-end custom1 desc
  2731. line lines left right n n1)
  2732. (save-window-excursion
  2733. (delete-other-windows)
  2734. (org-switch-to-buffer-other-window " *Agenda Commands*")
  2735. (erase-buffer)
  2736. (insert (eval-when-compile
  2737. (let ((header
  2738. (copy-sequence
  2739. "Press key for an agenda command:
  2740. -------------------------------- < Buffer, subtree/region restriction
  2741. a Agenda for current week or day > Remove restriction
  2742. t List of all TODO entries e Export agenda views
  2743. m Match a TAGS/PROP/TODO query T Entries with special TODO kwd
  2744. s Search for keywords M Like m, but only TODO entries
  2745. / Multi-occur S Like s, but only TODO entries
  2746. ? Find :FLAGGED: entries C Configure custom agenda commands
  2747. * Toggle sticky agenda views # List stuck projects (!=configure)
  2748. "))
  2749. (start 0))
  2750. (while (string-match
  2751. "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
  2752. header start)
  2753. (setq start (match-end 0))
  2754. (add-text-properties (match-beginning 2) (match-end 2)
  2755. '(face bold) header))
  2756. header)))
  2757. (setq header-end (point-marker))
  2758. (while t
  2759. (setq custom1 custom)
  2760. (when (eq rmheader t)
  2761. (org-goto-line 1)
  2762. (re-search-forward ":" nil t)
  2763. (delete-region (match-end 0) (point-at-eol))
  2764. (forward-char 1)
  2765. (looking-at "-+")
  2766. (delete-region (match-end 0) (point-at-eol))
  2767. (move-marker header-end (match-end 0)))
  2768. (goto-char header-end)
  2769. (delete-region (point) (point-max))
  2770. ;; Produce all the lines that describe custom commands and prefixes
  2771. (setq lines nil)
  2772. (while (setq entry (pop custom1))
  2773. (setq key (car entry) desc (nth 1 entry)
  2774. type (nth 2 entry)
  2775. match (nth 3 entry))
  2776. (if (> (length key) 1)
  2777. (cl-pushnew (string-to-char key) prefixes :test #'equal)
  2778. (setq line
  2779. (format
  2780. "%-4s%-14s"
  2781. (org-add-props (copy-sequence key)
  2782. '(face bold))
  2783. (cond
  2784. ((string-match "\\S-" desc) desc)
  2785. ((eq type 'agenda) "Agenda for current week or day")
  2786. ((eq type 'agenda*) "Appointments for current week or day")
  2787. ((eq type 'alltodo) "List of all TODO entries")
  2788. ((eq type 'search) "Word search")
  2789. ((eq type 'stuck) "List of stuck projects")
  2790. ((eq type 'todo) "TODO keyword")
  2791. ((eq type 'tags) "Tags query")
  2792. ((eq type 'tags-todo) "Tags (TODO)")
  2793. ((eq type 'tags-tree) "Tags tree")
  2794. ((eq type 'todo-tree) "TODO kwd tree")
  2795. ((eq type 'occur-tree) "Occur tree")
  2796. ((functionp type) (if (symbolp type)
  2797. (symbol-name type)
  2798. "Lambda expression"))
  2799. (t "???"))))
  2800. (cond
  2801. ((not (org-string-nw-p match)) nil)
  2802. (org-agenda-menu-show-matcher
  2803. (setq line
  2804. (concat line ": "
  2805. (cond
  2806. ((stringp match)
  2807. (propertize match 'face 'org-warning))
  2808. ((listp type)
  2809. (format "set of %d commands" (length type)))))))
  2810. (t
  2811. (org-add-props line nil 'help-echo (concat "Matcher: " match))))
  2812. (push line lines)))
  2813. (setq lines (nreverse lines))
  2814. (when prefixes
  2815. (mapc (lambda (x)
  2816. (push
  2817. (format "%s %s"
  2818. (org-add-props (char-to-string x)
  2819. nil 'face 'bold)
  2820. (or (cdr (assoc (concat selstring
  2821. (char-to-string x))
  2822. prefix-descriptions))
  2823. "Prefix key"))
  2824. lines))
  2825. prefixes))
  2826. ;; Check if we should display in two columns
  2827. (if org-agenda-menu-two-columns
  2828. (progn
  2829. (setq n (length lines)
  2830. n1 (+ (/ n 2) (mod n 2))
  2831. right (nthcdr n1 lines)
  2832. left (copy-sequence lines))
  2833. (setcdr (nthcdr (1- n1) left) nil))
  2834. (setq left lines right nil))
  2835. (while left
  2836. (insert "\n" (pop left))
  2837. (when right
  2838. (if (< (current-column) 40)
  2839. (move-to-column 40 t)
  2840. (insert " "))
  2841. (insert (pop right))))
  2842. ;; Make the window the right size
  2843. (goto-char (point-min))
  2844. (if second-time
  2845. (when (not (pos-visible-in-window-p (point-max)))
  2846. (org-fit-window-to-buffer))
  2847. (setq second-time t)
  2848. (org-fit-window-to-buffer))
  2849. ;; Hint to navigation if window too small for all information
  2850. (setq header-line-format
  2851. (when (not (pos-visible-in-window-p (point-max)))
  2852. "Use C-v, M-v, C-n or C-p to navigate."))
  2853. ;; Ask for selection
  2854. (cl-loop
  2855. do (progn
  2856. (message "Press key for agenda command%s:"
  2857. (if (or restrict-ok org-agenda-overriding-restriction)
  2858. (if org-agenda-overriding-restriction
  2859. " (restriction lock active)"
  2860. (if restriction
  2861. (format " (restricted to %s)" restriction)
  2862. " (unrestricted)"))
  2863. ""))
  2864. (setq c (read-char-exclusive)))
  2865. until (not (memq c '(14 16 22 134217846)))
  2866. do (org-scroll c))
  2867. (message "")
  2868. (cond
  2869. ((assoc (char-to-string c) custom)
  2870. (setq selstring (concat selstring (char-to-string c)))
  2871. (throw 'exit (cons selstring restriction)))
  2872. ((memq c prefixes)
  2873. (setq selstring (concat selstring (char-to-string c))
  2874. prefixes nil
  2875. rmheader (or rmheader t)
  2876. custom (delq nil (mapcar
  2877. (lambda (x)
  2878. (if (or (= (length (car x)) 1)
  2879. (/= (string-to-char (car x)) c))
  2880. nil
  2881. (cons (substring (car x) 1) (cdr x))))
  2882. custom))))
  2883. ((eq c ?*)
  2884. (call-interactively 'org-toggle-sticky-agenda)
  2885. (sit-for 2))
  2886. ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
  2887. (message "Restriction is only possible in Org buffers")
  2888. (ding) (sit-for 1))
  2889. ((eq c ?1)
  2890. (org-agenda-remove-restriction-lock 'noupdate)
  2891. (setq restriction 'buffer))
  2892. ((eq c ?0)
  2893. (org-agenda-remove-restriction-lock 'noupdate)
  2894. (setq restriction (if region-p 'region 'subtree)))
  2895. ((eq c ?<)
  2896. (org-agenda-remove-restriction-lock 'noupdate)
  2897. (setq restriction
  2898. (cond
  2899. ((eq restriction 'buffer)
  2900. (if region-p 'region 'subtree))
  2901. ((memq restriction '(subtree region))
  2902. nil)
  2903. (t 'buffer))))
  2904. ((eq c ?>)
  2905. (org-agenda-remove-restriction-lock 'noupdate)
  2906. (setq restriction nil))
  2907. ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
  2908. (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
  2909. ((and (> (length selstring) 0) (eq c ?\d))
  2910. (delete-window)
  2911. (org-agenda-get-restriction-and-command prefix-descriptions))
  2912. ((equal c ?q) (user-error "Abort"))
  2913. (t (user-error "Invalid key %c" c))))))))
  2914. (defun org-agenda-fit-window-to-buffer ()
  2915. "Fit the window to the buffer size."
  2916. (and (memq org-agenda-window-setup '(reorganize-frame))
  2917. (fboundp 'fit-window-to-buffer)
  2918. (if (and (= (cdr org-agenda-window-frame-fractions) 1.0)
  2919. (= (car org-agenda-window-frame-fractions) 1.0))
  2920. (delete-other-windows)
  2921. (org-fit-window-to-buffer
  2922. nil
  2923. (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
  2924. (floor (* (frame-height) (car org-agenda-window-frame-fractions)))))))
  2925. (defvar org-cmd nil)
  2926. (defvar org-agenda-overriding-cmd nil)
  2927. (defvar org-agenda-overriding-arguments nil)
  2928. (defvar org-agenda-overriding-cmd-arguments nil)
  2929. (defun org-let (list &rest body) ;FIXME: So many kittens are suffering here.
  2930. (declare (indent 1) (obsolete cl-progv "2021"))
  2931. (eval (cons 'let (cons list body))))
  2932. (defun org-let2 (list1 list2 &rest body) ;FIXME: Where did our karma go?
  2933. (declare (indent 2) (obsolete cl-progv "2021"))
  2934. (eval (cons 'let (cons list1 (list (cons 'let (cons list2 body)))))))
  2935. (defun org-agenda-run-series (name series)
  2936. "Run agenda NAME as a SERIES of agenda commands."
  2937. (let* ((gprops (nth 1 series))
  2938. (gvars (mapcar #'car gprops))
  2939. (gvals (mapcar (lambda (binding) (eval (cadr binding) t)) gprops)))
  2940. (cl-progv gvars gvals (org-agenda-prepare name))
  2941. ;; We need to reset agenda markers here, because when constructing a
  2942. ;; block agenda, the individual blocks do not do that.
  2943. (org-agenda-reset-markers)
  2944. (with-no-warnings
  2945. (defvar match)) ;Used via the `eval' below.
  2946. (let* ((org-agenda-multi t)
  2947. ;; FIXME: Redo should contain lists of (FUNS . ARGS) rather
  2948. ;; than expressions, so you don't need to `quote' the args
  2949. ;; and you just need to `apply' instead of `eval' when using it.
  2950. (redo (list 'org-agenda-run-series name (list 'quote series)))
  2951. (cmds (car series))
  2952. match
  2953. org-cmd type lprops)
  2954. (while (setq org-cmd (pop cmds))
  2955. (setq type (car org-cmd))
  2956. (setq match (eval (nth 1 org-cmd) t))
  2957. (setq lprops (nth 2 org-cmd))
  2958. (let ((org-agenda-overriding-arguments
  2959. (if (eq org-agenda-overriding-cmd org-cmd)
  2960. (or org-agenda-overriding-arguments
  2961. org-agenda-overriding-cmd-arguments)))
  2962. (lvars (mapcar #'car lprops))
  2963. (lvals (mapcar (lambda (binding) (eval (cadr binding) t)) lprops)))
  2964. (cl-progv (append gvars lvars) (append gvals lvals)
  2965. (pcase type
  2966. (`agenda
  2967. (call-interactively 'org-agenda-list))
  2968. (`agenda*
  2969. (funcall 'org-agenda-list nil nil t))
  2970. (`alltodo
  2971. (call-interactively 'org-todo-list))
  2972. (`search
  2973. (org-search-view current-prefix-arg match nil))
  2974. (`stuck
  2975. (call-interactively 'org-agenda-list-stuck-projects))
  2976. (`tags
  2977. (org-tags-view current-prefix-arg match))
  2978. (`tags-todo
  2979. (org-tags-view '(4) match))
  2980. (`todo
  2981. (org-todo-list match))
  2982. ((pred fboundp)
  2983. (funcall type match))
  2984. (_ (error "Invalid type in command series"))))))
  2985. (widen)
  2986. (let ((inhibit-read-only t))
  2987. (add-text-properties (point-min) (point-max)
  2988. `(org-series t org-series-redo-cmd ,redo)))
  2989. (setq org-agenda-redo-command redo)
  2990. (goto-char (point-min)))
  2991. (org-agenda-fit-window-to-buffer)
  2992. (cl-progv gvars gvals (org-agenda-finalize))))
  2993. (defun org-agenda--split-plist (plist)
  2994. ;; We could/should arguably use `map-keys' and `map-values'.
  2995. (let (keys vals)
  2996. (while plist
  2997. (push (pop plist) keys)
  2998. (push (pop plist) vals))
  2999. (cons (nreverse keys) (nreverse vals))))
  3000. ;;;###autoload
  3001. (defmacro org-batch-agenda (cmd-key &rest parameters)
  3002. "Run an agenda command in batch mode and send the result to STDOUT.
  3003. If CMD-KEY is a string of length 1, it is used as a key in
  3004. `org-agenda-custom-commands' and triggers this command. If it is a
  3005. longer string it is used as a tags/todo match string.
  3006. Parameters are alternating variable names and values that will be bound
  3007. before running the agenda command."
  3008. (pcase-let ((`(,vars . ,exps) (org-agenda--split-plist parameters)))
  3009. `(org--batch-agenda ,cmd-key ',vars (list ,@exps))))
  3010. (defun org--batch-agenda (cmd-key vars vals)
  3011. ;; `org-batch-agenda' is a macro because every other "parameter" is
  3012. ;; a variable name rather than an expression to evaluate. Yuck!
  3013. (cl-progv vars vals
  3014. (let (org-agenda-sticky)
  3015. (if (> (length cmd-key) 1)
  3016. (org-tags-view nil cmd-key)
  3017. (org-agenda nil cmd-key))))
  3018. (set-buffer org-agenda-buffer-name)
  3019. (princ (buffer-string)))
  3020. (defvar org-agenda-info nil)
  3021. ;;;###autoload
  3022. (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
  3023. "Run an agenda command in batch mode and send the result to STDOUT.
  3024. If CMD-KEY is a string of length 1, it is used as a key in
  3025. `org-agenda-custom-commands' and triggers this command. If it is a
  3026. longer string it is used as a tags/todo match string.
  3027. Parameters are alternating variable names and values that will be bound
  3028. before running the agenda command.
  3029. The output gives a line for each selected agenda item. Each
  3030. item is a list of comma-separated values, like this:
  3031. category,head,type,todo,tags,date,time,extra,priority-l,priority-n
  3032. category The category of the item
  3033. head The headline, without TODO kwd, TAGS and PRIORITY
  3034. type The type of the agenda entry, can be
  3035. todo selected in TODO match
  3036. tagsmatch selected in tags match
  3037. diary imported from diary
  3038. deadline a deadline on given date
  3039. scheduled scheduled on given date
  3040. timestamp entry has timestamp on given date
  3041. closed entry was closed on given date
  3042. upcoming-deadline warning about deadline
  3043. past-scheduled forwarded scheduled item
  3044. block entry has date block including g. date
  3045. todo The todo keyword, if any
  3046. tags All tags including inherited ones, separated by colons
  3047. date The relevant date, like 2007-2-14
  3048. time The time, like 15:00-16:50
  3049. extra String with extra planning info
  3050. priority-l The priority letter if any was given
  3051. priority-n The computed numerical priority
  3052. agenda-day The day in the agenda where this is listed"
  3053. (pcase-let ((`(,vars . ,exps) (org-agenda--split-plist parameters)))
  3054. `(org--batch-agenda-csv ,cmd-key ',vars (list ,@exps))))
  3055. (defun org--batch-agenda-csv (cmd-key vars vals)
  3056. ;; `org-batch-agenda-csv' is a macro because every other "parameter" is
  3057. ;; a variable name rather than an expression to evaluate. Yuck!
  3058. (let ((org-agenda-remove-tags t))
  3059. (cl-progv vars vals
  3060. ;; FIXME: Shouldn't this be 1 (see commit 10173ad6d610b)?
  3061. (if (> (length cmd-key) 2)
  3062. (org-tags-view nil cmd-key)
  3063. (org-agenda nil cmd-key))))
  3064. (set-buffer org-agenda-buffer-name)
  3065. (let ((lines (org-split-string (buffer-string) "\n")))
  3066. (dolist (line lines)
  3067. (when (get-text-property 0 'org-category line)
  3068. (setq org-agenda-info
  3069. (org-fix-agenda-info (text-properties-at 0 line)))
  3070. (princ
  3071. (mapconcat #'org-agenda-export-csv-mapper
  3072. '(org-category txt type todo tags date time extra
  3073. priority-letter priority agenda-day)
  3074. ","))
  3075. (princ "\n")))))
  3076. (defun org-fix-agenda-info (props)
  3077. "Make sure all properties on an agenda item have a canonical form.
  3078. This ensures the export commands can easily use it."
  3079. (let (tmp re)
  3080. (when (setq tmp (plist-get props 'tags))
  3081. (setq props (plist-put props 'tags (mapconcat #'identity tmp ":"))))
  3082. (when (setq tmp (plist-get props 'date))
  3083. (when (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  3084. (let ((calendar-date-display-form '(year "-" month "-" day)))
  3085. '((format "%4d, %9s %2s, %4s" dayname monthname day year))
  3086. (setq tmp (calendar-date-string tmp)))
  3087. (setq props (plist-put props 'date tmp)))
  3088. (when (setq tmp (plist-get props 'day))
  3089. (when (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  3090. (let ((calendar-date-display-form '(year "-" month "-" day)))
  3091. (setq tmp (calendar-date-string tmp)))
  3092. (setq props (plist-put props 'day tmp))
  3093. (setq props (plist-put props 'agenda-day tmp)))
  3094. (when (setq tmp (plist-get props 'txt))
  3095. (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
  3096. (plist-put props 'priority-letter (match-string 1 tmp))
  3097. (setq tmp (replace-match "" t t tmp)))
  3098. (when (and (setq re (plist-get props 'org-todo-regexp))
  3099. (setq re (concat "\\`\\.*" re " ?"))
  3100. (let ((case-fold-search nil)) (string-match re tmp)))
  3101. (plist-put props 'todo (match-string 1 tmp))
  3102. (setq tmp (replace-match "" t t tmp)))
  3103. (plist-put props 'txt tmp)))
  3104. props)
  3105. (defun org-agenda-export-csv-mapper (prop)
  3106. (let ((res (plist-get org-agenda-info prop)))
  3107. (setq res
  3108. (cond
  3109. ((not res) "")
  3110. ((stringp res) res)
  3111. (t (prin1-to-string res))))
  3112. (org-trim (replace-regexp-in-string "," ";" res nil t))))
  3113. ;;;###autoload
  3114. (defun org-store-agenda-views (&rest _parameters)
  3115. "Store agenda views."
  3116. (interactive)
  3117. (org--batch-store-agenda-views nil nil))
  3118. ;;;###autoload
  3119. (defmacro org-batch-store-agenda-views (&rest parameters)
  3120. "Run all custom agenda commands that have a file argument."
  3121. (pcase-let ((`(,vars . ,exps) (org-agenda--split-plist parameters)))
  3122. `(org--batch-store-agenda-views ',vars (list ,@exps))))
  3123. (defun org--batch-store-agenda-views (vars vals)
  3124. (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
  3125. (pop-up-frames nil)
  3126. (dir default-directory)
  3127. cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
  3128. (save-window-excursion
  3129. (while cmds
  3130. (setq cmd (pop cmds)
  3131. thiscmdkey (car cmd)
  3132. thiscmdcmd (cdr cmd)
  3133. match (nth 2 thiscmdcmd)
  3134. bufname (if org-agenda-sticky
  3135. (or (and (stringp match)
  3136. (format "*Org Agenda(%s:%s)*" thiscmdkey match))
  3137. (format "*Org Agenda(%s)*" thiscmdkey))
  3138. org-agenda-buffer-name)
  3139. cmd-or-set (nth 2 cmd)
  3140. opts (nth (if (listp cmd-or-set) 3 4) cmd)
  3141. files (nth (if (listp cmd-or-set) 4 5) cmd))
  3142. (if (stringp files) (setq files (list files)))
  3143. (when files
  3144. (let* ((opts (append org-agenda-exporter-settings opts))
  3145. (vars (append (mapcar #'car opts) vars))
  3146. (vals (append (mapcar (lambda (binding) (eval (cadr binding) t))
  3147. opts)
  3148. vals)))
  3149. (cl-progv vars vals
  3150. (org-agenda nil thiscmdkey))
  3151. (set-buffer bufname)
  3152. (while files
  3153. (cl-progv vars vals
  3154. (org-agenda-write (expand-file-name (pop files) dir)
  3155. nil t bufname))))
  3156. (and (get-buffer bufname)
  3157. (kill-buffer bufname)))))))
  3158. (defvar org-agenda-current-span nil
  3159. "The current span used in the agenda view.") ; local variable in the agenda buffer
  3160. (defun org-agenda-mark-header-line (pos)
  3161. "Mark the line at POS as an agenda structure header."
  3162. (save-excursion
  3163. (goto-char pos)
  3164. (put-text-property (point-at-bol) (point-at-eol)
  3165. 'org-agenda-structural-header t)
  3166. (when org-agenda-title-append
  3167. (put-text-property (point-at-bol) (point-at-eol)
  3168. 'org-agenda-title-append org-agenda-title-append))))
  3169. (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
  3170. (defvar org-agenda-write-buffer-name "Agenda View")
  3171. (defun org-agenda-write (file &optional open nosettings agenda-bufname)
  3172. "Write the current buffer (an agenda view) as a file.
  3173. Depending on the extension of the file name, plain text (.txt),
  3174. HTML (.html or .htm), PDF (.pdf) or Postscript (.ps) is produced.
  3175. If the extension is .ics, translate visible agenda into iCalendar
  3176. format. If the extension is .org, collect all subtrees
  3177. corresponding to the agenda entries and add them in an .org file.
  3178. With prefix argument OPEN, open the new file immediately. If
  3179. NOSETTINGS is given, do not scope the settings of
  3180. `org-agenda-exporter-settings' into the export commands. This is
  3181. used when the settings have already been scoped and we do not
  3182. wish to overrule other, higher priority settings. If
  3183. AGENDA-BUFFER-NAME is provided, use this as the buffer name for
  3184. the agenda to write."
  3185. (interactive "FWrite agenda to file: \nP")
  3186. (if (or (not (file-writable-p file))
  3187. (and (file-exists-p file)
  3188. (if (called-interactively-p 'any)
  3189. (not (y-or-n-p (format "Overwrite existing file %s? " file))))))
  3190. (user-error "Cannot write agenda to file %s" file))
  3191. (cl-progv
  3192. (if nosettings nil (mapcar #'car org-agenda-exporter-settings))
  3193. (if nosettings nil (mapcar (lambda (binding) (eval (cadr binding) t))
  3194. org-agenda-exporter-settings))
  3195. (save-excursion
  3196. (save-window-excursion
  3197. (let ((bs (copy-sequence (buffer-string)))
  3198. (extension (file-name-extension file))
  3199. (default-directory (file-name-directory file))
  3200. ) ;; beg content
  3201. (with-temp-buffer
  3202. (rename-buffer org-agenda-write-buffer-name t)
  3203. (set-buffer-modified-p nil)
  3204. (insert bs)
  3205. (org-agenda-remove-marked-text 'invisible 'org-filtered)
  3206. (run-hooks 'org-agenda-before-write-hook)
  3207. (cond
  3208. ((bound-and-true-p org-mobile-creating-agendas)
  3209. (org-mobile-write-agenda-for-mobile file))
  3210. ((string= "org" extension)
  3211. (let (content p m message-log-max)
  3212. (goto-char (point-min))
  3213. (while (setq p (next-single-property-change (point) 'org-hd-marker nil))
  3214. (goto-char p)
  3215. (setq m (get-text-property (point) 'org-hd-marker))
  3216. (when m
  3217. (push (with-current-buffer (marker-buffer m)
  3218. (goto-char m)
  3219. (org-copy-subtree 1 nil t t)
  3220. org-subtree-clip)
  3221. content)))
  3222. (find-file file)
  3223. (erase-buffer)
  3224. (dolist (s content) (org-paste-subtree 1 s))
  3225. (write-file file)
  3226. (kill-buffer (current-buffer))
  3227. (message "Org file written to %s" file)))
  3228. ((member extension '("html" "htm"))
  3229. (or (require 'htmlize nil t)
  3230. (error "Please install htmlize from https://github.com/hniksic/emacs-htmlize"))
  3231. (declare-function htmlize-buffer "htmlize" (&optional buffer))
  3232. (set-buffer (htmlize-buffer (current-buffer)))
  3233. (when org-agenda-export-html-style
  3234. ;; replace <style> section with org-agenda-export-html-style
  3235. (goto-char (point-min))
  3236. (kill-region (- (search-forward "<style") 6)
  3237. (search-forward "</style>"))
  3238. (insert org-agenda-export-html-style))
  3239. (write-file file)
  3240. (kill-buffer (current-buffer))
  3241. (message "HTML written to %s" file))
  3242. ((string= "ps" extension)
  3243. (require 'ps-print)
  3244. (ps-print-buffer-with-faces file)
  3245. (message "Postscript written to %s" file))
  3246. ((string= "pdf" extension)
  3247. (require 'ps-print)
  3248. (ps-print-buffer-with-faces
  3249. (concat (file-name-sans-extension file) ".ps"))
  3250. (call-process "ps2pdf" nil nil nil
  3251. (expand-file-name
  3252. (concat (file-name-sans-extension file) ".ps"))
  3253. (expand-file-name file))
  3254. (delete-file (concat (file-name-sans-extension file) ".ps"))
  3255. (message "PDF written to %s" file))
  3256. ((string= "ics" extension)
  3257. (require 'ox-icalendar)
  3258. (declare-function org-icalendar-export-current-agenda
  3259. "ox-icalendar" (file))
  3260. (org-icalendar-export-current-agenda (expand-file-name file)))
  3261. (t
  3262. (let ((bs (buffer-string)))
  3263. (find-file file)
  3264. (erase-buffer)
  3265. (insert bs)
  3266. (save-buffer 0)
  3267. (kill-buffer (current-buffer))
  3268. (message "Plain text written to %s" file))))))))
  3269. (set-buffer (or agenda-bufname
  3270. ;; FIXME: I'm pretty sure called-interactively-p
  3271. ;; doesn't do what we want here!
  3272. (and (called-interactively-p 'any) (buffer-name))
  3273. org-agenda-buffer-name)))
  3274. (when open (org-open-file file)))
  3275. (defun org-agenda-remove-marked-text (property &optional value)
  3276. "Delete all text marked with VALUE of PROPERTY.
  3277. VALUE defaults to t."
  3278. (let (beg)
  3279. (setq value (or value t))
  3280. (while (setq beg (text-property-any (point-min) (point-max)
  3281. property value))
  3282. (delete-region
  3283. beg (or (next-single-property-change beg property)
  3284. (point-max))))))
  3285. (defun org-agenda-add-entry-text ()
  3286. "Add entry text to agenda lines.
  3287. This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
  3288. entry text following headings shown in the agenda.
  3289. Drawers will be excluded, also the line with scheduling/deadline info."
  3290. (when (and (> org-agenda-add-entry-text-maxlines 0)
  3291. (not (bound-and-true-p org-mobile-creating-agendas)))
  3292. (let (m txt)
  3293. (goto-char (point-min))
  3294. (while (not (eobp))
  3295. (if (not (setq m (org-get-at-bol 'org-hd-marker)))
  3296. (beginning-of-line 2)
  3297. (setq txt (org-agenda-get-some-entry-text
  3298. m org-agenda-add-entry-text-maxlines " > "))
  3299. (end-of-line 1)
  3300. (if (string-match "\\S-" txt)
  3301. (insert "\n" txt)
  3302. (or (eobp) (forward-char 1))))))))
  3303. (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
  3304. &rest keep)
  3305. "Extract entry text from MARKER, at most N-LINES lines.
  3306. This will ignore drawers etc, just get the text.
  3307. If INDENT is given, prefix every line with this string. If KEEP is
  3308. given, it is a list of symbols, defining stuff that should not be
  3309. removed from the entry content. Currently only `planning' is allowed here."
  3310. (let (txt drawer-re kwd-time-re ind)
  3311. (save-excursion
  3312. (with-current-buffer (marker-buffer marker)
  3313. (if (not (derived-mode-p 'org-mode))
  3314. (setq txt "")
  3315. (org-with-wide-buffer
  3316. (goto-char marker)
  3317. (end-of-line 1)
  3318. (setq txt (buffer-substring
  3319. (min (1+ (point)) (point-max))
  3320. (progn (outline-next-heading) (point)))
  3321. drawer-re org-drawer-regexp
  3322. kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
  3323. ".*\n?"))
  3324. (with-temp-buffer
  3325. (insert txt)
  3326. (when org-agenda-add-entry-text-descriptive-links
  3327. (goto-char (point-min))
  3328. (while (org-activate-links (point-max))
  3329. (goto-char (match-end 0))))
  3330. (goto-char (point-min))
  3331. (while (re-search-forward org-link-bracket-re (point-max) t)
  3332. (set-text-properties (match-beginning 0) (match-end 0)
  3333. nil))
  3334. (goto-char (point-min))
  3335. (while (re-search-forward drawer-re nil t)
  3336. (delete-region
  3337. (match-beginning 0)
  3338. (progn (re-search-forward
  3339. "^[ \t]*:END:.*\n?" nil 'move)
  3340. (point))))
  3341. (unless (member 'planning keep)
  3342. (goto-char (point-min))
  3343. (while (re-search-forward kwd-time-re nil t)
  3344. (replace-match "")))
  3345. (goto-char (point-min))
  3346. (when org-agenda-entry-text-exclude-regexps
  3347. (let ((re-list org-agenda-entry-text-exclude-regexps) re)
  3348. (while (setq re (pop re-list))
  3349. (goto-char (point-min))
  3350. (while (re-search-forward re nil t)
  3351. (replace-match "")))))
  3352. (goto-char (point-max))
  3353. (skip-chars-backward " \t\n")
  3354. (when (looking-at "[ \t\n]+\\'") (replace-match ""))
  3355. ;; find and remove min common indentation
  3356. (goto-char (point-min))
  3357. (untabify (point-min) (point-max))
  3358. (setq ind (current-indentation))
  3359. (while (not (eobp))
  3360. (unless (looking-at "[ \t]*$")
  3361. (setq ind (min ind (current-indentation))))
  3362. (beginning-of-line 2))
  3363. (goto-char (point-min))
  3364. (while (not (eobp))
  3365. (unless (looking-at "[ \t]*$")
  3366. (move-to-column ind)
  3367. (delete-region (point-at-bol) (point)))
  3368. (beginning-of-line 2))
  3369. (run-hooks 'org-agenda-entry-text-cleanup-hook)
  3370. (goto-char (point-min))
  3371. (when indent
  3372. (while (and (not (eobp)) (re-search-forward "^" nil t))
  3373. (replace-match indent t t)))
  3374. (goto-char (point-min))
  3375. (while (looking-at "[ \t]*\n") (replace-match ""))
  3376. (goto-char (point-max))
  3377. (when (> (org-current-line)
  3378. n-lines)
  3379. (org-goto-line (1+ n-lines))
  3380. (backward-char 1))
  3381. (setq txt (buffer-substring (point-min) (point))))))))
  3382. txt))
  3383. (defun org-check-for-org-mode ()
  3384. "Make sure current buffer is in Org mode. Error if not."
  3385. (or (derived-mode-p 'org-mode)
  3386. (error "Cannot execute Org agenda command on buffer in %s"
  3387. major-mode)))
  3388. ;;; Agenda prepare and finalize
  3389. (defvar org-agenda-multi nil) ; dynamically scoped
  3390. (defvar org-agenda-pre-window-conf nil)
  3391. (defvar org-agenda-columns-active nil)
  3392. (defvar org-agenda-name nil)
  3393. (defvar org-agenda-tag-filter nil)
  3394. (defvar org-agenda-category-filter nil)
  3395. (defvar org-agenda-regexp-filter nil)
  3396. (defvar org-agenda-effort-filter nil)
  3397. (defvar org-agenda-top-headline-filter nil)
  3398. (defvar org-agenda-represented-categories nil
  3399. "Cache for the list of all categories in the agenda.")
  3400. (defvar org-agenda-represented-tags nil
  3401. "Cache for the list of all categories in the agenda.")
  3402. (defvar org-agenda-tag-filter-preset nil
  3403. "A preset of the tags filter used for secondary agenda filtering.
  3404. This must be a list of strings, each string must be a single tag preceded
  3405. by \"+\" or \"-\".
  3406. This variable should not be set directly, but agenda custom commands can
  3407. bind it in the options section. The preset filter is a global property of
  3408. the entire agenda view. In a block agenda, it will not work reliably to
  3409. define a filter for one of the individual blocks. You need to set it in
  3410. the global options and expect it to be applied to the entire view.")
  3411. (defconst org-agenda-filter-variables
  3412. '((category . org-agenda-category-filter)
  3413. (tag . org-agenda-tag-filter)
  3414. (effort . org-agenda-effort-filter)
  3415. (regexp . org-agenda-regexp-filter))
  3416. "Alist of filter types and associated variables.")
  3417. (defun org-agenda-filter-any ()
  3418. "Is any filter active?"
  3419. (cl-some (lambda (x)
  3420. (or (symbol-value (cdr x))
  3421. (get :preset-filter x)))
  3422. org-agenda-filter-variables))
  3423. (defvar org-agenda-category-filter-preset nil
  3424. "A preset of the category filter used for secondary agenda filtering.
  3425. This must be a list of strings, each string must be a single category
  3426. preceded by \"+\" or \"-\".
  3427. This variable should not be set directly, but agenda custom commands can
  3428. bind it in the options section. The preset filter is a global property of
  3429. the entire agenda view. In a block agenda, it will not work reliably to
  3430. define a filter for one of the individual blocks. You need to set it in
  3431. the global options and expect it to be applied to the entire view.")
  3432. (defvar org-agenda-regexp-filter-preset nil
  3433. "A preset of the regexp filter used for secondary agenda filtering.
  3434. This must be a list of strings, each string must be a single regexp
  3435. preceded by \"+\" or \"-\".
  3436. This variable should not be set directly, but agenda custom commands can
  3437. bind it in the options section. The preset filter is a global property of
  3438. the entire agenda view. In a block agenda, it will not work reliably to
  3439. define a filter for one of the individual blocks. You need to set it in
  3440. the global options and expect it to be applied to the entire view.")
  3441. (defvar org-agenda-effort-filter-preset nil
  3442. "A preset of the effort condition used for secondary agenda filtering.
  3443. This must be a list of strings, each string must be a single regexp
  3444. preceded by \"+\" or \"-\".
  3445. This variable should not be set directly, but agenda custom commands can
  3446. bind it in the options section. The preset filter is a global property of
  3447. the entire agenda view. In a block agenda, it will not work reliably to
  3448. define a filter for one of the individual blocks. You need to set it in
  3449. the global options and expect it to be applied to the entire view.")
  3450. (defun org-agenda-use-sticky-p ()
  3451. "Return non-nil if an agenda buffer named
  3452. `org-agenda-buffer-name' exists and should be shown instead of
  3453. generating a new one."
  3454. (and
  3455. ;; turned off by user
  3456. org-agenda-sticky
  3457. ;; For multi-agenda buffer already exists
  3458. (not org-agenda-multi)
  3459. ;; buffer found
  3460. (get-buffer org-agenda-buffer-name)
  3461. ;; C-u parameter is same as last call
  3462. (with-current-buffer (get-buffer org-agenda-buffer-name)
  3463. (and
  3464. (equal current-prefix-arg
  3465. org-agenda-last-prefix-arg)
  3466. ;; In case user turned stickiness on, while having existing
  3467. ;; Agenda buffer active, don't reuse that buffer, because it
  3468. ;; does not have org variables local
  3469. org-agenda-this-buffer-is-sticky))))
  3470. (defvar org-agenda-buffer-tmp-name nil)
  3471. (defun org-agenda--get-buffer-name (sticky-name)
  3472. (or org-agenda-buffer-tmp-name
  3473. (and org-agenda-doing-sticky-redo org-agenda-buffer-name)
  3474. sticky-name
  3475. "*Org Agenda*"))
  3476. (defun org-agenda-prepare-window (abuf filter-alist)
  3477. "Setup agenda buffer in the window.
  3478. ABUF is the buffer for the agenda window.
  3479. FILTER-ALIST is an alist of filters we need to apply when
  3480. `org-agenda-persistent-filter' is non-nil."
  3481. (let* ((awin (get-buffer-window abuf)) wconf)
  3482. (cond
  3483. ((equal (current-buffer) abuf) nil)
  3484. (awin (select-window awin))
  3485. ((not (setq wconf (current-window-configuration))))
  3486. ((eq org-agenda-window-setup 'current-window)
  3487. (pop-to-buffer-same-window abuf))
  3488. ((eq org-agenda-window-setup 'other-window)
  3489. (org-switch-to-buffer-other-window abuf))
  3490. ((eq org-agenda-window-setup 'other-frame)
  3491. (switch-to-buffer-other-frame abuf))
  3492. ((eq org-agenda-window-setup 'other-tab)
  3493. (if (fboundp 'switch-to-buffer-other-tab)
  3494. (switch-to-buffer-other-tab abuf)
  3495. (user-error "Your version of Emacs does not have tab bar support")))
  3496. ((eq org-agenda-window-setup 'only-window)
  3497. (delete-other-windows)
  3498. (pop-to-buffer-same-window abuf))
  3499. ((eq org-agenda-window-setup 'reorganize-frame)
  3500. (delete-other-windows)
  3501. (org-switch-to-buffer-other-window abuf)))
  3502. (setq org-agenda-tag-filter (cdr (assq 'tag filter-alist)))
  3503. (setq org-agenda-category-filter (cdr (assq 'cat filter-alist)))
  3504. (setq org-agenda-effort-filter (cdr (assq 'effort filter-alist)))
  3505. (setq org-agenda-regexp-filter (cdr (assq 're filter-alist)))
  3506. ;; Additional test in case agenda is invoked from within agenda
  3507. ;; buffer via elisp link.
  3508. (unless (equal (current-buffer) abuf)
  3509. (pop-to-buffer-same-window abuf))
  3510. (setq org-agenda-pre-window-conf
  3511. (or wconf org-agenda-pre-window-conf))))
  3512. (defun org-agenda-prepare (&optional name)
  3513. (let ((filter-alist (when org-agenda-persistent-filter
  3514. (with-current-buffer
  3515. (get-buffer-create org-agenda-buffer-name)
  3516. `((tag . ,org-agenda-tag-filter)
  3517. (re . ,org-agenda-regexp-filter)
  3518. (effort . ,org-agenda-effort-filter)
  3519. (cat . ,org-agenda-category-filter))))))
  3520. (if (org-agenda-use-sticky-p)
  3521. (progn
  3522. (put 'org-agenda-tag-filter :preset-filter nil)
  3523. (put 'org-agenda-category-filter :preset-filter nil)
  3524. (put 'org-agenda-regexp-filter :preset-filter nil)
  3525. (put 'org-agenda-effort-filter :preset-filter nil)
  3526. ;; Popup existing buffer
  3527. (org-agenda-prepare-window (get-buffer org-agenda-buffer-name)
  3528. filter-alist)
  3529. (message "Sticky Agenda buffer, use `r' to refresh")
  3530. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3531. (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
  3532. (setq org-todo-keywords-for-agenda nil)
  3533. (put 'org-agenda-tag-filter :preset-filter
  3534. org-agenda-tag-filter-preset)
  3535. (put 'org-agenda-category-filter :preset-filter
  3536. org-agenda-category-filter-preset)
  3537. (put 'org-agenda-regexp-filter :preset-filter
  3538. org-agenda-regexp-filter-preset)
  3539. (put 'org-agenda-effort-filter :preset-filter
  3540. org-agenda-effort-filter-preset)
  3541. (if org-agenda-multi
  3542. (progn
  3543. (setq buffer-read-only nil)
  3544. (goto-char (point-max))
  3545. (unless (or (bobp) org-agenda-compact-blocks
  3546. (not org-agenda-block-separator))
  3547. (insert "\n"
  3548. (if (stringp org-agenda-block-separator)
  3549. org-agenda-block-separator
  3550. (make-string (window-width) org-agenda-block-separator))
  3551. "\n"))
  3552. (narrow-to-region (point) (point-max)))
  3553. (setq org-done-keywords-for-agenda nil)
  3554. ;; Setting any org variables that are in org-agenda-local-vars
  3555. ;; list need to be done after the prepare call
  3556. (org-agenda-prepare-window
  3557. (get-buffer-create org-agenda-buffer-name) filter-alist)
  3558. (setq buffer-read-only nil)
  3559. (org-agenda-reset-markers)
  3560. (let ((inhibit-read-only t)) (erase-buffer))
  3561. (org-agenda-mode)
  3562. (setq org-agenda-buffer (current-buffer))
  3563. (setq org-agenda-contributing-files nil)
  3564. (setq org-agenda-columns-active nil)
  3565. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  3566. (setq org-todo-keywords-for-agenda
  3567. (org-uniquify org-todo-keywords-for-agenda))
  3568. (setq org-done-keywords-for-agenda
  3569. (org-uniquify org-done-keywords-for-agenda))
  3570. (setq org-agenda-last-prefix-arg current-prefix-arg)
  3571. (setq org-agenda-this-buffer-name org-agenda-buffer-name)
  3572. (and name (not org-agenda-name)
  3573. (setq-local org-agenda-name name)))
  3574. (setq buffer-read-only nil))))
  3575. (defvar org-overriding-columns-format)
  3576. (defvar org-local-columns-format)
  3577. (defun org-agenda-finalize ()
  3578. "Finishing touch for the agenda buffer.
  3579. This function is called just before displaying the agenda. If
  3580. you want to add your own functions to the finalization of the
  3581. agenda display, configure `org-agenda-finalize-hook'."
  3582. (unless org-agenda-multi
  3583. (let ((inhibit-read-only t))
  3584. (save-excursion
  3585. (goto-char (point-min))
  3586. (save-excursion
  3587. (while (org-activate-links (point-max))
  3588. (goto-char (match-end 0))))
  3589. (unless (eq org-agenda-remove-tags t)
  3590. (org-agenda-align-tags))
  3591. (unless org-agenda-with-colors
  3592. (remove-text-properties (point-min) (point-max) '(face nil)))
  3593. (when (bound-and-true-p org-overriding-columns-format)
  3594. (setq-local org-local-columns-format
  3595. org-overriding-columns-format))
  3596. (when org-agenda-view-columns-initially
  3597. (org-agenda-columns))
  3598. (when org-agenda-fontify-priorities
  3599. (org-agenda-fontify-priorities))
  3600. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  3601. (org-agenda-dim-blocked-tasks))
  3602. (org-agenda-mark-clocking-task)
  3603. (when org-agenda-entry-text-mode
  3604. (org-agenda-entry-text-hide)
  3605. (org-agenda-entry-text-show))
  3606. (when (and (featurep 'org-habit)
  3607. (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
  3608. (org-habit-insert-consistency-graphs))
  3609. (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
  3610. (unless (or (eq org-agenda-show-inherited-tags 'always)
  3611. (and (listp org-agenda-show-inherited-tags)
  3612. (memq org-agenda-type org-agenda-show-inherited-tags))
  3613. (and (eq org-agenda-show-inherited-tags t)
  3614. (or (eq org-agenda-use-tag-inheritance t)
  3615. (and (listp org-agenda-use-tag-inheritance)
  3616. (not (memq org-agenda-type
  3617. org-agenda-use-tag-inheritance))))))
  3618. (let (mrk)
  3619. (save-excursion
  3620. (goto-char (point-min))
  3621. (while (equal (forward-line) 0)
  3622. (when (setq mrk (get-text-property (point) 'org-hd-marker))
  3623. (put-text-property (point-at-bol) (point-at-eol)
  3624. 'tags
  3625. (org-with-point-at mrk
  3626. (org-get-tags))))))))
  3627. (setq org-agenda-represented-tags nil
  3628. org-agenda-represented-categories nil)
  3629. (when org-agenda-top-headline-filter
  3630. (org-agenda-filter-top-headline-apply
  3631. org-agenda-top-headline-filter))
  3632. (when org-agenda-tag-filter
  3633. (org-agenda-filter-apply org-agenda-tag-filter 'tag t))
  3634. (when (get 'org-agenda-tag-filter :preset-filter)
  3635. (org-agenda-filter-apply
  3636. (get 'org-agenda-tag-filter :preset-filter) 'tag t))
  3637. (when org-agenda-category-filter
  3638. (org-agenda-filter-apply org-agenda-category-filter 'category))
  3639. (when (get 'org-agenda-category-filter :preset-filter)
  3640. (org-agenda-filter-apply
  3641. (get 'org-agenda-category-filter :preset-filter) 'category))
  3642. (when org-agenda-regexp-filter
  3643. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
  3644. (when (get 'org-agenda-regexp-filter :preset-filter)
  3645. (org-agenda-filter-apply
  3646. (get 'org-agenda-regexp-filter :preset-filter) 'regexp))
  3647. (when org-agenda-effort-filter
  3648. (org-agenda-filter-apply org-agenda-effort-filter 'effort))
  3649. (when (get 'org-agenda-effort-filter :preset-filter)
  3650. (org-agenda-filter-apply
  3651. (get 'org-agenda-effort-filter :preset-filter) 'effort))
  3652. (add-hook 'kill-buffer-hook #'org-agenda-reset-markers 'append 'local))
  3653. (run-hooks 'org-agenda-finalize-hook))))
  3654. (defun org-agenda-mark-clocking-task ()
  3655. "Mark the current clock entry in the agenda if it is present."
  3656. ;; We need to widen when `org-agenda-finalize' is called from
  3657. ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in').
  3658. (when (bound-and-true-p org-clock-current-task)
  3659. (save-restriction
  3660. (widen)
  3661. (org-agenda-unmark-clocking-task)
  3662. (when (marker-buffer org-clock-hd-marker)
  3663. (save-excursion
  3664. (goto-char (point-min))
  3665. (let (s ov)
  3666. (while (setq s (next-single-property-change (point) 'org-hd-marker))
  3667. (goto-char s)
  3668. (when (equal (org-get-at-bol 'org-hd-marker)
  3669. org-clock-hd-marker)
  3670. (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
  3671. (overlay-put ov 'type 'org-agenda-clocking)
  3672. (overlay-put ov 'face 'org-agenda-clocking)
  3673. (overlay-put ov 'help-echo
  3674. "The clock is running in this item")))))))))
  3675. (defun org-agenda-unmark-clocking-task ()
  3676. "Unmark the current clocking task."
  3677. (mapc (lambda (o)
  3678. (when (eq (overlay-get o 'type) 'org-agenda-clocking)
  3679. (delete-overlay o)))
  3680. (overlays-in (point-min) (point-max))))
  3681. (defun org-agenda-fontify-priorities ()
  3682. "Make highest priority lines bold, and lowest italic."
  3683. (interactive)
  3684. (mapc (lambda (o) (when (eq (overlay-get o 'org-type) 'org-priority)
  3685. (delete-overlay o)))
  3686. (overlays-in (point-min) (point-max)))
  3687. (save-excursion
  3688. (let (b e p ov h l)
  3689. (goto-char (point-min))
  3690. (while (re-search-forward org-priority-regexp nil t)
  3691. (setq h (or (get-char-property (point) 'org-priority-highest)
  3692. org-priority-highest)
  3693. l (or (get-char-property (point) 'org-priority-lowest)
  3694. org-priority-lowest)
  3695. p (string-to-char (match-string 2))
  3696. b (match-beginning 1)
  3697. e (if (eq org-agenda-fontify-priorities 'cookies)
  3698. (1+ (match-end 2))
  3699. (point-at-eol))
  3700. ov (make-overlay b e))
  3701. (overlay-put
  3702. ov 'face
  3703. (let ((special-face
  3704. (cond ((org-face-from-face-or-color
  3705. 'priority 'org-priority
  3706. (cdr (assoc p org-priority-faces))))
  3707. ((and (listp org-agenda-fontify-priorities)
  3708. (org-face-from-face-or-color
  3709. 'priority 'org-priority
  3710. (cdr (assoc p org-agenda-fontify-priorities)))))
  3711. ((equal p l) 'italic)
  3712. ((equal p h) 'bold))))
  3713. (if special-face (list special-face 'org-priority) 'org-priority)))
  3714. (overlay-put ov 'org-type 'org-priority)))))
  3715. (defvar org-depend-tag-blocked)
  3716. (defun org-agenda-dim-blocked-tasks (&optional _invisible)
  3717. "Dim currently blocked TODOs in the agenda display.
  3718. When INVISIBLE is non-nil, hide currently blocked TODO instead of
  3719. dimming them." ;FIXME: The arg isn't used, actually!
  3720. (interactive "P")
  3721. (when (called-interactively-p 'interactive)
  3722. (message "Dim or hide blocked tasks..."))
  3723. (dolist (o (overlays-in (point-min) (point-max)))
  3724. (when (eq (overlay-get o 'face) 'org-agenda-dimmed-todo-face)
  3725. (delete-overlay o)))
  3726. (save-excursion
  3727. (let ((inhibit-read-only t))
  3728. (goto-char (point-min))
  3729. (while (let ((pos (text-property-not-all
  3730. (point) (point-max) 'org-todo-blocked nil)))
  3731. (when pos (goto-char pos)))
  3732. (let* ((invisible
  3733. (eq (org-get-at-bol 'org-todo-blocked) 'invisible))
  3734. (todo-blocked
  3735. (eq (org-get-at-bol 'org-filter-type) 'todo-blocked))
  3736. (ov (make-overlay (if invisible
  3737. (line-end-position 0)
  3738. (line-beginning-position))
  3739. (line-end-position))))
  3740. (when todo-blocked
  3741. (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
  3742. (when invisible
  3743. (org-agenda-filter-hide-line 'todo-blocked)))
  3744. (if (= (point-max) (line-end-position))
  3745. (goto-char (point-max))
  3746. (move-beginning-of-line 2)))))
  3747. (when (called-interactively-p 'interactive)
  3748. (message "Dim or hide blocked tasks...done")))
  3749. (defun org-agenda--mark-blocked-entry (entry)
  3750. "If ENTRY is blocked, mark it for fontification or invisibility.
  3751. If the header at `org-hd-marker' is blocked according to
  3752. `org-entry-blocked-p', then if `org-agenda-dim-blocked-tasks' is
  3753. 'invisible and the header is not blocked by checkboxes, set the
  3754. text property `org-todo-blocked' to `invisible', otherwise set it
  3755. to t."
  3756. (when (get-text-property 0 'todo-state entry)
  3757. (let ((entry-marker (get-text-property 0 'org-hd-marker entry))
  3758. (org-blocked-by-checkboxes nil)
  3759. ;; Necessary so that `org-entry-blocked-p' does not change
  3760. ;; the buffer.
  3761. (org-depend-tag-blocked nil))
  3762. (when entry-marker
  3763. (let ((blocked
  3764. (with-current-buffer (marker-buffer entry-marker)
  3765. (save-excursion
  3766. (goto-char entry-marker)
  3767. (org-entry-blocked-p)))))
  3768. (when blocked
  3769. (let ((really-invisible
  3770. (and (not org-blocked-by-checkboxes)
  3771. (eq org-agenda-dim-blocked-tasks 'invisible))))
  3772. (put-text-property
  3773. 0 (length entry) 'org-todo-blocked
  3774. (if really-invisible 'invisible t)
  3775. entry)
  3776. (put-text-property
  3777. 0 (length entry) 'org-filter-type 'todo-blocked entry)))))))
  3778. entry)
  3779. (defvar org-agenda-skip-function nil
  3780. "Function to be called at each match during agenda construction.
  3781. If this function returns nil, the current match should not be skipped.
  3782. Otherwise, the function must return a position from where the search
  3783. should be continued.
  3784. This may also be a Lisp form, it will be evaluated.
  3785. Never set this variable using `setq' or so, because then it will apply
  3786. to all future agenda commands. If you do want a global skipping condition,
  3787. use the option `org-agenda-skip-function-global' instead.
  3788. The correct usage for `org-agenda-skip-function' is to bind it with
  3789. `let' to scope it dynamically into the agenda-constructing command.
  3790. A good way to set it is through options in `org-agenda-custom-commands'.")
  3791. (defun org-agenda-skip ()
  3792. "Throw to `:skip' in places that should be skipped.
  3793. Also moves point to the end of the skipped region, so that search can
  3794. continue from there."
  3795. (let ((p (point-at-bol)) to)
  3796. (when (or
  3797. (save-excursion (goto-char p) (looking-at comment-start-skip))
  3798. (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
  3799. (or (and (get-text-property p :org-archived)
  3800. (org-end-of-subtree t))
  3801. (and (member org-archive-tag org-file-tags)
  3802. (goto-char (point-max)))))
  3803. (and org-agenda-skip-comment-trees
  3804. (get-text-property p :org-comment)
  3805. (org-end-of-subtree t))
  3806. (and (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
  3807. (org-agenda-skip-eval org-agenda-skip-function)))
  3808. (goto-char to))
  3809. (org-in-src-block-p t))
  3810. (throw :skip t))))
  3811. (defun org-agenda-skip-eval (form)
  3812. "If FORM is a function or a list, call (or eval) it and return the result.
  3813. `save-excursion' and `save-match-data' are wrapped around the call, so point
  3814. and match data are returned to the previous state no matter what these
  3815. functions do."
  3816. (let (fp)
  3817. (and form
  3818. (or (setq fp (functionp form))
  3819. (consp form))
  3820. (save-excursion
  3821. (save-match-data
  3822. (if fp
  3823. (funcall form)
  3824. (eval form t)))))))
  3825. (defvar org-agenda-markers nil
  3826. "List of all currently active markers created by `org-agenda'.")
  3827. (defvar org-agenda-last-marker-time (float-time)
  3828. "Creation time of the last agenda marker.")
  3829. (defun org-agenda-new-marker (&optional pos)
  3830. "Return a new agenda marker.
  3831. Marker is at point, or at POS if non-nil. Org mode keeps a list
  3832. of these markers and resets them when they are no longer in use."
  3833. (let ((m (copy-marker (or pos (point)) t)))
  3834. (setq org-agenda-last-marker-time (float-time))
  3835. (if org-agenda-buffer
  3836. (with-current-buffer org-agenda-buffer
  3837. (push m org-agenda-markers))
  3838. (push m org-agenda-markers))
  3839. m))
  3840. (defun org-agenda-reset-markers ()
  3841. "Reset markers created by `org-agenda'."
  3842. (while org-agenda-markers
  3843. (move-marker (pop org-agenda-markers) nil)))
  3844. (defun org-agenda-save-markers-for-cut-and-paste (beg end)
  3845. "Save relative positions of markers in region.
  3846. This check for agenda markers in all agenda buffers currently active."
  3847. (dolist (buf (buffer-list))
  3848. (with-current-buffer buf
  3849. (when (eq major-mode 'org-agenda-mode)
  3850. (mapc (lambda (m) (org-check-and-save-marker m beg end))
  3851. org-agenda-markers)))))
  3852. ;;; Entry text mode
  3853. (defun org-agenda-entry-text-show-here ()
  3854. "Add some text from the entry as context to the current line."
  3855. (let (m txt o)
  3856. (setq m (org-get-at-bol 'org-hd-marker))
  3857. (unless (marker-buffer m)
  3858. (error "No marker points to an entry here"))
  3859. (setq txt (concat "\n" (org-no-properties
  3860. (org-agenda-get-some-entry-text
  3861. m org-agenda-entry-text-maxlines
  3862. org-agenda-entry-text-leaders))))
  3863. (when (string-match "\\S-" txt)
  3864. (setq o (make-overlay (point-at-bol) (point-at-eol)))
  3865. (overlay-put o 'evaporate t)
  3866. (overlay-put o 'org-overlay-type 'agenda-entry-content)
  3867. (overlay-put o 'after-string txt))))
  3868. (defun org-agenda-entry-text-show ()
  3869. "Add entry context for all agenda lines."
  3870. (interactive)
  3871. (save-excursion
  3872. (goto-char (point-max))
  3873. (beginning-of-line 1)
  3874. (while (not (bobp))
  3875. (when (org-get-at-bol 'org-hd-marker)
  3876. (org-agenda-entry-text-show-here))
  3877. (beginning-of-line 0))))
  3878. (defun org-agenda-entry-text-hide ()
  3879. "Remove any shown entry context."
  3880. (mapc (lambda (o)
  3881. (when (eq (overlay-get o 'org-overlay-type)
  3882. 'agenda-entry-content)
  3883. (delete-overlay o)))
  3884. (overlays-in (point-min) (point-max))))
  3885. (defun org-agenda-get-day-face (date)
  3886. "Return the face DATE should be displayed with."
  3887. (cond ((and (functionp org-agenda-day-face-function)
  3888. (funcall org-agenda-day-face-function date)))
  3889. ((and (org-agenda-today-p date)
  3890. (memq (calendar-day-of-week date) org-agenda-weekend-days))
  3891. 'org-agenda-date-weekend-today)
  3892. ((org-agenda-today-p date) 'org-agenda-date-today)
  3893. ((memq (calendar-day-of-week date) org-agenda-weekend-days)
  3894. 'org-agenda-date-weekend)
  3895. (t 'org-agenda-date)))
  3896. (defvar org-agenda-show-log-scoped)
  3897. ;;; Agenda Daily/Weekly
  3898. (defvar org-agenda-start-day nil ; dynamically scoped parameter
  3899. "Start day for the agenda view.
  3900. Custom commands can set this variable in the options section.
  3901. This is usually a string like \"2007-11-01\", \"+2d\" or any other
  3902. input allowed when reading a date through the Org calendar.
  3903. See the docstring of `org-read-date' for details.")
  3904. (defvar org-starting-day nil) ; local variable in the agenda buffer
  3905. (defvar org-arg-loc nil) ; local variable
  3906. ;;;###autoload
  3907. (defun org-agenda-list (&optional arg start-day span with-hour)
  3908. "Produce a daily/weekly view from all files in variable `org-agenda-files'.
  3909. The view will be for the current day or week, but from the overview buffer
  3910. you will be able to go to other days/weeks.
  3911. With a numeric prefix argument in an interactive call, the agenda will
  3912. span ARG days. Lisp programs should instead specify SPAN to change
  3913. the number of days. SPAN defaults to `org-agenda-span'.
  3914. START-DAY defaults to TODAY, or to the most recent match for the weekday
  3915. given in `org-agenda-start-on-weekday'.
  3916. When WITH-HOUR is non-nil, only include scheduled and deadline
  3917. items if they have an hour specification like [h]h:mm."
  3918. (interactive "P")
  3919. (when org-agenda-overriding-arguments
  3920. (setq arg (car org-agenda-overriding-arguments)
  3921. start-day (nth 1 org-agenda-overriding-arguments)
  3922. span (nth 2 org-agenda-overriding-arguments)))
  3923. (when (and (integerp arg) (> arg 0))
  3924. (setq span arg arg nil))
  3925. (when (numberp span)
  3926. (unless (< 0 span)
  3927. (user-error "Agenda creation impossible for this span(=%d days)" span)))
  3928. (catch 'exit
  3929. (setq org-agenda-buffer-name
  3930. (org-agenda--get-buffer-name
  3931. (and org-agenda-sticky
  3932. (cond ((and org-keys (stringp org-match))
  3933. (format "*Org Agenda(%s:%s)*" org-keys org-match))
  3934. (org-keys
  3935. (format "*Org Agenda(%s)*" org-keys))
  3936. (t "*Org Agenda(a)*")))))
  3937. (org-agenda-prepare "Day/Week")
  3938. (setq start-day (or start-day org-agenda-start-day))
  3939. (when (stringp start-day)
  3940. ;; Convert to an absolute day number
  3941. (setq start-day (time-to-days (org-read-date nil t start-day))))
  3942. (org-compile-prefix-format 'agenda)
  3943. (org-set-sorting-strategy 'agenda)
  3944. (let* ((span (org-agenda-ndays-to-span (or span org-agenda-span)))
  3945. (today (org-today))
  3946. (sd (or start-day today))
  3947. (ndays (org-agenda-span-to-ndays span sd))
  3948. (org-agenda-start-on-weekday
  3949. (and (or (eq ndays 7) (eq ndays 14))
  3950. org-agenda-start-on-weekday))
  3951. (thefiles (org-agenda-files nil 'ifmode))
  3952. (files thefiles)
  3953. (start (if (or (null org-agenda-start-on-weekday)
  3954. (< ndays 7))
  3955. sd
  3956. (let* ((nt (calendar-day-of-week
  3957. (calendar-gregorian-from-absolute sd)))
  3958. (n1 org-agenda-start-on-weekday)
  3959. (d (- nt n1)))
  3960. (- sd (+ (if (< d 0) 7 0) d)))))
  3961. (day-numbers (list start))
  3962. (day-cnt 0)
  3963. (inhibit-redisplay (not debug-on-error))
  3964. (org-agenda-show-log-scoped org-agenda-show-log)
  3965. s rtn rtnall file date d start-pos end-pos todayp ;; e
  3966. clocktable-start clocktable-end) ;; filter
  3967. (setq org-agenda-redo-command
  3968. (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span) with-hour))
  3969. (dotimes (_ (1- ndays))
  3970. (push (1+ (car day-numbers)) day-numbers))
  3971. (setq day-numbers (nreverse day-numbers))
  3972. (setq clocktable-start (car day-numbers)
  3973. clocktable-end (1+ (or (org-last day-numbers) 0)))
  3974. (setq-local org-starting-day (car day-numbers))
  3975. (setq-local org-arg-loc arg)
  3976. (setq-local org-agenda-current-span (org-agenda-ndays-to-span span))
  3977. (unless org-agenda-compact-blocks
  3978. (let* ((d1 (car day-numbers))
  3979. (d2 (org-last day-numbers))
  3980. (w1 (org-days-to-iso-week d1))
  3981. (w2 (org-days-to-iso-week d2)))
  3982. (setq s (point))
  3983. (org-agenda--insert-overriding-header
  3984. (concat (org-agenda-span-name span)
  3985. "-agenda"
  3986. (cond ((<= 350 (- d2 d1)) "")
  3987. ((= w1 w2) (format " (W%02d)" w1))
  3988. (t (format " (W%02d-W%02d)" w1 w2)))
  3989. ":\n")))
  3990. ;; Add properties if we actually inserted a header.
  3991. (when (> (point) s)
  3992. (add-text-properties s (1- (point))
  3993. (list 'face 'org-agenda-structure
  3994. 'org-date-line t))
  3995. (org-agenda-mark-header-line s)))
  3996. (while (setq d (pop day-numbers))
  3997. (setq date (calendar-gregorian-from-absolute d)
  3998. s (point))
  3999. (if (or (setq todayp (= d today))
  4000. (and (not start-pos) (= d sd)))
  4001. (setq start-pos (point))
  4002. (when (and start-pos (not end-pos))
  4003. (setq end-pos (point))))
  4004. (setq files thefiles
  4005. rtnall nil)
  4006. (while (setq file (pop files))
  4007. (catch 'nextfile
  4008. (org-check-agenda-file file)
  4009. (let ((org-agenda-entry-types org-agenda-entry-types))
  4010. ;; Starred types override non-starred equivalents
  4011. (when (member :deadline* org-agenda-entry-types)
  4012. (setq org-agenda-entry-types
  4013. (delq :deadline org-agenda-entry-types)))
  4014. (when (member :scheduled* org-agenda-entry-types)
  4015. (setq org-agenda-entry-types
  4016. (delq :scheduled org-agenda-entry-types)))
  4017. ;; Honor with-hour
  4018. (when with-hour
  4019. (when (member :deadline org-agenda-entry-types)
  4020. (setq org-agenda-entry-types
  4021. (delq :deadline org-agenda-entry-types))
  4022. (push :deadline* org-agenda-entry-types))
  4023. (when (member :scheduled org-agenda-entry-types)
  4024. (setq org-agenda-entry-types
  4025. (delq :scheduled org-agenda-entry-types))
  4026. (push :scheduled* org-agenda-entry-types)))
  4027. (unless org-agenda-include-deadlines
  4028. (setq org-agenda-entry-types
  4029. (delq :deadline* (delq :deadline org-agenda-entry-types))))
  4030. (cond
  4031. ((memq org-agenda-show-log-scoped '(only clockcheck))
  4032. (setq rtn (org-agenda-get-day-entries
  4033. file date :closed)))
  4034. (org-agenda-show-log-scoped
  4035. (setq rtn (apply #'org-agenda-get-day-entries
  4036. file date
  4037. (append '(:closed) org-agenda-entry-types))))
  4038. (t
  4039. (setq rtn (apply #'org-agenda-get-day-entries
  4040. file date
  4041. org-agenda-entry-types)))))
  4042. (setq rtnall (append rtnall rtn)))) ;; all entries
  4043. (when org-agenda-include-diary
  4044. (let ((org-agenda-search-headline-for-time t))
  4045. (require 'diary-lib)
  4046. (setq rtn (org-get-entries-from-diary date))
  4047. (setq rtnall (append rtnall rtn))))
  4048. (when (or rtnall org-agenda-show-all-dates)
  4049. (setq day-cnt (1+ day-cnt))
  4050. (insert
  4051. (if (stringp org-agenda-format-date)
  4052. (format-time-string org-agenda-format-date
  4053. (org-time-from-absolute date))
  4054. (funcall org-agenda-format-date date))
  4055. "\n")
  4056. (put-text-property s (1- (point)) 'face
  4057. (org-agenda-get-day-face date))
  4058. (put-text-property s (1- (point)) 'org-date-line t)
  4059. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  4060. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
  4061. (when todayp
  4062. (put-text-property s (1- (point)) 'org-today t))
  4063. (setq rtnall
  4064. (org-agenda-add-time-grid-maybe rtnall ndays todayp))
  4065. (when rtnall (insert ;; all entries
  4066. (org-agenda-finalize-entries rtnall 'agenda)
  4067. "\n"))
  4068. (put-text-property s (1- (point)) 'day d)
  4069. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)))
  4070. (when (and org-agenda-clockreport-mode clocktable-start)
  4071. (let ((org-agenda-files (org-agenda-files nil 'ifmode))
  4072. ;; the above line is to ensure the restricted range!
  4073. (p (copy-sequence org-agenda-clockreport-parameter-plist))
  4074. tbl)
  4075. (setq p (org-plist-delete p :block))
  4076. (setq p (plist-put p :tstart clocktable-start))
  4077. (setq p (plist-put p :tend clocktable-end))
  4078. (setq p (plist-put p :scope 'agenda))
  4079. (setq tbl (apply #'org-clock-get-clocktable p))
  4080. (insert tbl)))
  4081. (goto-char (point-min))
  4082. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4083. (unless (or (not (get-buffer-window org-agenda-buffer-name))
  4084. (and (pos-visible-in-window-p (point-min))
  4085. (pos-visible-in-window-p (point-max))))
  4086. (goto-char (1- (point-max)))
  4087. (recenter -1)
  4088. (when (not (pos-visible-in-window-p (or start-pos 1)))
  4089. (goto-char (or start-pos 1))
  4090. (recenter 1)))
  4091. (goto-char (or start-pos 1))
  4092. (add-text-properties (point-min) (point-max)
  4093. `(org-agenda-type agenda
  4094. org-last-args (,arg ,start-day ,span)
  4095. org-redo-cmd ,org-agenda-redo-command
  4096. org-series-cmd ,org-cmd))
  4097. (when (eq org-agenda-show-log-scoped 'clockcheck)
  4098. (org-agenda-show-clocking-issues))
  4099. (org-agenda-finalize)
  4100. (setq buffer-read-only t)
  4101. (message ""))))
  4102. (defun org-agenda-ndays-to-span (n)
  4103. "Return a span symbol for a span of N days, or N if none matches."
  4104. (cond ((symbolp n) n)
  4105. ((= n 1) 'day)
  4106. ((= n 7) 'week)
  4107. ((= n 14) 'fortnight)
  4108. (t n)))
  4109. (defun org-agenda-span-to-ndays (span &optional start-day)
  4110. "Return ndays from SPAN, possibly starting at START-DAY.
  4111. START-DAY is an absolute time value."
  4112. (cond ((numberp span) span)
  4113. ((eq span 'day) 1)
  4114. ((eq span 'week) 7)
  4115. ((eq span 'fortnight) 14)
  4116. ((eq span 'month)
  4117. (let ((date (calendar-gregorian-from-absolute start-day)))
  4118. (calendar-last-day-of-month (car date) (cl-caddr date))))
  4119. ((eq span 'year)
  4120. (let ((date (calendar-gregorian-from-absolute start-day)))
  4121. (if (calendar-leap-year-p (cl-caddr date)) 366 365)))))
  4122. (defun org-agenda-span-name (span)
  4123. "Return a SPAN name."
  4124. (if (null span)
  4125. ""
  4126. (if (symbolp span)
  4127. (capitalize (symbol-name span))
  4128. (format "%d days" span))))
  4129. ;;; Agenda word search
  4130. (defvar org-agenda-search-history nil)
  4131. (defvar org-search-syntax-table nil
  4132. "Special syntax table for Org search.
  4133. In this table, we have single quotes not as word constituents, to
  4134. that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
  4135. (defvar org-mode-syntax-table) ; From org.el
  4136. (defun org-search-syntax-table ()
  4137. (unless org-search-syntax-table
  4138. (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
  4139. (modify-syntax-entry ?' "." org-search-syntax-table)
  4140. (modify-syntax-entry ?` "." org-search-syntax-table))
  4141. org-search-syntax-table)
  4142. (defvar org-agenda-last-search-view-search-was-boolean nil)
  4143. ;;;###autoload
  4144. (defun org-search-view (&optional todo-only string edit-at)
  4145. "Show all entries that contain a phrase or words or regular expressions.
  4146. With optional prefix argument TODO-ONLY, only consider entries that are
  4147. TODO entries. The argument STRING can be used to pass a default search
  4148. string into this function. If EDIT-AT is non-nil, it means that the
  4149. user should get a chance to edit this string, with cursor at position
  4150. EDIT-AT.
  4151. The search string can be viewed either as a phrase that should be found as
  4152. is, or it can be broken into a number of snippets, each of which must match
  4153. in a Boolean way to select an entry. The default depends on the variable
  4154. `org-agenda-search-view-always-boolean'.
  4155. Even if this is turned off (the default) you can always switch to
  4156. Boolean search dynamically by preceding the first word with \"+\" or \"-\".
  4157. The default is a direct search of the whole phrase, where each space in
  4158. the search string can expand to an arbitrary amount of whitespace,
  4159. including newlines.
  4160. If using a Boolean search, the search string is split on whitespace and
  4161. each snippet is searched separately, with logical AND to select an entry.
  4162. Words prefixed with a minus must *not* occur in the entry. Words without
  4163. a prefix or prefixed with a plus must occur in the entry. Matching is
  4164. case-insensitive. Words are enclosed by word delimiters (i.e. they must
  4165. match whole words, not parts of a word) if
  4166. `org-agenda-search-view-force-full-words' is set (default is nil).
  4167. Boolean search snippets enclosed by curly braces are interpreted as
  4168. regular expressions that must or (when preceded with \"-\") must not
  4169. match in the entry. Snippets enclosed into double quotes will be taken
  4170. as a whole, to include whitespace.
  4171. - If the search string starts with an asterisk, search only in headlines.
  4172. - If (possibly after the leading star) the search string starts with an
  4173. exclamation mark, this also means to look at TODO entries only, an effect
  4174. that can also be achieved with a prefix argument.
  4175. - If (possibly after star and exclamation mark) the search string starts
  4176. with a colon, this will mean that the (non-regexp) snippets of the
  4177. Boolean search must match as full words.
  4178. This command searches the agenda files, and in addition the files
  4179. listed in `org-agenda-text-search-extra-files' unless a restriction lock
  4180. is active."
  4181. (interactive "P")
  4182. (when org-agenda-overriding-arguments
  4183. (setq todo-only (car org-agenda-overriding-arguments)
  4184. string (nth 1 org-agenda-overriding-arguments)
  4185. edit-at (nth 2 org-agenda-overriding-arguments)))
  4186. (let* ((props (list 'face nil
  4187. 'done-face 'org-agenda-done
  4188. 'org-not-done-regexp org-not-done-regexp
  4189. 'org-todo-regexp org-todo-regexp
  4190. 'org-complex-heading-regexp org-complex-heading-regexp
  4191. 'mouse-face 'highlight
  4192. 'help-echo "mouse-2 or RET jump to location"))
  4193. (full-words org-agenda-search-view-force-full-words)
  4194. (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
  4195. regexp rtn rtnall files file pos inherited-tags
  4196. marker category level tags c neg re boolean
  4197. ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
  4198. (unless (and (not edit-at)
  4199. (stringp string)
  4200. (string-match "\\S-" string))
  4201. (setq string (read-string
  4202. (if org-agenda-search-view-always-boolean
  4203. "[+-]Word/{Regexp} ...: "
  4204. "Phrase or [+-]Word/{Regexp} ...: ")
  4205. (cond
  4206. ((integerp edit-at) (cons string edit-at))
  4207. (edit-at string))
  4208. 'org-agenda-search-history)))
  4209. (catch 'exit
  4210. (setq org-agenda-buffer-name
  4211. (org-agenda--get-buffer-name
  4212. (and org-agenda-sticky
  4213. (if (stringp string)
  4214. (format "*Org Agenda(%s:%s)*"
  4215. (or org-keys (or (and todo-only "S") "s"))
  4216. string)
  4217. (format "*Org Agenda(%s)*"
  4218. (or (and todo-only "S") "s"))))))
  4219. (org-agenda-prepare "SEARCH")
  4220. (org-compile-prefix-format 'search)
  4221. (org-set-sorting-strategy 'search)
  4222. (setq org-agenda-redo-command
  4223. (list 'org-search-view (if todo-only t nil)
  4224. (list 'if 'current-prefix-arg nil string)))
  4225. (setq org-agenda-query-string string)
  4226. (if (equal (string-to-char string) ?*)
  4227. (setq hdl-only t
  4228. words (substring string 1))
  4229. (setq words string))
  4230. (when (equal (string-to-char words) ?!)
  4231. (setq todo-only t
  4232. words (substring words 1)))
  4233. (when (equal (string-to-char words) ?:)
  4234. (setq full-words t
  4235. words (substring words 1)))
  4236. (when (or org-agenda-search-view-always-boolean
  4237. (member (string-to-char words) '(?- ?+ ?\{)))
  4238. (setq boolean t))
  4239. (setq words (split-string words))
  4240. (let (www w)
  4241. (while (setq w (pop words))
  4242. (while (and (string-match "\\\\\\'" w) words)
  4243. (setq w (concat (substring w 0 -1) " " (pop words))))
  4244. (push w www))
  4245. (setq words (nreverse www) www nil)
  4246. (while (setq w (pop words))
  4247. (when (and (string-match "\\`[-+]?{" w)
  4248. (not (string-match "}\\'" w)))
  4249. (while (and words (not (string-match "}\\'" (car words))))
  4250. (setq w (concat w " " (pop words))))
  4251. (setq w (concat w " " (pop words))))
  4252. (push w www))
  4253. (setq words (nreverse www)))
  4254. (setq org-agenda-last-search-view-search-was-boolean boolean)
  4255. (when boolean
  4256. (let (wds w)
  4257. (while (setq w (pop words))
  4258. (when (or (equal (substring w 0 1) "\"")
  4259. (and (> (length w) 1)
  4260. (member (substring w 0 1) '("+" "-"))
  4261. (equal (substring w 1 2) "\"")))
  4262. (while (and words (not (equal (substring w -1) "\"")))
  4263. (setq w (concat w " " (pop words)))))
  4264. (and (string-match "\\`\\([-+]?\\)\"" w)
  4265. (setq w (replace-match "\\1" nil nil w)))
  4266. (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
  4267. (push w wds))
  4268. (setq words (nreverse wds))))
  4269. (if boolean
  4270. (mapc (lambda (w)
  4271. (setq c (string-to-char w))
  4272. (if (equal c ?-)
  4273. (setq neg t w (substring w 1))
  4274. (if (equal c ?+)
  4275. (setq neg nil w (substring w 1))
  4276. (setq neg nil)))
  4277. (if (string-match "\\`{.*}\\'" w)
  4278. (setq re (substring w 1 -1))
  4279. (if full-words
  4280. (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
  4281. (setq re (regexp-quote (downcase w)))))
  4282. (if neg (push re regexps-) (push re regexps+)))
  4283. words)
  4284. (push (mapconcat #'regexp-quote words "\\s-+")
  4285. regexps+))
  4286. (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
  4287. (if (not regexps+)
  4288. (setq regexp org-outline-regexp-bol)
  4289. (setq regexp (pop regexps+))
  4290. (when hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
  4291. regexp))))
  4292. (setq files (org-agenda-files nil 'ifmode))
  4293. ;; Add `org-agenda-text-search-extra-files' unless there is some
  4294. ;; restriction.
  4295. (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
  4296. (pop org-agenda-text-search-extra-files)
  4297. (unless (get 'org-agenda-files 'org-restrict)
  4298. (setq files (org-add-archive-files files))))
  4299. ;; Uniquify files. However, let `org-check-agenda-file' handle
  4300. ;; non-existent ones.
  4301. (setq files (cl-remove-duplicates
  4302. (append files org-agenda-text-search-extra-files)
  4303. :test (lambda (a b)
  4304. (and (file-exists-p a)
  4305. (file-exists-p b)
  4306. (file-equal-p a b))))
  4307. rtnall nil)
  4308. (while (setq file (pop files))
  4309. (setq ee nil)
  4310. (catch 'nextfile
  4311. (org-check-agenda-file file)
  4312. (setq buffer (if (file-exists-p file)
  4313. (org-get-agenda-file-buffer file)
  4314. (error "No such file %s" file)))
  4315. (unless buffer
  4316. ;; If file does not exist, make sure an error message is sent
  4317. (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
  4318. file))))
  4319. (with-current-buffer buffer
  4320. (with-syntax-table (org-search-syntax-table)
  4321. (unless (derived-mode-p 'org-mode)
  4322. (error "Agenda file %s is not in Org mode" file))
  4323. (let ((case-fold-search t))
  4324. (save-excursion
  4325. (save-restriction
  4326. (if (eq buffer org-agenda-restrict)
  4327. (narrow-to-region org-agenda-restrict-begin
  4328. org-agenda-restrict-end)
  4329. (widen))
  4330. (goto-char (point-min))
  4331. (unless (or (org-at-heading-p)
  4332. (outline-next-heading))
  4333. (throw 'nextfile t))
  4334. (goto-char (max (point-min) (1- (point))))
  4335. (while (re-search-forward regexp nil t)
  4336. (org-back-to-heading t)
  4337. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4338. (> (org-reduced-level (org-outline-level))
  4339. org-agenda-search-view-max-outline-level)
  4340. (forward-line -1)
  4341. (org-back-to-heading t)))
  4342. (skip-chars-forward "* ")
  4343. (setq beg (point-at-bol)
  4344. beg1 (point)
  4345. end (progn
  4346. (outline-next-heading)
  4347. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4348. (> (org-reduced-level (org-outline-level))
  4349. org-agenda-search-view-max-outline-level)
  4350. (forward-line 1)
  4351. (outline-next-heading)))
  4352. (point)))
  4353. (catch :skip
  4354. (goto-char beg)
  4355. (org-agenda-skip)
  4356. (setq str (buffer-substring-no-properties
  4357. (point-at-bol)
  4358. (if hdl-only (point-at-eol) end)))
  4359. (mapc (lambda (wr) (when (string-match wr str)
  4360. (goto-char (1- end))
  4361. (throw :skip t)))
  4362. regexps-)
  4363. (mapc (lambda (wr) (unless (string-match wr str)
  4364. (goto-char (1- end))
  4365. (throw :skip t)))
  4366. (if todo-only
  4367. (cons (concat "^\\*+[ \t]+"
  4368. org-not-done-regexp)
  4369. regexps+)
  4370. regexps+))
  4371. (goto-char beg)
  4372. (setq marker (org-agenda-new-marker (point))
  4373. category (org-get-category)
  4374. level (make-string (org-reduced-level (org-outline-level)) ? )
  4375. inherited-tags
  4376. (or (eq org-agenda-show-inherited-tags 'always)
  4377. (and (listp org-agenda-show-inherited-tags)
  4378. (memq 'todo org-agenda-show-inherited-tags))
  4379. (and (eq org-agenda-show-inherited-tags t)
  4380. (or (eq org-agenda-use-tag-inheritance t)
  4381. (memq 'todo org-agenda-use-tag-inheritance))))
  4382. tags (org-get-tags nil (not inherited-tags))
  4383. txt (org-agenda-format-item
  4384. ""
  4385. (buffer-substring-no-properties
  4386. beg1 (point-at-eol))
  4387. level category tags t))
  4388. (org-add-props txt props
  4389. 'org-marker marker 'org-hd-marker marker
  4390. 'org-todo-regexp org-todo-regexp
  4391. 'level level
  4392. 'org-complex-heading-regexp org-complex-heading-regexp
  4393. 'priority 1000
  4394. 'type "search")
  4395. (push txt ee)
  4396. (goto-char (1- end))))))))))
  4397. (setq rtn (nreverse ee))
  4398. (setq rtnall (append rtnall rtn)))
  4399. (org-agenda--insert-overriding-header
  4400. (with-temp-buffer
  4401. (insert "Search words: ")
  4402. (add-text-properties (point-min) (1- (point))
  4403. (list 'face 'org-agenda-structure))
  4404. (setq pos (point))
  4405. (insert string "\n")
  4406. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure-filter))
  4407. (setq pos (point))
  4408. (unless org-agenda-multi
  4409. (insert (substitute-command-keys "\\<org-agenda-mode-map>\
  4410. Press `\\[org-agenda-manipulate-query-add]', \
  4411. `\\[org-agenda-manipulate-query-subtract]' to add/sub word, \
  4412. `\\[org-agenda-manipulate-query-add-re]', \
  4413. `\\[org-agenda-manipulate-query-subtract-re]' to add/sub regexp, \
  4414. `\\[universal-argument] \\[org-agenda-redo]' for a fresh search\n"))
  4415. (add-text-properties pos (1- (point))
  4416. (list 'face 'org-agenda-structure-secondary)))
  4417. (buffer-string)))
  4418. (org-agenda-mark-header-line (point-min))
  4419. (when rtnall
  4420. (insert (org-agenda-finalize-entries rtnall 'search) "\n"))
  4421. (goto-char (point-min))
  4422. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4423. (add-text-properties (point-min) (point-max)
  4424. `(org-agenda-type search
  4425. org-last-args (,todo-only ,string ,edit-at)
  4426. org-redo-cmd ,org-agenda-redo-command
  4427. org-series-cmd ,org-cmd))
  4428. (org-agenda-finalize)
  4429. (setq buffer-read-only t))))
  4430. ;;; Agenda TODO list
  4431. (defun org-agenda-propertize-selected-todo-keywords (keywords)
  4432. "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
  4433. (concat
  4434. (if (or (equal keywords "ALL") (not keywords))
  4435. (propertize "ALL" 'face 'org-agenda-structure-filter)
  4436. (mapconcat
  4437. (lambda (kw)
  4438. (propertize kw 'face (list (org-get-todo-face kw) 'org-agenda-structure)))
  4439. (org-split-string keywords "|")
  4440. "|"))
  4441. "\n"))
  4442. (defvar org-select-this-todo-keyword nil)
  4443. (defvar org-last-arg nil)
  4444. (defvar crm-separator)
  4445. ;;;###autoload
  4446. (defun org-todo-list (&optional arg)
  4447. "Show all (not done) TODO entries from all agenda file in a single list.
  4448. The prefix arg can be used to select a specific TODO keyword and limit
  4449. the list to these. When using `\\[universal-argument]', you will be prompted
  4450. for a keyword. A numeric prefix directly selects the Nth keyword in
  4451. `org-todo-keywords-1'."
  4452. (interactive "P")
  4453. (when org-agenda-overriding-arguments
  4454. (setq arg org-agenda-overriding-arguments))
  4455. (when (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
  4456. (let* ((today (org-today))
  4457. (date (calendar-gregorian-from-absolute today))
  4458. (completion-ignore-case t)
  4459. kwds org-select-this-todo-keyword rtn rtnall files file pos)
  4460. (catch 'exit
  4461. (setq org-agenda-buffer-name
  4462. (org-agenda--get-buffer-name
  4463. (and org-agenda-sticky
  4464. (if (stringp org-select-this-todo-keyword)
  4465. (format "*Org Agenda(%s:%s)*" (or org-keys "t")
  4466. org-select-this-todo-keyword)
  4467. (format "*Org Agenda(%s)*" (or org-keys "t"))))))
  4468. (org-agenda-prepare "TODO")
  4469. (setq kwds org-todo-keywords-for-agenda
  4470. org-select-this-todo-keyword (if (stringp arg) arg
  4471. (and (integerp arg)
  4472. (> arg 0)
  4473. (nth (1- arg) kwds))))
  4474. (when (equal arg '(4))
  4475. (setq org-select-this-todo-keyword
  4476. (mapconcat #'identity
  4477. (let ((crm-separator "|"))
  4478. (completing-read-multiple
  4479. "Keyword (or KWD1|KWD2|...): "
  4480. (mapcar #'list kwds) nil nil))
  4481. "|")))
  4482. (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
  4483. (org-compile-prefix-format 'todo)
  4484. (org-set-sorting-strategy 'todo)
  4485. (setq org-agenda-redo-command
  4486. `(org-todo-list (or (and (numberp current-prefix-arg)
  4487. current-prefix-arg)
  4488. ,org-select-this-todo-keyword
  4489. current-prefix-arg ,arg)))
  4490. (setq files (org-agenda-files nil 'ifmode)
  4491. rtnall nil)
  4492. (while (setq file (pop files))
  4493. (catch 'nextfile
  4494. (org-check-agenda-file file)
  4495. (setq rtn (org-agenda-get-day-entries file date :todo))
  4496. (setq rtnall (append rtnall rtn))))
  4497. (org-agenda--insert-overriding-header
  4498. (with-temp-buffer
  4499. (insert "Global list of TODO items of type: ")
  4500. (add-text-properties (point-min) (1- (point))
  4501. (list 'face 'org-agenda-structure
  4502. 'short-heading
  4503. (concat "ToDo: "
  4504. (or org-select-this-todo-keyword "ALL"))))
  4505. (org-agenda-mark-header-line (point-min))
  4506. (insert (org-agenda-propertize-selected-todo-keywords
  4507. org-select-this-todo-keyword))
  4508. (setq pos (point))
  4509. (unless org-agenda-multi
  4510. (insert (substitute-command-keys "Press \
  4511. \\<org-agenda-mode-map>`N \\[org-agenda-redo]' (e.g. `0 \\[org-agenda-redo]') \
  4512. to search again: (0)[ALL]"))
  4513. (let ((n 0))
  4514. (dolist (k kwds)
  4515. (let ((s (format "(%d)%s" (cl-incf n) k)))
  4516. (when (> (+ (current-column) (string-width s) 1) (window-width))
  4517. (insert "\n "))
  4518. (insert " " s))))
  4519. (insert "\n"))
  4520. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure-secondary))
  4521. (buffer-string)))
  4522. (org-agenda-mark-header-line (point-min))
  4523. (when rtnall
  4524. (insert (org-agenda-finalize-entries rtnall 'todo) "\n"))
  4525. (goto-char (point-min))
  4526. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4527. (add-text-properties (point-min) (point-max)
  4528. `(org-agenda-type todo
  4529. org-last-args ,arg
  4530. org-redo-cmd ,org-agenda-redo-command
  4531. org-series-cmd ,org-cmd))
  4532. (org-agenda-finalize)
  4533. (setq buffer-read-only t))))
  4534. ;;; Agenda tags match
  4535. ;;;###autoload
  4536. (defun org-tags-view (&optional todo-only match)
  4537. "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
  4538. The prefix arg TODO-ONLY limits the search to TODO entries."
  4539. (interactive "P")
  4540. (when org-agenda-overriding-arguments
  4541. (setq todo-only (car org-agenda-overriding-arguments)
  4542. match (nth 1 org-agenda-overriding-arguments)))
  4543. (let* ((org-tags-match-list-sublevels
  4544. org-tags-match-list-sublevels)
  4545. (completion-ignore-case t)
  4546. (org--matcher-tags-todo-only todo-only)
  4547. rtn rtnall files file pos matcher
  4548. buffer)
  4549. (when (and (stringp match) (not (string-match "\\S-" match)))
  4550. (setq match nil))
  4551. (catch 'exit
  4552. (setq org-agenda-buffer-name
  4553. (org-agenda--get-buffer-name
  4554. (and org-agenda-sticky
  4555. (if (stringp match)
  4556. (format "*Org Agenda(%s:%s)*"
  4557. (or org-keys (or (and todo-only "M") "m"))
  4558. match)
  4559. (format "*Org Agenda(%s)*"
  4560. (or (and todo-only "M") "m"))))))
  4561. (setq matcher (org-make-tags-matcher match))
  4562. ;; Prepare agendas (and `org-tag-alist-for-agenda') before
  4563. ;; expanding tags within `org-make-tags-matcher'
  4564. (org-agenda-prepare (concat "TAGS " match))
  4565. (setq match (car matcher)
  4566. matcher (cdr matcher))
  4567. (org-compile-prefix-format 'tags)
  4568. (org-set-sorting-strategy 'tags)
  4569. (setq org-agenda-query-string match)
  4570. (setq org-agenda-redo-command
  4571. (list 'org-tags-view
  4572. `(quote ,org--matcher-tags-todo-only)
  4573. `(if current-prefix-arg nil ,org-agenda-query-string)))
  4574. (setq files (org-agenda-files nil 'ifmode)
  4575. rtnall nil)
  4576. (while (setq file (pop files))
  4577. (catch 'nextfile
  4578. (org-check-agenda-file file)
  4579. (setq buffer (if (file-exists-p file)
  4580. (org-get-agenda-file-buffer file)
  4581. (error "No such file %s" file)))
  4582. (if (not buffer)
  4583. ;; If file does not exist, error message to agenda
  4584. (setq rtn (list
  4585. (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4586. rtnall (append rtnall rtn))
  4587. (with-current-buffer buffer
  4588. (unless (derived-mode-p 'org-mode)
  4589. (error "Agenda file %s is not in Org mode" file))
  4590. (save-excursion
  4591. (save-restriction
  4592. (if (eq buffer org-agenda-restrict)
  4593. (narrow-to-region org-agenda-restrict-begin
  4594. org-agenda-restrict-end)
  4595. (widen))
  4596. (setq rtn (org-scan-tags 'agenda
  4597. matcher
  4598. org--matcher-tags-todo-only))
  4599. (setq rtnall (append rtnall rtn))))))))
  4600. (org-agenda--insert-overriding-header
  4601. (with-temp-buffer
  4602. (insert "Headlines with TAGS match: ")
  4603. (add-text-properties (point-min) (1- (point))
  4604. (list 'face 'org-agenda-structure
  4605. 'short-heading
  4606. (concat "Match: " match)))
  4607. (setq pos (point))
  4608. (insert match "\n")
  4609. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure-filter))
  4610. (setq pos (point))
  4611. (unless org-agenda-multi
  4612. (insert (substitute-command-keys
  4613. "Press \
  4614. \\<org-agenda-mode-map>`\\[universal-argument] \\[org-agenda-redo]' \
  4615. to search again\n")))
  4616. (add-text-properties pos (1- (point))
  4617. (list 'face 'org-agenda-structure-secondary))
  4618. (buffer-string)))
  4619. (org-agenda-mark-header-line (point-min))
  4620. (when rtnall
  4621. (insert (org-agenda-finalize-entries rtnall 'tags) "\n"))
  4622. (goto-char (point-min))
  4623. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4624. (add-text-properties
  4625. (point-min) (point-max)
  4626. `(org-agenda-type tags
  4627. org-last-args (,org--matcher-tags-todo-only ,match)
  4628. org-redo-cmd ,org-agenda-redo-command
  4629. org-series-cmd ,org-cmd))
  4630. (org-agenda-finalize)
  4631. (setq buffer-read-only t))))
  4632. ;;; Agenda Finding stuck projects
  4633. (defvar org-agenda-skip-regexp nil
  4634. "Regular expression used in skipping subtrees for the agenda.
  4635. This is basically a temporary global variable that can be set and then
  4636. used by user-defined selections using `org-agenda-skip-function'.")
  4637. (defvar org-agenda-overriding-header nil
  4638. "When set during agenda, todo and tags searches it replaces the header.
  4639. If an empty string, no header will be inserted. If any other
  4640. string, it will be inserted as a header. If nil, a header will
  4641. be generated automatically according to the command. This
  4642. variable should not be set directly, but custom commands can bind
  4643. it in the options section.")
  4644. (defun org-agenda-skip-entry-if (&rest conditions)
  4645. "Skip entry if any of CONDITIONS is true.
  4646. See `org-agenda-skip-if' for details."
  4647. (org-agenda-skip-if nil conditions))
  4648. (defun org-agenda-skip-subtree-if (&rest conditions)
  4649. "Skip subtree if any of CONDITIONS is true.
  4650. See `org-agenda-skip-if' for details."
  4651. (org-agenda-skip-if t conditions))
  4652. (defun org-agenda-skip-if (subtree conditions)
  4653. "Check current entity for CONDITIONS.
  4654. If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
  4655. the entry (i.e. the text before the next heading) is checked.
  4656. CONDITIONS is a list of symbols, boolean OR is used to combine the results
  4657. from different tests. Valid conditions are:
  4658. scheduled Check if there is a scheduled cookie
  4659. notscheduled Check if there is no scheduled cookie
  4660. deadline Check if there is a deadline
  4661. notdeadline Check if there is no deadline
  4662. timestamp Check if there is a timestamp (also deadline or scheduled)
  4663. nottimestamp Check if there is no timestamp (also deadline or scheduled)
  4664. regexp Check if regexp matches
  4665. notregexp Check if regexp does not match.
  4666. todo Check if TODO keyword matches
  4667. nottodo Check if TODO keyword does not match
  4668. The regexp is taken from the conditions list, it must come right after
  4669. the `regexp' or `notregexp' element.
  4670. `todo' and `nottodo' accept as an argument a list of todo
  4671. keywords, which may include \"*\" to match any todo keyword.
  4672. (org-agenda-skip-entry-if \\='todo \\='(\"TODO\" \"WAITING\"))
  4673. would skip all entries with \"TODO\" or \"WAITING\" keywords.
  4674. Instead of a list, a keyword class may be given. For example:
  4675. (org-agenda-skip-entry-if \\='nottodo \\='done)
  4676. would skip entries that haven't been marked with any of \"DONE\"
  4677. keywords. Possible classes are: `todo', `done', `any'.
  4678. If any of these conditions is met, this function returns the end point of
  4679. the entity, causing the search to continue from there. This is a function
  4680. that can be put into `org-agenda-skip-function' for the duration of a command."
  4681. (org-back-to-heading t)
  4682. (let* (;; (beg (point))
  4683. (end (if subtree (save-excursion (org-end-of-subtree t) (point))
  4684. (org-entry-end-position)))
  4685. (planning-end (if subtree end (line-end-position 2)))
  4686. m)
  4687. (and
  4688. (or (and (memq 'scheduled conditions)
  4689. (re-search-forward org-scheduled-time-regexp planning-end t))
  4690. (and (memq 'notscheduled conditions)
  4691. (not
  4692. (save-excursion
  4693. (re-search-forward org-scheduled-time-regexp planning-end t))))
  4694. (and (memq 'deadline conditions)
  4695. (re-search-forward org-deadline-time-regexp planning-end t))
  4696. (and (memq 'notdeadline conditions)
  4697. (not
  4698. (save-excursion
  4699. (re-search-forward org-deadline-time-regexp planning-end t))))
  4700. (and (memq 'timestamp conditions)
  4701. (re-search-forward org-ts-regexp end t))
  4702. (and (memq 'nottimestamp conditions)
  4703. (not (save-excursion (re-search-forward org-ts-regexp end t))))
  4704. (and (setq m (memq 'regexp conditions))
  4705. (stringp (nth 1 m))
  4706. (re-search-forward (nth 1 m) end t))
  4707. (and (setq m (memq 'notregexp conditions))
  4708. (stringp (nth 1 m))
  4709. (not (save-excursion (re-search-forward (nth 1 m) end t))))
  4710. (and (or
  4711. (setq m (memq 'nottodo conditions))
  4712. (setq m (memq 'todo-unblocked conditions))
  4713. (setq m (memq 'nottodo-unblocked conditions))
  4714. (setq m (memq 'todo conditions)))
  4715. (org-agenda-skip-if-todo m end)))
  4716. end)))
  4717. (defun org-agenda-skip-if-todo (args end)
  4718. "Helper function for `org-agenda-skip-if', do not use it directly.
  4719. ARGS is a list with first element either `todo', `nottodo',
  4720. `todo-unblocked' or `nottodo-unblocked'. The remainder is either
  4721. a list of TODO keywords, or a state symbol `todo' or `done' or
  4722. `any'."
  4723. (let ((todo-re
  4724. (concat "^\\*+[ \t]+"
  4725. (regexp-opt
  4726. (pcase args
  4727. (`(,_ todo)
  4728. (org-delete-all org-done-keywords
  4729. (copy-sequence org-todo-keywords-1)))
  4730. (`(,_ done) org-done-keywords)
  4731. (`(,_ any) org-todo-keywords-1)
  4732. (`(,_ ,(pred atom))
  4733. (error "Invalid TODO class or type: %S" args))
  4734. (`(,_ ,(pred (member "*"))) org-todo-keywords-1)
  4735. (`(,_ ,todo-list) todo-list))
  4736. 'words))))
  4737. (pcase args
  4738. (`(todo . ,_)
  4739. (let (case-fold-search) (re-search-forward todo-re end t)))
  4740. (`(nottodo . ,_)
  4741. (not (let (case-fold-search) (re-search-forward todo-re end t))))
  4742. (`(todo-unblocked . ,_)
  4743. (catch :unblocked
  4744. (while (let (case-fold-search) (re-search-forward todo-re end t))
  4745. (when (org-entry-blocked-p) (throw :unblocked t)))
  4746. nil))
  4747. (`(nottodo-unblocked . ,_)
  4748. (catch :unblocked
  4749. (while (let (case-fold-search) (re-search-forward todo-re end t))
  4750. (when (org-entry-blocked-p) (throw :unblocked nil)))
  4751. t))
  4752. (`(,type . ,_) (error "Unknown TODO skip type: %S" type)))))
  4753. ;;;###autoload
  4754. (defun org-agenda-list-stuck-projects (&rest _ignore)
  4755. "Create agenda view for projects that are stuck.
  4756. Stuck projects are project that have no next actions. For the definitions
  4757. of what a project is and how to check if it stuck, customize the variable
  4758. `org-stuck-projects'."
  4759. (interactive)
  4760. (let* ((org-agenda-overriding-header
  4761. (or org-agenda-overriding-header "List of stuck projects: "))
  4762. (matcher (nth 0 org-stuck-projects))
  4763. (todo (nth 1 org-stuck-projects))
  4764. (tags (nth 2 org-stuck-projects))
  4765. (gen-re (org-string-nw-p (nth 3 org-stuck-projects)))
  4766. (todo-wds
  4767. (if (not (member "*" todo)) todo
  4768. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  4769. (org-delete-all org-done-keywords-for-agenda
  4770. (copy-sequence org-todo-keywords-for-agenda))))
  4771. (todo-re (and todo
  4772. (format "^\\*+[ \t]+\\(%s\\)\\>"
  4773. (mapconcat #'identity todo-wds "\\|"))))
  4774. (tags-re (cond ((null tags) nil)
  4775. ((member "*" tags) org-tag-line-re)
  4776. (tags
  4777. (let ((other-tags (format "\\(?:%s:\\)*" org-tag-re)))
  4778. (concat org-outline-regexp-bol
  4779. ".*?[ \t]:"
  4780. other-tags
  4781. (regexp-opt tags t)
  4782. ":" other-tags "[ \t]*$")))
  4783. (t nil)))
  4784. (re-list (delq nil (list todo-re tags-re gen-re)))
  4785. (skip-re
  4786. (if (null re-list)
  4787. (error "Missing information to identify unstuck projects")
  4788. (mapconcat #'identity re-list "\\|")))
  4789. (org-agenda-skip-function
  4790. ;; Skip entry if `org-agenda-skip-regexp' matches anywhere
  4791. ;; in the subtree.
  4792. (lambda ()
  4793. (and (save-excursion
  4794. (let ((case-fold-search nil))
  4795. (re-search-forward
  4796. skip-re (save-excursion (org-end-of-subtree t)) t)))
  4797. (progn (outline-next-heading) (point))))))
  4798. (org-tags-view nil matcher)
  4799. (setq org-agenda-buffer-name (buffer-name))
  4800. (with-current-buffer org-agenda-buffer-name
  4801. (setq org-agenda-redo-command
  4802. `(org-agenda-list-stuck-projects ,current-prefix-arg))
  4803. (let ((inhibit-read-only t))
  4804. (add-text-properties
  4805. (point-min) (point-max)
  4806. `(org-redo-cmd ,org-agenda-redo-command))))))
  4807. ;;; Diary integration
  4808. (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
  4809. (defvar diary-list-entries-hook)
  4810. (defvar diary-time-regexp)
  4811. (defvar diary-modify-entry-list-string-function)
  4812. (defvar diary-file-name-prefix)
  4813. (defvar diary-display-function)
  4814. (defun org-get-entries-from-diary (date)
  4815. "Get the (Emacs Calendar) diary entries for DATE."
  4816. (require 'diary-lib)
  4817. (declare-function diary-fancy-display "diary-lib" ())
  4818. (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
  4819. (diary-display-function #'diary-fancy-display)
  4820. (pop-up-frames nil)
  4821. (diary-list-entries-hook
  4822. (cons 'org-diary-default-entry diary-list-entries-hook))
  4823. (diary-file-name-prefix nil) ; turn this feature off
  4824. (diary-modify-entry-list-string-function
  4825. #'org-modify-diary-entry-string)
  4826. (diary-time-regexp (concat "^" diary-time-regexp))
  4827. entries
  4828. (org-disable-agenda-to-diary t))
  4829. (save-excursion
  4830. (save-window-excursion
  4831. (diary-list-entries date 1)))
  4832. (if (not (get-buffer diary-fancy-buffer))
  4833. (setq entries nil)
  4834. (with-current-buffer diary-fancy-buffer
  4835. (setq buffer-read-only nil)
  4836. (if (zerop (buffer-size))
  4837. ;; No entries
  4838. (setq entries nil)
  4839. ;; Omit the date and other unnecessary stuff
  4840. (org-agenda-cleanup-fancy-diary)
  4841. ;; Add prefix to each line and extend the text properties
  4842. (if (zerop (buffer-size))
  4843. (setq entries nil)
  4844. (setq entries (buffer-substring (point-min) (- (point-max) 1)))
  4845. (setq entries
  4846. (with-temp-buffer
  4847. (insert entries) (goto-char (point-min))
  4848. (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
  4849. (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
  4850. (replace-match (concat "; " (match-string 1)))))
  4851. (buffer-string)))))
  4852. (set-buffer-modified-p nil)
  4853. (kill-buffer diary-fancy-buffer)))
  4854. (when entries
  4855. (setq entries (org-split-string entries "\n"))
  4856. (setq entries
  4857. (mapcar
  4858. (lambda (x)
  4859. (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
  4860. ;; Extend the text properties to the beginning of the line
  4861. (org-add-props x (text-properties-at (1- (length x)) x)
  4862. 'type "diary" 'date date 'face 'org-agenda-diary))
  4863. entries)))))
  4864. (defvar org-agenda-cleanup-fancy-diary-hook nil
  4865. "Hook run when the fancy diary buffer is cleaned up.")
  4866. (defun org-agenda-cleanup-fancy-diary ()
  4867. "Remove unwanted stuff in buffer created by `fancy-diary-display'.
  4868. This gets rid of the date, the underline under the date, and the
  4869. dummy entry installed by Org mode to ensure non-empty diary for
  4870. each date. It also removes lines that contain only whitespace."
  4871. (goto-char (point-min))
  4872. (if (looking-at ".*?:[ \t]*")
  4873. (progn
  4874. (replace-match "")
  4875. (re-search-forward "\n=+$" nil t)
  4876. (replace-match "")
  4877. (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
  4878. (re-search-forward "\n=+$" nil t)
  4879. (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
  4880. (goto-char (point-min))
  4881. (while (re-search-forward "^ +\n" nil t)
  4882. (replace-match ""))
  4883. (goto-char (point-min))
  4884. (when (re-search-forward "^Org mode dummy\n?" nil t)
  4885. (replace-match ""))
  4886. (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
  4887. (defun org-modify-diary-entry-string (string)
  4888. "Add text properties to string, allowing Org to act on it."
  4889. (org-add-props string nil
  4890. 'mouse-face 'highlight
  4891. 'help-echo (if buffer-file-name
  4892. (format "mouse-2 or RET jump to diary file %s"
  4893. (abbreviate-file-name buffer-file-name))
  4894. "")
  4895. 'org-agenda-diary-link t
  4896. 'org-marker (org-agenda-new-marker (point-at-bol))))
  4897. (defun org-diary-default-entry ()
  4898. "Add a dummy entry to the diary.
  4899. Needed to avoid empty dates which mess up holiday display."
  4900. ;; Catch the error if dealing with the new add-to-diary-alist
  4901. (when org-disable-agenda-to-diary
  4902. (diary-add-to-list original-date "Org mode dummy" "")))
  4903. (defvar org-diary-last-run-time nil)
  4904. ;;;###autoload
  4905. (defun org-diary (&rest args)
  4906. "Return diary information from org files.
  4907. This function can be used in a \"sexp\" diary entry in the Emacs calendar.
  4908. It accesses org files and extracts information from those files to be
  4909. listed in the diary. The function accepts arguments specifying what
  4910. items should be listed. For a list of arguments allowed here, see the
  4911. variable `org-agenda-entry-types'.
  4912. The call in the diary file should look like this:
  4913. &%%(org-diary) ~/path/to/some/orgfile.org
  4914. Use a separate line for each org file to check. Or, if you omit the file name,
  4915. all files listed in `org-agenda-files' will be checked automatically:
  4916. &%%(org-diary)
  4917. If you don't give any arguments (as in the example above), the default value
  4918. of `org-agenda-entry-types' is used: (:deadline :scheduled :timestamp :sexp).
  4919. So the example above may also be written as
  4920. &%%(org-diary :deadline :timestamp :sexp :scheduled)
  4921. The function expects the lisp variables `entry' and `date' to be provided
  4922. by the caller, because this is how the calendar works. Don't use this
  4923. function from a program - use `org-agenda-get-day-entries' instead."
  4924. (with-no-warnings (defvar date) (defvar entry))
  4925. (when (> (- (float-time)
  4926. org-agenda-last-marker-time)
  4927. 5)
  4928. ;; I am not sure if this works with sticky agendas, because the marker
  4929. ;; list is then no longer a global variable.
  4930. (org-agenda-reset-markers))
  4931. (org-compile-prefix-format 'agenda)
  4932. (org-set-sorting-strategy 'agenda)
  4933. (setq args (or args org-agenda-entry-types))
  4934. (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
  4935. (list entry)
  4936. (org-agenda-files t)))
  4937. (time (float-time))
  4938. file rtn results)
  4939. (when (or (not org-diary-last-run-time)
  4940. (> (- time
  4941. org-diary-last-run-time)
  4942. 3))
  4943. (org-agenda-prepare-buffers files))
  4944. (setq org-diary-last-run-time time)
  4945. ;; If this is called during org-agenda, don't return any entries to
  4946. ;; the calendar. Org Agenda will list these entries itself.
  4947. (when org-disable-agenda-to-diary (setq files nil))
  4948. (while (setq file (pop files))
  4949. (setq rtn (apply #'org-agenda-get-day-entries file date args))
  4950. (setq results (append results rtn)))
  4951. (when results
  4952. (setq results
  4953. (mapcar (lambda (i) (replace-regexp-in-string
  4954. org-link-bracket-re "\\2" i))
  4955. results))
  4956. (concat (org-agenda-finalize-entries results) "\n"))))
  4957. ;;; Agenda entry finders
  4958. (defun org-agenda--timestamp-to-absolute (&rest args)
  4959. "Call `org-time-string-to-absolute' with ARGS.
  4960. However, throw `:skip' whenever an error is raised."
  4961. (condition-case e
  4962. (apply #'org-time-string-to-absolute args)
  4963. (org-diary-sexp-no-match (throw :skip nil))
  4964. (error
  4965. (message "%s; Skipping entry" (error-message-string e))
  4966. (throw :skip nil))))
  4967. (defun org-agenda-get-day-entries (file date &rest args)
  4968. "Does the work for `org-diary' and `org-agenda'.
  4969. FILE is the path to a file to be checked for entries. DATE is date like
  4970. the one returned by `calendar-current-date'. ARGS are symbols indicating
  4971. which kind of entries should be extracted. For details about these, see
  4972. the documentation of `org-diary'."
  4973. (let* ((org-startup-folded nil)
  4974. (org-startup-align-all-tables nil)
  4975. (buffer (if (file-exists-p file) (org-get-agenda-file-buffer file)
  4976. (error "No such file %s" file))))
  4977. (if (not buffer)
  4978. ;; If file does not exist, signal it in diary nonetheless.
  4979. (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4980. (with-current-buffer buffer
  4981. (unless (derived-mode-p 'org-mode)
  4982. (error "Agenda file %s is not in Org mode" file))
  4983. (setq org-agenda-buffer (or org-agenda-buffer buffer))
  4984. (setf org-agenda-current-date date)
  4985. (save-excursion
  4986. (save-restriction
  4987. (if (eq buffer org-agenda-restrict)
  4988. (narrow-to-region org-agenda-restrict-begin
  4989. org-agenda-restrict-end)
  4990. (widen))
  4991. ;; Rationalize ARGS. Also make sure `:deadline' comes
  4992. ;; first in order to populate DEADLINES before passing it.
  4993. ;;
  4994. ;; We use `delq' since `org-uniquify' duplicates ARGS,
  4995. ;; guarding us from modifying `org-agenda-entry-types'.
  4996. (setf args (org-uniquify (or args org-agenda-entry-types)))
  4997. (when (and (memq :scheduled args) (memq :scheduled* args))
  4998. (setf args (delq :scheduled* args)))
  4999. (cond
  5000. ((memq :deadline args)
  5001. (setf args (cons :deadline
  5002. (delq :deadline (delq :deadline* args)))))
  5003. ((memq :deadline* args)
  5004. (setf args (cons :deadline* (delq :deadline* args)))))
  5005. ;; Collect list of headlines. Return them flattened.
  5006. (let ((case-fold-search nil) results deadlines)
  5007. (org-dlet
  5008. ((date date))
  5009. (dolist (arg args (apply #'nconc (nreverse results)))
  5010. (pcase arg
  5011. ((and :todo (guard (org-agenda-today-p date)))
  5012. (push (org-agenda-get-todos) results))
  5013. (:timestamp
  5014. (push (org-agenda-get-blocks) results)
  5015. (push (org-agenda-get-timestamps deadlines) results))
  5016. (:sexp
  5017. (push (org-agenda-get-sexps) results))
  5018. (:scheduled
  5019. (push (org-agenda-get-scheduled deadlines) results))
  5020. (:scheduled*
  5021. (push (org-agenda-get-scheduled deadlines t) results))
  5022. (:closed
  5023. (push (org-agenda-get-progress) results))
  5024. (:deadline
  5025. (setf deadlines (org-agenda-get-deadlines))
  5026. (push deadlines results))
  5027. (:deadline*
  5028. (setf deadlines (org-agenda-get-deadlines t))
  5029. (push deadlines results))))))))))))
  5030. (defsubst org-em (x y list)
  5031. "Is X or Y a member of LIST?"
  5032. (or (memq x list) (memq y list)))
  5033. (defvar org-heading-keyword-regexp-format) ; defined in org.el
  5034. (defvar org-agenda-sorting-strategy-selected nil)
  5035. (defun org-agenda-entry-get-agenda-timestamp (pom)
  5036. "Retrieve timestamp information for sorting agenda views.
  5037. Given a point or marker POM, returns a cons cell of the timestamp
  5038. and the timestamp type relevant for the sorting strategy in
  5039. `org-agenda-sorting-strategy-selected'."
  5040. (let (ts ts-date-type)
  5041. (save-match-data
  5042. (cond ((org-em 'scheduled-up 'scheduled-down
  5043. org-agenda-sorting-strategy-selected)
  5044. (setq ts (org-entry-get pom "SCHEDULED")
  5045. ts-date-type " scheduled"))
  5046. ((org-em 'deadline-up 'deadline-down
  5047. org-agenda-sorting-strategy-selected)
  5048. (setq ts (org-entry-get pom "DEADLINE")
  5049. ts-date-type " deadline"))
  5050. ((org-em 'ts-up 'ts-down
  5051. org-agenda-sorting-strategy-selected)
  5052. (setq ts (org-entry-get pom "TIMESTAMP")
  5053. ts-date-type " timestamp"))
  5054. ((org-em 'tsia-up 'tsia-down
  5055. org-agenda-sorting-strategy-selected)
  5056. (setq ts (org-entry-get pom "TIMESTAMP_IA")
  5057. ts-date-type " timestamp_ia"))
  5058. ((org-em 'timestamp-up 'timestamp-down
  5059. org-agenda-sorting-strategy-selected)
  5060. (setq ts (or (org-entry-get pom "SCHEDULED")
  5061. (org-entry-get pom "DEADLINE")
  5062. (org-entry-get pom "TIMESTAMP")
  5063. (org-entry-get pom "TIMESTAMP_IA"))
  5064. ts-date-type ""))
  5065. (t (setq ts-date-type "")))
  5066. (cons (when ts (ignore-errors (org-time-string-to-absolute ts)))
  5067. ts-date-type))))
  5068. (defun org-agenda-get-todos ()
  5069. "Return the TODO information for agenda display."
  5070. (let* ((props (list 'face nil
  5071. 'done-face 'org-agenda-done
  5072. 'org-not-done-regexp org-not-done-regexp
  5073. 'org-todo-regexp org-todo-regexp
  5074. 'org-complex-heading-regexp org-complex-heading-regexp
  5075. 'mouse-face 'highlight
  5076. 'help-echo
  5077. (format "mouse-2 or RET jump to org file %s"
  5078. (abbreviate-file-name buffer-file-name))))
  5079. (case-fold-search nil)
  5080. (regexp (format org-heading-keyword-regexp-format
  5081. (cond
  5082. ((and org-select-this-todo-keyword
  5083. (equal org-select-this-todo-keyword "*"))
  5084. org-todo-regexp)
  5085. (org-select-this-todo-keyword
  5086. (concat "\\("
  5087. (mapconcat #'identity
  5088. (org-split-string
  5089. org-select-this-todo-keyword
  5090. "|")
  5091. "\\|")
  5092. "\\)"))
  5093. (t org-not-done-regexp))))
  5094. marker priority category level tags todo-state
  5095. ts-date ts-date-type ts-date-pair
  5096. ee txt beg end inherited-tags todo-state-end-pos)
  5097. (goto-char (point-min))
  5098. (while (re-search-forward regexp nil t)
  5099. (catch :skip
  5100. (save-match-data
  5101. (beginning-of-line)
  5102. (org-agenda-skip)
  5103. (setq beg (point) end (save-excursion (outline-next-heading) (point)))
  5104. (unless (and (setq todo-state (org-get-todo-state))
  5105. (setq todo-state-end-pos (match-end 2)))
  5106. (goto-char end)
  5107. (throw :skip nil))
  5108. (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
  5109. (goto-char (1+ beg))
  5110. (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
  5111. (throw :skip nil)))
  5112. (goto-char (match-beginning 2))
  5113. (setq marker (org-agenda-new-marker (match-beginning 0))
  5114. category (org-get-category)
  5115. ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
  5116. ts-date (car ts-date-pair)
  5117. ts-date-type (cdr ts-date-pair)
  5118. txt (org-trim (buffer-substring (match-beginning 2) (match-end 0)))
  5119. inherited-tags
  5120. (or (eq org-agenda-show-inherited-tags 'always)
  5121. (and (listp org-agenda-show-inherited-tags)
  5122. (memq 'todo org-agenda-show-inherited-tags))
  5123. (and (eq org-agenda-show-inherited-tags t)
  5124. (or (eq org-agenda-use-tag-inheritance t)
  5125. (memq 'todo org-agenda-use-tag-inheritance))))
  5126. tags (org-get-tags nil (not inherited-tags))
  5127. level (make-string (org-reduced-level (org-outline-level)) ? )
  5128. txt (org-agenda-format-item "" txt level category tags t)
  5129. priority (1+ (org-get-priority txt)))
  5130. (org-add-props txt props
  5131. 'org-marker marker 'org-hd-marker marker
  5132. 'priority priority
  5133. 'level level
  5134. 'ts-date ts-date
  5135. 'type (concat "todo" ts-date-type) 'todo-state todo-state)
  5136. (push txt ee)
  5137. (if org-agenda-todo-list-sublevels
  5138. (goto-char todo-state-end-pos)
  5139. (org-end-of-subtree 'invisible))))
  5140. (nreverse ee)))
  5141. (defun org-agenda-todo-custom-ignore-p (time n)
  5142. "Check whether timestamp is farther away than n number of days.
  5143. This function is invoked if `org-agenda-todo-ignore-deadlines',
  5144. `org-agenda-todo-ignore-scheduled' or
  5145. `org-agenda-todo-ignore-timestamp' is set to an integer."
  5146. (let ((days (org-time-stamp-to-now
  5147. time org-agenda-todo-ignore-time-comparison-use-seconds)))
  5148. (if (>= n 0)
  5149. (>= days n)
  5150. (<= days n))))
  5151. ;;;###autoload
  5152. (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  5153. (&optional end)
  5154. "Do we have a reason to ignore this TODO entry because it has a time stamp?"
  5155. (when (or org-agenda-todo-ignore-with-date
  5156. org-agenda-todo-ignore-scheduled
  5157. org-agenda-todo-ignore-deadlines
  5158. org-agenda-todo-ignore-timestamp)
  5159. (setq end (or end (save-excursion (outline-next-heading) (point))))
  5160. (save-excursion
  5161. (or (and org-agenda-todo-ignore-with-date
  5162. (re-search-forward org-ts-regexp end t))
  5163. (and org-agenda-todo-ignore-scheduled
  5164. (re-search-forward org-scheduled-time-regexp end t)
  5165. (cond
  5166. ((eq org-agenda-todo-ignore-scheduled 'future)
  5167. (> (org-time-stamp-to-now
  5168. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5169. 0))
  5170. ((eq org-agenda-todo-ignore-scheduled 'past)
  5171. (<= (org-time-stamp-to-now
  5172. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5173. 0))
  5174. ((numberp org-agenda-todo-ignore-scheduled)
  5175. (org-agenda-todo-custom-ignore-p
  5176. (match-string 1) org-agenda-todo-ignore-scheduled))
  5177. (t)))
  5178. (and org-agenda-todo-ignore-deadlines
  5179. (re-search-forward org-deadline-time-regexp end t)
  5180. (cond
  5181. ((eq org-agenda-todo-ignore-deadlines 'all) t)
  5182. ((eq org-agenda-todo-ignore-deadlines 'far)
  5183. (not (org-deadline-close-p (match-string 1))))
  5184. ((eq org-agenda-todo-ignore-deadlines 'future)
  5185. (> (org-time-stamp-to-now
  5186. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5187. 0))
  5188. ((eq org-agenda-todo-ignore-deadlines 'past)
  5189. (<= (org-time-stamp-to-now
  5190. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5191. 0))
  5192. ((numberp org-agenda-todo-ignore-deadlines)
  5193. (org-agenda-todo-custom-ignore-p
  5194. (match-string 1) org-agenda-todo-ignore-deadlines))
  5195. (t (org-deadline-close-p (match-string 1)))))
  5196. (and org-agenda-todo-ignore-timestamp
  5197. (let ((buffer (current-buffer))
  5198. (regexp
  5199. (concat
  5200. org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
  5201. (start (point)))
  5202. ;; Copy current buffer into a temporary one
  5203. (with-temp-buffer
  5204. (insert-buffer-substring buffer start end)
  5205. (goto-char (point-min))
  5206. ;; Delete SCHEDULED and DEADLINE items
  5207. (while (re-search-forward regexp end t)
  5208. (delete-region (match-beginning 0) (match-end 0)))
  5209. (goto-char (point-min))
  5210. ;; No search for timestamp left
  5211. (when (re-search-forward org-ts-regexp nil t)
  5212. (cond
  5213. ((eq org-agenda-todo-ignore-timestamp 'future)
  5214. (> (org-time-stamp-to-now
  5215. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5216. 0))
  5217. ((eq org-agenda-todo-ignore-timestamp 'past)
  5218. (<= (org-time-stamp-to-now
  5219. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds)
  5220. 0))
  5221. ((numberp org-agenda-todo-ignore-timestamp)
  5222. (org-agenda-todo-custom-ignore-p
  5223. (match-string 1) org-agenda-todo-ignore-timestamp))
  5224. (t))))))))))
  5225. (defun org-agenda-get-timestamps (&optional deadlines)
  5226. "Return the date stamp information for agenda display.
  5227. Optional argument DEADLINES is a list of deadline items to be
  5228. displayed in agenda view."
  5229. (with-no-warnings (defvar date))
  5230. (let* ((props (list 'face 'org-agenda-calendar-event
  5231. 'org-not-done-regexp org-not-done-regexp
  5232. 'org-todo-regexp org-todo-regexp
  5233. 'org-complex-heading-regexp org-complex-heading-regexp
  5234. 'mouse-face 'highlight
  5235. 'help-echo
  5236. (format "mouse-2 or RET jump to Org file %s"
  5237. (abbreviate-file-name buffer-file-name))))
  5238. (current (calendar-absolute-from-gregorian date))
  5239. (today (org-today))
  5240. (deadline-position-alist
  5241. (mapcar (lambda (d)
  5242. (let ((m (get-text-property 0 'org-hd-marker d)))
  5243. (and m (marker-position m))))
  5244. deadlines))
  5245. ;; Match time-stamps set to current date, time-stamps with
  5246. ;; a repeater, and S-exp time-stamps.
  5247. (regexp
  5248. (concat
  5249. (if org-agenda-include-inactive-timestamps "[[<]" "<")
  5250. (regexp-quote
  5251. (substring
  5252. (format-time-string
  5253. (car org-time-stamp-formats)
  5254. (encode-time ; DATE bound by calendar
  5255. 0 0 0 (nth 1 date) (car date) (nth 2 date)))
  5256. 1 11))
  5257. "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
  5258. "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
  5259. timestamp-items)
  5260. (goto-char (point-min))
  5261. (while (re-search-forward regexp nil t)
  5262. ;; Skip date ranges, scheduled and deadlines, which are handled
  5263. ;; specially. Also skip time-stamps before first headline as
  5264. ;; there would be no entry to add to the agenda. Eventually,
  5265. ;; ignore clock entries.
  5266. (catch :skip
  5267. (save-match-data
  5268. (when (or (org-at-date-range-p)
  5269. (org-at-planning-p)
  5270. (org-before-first-heading-p)
  5271. (and org-agenda-include-inactive-timestamps
  5272. (org-at-clock-log-p)))
  5273. (throw :skip nil))
  5274. (org-agenda-skip))
  5275. (let* ((pos (match-beginning 0))
  5276. (repeat (match-string 1))
  5277. (sexp-entry (match-string 3))
  5278. (time-stamp (if (or repeat sexp-entry) (match-string 0)
  5279. (save-excursion
  5280. (goto-char pos)
  5281. (looking-at org-ts-regexp-both)
  5282. (match-string 0))))
  5283. (todo-state (org-get-todo-state))
  5284. (warntime (get-text-property (point) 'org-appt-warntime))
  5285. (done? (member todo-state org-done-keywords)))
  5286. ;; Possibly skip done tasks.
  5287. (when (and done? org-agenda-skip-timestamp-if-done)
  5288. (throw :skip t))
  5289. ;; S-exp entry doesn't match current day: skip it.
  5290. (when (and sexp-entry (not (org-diary-sexp-entry sexp-entry "" date)))
  5291. (throw :skip nil))
  5292. (when repeat
  5293. (let* ((past
  5294. ;; A repeating time stamp is shown at its base
  5295. ;; date and every repeated date up to TODAY. If
  5296. ;; `org-agenda-prefer-last-repeat' is non-nil,
  5297. ;; however, only the last repeat before today
  5298. ;; (inclusive) is shown.
  5299. (org-agenda--timestamp-to-absolute
  5300. repeat
  5301. (if (or (> current today)
  5302. (eq org-agenda-prefer-last-repeat t)
  5303. (member todo-state org-agenda-prefer-last-repeat))
  5304. today
  5305. current)
  5306. 'past (current-buffer) pos))
  5307. (future
  5308. ;; Display every repeated date past TODAY
  5309. ;; (exclusive) unless
  5310. ;; `org-agenda-show-future-repeats' is nil. If
  5311. ;; this variable is set to `next', only display
  5312. ;; the first repeated date after TODAY
  5313. ;; (exclusive).
  5314. (cond
  5315. ((<= current today) past)
  5316. ((not org-agenda-show-future-repeats) past)
  5317. (t
  5318. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5319. (1+ today)
  5320. current)))
  5321. (org-agenda--timestamp-to-absolute
  5322. repeat base 'future (current-buffer) pos))))))
  5323. (when (and (/= current past) (/= current future))
  5324. (throw :skip nil))))
  5325. (save-excursion
  5326. (re-search-backward org-outline-regexp-bol nil t)
  5327. ;; Possibly skip time-stamp when a deadline is set.
  5328. (when (and org-agenda-skip-timestamp-if-deadline-is-shown
  5329. (assq (point) deadline-position-alist))
  5330. (throw :skip nil))
  5331. (let* ((category (org-get-category pos))
  5332. (inherited-tags
  5333. (or (eq org-agenda-show-inherited-tags 'always)
  5334. (and (consp org-agenda-show-inherited-tags)
  5335. (memq 'agenda org-agenda-show-inherited-tags))
  5336. (and (eq org-agenda-show-inherited-tags t)
  5337. (or (eq org-agenda-use-tag-inheritance t)
  5338. (memq 'agenda
  5339. org-agenda-use-tag-inheritance)))))
  5340. (tags (org-get-tags nil (not inherited-tags)))
  5341. (level (make-string (org-reduced-level (org-outline-level))
  5342. ?\s))
  5343. (head (and (looking-at "\\*+[ \t]+\\(.*\\)")
  5344. (match-string 1)))
  5345. (inactive? (= (char-after pos) ?\[))
  5346. (habit? (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  5347. (item
  5348. (org-agenda-format-item
  5349. (and inactive? org-agenda-inactive-leader)
  5350. head level category tags time-stamp org-ts-regexp habit?)))
  5351. (org-add-props item props
  5352. 'priority (if habit?
  5353. (org-habit-get-priority (org-habit-parse-todo))
  5354. (org-get-priority item))
  5355. 'org-marker (org-agenda-new-marker pos)
  5356. 'org-hd-marker (org-agenda-new-marker)
  5357. 'date date
  5358. 'level level
  5359. 'ts-date (if repeat (org-agenda--timestamp-to-absolute repeat)
  5360. current)
  5361. 'todo-state todo-state
  5362. 'warntime warntime
  5363. 'type "timestamp")
  5364. (push item timestamp-items))))
  5365. (when org-agenda-skip-additional-timestamps-same-entry
  5366. (outline-next-heading))))
  5367. (nreverse timestamp-items)))
  5368. (defun org-agenda-get-sexps ()
  5369. "Return the sexp information for agenda display."
  5370. (require 'diary-lib)
  5371. (with-no-warnings (defvar date) (defvar entry))
  5372. (let* ((props (list 'face 'org-agenda-calendar-sexp
  5373. 'mouse-face 'highlight
  5374. 'help-echo
  5375. (format "mouse-2 or RET jump to org file %s"
  5376. (abbreviate-file-name buffer-file-name))))
  5377. (regexp "^&?%%(")
  5378. ;; FIXME: Is this `entry' binding intended to be dynamic,
  5379. ;; so as to "hide" any current binding for it?
  5380. marker category extra level ee txt tags entry
  5381. result beg b sexp sexp-entry todo-state warntime inherited-tags)
  5382. (goto-char (point-min))
  5383. (while (re-search-forward regexp nil t)
  5384. (catch :skip
  5385. (org-agenda-skip)
  5386. (setq beg (match-beginning 0))
  5387. (goto-char (1- (match-end 0)))
  5388. (setq b (point))
  5389. (forward-sexp 1)
  5390. (setq sexp (buffer-substring b (point)))
  5391. (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
  5392. (org-trim (match-string 1))
  5393. ""))
  5394. (setq result (org-diary-sexp-entry sexp sexp-entry date))
  5395. (when result
  5396. (setq marker (org-agenda-new-marker beg)
  5397. level (make-string (org-reduced-level (org-outline-level)) ? )
  5398. category (org-get-category beg)
  5399. inherited-tags
  5400. (or (eq org-agenda-show-inherited-tags 'always)
  5401. (and (listp org-agenda-show-inherited-tags)
  5402. (memq 'agenda org-agenda-show-inherited-tags))
  5403. (and (eq org-agenda-show-inherited-tags t)
  5404. (or (eq org-agenda-use-tag-inheritance t)
  5405. (memq 'agenda org-agenda-use-tag-inheritance))))
  5406. tags (org-get-tags nil (not inherited-tags))
  5407. todo-state (org-get-todo-state)
  5408. warntime (get-text-property (point) 'org-appt-warntime)
  5409. extra nil)
  5410. (dolist (r (if (stringp result)
  5411. (list result)
  5412. result)) ;; we expect a list here
  5413. (when (and org-agenda-diary-sexp-prefix
  5414. (string-match org-agenda-diary-sexp-prefix r))
  5415. (setq extra (match-string 0 r)
  5416. r (replace-match "" nil nil r)))
  5417. (if (string-match "\\S-" r)
  5418. (setq txt r)
  5419. (setq txt "SEXP entry returned empty string"))
  5420. (setq txt (org-agenda-format-item extra txt level category tags 'time))
  5421. (org-add-props txt props 'org-marker marker
  5422. 'date date 'todo-state todo-state
  5423. 'level level 'type "sexp" 'warntime warntime)
  5424. (push txt ee)))))
  5425. (nreverse ee)))
  5426. ;; Calendar sanity: define some functions that are independent of
  5427. ;; `calendar-date-style'.
  5428. (defun org-anniversary (year month day &optional mark)
  5429. "Like `diary-anniversary', but with fixed (ISO) order of arguments."
  5430. (with-no-warnings
  5431. (let ((calendar-date-style 'iso))
  5432. (diary-anniversary year month day mark))))
  5433. (defun org-cyclic (N year month day &optional mark)
  5434. "Like `diary-cyclic', but with fixed (ISO) order of arguments."
  5435. (with-no-warnings
  5436. (let ((calendar-date-style 'iso))
  5437. (diary-cyclic N year month day mark))))
  5438. (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
  5439. "Like `diary-block', but with fixed (ISO) order of arguments."
  5440. (with-no-warnings
  5441. (let ((calendar-date-style 'iso))
  5442. (diary-block Y1 M1 D1 Y2 M2 D2 mark))))
  5443. (defun org-date (year month day &optional mark)
  5444. "Like `diary-date', but with fixed (ISO) order of arguments."
  5445. (with-no-warnings
  5446. (let ((calendar-date-style 'iso))
  5447. (diary-date year month day mark))))
  5448. ;; Define the `org-class' function
  5449. (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
  5450. "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
  5451. DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
  5452. SKIP-WEEKS is any number of ISO weeks in the block period for which the
  5453. item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
  5454. `holidays', then any date that is known by the Emacs calendar to be a
  5455. holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
  5456. then those holidays will be skipped."
  5457. (with-no-warnings (defvar date) (defvar entry))
  5458. (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
  5459. (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
  5460. (d (calendar-absolute-from-gregorian date))
  5461. (h (when skip-weeks (calendar-check-holidays date))))
  5462. (and
  5463. (<= date1 d)
  5464. (<= d date2)
  5465. (= (calendar-day-of-week date) dayname)
  5466. (or (not skip-weeks)
  5467. (progn
  5468. (require 'cal-iso)
  5469. (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
  5470. (not (or (and h (memq 'holidays skip-weeks))
  5471. (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
  5472. entry)))
  5473. (defalias 'org-get-closed #'org-agenda-get-progress)
  5474. (defun org-agenda-get-progress ()
  5475. "Return the logged TODO entries for agenda display."
  5476. (with-no-warnings (defvar date))
  5477. (let* ((props (list 'mouse-face 'highlight
  5478. 'org-not-done-regexp org-not-done-regexp
  5479. 'org-todo-regexp org-todo-regexp
  5480. 'org-complex-heading-regexp org-complex-heading-regexp
  5481. 'help-echo
  5482. (format "mouse-2 or RET jump to org file %s"
  5483. (abbreviate-file-name buffer-file-name))))
  5484. (items (if (consp org-agenda-show-log-scoped)
  5485. org-agenda-show-log-scoped
  5486. (if (eq org-agenda-show-log-scoped 'clockcheck)
  5487. '(clock)
  5488. org-agenda-log-mode-items)))
  5489. (parts
  5490. (delq nil
  5491. (list
  5492. (when (memq 'closed items) (concat "\\<" org-closed-string))
  5493. (when (memq 'clock items) (concat "\\<" org-clock-string))
  5494. (when (memq 'state items)
  5495. (format "- +State \"%s\".*?" org-todo-regexp)))))
  5496. (parts-re (if parts (mapconcat #'identity parts "\\|")
  5497. (error "`org-agenda-log-mode-items' is empty")))
  5498. (regexp (concat
  5499. "\\(" parts-re "\\)"
  5500. " *\\["
  5501. (regexp-quote
  5502. (substring
  5503. (format-time-string
  5504. (car org-time-stamp-formats)
  5505. (encode-time ; DATE bound by calendar
  5506. 0 0 0 (nth 1 date) (car date) (nth 2 date)))
  5507. 1 11))))
  5508. (org-agenda-search-headline-for-time nil)
  5509. marker hdmarker priority category level tags closedp type
  5510. statep clockp state ee txt extra timestr rest clocked inherited-tags)
  5511. (goto-char (point-min))
  5512. (while (re-search-forward regexp nil t)
  5513. (catch :skip
  5514. (org-agenda-skip)
  5515. (setq marker (org-agenda-new-marker (match-beginning 0))
  5516. closedp (equal (match-string 1) org-closed-string)
  5517. statep (equal (string-to-char (match-string 1)) ?-)
  5518. clockp (not (or closedp statep))
  5519. state (and statep (match-string 2))
  5520. category (org-get-category (match-beginning 0))
  5521. timestr (buffer-substring (match-beginning 0) (point-at-eol)))
  5522. (when (string-match "\\]" timestr)
  5523. ;; substring should only run to end of time stamp
  5524. (setq rest (substring timestr (match-end 0))
  5525. timestr (substring timestr 0 (match-end 0)))
  5526. (if (and (not closedp) (not statep)
  5527. (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
  5528. rest))
  5529. (progn (setq timestr (concat (substring timestr 0 -1)
  5530. "-" (match-string 1 rest) "]"))
  5531. (setq clocked (match-string 2 rest)))
  5532. (setq clocked "-")))
  5533. (save-excursion
  5534. (setq extra
  5535. (cond
  5536. ((not org-agenda-log-mode-add-notes) nil)
  5537. (statep
  5538. (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
  5539. (match-string 1)))
  5540. (clockp
  5541. (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
  5542. (match-string 1)))))
  5543. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5544. (throw :skip nil)
  5545. (goto-char (match-beginning 0))
  5546. (setq hdmarker (org-agenda-new-marker)
  5547. inherited-tags
  5548. (or (eq org-agenda-show-inherited-tags 'always)
  5549. (and (listp org-agenda-show-inherited-tags)
  5550. (memq 'todo org-agenda-show-inherited-tags))
  5551. (and (eq org-agenda-show-inherited-tags t)
  5552. (or (eq org-agenda-use-tag-inheritance t)
  5553. (memq 'todo org-agenda-use-tag-inheritance))))
  5554. tags (org-get-tags nil (not inherited-tags))
  5555. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5556. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5557. (setq txt (match-string 1))
  5558. (when extra
  5559. (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
  5560. (setq txt (concat (substring txt 0 (match-beginning 1))
  5561. " - " extra " " (match-string 2 txt)))
  5562. (setq txt (concat txt " - " extra))))
  5563. (setq txt (org-agenda-format-item
  5564. (cond
  5565. (closedp "Closed: ")
  5566. (statep (concat "State: (" state ")"))
  5567. (t (concat "Clocked: (" clocked ")")))
  5568. txt level category tags timestr)))
  5569. (setq type (cond (closedp "closed")
  5570. (statep "state")
  5571. (t "clock")))
  5572. (setq priority 100000)
  5573. (org-add-props txt props
  5574. 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
  5575. 'priority priority 'level level
  5576. 'type type 'date date
  5577. 'undone-face 'org-warning 'done-face 'org-agenda-done)
  5578. (push txt ee))
  5579. (goto-char (point-at-eol))))
  5580. (nreverse ee)))
  5581. (defun org-agenda-show-clocking-issues ()
  5582. "Add overlays, showing issues with clocking.
  5583. See also the user option `org-agenda-clock-consistency-checks'."
  5584. (interactive)
  5585. (let* ((pl org-agenda-clock-consistency-checks)
  5586. (re (concat "^[ \t]*"
  5587. org-clock-string
  5588. "[ \t]+"
  5589. "\\(\\[.*?\\]\\)" ; group 1 is first stamp
  5590. "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
  5591. (tlstart 0.)
  5592. (tlend 0.)
  5593. (maxtime (org-duration-to-minutes
  5594. (or (plist-get pl :max-duration) "24:00")))
  5595. (mintime (org-duration-to-minutes
  5596. (or (plist-get pl :min-duration) 0)))
  5597. (maxgap (org-duration-to-minutes
  5598. ;; default 30:00 means never complain
  5599. (or (plist-get pl :max-gap) "30:00")))
  5600. (gapok (mapcar #'org-duration-to-minutes
  5601. (plist-get pl :gap-ok-around)))
  5602. (def-face (or (plist-get pl :default-face)
  5603. '((:background "DarkRed") (:foreground "white"))))
  5604. issue face m te ts dt ov)
  5605. (goto-char (point-min))
  5606. (while (re-search-forward " Clocked: +(\\(?:-\\|\\([0-9]+:[0-9]+\\)\\))" nil t)
  5607. (setq issue nil face def-face)
  5608. (catch 'next
  5609. (setq m (org-get-at-bol 'org-marker)
  5610. te nil ts nil)
  5611. (unless (and m (markerp m))
  5612. (setq issue "No valid clock line") (throw 'next t))
  5613. (org-with-point-at m
  5614. (save-excursion
  5615. (goto-char (point-at-bol))
  5616. (unless (looking-at re)
  5617. (error "No valid Clock line")
  5618. (throw 'next t))
  5619. (unless (match-end 3)
  5620. (setq issue
  5621. (format
  5622. "No end time: (%s)"
  5623. (org-duration-from-minutes
  5624. (floor
  5625. (- (float-time (org-current-time))
  5626. (float-time (org-time-string-to-time (match-string 1))))
  5627. 60)))
  5628. face (or (plist-get pl :no-end-time-face) face))
  5629. (throw 'next t))
  5630. (setq ts (match-string 1)
  5631. te (match-string 3)
  5632. ts (float-time (org-time-string-to-time ts))
  5633. te (float-time (org-time-string-to-time te))
  5634. dt (- te ts))))
  5635. (cond
  5636. ((> dt (* 60 maxtime))
  5637. ;; a very long clocking chunk
  5638. (setq issue (format "Clocking interval is very long: %s"
  5639. (org-duration-from-minutes (floor dt 60)))
  5640. face (or (plist-get pl :long-face) face)))
  5641. ((< dt (* 60 mintime))
  5642. ;; a very short clocking chunk
  5643. (setq issue (format "Clocking interval is very short: %s"
  5644. (org-duration-from-minutes (floor dt 60)))
  5645. face (or (plist-get pl :short-face) face)))
  5646. ((and (> tlend 0) (< ts tlend))
  5647. ;; Two clock entries are overlapping
  5648. (setq issue (format "Clocking overlap: %d minutes"
  5649. (/ (- tlend ts) 60))
  5650. face (or (plist-get pl :overlap-face) face)))
  5651. ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
  5652. ;; There is a gap, lets see if we need to report it
  5653. (unless (org-agenda-check-clock-gap tlend ts gapok)
  5654. (setq issue (format "Clocking gap: %d minutes"
  5655. (/ (- ts tlend) 60))
  5656. face (or (plist-get pl :gap-face) face))))
  5657. (t nil)))
  5658. (setq tlend (or te tlend) tlstart (or ts tlstart))
  5659. (when issue
  5660. ;; OK, there was some issue, add an overlay to show the issue
  5661. (setq ov (make-overlay (point-at-bol) (point-at-eol)))
  5662. (overlay-put ov 'before-string
  5663. (concat
  5664. (org-add-props
  5665. (format "%-43s" (concat " " issue))
  5666. nil
  5667. 'face face)
  5668. "\n"))
  5669. (overlay-put ov 'evaporate t)))))
  5670. (defun org-agenda-check-clock-gap (t1 t2 ok-list)
  5671. "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
  5672. (catch 'exit
  5673. (unless ok-list
  5674. ;; there are no OK times for gaps...
  5675. (throw 'exit nil))
  5676. (when (> (- (/ t2 36000) (/ t1 36000)) 24)
  5677. ;; This is more than 24 hours, so it is OK.
  5678. ;; because we have at least one OK time, that must be in the
  5679. ;; 24 hour interval.
  5680. (throw 'exit t))
  5681. ;; We have a shorter gap.
  5682. ;; Now we have to get the minute of the day when these times are
  5683. (let* ((t1dec (org-decode-time t1))
  5684. (t2dec (org-decode-time t2))
  5685. ;; compute the minute on the day
  5686. (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
  5687. (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
  5688. (when (< min2 min1)
  5689. ;; if min2 is smaller than min1, this means it is on the next day.
  5690. ;; Wrap it to after midnight.
  5691. (setq min2 (+ min2 1440)))
  5692. ;; Now check if any of the OK times is in the gap
  5693. (mapc (lambda (x)
  5694. ;; Wrap the time to after midnight if necessary
  5695. (when (< x min1) (setq x (+ x 1440)))
  5696. ;; Check if in interval
  5697. (and (<= min1 x) (>= min2 x) (throw 'exit t)))
  5698. ok-list)
  5699. ;; Nope, this gap is not OK
  5700. nil)))
  5701. (defun org-agenda-get-deadlines (&optional with-hour)
  5702. "Return the deadline information for agenda display.
  5703. When WITH-HOUR is non-nil, only return deadlines with an hour
  5704. specification like [h]h:mm."
  5705. (with-no-warnings (defvar date))
  5706. (let* ((props (list 'mouse-face 'highlight
  5707. 'org-not-done-regexp org-not-done-regexp
  5708. 'org-todo-regexp org-todo-regexp
  5709. 'org-complex-heading-regexp org-complex-heading-regexp
  5710. 'help-echo
  5711. (format "mouse-2 or RET jump to org file %s"
  5712. (abbreviate-file-name buffer-file-name))))
  5713. (regexp (if with-hour
  5714. org-deadline-time-hour-regexp
  5715. org-deadline-time-regexp))
  5716. (today (org-today))
  5717. (today? (org-agenda-today-p date)) ; DATE bound by calendar.
  5718. (current (calendar-absolute-from-gregorian date))
  5719. deadline-items)
  5720. (goto-char (point-min))
  5721. (while (re-search-forward regexp nil t)
  5722. (catch :skip
  5723. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5724. (org-agenda-skip)
  5725. (let* ((s (match-string 1))
  5726. (pos (1- (match-beginning 1)))
  5727. (todo-state (save-match-data (org-get-todo-state)))
  5728. (done? (member todo-state org-done-keywords))
  5729. (sexp? (string-prefix-p "%%" s))
  5730. ;; DEADLINE is the deadline date for the entry. It is
  5731. ;; either the base date or the last repeat, according
  5732. ;; to `org-agenda-prefer-last-repeat'.
  5733. (deadline
  5734. (cond
  5735. (sexp? (org-agenda--timestamp-to-absolute s current))
  5736. ((or (eq org-agenda-prefer-last-repeat t)
  5737. (member todo-state org-agenda-prefer-last-repeat))
  5738. (org-agenda--timestamp-to-absolute
  5739. s today 'past (current-buffer) pos))
  5740. (t (org-agenda--timestamp-to-absolute s))))
  5741. ;; REPEAT is the future repeat closest from CURRENT,
  5742. ;; according to `org-agenda-show-future-repeats'. If
  5743. ;; the latter is nil, or if the time stamp has no
  5744. ;; repeat part, default to DEADLINE.
  5745. (repeat
  5746. (cond
  5747. (sexp? deadline)
  5748. ((<= current today) deadline)
  5749. ((not org-agenda-show-future-repeats) deadline)
  5750. (t
  5751. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5752. (1+ today)
  5753. current)))
  5754. (org-agenda--timestamp-to-absolute
  5755. s base 'future (current-buffer) pos)))))
  5756. (diff (- deadline current))
  5757. (suppress-prewarning
  5758. (let ((scheduled
  5759. (and org-agenda-skip-deadline-prewarning-if-scheduled
  5760. (org-entry-get nil "SCHEDULED"))))
  5761. (cond
  5762. ((not scheduled) nil)
  5763. ;; The current item has a scheduled date, so
  5764. ;; evaluate its prewarning lead time.
  5765. ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
  5766. ;; Use global prewarning-restart lead time.
  5767. org-agenda-skip-deadline-prewarning-if-scheduled)
  5768. ((eq org-agenda-skip-deadline-prewarning-if-scheduled
  5769. 'pre-scheduled)
  5770. ;; Set pre-warning to no earlier than SCHEDULED.
  5771. (min (- deadline
  5772. (org-agenda--timestamp-to-absolute scheduled))
  5773. org-deadline-warning-days))
  5774. ;; Set pre-warning to deadline.
  5775. (t 0))))
  5776. (wdays (or suppress-prewarning (org-get-wdays s))))
  5777. (cond
  5778. ;; Only display deadlines at their base date, at future
  5779. ;; repeat occurrences or in today agenda.
  5780. ((= current deadline) nil)
  5781. ((= current repeat) nil)
  5782. ((not today?) (throw :skip nil))
  5783. ;; Upcoming deadline: display within warning period WDAYS.
  5784. ((> deadline current) (when (> diff wdays) (throw :skip nil)))
  5785. ;; Overdue deadline: warn about it for
  5786. ;; `org-deadline-past-days' duration.
  5787. (t (when (< org-deadline-past-days (- diff)) (throw :skip nil))))
  5788. ;; Possibly skip done tasks.
  5789. (when (and done?
  5790. (or org-agenda-skip-deadline-if-done
  5791. (/= deadline current)))
  5792. (throw :skip nil))
  5793. (save-excursion
  5794. (re-search-backward "^\\*+[ \t]+" nil t)
  5795. (goto-char (match-end 0))
  5796. (let* ((category (org-get-category))
  5797. (level (make-string (org-reduced-level (org-outline-level))
  5798. ?\s))
  5799. (head (buffer-substring (point) (line-end-position)))
  5800. (inherited-tags
  5801. (or (eq org-agenda-show-inherited-tags 'always)
  5802. (and (listp org-agenda-show-inherited-tags)
  5803. (memq 'agenda org-agenda-show-inherited-tags))
  5804. (and (eq org-agenda-show-inherited-tags t)
  5805. (or (eq org-agenda-use-tag-inheritance t)
  5806. (memq 'agenda
  5807. org-agenda-use-tag-inheritance)))))
  5808. (tags (org-get-tags nil (not inherited-tags)))
  5809. (time
  5810. (cond
  5811. ;; No time of day designation if it is only
  5812. ;; a reminder.
  5813. ((and (/= current deadline) (/= current repeat)) nil)
  5814. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5815. (concat (substring s (match-beginning 1)) " "))
  5816. (t 'time)))
  5817. (item
  5818. (org-agenda-format-item
  5819. ;; Insert appropriate suffixes before deadlines.
  5820. ;; Those only apply to today agenda.
  5821. (pcase-let ((`(,now ,future ,past)
  5822. org-agenda-deadline-leaders))
  5823. (cond
  5824. ((and today? (< deadline today)) (format past (- diff)))
  5825. ((and today? (> deadline today)) (format future diff))
  5826. (t now)))
  5827. head level category tags time))
  5828. (face (org-agenda-deadline-face
  5829. (- 1 (/ (float diff) (max wdays 1)))))
  5830. (upcoming? (and today? (> deadline today)))
  5831. (warntime (get-text-property (point) 'org-appt-warntime)))
  5832. (org-add-props item props
  5833. 'org-marker (org-agenda-new-marker pos)
  5834. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  5835. 'warntime warntime
  5836. 'level level
  5837. 'ts-date deadline
  5838. 'priority
  5839. ;; Adjust priority to today reminders about deadlines.
  5840. ;; Overdue deadlines get the highest priority
  5841. ;; increase, then imminent deadlines and eventually
  5842. ;; more distant deadlines.
  5843. (let ((adjust (if today? (- diff) 0)))
  5844. (+ adjust (org-get-priority item)))
  5845. 'todo-state todo-state
  5846. 'type (if upcoming? "upcoming-deadline" "deadline")
  5847. 'date (if upcoming? date deadline)
  5848. 'face (if done? 'org-agenda-done face)
  5849. 'undone-face face
  5850. 'done-face 'org-agenda-done)
  5851. (push item deadline-items))))))
  5852. (nreverse deadline-items)))
  5853. (defun org-agenda-deadline-face (fraction)
  5854. "Return the face to displaying a deadline item.
  5855. FRACTION is what fraction of the head-warning time has passed."
  5856. (assoc-default fraction org-agenda-deadline-faces #'<=))
  5857. (defun org-agenda-get-scheduled (&optional deadlines with-hour)
  5858. "Return the scheduled information for agenda display.
  5859. Optional argument DEADLINES is a list of deadline items to be
  5860. displayed in agenda view. When WITH-HOUR is non-nil, only return
  5861. scheduled items with an hour specification like [h]h:mm."
  5862. (with-no-warnings (defvar date))
  5863. (let* ((props (list 'org-not-done-regexp org-not-done-regexp
  5864. 'org-todo-regexp org-todo-regexp
  5865. 'org-complex-heading-regexp org-complex-heading-regexp
  5866. 'done-face 'org-agenda-done
  5867. 'mouse-face 'highlight
  5868. 'help-echo
  5869. (format "mouse-2 or RET jump to Org file %s"
  5870. (abbreviate-file-name buffer-file-name))))
  5871. (regexp (if with-hour
  5872. org-scheduled-time-hour-regexp
  5873. org-scheduled-time-regexp))
  5874. (today (org-today))
  5875. (todayp (org-agenda-today-p date)) ; DATE bound by calendar.
  5876. (current (calendar-absolute-from-gregorian date))
  5877. (deadline-pos
  5878. (mapcar (lambda (d)
  5879. (let ((m (get-text-property 0 'org-hd-marker d)))
  5880. (and m (marker-position m))))
  5881. deadlines))
  5882. scheduled-items)
  5883. (goto-char (point-min))
  5884. (while (re-search-forward regexp nil t)
  5885. (catch :skip
  5886. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5887. (org-agenda-skip)
  5888. (let* ((s (match-string 1))
  5889. (pos (1- (match-beginning 1)))
  5890. (todo-state (save-match-data (org-get-todo-state)))
  5891. (donep (member todo-state org-done-keywords))
  5892. (sexp? (string-prefix-p "%%" s))
  5893. ;; SCHEDULE is the scheduled date for the entry. It is
  5894. ;; either the bare date or the last repeat, according
  5895. ;; to `org-agenda-prefer-last-repeat'.
  5896. (schedule
  5897. (cond
  5898. (sexp? (org-agenda--timestamp-to-absolute s current))
  5899. ((or (eq org-agenda-prefer-last-repeat t)
  5900. (member todo-state org-agenda-prefer-last-repeat))
  5901. (org-agenda--timestamp-to-absolute
  5902. s today 'past (current-buffer) pos))
  5903. (t (org-agenda--timestamp-to-absolute s))))
  5904. ;; REPEAT is the future repeat closest from CURRENT,
  5905. ;; according to `org-agenda-show-future-repeats'. If
  5906. ;; the latter is nil, or if the time stamp has no
  5907. ;; repeat part, default to SCHEDULE.
  5908. (repeat
  5909. (cond
  5910. (sexp? schedule)
  5911. ((<= current today) schedule)
  5912. ((not org-agenda-show-future-repeats) schedule)
  5913. (t
  5914. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5915. (1+ today)
  5916. current)))
  5917. (org-agenda--timestamp-to-absolute
  5918. s base 'future (current-buffer) pos)))))
  5919. (diff (- current schedule))
  5920. (warntime (get-text-property (point) 'org-appt-warntime))
  5921. (pastschedp (< schedule today))
  5922. (futureschedp (> schedule today))
  5923. (habitp (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  5924. (suppress-delay
  5925. (let ((deadline (and org-agenda-skip-scheduled-delay-if-deadline
  5926. (org-entry-get nil "DEADLINE"))))
  5927. (cond
  5928. ((not deadline) nil)
  5929. ;; The current item has a deadline date, so
  5930. ;; evaluate its delay time.
  5931. ((integerp org-agenda-skip-scheduled-delay-if-deadline)
  5932. ;; Use global delay time.
  5933. (- org-agenda-skip-scheduled-delay-if-deadline))
  5934. ((eq org-agenda-skip-scheduled-delay-if-deadline
  5935. 'post-deadline)
  5936. ;; Set delay to no later than DEADLINE.
  5937. (min (- schedule
  5938. (org-agenda--timestamp-to-absolute deadline))
  5939. org-scheduled-delay-days))
  5940. (t 0))))
  5941. (ddays
  5942. (cond
  5943. ;; Nullify delay when a repeater triggered already
  5944. ;; and the delay is of the form --Xd.
  5945. ((and (string-match-p "--[0-9]+[hdwmy]" s)
  5946. (> schedule (org-agenda--timestamp-to-absolute s)))
  5947. 0)
  5948. (suppress-delay
  5949. (let ((org-scheduled-delay-days suppress-delay))
  5950. (org-get-wdays s t t)))
  5951. (t (org-get-wdays s t)))))
  5952. ;; Display scheduled items at base date (SCHEDULE), today if
  5953. ;; scheduled before the current date, and at any repeat past
  5954. ;; today. However, skip delayed items and items that have
  5955. ;; been displayed for more than `org-scheduled-past-days'.
  5956. (unless (and todayp
  5957. habitp
  5958. (bound-and-true-p org-habit-show-all-today))
  5959. (when (or (and (> ddays 0) (< diff ddays))
  5960. (> diff (or (and habitp org-habit-scheduled-past-days)
  5961. org-scheduled-past-days))
  5962. (> schedule current)
  5963. (and (/= current schedule)
  5964. (/= current today)
  5965. (/= current repeat)))
  5966. (throw :skip nil)))
  5967. ;; Possibly skip done tasks.
  5968. (when (and donep
  5969. (or org-agenda-skip-scheduled-if-done
  5970. (/= schedule current)))
  5971. (throw :skip nil))
  5972. ;; Skip entry if it already appears as a deadline, per
  5973. ;; `org-agenda-skip-scheduled-if-deadline-is-shown'. This
  5974. ;; doesn't apply to habits.
  5975. (when (pcase org-agenda-skip-scheduled-if-deadline-is-shown
  5976. ((guard
  5977. (or (not (memq (line-beginning-position 0) deadline-pos))
  5978. habitp))
  5979. nil)
  5980. (`repeated-after-deadline
  5981. (let ((deadline (time-to-days
  5982. (org-get-deadline-time (point)))))
  5983. (and (<= schedule deadline) (> current deadline))))
  5984. (`not-today pastschedp)
  5985. (`t t)
  5986. (_ nil))
  5987. (throw :skip nil))
  5988. ;; Skip habits if `org-habit-show-habits' is nil, or if we
  5989. ;; only show them for today. Also skip done habits.
  5990. (when (and habitp
  5991. (or donep
  5992. (not (bound-and-true-p org-habit-show-habits))
  5993. (and (not todayp)
  5994. (bound-and-true-p
  5995. org-habit-show-habits-only-for-today))))
  5996. (throw :skip nil))
  5997. (save-excursion
  5998. (re-search-backward "^\\*+[ \t]+" nil t)
  5999. (goto-char (match-end 0))
  6000. (let* ((category (org-get-category))
  6001. (inherited-tags
  6002. (or (eq org-agenda-show-inherited-tags 'always)
  6003. (and (listp org-agenda-show-inherited-tags)
  6004. (memq 'agenda org-agenda-show-inherited-tags))
  6005. (and (eq org-agenda-show-inherited-tags t)
  6006. (or (eq org-agenda-use-tag-inheritance t)
  6007. (memq 'agenda
  6008. org-agenda-use-tag-inheritance)))))
  6009. (tags (org-get-tags nil (not inherited-tags)))
  6010. (level (make-string (org-reduced-level (org-outline-level))
  6011. ?\s))
  6012. (head (buffer-substring (point) (line-end-position)))
  6013. (time
  6014. (cond
  6015. ;; No time of day designation if it is only a
  6016. ;; reminder, except for habits, which always show
  6017. ;; the time of day. Habits are an exception
  6018. ;; because if there is a time of day, that is
  6019. ;; interpreted to mean they should usually happen
  6020. ;; then, even if doing the habit was missed.
  6021. ((and
  6022. (not habitp)
  6023. (/= current schedule)
  6024. (/= current repeat))
  6025. nil)
  6026. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  6027. (concat (substring s (match-beginning 1)) " "))
  6028. (t 'time)))
  6029. (item
  6030. (org-agenda-format-item
  6031. (pcase-let ((`(,first ,past) org-agenda-scheduled-leaders))
  6032. ;; Show a reminder of a past scheduled today.
  6033. (if (and todayp pastschedp)
  6034. (format past diff)
  6035. first))
  6036. head level category tags time nil habitp))
  6037. (face (cond ((and (not habitp) pastschedp)
  6038. 'org-scheduled-previously)
  6039. ((and habitp futureschedp)
  6040. 'org-agenda-done)
  6041. (todayp 'org-scheduled-today)
  6042. (t 'org-scheduled)))
  6043. (habitp (and habitp (org-habit-parse-todo))))
  6044. (org-add-props item props
  6045. 'undone-face face
  6046. 'face (if donep 'org-agenda-done face)
  6047. 'org-marker (org-agenda-new-marker pos)
  6048. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  6049. 'type (if pastschedp "past-scheduled" "scheduled")
  6050. 'date (if pastschedp schedule date)
  6051. 'ts-date schedule
  6052. 'warntime warntime
  6053. 'level level
  6054. 'priority (if habitp (org-habit-get-priority habitp)
  6055. (+ 99 diff (org-get-priority item)))
  6056. 'org-habit-p habitp
  6057. 'todo-state todo-state)
  6058. (push item scheduled-items))))))
  6059. (nreverse scheduled-items)))
  6060. (defun org-agenda-get-blocks ()
  6061. "Return the date-range information for agenda display."
  6062. (with-no-warnings (defvar date))
  6063. (let* ((props (list 'face nil
  6064. 'org-not-done-regexp org-not-done-regexp
  6065. 'org-todo-regexp org-todo-regexp
  6066. 'org-complex-heading-regexp org-complex-heading-regexp
  6067. 'mouse-face 'highlight
  6068. 'help-echo
  6069. (format "mouse-2 or RET jump to org file %s"
  6070. (abbreviate-file-name buffer-file-name))))
  6071. (regexp org-tr-regexp)
  6072. (d0 (calendar-absolute-from-gregorian date))
  6073. marker hdmarker ee txt d1 d2 s1 s2 category
  6074. level todo-state tags pos head donep inherited-tags)
  6075. (goto-char (point-min))
  6076. (while (re-search-forward regexp nil t)
  6077. (catch :skip
  6078. (org-agenda-skip)
  6079. (setq pos (point))
  6080. (let ((start-time (match-string 1))
  6081. (end-time (match-string 2)))
  6082. (setq s1 (match-string 1)
  6083. s2 (match-string 2)
  6084. d1 (time-to-days
  6085. (condition-case err
  6086. (org-time-string-to-time s1)
  6087. (error
  6088. (error
  6089. "Bad timestamp %S at %d in buffer %S\nError was: %s"
  6090. s1
  6091. pos
  6092. (current-buffer)
  6093. (error-message-string err)))))
  6094. d2 (time-to-days
  6095. (condition-case err
  6096. (org-time-string-to-time s2)
  6097. (error
  6098. (error
  6099. "Bad timestamp %S at %d in buffer %S\nError was: %s"
  6100. s2
  6101. pos
  6102. (current-buffer)
  6103. (error-message-string err))))))
  6104. (when (and (> (- d0 d1) -1) (> (- d2 d0) -1))
  6105. ;; Only allow days between the limits, because the normal
  6106. ;; date stamps will catch the limits.
  6107. (save-excursion
  6108. (setq todo-state (org-get-todo-state))
  6109. (setq donep (member todo-state org-done-keywords))
  6110. (when (and donep org-agenda-skip-timestamp-if-done)
  6111. (throw :skip t))
  6112. (setq marker (org-agenda-new-marker (point))
  6113. category (org-get-category))
  6114. (if (not (re-search-backward org-outline-regexp-bol nil t))
  6115. (throw :skip nil)
  6116. (goto-char (match-beginning 0))
  6117. (setq hdmarker (org-agenda-new-marker (point))
  6118. inherited-tags
  6119. (or (eq org-agenda-show-inherited-tags 'always)
  6120. (and (listp org-agenda-show-inherited-tags)
  6121. (memq 'agenda org-agenda-show-inherited-tags))
  6122. (and (eq org-agenda-show-inherited-tags t)
  6123. (or (eq org-agenda-use-tag-inheritance t)
  6124. (memq 'agenda org-agenda-use-tag-inheritance))))
  6125. tags (org-get-tags nil (not inherited-tags)))
  6126. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  6127. (looking-at "\\*+[ \t]+\\(.*\\)")
  6128. (setq head (match-string 1))
  6129. (let ((remove-re
  6130. (if org-agenda-remove-timeranges-from-blocks
  6131. (concat
  6132. "<" (regexp-quote s1) ".*?>"
  6133. "--"
  6134. "<" (regexp-quote s2) ".*?>")
  6135. nil)))
  6136. (setq txt (org-agenda-format-item
  6137. (format
  6138. (nth (if (= d1 d2) 0 1)
  6139. org-agenda-timerange-leaders)
  6140. (1+ (- d0 d1)) (1+ (- d2 d1)))
  6141. head level category tags
  6142. (save-match-data
  6143. (let ((hhmm1 (and (string-match org-ts-regexp1 s1)
  6144. (match-string 6 s1)))
  6145. (hhmm2 (and (string-match org-ts-regexp1 s2)
  6146. (match-string 6 s2))))
  6147. (cond ((string= hhmm1 hhmm2)
  6148. (concat "<" start-time ">--<" end-time ">"))
  6149. ((and (= d1 d0) (= d2 d0))
  6150. (concat "<" start-time ">--<" end-time ">"))
  6151. ((= d1 d0)
  6152. (concat "<" start-time ">"))
  6153. ((= d2 d0)
  6154. (concat "<" end-time ">")))))
  6155. remove-re))))
  6156. (org-add-props txt props
  6157. 'org-marker marker 'org-hd-marker hdmarker
  6158. 'type "block" 'date date
  6159. 'level level
  6160. 'todo-state todo-state
  6161. 'priority (org-get-priority txt))
  6162. (push txt ee))))
  6163. (goto-char pos)))
  6164. ;; Sort the entries by expiration date.
  6165. (nreverse ee)))
  6166. ;;; Agenda presentation and sorting
  6167. (defvar org-prefix-has-time nil
  6168. "A flag, set by `org-compile-prefix-format'.
  6169. The flag is set if the currently compiled format contains a `%t'.")
  6170. (defvar org-prefix-has-tag nil
  6171. "A flag, set by `org-compile-prefix-format'.
  6172. The flag is set if the currently compiled format contains a `%T'.")
  6173. (defvar org-prefix-has-effort nil
  6174. "A flag, set by `org-compile-prefix-format'.
  6175. The flag is set if the currently compiled format contains a `%e'.")
  6176. (defvar org-prefix-has-breadcrumbs nil
  6177. "A flag, set by `org-compile-prefix-format'.
  6178. The flag is set if the currently compiled format contains a `%b'.")
  6179. (defvar org-prefix-category-length nil
  6180. "Used by `org-compile-prefix-format' to remember the category field width.")
  6181. (defvar org-prefix-category-max-length nil
  6182. "Used by `org-compile-prefix-format' to remember the category field width.")
  6183. (defun org-agenda-get-category-icon (category)
  6184. "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
  6185. (cl-dolist (entry org-agenda-category-icon-alist)
  6186. (when (string-match-p (car entry) category)
  6187. (if (listp (cadr entry))
  6188. (cl-return (cadr entry))
  6189. (cl-return (apply #'create-image (cdr entry)))))))
  6190. (defun org-agenda-format-item (extra txt &optional with-level with-category tags dotime
  6191. remove-re habitp)
  6192. "Format TXT to be inserted into the agenda buffer.
  6193. In particular, add the prefix and corresponding text properties.
  6194. EXTRA must be a string to replace the `%s' specifier in the prefix format.
  6195. WITH-LEVEL may be a string to replace the `%l' specifier.
  6196. WITH-CATEGORY (a string, a symbol or nil) may be used to overrule the default
  6197. category taken from local variable or file name. It will replace the `%c'
  6198. specifier in the format.
  6199. DOTIME, when non-nil, indicates that a time-of-day should be extracted from
  6200. TXT for sorting of this entry, and for the `%t' specifier in the format.
  6201. When DOTIME is a string, this string is searched for a time before TXT is.
  6202. TAGS can be the tags of the headline.
  6203. Any match of REMOVE-RE will be removed from TXT."
  6204. ;; We keep the org-prefix-* variable values along with a compiled
  6205. ;; formatter, so that multiple agendas existing at the same time do
  6206. ;; not step on each other toes.
  6207. ;;
  6208. ;; It was inconvenient to make these variables buffer local in
  6209. ;; Agenda buffers, because this function expects to be called with
  6210. ;; the buffer where item comes from being current, and not agenda
  6211. ;; buffer
  6212. (let* ((bindings (car org-prefix-format-compiled))
  6213. (formatter (cadr org-prefix-format-compiled)))
  6214. (cl-loop for (var value) in bindings
  6215. do (set var value))
  6216. (save-match-data
  6217. ;; Diary entries sometimes have extra whitespace at the beginning
  6218. (setq txt (org-trim txt))
  6219. ;; Fix the tags part in txt
  6220. (setq txt (org-agenda-fix-displayed-tags
  6221. txt tags
  6222. org-agenda-show-inherited-tags
  6223. org-agenda-hide-tags-regexp))
  6224. (with-no-warnings
  6225. ;; `time', `tag', `effort' are needed for the eval of the prefix format.
  6226. ;; Based on what I see in `org-compile-prefix-format', I added
  6227. ;; a few more.
  6228. (defvar breadcrumbs) (defvar category) (defvar category-icon)
  6229. (defvar effort) (defvar extra)
  6230. (defvar level) (defvar tag) (defvar time))
  6231. (let* ((category (or with-category
  6232. (if buffer-file-name
  6233. (file-name-sans-extension
  6234. (file-name-nondirectory buffer-file-name))
  6235. "")))
  6236. (category-icon (org-agenda-get-category-icon category))
  6237. (category-icon (if category-icon
  6238. (propertize " " 'display category-icon)
  6239. ""))
  6240. (effort (and (not (string= txt ""))
  6241. (get-text-property 1 'effort txt)))
  6242. (tag (if tags (nth (1- (length tags)) tags) ""))
  6243. (time-grid-trailing-characters (nth 2 org-agenda-time-grid))
  6244. (extra (or (and (not habitp) extra) ""))
  6245. time
  6246. (ts (when dotime (concat
  6247. (if (stringp dotime) dotime "")
  6248. (and org-agenda-search-headline-for-time txt))))
  6249. (time-of-day (and dotime (org-get-time-of-day ts)))
  6250. stamp plain s0 s1 s2 rtn srp l
  6251. duration breadcrumbs)
  6252. (and (derived-mode-p 'org-mode) buffer-file-name
  6253. (add-to-list 'org-agenda-contributing-files buffer-file-name))
  6254. (when (and dotime time-of-day)
  6255. ;; Extract starting and ending time and move them to prefix
  6256. (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
  6257. (setq plain (string-match org-plain-time-of-day-regexp ts)))
  6258. (setq s0 (match-string 0 ts)
  6259. srp (and stamp (match-end 3))
  6260. s1 (match-string (if plain 1 2) ts)
  6261. s2 (match-string (if plain 8 (if srp 4 6)) ts))
  6262. ;; If the times are in TXT (not in DOTIMES), and the prefix will list
  6263. ;; them, we might want to remove them there to avoid duplication.
  6264. ;; The user can turn this off with a variable.
  6265. (when (and org-prefix-has-time
  6266. org-agenda-remove-times-when-in-prefix (or stamp plain)
  6267. (string-match (concat (regexp-quote s0) " *") txt)
  6268. (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
  6269. (if (eq org-agenda-remove-times-when-in-prefix 'beg)
  6270. (= (match-beginning 0) 0)
  6271. t))
  6272. (setq txt (replace-match "" nil nil txt))))
  6273. ;; Normalize the time(s) to 24 hour.
  6274. (when s1 (setq s1 (org-get-time-of-day s1 t)))
  6275. (when s2 (setq s2 (org-get-time-of-day s2 t)))
  6276. ;; Try to set s2 if s1 and
  6277. ;; `org-agenda-default-appointment-duration' are set
  6278. (when (and s1 (not s2) org-agenda-default-appointment-duration)
  6279. (setq s2
  6280. (org-duration-from-minutes
  6281. (+ (org-duration-to-minutes s1 t)
  6282. org-agenda-default-appointment-duration)
  6283. nil t)))
  6284. ;; Compute the duration
  6285. (when s2
  6286. (setq duration (- (org-duration-to-minutes s2)
  6287. (org-duration-to-minutes s1))))
  6288. ;; Format S1 and S2 for display.
  6289. (when s1 (setq s1 (org-get-time-of-day s1 'overtime)))
  6290. (when s2 (setq s2 (org-get-time-of-day s2 'overtime))))
  6291. (when (string-match org-tag-group-re txt)
  6292. ;; Tags are in the string
  6293. (if (or (eq org-agenda-remove-tags t)
  6294. (and org-agenda-remove-tags
  6295. org-prefix-has-tag))
  6296. (setq txt (replace-match "" t t txt))
  6297. (setq txt (replace-match
  6298. (concat (make-string (max (- 50 (length txt)) 1) ?\ )
  6299. (match-string 1 txt))
  6300. t t txt))))
  6301. (when remove-re
  6302. (while (string-match remove-re txt)
  6303. (setq txt (replace-match "" t t txt))))
  6304. ;; Set org-heading property on `txt' to mark the start of the
  6305. ;; heading.
  6306. (add-text-properties 0 (length txt) '(org-heading t) txt)
  6307. ;; Prepare the variables needed in the eval of the compiled format
  6308. (when org-prefix-has-breadcrumbs
  6309. (setq breadcrumbs (org-with-point-at (org-get-at-bol 'org-marker)
  6310. (let ((s (org-format-outline-path (org-get-outline-path)
  6311. (1- (frame-width))
  6312. nil org-agenda-breadcrumbs-separator)))
  6313. (if (eq "" s) "" (concat s org-agenda-breadcrumbs-separator))))))
  6314. (setq time (cond (s2 (concat
  6315. (org-agenda-time-of-day-to-ampm-maybe s1)
  6316. "-" (org-agenda-time-of-day-to-ampm-maybe s2)
  6317. (when org-agenda-timegrid-use-ampm " ")))
  6318. (s1 (concat
  6319. (org-agenda-time-of-day-to-ampm-maybe s1)
  6320. (if org-agenda-timegrid-use-ampm
  6321. (concat time-grid-trailing-characters " ")
  6322. time-grid-trailing-characters)))
  6323. (t ""))
  6324. category (if (symbolp category) (symbol-name category) category)
  6325. level (or with-level ""))
  6326. (if (string-match org-link-bracket-re category)
  6327. (progn
  6328. (setq l (string-width (or (match-string 2) (match-string 1))))
  6329. (when (< l (or org-prefix-category-length 0))
  6330. (setq category (copy-sequence category))
  6331. (org-add-props category nil
  6332. 'extra-space (make-string
  6333. (- org-prefix-category-length l 1) ?\ ))))
  6334. (when (and org-prefix-category-max-length
  6335. (>= (length category) org-prefix-category-max-length))
  6336. (setq category (substring category 0 (1- org-prefix-category-max-length)))))
  6337. ;; Evaluate the compiled format
  6338. (setq rtn (concat (eval formatter t) txt))
  6339. ;; And finally add the text properties
  6340. (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
  6341. (org-add-props rtn nil
  6342. 'org-category category
  6343. 'tags tags
  6344. 'org-priority-highest org-priority-highest
  6345. 'org-priority-lowest org-priority-lowest
  6346. 'time-of-day time-of-day
  6347. 'duration duration
  6348. 'breadcrumbs breadcrumbs
  6349. 'txt txt
  6350. 'level level
  6351. 'time time
  6352. 'extra extra
  6353. 'format org-prefix-format-compiled
  6354. 'dotime dotime)))))
  6355. (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
  6356. "Remove tags string from TXT, and add a modified list of tags.
  6357. The modified list may contain inherited tags, and tags matched by
  6358. `org-agenda-hide-tags-regexp' will be removed."
  6359. (when (or add-inherited hide-re)
  6360. (when (string-match org-tag-group-re txt)
  6361. (setq txt (substring txt 0 (match-beginning 0))))
  6362. (setq tags
  6363. (delq nil
  6364. (mapcar (lambda (tg)
  6365. (if (or (and hide-re (string-match hide-re tg))
  6366. (and (not add-inherited)
  6367. (get-text-property 0 'inherited tg)))
  6368. nil
  6369. tg))
  6370. tags)))
  6371. (when tags
  6372. (let ((have-i (get-text-property 0 'inherited (car tags)))
  6373. i)
  6374. (setq txt (concat txt " :"
  6375. (mapconcat
  6376. (lambda (x)
  6377. (setq i (get-text-property 0 'inherited x))
  6378. (if (and have-i (not i))
  6379. (progn
  6380. (setq have-i nil)
  6381. (concat ":" x))
  6382. x))
  6383. tags ":")
  6384. (if have-i "::" ":"))))))
  6385. txt)
  6386. (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
  6387. (defun org-agenda-add-time-grid-maybe (list ndays todayp)
  6388. "Add a time-grid for agenda items which need it.
  6389. LIST is the list of agenda items formatted by `org-agenda-list'.
  6390. NDAYS is the span of the current agenda view.
  6391. TODAYP is t when the current agenda view is on today."
  6392. (catch 'exit
  6393. (cond ((not org-agenda-use-time-grid) (throw 'exit list))
  6394. ((and todayp (member 'today (car org-agenda-time-grid))))
  6395. ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
  6396. ((member 'weekly (car org-agenda-time-grid)))
  6397. (t (throw 'exit list)))
  6398. (let* ((have (delq nil (mapcar
  6399. (lambda (x) (get-text-property 1 'time-of-day x))
  6400. list)))
  6401. (string (nth 3 org-agenda-time-grid))
  6402. (gridtimes (nth 1 org-agenda-time-grid))
  6403. (req (car org-agenda-time-grid))
  6404. (remove (member 'remove-match req))
  6405. new time)
  6406. (when (and (member 'require-timed req) (not have))
  6407. ;; don't show empty grid
  6408. (throw 'exit list))
  6409. (while (setq time (pop gridtimes))
  6410. (unless (and remove (member time have))
  6411. (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
  6412. (push (org-agenda-format-item
  6413. nil string nil "" nil
  6414. (concat (substring time 0 -2) ":" (substring time -2)))
  6415. new)
  6416. (put-text-property
  6417. 2 (length (car new)) 'face 'org-time-grid (car new))))
  6418. (when (and todayp org-agenda-show-current-time-in-grid)
  6419. (push (org-agenda-format-item
  6420. nil org-agenda-current-time-string nil "" nil
  6421. (format-time-string "%H:%M "))
  6422. new)
  6423. (put-text-property
  6424. 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
  6425. (if (member 'time-up org-agenda-sorting-strategy-selected)
  6426. (append new list)
  6427. (append list new)))))
  6428. (defun org-compile-prefix-format (key)
  6429. "Compile the prefix format into a Lisp form that can be evaluated.
  6430. The resulting form and associated variable bindings is returned
  6431. and stored in the variable `org-prefix-format-compiled'."
  6432. (setq org-prefix-has-time nil
  6433. org-prefix-has-tag nil
  6434. org-prefix-category-length nil
  6435. org-prefix-has-effort nil
  6436. org-prefix-has-breadcrumbs nil)
  6437. (let ((s (cond
  6438. ((stringp org-agenda-prefix-format)
  6439. org-agenda-prefix-format)
  6440. ((assq key org-agenda-prefix-format)
  6441. (cdr (assq key org-agenda-prefix-format)))
  6442. (t " %-12:c%?-12t% s")))
  6443. (start 0)
  6444. varform vars var c f opt) ;; e
  6445. (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cltseib]\\|(.+?)\\)"
  6446. s start)
  6447. (setq var (or (cdr (assoc (match-string 4 s)
  6448. '(("c" . category) ("t" . time) ("l" . level) ("s" . extra)
  6449. ("i" . category-icon) ("T" . tag) ("e" . effort) ("b" . breadcrumbs))))
  6450. 'eval)
  6451. c (or (match-string 3 s) "")
  6452. opt (match-beginning 1)
  6453. start (1+ (match-beginning 0)))
  6454. (cl-case var
  6455. (time (setq org-prefix-has-time t))
  6456. (tag (setq org-prefix-has-tag t))
  6457. (effort (setq org-prefix-has-effort t))
  6458. (breadcrumbs (setq org-prefix-has-breadcrumbs t)))
  6459. (setq f (concat "%" (match-string 2 s) "s"))
  6460. (when (eq var 'category)
  6461. (setq org-prefix-category-length
  6462. (floor (abs (string-to-number (match-string 2 s)))))
  6463. (setq org-prefix-category-max-length
  6464. (let ((x (match-string 2 s)))
  6465. (save-match-data
  6466. (and (string-match "\\.[0-9]+" x)
  6467. (string-to-number (substring (match-string 0 x) 1)))))))
  6468. (if (eq var 'eval)
  6469. (setq varform `(format ,f (org-eval ,(read (substring s (match-beginning 4))))))
  6470. (if opt
  6471. (setq varform
  6472. `(if (member ,var '("" nil))
  6473. ""
  6474. (format ,f (concat ,var ,c))))
  6475. (setq varform
  6476. `(format ,f (if (member ,var '("" nil)) ""
  6477. (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
  6478. (if (eq var 'eval)
  6479. (setf (substring s (match-beginning 0)
  6480. (+ (match-beginning 4)
  6481. (length (format "%S" (read (substring s (match-beginning 4)))))))
  6482. "%s")
  6483. (setq s (replace-match "%s" t nil s)))
  6484. (push varform vars))
  6485. (setq vars (nreverse vars))
  6486. (with-current-buffer (or org-agenda-buffer (current-buffer))
  6487. (setq org-prefix-format-compiled
  6488. (list
  6489. `((org-prefix-has-time ,org-prefix-has-time)
  6490. (org-prefix-has-tag ,org-prefix-has-tag)
  6491. (org-prefix-category-length ,org-prefix-category-length)
  6492. (org-prefix-has-effort ,org-prefix-has-effort)
  6493. (org-prefix-has-breadcrumbs ,org-prefix-has-breadcrumbs))
  6494. `(format ,s ,@vars))))))
  6495. (defun org-set-sorting-strategy (key)
  6496. (setq org-agenda-sorting-strategy-selected
  6497. (if (symbolp (car org-agenda-sorting-strategy))
  6498. ;; the old format
  6499. org-agenda-sorting-strategy
  6500. (or (cdr (assq key org-agenda-sorting-strategy))
  6501. (cdr (assq 'agenda org-agenda-sorting-strategy))
  6502. '(time-up category-keep priority-down)))))
  6503. (defun org-get-time-of-day (s &optional string)
  6504. "Check string S for a time of day.
  6505. If found, return it as a military time number between 0 and 2400.
  6506. If not found, return nil.
  6507. The optional STRING argument forces conversion into a 5 character wide string
  6508. HH:MM. When it is `overtime', any time above 24:00 is turned into \"+H:MM\"
  6509. where H:MM is the duration above midnight."
  6510. (let ((case-fold-search t)
  6511. (time-regexp
  6512. (rx word-start
  6513. (group (opt (any "012")) digit) ;group 1: hours
  6514. (or (and ":" (group (any "012345") digit) ;group 2: minutes
  6515. (opt (group (or "am" "pm")))) ;group 3: am/pm
  6516. ;; Special "HHam/pm" case.
  6517. (group-n 3 (or "am" "pm")))
  6518. word-end)))
  6519. (save-match-data
  6520. (when (and (string-match time-regexp s)
  6521. (not (eq 'org-link (get-text-property 1 'face s))))
  6522. (let ((hours
  6523. (let* ((ampm (and (match-end 3) (downcase (match-string 3 s))))
  6524. (am-p (equal ampm "am")))
  6525. (pcase (string-to-number (match-string 1 s))
  6526. ((and (guard (not ampm)) h) h)
  6527. (12 (if am-p 0 12))
  6528. (h (+ h (if am-p 0 12))))))
  6529. (minutes
  6530. (if (match-end 2)
  6531. (string-to-number (match-string 2 s))
  6532. 0)))
  6533. (pcase string
  6534. (`nil (+ minutes (* hours 100)))
  6535. ((and `overtime
  6536. (guard (or (> hours 24)
  6537. (and (= hours 24)
  6538. (> minutes 0)))))
  6539. (format "+%d:%02d" (- hours 24) minutes))
  6540. ((guard org-agenda-time-leading-zero)
  6541. (format "%02d:%02d" hours minutes))
  6542. (_
  6543. (format "%d:%02d" hours minutes))))))))
  6544. (defvar org-agenda-before-sorting-filter-function nil
  6545. "Function to be applied to agenda items prior to sorting.
  6546. Prior to sorting also means just before they are inserted into the agenda.
  6547. To aid sorting, you may revisit the original entries and add more text
  6548. properties which will later be used by the sorting functions.
  6549. The function should take a string argument, an agenda line.
  6550. It has access to the text properties in that line, which contain among
  6551. other things, the property `org-hd-marker' that points to the entry
  6552. where the line comes from. Note that not all lines going into the agenda
  6553. have this property, only most.
  6554. The function should return the modified string. It is probably best
  6555. to ONLY change text properties.
  6556. You can also use this function as a filter, by returning nil for lines
  6557. you don't want to have in the agenda at all. For this application, you
  6558. could bind the variable in the options section of a custom command.")
  6559. (defun org-agenda-finalize-entries (list &optional type)
  6560. "Sort, limit and concatenate the LIST of agenda items.
  6561. The optional argument TYPE tells the agenda type."
  6562. (let ((max-effort (cond ((listp org-agenda-max-effort)
  6563. (cdr (assoc type org-agenda-max-effort)))
  6564. (t org-agenda-max-effort)))
  6565. (max-todo (cond ((listp org-agenda-max-todos)
  6566. (cdr (assoc type org-agenda-max-todos)))
  6567. (t org-agenda-max-todos)))
  6568. (max-tags (cond ((listp org-agenda-max-tags)
  6569. (cdr (assoc type org-agenda-max-tags)))
  6570. (t org-agenda-max-tags)))
  6571. (max-entries (cond ((listp org-agenda-max-entries)
  6572. (cdr (assoc type org-agenda-max-entries)))
  6573. (t org-agenda-max-entries))))
  6574. (when org-agenda-before-sorting-filter-function
  6575. (setq list
  6576. (delq nil
  6577. (mapcar
  6578. org-agenda-before-sorting-filter-function list))))
  6579. (setq list (mapcar #'org-agenda-highlight-todo list)
  6580. list (mapcar #'identity (sort list #'org-entries-lessp)))
  6581. (when max-effort
  6582. (setq list (org-agenda-limit-entries
  6583. list 'effort-minutes max-effort
  6584. (lambda (e) (or e (if org-agenda-sort-noeffort-is-high
  6585. 32767 -1))))))
  6586. (when max-todo
  6587. (setq list (org-agenda-limit-entries list 'todo-state max-todo)))
  6588. (when max-tags
  6589. (setq list (org-agenda-limit-entries list 'tags max-tags)))
  6590. (when max-entries
  6591. (setq list (org-agenda-limit-entries list 'org-hd-marker max-entries)))
  6592. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  6593. (setq list (mapcar #'org-agenda--mark-blocked-entry list)))
  6594. (mapconcat #'identity list "\n")))
  6595. (defun org-agenda-limit-entries (list prop limit &optional fn)
  6596. "Limit the number of agenda entries."
  6597. (let ((include (and limit (< limit 0))))
  6598. (if limit
  6599. (let ((fun (or fn (lambda (p) (when p 1))))
  6600. (lim 0))
  6601. (delq nil
  6602. (mapcar
  6603. (lambda (e)
  6604. (let ((pval (funcall
  6605. fun (get-text-property (1- (length e))
  6606. prop e))))
  6607. (when pval (setq lim (+ lim pval)))
  6608. (cond ((and pval (<= lim (abs limit))) e)
  6609. ((and include (not pval)) e))))
  6610. list)))
  6611. list)))
  6612. (defun org-agenda-limit-interactively (remove)
  6613. "In agenda, interactively limit entries to various maximums."
  6614. (interactive "P")
  6615. (if remove
  6616. (progn (setq org-agenda-max-entries nil
  6617. org-agenda-max-todos nil
  6618. org-agenda-max-tags nil
  6619. org-agenda-max-effort nil)
  6620. (org-agenda-redo))
  6621. (let* ((max (read-char "Number of [e]ntries [t]odos [T]ags [E]ffort? "))
  6622. (msg (cond ((= max ?E) "How many minutes? ")
  6623. ((= max ?e) "How many entries? ")
  6624. ((= max ?t) "How many TODO entries? ")
  6625. ((= max ?T) "How many tagged entries? ")
  6626. (t (user-error "Wrong input"))))
  6627. (num (string-to-number (read-from-minibuffer msg))))
  6628. (cond ((equal max ?e)
  6629. (let ((org-agenda-max-entries num)) (org-agenda-redo)))
  6630. ((equal max ?t)
  6631. (let ((org-agenda-max-todos num)) (org-agenda-redo)))
  6632. ((equal max ?T)
  6633. (let ((org-agenda-max-tags num)) (org-agenda-redo)))
  6634. ((equal max ?E)
  6635. (let ((org-agenda-max-effort num)) (org-agenda-redo))))))
  6636. (org-agenda-fit-window-to-buffer))
  6637. (defun org-agenda-highlight-todo (x)
  6638. (let ((org-done-keywords org-done-keywords-for-agenda)
  6639. (case-fold-search nil)
  6640. re)
  6641. (if (eq x 'line)
  6642. (save-excursion
  6643. (beginning-of-line 1)
  6644. (setq re (org-get-at-bol 'org-todo-regexp))
  6645. (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
  6646. (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
  6647. (add-text-properties (match-beginning 0) (match-end 1)
  6648. (list 'face (org-get-todo-face 1)))
  6649. (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
  6650. (delete-region (match-beginning 1) (1- (match-end 0)))
  6651. (goto-char (match-beginning 1))
  6652. (insert (format org-agenda-todo-keyword-format s)))))
  6653. (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
  6654. (setq re (get-text-property 0 'org-todo-regexp x))
  6655. (when (and re
  6656. ;; Test `pl' because if there's no heading content,
  6657. ;; there's no point matching to highlight. Note
  6658. ;; that if we didn't test `pl' first, and there
  6659. ;; happened to be no keyword from `org-todo-regexp'
  6660. ;; on this heading line, then the `equal' comparison
  6661. ;; afterwards would spuriously succeed in the case
  6662. ;; where `pl' is nil -- causing an args-out-of-range
  6663. ;; error when we try to add text properties to text
  6664. ;; that isn't there.
  6665. pl
  6666. (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
  6667. x pl)
  6668. pl))
  6669. (add-text-properties
  6670. (or (match-end 1) (match-end 0)) (match-end 0)
  6671. (list 'face (org-get-todo-face (match-string 2 x)))
  6672. x)
  6673. (when (match-end 1)
  6674. (setq x
  6675. (concat
  6676. (substring x 0 (match-end 1))
  6677. (unless (string= org-agenda-todo-keyword-format "")
  6678. (format org-agenda-todo-keyword-format
  6679. (match-string 2 x)))
  6680. ;; Remove `display' property as the icon could leak
  6681. ;; on the white space.
  6682. (org-add-props " " (org-plist-delete (text-properties-at 0 x)
  6683. 'display))
  6684. (substring x (match-end 3)))))))
  6685. x)))
  6686. (defsubst org-cmp-values (a b property)
  6687. "Compare the numeric value of text PROPERTY for string A and B."
  6688. (let ((pa (or (get-text-property (1- (length a)) property a) 0))
  6689. (pb (or (get-text-property (1- (length b)) property b) 0)))
  6690. (cond ((> pa pb) +1)
  6691. ((< pa pb) -1))))
  6692. (defsubst org-cmp-effort (a b)
  6693. "Compare the effort values of string A and B."
  6694. (let* ((def (if org-agenda-sort-noeffort-is-high 32767 -1))
  6695. ;; `effort-minutes' property is not directly accessible from
  6696. ;; the strings, but is stored as a property in `txt'.
  6697. (ea (or (get-text-property
  6698. 0 'effort-minutes (get-text-property 0 'txt a))
  6699. def))
  6700. (eb (or (get-text-property
  6701. 0 'effort-minutes (get-text-property 0 'txt b))
  6702. def)))
  6703. (cond ((> ea eb) +1)
  6704. ((< ea eb) -1))))
  6705. (defsubst org-cmp-category (a b)
  6706. "Compare the string values of categories of strings A and B."
  6707. (let ((ca (or (get-text-property (1- (length a)) 'org-category a) ""))
  6708. (cb (or (get-text-property (1- (length b)) 'org-category b) "")))
  6709. (cond ((string-lessp ca cb) -1)
  6710. ((string-lessp cb ca) +1))))
  6711. (defsubst org-cmp-todo-state (a b)
  6712. "Compare the todo states of strings A and B."
  6713. (let* ((ma (or (get-text-property 1 'org-marker a)
  6714. (get-text-property 1 'org-hd-marker a)))
  6715. (mb (or (get-text-property 1 'org-marker b)
  6716. (get-text-property 1 'org-hd-marker b)))
  6717. (fa (and ma (marker-buffer ma)))
  6718. (fb (and mb (marker-buffer mb)))
  6719. (todo-kwds
  6720. (or (and fa (with-current-buffer fa org-todo-keywords-1))
  6721. (and fb (with-current-buffer fb org-todo-keywords-1))))
  6722. (ta (or (get-text-property 1 'todo-state a) ""))
  6723. (tb (or (get-text-property 1 'todo-state b) ""))
  6724. (la (- (length (member ta todo-kwds))))
  6725. (lb (- (length (member tb todo-kwds))))
  6726. (donepa (member ta org-done-keywords-for-agenda))
  6727. (donepb (member tb org-done-keywords-for-agenda)))
  6728. (cond ((and donepa (not donepb)) -1)
  6729. ((and (not donepa) donepb) +1)
  6730. ((< la lb) -1)
  6731. ((< lb la) +1))))
  6732. (defsubst org-cmp-alpha (a b)
  6733. "Compare the headlines, alphabetically."
  6734. (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
  6735. (plb (text-property-any 0 (length b) 'org-heading t b))
  6736. (ta (and pla (substring a pla)))
  6737. (tb (and plb (substring b plb)))
  6738. (case-fold-search nil))
  6739. (when pla
  6740. (when (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
  6741. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *")
  6742. ta)
  6743. (setq ta (substring ta (match-end 0))))
  6744. (setq ta (downcase ta)))
  6745. (when plb
  6746. (when (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
  6747. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *")
  6748. tb)
  6749. (setq tb (substring tb (match-end 0))))
  6750. (setq tb (downcase tb)))
  6751. (cond ((not (or ta tb)) nil)
  6752. ((not ta) +1)
  6753. ((not tb) -1)
  6754. ((string-lessp ta tb) -1)
  6755. ((string-lessp tb ta) +1))))
  6756. (defsubst org-cmp-tag (a b)
  6757. "Compare the string values of the first tags of A and B."
  6758. (let ((ta (car (last (get-text-property 1 'tags a))))
  6759. (tb (car (last (get-text-property 1 'tags b)))))
  6760. (cond ((not (or ta tb)) nil)
  6761. ((not ta) +1)
  6762. ((not tb) -1)
  6763. ((string-lessp ta tb) -1)
  6764. ((string-lessp tb ta) +1))))
  6765. (defsubst org-cmp-time (a b)
  6766. "Compare the time-of-day values of strings A and B."
  6767. (let* ((def (if org-agenda-sort-notime-is-late 9901 -1))
  6768. (ta (or (get-text-property 1 'time-of-day a) def))
  6769. (tb (or (get-text-property 1 'time-of-day b) def)))
  6770. (cond ((< ta tb) -1)
  6771. ((< tb ta) +1))))
  6772. (defsubst org-cmp-ts (a b type)
  6773. "Compare the timestamps values of entries A and B.
  6774. When TYPE is \"scheduled\", \"deadline\", \"timestamp\" or
  6775. \"timestamp_ia\", compare within each of these type. When TYPE
  6776. is the empty string, compare all timestamps without respect of
  6777. their type."
  6778. (let* ((def (and (not org-agenda-sort-notime-is-late) -1))
  6779. (ta (or (and (string-match type (or (get-text-property 1 'type a) ""))
  6780. (get-text-property 1 'ts-date a))
  6781. def))
  6782. (tb (or (and (string-match type (or (get-text-property 1 'type b) ""))
  6783. (get-text-property 1 'ts-date b))
  6784. def)))
  6785. (cond ((if ta (and tb (< ta tb)) tb) -1)
  6786. ((if tb (and ta (< tb ta)) ta) +1))))
  6787. (defsubst org-cmp-habit-p (a b)
  6788. "Compare the todo states of strings A and B."
  6789. (let ((ha (get-text-property 1 'org-habit-p a))
  6790. (hb (get-text-property 1 'org-habit-p b)))
  6791. (cond ((and ha (not hb)) -1)
  6792. ((and (not ha) hb) +1))))
  6793. (defun org-entries-lessp (a b)
  6794. "Predicate for sorting agenda entries."
  6795. ;; The following variables will be used when the form is evaluated.
  6796. ;; So even though the compiler complains, keep them.
  6797. (let ((ss org-agenda-sorting-strategy-selected))
  6798. (org-dlet
  6799. ((timestamp-up (and (org-em 'timestamp-up 'timestamp-down ss)
  6800. (org-cmp-ts a b "")))
  6801. (timestamp-down (if timestamp-up (- timestamp-up) nil))
  6802. (scheduled-up (and (org-em 'scheduled-up 'scheduled-down ss)
  6803. (org-cmp-ts a b "scheduled")))
  6804. (scheduled-down (if scheduled-up (- scheduled-up) nil))
  6805. (deadline-up (and (org-em 'deadline-up 'deadline-down ss)
  6806. (org-cmp-ts a b "deadline")))
  6807. (deadline-down (if deadline-up (- deadline-up) nil))
  6808. (tsia-up (and (org-em 'tsia-up 'tsia-down ss)
  6809. (org-cmp-ts a b "timestamp_ia")))
  6810. (tsia-down (if tsia-up (- tsia-up) nil))
  6811. (ts-up (and (org-em 'ts-up 'ts-down ss)
  6812. (org-cmp-ts a b "timestamp")))
  6813. (ts-down (if ts-up (- ts-up) nil))
  6814. (time-up (and (org-em 'time-up 'time-down ss)
  6815. (org-cmp-time a b)))
  6816. (time-down (if time-up (- time-up) nil))
  6817. (stats-up (and (org-em 'stats-up 'stats-down ss)
  6818. (org-cmp-values a b 'org-stats)))
  6819. (stats-down (if stats-up (- stats-up) nil))
  6820. (priority-up (and (org-em 'priority-up 'priority-down ss)
  6821. (org-cmp-values a b 'priority)))
  6822. (priority-down (if priority-up (- priority-up) nil))
  6823. (effort-up (and (org-em 'effort-up 'effort-down ss)
  6824. (org-cmp-effort a b)))
  6825. (effort-down (if effort-up (- effort-up) nil))
  6826. (category-up (and (or (org-em 'category-up 'category-down ss)
  6827. (memq 'category-keep ss))
  6828. (org-cmp-category a b)))
  6829. (category-down (if category-up (- category-up) nil))
  6830. (category-keep (if category-up +1 nil))
  6831. (tag-up (and (org-em 'tag-up 'tag-down ss)
  6832. (org-cmp-tag a b)))
  6833. (tag-down (if tag-up (- tag-up) nil))
  6834. (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
  6835. (org-cmp-todo-state a b)))
  6836. (todo-state-down (if todo-state-up (- todo-state-up) nil))
  6837. (habit-up (and (org-em 'habit-up 'habit-down ss)
  6838. (org-cmp-habit-p a b)))
  6839. (habit-down (if habit-up (- habit-up) nil))
  6840. (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
  6841. (org-cmp-alpha a b)))
  6842. (alpha-down (if alpha-up (- alpha-up) nil))
  6843. (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
  6844. user-defined-up user-defined-down)
  6845. (when (and need-user-cmp org-agenda-cmp-user-defined
  6846. (functionp org-agenda-cmp-user-defined))
  6847. (setq user-defined-up
  6848. (funcall org-agenda-cmp-user-defined a b)
  6849. user-defined-down (if user-defined-up (- user-defined-up) nil)))
  6850. (cdr (assoc
  6851. (eval (cons 'or org-agenda-sorting-strategy-selected) t)
  6852. '((-1 . t) (1 . nil) (nil . nil)))))))
  6853. ;;; Agenda restriction lock
  6854. (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
  6855. "Overlay to mark the headline to which agenda commands are restricted.")
  6856. (overlay-put org-agenda-restriction-lock-overlay
  6857. 'face 'org-agenda-restriction-lock)
  6858. (overlay-put org-agenda-restriction-lock-overlay
  6859. 'help-echo "Agendas are currently limited to this subtree.")
  6860. (delete-overlay org-agenda-restriction-lock-overlay)
  6861. (defun org-agenda-set-restriction-lock-from-agenda (arg)
  6862. "Set the restriction lock to the agenda item at point from within the agenda.
  6863. When called with a `\\[universal-argument]' prefix, restrict to
  6864. the file which contains the item.
  6865. Argument ARG is the prefix argument."
  6866. (interactive "P")
  6867. (unless (derived-mode-p 'org-agenda-mode)
  6868. (user-error "Not in an Org agenda buffer"))
  6869. (let* ((marker (or (org-get-at-bol 'org-marker)
  6870. (org-agenda-error)))
  6871. (buffer (marker-buffer marker))
  6872. (pos (marker-position marker)))
  6873. (with-current-buffer buffer
  6874. (goto-char pos)
  6875. (org-agenda-set-restriction-lock arg))))
  6876. ;;;###autoload
  6877. (defun org-agenda-set-restriction-lock (&optional type)
  6878. "Set restriction lock for agenda to current subtree or file.
  6879. When in a restricted subtree, remove it.
  6880. The restriction will span over the entire file if TYPE is `file',
  6881. or if type is '(4), or if the cursor is before the first headline
  6882. in the file. Otherwise, only apply the restriction to the current
  6883. subtree."
  6884. (interactive "P")
  6885. (if (and org-agenda-overriding-restriction
  6886. (member org-agenda-restriction-lock-overlay
  6887. (overlays-at (point)))
  6888. (equal (overlay-start org-agenda-restriction-lock-overlay)
  6889. (point)))
  6890. (org-agenda-remove-restriction-lock 'noupdate)
  6891. (org-agenda-remove-restriction-lock 'noupdate)
  6892. (and (equal type '(4)) (setq type 'file))
  6893. (setq type (cond
  6894. (type type)
  6895. ((org-at-heading-p) 'subtree)
  6896. ((condition-case nil (org-back-to-heading t) (error nil))
  6897. 'subtree)
  6898. (t 'file)))
  6899. (if (eq type 'subtree)
  6900. (progn
  6901. (setq org-agenda-restrict (current-buffer))
  6902. (setq org-agenda-overriding-restriction 'subtree)
  6903. (put 'org-agenda-files 'org-restrict
  6904. (list (buffer-file-name (buffer-base-buffer))))
  6905. (org-back-to-heading t)
  6906. (move-overlay org-agenda-restriction-lock-overlay
  6907. (point)
  6908. (if org-agenda-restriction-lock-highlight-subtree
  6909. (save-excursion (org-end-of-subtree t t) (point))
  6910. (point-at-eol)))
  6911. (move-marker org-agenda-restrict-begin (point))
  6912. (move-marker org-agenda-restrict-end
  6913. (save-excursion (org-end-of-subtree t t)))
  6914. (message "Locking agenda restriction to subtree"))
  6915. (put 'org-agenda-files 'org-restrict
  6916. (list (buffer-file-name (buffer-base-buffer))))
  6917. (setq org-agenda-restrict nil)
  6918. (setq org-agenda-overriding-restriction 'file)
  6919. (move-marker org-agenda-restrict-begin nil)
  6920. (move-marker org-agenda-restrict-end nil)
  6921. (message "Locking agenda restriction to file"))
  6922. (setq current-prefix-arg nil))
  6923. (org-agenda-maybe-redo))
  6924. (defun org-agenda-remove-restriction-lock (&optional noupdate)
  6925. "Remove agenda restriction lock."
  6926. (interactive "P")
  6927. (if (not org-agenda-restrict)
  6928. (message "No agenda restriction to remove.")
  6929. (delete-overlay org-agenda-restriction-lock-overlay)
  6930. (delete-overlay org-speedbar-restriction-lock-overlay)
  6931. (setq org-agenda-overriding-restriction nil)
  6932. (setq org-agenda-restrict nil)
  6933. (put 'org-agenda-files 'org-restrict nil)
  6934. (move-marker org-agenda-restrict-begin nil)
  6935. (move-marker org-agenda-restrict-end nil)
  6936. (setq current-prefix-arg nil)
  6937. (message "Agenda restriction lock removed")
  6938. (or noupdate (org-agenda-maybe-redo))))
  6939. (defun org-agenda-maybe-redo ()
  6940. "If there is any window showing the agenda view, update it."
  6941. (let ((w (get-buffer-window (or org-agenda-this-buffer-name
  6942. org-agenda-buffer-name)
  6943. t))
  6944. (w0 (selected-window)))
  6945. (when w
  6946. (select-window w)
  6947. (org-agenda-redo)
  6948. (select-window w0)
  6949. (if org-agenda-overriding-restriction
  6950. (message "Agenda view shifted to new %s restriction"
  6951. org-agenda-overriding-restriction)
  6952. (message "Agenda restriction lock removed")))))
  6953. ;;; Agenda commands
  6954. (defun org-agenda-check-type (error &rest types)
  6955. "Check if agenda buffer or component is of allowed type.
  6956. If ERROR is non-nil, throw an error, otherwise just return nil.
  6957. Allowed types are `agenda' `todo' `tags' `search'."
  6958. (cond ((not org-agenda-type)
  6959. (error "No Org agenda currently displayed"))
  6960. ((memq org-agenda-type types) t)
  6961. (error
  6962. (error "Not allowed in '%s'-type agenda buffer or component" org-agenda-type))
  6963. (t nil)))
  6964. (defun org-agenda-Quit ()
  6965. "Exit the agenda, killing the agenda buffer.
  6966. Like `org-agenda-quit', but kill the buffer even when
  6967. `org-agenda-sticky' is non-nil."
  6968. (interactive)
  6969. (org-agenda--quit))
  6970. (defun org-agenda-quit ()
  6971. "Exit the agenda.
  6972. When `org-agenda-sticky' is non-nil, bury the agenda buffer
  6973. instead of killing it.
  6974. When `org-agenda-restore-windows-after-quit' is non-nil, restore
  6975. the pre-agenda window configuration.
  6976. When column view is active, exit column view instead of the
  6977. agenda."
  6978. (interactive)
  6979. (org-agenda--quit org-agenda-sticky))
  6980. (defun org-agenda--quit (&optional bury)
  6981. (if org-agenda-columns-active
  6982. (org-columns-quit)
  6983. (let ((wconf org-agenda-pre-window-conf)
  6984. (buf (current-buffer))
  6985. (org-agenda-last-indirect-window
  6986. (and (eq org-indirect-buffer-display 'other-window)
  6987. org-agenda-last-indirect-buffer
  6988. (get-buffer-window org-agenda-last-indirect-buffer))))
  6989. (cond
  6990. ((eq org-agenda-window-setup 'other-frame)
  6991. (delete-frame))
  6992. ((eq org-agenda-window-setup 'other-tab)
  6993. (if (fboundp 'tab-bar-close-tab)
  6994. (tab-bar-close-tab)
  6995. (user-error "Your version of Emacs does not have tab bar mode support")))
  6996. ((and org-agenda-restore-windows-after-quit
  6997. wconf)
  6998. ;; Maybe restore the pre-agenda window configuration. Reset
  6999. ;; `org-agenda-pre-window-conf' before running
  7000. ;; `set-window-configuration', which loses the current buffer.
  7001. (setq org-agenda-pre-window-conf nil)
  7002. (set-window-configuration wconf))
  7003. (t
  7004. (when org-agenda-last-indirect-window
  7005. (delete-window org-agenda-last-indirect-window))
  7006. (and (not (eq org-agenda-window-setup 'current-window))
  7007. (not (one-window-p))
  7008. (delete-window))))
  7009. (if bury
  7010. ;; Set the agenda buffer as the current buffer instead of
  7011. ;; passing it as an argument to `bury-buffer' so that
  7012. ;; `bury-buffer' removes it from the window.
  7013. (with-current-buffer buf
  7014. (bury-buffer))
  7015. (kill-buffer buf)
  7016. (setq org-agenda-archives-mode nil
  7017. org-agenda-buffer nil)))))
  7018. (defun org-agenda-exit ()
  7019. "Exit the agenda, killing Org buffers loaded by the agenda.
  7020. Like `org-agenda-Quit', but kill any buffers that were created by
  7021. the agenda. Org buffers visited directly by the user will not be
  7022. touched. Also, exit the agenda even if it is in column view."
  7023. (interactive)
  7024. (when org-agenda-columns-active
  7025. (org-columns-quit))
  7026. (org-release-buffers org-agenda-new-buffers)
  7027. (setq org-agenda-new-buffers nil)
  7028. (org-agenda-Quit))
  7029. (defun org-agenda-kill-all-agenda-buffers ()
  7030. "Kill all buffers in `org-agenda-mode'.
  7031. This is used when toggling sticky agendas."
  7032. (interactive)
  7033. (let (blist)
  7034. (dolist (buf (buffer-list))
  7035. (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
  7036. (push buf blist)))
  7037. (mapc #'kill-buffer blist)))
  7038. (defun org-agenda-execute (arg)
  7039. "Execute another agenda command, keeping same window.
  7040. So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
  7041. in the agenda."
  7042. (interactive "P")
  7043. (let ((org-agenda-window-setup 'current-window))
  7044. (org-agenda arg)))
  7045. (defun org-agenda-redo (&optional all)
  7046. "Rebuild possibly ALL agenda view(s) in the current buffer."
  7047. (interactive "P")
  7048. (defvar org-agenda-tag-filter-while-redo) ;FIXME: Where is this var used?
  7049. (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
  7050. (cpa (unless (eq all t) current-prefix-arg))
  7051. (org-agenda-doing-sticky-redo org-agenda-sticky)
  7052. (org-agenda-sticky nil)
  7053. (org-agenda-buffer-name (or org-agenda-this-buffer-name
  7054. org-agenda-buffer-name))
  7055. (org-agenda-keep-modes t)
  7056. (tag-filter org-agenda-tag-filter)
  7057. (tag-preset (get 'org-agenda-tag-filter :preset-filter))
  7058. (top-hl-filter org-agenda-top-headline-filter)
  7059. (cat-filter org-agenda-category-filter)
  7060. (cat-preset (get 'org-agenda-category-filter :preset-filter))
  7061. (re-filter org-agenda-regexp-filter)
  7062. (re-preset (get 'org-agenda-regexp-filter :preset-filter))
  7063. (effort-filter org-agenda-effort-filter)
  7064. (effort-preset (get 'org-agenda-effort-filter :preset-filter))
  7065. (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
  7066. (cols org-agenda-columns-active)
  7067. (line (org-current-line))
  7068. (window-line (- line (org-current-line (window-start))))
  7069. (lprops (get 'org-agenda-redo-command 'org-lprops))
  7070. (redo-cmd (get-text-property p 'org-redo-cmd))
  7071. (last-args (get-text-property p 'org-last-args))
  7072. (org-agenda-overriding-cmd (get-text-property p 'org-series-cmd))
  7073. (org-agenda-overriding-cmd-arguments
  7074. (unless (eq all t)
  7075. (cond ((listp last-args)
  7076. (cons (or cpa (car last-args)) (cdr last-args)))
  7077. ((stringp last-args)
  7078. last-args))))
  7079. (series-redo-cmd (get-text-property p 'org-series-redo-cmd)))
  7080. (put 'org-agenda-tag-filter :preset-filter nil)
  7081. (put 'org-agenda-category-filter :preset-filter nil)
  7082. (put 'org-agenda-regexp-filter :preset-filter nil)
  7083. (put 'org-agenda-effort-filter :preset-filter nil)
  7084. (and cols (org-columns-quit))
  7085. (message "Rebuilding agenda buffer...")
  7086. (if series-redo-cmd
  7087. (eval series-redo-cmd t)
  7088. (cl-progv
  7089. (mapcar #'car lprops)
  7090. (mapcar (lambda (binding) (eval (cadr binding) t)) lprops)
  7091. (eval redo-cmd t)))
  7092. (setq org-agenda-undo-list nil
  7093. org-agenda-pending-undo-list nil
  7094. org-agenda-tag-filter tag-filter
  7095. org-agenda-category-filter cat-filter
  7096. org-agenda-regexp-filter re-filter
  7097. org-agenda-effort-filter effort-filter
  7098. org-agenda-top-headline-filter top-hl-filter)
  7099. (message "Rebuilding agenda buffer...done")
  7100. (put 'org-agenda-tag-filter :preset-filter tag-preset)
  7101. (put 'org-agenda-category-filter :preset-filter cat-preset)
  7102. (put 'org-agenda-regexp-filter :preset-filter re-preset)
  7103. (put 'org-agenda-effort-filter :preset-filter effort-preset)
  7104. (let ((tag (or tag-filter tag-preset))
  7105. (cat (or cat-filter cat-preset))
  7106. (effort (or effort-filter effort-preset))
  7107. (re (or re-filter re-preset)))
  7108. (when tag (org-agenda-filter-apply tag 'tag t))
  7109. (when cat (org-agenda-filter-apply cat 'category))
  7110. (when effort (org-agenda-filter-apply effort 'effort))
  7111. (when re (org-agenda-filter-apply re 'regexp)))
  7112. (and top-hl-filter (org-agenda-filter-top-headline-apply top-hl-filter))
  7113. (and cols (called-interactively-p 'any) (org-agenda-columns))
  7114. (org-goto-line line)
  7115. (when (called-interactively-p 'any) (recenter window-line))))
  7116. (defun org-agenda-redo-all (&optional exhaustive)
  7117. "Rebuild all agenda views in the current buffer.
  7118. With a prefix argument, do so in all agenda buffers."
  7119. (interactive "P")
  7120. (if exhaustive
  7121. (dolist (buffer (buffer-list))
  7122. (with-current-buffer buffer
  7123. (when (derived-mode-p 'org-agenda-mode)
  7124. (org-agenda-redo t))))
  7125. (org-agenda-redo t)))
  7126. (defvar org-global-tags-completion-table nil)
  7127. (defvar org-agenda-filter-form nil)
  7128. (defvar org-agenda-filtered-by-category nil)
  7129. (defsubst org-agenda-get-category ()
  7130. "Return the category of the agenda line."
  7131. (org-get-at-bol 'org-category))
  7132. (defun org-agenda-filter-by-category (strip)
  7133. "Filter lines in the agenda buffer that have a specific category.
  7134. The category is that of the current line.
  7135. With a `\\[universal-argument]' prefix argument, exclude the lines of that category.
  7136. When there is already a category filter in place, this command removes the
  7137. filter."
  7138. (interactive "P")
  7139. (if (and org-agenda-filtered-by-category
  7140. org-agenda-category-filter)
  7141. (org-agenda-filter-show-all-cat)
  7142. (let ((cat (org-no-properties (org-get-at-eol 'org-category 1))))
  7143. (cond
  7144. ((and cat strip)
  7145. (org-agenda-filter-apply
  7146. (push (concat "-" cat) org-agenda-category-filter) 'category))
  7147. (cat
  7148. (org-agenda-filter-apply
  7149. (setq org-agenda-category-filter
  7150. (list (concat "+" cat)))
  7151. 'category))
  7152. (t (error "No category at point"))))))
  7153. (defun org-find-top-headline (&optional pos)
  7154. "Find the topmost parent headline and return it.
  7155. POS when non-nil is the marker or buffer position to start the
  7156. search from."
  7157. (save-excursion
  7158. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  7159. (when pos (goto-char pos))
  7160. ;; Skip up to the topmost parent.
  7161. (while (org-up-heading-safe))
  7162. (ignore-errors
  7163. (replace-regexp-in-string
  7164. "^\\[[0-9]+/[0-9]+\\] *\\|^\\[%[0-9]+\\] *" ""
  7165. (nth 4 (org-heading-components)))))))
  7166. (defvar org-agenda-filtered-by-top-headline nil)
  7167. (defun org-agenda-filter-by-top-headline (strip)
  7168. "Keep only those lines that are descendants from the same top headline.
  7169. The top headline is that of the current line. With prefix arg STRIP, hide
  7170. all lines of the category at point."
  7171. (interactive "P")
  7172. (if org-agenda-filtered-by-top-headline
  7173. (progn
  7174. (setq org-agenda-filtered-by-top-headline nil
  7175. org-agenda-top-headline-filter nil)
  7176. (org-agenda-filter-show-all-top-filter))
  7177. (let ((toph (org-find-top-headline (org-get-at-bol 'org-hd-marker))))
  7178. (if toph (org-agenda-filter-top-headline-apply toph strip)
  7179. (error "No top-level headline at point")))))
  7180. (defvar org-agenda-regexp-filter nil)
  7181. (defun org-agenda-filter-by-regexp (strip-or-accumulate)
  7182. "Filter agenda entries by a regular expressions.
  7183. You will be prompted for the regular expression, and the agenda
  7184. view will only show entries that are matched by that expression.
  7185. With one `\\[universal-argument]' prefix argument, hide entries matching the regexp.
  7186. When there is already a regexp filter active, this command removed the
  7187. filter. However, with two `\\[universal-argument]' prefix arguments, add a new condition to
  7188. an already existing regexp filter."
  7189. (interactive "P")
  7190. (let* ((strip (equal strip-or-accumulate '(4)))
  7191. (accumulate (equal strip-or-accumulate '(16))))
  7192. (cond
  7193. ((and org-agenda-regexp-filter (not accumulate))
  7194. (org-agenda-filter-show-all-re)
  7195. (message "Regexp filter removed"))
  7196. (t (let ((flt (concat (if strip "-" "+")
  7197. (read-from-minibuffer
  7198. (if strip
  7199. "Hide entries matching regexp: "
  7200. "Narrow to entries matching regexp: ")))))
  7201. (push flt org-agenda-regexp-filter)
  7202. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))))))
  7203. (defvar org-agenda-effort-filter nil)
  7204. (defun org-agenda-filter-by-effort (strip-or-accumulate)
  7205. "Filter agenda entries by effort.
  7206. With no `\\[universal-argument]' prefix argument, keep entries matching the effort condition.
  7207. With one `\\[universal-argument]' prefix argument, filter out entries matching the condition.
  7208. With two `\\[universal-argument]' prefix arguments, add a second condition to the existing filter.
  7209. This last option is in practice not very useful, but it is available for
  7210. consistency with the other filter commands."
  7211. (interactive "P")
  7212. (let* ((efforts (split-string
  7213. (or (cdr (assoc-string (concat org-effort-property "_ALL")
  7214. org-global-properties
  7215. t))
  7216. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00")))
  7217. ;; XXX: the following handles only up to 10 different
  7218. ;; effort values.
  7219. (allowed-keys (if (null efforts) nil
  7220. (mapcar (lambda (n) (mod n 10)) ;turn 10 into 0
  7221. (number-sequence 1 (length efforts)))))
  7222. (keep (equal strip-or-accumulate '(16)))
  7223. (negative (equal strip-or-accumulate '(4)))
  7224. (current org-agenda-effort-filter)
  7225. (op nil))
  7226. (while (not (memq op '(?< ?> ?= ?_)))
  7227. (setq op (read-char-exclusive
  7228. "Effort operator? (> = or <) or press `_' again to remove filter")))
  7229. ;; Select appropriate duration. Ignore non-digit characters.
  7230. (if (eq op ?_)
  7231. (progn
  7232. (org-agenda-filter-show-all-effort)
  7233. (message "Effort filter removed"))
  7234. (let ((prompt
  7235. (apply #'format
  7236. (concat "Effort %c "
  7237. (mapconcat (lambda (s) (concat "[%d]" s))
  7238. efforts
  7239. " "))
  7240. op allowed-keys))
  7241. (eff -1))
  7242. (while (not (memq eff allowed-keys))
  7243. (message prompt)
  7244. (setq eff (- (read-char-exclusive) 48)))
  7245. (org-agenda-filter-show-all-effort)
  7246. (setq org-agenda-effort-filter
  7247. (append
  7248. (list (concat (if negative "-" "+")
  7249. (char-to-string op)
  7250. ;; Numbering is 1 2 3 ... 9 0, but we want
  7251. ;; 0 1 2 ... 8 9.
  7252. (nth (mod (1- eff) 10) efforts)))
  7253. (if keep current nil)))
  7254. (org-agenda-filter-apply org-agenda-effort-filter 'effort)))))
  7255. (defun org-agenda-filter (&optional strip-or-accumulate)
  7256. "Prompt for a general filter string and apply it to the agenda.
  7257. The string may contain filter elements like
  7258. +category
  7259. +tag
  7260. +<effort > and = are also allowed as effort operators
  7261. +/regexp/
  7262. Instead of `+', `-' is allowed to strip the agenda of matching entries.
  7263. `+' is optional if it is not required to separate two string parts.
  7264. Multiple filter elements can be concatenated without spaces, for example
  7265. +work-John<0:10-/plot/
  7266. selects entries with category `work' and effort estimates below 10 minutes,
  7267. and deselects entries with tag `John' or matching the regexp `plot'.
  7268. During entry of the filter, completion for tags, categories and effort
  7269. values is offered. Since the syntax for categories and tags is identical
  7270. there should be no overlap between categories and tags. If there is, tags
  7271. get priority.
  7272. A single `\\[universal-argument]' prefix arg STRIP-OR-ACCUMULATE will negate the
  7273. entire filter, which can be useful in connection with the prompt history.
  7274. A double `\\[universal-argument] \\[universal-argument]' prefix arg will add the new filter elements to the
  7275. existing ones. A shortcut for this is to add an additional `+' at the
  7276. beginning of the string, like `+-John'.
  7277. With a triple prefix argument, execute the computed filtering defined in
  7278. the variable `org-agenda-auto-exclude-function'."
  7279. (interactive "P")
  7280. (if (equal strip-or-accumulate '(64))
  7281. ;; Execute the auto-exclude action
  7282. (if (not org-agenda-auto-exclude-function)
  7283. (user-error "`org-agenda-auto-exclude-function' is undefined")
  7284. (org-agenda-filter-show-all-tag)
  7285. (setq org-agenda-tag-filter nil)
  7286. (dolist (tag (org-agenda-get-represented-tags))
  7287. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  7288. (when modifier
  7289. (push modifier org-agenda-tag-filter))))
  7290. (unless (null org-agenda-tag-filter)
  7291. (org-agenda-filter-apply org-agenda-tag-filter 'tag 'expand)))
  7292. ;; Prompt for a filter and act
  7293. (let* ((tag-list (org-agenda-get-represented-tags))
  7294. (category-list (org-agenda-get-represented-categories))
  7295. (negate (equal strip-or-accumulate '(4)))
  7296. (cf (mapconcat #'identity org-agenda-category-filter ""))
  7297. (tf (mapconcat #'identity org-agenda-tag-filter ""))
  7298. ;; (rpl-fn (lambda (c) (replace-regexp-in-string "^\\+" "" (or (car c) ""))))
  7299. (ef (replace-regexp-in-string "^\\+" "" (or (car org-agenda-effort-filter) "")))
  7300. (rf (replace-regexp-in-string "^\\+" "" (or (car org-agenda-regexp-filter) "")))
  7301. (ff (concat cf tf ef (when (not (equal rf "")) (concat "/" rf "/"))))
  7302. (f-string (completing-read
  7303. (concat
  7304. (if negate "Negative filter" "Filter")
  7305. " [+cat-tag<0:10-/regexp/]: ")
  7306. #'org-agenda-filter-completion-function
  7307. nil nil ff))
  7308. (keep (or (if (string-match "^\\+[+-]" f-string)
  7309. (progn (setq f-string (substring f-string 1)) t))
  7310. (equal strip-or-accumulate '(16))))
  7311. (fc (if keep org-agenda-category-filter))
  7312. (ft (if keep org-agenda-tag-filter))
  7313. (fe (if keep org-agenda-effort-filter))
  7314. (fr (if keep org-agenda-regexp-filter))
  7315. pm s)
  7316. ;; If the filter contains a double-quoted string, replace a
  7317. ;; single hyphen by the arbitrary and temporary string "~~~"
  7318. ;; to disambiguate such hyphens from syntactic ones.
  7319. (setq f-string (replace-regexp-in-string
  7320. "\"\\([^\"]*\\)-\\([^\"]*\\)\"" "\"\\1~~~\\2\"" f-string))
  7321. (while (string-match "^[ \t]*\\([-+]\\)?\\(\\([^-+<>=/ \t]+\\)\\|\\([<>=][0-9:]+\\)\\|\\(/\\([^/]+\\)/?\\)\\)" f-string)
  7322. (setq pm (if (match-beginning 1) (match-string 1 f-string) "+"))
  7323. (when negate
  7324. (setq pm (if (equal pm "+") "-" "+")))
  7325. (cond
  7326. ((match-beginning 3)
  7327. ;; category or tag
  7328. (setq s (replace-regexp-in-string ; Remove the temporary special string.
  7329. "~~~" "-" (match-string 3 f-string)))
  7330. (cond
  7331. ((member s tag-list)
  7332. (org-pushnew-to-end (concat pm s) ft))
  7333. ((member s category-list)
  7334. (org-pushnew-to-end (concat pm ; Remove temporary double quotes.
  7335. (replace-regexp-in-string "\"\\(.*\\)\"" "\\1" s))
  7336. fc))
  7337. (t (message
  7338. "`%s%s' filter ignored because tag/category is not represented"
  7339. pm s))))
  7340. ((match-beginning 4)
  7341. ;; effort
  7342. (org-pushnew-to-end (concat pm (match-string 4 f-string)) fe))
  7343. ((match-beginning 5)
  7344. ;; regexp
  7345. (org-pushnew-to-end (concat pm (match-string 6 f-string)) fr)))
  7346. (setq f-string (substring f-string (match-end 0))))
  7347. (org-agenda-filter-remove-all)
  7348. (and fc (org-agenda-filter-apply
  7349. (setq org-agenda-category-filter fc) 'category))
  7350. (and ft (org-agenda-filter-apply
  7351. (setq org-agenda-tag-filter ft) 'tag 'expand))
  7352. (and fe (org-agenda-filter-apply
  7353. (setq org-agenda-effort-filter fe) 'effort))
  7354. (and fr (org-agenda-filter-apply
  7355. (setq org-agenda-regexp-filter fr) 'regexp))
  7356. (run-hooks 'org-agenda-filter-hook))))
  7357. (defun org-agenda-filter-completion-function (string _predicate &optional flag)
  7358. "Complete a complex filter string.
  7359. FLAG specifies the type of completion operation to perform. This
  7360. function is passed as a collection function to `completing-read',
  7361. which see."
  7362. (let ((completion-ignore-case t) ;tags are case-sensitive
  7363. (confirm (lambda (x) (stringp x)))
  7364. (prefix "")
  7365. (operator "")
  7366. table)
  7367. (when (string-match "^\\(.*\\([-+<>=]\\)\\)\\([^-+<>=]*\\)$" string)
  7368. (setq prefix (match-string 1 string)
  7369. operator (match-string 2 string)
  7370. string (match-string 3 string)))
  7371. (cond
  7372. ((member operator '("+" "-" "" nil))
  7373. (setq table (append (org-agenda-get-represented-categories)
  7374. (org-agenda-get-represented-tags))))
  7375. ((member operator '("<" ">" "="))
  7376. (setq table (split-string
  7377. (or (cdr (assoc-string (concat org-effort-property "_ALL")
  7378. org-global-properties
  7379. t))
  7380. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00")
  7381. " +")))
  7382. (t (setq table nil)))
  7383. (pcase flag
  7384. (`t (all-completions string table confirm))
  7385. (`lambda (assoc string table)) ;exact match?
  7386. (`nil
  7387. (pcase (try-completion string table confirm)
  7388. ((and completion (pred stringp))
  7389. (concat prefix completion))
  7390. (completion completion)))
  7391. (_ nil))))
  7392. (defun org-agenda-filter-remove-all ()
  7393. "Remove all filters from the current agenda buffer."
  7394. (interactive)
  7395. (when org-agenda-tag-filter
  7396. (org-agenda-filter-show-all-tag))
  7397. (when org-agenda-category-filter
  7398. (org-agenda-filter-show-all-cat))
  7399. (when org-agenda-regexp-filter
  7400. (org-agenda-filter-show-all-re))
  7401. (when org-agenda-top-headline-filter
  7402. (org-agenda-filter-show-all-top-filter))
  7403. (when org-agenda-effort-filter
  7404. (org-agenda-filter-show-all-effort))
  7405. (org-agenda-finalize)
  7406. (when (called-interactively-p 'interactive)
  7407. (message "All agenda filters removed")))
  7408. (defun org-agenda-filter-by-tag (strip-or-accumulate &optional char exclude)
  7409. "Keep only those lines in the agenda buffer that have a specific tag.
  7410. The tag is selected with its fast selection letter, as configured.
  7411. With a `\\[universal-argument]' prefix, apply the filter negatively, stripping all matches.
  7412. With a `\\[universal-argument] \\[universal-argument]' prefix, add the new tag to the existing filter
  7413. instead of replacing it.
  7414. With a `\\[universal-argument] \\[universal-argument] \\[universal-argument]' prefix, filter the literal tag, \
  7415. i.e. don't
  7416. filter on all its group members.
  7417. A Lisp caller can specify CHAR. EXCLUDE means that the new tag
  7418. should be used to exclude the search - the interactive user can
  7419. also press `-' or `+' to switch between filtering and excluding."
  7420. (interactive "P")
  7421. (let* ((alist org-tag-alist-for-agenda)
  7422. (seen-chars nil)
  7423. (tag-chars (mapconcat
  7424. (lambda (x) (if (and (not (symbolp (car x)))
  7425. (cdr x)
  7426. (not (member (cdr x) seen-chars)))
  7427. (progn
  7428. (push (cdr x) seen-chars)
  7429. (char-to-string (cdr x)))
  7430. ""))
  7431. org-tag-alist-for-agenda ""))
  7432. (valid-char-list (append '(?\t ?\r ?\\ ?. ?\s ?q)
  7433. (string-to-list tag-chars)))
  7434. (exclude (or exclude (equal strip-or-accumulate '(4))))
  7435. (accumulate (equal strip-or-accumulate '(16)))
  7436. (expand (not (equal strip-or-accumulate '(64))))
  7437. (inhibit-read-only t)
  7438. (current org-agenda-tag-filter)
  7439. a tag) ;; n
  7440. (unless char
  7441. (while (not (memq char valid-char-list))
  7442. (org-unlogged-message
  7443. "%s by tag%s: [%s ]tag-char [TAB]tag %s[\\]off [q]uit"
  7444. (if exclude "Exclude[+]" "Filter[-]")
  7445. (if expand "" " (no grouptag expand)")
  7446. tag-chars
  7447. (if org-agenda-auto-exclude-function "[RET] " ""))
  7448. (setq char (read-char-exclusive))
  7449. ;; Excluding or filtering down
  7450. (cond ((eq char ?-) (setq exclude t))
  7451. ((eq char ?+) (setq exclude nil)))))
  7452. (when (eq char ?\t)
  7453. (unless (local-variable-p 'org-global-tags-completion-table)
  7454. (setq-local org-global-tags-completion-table
  7455. (org-global-tags-completion-table)))
  7456. (let ((completion-ignore-case t))
  7457. (setq tag (completing-read
  7458. "Tag: " org-global-tags-completion-table nil t))))
  7459. (cond
  7460. ((eq char ?\r)
  7461. (org-agenda-filter-show-all-tag)
  7462. (when org-agenda-auto-exclude-function
  7463. (setq org-agenda-tag-filter nil)
  7464. (dolist (tag (org-agenda-get-represented-tags))
  7465. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  7466. (when modifier
  7467. (push modifier org-agenda-tag-filter))))
  7468. (unless (null org-agenda-tag-filter)
  7469. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))))
  7470. ((eq char ?\\)
  7471. (org-agenda-filter-show-all-tag)
  7472. (when (get 'org-agenda-tag-filter :preset-filter)
  7473. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand)))
  7474. ((eq char ?.)
  7475. (setq org-agenda-tag-filter
  7476. (mapcar (lambda(tag) (concat "+" tag))
  7477. (org-get-at-bol 'tags)))
  7478. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  7479. ((eq char ?q)) ;If q, abort (even if there is a q-key for a tag...)
  7480. ((or (eq char ?\s)
  7481. (setq a (rassoc char alist))
  7482. (and tag (setq a (cons tag nil))))
  7483. (org-agenda-filter-show-all-tag)
  7484. (setq tag (car a))
  7485. (setq org-agenda-tag-filter
  7486. (cons (concat (if exclude "-" "+") tag)
  7487. (if accumulate current nil)))
  7488. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  7489. (t (error "Invalid tag selection character %c" char)))))
  7490. (defun org-agenda-get-represented-categories ()
  7491. "Return a list of all categories used in this agenda buffer."
  7492. (or org-agenda-represented-categories
  7493. (when (derived-mode-p 'org-agenda-mode)
  7494. (let ((pos (point-min)) categories)
  7495. (while (and (< pos (point-max))
  7496. (setq pos (next-single-property-change
  7497. pos 'org-category nil (point-max))))
  7498. (push (get-text-property pos 'org-category) categories))
  7499. (setq org-agenda-represented-categories
  7500. ;; Enclose category names with a hyphen in double
  7501. ;; quotes to process them specially in `org-agenda-filter'.
  7502. (mapcar (lambda (s) (if (string-match-p "-" s) (format "\"%s\"" s) s))
  7503. (nreverse (org-uniquify (delq nil categories)))))))))
  7504. (defvar org-tag-groups-alist-for-agenda)
  7505. (defun org-agenda-get-represented-tags ()
  7506. "Return a list of all tags used in this agenda buffer.
  7507. These will be lower-case, for filtering."
  7508. (or org-agenda-represented-tags
  7509. (when (derived-mode-p 'org-agenda-mode)
  7510. (let ((pos (point-min)) tags-lists tt)
  7511. (while (and (< pos (point-max))
  7512. (setq pos (next-single-property-change
  7513. pos 'tags nil (point-max))))
  7514. (setq tt (get-text-property pos 'tags))
  7515. (if tt (push tt tags-lists)))
  7516. (setq tags-lists
  7517. (nreverse (org-uniquify
  7518. (delq nil (apply #'append tags-lists)))))
  7519. (dolist (tag tags-lists)
  7520. (mapc
  7521. (lambda (group)
  7522. (when (member tag group)
  7523. (push (car group) tags-lists)))
  7524. org-tag-groups-alist-for-agenda))
  7525. (setq org-agenda-represented-tags tags-lists)))))
  7526. (defun org-agenda-filter-make-matcher (filter type &optional expand)
  7527. "Create the form that tests a line for agenda filter.
  7528. Optional argument EXPAND can be used for the TYPE tag and will
  7529. expand the tags in the FILTER if any of the tags in FILTER are
  7530. grouptags."
  7531. (let ((multi-pos-cats
  7532. (and (eq type 'category)
  7533. (string-match-p "\\+.*\\+"
  7534. (mapconcat (lambda (cat) (substring cat 0 1))
  7535. filter ""))))
  7536. f f1)
  7537. (cond
  7538. ;; Tag filter
  7539. ((eq type 'tag)
  7540. (setq filter
  7541. (delete-dups
  7542. (append (get 'org-agenda-tag-filter :preset-filter)
  7543. filter)))
  7544. (dolist (x filter)
  7545. (let ((op (string-to-char x)))
  7546. (if expand (setq x (org-agenda-filter-expand-tags (list x) t))
  7547. (setq x (list x)))
  7548. (setq f1 (org-agenda-filter-make-matcher-tag-exp x op))
  7549. (push f1 f))))
  7550. ;; Category filter
  7551. ((eq type 'category)
  7552. (setq filter
  7553. (delete-dups
  7554. (append (get 'org-agenda-category-filter :preset-filter)
  7555. filter)))
  7556. (dolist (x filter)
  7557. (if (equal "-" (substring x 0 1))
  7558. (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
  7559. (setq f1 (list 'equal (substring x 1) 'cat)))
  7560. (push f1 f)))
  7561. ;; Regexp filter
  7562. ((eq type 'regexp)
  7563. (setq filter
  7564. (delete-dups
  7565. (append (get 'org-agenda-regexp-filter :preset-filter)
  7566. filter)))
  7567. (dolist (x filter)
  7568. (if (equal "-" (substring x 0 1))
  7569. (setq f1 (list 'not (list 'string-match (substring x 1) 'txt)))
  7570. (setq f1 (list 'string-match (substring x 1) 'txt)))
  7571. (push f1 f)))
  7572. ;; Effort filter
  7573. ((eq type 'effort)
  7574. (setq filter
  7575. (delete-dups
  7576. (append (get 'org-agenda-effort-filter :preset-filter)
  7577. filter)))
  7578. (dolist (x filter)
  7579. (push (org-agenda-filter-effort-form x) f))))
  7580. (cons (if multi-pos-cats 'or 'and) (nreverse f))))
  7581. (defun org-agenda-filter-make-matcher-tag-exp (tags op)
  7582. "Return a form associated to tag-expression TAGS.
  7583. Build a form testing a line for agenda filter for
  7584. tag-expressions. OP is an operator of type CHAR that allows the
  7585. function to set the right switches in the returned form."
  7586. (let (form)
  7587. ;; Any of the expressions can match if OP is +, all must match if
  7588. ;; the operator is -.
  7589. (dolist (x tags (cons (if (eq op ?-) 'and 'or) form))
  7590. (let* ((tag (substring x 1))
  7591. (f (cond
  7592. ((string= "" tag) 'tags)
  7593. ((and (string-match-p "\\`{" tag) (string-match-p "}\\'" tag))
  7594. ;; TAG is a regexp.
  7595. (list 'org-match-any-p (substring tag 1 -1) 'tags))
  7596. (t (list 'member tag 'tags)))))
  7597. (push (if (eq op ?-) (list 'not f) f) form)))))
  7598. (defun org-agenda-filter-effort-form (e)
  7599. "Return the form to compare the effort of the current line with what E says.
  7600. E looks like \"+<2:25\"."
  7601. (let (op)
  7602. (setq e (substring e 1))
  7603. (setq op (string-to-char e) e (substring e 1))
  7604. (setq op (cond ((equal op ?<) '<=)
  7605. ((equal op ?>) '>=)
  7606. ((equal op ??) op)
  7607. (t '=)))
  7608. (list 'org-agenda-compare-effort (list 'quote op)
  7609. (org-duration-to-minutes e))))
  7610. (defun org-agenda-compare-effort (op value)
  7611. "Compare the effort of the current line with VALUE, using OP.
  7612. If the line does not have an effort defined, return nil."
  7613. ;; `effort-minutes' property cannot be extracted directly from
  7614. ;; current line but is stored as a property in `txt'.
  7615. (let ((effort (get-text-property 0 'effort-minutes (org-get-at-bol 'txt))))
  7616. (funcall op
  7617. (or effort (if org-agenda-sort-noeffort-is-high 32767 -1))
  7618. value)))
  7619. (defun org-agenda-filter-expand-tags (filter &optional no-operator)
  7620. "Expand group tags in FILTER for the agenda.
  7621. When NO-OPERATOR is non-nil, do not add the + operator to
  7622. returned tags."
  7623. (if org-group-tags
  7624. (let (case-fold-search rtn)
  7625. (mapc
  7626. (lambda (f)
  7627. (let (f0 dir)
  7628. (if (string-match "^\\([+-]\\)\\(.+\\)" f)
  7629. (setq dir (match-string 1 f) f0 (match-string 2 f))
  7630. (setq dir (if no-operator "" "+") f0 f))
  7631. (setq rtn (append (mapcar (lambda(f1) (concat dir f1))
  7632. (org-tags-expand f0 t))
  7633. rtn))))
  7634. filter)
  7635. (reverse rtn))
  7636. filter))
  7637. (defun org-agenda-filter-apply (filter type &optional expand)
  7638. "Set FILTER as the new agenda filter and apply it.
  7639. Optional argument EXPAND can be used for the TYPE tag and will
  7640. expand the tags in the FILTER if any of the tags in FILTER are
  7641. grouptags."
  7642. ;; Deactivate `org-agenda-entry-text-mode' when filtering
  7643. (when org-agenda-entry-text-mode (org-agenda-entry-text-mode))
  7644. (setq org-agenda-filter-form (org-agenda-filter-make-matcher
  7645. filter type expand))
  7646. ;; Only set `org-agenda-filtered-by-category' to t when a unique
  7647. ;; category is used as the filter:
  7648. (setq org-agenda-filtered-by-category
  7649. (and (eq type 'category)
  7650. (not (equal (substring (car filter) 0 1) "-"))))
  7651. (org-agenda-set-mode-name)
  7652. (save-excursion
  7653. (goto-char (point-min))
  7654. (while (not (eobp))
  7655. (when (or (org-get-at-bol 'org-hd-marker)
  7656. (org-get-at-bol 'org-marker))
  7657. (org-dlet
  7658. ((tags (org-get-at-bol 'tags))
  7659. (cat (org-agenda-get-category))
  7660. (txt (or (org-get-at-bol 'txt) "")))
  7661. (unless (eval org-agenda-filter-form t)
  7662. (org-agenda-filter-hide-line type))))
  7663. (beginning-of-line 2)))
  7664. (when (get-char-property (point) 'invisible)
  7665. (ignore-errors (org-agenda-previous-line))))
  7666. (defun org-agenda-filter-top-headline-apply (hl &optional negative)
  7667. "Filter by top headline HL."
  7668. (org-agenda-set-mode-name)
  7669. (save-excursion
  7670. (goto-char (point-min))
  7671. (while (not (eobp))
  7672. (let* ((pos (org-get-at-bol 'org-hd-marker))
  7673. (tophl (and pos (org-find-top-headline pos))))
  7674. (when (and tophl (funcall (if negative 'identity 'not)
  7675. (string= hl tophl)))
  7676. (org-agenda-filter-hide-line 'top-headline)))
  7677. (beginning-of-line 2)))
  7678. (when (get-char-property (point) 'invisible)
  7679. (org-agenda-previous-line))
  7680. (setq org-agenda-top-headline-filter hl
  7681. org-agenda-filtered-by-top-headline t))
  7682. (defun org-agenda-filter-hide-line (type)
  7683. "If current line is TYPE, hide it in the agenda buffer."
  7684. (let* (buffer-invisibility-spec
  7685. (beg (max (point-min) (1- (point-at-bol))))
  7686. (end (point-at-eol)))
  7687. (let ((inhibit-read-only t))
  7688. (add-text-properties
  7689. beg end `(invisible org-filtered org-filter-type ,type)))))
  7690. (defun org-agenda-remove-filter (type)
  7691. "Remove filter of type TYPE from the agenda buffer."
  7692. (interactive)
  7693. (save-excursion
  7694. (goto-char (point-min))
  7695. (let ((inhibit-read-only t) pos)
  7696. (while (setq pos (text-property-any (point) (point-max)
  7697. 'org-filter-type type))
  7698. (goto-char pos)
  7699. (remove-text-properties
  7700. (point) (next-single-property-change (point) 'org-filter-type)
  7701. `(invisible org-filtered org-filter-type ,type))))
  7702. (set (intern (format "org-agenda-%s-filter" (intern-soft type))) nil)
  7703. (setq org-agenda-filter-form nil)
  7704. (org-agenda-set-mode-name)
  7705. (org-agenda-finalize)))
  7706. (defun org-agenda-filter-show-all-tag nil
  7707. (org-agenda-remove-filter 'tag))
  7708. (defun org-agenda-filter-show-all-re nil
  7709. (org-agenda-remove-filter 'regexp))
  7710. (defun org-agenda-filter-show-all-effort nil
  7711. (org-agenda-remove-filter 'effort))
  7712. (defun org-agenda-filter-show-all-cat nil
  7713. (org-agenda-remove-filter 'category))
  7714. (defun org-agenda-filter-show-all-top-filter nil
  7715. (org-agenda-remove-filter 'top-headline))
  7716. (defun org-agenda-manipulate-query-add ()
  7717. "Manipulate the query by adding a search term with positive selection.
  7718. Positive selection means the term must be matched for selection of an entry."
  7719. (interactive)
  7720. (org-agenda-manipulate-query ?\[))
  7721. (defun org-agenda-manipulate-query-subtract ()
  7722. "Manipulate the query by adding a search term with negative selection.
  7723. Negative selection means term must not be matched for selection of an entry."
  7724. (interactive)
  7725. (org-agenda-manipulate-query ?\]))
  7726. (defun org-agenda-manipulate-query-add-re ()
  7727. "Manipulate the query by adding a search regexp with positive selection.
  7728. Positive selection means the regexp must match for selection of an entry."
  7729. (interactive)
  7730. (org-agenda-manipulate-query ?\{))
  7731. (defun org-agenda-manipulate-query-subtract-re ()
  7732. "Manipulate the query by adding a search regexp with negative selection.
  7733. Negative selection means regexp must not match for selection of an entry."
  7734. (interactive)
  7735. (org-agenda-manipulate-query ?\}))
  7736. (defun org-agenda-manipulate-query (char)
  7737. (cond
  7738. ((eq org-agenda-type 'agenda)
  7739. (let ((org-agenda-include-inactive-timestamps t))
  7740. (org-agenda-redo))
  7741. (message "Display now includes inactive timestamps as well"))
  7742. ((eq org-agenda-type 'search)
  7743. (org-add-to-string
  7744. 'org-agenda-query-string
  7745. (if org-agenda-last-search-view-search-was-boolean
  7746. (cdr (assoc char '((?\[ . " +") (?\] . " -")
  7747. (?\{ . " +{}") (?\} . " -{}"))))
  7748. " "))
  7749. (setq org-agenda-redo-command
  7750. (list 'org-search-view
  7751. (car (get-text-property (min (1- (point-max)) (point))
  7752. 'org-last-args))
  7753. org-agenda-query-string
  7754. (+ (length org-agenda-query-string)
  7755. (if (member char '(?\{ ?\})) 0 1))))
  7756. (set-register org-agenda-query-register org-agenda-query-string)
  7757. (let ((org-agenda-overriding-arguments
  7758. (cdr org-agenda-redo-command)))
  7759. (org-agenda-redo)))
  7760. (t (error "Cannot manipulate query for %s-type agenda buffers"
  7761. org-agenda-type))))
  7762. (defun org-add-to-string (var string)
  7763. (set var (concat (symbol-value var) string)))
  7764. (defun org-agenda-goto-date (date)
  7765. "Jump to DATE in agenda."
  7766. (interactive
  7767. (list
  7768. (let ((org-read-date-prefer-future org-agenda-jump-prefer-future))
  7769. (org-read-date))))
  7770. (let* ((day (time-to-days (org-time-string-to-time date)))
  7771. (org-agenda-sticky-orig org-agenda-sticky)
  7772. (org-agenda-buffer-tmp-name (buffer-name))
  7773. (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7774. (0-arg (or current-prefix-arg (car args)))
  7775. (2-arg (nth 2 args))
  7776. (with-hour-p (nth 4 org-agenda-redo-command))
  7777. (newcmd (list 'org-agenda-list 0-arg date
  7778. (org-agenda-span-to-ndays
  7779. 2-arg (org-time-string-to-absolute date))
  7780. with-hour-p))
  7781. (newargs (cdr newcmd))
  7782. (inhibit-read-only t)
  7783. org-agenda-sticky)
  7784. (if (not (org-agenda-check-type t 'agenda))
  7785. (error "Not available in non-agenda views")
  7786. (add-text-properties (point-min) (point-max)
  7787. `(org-redo-cmd ,newcmd org-last-args ,newargs))
  7788. (org-agenda-redo)
  7789. (goto-char (point-min))
  7790. (while (not (or (= (or (get-text-property (point) 'day) 0) day)
  7791. (save-excursion (move-beginning-of-line 2) (eobp))))
  7792. (move-beginning-of-line 2))
  7793. (setq org-agenda-sticky org-agenda-sticky-orig
  7794. org-agenda-this-buffer-is-sticky org-agenda-sticky))))
  7795. (defun org-agenda-goto-today ()
  7796. "Go to today."
  7797. (interactive)
  7798. (org-agenda-check-type t 'agenda)
  7799. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7800. (curspan (nth 2 args))
  7801. (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
  7802. (cond
  7803. (tdpos (goto-char tdpos))
  7804. ((eq org-agenda-type 'agenda)
  7805. (let* ((sd (org-agenda-compute-starting-span
  7806. (org-today) (or curspan org-agenda-span)))
  7807. (org-agenda-overriding-arguments args))
  7808. (setf (nth 1 org-agenda-overriding-arguments) sd)
  7809. (org-agenda-redo)
  7810. (org-agenda-find-same-or-today-or-agenda)))
  7811. (t (error "Cannot find today")))))
  7812. (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
  7813. (goto-char
  7814. (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
  7815. (text-property-any (point-min) (point-max) 'org-today t)
  7816. (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
  7817. (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
  7818. (org-agenda-backward-block))
  7819. (point-min))))
  7820. (defun org-agenda-backward-block ()
  7821. "Move backward by one agenda block."
  7822. (interactive)
  7823. (org-agenda-forward-block 'backward))
  7824. (defun org-agenda-forward-block (&optional backward)
  7825. "Move forward by one agenda block.
  7826. When optional argument BACKWARD is set, go backward."
  7827. (interactive)
  7828. (cond ((not (derived-mode-p 'org-agenda-mode))
  7829. (user-error
  7830. "Cannot execute this command outside of org-agenda-mode buffers"))
  7831. ((looking-at (if backward "\\`" "\\'"))
  7832. (message "Already at the %s block" (if backward "first" "last")))
  7833. (t (let ((_pos (prog1 (point)
  7834. (ignore-errors (if backward (backward-char 1)
  7835. (move-end-of-line 1)))))
  7836. (f (if backward
  7837. #'previous-single-property-change
  7838. #'next-single-property-change))
  7839. moved dest)
  7840. (while (and (setq dest (funcall
  7841. f (point) 'org-agenda-structural-header))
  7842. (not (get-text-property
  7843. (point) 'org-agenda-structural-header)))
  7844. (setq moved t)
  7845. (goto-char dest))
  7846. (if moved (move-beginning-of-line 1)
  7847. (goto-char (if backward (point-min) (point-max)))
  7848. (move-beginning-of-line 1)
  7849. (message "No %s block" (if backward "previous" "further")))))))
  7850. (defun org-agenda-later (arg)
  7851. "Go forward in time by the current span.
  7852. With prefix ARG, go forward that many times the current span."
  7853. (interactive "p")
  7854. (org-agenda-check-type t 'agenda)
  7855. (let* ((wstart (window-start))
  7856. (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7857. (span (or (nth 2 args) org-agenda-current-span))
  7858. (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
  7859. (greg (calendar-gregorian-from-absolute sd))
  7860. (cnt (org-get-at-bol 'org-day-cnt))
  7861. greg2)
  7862. (cond
  7863. ((numberp span)
  7864. (setq sd (+ (* span arg) sd)))
  7865. ((eq span 'day)
  7866. (setq sd (+ arg sd)))
  7867. ((eq span 'week)
  7868. (setq sd (+ (* 7 arg) sd)))
  7869. ((eq span 'fortnight)
  7870. (setq sd (+ (* 14 arg) sd)))
  7871. ((eq span 'month)
  7872. (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
  7873. sd (calendar-absolute-from-gregorian greg2))
  7874. (setcar greg2 (1+ (car greg2))))
  7875. ((eq span 'year)
  7876. (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
  7877. sd (calendar-absolute-from-gregorian greg2))
  7878. (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
  7879. (t
  7880. (setq sd (+ (* span arg) sd))))
  7881. (let ((org-agenda-overriding-cmd
  7882. ;; `cmd' may have been set by `org-agenda-run-series' which
  7883. ;; uses `org-agenda-overriding-cmd' to decide whether
  7884. ;; overriding is allowed for `cmd'
  7885. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7886. (org-agenda-overriding-arguments
  7887. (list (car args) sd span)))
  7888. (org-agenda-redo)
  7889. (org-agenda-find-same-or-today-or-agenda cnt))
  7890. (set-window-start nil wstart)))
  7891. (defun org-agenda-earlier (arg)
  7892. "Go backward in time by the current span.
  7893. With prefix ARG, go backward that many times the current span."
  7894. (interactive "p")
  7895. (org-agenda-later (- arg)))
  7896. (defun org-agenda-view-mode-dispatch ()
  7897. "Call one of the view mode commands."
  7898. (interactive)
  7899. (org-unlogged-message
  7900. "View: [d]ay [w]eek for[t]night [m]onth [y]ear [SPC]reset [q]uit/abort
  7901. time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
  7902. [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
  7903. (pcase (read-char-exclusive)
  7904. (?\ (call-interactively 'org-agenda-reset-view))
  7905. (?d (call-interactively 'org-agenda-day-view))
  7906. (?w (call-interactively 'org-agenda-week-view))
  7907. (?t (call-interactively 'org-agenda-fortnight-view))
  7908. (?m (call-interactively 'org-agenda-month-view))
  7909. (?y (call-interactively 'org-agenda-year-view))
  7910. (?l (call-interactively 'org-agenda-log-mode))
  7911. (?L (org-agenda-log-mode '(4)))
  7912. (?c (org-agenda-log-mode 'clockcheck))
  7913. ((or ?F ?f) (call-interactively 'org-agenda-follow-mode))
  7914. (?a (call-interactively 'org-agenda-archives-mode))
  7915. (?A (org-agenda-archives-mode 'files))
  7916. ((or ?R ?r) (call-interactively 'org-agenda-clockreport-mode))
  7917. ((or ?E ?e) (call-interactively 'org-agenda-entry-text-mode))
  7918. (?G (call-interactively 'org-agenda-toggle-time-grid))
  7919. (?D (call-interactively 'org-agenda-toggle-diary))
  7920. (?\! (call-interactively 'org-agenda-toggle-deadlines))
  7921. (?\[ (let ((org-agenda-include-inactive-timestamps t))
  7922. (org-agenda-check-type t 'agenda)
  7923. (org-agenda-redo))
  7924. (message "Display now includes inactive timestamps as well"))
  7925. (?q (message "Abort"))
  7926. (key (user-error "Invalid key: %s" key))))
  7927. (defun org-agenda-reset-view ()
  7928. "Switch to default view for agenda."
  7929. (interactive)
  7930. (org-agenda-change-time-span org-agenda-span))
  7931. (defun org-agenda-day-view (&optional day-of-month)
  7932. "Switch to daily view for agenda.
  7933. With argument DAY-OF-MONTH, switch to that day of the month."
  7934. (interactive "P")
  7935. (org-agenda-change-time-span 'day day-of-month))
  7936. (defun org-agenda-week-view (&optional iso-week)
  7937. "Switch to weekly view for agenda.
  7938. With argument ISO-WEEK, switch to the corresponding ISO week.
  7939. If ISO-WEEK has more then 2 digits, only the last two encode
  7940. the week. Any digits before this encode a year. So 200712
  7941. means week 12 of year 2007. Years ranging from 70 years ago
  7942. to 30 years in the future can also be written as 2-digit years."
  7943. (interactive "P")
  7944. (org-agenda-change-time-span 'week iso-week))
  7945. (defun org-agenda-fortnight-view (&optional iso-week)
  7946. "Switch to fortnightly view for agenda.
  7947. With argument ISO-WEEK, switch to the corresponding ISO week.
  7948. If ISO-WEEK has more then 2 digits, only the last two encode
  7949. the week. Any digits before this encode a year. So 200712
  7950. means week 12 of year 2007. Years ranging from 70 years ago
  7951. to 30 years in the future can also be written as 2-digit years."
  7952. (interactive "P")
  7953. (org-agenda-change-time-span 'fortnight iso-week))
  7954. (defun org-agenda-month-view (&optional month)
  7955. "Switch to monthly view for agenda.
  7956. With argument MONTH, switch to that month. If MONTH has more
  7957. then 2 digits, only the last two encode the month. Any digits
  7958. before this encode a year. So 200712 means December year 2007.
  7959. Years ranging from 70 years ago to 30 years in the future can
  7960. also be written as 2-digit years."
  7961. (interactive "P")
  7962. (org-agenda-change-time-span 'month month))
  7963. (defun org-agenda-year-view (&optional year)
  7964. "Switch to yearly view for agenda.
  7965. With argument YEAR, switch to that year. Years ranging from 70
  7966. years ago to 30 years in the future can also be written as
  7967. 2-digit years."
  7968. (interactive "P")
  7969. (when year
  7970. (setq year (org-small-year-to-year year)))
  7971. (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
  7972. (org-agenda-change-time-span 'year year)
  7973. (error "Abort")))
  7974. (defun org-agenda-change-time-span (span &optional n)
  7975. "Change the agenda view to SPAN.
  7976. SPAN may be `day', `week', `fortnight', `month', `year'."
  7977. (org-agenda-check-type t 'agenda)
  7978. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7979. (curspan (nth 2 args)))
  7980. (when (and (not n) (equal curspan span))
  7981. (error "Viewing span is already \"%s\"" span))
  7982. (let* ((sd (or (org-get-at-bol 'day)
  7983. (nth 1 args)
  7984. org-starting-day))
  7985. (sd (org-agenda-compute-starting-span sd span n))
  7986. (org-agenda-overriding-cmd
  7987. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7988. (org-agenda-overriding-arguments
  7989. (list (car args) sd span)))
  7990. (org-agenda-redo)
  7991. (org-agenda-find-same-or-today-or-agenda))
  7992. (org-agenda-set-mode-name)
  7993. (message "Switched to %s view" span)))
  7994. (defun org-agenda-compute-starting-span (sd span &optional n)
  7995. "Compute starting date for agenda.
  7996. SPAN may be `day', `week', `fortnight', `month', `year'. The return value
  7997. is a cons cell with the starting date and the number of days,
  7998. so that the date SD will be in that range."
  7999. (let* ((greg (calendar-gregorian-from-absolute sd))
  8000. ;; (dg (nth 1 greg))
  8001. (mg (car greg))
  8002. (yg (nth 2 greg)))
  8003. (cond
  8004. ((eq span 'day)
  8005. (when n
  8006. (setq sd (+ (calendar-absolute-from-gregorian
  8007. (list mg 1 yg))
  8008. n -1))))
  8009. ((or (eq span 'week) (eq span 'fortnight))
  8010. (let* ((nt (calendar-day-of-week
  8011. (calendar-gregorian-from-absolute sd)))
  8012. (d (if org-agenda-start-on-weekday
  8013. (- nt org-agenda-start-on-weekday)
  8014. 0))
  8015. y1)
  8016. (setq sd (- sd (+ (if (< d 0) 7 0) d)))
  8017. (when n
  8018. (require 'cal-iso)
  8019. (when (> n 99)
  8020. (setq y1 (org-small-year-to-year (/ n 100))
  8021. n (mod n 100)))
  8022. (setq sd
  8023. (calendar-iso-to-absolute
  8024. (list n 1
  8025. (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
  8026. ((eq span 'month)
  8027. (let (y1)
  8028. (when (and n (> n 99))
  8029. (setq y1 (org-small-year-to-year (/ n 100))
  8030. n (mod n 100)))
  8031. (setq sd (calendar-absolute-from-gregorian
  8032. (list (or n mg) 1 (or y1 yg))))))
  8033. ((eq span 'year)
  8034. (setq sd (calendar-absolute-from-gregorian
  8035. (list 1 1 (or n yg))))))
  8036. sd))
  8037. (defun org-agenda-next-date-line (&optional arg)
  8038. "Jump to the next line indicating a date in agenda buffer."
  8039. (interactive "p")
  8040. (org-agenda-check-type t 'agenda)
  8041. (beginning-of-line 1)
  8042. ;; This does not work if user makes date format that starts with a blank
  8043. (when (looking-at-p "^\\S-") (forward-char 1))
  8044. (unless (re-search-forward "^\\S-" nil t arg)
  8045. (backward-char 1)
  8046. (error "No next date after this line in this buffer"))
  8047. (goto-char (match-beginning 0)))
  8048. (defun org-agenda-previous-date-line (&optional arg)
  8049. "Jump to the previous line indicating a date in agenda buffer."
  8050. (interactive "p")
  8051. (org-agenda-check-type t 'agenda)
  8052. (beginning-of-line 1)
  8053. (unless (re-search-backward "^\\S-" nil t arg)
  8054. (error "No previous date before this line in this buffer")))
  8055. ;; Initialize the highlight
  8056. (defvar org-hl (make-overlay 1 1))
  8057. (overlay-put org-hl 'face 'highlight)
  8058. (defun org-highlight (begin end &optional buffer)
  8059. "Highlight a region with overlay."
  8060. (move-overlay org-hl begin end (or buffer (current-buffer))))
  8061. (defun org-unhighlight ()
  8062. "Detach overlay INDEX."
  8063. (delete-overlay org-hl))
  8064. (defun org-unhighlight-once ()
  8065. "Remove the highlight from its position, and this function from the hook."
  8066. (remove-hook 'pre-command-hook #'org-unhighlight-once)
  8067. (org-unhighlight))
  8068. (defvar org-agenda-pre-follow-window-conf nil)
  8069. (defun org-agenda-follow-mode ()
  8070. "Toggle follow mode in an agenda buffer."
  8071. (interactive)
  8072. (unless org-agenda-follow-mode
  8073. (setq org-agenda-pre-follow-window-conf
  8074. (current-window-configuration)))
  8075. (setq org-agenda-follow-mode (not org-agenda-follow-mode))
  8076. (unless org-agenda-follow-mode
  8077. (set-window-configuration org-agenda-pre-follow-window-conf))
  8078. (org-agenda-set-mode-name)
  8079. (org-agenda-do-context-action)
  8080. (message "Follow mode is %s"
  8081. (if org-agenda-follow-mode "on" "off")))
  8082. (defun org-agenda-entry-text-mode (&optional arg)
  8083. "Toggle entry text mode in an agenda buffer."
  8084. (interactive "P")
  8085. (if (or org-agenda-tag-filter
  8086. org-agenda-category-filter
  8087. org-agenda-regexp-filter
  8088. org-agenda-top-headline-filter)
  8089. (user-error "Can't show entry text in filtered views")
  8090. (setq org-agenda-entry-text-mode (or (integerp arg)
  8091. (not org-agenda-entry-text-mode)))
  8092. (org-agenda-entry-text-hide)
  8093. (and org-agenda-entry-text-mode
  8094. (let ((org-agenda-entry-text-maxlines
  8095. (if (integerp arg) arg org-agenda-entry-text-maxlines)))
  8096. (org-agenda-entry-text-show)))
  8097. (org-agenda-set-mode-name)
  8098. (message "Entry text mode is %s%s"
  8099. (if org-agenda-entry-text-mode "on" "off")
  8100. (if (not org-agenda-entry-text-mode) ""
  8101. (format " (maximum number of lines is %d)"
  8102. (if (integerp arg) arg org-agenda-entry-text-maxlines))))))
  8103. (defun org-agenda-clockreport-mode ()
  8104. "Toggle clocktable mode in an agenda buffer."
  8105. (interactive)
  8106. (org-agenda-check-type t 'agenda)
  8107. (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode))
  8108. (org-agenda-set-mode-name)
  8109. (org-agenda-redo)
  8110. (message "Clocktable mode is %s"
  8111. (if org-agenda-clockreport-mode "on" "off")))
  8112. (defun org-agenda-log-mode (&optional special)
  8113. "Toggle log mode in an agenda buffer.
  8114. With argument SPECIAL, show all possible log items, not only the ones
  8115. configured in `org-agenda-log-mode-items'.
  8116. With a `\\[universal-argument] \\[universal-argument]' prefix, show *only* \
  8117. log items, nothing else."
  8118. (interactive "P")
  8119. (org-agenda-check-type t 'agenda)
  8120. (setq org-agenda-show-log
  8121. (cond
  8122. ((equal special '(16)) 'only)
  8123. ((eq special 'clockcheck)
  8124. (if (eq org-agenda-show-log 'clockcheck)
  8125. nil 'clockcheck))
  8126. (special '(closed clock state))
  8127. (t (not org-agenda-show-log))))
  8128. (org-agenda-set-mode-name)
  8129. (org-agenda-redo)
  8130. (message "Log mode is %s" (if org-agenda-show-log "on" "off")))
  8131. (defun org-agenda-archives-mode (&optional with-files)
  8132. "Toggle inclusion of items in trees marked with :ARCHIVE:.
  8133. When called with a prefix argument, include all archive files as well."
  8134. (interactive "P")
  8135. (setq org-agenda-archives-mode
  8136. (cond ((and with-files (eq org-agenda-archives-mode t)) nil)
  8137. (with-files t)
  8138. (org-agenda-archives-mode nil)
  8139. (t 'trees)))
  8140. (org-agenda-set-mode-name)
  8141. (org-agenda-redo)
  8142. (message
  8143. "%s"
  8144. (cond
  8145. ((eq org-agenda-archives-mode nil)
  8146. "No archives are included")
  8147. ((eq org-agenda-archives-mode 'trees)
  8148. (format "Trees with :%s: tag are included" org-archive-tag))
  8149. ((eq org-agenda-archives-mode t)
  8150. (format "Trees with :%s: tag and all active archive files are included"
  8151. org-archive-tag)))))
  8152. (defun org-agenda-toggle-diary ()
  8153. "Toggle diary inclusion in an agenda buffer."
  8154. (interactive)
  8155. (org-agenda-check-type t 'agenda)
  8156. (setq org-agenda-include-diary (not org-agenda-include-diary))
  8157. (org-agenda-redo)
  8158. (org-agenda-set-mode-name)
  8159. (message "Diary inclusion turned %s"
  8160. (if org-agenda-include-diary "on" "off")))
  8161. (defun org-agenda-toggle-deadlines ()
  8162. "Toggle inclusion of entries with a deadline in an agenda buffer."
  8163. (interactive)
  8164. (org-agenda-check-type t 'agenda)
  8165. (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
  8166. (org-agenda-redo)
  8167. (org-agenda-set-mode-name)
  8168. (message "Deadlines inclusion turned %s"
  8169. (if org-agenda-include-deadlines "on" "off")))
  8170. (defun org-agenda-toggle-time-grid ()
  8171. "Toggle time grid in an agenda buffer."
  8172. (interactive)
  8173. (org-agenda-check-type t 'agenda)
  8174. (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
  8175. (org-agenda-redo)
  8176. (org-agenda-set-mode-name)
  8177. (message "Time-grid turned %s"
  8178. (if org-agenda-use-time-grid "on" "off")))
  8179. (defun org-agenda-set-mode-name ()
  8180. "Set the mode name to indicate all the small mode settings."
  8181. (setq mode-name
  8182. (list "Org-Agenda"
  8183. (if (get 'org-agenda-files 'org-restrict) " []" "")
  8184. " "
  8185. '(:eval (org-agenda-span-name org-agenda-current-span))
  8186. (if org-agenda-follow-mode " Follow" "")
  8187. (if org-agenda-entry-text-mode " ETxt" "")
  8188. (if org-agenda-include-diary " Diary" "")
  8189. (if org-agenda-include-deadlines " Ddl" "")
  8190. (if org-agenda-use-time-grid " Grid" "")
  8191. (if (and (boundp 'org-habit-show-habits)
  8192. org-habit-show-habits)
  8193. " Habit" "")
  8194. (cond
  8195. ((consp org-agenda-show-log) " LogAll")
  8196. ((eq org-agenda-show-log 'clockcheck) " ClkCk")
  8197. (org-agenda-show-log " Log")
  8198. (t ""))
  8199. (if (org-agenda-filter-any) " " "")
  8200. (if (or org-agenda-category-filter
  8201. (get 'org-agenda-category-filter :preset-filter))
  8202. '(:eval (propertize
  8203. (concat "["
  8204. (mapconcat
  8205. #'identity
  8206. (append
  8207. (get 'org-agenda-category-filter :preset-filter)
  8208. org-agenda-category-filter)
  8209. "")
  8210. "]")
  8211. 'face 'org-agenda-filter-category
  8212. 'help-echo "Category used in filtering"))
  8213. "")
  8214. (if (or org-agenda-tag-filter
  8215. (get 'org-agenda-tag-filter :preset-filter))
  8216. '(:eval (propertize
  8217. (concat (mapconcat
  8218. #'identity
  8219. (append
  8220. (get 'org-agenda-tag-filter :preset-filter)
  8221. org-agenda-tag-filter)
  8222. ""))
  8223. 'face 'org-agenda-filter-tags
  8224. 'help-echo "Tags used in filtering"))
  8225. "")
  8226. (if (or org-agenda-effort-filter
  8227. (get 'org-agenda-effort-filter :preset-filter))
  8228. '(:eval (propertize
  8229. (concat (mapconcat
  8230. #'identity
  8231. (append
  8232. (get 'org-agenda-effort-filter :preset-filter)
  8233. org-agenda-effort-filter)
  8234. ""))
  8235. 'face 'org-agenda-filter-effort
  8236. 'help-echo "Effort conditions used in filtering"))
  8237. "")
  8238. (if (or org-agenda-regexp-filter
  8239. (get 'org-agenda-regexp-filter :preset-filter))
  8240. '(:eval (propertize
  8241. (concat (mapconcat
  8242. (lambda (x) (concat (substring x 0 1) "/" (substring x 1) "/"))
  8243. (append
  8244. (get 'org-agenda-regexp-filter :preset-filter)
  8245. org-agenda-regexp-filter)
  8246. ""))
  8247. 'face 'org-agenda-filter-regexp
  8248. 'help-echo "Regexp used in filtering"))
  8249. "")
  8250. (if org-agenda-archives-mode
  8251. (if (eq org-agenda-archives-mode t)
  8252. " Archives"
  8253. (format " :%s:" org-archive-tag))
  8254. "")
  8255. (if org-agenda-clockreport-mode " Clock" "")))
  8256. (force-mode-line-update))
  8257. (defun org-agenda-update-agenda-type ()
  8258. "Update the agenda type after each command."
  8259. (setq org-agenda-type
  8260. (or (get-text-property (point) 'org-agenda-type)
  8261. (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
  8262. (defun org-agenda-next-line ()
  8263. "Move cursor to the next line, and show if follow mode is active."
  8264. (interactive)
  8265. (call-interactively 'next-line)
  8266. (org-agenda-do-context-action))
  8267. (defun org-agenda-previous-line ()
  8268. "Move cursor to the previous line, and show if follow-mode is active."
  8269. (interactive)
  8270. (call-interactively 'previous-line)
  8271. (org-agenda-do-context-action))
  8272. (defun org-agenda-next-item (n)
  8273. "Move cursor to next agenda item."
  8274. (interactive "p")
  8275. (let ((col (current-column)))
  8276. (dotimes (_ n)
  8277. (when (next-single-property-change (point-at-eol) 'org-marker)
  8278. (move-end-of-line 1)
  8279. (goto-char (next-single-property-change (point) 'org-marker))))
  8280. (org-move-to-column col))
  8281. (org-agenda-do-context-action))
  8282. (defun org-agenda-previous-item (n)
  8283. "Move cursor to next agenda item."
  8284. (interactive "p")
  8285. (dotimes (_ n)
  8286. (let ((col (current-column))
  8287. (goto (save-excursion
  8288. (move-end-of-line 0)
  8289. (previous-single-property-change (point) 'org-marker))))
  8290. (when goto (goto-char goto))
  8291. (org-move-to-column col)))
  8292. (org-agenda-do-context-action))
  8293. (defun org-agenda-do-context-action ()
  8294. "Show outline path and, maybe, follow mode window."
  8295. (let ((m (org-get-at-bol 'org-marker)))
  8296. (when (and (markerp m) (marker-buffer m))
  8297. (and org-agenda-follow-mode
  8298. (if org-agenda-follow-indirect
  8299. (org-agenda-tree-to-indirect-buffer nil)
  8300. (org-agenda-show)))
  8301. (and org-agenda-show-outline-path
  8302. (org-with-point-at m (org-display-outline-path t))))))
  8303. (defun org-agenda-show-tags ()
  8304. "Show the tags applicable to the current item."
  8305. (interactive)
  8306. (let* ((tags (org-get-at-bol 'tags)))
  8307. (if tags
  8308. (message "Tags are :%s:"
  8309. (org-no-properties (mapconcat #'identity tags ":")))
  8310. (message "No tags associated with this line"))))
  8311. (defun org-agenda-goto (&optional highlight)
  8312. "Go to the entry at point in the corresponding Org file."
  8313. (interactive)
  8314. (let* ((marker (or (org-get-at-bol 'org-marker)
  8315. (org-agenda-error)))
  8316. (buffer (marker-buffer marker))
  8317. (pos (marker-position marker)))
  8318. ;; FIXME: use `org-switch-to-buffer-other-window'?
  8319. (switch-to-buffer-other-window buffer)
  8320. (widen)
  8321. (push-mark)
  8322. (goto-char pos)
  8323. (when (derived-mode-p 'org-mode)
  8324. (org-show-context 'agenda)
  8325. (recenter (/ (window-height) 2))
  8326. (org-back-to-heading t)
  8327. (let ((case-fold-search nil))
  8328. (when (re-search-forward org-complex-heading-regexp nil t)
  8329. (goto-char (match-beginning 4)))))
  8330. (run-hooks 'org-agenda-after-show-hook)
  8331. (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
  8332. (defvar org-agenda-after-show-hook nil
  8333. "Normal hook run after an item has been shown from the agenda.
  8334. Point is in the buffer where the item originated.")
  8335. ;; Defined later in org-agenda.el
  8336. (defvar org-agenda-loop-over-headlines-in-active-region nil)
  8337. (defun org-agenda-do-in-region (beg end cmd &optional arg force-arg delete)
  8338. "Between region BEG and END, call agenda command CMD.
  8339. When optional argument ARG is non-nil or FORCE-ARG is t, pass
  8340. ARG to CMD. When optional argument DELETE is non-nil, assume CMD
  8341. deletes the agenda entry and don't move to the next entry."
  8342. (save-excursion
  8343. (goto-char beg)
  8344. (let ((mend (move-marker (make-marker) end))
  8345. (all (eq org-agenda-loop-over-headlines-in-active-region t))
  8346. (match (and (stringp org-agenda-loop-over-headlines-in-active-region)
  8347. org-agenda-loop-over-headlines-in-active-region))
  8348. (level (and (eq org-agenda-loop-over-headlines-in-active-region 'start-level)
  8349. (org-get-at-bol 'level))))
  8350. (while (< (point) mend)
  8351. (let ((ov (make-overlay (point) (point-at-eol))))
  8352. (if (not (or all
  8353. (and match (looking-at-p match))
  8354. (eq level (org-get-at-bol 'level))))
  8355. (org-agenda-next-item 1)
  8356. (overlay-put ov 'face 'region)
  8357. (if (or arg force-arg) (funcall cmd arg) (funcall cmd))
  8358. (when (not delete) (org-agenda-next-item 1))
  8359. (delete-overlay ov)))))))
  8360. ;; org-agenda-[schedule,deadline,date-prompt,todo,[toggle]archive*,
  8361. ;; kill,set-property,set-effort] commands may loop over agenda
  8362. ;; entries. Commands `org-agenda-set-tags' and `org-agenda-bulk-mark'
  8363. ;; use their own mechanisms on active regions.
  8364. (defmacro org-agenda-maybe-loop (cmd arg force-arg delete &rest body)
  8365. "Maybe loop over agenda entries and perform CMD.
  8366. Pass ARG, FORCE-ARG, DELETE and BODY to `org-agenda-do-in-region'."
  8367. (declare (debug t))
  8368. `(if (and (called-interactively-p 'any)
  8369. org-agenda-loop-over-headlines-in-active-region
  8370. (org-region-active-p))
  8371. (org-agenda-do-in-region
  8372. (region-beginning) (region-end) ,cmd ,arg ,force-arg ,delete)
  8373. ,@body))
  8374. (defun org-agenda-kill ()
  8375. "Kill the entry or subtree belonging to the current agenda entry."
  8376. (interactive)
  8377. (or (eq major-mode 'org-agenda-mode) (user-error "Not in agenda"))
  8378. (org-agenda-maybe-loop
  8379. #'org-agenda-kill nil nil t
  8380. (let* ((bufname-orig (buffer-name))
  8381. (marker (or (org-get-at-bol 'org-marker)
  8382. (org-agenda-error)))
  8383. (buffer (marker-buffer marker))
  8384. (pos (marker-position marker))
  8385. (type (org-get-at-bol 'type))
  8386. dbeg dend (n 0))
  8387. (org-with-remote-undo buffer
  8388. (with-current-buffer buffer
  8389. (save-excursion
  8390. (goto-char pos)
  8391. (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
  8392. (setq dbeg (progn (org-back-to-heading t) (point))
  8393. dend (org-end-of-subtree t t))
  8394. (setq dbeg (point-at-bol)
  8395. dend (min (point-max) (1+ (point-at-eol)))))
  8396. (goto-char dbeg)
  8397. (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
  8398. (when (or (eq t org-agenda-confirm-kill)
  8399. (and (numberp org-agenda-confirm-kill)
  8400. (> n org-agenda-confirm-kill)))
  8401. (let ((win-conf (current-window-configuration)))
  8402. (unwind-protect
  8403. (and
  8404. (prog2
  8405. (org-agenda-tree-to-indirect-buffer nil)
  8406. (not (y-or-n-p
  8407. (format "Delete entry with %d lines in buffer \"%s\"? "
  8408. n (buffer-name buffer))))
  8409. (kill-buffer org-last-indirect-buffer))
  8410. (error "Abort"))
  8411. (set-window-configuration win-conf))))
  8412. (let ((org-agenda-buffer-name bufname-orig))
  8413. (org-remove-subtree-entries-from-agenda buffer dbeg dend))
  8414. (with-current-buffer buffer (delete-region dbeg dend))
  8415. (message "Agenda item and source killed")))))
  8416. (defvar org-archive-default-command) ; defined in org-archive.el
  8417. (defun org-agenda-archive-default ()
  8418. "Archive the entry or subtree belonging to the current agenda entry."
  8419. (interactive)
  8420. (require 'org-archive)
  8421. (funcall-interactively
  8422. #'org-agenda-archive-with org-archive-default-command))
  8423. (defun org-agenda-archive-default-with-confirmation ()
  8424. "Archive the entry or subtree belonging to the current agenda entry."
  8425. (interactive)
  8426. (require 'org-archive)
  8427. (funcall-interactively
  8428. #'org-agenda-archive-with org-archive-default-command 'confirm))
  8429. (defun org-agenda-archive ()
  8430. "Archive the entry or subtree belonging to the current agenda entry."
  8431. (interactive)
  8432. (funcall-interactively
  8433. #'org-agenda-archive-with 'org-archive-subtree))
  8434. (defun org-agenda-archive-to-archive-sibling ()
  8435. "Move the entry to the archive sibling."
  8436. (interactive)
  8437. (funcall-interactively
  8438. #'org-agenda-archive-with 'org-archive-to-archive-sibling))
  8439. (defvar org-archive-from-agenda)
  8440. (defun org-agenda-archive-with (cmd &optional confirm)
  8441. "Move the entry to the archive sibling."
  8442. (interactive)
  8443. (or (eq major-mode 'org-agenda-mode) (user-error "Not in agenda"))
  8444. (org-agenda-maybe-loop
  8445. #'org-agenda-archive-with cmd nil t
  8446. (let* ((bufname-orig (buffer-name))
  8447. (marker (or (org-get-at-bol 'org-marker)
  8448. (org-agenda-error)))
  8449. (buffer (marker-buffer marker))
  8450. (pos (marker-position marker)))
  8451. (org-with-remote-undo buffer
  8452. (with-current-buffer buffer
  8453. (if (derived-mode-p 'org-mode)
  8454. (if (and confirm
  8455. (not (y-or-n-p "Archive this subtree or entry? ")))
  8456. (error "Abort")
  8457. (save-window-excursion
  8458. (goto-char pos)
  8459. (let ((org-agenda-buffer-name bufname-orig))
  8460. (org-remove-subtree-entries-from-agenda))
  8461. (org-back-to-heading t)
  8462. (let ((org-archive-from-agenda t))
  8463. (funcall cmd))))
  8464. (error "Archiving works only in Org files")))))))
  8465. (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
  8466. "Remove all lines in the agenda that correspond to a given subtree.
  8467. The subtree is the one in buffer BUF, starting at BEG and ending at END.
  8468. If this information is not given, the function uses the tree at point."
  8469. (let ((buf (or buf (current-buffer))) m p)
  8470. (save-excursion
  8471. (unless (and beg end)
  8472. (org-back-to-heading t)
  8473. (setq beg (point))
  8474. (org-end-of-subtree t)
  8475. (setq end (point)))
  8476. (set-buffer (get-buffer org-agenda-buffer-name))
  8477. (save-excursion
  8478. (goto-char (point-max))
  8479. (beginning-of-line 1)
  8480. (while (not (bobp))
  8481. (when (and (setq m (org-get-at-bol 'org-marker))
  8482. (equal buf (marker-buffer m))
  8483. (setq p (marker-position m))
  8484. (>= p beg)
  8485. (< p end))
  8486. (let ((inhibit-read-only t))
  8487. (delete-region (point-at-bol) (1+ (point-at-eol)))))
  8488. (beginning-of-line 0))))))
  8489. (defun org-agenda-refile (&optional goto rfloc no-update)
  8490. "Refile the item at point.
  8491. When called with `\\[universal-argument] \\[universal-argument]', \
  8492. go to the location of the last
  8493. refiled item.
  8494. When called with `\\[universal-argument] \\[universal-argument] \
  8495. \\[universal-argument]' prefix or when GOTO is 0, clear
  8496. the refile cache.
  8497. RFLOC can be a refile location obtained in a different way.
  8498. When NO-UPDATE is non-nil, don't redo the agenda buffer."
  8499. (interactive "P")
  8500. (cond
  8501. ((member goto '(0 (64)))
  8502. (org-refile-cache-clear))
  8503. ((equal goto '(16))
  8504. (org-refile-goto-last-stored))
  8505. (t
  8506. (let* ((buffer-orig (buffer-name))
  8507. (marker (or (org-get-at-bol 'org-hd-marker)
  8508. (org-agenda-error)))
  8509. (buffer (marker-buffer marker))
  8510. ;; (pos (marker-position marker))
  8511. (rfloc (or rfloc
  8512. (org-refile-get-location
  8513. (if goto "Goto" "Refile to") buffer
  8514. org-refile-allow-creating-parent-nodes))))
  8515. (with-current-buffer buffer
  8516. (org-with-wide-buffer
  8517. (goto-char marker)
  8518. (let ((org-agenda-buffer-name buffer-orig))
  8519. (org-remove-subtree-entries-from-agenda))
  8520. (org-refile goto buffer rfloc))))
  8521. (unless no-update (org-agenda-redo)))))
  8522. (defun org-agenda-open-link (&optional arg)
  8523. "Open the link(s) in the current entry, if any.
  8524. This looks for a link in the displayed line in the agenda.
  8525. It also looks at the text of the entry itself."
  8526. (interactive "P")
  8527. (let* ((marker (or (org-get-at-bol 'org-hd-marker)
  8528. (org-get-at-bol 'org-marker)))
  8529. (buffer (and marker (marker-buffer marker)))
  8530. (prefix (buffer-substring (point-at-bol) (point-at-eol)))
  8531. (lkall (and buffer (org-offer-links-in-entry
  8532. buffer marker arg prefix)))
  8533. (lk0 (car lkall))
  8534. (lk (if (stringp lk0) (list lk0) lk0))
  8535. (lkend (cdr lkall))
  8536. trg)
  8537. (cond
  8538. ((and buffer lk)
  8539. (mapcar (lambda(l)
  8540. (with-current-buffer buffer
  8541. (setq trg (and (string-match org-link-bracket-re l)
  8542. (match-string 1 l)))
  8543. (if (or (not trg) (string-match org-link-any-re trg))
  8544. ;; Don't use `org-with-wide-buffer' here as
  8545. ;; opening the link may result in moving the point
  8546. (save-restriction
  8547. (widen)
  8548. (goto-char marker)
  8549. (when (search-forward l nil lkend)
  8550. (goto-char (match-beginning 0))
  8551. (org-open-at-point)))
  8552. ;; This is an internal link, widen the buffer
  8553. ;; FIXME: use `org-switch-to-buffer-other-window'?
  8554. (switch-to-buffer-other-window buffer)
  8555. (widen)
  8556. (goto-char marker)
  8557. (when (search-forward l nil lkend)
  8558. (goto-char (match-beginning 0))
  8559. (org-open-at-point)))))
  8560. lk))
  8561. ((or (org-in-regexp (concat "\\(" org-link-bracket-re "\\)"))
  8562. (save-excursion
  8563. (beginning-of-line 1)
  8564. (looking-at (concat ".*?\\(" org-link-bracket-re "\\)"))))
  8565. (org-link-open-from-string (match-string 1)))
  8566. (t (message "No link to open here")))))
  8567. (defun org-agenda-copy-local-variable (var)
  8568. "Get a variable from a referenced buffer and install it here."
  8569. (let ((m (org-get-at-bol 'org-marker)))
  8570. (when (and m (buffer-live-p (marker-buffer m)))
  8571. (set (make-local-variable var)
  8572. (with-current-buffer (marker-buffer m)
  8573. (symbol-value var))))))
  8574. (defun org-agenda-switch-to (&optional delete-other-windows)
  8575. "Go to the Org mode file which contains the item at point.
  8576. When optional argument DELETE-OTHER-WINDOWS is non-nil, the
  8577. displayed Org file fills the frame."
  8578. (interactive)
  8579. (if (and org-return-follows-link
  8580. (not (org-get-at-bol 'org-marker))
  8581. (org-in-regexp org-link-bracket-re))
  8582. (org-link-open-from-string (match-string 0))
  8583. (let* ((marker (or (org-get-at-bol 'org-marker)
  8584. (org-agenda-error)))
  8585. (buffer (marker-buffer marker))
  8586. (pos (marker-position marker)))
  8587. (unless buffer (user-error "Trying to switch to non-existent buffer"))
  8588. (pop-to-buffer-same-window buffer)
  8589. (when delete-other-windows (delete-other-windows))
  8590. (widen)
  8591. (goto-char pos)
  8592. (when (derived-mode-p 'org-mode)
  8593. (org-show-context 'agenda)
  8594. (run-hooks 'org-agenda-after-show-hook)))))
  8595. (defun org-agenda-goto-mouse (ev)
  8596. "Go to the Org file which contains the item at the mouse click."
  8597. (interactive "e")
  8598. (mouse-set-point ev)
  8599. (org-agenda-goto))
  8600. (defun org-agenda-show (&optional full-entry)
  8601. "Display the Org file which contains the item at point.
  8602. With prefix argument FULL-ENTRY, make the entire entry visible
  8603. if it was hidden in the outline."
  8604. (interactive "P")
  8605. (let ((win (selected-window)))
  8606. (org-agenda-goto t)
  8607. (when full-entry (org-show-entry))
  8608. (select-window win)))
  8609. (defvar org-agenda-show-window nil)
  8610. (defun org-agenda-show-and-scroll-up (&optional arg)
  8611. "Display the Org file which contains the item at point.
  8612. When called repeatedly, scroll the window that is displaying the buffer.
  8613. With a `\\[universal-argument]' prefix argument, display the item, but \
  8614. fold drawers."
  8615. (interactive "P")
  8616. (let ((win (selected-window)))
  8617. (if (and (window-live-p org-agenda-show-window)
  8618. (eq this-command last-command))
  8619. (progn
  8620. (select-window org-agenda-show-window)
  8621. (ignore-errors (scroll-up)))
  8622. (org-agenda-goto t)
  8623. (org-show-entry)
  8624. (if arg (org-cycle-hide-drawers 'children)
  8625. (org-with-wide-buffer
  8626. (narrow-to-region (org-entry-beginning-position)
  8627. (org-entry-end-position))
  8628. (org-show-all '(drawers))))
  8629. (setq org-agenda-show-window (selected-window)))
  8630. (select-window win)))
  8631. (defun org-agenda-show-scroll-down ()
  8632. "Scroll down the window showing the agenda."
  8633. (interactive)
  8634. (let ((win (selected-window)))
  8635. (when (window-live-p org-agenda-show-window)
  8636. (select-window org-agenda-show-window)
  8637. (ignore-errors (scroll-down))
  8638. (select-window win))))
  8639. (defun org-agenda-show-1 (&optional more)
  8640. "Display the Org file which contains the item at point.
  8641. The prefix arg selects the amount of information to display:
  8642. 0 hide the subtree
  8643. 1 just show the entry according to defaults.
  8644. 2 show the children view
  8645. 3 show the subtree view
  8646. 4 show the entire subtree and any drawers
  8647. With prefix argument FULL-ENTRY, make the entire entry visible
  8648. if it was hidden in the outline."
  8649. (interactive "p")
  8650. (let ((win (selected-window)))
  8651. (org-agenda-goto t)
  8652. (org-back-to-heading)
  8653. (set-window-start (selected-window) (point-at-bol))
  8654. (cond
  8655. ((= more 0)
  8656. (org-flag-subtree t)
  8657. (save-excursion
  8658. (org-back-to-heading)
  8659. (run-hook-with-args 'org-cycle-hook 'folded))
  8660. (message "Remote: FOLDED"))
  8661. ((and (called-interactively-p 'any) (= more 1))
  8662. (message "Remote: show with default settings"))
  8663. ((= more 2)
  8664. (outline-show-entry)
  8665. (org-show-children)
  8666. (save-excursion
  8667. (org-back-to-heading)
  8668. (run-hook-with-args 'org-cycle-hook 'children))
  8669. (message "Remote: CHILDREN"))
  8670. ((= more 3)
  8671. (outline-show-subtree)
  8672. (save-excursion
  8673. (org-back-to-heading)
  8674. (run-hook-with-args 'org-cycle-hook 'subtree))
  8675. (message "Remote: SUBTREE"))
  8676. ((> more 3)
  8677. (outline-show-subtree)
  8678. (message "Remote: SUBTREE AND ALL DRAWERS")))
  8679. (select-window win)))
  8680. (defvar org-agenda-cycle-counter nil)
  8681. (defun org-agenda-cycle-show (&optional n)
  8682. "Show the current entry in another window, with default settings.
  8683. Default settings are taken from `org-show-context-detail'. When
  8684. use repeatedly in immediate succession, the remote entry will
  8685. cycle through visibility
  8686. children -> subtree -> folded
  8687. When called with a numeric prefix arg, that arg will be passed through to
  8688. `org-agenda-show-1'. For the interpretation of that argument, see the
  8689. docstring of `org-agenda-show-1'."
  8690. (interactive "P")
  8691. (if (integerp n)
  8692. (setq org-agenda-cycle-counter n)
  8693. (if (not (eq last-command this-command))
  8694. (setq org-agenda-cycle-counter 1)
  8695. (if (equal org-agenda-cycle-counter 0)
  8696. (setq org-agenda-cycle-counter 2)
  8697. (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
  8698. (when (> org-agenda-cycle-counter 3)
  8699. (setq org-agenda-cycle-counter 0)))))
  8700. (org-agenda-show-1 org-agenda-cycle-counter))
  8701. (defun org-agenda-recenter (arg)
  8702. "Display the Org file which contains the item at point and recenter."
  8703. (interactive "P")
  8704. (let ((win (selected-window)))
  8705. (org-agenda-goto t)
  8706. (recenter arg)
  8707. (select-window win)))
  8708. (defun org-agenda-show-mouse (ev)
  8709. "Display the Org file which contains the item at the mouse click."
  8710. (interactive "e")
  8711. (mouse-set-point ev)
  8712. (org-agenda-show))
  8713. (defun org-agenda-check-no-diary ()
  8714. "Check if the entry is a diary link and abort if yes."
  8715. (when (org-get-at-bol 'org-agenda-diary-link)
  8716. (org-agenda-error)))
  8717. (defun org-agenda-error ()
  8718. "Throw an error when a command is not allowed in the agenda."
  8719. (user-error "Command not allowed in this line"))
  8720. (defun org-agenda-tree-to-indirect-buffer (arg)
  8721. "Show the subtree corresponding to the current entry in an indirect buffer.
  8722. This calls the command `org-tree-to-indirect-buffer' from the original buffer.
  8723. With a numerical prefix ARG, go up to this level and then take that tree.
  8724. With a negative numeric ARG, go up by this number of levels.
  8725. With a `\\[universal-argument]' prefix, make a separate frame for this tree, \
  8726. i.e. don't use
  8727. the dedicated frame."
  8728. (interactive "P")
  8729. (if current-prefix-arg
  8730. (org-agenda-do-tree-to-indirect-buffer arg)
  8731. (let ((agenda-buffer (buffer-name))
  8732. (agenda-window (selected-window))
  8733. (indirect-window
  8734. (and org-last-indirect-buffer
  8735. (get-buffer-window org-last-indirect-buffer))))
  8736. (save-window-excursion (org-agenda-do-tree-to-indirect-buffer arg))
  8737. (unless (or (eq org-indirect-buffer-display 'new-frame)
  8738. (eq org-indirect-buffer-display 'dedicated-frame))
  8739. (unwind-protect
  8740. (unless (and indirect-window (window-live-p indirect-window))
  8741. (setq indirect-window (split-window agenda-window)))
  8742. (and indirect-window (select-window indirect-window))
  8743. (switch-to-buffer org-last-indirect-buffer :norecord)
  8744. (fit-window-to-buffer indirect-window)))
  8745. (select-window (get-buffer-window agenda-buffer))
  8746. (setq org-agenda-last-indirect-buffer org-last-indirect-buffer))))
  8747. (defun org-agenda-do-tree-to-indirect-buffer (arg)
  8748. "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
  8749. (org-agenda-check-no-diary)
  8750. (let* ((marker (or (org-get-at-bol 'org-marker)
  8751. (org-agenda-error)))
  8752. (buffer (marker-buffer marker))
  8753. (pos (marker-position marker)))
  8754. (with-current-buffer buffer
  8755. (save-excursion
  8756. (goto-char pos)
  8757. (org-tree-to-indirect-buffer arg)))))
  8758. (defvar org-last-heading-marker (make-marker)
  8759. "Marker pointing to the headline that last changed its TODO state
  8760. by a remote command from the agenda.")
  8761. (defun org-agenda-todo-nextset ()
  8762. "Switch TODO entry to next sequence."
  8763. (interactive)
  8764. (org-agenda-todo 'nextset))
  8765. (defun org-agenda-todo-previousset ()
  8766. "Switch TODO entry to previous sequence."
  8767. (interactive)
  8768. (org-agenda-todo 'previousset))
  8769. (defvar org-agenda-headline-snapshot-before-repeat)
  8770. (defun org-agenda-todo (&optional arg)
  8771. "Cycle TODO state of line at point, also in Org file.
  8772. This changes the line at point, all other lines in the agenda referring to
  8773. the same tree node, and the headline of the tree node in the Org file."
  8774. (interactive "P")
  8775. (org-agenda-check-no-diary)
  8776. (org-agenda-maybe-loop
  8777. #'org-agenda-todo arg nil nil
  8778. (let* ((col (current-column))
  8779. (marker (or (org-get-at-bol 'org-marker)
  8780. (org-agenda-error)))
  8781. (buffer (marker-buffer marker))
  8782. (pos (marker-position marker))
  8783. (hdmarker (org-get-at-bol 'org-hd-marker))
  8784. (todayp (org-agenda-today-p (org-get-at-bol 'day)))
  8785. (inhibit-read-only t)
  8786. org-loop-over-headlines-in-active-region
  8787. org-agenda-headline-snapshot-before-repeat newhead just-one)
  8788. (org-with-remote-undo buffer
  8789. (with-current-buffer buffer
  8790. (widen)
  8791. (goto-char pos)
  8792. (org-show-context 'agenda)
  8793. (let ((current-prefix-arg arg))
  8794. (call-interactively 'org-todo)
  8795. ;; Make sure that log is recorded in current undo.
  8796. (when (and org-log-setup
  8797. (not (eq org-log-note-how 'note)))
  8798. (org-add-log-note)))
  8799. (and (bolp) (forward-char 1))
  8800. (setq newhead (org-get-heading))
  8801. (when (and org-agenda-headline-snapshot-before-repeat
  8802. (not (equal org-agenda-headline-snapshot-before-repeat
  8803. newhead))
  8804. todayp)
  8805. (setq newhead org-agenda-headline-snapshot-before-repeat
  8806. just-one t))
  8807. (save-excursion
  8808. (org-back-to-heading)
  8809. (move-marker org-last-heading-marker (point))))
  8810. (beginning-of-line 1)
  8811. (save-window-excursion
  8812. (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
  8813. (when (bound-and-true-p org-clock-out-when-done)
  8814. (string-match (concat "^" (regexp-opt org-done-keywords-for-agenda))
  8815. newhead)
  8816. (org-agenda-unmark-clocking-task))
  8817. (org-move-to-column col)
  8818. (org-agenda-mark-clocking-task)))))
  8819. (defun org-agenda-add-note (&optional _arg)
  8820. "Add a time-stamped note to the entry at point."
  8821. (interactive) ;; "P"
  8822. (org-agenda-check-no-diary)
  8823. (let* ((marker (or (org-get-at-bol 'org-marker)
  8824. (org-agenda-error)))
  8825. (buffer (marker-buffer marker))
  8826. (pos (marker-position marker))
  8827. (_hdmarker (org-get-at-bol 'org-hd-marker))
  8828. (inhibit-read-only t))
  8829. (with-current-buffer buffer
  8830. (widen)
  8831. (goto-char pos)
  8832. (org-show-context 'agenda)
  8833. (org-add-note))))
  8834. (defun org-agenda-change-all-lines (newhead hdmarker
  8835. &optional fixface just-this)
  8836. "Change all lines in the agenda buffer which match HDMARKER.
  8837. The new content of the line will be NEWHEAD (as modified by
  8838. `org-agenda-format-item'). HDMARKER is checked with
  8839. `equal' against all `org-hd-marker' text properties in the file.
  8840. If FIXFACE is non-nil, the face of each item is modified according to
  8841. the new TODO state.
  8842. If JUST-THIS is non-nil, change just the current line, not all.
  8843. If FORCE-TAGS is non-nil, the car of it returns the new tags."
  8844. (let* ((inhibit-read-only t)
  8845. (line (org-current-line))
  8846. (org-agenda-buffer (current-buffer))
  8847. (thetags (with-current-buffer (marker-buffer hdmarker)
  8848. (org-get-tags hdmarker)))
  8849. props m undone-face done-face finish new dotime level cat tags) ;; pl
  8850. (save-excursion
  8851. (goto-char (point-max))
  8852. (beginning-of-line 1)
  8853. (while (not finish)
  8854. (setq finish (bobp))
  8855. (when (and (setq m (org-get-at-bol 'org-hd-marker))
  8856. (or (not just-this) (= (org-current-line) line))
  8857. (equal m hdmarker))
  8858. (setq props (text-properties-at (point))
  8859. dotime (org-get-at-bol 'dotime)
  8860. cat (org-agenda-get-category)
  8861. level (org-get-at-bol 'level)
  8862. tags thetags
  8863. new
  8864. (let ((org-prefix-format-compiled
  8865. (or (get-text-property (min (1- (point-max)) (point)) 'format)
  8866. org-prefix-format-compiled))
  8867. (extra (org-get-at-bol 'extra)))
  8868. (with-current-buffer (marker-buffer hdmarker)
  8869. (org-with-wide-buffer
  8870. (org-agenda-format-item extra newhead level cat tags dotime))))
  8871. ;; pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
  8872. undone-face (org-get-at-bol 'undone-face)
  8873. done-face (org-get-at-bol 'done-face))
  8874. (beginning-of-line 1)
  8875. (cond
  8876. ((equal new "") (delete-region (point) (line-beginning-position 2)))
  8877. ((looking-at ".*")
  8878. ;; When replacing the whole line, preserve bulk mark
  8879. ;; overlay, if any.
  8880. (let ((mark (catch :overlay
  8881. (dolist (o (overlays-in (point) (+ 2 (point))))
  8882. (when (eq (overlay-get o 'type)
  8883. 'org-marked-entry-overlay)
  8884. (throw :overlay o))))))
  8885. (replace-match new t t)
  8886. (beginning-of-line)
  8887. (when mark (move-overlay mark (point) (+ 2 (point)))))
  8888. (add-text-properties (point-at-bol) (point-at-eol) props)
  8889. (when fixface
  8890. (add-text-properties
  8891. (point-at-bol) (point-at-eol)
  8892. (list 'face
  8893. (if org-last-todo-state-is-todo
  8894. undone-face done-face))))
  8895. (org-agenda-highlight-todo 'line)
  8896. (beginning-of-line 1))
  8897. (t (error "Line update did not work")))
  8898. (save-restriction
  8899. (narrow-to-region (point-at-bol) (point-at-eol))
  8900. (org-agenda-finalize)))
  8901. (beginning-of-line 0)))))
  8902. (defun org-agenda-align-tags (&optional line)
  8903. "Align all tags in agenda items to `org-agenda-tags-column'.
  8904. When optional argument LINE is non-nil, align tags only on the
  8905. current line."
  8906. (let ((inhibit-read-only t)
  8907. (org-agenda-tags-column (if (eq 'auto org-agenda-tags-column)
  8908. (- (window-text-width))
  8909. org-agenda-tags-column))
  8910. (end (and line (line-end-position)))
  8911. l c)
  8912. (save-excursion
  8913. (goto-char (if line (line-beginning-position) (point-min)))
  8914. (while (re-search-forward org-tag-group-re end t)
  8915. (add-text-properties
  8916. (match-beginning 1) (match-end 1)
  8917. (list 'face (delq nil (let ((prop (get-text-property
  8918. (match-beginning 1) 'face)))
  8919. (or (listp prop) (setq prop (list prop)))
  8920. (if (memq 'org-tag prop)
  8921. prop
  8922. (cons 'org-tag prop))))))
  8923. (setq l (string-width (match-string 1))
  8924. c (if (< org-agenda-tags-column 0)
  8925. (- (abs org-agenda-tags-column) l)
  8926. org-agenda-tags-column))
  8927. (goto-char (match-beginning 1))
  8928. (delete-region (save-excursion (skip-chars-backward " \t") (point))
  8929. (point))
  8930. (insert (org-add-props
  8931. (make-string (max 1 (- c (current-column))) ?\s)
  8932. (plist-put (copy-sequence (text-properties-at (point)))
  8933. 'face nil))))
  8934. (goto-char (point-min))
  8935. (org-font-lock-add-tag-faces (point-max)))))
  8936. (defun org-agenda-priority-up ()
  8937. "Increase the priority of line at point, also in Org file."
  8938. (interactive)
  8939. (org-agenda-priority 'up))
  8940. (defun org-agenda-priority-down ()
  8941. "Decrease the priority of line at point, also in Org file."
  8942. (interactive)
  8943. (org-agenda-priority 'down))
  8944. (defun org-agenda-priority (&optional force-direction)
  8945. "Set the priority of line at point, also in Org file.
  8946. This changes the line at point, all other lines in the agenda
  8947. referring to the same tree node, and the headline of the tree
  8948. node in the Org file.
  8949. Called with one universal prefix arg, show the priority instead
  8950. of setting it.
  8951. When called programmatically, FORCE-DIRECTION can be `set', `up',
  8952. `down', or a character."
  8953. (interactive "P")
  8954. (unless org-priority-enable-commands
  8955. (user-error "Priority commands are disabled"))
  8956. (org-agenda-check-no-diary)
  8957. (let* ((col (current-column))
  8958. (hdmarker (org-get-at-bol 'org-hd-marker))
  8959. (buffer (marker-buffer hdmarker))
  8960. (pos (marker-position hdmarker))
  8961. (inhibit-read-only t)
  8962. newhead)
  8963. (org-with-remote-undo buffer
  8964. (with-current-buffer buffer
  8965. (widen)
  8966. (goto-char pos)
  8967. (org-show-context 'agenda)
  8968. (org-priority force-direction)
  8969. (end-of-line 1)
  8970. (setq newhead (org-get-heading)))
  8971. (org-agenda-change-all-lines newhead hdmarker)
  8972. (org-move-to-column col))))
  8973. ;; FIXME: should fix the tags property of the agenda line.
  8974. (defun org-agenda-set-tags (&optional tag onoff)
  8975. "Set tags for the current headline."
  8976. (interactive)
  8977. (org-agenda-check-no-diary)
  8978. (if (and (org-region-active-p) (called-interactively-p 'any))
  8979. (call-interactively 'org-change-tag-in-region)
  8980. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8981. (org-agenda-error)))
  8982. (buffer (marker-buffer hdmarker))
  8983. (pos (marker-position hdmarker))
  8984. (inhibit-read-only t)
  8985. newhead)
  8986. (org-with-remote-undo buffer
  8987. (with-current-buffer buffer
  8988. (widen)
  8989. (goto-char pos)
  8990. (org-show-context 'agenda)
  8991. (if tag
  8992. (org-toggle-tag tag onoff)
  8993. (call-interactively #'org-set-tags-command))
  8994. (end-of-line 1)
  8995. (setq newhead (org-get-heading)))
  8996. (org-agenda-change-all-lines newhead hdmarker)
  8997. (beginning-of-line 1)))))
  8998. (defun org-agenda-set-property ()
  8999. "Set a property for the current headline."
  9000. (interactive)
  9001. (org-agenda-check-no-diary)
  9002. (org-agenda-maybe-loop
  9003. #'org-agenda-set-property nil nil nil
  9004. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  9005. (org-agenda-error)))
  9006. (buffer (marker-buffer hdmarker))
  9007. (pos (marker-position hdmarker))
  9008. (inhibit-read-only t)
  9009. ) ;; newhead
  9010. (org-with-remote-undo buffer
  9011. (with-current-buffer buffer
  9012. (widen)
  9013. (goto-char pos)
  9014. (org-show-context 'agenda)
  9015. (call-interactively 'org-set-property))))))
  9016. (defun org-agenda-set-effort ()
  9017. "Set the effort property for the current headline."
  9018. (interactive)
  9019. (org-agenda-check-no-diary)
  9020. (org-agenda-maybe-loop
  9021. #'org-agenda-set-effort nil nil nil
  9022. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  9023. (org-agenda-error)))
  9024. (buffer (marker-buffer hdmarker))
  9025. (pos (marker-position hdmarker))
  9026. (inhibit-read-only t)
  9027. newhead)
  9028. (org-with-remote-undo buffer
  9029. (with-current-buffer buffer
  9030. (widen)
  9031. (goto-char pos)
  9032. (org-show-context 'agenda)
  9033. (call-interactively 'org-set-effort)
  9034. (end-of-line 1)
  9035. (setq newhead (org-get-heading)))
  9036. (org-agenda-change-all-lines newhead hdmarker)))))
  9037. (defun org-agenda-toggle-archive-tag ()
  9038. "Toggle the archive tag for the current entry."
  9039. (interactive)
  9040. (org-agenda-check-no-diary)
  9041. (org-agenda-maybe-loop
  9042. #'org-agenda-toggle-archive-tag nil nil nil
  9043. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  9044. (org-agenda-error)))
  9045. (buffer (marker-buffer hdmarker))
  9046. (pos (marker-position hdmarker))
  9047. (inhibit-read-only t)
  9048. newhead)
  9049. (org-with-remote-undo buffer
  9050. (with-current-buffer buffer
  9051. (widen)
  9052. (goto-char pos)
  9053. (org-show-context 'agenda)
  9054. (call-interactively 'org-toggle-archive-tag)
  9055. (end-of-line 1)
  9056. (setq newhead (org-get-heading)))
  9057. (org-agenda-change-all-lines newhead hdmarker)
  9058. (beginning-of-line 1)))))
  9059. (defun org-agenda-do-date-later (arg)
  9060. (interactive "P")
  9061. (cond
  9062. ((or (equal arg '(16))
  9063. (memq last-command
  9064. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  9065. (setq this-command 'org-agenda-date-later-minutes)
  9066. (org-agenda-date-later-minutes 1))
  9067. ((or (equal arg '(4))
  9068. (memq last-command
  9069. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  9070. (setq this-command 'org-agenda-date-later-hours)
  9071. (org-agenda-date-later-hours 1))
  9072. (t
  9073. (org-agenda-date-later (prefix-numeric-value arg)))))
  9074. (defun org-agenda-do-date-earlier (arg)
  9075. (interactive "P")
  9076. (cond
  9077. ((or (equal arg '(16))
  9078. (memq last-command
  9079. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  9080. (setq this-command 'org-agenda-date-earlier-minutes)
  9081. (org-agenda-date-earlier-minutes 1))
  9082. ((or (equal arg '(4))
  9083. (memq last-command
  9084. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  9085. (setq this-command 'org-agenda-date-earlier-hours)
  9086. (org-agenda-date-earlier-hours 1))
  9087. (t
  9088. (org-agenda-date-earlier (prefix-numeric-value arg)))))
  9089. (defun org-agenda-date-later (arg &optional what)
  9090. "Change the date of this item to ARG day(s) later."
  9091. (interactive "p")
  9092. (org-agenda-check-type t 'agenda)
  9093. (org-agenda-check-no-diary)
  9094. (let* ((marker (or (org-get-at-bol 'org-marker)
  9095. (org-agenda-error)))
  9096. (buffer (marker-buffer marker))
  9097. (pos (marker-position marker))
  9098. cdate today)
  9099. (org-with-remote-undo buffer
  9100. (with-current-buffer buffer
  9101. (widen)
  9102. (goto-char pos)
  9103. (unless (org-at-timestamp-p 'lax) (error "Cannot find time stamp"))
  9104. (when (and org-agenda-move-date-from-past-immediately-to-today
  9105. (equal arg 1)
  9106. (or (not what) (eq what 'day))
  9107. (not (save-match-data (org-at-date-range-p))))
  9108. (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
  9109. cdate (calendar-absolute-from-gregorian
  9110. (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
  9111. today (org-today))
  9112. (when (> today cdate)
  9113. ;; immediately shift to today
  9114. (setq arg (- today cdate))))
  9115. (org-timestamp-change arg (or what 'day))
  9116. (when (and (org-at-date-range-p)
  9117. (re-search-backward org-tr-regexp-both (point-at-bol)))
  9118. (let ((end org-last-changed-timestamp))
  9119. (org-timestamp-change arg (or what 'day))
  9120. (setq org-last-changed-timestamp
  9121. (concat org-last-changed-timestamp "--" end)))))
  9122. (org-agenda-show-new-time marker org-last-changed-timestamp))
  9123. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  9124. (defun org-agenda-date-earlier (arg &optional what)
  9125. "Change the date of this item to ARG day(s) earlier."
  9126. (interactive "p")
  9127. (org-agenda-date-later (- arg) what))
  9128. (defun org-agenda-date-later-minutes (arg)
  9129. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  9130. (interactive "p")
  9131. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  9132. (org-agenda-date-later arg 'minute))
  9133. (defun org-agenda-date-earlier-minutes (arg)
  9134. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  9135. (interactive "p")
  9136. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  9137. (org-agenda-date-earlier arg 'minute))
  9138. (defun org-agenda-date-later-hours (arg)
  9139. "Change the time of this item, in hour steps."
  9140. (interactive "p")
  9141. (org-agenda-date-later arg 'hour))
  9142. (defun org-agenda-date-earlier-hours (arg)
  9143. "Change the time of this item, in hour steps."
  9144. (interactive "p")
  9145. (org-agenda-date-earlier arg 'hour))
  9146. (defun org-agenda-show-new-time (marker stamp &optional prefix)
  9147. "Show new date stamp via text properties."
  9148. ;; We use text properties to make this undoable
  9149. (let ((inhibit-read-only t))
  9150. (setq stamp (concat prefix " => " stamp " "))
  9151. (save-excursion
  9152. (goto-char (point-max))
  9153. (while (not (bobp))
  9154. (when (equal marker (org-get-at-bol 'org-marker))
  9155. (remove-text-properties (line-beginning-position)
  9156. (line-end-position)
  9157. '(display nil))
  9158. (org-move-to-column
  9159. (- (if (fboundp 'window-font-width)
  9160. (/ (window-width nil t) (window-font-width))
  9161. ;; Fall back to pre-9.3.3 behavior on Emacs <25.
  9162. (window-width))
  9163. (length stamp))
  9164. t)
  9165. (add-text-properties
  9166. (1- (point)) (point-at-eol)
  9167. (list 'display (org-add-props stamp nil
  9168. 'face '(secondary-selection default))))
  9169. (beginning-of-line 1))
  9170. (beginning-of-line 0)))))
  9171. (defun org-agenda-date-prompt (arg)
  9172. "Change the date of this item. Date is prompted for, with default today.
  9173. The prefix ARG is passed to the `org-time-stamp' command and can therefore
  9174. be used to request time specification in the time stamp."
  9175. (interactive "P")
  9176. (org-agenda-check-type t 'agenda)
  9177. (org-agenda-check-no-diary)
  9178. (org-agenda-maybe-loop
  9179. #'org-agenda-date-prompt arg t nil
  9180. (let* ((marker (or (org-get-at-bol 'org-marker)
  9181. (org-agenda-error)))
  9182. (buffer (marker-buffer marker))
  9183. (pos (marker-position marker)))
  9184. (org-with-remote-undo buffer
  9185. (with-current-buffer buffer
  9186. (widen)
  9187. (goto-char pos)
  9188. (unless (org-at-timestamp-p 'lax) (error "Cannot find time stamp"))
  9189. (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
  9190. (org-agenda-show-new-time marker org-last-changed-timestamp))
  9191. (message "Time stamp changed to %s" org-last-changed-timestamp))))
  9192. (defun org-agenda-schedule (arg &optional time)
  9193. "Schedule the item at point.
  9194. ARG is passed through to `org-schedule'."
  9195. (interactive "P")
  9196. (org-agenda-check-type t 'agenda 'todo 'tags 'search)
  9197. (org-agenda-check-no-diary)
  9198. (org-agenda-maybe-loop
  9199. #'org-agenda-schedule arg t nil
  9200. (let* ((marker (or (org-get-at-bol 'org-marker)
  9201. (org-agenda-error)))
  9202. ;; (type (marker-insertion-type marker))
  9203. (buffer (marker-buffer marker))
  9204. (pos (marker-position marker))
  9205. ts)
  9206. (set-marker-insertion-type marker t)
  9207. (org-with-remote-undo buffer
  9208. (with-current-buffer buffer
  9209. (widen)
  9210. (goto-char pos)
  9211. (setq ts (org-schedule arg time)))
  9212. (org-agenda-show-new-time marker ts " S"))
  9213. (message "%s" ts))))
  9214. (defun org-agenda-deadline (arg &optional time)
  9215. "Schedule the item at point.
  9216. ARG is passed through to `org-deadline'."
  9217. (interactive "P")
  9218. (org-agenda-check-type t 'agenda 'todo 'tags 'search)
  9219. (org-agenda-check-no-diary)
  9220. (org-agenda-maybe-loop
  9221. #'org-agenda-deadline arg t nil
  9222. (let* ((marker (or (org-get-at-bol 'org-marker)
  9223. (org-agenda-error)))
  9224. (buffer (marker-buffer marker))
  9225. (pos (marker-position marker))
  9226. ts)
  9227. (org-with-remote-undo buffer
  9228. (with-current-buffer buffer
  9229. (widen)
  9230. (goto-char pos)
  9231. (setq ts (org-deadline arg time)))
  9232. (org-agenda-show-new-time marker ts " D"))
  9233. (message "%s" ts))))
  9234. (defun org-agenda-clock-in (&optional arg)
  9235. "Start the clock on the currently selected item."
  9236. (interactive "P")
  9237. (org-agenda-check-no-diary)
  9238. (if (equal arg '(4))
  9239. (org-clock-in arg)
  9240. (let* ((marker (or (org-get-at-bol 'org-marker)
  9241. (org-agenda-error)))
  9242. (hdmarker (or (org-get-at-bol 'org-hd-marker) marker))
  9243. (pos (marker-position marker))
  9244. (col (current-column))
  9245. newhead)
  9246. (org-with-remote-undo (marker-buffer marker)
  9247. (with-current-buffer (marker-buffer marker)
  9248. (widen)
  9249. (goto-char pos)
  9250. (org-show-context 'agenda)
  9251. (org-clock-in arg)
  9252. (setq newhead (org-get-heading)))
  9253. (org-agenda-change-all-lines newhead hdmarker))
  9254. (org-move-to-column col))))
  9255. (defun org-agenda-clock-out ()
  9256. "Stop the currently running clock."
  9257. (interactive)
  9258. (unless (marker-buffer org-clock-marker)
  9259. (user-error "No running clock"))
  9260. (let ((marker (make-marker)) (col (current-column)) newhead)
  9261. (org-with-remote-undo (marker-buffer org-clock-marker)
  9262. (with-current-buffer (marker-buffer org-clock-marker)
  9263. (org-with-wide-buffer
  9264. (goto-char org-clock-marker)
  9265. (org-back-to-heading t)
  9266. (move-marker marker (point))
  9267. (org-clock-out)
  9268. (setq newhead (org-get-heading)))))
  9269. (org-agenda-change-all-lines newhead marker)
  9270. (move-marker marker nil)
  9271. (org-move-to-column col)
  9272. (org-agenda-unmark-clocking-task)))
  9273. (defun org-agenda-clock-cancel (&optional _arg)
  9274. "Cancel the currently running clock."
  9275. (interactive) ;; "P"
  9276. (unless (marker-buffer org-clock-marker)
  9277. (user-error "No running clock"))
  9278. (org-with-remote-undo (marker-buffer org-clock-marker)
  9279. (org-clock-cancel)))
  9280. (defun org-agenda-clock-goto ()
  9281. "Jump to the currently clocked in task within the agenda.
  9282. If the currently clocked in task is not listed in the agenda
  9283. buffer, display it in another window."
  9284. (interactive)
  9285. (let (pos)
  9286. (mapc (lambda (o)
  9287. (when (eq (overlay-get o 'type) 'org-agenda-clocking)
  9288. (setq pos (overlay-start o))))
  9289. (overlays-in (point-min) (point-max)))
  9290. (cond (pos (goto-char pos))
  9291. ;; If the currently clocked entry is not in the agenda
  9292. ;; buffer, we visit it in another window:
  9293. ((bound-and-true-p org-clock-current-task)
  9294. (org-switch-to-buffer-other-window (org-clock-goto)))
  9295. (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
  9296. (defun org-agenda-diary-entry-in-org-file ()
  9297. "Make a diary entry in the file `org-agenda-diary-file'."
  9298. (let (d1 d2 char (text "") dp1 dp2)
  9299. (if (equal (buffer-name) "*Calendar*")
  9300. (setq d1 (calendar-cursor-to-date t)
  9301. d2 (car calendar-mark-ring))
  9302. (setq dp1 (get-text-property (point-at-bol) 'day))
  9303. (unless dp1 (user-error "No date defined in current line"))
  9304. (setq d1 (calendar-gregorian-from-absolute dp1)
  9305. d2 (and (ignore-errors (mark))
  9306. (save-excursion
  9307. (goto-char (mark))
  9308. (setq dp2 (get-text-property (point-at-bol) 'day)))
  9309. (calendar-gregorian-from-absolute dp2))))
  9310. (message "Diary entry: [d]ay [a]nniversary [b]lock [j]ump to date tree")
  9311. (setq char (read-char-exclusive))
  9312. (cond
  9313. ((equal char ?d)
  9314. (setq text (read-string "Day entry: "))
  9315. (org-agenda-add-entry-to-org-agenda-diary-file 'day text d1)
  9316. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  9317. ((equal char ?a)
  9318. (setq d1 (list (car d1) (nth 1 d1)
  9319. (read-number (format "Reference year [%d]: " (nth 2 d1))
  9320. (nth 2 d1))))
  9321. (setq text (read-string "Anniversary (use %d to show years): "))
  9322. (org-agenda-add-entry-to-org-agenda-diary-file 'anniversary text d1)
  9323. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  9324. ((equal char ?b)
  9325. (setq text (read-string "Block entry: "))
  9326. (unless (and d1 d2 (not (equal d1 d2)))
  9327. (user-error "No block of days selected"))
  9328. (org-agenda-add-entry-to-org-agenda-diary-file 'block text d1 d2)
  9329. (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
  9330. ((equal char ?j)
  9331. (org-switch-to-buffer-other-window
  9332. (find-file-noselect org-agenda-diary-file))
  9333. (require 'org-datetree)
  9334. (org-datetree-find-date-create d1)
  9335. (org-reveal t))
  9336. (t (user-error "Invalid selection character `%c'" char)))))
  9337. (defcustom org-agenda-insert-diary-strategy 'date-tree
  9338. "Where in `org-agenda-diary-file' should new entries be added?
  9339. Valid values:
  9340. date-tree in the date tree, as first child of the date
  9341. date-tree-last in the date tree, as last child of the date
  9342. top-level as top-level entries at the end of the file."
  9343. :group 'org-agenda
  9344. :type '(choice
  9345. (const :tag "first in a date tree" date-tree)
  9346. (const :tag "last in a date tree" date-tree-last)
  9347. (const :tag "as top level at end of file" top-level)))
  9348. (defcustom org-agenda-insert-diary-extract-time nil
  9349. "Non-nil means extract any time specification from the diary entry."
  9350. :group 'org-agenda
  9351. :version "24.1"
  9352. :type 'boolean)
  9353. (defcustom org-agenda-bulk-mark-char ">"
  9354. "A single-character string to be used as the bulk mark."
  9355. :group 'org-agenda
  9356. :version "24.1"
  9357. :type 'string)
  9358. (defun org-agenda-add-entry-to-org-agenda-diary-file (type text &optional d1 d2)
  9359. "Add a diary entry with TYPE to `org-agenda-diary-file'.
  9360. If TEXT is not empty, it will become the headline of the new entry, and
  9361. the resulting entry will not be shown. When TEXT is empty, switch to
  9362. `org-agenda-diary-file' and let the user finish the entry there."
  9363. (let ((cw (current-window-configuration)))
  9364. (org-switch-to-buffer-other-window
  9365. (find-file-noselect org-agenda-diary-file))
  9366. (widen)
  9367. (goto-char (point-min))
  9368. (cl-case type
  9369. (anniversary
  9370. (or (re-search-forward "^\\*[ \t]+Anniversaries" nil t)
  9371. (progn
  9372. (or (org-at-heading-p t)
  9373. (progn
  9374. (outline-next-heading)
  9375. (insert "* Anniversaries\n\n")
  9376. (beginning-of-line -1)))))
  9377. (outline-next-heading)
  9378. (org-back-over-empty-lines)
  9379. (backward-char 1)
  9380. (insert "\n")
  9381. (insert (format "%%%%(org-anniversary %d %2d %2d) %s"
  9382. (nth 2 d1) (car d1) (nth 1 d1) text)))
  9383. (day
  9384. (let ((org-prefix-has-time t)
  9385. (org-agenda-time-leading-zero t)
  9386. fmt time time2)
  9387. (when org-agenda-insert-diary-extract-time
  9388. ;; Use org-agenda-format-item to parse text for a time-range and
  9389. ;; remove it. FIXME: This is a hack, we should refactor
  9390. ;; that function to make time extraction available separately
  9391. (setq fmt (org-agenda-format-item nil text nil nil nil t)
  9392. time (get-text-property 0 'time fmt)
  9393. time2 (if (> (length time) 0)
  9394. ;; split-string removes trailing ...... if
  9395. ;; no end time given. First space
  9396. ;; separates time from date.
  9397. (concat " " (car (split-string time "\\.")))
  9398. nil)
  9399. text (get-text-property 0 'txt fmt)))
  9400. (if (eq org-agenda-insert-diary-strategy 'top-level)
  9401. (org-agenda-insert-diary-as-top-level text)
  9402. (require 'org-datetree)
  9403. (org-datetree-find-date-create d1)
  9404. (org-agenda-insert-diary-make-new-entry text))
  9405. (org-insert-time-stamp (org-time-from-absolute
  9406. (calendar-absolute-from-gregorian d1))
  9407. nil nil nil nil time2))
  9408. (end-of-line 0))
  9409. ((block) ;; Wrap this in (strictly unnecessary) parens because
  9410. ;; otherwise the indentation gets confused by the
  9411. ;; special meaning of 'block
  9412. (when (> (calendar-absolute-from-gregorian d1)
  9413. (calendar-absolute-from-gregorian d2))
  9414. (setq d1 (prog1 d2 (setq d2 d1))))
  9415. (if (eq org-agenda-insert-diary-strategy 'top-level)
  9416. (org-agenda-insert-diary-as-top-level text)
  9417. (require 'org-datetree)
  9418. (org-datetree-find-date-create d1)
  9419. (org-agenda-insert-diary-make-new-entry text))
  9420. (org-insert-time-stamp (org-time-from-absolute
  9421. (calendar-absolute-from-gregorian d1)))
  9422. (insert "--")
  9423. (org-insert-time-stamp (org-time-from-absolute
  9424. (calendar-absolute-from-gregorian d2)))
  9425. (end-of-line 0)))
  9426. (if (string-match "\\S-" text)
  9427. (progn
  9428. (set-window-configuration cw)
  9429. (message "%s entry added to %s"
  9430. (capitalize (symbol-name type))
  9431. (abbreviate-file-name org-agenda-diary-file)))
  9432. (org-reveal t)
  9433. (message "Please finish entry here"))))
  9434. (defun org-agenda-insert-diary-as-top-level (text)
  9435. "Make new entry as a top-level entry at the end of the file.
  9436. Add TEXT as headline, and position the cursor in the second line so that
  9437. a timestamp can be added there."
  9438. (widen)
  9439. (goto-char (point-max))
  9440. (unless (bolp) (insert "\n"))
  9441. (org-insert-heading nil t t)
  9442. (insert text)
  9443. (org-end-of-meta-data)
  9444. (unless (bolp) (insert "\n"))
  9445. (when org-adapt-indentation (indent-to-column 2)))
  9446. (defun org-agenda-insert-diary-make-new-entry (text)
  9447. "Make a new entry with TEXT as a child of the current subtree.
  9448. Position the point in the heading's first body line so that
  9449. a timestamp can be added there."
  9450. (cond
  9451. ((eq org-agenda-insert-diary-strategy 'date-tree-last)
  9452. (end-of-line)
  9453. (org-insert-heading '(4) t)
  9454. (org-do-demote))
  9455. (t
  9456. (outline-next-heading)
  9457. (org-back-over-empty-lines)
  9458. (unless (looking-at "[ \t]*$") (save-excursion (insert "\n")))
  9459. (org-insert-heading nil t)
  9460. (org-do-demote)))
  9461. (let ((col (current-column)))
  9462. (insert text)
  9463. (org-end-of-meta-data)
  9464. ;; Ensure point is left on a blank line, at proper indentation.
  9465. (unless (bolp) (insert "\n"))
  9466. (unless (looking-at-p "^[ \t]*$") (save-excursion (insert "\n")))
  9467. (when org-adapt-indentation (indent-to-column col)))
  9468. (org-show-set-visibility 'lineage))
  9469. (defun org-agenda-diary-entry ()
  9470. "Make a diary entry, like the `i' command from the calendar.
  9471. All the standard commands work: block, weekly etc.
  9472. When `org-agenda-diary-file' points to a file,
  9473. `org-agenda-diary-entry-in-org-file' is called instead to create
  9474. entries in that Org file."
  9475. (interactive)
  9476. (if (not (eq org-agenda-diary-file 'diary-file))
  9477. (org-agenda-diary-entry-in-org-file)
  9478. (require 'diary-lib)
  9479. (let* ((char (read-char-exclusive
  9480. "Diary entry: [d]ay [w]eekly [m]onthly [y]early\
  9481. [a]nniversary [b]lock [c]yclic"))
  9482. (cmd (cdr (assoc char
  9483. '((?d . diary-insert-entry)
  9484. (?w . diary-insert-weekly-entry)
  9485. (?m . diary-insert-monthly-entry)
  9486. (?y . diary-insert-yearly-entry)
  9487. (?a . diary-insert-anniversary-entry)
  9488. (?b . diary-insert-block-entry)
  9489. (?c . diary-insert-cyclic-entry)))))
  9490. (oldf (symbol-function 'calendar-cursor-to-date))
  9491. ;; (buf (get-file-buffer (substitute-in-file-name diary-file)))
  9492. (point (point))
  9493. (mark (or (mark t) (point))))
  9494. (unless cmd
  9495. (user-error "No command associated with <%c>" char))
  9496. (unless (and (get-text-property point 'day)
  9497. (or (not (equal ?b char))
  9498. (get-text-property mark 'day)))
  9499. (user-error "Don't know which date to use for diary entry"))
  9500. ;; We implement this by hacking the `calendar-cursor-to-date' function
  9501. ;; and the `calendar-mark-ring' variable. Saves a lot of code.
  9502. (let ((calendar-mark-ring
  9503. (list (calendar-gregorian-from-absolute
  9504. (or (get-text-property mark 'day)
  9505. (get-text-property point 'day))))))
  9506. (unwind-protect
  9507. (progn
  9508. (fset 'calendar-cursor-to-date
  9509. (lambda (&optional _error _dummy)
  9510. (calendar-gregorian-from-absolute
  9511. (get-text-property point 'day))))
  9512. (call-interactively cmd))
  9513. (fset 'calendar-cursor-to-date oldf))))))
  9514. (defun org-agenda-execute-calendar-command (cmd)
  9515. "Execute a calendar command from the agenda with date from cursor."
  9516. (org-agenda-check-type t 'agenda)
  9517. (require 'diary-lib)
  9518. (unless (get-text-property (min (1- (point-max)) (point)) 'day)
  9519. (user-error "Don't know which date to use for the calendar command"))
  9520. (let* ((oldf (symbol-function 'calendar-cursor-to-date))
  9521. (point (point))
  9522. (date (calendar-gregorian-from-absolute
  9523. (get-text-property point 'day))))
  9524. ;; the following 2 vars are needed in the calendar
  9525. (org-dlet
  9526. ((displayed-month (car date))
  9527. (displayed-year (nth 2 date)))
  9528. (unwind-protect
  9529. (progn
  9530. (fset 'calendar-cursor-to-date
  9531. (lambda (&optional _error _dummy)
  9532. (calendar-gregorian-from-absolute
  9533. (get-text-property point 'day))))
  9534. (call-interactively cmd))
  9535. (fset 'calendar-cursor-to-date oldf)))))
  9536. (defun org-agenda-phases-of-moon ()
  9537. "Display the phases of the moon for the 3 months around the cursor date."
  9538. (interactive)
  9539. (org-agenda-execute-calendar-command 'calendar-lunar-phases))
  9540. (defun org-agenda-holidays ()
  9541. "Display the holidays for the 3 months around the cursor date."
  9542. (interactive)
  9543. (org-agenda-execute-calendar-command 'calendar-list-holidays))
  9544. (defvar calendar-longitude) ; defined in calendar.el
  9545. (defvar calendar-latitude) ; defined in calendar.el
  9546. (defvar calendar-location-name) ; defined in calendar.el
  9547. (defun org-agenda-sunrise-sunset (arg)
  9548. "Display sunrise and sunset for the cursor date.
  9549. Latitude and longitude can be specified with the variables
  9550. `calendar-latitude' and `calendar-longitude'. When called with prefix
  9551. argument, latitude and longitude will be prompted for."
  9552. (interactive "P")
  9553. (require 'solar)
  9554. (let ((calendar-longitude (if arg nil calendar-longitude))
  9555. (calendar-latitude (if arg nil calendar-latitude))
  9556. (calendar-location-name
  9557. (if arg "the given coordinates" calendar-location-name)))
  9558. (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
  9559. (defun org-agenda-goto-calendar ()
  9560. "Open the Emacs calendar with the date at the cursor."
  9561. (interactive)
  9562. (org-agenda-check-type t 'agenda)
  9563. (let* ((day (or (get-text-property (min (1- (point-max)) (point)) 'day)
  9564. (user-error "Don't know which date to open in calendar")))
  9565. (date (calendar-gregorian-from-absolute day))
  9566. (calendar-move-hook nil)
  9567. (calendar-view-holidays-initially-flag nil)
  9568. (calendar-view-diary-initially-flag nil))
  9569. (calendar)
  9570. (calendar-goto-date date)))
  9571. ;;;###autoload
  9572. (defun org-calendar-goto-agenda ()
  9573. "Compute the Org agenda for the calendar date displayed at the cursor.
  9574. This is a command that has to be installed in `calendar-mode-map'."
  9575. (interactive)
  9576. ;; Temporarily disable sticky agenda since user clearly wants to
  9577. ;; refresh view anyway.
  9578. (let ((org-agenda-buffer-tmp-name "*Org Agenda(a)*")
  9579. (org-agenda-sticky nil))
  9580. (org-agenda-list nil (calendar-absolute-from-gregorian
  9581. (calendar-cursor-to-date))
  9582. nil)))
  9583. (defun org-agenda-convert-date ()
  9584. (interactive)
  9585. (org-agenda-check-type t 'agenda)
  9586. (let ((day (get-text-property (min (1- (point-max)) (point)) 'day))
  9587. date s)
  9588. (unless day
  9589. (user-error "Don't know which date to convert"))
  9590. (setq date (calendar-gregorian-from-absolute day))
  9591. (setq s (concat
  9592. "Gregorian: " (calendar-date-string date) "\n"
  9593. "ISO: " (calendar-iso-date-string date) "\n"
  9594. "Day of Yr: " (calendar-day-of-year-string date) "\n"
  9595. "Julian: " (calendar-julian-date-string date) "\n"
  9596. "Astron. JD: " (calendar-astro-date-string date)
  9597. " (Julian date number at noon UTC)\n"
  9598. "Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
  9599. "Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
  9600. "French: " (calendar-french-date-string date) "\n"
  9601. "Bahá’í: " (calendar-bahai-date-string date) " (until sunset)\n"
  9602. "Mayan: " (calendar-mayan-date-string date) "\n"
  9603. "Coptic: " (calendar-coptic-date-string date) "\n"
  9604. "Ethiopic: " (calendar-ethiopic-date-string date) "\n"
  9605. "Persian: " (calendar-persian-date-string date) "\n"
  9606. "Chinese: " (calendar-chinese-date-string date) "\n"))
  9607. (with-output-to-temp-buffer "*Dates*"
  9608. (princ s))
  9609. (org-fit-window-to-buffer (get-buffer-window "*Dates*"))))
  9610. ;;; Bulk commands
  9611. (defun org-agenda-bulk-marked-p ()
  9612. "Non-nil when current entry is marked for bulk action."
  9613. (eq (get-char-property (point-at-bol) 'type)
  9614. 'org-marked-entry-overlay))
  9615. (defun org-agenda-bulk-mark (&optional arg)
  9616. "Mark entries for future bulk action.
  9617. When ARG is nil or one and region is not active then mark the
  9618. entry at point.
  9619. When ARG is nil or one and region is active then mark the entries
  9620. in the region.
  9621. When ARG is greater than one mark ARG lines."
  9622. (interactive "p")
  9623. (when (and (or (not arg) (= arg 1)) (use-region-p))
  9624. (setq arg (count-lines (region-beginning) (region-end)))
  9625. (goto-char (region-beginning))
  9626. (deactivate-mark))
  9627. (dotimes (_ (or arg 1))
  9628. (unless (org-get-at-bol 'org-agenda-diary-link)
  9629. (let* ((m (org-get-at-bol 'org-hd-marker))
  9630. ov)
  9631. (unless (org-agenda-bulk-marked-p)
  9632. (unless m (user-error "Nothing to mark at point"))
  9633. (push m org-agenda-bulk-marked-entries)
  9634. (setq ov (make-overlay (point-at-bol) (+ 2 (point-at-bol))))
  9635. (org-overlay-display ov (concat org-agenda-bulk-mark-char " ")
  9636. (org-get-todo-face "TODO")
  9637. 'evaporate)
  9638. (overlay-put ov 'type 'org-marked-entry-overlay))
  9639. (end-of-line 1)
  9640. (or (ignore-errors
  9641. (goto-char (next-single-property-change (point) 'org-hd-marker)))
  9642. (beginning-of-line 2))
  9643. (while (and (get-char-property (point) 'invisible) (not (eobp)))
  9644. (beginning-of-line 2)))))
  9645. (message "%d entries marked for bulk action"
  9646. (length org-agenda-bulk-marked-entries)))
  9647. (defun org-agenda-bulk-mark-all ()
  9648. "Mark all entries for future agenda bulk action."
  9649. (interactive)
  9650. (org-agenda-bulk-mark-regexp "."))
  9651. (defun org-agenda-bulk-mark-regexp (regexp)
  9652. "Mark entries matching REGEXP for future agenda bulk action."
  9653. (interactive "sMark entries matching regexp: ")
  9654. (let ((entries-marked 0) txt-at-point)
  9655. (save-excursion
  9656. (goto-char (point-min))
  9657. (goto-char (next-single-property-change (point) 'org-hd-marker))
  9658. (while (and (re-search-forward regexp nil t)
  9659. (setq txt-at-point
  9660. (get-text-property (match-beginning 0) 'txt)))
  9661. (if (get-char-property (point) 'invisible)
  9662. (beginning-of-line 2)
  9663. (when (string-match-p regexp txt-at-point)
  9664. (setq entries-marked (1+ entries-marked))
  9665. (call-interactively 'org-agenda-bulk-mark)))))
  9666. (unless entries-marked
  9667. (message "No entry matching this regexp."))))
  9668. (defun org-agenda-bulk-unmark (&optional arg)
  9669. "Unmark the entry at point for future bulk action."
  9670. (interactive "P")
  9671. (if arg
  9672. (org-agenda-bulk-unmark-all)
  9673. (cond ((org-agenda-bulk-marked-p)
  9674. (org-agenda-bulk-remove-overlays
  9675. (point-at-bol) (+ 2 (point-at-bol)))
  9676. (setq org-agenda-bulk-marked-entries
  9677. (delete (org-get-at-bol 'org-hd-marker)
  9678. org-agenda-bulk-marked-entries))
  9679. (end-of-line 1)
  9680. (or (ignore-errors
  9681. (goto-char (next-single-property-change (point) 'txt)))
  9682. (beginning-of-line 2))
  9683. (while (and (get-char-property (point) 'invisible) (not (eobp)))
  9684. (beginning-of-line 2))
  9685. (message "%d entries left marked for bulk action"
  9686. (length org-agenda-bulk-marked-entries)))
  9687. (t (message "No entry to unmark here")))))
  9688. (defun org-agenda-bulk-toggle-all ()
  9689. "Toggle all marks for bulk action."
  9690. (interactive)
  9691. (save-excursion
  9692. (goto-char (point-min))
  9693. (while (ignore-errors
  9694. (goto-char (next-single-property-change (point) 'org-hd-marker)))
  9695. (org-agenda-bulk-toggle))))
  9696. (defun org-agenda-bulk-toggle ()
  9697. "Toggle the mark at point for bulk action."
  9698. (interactive)
  9699. (if (org-agenda-bulk-marked-p)
  9700. (org-agenda-bulk-unmark)
  9701. (org-agenda-bulk-mark)))
  9702. (defun org-agenda-bulk-remove-overlays (&optional beg end)
  9703. "Remove the mark overlays between BEG and END in the agenda buffer.
  9704. BEG and END default to the buffer limits.
  9705. This only removes the overlays, it does not remove the markers
  9706. from the list in `org-agenda-bulk-marked-entries'."
  9707. (interactive)
  9708. (mapc (lambda (ov)
  9709. (and (eq (overlay-get ov 'type) 'org-marked-entry-overlay)
  9710. (delete-overlay ov)))
  9711. (overlays-in (or beg (point-min)) (or end (point-max)))))
  9712. (defun org-agenda-bulk-unmark-all ()
  9713. "Remove all marks in the agenda buffer.
  9714. This will remove the markers and the overlays."
  9715. (interactive)
  9716. (if (null org-agenda-bulk-marked-entries)
  9717. (message "No entry to unmark")
  9718. (setq org-agenda-bulk-marked-entries nil)
  9719. (org-agenda-bulk-remove-overlays (point-min) (point-max))))
  9720. (defcustom org-agenda-persistent-marks nil
  9721. "Non-nil means marked items will stay marked after a bulk action.
  9722. You can toggle this interactively by typing `p' when prompted for a
  9723. bulk action."
  9724. :group 'org-agenda
  9725. :version "24.1"
  9726. :type 'boolean)
  9727. (defcustom org-agenda-loop-over-headlines-in-active-region t
  9728. "Shall some commands act upon headlines in the active region?
  9729. When set to t, some commands will be performed in all headlines
  9730. within the active region.
  9731. When set to `start-level', some commands will be performed in all
  9732. headlines within the active region, provided that these headlines
  9733. are of the same level than the first one.
  9734. When set to a regular expression, those commands will be
  9735. performed on the matching headlines within the active region.
  9736. The list of commands is: `org-agenda-schedule',
  9737. `org-agenda-deadline', `org-agenda-date-prompt',
  9738. `org-agenda-todo', `org-agenda-archive*', `org-agenda-kill'.
  9739. See `org-loop-over-headlines-in-active-region' for the equivalent
  9740. option for Org buffers."
  9741. :type '(choice (const :tag "Don't loop" nil)
  9742. (const :tag "All headlines in active region" t)
  9743. (const :tag "In active region, headlines at the same level than the first one" start-level)
  9744. (regexp :tag "Regular expression matcher"))
  9745. :version "27.1"
  9746. :package-version '(Org . "9.4")
  9747. :group 'org-agenda)
  9748. (defun org-agenda-bulk-action (&optional arg)
  9749. "Execute an remote-editing action on all marked entries.
  9750. The prefix arg is passed through to the command if possible."
  9751. (interactive "P")
  9752. ;; When there is no mark, act on the agenda entry at point.
  9753. (if (not org-agenda-bulk-marked-entries)
  9754. (save-excursion (org-agenda-bulk-mark)))
  9755. (dolist (m org-agenda-bulk-marked-entries)
  9756. (unless (and (markerp m)
  9757. (marker-buffer m)
  9758. (buffer-live-p (marker-buffer m))
  9759. (marker-position m))
  9760. (user-error "Marker %s for bulk command is invalid" m)))
  9761. ;; Prompt for the bulk command.
  9762. (org-unlogged-message
  9763. (concat "Bulk (" (if org-agenda-persistent-marks "" "don't ") "[p]ersist marks): "
  9764. "[$]arch [A]rch->sib [t]odo [+/-]tag [s]chd [d]eadline [r]efile "
  9765. "[S]catter [f]unction "
  9766. (and org-agenda-bulk-custom-functions
  9767. (format " Custom: [%s]"
  9768. (mapconcat (lambda (f) (char-to-string (car f)))
  9769. org-agenda-bulk-custom-functions
  9770. "")))))
  9771. (catch 'exit
  9772. (let* ((org-log-refile (if org-log-refile 'time nil))
  9773. (entries (reverse org-agenda-bulk-marked-entries))
  9774. (org-overriding-default-time
  9775. (and (get-text-property (point) 'org-agenda-date-header)
  9776. (org-get-cursor-date)))
  9777. redo-at-end
  9778. cmd)
  9779. (pcase (read-char-exclusive)
  9780. (?p
  9781. (let ((org-agenda-persistent-marks
  9782. (not org-agenda-persistent-marks)))
  9783. (org-agenda-bulk-action)
  9784. (throw 'exit nil)))
  9785. (?$
  9786. (setq cmd #'org-agenda-archive))
  9787. (?A
  9788. (setq cmd #'org-agenda-archive-to-archive-sibling))
  9789. ((or ?r ?w)
  9790. (let ((refile-location
  9791. (org-refile-get-location
  9792. "Refile to"
  9793. (marker-buffer (car entries))
  9794. org-refile-allow-creating-parent-nodes)))
  9795. (when (nth 3 refile-location)
  9796. (setcar (nthcdr 3 refile-location)
  9797. (move-marker
  9798. (make-marker)
  9799. (nth 3 refile-location)
  9800. (or (get-file-buffer (nth 1 refile-location))
  9801. (find-buffer-visiting (nth 1 refile-location))
  9802. (error "This should not happen")))))
  9803. (setq cmd (lambda () (org-agenda-refile nil refile-location t)))
  9804. (setq redo-at-end t)))
  9805. (?t
  9806. (let ((state (completing-read
  9807. "Todo state: "
  9808. (with-current-buffer (marker-buffer (car entries))
  9809. (mapcar #'list org-todo-keywords-1)))))
  9810. (setq cmd (lambda ()
  9811. (let ((org-inhibit-blocking t)
  9812. (org-inhibit-logging 'note))
  9813. (org-agenda-todo state))))))
  9814. ((and (or ?- ?+) action)
  9815. (let ((tag (completing-read
  9816. (format "Tag to %s: " (if (eq action ?+) "add" "remove"))
  9817. (with-current-buffer (marker-buffer (car entries))
  9818. (delq nil
  9819. (mapcar (lambda (x) (and (stringp (car x)) x))
  9820. org-current-tag-alist))))))
  9821. (setq cmd
  9822. (lambda ()
  9823. (org-agenda-set-tags tag
  9824. (if (eq action ?+) 'on 'off))))))
  9825. ((and (or ?s ?d) c)
  9826. (let* ((schedule? (eq c ?s))
  9827. (prompt (if schedule? "(Re)Schedule to" "(Re)Set Deadline to"))
  9828. (time
  9829. (and (not arg)
  9830. (let ((new (org-read-date
  9831. nil nil nil prompt org-overriding-default-time)))
  9832. ;; A "double plus" answer applies to every
  9833. ;; scheduled time. Do not turn it into
  9834. ;; a fixed date yet.
  9835. (if (string-match-p "\\`[ \t]*\\+\\+"
  9836. org-read-date-final-answer)
  9837. org-read-date-final-answer
  9838. new)))))
  9839. ;; Make sure to not prompt for a note when bulk
  9840. ;; rescheduling/resetting deadline as Org cannot cope with
  9841. ;; simultaneous notes. Besides, it could be annoying
  9842. ;; depending on the number of marked items.
  9843. (setq cmd
  9844. (if schedule?
  9845. (lambda ()
  9846. (let ((org-log-reschedule
  9847. (and org-log-reschedule 'time)))
  9848. (org-agenda-schedule arg time)))
  9849. (lambda ()
  9850. (let ((org-log-redeadline (and org-log-redeadline 'time)))
  9851. (org-agenda-deadline arg time)))))))
  9852. (?S
  9853. (unless (org-agenda-check-type nil 'agenda 'todo)
  9854. (user-error "Can't scatter tasks in \"%s\" agenda view" org-agenda-type))
  9855. (let ((days (read-number
  9856. (format "Scatter tasks across how many %sdays: "
  9857. (if arg "week" ""))
  9858. 7)))
  9859. (setq cmd
  9860. (lambda ()
  9861. (let ((distance (1+ (random days))))
  9862. (when arg
  9863. (let ((dist distance)
  9864. (day-of-week
  9865. (calendar-day-of-week
  9866. (calendar-gregorian-from-absolute (org-today)))))
  9867. (dotimes (_ (1+ dist))
  9868. (while (member day-of-week org-agenda-weekend-days)
  9869. (cl-incf distance)
  9870. (cl-incf day-of-week)
  9871. (when (= day-of-week 7)
  9872. (setq day-of-week 0)))
  9873. (cl-incf day-of-week)
  9874. (when (= day-of-week 7)
  9875. (setq day-of-week 0)))))
  9876. ;; Silently fail when try to replan a sexp entry.
  9877. (ignore-errors
  9878. (let* ((date (calendar-gregorian-from-absolute
  9879. (+ (org-today) distance)))
  9880. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date)
  9881. (nth 2 date))))
  9882. (org-agenda-schedule nil time))))))))
  9883. (?f
  9884. (setq cmd
  9885. (intern
  9886. (completing-read "Function: " obarray #'fboundp t nil nil))))
  9887. (action
  9888. (setq cmd
  9889. (pcase (assoc action org-agenda-bulk-custom-functions)
  9890. (`(,_ ,fn)
  9891. fn)
  9892. (`(,_ ,fn ,arg-fn)
  9893. (apply #'apply-partially fn (funcall arg-fn)))
  9894. (_
  9895. (user-error "Invalid bulk action: %c" action))))
  9896. (setq redo-at-end t)))
  9897. ;; Sort the markers, to make sure that parents are handled
  9898. ;; before children.
  9899. (setq entries (sort entries
  9900. (lambda (a b)
  9901. (cond
  9902. ((eq (marker-buffer a) (marker-buffer b))
  9903. (< (marker-position a) (marker-position b)))
  9904. (t
  9905. (string< (buffer-name (marker-buffer a))
  9906. (buffer-name (marker-buffer b))))))))
  9907. ;; Now loop over all markers and apply CMD.
  9908. (let ((processed 0)
  9909. (skipped 0))
  9910. (dolist (e entries)
  9911. (let ((pos (text-property-any (point-min) (point-max) 'org-hd-marker e)))
  9912. (if (not pos)
  9913. (progn (message "Skipping removed entry at %s" e)
  9914. (cl-incf skipped))
  9915. (goto-char pos)
  9916. (let (org-loop-over-headlines-in-active-region) (funcall cmd))
  9917. ;; `post-command-hook' is not run yet. We make sure any
  9918. ;; pending log note is processed.
  9919. (when org-log-setup (org-add-log-note))
  9920. (cl-incf processed))))
  9921. (when redo-at-end (org-agenda-redo))
  9922. (unless org-agenda-persistent-marks (org-agenda-bulk-unmark-all))
  9923. (message "Acted on %d entries%s%s"
  9924. processed
  9925. (if (= skipped 0)
  9926. ""
  9927. (format ", skipped %d (disappeared before their turn)"
  9928. skipped))
  9929. (if (not org-agenda-persistent-marks) "" " (kept marked)"))))))
  9930. (defun org-agenda-capture (&optional with-time)
  9931. "Call `org-capture' with the date at point.
  9932. With a `C-1' prefix, use the HH:MM value at point (if any) or the
  9933. current HH:MM time."
  9934. (interactive "P")
  9935. (if (not (eq major-mode 'org-agenda-mode))
  9936. (user-error "You cannot do this outside of agenda buffers")
  9937. (let ((org-overriding-default-time
  9938. (org-get-cursor-date (equal with-time 1))))
  9939. (call-interactively 'org-capture))))
  9940. ;;; Dragging agenda lines forward/backward
  9941. (defun org-agenda-reapply-filters ()
  9942. "Re-apply all agenda filters."
  9943. (mapcar
  9944. (lambda(f) (when (car f) (org-agenda-filter-apply (car f) (cadr f) t)))
  9945. `((,org-agenda-tag-filter tag)
  9946. (,org-agenda-category-filter category)
  9947. (,org-agenda-regexp-filter regexp)
  9948. (,org-agenda-effort-filter effort)
  9949. (,(get 'org-agenda-tag-filter :preset-filter) tag)
  9950. (,(get 'org-agenda-category-filter :preset-filter) category)
  9951. (,(get 'org-agenda-effort-filter :preset-filter) effort)
  9952. (,(get 'org-agenda-regexp-filter :preset-filter) regexp))))
  9953. (defun org-agenda-drag-line-forward (arg &optional backward)
  9954. "Drag an agenda line forward by ARG lines.
  9955. When the optional argument `backward' is non-nil, move backward."
  9956. (interactive "p")
  9957. (let ((inhibit-read-only t) lst line)
  9958. (if (or (not (get-text-property (point) 'txt))
  9959. (save-excursion
  9960. (dotimes (_ arg)
  9961. (move-beginning-of-line (if backward 0 2))
  9962. (push (not (get-text-property (point) 'txt)) lst))
  9963. (delq nil lst)))
  9964. (message "Cannot move line forward")
  9965. (let ((end (save-excursion (move-beginning-of-line 2) (point))))
  9966. (move-beginning-of-line 1)
  9967. (setq line (buffer-substring (point) end))
  9968. (delete-region (point) end)
  9969. (move-beginning-of-line (funcall (if backward '1- '1+) arg))
  9970. (insert line)
  9971. (org-agenda-reapply-filters)
  9972. (org-agenda-mark-clocking-task)
  9973. (move-beginning-of-line 0)))))
  9974. (defun org-agenda-drag-line-backward (arg)
  9975. "Drag an agenda line backward by ARG lines."
  9976. (interactive "p")
  9977. (org-agenda-drag-line-forward arg t))
  9978. ;;; Flagging notes
  9979. (defun org-agenda-show-the-flagging-note ()
  9980. "Display the flagging note in the other window.
  9981. When called a second time in direct sequence, offer to remove the FLAGGING
  9982. tag and (if present) the flagging note."
  9983. (interactive)
  9984. (let ((hdmarker (org-get-at-bol 'org-hd-marker))
  9985. (win (selected-window))
  9986. note) ;; heading newhead
  9987. (unless hdmarker
  9988. (user-error "No linked entry at point"))
  9989. (if (and (eq this-command last-command)
  9990. (y-or-n-p "Unflag and remove any flagging note? "))
  9991. (progn
  9992. (org-agenda-remove-flag hdmarker)
  9993. (let ((win (get-buffer-window "*Flagging Note*")))
  9994. (and win (delete-window win)))
  9995. (message "Entry unflagged"))
  9996. (setq note (org-entry-get hdmarker "THEFLAGGINGNOTE"))
  9997. (unless note
  9998. (user-error "No flagging note"))
  9999. (org-kill-new note)
  10000. (org-switch-to-buffer-other-window "*Flagging Note*")
  10001. (erase-buffer)
  10002. (insert note)
  10003. (goto-char (point-min))
  10004. (while (re-search-forward "\\\\n" nil t)
  10005. (replace-match "\n" t t))
  10006. (goto-char (point-min))
  10007. (select-window win)
  10008. (message "%s" (substitute-command-keys "Flagging note pushed to \
  10009. kill ring. Press `\\[org-agenda-show-the-flagging-note]' again to remove \
  10010. tag and note")))))
  10011. (defun org-agenda-remove-flag (marker)
  10012. "Remove the FLAGGED tag and any flagging note in the entry."
  10013. (let ((newhead
  10014. (org-with-point-at marker
  10015. (org-toggle-tag "FLAGGED" 'off)
  10016. (org-entry-delete nil "THEFLAGGINGNOTE")
  10017. (org-get-heading))))
  10018. (org-agenda-change-all-lines newhead marker)
  10019. (message "Entry unflagged")))
  10020. (defun org-agenda-get-any-marker (&optional pos)
  10021. (or (get-text-property (or pos (point-at-bol)) 'org-hd-marker)
  10022. (get-text-property (or pos (point-at-bol)) 'org-marker)))
  10023. ;;; Appointment reminders
  10024. (defvar appt-time-msg-list) ; defined in appt.el
  10025. ;;;###autoload
  10026. (defun org-agenda-to-appt (&optional refresh filter &rest args)
  10027. "Activate appointments found in `org-agenda-files'.
  10028. With a `\\[universal-argument]' prefix, refresh the list of \
  10029. appointments.
  10030. If FILTER is t, interactively prompt the user for a regular
  10031. expression, and filter out entries that don't match it.
  10032. If FILTER is a string, use this string as a regular expression
  10033. for filtering entries out.
  10034. If FILTER is a function, filter out entries against which
  10035. calling the function returns nil. This function takes one
  10036. argument: an entry from `org-agenda-get-day-entries'.
  10037. FILTER can also be an alist with the car of each cell being
  10038. either `headline' or `category'. For example:
  10039. \\='((headline \"IMPORTANT\")
  10040. (category \"Work\"))
  10041. will only add headlines containing IMPORTANT or headlines
  10042. belonging to the \"Work\" category.
  10043. ARGS are symbols indicating what kind of entries to consider.
  10044. By default `org-agenda-to-appt' will use :deadline*, :scheduled*
  10045. \(i.e., deadlines and scheduled items with a hh:mm specification)
  10046. and :timestamp entries. See the docstring of `org-diary' for
  10047. details and examples.
  10048. If an entry has a APPT_WARNTIME property, its value will be used
  10049. to override `appt-message-warning-time'."
  10050. (interactive "P")
  10051. (when refresh (setq appt-time-msg-list nil))
  10052. (when (eq filter t)
  10053. (setq filter (read-from-minibuffer "Regexp filter: ")))
  10054. (let* ((cnt 0) ; count added events
  10055. (scope (or args '(:deadline* :scheduled* :timestamp)))
  10056. (org-agenda-new-buffers nil)
  10057. (org-deadline-warning-days 0)
  10058. ;; Do not use `org-today' here because appt only takes
  10059. ;; time and without date as argument, so it may pass wrong
  10060. ;; information otherwise
  10061. (today (org-date-to-gregorian
  10062. (time-to-days nil)))
  10063. (org-agenda-restrict nil)
  10064. (files (org-agenda-files 'unrestricted)) entries file
  10065. (org-agenda-buffer nil))
  10066. ;; Get all entries which may contain an appt
  10067. (org-agenda-prepare-buffers files)
  10068. (while (setq file (pop files))
  10069. (setq entries
  10070. (delq nil
  10071. (append entries
  10072. (apply #'org-agenda-get-day-entries
  10073. file today scope)))))
  10074. ;; Map through entries and find if we should filter them out
  10075. (mapc
  10076. (lambda (x)
  10077. (let* ((evt (org-trim
  10078. (replace-regexp-in-string
  10079. org-link-bracket-re "\\2"
  10080. (or (get-text-property 1 'txt x) ""))))
  10081. (cat (get-text-property (1- (length x)) 'org-category x))
  10082. (tod (get-text-property 1 'time-of-day x))
  10083. (ok (or (null filter)
  10084. (and (stringp filter) (string-match filter evt))
  10085. (and (functionp filter) (funcall filter x))
  10086. (and (listp filter)
  10087. (let ((cat-filter (cadr (assq 'category filter)))
  10088. (evt-filter (cadr (assq 'headline filter))))
  10089. (or (and (stringp cat-filter)
  10090. (string-match cat-filter cat))
  10091. (and (stringp evt-filter)
  10092. (string-match evt-filter evt)))))))
  10093. (wrn (get-text-property 1 'warntime x)))
  10094. ;; FIXME: Shall we remove text-properties for the appt text?
  10095. ;; (setq evt (set-text-properties 0 (length evt) nil evt))
  10096. (when (and ok tod (not (string-match "\\`DONE\\|CANCELLED" evt)))
  10097. (setq tod (concat "00" (number-to-string tod)))
  10098. (setq tod (when (string-match
  10099. "\\([0-9]\\{1,2\\}\\)\\([0-9]\\{2\\}\\)\\'" tod)
  10100. (concat (match-string 1 tod) ":"
  10101. (match-string 2 tod))))
  10102. (when (appt-add tod evt wrn)
  10103. (setq cnt (1+ cnt))))))
  10104. entries)
  10105. (org-release-buffers org-agenda-new-buffers)
  10106. (if (eq cnt 0)
  10107. (message "No event to add")
  10108. (message "Added %d event%s for today" cnt (if (> cnt 1) "s" "")))))
  10109. (defun org-agenda-today-p (date)
  10110. "Non-nil when DATE means today.
  10111. DATE is either a list of the form (month day year) or a number of
  10112. days as returned by `calendar-absolute-from-gregorian' or
  10113. `org-today'. This function considers `org-extend-today-until'
  10114. when defining today."
  10115. (eq (org-today)
  10116. (if (consp date) (calendar-absolute-from-gregorian date) date)))
  10117. (defun org-agenda-todo-yesterday (&optional arg)
  10118. "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday."
  10119. (interactive "P")
  10120. (let* ((org-use-effective-time t)
  10121. (hour (nth 2 (decode-time (org-current-time))))
  10122. (org-extend-today-until (1+ hour)))
  10123. (org-agenda-todo arg)))
  10124. (defun org-agenda-ctrl-c-ctrl-c ()
  10125. "Set tags in agenda buffer."
  10126. (interactive)
  10127. (org-agenda-set-tags))
  10128. (provide 'org-agenda)
  10129. ;;; org-agenda.el ends here