org-agenda.el 394 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180
  1. ;;; org-agenda.el --- Dynamic task and appointment lists for Org
  2. ;; Copyright (C) 2004-2016 Free Software Foundation, Inc.
  3. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; Homepage: http://orgmode.org
  6. ;;
  7. ;; This file is part of GNU Emacs.
  8. ;;
  9. ;; GNU Emacs is free software: you can redistribute it and/or modify
  10. ;; it under the terms of the GNU General Public License as published by
  11. ;; the Free Software Foundation, either version 3 of the License, or
  12. ;; (at your option) any later version.
  13. ;; GNU Emacs is distributed in the hope that it will be useful,
  14. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. ;; GNU General Public License for more details.
  17. ;; You should have received a copy of the GNU General Public License
  18. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  19. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  20. ;;
  21. ;;; Commentary:
  22. ;; This file contains the code for creating and using the Agenda for Org-mode.
  23. ;;
  24. ;; The functions `org-batch-agenda', `org-batch-agenda-csv', and
  25. ;; `org-batch-store-agenda-views' are implemented as macros to provide
  26. ;; a convenient way for extracting agenda information from the command
  27. ;; line. The Lisp does not evaluate parameters of a macro call; thus
  28. ;; it is not necessary to quote the parameters passed to one of those
  29. ;; functions. E.g. you can write:
  30. ;;
  31. ;; emacs -batch -l ~/.emacs -eval '(org-batch-agenda "a" org-agenda-span 7)'
  32. ;;
  33. ;; To export an agenda spanning 7 days. If `org-batch-agenda' would
  34. ;; have been implemented as a regular function you'd have to quote the
  35. ;; symbol org-agenda-span. Moreover: To use a symbol as parameter
  36. ;; value you would have to double quote the symbol.
  37. ;;
  38. ;; This is a hack, but it works even when running Org byte-compiled.
  39. ;;
  40. ;;; Code:
  41. (require 'org)
  42. (require 'org-macs)
  43. (eval-when-compile
  44. (require 'cl))
  45. (declare-function diary-add-to-list "diary-lib"
  46. (date string specifier &optional marker globcolor literal))
  47. (declare-function calendar-iso-to-absolute "cal-iso" (date))
  48. (declare-function calendar-astro-date-string "cal-julian" (&optional date))
  49. (declare-function calendar-bahai-date-string "cal-bahai" (&optional date))
  50. (declare-function calendar-chinese-date-string "cal-china" (&optional date))
  51. (declare-function calendar-coptic-date-string "cal-coptic" (&optional date))
  52. (declare-function calendar-ethiopic-date-string "cal-coptic" (&optional date))
  53. (declare-function calendar-french-date-string "cal-french" (&optional date))
  54. (declare-function calendar-goto-date "cal-move" (date))
  55. (declare-function calendar-hebrew-date-string "cal-hebrew" (&optional date))
  56. (declare-function calendar-islamic-date-string "cal-islam" (&optional date))
  57. (declare-function calendar-iso-date-string "cal-iso" (&optional date))
  58. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  59. (declare-function calendar-julian-date-string "cal-julian" (&optional date))
  60. (declare-function calendar-mayan-date-string "cal-mayan" (&optional date))
  61. (declare-function calendar-persian-date-string "cal-persia" (&optional date))
  62. (declare-function calendar-check-holidays "holidays" (date))
  63. (declare-function org-columns-remove-overlays "org-colview" ())
  64. (declare-function org-datetree-find-date-create "org-datetree"
  65. (date &optional keep-restriction))
  66. (declare-function org-columns-quit "org-colview" ())
  67. (declare-function diary-date-display-form "diary-lib" (&optional type))
  68. (declare-function org-mobile-write-agenda-for-mobile "org-mobile" (file))
  69. (declare-function org-habit-insert-consistency-graphs
  70. "org-habit" (&optional line))
  71. (declare-function org-is-habit-p "org-habit" (&optional pom))
  72. (declare-function org-habit-parse-todo "org-habit" (&optional pom))
  73. (declare-function org-habit-get-priority "org-habit" (habit &optional moment))
  74. (declare-function org-agenda-columns "org-colview" ())
  75. (declare-function org-add-archive-files "org-archive" (files))
  76. (declare-function org-capture "org-capture" (&optional goto keys))
  77. (defvar calendar-mode-map)
  78. (defvar org-clock-current-task)
  79. (defvar org-current-tag-alist)
  80. (defvar org-mobile-force-id-on-agenda-items)
  81. (defvar org-habit-show-habits)
  82. (defvar org-habit-show-habits-only-for-today)
  83. (defvar org-habit-show-all-today)
  84. ;; Defined somewhere in this file, but used before definition.
  85. (defvar org-agenda-buffer-name "*Org Agenda*")
  86. (defvar org-agenda-overriding-header nil)
  87. (defvar org-agenda-title-append nil)
  88. (with-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  89. (with-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  90. (defvar original-date) ; dynamically scoped, calendar.el does scope this
  91. (defvar org-agenda-undo-list nil
  92. "List of undoable operations in the agenda since last refresh.")
  93. (defvar org-agenda-pending-undo-list nil
  94. "In a series of undo commands, this is the list of remaining undo items.")
  95. (defcustom org-agenda-confirm-kill 1
  96. "When set, remote killing from the agenda buffer needs confirmation.
  97. When t, a confirmation is always needed. When a number N, confirmation is
  98. only needed when the text to be killed contains more than N non-white lines."
  99. :group 'org-agenda
  100. :type '(choice
  101. (const :tag "Never" nil)
  102. (const :tag "Always" t)
  103. (integer :tag "When more than N lines")))
  104. (defcustom org-agenda-compact-blocks nil
  105. "Non-nil means make the block agenda more compact.
  106. This is done globally by leaving out lines like the agenda span
  107. name and week number or the separator lines."
  108. :group 'org-agenda
  109. :type 'boolean)
  110. (defcustom org-agenda-block-separator ?=
  111. "The separator between blocks in the agenda.
  112. If this is a string, it will be used as the separator, with a newline added.
  113. If it is a character, it will be repeated to fill the window width.
  114. If nil the separator is disabled. In `org-agenda-custom-commands' this
  115. addresses the separator between the current and the previous block."
  116. :group 'org-agenda
  117. :type '(choice
  118. (const :tag "Disabled" nil)
  119. (character)
  120. (string)))
  121. (defgroup org-agenda-export nil
  122. "Options concerning exporting agenda views in Org-mode."
  123. :tag "Org Agenda Export"
  124. :group 'org-agenda)
  125. (defcustom org-agenda-with-colors t
  126. "Non-nil means use colors in agenda views."
  127. :group 'org-agenda-export
  128. :type 'boolean)
  129. (defcustom org-agenda-exporter-settings nil
  130. "Alist of variable/value pairs that should be active during agenda export.
  131. This is a good place to set options for ps-print and for htmlize.
  132. Note that the way this is implemented, the values will be evaluated
  133. before assigned to the variables. So make sure to quote values you do
  134. *not* want evaluated, for example
  135. (setq org-agenda-exporter-settings
  136. \\='((ps-print-color-p \\='black-white)))"
  137. :group 'org-agenda-export
  138. :type '(repeat
  139. (list
  140. (variable)
  141. (sexp :tag "Value"))))
  142. (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
  143. "Hook run in a temporary buffer before writing the agenda to an export file.
  144. A useful function for this hook is `org-agenda-add-entry-text'."
  145. :group 'org-agenda-export
  146. :type 'hook
  147. :options '(org-agenda-add-entry-text))
  148. (defcustom org-agenda-add-entry-text-maxlines 0
  149. "Maximum number of entry text lines to be added to agenda.
  150. This is only relevant when `org-agenda-add-entry-text' is part of
  151. `org-agenda-before-write-hook', which is the default.
  152. When this is 0, nothing will happen. When it is greater than 0, it
  153. specifies the maximum number of lines that will be added for each entry
  154. that is listed in the agenda view.
  155. Note that this variable is not used during display, only when exporting
  156. the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
  157. and `org-agenda-entry-text-maxlines'."
  158. :group 'org-agenda
  159. :type 'integer)
  160. (defcustom org-agenda-add-entry-text-descriptive-links t
  161. "Non-nil means export org-links as descriptive links in agenda added text.
  162. This variable applies to the text added to the agenda when
  163. `org-agenda-add-entry-text-maxlines' is larger than 0.
  164. When this variable nil, the URL will (also) be shown."
  165. :group 'org-agenda
  166. :type 'boolean)
  167. (defcustom org-agenda-export-html-style nil
  168. "The style specification for exported HTML Agenda files.
  169. If this variable contains a string, it will replace the default <style>
  170. section as produced by `htmlize'.
  171. Since there are different ways of setting style information, this variable
  172. needs to contain the full HTML structure to provide a style, including the
  173. surrounding HTML tags. The style specifications should include definitions
  174. the fonts used by the agenda, here is an example:
  175. <style type=\"text/css\">
  176. p { font-weight: normal; color: gray; }
  177. .org-agenda-structure {
  178. font-size: 110%;
  179. color: #003399;
  180. font-weight: 600;
  181. }
  182. .org-todo {
  183. color: #cc6666;
  184. font-weight: bold;
  185. }
  186. .org-agenda-done {
  187. color: #339933;
  188. }
  189. .org-done {
  190. color: #339933;
  191. }
  192. .title { text-align: center; }
  193. .todo, .deadline { color: red; }
  194. .done { color: green; }
  195. </style>
  196. or, if you want to keep the style in a file,
  197. <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
  198. As the value of this option simply gets inserted into the HTML <head> header,
  199. you can \"misuse\" it to also add other text to the header."
  200. :group 'org-agenda-export
  201. :group 'org-export-html
  202. :type '(choice
  203. (const nil)
  204. (string)))
  205. (defcustom org-agenda-persistent-filter nil
  206. "When set, keep filters from one agenda view to the next."
  207. :group 'org-agenda
  208. :type 'boolean)
  209. (defgroup org-agenda-custom-commands nil
  210. "Options concerning agenda views in Org-mode."
  211. :tag "Org Agenda Custom Commands"
  212. :group 'org-agenda)
  213. (defconst org-sorting-choice
  214. '(choice
  215. (const time-up) (const time-down)
  216. (const timestamp-up) (const timestamp-down)
  217. (const scheduled-up) (const scheduled-down)
  218. (const deadline-up) (const deadline-down)
  219. (const ts-up) (const ts-down)
  220. (const tsia-up) (const tsia-down)
  221. (const category-keep) (const category-up) (const category-down)
  222. (const tag-down) (const tag-up)
  223. (const priority-up) (const priority-down)
  224. (const todo-state-up) (const todo-state-down)
  225. (const effort-up) (const effort-down)
  226. (const habit-up) (const habit-down)
  227. (const alpha-up) (const alpha-down)
  228. (const user-defined-up) (const user-defined-down))
  229. "Sorting choices.")
  230. ;; Keep custom values for `org-agenda-filter-preset' compatible with
  231. ;; the new variable `org-agenda-tag-filter-preset'.
  232. (defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
  233. (defvaralias 'org-agenda-filter 'org-agenda-tag-filter)
  234. (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
  235. "List of types searched for when creating the daily/weekly agenda.
  236. This variable is a list of symbols that controls the types of
  237. items that appear in the daily/weekly agenda. Allowed symbols in this
  238. list are are
  239. :timestamp List items containing a date stamp or date range matching
  240. the selected date. This includes sexp entries in angular
  241. brackets.
  242. :sexp List entries resulting from plain diary-like sexps.
  243. :deadline List deadline due on that date. When the date is today,
  244. also list any deadlines past due, or due within
  245. `org-deadline-warning-days'. `:deadline' must appear before
  246. `:scheduled' if the setting of
  247. `org-agenda-skip-scheduled-if-deadline-is-shown' is to have
  248. any effect.
  249. :deadline* Same as above, but only include the deadline if it has an
  250. hour specification as [h]h:mm.
  251. :scheduled List all items which are scheduled for the given date.
  252. The diary for *today* also contains items which were
  253. scheduled earlier and are not yet marked DONE.
  254. :scheduled* Same as above, but only include the scheduled item if it
  255. has an hour specification as [h]h:mm.
  256. By default, all four non-starred types are turned on.
  257. When :scheduled* or :deadline* are included, :schedule or :deadline
  258. will be ignored.
  259. Never set this variable globally using `setq', because then it
  260. will apply to all future agenda commands. Instead, bind it with
  261. `let' to scope it dynamically into the agenda-constructing
  262. command. A good way to set it is through options in
  263. `org-agenda-custom-commands'. For a more flexible (though
  264. somewhat less efficient) way of determining what is included in
  265. the daily/weekly agenda, see `org-agenda-skip-function'.")
  266. (defconst org-agenda-custom-commands-local-options
  267. `(repeat :tag "Local settings for this command. Remember to quote values"
  268. (choice :tag "Setting"
  269. (list :tag "Heading for this block"
  270. (const org-agenda-overriding-header)
  271. (string :tag "Headline"))
  272. (list :tag "Files to be searched"
  273. (const org-agenda-files)
  274. (list
  275. (const :format "" quote)
  276. (repeat (file))))
  277. (list :tag "Sorting strategy"
  278. (const org-agenda-sorting-strategy)
  279. (list
  280. (const :format "" quote)
  281. (repeat
  282. ,org-sorting-choice)))
  283. (list :tag "Prefix format"
  284. (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
  285. (string))
  286. (list :tag "Number of days in agenda"
  287. (const org-agenda-span)
  288. (choice (const :tag "Day" day)
  289. (const :tag "Week" week)
  290. (const :tag "Fortnight" fortnight)
  291. (const :tag "Month" month)
  292. (const :tag "Year" year)
  293. (integer :tag "Custom")))
  294. (list :tag "Fixed starting date"
  295. (const org-agenda-start-day)
  296. (string :value "2007-11-01"))
  297. (list :tag "Start on day of week"
  298. (const org-agenda-start-on-weekday)
  299. (choice :value 1
  300. (const :tag "Today" nil)
  301. (integer :tag "Weekday No.")))
  302. (list :tag "Include data from diary"
  303. (const org-agenda-include-diary)
  304. (boolean))
  305. (list :tag "Deadline Warning days"
  306. (const org-deadline-warning-days)
  307. (integer :value 1))
  308. (list :tag "Category filter preset"
  309. (const org-agenda-category-filter-preset)
  310. (list
  311. (const :format "" quote)
  312. (repeat
  313. (string :tag "+category or -category"))))
  314. (list :tag "Tags filter preset"
  315. (const org-agenda-tag-filter-preset)
  316. (list
  317. (const :format "" quote)
  318. (repeat
  319. (string :tag "+tag or -tag"))))
  320. (list :tag "Effort filter preset"
  321. (const org-agenda-effort-filter-preset)
  322. (list
  323. (const :format "" quote)
  324. (repeat
  325. (string :tag "+=10 or -=10 or +<10 or ->10"))))
  326. (list :tag "Regexp filter preset"
  327. (const org-agenda-regexp-filter-preset)
  328. (list
  329. (const :format "" quote)
  330. (repeat
  331. (string :tag "+regexp or -regexp"))))
  332. (list :tag "Set daily/weekly entry types"
  333. (const org-agenda-entry-types)
  334. (list
  335. (const :format "" quote)
  336. (set :greedy t :value ,org-agenda-entry-types
  337. (const :deadline)
  338. (const :scheduled)
  339. (const :deadline*)
  340. (const :scheduled*)
  341. (const :timestamp)
  342. (const :sexp))))
  343. (list :tag "Standard skipping condition"
  344. :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
  345. (const org-agenda-skip-function)
  346. (list
  347. (const :format "" quote)
  348. (list
  349. (choice
  350. :tag "Skipping range"
  351. (const :tag "Skip entry" org-agenda-skip-entry-if)
  352. (const :tag "Skip subtree" org-agenda-skip-subtree-if))
  353. (repeat :inline t :tag "Conditions for skipping"
  354. (choice
  355. :tag "Condition type"
  356. (list :tag "Regexp matches" :inline t
  357. (const :format "" 'regexp)
  358. (regexp))
  359. (list :tag "Regexp does not match" :inline t
  360. (const :format "" 'notregexp)
  361. (regexp))
  362. (list :tag "TODO state is" :inline t
  363. (const 'todo)
  364. (choice
  365. (const :tag "Any not-done state" 'todo)
  366. (const :tag "Any done state" 'done)
  367. (const :tag "Any state" 'any)
  368. (list :tag "Keyword list"
  369. (const :format "" quote)
  370. (repeat (string :tag "Keyword")))))
  371. (list :tag "TODO state is not" :inline t
  372. (const 'nottodo)
  373. (choice
  374. (const :tag "Any not-done state" 'todo)
  375. (const :tag "Any done state" 'done)
  376. (const :tag "Any state" 'any)
  377. (list :tag "Keyword list"
  378. (const :format "" quote)
  379. (repeat (string :tag "Keyword")))))
  380. (const :tag "scheduled" 'scheduled)
  381. (const :tag "not scheduled" 'notscheduled)
  382. (const :tag "deadline" 'deadline)
  383. (const :tag "no deadline" 'notdeadline)
  384. (const :tag "timestamp" 'timestamp)
  385. (const :tag "no timestamp" 'nottimestamp))))))
  386. (list :tag "Non-standard skipping condition"
  387. :value (org-agenda-skip-function)
  388. (const org-agenda-skip-function)
  389. (sexp :tag "Function or form (quoted!)"))
  390. (list :tag "Any variable"
  391. (variable :tag "Variable")
  392. (sexp :tag "Value (sexp)"))))
  393. "Selection of examples for agenda command settings.
  394. This will be spliced into the custom type of
  395. `org-agenda-custom-commands'.")
  396. (defcustom org-agenda-custom-commands
  397. '(("n" "Agenda and all TODOs" ((agenda "") (alltodo ""))))
  398. "Custom commands for the agenda.
  399. These commands will be offered on the splash screen displayed by the
  400. agenda dispatcher \\[org-agenda]. Each entry is a list like this:
  401. (key desc type match settings files)
  402. key The key (one or more characters as a string) to be associated
  403. with the command.
  404. desc A description of the command, when omitted or nil, a default
  405. description is built using MATCH.
  406. type The command type, any of the following symbols:
  407. agenda The daily/weekly agenda.
  408. todo Entries with a specific TODO keyword, in all agenda files.
  409. search Entries containing search words entry or headline.
  410. tags Tags/Property/TODO match in all agenda files.
  411. tags-todo Tags/P/T match in all agenda files, TODO entries only.
  412. todo-tree Sparse tree of specific TODO keyword in *current* file.
  413. tags-tree Sparse tree with all tags matches in *current* file.
  414. occur-tree Occur sparse tree for *current* file.
  415. ... A user-defined function.
  416. match What to search for:
  417. - a single keyword for TODO keyword searches
  418. - a tags match expression for tags searches
  419. - a word search expression for text searches.
  420. - a regular expression for occur searches
  421. For all other commands, this should be the empty string.
  422. settings A list of option settings, similar to that in a let form, so like
  423. this: ((opt1 val1) (opt2 val2) ...). The values will be
  424. evaluated at the moment of execution, so quote them when needed.
  425. files A list of files file to write the produced agenda buffer to
  426. with the command `org-store-agenda-views'.
  427. If a file name ends in \".html\", an HTML version of the buffer
  428. is written out. If it ends in \".ps\", a postscript version is
  429. produced. Otherwise, only the plain text is written to the file.
  430. You can also define a set of commands, to create a composite agenda buffer.
  431. In this case, an entry looks like this:
  432. (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
  433. where
  434. desc A description string to be displayed in the dispatcher menu.
  435. cmd An agenda command, similar to the above. However, tree commands
  436. are not allowed, but instead you can get agenda and global todo list.
  437. So valid commands for a set are:
  438. (agenda \"\" settings)
  439. (alltodo \"\" settings)
  440. (stuck \"\" settings)
  441. (todo \"match\" settings files)
  442. (search \"match\" settings files)
  443. (tags \"match\" settings files)
  444. (tags-todo \"match\" settings files)
  445. Each command can carry a list of options, and another set of options can be
  446. given for the whole set of commands. Individual command options take
  447. precedence over the general options.
  448. When using several characters as key to a command, the first characters
  449. are prefix commands. For the dispatcher to display useful information, you
  450. should provide a description for the prefix, like
  451. (setq org-agenda-custom-commands
  452. \\='((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
  453. (\"hl\" tags \"+HOME+Lisa\")
  454. (\"hp\" tags \"+HOME+Peter\")
  455. (\"hk\" tags \"+HOME+Kim\")))"
  456. :group 'org-agenda-custom-commands
  457. :type `(repeat
  458. (choice :value ("x" "Describe command here" tags "" nil)
  459. (list :tag "Single command"
  460. (string :tag "Access Key(s) ")
  461. (option (string :tag "Description"))
  462. (choice
  463. (const :tag "Agenda" agenda)
  464. (const :tag "TODO list" alltodo)
  465. (const :tag "Search words" search)
  466. (const :tag "Stuck projects" stuck)
  467. (const :tag "Tags/Property match (all agenda files)" tags)
  468. (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
  469. (const :tag "TODO keyword search (all agenda files)" todo)
  470. (const :tag "Tags sparse tree (current buffer)" tags-tree)
  471. (const :tag "TODO keyword tree (current buffer)" todo-tree)
  472. (const :tag "Occur tree (current buffer)" occur-tree)
  473. (sexp :tag "Other, user-defined function"))
  474. (string :tag "Match (only for some commands)")
  475. ,org-agenda-custom-commands-local-options
  476. (option (repeat :tag "Export" (file :tag "Export to"))))
  477. (list :tag "Command series, all agenda files"
  478. (string :tag "Access Key(s)")
  479. (string :tag "Description ")
  480. (repeat :tag "Component"
  481. (choice
  482. (list :tag "Agenda"
  483. (const :format "" agenda)
  484. (const :tag "" :format "" "")
  485. ,org-agenda-custom-commands-local-options)
  486. (list :tag "TODO list (all keywords)"
  487. (const :format "" alltodo)
  488. (const :tag "" :format "" "")
  489. ,org-agenda-custom-commands-local-options)
  490. (list :tag "Search words"
  491. (const :format "" search)
  492. (string :tag "Match")
  493. ,org-agenda-custom-commands-local-options)
  494. (list :tag "Stuck projects"
  495. (const :format "" stuck)
  496. (const :tag "" :format "" "")
  497. ,org-agenda-custom-commands-local-options)
  498. (list :tag "Tags search"
  499. (const :format "" tags)
  500. (string :tag "Match")
  501. ,org-agenda-custom-commands-local-options)
  502. (list :tag "Tags search, TODO entries only"
  503. (const :format "" tags-todo)
  504. (string :tag "Match")
  505. ,org-agenda-custom-commands-local-options)
  506. (list :tag "TODO keyword search"
  507. (const :format "" todo)
  508. (string :tag "Match")
  509. ,org-agenda-custom-commands-local-options)
  510. (list :tag "Other, user-defined function"
  511. (symbol :tag "function")
  512. (string :tag "Match")
  513. ,org-agenda-custom-commands-local-options)))
  514. (repeat :tag "Settings for entire command set"
  515. (list (variable :tag "Any variable")
  516. (sexp :tag "Value")))
  517. (option (repeat :tag "Export" (file :tag "Export to"))))
  518. (cons :tag "Prefix key documentation"
  519. (string :tag "Access Key(s)")
  520. (string :tag "Description ")))))
  521. (defcustom org-agenda-query-register ?o
  522. "The register holding the current query string.
  523. The purpose of this is that if you construct a query string interactively,
  524. you can then use it to define a custom command."
  525. :group 'org-agenda-custom-commands
  526. :type 'character)
  527. (defcustom org-stuck-projects
  528. '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
  529. "How to identify stuck projects.
  530. This is a list of four items:
  531. 1. A tags/todo/property matcher string that is used to identify a project.
  532. See the manual for a description of tag and property searches.
  533. The entire tree below a headline matched by this is considered one project.
  534. 2. A list of TODO keywords identifying non-stuck projects.
  535. If the project subtree contains any headline with one of these todo
  536. keywords, the project is considered to be not stuck. If you specify
  537. \"*\" as a keyword, any TODO keyword will mark the project unstuck.
  538. 3. A list of tags identifying non-stuck projects.
  539. If the project subtree contains any headline with one of these tags,
  540. the project is considered to be not stuck. If you specify \"*\" as
  541. a tag, any tag will mark the project unstuck. Note that this is about
  542. the explicit presence of a tag somewhere in the subtree, inherited
  543. tags do not count here. If inherited tags make a project not stuck,
  544. use \"-TAG\" in the tags part of the matcher under (1.) above.
  545. 4. An arbitrary regular expression matching non-stuck projects.
  546. If the project turns out to be not stuck, search continues also in the
  547. subtree to see if any of the subtasks have project status.
  548. See also the variable `org-tags-match-list-sublevels' which applies
  549. to projects matched by this search as well.
  550. After defining this variable, you may use \\[org-agenda-list-stuck-projects]
  551. or `C-c a #' to produce the list."
  552. :group 'org-agenda-custom-commands
  553. :type '(list
  554. (string :tag "Tags/TODO match to identify a project")
  555. (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
  556. (repeat :tag "Projects are *not* stuck if they have an entry with TAG being any of" (string))
  557. (regexp :tag "Projects are *not* stuck if this regexp matches inside the subtree")))
  558. (defgroup org-agenda-skip nil
  559. "Options concerning skipping parts of agenda files."
  560. :tag "Org Agenda Skip"
  561. :group 'org-agenda)
  562. (defcustom org-agenda-skip-function-global nil
  563. "Function to be called at each match during agenda construction.
  564. If this function returns nil, the current match should not be skipped.
  565. If the function decided to skip an agenda match, is must return the
  566. buffer position from which the search should be continued.
  567. This may also be a Lisp form, which will be evaluated.
  568. This variable will be applied to every agenda match, including
  569. tags/property searches and TODO lists. So try to make the test function
  570. do its checking as efficiently as possible. To implement a skipping
  571. condition just for specific agenda commands, use the variable
  572. `org-agenda-skip-function' which can be set in the options section
  573. of custom agenda commands."
  574. :group 'org-agenda-skip
  575. :type 'sexp)
  576. (defgroup org-agenda-daily/weekly nil
  577. "Options concerning the daily/weekly agenda."
  578. :tag "Org Agenda Daily/Weekly"
  579. :group 'org-agenda)
  580. (defgroup org-agenda-todo-list nil
  581. "Options concerning the global todo list agenda view."
  582. :tag "Org Agenda Todo List"
  583. :group 'org-agenda)
  584. (defgroup org-agenda-match-view nil
  585. "Options concerning the general tags/property/todo match agenda view."
  586. :tag "Org Agenda Match View"
  587. :group 'org-agenda)
  588. (defgroup org-agenda-search-view nil
  589. "Options concerning the search agenda view."
  590. :tag "Org Agenda Search View"
  591. :group 'org-agenda)
  592. (defvar org-agenda-archives-mode nil
  593. "Non-nil means the agenda will include archived items.
  594. If this is the symbol `trees', trees in the selected agenda scope
  595. that are marked with the ARCHIVE tag will be included anyway. When this is
  596. t, also all archive files associated with the current selection of agenda
  597. files will be included.")
  598. (defcustom org-agenda-restriction-lock-highlight-subtree t
  599. "Non-nil means highlight the whole subtree when restriction is active.
  600. Otherwise only highlight the headline. Highlighting the whole subtree is
  601. useful to ensure no edits happen beyond the restricted region."
  602. :group 'org-agenda
  603. :type 'boolean)
  604. (defcustom org-agenda-skip-comment-trees t
  605. "Non-nil means skip trees that start with the COMMENT keyword.
  606. When nil, these trees are also scanned by agenda commands."
  607. :group 'org-agenda-skip
  608. :type 'boolean)
  609. (defcustom org-agenda-todo-list-sublevels t
  610. "Non-nil means check also the sublevels of a TODO entry for TODO entries.
  611. When nil, the sublevels of a TODO entry are not checked, resulting in
  612. potentially much shorter TODO lists."
  613. :group 'org-agenda-skip
  614. :group 'org-agenda-todo-list
  615. :type 'boolean)
  616. (defcustom org-agenda-todo-ignore-with-date nil
  617. "Non-nil means don't show entries with a date in the global todo list.
  618. You can use this if you prefer to mark mere appointments with a TODO keyword,
  619. but don't want them to show up in the TODO list.
  620. When this is set, it also covers deadlines and scheduled items, the settings
  621. of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
  622. will be ignored.
  623. See also the variable `org-agenda-tags-todo-honor-ignore-options'."
  624. :group 'org-agenda-skip
  625. :group 'org-agenda-todo-list
  626. :type 'boolean)
  627. (defcustom org-agenda-todo-ignore-timestamp nil
  628. "Non-nil means don't show entries with a timestamp.
  629. This applies when creating the global todo list.
  630. Valid values are:
  631. past Don't show entries for today or in the past.
  632. future Don't show entries with a timestamp in the future.
  633. The idea behind this is that if it has a future
  634. timestamp, you don't want to think about it until the
  635. date.
  636. all Don't show any entries with a timestamp in the global todo list.
  637. The idea behind this is that by setting a timestamp, you
  638. have already \"taken care\" of this item.
  639. This variable can also have an integer as a value. If positive (N),
  640. todos with a timestamp N or more days in the future will be ignored. If
  641. negative (-N), todos with a timestamp N or more days in the past will be
  642. ignored. If 0, todos with a timestamp either today or in the future will
  643. be ignored. For example, a value of -1 will exclude todos with a
  644. timestamp in the past (yesterday or earlier), while a value of 7 will
  645. exclude todos with a timestamp a week or more in the future.
  646. See also `org-agenda-todo-ignore-with-date'.
  647. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  648. to make his option also apply to the tags-todo list."
  649. :group 'org-agenda-skip
  650. :group 'org-agenda-todo-list
  651. :version "24.1"
  652. :type '(choice
  653. (const :tag "Ignore future timestamp todos" future)
  654. (const :tag "Ignore past or present timestamp todos" past)
  655. (const :tag "Ignore all timestamp todos" all)
  656. (const :tag "Show timestamp todos" nil)
  657. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  658. (defcustom org-agenda-todo-ignore-scheduled nil
  659. "Non-nil means, ignore some scheduled TODO items when making TODO list.
  660. This applies when creating the global todo list.
  661. Valid values are:
  662. past Don't show entries scheduled today or in the past.
  663. future Don't show entries scheduled in the future.
  664. The idea behind this is that by scheduling it, you don't want to
  665. think about it until the scheduled date.
  666. all Don't show any scheduled entries in the global todo list.
  667. The idea behind this is that by scheduling it, you have already
  668. \"taken care\" of this item.
  669. t Same as `all', for backward compatibility.
  670. This variable can also have an integer as a value. See
  671. `org-agenda-todo-ignore-timestamp' for more details.
  672. See also `org-agenda-todo-ignore-with-date'.
  673. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  674. to make his option also apply to the tags-todo list."
  675. :group 'org-agenda-skip
  676. :group 'org-agenda-todo-list
  677. :type '(choice
  678. (const :tag "Ignore future-scheduled todos" future)
  679. (const :tag "Ignore past- or present-scheduled todos" past)
  680. (const :tag "Ignore all scheduled todos" all)
  681. (const :tag "Ignore all scheduled todos (compatibility)" t)
  682. (const :tag "Show scheduled todos" nil)
  683. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  684. (defcustom org-agenda-todo-ignore-deadlines nil
  685. "Non-nil means ignore some deadline TODO items when making TODO list.
  686. There are different motivations for using different values, please think
  687. carefully when configuring this variable.
  688. This applies when creating the global todo list.
  689. Valid values are:
  690. near Don't show near deadline entries. A deadline is near when it is
  691. closer than `org-deadline-warning-days' days. The idea behind this
  692. is that such items will appear in the agenda anyway.
  693. far Don't show TODO entries where a deadline has been defined, but
  694. the deadline is not near. This is useful if you don't want to
  695. use the todo list to figure out what to do now.
  696. past Don't show entries with a deadline timestamp for today or in the past.
  697. future Don't show entries with a deadline timestamp in the future, not even
  698. when they become `near' ones. Use it with caution.
  699. all Ignore all TODO entries that do have a deadline.
  700. t Same as `near', for backward compatibility.
  701. This variable can also have an integer as a value. See
  702. `org-agenda-todo-ignore-timestamp' for more details.
  703. See also `org-agenda-todo-ignore-with-date'.
  704. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  705. to make his option also apply to the tags-todo list."
  706. :group 'org-agenda-skip
  707. :group 'org-agenda-todo-list
  708. :type '(choice
  709. (const :tag "Ignore near deadlines" near)
  710. (const :tag "Ignore near deadlines (compatibility)" t)
  711. (const :tag "Ignore far deadlines" far)
  712. (const :tag "Ignore all TODOs with a deadlines" all)
  713. (const :tag "Show all TODOs, even if they have a deadline" nil)
  714. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  715. (defcustom org-agenda-todo-ignore-time-comparison-use-seconds nil
  716. "Time unit to use when possibly ignoring an agenda item.
  717. See the docstring of various `org-agenda-todo-ignore-*' options.
  718. The default is to compare time stamps using days. An item is thus
  719. considered to be in the future if it is at least one day after today.
  720. Non-nil means to compare time stamps using seconds. An item is then
  721. considered future if it has a time value later than current time."
  722. :group 'org-agenda-skip
  723. :group 'org-agenda-todo-list
  724. :version "24.4"
  725. :package-version '(Org . "8.0")
  726. :type '(choice
  727. (const :tag "Compare time with days" nil)
  728. (const :tag "Compare time with seconds" t)))
  729. (defcustom org-agenda-tags-todo-honor-ignore-options nil
  730. "Non-nil means honor todo-list ignores options also in tags-todo search.
  731. The variables
  732. `org-agenda-todo-ignore-with-date',
  733. `org-agenda-todo-ignore-timestamp',
  734. `org-agenda-todo-ignore-scheduled',
  735. `org-agenda-todo-ignore-deadlines'
  736. make the global TODO list skip entries that have time stamps of certain
  737. kinds. If this option is set, the same options will also apply for the
  738. tags-todo search, which is the general tags/property matcher
  739. restricted to unfinished TODO entries only."
  740. :group 'org-agenda-skip
  741. :group 'org-agenda-todo-list
  742. :group 'org-agenda-match-view
  743. :type 'boolean)
  744. (defcustom org-agenda-skip-scheduled-if-done nil
  745. "Non-nil means don't show scheduled items in agenda when they are done.
  746. This is relevant for the daily/weekly agenda, not for the TODO list. And
  747. it applies only to the actual date of the scheduling. Warnings about
  748. an item with a past scheduling dates are always turned off when the item
  749. is DONE."
  750. :group 'org-agenda-skip
  751. :group 'org-agenda-daily/weekly
  752. :type 'boolean)
  753. (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
  754. "Non-nil means skip scheduling line if same entry shows because of deadline.
  755. In the agenda of today, an entry can show up multiple times
  756. because it is both scheduled and has a nearby deadline, and maybe
  757. a plain time stamp as well.
  758. When this variable is nil, the entry will be shown several times.
  759. When set to t, then only the deadline is shown and the fact that
  760. the entry is scheduled today or was scheduled previously is not
  761. shown.
  762. When set to the symbol `not-today', skip scheduled previously,
  763. but not scheduled today.
  764. When set to the symbol `repeated-after-deadline', skip scheduled
  765. items if they are repeated beyond the current deadline."
  766. :group 'org-agenda-skip
  767. :group 'org-agenda-daily/weekly
  768. :type '(choice
  769. (const :tag "Never" nil)
  770. (const :tag "Always" t)
  771. (const :tag "Not when scheduled today" not-today)
  772. (const :tag "When repeated past deadline" repeated-after-deadline)))
  773. (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
  774. "Non-nil means skip timestamp line if same entry shows because of deadline.
  775. In the agenda of today, an entry can show up multiple times
  776. because it has both a plain timestamp and has a nearby deadline.
  777. When this variable is t, then only the deadline is shown and the
  778. fact that the entry has a timestamp for or including today is not
  779. shown. When this variable is nil, the entry will be shown
  780. several times."
  781. :group 'org-agenda-skip
  782. :group 'org-agenda-daily/weekly
  783. :version "24.1"
  784. :type '(choice
  785. (const :tag "Never" nil)
  786. (const :tag "Always" t)))
  787. (defcustom org-agenda-skip-deadline-if-done nil
  788. "Non-nil means don't show deadlines when the corresponding item is done.
  789. When nil, the deadline is still shown and should give you a happy feeling.
  790. This is relevant for the daily/weekly agenda. And it applied only to the
  791. actually date of the deadline. Warnings about approaching and past-due
  792. deadlines are always turned off when the item is DONE."
  793. :group 'org-agenda-skip
  794. :group 'org-agenda-daily/weekly
  795. :type 'boolean)
  796. (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
  797. "Non-nil means skip deadline prewarning when entry is also scheduled.
  798. This will apply on all days where a prewarning for the deadline would
  799. be shown, but not at the day when the entry is actually due. On that day,
  800. the deadline will be shown anyway.
  801. This variable may be set to nil, t, the symbol `pre-scheduled',
  802. or a number which will then give the number of days before the actual
  803. deadline when the prewarnings should resume. The symbol `pre-scheduled'
  804. eliminates the deadline prewarning only prior to the scheduled date.
  805. This can be used in a workflow where the first showing of the deadline will
  806. trigger you to schedule it, and then you don't want to be reminded of it
  807. because you will take care of it on the day when scheduled."
  808. :group 'org-agenda-skip
  809. :group 'org-agenda-daily/weekly
  810. :version "24.1"
  811. :type '(choice
  812. (const :tag "Always show prewarning" nil)
  813. (const :tag "Remove prewarning prior to scheduled date" pre-scheduled)
  814. (const :tag "Remove prewarning if entry is scheduled" t)
  815. (integer :tag "Restart prewarning N days before deadline")))
  816. (defcustom org-agenda-skip-scheduled-delay-if-deadline nil
  817. "Non-nil means skip scheduled delay when entry also has a deadline.
  818. This variable may be set to nil, t, the symbol `post-deadline',
  819. or a number which will then give the number of days after the actual
  820. scheduled date when the delay should expire. The symbol `post-deadline'
  821. eliminates the schedule delay when the date is posterior to the deadline."
  822. :group 'org-agenda-skip
  823. :group 'org-agenda-daily/weekly
  824. :version "24.4"
  825. :package-version '(Org . "8.0")
  826. :type '(choice
  827. (const :tag "Always honor delay" nil)
  828. (const :tag "Ignore delay if posterior to the deadline" post-deadline)
  829. (const :tag "Ignore delay if entry has a deadline" t)
  830. (integer :tag "Honor delay up until N days after the scheduled date")))
  831. (defcustom org-agenda-skip-additional-timestamps-same-entry nil
  832. "When nil, multiple same-day timestamps in entry make multiple agenda lines.
  833. When non-nil, after the search for timestamps has matched once in an
  834. entry, the rest of the entry will not be searched."
  835. :group 'org-agenda-skip
  836. :type 'boolean)
  837. (defcustom org-agenda-skip-timestamp-if-done nil
  838. "Non-nil means don't select item by timestamp or -range if it is DONE."
  839. :group 'org-agenda-skip
  840. :group 'org-agenda-daily/weekly
  841. :type 'boolean)
  842. (defcustom org-agenda-dim-blocked-tasks t
  843. "Non-nil means dim blocked tasks in the agenda display.
  844. This causes some overhead during agenda construction, but if you
  845. have turned on `org-enforce-todo-dependencies',
  846. `org-enforce-todo-checkbox-dependencies', or any other blocking
  847. mechanism, this will create useful feedback in the agenda.
  848. Instead of t, this variable can also have the value `invisible'.
  849. Then blocked tasks will be invisible and only become visible when
  850. they become unblocked. An exemption to this behavior is when a task is
  851. blocked because of unchecked checkboxes below it. Since checkboxes do
  852. not show up in the agenda views, making this task invisible you remove any
  853. trace from agenda views that there is something to do. Therefore, a task
  854. that is blocked because of checkboxes will never be made invisible, it
  855. will only be dimmed."
  856. :group 'org-agenda-daily/weekly
  857. :group 'org-agenda-todo-list
  858. :version "24.3"
  859. :type '(choice
  860. (const :tag "Do not dim" nil)
  861. (const :tag "Dim to a gray face" t)
  862. (const :tag "Make invisible" invisible)))
  863. (defcustom org-timeline-show-empty-dates 3
  864. "Non-nil means `org-timeline' also shows dates without an entry.
  865. When nil, only the days which actually have entries are shown.
  866. When t, all days between the first and the last date are shown.
  867. When an integer, show also empty dates, but if there is a gap of more than
  868. N days, just insert a special line indicating the size of the gap."
  869. :group 'org-agenda-skip
  870. :type '(choice
  871. (const :tag "None" nil)
  872. (const :tag "All" t)
  873. (integer :tag "at most")))
  874. (defgroup org-agenda-startup nil
  875. "Options concerning initial settings in the Agenda in Org Mode."
  876. :tag "Org Agenda Startup"
  877. :group 'org-agenda)
  878. (defcustom org-agenda-menu-show-matcher t
  879. "Non-nil means show the match string in the agenda dispatcher menu.
  880. When nil, the matcher string is not shown, but is put into the help-echo
  881. property so than moving the mouse over the command shows it.
  882. Setting it to nil is good if matcher strings are very long and/or if
  883. you want to use two-columns display (see `org-agenda-menu-two-columns')."
  884. :group 'org-agenda
  885. :version "24.1"
  886. :type 'boolean)
  887. (defcustom org-agenda-menu-two-columns nil
  888. "Non-nil means, use two columns to show custom commands in the dispatcher.
  889. If you use this, you probably want to set `org-agenda-menu-show-matcher'
  890. to nil."
  891. :group 'org-agenda
  892. :version "24.1"
  893. :type 'boolean)
  894. (defcustom org-agenda-finalize-hook nil
  895. "Hook run just before displaying an agenda buffer.
  896. The buffer is still writable when the hook is called.
  897. You can modify some of the buffer substrings but you should be
  898. extra careful not to modify the text properties of the agenda
  899. headlines as the agenda display heavily relies on them."
  900. :group 'org-agenda-startup
  901. :type 'hook)
  902. (defcustom org-agenda-mouse-1-follows-link nil
  903. "Non-nil means mouse-1 on a link will follow the link in the agenda.
  904. A longer mouse click will still set point. Needs to be set
  905. before org.el is loaded."
  906. :group 'org-agenda-startup
  907. :type 'boolean)
  908. (defcustom org-agenda-start-with-follow-mode nil
  909. "The initial value of follow mode in a newly created agenda window."
  910. :group 'org-agenda-startup
  911. :type 'boolean)
  912. (defcustom org-agenda-follow-indirect nil
  913. "Non-nil means `org-agenda-follow-mode' displays only the
  914. current item's tree, in an indirect buffer."
  915. :group 'org-agenda
  916. :version "24.1"
  917. :type 'boolean)
  918. (defcustom org-agenda-show-outline-path t
  919. "Non-nil means show outline path in echo area after line motion."
  920. :group 'org-agenda-startup
  921. :type 'boolean)
  922. (defcustom org-agenda-start-with-entry-text-mode nil
  923. "The initial value of entry-text-mode in a newly created agenda window."
  924. :group 'org-agenda-startup
  925. :type 'boolean)
  926. (defcustom org-agenda-entry-text-maxlines 5
  927. "Number of text lines to be added when `E' is pressed in the agenda.
  928. Note that this variable only used during agenda display. Add add entry text
  929. when exporting the agenda, configure the variable
  930. `org-agenda-add-entry-ext-maxlines'."
  931. :group 'org-agenda
  932. :type 'integer)
  933. (defcustom org-agenda-entry-text-exclude-regexps nil
  934. "List of regular expressions to clean up entry text.
  935. The complete matches of all regular expressions in this list will be
  936. removed from entry text before it is shown in the agenda."
  937. :group 'org-agenda
  938. :type '(repeat (regexp)))
  939. (defcustom org-agenda-entry-text-leaders " > "
  940. "Text prepended to the entry text in agenda buffers."
  941. :version "24.4"
  942. :package-version '(Org . "8.0")
  943. :group 'org-agenda
  944. :type 'string)
  945. (defvar org-agenda-entry-text-cleanup-hook nil
  946. "Hook that is run after basic cleanup of entry text to be shown in agenda.
  947. This cleanup is done in a temporary buffer, so the function may inspect and
  948. change the entire buffer.
  949. Some default stuff like drawers and scheduling/deadline dates will already
  950. have been removed when this is called, as will any matches for regular
  951. expressions listed in `org-agenda-entry-text-exclude-regexps'.")
  952. (defvar org-agenda-include-inactive-timestamps nil
  953. "Non-nil means include inactive time stamps in agenda and timeline.
  954. Dynamically scoped.")
  955. (defgroup org-agenda-windows nil
  956. "Options concerning the windows used by the Agenda in Org Mode."
  957. :tag "Org Agenda Windows"
  958. :group 'org-agenda)
  959. (defcustom org-agenda-window-setup 'reorganize-frame
  960. "How the agenda buffer should be displayed.
  961. Possible values for this option are:
  962. current-window Show agenda in the current window, keeping all other windows.
  963. other-window Use `switch-to-buffer-other-window' to display agenda.
  964. only-window Show agenda, deleting all other windows.
  965. reorganize-frame Show only two windows on the current frame, the current
  966. window and the agenda.
  967. other-frame Use `switch-to-buffer-other-frame' to display agenda.
  968. Also, when exiting the agenda, kill that frame.
  969. See also the variable `org-agenda-restore-windows-after-quit'."
  970. :group 'org-agenda-windows
  971. :type '(choice
  972. (const current-window)
  973. (const other-frame)
  974. (const other-window)
  975. (const only-window)
  976. (const reorganize-frame)))
  977. (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
  978. "The min and max height of the agenda window as a fraction of frame height.
  979. The value of the variable is a cons cell with two numbers between 0 and 1.
  980. It only matters if `org-agenda-window-setup' is `reorganize-frame'."
  981. :group 'org-agenda-windows
  982. :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
  983. (defcustom org-agenda-restore-windows-after-quit nil
  984. "Non-nil means restore window configuration upon exiting agenda.
  985. Before the window configuration is changed for displaying the agenda,
  986. the current status is recorded. When the agenda is exited with
  987. `q' or `x' and this option is set, the old state is restored. If
  988. `org-agenda-window-setup' is `other-frame', the value of this
  989. option will be ignored."
  990. :group 'org-agenda-windows
  991. :type 'boolean)
  992. (defcustom org-agenda-span 'week
  993. "Number of days to include in overview display.
  994. Can be day, week, month, year, or any number of days.
  995. Custom commands can set this variable in the options section."
  996. :group 'org-agenda-daily/weekly
  997. :type '(choice (const :tag "Day" day)
  998. (const :tag "Week" week)
  999. (const :tag "Fortnight" fortnight)
  1000. (const :tag "Month" month)
  1001. (const :tag "Year" year)
  1002. (integer :tag "Custom")))
  1003. (defcustom org-agenda-start-on-weekday 1
  1004. "Non-nil means start the overview always on the specified weekday.
  1005. 0 denotes Sunday, 1 denotes Monday, etc.
  1006. When nil, always start on the current day.
  1007. Custom commands can set this variable in the options section."
  1008. :group 'org-agenda-daily/weekly
  1009. :type '(choice (const :tag "Today" nil)
  1010. (integer :tag "Weekday No.")))
  1011. (defcustom org-agenda-show-all-dates t
  1012. "Non-nil means `org-agenda' shows every day in the selected range.
  1013. When nil, only the days which actually have entries are shown."
  1014. :group 'org-agenda-daily/weekly
  1015. :type 'boolean)
  1016. (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
  1017. "Format string for displaying dates in the agenda.
  1018. Used by the daily/weekly agenda and by the timeline. This should be
  1019. a format string understood by `format-time-string', or a function returning
  1020. the formatted date as a string. The function must take a single argument,
  1021. a calendar-style date list like (month day year)."
  1022. :group 'org-agenda-daily/weekly
  1023. :type '(choice
  1024. (string :tag "Format string")
  1025. (function :tag "Function")))
  1026. (defun org-agenda-format-date-aligned (date)
  1027. "Format a DATE string for display in the daily/weekly agenda, or timeline.
  1028. This function makes sure that dates are aligned for easy reading."
  1029. (require 'cal-iso)
  1030. (let* ((dayname (calendar-day-name date))
  1031. (day (cadr date))
  1032. (day-of-week (calendar-day-of-week date))
  1033. (month (car date))
  1034. (monthname (calendar-month-name month))
  1035. (year (nth 2 date))
  1036. (iso-week (org-days-to-iso-week
  1037. (calendar-absolute-from-gregorian date)))
  1038. (weekyear (cond ((and (= month 1) (>= iso-week 52))
  1039. (1- year))
  1040. ((and (= month 12) (<= iso-week 1))
  1041. (1+ year))
  1042. (t year)))
  1043. (weekstring (if (= day-of-week 1)
  1044. (format " W%02d" iso-week)
  1045. "")))
  1046. (format "%-10s %2d %s %4d%s"
  1047. dayname day monthname year weekstring)))
  1048. (defcustom org-agenda-time-leading-zero nil
  1049. "Non-nil means use leading zero for military times in agenda.
  1050. For example, 9:30am would become 09:30 rather than 9:30."
  1051. :group 'org-agenda-daily/weekly
  1052. :version "24.1"
  1053. :type 'boolean)
  1054. (defcustom org-agenda-timegrid-use-ampm nil
  1055. "When set, show AM/PM style timestamps on the timegrid."
  1056. :group 'org-agenda
  1057. :version "24.1"
  1058. :type 'boolean)
  1059. (defun org-agenda-time-of-day-to-ampm (time)
  1060. "Convert TIME of a string like \"13:45\" to an AM/PM style time string."
  1061. (let* ((hour-number (string-to-number (substring time 0 -3)))
  1062. (minute (substring time -2))
  1063. (ampm "am"))
  1064. (cond
  1065. ((equal hour-number 12)
  1066. (setq ampm "pm"))
  1067. ((> hour-number 12)
  1068. (setq ampm "pm")
  1069. (setq hour-number (- hour-number 12))))
  1070. (concat
  1071. (if org-agenda-time-leading-zero
  1072. (format "%02d" hour-number)
  1073. (format "%02s" (number-to-string hour-number)))
  1074. ":" minute ampm)))
  1075. (defun org-agenda-time-of-day-to-ampm-maybe (time)
  1076. "Conditionally convert TIME to AM/PM format based on `org-agenda-timegrid-use-ampm'."
  1077. (if org-agenda-timegrid-use-ampm
  1078. (org-agenda-time-of-day-to-ampm time)
  1079. time))
  1080. (defcustom org-agenda-weekend-days '(6 0)
  1081. "Which days are weekend?
  1082. These days get the special face `org-agenda-date-weekend' in the agenda
  1083. and timeline buffers."
  1084. :group 'org-agenda-daily/weekly
  1085. :type '(set :greedy t
  1086. (const :tag "Monday" 1)
  1087. (const :tag "Tuesday" 2)
  1088. (const :tag "Wednesday" 3)
  1089. (const :tag "Thursday" 4)
  1090. (const :tag "Friday" 5)
  1091. (const :tag "Saturday" 6)
  1092. (const :tag "Sunday" 0)))
  1093. (defcustom org-agenda-move-date-from-past-immediately-to-today t
  1094. "Non-nil means jump to today when moving a past date forward in time.
  1095. When using S-right in the agenda to move a a date forward, and the date
  1096. stamp currently points to the past, the first key press will move it
  1097. to today. WHen nil, just move one day forward even if the date stays
  1098. in the past."
  1099. :group 'org-agenda-daily/weekly
  1100. :version "24.1"
  1101. :type 'boolean)
  1102. (defcustom org-agenda-include-diary nil
  1103. "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
  1104. Custom commands can set this variable in the options section."
  1105. :group 'org-agenda-daily/weekly
  1106. :type 'boolean)
  1107. (defcustom org-agenda-include-deadlines t
  1108. "If non-nil, include entries within their deadline warning period.
  1109. Custom commands can set this variable in the options section."
  1110. :group 'org-agenda-daily/weekly
  1111. :version "24.1"
  1112. :type 'boolean)
  1113. (defcustom org-agenda-repeating-timestamp-show-all t
  1114. "Non-nil means show all occurrences of a repeating stamp in the agenda.
  1115. When set to a list of strings, only show occurrences of repeating
  1116. stamps for these TODO keywords. When nil, only one occurrence is
  1117. shown, either today or the nearest into the future."
  1118. :group 'org-agenda-daily/weekly
  1119. :type '(choice
  1120. (const :tag "Show repeating stamps" t)
  1121. (repeat :tag "Show repeating stamps for these TODO keywords"
  1122. (string :tag "TODO Keyword"))
  1123. (const :tag "Don't show repeating stamps" nil)))
  1124. (defcustom org-scheduled-past-days 10000
  1125. "Number of days to continue listing scheduled items not marked DONE.
  1126. When an item is scheduled on a date, it shows up in the agenda on
  1127. this day and will be listed until it is marked done or for the
  1128. number of days given here."
  1129. :group 'org-agenda-daily/weekly
  1130. :type 'integer)
  1131. (defcustom org-agenda-log-mode-items '(closed clock)
  1132. "List of items that should be shown in agenda log mode.
  1133. \\<org-agenda-mode-map>\
  1134. This list may contain the following symbols:
  1135. closed Show entries that have been closed on that day.
  1136. clock Show entries that have received clocked time on that day.
  1137. state Show all logged state changes.
  1138. Note that instead of changing this variable, you can also press \
  1139. `\\[universal-argument] \\[org-agenda-log-mode]' in
  1140. the agenda to display all available LOG items temporarily."
  1141. :group 'org-agenda-daily/weekly
  1142. :type '(set :greedy t (const closed) (const clock) (const state)))
  1143. (defcustom org-agenda-clock-consistency-checks
  1144. '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
  1145. :gap-ok-around ("4:00")
  1146. :default-face ((:background "DarkRed") (:foreground "white"))
  1147. :overlap-face nil :gap-face nil :no-end-time-face nil
  1148. :long-face nil :short-face nil)
  1149. "This is a property list, with the following keys:
  1150. :max-duration Mark clocking chunks that are longer than this time.
  1151. This is a time string like \"HH:MM\", or the number
  1152. of minutes as an integer.
  1153. :min-duration Mark clocking chunks that are shorter that this.
  1154. This is a time string like \"HH:MM\", or the number
  1155. of minutes as an integer.
  1156. :max-gap Mark gaps between clocking chunks that are longer than
  1157. this duration. A number of minutes, or a string
  1158. like \"HH:MM\".
  1159. :gap-ok-around List of times during the day which are usually not working
  1160. times. When a gap is detected, but the gap contains any
  1161. of these times, the gap is *not* reported. For example,
  1162. if this is (\"4:00\" \"13:00\") then gaps that contain
  1163. 4:00 in the morning (i.e. the night) and 13:00
  1164. (i.e. a typical lunch time) do not cause a warning.
  1165. You should have at least one time during the night in this
  1166. list, or otherwise the first task each morning will trigger
  1167. a warning because it follows a long gap.
  1168. Furthermore, the following properties can be used to define faces for
  1169. issue display.
  1170. :default-face the default face, if the specific face is undefined
  1171. :overlap-face face for overlapping clocks
  1172. :gap-face face for gaps between clocks
  1173. :no-end-time-face face for incomplete clocks
  1174. :long-face face for clock intervals that are too long
  1175. :short-face face for clock intervals that are too short"
  1176. :group 'org-agenda-daily/weekly
  1177. :group 'org-clock
  1178. :version "24.1"
  1179. :type 'plist)
  1180. (defcustom org-agenda-log-mode-add-notes t
  1181. "Non-nil means add first line of notes to log entries in agenda views.
  1182. If a log item like a state change or a clock entry is associated with
  1183. notes, the first line of these notes will be added to the entry in the
  1184. agenda display."
  1185. :group 'org-agenda-daily/weekly
  1186. :type 'boolean)
  1187. (defcustom org-agenda-start-with-log-mode nil
  1188. "The initial value of log-mode in a newly created agenda window.
  1189. See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
  1190. explanations on the possible values."
  1191. :group 'org-agenda-startup
  1192. :group 'org-agenda-daily/weekly
  1193. :type '(choice (const :tag "Don't show log items" nil)
  1194. (const :tag "Show only log items" only)
  1195. (const :tag "Show all possible log items" clockcheck)
  1196. (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
  1197. (choice (const :tag "Show closed log items" closed)
  1198. (const :tag "Show clocked log items" clock)
  1199. (const :tag "Show all logged state changes" state)))))
  1200. (defcustom org-agenda-start-with-clockreport-mode nil
  1201. "The initial value of clockreport-mode in a newly created agenda window."
  1202. :group 'org-agenda-startup
  1203. :group 'org-agenda-daily/weekly
  1204. :type 'boolean)
  1205. (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
  1206. "Property list with parameters for the clocktable in clockreport mode.
  1207. This is the display mode that shows a clock table in the daily/weekly
  1208. agenda, the properties for this dynamic block can be set here.
  1209. The usual clocktable parameters are allowed here, but you cannot set
  1210. the properties :name, :tstart, :tend, :block, and :scope - these will
  1211. be overwritten to make sure the content accurately reflects the
  1212. current display in the agenda."
  1213. :group 'org-agenda-daily/weekly
  1214. :type 'plist)
  1215. (defcustom org-agenda-search-view-always-boolean nil
  1216. "Non-nil means the search string is interpreted as individual parts.
  1217. The search string for search view can either be interpreted as a phrase,
  1218. or as a list of snippets that define a boolean search for a number of
  1219. strings.
  1220. When this is non-nil, the string will be split on whitespace, and each
  1221. snippet will be searched individually, and all must match in order to
  1222. select an entry. A snippet is then a single string of non-white
  1223. characters, or a string in double quotes, or a regexp in {} braces.
  1224. If a snippet is preceded by \"-\", the snippet must *not* match.
  1225. \"+\" is syntactic sugar for positive selection. Each snippet may
  1226. be found as a full word or a partial word, but see the variable
  1227. `org-agenda-search-view-force-full-words'.
  1228. When this is nil, search will look for the entire search phrase as one,
  1229. with each space character matching any amount of whitespace, including
  1230. line breaks.
  1231. Even when this is nil, you can still switch to Boolean search dynamically
  1232. by preceding the first snippet with \"+\" or \"-\". If the first snippet
  1233. is a regexp marked with braces like \"{abc}\", this will also switch to
  1234. boolean search."
  1235. :group 'org-agenda-search-view
  1236. :version "24.1"
  1237. :type 'boolean)
  1238. (defvaralias 'org-agenda-search-view-search-words-only
  1239. 'org-agenda-search-view-always-boolean)
  1240. (defcustom org-agenda-search-view-force-full-words nil
  1241. "Non-nil means, search words must be matches as complete words.
  1242. When nil, they may also match part of a word."
  1243. :group 'org-agenda-search-view
  1244. :version "24.1"
  1245. :type 'boolean)
  1246. (defcustom org-agenda-search-view-max-outline-level 0
  1247. "Maximum outline level to display in search view.
  1248. E.g. when this is set to 1, the search view will only
  1249. show headlines of level 1. When set to 0, the default
  1250. value, don't limit agenda view by outline level."
  1251. :group 'org-agenda-search-view
  1252. :version "24.4"
  1253. :package-version '(Org . "8.3")
  1254. :type 'integer)
  1255. (defgroup org-agenda-time-grid nil
  1256. "Options concerning the time grid in the Org-mode Agenda."
  1257. :tag "Org Agenda Time Grid"
  1258. :group 'org-agenda)
  1259. (defcustom org-agenda-search-headline-for-time t
  1260. "Non-nil means search headline for a time-of-day.
  1261. If the headline contains a time-of-day in one format or another, it will
  1262. be used to sort the entry into the time sequence of items for a day.
  1263. Some people have time stamps in the headline that refer to the creation
  1264. time or so, and then this produces an unwanted side effect. If this is
  1265. the case for your, use this variable to turn off searching the headline
  1266. for a time."
  1267. :group 'org-agenda-time-grid
  1268. :type 'boolean)
  1269. (defcustom org-agenda-use-time-grid t
  1270. "Non-nil means show a time grid in the agenda schedule.
  1271. A time grid is a set of lines for specific times (like every two hours between
  1272. 8:00 and 20:00). The items scheduled for a day at specific times are
  1273. sorted in between these lines.
  1274. For details about when the grid will be shown, and what it will look like, see
  1275. the variable `org-agenda-time-grid'."
  1276. :group 'org-agenda-time-grid
  1277. :type 'boolean)
  1278. (defcustom org-agenda-time-grid
  1279. '((daily today require-timed)
  1280. "----------------"
  1281. (800 1000 1200 1400 1600 1800 2000))
  1282. "The settings for time grid for agenda display.
  1283. This is a list of three items. The first item is again a list. It contains
  1284. symbols specifying conditions when the grid should be displayed:
  1285. daily if the agenda shows a single day
  1286. weekly if the agenda shows an entire week
  1287. today show grid on current date, independent of daily/weekly display
  1288. require-timed show grid only if at least one item has a time specification
  1289. remove-match skip grid times already present in an entry
  1290. The second item is a string which will be placed behind the grid time.
  1291. The third item is a list of integers, indicating the times that should have
  1292. a grid line."
  1293. :group 'org-agenda-time-grid
  1294. :type
  1295. '(list
  1296. (set :greedy t :tag "Grid Display Options"
  1297. (const :tag "Show grid in single day agenda display" daily)
  1298. (const :tag "Show grid in weekly agenda display" weekly)
  1299. (const :tag "Always show grid for today" today)
  1300. (const :tag "Show grid only if any timed entries are present"
  1301. require-timed)
  1302. (const :tag "Skip grid times already present in an entry"
  1303. remove-match))
  1304. (string :tag "Grid String")
  1305. (repeat :tag "Grid Times" (integer :tag "Time"))))
  1306. (defcustom org-agenda-show-current-time-in-grid t
  1307. "Non-nil means show the current time in the time grid."
  1308. :group 'org-agenda-time-grid
  1309. :version "24.1"
  1310. :type 'boolean)
  1311. (defcustom org-agenda-current-time-string
  1312. "now - - - - - - - - - - - - - - - - - - - - - - - - -"
  1313. "The string for the current time marker in the agenda."
  1314. :group 'org-agenda-time-grid
  1315. :version "24.1"
  1316. :type 'string)
  1317. (defgroup org-agenda-sorting nil
  1318. "Options concerning sorting in the Org-mode Agenda."
  1319. :tag "Org Agenda Sorting"
  1320. :group 'org-agenda)
  1321. (defcustom org-agenda-sorting-strategy
  1322. '((agenda habit-down time-up priority-down category-keep)
  1323. (todo priority-down category-keep)
  1324. (tags priority-down category-keep)
  1325. (search category-keep))
  1326. "Sorting structure for the agenda items of a single day.
  1327. This is a list of symbols which will be used in sequence to determine
  1328. if an entry should be listed before another entry. The following
  1329. symbols are recognized:
  1330. time-up Put entries with time-of-day indications first, early first
  1331. time-down Put entries with time-of-day indications first, late first
  1332. timestamp-up Sort by any timestamp, early first
  1333. timestamp-down Sort by any timestamp, late first
  1334. scheduled-up Sort by scheduled timestamp, early first
  1335. scheduled-down Sort by scheduled timestamp, late first
  1336. deadline-up Sort by deadline timestamp, early first
  1337. deadline-down Sort by deadline timestamp, late first
  1338. ts-up Sort by active timestamp, early first
  1339. ts-down Sort by active timestamp, late first
  1340. tsia-up Sort by inactive timestamp, early first
  1341. tsia-down Sort by inactive timestamp, late first
  1342. category-keep Keep the default order of categories, corresponding to the
  1343. sequence in `org-agenda-files'.
  1344. category-up Sort alphabetically by category, A-Z.
  1345. category-down Sort alphabetically by category, Z-A.
  1346. tag-up Sort alphabetically by last tag, A-Z.
  1347. tag-down Sort alphabetically by last tag, Z-A.
  1348. priority-up Sort numerically by priority, high priority last.
  1349. priority-down Sort numerically by priority, high priority first.
  1350. todo-state-up Sort by todo state, tasks that are done last.
  1351. todo-state-down Sort by todo state, tasks that are done first.
  1352. effort-up Sort numerically by estimated effort, high effort last.
  1353. effort-down Sort numerically by estimated effort, high effort first.
  1354. user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
  1355. user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
  1356. habit-up Put entries that are habits first
  1357. habit-down Put entries that are habits last
  1358. alpha-up Sort headlines alphabetically
  1359. alpha-down Sort headlines alphabetically, reversed
  1360. The different possibilities will be tried in sequence, and testing stops
  1361. if one comparison returns a \"not-equal\". For example, the default
  1362. '(time-up category-keep priority-down)
  1363. means: Pull out all entries having a specified time of day and sort them,
  1364. in order to make a time schedule for the current day the first thing in the
  1365. agenda listing for the day. Of the entries without a time indication, keep
  1366. the grouped in categories, don't sort the categories, but keep them in
  1367. the sequence given in `org-agenda-files'. Within each category sort by
  1368. priority.
  1369. Leaving out `category-keep' would mean that items will be sorted across
  1370. categories by priority.
  1371. Instead of a single list, this can also be a set of list for specific
  1372. contents, with a context symbol in the car of the list, any of
  1373. `agenda', `todo', `tags', `search' for the corresponding agenda views.
  1374. Custom commands can bind this variable in the options section."
  1375. :group 'org-agenda-sorting
  1376. :type `(choice
  1377. (repeat :tag "General" ,org-sorting-choice)
  1378. (list :tag "Individually"
  1379. (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
  1380. (repeat ,org-sorting-choice))
  1381. (cons (const :tag "Strategy for TODO lists" todo)
  1382. (repeat ,org-sorting-choice))
  1383. (cons (const :tag "Strategy for Tags matches" tags)
  1384. (repeat ,org-sorting-choice))
  1385. (cons (const :tag "Strategy for search matches" search)
  1386. (repeat ,org-sorting-choice)))))
  1387. (defcustom org-agenda-cmp-user-defined nil
  1388. "A function to define the comparison `user-defined'.
  1389. This function must receive two arguments, agenda entry a and b.
  1390. If a>b, return +1. If a<b, return -1. If they are equal as seen by
  1391. the user comparison, return nil.
  1392. When this is defined, you can make `user-defined-up' and `user-defined-down'
  1393. part of an agenda sorting strategy."
  1394. :group 'org-agenda-sorting
  1395. :type 'symbol)
  1396. (defcustom org-sort-agenda-notime-is-late t
  1397. "Non-nil means items without time are considered late.
  1398. This is only relevant for sorting. When t, items which have no explicit
  1399. time like 15:30 will be considered as 99:01, i.e. later than any items which
  1400. do have a time. When nil, the default time is before 0:00. You can use this
  1401. option to decide if the schedule for today should come before or after timeless
  1402. agenda entries."
  1403. :group 'org-agenda-sorting
  1404. :type 'boolean)
  1405. (defcustom org-sort-agenda-noeffort-is-high t
  1406. "Non-nil means items without effort estimate are sorted as high effort.
  1407. This also applies when filtering an agenda view with respect to the
  1408. < or > effort operator. Then, tasks with no effort defined will be treated
  1409. as tasks with high effort.
  1410. When nil, such items are sorted as 0 minutes effort."
  1411. :group 'org-agenda-sorting
  1412. :type 'boolean)
  1413. (defgroup org-agenda-line-format nil
  1414. "Options concerning the entry prefix in the Org-mode agenda display."
  1415. :tag "Org Agenda Line Format"
  1416. :group 'org-agenda)
  1417. (defcustom org-agenda-prefix-format
  1418. '((agenda . " %i %-12:c%?-12t% s")
  1419. (timeline . " % s")
  1420. (todo . " %i %-12:c")
  1421. (tags . " %i %-12:c")
  1422. (search . " %i %-12:c"))
  1423. "Format specifications for the prefix of items in the agenda views.
  1424. An alist with five entries, each for the different agenda types. The
  1425. keys of the sublists are `agenda', `timeline', `todo', `search' and `tags'.
  1426. The values are format strings.
  1427. This format works similar to a printf format, with the following meaning:
  1428. %c the category of the item, \"Diary\" for entries from the diary,
  1429. or as given by the CATEGORY keyword or derived from the file name
  1430. %e the effort required by the item
  1431. %l the level of the item (insert X space(s) if item is of level X)
  1432. %i the icon category of the item, see `org-agenda-category-icon-alist'
  1433. %T the last tag of the item (ignore inherited tags, which come first)
  1434. %t the HH:MM time-of-day specification if one applies to the entry
  1435. %s Scheduling/Deadline information, a short string
  1436. %b show breadcrumbs, i.e., the names of the higher levels
  1437. %(expression) Eval EXPRESSION and replace the control string
  1438. by the result
  1439. All specifiers work basically like the standard `%s' of printf, but may
  1440. contain two additional characters: a question mark just after the `%'
  1441. and a whitespace/punctuation character just before the final letter.
  1442. If the first character after `%' is a question mark, the entire field
  1443. will only be included if the corresponding value applies to the current
  1444. entry. This is useful for fields which should have fixed width when
  1445. present, but zero width when absent. For example, \"%?-12t\" will
  1446. result in a 12 character time field if a time of the day is specified,
  1447. but will completely disappear in entries which do not contain a time.
  1448. If there is punctuation or whitespace character just before the
  1449. final format letter, this character will be appended to the field
  1450. value if the value is not empty. For example, the format
  1451. \"%-12:c\" leads to \"Diary: \" if the category is \"Diary\". If
  1452. the category is empty, no additional colon is inserted.
  1453. The default value for the agenda sublist is \" %-12:c%?-12t% s\",
  1454. which means:
  1455. - Indent the line with two space characters
  1456. - Give the category a 12 chars wide field, padded with whitespace on
  1457. the right (because of `-'). Append a colon if there is a category
  1458. (because of `:').
  1459. - If there is a time-of-day, put it into a 12 chars wide field. If no
  1460. time, don't put in an empty field, just skip it (because of '?').
  1461. - Finally, put the scheduling information.
  1462. See also the variables `org-agenda-remove-times-when-in-prefix' and
  1463. `org-agenda-remove-tags'.
  1464. Custom commands can set this variable in the options section."
  1465. :type '(choice
  1466. (string :tag "General format")
  1467. (list :greedy t :tag "View dependent"
  1468. (cons (const agenda) (string :tag "Format"))
  1469. (cons (const timeline) (string :tag "Format"))
  1470. (cons (const todo) (string :tag "Format"))
  1471. (cons (const tags) (string :tag "Format"))
  1472. (cons (const search) (string :tag "Format"))))
  1473. :group 'org-agenda-line-format)
  1474. (defvar org-prefix-format-compiled nil
  1475. "The compiled prefix format and associated variables.
  1476. This is a list where first element is a list of variable bindings, and second
  1477. element is the compiled format expression. See the variable
  1478. `org-agenda-prefix-format'.")
  1479. (defcustom org-agenda-todo-keyword-format "%-1s"
  1480. "Format for the TODO keyword in agenda lines.
  1481. Set this to something like \"%-12s\" if you want all TODO keywords
  1482. to occupy a fixed space in the agenda display."
  1483. :group 'org-agenda-line-format
  1484. :type 'string)
  1485. (defcustom org-agenda-diary-sexp-prefix nil
  1486. "A regexp that matches part of a diary sexp entry
  1487. which should be treated as scheduling/deadline information in
  1488. `org-agenda'.
  1489. For example, you can use this to extract the `diary-remind-message' from
  1490. `diary-remind' entries."
  1491. :group 'org-agenda-line-format
  1492. :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
  1493. (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
  1494. "Text preceding timerange entries in the agenda view.
  1495. This is a list with two strings. The first applies when the range
  1496. is entirely on one day. The second applies if the range spans several days.
  1497. The strings may have two \"%d\" format specifiers which will be filled
  1498. with the sequence number of the days, and the total number of days in the
  1499. range, respectively."
  1500. :group 'org-agenda-line-format
  1501. :type '(list
  1502. (string :tag "Deadline today ")
  1503. (choice :tag "Deadline relative"
  1504. (string :tag "Format string")
  1505. (function))))
  1506. (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
  1507. "Text preceding scheduled items in the agenda view.
  1508. This is a list with two strings. The first applies when the item is
  1509. scheduled on the current day. The second applies when it has been scheduled
  1510. previously, it may contain a %d indicating that this is the nth time that
  1511. this item is scheduled, due to automatic rescheduling of unfinished items
  1512. for the following day. So this number is one larger than the number of days
  1513. that passed since this item was scheduled first."
  1514. :group 'org-agenda-line-format
  1515. :version "24.4"
  1516. :package-version '(Org . "8.0")
  1517. :type '(list
  1518. (string :tag "Scheduled today ")
  1519. (string :tag "Scheduled previously")))
  1520. (defcustom org-agenda-inactive-leader "["
  1521. "Text preceding item pulled into the agenda by inactive time stamps.
  1522. These entries are added to the agenda when pressing \"[\"."
  1523. :group 'org-agenda-line-format
  1524. :version "24.1"
  1525. :type 'string)
  1526. (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: " "%2d d. ago: ")
  1527. "Text preceding deadline items in the agenda view.
  1528. This is a list with three strings. The first applies when the item has its
  1529. deadline on the current day. The second applies when the deadline is in the
  1530. future, the third one when it is in the past. The strings may contain %d
  1531. to capture the number of days."
  1532. :group 'org-agenda-line-format
  1533. :version "24.4"
  1534. :package-version '(Org . "8.0")
  1535. :type '(list
  1536. (string :tag "Deadline today ")
  1537. (string :tag "Deadline in the future ")
  1538. (string :tag "Deadline in the past ")))
  1539. (defcustom org-agenda-remove-times-when-in-prefix t
  1540. "Non-nil means remove duplicate time specifications in agenda items.
  1541. When the format `org-agenda-prefix-format' contains a `%t' specifier, a
  1542. time-of-day specification in a headline or diary entry is extracted and
  1543. placed into the prefix. If this option is non-nil, the original specification
  1544. \(a timestamp or -range, or just a plain time(range) specification like
  1545. 11:30-4pm) will be removed for agenda display. This makes the agenda less
  1546. cluttered.
  1547. The option can be t or nil. It may also be the symbol `beg', indicating
  1548. that the time should only be removed when it is located at the beginning of
  1549. the headline/diary entry."
  1550. :group 'org-agenda-line-format
  1551. :type '(choice
  1552. (const :tag "Always" t)
  1553. (const :tag "Never" nil)
  1554. (const :tag "When at beginning of entry" beg)))
  1555. (defcustom org-agenda-remove-timeranges-from-blocks nil
  1556. "Non-nil means remove time ranges specifications in agenda
  1557. items that span on several days."
  1558. :group 'org-agenda-line-format
  1559. :version "24.1"
  1560. :type 'boolean)
  1561. (defcustom org-agenda-default-appointment-duration nil
  1562. "Default duration for appointments that only have a starting time.
  1563. When nil, no duration is specified in such cases.
  1564. When non-nil, this must be the number of minutes, e.g. 60 for one hour."
  1565. :group 'org-agenda-line-format
  1566. :type '(choice
  1567. (integer :tag "Minutes")
  1568. (const :tag "No default duration")))
  1569. (defcustom org-agenda-show-inherited-tags t
  1570. "Non-nil means show inherited tags in each agenda line.
  1571. When this option is set to `always', it take precedences over
  1572. `org-agenda-use-tag-inheritance' and inherited tags are shown
  1573. in every agenda.
  1574. When this option is set to t (the default), inherited tags are
  1575. shown when they are available, i.e. when the value of
  1576. `org-agenda-use-tag-inheritance' has been taken into account.
  1577. This can be set to a list of agenda types in which the agenda
  1578. must display the inherited tags. Available types are `todo',
  1579. `agenda', `search' and `timeline'.
  1580. When set to nil, never show inherited tags in agenda lines."
  1581. :group 'org-agenda-line-format
  1582. :group 'org-agenda
  1583. :version "24.3"
  1584. :type '(choice
  1585. (const :tag "Show inherited tags when available" t)
  1586. (const :tag "Always show inherited tags" always)
  1587. (repeat :tag "Show inherited tags only in selected agenda types"
  1588. (symbol :tag "Agenda type"))))
  1589. (defcustom org-agenda-use-tag-inheritance '(todo search timeline agenda)
  1590. "List of agenda view types where to use tag inheritance.
  1591. In tags/tags-todo/tags-tree agenda views, tag inheritance is
  1592. controlled by `org-use-tag-inheritance'. In other agenda types,
  1593. `org-use-tag-inheritance' is not used for the selection of the
  1594. agenda entries. Still, you may want the agenda to be aware of
  1595. the inherited tags anyway, e.g. for later tag filtering.
  1596. Allowed value are `todo', `search', `timeline' and `agenda'.
  1597. This variable has no effect if `org-agenda-show-inherited-tags'
  1598. is set to `always'. In that case, the agenda is aware of those
  1599. tags.
  1600. The default value sets tags in every agenda type. Setting this
  1601. option to nil will speed up non-tags agenda view a lot."
  1602. :group 'org-agenda
  1603. :version "24.3"
  1604. :type '(choice
  1605. (const :tag "Use tag inheritance in all agenda types" t)
  1606. (repeat :tag "Use tag inheritance in selected agenda types"
  1607. (symbol :tag "Agenda type"))))
  1608. (defcustom org-agenda-hide-tags-regexp nil
  1609. "Regular expression used to filter away specific tags in agenda views.
  1610. This means that these tags will be present, but not be shown in the agenda
  1611. line. Secondary filtering will still work on the hidden tags.
  1612. Nil means don't hide any tags."
  1613. :group 'org-agenda-line-format
  1614. :type '(choice
  1615. (const :tag "Hide none" nil)
  1616. (string :tag "Regexp ")))
  1617. (defcustom org-agenda-remove-tags nil
  1618. "Non-nil means remove the tags from the headline copy in the agenda.
  1619. When this is the symbol `prefix', only remove tags when
  1620. `org-agenda-prefix-format' contains a `%T' specifier."
  1621. :group 'org-agenda-line-format
  1622. :type '(choice
  1623. (const :tag "Always" t)
  1624. (const :tag "Never" nil)
  1625. (const :tag "When prefix format contains %T" prefix)))
  1626. (defvaralias 'org-agenda-remove-tags-when-in-prefix
  1627. 'org-agenda-remove-tags)
  1628. (defcustom org-agenda-tags-column -80
  1629. "Shift tags in agenda items to this column.
  1630. If this number is positive, it specifies the column. If it is negative,
  1631. it means that the tags should be flushright to that column. For example,
  1632. -80 works well for a normal 80 character screen."
  1633. :group 'org-agenda-line-format
  1634. :type 'integer)
  1635. (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column)
  1636. (defcustom org-agenda-fontify-priorities 'cookies
  1637. "Non-nil means highlight low and high priorities in agenda.
  1638. When t, the highest priority entries are bold, lowest priority italic.
  1639. However, settings in `org-priority-faces' will overrule these faces.
  1640. When this variable is the symbol `cookies', only fontify the
  1641. cookies, not the entire task.
  1642. This may also be an association list of priority faces, whose
  1643. keys are the character values of `org-highest-priority',
  1644. `org-default-priority', and `org-lowest-priority' (the default values
  1645. are ?A, ?B, and ?C, respectively). The face may be a named face, a
  1646. color as a string, or a list like `(:background \"Red\")'.
  1647. If it is a color, the variable `org-faces-easy-properties'
  1648. determines if it is a foreground or a background color."
  1649. :group 'org-agenda-line-format
  1650. :type '(choice
  1651. (const :tag "Never" nil)
  1652. (const :tag "Defaults" t)
  1653. (const :tag "Cookies only" cookies)
  1654. (repeat :tag "Specify"
  1655. (list (character :tag "Priority" :value ?A)
  1656. (choice :tag "Face "
  1657. (string :tag "Color")
  1658. (sexp :tag "Face"))))))
  1659. (defcustom org-agenda-day-face-function nil
  1660. "Function called to determine what face should be used to display a day.
  1661. The only argument passed to that function is the day. It should
  1662. returns a face, or nil if does not want to specify a face and let
  1663. the normal rules apply."
  1664. :group 'org-agenda-line-format
  1665. :version "24.1"
  1666. :type '(choice (const nil) (function)))
  1667. (defcustom org-agenda-category-icon-alist nil
  1668. "Alist of category icon to be displayed in agenda views.
  1669. Each entry should have the following format:
  1670. (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
  1671. Where CATEGORY-REGEXP is a regexp matching the categories where
  1672. the icon should be displayed.
  1673. FILE-OR-DATA either a file path or a string containing image data.
  1674. The other fields can be omitted safely if not needed:
  1675. TYPE indicates the image type.
  1676. DATA-P is a boolean indicating whether the FILE-OR-DATA string is
  1677. image data.
  1678. PROPS are additional image attributes to assign to the image,
  1679. like, e.g. `:ascent center'.
  1680. (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
  1681. If you want to set the display properties yourself, just put a
  1682. list as second element:
  1683. (CATEGORY-REGEXP (MY PROPERTY LIST))
  1684. For example, to display a 16px horizontal space for Emacs
  1685. category, you can use:
  1686. (\"Emacs\" \\='(space . (:width (16))))"
  1687. :group 'org-agenda-line-format
  1688. :version "24.1"
  1689. :type '(alist :key-type (string :tag "Regexp matching category")
  1690. :value-type (choice (list :tag "Icon"
  1691. (string :tag "File or data")
  1692. (symbol :tag "Type")
  1693. (boolean :tag "Data?")
  1694. (repeat :tag "Extra image properties" :inline t symbol))
  1695. (list :tag "Display properties" sexp))))
  1696. (defgroup org-agenda-column-view nil
  1697. "Options concerning column view in the agenda."
  1698. :tag "Org Agenda Column View"
  1699. :group 'org-agenda)
  1700. (defcustom org-agenda-view-columns-initially nil
  1701. "When non-nil, switch to columns view right after creating the agenda."
  1702. :group 'org-agenda-column-view
  1703. :type 'boolean
  1704. :version "25.1"
  1705. :package-version '(Org . "9.0")
  1706. :safe #'booleanp)
  1707. (defcustom org-agenda-columns-show-summaries t
  1708. "Non-nil means show summaries for columns displayed in the agenda view."
  1709. :group 'org-agenda-column-view
  1710. :type 'boolean)
  1711. (defcustom org-agenda-columns-compute-summary-properties t
  1712. "Non-nil means recompute all summary properties before column view.
  1713. When column view in the agenda is listing properties that have a summary
  1714. operator, it can go to all relevant buffers and recompute the summaries
  1715. there. This can mean overhead for the agenda column view, but is necessary
  1716. to have thing up to date.
  1717. As a special case, a CLOCKSUM property also makes sure that the clock
  1718. computations are current."
  1719. :group 'org-agenda-column-view
  1720. :type 'boolean)
  1721. (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
  1722. "Non-nil means the duration of an appointment will add to day effort.
  1723. The property to which appointment durations will be added is the one given
  1724. in the option `org-effort-property'. If an appointment does not have
  1725. an end time, `org-agenda-default-appointment-duration' will be used. If that
  1726. is not set, an appointment without end time will not contribute to the time
  1727. estimate."
  1728. :group 'org-agenda-column-view
  1729. :type 'boolean)
  1730. (defcustom org-agenda-auto-exclude-function nil
  1731. "A function called with a tag to decide if it is filtered on \
  1732. \\<org-agenda-mode-map>`\\[org-agenda-filter-by-tag] RET'.
  1733. The sole argument to the function, which is called once for each
  1734. possible tag, is a string giving the name of the tag. The
  1735. function should return either nil if the tag should be included
  1736. as normal, or \"-<TAG>\" to exclude the tag.
  1737. Note that for the purpose of tag filtering, only the lower-case version of
  1738. all tags will be considered, so that this function will only ever see
  1739. the lower-case version of all tags."
  1740. :group 'org-agenda
  1741. :type '(choice (const nil) (function)))
  1742. (defcustom org-agenda-bulk-custom-functions nil
  1743. "Alist of characters and custom functions for bulk actions.
  1744. For example, this value makes those two functions available:
  1745. \\='((?R set-category)
  1746. (?C bulk-cut))
  1747. With selected entries in an agenda buffer, `B R' will call
  1748. the custom function `set-category' on the selected entries.
  1749. Note that functions in this alist don't need to be quoted."
  1750. :type '(alist :key-type character :value-type (group function))
  1751. :version "24.1"
  1752. :group 'org-agenda)
  1753. (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
  1754. "Execute BODY with point at location given by `org-hd-marker' property.
  1755. If STRING is non-nil, the text property will be fetched from position 0
  1756. in that string. If STRING is nil, it will be fetched from the beginning
  1757. of the current line."
  1758. (org-with-gensyms (marker)
  1759. `(let ((,marker (get-text-property (if ,string 0 (point-at-bol))
  1760. 'org-hd-marker ,string)))
  1761. (with-current-buffer (marker-buffer ,marker)
  1762. (save-excursion
  1763. (goto-char ,marker)
  1764. ,@body)))))
  1765. (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
  1766. (defun org-add-agenda-custom-command (entry)
  1767. "Replace or add a command in `org-agenda-custom-commands'.
  1768. This is mostly for hacking and trying a new command - once the command
  1769. works you probably want to add it to `org-agenda-custom-commands' for good."
  1770. (let ((ass (assoc (car entry) org-agenda-custom-commands)))
  1771. (if ass
  1772. (setcdr ass (cdr entry))
  1773. (push entry org-agenda-custom-commands))))
  1774. ;;; Define the org-agenda-mode
  1775. (defvar org-agenda-mode-map (make-sparse-keymap)
  1776. "Keymap for `org-agenda-mode'.")
  1777. (defvaralias 'org-agenda-keymap 'org-agenda-mode-map)
  1778. (defvar org-agenda-menu) ; defined later in this file.
  1779. (defvar org-agenda-restrict nil) ; defined later in this file.
  1780. (defvar org-agenda-follow-mode nil)
  1781. (defvar org-agenda-entry-text-mode nil)
  1782. (defvar org-agenda-clockreport-mode nil)
  1783. (defvar org-agenda-show-log nil)
  1784. (defvar org-agenda-redo-command nil)
  1785. (defvar org-agenda-query-string nil)
  1786. (defvar org-agenda-mode-hook nil
  1787. "Hook run after `org-agenda-mode' is turned on.
  1788. The buffer is still writable when this hook is called.")
  1789. (defvar org-agenda-type nil)
  1790. (defvar org-agenda-force-single-file nil)
  1791. (defvar org-agenda-bulk-marked-entries nil
  1792. "List of markers that refer to marked entries in the agenda.")
  1793. (defvar org-agenda-current-date nil
  1794. "Active date when building the agenda.")
  1795. ;;; Multiple agenda buffers support
  1796. (defcustom org-agenda-sticky nil
  1797. "Non-nil means agenda q key will bury agenda buffers.
  1798. Agenda commands will then show existing buffer instead of generating new ones.
  1799. When nil, `q' will kill the single agenda buffer."
  1800. :group 'org-agenda
  1801. :version "24.3"
  1802. :type 'boolean)
  1803. ;;;###autoload
  1804. (defun org-toggle-sticky-agenda (&optional arg)
  1805. "Toggle `org-agenda-sticky'."
  1806. (interactive "P")
  1807. (let ((new-value (if arg
  1808. (> (prefix-numeric-value arg) 0)
  1809. (not org-agenda-sticky))))
  1810. (if (equal new-value org-agenda-sticky)
  1811. (and (called-interactively-p 'interactive)
  1812. (message "Sticky agenda was already %s"
  1813. (if org-agenda-sticky "enabled" "disabled")))
  1814. (setq org-agenda-sticky new-value)
  1815. (org-agenda-kill-all-agenda-buffers)
  1816. (and (called-interactively-p 'interactive)
  1817. (message "Sticky agenda %s"
  1818. (if org-agenda-sticky "enabled" "disabled"))))))
  1819. (defvar org-agenda-buffer nil
  1820. "Agenda buffer currently being generated.")
  1821. (defvar org-agenda-last-prefix-arg nil)
  1822. (defvar org-agenda-this-buffer-name nil)
  1823. (defvar org-agenda-doing-sticky-redo nil)
  1824. (defvar org-agenda-this-buffer-is-sticky nil)
  1825. (defvar org-agenda-last-indirect-buffer nil
  1826. "Last buffer loaded by `org-agenda-tree-to-indirect-buffer'.")
  1827. (defconst org-agenda-local-vars
  1828. '(org-agenda-this-buffer-name
  1829. org-agenda-undo-list
  1830. org-agenda-pending-undo-list
  1831. org-agenda-follow-mode
  1832. org-agenda-entry-text-mode
  1833. org-agenda-clockreport-mode
  1834. org-agenda-show-log
  1835. org-agenda-redo-command
  1836. org-agenda-query-string
  1837. org-agenda-type
  1838. org-agenda-bulk-marked-entries
  1839. org-agenda-undo-has-started-in
  1840. org-agenda-info
  1841. org-agenda-pre-window-conf
  1842. org-agenda-columns-active
  1843. org-agenda-tag-filter
  1844. org-agenda-category-filter
  1845. org-agenda-top-headline-filter
  1846. org-agenda-regexp-filter
  1847. org-agenda-effort-filter
  1848. org-agenda-markers
  1849. org-agenda-last-search-view-search-was-boolean
  1850. org-agenda-last-indirect-buffer
  1851. org-agenda-filtered-by-category
  1852. org-agenda-filter-form
  1853. org-agenda-cycle-counter
  1854. org-agenda-last-prefix-arg)
  1855. "Variables that must be local in agenda buffers to allow multiple buffers.")
  1856. (defun org-agenda-mode ()
  1857. "Mode for time-sorted view on action items in Org-mode files.
  1858. The following commands are available:
  1859. \\{org-agenda-mode-map}"
  1860. (interactive)
  1861. (cond (org-agenda-doing-sticky-redo
  1862. ;; Refreshing sticky agenda-buffer
  1863. ;;
  1864. ;; Preserve the value of `org-agenda-local-vars' variables,
  1865. ;; while letting `kill-all-local-variables' kill the rest
  1866. (let ((save (buffer-local-variables)))
  1867. (kill-all-local-variables)
  1868. (mapc 'make-local-variable org-agenda-local-vars)
  1869. (dolist (elem save)
  1870. (let ((var (car elem))
  1871. (val (cdr elem)))
  1872. (when (and val
  1873. (member var org-agenda-local-vars))
  1874. (set var val)))))
  1875. (setq-local org-agenda-this-buffer-is-sticky t))
  1876. (org-agenda-sticky
  1877. ;; Creating a sticky Agenda buffer for the first time
  1878. (kill-all-local-variables)
  1879. (mapc 'make-local-variable org-agenda-local-vars)
  1880. (setq-local org-agenda-this-buffer-is-sticky t))
  1881. (t
  1882. ;; Creating a non-sticky agenda buffer
  1883. (kill-all-local-variables)
  1884. (setq-local org-agenda-this-buffer-is-sticky nil)))
  1885. (setq org-agenda-undo-list nil
  1886. org-agenda-pending-undo-list nil
  1887. org-agenda-bulk-marked-entries nil)
  1888. (setq major-mode 'org-agenda-mode)
  1889. ;; Keep global-font-lock-mode from turning on font-lock-mode
  1890. (setq-local font-lock-global-modes (list 'not major-mode))
  1891. (setq mode-name "Org-Agenda")
  1892. (setq indent-tabs-mode nil)
  1893. (use-local-map org-agenda-mode-map)
  1894. (easy-menu-add org-agenda-menu)
  1895. (if org-startup-truncated (setq truncate-lines t))
  1896. (setq-local line-move-visual nil)
  1897. (add-hook 'post-command-hook 'org-agenda-update-agenda-type nil 'local)
  1898. (add-hook 'pre-command-hook 'org-unhighlight nil 'local)
  1899. ;; Make sure properties are removed when copying text
  1900. (add-hook 'filter-buffer-substring-functions
  1901. (lambda (fun start end delete)
  1902. (substring-no-properties (funcall fun start end delete)))
  1903. nil t)
  1904. (unless org-agenda-keep-modes
  1905. (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
  1906. org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode))
  1907. (setq org-agenda-show-log org-agenda-start-with-log-mode)
  1908. (setq org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode)
  1909. (add-to-invisibility-spec '(org-filtered))
  1910. (add-to-invisibility-spec '(org-link))
  1911. (easy-menu-change
  1912. '("Agenda") "Agenda Files"
  1913. (append
  1914. (list
  1915. (vector
  1916. (if (get 'org-agenda-files 'org-restrict)
  1917. "Restricted to single file"
  1918. "Edit File List")
  1919. '(org-edit-agenda-file-list)
  1920. (not (get 'org-agenda-files 'org-restrict)))
  1921. "--")
  1922. (mapcar 'org-file-menu-entry (org-agenda-files))))
  1923. (org-agenda-set-mode-name)
  1924. (apply
  1925. (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
  1926. (list 'org-agenda-mode-hook)))
  1927. (substitute-key-definition 'undo 'org-agenda-undo
  1928. org-agenda-mode-map global-map)
  1929. (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
  1930. (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
  1931. (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
  1932. (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
  1933. (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
  1934. (org-defkey org-agenda-mode-map [(meta down)] 'org-agenda-drag-line-forward)
  1935. (org-defkey org-agenda-mode-map [(meta up)] 'org-agenda-drag-line-backward)
  1936. (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
  1937. (org-defkey org-agenda-mode-map "\M-m" 'org-agenda-bulk-toggle)
  1938. (org-defkey org-agenda-mode-map "*" 'org-agenda-bulk-mark-all)
  1939. (org-defkey org-agenda-mode-map "\M-*" 'org-agenda-bulk-toggle-all)
  1940. (org-defkey org-agenda-mode-map "#" 'org-agenda-dim-blocked-tasks)
  1941. (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
  1942. (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
  1943. (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-unmark-all)
  1944. (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
  1945. (org-defkey org-agenda-mode-map "k" 'org-agenda-capture)
  1946. (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
  1947. (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
  1948. (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
  1949. (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
  1950. (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
  1951. (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
  1952. (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
  1953. (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
  1954. (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
  1955. (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
  1956. (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
  1957. (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
  1958. (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
  1959. (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
  1960. (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
  1961. (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
  1962. (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
  1963. (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
  1964. (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
  1965. (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
  1966. (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
  1967. (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
  1968. (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
  1969. (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
  1970. (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
  1971. (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
  1972. (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
  1973. (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
  1974. (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
  1975. (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
  1976. (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
  1977. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
  1978. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
  1979. (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
  1980. (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
  1981. (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
  1982. (let ((l '(1 2 3 4 5 6 7 8 9 0)))
  1983. (while l (org-defkey org-agenda-mode-map
  1984. (int-to-string (pop l)) 'digit-argument)))
  1985. (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
  1986. (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
  1987. (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
  1988. (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
  1989. (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
  1990. (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
  1991. (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
  1992. (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
  1993. (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
  1994. (org-defkey org-agenda-mode-map "g" (lambda () (interactive) (org-agenda-redo t)))
  1995. (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
  1996. (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
  1997. (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
  1998. 'org-clock-modify-effort-estimate)
  1999. (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
  2000. (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
  2001. (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
  2002. (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
  2003. (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
  2004. (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
  2005. (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
  2006. (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
  2007. (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
  2008. (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
  2009. (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
  2010. (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
  2011. (substitute-key-definition 'next-line 'org-agenda-next-line
  2012. org-agenda-mode-map global-map)
  2013. (substitute-key-definition 'previous-line 'org-agenda-previous-line
  2014. org-agenda-mode-map global-map)
  2015. (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
  2016. (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
  2017. (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
  2018. (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
  2019. (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
  2020. (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
  2021. (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
  2022. (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
  2023. (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
  2024. (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
  2025. (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
  2026. (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
  2027. (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
  2028. (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
  2029. (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
  2030. (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
  2031. (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
  2032. (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
  2033. (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  2034. (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
  2035. (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
  2036. (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
  2037. (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
  2038. (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
  2039. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
  2040. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
  2041. (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
  2042. (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
  2043. (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
  2044. (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  2045. (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
  2046. (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
  2047. (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
  2048. (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
  2049. (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
  2050. (org-defkey org-agenda-mode-map "_" 'org-agenda-filter-by-effort)
  2051. (org-defkey org-agenda-mode-map "=" 'org-agenda-filter-by-regexp)
  2052. (org-defkey org-agenda-mode-map "|" 'org-agenda-filter-remove-all)
  2053. (org-defkey org-agenda-mode-map "~" 'org-agenda-limit-interactively)
  2054. (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
  2055. (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-headline)
  2056. (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
  2057. (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
  2058. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  2059. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  2060. (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
  2061. (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
  2062. (define-key org-agenda-mode-map [remap forward-paragraph] 'org-agenda-forward-block)
  2063. (define-key org-agenda-mode-map [remap backward-paragraph] 'org-agenda-backward-block)
  2064. (when org-agenda-mouse-1-follows-link
  2065. (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
  2066. (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
  2067. '("Agenda"
  2068. ("Agenda Files")
  2069. "--"
  2070. ("Agenda Dates"
  2071. ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
  2072. ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
  2073. ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
  2074. ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
  2075. "--"
  2076. ("View"
  2077. ["Day View" org-agenda-day-view
  2078. :active (org-agenda-check-type nil 'agenda)
  2079. :style radio :selected (eq org-agenda-current-span 'day)
  2080. :keys "v d (or just d)"]
  2081. ["Week View" org-agenda-week-view
  2082. :active (org-agenda-check-type nil 'agenda)
  2083. :style radio :selected (eq org-agenda-current-span 'week)
  2084. :keys "v w"]
  2085. ["Fortnight View" org-agenda-fortnight-view
  2086. :active (org-agenda-check-type nil 'agenda)
  2087. :style radio :selected (eq org-agenda-current-span 'fortnight)
  2088. :keys "v f"]
  2089. ["Month View" org-agenda-month-view
  2090. :active (org-agenda-check-type nil 'agenda)
  2091. :style radio :selected (eq org-agenda-current-span 'month)
  2092. :keys "v m"]
  2093. ["Year View" org-agenda-year-view
  2094. :active (org-agenda-check-type nil 'agenda)
  2095. :style radio :selected (eq org-agenda-current-span 'year)
  2096. :keys "v y"]
  2097. "--"
  2098. ["Include Diary" org-agenda-toggle-diary
  2099. :style toggle :selected org-agenda-include-diary
  2100. :active (org-agenda-check-type nil 'agenda)]
  2101. ["Include Deadlines" org-agenda-toggle-deadlines
  2102. :style toggle :selected org-agenda-include-deadlines
  2103. :active (org-agenda-check-type nil 'agenda)]
  2104. ["Use Time Grid" org-agenda-toggle-time-grid
  2105. :style toggle :selected org-agenda-use-time-grid
  2106. :active (org-agenda-check-type nil 'agenda)]
  2107. "--"
  2108. ["Show clock report" org-agenda-clockreport-mode
  2109. :style toggle :selected org-agenda-clockreport-mode
  2110. :active (org-agenda-check-type nil 'agenda)]
  2111. ["Show some entry text" org-agenda-entry-text-mode
  2112. :style toggle :selected org-agenda-entry-text-mode
  2113. :active t]
  2114. "--"
  2115. ["Show Logbook entries" org-agenda-log-mode
  2116. :style toggle :selected org-agenda-show-log
  2117. :active (org-agenda-check-type nil 'agenda 'timeline)
  2118. :keys "v l (or just l)"]
  2119. ["Include archived trees" org-agenda-archives-mode
  2120. :style toggle :selected org-agenda-archives-mode :active t
  2121. :keys "v a"]
  2122. ["Include archive files" (org-agenda-archives-mode t)
  2123. :style toggle :selected (eq org-agenda-archives-mode t) :active t
  2124. :keys "v A"]
  2125. "--"
  2126. ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
  2127. ["Write view to file" org-agenda-write t]
  2128. ["Rebuild buffer" org-agenda-redo t]
  2129. ["Save all Org-mode Buffers" org-save-all-org-buffers t]
  2130. "--"
  2131. ["Show original entry" org-agenda-show t]
  2132. ["Go To (other window)" org-agenda-goto t]
  2133. ["Go To (this window)" org-agenda-switch-to t]
  2134. ["Capture with cursor date" org-agenda-capture t]
  2135. ["Follow Mode" org-agenda-follow-mode
  2136. :style toggle :selected org-agenda-follow-mode :active t]
  2137. ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
  2138. "--"
  2139. ("TODO"
  2140. ["Cycle TODO" org-agenda-todo t]
  2141. ["Next TODO set" org-agenda-todo-nextset t]
  2142. ["Previous TODO set" org-agenda-todo-previousset t]
  2143. ["Add note" org-agenda-add-note t])
  2144. ("Archive/Refile/Delete"
  2145. ["Archive default" org-agenda-archive-default t]
  2146. ["Archive default" org-agenda-archive-default-with-confirmation t]
  2147. ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
  2148. ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
  2149. ["Archive subtree" org-agenda-archive t]
  2150. "--"
  2151. ["Refile" org-agenda-refile t]
  2152. "--"
  2153. ["Delete subtree" org-agenda-kill t])
  2154. ("Bulk action"
  2155. ["Mark entry" org-agenda-bulk-mark t]
  2156. ["Mark all" org-agenda-bulk-mark-all t]
  2157. ["Unmark entry" org-agenda-bulk-unmark t]
  2158. ["Unmark all" org-agenda-bulk-unmark-all :active t :keys "U"]
  2159. ["Toggle mark" org-agenda-bulk-toggle t]
  2160. ["Toggle all" org-agenda-bulk-toggle-all t]
  2161. ["Mark regexp" org-agenda-bulk-mark-regexp t])
  2162. ["Act on all marked" org-agenda-bulk-action t]
  2163. "--"
  2164. ("Tags and Properties"
  2165. ["Show all Tags" org-agenda-show-tags t]
  2166. ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
  2167. ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
  2168. "--"
  2169. ["Column View" org-columns t])
  2170. ("Deadline/Schedule"
  2171. ["Schedule" org-agenda-schedule t]
  2172. ["Set Deadline" org-agenda-deadline t]
  2173. "--"
  2174. ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
  2175. ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
  2176. ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
  2177. ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
  2178. ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
  2179. ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
  2180. ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
  2181. ("Clock and Effort"
  2182. ["Clock in" org-agenda-clock-in t]
  2183. ["Clock out" org-agenda-clock-out t]
  2184. ["Clock cancel" org-agenda-clock-cancel t]
  2185. ["Goto running clock" org-clock-goto t]
  2186. "--"
  2187. ["Set Effort" org-agenda-set-effort t]
  2188. ["Change clocked effort" org-clock-modify-effort-estimate
  2189. (org-clock-is-active)])
  2190. ("Priority"
  2191. ["Set Priority" org-agenda-priority t]
  2192. ["Increase Priority" org-agenda-priority-up t]
  2193. ["Decrease Priority" org-agenda-priority-down t]
  2194. ["Show Priority" org-show-priority t])
  2195. ("Calendar/Diary"
  2196. ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
  2197. ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
  2198. ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
  2199. ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
  2200. ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
  2201. ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
  2202. "--"
  2203. ["Create iCalendar File" org-icalendar-combine-agenda-files t])
  2204. "--"
  2205. ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
  2206. "--"
  2207. ("MobileOrg"
  2208. ["Push Files and Views" org-mobile-push t]
  2209. ["Get Captured and Flagged" org-mobile-pull t]
  2210. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
  2211. ["Show note / unflag" org-agenda-show-the-flagging-note t]
  2212. "--"
  2213. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  2214. "--"
  2215. ["Quit" org-agenda-quit t]
  2216. ["Exit and Release Buffers" org-agenda-exit t]
  2217. ))
  2218. ;;; Agenda undo
  2219. (defvar org-agenda-allow-remote-undo t
  2220. "Non-nil means allow remote undo from the agenda buffer.")
  2221. (defvar org-agenda-undo-has-started-in nil
  2222. "Buffers that have already seen `undo-start' in the current undo sequence.")
  2223. (defun org-agenda-undo ()
  2224. "Undo a remote editing step in the agenda.
  2225. This undoes changes both in the agenda buffer and in the remote buffer
  2226. that have been changed along."
  2227. (interactive)
  2228. (or org-agenda-allow-remote-undo
  2229. (user-error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
  2230. (if (not (eq this-command last-command))
  2231. (setq org-agenda-undo-has-started-in nil
  2232. org-agenda-pending-undo-list org-agenda-undo-list))
  2233. (if (not org-agenda-pending-undo-list)
  2234. (user-error "No further undo information"))
  2235. (let* ((entry (pop org-agenda-pending-undo-list))
  2236. buf line cmd rembuf)
  2237. (setq cmd (pop entry) line (pop entry))
  2238. (setq rembuf (nth 2 entry))
  2239. (org-with-remote-undo rembuf
  2240. (while (bufferp (setq buf (pop entry)))
  2241. (if (pop entry)
  2242. (with-current-buffer buf
  2243. (let ((last-undo-buffer buf)
  2244. (inhibit-read-only t))
  2245. (unless (memq buf org-agenda-undo-has-started-in)
  2246. (push buf org-agenda-undo-has-started-in)
  2247. (make-local-variable 'pending-undo-list)
  2248. (undo-start))
  2249. (while (and pending-undo-list
  2250. (listp pending-undo-list)
  2251. (not (car pending-undo-list)))
  2252. (pop pending-undo-list))
  2253. (undo-more 1))))))
  2254. (org-goto-line line)
  2255. (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
  2256. (defun org-verify-change-for-undo (l1 l2)
  2257. "Verify that a real change occurred between the undo lists L1 and L2."
  2258. (while (and l1 (listp l1) (null (car l1))) (pop l1))
  2259. (while (and l2 (listp l2) (null (car l2))) (pop l2))
  2260. (not (eq l1 l2)))
  2261. ;;; Agenda dispatch
  2262. (defvar org-agenda-restrict-begin (make-marker))
  2263. (defvar org-agenda-restrict-end (make-marker))
  2264. (defvar org-agenda-last-dispatch-buffer nil)
  2265. (defvar org-agenda-overriding-restriction nil)
  2266. (defcustom org-agenda-custom-commands-contexts nil
  2267. "Alist of custom agenda keys and contextual rules.
  2268. For example, if you have a custom agenda command \"p\" and you
  2269. want this command to be accessible only from plain text files,
  2270. use this:
  2271. \\='((\"p\" ((in-file . \"\\\\.txt\\\\'\"))))
  2272. Here are the available contexts definitions:
  2273. in-file: command displayed only in matching files
  2274. in-mode: command displayed only in matching modes
  2275. not-in-file: command not displayed in matching files
  2276. not-in-mode: command not displayed in matching modes
  2277. in-buffer: command displayed only in matching buffers
  2278. not-in-buffer: command not displayed in matching buffers
  2279. [function]: a custom function taking no argument
  2280. If you define several checks, the agenda command will be
  2281. accessible if there is at least one valid check.
  2282. You can also bind a key to another agenda custom command
  2283. depending on contextual rules.
  2284. \\='((\"p\" \"q\" ((in-file . \"\\\\.txt\\\\'\"))))
  2285. Here it means: in .txt files, use \"p\" as the key for the
  2286. agenda command otherwise associated with \"q\". (The command
  2287. originally associated with \"q\" is not displayed to avoid
  2288. duplicates.)"
  2289. :version "24.3"
  2290. :group 'org-agenda-custom-commands
  2291. :type '(repeat (list :tag "Rule"
  2292. (string :tag " Agenda key")
  2293. (string :tag "Replace by command")
  2294. (repeat :tag "Available when"
  2295. (choice
  2296. (cons :tag "Condition"
  2297. (choice
  2298. (const :tag "In file" in-file)
  2299. (const :tag "Not in file" not-in-file)
  2300. (const :tag "In buffer" in-buffer)
  2301. (const :tag "Not in buffer" not-in-buffer)
  2302. (const :tag "In mode" in-mode)
  2303. (const :tag "Not in mode" not-in-mode))
  2304. (regexp))
  2305. (function :tag "Custom function"))))))
  2306. (defcustom org-agenda-max-entries nil
  2307. "Maximum number of entries to display in an agenda.
  2308. This can be nil (no limit) or an integer or an alist of agenda
  2309. types with an associated number of entries to display in this
  2310. type."
  2311. :version "24.4"
  2312. :package-version '(Org . "8.0")
  2313. :group 'org-agenda-custom-commands
  2314. :type '(choice (symbol :tag "No limit" nil)
  2315. (integer :tag "Max number of entries")
  2316. (repeat
  2317. (cons (choice :tag "Agenda type"
  2318. (const agenda)
  2319. (const todo)
  2320. (const tags)
  2321. (const search)
  2322. (const timeline))
  2323. (integer :tag "Max number of entries")))))
  2324. (defcustom org-agenda-max-todos nil
  2325. "Maximum number of TODOs to display in an agenda.
  2326. This can be nil (no limit) or an integer or an alist of agenda
  2327. types with an associated number of entries to display in this
  2328. type."
  2329. :version "24.4"
  2330. :package-version '(Org . "8.0")
  2331. :group 'org-agenda-custom-commands
  2332. :type '(choice (symbol :tag "No limit" nil)
  2333. (integer :tag "Max number of TODOs")
  2334. (repeat
  2335. (cons (choice :tag "Agenda type"
  2336. (const agenda)
  2337. (const todo)
  2338. (const tags)
  2339. (const search)
  2340. (const timeline))
  2341. (integer :tag "Max number of TODOs")))))
  2342. (defcustom org-agenda-max-tags nil
  2343. "Maximum number of tagged entries to display in an agenda.
  2344. This can be nil (no limit) or an integer or an alist of agenda
  2345. types with an associated number of entries to display in this
  2346. type."
  2347. :version "24.4"
  2348. :package-version '(Org . "8.0")
  2349. :group 'org-agenda-custom-commands
  2350. :type '(choice (symbol :tag "No limit" nil)
  2351. (integer :tag "Max number of tagged entries")
  2352. (repeat
  2353. (cons (choice :tag "Agenda type"
  2354. (const agenda)
  2355. (const todo)
  2356. (const tags)
  2357. (const search)
  2358. (const timeline))
  2359. (integer :tag "Max number of tagged entries")))))
  2360. (defcustom org-agenda-max-effort nil
  2361. "Maximum cumulated effort duration for the agenda.
  2362. This can be nil (no limit) or a number of minutes (as an integer)
  2363. or an alist of agenda types with an associated number of minutes
  2364. to limit entries to in this type."
  2365. :version "24.4"
  2366. :package-version '(Org . "8.0")
  2367. :group 'org-agenda-custom-commands
  2368. :type '(choice (symbol :tag "No limit" nil)
  2369. (integer :tag "Max number of minutes")
  2370. (repeat
  2371. (cons (choice :tag "Agenda type"
  2372. (const agenda)
  2373. (const todo)
  2374. (const tags)
  2375. (const search)
  2376. (const timeline))
  2377. (integer :tag "Max number of minutes")))))
  2378. (defvar org-agenda-keep-restricted-file-list nil)
  2379. (defvar org-keys nil)
  2380. (defvar org-match nil)
  2381. ;;;###autoload
  2382. (defun org-agenda (&optional arg org-keys restriction)
  2383. "Dispatch agenda commands to collect entries to the agenda buffer.
  2384. Prompts for a command to execute. Any prefix arg will be passed
  2385. on to the selected command. The default selections are:
  2386. a Call `org-agenda-list' to display the agenda for current day or week.
  2387. t Call `org-todo-list' to display the global todo list.
  2388. T Call `org-todo-list' to display the global todo list, select only
  2389. entries with a specific TODO keyword (the user gets a prompt).
  2390. m Call `org-tags-view' to display headlines with tags matching
  2391. a condition (the user is prompted for the condition).
  2392. M Like `m', but select only TODO entries, no ordinary headlines.
  2393. L Create a timeline for the current buffer.
  2394. e Export views to associated files.
  2395. s Search entries for keywords.
  2396. S Search entries for keywords, only with TODO keywords.
  2397. / Multi occur across all agenda files and also files listed
  2398. in `org-agenda-text-search-extra-files'.
  2399. < Restrict agenda commands to buffer, subtree, or region.
  2400. Press several times to get the desired effect.
  2401. > Remove a previous restriction.
  2402. # List \"stuck\" projects.
  2403. ! Configure what \"stuck\" means.
  2404. C Configure custom agenda commands.
  2405. More commands can be added by configuring the variable
  2406. `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
  2407. searches can be pre-defined in this way.
  2408. If the current buffer is in Org-mode and visiting a file, you can also
  2409. first press `<' once to indicate that the agenda should be temporarily
  2410. \(until the next use of \\[org-agenda]) restricted to the current file.
  2411. Pressing `<' twice means to restrict to the current subtree or region
  2412. \(if active)."
  2413. (interactive "P")
  2414. (catch 'exit
  2415. (let* ((prefix-descriptions nil)
  2416. (org-agenda-buffer-name org-agenda-buffer-name)
  2417. (org-agenda-window-setup (if (equal (buffer-name)
  2418. org-agenda-buffer-name)
  2419. 'current-window
  2420. org-agenda-window-setup))
  2421. (org-agenda-custom-commands-orig org-agenda-custom-commands)
  2422. (org-agenda-custom-commands
  2423. ;; normalize different versions
  2424. (delq nil
  2425. (mapcar
  2426. (lambda (x)
  2427. (cond ((stringp (cdr x))
  2428. (push x prefix-descriptions)
  2429. nil)
  2430. ((stringp (nth 1 x)) x)
  2431. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2432. (t (cons (car x) (cons "" (cdr x))))))
  2433. org-agenda-custom-commands)))
  2434. (org-agenda-custom-commands
  2435. (org-contextualize-keys
  2436. org-agenda-custom-commands org-agenda-custom-commands-contexts))
  2437. (buf (current-buffer))
  2438. (bfn (buffer-file-name (buffer-base-buffer)))
  2439. entry key type org-match lprops ans)
  2440. ;; Turn off restriction unless there is an overriding one,
  2441. (unless org-agenda-overriding-restriction
  2442. (unless org-agenda-keep-restricted-file-list
  2443. ;; There is a request to keep the file list in place
  2444. (put 'org-agenda-files 'org-restrict nil))
  2445. (setq org-agenda-restrict nil)
  2446. (move-marker org-agenda-restrict-begin nil)
  2447. (move-marker org-agenda-restrict-end nil))
  2448. ;; Delete old local properties
  2449. (put 'org-agenda-redo-command 'org-lprops nil)
  2450. ;; Delete previously set last-arguments
  2451. (put 'org-agenda-redo-command 'last-args nil)
  2452. ;; Remember where this call originated
  2453. (setq org-agenda-last-dispatch-buffer (current-buffer))
  2454. (unless org-keys
  2455. (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
  2456. org-keys (car ans)
  2457. restriction (cdr ans)))
  2458. ;; If we have sticky agenda buffers, set a name for the buffer,
  2459. ;; depending on the invoking keys. The user may still set this
  2460. ;; as a command option, which will overwrite what we do here.
  2461. (if org-agenda-sticky
  2462. (setq org-agenda-buffer-name
  2463. (format "*Org Agenda(%s)*" org-keys)))
  2464. ;; Establish the restriction, if any
  2465. (when (and (not org-agenda-overriding-restriction) restriction)
  2466. (put 'org-agenda-files 'org-restrict (list bfn))
  2467. (cond
  2468. ((eq restriction 'region)
  2469. (setq org-agenda-restrict (current-buffer))
  2470. (move-marker org-agenda-restrict-begin (region-beginning))
  2471. (move-marker org-agenda-restrict-end (region-end)))
  2472. ((eq restriction 'subtree)
  2473. (save-excursion
  2474. (setq org-agenda-restrict (current-buffer))
  2475. (org-back-to-heading t)
  2476. (move-marker org-agenda-restrict-begin (point))
  2477. (move-marker org-agenda-restrict-end
  2478. (progn (org-end-of-subtree t)))))))
  2479. ;; For example the todo list should not need it (but does...)
  2480. (cond
  2481. ((setq entry (assoc org-keys org-agenda-custom-commands))
  2482. (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
  2483. (progn
  2484. (setq type (nth 2 entry) org-match (eval (nth 3 entry))
  2485. lprops (nth 4 entry))
  2486. (if org-agenda-sticky
  2487. (setq org-agenda-buffer-name
  2488. (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
  2489. (format "*Org Agenda(%s)*" org-keys))))
  2490. (put 'org-agenda-redo-command 'org-lprops lprops)
  2491. (cond
  2492. ((eq type 'agenda)
  2493. (org-let lprops '(org-agenda-list current-prefix-arg)))
  2494. ((eq type 'agenda*)
  2495. (org-let lprops '(org-agenda-list current-prefix-arg nil nil t)))
  2496. ((eq type 'alltodo)
  2497. (org-let lprops '(org-todo-list current-prefix-arg)))
  2498. ((eq type 'search)
  2499. (org-let lprops '(org-search-view current-prefix-arg org-match nil)))
  2500. ((eq type 'stuck)
  2501. (org-let lprops '(org-agenda-list-stuck-projects
  2502. current-prefix-arg)))
  2503. ((eq type 'tags)
  2504. (org-let lprops '(org-tags-view current-prefix-arg org-match)))
  2505. ((eq type 'tags-todo)
  2506. (org-let lprops '(org-tags-view '(4) org-match)))
  2507. ((eq type 'todo)
  2508. (org-let lprops '(org-todo-list org-match)))
  2509. ((eq type 'tags-tree)
  2510. (org-check-for-org-mode)
  2511. (org-let lprops '(org-match-sparse-tree current-prefix-arg org-match)))
  2512. ((eq type 'todo-tree)
  2513. (org-check-for-org-mode)
  2514. (org-let lprops
  2515. '(org-occur (concat "^" org-outline-regexp "[ \t]*"
  2516. (regexp-quote org-match) "\\>"))))
  2517. ((eq type 'occur-tree)
  2518. (org-check-for-org-mode)
  2519. (org-let lprops '(org-occur org-match)))
  2520. ((functionp type)
  2521. (org-let lprops '(funcall type org-match)))
  2522. ((fboundp type)
  2523. (org-let lprops '(funcall type org-match)))
  2524. (t (user-error "Invalid custom agenda command type %s" type))))
  2525. (org-agenda-run-series (nth 1 entry) (cddr entry))))
  2526. ((equal org-keys "C")
  2527. (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
  2528. (customize-variable 'org-agenda-custom-commands))
  2529. ((equal org-keys "a") (call-interactively 'org-agenda-list))
  2530. ((equal org-keys "s") (call-interactively 'org-search-view))
  2531. ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
  2532. ((equal org-keys "t") (call-interactively 'org-todo-list))
  2533. ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
  2534. ((equal org-keys "m") (call-interactively 'org-tags-view))
  2535. ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
  2536. ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
  2537. ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
  2538. (add-hook
  2539. 'post-command-hook
  2540. (lambda ()
  2541. (unless (current-message)
  2542. (let* ((m (org-agenda-get-any-marker))
  2543. (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
  2544. (when note
  2545. (message (concat
  2546. "FLAGGING-NOTE ([?] for more info): "
  2547. (org-add-props
  2548. (replace-regexp-in-string
  2549. "\\\\n" "//"
  2550. (copy-sequence note))
  2551. nil 'face 'org-warning)))))))
  2552. t t))
  2553. ((equal org-keys "L")
  2554. (unless (derived-mode-p 'org-mode)
  2555. (user-error "This is not an Org-mode file"))
  2556. (unless restriction
  2557. (put 'org-agenda-files 'org-restrict (list bfn))
  2558. (org-call-with-arg 'org-timeline arg)))
  2559. ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
  2560. ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
  2561. ((equal org-keys "!") (customize-variable 'org-stuck-projects))
  2562. (t (user-error "Invalid agenda key"))))))
  2563. (defvar org-agenda-multi)
  2564. (defun org-agenda-append-agenda ()
  2565. "Append another agenda view to the current one.
  2566. This function allows interactive building of block agendas.
  2567. Agenda views are separated by `org-agenda-block-separator'."
  2568. (interactive)
  2569. (unless (derived-mode-p 'org-agenda-mode)
  2570. (user-error "Can only append from within agenda buffer"))
  2571. (let ((org-agenda-multi t))
  2572. (org-agenda)
  2573. (widen)
  2574. (org-agenda-finalize)
  2575. (setq buffer-read-only t)
  2576. (org-agenda-fit-window-to-buffer)))
  2577. (defun org-agenda-normalize-custom-commands (cmds)
  2578. "Normalize custom commands CMDS."
  2579. (delq nil
  2580. (mapcar
  2581. (lambda (x)
  2582. (cond ((stringp (cdr x)) nil)
  2583. ((stringp (nth 1 x)) x)
  2584. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2585. (t (cons (car x) (cons "" (cdr x))))))
  2586. cmds)))
  2587. (defun org-agenda-get-restriction-and-command (prefix-descriptions)
  2588. "The user interface for selecting an agenda command."
  2589. (catch 'exit
  2590. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  2591. (restrict-ok (and bfn (derived-mode-p 'org-mode)))
  2592. (region-p (org-region-active-p))
  2593. (custom org-agenda-custom-commands)
  2594. (selstring "")
  2595. restriction second-time
  2596. c entry key type match prefixes rmheader header-end custom1 desc
  2597. line lines left right n n1)
  2598. (save-window-excursion
  2599. (delete-other-windows)
  2600. (org-switch-to-buffer-other-window " *Agenda Commands*")
  2601. (erase-buffer)
  2602. (insert (eval-when-compile
  2603. (let ((header
  2604. "Press key for an agenda command: < Buffer, subtree/region restriction
  2605. -------------------------------- > Remove restriction
  2606. a Agenda for current week or day e Export agenda views
  2607. t List of all TODO entries T Entries with special TODO kwd
  2608. m Match a TAGS/PROP/TODO query M Like m, but only TODO entries
  2609. s Search for keywords S Like s, but only TODO entries
  2610. L Timeline for current buffer # List stuck projects (!=configure)
  2611. / Multi-occur C Configure custom agenda commands
  2612. ? Find :FLAGGED: entries * Toggle sticky agenda views
  2613. ")
  2614. (start 0))
  2615. (while (string-match
  2616. "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
  2617. header start)
  2618. (setq start (match-end 0))
  2619. (add-text-properties (match-beginning 2) (match-end 2)
  2620. '(face bold) header))
  2621. header)))
  2622. (setq header-end (point-marker))
  2623. (while t
  2624. (setq custom1 custom)
  2625. (when (eq rmheader t)
  2626. (org-goto-line 1)
  2627. (re-search-forward ":" nil t)
  2628. (delete-region (match-end 0) (point-at-eol))
  2629. (forward-char 1)
  2630. (looking-at "-+")
  2631. (delete-region (match-end 0) (point-at-eol))
  2632. (move-marker header-end (match-end 0)))
  2633. (goto-char header-end)
  2634. (delete-region (point) (point-max))
  2635. ;; Produce all the lines that describe custom commands and prefixes
  2636. (setq lines nil)
  2637. (while (setq entry (pop custom1))
  2638. (setq key (car entry) desc (nth 1 entry)
  2639. type (nth 2 entry)
  2640. match (nth 3 entry))
  2641. (if (> (length key) 1)
  2642. (add-to-list 'prefixes (string-to-char key))
  2643. (setq line
  2644. (format
  2645. "%-4s%-14s"
  2646. (org-add-props (copy-sequence key)
  2647. '(face bold))
  2648. (cond
  2649. ((string-match "\\S-" desc) desc)
  2650. ((eq type 'agenda) "Agenda for current week or day")
  2651. ((eq type 'agenda*) "Appointments for current week or day")
  2652. ((eq type 'alltodo) "List of all TODO entries")
  2653. ((eq type 'search) "Word search")
  2654. ((eq type 'stuck) "List of stuck projects")
  2655. ((eq type 'todo) "TODO keyword")
  2656. ((eq type 'tags) "Tags query")
  2657. ((eq type 'tags-todo) "Tags (TODO)")
  2658. ((eq type 'tags-tree) "Tags tree")
  2659. ((eq type 'todo-tree) "TODO kwd tree")
  2660. ((eq type 'occur-tree) "Occur tree")
  2661. ((functionp type) (if (symbolp type)
  2662. (symbol-name type)
  2663. "Lambda expression"))
  2664. (t "???"))))
  2665. (if org-agenda-menu-show-matcher
  2666. (setq line
  2667. (concat line ": "
  2668. (cond
  2669. ((stringp match)
  2670. (setq match (copy-sequence match))
  2671. (org-add-props match nil 'face 'org-warning))
  2672. ((listp type)
  2673. (format "set of %d commands" (length type))))))
  2674. (if (org-string-nw-p match)
  2675. (add-text-properties
  2676. 0 (length line) (list 'help-echo
  2677. (concat "Matcher: " match)) line)))
  2678. (push line lines)))
  2679. (setq lines (nreverse lines))
  2680. (when prefixes
  2681. (mapc (lambda (x)
  2682. (push
  2683. (format "%s %s"
  2684. (org-add-props (char-to-string x)
  2685. nil 'face 'bold)
  2686. (or (cdr (assoc (concat selstring
  2687. (char-to-string x))
  2688. prefix-descriptions))
  2689. "Prefix key"))
  2690. lines))
  2691. prefixes))
  2692. ;; Check if we should display in two columns
  2693. (if org-agenda-menu-two-columns
  2694. (progn
  2695. (setq n (length lines)
  2696. n1 (+ (/ n 2) (mod n 2))
  2697. right (nthcdr n1 lines)
  2698. left (copy-sequence lines))
  2699. (setcdr (nthcdr (1- n1) left) nil))
  2700. (setq left lines right nil))
  2701. (while left
  2702. (insert "\n" (pop left))
  2703. (when right
  2704. (if (< (current-column) 40)
  2705. (move-to-column 40 t)
  2706. (insert " "))
  2707. (insert (pop right))))
  2708. ;; Make the window the right size
  2709. (goto-char (point-min))
  2710. (if second-time
  2711. (if (not (pos-visible-in-window-p (point-max)))
  2712. (org-fit-window-to-buffer))
  2713. (setq second-time t)
  2714. (org-fit-window-to-buffer))
  2715. ;; Ask for selection
  2716. (message "Press key for agenda command%s:"
  2717. (if (or restrict-ok org-agenda-overriding-restriction)
  2718. (if org-agenda-overriding-restriction
  2719. " (restriction lock active)"
  2720. (if restriction
  2721. (format " (restricted to %s)" restriction)
  2722. " (unrestricted)"))
  2723. ""))
  2724. (setq c (read-char-exclusive))
  2725. (message "")
  2726. (cond
  2727. ((assoc (char-to-string c) custom)
  2728. (setq selstring (concat selstring (char-to-string c)))
  2729. (throw 'exit (cons selstring restriction)))
  2730. ((memq c prefixes)
  2731. (setq selstring (concat selstring (char-to-string c))
  2732. prefixes nil
  2733. rmheader (or rmheader t)
  2734. custom (delq nil (mapcar
  2735. (lambda (x)
  2736. (if (or (= (length (car x)) 1)
  2737. (/= (string-to-char (car x)) c))
  2738. nil
  2739. (cons (substring (car x) 1) (cdr x))))
  2740. custom))))
  2741. ((eq c ?*)
  2742. (call-interactively 'org-toggle-sticky-agenda)
  2743. (sit-for 2))
  2744. ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
  2745. (message "Restriction is only possible in Org-mode buffers")
  2746. (ding) (sit-for 1))
  2747. ((eq c ?1)
  2748. (org-agenda-remove-restriction-lock 'noupdate)
  2749. (setq restriction 'buffer))
  2750. ((eq c ?0)
  2751. (org-agenda-remove-restriction-lock 'noupdate)
  2752. (setq restriction (if region-p 'region 'subtree)))
  2753. ((eq c ?<)
  2754. (org-agenda-remove-restriction-lock 'noupdate)
  2755. (setq restriction
  2756. (cond
  2757. ((eq restriction 'buffer)
  2758. (if region-p 'region 'subtree))
  2759. ((memq restriction '(subtree region))
  2760. nil)
  2761. (t 'buffer))))
  2762. ((eq c ?>)
  2763. (org-agenda-remove-restriction-lock 'noupdate)
  2764. (setq restriction nil))
  2765. ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
  2766. (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
  2767. ((and (> (length selstring) 0) (eq c ?\d))
  2768. (delete-window)
  2769. (org-agenda-get-restriction-and-command prefix-descriptions))
  2770. ((equal c ?q) (error "Abort"))
  2771. (t (user-error "Invalid key %c" c))))))))
  2772. (defun org-agenda-fit-window-to-buffer ()
  2773. "Fit the window to the buffer size."
  2774. (and (memq org-agenda-window-setup '(reorganize-frame))
  2775. (fboundp 'fit-window-to-buffer)
  2776. (if (and (= (cdr org-agenda-window-frame-fractions) 1.0)
  2777. (= (car org-agenda-window-frame-fractions) 1.0))
  2778. (delete-other-windows)
  2779. (org-fit-window-to-buffer
  2780. nil
  2781. (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
  2782. (floor (* (frame-height) (car org-agenda-window-frame-fractions)))))))
  2783. (defvar org-cmd nil)
  2784. (defvar org-agenda-overriding-cmd nil)
  2785. (defvar org-agenda-overriding-arguments nil)
  2786. (defvar org-agenda-overriding-cmd-arguments nil)
  2787. (defun org-agenda-run-series (name series)
  2788. "Run agenda NAME as a SERIES of agenda commands."
  2789. (org-let (nth 1 series) '(org-agenda-prepare name))
  2790. ;; We need to reset agenda markers here, because when constructing a
  2791. ;; block agenda, the individual blocks do not do that.
  2792. (org-agenda-reset-markers)
  2793. (let* ((org-agenda-multi t)
  2794. (redo (list 'org-agenda-run-series name (list 'quote series)))
  2795. (cmds (car series))
  2796. (gprops (nth 1 series))
  2797. match ;; The byte compiler incorrectly complains about this. Keep it!
  2798. org-cmd type lprops)
  2799. (while (setq org-cmd (pop cmds))
  2800. (setq type (car org-cmd))
  2801. (setq match (eval (nth 1 org-cmd)))
  2802. (setq lprops (nth 2 org-cmd))
  2803. (let ((org-agenda-overriding-arguments
  2804. (if (eq org-agenda-overriding-cmd org-cmd)
  2805. (or org-agenda-overriding-arguments
  2806. org-agenda-overriding-cmd-arguments))))
  2807. (cond
  2808. ((eq type 'agenda)
  2809. (org-let2 gprops lprops
  2810. '(call-interactively 'org-agenda-list)))
  2811. ((eq type 'agenda*)
  2812. (org-let2 gprops lprops
  2813. '(funcall 'org-agenda-list nil nil t)))
  2814. ((eq type 'alltodo)
  2815. (org-let2 gprops lprops
  2816. '(call-interactively 'org-todo-list)))
  2817. ((eq type 'search)
  2818. (org-let2 gprops lprops
  2819. '(org-search-view current-prefix-arg match nil)))
  2820. ((eq type 'stuck)
  2821. (org-let2 gprops lprops
  2822. '(call-interactively 'org-agenda-list-stuck-projects)))
  2823. ((eq type 'tags)
  2824. (org-let2 gprops lprops
  2825. '(org-tags-view current-prefix-arg match)))
  2826. ((eq type 'tags-todo)
  2827. (org-let2 gprops lprops
  2828. '(org-tags-view '(4) match)))
  2829. ((eq type 'todo)
  2830. (org-let2 gprops lprops
  2831. '(org-todo-list match)))
  2832. ((fboundp type)
  2833. (org-let2 gprops lprops
  2834. '(funcall type match)))
  2835. (t (error "Invalid type in command series")))))
  2836. (widen)
  2837. (let ((inhibit-read-only t))
  2838. (add-text-properties (point-min) (point-max)
  2839. `(org-series t org-series-redo-cmd ,redo)))
  2840. (setq org-agenda-redo-command redo)
  2841. (goto-char (point-min)))
  2842. (org-agenda-fit-window-to-buffer)
  2843. (org-let (nth 1 series) '(org-agenda-finalize)))
  2844. ;;;###autoload
  2845. (defmacro org-batch-agenda (cmd-key &rest parameters)
  2846. "Run an agenda command in batch mode and send the result to STDOUT.
  2847. If CMD-KEY is a string of length 1, it is used as a key in
  2848. `org-agenda-custom-commands' and triggers this command. If it is a
  2849. longer string it is used as a tags/todo match string.
  2850. Parameters are alternating variable names and values that will be bound
  2851. before running the agenda command."
  2852. (org-eval-in-environment (org-make-parameter-alist parameters)
  2853. (let (org-agenda-sticky)
  2854. (if (> (length cmd-key) 1)
  2855. (org-tags-view nil cmd-key)
  2856. (org-agenda nil cmd-key))))
  2857. (set-buffer org-agenda-buffer-name)
  2858. (princ (buffer-string)))
  2859. (defvar org-agenda-info nil)
  2860. ;;;###autoload
  2861. (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
  2862. "Run an agenda command in batch mode and send the result to STDOUT.
  2863. If CMD-KEY is a string of length 1, it is used as a key in
  2864. `org-agenda-custom-commands' and triggers this command. If it is a
  2865. longer string it is used as a tags/todo match string.
  2866. Parameters are alternating variable names and values that will be bound
  2867. before running the agenda command.
  2868. The output gives a line for each selected agenda item. Each
  2869. item is a list of comma-separated values, like this:
  2870. category,head,type,todo,tags,date,time,extra,priority-l,priority-n
  2871. category The category of the item
  2872. head The headline, without TODO kwd, TAGS and PRIORITY
  2873. type The type of the agenda entry, can be
  2874. todo selected in TODO match
  2875. tagsmatch selected in tags match
  2876. diary imported from diary
  2877. deadline a deadline on given date
  2878. scheduled scheduled on given date
  2879. timestamp entry has timestamp on given date
  2880. closed entry was closed on given date
  2881. upcoming-deadline warning about deadline
  2882. past-scheduled forwarded scheduled item
  2883. block entry has date block including g. date
  2884. todo The todo keyword, if any
  2885. tags All tags including inherited ones, separated by colons
  2886. date The relevant date, like 2007-2-14
  2887. time The time, like 15:00-16:50
  2888. extra Sting with extra planning info
  2889. priority-l The priority letter if any was given
  2890. priority-n The computed numerical priority
  2891. agenda-day The day in the agenda where this is listed"
  2892. (org-eval-in-environment (append '((org-agenda-remove-tags t))
  2893. (org-make-parameter-alist parameters))
  2894. (if (> (length cmd-key) 2)
  2895. (org-tags-view nil cmd-key)
  2896. (org-agenda nil cmd-key)))
  2897. (set-buffer org-agenda-buffer-name)
  2898. (let* ((lines (org-split-string (buffer-string) "\n"))
  2899. line)
  2900. (while (setq line (pop lines))
  2901. (catch 'next
  2902. (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
  2903. (setq org-agenda-info
  2904. (org-fix-agenda-info (text-properties-at 0 line)))
  2905. (princ
  2906. (mapconcat 'org-agenda-export-csv-mapper
  2907. '(org-category txt type todo tags date time extra
  2908. priority-letter priority agenda-day)
  2909. ","))
  2910. (princ "\n")))))
  2911. (defun org-fix-agenda-info (props)
  2912. "Make sure all properties on an agenda item have a canonical form.
  2913. This ensures the export commands can easily use it."
  2914. (let (tmp re)
  2915. (when (setq tmp (plist-get props 'tags))
  2916. (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
  2917. (when (setq tmp (plist-get props 'date))
  2918. (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2919. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2920. '((format "%4d, %9s %2s, %4s" dayname monthname day year))
  2921. (setq tmp (calendar-date-string tmp)))
  2922. (setq props (plist-put props 'date tmp)))
  2923. (when (setq tmp (plist-get props 'day))
  2924. (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2925. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2926. (setq tmp (calendar-date-string tmp)))
  2927. (setq props (plist-put props 'day tmp))
  2928. (setq props (plist-put props 'agenda-day tmp)))
  2929. (when (setq tmp (plist-get props 'txt))
  2930. (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
  2931. (plist-put props 'priority-letter (match-string 1 tmp))
  2932. (setq tmp (replace-match "" t t tmp)))
  2933. (when (and (setq re (plist-get props 'org-todo-regexp))
  2934. (setq re (concat "\\`\\.*" re " ?"))
  2935. (string-match re tmp))
  2936. (plist-put props 'todo (match-string 1 tmp))
  2937. (setq tmp (replace-match "" t t tmp)))
  2938. (plist-put props 'txt tmp)))
  2939. props)
  2940. (defun org-agenda-export-csv-mapper (prop)
  2941. (let ((res (plist-get org-agenda-info prop)))
  2942. (setq res
  2943. (cond
  2944. ((not res) "")
  2945. ((stringp res) res)
  2946. (t (prin1-to-string res))))
  2947. (while (string-match "," res)
  2948. (setq res (replace-match ";" t t res)))
  2949. (org-trim res)))
  2950. ;;;###autoload
  2951. (defun org-store-agenda-views (&rest parameters)
  2952. "Store agenda views."
  2953. (interactive)
  2954. (eval (list 'org-batch-store-agenda-views)))
  2955. ;;;###autoload
  2956. (defmacro org-batch-store-agenda-views (&rest parameters)
  2957. "Run all custom agenda commands that have a file argument."
  2958. (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
  2959. (pop-up-frames nil)
  2960. (dir default-directory)
  2961. (pars (org-make-parameter-alist parameters))
  2962. cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
  2963. (save-window-excursion
  2964. (while cmds
  2965. (setq cmd (pop cmds)
  2966. thiscmdkey (car cmd)
  2967. thiscmdcmd (cdr cmd)
  2968. match (nth 2 thiscmdcmd)
  2969. bufname (if org-agenda-sticky
  2970. (or (and (stringp match)
  2971. (format "*Org Agenda(%s:%s)*" thiscmdkey match))
  2972. (format "*Org Agenda(%s)*" thiscmdkey))
  2973. org-agenda-buffer-name)
  2974. cmd-or-set (nth 2 cmd)
  2975. opts (nth (if (listp cmd-or-set) 3 4) cmd)
  2976. files (nth (if (listp cmd-or-set) 4 5) cmd))
  2977. (if (stringp files) (setq files (list files)))
  2978. (when files
  2979. (org-eval-in-environment (append org-agenda-exporter-settings
  2980. opts pars)
  2981. (org-agenda nil thiscmdkey))
  2982. (set-buffer bufname)
  2983. (while files
  2984. (org-eval-in-environment (append org-agenda-exporter-settings
  2985. opts pars)
  2986. (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
  2987. (and (get-buffer bufname)
  2988. (kill-buffer bufname)))))))
  2989. (defvar org-agenda-current-span nil
  2990. "The current span used in the agenda view.") ; local variable in the agenda buffer
  2991. (defun org-agenda-mark-header-line (pos)
  2992. "Mark the line at POS as an agenda structure header."
  2993. (save-excursion
  2994. (goto-char pos)
  2995. (put-text-property (point-at-bol) (point-at-eol)
  2996. 'org-agenda-structural-header t)
  2997. (when org-agenda-title-append
  2998. (put-text-property (point-at-bol) (point-at-eol)
  2999. 'org-agenda-title-append org-agenda-title-append))))
  3000. (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
  3001. (defvar org-agenda-write-buffer-name "Agenda View")
  3002. (defun org-agenda-write (file &optional open nosettings agenda-bufname)
  3003. "Write the current buffer (an agenda view) as a file.
  3004. Depending on the extension of the file name, plain text (.txt),
  3005. HTML (.html or .htm), PDF (.pdf) or Postscript (.ps) is produced.
  3006. If the extension is .ics, translate visible agenda into iCalendar
  3007. format. If the extension is .org, collect all subtrees
  3008. corresponding to the agenda entries and add them in an .org file.
  3009. With prefix argument OPEN, open the new file immediately. If
  3010. NOSETTINGS is given, do not scope the settings of
  3011. `org-agenda-exporter-settings' into the export commands. This is
  3012. used when the settings have already been scoped and we do not
  3013. wish to overrule other, higher priority settings. If
  3014. AGENDA-BUFFER-NAME is provided, use this as the buffer name for
  3015. the agenda to write."
  3016. (interactive "FWrite agenda to file: \nP")
  3017. (if (or (not (file-writable-p file))
  3018. (and (file-exists-p file)
  3019. (if (called-interactively-p 'any)
  3020. (not (y-or-n-p (format "Overwrite existing file %s? " file))))))
  3021. (user-error "Cannot write agenda to file %s" file))
  3022. (org-let (if nosettings nil org-agenda-exporter-settings)
  3023. '(save-excursion
  3024. (save-window-excursion
  3025. (let ((bs (copy-sequence (buffer-string))) beg content)
  3026. (with-temp-buffer
  3027. (rename-buffer org-agenda-write-buffer-name t)
  3028. (set-buffer-modified-p nil)
  3029. (insert bs)
  3030. (org-agenda-remove-marked-text 'invisible 'org-filtered)
  3031. (run-hooks 'org-agenda-before-write-hook)
  3032. (cond
  3033. ((bound-and-true-p org-mobile-creating-agendas)
  3034. (org-mobile-write-agenda-for-mobile file))
  3035. ((string-match "\\.org\\'" file)
  3036. (let (content p m message-log-max)
  3037. (goto-char (point-min))
  3038. (while (setq p (next-single-property-change (point) 'org-hd-marker nil))
  3039. (goto-char p)
  3040. (setq m (get-text-property (point) 'org-hd-marker))
  3041. (when m
  3042. (push (save-excursion
  3043. (set-buffer (marker-buffer m))
  3044. (goto-char m)
  3045. (org-copy-subtree 1 nil t t)
  3046. org-subtree-clip)
  3047. content)))
  3048. (find-file file)
  3049. (erase-buffer)
  3050. (dolist (s content) (org-paste-subtree 1 s))
  3051. (write-file file)
  3052. (kill-buffer (current-buffer))
  3053. (message "Org file written to %s" file)))
  3054. ((string-match "\\.html?\\'" file)
  3055. (require 'htmlize)
  3056. (set-buffer (htmlize-buffer (current-buffer)))
  3057. (when org-agenda-export-html-style
  3058. ;; replace <style> section with org-agenda-export-html-style
  3059. (goto-char (point-min))
  3060. (kill-region (- (search-forward "<style") 6)
  3061. (search-forward "</style>"))
  3062. (insert org-agenda-export-html-style))
  3063. (write-file file)
  3064. (kill-buffer (current-buffer))
  3065. (message "HTML written to %s" file))
  3066. ((string-match "\\.ps\\'" file)
  3067. (require 'ps-print)
  3068. (ps-print-buffer-with-faces file)
  3069. (message "Postscript written to %s" file))
  3070. ((string-match "\\.pdf\\'" file)
  3071. (require 'ps-print)
  3072. (ps-print-buffer-with-faces
  3073. (concat (file-name-sans-extension file) ".ps"))
  3074. (call-process "ps2pdf" nil nil nil
  3075. (expand-file-name
  3076. (concat (file-name-sans-extension file) ".ps"))
  3077. (expand-file-name file))
  3078. (delete-file (concat (file-name-sans-extension file) ".ps"))
  3079. (message "PDF written to %s" file))
  3080. ((string-match "\\.ics\\'" file)
  3081. (require 'ox-icalendar)
  3082. (org-icalendar-export-current-agenda (expand-file-name file)))
  3083. (t
  3084. (let ((bs (buffer-string)))
  3085. (find-file file)
  3086. (erase-buffer)
  3087. (insert bs)
  3088. (save-buffer 0)
  3089. (kill-buffer (current-buffer))
  3090. (message "Plain text written to %s" file))))))))
  3091. (set-buffer (or agenda-bufname
  3092. (and (called-interactively-p 'any) (buffer-name))
  3093. org-agenda-buffer-name)))
  3094. (when open (org-open-file file)))
  3095. (defun org-agenda-remove-marked-text (property &optional value)
  3096. "Delete all text marked with VALUE of PROPERTY.
  3097. VALUE defaults to t."
  3098. (let (beg)
  3099. (setq value (or value t))
  3100. (while (setq beg (text-property-any (point-min) (point-max)
  3101. property value))
  3102. (delete-region
  3103. beg (or (next-single-property-change beg property)
  3104. (point-max))))))
  3105. (defun org-agenda-add-entry-text ()
  3106. "Add entry text to agenda lines.
  3107. This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
  3108. entry text following headings shown in the agenda.
  3109. Drawers will be excluded, also the line with scheduling/deadline info."
  3110. (when (and (> org-agenda-add-entry-text-maxlines 0)
  3111. (not (bound-and-true-p org-mobile-creating-agendas)))
  3112. (let (m txt)
  3113. (goto-char (point-min))
  3114. (while (not (eobp))
  3115. (if (not (setq m (org-get-at-bol 'org-hd-marker)))
  3116. (beginning-of-line 2)
  3117. (setq txt (org-agenda-get-some-entry-text
  3118. m org-agenda-add-entry-text-maxlines " > "))
  3119. (end-of-line 1)
  3120. (if (string-match "\\S-" txt)
  3121. (insert "\n" txt)
  3122. (or (eobp) (forward-char 1))))))))
  3123. (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
  3124. &rest keep)
  3125. "Extract entry text from MARKER, at most N-LINES lines.
  3126. This will ignore drawers etc, just get the text.
  3127. If INDENT is given, prefix every line with this string. If KEEP is
  3128. given, it is a list of symbols, defining stuff that should not be
  3129. removed from the entry content. Currently only `planning' is allowed here."
  3130. (let (txt drawer-re kwd-time-re ind)
  3131. (save-excursion
  3132. (with-current-buffer (marker-buffer marker)
  3133. (if (not (derived-mode-p 'org-mode))
  3134. (setq txt "")
  3135. (save-excursion
  3136. (save-restriction
  3137. (widen)
  3138. (goto-char marker)
  3139. (end-of-line 1)
  3140. (setq txt (buffer-substring
  3141. (min (1+ (point)) (point-max))
  3142. (progn (outline-next-heading) (point)))
  3143. drawer-re org-drawer-regexp
  3144. kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
  3145. ".*\n?"))
  3146. (with-temp-buffer
  3147. (insert txt)
  3148. (when org-agenda-add-entry-text-descriptive-links
  3149. (goto-char (point-min))
  3150. (while (org-activate-bracket-links (point-max))
  3151. (add-text-properties (match-beginning 0) (match-end 0)
  3152. '(face org-link))))
  3153. (goto-char (point-min))
  3154. (while (re-search-forward org-bracket-link-regexp (point-max) t)
  3155. (set-text-properties (match-beginning 0) (match-end 0)
  3156. nil))
  3157. (goto-char (point-min))
  3158. (while (re-search-forward drawer-re nil t)
  3159. (delete-region
  3160. (match-beginning 0)
  3161. (progn (re-search-forward
  3162. "^[ \t]*:END:.*\n?" nil 'move)
  3163. (point))))
  3164. (unless (member 'planning keep)
  3165. (goto-char (point-min))
  3166. (while (re-search-forward kwd-time-re nil t)
  3167. (replace-match "")))
  3168. (goto-char (point-min))
  3169. (when org-agenda-entry-text-exclude-regexps
  3170. (let ((re-list org-agenda-entry-text-exclude-regexps) re)
  3171. (while (setq re (pop re-list))
  3172. (goto-char (point-min))
  3173. (while (re-search-forward re nil t)
  3174. (replace-match "")))))
  3175. (goto-char (point-max))
  3176. (skip-chars-backward " \t\n")
  3177. (if (looking-at "[ \t\n]+\\'") (replace-match ""))
  3178. ;; find and remove min common indentation
  3179. (goto-char (point-min))
  3180. (untabify (point-min) (point-max))
  3181. (setq ind (org-get-indentation))
  3182. (while (not (eobp))
  3183. (unless (looking-at "[ \t]*$")
  3184. (setq ind (min ind (org-get-indentation))))
  3185. (beginning-of-line 2))
  3186. (goto-char (point-min))
  3187. (while (not (eobp))
  3188. (unless (looking-at "[ \t]*$")
  3189. (move-to-column ind)
  3190. (delete-region (point-at-bol) (point)))
  3191. (beginning-of-line 2))
  3192. (run-hooks 'org-agenda-entry-text-cleanup-hook)
  3193. (goto-char (point-min))
  3194. (when indent
  3195. (while (and (not (eobp)) (re-search-forward "^" nil t))
  3196. (replace-match indent t t)))
  3197. (goto-char (point-min))
  3198. (while (looking-at "[ \t]*\n") (replace-match ""))
  3199. (goto-char (point-max))
  3200. (when (> (org-current-line)
  3201. n-lines)
  3202. (org-goto-line (1+ n-lines))
  3203. (backward-char 1))
  3204. (setq txt (buffer-substring (point-min) (point)))))))))
  3205. txt))
  3206. (defun org-check-for-org-mode ()
  3207. "Make sure current buffer is in org-mode. Error if not."
  3208. (or (derived-mode-p 'org-mode)
  3209. (error "Cannot execute org-mode agenda command on buffer in %s"
  3210. major-mode)))
  3211. ;;; Agenda prepare and finalize
  3212. (defvar org-agenda-multi nil) ; dynamically scoped
  3213. (defvar org-agenda-pre-window-conf nil)
  3214. (defvar org-agenda-columns-active nil)
  3215. (defvar org-agenda-name nil)
  3216. (defvar org-agenda-tag-filter nil)
  3217. (defvar org-agenda-category-filter nil)
  3218. (defvar org-agenda-regexp-filter nil)
  3219. (defvar org-agenda-effort-filter nil)
  3220. (defvar org-agenda-top-headline-filter nil)
  3221. (defvar org-agenda-tag-filter-preset nil
  3222. "A preset of the tags filter used for secondary agenda filtering.
  3223. This must be a list of strings, each string must be a single tag preceded
  3224. by \"+\" or \"-\".
  3225. This variable should not be set directly, but agenda custom commands can
  3226. bind it in the options section. The preset filter is a global property of
  3227. the entire agenda view. In a block agenda, it will not work reliably to
  3228. define a filter for one of the individual blocks. You need to set it in
  3229. the global options and expect it to be applied to the entire view.")
  3230. (defvar org-agenda-category-filter-preset nil
  3231. "A preset of the category filter used for secondary agenda filtering.
  3232. This must be a list of strings, each string must be a single category
  3233. preceded by \"+\" or \"-\".
  3234. This variable should not be set directly, but agenda custom commands can
  3235. bind it in the options section. The preset filter is a global property of
  3236. the entire agenda view. In a block agenda, it will not work reliably to
  3237. define a filter for one of the individual blocks. You need to set it in
  3238. the global options and expect it to be applied to the entire view.")
  3239. (defvar org-agenda-regexp-filter-preset nil
  3240. "A preset of the regexp filter used for secondary agenda filtering.
  3241. This must be a list of strings, each string must be a single regexp
  3242. preceded by \"+\" or \"-\".
  3243. This variable should not be set directly, but agenda custom commands can
  3244. bind it in the options section. The preset filter is a global property of
  3245. the entire agenda view. In a block agenda, it will not work reliably to
  3246. define a filter for one of the individual blocks. You need to set it in
  3247. the global options and expect it to be applied to the entire view.")
  3248. (defvar org-agenda-effort-filter-preset nil
  3249. "A preset of the effort condition used for secondary agenda filtering.
  3250. This must be a list of strings, each string must be a single regexp
  3251. preceded by \"+\" or \"-\".
  3252. This variable should not be set directly, but agenda custom commands can
  3253. bind it in the options section. The preset filter is a global property of
  3254. the entire agenda view. In a block agenda, it will not work reliably to
  3255. define a filter for one of the individual blocks. You need to set it in
  3256. the global options and expect it to be applied to the entire view.")
  3257. (defun org-agenda-use-sticky-p ()
  3258. "Return non-nil if an agenda buffer named
  3259. `org-agenda-buffer-name' exists and should be shown instead of
  3260. generating a new one."
  3261. (and
  3262. ;; turned off by user
  3263. org-agenda-sticky
  3264. ;; For multi-agenda buffer already exists
  3265. (not org-agenda-multi)
  3266. ;; buffer found
  3267. (get-buffer org-agenda-buffer-name)
  3268. ;; C-u parameter is same as last call
  3269. (with-current-buffer (get-buffer org-agenda-buffer-name)
  3270. (and
  3271. (equal current-prefix-arg
  3272. org-agenda-last-prefix-arg)
  3273. ;; In case user turned stickiness on, while having existing
  3274. ;; Agenda buffer active, don't reuse that buffer, because it
  3275. ;; does not have org variables local
  3276. org-agenda-this-buffer-is-sticky))))
  3277. (defun org-agenda-prepare-window (abuf filter-alist)
  3278. "Setup agenda buffer in the window.
  3279. ABUF is the buffer for the agenda window.
  3280. FILTER-ALIST is an alist of filters we need to apply when
  3281. `org-agenda-persistent-filter' is non-nil."
  3282. (let* ((awin (get-buffer-window abuf)) wconf)
  3283. (cond
  3284. ((equal (current-buffer) abuf) nil)
  3285. (awin (select-window awin))
  3286. ((not (setq wconf (current-window-configuration))))
  3287. ((equal org-agenda-window-setup 'current-window)
  3288. (pop-to-buffer-same-window abuf))
  3289. ((equal org-agenda-window-setup 'other-window)
  3290. (org-switch-to-buffer-other-window abuf))
  3291. ((equal org-agenda-window-setup 'other-frame)
  3292. (switch-to-buffer-other-frame abuf))
  3293. ((eq org-agenda-window-setup 'only-window)
  3294. (delete-other-windows)
  3295. (pop-to-buffer-same-window abuf))
  3296. ((equal org-agenda-window-setup 'reorganize-frame)
  3297. (delete-other-windows)
  3298. (org-switch-to-buffer-other-window abuf)))
  3299. (setq org-agenda-tag-filter (cdr (assoc 'tag filter-alist)))
  3300. (setq org-agenda-category-filter (cdr (assoc 'cat filter-alist)))
  3301. (setq org-agenda-effort-filter (cdr (assoc 'effort filter-alist)))
  3302. (setq org-agenda-regexp-filter (cdr (assoc 're filter-alist)))
  3303. ;; Additional test in case agenda is invoked from within agenda
  3304. ;; buffer via elisp link.
  3305. (unless (equal (current-buffer) abuf)
  3306. (pop-to-buffer-same-window abuf))
  3307. (setq org-agenda-pre-window-conf
  3308. (or wconf org-agenda-pre-window-conf))))
  3309. (defun org-agenda-prepare (&optional name)
  3310. (let ((filter-alist (if org-agenda-persistent-filter
  3311. (with-current-buffer
  3312. (get-buffer-create org-agenda-buffer-name)
  3313. (list `(tag . ,org-agenda-tag-filter)
  3314. `(re . ,org-agenda-regexp-filter)
  3315. `(effort . ,org-agenda-effort-filter)
  3316. `(cat . ,org-agenda-category-filter))))))
  3317. (if (org-agenda-use-sticky-p)
  3318. (progn
  3319. (put 'org-agenda-tag-filter :preset-filter nil)
  3320. (put 'org-agenda-category-filter :preset-filter nil)
  3321. (put 'org-agenda-regexp-filter :preset-filter nil)
  3322. ;; Popup existing buffer
  3323. (org-agenda-prepare-window (get-buffer org-agenda-buffer-name)
  3324. filter-alist)
  3325. (message "Sticky Agenda buffer, use `r' to refresh")
  3326. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3327. (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
  3328. (setq org-todo-keywords-for-agenda nil)
  3329. (put 'org-agenda-tag-filter :preset-filter
  3330. org-agenda-tag-filter-preset)
  3331. (put 'org-agenda-category-filter :preset-filter
  3332. org-agenda-category-filter-preset)
  3333. (put 'org-agenda-regexp-filter :preset-filter
  3334. org-agenda-regexp-filter-preset)
  3335. (put 'org-agenda-effort-filter :preset-filter
  3336. org-agenda-effort-filter-preset)
  3337. (if org-agenda-multi
  3338. (progn
  3339. (setq buffer-read-only nil)
  3340. (goto-char (point-max))
  3341. (unless (or (bobp) org-agenda-compact-blocks
  3342. (not org-agenda-block-separator))
  3343. (insert "\n"
  3344. (if (stringp org-agenda-block-separator)
  3345. org-agenda-block-separator
  3346. (make-string (window-width) org-agenda-block-separator))
  3347. "\n"))
  3348. (narrow-to-region (point) (point-max)))
  3349. (setq org-done-keywords-for-agenda nil)
  3350. ;; Setting any org variables that are in org-agenda-local-vars
  3351. ;; list need to be done after the prepare call
  3352. (org-agenda-prepare-window
  3353. (get-buffer-create org-agenda-buffer-name) filter-alist)
  3354. (setq buffer-read-only nil)
  3355. (org-agenda-reset-markers)
  3356. (let ((inhibit-read-only t)) (erase-buffer))
  3357. (org-agenda-mode)
  3358. (setq org-agenda-buffer (current-buffer))
  3359. (setq org-agenda-contributing-files nil)
  3360. (setq org-agenda-columns-active nil)
  3361. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  3362. (setq org-todo-keywords-for-agenda
  3363. (org-uniquify org-todo-keywords-for-agenda))
  3364. (setq org-done-keywords-for-agenda
  3365. (org-uniquify org-done-keywords-for-agenda))
  3366. (setq org-agenda-last-prefix-arg current-prefix-arg)
  3367. (setq org-agenda-this-buffer-name org-agenda-buffer-name)
  3368. (and name (not org-agenda-name)
  3369. (setq-local org-agenda-name name)))
  3370. (setq buffer-read-only nil))))
  3371. (defvar org-agenda-overriding-columns-format) ; From org-colview.el
  3372. (defun org-agenda-finalize ()
  3373. "Finishing touch for the agenda buffer, called just before displaying it."
  3374. (unless org-agenda-multi
  3375. (save-excursion
  3376. (let ((inhibit-read-only t))
  3377. (goto-char (point-min))
  3378. (save-excursion
  3379. (while (org-activate-bracket-links (point-max))
  3380. (add-text-properties (match-beginning 0) (match-end 0)
  3381. '(face org-link))))
  3382. (save-excursion
  3383. (while (org-activate-plain-links (point-max))
  3384. (add-text-properties (match-beginning 0) (match-end 0)
  3385. '(face org-link))))
  3386. (unless (eq org-agenda-remove-tags t)
  3387. (org-agenda-align-tags))
  3388. (unless org-agenda-with-colors
  3389. (remove-text-properties (point-min) (point-max) '(face nil)))
  3390. (if (and (boundp 'org-agenda-overriding-columns-format)
  3391. org-agenda-overriding-columns-format)
  3392. (setq-local org-agenda-overriding-columns-format
  3393. org-agenda-overriding-columns-format))
  3394. (if (and (boundp 'org-agenda-view-columns-initially)
  3395. org-agenda-view-columns-initially)
  3396. (org-agenda-columns))
  3397. (when org-agenda-fontify-priorities
  3398. (org-agenda-fontify-priorities))
  3399. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  3400. (org-agenda-dim-blocked-tasks))
  3401. (org-agenda-mark-clocking-task)
  3402. (when org-agenda-entry-text-mode
  3403. (org-agenda-entry-text-hide)
  3404. (org-agenda-entry-text-show))
  3405. (if (and (functionp 'org-habit-insert-consistency-graphs)
  3406. (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
  3407. (org-habit-insert-consistency-graphs))
  3408. (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
  3409. (unless (or (eq org-agenda-show-inherited-tags 'always)
  3410. (and (listp org-agenda-show-inherited-tags)
  3411. (memq org-agenda-type org-agenda-show-inherited-tags))
  3412. (and (eq org-agenda-show-inherited-tags t)
  3413. (or (eq org-agenda-use-tag-inheritance t)
  3414. (and (listp org-agenda-use-tag-inheritance)
  3415. (not (memq org-agenda-type
  3416. org-agenda-use-tag-inheritance))))))
  3417. (let (mrk)
  3418. (save-excursion
  3419. (goto-char (point-min))
  3420. (while (equal (forward-line) 0)
  3421. (when (setq mrk (get-text-property (point) 'org-hd-marker))
  3422. (put-text-property (point-at-bol) (point-at-eol)
  3423. 'tags (org-with-point-at mrk
  3424. (delete-dups
  3425. (mapcar 'downcase (org-get-tags-at))))))))))
  3426. (run-hooks 'org-agenda-finalize-hook)
  3427. (when org-agenda-top-headline-filter
  3428. (org-agenda-filter-top-headline-apply
  3429. org-agenda-top-headline-filter))
  3430. (when org-agenda-tag-filter
  3431. (org-agenda-filter-apply org-agenda-tag-filter 'tag t))
  3432. (when (get 'org-agenda-tag-filter :preset-filter)
  3433. (org-agenda-filter-apply
  3434. (get 'org-agenda-tag-filter :preset-filter) 'tag t))
  3435. (when org-agenda-category-filter
  3436. (org-agenda-filter-apply org-agenda-category-filter 'category))
  3437. (when (get 'org-agenda-category-filter :preset-filter)
  3438. (org-agenda-filter-apply
  3439. (get 'org-agenda-category-filter :preset-filter) 'category))
  3440. (when org-agenda-regexp-filter
  3441. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
  3442. (when (get 'org-agenda-regexp-filter :preset-filter)
  3443. (org-agenda-filter-apply
  3444. (get 'org-agenda-regexp-filter :preset-filter) 'regexp))
  3445. (when org-agenda-effort-filter
  3446. (org-agenda-filter-apply org-agenda-effort-filter 'effort))
  3447. (when (get 'org-agenda-effort-filter :preset-filter)
  3448. (org-agenda-filter-apply
  3449. (get 'org-agenda-effort-filter :preset-filter) 'effort))
  3450. (add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)))))
  3451. (defun org-agenda-mark-clocking-task ()
  3452. "Mark the current clock entry in the agenda if it is present."
  3453. ;; We need to widen when `org-agenda-finalize' is called from
  3454. ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in')
  3455. (when (bound-and-true-p org-clock-current-task)
  3456. (save-restriction
  3457. (widen)
  3458. (org-agenda-unmark-clocking-task)
  3459. (when (marker-buffer org-clock-hd-marker)
  3460. (save-excursion
  3461. (goto-char (point-min))
  3462. (let (s ov)
  3463. (while (setq s (next-single-property-change (point) 'org-hd-marker))
  3464. (goto-char s)
  3465. (when (equal (org-get-at-bol 'org-hd-marker)
  3466. org-clock-hd-marker)
  3467. (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
  3468. (overlay-put ov 'type 'org-agenda-clocking)
  3469. (overlay-put ov 'face 'org-agenda-clocking)
  3470. (overlay-put ov 'help-echo
  3471. "The clock is running in this item")))))))))
  3472. (defun org-agenda-unmark-clocking-task ()
  3473. "Unmark the current clocking task."
  3474. (mapc (lambda (o)
  3475. (if (eq (overlay-get o 'type) 'org-agenda-clocking)
  3476. (delete-overlay o)))
  3477. (overlays-in (point-min) (point-max))))
  3478. (defun org-agenda-fontify-priorities ()
  3479. "Make highest priority lines bold, and lowest italic."
  3480. (interactive)
  3481. (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
  3482. (delete-overlay o)))
  3483. (overlays-in (point-min) (point-max)))
  3484. (save-excursion
  3485. (let (b e p ov h l)
  3486. (goto-char (point-min))
  3487. (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
  3488. (setq h (or (get-char-property (point) 'org-highest-priority)
  3489. org-highest-priority)
  3490. l (or (get-char-property (point) 'org-lowest-priority)
  3491. org-lowest-priority)
  3492. p (string-to-char (match-string 1))
  3493. b (match-beginning 0)
  3494. e (if (eq org-agenda-fontify-priorities 'cookies)
  3495. (match-end 0)
  3496. (point-at-eol))
  3497. ov (make-overlay b e))
  3498. (overlay-put
  3499. ov 'face
  3500. (let ((special-face
  3501. (cond ((org-face-from-face-or-color
  3502. 'priority nil
  3503. (cdr (assoc p org-priority-faces))))
  3504. ((and (listp org-agenda-fontify-priorities)
  3505. (org-face-from-face-or-color
  3506. 'priority nil
  3507. (cdr (assoc p org-agenda-fontify-priorities)))))
  3508. ((equal p l) 'italic)
  3509. ((equal p h) 'bold))))
  3510. (if special-face (list special-face 'org-priority) 'org-priority)))
  3511. (overlay-put ov 'org-type 'org-priority)))))
  3512. (defvar org-depend-tag-blocked)
  3513. (defun org-agenda-dim-blocked-tasks (&optional invisible)
  3514. "Dim currently blocked TODOs in the agenda display.
  3515. When INVISIBLE is non-nil, hide currently blocked TODO instead of
  3516. dimming them."
  3517. (interactive "P")
  3518. (when (called-interactively-p 'interactive)
  3519. (message "Dim or hide blocked tasks..."))
  3520. (dolist (o (overlays-in (point-min) (point-max)))
  3521. (when (eq (overlay-get o 'org-type) 'org-blocked-todo)
  3522. (delete-overlay o)))
  3523. (save-excursion
  3524. (let ((inhibit-read-only t)
  3525. (org-depend-tag-blocked nil)
  3526. org-blocked-by-checkboxes)
  3527. (goto-char (point-min))
  3528. (while (let ((pos (text-property-not-all
  3529. (point) (point-max) 'todo-state nil)))
  3530. (when pos (goto-char pos)))
  3531. (setq org-blocked-by-checkboxes nil)
  3532. (let ((marker (org-get-at-bol 'org-hd-marker)))
  3533. (when (and (markerp marker)
  3534. (with-current-buffer (marker-buffer marker)
  3535. (save-excursion (goto-char marker)
  3536. (org-entry-blocked-p))))
  3537. ;; Entries blocked by checkboxes cannot be made invisible.
  3538. ;; See `org-agenda-dim-blocked-tasks' for details.
  3539. (let* ((really-invisible
  3540. (and (not org-blocked-by-checkboxes)
  3541. (or invisible (eq org-agenda-dim-blocked-tasks
  3542. 'invisible))))
  3543. (ov (make-overlay (if really-invisible (line-end-position 0)
  3544. (line-beginning-position))
  3545. (line-end-position))))
  3546. (if really-invisible (overlay-put ov 'invisible t)
  3547. (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
  3548. (overlay-put ov 'org-type 'org-blocked-todo))))
  3549. (forward-line))))
  3550. (when (called-interactively-p 'interactive)
  3551. (message "Dim or hide blocked tasks...done")))
  3552. (defvar org-agenda-skip-function nil
  3553. "Function to be called at each match during agenda construction.
  3554. If this function returns nil, the current match should not be skipped.
  3555. Otherwise, the function must return a position from where the search
  3556. should be continued.
  3557. This may also be a Lisp form, it will be evaluated.
  3558. Never set this variable using `setq' or so, because then it will apply
  3559. to all future agenda commands. If you do want a global skipping condition,
  3560. use the option `org-agenda-skip-function-global' instead.
  3561. The correct usage for `org-agenda-skip-function' is to bind it with
  3562. `let' to scope it dynamically into the agenda-constructing command.
  3563. A good way to set it is through options in `org-agenda-custom-commands'.")
  3564. (defun org-agenda-skip ()
  3565. "Throw to `:skip' in places that should be skipped.
  3566. Also moves point to the end of the skipped region, so that search can
  3567. continue from there."
  3568. (let ((p (point-at-bol)) to)
  3569. (when (or
  3570. (save-excursion (goto-char p) (looking-at comment-start-skip))
  3571. (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
  3572. (get-text-property p :org-archived)
  3573. (org-end-of-subtree t))
  3574. (and org-agenda-skip-comment-trees
  3575. (get-text-property p :org-comment)
  3576. (org-end-of-subtree t))
  3577. (and (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
  3578. (org-agenda-skip-eval org-agenda-skip-function)))
  3579. (goto-char to))
  3580. (org-in-src-block-p t))
  3581. (throw :skip t))))
  3582. (defun org-agenda-skip-eval (form)
  3583. "If FORM is a function or a list, call (or eval) it and return the result.
  3584. `save-excursion' and `save-match-data' are wrapped around the call, so point
  3585. and match data are returned to the previous state no matter what these
  3586. functions do."
  3587. (let (fp)
  3588. (and form
  3589. (or (setq fp (functionp form))
  3590. (consp form))
  3591. (save-excursion
  3592. (save-match-data
  3593. (if fp
  3594. (funcall form)
  3595. (eval form)))))))
  3596. (defvar org-agenda-markers nil
  3597. "List of all currently active markers created by `org-agenda'.")
  3598. (defvar org-agenda-last-marker-time (float-time)
  3599. "Creation time of the last agenda marker.")
  3600. (defun org-agenda-new-marker (&optional pos)
  3601. "Return a new agenda marker.
  3602. Maker is at point, or at POS if non-nil. Org mode keeps a list of
  3603. these markers and resets them when they are no longer in use."
  3604. (let ((m (copy-marker (or pos (point)) t)))
  3605. (setq org-agenda-last-marker-time (float-time))
  3606. (if org-agenda-buffer
  3607. (with-current-buffer org-agenda-buffer
  3608. (push m org-agenda-markers))
  3609. (push m org-agenda-markers))
  3610. m))
  3611. (defun org-agenda-reset-markers ()
  3612. "Reset markers created by `org-agenda'."
  3613. (while org-agenda-markers
  3614. (move-marker (pop org-agenda-markers) nil)))
  3615. (defun org-agenda-save-markers-for-cut-and-paste (beg end)
  3616. "Save relative positions of markers in region.
  3617. This check for agenda markers in all agenda buffers currently active."
  3618. (dolist (buf (buffer-list))
  3619. (with-current-buffer buf
  3620. (when (eq major-mode 'org-agenda-mode)
  3621. (mapc (lambda (m) (org-check-and-save-marker m beg end))
  3622. org-agenda-markers)))))
  3623. ;;; Entry text mode
  3624. (defun org-agenda-entry-text-show-here ()
  3625. "Add some text from the entry as context to the current line."
  3626. (let (m txt o)
  3627. (setq m (org-get-at-bol 'org-hd-marker))
  3628. (unless (marker-buffer m)
  3629. (error "No marker points to an entry here"))
  3630. (setq txt (concat "\n" (org-no-properties
  3631. (org-agenda-get-some-entry-text
  3632. m org-agenda-entry-text-maxlines
  3633. org-agenda-entry-text-leaders))))
  3634. (when (string-match "\\S-" txt)
  3635. (setq o (make-overlay (point-at-bol) (point-at-eol)))
  3636. (overlay-put o 'evaporate t)
  3637. (overlay-put o 'org-overlay-type 'agenda-entry-content)
  3638. (overlay-put o 'after-string txt))))
  3639. (defun org-agenda-entry-text-show ()
  3640. "Add entry context for all agenda lines."
  3641. (interactive)
  3642. (save-excursion
  3643. (goto-char (point-max))
  3644. (beginning-of-line 1)
  3645. (while (not (bobp))
  3646. (when (org-get-at-bol 'org-hd-marker)
  3647. (org-agenda-entry-text-show-here))
  3648. (beginning-of-line 0))))
  3649. (defun org-agenda-entry-text-hide ()
  3650. "Remove any shown entry context."
  3651. (delq nil
  3652. (mapcar (lambda (o)
  3653. (if (eq (overlay-get o 'org-overlay-type)
  3654. 'agenda-entry-content)
  3655. (progn (delete-overlay o) t)))
  3656. (overlays-in (point-min) (point-max)))))
  3657. (defun org-agenda-get-day-face (date)
  3658. "Return the face DATE should be displayed with."
  3659. (cond ((and (functionp org-agenda-day-face-function)
  3660. (funcall org-agenda-day-face-function date)))
  3661. ((org-agenda-today-p date) 'org-agenda-date-today)
  3662. ((memq (calendar-day-of-week date) org-agenda-weekend-days)
  3663. 'org-agenda-date-weekend)
  3664. (t 'org-agenda-date)))
  3665. ;;; Agenda timeline
  3666. (defvar org-agenda-only-exact-dates nil) ; dynamically scoped
  3667. (defvar org-agenda-show-log-scoped) ;; dynamically scope in `org-timeline' or `org-agenda-list'
  3668. (defun org-timeline (&optional dotodo)
  3669. "Show a time-sorted view of the entries in the current org file.
  3670. Only entries with a time stamp of today or later will be listed. With
  3671. \\[universal-argument] prefix, all unfinished TODO items will also be shown,
  3672. under the current date.
  3673. If the buffer contains an active region, only check the region for
  3674. dates."
  3675. (interactive "P")
  3676. (let* ((dopast t)
  3677. (org-agenda-show-log-scoped org-agenda-show-log)
  3678. (org-agenda-show-log org-agenda-show-log-scoped)
  3679. (entry (buffer-file-name (or (buffer-base-buffer (current-buffer))
  3680. (current-buffer))))
  3681. (date (calendar-current-date))
  3682. (beg (if (org-region-active-p) (region-beginning) (point-min)))
  3683. (end (if (org-region-active-p) (region-end) (point-max)))
  3684. (day-numbers (org-get-all-dates
  3685. beg end 'no-ranges
  3686. t org-agenda-show-log-scoped ; always include today
  3687. org-timeline-show-empty-dates))
  3688. (org-deadline-warning-days 0)
  3689. (org-agenda-only-exact-dates t)
  3690. (today (org-today))
  3691. (past t)
  3692. args
  3693. s e rtn d emptyp)
  3694. (setq org-agenda-redo-command
  3695. (list 'let
  3696. (list (list 'org-agenda-show-log 'org-agenda-show-log))
  3697. (list 'org-switch-to-buffer-other-window (current-buffer))
  3698. (list 'org-timeline (list 'quote dotodo))))
  3699. (put 'org-agenda-redo-command 'org-lprops nil)
  3700. (if (not dopast)
  3701. ;; Remove past dates from the list of dates.
  3702. (setq day-numbers (delq nil (mapcar (lambda(x)
  3703. (if (>= x today) x nil))
  3704. day-numbers))))
  3705. (org-agenda-prepare (concat "Timeline " (file-name-nondirectory entry)))
  3706. (org-compile-prefix-format 'timeline)
  3707. (org-set-sorting-strategy 'timeline)
  3708. (if org-agenda-show-log-scoped (push :closed args))
  3709. (push :timestamp args)
  3710. (push :deadline args)
  3711. (push :scheduled args)
  3712. (push :sexp args)
  3713. (if dotodo (push :todo args))
  3714. (insert "Timeline of file " entry "\n")
  3715. (add-text-properties (point-min) (point)
  3716. (list 'face 'org-agenda-structure))
  3717. (org-agenda-mark-header-line (point-min))
  3718. (while (setq d (pop day-numbers))
  3719. (if (and (listp d) (eq (car d) :omitted))
  3720. (progn
  3721. (setq s (point))
  3722. (insert (format "\n[... %d empty days omitted]\n\n" (cdr d)))
  3723. (put-text-property s (1- (point)) 'face 'org-agenda-structure))
  3724. (if (listp d) (setq d (car d) emptyp t) (setq emptyp nil))
  3725. (if (and (>= d today)
  3726. dopast
  3727. past)
  3728. (progn
  3729. (setq past nil)
  3730. (insert (make-string 79 ?-) "\n")))
  3731. (setq date (calendar-gregorian-from-absolute d))
  3732. (setq s (point))
  3733. (setq rtn (and (not emptyp)
  3734. (apply 'org-agenda-get-day-entries entry
  3735. date args)))
  3736. (if (or rtn (equal d today) org-timeline-show-empty-dates)
  3737. (progn
  3738. (insert
  3739. (if (stringp org-agenda-format-date)
  3740. (format-time-string org-agenda-format-date
  3741. (org-time-from-absolute date))
  3742. (funcall org-agenda-format-date date))
  3743. "\n")
  3744. (put-text-property s (1- (point)) 'face
  3745. (org-agenda-get-day-face date))
  3746. (put-text-property s (1- (point)) 'org-date-line t)
  3747. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3748. (if (equal d today)
  3749. (put-text-property s (1- (point)) 'org-today t))
  3750. (and rtn (insert (org-agenda-finalize-entries rtn 'timeline) "\n"))
  3751. (put-text-property s (1- (point)) 'day d)))))
  3752. (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
  3753. (point-min)))
  3754. (add-text-properties
  3755. (point-min) (point-max)
  3756. `(org-agenda-type timeline org-redo-cmd ,org-agenda-redo-command))
  3757. (org-agenda-finalize)
  3758. (setq buffer-read-only t)))
  3759. (defun org-get-all-dates (beg end &optional no-ranges force-today inactive empty pre-re)
  3760. "Return a list of all relevant day numbers from BEG to END buffer positions.
  3761. If NO-RANGES is non-nil, include only the start and end dates of a range,
  3762. not every single day in the range. If FORCE-TODAY is non-nil, make
  3763. sure that TODAY is included in the list. If INACTIVE is non-nil, also
  3764. inactive time stamps (those in square brackets) are included.
  3765. When EMPTY is non-nil, also include days without any entries."
  3766. (let ((re (concat
  3767. (if pre-re pre-re "")
  3768. (if inactive org-ts-regexp-both org-ts-regexp)))
  3769. dates dates1 date day day1 day2 ts1 ts2 pos)
  3770. (if force-today
  3771. (setq dates (list (org-today))))
  3772. (save-excursion
  3773. (goto-char beg)
  3774. (while (re-search-forward re end t)
  3775. (setq day (time-to-days (org-time-string-to-time
  3776. (substring (match-string 1) 0 10)
  3777. (current-buffer) (match-beginning 0))))
  3778. (or (memq day dates) (push day dates)))
  3779. (unless no-ranges
  3780. (goto-char beg)
  3781. (while (re-search-forward org-tr-regexp end t)
  3782. (setq pos (match-beginning 0))
  3783. (setq ts1 (substring (match-string 1) 0 10)
  3784. ts2 (substring (match-string 2) 0 10)
  3785. day1 (time-to-days (org-time-string-to-time
  3786. ts1 (current-buffer) pos))
  3787. day2 (time-to-days (org-time-string-to-time
  3788. ts2 (current-buffer) pos)))
  3789. (while (< (setq day1 (1+ day1)) day2)
  3790. (or (memq day1 dates) (push day1 dates)))))
  3791. (setq dates (sort dates '<))
  3792. (when empty
  3793. (while (setq day (pop dates))
  3794. (setq day2 (car dates))
  3795. (push day dates1)
  3796. (when (and day2 empty)
  3797. (if (or (eq empty t)
  3798. (and (numberp empty) (<= (- day2 day) empty)))
  3799. (while (< (setq day (1+ day)) day2)
  3800. (push (list day) dates1))
  3801. (push (cons :omitted (- day2 day)) dates1))))
  3802. (setq dates (nreverse dates1)))
  3803. dates)))
  3804. ;;; Agenda Daily/Weekly
  3805. (defvar org-agenda-start-day nil ; dynamically scoped parameter
  3806. "Start day for the agenda view.
  3807. Custom commands can set this variable in the options section.
  3808. This is usually a string like \"2007-11-01\", \"+2d\" or any other
  3809. input allowed when reading a date through the Org calendar.
  3810. See the docstring of `org-read-date' for details.")
  3811. (defvar org-starting-day nil) ; local variable in the agenda buffer
  3812. (defvar org-arg-loc nil) ; local variable
  3813. (defvar org-agenda-buffer-tmp-name nil)
  3814. ;;;###autoload
  3815. (defun org-agenda-list (&optional arg start-day span with-hour)
  3816. "Produce a daily/weekly view from all files in variable `org-agenda-files'.
  3817. The view will be for the current day or week, but from the overview buffer
  3818. you will be able to go to other days/weeks.
  3819. With a numeric prefix argument in an interactive call, the agenda will
  3820. span ARG days. Lisp programs should instead specify SPAN to change
  3821. the number of days. SPAN defaults to `org-agenda-span'.
  3822. START-DAY defaults to TODAY, or to the most recent match for the weekday
  3823. given in `org-agenda-start-on-weekday'.
  3824. When WITH-HOUR is non-nil, only include scheduled and deadline
  3825. items if they have an hour specification like [h]h:mm."
  3826. (interactive "P")
  3827. (if org-agenda-overriding-arguments
  3828. (setq arg (car org-agenda-overriding-arguments)
  3829. start-day (nth 1 org-agenda-overriding-arguments)
  3830. span (nth 2 org-agenda-overriding-arguments)))
  3831. (if (and (integerp arg) (> arg 0))
  3832. (setq span arg arg nil))
  3833. (catch 'exit
  3834. (setq org-agenda-buffer-name
  3835. (or org-agenda-buffer-tmp-name
  3836. (if org-agenda-sticky
  3837. (cond ((and org-keys (stringp org-match))
  3838. (format "*Org Agenda(%s:%s)*" org-keys org-match))
  3839. (org-keys
  3840. (format "*Org Agenda(%s)*" org-keys))
  3841. (t "*Org Agenda(a)*")))
  3842. org-agenda-buffer-name))
  3843. (org-agenda-prepare "Day/Week")
  3844. (setq start-day (or start-day org-agenda-start-day))
  3845. (if (stringp start-day)
  3846. ;; Convert to an absolute day number
  3847. (setq start-day (time-to-days (org-read-date nil t start-day))))
  3848. (org-compile-prefix-format 'agenda)
  3849. (org-set-sorting-strategy 'agenda)
  3850. (let* ((span (org-agenda-ndays-to-span (or span org-agenda-span)))
  3851. (today (org-today))
  3852. (sd (or start-day today))
  3853. (ndays (org-agenda-span-to-ndays span sd))
  3854. (org-agenda-start-on-weekday
  3855. (if (or (eq ndays 7) (eq ndays 14))
  3856. org-agenda-start-on-weekday))
  3857. (thefiles (org-agenda-files nil 'ifmode))
  3858. (files thefiles)
  3859. (start (if (or (null org-agenda-start-on-weekday)
  3860. (< ndays 7))
  3861. sd
  3862. (let* ((nt (calendar-day-of-week
  3863. (calendar-gregorian-from-absolute sd)))
  3864. (n1 org-agenda-start-on-weekday)
  3865. (d (- nt n1)))
  3866. (- sd (+ (if (< d 0) 7 0) d)))))
  3867. (day-numbers (list start))
  3868. (day-cnt 0)
  3869. (inhibit-redisplay (not debug-on-error))
  3870. (org-agenda-show-log-scoped org-agenda-show-log)
  3871. s e rtn rtnall file date d start-pos end-pos todayp
  3872. clocktable-start clocktable-end filter)
  3873. (setq org-agenda-redo-command
  3874. (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span) with-hour))
  3875. (dotimes (n (1- ndays))
  3876. (push (1+ (car day-numbers)) day-numbers))
  3877. (setq day-numbers (nreverse day-numbers))
  3878. (setq clocktable-start (car day-numbers)
  3879. clocktable-end (1+ (or (org-last day-numbers) 0)))
  3880. (setq-local org-starting-day (car day-numbers))
  3881. (setq-local org-arg-loc arg)
  3882. (setq-local org-agenda-current-span (org-agenda-ndays-to-span span))
  3883. (unless org-agenda-compact-blocks
  3884. (let* ((d1 (car day-numbers))
  3885. (d2 (org-last day-numbers))
  3886. (w1 (org-days-to-iso-week d1))
  3887. (w2 (org-days-to-iso-week d2)))
  3888. (setq s (point))
  3889. (if org-agenda-overriding-header
  3890. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  3891. nil 'face 'org-agenda-structure) "\n")
  3892. (insert (org-agenda-span-name span)
  3893. "-agenda"
  3894. (if (< (- d2 d1) 350)
  3895. (if (= w1 w2)
  3896. (format " (W%02d)" w1)
  3897. (format " (W%02d-W%02d)" w1 w2))
  3898. "")
  3899. ":\n")))
  3900. (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
  3901. 'org-date-line t))
  3902. (org-agenda-mark-header-line s))
  3903. (while (setq d (pop day-numbers))
  3904. (setq date (calendar-gregorian-from-absolute d)
  3905. s (point))
  3906. (if (or (setq todayp (= d today))
  3907. (and (not start-pos) (= d sd)))
  3908. (setq start-pos (point))
  3909. (if (and start-pos (not end-pos))
  3910. (setq end-pos (point))))
  3911. (setq files thefiles
  3912. rtnall nil)
  3913. (while (setq file (pop files))
  3914. (catch 'nextfile
  3915. (org-check-agenda-file file)
  3916. (let ((org-agenda-entry-types org-agenda-entry-types))
  3917. ;; Starred types override non-starred equivalents
  3918. (when (member :deadline* org-agenda-entry-types)
  3919. (setq org-agenda-entry-types
  3920. (delq :deadline org-agenda-entry-types)))
  3921. (when (member :scheduled* org-agenda-entry-types)
  3922. (setq org-agenda-entry-types
  3923. (delq :scheduled org-agenda-entry-types)))
  3924. ;; Honor with-hour
  3925. (when with-hour
  3926. (when (member :deadline org-agenda-entry-types)
  3927. (setq org-agenda-entry-types
  3928. (delq :deadline org-agenda-entry-types))
  3929. (push :deadline* org-agenda-entry-types))
  3930. (when (member :scheduled org-agenda-entry-types)
  3931. (setq org-agenda-entry-types
  3932. (delq :scheduled org-agenda-entry-types))
  3933. (push :scheduled* org-agenda-entry-types)))
  3934. (unless org-agenda-include-deadlines
  3935. (setq org-agenda-entry-types
  3936. (delq :deadline* (delq :deadline org-agenda-entry-types))))
  3937. (cond
  3938. ((memq org-agenda-show-log-scoped '(only clockcheck))
  3939. (setq rtn (org-agenda-get-day-entries
  3940. file date :closed)))
  3941. (org-agenda-show-log-scoped
  3942. (setq rtn (apply 'org-agenda-get-day-entries
  3943. file date
  3944. (append '(:closed) org-agenda-entry-types))))
  3945. (t
  3946. (setq rtn (apply 'org-agenda-get-day-entries
  3947. file date
  3948. org-agenda-entry-types)))))
  3949. (setq rtnall (append rtnall rtn)))) ;; all entries
  3950. (if org-agenda-include-diary
  3951. (let ((org-agenda-search-headline-for-time t))
  3952. (require 'diary-lib)
  3953. (setq rtn (org-get-entries-from-diary date))
  3954. (setq rtnall (append rtnall rtn))))
  3955. (if (or rtnall org-agenda-show-all-dates)
  3956. (progn
  3957. (setq day-cnt (1+ day-cnt))
  3958. (insert
  3959. (if (stringp org-agenda-format-date)
  3960. (format-time-string org-agenda-format-date
  3961. (org-time-from-absolute date))
  3962. (funcall org-agenda-format-date date))
  3963. "\n")
  3964. (put-text-property s (1- (point)) 'face
  3965. (org-agenda-get-day-face date))
  3966. (put-text-property s (1- (point)) 'org-date-line t)
  3967. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3968. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
  3969. (when todayp
  3970. (put-text-property s (1- (point)) 'org-today t))
  3971. (setq rtnall
  3972. (org-agenda-add-time-grid-maybe rtnall ndays todayp))
  3973. (if rtnall (insert ;; all entries
  3974. (org-agenda-finalize-entries rtnall 'agenda)
  3975. "\n"))
  3976. (put-text-property s (1- (point)) 'day d)
  3977. (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
  3978. (when (and org-agenda-clockreport-mode clocktable-start)
  3979. (let ((org-agenda-files (org-agenda-files nil 'ifmode))
  3980. ;; the above line is to ensure the restricted range!
  3981. (p (copy-sequence org-agenda-clockreport-parameter-plist))
  3982. tbl)
  3983. (setq p (org-plist-delete p :block))
  3984. (setq p (plist-put p :tstart clocktable-start))
  3985. (setq p (plist-put p :tend clocktable-end))
  3986. (setq p (plist-put p :scope 'agenda))
  3987. (setq tbl (apply 'org-clock-get-clocktable p))
  3988. (insert tbl)))
  3989. (goto-char (point-min))
  3990. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3991. (unless (and (pos-visible-in-window-p (point-min))
  3992. (pos-visible-in-window-p (point-max)))
  3993. (goto-char (1- (point-max)))
  3994. (recenter -1)
  3995. (if (not (pos-visible-in-window-p (or start-pos 1)))
  3996. (progn
  3997. (goto-char (or start-pos 1))
  3998. (recenter 1))))
  3999. (goto-char (or start-pos 1))
  4000. (add-text-properties (point-min) (point-max)
  4001. `(org-agenda-type agenda
  4002. org-last-args (,arg ,start-day ,span)
  4003. org-redo-cmd ,org-agenda-redo-command
  4004. org-series-cmd ,org-cmd))
  4005. (if (eq org-agenda-show-log-scoped 'clockcheck)
  4006. (org-agenda-show-clocking-issues))
  4007. (org-agenda-finalize)
  4008. (setq buffer-read-only t)
  4009. (message ""))))
  4010. (defun org-agenda-ndays-to-span (n)
  4011. "Return a span symbol for a span of N days, or N if none matches."
  4012. (cond ((symbolp n) n)
  4013. ((= n 1) 'day)
  4014. ((= n 7) 'week)
  4015. ((= n 14) 'fortnight)
  4016. (t n)))
  4017. (defun org-agenda-span-to-ndays (span &optional start-day)
  4018. "Return ndays from SPAN, possibly starting at START-DAY.
  4019. START-DAY is an absolute time value."
  4020. (cond ((numberp span) span)
  4021. ((eq span 'day) 1)
  4022. ((eq span 'week) 7)
  4023. ((eq span 'fortnight) 14)
  4024. ((eq span 'month)
  4025. (let ((date (calendar-gregorian-from-absolute start-day)))
  4026. (calendar-last-day-of-month (car date) (caddr date))))
  4027. ((eq span 'year)
  4028. (let ((date (calendar-gregorian-from-absolute start-day)))
  4029. (if (calendar-leap-year-p (caddr date)) 366 365)))))
  4030. (defun org-agenda-span-name (span)
  4031. "Return a SPAN name."
  4032. (if (null span)
  4033. ""
  4034. (if (symbolp span)
  4035. (capitalize (symbol-name span))
  4036. (format "%d days" span))))
  4037. ;;; Agenda word search
  4038. (defvar org-agenda-search-history nil)
  4039. (defvar org-search-syntax-table nil
  4040. "Special syntax table for org-mode search.
  4041. In this table, we have single quotes not as word constituents, to
  4042. that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
  4043. (defvar org-mode-syntax-table) ; From org.el
  4044. (defun org-search-syntax-table ()
  4045. (unless org-search-syntax-table
  4046. (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
  4047. (modify-syntax-entry ?' "." org-search-syntax-table)
  4048. (modify-syntax-entry ?` "." org-search-syntax-table))
  4049. org-search-syntax-table)
  4050. (defvar org-agenda-last-search-view-search-was-boolean nil)
  4051. ;;;###autoload
  4052. (defun org-search-view (&optional todo-only string edit-at)
  4053. "Show all entries that contain a phrase or words or regular expressions.
  4054. With optional prefix argument TODO-ONLY, only consider entries that are
  4055. TODO entries. The argument STRING can be used to pass a default search
  4056. string into this function. If EDIT-AT is non-nil, it means that the
  4057. user should get a chance to edit this string, with cursor at position
  4058. EDIT-AT.
  4059. The search string can be viewed either as a phrase that should be found as
  4060. is, or it can be broken into a number of snippets, each of which must match
  4061. in a Boolean way to select an entry. The default depends on the variable
  4062. `org-agenda-search-view-always-boolean'.
  4063. Even if this is turned off (the default) you can always switch to
  4064. Boolean search dynamically by preceding the first word with \"+\" or \"-\".
  4065. The default is a direct search of the whole phrase, where each space in
  4066. the search string can expand to an arbitrary amount of whitespace,
  4067. including newlines.
  4068. If using a Boolean search, the search string is split on whitespace and
  4069. each snippet is searched separately, with logical AND to select an entry.
  4070. Words prefixed with a minus must *not* occur in the entry. Words without
  4071. a prefix or prefixed with a plus must occur in the entry. Matching is
  4072. case-insensitive. Words are enclosed by word delimiters (i.e. they must
  4073. match whole words, not parts of a word) if
  4074. `org-agenda-search-view-force-full-words' is set (default is nil).
  4075. Boolean search snippets enclosed by curly braces are interpreted as
  4076. regular expressions that must or (when preceded with \"-\") must not
  4077. match in the entry. Snippets enclosed into double quotes will be taken
  4078. as a whole, to include whitespace.
  4079. - If the search string starts with an asterisk, search only in headlines.
  4080. - If (possibly after the leading star) the search string starts with an
  4081. exclamation mark, this also means to look at TODO entries only, an effect
  4082. that can also be achieved with a prefix argument.
  4083. - If (possibly after star and exclamation mark) the search string starts
  4084. with a colon, this will mean that the (non-regexp) snippets of the
  4085. Boolean search must match as full words.
  4086. This command searches the agenda files, and in addition the files listed
  4087. in `org-agenda-text-search-extra-files'."
  4088. (interactive "P")
  4089. (if org-agenda-overriding-arguments
  4090. (setq todo-only (car org-agenda-overriding-arguments)
  4091. string (nth 1 org-agenda-overriding-arguments)
  4092. edit-at (nth 2 org-agenda-overriding-arguments)))
  4093. (let* ((props (list 'face nil
  4094. 'done-face 'org-agenda-done
  4095. 'org-not-done-regexp org-not-done-regexp
  4096. 'org-todo-regexp org-todo-regexp
  4097. 'org-complex-heading-regexp org-complex-heading-regexp
  4098. 'mouse-face 'highlight
  4099. 'help-echo (format "mouse-2 or RET jump to location")))
  4100. (full-words org-agenda-search-view-force-full-words)
  4101. (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
  4102. regexp rtn rtnall files file pos inherited-tags
  4103. marker category level tags c neg re boolean
  4104. ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
  4105. (unless (and (not edit-at)
  4106. (stringp string)
  4107. (string-match "\\S-" string))
  4108. (setq string (read-string
  4109. (if org-agenda-search-view-always-boolean
  4110. "[+-]Word/{Regexp} ...: "
  4111. "Phrase or [+-]Word/{Regexp} ...: ")
  4112. (cond
  4113. ((integerp edit-at) (cons string edit-at))
  4114. (edit-at string))
  4115. 'org-agenda-search-history)))
  4116. (catch 'exit
  4117. (if org-agenda-sticky
  4118. (setq org-agenda-buffer-name
  4119. (if (stringp string)
  4120. (format "*Org Agenda(%s:%s)*"
  4121. (or org-keys (or (and todo-only "S") "s")) string)
  4122. (format "*Org Agenda(%s)*" (or (and todo-only "S") "s")))))
  4123. (org-agenda-prepare "SEARCH")
  4124. (org-compile-prefix-format 'search)
  4125. (org-set-sorting-strategy 'search)
  4126. (setq org-agenda-redo-command
  4127. (list 'org-search-view (if todo-only t nil)
  4128. (list 'if 'current-prefix-arg nil string)))
  4129. (setq org-agenda-query-string string)
  4130. (if (equal (string-to-char string) ?*)
  4131. (setq hdl-only t
  4132. words (substring string 1))
  4133. (setq words string))
  4134. (when (equal (string-to-char words) ?!)
  4135. (setq todo-only t
  4136. words (substring words 1)))
  4137. (when (equal (string-to-char words) ?:)
  4138. (setq full-words t
  4139. words (substring words 1)))
  4140. (if (or org-agenda-search-view-always-boolean
  4141. (member (string-to-char words) '(?- ?+ ?\{)))
  4142. (setq boolean t))
  4143. (setq words (org-split-string words))
  4144. (let (www w)
  4145. (while (setq w (pop words))
  4146. (while (and (string-match "\\\\\\'" w) words)
  4147. (setq w (concat (substring w 0 -1) " " (pop words))))
  4148. (push w www))
  4149. (setq words (nreverse www) www nil)
  4150. (while (setq w (pop words))
  4151. (when (and (string-match "\\`[-+]?{" w)
  4152. (not (string-match "}\\'" w)))
  4153. (while (and words (not (string-match "}\\'" (car words))))
  4154. (setq w (concat w " " (pop words))))
  4155. (setq w (concat w " " (pop words))))
  4156. (push w www))
  4157. (setq words (nreverse www)))
  4158. (setq org-agenda-last-search-view-search-was-boolean boolean)
  4159. (when boolean
  4160. (let (wds w)
  4161. (while (setq w (pop words))
  4162. (if (or (equal (substring w 0 1) "\"")
  4163. (and (> (length w) 1)
  4164. (member (substring w 0 1) '("+" "-"))
  4165. (equal (substring w 1 2) "\"")))
  4166. (while (and words (not (equal (substring w -1) "\"")))
  4167. (setq w (concat w " " (pop words)))))
  4168. (and (string-match "\\`\\([-+]?\\)\"" w)
  4169. (setq w (replace-match "\\1" nil nil w)))
  4170. (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
  4171. (push w wds))
  4172. (setq words (nreverse wds))))
  4173. (if boolean
  4174. (mapc (lambda (w)
  4175. (setq c (string-to-char w))
  4176. (if (equal c ?-)
  4177. (setq neg t w (substring w 1))
  4178. (if (equal c ?+)
  4179. (setq neg nil w (substring w 1))
  4180. (setq neg nil)))
  4181. (if (string-match "\\`{.*}\\'" w)
  4182. (setq re (substring w 1 -1))
  4183. (if full-words
  4184. (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
  4185. (setq re (regexp-quote (downcase w)))))
  4186. (if neg (push re regexps-) (push re regexps+)))
  4187. words)
  4188. (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
  4189. regexps+))
  4190. (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
  4191. (if (not regexps+)
  4192. (setq regexp org-outline-regexp-bol)
  4193. (setq regexp (pop regexps+))
  4194. (if hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
  4195. regexp))))
  4196. (setq files (org-agenda-files nil 'ifmode))
  4197. (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
  4198. (pop org-agenda-text-search-extra-files)
  4199. (setq files (org-add-archive-files files)))
  4200. (setq files (append files org-agenda-text-search-extra-files)
  4201. rtnall nil)
  4202. (while (setq file (pop files))
  4203. (setq ee nil)
  4204. (catch 'nextfile
  4205. (org-check-agenda-file file)
  4206. (setq buffer (if (file-exists-p file)
  4207. (org-get-agenda-file-buffer file)
  4208. (error "No such file %s" file)))
  4209. (if (not buffer)
  4210. ;; If file does not exist, make sure an error message is sent
  4211. (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
  4212. file))))
  4213. (with-current-buffer buffer
  4214. (with-syntax-table (org-search-syntax-table)
  4215. (unless (derived-mode-p 'org-mode)
  4216. (error "Agenda file %s is not in `org-mode'" file))
  4217. (let ((case-fold-search t))
  4218. (save-excursion
  4219. (save-restriction
  4220. (if (eq buffer org-agenda-restrict)
  4221. (narrow-to-region org-agenda-restrict-begin
  4222. org-agenda-restrict-end)
  4223. (widen))
  4224. (goto-char (point-min))
  4225. (unless (or (org-at-heading-p)
  4226. (outline-next-heading))
  4227. (throw 'nextfile t))
  4228. (goto-char (max (point-min) (1- (point))))
  4229. (while (re-search-forward regexp nil t)
  4230. (org-back-to-heading t)
  4231. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4232. (> (org-reduced-level (org-outline-level))
  4233. org-agenda-search-view-max-outline-level)
  4234. (forward-line -1)
  4235. (org-back-to-heading t)))
  4236. (skip-chars-forward "* ")
  4237. (setq beg (point-at-bol)
  4238. beg1 (point)
  4239. end (progn
  4240. (outline-next-heading)
  4241. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4242. (> (org-reduced-level (org-outline-level))
  4243. org-agenda-search-view-max-outline-level)
  4244. (forward-line 1)
  4245. (outline-next-heading)))
  4246. (point)))
  4247. (catch :skip
  4248. (goto-char beg)
  4249. (org-agenda-skip)
  4250. (setq str (buffer-substring-no-properties
  4251. (point-at-bol)
  4252. (if hdl-only (point-at-eol) end)))
  4253. (mapc (lambda (wr) (when (string-match wr str)
  4254. (goto-char (1- end))
  4255. (throw :skip t)))
  4256. regexps-)
  4257. (mapc (lambda (wr) (unless (string-match wr str)
  4258. (goto-char (1- end))
  4259. (throw :skip t)))
  4260. (if todo-only
  4261. (cons (concat "^\\*+[ \t]+"
  4262. org-not-done-regexp)
  4263. regexps+)
  4264. regexps+))
  4265. (goto-char beg)
  4266. (setq marker (org-agenda-new-marker (point))
  4267. category (org-get-category)
  4268. level (make-string (org-reduced-level (org-outline-level)) ? )
  4269. inherited-tags
  4270. (or (eq org-agenda-show-inherited-tags 'always)
  4271. (and (listp org-agenda-show-inherited-tags)
  4272. (memq 'todo org-agenda-show-inherited-tags))
  4273. (and (eq org-agenda-show-inherited-tags t)
  4274. (or (eq org-agenda-use-tag-inheritance t)
  4275. (memq 'todo org-agenda-use-tag-inheritance))))
  4276. tags (org-get-tags-at nil (not inherited-tags))
  4277. txt (org-agenda-format-item
  4278. ""
  4279. (buffer-substring-no-properties
  4280. beg1 (point-at-eol))
  4281. level category tags t))
  4282. (org-add-props txt props
  4283. 'org-marker marker 'org-hd-marker marker
  4284. 'org-todo-regexp org-todo-regexp
  4285. 'level level
  4286. 'org-complex-heading-regexp org-complex-heading-regexp
  4287. 'priority 1000
  4288. 'type "search")
  4289. (push txt ee)
  4290. (goto-char (1- end))))))))))
  4291. (setq rtn (nreverse ee))
  4292. (setq rtnall (append rtnall rtn)))
  4293. (if org-agenda-overriding-header
  4294. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4295. nil 'face 'org-agenda-structure) "\n")
  4296. (insert "Search words: ")
  4297. (add-text-properties (point-min) (1- (point))
  4298. (list 'face 'org-agenda-structure))
  4299. (setq pos (point))
  4300. (insert string "\n")
  4301. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4302. (setq pos (point))
  4303. (unless org-agenda-multi
  4304. (insert (substitute-command-keys "\
  4305. Press `\\[org-agenda-manipulate-query-add]', \
  4306. `\\[org-agenda-manipulate-query-subtract]' to add/sub word, \
  4307. `\\[org-agenda-manipulate-query-add-re]', \
  4308. `\\[org-agenda-manipulate-query-subtract-re]' to add/sub regexp, \
  4309. `\\[universal-argument] \\[org-agenda-redo]' to edit\n"))
  4310. (add-text-properties pos (1- (point))
  4311. (list 'face 'org-agenda-structure))))
  4312. (org-agenda-mark-header-line (point-min))
  4313. (when rtnall
  4314. (insert (org-agenda-finalize-entries rtnall 'search) "\n"))
  4315. (goto-char (point-min))
  4316. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4317. (add-text-properties (point-min) (point-max)
  4318. `(org-agenda-type search
  4319. org-last-args (,todo-only ,string ,edit-at)
  4320. org-redo-cmd ,org-agenda-redo-command
  4321. org-series-cmd ,org-cmd))
  4322. (org-agenda-finalize)
  4323. (setq buffer-read-only t))))
  4324. ;;; Agenda TODO list
  4325. (defun org-agenda-propertize-selected-todo-keywords (keywords)
  4326. "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
  4327. (concat
  4328. (if (or (equal keywords "ALL") (not keywords))
  4329. (propertize "ALL" 'face 'warning)
  4330. (mapconcat
  4331. (lambda (kw)
  4332. (propertize kw 'face (org-get-todo-face kw)))
  4333. (org-split-string keywords "|")
  4334. "|"))
  4335. "\n"))
  4336. (defvar org-select-this-todo-keyword nil)
  4337. (defvar org-last-arg nil)
  4338. ;;;###autoload
  4339. (defun org-todo-list (&optional arg)
  4340. "Show all (not done) TODO entries from all agenda file in a single list.
  4341. The prefix arg can be used to select a specific TODO keyword and limit
  4342. the list to these. When using \\[universal-argument], you will be prompted
  4343. for a keyword. A numeric prefix directly selects the Nth keyword in
  4344. `org-todo-keywords-1'."
  4345. (interactive "P")
  4346. (if org-agenda-overriding-arguments
  4347. (setq arg org-agenda-overriding-arguments))
  4348. (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
  4349. (let* ((today (org-today))
  4350. (date (calendar-gregorian-from-absolute today))
  4351. (kwds org-todo-keywords-for-agenda)
  4352. (completion-ignore-case t)
  4353. (org-select-this-todo-keyword
  4354. (if (stringp arg) arg
  4355. (and arg (integerp arg) (> arg 0)
  4356. (nth (1- arg) kwds))))
  4357. rtn rtnall files file pos)
  4358. (when (equal arg '(4))
  4359. (setq org-select-this-todo-keyword
  4360. (completing-read "Keyword (or KWD1|K2D2|...): "
  4361. (mapcar #'list kwds) nil nil)))
  4362. (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
  4363. (catch 'exit
  4364. (if org-agenda-sticky
  4365. (setq org-agenda-buffer-name
  4366. (if (stringp org-select-this-todo-keyword)
  4367. (format "*Org Agenda(%s:%s)*" (or org-keys "t")
  4368. org-select-this-todo-keyword)
  4369. (format "*Org Agenda(%s)*" (or org-keys "t")))))
  4370. (org-agenda-prepare "TODO")
  4371. (org-compile-prefix-format 'todo)
  4372. (org-set-sorting-strategy 'todo)
  4373. (setq org-agenda-redo-command
  4374. `(org-todo-list (or (and (numberp current-prefix-arg)
  4375. current-prefix-arg)
  4376. ,org-select-this-todo-keyword
  4377. current-prefix-arg ,arg)))
  4378. (setq files (org-agenda-files nil 'ifmode)
  4379. rtnall nil)
  4380. (while (setq file (pop files))
  4381. (catch 'nextfile
  4382. (org-check-agenda-file file)
  4383. (setq rtn (org-agenda-get-day-entries file date :todo))
  4384. (setq rtnall (append rtnall rtn))))
  4385. (if org-agenda-overriding-header
  4386. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4387. nil 'face 'org-agenda-structure) "\n")
  4388. (insert "Global list of TODO items of type: ")
  4389. (add-text-properties (point-min) (1- (point))
  4390. (list 'face 'org-agenda-structure
  4391. 'short-heading
  4392. (concat "ToDo: "
  4393. (or org-select-this-todo-keyword "ALL"))))
  4394. (org-agenda-mark-header-line (point-min))
  4395. (insert (org-agenda-propertize-selected-todo-keywords
  4396. org-select-this-todo-keyword))
  4397. (setq pos (point))
  4398. (unless org-agenda-multi
  4399. (insert (substitute-command-keys "Available with \
  4400. `N \\[org-agenda-redo]': (0)[ALL]"))
  4401. (let ((n 0) s)
  4402. (mapc (lambda (x)
  4403. (setq s (format "(%d)%s" (setq n (1+ n)) x))
  4404. (if (> (+ (current-column) (string-width s) 1) (frame-width))
  4405. (insert "\n "))
  4406. (insert " " s))
  4407. kwds))
  4408. (insert "\n"))
  4409. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
  4410. (org-agenda-mark-header-line (point-min))
  4411. (when rtnall
  4412. (insert (org-agenda-finalize-entries rtnall 'todo) "\n"))
  4413. (goto-char (point-min))
  4414. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4415. (add-text-properties (point-min) (point-max)
  4416. `(org-agenda-type todo
  4417. org-last-args ,arg
  4418. org-redo-cmd ,org-agenda-redo-command
  4419. org-series-cmd ,org-cmd))
  4420. (org-agenda-finalize)
  4421. (setq buffer-read-only t))))
  4422. ;;; Agenda tags match
  4423. ;;;###autoload
  4424. (defun org-tags-view (&optional todo-only match)
  4425. "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
  4426. The prefix arg TODO-ONLY limits the search to TODO entries."
  4427. (interactive "P")
  4428. (if org-agenda-overriding-arguments
  4429. (setq todo-only (car org-agenda-overriding-arguments)
  4430. match (nth 1 org-agenda-overriding-arguments)))
  4431. (let* ((org-tags-match-list-sublevels
  4432. org-tags-match-list-sublevels)
  4433. (completion-ignore-case t)
  4434. rtn rtnall files file pos matcher
  4435. buffer)
  4436. (when (and (stringp match) (not (string-match "\\S-" match)))
  4437. (setq match nil))
  4438. (catch 'exit
  4439. (if org-agenda-sticky
  4440. (setq org-agenda-buffer-name
  4441. (if (stringp match)
  4442. (format "*Org Agenda(%s:%s)*"
  4443. (or org-keys (or (and todo-only "M") "m")) match)
  4444. (format "*Org Agenda(%s)*" (or (and todo-only "M") "m")))))
  4445. ;; Prepare agendas (and `org-tag-alist-for-agenda') before
  4446. ;; expanding tags within `org-make-tags-matcher'
  4447. (org-agenda-prepare (concat "TAGS " match))
  4448. (setq org--matcher-tags-todo-only todo-only
  4449. matcher (org-make-tags-matcher match)
  4450. match (car matcher)
  4451. matcher (cdr matcher))
  4452. (org-compile-prefix-format 'tags)
  4453. (org-set-sorting-strategy 'tags)
  4454. (setq org-agenda-query-string match)
  4455. (setq org-agenda-redo-command
  4456. (list 'org-tags-view
  4457. `(quote ,org--matcher-tags-todo-only)
  4458. `(if current-prefix-arg nil ,org-agenda-query-string)))
  4459. (setq files (org-agenda-files nil 'ifmode)
  4460. rtnall nil)
  4461. (while (setq file (pop files))
  4462. (catch 'nextfile
  4463. (org-check-agenda-file file)
  4464. (setq buffer (if (file-exists-p file)
  4465. (org-get-agenda-file-buffer file)
  4466. (error "No such file %s" file)))
  4467. (if (not buffer)
  4468. ;; If file does not exist, error message to agenda
  4469. (setq rtn (list
  4470. (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4471. rtnall (append rtnall rtn))
  4472. (with-current-buffer buffer
  4473. (unless (derived-mode-p 'org-mode)
  4474. (error "Agenda file %s is not in `org-mode'" file))
  4475. (save-excursion
  4476. (save-restriction
  4477. (if (eq buffer org-agenda-restrict)
  4478. (narrow-to-region org-agenda-restrict-begin
  4479. org-agenda-restrict-end)
  4480. (widen))
  4481. (setq rtn (org-scan-tags 'agenda
  4482. matcher
  4483. org--matcher-tags-todo-only))
  4484. (setq rtnall (append rtnall rtn))))))))
  4485. (if org-agenda-overriding-header
  4486. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4487. nil 'face 'org-agenda-structure) "\n")
  4488. (insert "Headlines with TAGS match: ")
  4489. (add-text-properties (point-min) (1- (point))
  4490. (list 'face 'org-agenda-structure
  4491. 'short-heading
  4492. (concat "Match: " match)))
  4493. (setq pos (point))
  4494. (insert match "\n")
  4495. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4496. (setq pos (point))
  4497. (unless org-agenda-multi
  4498. (insert (substitute-command-keys
  4499. "Press `\\[universal-argument] \\[org-agenda-redo]' \
  4500. to search again with new search string\n")))
  4501. (add-text-properties pos (1- (point))
  4502. (list 'face 'org-agenda-structure)))
  4503. (org-agenda-mark-header-line (point-min))
  4504. (when rtnall
  4505. (insert (org-agenda-finalize-entries rtnall 'tags) "\n"))
  4506. (goto-char (point-min))
  4507. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4508. (add-text-properties
  4509. (point-min) (point-max)
  4510. `(org-agenda-type tags
  4511. org-last-args (,org--matcher-tags-todo-only ,match)
  4512. org-redo-cmd ,org-agenda-redo-command
  4513. org-series-cmd ,org-cmd))
  4514. (org-agenda-finalize)
  4515. (setq buffer-read-only t))))
  4516. ;;; Agenda Finding stuck projects
  4517. (defvar org-agenda-skip-regexp nil
  4518. "Regular expression used in skipping subtrees for the agenda.
  4519. This is basically a temporary global variable that can be set and then
  4520. used by user-defined selections using `org-agenda-skip-function'.")
  4521. (defvar org-agenda-overriding-header nil
  4522. "When set during agenda, todo and tags searches it replaces the header.
  4523. This variable should not be set directly, but custom commands can bind it
  4524. in the options section.")
  4525. (defun org-agenda-skip-entry-when-regexp-matches ()
  4526. "Check if the current entry contains match for `org-agenda-skip-regexp'.
  4527. If yes, it returns the end position of this entry, causing agenda commands
  4528. to skip the entry but continuing the search in the subtree. This is a
  4529. function that can be put into `org-agenda-skip-function' for the duration
  4530. of a command."
  4531. (let ((end (save-excursion (org-end-of-subtree t)))
  4532. skip)
  4533. (save-excursion
  4534. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  4535. (and skip end)))
  4536. (defun org-agenda-skip-subtree-when-regexp-matches ()
  4537. "Check if the current subtree contains match for `org-agenda-skip-regexp'.
  4538. If yes, it returns the end position of this tree, causing agenda commands
  4539. to skip this subtree. This is a function that can be put into
  4540. `org-agenda-skip-function' for the duration of a command."
  4541. (let ((end (save-excursion (org-end-of-subtree t)))
  4542. skip)
  4543. (save-excursion
  4544. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  4545. (and skip end)))
  4546. (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
  4547. "Check if the current subtree contains match for `org-agenda-skip-regexp'.
  4548. If yes, it returns the end position of the current entry (NOT the tree),
  4549. causing agenda commands to skip the entry but continuing the search in
  4550. the subtree. This is a function that can be put into
  4551. `org-agenda-skip-function' for the duration of a command. An important
  4552. use of this function is for the stuck project list."
  4553. (let ((end (save-excursion (org-end-of-subtree t)))
  4554. (entry-end (save-excursion (outline-next-heading) (1- (point))))
  4555. skip)
  4556. (save-excursion
  4557. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  4558. (and skip entry-end)))
  4559. (defun org-agenda-skip-entry-if (&rest conditions)
  4560. "Skip entry if any of CONDITIONS is true.
  4561. See `org-agenda-skip-if' for details."
  4562. (org-agenda-skip-if nil conditions))
  4563. (defun org-agenda-skip-subtree-if (&rest conditions)
  4564. "Skip subtree if any of CONDITIONS is true.
  4565. See `org-agenda-skip-if' for details."
  4566. (org-agenda-skip-if t conditions))
  4567. (defun org-agenda-skip-if (subtree conditions)
  4568. "Checks current entity for CONDITIONS.
  4569. If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
  4570. the entry (i.e. the text before the next heading) is checked.
  4571. CONDITIONS is a list of symbols, boolean OR is used to combine the results
  4572. from different tests. Valid conditions are:
  4573. scheduled Check if there is a scheduled cookie
  4574. notscheduled Check if there is no scheduled cookie
  4575. deadline Check if there is a deadline
  4576. notdeadline Check if there is no deadline
  4577. timestamp Check if there is a timestamp (also deadline or scheduled)
  4578. nottimestamp Check if there is no timestamp (also deadline or scheduled)
  4579. regexp Check if regexp matches
  4580. notregexp Check if regexp does not match.
  4581. todo Check if TODO keyword matches
  4582. nottodo Check if TODO keyword does not match
  4583. The regexp is taken from the conditions list, it must come right after
  4584. the `regexp' or `notregexp' element.
  4585. `todo' and `nottodo' accept as an argument a list of todo
  4586. keywords, which may include \"*\" to match any todo keyword.
  4587. (org-agenda-skip-entry-if \\='todo \\='(\"TODO\" \"WAITING\"))
  4588. would skip all entries with \"TODO\" or \"WAITING\" keywords.
  4589. Instead of a list, a keyword class may be given. For example:
  4590. (org-agenda-skip-entry-if \\='nottodo \\='done)
  4591. would skip entries that haven't been marked with any of \"DONE\"
  4592. keywords. Possible classes are: `todo', `done', `any'.
  4593. If any of these conditions is met, this function returns the end point of
  4594. the entity, causing the search to continue from there. This is a function
  4595. that can be put into `org-agenda-skip-function' for the duration of a command."
  4596. (let (beg end m)
  4597. (org-back-to-heading t)
  4598. (setq beg (point)
  4599. end (if subtree
  4600. (progn (org-end-of-subtree t) (point))
  4601. (progn (outline-next-heading) (1- (point)))))
  4602. (goto-char beg)
  4603. (and
  4604. (or
  4605. (and (memq 'scheduled conditions)
  4606. (re-search-forward org-scheduled-time-regexp end t))
  4607. (and (memq 'notscheduled conditions)
  4608. (not (re-search-forward org-scheduled-time-regexp end t)))
  4609. (and (memq 'deadline conditions)
  4610. (re-search-forward org-deadline-time-regexp end t))
  4611. (and (memq 'notdeadline conditions)
  4612. (not (re-search-forward org-deadline-time-regexp end t)))
  4613. (and (memq 'timestamp conditions)
  4614. (re-search-forward org-ts-regexp end t))
  4615. (and (memq 'nottimestamp conditions)
  4616. (not (re-search-forward org-ts-regexp end t)))
  4617. (and (setq m (memq 'regexp conditions))
  4618. (stringp (nth 1 m))
  4619. (re-search-forward (nth 1 m) end t))
  4620. (and (setq m (memq 'notregexp conditions))
  4621. (stringp (nth 1 m))
  4622. (not (re-search-forward (nth 1 m) end t)))
  4623. (and (or
  4624. (setq m (memq 'nottodo conditions))
  4625. (setq m (memq 'todo-unblocked conditions))
  4626. (setq m (memq 'nottodo-unblocked conditions))
  4627. (setq m (memq 'todo conditions)))
  4628. (org-agenda-skip-if-todo m end)))
  4629. end)))
  4630. (defun org-agenda-skip-if-todo (args end)
  4631. "Helper function for `org-agenda-skip-if', do not use it directly.
  4632. ARGS is a list with first element either `todo', `nottodo',
  4633. `todo-unblocked' or `nottodo-unblocked'. The remainder is either
  4634. a list of TODO keywords, or a state symbol `todo' or `done' or
  4635. `any'."
  4636. (let ((kw (car args))
  4637. (arg (cadr args))
  4638. todo-wds todo-re)
  4639. (setq todo-wds
  4640. (org-uniquify
  4641. (cond
  4642. ((listp arg) ;; list of keywords
  4643. (if (member "*" arg)
  4644. (mapcar 'substring-no-properties org-todo-keywords-1)
  4645. arg))
  4646. ((symbolp arg) ;; keyword class name
  4647. (cond
  4648. ((eq arg 'todo)
  4649. (org-delete-all org-done-keywords
  4650. (mapcar 'substring-no-properties
  4651. org-todo-keywords-1)))
  4652. ((eq arg 'done) org-done-keywords)
  4653. ((eq arg 'any)
  4654. (mapcar 'substring-no-properties org-todo-keywords-1)))))))
  4655. (setq todo-re
  4656. (concat "^\\*+[ \t]+\\<\\("
  4657. (mapconcat 'identity todo-wds "\\|")
  4658. "\\)\\>"))
  4659. (cond
  4660. ((eq kw 'todo) (re-search-forward todo-re end t))
  4661. ((eq kw 'nottodo) (not (re-search-forward todo-re end t)))
  4662. ((eq kw 'todo-unblocked)
  4663. (catch 'unblocked
  4664. (while (re-search-forward todo-re end t)
  4665. (or (org-entry-blocked-p) (throw 'unblocked t)))
  4666. nil))
  4667. ((eq kw 'nottodo-unblocked)
  4668. (catch 'unblocked
  4669. (while (re-search-forward todo-re end t)
  4670. (or (org-entry-blocked-p) (throw 'unblocked nil)))
  4671. t))
  4672. )))
  4673. ;;;###autoload
  4674. (defun org-agenda-list-stuck-projects (&rest ignore)
  4675. "Create agenda view for projects that are stuck.
  4676. Stuck projects are project that have no next actions. For the definitions
  4677. of what a project is and how to check if it stuck, customize the variable
  4678. `org-stuck-projects'."
  4679. (interactive)
  4680. (let* ((org-agenda-skip-function
  4681. 'org-agenda-skip-entry-when-regexp-matches-in-subtree)
  4682. ;; We could have used org-agenda-skip-if here.
  4683. (org-agenda-overriding-header
  4684. (or org-agenda-overriding-header "List of stuck projects: "))
  4685. (matcher (nth 0 org-stuck-projects))
  4686. (todo (nth 1 org-stuck-projects))
  4687. (todo-wds (if (member "*" todo)
  4688. (progn
  4689. (org-agenda-prepare-buffers (org-agenda-files
  4690. nil 'ifmode))
  4691. (org-delete-all
  4692. org-done-keywords-for-agenda
  4693. (copy-sequence org-todo-keywords-for-agenda)))
  4694. todo))
  4695. (todo-re (concat "^\\*+[ \t]+\\("
  4696. (mapconcat 'identity todo-wds "\\|")
  4697. "\\)\\>"))
  4698. (tags (nth 2 org-stuck-projects))
  4699. (tags-re (if (member "*" tags)
  4700. (concat org-outline-regexp-bol
  4701. ".*:[[:alnum:]_@#%]+:[ \t]*$")
  4702. (if tags
  4703. (concat org-outline-regexp-bol
  4704. ".*:\\("
  4705. (mapconcat #'identity tags "\\|")
  4706. "\\):[[:alnum:]_@#%:]*[ \t]*$"))))
  4707. (gen-re (nth 3 org-stuck-projects))
  4708. (re-list
  4709. (delq nil
  4710. (list
  4711. (if todo todo-re)
  4712. (if tags tags-re)
  4713. (and gen-re (stringp gen-re) (string-match "\\S-" gen-re)
  4714. gen-re)))))
  4715. (setq org-agenda-skip-regexp
  4716. (if re-list
  4717. (mapconcat 'identity re-list "\\|")
  4718. (error "No information how to identify unstuck projects")))
  4719. (org-tags-view nil matcher)
  4720. (setq org-agenda-buffer-name (buffer-name))
  4721. (with-current-buffer org-agenda-buffer-name
  4722. (setq org-agenda-redo-command
  4723. `(org-agenda-list-stuck-projects ,current-prefix-arg)))))
  4724. ;;; Diary integration
  4725. (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
  4726. (defvar diary-list-entries-hook)
  4727. (defvar diary-time-regexp)
  4728. (defun org-get-entries-from-diary (date)
  4729. "Get the (Emacs Calendar) diary entries for DATE."
  4730. (require 'diary-lib)
  4731. (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
  4732. (diary-display-function 'diary-fancy-display)
  4733. (pop-up-frames nil)
  4734. (diary-list-entries-hook
  4735. (cons 'org-diary-default-entry diary-list-entries-hook))
  4736. (diary-file-name-prefix nil) ; turn this feature off
  4737. (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
  4738. entries
  4739. (org-disable-agenda-to-diary t))
  4740. (save-excursion
  4741. (save-window-excursion
  4742. (funcall (if (fboundp 'diary-list-entries)
  4743. 'diary-list-entries 'list-diary-entries)
  4744. date 1)))
  4745. (if (not (get-buffer diary-fancy-buffer))
  4746. (setq entries nil)
  4747. (with-current-buffer diary-fancy-buffer
  4748. (setq buffer-read-only nil)
  4749. (if (zerop (buffer-size))
  4750. ;; No entries
  4751. (setq entries nil)
  4752. ;; Omit the date and other unnecessary stuff
  4753. (org-agenda-cleanup-fancy-diary)
  4754. ;; Add prefix to each line and extend the text properties
  4755. (if (zerop (buffer-size))
  4756. (setq entries nil)
  4757. (setq entries (buffer-substring (point-min) (- (point-max) 1)))
  4758. (setq entries
  4759. (with-temp-buffer
  4760. (insert entries) (goto-char (point-min))
  4761. (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
  4762. (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
  4763. (replace-match (concat "; " (match-string 1)))))
  4764. (buffer-string)))))
  4765. (set-buffer-modified-p nil)
  4766. (kill-buffer diary-fancy-buffer)))
  4767. (when entries
  4768. (setq entries (org-split-string entries "\n"))
  4769. (setq entries
  4770. (mapcar
  4771. (lambda (x)
  4772. (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
  4773. ;; Extend the text properties to the beginning of the line
  4774. (org-add-props x (text-properties-at (1- (length x)) x)
  4775. 'type "diary" 'date date 'face 'org-agenda-diary))
  4776. entries)))))
  4777. (defvar org-agenda-cleanup-fancy-diary-hook nil
  4778. "Hook run when the fancy diary buffer is cleaned up.")
  4779. (defun org-agenda-cleanup-fancy-diary ()
  4780. "Remove unwanted stuff in buffer created by `fancy-diary-display'.
  4781. This gets rid of the date, the underline under the date, and
  4782. the dummy entry installed by `org-mode' to ensure non-empty diary for each
  4783. date. It also removes lines that contain only whitespace."
  4784. (goto-char (point-min))
  4785. (if (looking-at ".*?:[ \t]*")
  4786. (progn
  4787. (replace-match "")
  4788. (re-search-forward "\n=+$" nil t)
  4789. (replace-match "")
  4790. (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
  4791. (re-search-forward "\n=+$" nil t)
  4792. (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
  4793. (goto-char (point-min))
  4794. (while (re-search-forward "^ +\n" nil t)
  4795. (replace-match ""))
  4796. (goto-char (point-min))
  4797. (if (re-search-forward "^Org-mode dummy\n?" nil t)
  4798. (replace-match ""))
  4799. (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
  4800. ;; Make sure entries from the diary have the right text properties.
  4801. (eval-after-load "diary-lib"
  4802. '(if (boundp 'diary-modify-entry-list-string-function)
  4803. ;; We can rely on the hook, nothing to do
  4804. nil
  4805. ;; Hook not available, must use advice to make this work
  4806. (defadvice add-to-diary-list (before org-mark-diary-entry activate)
  4807. "Make the position visible."
  4808. (if (and org-disable-agenda-to-diary ;; called from org-agenda
  4809. (stringp string)
  4810. buffer-file-name)
  4811. (setq string (org-modify-diary-entry-string string))))))
  4812. (defun org-modify-diary-entry-string (string)
  4813. "Add text properties to string, allowing org-mode to act on it."
  4814. (org-add-props string nil
  4815. 'mouse-face 'highlight
  4816. 'help-echo (if buffer-file-name
  4817. (format "mouse-2 or RET jump to diary file %s"
  4818. (abbreviate-file-name buffer-file-name))
  4819. "")
  4820. 'org-agenda-diary-link t
  4821. 'org-marker (org-agenda-new-marker (point-at-bol))))
  4822. (defun org-diary-default-entry ()
  4823. "Add a dummy entry to the diary.
  4824. Needed to avoid empty dates which mess up holiday display."
  4825. ;; Catch the error if dealing with the new add-to-diary-alist
  4826. (when org-disable-agenda-to-diary
  4827. (condition-case nil
  4828. (org-add-to-diary-list original-date "Org-mode dummy" "")
  4829. (error
  4830. (org-add-to-diary-list original-date "Org-mode dummy" "" nil)))))
  4831. (defun org-add-to-diary-list (&rest args)
  4832. (if (fboundp 'diary-add-to-list)
  4833. (apply 'diary-add-to-list args)
  4834. (apply 'add-to-diary-list args)))
  4835. (defvar org-diary-last-run-time nil)
  4836. ;;;###autoload
  4837. (defun org-diary (&rest args)
  4838. "Return diary information from org files.
  4839. This function can be used in a \"sexp\" diary entry in the Emacs calendar.
  4840. It accesses org files and extracts information from those files to be
  4841. listed in the diary. The function accepts arguments specifying what
  4842. items should be listed. For a list of arguments allowed here, see the
  4843. variable `org-agenda-entry-types'.
  4844. The call in the diary file should look like this:
  4845. &%%(org-diary) ~/path/to/some/orgfile.org
  4846. Use a separate line for each org file to check. Or, if you omit the file name,
  4847. all files listed in `org-agenda-files' will be checked automatically:
  4848. &%%(org-diary)
  4849. If you don't give any arguments (as in the example above), the default value
  4850. of `org-agenda-entry-types' is used: (:deadline :scheduled :timestamp :sexp).
  4851. So the example above may also be written as
  4852. &%%(org-diary :deadline :timestamp :sexp :scheduled)
  4853. The function expects the lisp variables `entry' and `date' to be provided
  4854. by the caller, because this is how the calendar works. Don't use this
  4855. function from a program - use `org-agenda-get-day-entries' instead."
  4856. (when (> (- (float-time)
  4857. org-agenda-last-marker-time)
  4858. 5)
  4859. ;; I am not sure if this works with sticky agendas, because the marker
  4860. ;; list is then no longer a global variable.
  4861. (org-agenda-reset-markers))
  4862. (org-compile-prefix-format 'agenda)
  4863. (org-set-sorting-strategy 'agenda)
  4864. (setq args (or args org-agenda-entry-types))
  4865. (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
  4866. (list entry)
  4867. (org-agenda-files t)))
  4868. (time (float-time))
  4869. file rtn results)
  4870. (when (or (not org-diary-last-run-time)
  4871. (> (- time
  4872. org-diary-last-run-time)
  4873. 3))
  4874. (org-agenda-prepare-buffers files))
  4875. (setq org-diary-last-run-time time)
  4876. ;; If this is called during org-agenda, don't return any entries to
  4877. ;; the calendar. Org Agenda will list these entries itself.
  4878. (if org-disable-agenda-to-diary (setq files nil))
  4879. (while (setq file (pop files))
  4880. (setq rtn (apply 'org-agenda-get-day-entries file date args))
  4881. (setq results (append results rtn)))
  4882. (when results
  4883. (setq results
  4884. (mapcar (lambda (i) (replace-regexp-in-string
  4885. org-bracket-link-regexp "\\3" i)) results))
  4886. (concat (org-agenda-finalize-entries results) "\n"))))
  4887. ;;; Agenda entry finders
  4888. (defun org-agenda--timestamp-to-absolute (&rest args)
  4889. "Call `org-time-string-to-absolute' with ARGS.
  4890. However, throw `:skip' whenever an error is raised."
  4891. (condition-case e
  4892. (apply #'org-time-string-to-absolute args)
  4893. (org-diary-sexp-no-match (throw :skip nil))
  4894. (error
  4895. (message "%s; Skipping entry" (error-message-string e))
  4896. (throw :skip nil))))
  4897. (defun org-agenda-get-day-entries (file date &rest args)
  4898. "Does the work for `org-diary' and `org-agenda'.
  4899. FILE is the path to a file to be checked for entries. DATE is date like
  4900. the one returned by `calendar-current-date'. ARGS are symbols indicating
  4901. which kind of entries should be extracted. For details about these, see
  4902. the documentation of `org-diary'."
  4903. (let* ((org-startup-folded nil)
  4904. (org-startup-align-all-tables nil)
  4905. (buffer (if (file-exists-p file) (org-get-agenda-file-buffer file)
  4906. (error "No such file %s" file))))
  4907. (if (not buffer)
  4908. ;; If file does not exist, signal it in diary nonetheless.
  4909. (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4910. (with-current-buffer buffer
  4911. (unless (derived-mode-p 'org-mode)
  4912. (error "Agenda file %s is not in `org-mode'" file))
  4913. (setq org-agenda-buffer (or org-agenda-buffer buffer))
  4914. (setf org-agenda-current-date date)
  4915. (save-excursion
  4916. (save-restriction
  4917. (if (eq buffer org-agenda-restrict)
  4918. (narrow-to-region org-agenda-restrict-begin
  4919. org-agenda-restrict-end)
  4920. (widen))
  4921. ;; Rationalize ARGS. Also make sure `:deadline' comes
  4922. ;; first in order to populate DEADLINES before passing it.
  4923. ;;
  4924. ;; We use `delq' since `org-uniquify' duplicates ARGS,
  4925. ;; guarding us from modifying `org-agenda-entry-types'.
  4926. (setf args (org-uniquify (or args org-agenda-entry-types)))
  4927. (when (and (memq :scheduled args) (memq :scheduled* args))
  4928. (setf args (delq :scheduled* args)))
  4929. (cond
  4930. ((memq :deadline args)
  4931. (setf args (cons :deadline
  4932. (delq :deadline (delq :deadline* args)))))
  4933. ((memq :deadline* args)
  4934. (setf args (cons :deadline* (delq :deadline* args)))))
  4935. ;; Collect list of headlines. Return them flattened.
  4936. (let ((case-fold-search nil) results deadlines)
  4937. (dolist (arg args (apply #'nconc (nreverse results)))
  4938. (pcase arg
  4939. ((and :todo (guard (org-agenda-today-p date)))
  4940. (push (org-agenda-get-todos) results))
  4941. (:timestamp
  4942. (push (org-agenda-get-blocks) results)
  4943. (push (org-agenda-get-timestamps deadlines) results))
  4944. (:sexp
  4945. (push (org-agenda-get-sexps) results))
  4946. (:scheduled
  4947. (push (org-agenda-get-scheduled deadlines) results))
  4948. (:scheduled*
  4949. (push (org-agenda-get-scheduled deadlines t) results))
  4950. (:closed
  4951. (push (org-agenda-get-progress) results))
  4952. (:deadline
  4953. (setf deadlines (org-agenda-get-deadlines))
  4954. (push deadlines results))
  4955. (:deadline*
  4956. (setf deadlines (org-agenda-get-deadlines t))
  4957. (push deadlines results)))))))))))
  4958. (defsubst org-em (x y list)
  4959. "Is X or Y a member of LIST?"
  4960. (or (memq x list) (memq y list)))
  4961. (defvar org-heading-keyword-regexp-format) ; defined in org.el
  4962. (defvar org-agenda-sorting-strategy-selected nil)
  4963. (defun org-agenda-entry-get-agenda-timestamp (pom)
  4964. "Retrieve timestamp information for sorting agenda views.
  4965. Given a point or marker POM, returns a cons cell of the timestamp
  4966. and the timestamp type relevant for the sorting strategy in
  4967. `org-agenda-sorting-strategy-selected'."
  4968. (let (ts ts-date-type)
  4969. (save-match-data
  4970. (cond ((org-em 'scheduled-up 'scheduled-down
  4971. org-agenda-sorting-strategy-selected)
  4972. (setq ts (org-entry-get pom "SCHEDULED")
  4973. ts-date-type " scheduled"))
  4974. ((org-em 'deadline-up 'deadline-down
  4975. org-agenda-sorting-strategy-selected)
  4976. (setq ts (org-entry-get pom "DEADLINE")
  4977. ts-date-type " deadline"))
  4978. ((org-em 'ts-up 'ts-down
  4979. org-agenda-sorting-strategy-selected)
  4980. (setq ts (org-entry-get pom "TIMESTAMP")
  4981. ts-date-type " timestamp"))
  4982. ((org-em 'tsia-up 'tsia-down
  4983. org-agenda-sorting-strategy-selected)
  4984. (setq ts (org-entry-get pom "TIMESTAMP_IA")
  4985. ts-date-type " timestamp_ia"))
  4986. ((org-em 'timestamp-up 'timestamp-down
  4987. org-agenda-sorting-strategy-selected)
  4988. (setq ts (or (org-entry-get pom "SCHEDULED")
  4989. (org-entry-get pom "DEADLINE")
  4990. (org-entry-get pom "TIMESTAMP")
  4991. (org-entry-get pom "TIMESTAMP_IA"))
  4992. ts-date-type ""))
  4993. (t (setq ts-date-type "")))
  4994. (cons (when ts (ignore-errors (org-time-string-to-absolute ts)))
  4995. ts-date-type))))
  4996. (defun org-agenda-get-todos ()
  4997. "Return the TODO information for agenda display."
  4998. (let* ((props (list 'face nil
  4999. 'done-face 'org-agenda-done
  5000. 'org-not-done-regexp org-not-done-regexp
  5001. 'org-todo-regexp org-todo-regexp
  5002. 'org-complex-heading-regexp org-complex-heading-regexp
  5003. 'mouse-face 'highlight
  5004. 'help-echo
  5005. (format "mouse-2 or RET jump to org file %s"
  5006. (abbreviate-file-name buffer-file-name))))
  5007. (regexp (format org-heading-keyword-regexp-format
  5008. (cond
  5009. ((and org-select-this-todo-keyword
  5010. (equal org-select-this-todo-keyword "*"))
  5011. org-todo-regexp)
  5012. (org-select-this-todo-keyword
  5013. (concat "\\("
  5014. (mapconcat 'identity
  5015. (org-split-string
  5016. org-select-this-todo-keyword
  5017. "|")
  5018. "\\|") "\\)"))
  5019. (t org-not-done-regexp))))
  5020. marker priority category level tags todo-state
  5021. ts-date ts-date-type ts-date-pair
  5022. ee txt beg end inherited-tags todo-state-end-pos)
  5023. (goto-char (point-min))
  5024. (while (re-search-forward regexp nil t)
  5025. (catch :skip
  5026. (save-match-data
  5027. (beginning-of-line)
  5028. (org-agenda-skip)
  5029. (setq beg (point) end (save-excursion (outline-next-heading) (point)))
  5030. (unless (and (setq todo-state (org-get-todo-state))
  5031. (setq todo-state-end-pos (match-end 2)))
  5032. (goto-char end)
  5033. (throw :skip nil))
  5034. (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
  5035. (goto-char (1+ beg))
  5036. (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
  5037. (throw :skip nil)))
  5038. (goto-char (match-beginning 2))
  5039. (setq marker (org-agenda-new-marker (match-beginning 0))
  5040. category (org-get-category)
  5041. ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
  5042. ts-date (car ts-date-pair)
  5043. ts-date-type (cdr ts-date-pair)
  5044. txt (org-trim (buffer-substring (match-beginning 2) (match-end 0)))
  5045. inherited-tags
  5046. (or (eq org-agenda-show-inherited-tags 'always)
  5047. (and (listp org-agenda-show-inherited-tags)
  5048. (memq 'todo org-agenda-show-inherited-tags))
  5049. (and (eq org-agenda-show-inherited-tags t)
  5050. (or (eq org-agenda-use-tag-inheritance t)
  5051. (memq 'todo org-agenda-use-tag-inheritance))))
  5052. tags (org-get-tags-at nil (not inherited-tags))
  5053. level (make-string (org-reduced-level (org-outline-level)) ? )
  5054. txt (org-agenda-format-item "" txt level category tags t)
  5055. priority (1+ (org-get-priority txt)))
  5056. (org-add-props txt props
  5057. 'org-marker marker 'org-hd-marker marker
  5058. 'priority priority
  5059. 'level level
  5060. 'ts-date ts-date
  5061. 'type (concat "todo" ts-date-type) 'todo-state todo-state)
  5062. (push txt ee)
  5063. (if org-agenda-todo-list-sublevels
  5064. (goto-char todo-state-end-pos)
  5065. (org-end-of-subtree 'invisible))))
  5066. (nreverse ee)))
  5067. (defun org-agenda-todo-custom-ignore-p (time n)
  5068. "Check whether timestamp is farther away than n number of days.
  5069. This function is invoked if `org-agenda-todo-ignore-deadlines',
  5070. `org-agenda-todo-ignore-scheduled' or
  5071. `org-agenda-todo-ignore-timestamp' is set to an integer."
  5072. (let ((days (org-time-stamp-to-now
  5073. time org-agenda-todo-ignore-time-comparison-use-seconds)))
  5074. (if (>= n 0)
  5075. (>= days n)
  5076. (<= days n))))
  5077. ;;;###autoload
  5078. (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  5079. (&optional end)
  5080. "Do we have a reason to ignore this TODO entry because it has a time stamp?"
  5081. (when (or org-agenda-todo-ignore-with-date
  5082. org-agenda-todo-ignore-scheduled
  5083. org-agenda-todo-ignore-deadlines
  5084. org-agenda-todo-ignore-timestamp)
  5085. (setq end (or end (save-excursion (outline-next-heading) (point))))
  5086. (save-excursion
  5087. (or (and org-agenda-todo-ignore-with-date
  5088. (re-search-forward org-ts-regexp end t))
  5089. (and org-agenda-todo-ignore-scheduled
  5090. (re-search-forward org-scheduled-time-regexp end t)
  5091. (cond
  5092. ((eq org-agenda-todo-ignore-scheduled 'future)
  5093. (> (org-time-stamp-to-now
  5094. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5095. ((eq org-agenda-todo-ignore-scheduled 'past)
  5096. (<= (org-time-stamp-to-now
  5097. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5098. ((numberp org-agenda-todo-ignore-scheduled)
  5099. (org-agenda-todo-custom-ignore-p
  5100. (match-string 1) org-agenda-todo-ignore-scheduled))
  5101. (t)))
  5102. (and org-agenda-todo-ignore-deadlines
  5103. (re-search-forward org-deadline-time-regexp end t)
  5104. (cond
  5105. ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
  5106. ((eq org-agenda-todo-ignore-deadlines 'far)
  5107. (not (org-deadline-close-p (match-string 1))))
  5108. ((eq org-agenda-todo-ignore-deadlines 'future)
  5109. (> (org-time-stamp-to-now
  5110. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5111. ((eq org-agenda-todo-ignore-deadlines 'past)
  5112. (<= (org-time-stamp-to-now
  5113. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5114. ((numberp org-agenda-todo-ignore-deadlines)
  5115. (org-agenda-todo-custom-ignore-p
  5116. (match-string 1) org-agenda-todo-ignore-deadlines))
  5117. (t (org-deadline-close-p (match-string 1)))))
  5118. (and org-agenda-todo-ignore-timestamp
  5119. (let ((buffer (current-buffer))
  5120. (regexp
  5121. (concat
  5122. org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
  5123. (start (point)))
  5124. ;; Copy current buffer into a temporary one
  5125. (with-temp-buffer
  5126. (insert-buffer-substring buffer start end)
  5127. (goto-char (point-min))
  5128. ;; Delete SCHEDULED and DEADLINE items
  5129. (while (re-search-forward regexp end t)
  5130. (delete-region (match-beginning 0) (match-end 0)))
  5131. (goto-char (point-min))
  5132. ;; No search for timestamp left
  5133. (when (re-search-forward org-ts-regexp nil t)
  5134. (cond
  5135. ((eq org-agenda-todo-ignore-timestamp 'future)
  5136. (> (org-time-stamp-to-now
  5137. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5138. ((eq org-agenda-todo-ignore-timestamp 'past)
  5139. (<= (org-time-stamp-to-now
  5140. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5141. ((numberp org-agenda-todo-ignore-timestamp)
  5142. (org-agenda-todo-custom-ignore-p
  5143. (match-string 1) org-agenda-todo-ignore-timestamp))
  5144. (t))))))))))
  5145. (defun org-agenda-get-timestamps (&optional deadline-results)
  5146. "Return the date stamp information for agenda display."
  5147. (let* ((props (list 'face 'org-agenda-calendar-event
  5148. 'org-not-done-regexp org-not-done-regexp
  5149. 'org-todo-regexp org-todo-regexp
  5150. 'org-complex-heading-regexp org-complex-heading-regexp
  5151. 'mouse-face 'highlight
  5152. 'help-echo
  5153. (format "mouse-2 or RET jump to org file %s"
  5154. (abbreviate-file-name buffer-file-name))))
  5155. (d1 (calendar-absolute-from-gregorian date))
  5156. mm
  5157. (deadline-position-alist
  5158. (mapcar (lambda (a) (and (setq mm (get-text-property
  5159. 0 'org-hd-marker a))
  5160. (cons (marker-position mm) a)))
  5161. deadline-results))
  5162. (remove-re org-ts-regexp)
  5163. (regexp
  5164. (concat
  5165. (if org-agenda-include-inactive-timestamps "[[<]" "<")
  5166. (regexp-quote
  5167. (substring
  5168. (format-time-string
  5169. (car org-time-stamp-formats)
  5170. (apply 'encode-time ; DATE bound by calendar
  5171. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  5172. 1 11))
  5173. "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
  5174. "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
  5175. marker hdmarker deadlinep scheduledp clockp closedp inactivep
  5176. donep tmp priority category level ee txt timestr tags
  5177. b0 b3 e3 head todo-state end-of-match show-all warntime habitp
  5178. inherited-tags ts-date)
  5179. (goto-char (point-min))
  5180. (while (setq end-of-match (re-search-forward regexp nil t))
  5181. (setq b0 (match-beginning 0)
  5182. b3 (match-beginning 3) e3 (match-end 3)
  5183. todo-state (save-match-data (ignore-errors (org-get-todo-state)))
  5184. habitp (and (functionp 'org-is-habit-p) (save-match-data (org-is-habit-p)))
  5185. show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  5186. (member todo-state
  5187. org-agenda-repeating-timestamp-show-all)))
  5188. (catch :skip
  5189. (and (org-at-date-range-p) (throw :skip nil))
  5190. (org-agenda-skip)
  5191. (if (and (match-end 1)
  5192. (not (= d1 (org-agenda--timestamp-to-absolute
  5193. (match-string 1) d1 nil show-all
  5194. (current-buffer) b0))))
  5195. (throw :skip nil))
  5196. (if (and e3
  5197. (not (org-diary-sexp-entry (buffer-substring b3 e3) "" date)))
  5198. (throw :skip nil))
  5199. (setq tmp (buffer-substring (max (point-min)
  5200. (- b0 org-ds-keyword-length))
  5201. b0)
  5202. timestr (if b3 "" (buffer-substring b0 (point-at-eol)))
  5203. inactivep (= (char-after b0) ?\[)
  5204. deadlinep (string-match org-deadline-regexp tmp)
  5205. scheduledp (string-match org-scheduled-regexp tmp)
  5206. closedp (and org-agenda-include-inactive-timestamps
  5207. (string-match org-closed-string tmp))
  5208. clockp (and org-agenda-include-inactive-timestamps
  5209. (or (string-match org-clock-string tmp)
  5210. (string-match "]-+\\'" tmp)))
  5211. warntime (get-text-property (point) 'org-appt-warntime)
  5212. donep (member todo-state org-done-keywords))
  5213. (if (or scheduledp deadlinep closedp clockp
  5214. (and donep org-agenda-skip-timestamp-if-done))
  5215. (throw :skip t))
  5216. (if (string-match ">" timestr)
  5217. ;; substring should only run to end of time stamp
  5218. (setq timestr (substring timestr 0 (match-end 0))))
  5219. (setq marker (org-agenda-new-marker b0)
  5220. category (org-get-category b0))
  5221. (save-excursion
  5222. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5223. (throw :skip nil)
  5224. (goto-char (match-beginning 0))
  5225. (if (and (eq t org-agenda-skip-timestamp-if-deadline-is-shown)
  5226. (assoc (point) deadline-position-alist))
  5227. (throw :skip nil))
  5228. (setq hdmarker (org-agenda-new-marker)
  5229. inherited-tags
  5230. (or (eq org-agenda-show-inherited-tags 'always)
  5231. (and (listp org-agenda-show-inherited-tags)
  5232. (memq 'agenda org-agenda-show-inherited-tags))
  5233. (and (eq org-agenda-show-inherited-tags t)
  5234. (or (eq org-agenda-use-tag-inheritance t)
  5235. (memq 'agenda org-agenda-use-tag-inheritance))))
  5236. tags (org-get-tags-at nil (not inherited-tags))
  5237. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5238. (looking-at "\\*+[ \t]+\\(.*\\)")
  5239. (setq head (match-string 1))
  5240. (setq txt (org-agenda-format-item
  5241. (if inactivep org-agenda-inactive-leader nil)
  5242. head level category tags timestr
  5243. remove-re habitp)))
  5244. (setq priority (org-get-priority txt))
  5245. (org-add-props txt props 'priority priority
  5246. 'org-marker marker 'org-hd-marker hdmarker
  5247. 'date date
  5248. 'level level
  5249. 'ts-date
  5250. (ignore-errors (org-time-string-to-absolute timestr))
  5251. 'todo-state todo-state
  5252. 'warntime warntime
  5253. 'type "timestamp")
  5254. (push txt ee))
  5255. (if org-agenda-skip-additional-timestamps-same-entry
  5256. (outline-next-heading)
  5257. (goto-char end-of-match))))
  5258. (nreverse ee)))
  5259. (defun org-agenda-get-sexps ()
  5260. "Return the sexp information for agenda display."
  5261. (require 'diary-lib)
  5262. (let* ((props (list 'face 'org-agenda-calendar-sexp
  5263. 'mouse-face 'highlight
  5264. 'help-echo
  5265. (format "mouse-2 or RET jump to org file %s"
  5266. (abbreviate-file-name buffer-file-name))))
  5267. (regexp "^&?%%(")
  5268. marker category extra level ee txt tags entry
  5269. result beg b sexp sexp-entry todo-state warntime inherited-tags)
  5270. (goto-char (point-min))
  5271. (while (re-search-forward regexp nil t)
  5272. (catch :skip
  5273. (org-agenda-skip)
  5274. (setq beg (match-beginning 0))
  5275. (goto-char (1- (match-end 0)))
  5276. (setq b (point))
  5277. (forward-sexp 1)
  5278. (setq sexp (buffer-substring b (point)))
  5279. (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
  5280. (org-trim (match-string 1))
  5281. ""))
  5282. (setq result (org-diary-sexp-entry sexp sexp-entry date))
  5283. (when result
  5284. (setq marker (org-agenda-new-marker beg)
  5285. level (make-string (org-reduced-level (org-outline-level)) ? )
  5286. category (org-get-category beg)
  5287. inherited-tags
  5288. (or (eq org-agenda-show-inherited-tags 'always)
  5289. (and (listp org-agenda-show-inherited-tags)
  5290. (memq 'agenda org-agenda-show-inherited-tags))
  5291. (and (eq org-agenda-show-inherited-tags t)
  5292. (or (eq org-agenda-use-tag-inheritance t)
  5293. (memq 'agenda org-agenda-use-tag-inheritance))))
  5294. tags (org-get-tags-at nil (not inherited-tags))
  5295. todo-state (org-get-todo-state)
  5296. warntime (get-text-property (point) 'org-appt-warntime)
  5297. extra nil)
  5298. (dolist (r (if (stringp result)
  5299. (list result)
  5300. result)) ;; we expect a list here
  5301. (when (and org-agenda-diary-sexp-prefix
  5302. (string-match org-agenda-diary-sexp-prefix r))
  5303. (setq extra (match-string 0 r)
  5304. r (replace-match "" nil nil r)))
  5305. (if (string-match "\\S-" r)
  5306. (setq txt r)
  5307. (setq txt "SEXP entry returned empty string"))
  5308. (setq txt (org-agenda-format-item extra txt level category tags 'time))
  5309. (org-add-props txt props 'org-marker marker
  5310. 'date date 'todo-state todo-state
  5311. 'level level 'type "sexp" 'warntime warntime)
  5312. (push txt ee)))))
  5313. (nreverse ee)))
  5314. ;; Calendar sanity: define some functions that are independent of
  5315. ;; `calendar-date-style'.
  5316. (defun org-anniversary (year month day &optional mark)
  5317. "Like `diary-anniversary', but with fixed (ISO) order of arguments."
  5318. (with-no-warnings
  5319. (let ((calendar-date-style 'iso))
  5320. (diary-anniversary year month day mark))))
  5321. (defun org-cyclic (N year month day &optional mark)
  5322. "Like `diary-cyclic', but with fixed (ISO) order of arguments."
  5323. (with-no-warnings
  5324. (let ((calendar-date-style 'iso))
  5325. (diary-cyclic N year month day mark))))
  5326. (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
  5327. "Like `diary-block', but with fixed (ISO) order of arguments."
  5328. (with-no-warnings
  5329. (let ((calendar-date-style 'iso))
  5330. (diary-block Y1 M1 D1 Y2 M2 D2 mark))))
  5331. (defun org-date (year month day &optional mark)
  5332. "Like `diary-date', but with fixed (ISO) order of arguments."
  5333. (with-no-warnings
  5334. (let ((calendar-date-style 'iso))
  5335. (diary-date year month day mark))))
  5336. ;; Define the `org-class' function
  5337. (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
  5338. "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
  5339. DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
  5340. SKIP-WEEKS is any number of ISO weeks in the block period for which the
  5341. item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
  5342. `holidays', then any date that is known by the Emacs calendar to be a
  5343. holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
  5344. then those holidays will be skipped."
  5345. (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
  5346. (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
  5347. (d (calendar-absolute-from-gregorian date))
  5348. (h (when skip-weeks (calendar-check-holidays date))))
  5349. (and
  5350. (<= date1 d)
  5351. (<= d date2)
  5352. (= (calendar-day-of-week date) dayname)
  5353. (or (not skip-weeks)
  5354. (progn
  5355. (require 'cal-iso)
  5356. (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
  5357. (not (or (and h (memq 'holidays skip-weeks))
  5358. (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
  5359. entry)))
  5360. (defalias 'org-get-closed 'org-agenda-get-progress)
  5361. (defun org-agenda-get-progress ()
  5362. "Return the logged TODO entries for agenda display."
  5363. (let* ((props (list 'mouse-face 'highlight
  5364. 'org-not-done-regexp org-not-done-regexp
  5365. 'org-todo-regexp org-todo-regexp
  5366. 'org-complex-heading-regexp org-complex-heading-regexp
  5367. 'help-echo
  5368. (format "mouse-2 or RET jump to org file %s"
  5369. (abbreviate-file-name buffer-file-name))))
  5370. (items (if (consp org-agenda-show-log-scoped)
  5371. org-agenda-show-log-scoped
  5372. (if (eq org-agenda-show-log-scoped 'clockcheck)
  5373. '(clock)
  5374. org-agenda-log-mode-items)))
  5375. (parts
  5376. (delq nil
  5377. (list
  5378. (if (memq 'closed items) (concat "\\<" org-closed-string))
  5379. (if (memq 'clock items) (concat "\\<" org-clock-string))
  5380. (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
  5381. (parts-re (if parts (mapconcat 'identity parts "\\|")
  5382. (error "`org-agenda-log-mode-items' is empty")))
  5383. (regexp (concat
  5384. "\\(" parts-re "\\)"
  5385. " *\\["
  5386. (regexp-quote
  5387. (substring
  5388. (format-time-string
  5389. (car org-time-stamp-formats)
  5390. (apply 'encode-time ; DATE bound by calendar
  5391. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  5392. 1 11))))
  5393. (org-agenda-search-headline-for-time nil)
  5394. marker hdmarker priority category level tags closedp
  5395. statep clockp state ee txt extra timestr rest clocked inherited-tags)
  5396. (goto-char (point-min))
  5397. (while (re-search-forward regexp nil t)
  5398. (catch :skip
  5399. (org-agenda-skip)
  5400. (setq marker (org-agenda-new-marker (match-beginning 0))
  5401. closedp (equal (match-string 1) org-closed-string)
  5402. statep (equal (string-to-char (match-string 1)) ?-)
  5403. clockp (not (or closedp statep))
  5404. state (and statep (match-string 2))
  5405. category (org-get-category (match-beginning 0))
  5406. timestr (buffer-substring (match-beginning 0) (point-at-eol)))
  5407. (when (string-match "\\]" timestr)
  5408. ;; substring should only run to end of time stamp
  5409. (setq rest (substring timestr (match-end 0))
  5410. timestr (substring timestr 0 (match-end 0)))
  5411. (if (and (not closedp) (not statep)
  5412. (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
  5413. rest))
  5414. (progn (setq timestr (concat (substring timestr 0 -1)
  5415. "-" (match-string 1 rest) "]"))
  5416. (setq clocked (match-string 2 rest)))
  5417. (setq clocked "-")))
  5418. (save-excursion
  5419. (setq extra
  5420. (cond
  5421. ((not org-agenda-log-mode-add-notes) nil)
  5422. (statep
  5423. (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
  5424. (match-string 1)))
  5425. (clockp
  5426. (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
  5427. (match-string 1)))))
  5428. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5429. (throw :skip nil)
  5430. (goto-char (match-beginning 0))
  5431. (setq hdmarker (org-agenda-new-marker)
  5432. inherited-tags
  5433. (or (eq org-agenda-show-inherited-tags 'always)
  5434. (and (listp org-agenda-show-inherited-tags)
  5435. (memq 'todo org-agenda-show-inherited-tags))
  5436. (and (eq org-agenda-show-inherited-tags t)
  5437. (or (eq org-agenda-use-tag-inheritance t)
  5438. (memq 'todo org-agenda-use-tag-inheritance))))
  5439. tags (org-get-tags-at nil (not inherited-tags))
  5440. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5441. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5442. (setq txt (match-string 1))
  5443. (when extra
  5444. (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
  5445. (setq txt (concat (substring txt 0 (match-beginning 1))
  5446. " - " extra " " (match-string 2 txt)))
  5447. (setq txt (concat txt " - " extra))))
  5448. (setq txt (org-agenda-format-item
  5449. (cond
  5450. (closedp "Closed: ")
  5451. (statep (concat "State: (" state ")"))
  5452. (t (concat "Clocked: (" clocked ")")))
  5453. txt level category tags timestr)))
  5454. (setq priority 100000)
  5455. (org-add-props txt props
  5456. 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
  5457. 'priority priority 'level level
  5458. 'type "closed" 'date date
  5459. 'undone-face 'org-warning 'done-face 'org-agenda-done)
  5460. (push txt ee))
  5461. (goto-char (point-at-eol))))
  5462. (nreverse ee)))
  5463. (defun org-agenda-show-clocking-issues ()
  5464. "Add overlays, showing issues with clocking.
  5465. See also the user option `org-agenda-clock-consistency-checks'."
  5466. (interactive)
  5467. (let* ((org-time-clocksum-use-effort-durations nil)
  5468. (pl org-agenda-clock-consistency-checks)
  5469. (re (concat "^[ \t]*"
  5470. org-clock-string
  5471. "[ \t]+"
  5472. "\\(\\[.*?\\]\\)" ; group 1 is first stamp
  5473. "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
  5474. (tlstart 0.)
  5475. (tlend 0.)
  5476. (maxtime (org-hh:mm-string-to-minutes
  5477. (or (plist-get pl :max-duration) "24:00")))
  5478. (mintime (org-hh:mm-string-to-minutes
  5479. (or (plist-get pl :min-duration) 0)))
  5480. (maxgap (org-hh:mm-string-to-minutes
  5481. ;; default 30:00 means never complain
  5482. (or (plist-get pl :max-gap) "30:00")))
  5483. (gapok (mapcar 'org-hh:mm-string-to-minutes
  5484. (plist-get pl :gap-ok-around)))
  5485. (def-face (or (plist-get pl :default-face)
  5486. '((:background "DarkRed") (:foreground "white"))))
  5487. issue face m te ts dt ov)
  5488. (goto-char (point-min))
  5489. (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
  5490. (setq issue nil face def-face)
  5491. (catch 'next
  5492. (setq m (org-get-at-bol 'org-marker)
  5493. te nil ts nil)
  5494. (unless (and m (markerp m))
  5495. (setq issue "No valid clock line") (throw 'next t))
  5496. (org-with-point-at m
  5497. (save-excursion
  5498. (goto-char (point-at-bol))
  5499. (unless (looking-at re)
  5500. (error "No valid Clock line")
  5501. (throw 'next t))
  5502. (unless (match-end 3)
  5503. (setq issue "No end time"
  5504. face (or (plist-get pl :no-end-time-face) face))
  5505. (throw 'next t))
  5506. (setq ts (match-string 1)
  5507. te (match-string 3)
  5508. ts (float-time
  5509. (apply #'encode-time (org-parse-time-string ts)))
  5510. te (float-time
  5511. (apply #'encode-time (org-parse-time-string te)))
  5512. dt (- te ts))))
  5513. (cond
  5514. ((> dt (* 60 maxtime))
  5515. ;; a very long clocking chunk
  5516. (setq issue (format "Clocking interval is very long: %s"
  5517. (org-minutes-to-clocksum-string
  5518. (floor (/ (float dt) 60.))))
  5519. face (or (plist-get pl :long-face) face)))
  5520. ((< dt (* 60 mintime))
  5521. ;; a very short clocking chunk
  5522. (setq issue (format "Clocking interval is very short: %s"
  5523. (org-minutes-to-clocksum-string
  5524. (floor (/ (float dt) 60.))))
  5525. face (or (plist-get pl :short-face) face)))
  5526. ((and (> tlend 0) (< ts tlend))
  5527. ;; Two clock entries are overlapping
  5528. (setq issue (format "Clocking overlap: %d minutes"
  5529. (/ (- tlend ts) 60))
  5530. face (or (plist-get pl :overlap-face) face)))
  5531. ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
  5532. ;; There is a gap, lets see if we need to report it
  5533. (unless (org-agenda-check-clock-gap tlend ts gapok)
  5534. (setq issue (format "Clocking gap: %d minutes"
  5535. (/ (- ts tlend) 60))
  5536. face (or (plist-get pl :gap-face) face))))
  5537. (t nil)))
  5538. (setq tlend (or te tlend) tlstart (or ts tlstart))
  5539. (when issue
  5540. ;; OK, there was some issue, add an overlay to show the issue
  5541. (setq ov (make-overlay (point-at-bol) (point-at-eol)))
  5542. (overlay-put ov 'before-string
  5543. (concat
  5544. (org-add-props
  5545. (format "%-43s" (concat " " issue))
  5546. nil
  5547. 'face face)
  5548. "\n"))
  5549. (overlay-put ov 'evaporate t)))))
  5550. (defun org-agenda-check-clock-gap (t1 t2 ok-list)
  5551. "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
  5552. (catch 'exit
  5553. (unless ok-list
  5554. ;; there are no OK times for gaps...
  5555. (throw 'exit nil))
  5556. (if (> (- (/ t2 36000) (/ t1 36000)) 24)
  5557. ;; This is more than 24 hours, so it is OK.
  5558. ;; because we have at least one OK time, that must be in the
  5559. ;; 24 hour interval.
  5560. (throw 'exit t))
  5561. ;; We have a shorter gap.
  5562. ;; Now we have to get the minute of the day when these times are
  5563. (let* ((t1dec (decode-time (seconds-to-time t1)))
  5564. (t2dec (decode-time (seconds-to-time t2)))
  5565. ;; compute the minute on the day
  5566. (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
  5567. (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
  5568. (when (< min2 min1)
  5569. ;; if min2 is smaller than min1, this means it is on the next day.
  5570. ;; Wrap it to after midnight.
  5571. (setq min2 (+ min2 1440)))
  5572. ;; Now check if any of the OK times is in the gap
  5573. (mapc (lambda (x)
  5574. ;; Wrap the time to after midnight if necessary
  5575. (if (< x min1) (setq x (+ x 1440)))
  5576. ;; Check if in interval
  5577. (and (<= min1 x) (>= min2 x) (throw 'exit t)))
  5578. ok-list)
  5579. ;; Nope, this gap is not OK
  5580. nil)))
  5581. (defun org-agenda-get-deadlines (&optional with-hour)
  5582. "Return the deadline information for agenda display.
  5583. When WITH-HOUR is non-nil, only return deadlines with an hour
  5584. specification like [h]h:mm."
  5585. (let* ((props (list 'mouse-face 'highlight
  5586. 'org-not-done-regexp org-not-done-regexp
  5587. 'org-todo-regexp org-todo-regexp
  5588. 'org-complex-heading-regexp org-complex-heading-regexp
  5589. 'help-echo
  5590. (format "mouse-2 or RET jump to org file %s"
  5591. (abbreviate-file-name buffer-file-name))))
  5592. (regexp (if with-hour
  5593. org-deadline-time-hour-regexp
  5594. org-deadline-time-regexp))
  5595. (todayp (org-agenda-today-p date)) ; DATE bound by calendar.
  5596. (current (calendar-absolute-from-gregorian date))
  5597. deadline-items)
  5598. (goto-char (point-min))
  5599. (while (re-search-forward regexp nil t)
  5600. (catch :skip
  5601. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5602. (org-agenda-skip)
  5603. (let* ((s (match-string 1))
  5604. (pos (1- (match-beginning 1)))
  5605. (todo-state (save-match-data (org-get-todo-state)))
  5606. (donep (member todo-state org-done-keywords))
  5607. (show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  5608. (member todo-state
  5609. org-agenda-repeating-timestamp-show-all)))
  5610. ;; DEADLINE is the current scheduled date. When it
  5611. ;; contains a repeater and SHOW-ALL is non-nil,
  5612. ;; LAST-REPEAT is the repeat closest to CURRENT.
  5613. ;; Otherwise, LAST-REPEAT is equal to DEADLINE.
  5614. (last-repeat (org-agenda--timestamp-to-absolute
  5615. s current 'past show-all (current-buffer) pos))
  5616. (deadline (org-agenda--timestamp-to-absolute s current))
  5617. (diff (- last-repeat current))
  5618. (suppress-prewarning
  5619. (let ((scheduled
  5620. (and org-agenda-skip-deadline-prewarning-if-scheduled
  5621. (org-entry-get nil "SCHEDULED"))))
  5622. (cond
  5623. ((not scheduled) nil)
  5624. ;; The current item has a scheduled date, so
  5625. ;; evaluate its prewarning lead time.
  5626. ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
  5627. ;; Use global prewarning-restart lead time.
  5628. org-agenda-skip-deadline-prewarning-if-scheduled)
  5629. ((eq org-agenda-skip-deadline-prewarning-if-scheduled
  5630. 'pre-scheduled)
  5631. ;; Set pre-warning to no earlier than SCHEDULED.
  5632. (min (- last-repeat
  5633. (org-agenda--timestamp-to-absolute
  5634. scheduled current 'past show-all
  5635. (current-buffer)
  5636. (save-excursion
  5637. (beginning-of-line)
  5638. (1+ (search-forward org-deadline-string)))))
  5639. org-deadline-warning-days))
  5640. ;; Set pre-warning to deadline.
  5641. (t 0))))
  5642. (wdays (if suppress-prewarning
  5643. (let ((org-deadline-warning-days suppress-prewarning))
  5644. (org-get-wdays s))
  5645. (org-get-wdays s))))
  5646. ;; When to show a deadline in the calendar: if the
  5647. ;; expiration is within WDAYS warning time. Past-due
  5648. ;; deadlines are only shown on the current date
  5649. (unless (or (and (<= diff wdays)
  5650. (and todayp (not org-agenda-only-exact-dates)))
  5651. (= diff 0))
  5652. (throw :skip nil))
  5653. ;; Skip done tasks if `org-agenda-skip-deadline-if-done' is
  5654. ;; non-nil or if it isn't applicable to CURRENT deadline.
  5655. (when (and donep
  5656. (or org-agenda-skip-deadline-if-done
  5657. (/= deadline current)))
  5658. (throw :skip nil))
  5659. (save-excursion
  5660. (re-search-backward "^\\*+[ \t]+" nil t)
  5661. (goto-char (match-end 0))
  5662. (let* ((category (org-get-category))
  5663. (level
  5664. (make-string (org-reduced-level (org-outline-level)) ?\s))
  5665. (head (buffer-substring (point) (line-end-position)))
  5666. (inherited-tags
  5667. (or (eq org-agenda-show-inherited-tags 'always)
  5668. (and (listp org-agenda-show-inherited-tags)
  5669. (memq 'agenda org-agenda-show-inherited-tags))
  5670. (and (eq org-agenda-show-inherited-tags t)
  5671. (or (eq org-agenda-use-tag-inheritance t)
  5672. (memq 'agenda
  5673. org-agenda-use-tag-inheritance)))))
  5674. (tags (org-get-tags-at nil (not inherited-tags)))
  5675. (timestr
  5676. (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5677. (concat (substring s (match-beginning 1)) " ")
  5678. 'time))
  5679. (item
  5680. (org-agenda-format-item
  5681. ;; For past deadlines, make sure to report time
  5682. ;; difference since date S, not since closest
  5683. ;; repeater.
  5684. (let ((diff (if (< (org-today) current) diff
  5685. (- deadline current))))
  5686. (if (= diff 0) (car org-agenda-deadline-leaders)
  5687. (let ((future (nth 1 org-agenda-deadline-leaders))
  5688. (past (nth 2 org-agenda-deadline-leaders)))
  5689. (cond ((> diff 0) (format future diff))
  5690. ((string= future past) (format past diff))
  5691. (t (format past (abs diff)))))))
  5692. head level category tags
  5693. (and (= diff 0) timestr)))
  5694. (face (org-agenda-deadline-face
  5695. (- 1 (/ (float (- deadline current)) (max wdays 1)))))
  5696. (upcomingp (and todayp (> diff 0)))
  5697. (warntime (get-text-property (point) 'org-appt-warntime)))
  5698. (org-add-props item props
  5699. 'org-marker (org-agenda-new-marker pos)
  5700. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  5701. 'warntime warntime
  5702. 'level level
  5703. 'ts-date deadline
  5704. 'priority (- (org-get-priority item) diff)
  5705. 'todo-state todo-state
  5706. 'type (if upcomingp "upcoming-deadline" "deadline")
  5707. 'date (if upcomingp date deadline)
  5708. 'face (if donep 'org-agenda-done face)
  5709. 'undone-face face
  5710. 'done-face 'org-agenda-done)
  5711. (push item deadline-items))))))
  5712. (nreverse deadline-items)))
  5713. (defun org-agenda-deadline-face (fraction)
  5714. "Return the face to displaying a deadline item.
  5715. FRACTION is what fraction of the head-warning time has passed."
  5716. (let ((faces org-agenda-deadline-faces) f)
  5717. (catch 'exit
  5718. (while (setq f (pop faces))
  5719. (if (>= fraction (car f)) (throw 'exit (cdr f)))))))
  5720. (defun org-agenda-get-scheduled (&optional deadlines with-hour)
  5721. "Return the scheduled information for agenda display.
  5722. Optional argument DEADLINES is a list of deadline items to be
  5723. displayed in agenda view. When WITH-HOUR is non-nil, only return
  5724. scheduled items with an hour specification like [h]h:mm."
  5725. (let* ((props (list 'org-not-done-regexp org-not-done-regexp
  5726. 'org-todo-regexp org-todo-regexp
  5727. 'org-complex-heading-regexp org-complex-heading-regexp
  5728. 'done-face 'org-agenda-done
  5729. 'mouse-face 'highlight
  5730. 'help-echo
  5731. (format "mouse-2 or RET jump to org file %s"
  5732. (abbreviate-file-name buffer-file-name))))
  5733. (regexp (if with-hour
  5734. org-scheduled-time-hour-regexp
  5735. org-scheduled-time-regexp))
  5736. (todayp (org-agenda-today-p date)) ; DATE bound by calendar.
  5737. (current (calendar-absolute-from-gregorian date))
  5738. (deadline-pos
  5739. (mapcar (lambda (d)
  5740. (let ((m (get-text-property 0 'org-hd-marker d)))
  5741. (and m (marker-position m))))
  5742. deadlines))
  5743. scheduled-items)
  5744. (goto-char (point-min))
  5745. (while (re-search-forward regexp nil t)
  5746. (catch :skip
  5747. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5748. (org-agenda-skip)
  5749. (let* ((s (match-string 1))
  5750. (pos (1- (match-beginning 1)))
  5751. (todo-state (save-match-data (org-get-todo-state)))
  5752. (donep (member todo-state org-done-keywords))
  5753. (show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  5754. (member todo-state
  5755. org-agenda-repeating-timestamp-show-all)))
  5756. ;; SCHEDULE is the current scheduled date. When it
  5757. ;; contains a repeater and SHOW-ALL is non-nil,
  5758. ;; LAST-REPEAT is the repeat closest to CURRENT.
  5759. ;; Otherwise, LAST-REPEAT is equal to SCHEDULE.
  5760. (last-repeat (org-agenda--timestamp-to-absolute
  5761. s current 'past show-all (current-buffer) pos))
  5762. (schedule (org-agenda--timestamp-to-absolute s current))
  5763. (diff (- last-repeat current))
  5764. (warntime (get-text-property (point) 'org-appt-warntime))
  5765. (pastschedp (< schedule (org-today)))
  5766. (habitp (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  5767. (suppress-delay
  5768. (let ((deadline (and org-agenda-skip-scheduled-delay-if-deadline
  5769. (org-entry-get nil "DEADLINE"))))
  5770. (cond
  5771. ((not deadline) nil)
  5772. ;; The current item has a deadline date, so
  5773. ;; evaluate its delay time.
  5774. ((integerp org-agenda-skip-scheduled-delay-if-deadline)
  5775. ;; Use global delay time.
  5776. (- org-agenda-skip-scheduled-delay-if-deadline))
  5777. ((eq org-agenda-skip-scheduled-delay-if-deadline
  5778. 'post-deadline)
  5779. ;; Set delay to no later than DEADLINE. If
  5780. ;; DEADLINE has a repeater, compare last schedule
  5781. ;; repeat and last deadline repeat.
  5782. (min (- last-repeat
  5783. (org-agenda--timestamp-to-absolute
  5784. deadline current 'past show-all
  5785. (current-buffer)
  5786. (save-excursion
  5787. (beginning-of-line)
  5788. (1+ (search-forward org-deadline-string)))))
  5789. org-scheduled-delay-days))
  5790. (t 0))))
  5791. (ddays
  5792. (cond
  5793. ;; Nullify delay when a repeater triggered already
  5794. ;; and the delay is of the form --Xd.
  5795. ((and (save-match-data (string-match "--[0-9]+[hdwmy]" s))
  5796. (/= schedule last-repeat))
  5797. 0)
  5798. (suppress-delay
  5799. (let ((org-scheduled-delay-days suppress-delay))
  5800. (org-get-wdays s t t)))
  5801. (t (org-get-wdays s t)))))
  5802. ;; Only show a scheduled item in the calendar if it is on or
  5803. ;; past the current date. Skip it if it has been displayed
  5804. ;; for more than `org-scheduled-past-days'.
  5805. (unless (or (and (>= ddays 0) (= diff (- ddays)))
  5806. (and (< (+ diff ddays) 0)
  5807. (< (abs diff) org-scheduled-past-days)
  5808. (and todayp (not org-agenda-only-exact-dates)))
  5809. (and todayp
  5810. habitp
  5811. (bound-and-true-p org-habit-show-all-today)))
  5812. (throw :skip nil))
  5813. ;; Skip done habits, or tasks if
  5814. ;; `org-agenda-skip-deadline-if-done' is non-nil or if it
  5815. ;; was scheduled in the past anyway.
  5816. (when (and donep
  5817. (or org-agenda-skip-scheduled-if-done
  5818. (/= schedule current)
  5819. habitp))
  5820. (throw :skip nil))
  5821. ;; Skip entry if it already appears as a deadline, per
  5822. ;; `org-agenda-skip-scheduled-if-deadline-is-shown'. This
  5823. ;; doesn't apply to habits.
  5824. (when (pcase org-agenda-skip-scheduled-if-deadline-is-shown
  5825. ((guard
  5826. (or (not (assq (line-beginning-position 0) deadline-pos))
  5827. habitp))
  5828. nil)
  5829. (`repeated-after-deadline
  5830. (>= last-repeat
  5831. (time-to-days (org-get-deadline-time (point)))))
  5832. (`not-today pastschedp)
  5833. (`t t)
  5834. (_ nil))
  5835. (throw :skip nil))
  5836. ;; Skip habits if `org-habit-show-habits' is nil, or if we
  5837. ;; only show them for today.
  5838. (when (and habitp
  5839. (or (not (bound-and-true-p org-habit-show-habits))
  5840. (and (not todayp)
  5841. (bound-and-true-p
  5842. org-habit-show-habits-only-for-today))))
  5843. (throw :skip nil))
  5844. (save-excursion
  5845. (re-search-backward "^\\*+[ \t]+" nil t)
  5846. (goto-char (match-end 0))
  5847. (let* ((category (org-get-category))
  5848. (inherited-tags
  5849. (or (eq org-agenda-show-inherited-tags 'always)
  5850. (and (listp org-agenda-show-inherited-tags)
  5851. (memq 'agenda org-agenda-show-inherited-tags))
  5852. (and (eq org-agenda-show-inherited-tags t)
  5853. (or (eq org-agenda-use-tag-inheritance t)
  5854. (memq 'agenda
  5855. org-agenda-use-tag-inheritance)))))
  5856. (tags (org-get-tags-at nil (not inherited-tags)))
  5857. (level
  5858. (make-string (org-reduced-level (org-outline-level)) ?\s))
  5859. (head (buffer-substring (point) (line-end-position)))
  5860. (timestr
  5861. (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5862. (concat (substring s (match-beginning 1)) " ")
  5863. 'time))
  5864. (item (org-agenda-format-item
  5865. ;; For past scheduled dates, make sure to
  5866. ;; report time difference since SCHEDULE,
  5867. ;; not since closest repeater.
  5868. (let ((diff (if (< (org-today) current) diff
  5869. (- schedule current))))
  5870. (if (= diff 0) (car org-agenda-scheduled-leaders)
  5871. (format (nth 1 org-agenda-scheduled-leaders)
  5872. (- 1 diff))))
  5873. head level category tags
  5874. (and (= diff 0) timestr)
  5875. nil habitp))
  5876. (face (cond ((and (not habitp) pastschedp)
  5877. 'org-scheduled-previously)
  5878. (todayp 'org-scheduled-today)
  5879. (t 'org-scheduled)))
  5880. (habitp (and habitp (org-habit-parse-todo))))
  5881. (org-add-props item props
  5882. 'undone-face face
  5883. 'face (if donep 'org-agenda-done face)
  5884. 'org-marker (org-agenda-new-marker pos)
  5885. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  5886. 'type (if pastschedp "past-scheduled" "scheduled")
  5887. 'date (if pastschedp schedule date)
  5888. 'ts-date schedule
  5889. 'warntime warntime
  5890. 'level level
  5891. 'priority (if habitp (org-habit-get-priority habitp)
  5892. (+ 94 (- 5 diff) (org-get-priority item)))
  5893. 'org-habit-p habitp
  5894. 'todo-state todo-state)
  5895. (push item scheduled-items))))))
  5896. (nreverse scheduled-items)))
  5897. (defun org-agenda-get-blocks ()
  5898. "Return the date-range information for agenda display."
  5899. (let* ((props (list 'face nil
  5900. 'org-not-done-regexp org-not-done-regexp
  5901. 'org-todo-regexp org-todo-regexp
  5902. 'org-complex-heading-regexp org-complex-heading-regexp
  5903. 'mouse-face 'highlight
  5904. 'help-echo
  5905. (format "mouse-2 or RET jump to org file %s"
  5906. (abbreviate-file-name buffer-file-name))))
  5907. (regexp org-tr-regexp)
  5908. (d0 (calendar-absolute-from-gregorian date))
  5909. marker hdmarker ee txt d1 d2 s1 s2 category
  5910. level todo-state tags pos head donep inherited-tags)
  5911. (goto-char (point-min))
  5912. (while (re-search-forward regexp nil t)
  5913. (catch :skip
  5914. (org-agenda-skip)
  5915. (setq pos (point))
  5916. (let ((start-time (match-string 1))
  5917. (end-time (match-string 2)))
  5918. (setq s1 (match-string 1)
  5919. s2 (match-string 2)
  5920. d1 (time-to-days (org-time-string-to-time s1 (current-buffer) pos))
  5921. d2 (time-to-days (org-time-string-to-time s2 (current-buffer) pos)))
  5922. (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
  5923. ;; Only allow days between the limits, because the normal
  5924. ;; date stamps will catch the limits.
  5925. (save-excursion
  5926. (setq todo-state (org-get-todo-state))
  5927. (setq donep (member todo-state org-done-keywords))
  5928. (if (and donep org-agenda-skip-timestamp-if-done)
  5929. (throw :skip t))
  5930. (setq marker (org-agenda-new-marker (point))
  5931. category (org-get-category))
  5932. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5933. (throw :skip nil)
  5934. (goto-char (match-beginning 0))
  5935. (setq hdmarker (org-agenda-new-marker (point))
  5936. inherited-tags
  5937. (or (eq org-agenda-show-inherited-tags 'always)
  5938. (and (listp org-agenda-show-inherited-tags)
  5939. (memq 'agenda org-agenda-show-inherited-tags))
  5940. (and (eq org-agenda-show-inherited-tags t)
  5941. (or (eq org-agenda-use-tag-inheritance t)
  5942. (memq 'agenda org-agenda-use-tag-inheritance))))
  5943. tags (org-get-tags-at nil (not inherited-tags)))
  5944. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  5945. (looking-at "\\*+[ \t]+\\(.*\\)")
  5946. (setq head (match-string 1))
  5947. (let ((remove-re
  5948. (if org-agenda-remove-timeranges-from-blocks
  5949. (concat
  5950. "<" (regexp-quote s1) ".*?>"
  5951. "--"
  5952. "<" (regexp-quote s2) ".*?>")
  5953. nil)))
  5954. (setq txt (org-agenda-format-item
  5955. (format
  5956. (nth (if (= d1 d2) 0 1)
  5957. org-agenda-timerange-leaders)
  5958. (1+ (- d0 d1)) (1+ (- d2 d1)))
  5959. head level category tags
  5960. (cond ((and (= d1 d0) (= d2 d0))
  5961. (concat "<" start-time ">--<" end-time ">"))
  5962. ((= d1 d0)
  5963. (concat "<" start-time ">"))
  5964. ((= d2 d0)
  5965. (concat "<" end-time ">")))
  5966. remove-re))))
  5967. (org-add-props txt props
  5968. 'org-marker marker 'org-hd-marker hdmarker
  5969. 'type "block" 'date date
  5970. 'level level
  5971. 'todo-state todo-state
  5972. 'priority (org-get-priority txt))
  5973. (push txt ee))))
  5974. (goto-char pos)))
  5975. ;; Sort the entries by expiration date.
  5976. (nreverse ee)))
  5977. ;;; Agenda presentation and sorting
  5978. (defvar org-prefix-has-time nil
  5979. "A flag, set by `org-compile-prefix-format'.
  5980. The flag is set if the currently compiled format contains a `%t'.")
  5981. (defvar org-prefix-has-tag nil
  5982. "A flag, set by `org-compile-prefix-format'.
  5983. The flag is set if the currently compiled format contains a `%T'.")
  5984. (defvar org-prefix-has-effort nil
  5985. "A flag, set by `org-compile-prefix-format'.
  5986. The flag is set if the currently compiled format contains a `%e'.")
  5987. (defvar org-prefix-has-breadcrumbs nil
  5988. "A flag, set by `org-compile-prefix-format'.
  5989. The flag is set if the currently compiled format contains a `%b'.")
  5990. (defvar org-prefix-category-length nil
  5991. "Used by `org-compile-prefix-format' to remember the category field width.")
  5992. (defvar org-prefix-category-max-length nil
  5993. "Used by `org-compile-prefix-format' to remember the category field width.")
  5994. (defun org-agenda-get-category-icon (category)
  5995. "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
  5996. (dolist (entry org-agenda-category-icon-alist)
  5997. (when (string-match-p (car entry) category)
  5998. (if (listp (cadr entry))
  5999. (return (cadr entry))
  6000. (return (apply 'create-image (cdr entry)))))))
  6001. (defun org-agenda-format-item (extra txt &optional level category tags dotime
  6002. remove-re habitp)
  6003. "Format TXT to be inserted into the agenda buffer.
  6004. In particular, add the prefix and corresponding text properties.
  6005. EXTRA must be a string to replace the `%s' specifier in the prefix format.
  6006. LEVEL may be a string to replace the `%l' specifier.
  6007. CATEGORY (a string, a symbol or nil) may be used to overrule the default
  6008. category taken from local variable or file name. It will replace the `%c'
  6009. specifier in the format.
  6010. DOTIME, when non-nil, indicates that a time-of-day should be extracted from
  6011. TXT for sorting of this entry, and for the `%t' specifier in the format.
  6012. When DOTIME is a string, this string is searched for a time before TXT is.
  6013. TAGS can be the tags of the headline.
  6014. Any match of REMOVE-RE will be removed from TXT."
  6015. ;; We keep the org-prefix-* variable values along with a compiled
  6016. ;; formatter, so that multiple agendas existing at the same time do
  6017. ;; not step on each other toes.
  6018. ;;
  6019. ;; It was inconvenient to make these variables buffer local in
  6020. ;; Agenda buffers, because this function expects to be called with
  6021. ;; the buffer where item comes from being current, and not agenda
  6022. ;; buffer
  6023. (let* ((bindings (car org-prefix-format-compiled))
  6024. (formatter (cadr org-prefix-format-compiled)))
  6025. (loop for (var value) in bindings
  6026. do (set var value))
  6027. (save-match-data
  6028. ;; Diary entries sometimes have extra whitespace at the beginning
  6029. (setq txt (org-trim txt))
  6030. ;; Fix the tags part in txt
  6031. (setq txt (org-agenda-fix-displayed-tags
  6032. txt tags
  6033. org-agenda-show-inherited-tags
  6034. org-agenda-hide-tags-regexp))
  6035. (let* ((category (or category
  6036. (if buffer-file-name
  6037. (file-name-sans-extension
  6038. (file-name-nondirectory buffer-file-name))
  6039. "")))
  6040. (category-icon (org-agenda-get-category-icon category))
  6041. (category-icon (if category-icon
  6042. (propertize " " 'display category-icon)
  6043. ""))
  6044. (effort (and (not (string= txt ""))
  6045. (get-text-property 1 'effort txt)))
  6046. ;; time, tag, effort are needed for the eval of the prefix format
  6047. (tag (if tags (nth (1- (length tags)) tags) ""))
  6048. time
  6049. (ts (if dotime (concat
  6050. (if (stringp dotime) dotime "")
  6051. (and org-agenda-search-headline-for-time txt))))
  6052. (time-of-day (and dotime (org-get-time-of-day ts)))
  6053. stamp plain s0 s1 s2 rtn srp l
  6054. duration breadcrumbs)
  6055. (and (derived-mode-p 'org-mode) buffer-file-name
  6056. (add-to-list 'org-agenda-contributing-files buffer-file-name))
  6057. (when (and dotime time-of-day)
  6058. ;; Extract starting and ending time and move them to prefix
  6059. (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
  6060. (setq plain (string-match org-plain-time-of-day-regexp ts)))
  6061. (setq s0 (match-string 0 ts)
  6062. srp (and stamp (match-end 3))
  6063. s1 (match-string (if plain 1 2) ts)
  6064. s2 (match-string (if plain 8 (if srp 4 6)) ts))
  6065. ;; If the times are in TXT (not in DOTIMES), and the prefix will list
  6066. ;; them, we might want to remove them there to avoid duplication.
  6067. ;; The user can turn this off with a variable.
  6068. (if (and org-prefix-has-time
  6069. org-agenda-remove-times-when-in-prefix (or stamp plain)
  6070. (string-match (concat (regexp-quote s0) " *") txt)
  6071. (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
  6072. (if (eq org-agenda-remove-times-when-in-prefix 'beg)
  6073. (= (match-beginning 0) 0)
  6074. t))
  6075. (setq txt (replace-match "" nil nil txt))))
  6076. ;; Normalize the time(s) to 24 hour
  6077. (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
  6078. (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
  6079. ;; Try to set s2 if s1 and `org-agenda-default-appointment-duration' are set
  6080. (let (org-time-clocksum-use-effort-durations)
  6081. (when (and s1 (not s2) org-agenda-default-appointment-duration)
  6082. (setq s2
  6083. (org-minutes-to-clocksum-string
  6084. (+ (org-hh:mm-string-to-minutes s1)
  6085. org-agenda-default-appointment-duration)))))
  6086. ;; Compute the duration
  6087. (when s2
  6088. (setq duration (- (org-hh:mm-string-to-minutes s2)
  6089. (org-hh:mm-string-to-minutes s1)))))
  6090. (when (string-match "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$" txt)
  6091. ;; Tags are in the string
  6092. (if (or (eq org-agenda-remove-tags t)
  6093. (and org-agenda-remove-tags
  6094. org-prefix-has-tag))
  6095. (setq txt (replace-match "" t t txt))
  6096. (setq txt (replace-match
  6097. (concat (make-string (max (- 50 (length txt)) 1) ?\ )
  6098. (match-string 2 txt))
  6099. t t txt))))
  6100. (when remove-re
  6101. (while (string-match remove-re txt)
  6102. (setq txt (replace-match "" t t txt))))
  6103. ;; Set org-heading property on `txt' to mark the start of the
  6104. ;; heading.
  6105. (add-text-properties 0 (length txt) '(org-heading t) txt)
  6106. ;; Prepare the variables needed in the eval of the compiled format
  6107. (if org-prefix-has-breadcrumbs
  6108. (setq breadcrumbs (org-with-point-at (org-get-at-bol 'org-marker)
  6109. (let ((s (org-display-outline-path nil nil "->" t)))
  6110. (if (eq "" s) "" (concat s "->"))))))
  6111. (setq time (cond (s2 (concat
  6112. (org-agenda-time-of-day-to-ampm-maybe s1)
  6113. "-" (org-agenda-time-of-day-to-ampm-maybe s2)
  6114. (if org-agenda-timegrid-use-ampm " ")))
  6115. (s1 (concat
  6116. (org-agenda-time-of-day-to-ampm-maybe s1)
  6117. (if org-agenda-timegrid-use-ampm
  6118. "........ "
  6119. "......")))
  6120. (t ""))
  6121. extra (or (and (not habitp) extra) "")
  6122. category (if (symbolp category) (symbol-name category) category)
  6123. level (or level ""))
  6124. (if (string-match org-bracket-link-regexp category)
  6125. (progn
  6126. (setq l (if (match-end 3)
  6127. (- (match-end 3) (match-beginning 3))
  6128. (- (match-end 1) (match-beginning 1))))
  6129. (when (< l (or org-prefix-category-length 0))
  6130. (setq category (copy-sequence category))
  6131. (org-add-props category nil
  6132. 'extra-space (make-string
  6133. (- org-prefix-category-length l 1) ?\ ))))
  6134. (if (and org-prefix-category-max-length
  6135. (>= (length category) org-prefix-category-max-length))
  6136. (setq category (substring category 0 (1- org-prefix-category-max-length)))))
  6137. ;; Evaluate the compiled format
  6138. (setq rtn (concat (eval formatter) txt))
  6139. ;; And finally add the text properties
  6140. (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
  6141. (org-add-props rtn nil
  6142. 'org-category category
  6143. 'tags (mapcar 'org-downcase-keep-props tags)
  6144. 'org-highest-priority org-highest-priority
  6145. 'org-lowest-priority org-lowest-priority
  6146. 'time-of-day time-of-day
  6147. 'duration duration
  6148. 'breadcrumbs breadcrumbs
  6149. 'txt txt
  6150. 'level level
  6151. 'time time
  6152. 'extra extra
  6153. 'format org-prefix-format-compiled
  6154. 'dotime dotime)))))
  6155. (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
  6156. "Remove tags string from TXT, and add a modified list of tags.
  6157. The modified list may contain inherited tags, and tags matched by
  6158. `org-agenda-hide-tags-regexp' will be removed."
  6159. (when (or add-inherited hide-re)
  6160. (if (string-match "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$" txt)
  6161. (setq txt (substring txt 0 (match-beginning 0))))
  6162. (setq tags
  6163. (delq nil
  6164. (mapcar (lambda (tg)
  6165. (if (or (and hide-re (string-match hide-re tg))
  6166. (and (not add-inherited)
  6167. (get-text-property 0 'inherited tg)))
  6168. nil
  6169. tg))
  6170. tags)))
  6171. (when tags
  6172. (let ((have-i (get-text-property 0 'inherited (car tags)))
  6173. i)
  6174. (setq txt (concat txt " :"
  6175. (mapconcat
  6176. (lambda (x)
  6177. (setq i (get-text-property 0 'inherited x))
  6178. (if (and have-i (not i))
  6179. (progn
  6180. (setq have-i nil)
  6181. (concat ":" x))
  6182. x))
  6183. tags ":")
  6184. (if have-i "::" ":"))))))
  6185. txt)
  6186. (defun org-downcase-keep-props (s)
  6187. (let ((props (text-properties-at 0 s)))
  6188. (setq s (downcase s))
  6189. (add-text-properties 0 (length s) props s)
  6190. s))
  6191. (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
  6192. (defun org-agenda-add-time-grid-maybe (list ndays todayp)
  6193. "Add a time-grid for agenda items which need it.
  6194. LIST is the list of agenda items formatted by `org-agenda-list'.
  6195. NDAYS is the span of the current agenda view.
  6196. TODAYP is t when the current agenda view is on today."
  6197. (catch 'exit
  6198. (cond ((not org-agenda-use-time-grid) (throw 'exit list))
  6199. ((and todayp (member 'today (car org-agenda-time-grid))))
  6200. ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
  6201. ((member 'weekly (car org-agenda-time-grid)))
  6202. (t (throw 'exit list)))
  6203. (let* ((have (delq nil (mapcar
  6204. (lambda (x) (get-text-property 1 'time-of-day x))
  6205. list)))
  6206. (string (nth 1 org-agenda-time-grid))
  6207. (gridtimes (nth 2 org-agenda-time-grid))
  6208. (req (car org-agenda-time-grid))
  6209. (remove (member 'remove-match req))
  6210. new time)
  6211. (if (and (member 'require-timed req) (not have))
  6212. ;; don't show empty grid
  6213. (throw 'exit list))
  6214. (while (setq time (pop gridtimes))
  6215. (unless (and remove (member time have))
  6216. (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
  6217. (push (org-agenda-format-item
  6218. nil string nil "" nil
  6219. (concat (substring time 0 -2) ":" (substring time -2)))
  6220. new)
  6221. (put-text-property
  6222. 2 (length (car new)) 'face 'org-time-grid (car new))))
  6223. (when (and todayp org-agenda-show-current-time-in-grid)
  6224. (push (org-agenda-format-item
  6225. nil org-agenda-current-time-string nil "" nil
  6226. (format-time-string "%H:%M "))
  6227. new)
  6228. (put-text-property
  6229. 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
  6230. (if (member 'time-up org-agenda-sorting-strategy-selected)
  6231. (append new list)
  6232. (append list new)))))
  6233. (defun org-compile-prefix-format (key)
  6234. "Compile the prefix format into a Lisp form that can be evaluated.
  6235. The resulting form and associated variable bindings is returned
  6236. and stored in the variable `org-prefix-format-compiled'."
  6237. (setq org-prefix-has-time nil
  6238. org-prefix-has-tag nil
  6239. org-prefix-category-length nil
  6240. org-prefix-has-effort nil
  6241. org-prefix-has-breadcrumbs nil)
  6242. (let ((s (cond
  6243. ((stringp org-agenda-prefix-format)
  6244. org-agenda-prefix-format)
  6245. ((assq key org-agenda-prefix-format)
  6246. (cdr (assq key org-agenda-prefix-format)))
  6247. (t " %-12:c%?-12t% s")))
  6248. (start 0)
  6249. varform vars var e c f opt)
  6250. (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cltseib]\\|(.+)\\)"
  6251. s start)
  6252. (setq var (or (cdr (assoc (match-string 4 s)
  6253. '(("c" . category) ("t" . time) ("l" . level) ("s" . extra)
  6254. ("i" . category-icon) ("T" . tag) ("e" . effort) ("b" . breadcrumbs))))
  6255. 'eval)
  6256. c (or (match-string 3 s) "")
  6257. opt (match-beginning 1)
  6258. start (1+ (match-beginning 0)))
  6259. (if (equal var 'time) (setq org-prefix-has-time t))
  6260. (if (equal var 'tag) (setq org-prefix-has-tag t))
  6261. (if (equal var 'effort) (setq org-prefix-has-effort t))
  6262. (if (equal var 'breadcrumbs) (setq org-prefix-has-breadcrumbs t))
  6263. (setq f (concat "%" (match-string 2 s) "s"))
  6264. (when (equal var 'category)
  6265. (setq org-prefix-category-length
  6266. (floor (abs (string-to-number (match-string 2 s)))))
  6267. (setq org-prefix-category-max-length
  6268. (let ((x (match-string 2 s)))
  6269. (save-match-data
  6270. (if (string-match "\\.[0-9]+" x)
  6271. (string-to-number (substring (match-string 0 x) 1)))))))
  6272. (if (eq var 'eval)
  6273. (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
  6274. (if opt
  6275. (setq varform
  6276. `(if (or (equal "" ,var) (equal nil ,var))
  6277. ""
  6278. (format ,f (concat ,var ,c))))
  6279. (setq varform
  6280. `(format ,f (if (or (equal ,var "")
  6281. (equal ,var nil)) ""
  6282. (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
  6283. (setq s (replace-match "%s" t nil s))
  6284. (push varform vars))
  6285. (setq vars (nreverse vars))
  6286. (with-current-buffer (or org-agenda-buffer (current-buffer))
  6287. (setq org-prefix-format-compiled
  6288. (list
  6289. `((org-prefix-has-time ,org-prefix-has-time)
  6290. (org-prefix-has-tag ,org-prefix-has-tag)
  6291. (org-prefix-category-length ,org-prefix-category-length)
  6292. (org-prefix-has-effort ,org-prefix-has-effort)
  6293. (org-prefix-has-breadcrumbs ,org-prefix-has-breadcrumbs))
  6294. `(format ,s ,@vars))))))
  6295. (defun org-set-sorting-strategy (key)
  6296. (if (symbolp (car org-agenda-sorting-strategy))
  6297. ;; the old format
  6298. (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
  6299. (setq org-agenda-sorting-strategy-selected
  6300. (or (cdr (assq key org-agenda-sorting-strategy))
  6301. (cdr (assq 'agenda org-agenda-sorting-strategy))
  6302. '(time-up category-keep priority-down)))))
  6303. (defun org-get-time-of-day (s &optional string mod24)
  6304. "Check string S for a time of day.
  6305. If found, return it as a military time number between 0 and 2400.
  6306. If not found, return nil.
  6307. The optional STRING argument forces conversion into a 5 character wide string
  6308. HH:MM."
  6309. (save-match-data
  6310. (when
  6311. (and
  6312. (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
  6313. (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
  6314. (not (eq (get-text-property 1 'face s) 'org-link)))
  6315. (let* ((h (string-to-number (match-string 1 s)))
  6316. (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
  6317. (ampm (if (match-end 4) (downcase (match-string 4 s))))
  6318. (am-p (equal ampm "am"))
  6319. (h1 (cond ((not ampm) h)
  6320. ((= h 12) (if am-p 0 12))
  6321. (t (+ h (if am-p 0 12)))))
  6322. (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
  6323. (mod h1 24) h1))
  6324. (t0 (+ (* 100 h2) m))
  6325. (t1 (concat (if (>= h1 24) "+" " ")
  6326. (if (and org-agenda-time-leading-zero
  6327. (< t0 1000)) "0" "")
  6328. (if (< t0 100) "0" "")
  6329. (if (< t0 10) "0" "")
  6330. (int-to-string t0))))
  6331. (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
  6332. (defvar org-agenda-before-sorting-filter-function nil
  6333. "Function to be applied to agenda items prior to sorting.
  6334. Prior to sorting also means just before they are inserted into the agenda.
  6335. To aid sorting, you may revisit the original entries and add more text
  6336. properties which will later be used by the sorting functions.
  6337. The function should take a string argument, an agenda line.
  6338. It has access to the text properties in that line, which contain among
  6339. other things, the property `org-hd-marker' that points to the entry
  6340. where the line comes from. Note that not all lines going into the agenda
  6341. have this property, only most.
  6342. The function should return the modified string. It is probably best
  6343. to ONLY change text properties.
  6344. You can also use this function as a filter, by returning nil for lines
  6345. you don't want to have in the agenda at all. For this application, you
  6346. could bind the variable in the options section of a custom command.")
  6347. (defun org-agenda-finalize-entries (list &optional type)
  6348. "Sort, limit and concatenate the LIST of agenda items.
  6349. The optional argument TYPE tells the agenda type."
  6350. (let ((max-effort (cond ((listp org-agenda-max-effort)
  6351. (cdr (assoc type org-agenda-max-effort)))
  6352. (t org-agenda-max-effort)))
  6353. (max-todo (cond ((listp org-agenda-max-todos)
  6354. (cdr (assoc type org-agenda-max-todos)))
  6355. (t org-agenda-max-todos)))
  6356. (max-tags (cond ((listp org-agenda-max-tags)
  6357. (cdr (assoc type org-agenda-max-tags)))
  6358. (t org-agenda-max-tags)))
  6359. (max-entries (cond ((listp org-agenda-max-entries)
  6360. (cdr (assoc type org-agenda-max-entries)))
  6361. (t org-agenda-max-entries))))
  6362. (when org-agenda-before-sorting-filter-function
  6363. (setq list
  6364. (delq nil
  6365. (mapcar
  6366. org-agenda-before-sorting-filter-function list))))
  6367. (setq list (mapcar 'org-agenda-highlight-todo list)
  6368. list (mapcar 'identity (sort list 'org-entries-lessp)))
  6369. (when max-effort
  6370. (setq list (org-agenda-limit-entries
  6371. list 'effort-minutes max-effort
  6372. (lambda (e) (or e (if org-sort-agenda-noeffort-is-high
  6373. 32767 -1))))))
  6374. (when max-todo
  6375. (setq list (org-agenda-limit-entries list 'todo-state max-todo)))
  6376. (when max-tags
  6377. (setq list (org-agenda-limit-entries list 'tags max-tags)))
  6378. (when max-entries
  6379. (setq list (org-agenda-limit-entries list 'org-hd-marker max-entries)))
  6380. (mapconcat 'identity list "\n")))
  6381. (defun org-agenda-limit-entries (list prop limit &optional fn)
  6382. "Limit the number of agenda entries."
  6383. (let ((include (and limit (< limit 0))))
  6384. (if limit
  6385. (let ((fun (or fn (lambda (p) (if p 1))))
  6386. (lim 0))
  6387. (delq nil
  6388. (mapcar
  6389. (lambda (e)
  6390. (let ((pval (funcall
  6391. fun (get-text-property (1- (length e))
  6392. prop e))))
  6393. (if pval (setq lim (+ lim pval)))
  6394. (cond ((and pval (<= lim (abs limit))) e)
  6395. ((and include (not pval)) e))))
  6396. list)))
  6397. list)))
  6398. (defun org-agenda-limit-interactively (remove)
  6399. "In agenda, interactively limit entries to various maximums."
  6400. (interactive "P")
  6401. (if remove
  6402. (progn (setq org-agenda-max-entries nil
  6403. org-agenda-max-todos nil
  6404. org-agenda-max-tags nil
  6405. org-agenda-max-effort nil)
  6406. (org-agenda-redo))
  6407. (let* ((max (read-char "Number of [e]ntries [t]odos [T]ags [E]ffort? "))
  6408. (msg (cond ((= max ?E) "How many minutes? ")
  6409. ((= max ?e) "How many entries? ")
  6410. ((= max ?t) "How many TODO entries? ")
  6411. ((= max ?T) "How many tagged entries? ")
  6412. (t (user-error "Wrong input"))))
  6413. (num (string-to-number (read-from-minibuffer msg))))
  6414. (cond ((equal max ?e)
  6415. (let ((org-agenda-max-entries num)) (org-agenda-redo)))
  6416. ((equal max ?t)
  6417. (let ((org-agenda-max-todos num)) (org-agenda-redo)))
  6418. ((equal max ?T)
  6419. (let ((org-agenda-max-tags num)) (org-agenda-redo)))
  6420. ((equal max ?E)
  6421. (let ((org-agenda-max-effort num)) (org-agenda-redo))))))
  6422. (org-agenda-fit-window-to-buffer))
  6423. (defun org-agenda-highlight-todo (x)
  6424. (let ((org-done-keywords org-done-keywords-for-agenda)
  6425. (case-fold-search nil)
  6426. re)
  6427. (if (eq x 'line)
  6428. (save-excursion
  6429. (beginning-of-line 1)
  6430. (setq re (org-get-at-bol 'org-todo-regexp))
  6431. (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
  6432. (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
  6433. (add-text-properties (match-beginning 0) (match-end 1)
  6434. (list 'face (org-get-todo-face 1)))
  6435. (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
  6436. (delete-region (match-beginning 1) (1- (match-end 0)))
  6437. (goto-char (match-beginning 1))
  6438. (insert (format org-agenda-todo-keyword-format s)))))
  6439. (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
  6440. (setq re (get-text-property 0 'org-todo-regexp x))
  6441. (when (and re
  6442. ;; Test `pl' because if there's no heading content,
  6443. ;; there's no point matching to highlight. Note
  6444. ;; that if we didn't test `pl' first, and there
  6445. ;; happened to be no keyword from `org-todo-regexp'
  6446. ;; on this heading line, then the `equal' comparison
  6447. ;; afterwards would spuriously succeed in the case
  6448. ;; where `pl' is nil -- causing an args-out-of-range
  6449. ;; error when we try to add text properties to text
  6450. ;; that isn't there.
  6451. pl
  6452. (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
  6453. x pl) pl))
  6454. (add-text-properties
  6455. (or (match-end 1) (match-end 0)) (match-end 0)
  6456. (list 'face (org-get-todo-face (match-string 2 x)))
  6457. x)
  6458. (when (match-end 1)
  6459. (setq x (concat (substring x 0 (match-end 1))
  6460. (format org-agenda-todo-keyword-format
  6461. (match-string 2 x))
  6462. (org-add-props " " (text-properties-at 0 x))
  6463. (substring x (match-end 3)))))))
  6464. x)))
  6465. (defsubst org-cmp-values (a b property)
  6466. "Compare the numeric value of text PROPERTY for string A and B."
  6467. (let ((pa (or (get-text-property (1- (length a)) property a) 0))
  6468. (pb (or (get-text-property (1- (length b)) property b) 0)))
  6469. (cond ((> pa pb) +1)
  6470. ((< pa pb) -1))))
  6471. (defsubst org-cmp-effort (a b)
  6472. "Compare the effort values of string A and B."
  6473. (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
  6474. (ea (or (get-text-property (1- (length a)) 'effort-minutes a) def))
  6475. (eb (or (get-text-property (1- (length b)) 'effort-minutes b) def)))
  6476. (cond ((> ea eb) +1)
  6477. ((< ea eb) -1))))
  6478. (defsubst org-cmp-category (a b)
  6479. "Compare the string values of categories of strings A and B."
  6480. (let ((ca (or (get-text-property (1- (length a)) 'org-category a) ""))
  6481. (cb (or (get-text-property (1- (length b)) 'org-category b) "")))
  6482. (cond ((string-lessp ca cb) -1)
  6483. ((string-lessp cb ca) +1))))
  6484. (defsubst org-cmp-todo-state (a b)
  6485. "Compare the todo states of strings A and B."
  6486. (let* ((ma (or (get-text-property 1 'org-marker a)
  6487. (get-text-property 1 'org-hd-marker a)))
  6488. (mb (or (get-text-property 1 'org-marker b)
  6489. (get-text-property 1 'org-hd-marker b)))
  6490. (fa (and ma (marker-buffer ma)))
  6491. (fb (and mb (marker-buffer mb)))
  6492. (todo-kwds
  6493. (or (and fa (with-current-buffer fa org-todo-keywords-1))
  6494. (and fb (with-current-buffer fb org-todo-keywords-1))))
  6495. (ta (or (get-text-property 1 'todo-state a) ""))
  6496. (tb (or (get-text-property 1 'todo-state b) ""))
  6497. (la (- (length (member ta todo-kwds))))
  6498. (lb (- (length (member tb todo-kwds))))
  6499. (donepa (member ta org-done-keywords-for-agenda))
  6500. (donepb (member tb org-done-keywords-for-agenda)))
  6501. (cond ((and donepa (not donepb)) -1)
  6502. ((and (not donepa) donepb) +1)
  6503. ((< la lb) -1)
  6504. ((< lb la) +1))))
  6505. (defsubst org-cmp-alpha (a b)
  6506. "Compare the headlines, alphabetically."
  6507. (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
  6508. (plb (text-property-any 0 (length b) 'org-heading t b))
  6509. (ta (and pla (substring a pla)))
  6510. (tb (and plb (substring b plb))))
  6511. (when pla
  6512. (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
  6513. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
  6514. (setq ta (substring ta (match-end 0))))
  6515. (setq ta (downcase ta)))
  6516. (when plb
  6517. (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
  6518. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
  6519. (setq tb (substring tb (match-end 0))))
  6520. (setq tb (downcase tb)))
  6521. (cond ((not ta) +1)
  6522. ((not tb) -1)
  6523. ((string-lessp ta tb) -1)
  6524. ((string-lessp tb ta) +1))))
  6525. (defsubst org-cmp-tag (a b)
  6526. "Compare the string values of the first tags of A and B."
  6527. (let ((ta (car (last (get-text-property 1 'tags a))))
  6528. (tb (car (last (get-text-property 1 'tags b)))))
  6529. (cond ((not ta) +1)
  6530. ((not tb) -1)
  6531. ((string-lessp ta tb) -1)
  6532. ((string-lessp tb ta) +1))))
  6533. (defsubst org-cmp-time (a b)
  6534. "Compare the time-of-day values of strings A and B."
  6535. (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
  6536. (ta (or (get-text-property 1 'time-of-day a) def))
  6537. (tb (or (get-text-property 1 'time-of-day b) def)))
  6538. (cond ((< ta tb) -1)
  6539. ((< tb ta) +1))))
  6540. (defsubst org-cmp-ts (a b type)
  6541. "Compare the timestamps values of entries A and B.
  6542. When TYPE is \"scheduled\", \"deadline\", \"timestamp\" or
  6543. \"timestamp_ia\", compare within each of these type. When TYPE
  6544. is the empty string, compare all timestamps without respect of
  6545. their type."
  6546. (let* ((def (if org-sort-agenda-notime-is-late most-positive-fixnum -1))
  6547. (ta (or (and (string-match type (or (get-text-property 1 'type a) ""))
  6548. (get-text-property 1 'ts-date a))
  6549. def))
  6550. (tb (or (and (string-match type (or (get-text-property 1 'type b) ""))
  6551. (get-text-property 1 'ts-date b))
  6552. def)))
  6553. (cond ((< ta tb) -1)
  6554. ((< tb ta) +1))))
  6555. (defsubst org-cmp-habit-p (a b)
  6556. "Compare the todo states of strings A and B."
  6557. (let ((ha (get-text-property 1 'org-habit-p a))
  6558. (hb (get-text-property 1 'org-habit-p b)))
  6559. (cond ((and ha (not hb)) -1)
  6560. ((and (not ha) hb) +1))))
  6561. (defun org-entries-lessp (a b)
  6562. "Predicate for sorting agenda entries."
  6563. ;; The following variables will be used when the form is evaluated.
  6564. ;; So even though the compiler complains, keep them.
  6565. (let* ((ss org-agenda-sorting-strategy-selected)
  6566. (timestamp-up (and (org-em 'timestamp-up 'timestamp-down ss)
  6567. (org-cmp-ts a b "")))
  6568. (timestamp-down (if timestamp-up (- timestamp-up) nil))
  6569. (scheduled-up (and (org-em 'scheduled-up 'scheduled-down ss)
  6570. (org-cmp-ts a b "scheduled")))
  6571. (scheduled-down (if scheduled-up (- scheduled-up) nil))
  6572. (deadline-up (and (org-em 'deadline-up 'deadline-down ss)
  6573. (org-cmp-ts a b "deadline")))
  6574. (deadline-down (if deadline-up (- deadline-up) nil))
  6575. (tsia-up (and (org-em 'tsia-up 'tsia-down ss)
  6576. (org-cmp-ts a b "timestamp_ia")))
  6577. (tsia-down (if tsia-up (- tsia-up) nil))
  6578. (ts-up (and (org-em 'ts-up 'ts-down ss)
  6579. (org-cmp-ts a b "timestamp")))
  6580. (ts-down (if ts-up (- ts-up) nil))
  6581. (time-up (and (org-em 'time-up 'time-down ss)
  6582. (org-cmp-time a b)))
  6583. (time-down (if time-up (- time-up) nil))
  6584. (stats-up (and (org-em 'stats-up 'stats-down ss)
  6585. (org-cmp-values a b 'org-stats)))
  6586. (stats-down (if stats-up (- stats-up) nil))
  6587. (priority-up (and (org-em 'priority-up 'priority-down ss)
  6588. (org-cmp-values a b 'priority)))
  6589. (priority-down (if priority-up (- priority-up) nil))
  6590. (effort-up (and (org-em 'effort-up 'effort-down ss)
  6591. (org-cmp-effort a b)))
  6592. (effort-down (if effort-up (- effort-up) nil))
  6593. (category-up (and (or (org-em 'category-up 'category-down ss)
  6594. (memq 'category-keep ss))
  6595. (org-cmp-category a b)))
  6596. (category-down (if category-up (- category-up) nil))
  6597. (category-keep (if category-up +1 nil))
  6598. (tag-up (and (org-em 'tag-up 'tag-down ss)
  6599. (org-cmp-tag a b)))
  6600. (tag-down (if tag-up (- tag-up) nil))
  6601. (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
  6602. (org-cmp-todo-state a b)))
  6603. (todo-state-down (if todo-state-up (- todo-state-up) nil))
  6604. (habit-up (and (org-em 'habit-up 'habit-down ss)
  6605. (org-cmp-habit-p a b)))
  6606. (habit-down (if habit-up (- habit-up) nil))
  6607. (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
  6608. (org-cmp-alpha a b)))
  6609. (alpha-down (if alpha-up (- alpha-up) nil))
  6610. (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
  6611. user-defined-up user-defined-down)
  6612. (if (and need-user-cmp org-agenda-cmp-user-defined
  6613. (functionp org-agenda-cmp-user-defined))
  6614. (setq user-defined-up
  6615. (funcall org-agenda-cmp-user-defined a b)
  6616. user-defined-down (if user-defined-up (- user-defined-up) nil)))
  6617. (cdr (assoc
  6618. (eval (cons 'or org-agenda-sorting-strategy-selected))
  6619. '((-1 . t) (1 . nil) (nil . nil))))))
  6620. ;;; Agenda restriction lock
  6621. (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
  6622. "Overlay to mark the headline to which agenda commands are restricted.")
  6623. (overlay-put org-agenda-restriction-lock-overlay
  6624. 'face 'org-agenda-restriction-lock)
  6625. (overlay-put org-agenda-restriction-lock-overlay
  6626. 'help-echo "Agendas are currently limited to this subtree.")
  6627. (delete-overlay org-agenda-restriction-lock-overlay)
  6628. ;;;###autoload
  6629. (defun org-agenda-set-restriction-lock (&optional type)
  6630. "Set restriction lock for agenda, to current subtree or file.
  6631. Restriction will be the file if TYPE is `file', or if type is the
  6632. universal prefix \\='(4), or if the cursor is before the first headline
  6633. in the file. Otherwise, restriction will be to the current subtree."
  6634. (interactive "P")
  6635. (org-agenda-remove-restriction-lock 'noupdate)
  6636. (and (equal type '(4)) (setq type 'file))
  6637. (setq type (cond
  6638. (type type)
  6639. ((org-at-heading-p) 'subtree)
  6640. ((condition-case nil (org-back-to-heading t) (error nil))
  6641. 'subtree)
  6642. (t 'file)))
  6643. (if (eq type 'subtree)
  6644. (progn
  6645. (setq org-agenda-restrict (current-buffer))
  6646. (setq org-agenda-overriding-restriction 'subtree)
  6647. (put 'org-agenda-files 'org-restrict
  6648. (list (buffer-file-name (buffer-base-buffer))))
  6649. (org-back-to-heading t)
  6650. (move-overlay org-agenda-restriction-lock-overlay
  6651. (point)
  6652. (if org-agenda-restriction-lock-highlight-subtree
  6653. (save-excursion (org-end-of-subtree t t) (point))
  6654. (point-at-eol)))
  6655. (move-marker org-agenda-restrict-begin (point))
  6656. (move-marker org-agenda-restrict-end
  6657. (save-excursion (org-end-of-subtree t t)))
  6658. (message "Locking agenda restriction to subtree"))
  6659. (put 'org-agenda-files 'org-restrict
  6660. (list (buffer-file-name (buffer-base-buffer))))
  6661. (setq org-agenda-restrict nil)
  6662. (setq org-agenda-overriding-restriction 'file)
  6663. (move-marker org-agenda-restrict-begin nil)
  6664. (move-marker org-agenda-restrict-end nil)
  6665. (message "Locking agenda restriction to file"))
  6666. (setq current-prefix-arg nil)
  6667. (org-agenda-maybe-redo))
  6668. (defun org-agenda-remove-restriction-lock (&optional noupdate)
  6669. "Remove the agenda restriction lock."
  6670. (interactive "P")
  6671. (delete-overlay org-agenda-restriction-lock-overlay)
  6672. (delete-overlay org-speedbar-restriction-lock-overlay)
  6673. (setq org-agenda-overriding-restriction nil)
  6674. (setq org-agenda-restrict nil)
  6675. (put 'org-agenda-files 'org-restrict nil)
  6676. (move-marker org-agenda-restrict-begin nil)
  6677. (move-marker org-agenda-restrict-end nil)
  6678. (setq current-prefix-arg nil)
  6679. (message "Agenda restriction lock removed")
  6680. (or noupdate (org-agenda-maybe-redo)))
  6681. (defun org-agenda-maybe-redo ()
  6682. "If there is any window showing the agenda view, update it."
  6683. (let ((w (get-buffer-window (or org-agenda-this-buffer-name
  6684. org-agenda-buffer-name)
  6685. t))
  6686. (w0 (selected-window)))
  6687. (when w
  6688. (select-window w)
  6689. (org-agenda-redo)
  6690. (select-window w0)
  6691. (if org-agenda-overriding-restriction
  6692. (message "Agenda view shifted to new %s restriction"
  6693. org-agenda-overriding-restriction)
  6694. (message "Agenda restriction lock removed")))))
  6695. ;;; Agenda commands
  6696. (defun org-agenda-check-type (error &rest types)
  6697. "Check if agenda buffer is of allowed type.
  6698. If ERROR is non-nil, throw an error, otherwise just return nil.
  6699. Allowed types are `agenda' `timeline' `todo' `tags' `search'."
  6700. (if (not org-agenda-type)
  6701. (error "No Org agenda currently displayed")
  6702. (if (memq org-agenda-type types)
  6703. t
  6704. (if error
  6705. (error "Not allowed in %s-type agenda buffers" org-agenda-type)
  6706. nil))))
  6707. (defun org-agenda-Quit ()
  6708. "Exit the agenda, killing the agenda buffer.
  6709. Like `org-agenda-quit', but kill the buffer even when
  6710. `org-agenda-sticky' is non-nil."
  6711. (interactive)
  6712. (org-agenda--quit))
  6713. (defun org-agenda-quit ()
  6714. "Exit the agenda.
  6715. When `org-agenda-sticky' is non-nil, bury the agenda buffer
  6716. instead of killing it.
  6717. When `org-agenda-restore-windows-after-quit' is non-nil, restore
  6718. the pre-agenda window configuration.
  6719. When column view is active, exit column view instead of the
  6720. agenda."
  6721. (interactive)
  6722. (org-agenda--quit org-agenda-sticky))
  6723. (defun org-agenda--quit (&optional bury)
  6724. (if org-agenda-columns-active
  6725. (org-columns-quit)
  6726. (let ((wconf org-agenda-pre-window-conf)
  6727. (buf (current-buffer))
  6728. (org-agenda-last-indirect-window
  6729. (and (eq org-indirect-buffer-display 'other-window)
  6730. org-agenda-last-indirect-buffer
  6731. (get-buffer-window org-agenda-last-indirect-buffer))))
  6732. (cond
  6733. ((eq org-agenda-window-setup 'other-frame)
  6734. (delete-frame))
  6735. ((and org-agenda-restore-windows-after-quit
  6736. wconf)
  6737. ;; Maybe restore the pre-agenda window configuration. Reset
  6738. ;; `org-agenda-pre-window-conf' before running
  6739. ;; `set-window-configuration', which loses the current buffer.
  6740. (setq org-agenda-pre-window-conf nil)
  6741. (set-window-configuration wconf))
  6742. (t
  6743. (when org-agenda-last-indirect-window
  6744. (delete-window org-agenda-last-indirect-window))
  6745. (and (not (eq org-agenda-window-setup 'current-window))
  6746. (not (one-window-p))
  6747. (delete-window))))
  6748. (if bury
  6749. ;; Set the agenda buffer as the current buffer instead of
  6750. ;; passing it as an argument to `bury-buffer' so that
  6751. ;; `bury-buffer' removes it from the window.
  6752. (with-current-buffer buf
  6753. (bury-buffer))
  6754. (kill-buffer buf)
  6755. (setq org-agenda-archives-mode nil
  6756. org-agenda-buffer nil)))))
  6757. (defun org-agenda-exit ()
  6758. "Exit the agenda, killing Org buffers loaded by the agenda.
  6759. Like `org-agenda-Quit', but kill any buffers that were created by
  6760. the agenda. Org buffers visited directly by the user will not be
  6761. touched. Also, exit the agenda even if it is in column view."
  6762. (interactive)
  6763. (when org-agenda-columns-active
  6764. (org-columns-quit))
  6765. (org-release-buffers org-agenda-new-buffers)
  6766. (setq org-agenda-new-buffers nil)
  6767. (org-agenda-Quit))
  6768. (defun org-agenda-kill-all-agenda-buffers ()
  6769. "Kill all buffers in `org-agenda-mode'.
  6770. This is used when toggling sticky agendas."
  6771. (interactive)
  6772. (let (blist)
  6773. (dolist (buf (buffer-list))
  6774. (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
  6775. (push buf blist)))
  6776. (mapc 'kill-buffer blist)))
  6777. (defun org-agenda-execute (arg)
  6778. "Execute another agenda command, keeping same window.
  6779. So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
  6780. in the agenda."
  6781. (interactive "P")
  6782. (let ((org-agenda-window-setup 'current-window))
  6783. (org-agenda arg)))
  6784. (defun org-agenda-redo (&optional all)
  6785. "Rebuild possibly ALL agenda view(s) in the current buffer."
  6786. (interactive "P")
  6787. (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
  6788. (cpa (unless (eq all t) current-prefix-arg))
  6789. (org-agenda-doing-sticky-redo org-agenda-sticky)
  6790. (org-agenda-sticky nil)
  6791. (org-agenda-buffer-name (or org-agenda-this-buffer-name
  6792. org-agenda-buffer-name))
  6793. (org-agenda-keep-modes t)
  6794. (tag-filter org-agenda-tag-filter)
  6795. (tag-preset (get 'org-agenda-tag-filter :preset-filter))
  6796. (top-hl-filter org-agenda-top-headline-filter)
  6797. (cat-filter org-agenda-category-filter)
  6798. (cat-preset (get 'org-agenda-category-filter :preset-filter))
  6799. (re-filter org-agenda-regexp-filter)
  6800. (re-preset (get 'org-agenda-regexp-filter :preset-filter))
  6801. (effort-filter org-agenda-effort-filter)
  6802. (effort-preset (get 'org-agenda-effort-filter :preset-filter))
  6803. (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
  6804. (cols org-agenda-columns-active)
  6805. (line (org-current-line))
  6806. (window-line (- line (org-current-line (window-start))))
  6807. (lprops (get 'org-agenda-redo-command 'org-lprops))
  6808. (redo-cmd (get-text-property p 'org-redo-cmd))
  6809. (last-args (get-text-property p 'org-last-args))
  6810. (org-agenda-overriding-cmd (get-text-property p 'org-series-cmd))
  6811. (org-agenda-overriding-cmd-arguments
  6812. (unless (eq all t)
  6813. (cond ((listp last-args)
  6814. (cons (or cpa (car last-args)) (cdr last-args)))
  6815. ((stringp last-args)
  6816. last-args))))
  6817. (series-redo-cmd (get-text-property p 'org-series-redo-cmd)))
  6818. (put 'org-agenda-tag-filter :preset-filter nil)
  6819. (put 'org-agenda-category-filter :preset-filter nil)
  6820. (put 'org-agenda-regexp-filter :preset-filter nil)
  6821. (put 'org-agenda-effort-filter :preset-filter nil)
  6822. (and cols (org-columns-quit))
  6823. (message "Rebuilding agenda buffer...")
  6824. (if series-redo-cmd
  6825. (eval series-redo-cmd)
  6826. (org-let lprops redo-cmd))
  6827. (setq org-agenda-undo-list nil
  6828. org-agenda-pending-undo-list nil
  6829. org-agenda-tag-filter tag-filter
  6830. org-agenda-category-filter cat-filter
  6831. org-agenda-regexp-filter re-filter
  6832. org-agenda-effort-filter effort-filter
  6833. org-agenda-top-headline-filter top-hl-filter)
  6834. (message "Rebuilding agenda buffer...done")
  6835. (put 'org-agenda-tag-filter :preset-filter tag-preset)
  6836. (put 'org-agenda-category-filter :preset-filter cat-preset)
  6837. (put 'org-agenda-regexp-filter :preset-filter re-preset)
  6838. (put 'org-agenda-effort-filter :preset-filter effort-preset)
  6839. (let ((tag (or tag-filter tag-preset))
  6840. (cat (or cat-filter cat-preset))
  6841. (effort (or effort-filter effort-preset))
  6842. (re (or re-filter re-preset)))
  6843. (when tag (org-agenda-filter-apply tag 'tag t))
  6844. (when cat (org-agenda-filter-apply cat 'category))
  6845. (when effort (org-agenda-filter-apply effort 'effort))
  6846. (when re (org-agenda-filter-apply re 'regexp)))
  6847. (and top-hl-filter (org-agenda-filter-top-headline-apply top-hl-filter))
  6848. (and cols (called-interactively-p 'any) (org-agenda-columns))
  6849. (org-goto-line line)
  6850. (recenter window-line)))
  6851. (defvar org-global-tags-completion-table nil)
  6852. (defvar org-agenda-filter-form nil)
  6853. (defvar org-agenda-filtered-by-category nil)
  6854. (defun org-agenda-filter-by-category (strip)
  6855. "Filter lines in the agenda buffer that have a specific category.
  6856. The category is that of the current line.
  6857. Without prefix argument, keep only the lines of that category.
  6858. With a prefix argument, exclude the lines of that category.
  6859. "
  6860. (interactive "P")
  6861. (if (and org-agenda-filtered-by-category
  6862. org-agenda-category-filter)
  6863. (org-agenda-filter-show-all-cat)
  6864. (let ((cat (org-no-properties (org-get-at-eol 'org-category 1))))
  6865. (cond
  6866. ((and cat strip)
  6867. (org-agenda-filter-apply
  6868. (push (concat "-" cat) org-agenda-category-filter) 'category))
  6869. (cat
  6870. (org-agenda-filter-apply
  6871. (setq org-agenda-category-filter
  6872. (list (concat "+" cat))) 'category))
  6873. (t (error "No category at point"))))))
  6874. (defun org-find-top-headline (&optional pos)
  6875. "Find the topmost parent headline and return it."
  6876. (save-excursion
  6877. (with-current-buffer (if pos (marker-buffer pos) (current-buffer))
  6878. (if pos (goto-char pos))
  6879. ;; Skip up to the topmost parent
  6880. (while (ignore-errors (outline-up-heading 1) t))
  6881. (ignore-errors
  6882. (nth 4 (org-heading-components))))))
  6883. (defvar org-agenda-filtered-by-top-headline nil)
  6884. (defun org-agenda-filter-by-top-headline (strip)
  6885. "Keep only those lines that are descendants from the same top headline.
  6886. The top headline is that of the current line."
  6887. (interactive "P")
  6888. (if org-agenda-filtered-by-top-headline
  6889. (progn
  6890. (setq org-agenda-filtered-by-top-headline nil
  6891. org-agenda-top-headline-filter nil)
  6892. (org-agenda-filter-show-all-top-filter))
  6893. (let ((toph (org-find-top-headline (org-get-at-bol 'org-hd-marker))))
  6894. (if toph (org-agenda-filter-top-headline-apply toph strip)
  6895. (error "No top-level headline at point")))))
  6896. (defvar org-agenda-regexp-filter nil)
  6897. (defun org-agenda-filter-by-regexp (strip)
  6898. "Filter agenda entries by a regular expression.
  6899. Regexp filters are cumulative.
  6900. With no prefix argument, keep entries matching the regexp.
  6901. With one prefix argument, filter out entries matching the regexp.
  6902. With two prefix arguments, remove the regexp filters."
  6903. (interactive "P")
  6904. (if (not (equal strip '(16)))
  6905. (let ((flt (concat (if (equal strip '(4)) "-" "+")
  6906. (read-from-minibuffer
  6907. (if (equal strip '(4))
  6908. "Filter out entries matching regexp: "
  6909. "Narrow to entries matching regexp: ")))))
  6910. (push flt org-agenda-regexp-filter)
  6911. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
  6912. (org-agenda-filter-show-all-re)
  6913. (message "Regexp filter removed")))
  6914. (defvar org-agenda-effort-filter nil)
  6915. (defun org-agenda-filter-by-effort (strip)
  6916. "Filter agenda entries by effort.
  6917. With no prefix argument, keep entries matching the effort condition.
  6918. With one prefix argument, filter out entries matching the condition.
  6919. With two prefix arguments, remove the effort filters."
  6920. (interactive "P")
  6921. (cond ((member strip '(nil 4))
  6922. (let ((efforts (org-split-string
  6923. (or (cdr (assoc (concat org-effort-property "_ALL")
  6924. org-global-properties))
  6925. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00"
  6926. "")))
  6927. (eff -1)
  6928. effort-prompt op)
  6929. (while (not (member op '(?< ?> ?=)))
  6930. (setq op (read-char-exclusive "Effort operator? (> = or <)")))
  6931. (loop for i from 0 to 9 do
  6932. (setq effort-prompt
  6933. (concat
  6934. effort-prompt " ["
  6935. (if (= i 9) "0" (int-to-string (1+ i)))
  6936. "]" (nth i efforts))))
  6937. (message "Effort %s%s" (char-to-string op) effort-prompt)
  6938. (while (or (< eff 0) (> eff 9))
  6939. (setq eff (string-to-number (char-to-string (read-char-exclusive)))))
  6940. (setq org-agenda-effort-filter
  6941. (list (concat (if strip "-" "+")
  6942. (char-to-string op) (nth (1- eff) efforts))))
  6943. (org-agenda-filter-apply org-agenda-effort-filter 'effort)))
  6944. (t (org-agenda-filter-show-all-effort)
  6945. (message "Effort filter removed"))))
  6946. (defun org-agenda-filter-remove-all ()
  6947. "Remove all filters from the current agenda buffer."
  6948. (interactive)
  6949. (when org-agenda-tag-filter
  6950. (org-agenda-filter-show-all-tag))
  6951. (when org-agenda-category-filter
  6952. (org-agenda-filter-show-all-cat))
  6953. (when org-agenda-regexp-filter
  6954. (org-agenda-filter-show-all-re))
  6955. (when org-agenda-top-headline-filter
  6956. (org-agenda-filter-show-all-top-filter))
  6957. (when org-agenda-effort-filter
  6958. (org-agenda-filter-show-all-effort))
  6959. (org-agenda-finalize))
  6960. (defun org-agenda-filter-by-tag (arg &optional char exclude)
  6961. "Keep only those lines in the agenda buffer that have a specific tag.
  6962. The tag is selected with its fast selection letter, as
  6963. configured. With a single \\[universal-argument] prefix ARG,
  6964. exclude the agenda search. With a double \\[universal-argument]
  6965. prefix ARG, filter the literal tag. I.e. don't filter on all its
  6966. group members.
  6967. A lisp caller can specify CHAR. EXCLUDE means that the new tag should be
  6968. used to exclude the search - the interactive user can also press `-' or `+'
  6969. to switch between filtering and excluding."
  6970. (interactive "P")
  6971. (let* ((alist org-tag-alist-for-agenda)
  6972. (tag-chars (mapconcat
  6973. (lambda (x) (if (and (not (symbolp (car x)))
  6974. (cdr x))
  6975. (char-to-string (cdr x))
  6976. ""))
  6977. org-tag-alist-for-agenda ""))
  6978. (valid-char-list (append '(?\t ?\r ?/ ?. ?\s ?q)
  6979. (string-to-list tag-chars)))
  6980. (exclude (or exclude (equal arg '(4))))
  6981. (expand (not (equal arg '(16))))
  6982. (inhibit-read-only t)
  6983. (current org-agenda-tag-filter)
  6984. a n tag)
  6985. (unless char
  6986. (while (not (memq char valid-char-list))
  6987. (message
  6988. "%s by tag [%s ], [TAB], %s[/]:off, [+/-]:filter/exclude%s, [q]:quit"
  6989. (if exclude "Exclude" "Filter") tag-chars
  6990. (if org-agenda-auto-exclude-function "[RET], " "")
  6991. (if expand "" ", no grouptag expand"))
  6992. (setq char (read-char-exclusive))
  6993. ;; Excluding or filtering down
  6994. (cond ((eq char ?-) (setq exclude t))
  6995. ((eq char ?+) (setq exclude nil)))))
  6996. (when (eq char ?\t)
  6997. (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
  6998. (setq-local org-global-tags-completion-table
  6999. (org-global-tags-completion-table)))
  7000. (let ((completion-ignore-case t))
  7001. (setq tag (completing-read
  7002. "Tag: " org-global-tags-completion-table))))
  7003. (cond
  7004. ((eq char ?\r)
  7005. (org-agenda-filter-show-all-tag)
  7006. (when org-agenda-auto-exclude-function
  7007. (setq org-agenda-tag-filter nil)
  7008. (dolist (tag (org-agenda-get-represented-tags))
  7009. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  7010. (if modifier
  7011. (push modifier org-agenda-tag-filter))))
  7012. (if (not (null org-agenda-tag-filter))
  7013. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))))
  7014. ((eq char ?/)
  7015. (org-agenda-filter-show-all-tag)
  7016. (when (get 'org-agenda-tag-filter :preset-filter)
  7017. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand)))
  7018. ((eq char ?.)
  7019. (setq org-agenda-tag-filter
  7020. (mapcar (lambda(tag) (concat "+" tag))
  7021. (org-get-at-bol 'tags)))
  7022. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  7023. ((eq char ?q)) ;If q, abort (even if there is a q-key for a tag...)
  7024. ((or (eq char ?\s)
  7025. (setq a (rassoc char alist))
  7026. (and tag (setq a (cons tag nil))))
  7027. (org-agenda-filter-show-all-tag)
  7028. (setq tag (car a))
  7029. (setq org-agenda-tag-filter
  7030. (cons (concat (if exclude "-" "+") tag)
  7031. current))
  7032. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  7033. (t (error "Invalid tag selection character %c" char)))))
  7034. (defun org-agenda-get-represented-tags ()
  7035. "Get a list of all tags currently represented in the agenda."
  7036. (let (p tags)
  7037. (save-excursion
  7038. (goto-char (point-min))
  7039. (while (setq p (next-single-property-change (point) 'tags))
  7040. (goto-char p)
  7041. (mapc (lambda (x) (add-to-list 'tags x))
  7042. (get-text-property (point) 'tags))))
  7043. tags))
  7044. (defun org-agenda-filter-make-matcher (filter type &optional expand)
  7045. "Create the form that tests a line for agenda filter. Optional
  7046. argument EXPAND can be used for the TYPE tag and will expand the
  7047. tags in the FILTER if any of the tags in FILTER are grouptags."
  7048. (let (f f1)
  7049. (cond
  7050. ;; Tag filter
  7051. ((eq type 'tag)
  7052. (setq filter
  7053. (delete-dups
  7054. (append (get 'org-agenda-tag-filter :preset-filter)
  7055. filter)))
  7056. (dolist (x filter)
  7057. (let ((op (string-to-char x)))
  7058. (if expand (setq x (org-agenda-filter-expand-tags (list x) t))
  7059. (setq x (list x)))
  7060. (setq f1 (org-agenda-filter-make-matcher-tag-exp x op))
  7061. (push f1 f))))
  7062. ;; Category filter
  7063. ((eq type 'category)
  7064. (setq filter
  7065. (delete-dups
  7066. (append (get 'org-agenda-category-filter :preset-filter)
  7067. filter)))
  7068. (dolist (x filter)
  7069. (if (equal "-" (substring x 0 1))
  7070. (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
  7071. (setq f1 (list 'equal (substring x 1) 'cat)))
  7072. (push f1 f)))
  7073. ;; Regexp filter
  7074. ((eq type 'regexp)
  7075. (setq filter
  7076. (delete-dups
  7077. (append (get 'org-agenda-regexp-filter :preset-filter)
  7078. filter)))
  7079. (dolist (x filter)
  7080. (if (equal "-" (substring x 0 1))
  7081. (setq f1 (list 'not (list 'string-match (substring x 1) 'txt)))
  7082. (setq f1 (list 'string-match (substring x 1) 'txt)))
  7083. (push f1 f)))
  7084. ;; Effort filter
  7085. ((eq type 'effort)
  7086. (setq filter
  7087. (delete-dups
  7088. (append (get 'org-agenda-effort-filter :preset-filter)
  7089. filter)))
  7090. (dolist (x filter)
  7091. (push (org-agenda-filter-effort-form x) f))))
  7092. (cons 'and (nreverse f))))
  7093. (defun org-agenda-filter-make-matcher-tag-exp (tags op)
  7094. "Return a form associated to tag-expression TAGS.
  7095. Build a form testing a line for agenda filter for
  7096. tag-expressions. OP is an operator of type CHAR that allows the
  7097. function to set the right switches in the returned form."
  7098. (let (form)
  7099. ;; Any of the expressions can match if OP is +, all must match if
  7100. ;; the operator is -.
  7101. (dolist (x tags (cons (if (eq op ?-) 'and 'or) form))
  7102. (let* ((tag (substring x 1))
  7103. (f (cond
  7104. ((string= "" tag) '(not tags))
  7105. ((and (string-match-p "\\`{" tag) (string-match-p "}\\'" tag))
  7106. ;; TAG is a regexp.
  7107. (list 'org-match-any-p (substring tag 1 -1) 'tags))
  7108. (t (list 'member (downcase tag) 'tags)))))
  7109. (push (if (eq op ?-) (list 'not f) f) form)))))
  7110. (defun org-agenda-filter-effort-form (e)
  7111. "Return the form to compare the effort of the current line with what E says.
  7112. E looks like \"+<2:25\"."
  7113. (let (op)
  7114. (setq e (substring e 1))
  7115. (setq op (string-to-char e) e (substring e 1))
  7116. (setq op (cond ((equal op ?<) '<=)
  7117. ((equal op ?>) '>=)
  7118. ((equal op ??) op)
  7119. (t '=)))
  7120. (list 'org-agenda-compare-effort (list 'quote op)
  7121. (org-duration-string-to-minutes e))))
  7122. (defun org-agenda-compare-effort (op value)
  7123. "Compare the effort of the current line with VALUE, using OP.
  7124. If the line does not have an effort defined, return nil."
  7125. (let ((eff (org-get-at-eol 'effort-minutes 1)))
  7126. (funcall op (or eff (if org-sort-agenda-noeffort-is-high 32767 -1))
  7127. value)))
  7128. (defun org-agenda-filter-expand-tags (filter &optional no-operator)
  7129. "Expand group tags in FILTER for the agenda.
  7130. When NO-OPERATOR is non-nil, do not add the + operator to returned tags."
  7131. (if org-group-tags
  7132. (let ((case-fold-search t) rtn)
  7133. (mapc
  7134. (lambda (f)
  7135. (let (f0 dir)
  7136. (if (string-match "^\\([+-]\\)\\(.+\\)" f)
  7137. (setq dir (match-string 1 f) f0 (match-string 2 f))
  7138. (setq dir (if no-operator "" "+") f0 f))
  7139. (setq rtn (append (mapcar (lambda(f1) (concat dir f1))
  7140. (org-tags-expand f0 t t))
  7141. rtn))))
  7142. filter)
  7143. (reverse rtn))
  7144. filter))
  7145. (defun org-agenda-filter-apply (filter type &optional expand)
  7146. "Set FILTER as the new agenda filter and apply it. Optional
  7147. argument EXPAND can be used for the TYPE tag and will expand the
  7148. tags in the FILTER if any of the tags in FILTER are grouptags."
  7149. ;; Deactivate `org-agenda-entry-text-mode' when filtering
  7150. (if org-agenda-entry-text-mode (org-agenda-entry-text-mode))
  7151. (let (tags cat txt)
  7152. (setq org-agenda-filter-form (org-agenda-filter-make-matcher filter type expand))
  7153. ;; Only set `org-agenda-filtered-by-category' to t when a unique
  7154. ;; category is used as the filter:
  7155. (setq org-agenda-filtered-by-category
  7156. (and (eq type 'category)
  7157. (not (equal (substring (car filter) 0 1) "-"))))
  7158. (org-agenda-set-mode-name)
  7159. (save-excursion
  7160. (goto-char (point-min))
  7161. (while (not (eobp))
  7162. (if (org-get-at-bol 'org-marker)
  7163. (progn
  7164. (setq tags (org-get-at-bol 'tags)
  7165. cat (org-get-at-eol 'org-category 1)
  7166. txt (org-get-at-bol 'txt))
  7167. (if (not (eval org-agenda-filter-form))
  7168. (org-agenda-filter-hide-line type))
  7169. (beginning-of-line 2))
  7170. (beginning-of-line 2))))
  7171. (if (get-char-property (point) 'invisible)
  7172. (ignore-errors (org-agenda-previous-line)))))
  7173. (defun org-agenda-filter-top-headline-apply (hl &optional negative)
  7174. "Filter by top headline HL."
  7175. (org-agenda-set-mode-name)
  7176. (save-excursion
  7177. (goto-char (point-min))
  7178. (while (not (eobp))
  7179. (let* ((pos (org-get-at-bol 'org-hd-marker))
  7180. (tophl (and pos (org-find-top-headline pos))))
  7181. (if (and tophl (funcall (if negative 'identity 'not)
  7182. (string= hl tophl)))
  7183. (org-agenda-filter-hide-line 'top-headline)))
  7184. (beginning-of-line 2)))
  7185. (if (get-char-property (point) 'invisible)
  7186. (org-agenda-previous-line))
  7187. (setq org-agenda-top-headline-filter hl
  7188. org-agenda-filtered-by-top-headline t))
  7189. (defun org-agenda-filter-hide-line (type)
  7190. "Hide lines with TYPE in the agenda buffer."
  7191. (let* ((b (max (point-min) (1- (point-at-bol))))
  7192. (e (point-at-eol)))
  7193. (let ((inhibit-read-only t))
  7194. (add-text-properties
  7195. b e `(invisible org-filtered org-filter-type ,type)))))
  7196. (defun org-agenda-remove-filter (type)
  7197. (interactive)
  7198. "Remove filter of type TYPE from the agenda buffer."
  7199. (save-excursion
  7200. (goto-char (point-min))
  7201. (let ((inhibit-read-only t) pos)
  7202. (while (setq pos (text-property-any (point) (point-max) 'org-filter-type type))
  7203. (goto-char pos)
  7204. (remove-text-properties
  7205. (point) (next-single-property-change (point) 'org-filter-type)
  7206. `(invisible org-filtered org-filter-type ,type))))
  7207. (set (intern (format "org-agenda-%s-filter" (intern-soft type))) nil)
  7208. (setq org-agenda-filter-form nil)
  7209. (org-agenda-set-mode-name)
  7210. (org-agenda-finalize)))
  7211. (defun org-agenda-filter-show-all-tag nil
  7212. (org-agenda-remove-filter 'tag))
  7213. (defun org-agenda-filter-show-all-re nil
  7214. (org-agenda-remove-filter 'regexp))
  7215. (defun org-agenda-filter-show-all-effort nil
  7216. (org-agenda-remove-filter 'effort))
  7217. (defun org-agenda-filter-show-all-cat nil
  7218. (org-agenda-remove-filter 'category))
  7219. (defun org-agenda-filter-show-all-top-filter nil
  7220. (org-agenda-remove-filter 'top-headline))
  7221. (defun org-agenda-manipulate-query-add ()
  7222. "Manipulate the query by adding a search term with positive selection.
  7223. Positive selection means the term must be matched for selection of an entry."
  7224. (interactive)
  7225. (org-agenda-manipulate-query ?\[))
  7226. (defun org-agenda-manipulate-query-subtract ()
  7227. "Manipulate the query by adding a search term with negative selection.
  7228. Negative selection means term must not be matched for selection of an entry."
  7229. (interactive)
  7230. (org-agenda-manipulate-query ?\]))
  7231. (defun org-agenda-manipulate-query-add-re ()
  7232. "Manipulate the query by adding a search regexp with positive selection.
  7233. Positive selection means the regexp must match for selection of an entry."
  7234. (interactive)
  7235. (org-agenda-manipulate-query ?\{))
  7236. (defun org-agenda-manipulate-query-subtract-re ()
  7237. "Manipulate the query by adding a search regexp with negative selection.
  7238. Negative selection means regexp must not match for selection of an entry."
  7239. (interactive)
  7240. (org-agenda-manipulate-query ?\}))
  7241. (defun org-agenda-manipulate-query (char)
  7242. (cond
  7243. ((memq org-agenda-type '(timeline agenda))
  7244. (let ((org-agenda-include-inactive-timestamps t))
  7245. (org-agenda-redo))
  7246. (message "Display now includes inactive timestamps as well"))
  7247. ((eq org-agenda-type 'search)
  7248. (org-add-to-string
  7249. 'org-agenda-query-string
  7250. (if org-agenda-last-search-view-search-was-boolean
  7251. (cdr (assoc char '((?\[ . " +") (?\] . " -")
  7252. (?\{ . " +{}") (?\} . " -{}"))))
  7253. " "))
  7254. (setq org-agenda-redo-command
  7255. (list 'org-search-view
  7256. (car (get-text-property (min (1- (point-max)) (point))
  7257. 'org-last-args))
  7258. org-agenda-query-string
  7259. (+ (length org-agenda-query-string)
  7260. (if (member char '(?\{ ?\})) 0 1))))
  7261. (set-register org-agenda-query-register org-agenda-query-string)
  7262. (let ((org-agenda-overriding-arguments
  7263. (cdr org-agenda-redo-command)))
  7264. (org-agenda-redo)))
  7265. (t (error "Cannot manipulate query for %s-type agenda buffers"
  7266. org-agenda-type))))
  7267. (defun org-add-to-string (var string)
  7268. (set var (concat (symbol-value var) string)))
  7269. (defun org-agenda-goto-date (span)
  7270. "Jump to DATE in agenda."
  7271. (interactive "P")
  7272. (let* ((org-read-date-prefer-future
  7273. (eval org-agenda-jump-prefer-future))
  7274. (date (org-read-date))
  7275. (day (time-to-days (org-time-string-to-time date)))
  7276. (org-agenda-sticky-orig org-agenda-sticky)
  7277. (org-agenda-buffer-tmp-name (buffer-name))
  7278. (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7279. (0-arg (or current-prefix-arg (car args)))
  7280. (2-arg (nth 2 args))
  7281. (with-hour-p (nth 4 org-agenda-redo-command))
  7282. (newcmd (list 'org-agenda-list 0-arg date
  7283. (org-agenda-span-to-ndays
  7284. 2-arg (org-time-string-to-absolute date))
  7285. with-hour-p))
  7286. (newargs (cdr newcmd))
  7287. (inhibit-read-only t)
  7288. org-agenda-sticky)
  7289. (if (not (org-agenda-check-type t 'agenda))
  7290. (error "Not available in non-agenda views")
  7291. (add-text-properties (point-min) (point-max)
  7292. `(org-redo-cmd ,newcmd org-last-args ,newargs))
  7293. (org-agenda-redo)
  7294. (goto-char (point-min))
  7295. (while (not (or (= (or (get-text-property (point) 'day) 0) day)
  7296. (save-excursion (move-beginning-of-line 2) (eobp))))
  7297. (move-beginning-of-line 2))
  7298. (setq org-agenda-sticky org-agenda-sticky-orig
  7299. org-agenda-this-buffer-is-sticky org-agenda-sticky))))
  7300. (defun org-agenda-goto-today ()
  7301. "Go to today."
  7302. (interactive)
  7303. (org-agenda-check-type t 'timeline 'agenda)
  7304. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7305. (curspan (nth 2 args))
  7306. (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
  7307. (cond
  7308. (tdpos (goto-char tdpos))
  7309. ((eq org-agenda-type 'agenda)
  7310. (let* ((sd (org-agenda-compute-starting-span
  7311. (org-today) (or curspan org-agenda-span)))
  7312. (org-agenda-overriding-arguments args))
  7313. (setf (nth 1 org-agenda-overriding-arguments) sd)
  7314. (org-agenda-redo)
  7315. (org-agenda-find-same-or-today-or-agenda)))
  7316. (t (error "Cannot find today")))))
  7317. (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
  7318. (goto-char
  7319. (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
  7320. (text-property-any (point-min) (point-max) 'org-today t)
  7321. (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
  7322. (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
  7323. (org-agenda-backward-block))
  7324. (point-min))))
  7325. (defun org-agenda-backward-block ()
  7326. "Move backward by one agenda block."
  7327. (interactive)
  7328. (org-agenda-forward-block 'backward))
  7329. (defun org-agenda-forward-block (&optional backward)
  7330. "Move forward by one agenda block.
  7331. When optional argument BACKWARD is set, go backward"
  7332. (interactive)
  7333. (cond ((not (derived-mode-p 'org-agenda-mode))
  7334. (user-error
  7335. "Cannot execute this command outside of org-agenda-mode buffers"))
  7336. ((looking-at (if backward "\\`" "\\'"))
  7337. (message "Already at the %s block" (if backward "first" "last")))
  7338. (t (let ((pos (prog1 (point)
  7339. (ignore-errors (if backward (backward-char 1)
  7340. (move-end-of-line 1)))))
  7341. (f (if backward
  7342. 'previous-single-property-change
  7343. 'next-single-property-change))
  7344. moved dest)
  7345. (while (and (setq dest (funcall
  7346. f (point) 'org-agenda-structural-header))
  7347. (not (get-text-property
  7348. (point) 'org-agenda-structural-header)))
  7349. (setq moved t)
  7350. (goto-char dest))
  7351. (if moved (move-beginning-of-line 1)
  7352. (goto-char (if backward (point-min) (point-max)))
  7353. (move-beginning-of-line 1)
  7354. (message "No %s block" (if backward "previous" "further")))))))
  7355. (defun org-agenda-later (arg)
  7356. "Go forward in time by the current span.
  7357. With prefix ARG, go forward that many times the current span."
  7358. (interactive "p")
  7359. (org-agenda-check-type t 'agenda)
  7360. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7361. (span (or (nth 2 args) org-agenda-current-span))
  7362. (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
  7363. (greg (calendar-gregorian-from-absolute sd))
  7364. (cnt (org-get-at-bol 'org-day-cnt))
  7365. greg2)
  7366. (cond
  7367. ((numberp span)
  7368. (setq sd (+ (* span arg) sd)))
  7369. ((eq span 'day)
  7370. (setq sd (+ arg sd)))
  7371. ((eq span 'week)
  7372. (setq sd (+ (* 7 arg) sd)))
  7373. ((eq span 'fortnight)
  7374. (setq sd (+ (* 14 arg) sd)))
  7375. ((eq span 'month)
  7376. (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
  7377. sd (calendar-absolute-from-gregorian greg2))
  7378. (setcar greg2 (1+ (car greg2))))
  7379. ((eq span 'year)
  7380. (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
  7381. sd (calendar-absolute-from-gregorian greg2))
  7382. (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
  7383. (t
  7384. (setq sd (+ (* span arg) sd))))
  7385. (let ((org-agenda-overriding-cmd
  7386. ;; `cmd' may have been set by `org-agenda-run-series' which
  7387. ;; uses `org-agenda-overriding-cmd' to decide whether
  7388. ;; overriding is allowed for `cmd'
  7389. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7390. (org-agenda-overriding-arguments
  7391. (list (car args) sd span)))
  7392. (org-agenda-redo)
  7393. (org-agenda-find-same-or-today-or-agenda cnt))))
  7394. (defun org-agenda-earlier (arg)
  7395. "Go backward in time by the current span.
  7396. With prefix ARG, go backward that many times the current span."
  7397. (interactive "p")
  7398. (org-agenda-later (- arg)))
  7399. (defun org-agenda-view-mode-dispatch ()
  7400. "Call one of the view mode commands."
  7401. (interactive)
  7402. (message "View: [d]ay [w]eek for[t]night [m]onth [y]ear [SPC]reset [q]uit/abort
  7403. time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
  7404. [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
  7405. (let ((a (read-char-exclusive)))
  7406. (case a
  7407. (?\ (call-interactively 'org-agenda-reset-view))
  7408. (?d (call-interactively 'org-agenda-day-view))
  7409. (?w (call-interactively 'org-agenda-week-view))
  7410. (?t (call-interactively 'org-agenda-fortnight-view))
  7411. (?m (call-interactively 'org-agenda-month-view))
  7412. (?y (call-interactively 'org-agenda-year-view))
  7413. (?l (call-interactively 'org-agenda-log-mode))
  7414. (?L (org-agenda-log-mode '(4)))
  7415. (?c (org-agenda-log-mode 'clockcheck))
  7416. ((?F ?f) (call-interactively 'org-agenda-follow-mode))
  7417. (?a (call-interactively 'org-agenda-archives-mode))
  7418. (?A (org-agenda-archives-mode 'files))
  7419. ((?R ?r) (call-interactively 'org-agenda-clockreport-mode))
  7420. ((?E ?e) (call-interactively 'org-agenda-entry-text-mode))
  7421. (?G (call-interactively 'org-agenda-toggle-time-grid))
  7422. (?D (call-interactively 'org-agenda-toggle-diary))
  7423. (?\! (call-interactively 'org-agenda-toggle-deadlines))
  7424. (?\[ (let ((org-agenda-include-inactive-timestamps t))
  7425. (org-agenda-check-type t 'timeline 'agenda)
  7426. (org-agenda-redo))
  7427. (message "Display now includes inactive timestamps as well"))
  7428. (?q (message "Abort"))
  7429. (otherwise (error "Invalid key" )))))
  7430. (defun org-agenda-reset-view ()
  7431. "Switch to default view for agenda."
  7432. (interactive)
  7433. (org-agenda-change-time-span org-agenda-span))
  7434. (defun org-agenda-day-view (&optional day-of-month)
  7435. "Switch to daily view for agenda.
  7436. With argument DAY-OF-MONTH, switch to that day of the month."
  7437. (interactive "P")
  7438. (org-agenda-change-time-span 'day day-of-month))
  7439. (defun org-agenda-week-view (&optional iso-week)
  7440. "Switch to daily view for agenda.
  7441. With argument ISO-WEEK, switch to the corresponding ISO week.
  7442. If ISO-WEEK has more then 2 digits, only the last two encode the
  7443. week. Any digits before this encode a year. So 200712 means
  7444. week 12 of year 2007. Years in the range 1938-2037 can also be
  7445. written as 2-digit years."
  7446. (interactive "P")
  7447. (org-agenda-change-time-span 'week iso-week))
  7448. (defun org-agenda-fortnight-view (&optional iso-week)
  7449. "Switch to daily view for agenda.
  7450. With argument ISO-WEEK, switch to the corresponding ISO week.
  7451. If ISO-WEEK has more then 2 digits, only the last two encode the
  7452. week. Any digits before this encode a year. So 200712 means
  7453. week 12 of year 2007. Years in the range 1938-2037 can also be
  7454. written as 2-digit years."
  7455. (interactive "P")
  7456. (org-agenda-change-time-span 'fortnight iso-week))
  7457. (defun org-agenda-month-view (&optional month)
  7458. "Switch to monthly view for agenda.
  7459. With argument MONTH, switch to that month."
  7460. (interactive "P")
  7461. (org-agenda-change-time-span 'month month))
  7462. (defun org-agenda-year-view (&optional year)
  7463. "Switch to yearly view for agenda.
  7464. With argument YEAR, switch to that year.
  7465. If MONTH has more then 2 digits, only the last two encode the
  7466. month. Any digits before this encode a year. So 200712 means
  7467. December year 2007. Years in the range 1938-2037 can also be
  7468. written as 2-digit years."
  7469. (interactive "P")
  7470. (when year
  7471. (setq year (org-small-year-to-year year)))
  7472. (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
  7473. (org-agenda-change-time-span 'year year)
  7474. (error "Abort")))
  7475. (defun org-agenda-change-time-span (span &optional n)
  7476. "Change the agenda view to SPAN.
  7477. SPAN may be `day', `week', `fortnight', `month', `year'."
  7478. (org-agenda-check-type t 'agenda)
  7479. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7480. (curspan (nth 2 args)))
  7481. (if (and (not n) (equal curspan span))
  7482. (error "Viewing span is already \"%s\"" span))
  7483. (let* ((sd (or (org-get-at-bol 'day)
  7484. (nth 1 args)
  7485. org-starting-day))
  7486. (sd (org-agenda-compute-starting-span sd span n))
  7487. (org-agenda-overriding-cmd
  7488. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7489. (org-agenda-overriding-arguments
  7490. (list (car args) sd span)))
  7491. (org-agenda-redo)
  7492. (org-agenda-find-same-or-today-or-agenda))
  7493. (org-agenda-set-mode-name)
  7494. (message "Switched to %s view" span)))
  7495. (defun org-agenda-compute-starting-span (sd span &optional n)
  7496. "Compute starting date for agenda.
  7497. SPAN may be `day', `week', `fortnight', `month', `year'. The return value
  7498. is a cons cell with the starting date and the number of days,
  7499. so that the date SD will be in that range."
  7500. (let* ((greg (calendar-gregorian-from-absolute sd))
  7501. (dg (nth 1 greg))
  7502. (mg (car greg))
  7503. (yg (nth 2 greg)))
  7504. (cond
  7505. ((eq span 'day)
  7506. (when n
  7507. (setq sd (+ (calendar-absolute-from-gregorian
  7508. (list mg 1 yg))
  7509. n -1))))
  7510. ((or (eq span 'week) (eq span 'fortnight))
  7511. (let* ((nt (calendar-day-of-week
  7512. (calendar-gregorian-from-absolute sd)))
  7513. (d (if org-agenda-start-on-weekday
  7514. (- nt org-agenda-start-on-weekday)
  7515. 0))
  7516. y1)
  7517. (setq sd (- sd (+ (if (< d 0) 7 0) d)))
  7518. (when n
  7519. (require 'cal-iso)
  7520. (when (> n 99)
  7521. (setq y1 (org-small-year-to-year (/ n 100))
  7522. n (mod n 100)))
  7523. (setq sd
  7524. (calendar-iso-to-absolute
  7525. (list n 1
  7526. (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
  7527. ((eq span 'month)
  7528. (let (y1)
  7529. (when (and n (> n 99))
  7530. (setq y1 (org-small-year-to-year (/ n 100))
  7531. n (mod n 100)))
  7532. (setq sd (calendar-absolute-from-gregorian
  7533. (list (or n mg) 1 (or y1 yg))))))
  7534. ((eq span 'year)
  7535. (setq sd (calendar-absolute-from-gregorian
  7536. (list 1 1 (or n yg))))))
  7537. sd))
  7538. (defun org-agenda-next-date-line (&optional arg)
  7539. "Jump to the next line indicating a date in agenda buffer."
  7540. (interactive "p")
  7541. (org-agenda-check-type t 'agenda 'timeline)
  7542. (beginning-of-line 1)
  7543. ;; This does not work if user makes date format that starts with a blank
  7544. (if (looking-at "^\\S-") (forward-char 1))
  7545. (if (not (re-search-forward "^\\S-" nil t arg))
  7546. (progn
  7547. (backward-char 1)
  7548. (error "No next date after this line in this buffer")))
  7549. (goto-char (match-beginning 0)))
  7550. (defun org-agenda-previous-date-line (&optional arg)
  7551. "Jump to the previous line indicating a date in agenda buffer."
  7552. (interactive "p")
  7553. (org-agenda-check-type t 'agenda 'timeline)
  7554. (beginning-of-line 1)
  7555. (if (not (re-search-backward "^\\S-" nil t arg))
  7556. (error "No previous date before this line in this buffer")))
  7557. ;; Initialize the highlight
  7558. (defvar org-hl (make-overlay 1 1))
  7559. (overlay-put org-hl 'face 'highlight)
  7560. (defun org-highlight (begin end &optional buffer)
  7561. "Highlight a region with overlay."
  7562. (move-overlay org-hl begin end (or buffer (current-buffer))))
  7563. (defun org-unhighlight ()
  7564. "Detach overlay INDEX."
  7565. (delete-overlay org-hl))
  7566. (defun org-unhighlight-once ()
  7567. "Remove the highlight from its position, and this function from the hook."
  7568. (remove-hook 'pre-command-hook 'org-unhighlight-once)
  7569. (org-unhighlight))
  7570. (defvar org-agenda-pre-follow-window-conf nil)
  7571. (defun org-agenda-follow-mode ()
  7572. "Toggle follow mode in an agenda buffer."
  7573. (interactive)
  7574. (unless org-agenda-follow-mode
  7575. (setq org-agenda-pre-follow-window-conf
  7576. (current-window-configuration)))
  7577. (setq org-agenda-follow-mode (not org-agenda-follow-mode))
  7578. (unless org-agenda-follow-mode
  7579. (set-window-configuration org-agenda-pre-follow-window-conf))
  7580. (org-agenda-set-mode-name)
  7581. (org-agenda-do-context-action)
  7582. (message "Follow mode is %s"
  7583. (if org-agenda-follow-mode "on" "off")))
  7584. (defun org-agenda-entry-text-mode (&optional arg)
  7585. "Toggle entry text mode in an agenda buffer."
  7586. (interactive "P")
  7587. (if (or org-agenda-tag-filter
  7588. org-agenda-category-filter
  7589. org-agenda-regexp-filter
  7590. org-agenda-top-headline-filter)
  7591. (user-error "Can't show entry text in filtered views")
  7592. (setq org-agenda-entry-text-mode (or (integerp arg)
  7593. (not org-agenda-entry-text-mode)))
  7594. (org-agenda-entry-text-hide)
  7595. (and org-agenda-entry-text-mode
  7596. (let ((org-agenda-entry-text-maxlines
  7597. (if (integerp arg) arg org-agenda-entry-text-maxlines)))
  7598. (org-agenda-entry-text-show)))
  7599. (org-agenda-set-mode-name)
  7600. (message "Entry text mode is %s%s"
  7601. (if org-agenda-entry-text-mode "on" "off")
  7602. (if (not org-agenda-entry-text-mode) ""
  7603. (format " (maximum number of lines is %d)"
  7604. (if (integerp arg) arg org-agenda-entry-text-maxlines))))))
  7605. (defun org-agenda-clockreport-mode ()
  7606. "Toggle clocktable mode in an agenda buffer."
  7607. (interactive)
  7608. (org-agenda-check-type t 'agenda)
  7609. (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode))
  7610. (setq org-agenda-start-with-clockreport-mode org-agenda-clockreport-mode)
  7611. (org-agenda-set-mode-name)
  7612. (org-agenda-redo)
  7613. (message "Clocktable mode is %s"
  7614. (if org-agenda-clockreport-mode "on" "off")))
  7615. (defun org-agenda-log-mode (&optional special)
  7616. "Toggle log mode in an agenda buffer.
  7617. With argument SPECIAL, show all possible log items, not only the ones
  7618. configured in `org-agenda-log-mode-items'.
  7619. With a double \\[universal-argument] prefix arg, show *only* \
  7620. log items, nothing else."
  7621. (interactive "P")
  7622. (org-agenda-check-type t 'agenda 'timeline)
  7623. (setq org-agenda-show-log
  7624. (cond
  7625. ((equal special '(16)) 'only)
  7626. ((eq special 'clockcheck)
  7627. (if (eq org-agenda-show-log 'clockcheck)
  7628. nil 'clockcheck))
  7629. (special '(closed clock state))
  7630. (t (not org-agenda-show-log))))
  7631. (setq org-agenda-start-with-log-mode org-agenda-show-log)
  7632. (org-agenda-set-mode-name)
  7633. (org-agenda-redo)
  7634. (message "Log mode is %s"
  7635. (if org-agenda-show-log "on" "off")))
  7636. (defun org-agenda-archives-mode (&optional with-files)
  7637. "Toggle inclusion of items in trees marked with :ARCHIVE:.
  7638. When called with a prefix argument, include all archive files as well."
  7639. (interactive "P")
  7640. (setq org-agenda-archives-mode
  7641. (if with-files t (if org-agenda-archives-mode nil 'trees)))
  7642. (org-agenda-set-mode-name)
  7643. (org-agenda-redo)
  7644. (message
  7645. "%s"
  7646. (cond
  7647. ((eq org-agenda-archives-mode nil)
  7648. "No archives are included")
  7649. ((eq org-agenda-archives-mode 'trees)
  7650. (format "Trees with :%s: tag are included" org-archive-tag))
  7651. ((eq org-agenda-archives-mode t)
  7652. (format "Trees with :%s: tag and all active archive files are included"
  7653. org-archive-tag)))))
  7654. (defun org-agenda-toggle-diary ()
  7655. "Toggle diary inclusion in an agenda buffer."
  7656. (interactive)
  7657. (org-agenda-check-type t 'agenda)
  7658. (setq org-agenda-include-diary (not org-agenda-include-diary))
  7659. (org-agenda-redo)
  7660. (org-agenda-set-mode-name)
  7661. (message "Diary inclusion turned %s"
  7662. (if org-agenda-include-diary "on" "off")))
  7663. (defun org-agenda-toggle-deadlines ()
  7664. "Toggle inclusion of entries with a deadline in an agenda buffer."
  7665. (interactive)
  7666. (org-agenda-check-type t 'agenda)
  7667. (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
  7668. (org-agenda-redo)
  7669. (org-agenda-set-mode-name)
  7670. (message "Deadlines inclusion turned %s"
  7671. (if org-agenda-include-deadlines "on" "off")))
  7672. (defun org-agenda-toggle-time-grid ()
  7673. "Toggle time grid in an agenda buffer."
  7674. (interactive)
  7675. (org-agenda-check-type t 'agenda)
  7676. (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
  7677. (org-agenda-redo)
  7678. (org-agenda-set-mode-name)
  7679. (message "Time-grid turned %s"
  7680. (if org-agenda-use-time-grid "on" "off")))
  7681. (defun org-agenda-set-mode-name ()
  7682. "Set the mode name to indicate all the small mode settings."
  7683. (setq mode-name
  7684. (list "Org-Agenda"
  7685. (if (get 'org-agenda-files 'org-restrict) " []" "")
  7686. " "
  7687. '(:eval (org-agenda-span-name org-agenda-current-span))
  7688. (if org-agenda-follow-mode " Follow" "")
  7689. (if org-agenda-entry-text-mode " ETxt" "")
  7690. (if org-agenda-include-diary " Diary" "")
  7691. (if org-agenda-include-deadlines " Ddl" "")
  7692. (if org-agenda-use-time-grid " Grid" "")
  7693. (if (and (boundp 'org-habit-show-habits)
  7694. org-habit-show-habits) " Habit" "")
  7695. (cond
  7696. ((consp org-agenda-show-log) " LogAll")
  7697. ((eq org-agenda-show-log 'clockcheck) " ClkCk")
  7698. (org-agenda-show-log " Log")
  7699. (t ""))
  7700. (if (or org-agenda-category-filter
  7701. (get 'org-agenda-category-filter :preset-filter))
  7702. '(:eval (propertize
  7703. (concat " <"
  7704. (mapconcat
  7705. 'identity
  7706. (append
  7707. (get 'org-agenda-category-filter :preset-filter)
  7708. org-agenda-category-filter)
  7709. "")
  7710. ">")
  7711. 'face 'org-agenda-filter-category
  7712. 'help-echo "Category used in filtering")) "")
  7713. (if (or org-agenda-tag-filter
  7714. (get 'org-agenda-tag-filter :preset-filter))
  7715. '(:eval (propertize
  7716. (concat " {"
  7717. (mapconcat
  7718. 'identity
  7719. (append
  7720. (get 'org-agenda-tag-filter :preset-filter)
  7721. org-agenda-tag-filter)
  7722. "")
  7723. "}")
  7724. 'face 'org-agenda-filter-tags
  7725. 'help-echo "Tags used in filtering")) "")
  7726. (if (or org-agenda-effort-filter
  7727. (get 'org-agenda-effort-filter :preset-filter))
  7728. '(:eval (propertize
  7729. (concat " {"
  7730. (mapconcat
  7731. 'identity
  7732. (append
  7733. (get 'org-agenda-effort-filter :preset-filter)
  7734. org-agenda-effort-filter)
  7735. "")
  7736. "}")
  7737. 'face 'org-agenda-filter-effort
  7738. 'help-echo "Effort conditions used in filtering")) "")
  7739. (if (or org-agenda-regexp-filter
  7740. (get 'org-agenda-regexp-filter :preset-filter))
  7741. '(:eval (propertize
  7742. (concat " ["
  7743. (mapconcat
  7744. 'identity
  7745. (append
  7746. (get 'org-agenda-regexp-filter :preset-filter)
  7747. org-agenda-regexp-filter)
  7748. "")
  7749. "]")
  7750. 'face 'org-agenda-filter-regexp
  7751. 'help-echo "Regexp used in filtering")) "")
  7752. (if org-agenda-archives-mode
  7753. (if (eq org-agenda-archives-mode t)
  7754. " Archives"
  7755. (format " :%s:" org-archive-tag))
  7756. "")
  7757. (if org-agenda-clockreport-mode " Clock" "")))
  7758. (force-mode-line-update))
  7759. (defun org-agenda-update-agenda-type ()
  7760. "Update the agenda type after each command."
  7761. (setq org-agenda-type
  7762. (or (get-text-property (point) 'org-agenda-type)
  7763. (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
  7764. (defun org-agenda-next-line ()
  7765. "Move cursor to the next line, and show if follow mode is active."
  7766. (interactive)
  7767. (call-interactively 'next-line)
  7768. (org-agenda-do-context-action))
  7769. (defun org-agenda-previous-line ()
  7770. "Move cursor to the previous line, and show if follow-mode is active."
  7771. (interactive)
  7772. (call-interactively 'previous-line)
  7773. (org-agenda-do-context-action))
  7774. (defun org-agenda-next-item (n)
  7775. "Move cursor to next agenda item."
  7776. (interactive "p")
  7777. (let ((col (current-column)))
  7778. (dotimes (c n)
  7779. (when (next-single-property-change (point-at-eol) 'org-marker)
  7780. (move-end-of-line 1)
  7781. (goto-char (next-single-property-change (point) 'org-marker))))
  7782. (org-move-to-column col))
  7783. (org-agenda-do-context-action))
  7784. (defun org-agenda-previous-item (n)
  7785. "Move cursor to next agenda item."
  7786. (interactive "p")
  7787. (dotimes (c n)
  7788. (let ((col (current-column))
  7789. (goto (save-excursion
  7790. (move-end-of-line 0)
  7791. (previous-single-property-change (point) 'org-marker))))
  7792. (if goto (goto-char goto))
  7793. (org-move-to-column col)))
  7794. (org-agenda-do-context-action))
  7795. (defun org-agenda-do-context-action ()
  7796. "Show outline path and, maybe, follow mode window."
  7797. (let ((m (org-get-at-bol 'org-marker)))
  7798. (when (and (markerp m) (marker-buffer m))
  7799. (and org-agenda-follow-mode
  7800. (if org-agenda-follow-indirect
  7801. (org-agenda-tree-to-indirect-buffer nil)
  7802. (org-agenda-show)))
  7803. (and org-agenda-show-outline-path
  7804. (org-with-point-at m (org-display-outline-path t))))))
  7805. (defun org-agenda-show-tags ()
  7806. "Show the tags applicable to the current item."
  7807. (interactive)
  7808. (let* ((tags (org-get-at-bol 'tags)))
  7809. (if tags
  7810. (message "Tags are :%s:"
  7811. (org-no-properties (mapconcat 'identity tags ":")))
  7812. (message "No tags associated with this line"))))
  7813. (defun org-agenda-goto (&optional highlight)
  7814. "Go to the entry at point in the corresponding Org-mode file."
  7815. (interactive)
  7816. (let* ((marker (or (org-get-at-bol 'org-marker)
  7817. (org-agenda-error)))
  7818. (buffer (marker-buffer marker))
  7819. (pos (marker-position marker)))
  7820. (switch-to-buffer-other-window buffer)
  7821. (widen)
  7822. (push-mark)
  7823. (goto-char pos)
  7824. (when (derived-mode-p 'org-mode)
  7825. (org-show-context 'agenda)
  7826. (recenter (/ (window-height) 2))
  7827. (org-back-to-heading t)
  7828. (if (re-search-forward org-complex-heading-regexp nil t)
  7829. (goto-char (match-beginning 4))))
  7830. (run-hooks 'org-agenda-after-show-hook)
  7831. (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
  7832. (defvar org-agenda-after-show-hook nil
  7833. "Normal hook run after an item has been shown from the agenda.
  7834. Point is in the buffer where the item originated.")
  7835. (defun org-agenda-kill ()
  7836. "Kill the entry or subtree belonging to the current agenda entry."
  7837. (interactive)
  7838. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  7839. (let* ((bufname-orig (buffer-name))
  7840. (marker (or (org-get-at-bol 'org-marker)
  7841. (org-agenda-error)))
  7842. (buffer (marker-buffer marker))
  7843. (pos (marker-position marker))
  7844. (type (org-get-at-bol 'type))
  7845. dbeg dend (n 0) conf)
  7846. (org-with-remote-undo buffer
  7847. (with-current-buffer buffer
  7848. (save-excursion
  7849. (goto-char pos)
  7850. (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
  7851. (setq dbeg (progn (org-back-to-heading t) (point))
  7852. dend (org-end-of-subtree t t))
  7853. (setq dbeg (point-at-bol)
  7854. dend (min (point-max) (1+ (point-at-eol)))))
  7855. (goto-char dbeg)
  7856. (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
  7857. (setq conf (or (eq t org-agenda-confirm-kill)
  7858. (and (numberp org-agenda-confirm-kill)
  7859. (> n org-agenda-confirm-kill))))
  7860. (and conf
  7861. (not (y-or-n-p
  7862. (format "Delete entry with %d lines in buffer \"%s\"? "
  7863. n (buffer-name buffer))))
  7864. (error "Abort"))
  7865. (let ((org-agenda-buffer-name bufname-orig))
  7866. (org-remove-subtree-entries-from-agenda buffer dbeg dend))
  7867. (with-current-buffer buffer (delete-region dbeg dend))
  7868. (message "Agenda item and source killed"))))
  7869. (defvar org-archive-default-command) ; defined in org-archive.el
  7870. (defun org-agenda-archive-default ()
  7871. "Archive the entry or subtree belonging to the current agenda entry."
  7872. (interactive)
  7873. (require 'org-archive)
  7874. (org-agenda-archive-with org-archive-default-command))
  7875. (defun org-agenda-archive-default-with-confirmation ()
  7876. "Archive the entry or subtree belonging to the current agenda entry."
  7877. (interactive)
  7878. (require 'org-archive)
  7879. (org-agenda-archive-with org-archive-default-command 'confirm))
  7880. (defun org-agenda-archive ()
  7881. "Archive the entry or subtree belonging to the current agenda entry."
  7882. (interactive)
  7883. (org-agenda-archive-with 'org-archive-subtree))
  7884. (defun org-agenda-archive-to-archive-sibling ()
  7885. "Move the entry to the archive sibling."
  7886. (interactive)
  7887. (org-agenda-archive-with 'org-archive-to-archive-sibling))
  7888. (defun org-agenda-archive-with (cmd &optional confirm)
  7889. "Move the entry to the archive sibling."
  7890. (interactive)
  7891. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  7892. (let* ((bufname-orig (buffer-name))
  7893. (marker (or (org-get-at-bol 'org-marker)
  7894. (org-agenda-error)))
  7895. (buffer (marker-buffer marker))
  7896. (pos (marker-position marker)))
  7897. (org-with-remote-undo buffer
  7898. (with-current-buffer buffer
  7899. (if (derived-mode-p 'org-mode)
  7900. (if (and confirm
  7901. (not (y-or-n-p "Archive this subtree or entry? ")))
  7902. (error "Abort")
  7903. (save-window-excursion
  7904. (goto-char pos)
  7905. (let ((org-agenda-buffer-name bufname-orig))
  7906. (org-remove-subtree-entries-from-agenda))
  7907. (org-back-to-heading t)
  7908. (funcall cmd)))
  7909. (error "Archiving works only in Org-mode files"))))))
  7910. (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
  7911. "Remove all lines in the agenda that correspond to a given subtree.
  7912. The subtree is the one in buffer BUF, starting at BEG and ending at END.
  7913. If this information is not given, the function uses the tree at point."
  7914. (let ((buf (or buf (current-buffer))) m p)
  7915. (save-excursion
  7916. (unless (and beg end)
  7917. (org-back-to-heading t)
  7918. (setq beg (point))
  7919. (org-end-of-subtree t)
  7920. (setq end (point)))
  7921. (set-buffer (get-buffer org-agenda-buffer-name))
  7922. (save-excursion
  7923. (goto-char (point-max))
  7924. (beginning-of-line 1)
  7925. (while (not (bobp))
  7926. (when (and (setq m (org-get-at-bol 'org-marker))
  7927. (equal buf (marker-buffer m))
  7928. (setq p (marker-position m))
  7929. (>= p beg)
  7930. (< p end))
  7931. (let ((inhibit-read-only t))
  7932. (delete-region (point-at-bol) (1+ (point-at-eol)))))
  7933. (beginning-of-line 0))))))
  7934. (defun org-agenda-refile (&optional goto rfloc no-update)
  7935. "Refile the item at point.
  7936. When GOTO is 0 or \\='(64) or a triple \\[universal-argument] prefix argument,
  7937. clear the refile cache.
  7938. When GOTO is \\='(16) or a double \\[universal-argument] prefix argument,
  7939. go to the location of the last refiled item.
  7940. RFLOC can be a refile location obtained in a different way.
  7941. When NO-UPDATE is non-nil, don't redo the agenda buffer."
  7942. (interactive "P")
  7943. (cond
  7944. ((member goto '(0 (64)))
  7945. (org-refile-cache-clear))
  7946. ((equal goto '(16))
  7947. (org-refile-goto-last-stored))
  7948. (t
  7949. (let* ((buffer-orig (buffer-name))
  7950. (marker (or (org-get-at-bol 'org-hd-marker)
  7951. (org-agenda-error)))
  7952. (buffer (marker-buffer marker))
  7953. (pos (marker-position marker))
  7954. (rfloc (or rfloc
  7955. (org-refile-get-location
  7956. (if goto "Goto" "Refile to") buffer
  7957. org-refile-allow-creating-parent-nodes))))
  7958. (with-current-buffer buffer
  7959. (save-excursion
  7960. (save-restriction
  7961. (widen)
  7962. (goto-char marker)
  7963. (let ((org-agenda-buffer-name buffer-orig))
  7964. (org-remove-subtree-entries-from-agenda))
  7965. (org-refile goto buffer rfloc)))))
  7966. (unless no-update (org-agenda-redo)))))
  7967. (defun org-agenda-open-link (&optional arg)
  7968. "Open the link(s) in the current entry, if any.
  7969. This looks for a link in the displayed line in the agenda.
  7970. It also looks at the text of the entry itself."
  7971. (interactive "P")
  7972. (let* ((marker (or (org-get-at-bol 'org-hd-marker)
  7973. (org-get-at-bol 'org-marker)))
  7974. (buffer (and marker (marker-buffer marker)))
  7975. (prefix (buffer-substring (point-at-bol) (point-at-eol)))
  7976. (lkall (and buffer (org-offer-links-in-entry
  7977. buffer marker arg prefix)))
  7978. (lk0 (car lkall))
  7979. (lk (if (stringp lk0) (list lk0) lk0))
  7980. (lkend (cdr lkall))
  7981. trg)
  7982. (cond
  7983. ((and buffer lk)
  7984. (mapcar (lambda(l)
  7985. (with-current-buffer buffer
  7986. (setq trg (and (string-match org-bracket-link-regexp l)
  7987. (match-string 1 l)))
  7988. (if (or (not trg) (string-match org-any-link-re trg))
  7989. (save-excursion
  7990. (save-restriction
  7991. (widen)
  7992. (goto-char marker)
  7993. (when (search-forward l nil lkend)
  7994. (goto-char (match-beginning 0))
  7995. (org-open-at-point))))
  7996. ;; This is an internal link, widen the buffer
  7997. (switch-to-buffer-other-window buffer)
  7998. (widen)
  7999. (goto-char marker)
  8000. (when (search-forward l nil lkend)
  8001. (goto-char (match-beginning 0))
  8002. (org-open-at-point)))))
  8003. lk))
  8004. ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
  8005. (save-excursion
  8006. (beginning-of-line 1)
  8007. (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
  8008. (org-open-link-from-string (match-string 1)))
  8009. (t (message "No link to open here")))))
  8010. (defun org-agenda-copy-local-variable (var)
  8011. "Get a variable from a referenced buffer and install it here."
  8012. (let ((m (org-get-at-bol 'org-marker)))
  8013. (when (and m (buffer-live-p (marker-buffer m)))
  8014. (set (make-local-variable var)
  8015. (with-current-buffer (marker-buffer m)
  8016. (symbol-value var))))))
  8017. (defun org-agenda-switch-to (&optional delete-other-windows)
  8018. "Go to the Org mode file which contains the item at point.
  8019. When optional argument DELETE-OTHER-WINDOWS is non-nil, the
  8020. displayed Org file fills the frame."
  8021. (interactive)
  8022. (if (and org-return-follows-link
  8023. (not (org-get-at-bol 'org-marker))
  8024. (org-in-regexp org-bracket-link-regexp))
  8025. (org-open-link-from-string (match-string 0))
  8026. (let* ((marker (or (org-get-at-bol 'org-marker)
  8027. (org-agenda-error)))
  8028. (buffer (marker-buffer marker))
  8029. (pos (marker-position marker)))
  8030. (unless buffer (user-error "Trying to switch to non-existent buffer"))
  8031. (pop-to-buffer-same-window buffer)
  8032. (when delete-other-windows (delete-other-windows))
  8033. (widen)
  8034. (goto-char pos)
  8035. (when (derived-mode-p 'org-mode)
  8036. (org-show-context 'agenda)
  8037. (run-hooks 'org-agenda-after-show-hook)))))
  8038. (defun org-agenda-goto-mouse (ev)
  8039. "Go to the Org-mode file which contains the item at the mouse click."
  8040. (interactive "e")
  8041. (mouse-set-point ev)
  8042. (org-agenda-goto))
  8043. (defun org-agenda-show (&optional full-entry)
  8044. "Display the Org-mode file which contains the item at point.
  8045. With prefix argument FULL-ENTRY, make the entire entry visible
  8046. if it was hidden in the outline."
  8047. (interactive "P")
  8048. (let ((win (selected-window)))
  8049. (org-agenda-goto t)
  8050. (when full-entry (org-show-entry))
  8051. (select-window win)))
  8052. (defvar org-agenda-show-window nil)
  8053. (defun org-agenda-show-and-scroll-up (&optional arg)
  8054. "Display the Org-mode file which contains the item at point.
  8055. When called repeatedly, scroll the window that is displaying the buffer.
  8056. With a \\[universal-argument] prefix, use `org-show-entry' instead of
  8057. `show-subtree' to display the item, so that drawers and logbooks stay
  8058. folded."
  8059. (interactive "P")
  8060. (let ((win (selected-window)))
  8061. (if (and (window-live-p org-agenda-show-window)
  8062. (eq this-command last-command))
  8063. (progn
  8064. (select-window org-agenda-show-window)
  8065. (ignore-errors (scroll-up)))
  8066. (org-agenda-goto t)
  8067. (if arg (org-show-entry) (outline-show-subtree))
  8068. (setq org-agenda-show-window (selected-window)))
  8069. (select-window win)))
  8070. (defun org-agenda-show-scroll-down ()
  8071. "Scroll down the window showing the agenda."
  8072. (interactive)
  8073. (let ((win (selected-window)))
  8074. (when (window-live-p org-agenda-show-window)
  8075. (select-window org-agenda-show-window)
  8076. (ignore-errors (scroll-down))
  8077. (select-window win))))
  8078. (defun org-agenda-show-1 (&optional more)
  8079. "Display the Org-mode file which contains the item at point.
  8080. The prefix arg selects the amount of information to display:
  8081. 0 hide the subtree
  8082. 1 just show the entry according to defaults.
  8083. 2 show the children view
  8084. 3 show the subtree view
  8085. 4 show the entire subtree and any LOGBOOK drawers
  8086. 5 show the entire subtree and any drawers
  8087. With prefix argument FULL-ENTRY, make the entire entry visible
  8088. if it was hidden in the outline."
  8089. (interactive "p")
  8090. (let ((win (selected-window)))
  8091. (org-agenda-goto t)
  8092. (org-back-to-heading)
  8093. (set-window-start (selected-window) (point-at-bol))
  8094. (cond
  8095. ((= more 0)
  8096. (outline-hide-subtree)
  8097. (save-excursion
  8098. (org-back-to-heading)
  8099. (run-hook-with-args 'org-cycle-hook 'folded))
  8100. (message "Remote: FOLDED"))
  8101. ((and (called-interactively-p 'any) (= more 1))
  8102. (message "Remote: show with default settings"))
  8103. ((= more 2)
  8104. (outline-show-entry)
  8105. (org-show-children)
  8106. (save-excursion
  8107. (org-back-to-heading)
  8108. (run-hook-with-args 'org-cycle-hook 'children))
  8109. (message "Remote: CHILDREN"))
  8110. ((= more 3)
  8111. (outline-show-subtree)
  8112. (save-excursion
  8113. (org-back-to-heading)
  8114. (run-hook-with-args 'org-cycle-hook 'subtree))
  8115. (message "Remote: SUBTREE"))
  8116. ((= more 4)
  8117. (outline-show-subtree)
  8118. (save-excursion
  8119. (org-back-to-heading)
  8120. (org-cycle-hide-drawers 'subtree '("LOGBOOK")))
  8121. (message "Remote: SUBTREE AND LOGBOOK"))
  8122. ((> more 4)
  8123. (outline-show-subtree)
  8124. (message "Remote: SUBTREE AND ALL DRAWERS")))
  8125. (select-window win)))
  8126. (defvar org-agenda-cycle-counter nil)
  8127. (defun org-agenda-cycle-show (&optional n)
  8128. "Show the current entry in another window, with default settings.
  8129. Default settings are taken from `org-show-context-detail'. When
  8130. use repeatedly in immediate succession, the remote entry will
  8131. cycle through visibility
  8132. children -> subtree -> folded
  8133. When called with a numeric prefix arg, that arg will be passed through to
  8134. `org-agenda-show-1'. For the interpretation of that argument, see the
  8135. docstring of `org-agenda-show-1'."
  8136. (interactive "P")
  8137. (if (integerp n)
  8138. (setq org-agenda-cycle-counter n)
  8139. (if (not (eq last-command this-command))
  8140. (setq org-agenda-cycle-counter 1)
  8141. (if (equal org-agenda-cycle-counter 0)
  8142. (setq org-agenda-cycle-counter 2)
  8143. (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
  8144. (if (> org-agenda-cycle-counter 3)
  8145. (setq org-agenda-cycle-counter 0)))))
  8146. (org-agenda-show-1 org-agenda-cycle-counter))
  8147. (defun org-agenda-recenter (arg)
  8148. "Display the Org-mode file which contains the item at point and recenter."
  8149. (interactive "P")
  8150. (let ((win (selected-window)))
  8151. (org-agenda-goto t)
  8152. (recenter arg)
  8153. (select-window win)))
  8154. (defun org-agenda-show-mouse (ev)
  8155. "Display the Org-mode file which contains the item at the mouse click."
  8156. (interactive "e")
  8157. (mouse-set-point ev)
  8158. (org-agenda-show))
  8159. (defun org-agenda-check-no-diary ()
  8160. "Check if the entry is a diary link and abort if yes."
  8161. (if (org-get-at-bol 'org-agenda-diary-link)
  8162. (org-agenda-error)))
  8163. (defun org-agenda-error ()
  8164. "Throw an error when a command is not allowed in the agenda."
  8165. (user-error "Command not allowed in this line"))
  8166. (defun org-agenda-tree-to-indirect-buffer (arg)
  8167. "Show the subtree corresponding to the current entry in an indirect buffer.
  8168. This calls the command `org-tree-to-indirect-buffer' from the original buffer.
  8169. With a numerical prefix ARG, go up to this level and then take that tree.
  8170. With a negative numeric ARG, go up by this number of levels.
  8171. With a \\[universal-argument] prefix, make a separate frame for this tree (i.e. don't
  8172. use the dedicated frame)."
  8173. (interactive "P")
  8174. (if current-prefix-arg
  8175. (org-agenda-do-tree-to-indirect-buffer arg)
  8176. (let ((agenda-buffer (buffer-name))
  8177. (agenda-window (selected-window))
  8178. (indirect-window
  8179. (and org-last-indirect-buffer
  8180. (get-buffer-window org-last-indirect-buffer))))
  8181. (save-window-excursion (org-agenda-do-tree-to-indirect-buffer arg))
  8182. (unless (or (eq org-indirect-buffer-display 'new-frame)
  8183. (eq org-indirect-buffer-display 'dedicated-frame))
  8184. (unwind-protect
  8185. (unless (and indirect-window (window-live-p indirect-window))
  8186. (setq indirect-window (split-window agenda-window)))
  8187. (and indirect-window (select-window indirect-window))
  8188. (switch-to-buffer org-last-indirect-buffer :norecord)
  8189. (fit-window-to-buffer indirect-window)))
  8190. (select-window (get-buffer-window agenda-buffer))
  8191. (setq org-agenda-last-indirect-buffer org-last-indirect-buffer))))
  8192. (defun org-agenda-do-tree-to-indirect-buffer (arg)
  8193. "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
  8194. (org-agenda-check-no-diary)
  8195. (let* ((marker (or (org-get-at-bol 'org-marker)
  8196. (org-agenda-error)))
  8197. (buffer (marker-buffer marker))
  8198. (pos (marker-position marker)))
  8199. (with-current-buffer buffer
  8200. (save-excursion
  8201. (goto-char pos)
  8202. (funcall 'org-tree-to-indirect-buffer arg)))))
  8203. (defvar org-last-heading-marker (make-marker)
  8204. "Marker pointing to the headline that last changed its TODO state
  8205. by a remote command from the agenda.")
  8206. (defun org-agenda-todo-nextset ()
  8207. "Switch TODO entry to next sequence."
  8208. (interactive)
  8209. (org-agenda-todo 'nextset))
  8210. (defun org-agenda-todo-previousset ()
  8211. "Switch TODO entry to previous sequence."
  8212. (interactive)
  8213. (org-agenda-todo 'previousset))
  8214. (defun org-agenda-todo (&optional arg)
  8215. "Cycle TODO state of line at point, also in Org-mode file.
  8216. This changes the line at point, all other lines in the agenda referring to
  8217. the same tree node, and the headline of the tree node in the Org-mode file."
  8218. (interactive "P")
  8219. (org-agenda-check-no-diary)
  8220. (let* ((col (current-column))
  8221. (marker (or (org-get-at-bol 'org-marker)
  8222. (org-agenda-error)))
  8223. (buffer (marker-buffer marker))
  8224. (pos (marker-position marker))
  8225. (hdmarker (org-get-at-bol 'org-hd-marker))
  8226. (todayp (org-agenda-today-p (org-get-at-bol 'day)))
  8227. (inhibit-read-only t)
  8228. org-agenda-headline-snapshot-before-repeat newhead just-one)
  8229. (org-with-remote-undo buffer
  8230. (with-current-buffer buffer
  8231. (widen)
  8232. (goto-char pos)
  8233. (org-show-context 'agenda)
  8234. (let ((current-prefix-arg arg))
  8235. (call-interactively 'org-todo))
  8236. (and (bolp) (forward-char 1))
  8237. (setq newhead (org-get-heading))
  8238. (when (and (bound-and-true-p
  8239. org-agenda-headline-snapshot-before-repeat)
  8240. (not (equal org-agenda-headline-snapshot-before-repeat
  8241. newhead))
  8242. todayp)
  8243. (setq newhead org-agenda-headline-snapshot-before-repeat
  8244. just-one t))
  8245. (save-excursion
  8246. (org-back-to-heading)
  8247. (move-marker org-last-heading-marker (point))))
  8248. (beginning-of-line 1)
  8249. (save-window-excursion
  8250. (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
  8251. (when (bound-and-true-p org-clock-out-when-done)
  8252. (string-match (concat "^" (regexp-opt org-done-keywords-for-agenda))
  8253. newhead)
  8254. (org-agenda-unmark-clocking-task))
  8255. (org-move-to-column col)
  8256. (org-agenda-mark-clocking-task))))
  8257. (defun org-agenda-add-note (&optional arg)
  8258. "Add a time-stamped note to the entry at point."
  8259. (interactive "P")
  8260. (org-agenda-check-no-diary)
  8261. (let* ((marker (or (org-get-at-bol 'org-marker)
  8262. (org-agenda-error)))
  8263. (buffer (marker-buffer marker))
  8264. (pos (marker-position marker))
  8265. (hdmarker (org-get-at-bol 'org-hd-marker))
  8266. (inhibit-read-only t))
  8267. (with-current-buffer buffer
  8268. (widen)
  8269. (goto-char pos)
  8270. (org-show-context 'agenda)
  8271. (org-add-note))))
  8272. (defun org-agenda-change-all-lines (newhead hdmarker
  8273. &optional fixface just-this)
  8274. "Change all lines in the agenda buffer which match HDMARKER.
  8275. The new content of the line will be NEWHEAD (as modified by
  8276. `org-agenda-format-item'). HDMARKER is checked with
  8277. `equal' against all `org-hd-marker' text properties in the file.
  8278. If FIXFACE is non-nil, the face of each item is modified according to
  8279. the new TODO state.
  8280. If JUST-THIS is non-nil, change just the current line, not all.
  8281. If FORCE-TAGS is non nil, the car of it returns the new tags."
  8282. (let* ((inhibit-read-only t)
  8283. (line (org-current-line))
  8284. (org-agenda-buffer (current-buffer))
  8285. (thetags (with-current-buffer (marker-buffer hdmarker)
  8286. (save-excursion (save-restriction (widen)
  8287. (goto-char hdmarker)
  8288. (org-get-tags-at)))))
  8289. props m pl undone-face done-face finish new dotime level cat tags)
  8290. (save-excursion
  8291. (goto-char (point-max))
  8292. (beginning-of-line 1)
  8293. (while (not finish)
  8294. (setq finish (bobp))
  8295. (when (and (setq m (org-get-at-bol 'org-hd-marker))
  8296. (or (not just-this) (= (org-current-line) line))
  8297. (equal m hdmarker))
  8298. (setq props (text-properties-at (point))
  8299. dotime (org-get-at-bol 'dotime)
  8300. cat (org-get-at-eol 'org-category 1)
  8301. level (org-get-at-bol 'level)
  8302. tags thetags
  8303. new
  8304. (let ((org-prefix-format-compiled
  8305. (or (get-text-property (min (1- (point-max)) (point)) 'format)
  8306. org-prefix-format-compiled))
  8307. (extra (org-get-at-bol 'extra)))
  8308. (with-current-buffer (marker-buffer hdmarker)
  8309. (save-excursion
  8310. (save-restriction
  8311. (widen)
  8312. (org-agenda-format-item extra newhead level cat tags dotime)))))
  8313. pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
  8314. undone-face (org-get-at-bol 'undone-face)
  8315. done-face (org-get-at-bol 'done-face))
  8316. (beginning-of-line 1)
  8317. (cond
  8318. ((equal new "") (delete-region (point) (line-beginning-position 2)))
  8319. ((looking-at ".*")
  8320. ;; When replacing the whole line, preserve bulk mark
  8321. ;; overlay, if any.
  8322. (let ((mark (catch :overlay
  8323. (dolist (o (overlays-in (point) (+ 2 (point))))
  8324. (when (eq (overlay-get o 'type)
  8325. 'org-marked-entry-overlay)
  8326. (throw :overlay o))))))
  8327. (replace-match new t t)
  8328. (beginning-of-line)
  8329. (when mark (move-overlay mark (point) (+ 2 (point)))))
  8330. (add-text-properties (point-at-bol) (point-at-eol) props)
  8331. (when fixface
  8332. (add-text-properties
  8333. (point-at-bol) (point-at-eol)
  8334. (list 'face
  8335. (if org-last-todo-state-is-todo
  8336. undone-face done-face))))
  8337. (org-agenda-highlight-todo 'line)
  8338. (beginning-of-line 1))
  8339. (t (error "Line update did not work")))
  8340. (save-restriction
  8341. (narrow-to-region (point-at-bol) (point-at-eol))
  8342. (org-agenda-finalize)))
  8343. (beginning-of-line 0)))))
  8344. (defun org-agenda-align-tags (&optional line)
  8345. "Align all tags in agenda items to `org-agenda-tags-column'."
  8346. (let ((inhibit-read-only t) l c)
  8347. (save-excursion
  8348. (goto-char (if line (point-at-bol) (point-min)))
  8349. (while (re-search-forward "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"
  8350. (if line (point-at-eol) nil) t)
  8351. (add-text-properties
  8352. (match-beginning 2) (match-end 2)
  8353. (list 'face (delq nil (let ((prop (get-text-property
  8354. (match-beginning 2) 'face)))
  8355. (or (listp prop) (setq prop (list prop)))
  8356. (if (memq 'org-tag prop)
  8357. prop
  8358. (cons 'org-tag prop))))))
  8359. (setq l (- (match-end 2) (match-beginning 2))
  8360. c (if (< org-agenda-tags-column 0)
  8361. (- (abs org-agenda-tags-column) l)
  8362. org-agenda-tags-column))
  8363. (delete-region (match-beginning 1) (match-end 1))
  8364. (goto-char (match-beginning 1))
  8365. (insert (org-add-props
  8366. (make-string (max 1 (- c (current-column))) ?\ )
  8367. (plist-put (copy-sequence (text-properties-at (point)))
  8368. 'face nil))))
  8369. (goto-char (point-min))
  8370. (org-font-lock-add-tag-faces (point-max)))))
  8371. (defun org-agenda-priority-up ()
  8372. "Increase the priority of line at point, also in Org-mode file."
  8373. (interactive)
  8374. (org-agenda-priority 'up))
  8375. (defun org-agenda-priority-down ()
  8376. "Decrease the priority of line at point, also in Org-mode file."
  8377. (interactive)
  8378. (org-agenda-priority 'down))
  8379. (defun org-agenda-priority (&optional force-direction)
  8380. "Set the priority of line at point, also in Org-mode file.
  8381. This changes the line at point, all other lines in the agenda referring to
  8382. the same tree node, and the headline of the tree node in the Org-mode file.
  8383. Called with a universal prefix arg, show the priority instead of setting it."
  8384. (interactive "P")
  8385. (if (equal force-direction '(4))
  8386. (org-show-priority)
  8387. (unless org-enable-priority-commands
  8388. (error "Priority commands are disabled"))
  8389. (org-agenda-check-no-diary)
  8390. (let* ((col (current-column))
  8391. (marker (or (org-get-at-bol 'org-marker)
  8392. (org-agenda-error)))
  8393. (hdmarker (org-get-at-bol 'org-hd-marker))
  8394. (buffer (marker-buffer hdmarker))
  8395. (pos (marker-position hdmarker))
  8396. (inhibit-read-only t)
  8397. newhead)
  8398. (org-with-remote-undo buffer
  8399. (with-current-buffer buffer
  8400. (widen)
  8401. (goto-char pos)
  8402. (org-show-context 'agenda)
  8403. (funcall 'org-priority force-direction)
  8404. (end-of-line 1)
  8405. (setq newhead (org-get-heading)))
  8406. (org-agenda-change-all-lines newhead hdmarker)
  8407. (org-move-to-column col)))))
  8408. ;; FIXME: should fix the tags property of the agenda line.
  8409. (defun org-agenda-set-tags (&optional tag onoff)
  8410. "Set tags for the current headline."
  8411. (interactive)
  8412. (org-agenda-check-no-diary)
  8413. (if (and (org-region-active-p) (called-interactively-p 'any))
  8414. (call-interactively 'org-change-tag-in-region)
  8415. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8416. (org-agenda-error)))
  8417. (buffer (marker-buffer hdmarker))
  8418. (pos (marker-position hdmarker))
  8419. (inhibit-read-only t)
  8420. newhead)
  8421. (org-with-remote-undo buffer
  8422. (with-current-buffer buffer
  8423. (widen)
  8424. (goto-char pos)
  8425. (org-show-context 'agenda)
  8426. (if tag
  8427. (org-toggle-tag tag onoff)
  8428. (call-interactively 'org-set-tags))
  8429. (end-of-line 1)
  8430. (setq newhead (org-get-heading)))
  8431. (org-agenda-change-all-lines newhead hdmarker)
  8432. (beginning-of-line 1)))))
  8433. (defun org-agenda-set-property ()
  8434. "Set a property for the current headline."
  8435. (interactive)
  8436. (org-agenda-check-no-diary)
  8437. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8438. (org-agenda-error)))
  8439. (buffer (marker-buffer hdmarker))
  8440. (pos (marker-position hdmarker))
  8441. (inhibit-read-only t)
  8442. newhead)
  8443. (org-with-remote-undo buffer
  8444. (with-current-buffer buffer
  8445. (widen)
  8446. (goto-char pos)
  8447. (org-show-context 'agenda)
  8448. (call-interactively 'org-set-property)))))
  8449. (defun org-agenda-set-effort ()
  8450. "Set the effort property for the current headline."
  8451. (interactive)
  8452. (org-agenda-check-no-diary)
  8453. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8454. (org-agenda-error)))
  8455. (buffer (marker-buffer hdmarker))
  8456. (pos (marker-position hdmarker))
  8457. (inhibit-read-only t)
  8458. newhead)
  8459. (org-with-remote-undo buffer
  8460. (with-current-buffer buffer
  8461. (widen)
  8462. (goto-char pos)
  8463. (org-show-context 'agenda)
  8464. (call-interactively 'org-set-effort)
  8465. (end-of-line 1)
  8466. (setq newhead (org-get-heading)))
  8467. (org-agenda-change-all-lines newhead hdmarker))))
  8468. (defun org-agenda-toggle-archive-tag ()
  8469. "Toggle the archive tag for the current entry."
  8470. (interactive)
  8471. (org-agenda-check-no-diary)
  8472. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8473. (org-agenda-error)))
  8474. (buffer (marker-buffer hdmarker))
  8475. (pos (marker-position hdmarker))
  8476. (inhibit-read-only t)
  8477. newhead)
  8478. (org-with-remote-undo buffer
  8479. (with-current-buffer buffer
  8480. (widen)
  8481. (goto-char pos)
  8482. (org-show-context 'agenda)
  8483. (call-interactively 'org-toggle-archive-tag)
  8484. (end-of-line 1)
  8485. (setq newhead (org-get-heading)))
  8486. (org-agenda-change-all-lines newhead hdmarker)
  8487. (beginning-of-line 1))))
  8488. (defun org-agenda-do-date-later (arg)
  8489. (interactive "P")
  8490. (cond
  8491. ((or (equal arg '(16))
  8492. (memq last-command
  8493. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  8494. (setq this-command 'org-agenda-date-later-minutes)
  8495. (org-agenda-date-later-minutes 1))
  8496. ((or (equal arg '(4))
  8497. (memq last-command
  8498. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  8499. (setq this-command 'org-agenda-date-later-hours)
  8500. (org-agenda-date-later-hours 1))
  8501. (t
  8502. (org-agenda-date-later (prefix-numeric-value arg)))))
  8503. (defun org-agenda-do-date-earlier (arg)
  8504. (interactive "P")
  8505. (cond
  8506. ((or (equal arg '(16))
  8507. (memq last-command
  8508. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  8509. (setq this-command 'org-agenda-date-earlier-minutes)
  8510. (org-agenda-date-earlier-minutes 1))
  8511. ((or (equal arg '(4))
  8512. (memq last-command
  8513. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  8514. (setq this-command 'org-agenda-date-earlier-hours)
  8515. (org-agenda-date-earlier-hours 1))
  8516. (t
  8517. (org-agenda-date-earlier (prefix-numeric-value arg)))))
  8518. (defun org-agenda-date-later (arg &optional what)
  8519. "Change the date of this item to ARG day(s) later."
  8520. (interactive "p")
  8521. (org-agenda-check-type t 'agenda 'timeline)
  8522. (org-agenda-check-no-diary)
  8523. (let* ((marker (or (org-get-at-bol 'org-marker)
  8524. (org-agenda-error)))
  8525. (buffer (marker-buffer marker))
  8526. (pos (marker-position marker))
  8527. cdate today)
  8528. (org-with-remote-undo buffer
  8529. (with-current-buffer buffer
  8530. (widen)
  8531. (goto-char pos)
  8532. (if (not (org-at-timestamp-p))
  8533. (error "Cannot find time stamp"))
  8534. (when (and org-agenda-move-date-from-past-immediately-to-today
  8535. (equal arg 1)
  8536. (or (not what) (eq what 'day))
  8537. (not (save-match-data (org-at-date-range-p))))
  8538. (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
  8539. cdate (calendar-absolute-from-gregorian
  8540. (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
  8541. today (org-today))
  8542. (if (> today cdate)
  8543. ;; immediately shift to today
  8544. (setq arg (- today cdate))))
  8545. (org-timestamp-change arg (or what 'day))
  8546. (when (and (org-at-date-range-p)
  8547. (re-search-backward org-tr-regexp-both (point-at-bol)))
  8548. (let ((end org-last-changed-timestamp))
  8549. (org-timestamp-change arg (or what 'day))
  8550. (setq org-last-changed-timestamp
  8551. (concat org-last-changed-timestamp "--" end)))))
  8552. (org-agenda-show-new-time marker org-last-changed-timestamp))
  8553. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  8554. (defun org-agenda-date-earlier (arg &optional what)
  8555. "Change the date of this item to ARG day(s) earlier."
  8556. (interactive "p")
  8557. (org-agenda-date-later (- arg) what))
  8558. (defun org-agenda-date-later-minutes (arg)
  8559. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  8560. (interactive "p")
  8561. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  8562. (org-agenda-date-later arg 'minute))
  8563. (defun org-agenda-date-earlier-minutes (arg)
  8564. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  8565. (interactive "p")
  8566. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  8567. (org-agenda-date-earlier arg 'minute))
  8568. (defun org-agenda-date-later-hours (arg)
  8569. "Change the time of this item, in hour steps."
  8570. (interactive "p")
  8571. (org-agenda-date-later arg 'hour))
  8572. (defun org-agenda-date-earlier-hours (arg)
  8573. "Change the time of this item, in hour steps."
  8574. (interactive "p")
  8575. (org-agenda-date-earlier arg 'hour))
  8576. (defun org-agenda-show-new-time (marker stamp &optional prefix)
  8577. "Show new date stamp via text properties."
  8578. ;; We use text properties to make this undoable
  8579. (let ((inhibit-read-only t))
  8580. (setq stamp (concat prefix " => " stamp " "))
  8581. (save-excursion
  8582. (goto-char (point-max))
  8583. (while (not (bobp))
  8584. (when (equal marker (org-get-at-bol 'org-marker))
  8585. (remove-text-properties (point-at-bol) (point-at-eol) '(display))
  8586. (org-move-to-column (- (window-width) (length stamp)) t)
  8587. (add-text-properties
  8588. (1- (point)) (point-at-eol)
  8589. (list 'display (org-add-props stamp nil
  8590. 'face '(secondary-selection default))))
  8591. (beginning-of-line 1))
  8592. (beginning-of-line 0)))))
  8593. (defun org-agenda-date-prompt (arg)
  8594. "Change the date of this item. Date is prompted for, with default today.
  8595. The prefix ARG is passed to the `org-time-stamp' command and can therefore
  8596. be used to request time specification in the time stamp."
  8597. (interactive "P")
  8598. (org-agenda-check-type t 'agenda 'timeline)
  8599. (org-agenda-check-no-diary)
  8600. (let* ((marker (or (org-get-at-bol 'org-marker)
  8601. (org-agenda-error)))
  8602. (buffer (marker-buffer marker))
  8603. (pos (marker-position marker)))
  8604. (org-with-remote-undo buffer
  8605. (with-current-buffer buffer
  8606. (widen)
  8607. (goto-char pos)
  8608. (if (not (org-at-timestamp-p t))
  8609. (error "Cannot find time stamp"))
  8610. (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
  8611. (org-agenda-show-new-time marker org-last-changed-timestamp))
  8612. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  8613. (defun org-agenda-schedule (arg &optional time)
  8614. "Schedule the item at point.
  8615. ARG is passed through to `org-schedule'."
  8616. (interactive "P")
  8617. (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
  8618. (org-agenda-check-no-diary)
  8619. (let* ((marker (or (org-get-at-bol 'org-marker)
  8620. (org-agenda-error)))
  8621. (type (marker-insertion-type marker))
  8622. (buffer (marker-buffer marker))
  8623. (pos (marker-position marker))