org-agenda.el 396 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234
  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-pop-to-buffer-same-window "org-compat"
  75. (&optional buffer-or-name norecord label))
  76. (declare-function org-agenda-columns "org-colview" ())
  77. (declare-function org-add-archive-files "org-archive" (files))
  78. (declare-function org-capture "org-capture" (&optional goto keys))
  79. (defvar calendar-mode-map) ; defined in calendar.el
  80. (defvar org-clock-current-task nil) ; defined in org-clock.el
  81. (defvar org-mobile-force-id-on-agenda-items) ; defined in org-mobile.el
  82. (defvar org-habit-show-habits) ; defined in org-habit.el
  83. (defvar org-habit-show-habits-only-for-today)
  84. (defvar org-habit-show-all-today)
  85. ;; Defined somewhere in this file, but used before definition.
  86. (defvar org-agenda-buffer-name "*Org Agenda*")
  87. (defvar org-agenda-overriding-header nil)
  88. (defvar org-agenda-title-append nil)
  89. (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  90. (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  91. (defvar original-date) ; dynamically scoped, calendar.el does scope this
  92. (defvar org-agenda-undo-list nil
  93. "List of undoable operations in the agenda since last refresh.")
  94. (defvar org-agenda-pending-undo-list nil
  95. "In a series of undo commands, this is the list of remaining undo items.")
  96. (defcustom org-agenda-confirm-kill 1
  97. "When set, remote killing from the agenda buffer needs confirmation.
  98. When t, a confirmation is always needed. When a number N, confirmation is
  99. only needed when the text to be killed contains more than N non-white lines."
  100. :group 'org-agenda
  101. :type '(choice
  102. (const :tag "Never" nil)
  103. (const :tag "Always" t)
  104. (integer :tag "When more than N lines")))
  105. (defcustom org-agenda-compact-blocks nil
  106. "Non-nil means make the block agenda more compact.
  107. This is done globally by leaving out lines like the agenda span
  108. name and week number or the separator lines."
  109. :group 'org-agenda
  110. :type 'boolean)
  111. (defcustom org-agenda-block-separator ?=
  112. "The separator between blocks in the agenda.
  113. If this is a string, it will be used as the separator, with a newline added.
  114. If it is a character, it will be repeated to fill the window width.
  115. If nil the separator is disabled. In `org-agenda-custom-commands' this
  116. addresses the separator between the current and the previous block."
  117. :group 'org-agenda
  118. :type '(choice
  119. (const :tag "Disabled" nil)
  120. (character)
  121. (string)))
  122. (defgroup org-agenda-export nil
  123. "Options concerning exporting agenda views in Org-mode."
  124. :tag "Org Agenda Export"
  125. :group 'org-agenda)
  126. (defcustom org-agenda-with-colors t
  127. "Non-nil means use colors in agenda views."
  128. :group 'org-agenda-export
  129. :type 'boolean)
  130. (defcustom org-agenda-exporter-settings nil
  131. "Alist of variable/value pairs that should be active during agenda export.
  132. This is a good place to set options for ps-print and for htmlize.
  133. Note that the way this is implemented, the values will be evaluated
  134. before assigned to the variables. So make sure to quote values you do
  135. *not* want evaluated, for example
  136. (setq org-agenda-exporter-settings
  137. \\='((ps-print-color-p \\='black-white)))"
  138. :group 'org-agenda-export
  139. :type '(repeat
  140. (list
  141. (variable)
  142. (sexp :tag "Value"))))
  143. (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
  144. "Hook run in a temporary buffer before writing the agenda to an export file.
  145. A useful function for this hook is `org-agenda-add-entry-text'."
  146. :group 'org-agenda-export
  147. :type 'hook
  148. :options '(org-agenda-add-entry-text))
  149. (defcustom org-agenda-add-entry-text-maxlines 0
  150. "Maximum number of entry text lines to be added to agenda.
  151. This is only relevant when `org-agenda-add-entry-text' is part of
  152. `org-agenda-before-write-hook', which is the default.
  153. When this is 0, nothing will happen. When it is greater than 0, it
  154. specifies the maximum number of lines that will be added for each entry
  155. that is listed in the agenda view.
  156. Note that this variable is not used during display, only when exporting
  157. the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
  158. and `org-agenda-entry-text-maxlines'."
  159. :group 'org-agenda
  160. :type 'integer)
  161. (defcustom org-agenda-add-entry-text-descriptive-links t
  162. "Non-nil means export org-links as descriptive links in agenda added text.
  163. This variable applies to the text added to the agenda when
  164. `org-agenda-add-entry-text-maxlines' is larger than 0.
  165. When this variable nil, the URL will (also) be shown."
  166. :group 'org-agenda
  167. :type 'boolean)
  168. (defcustom org-agenda-export-html-style nil
  169. "The style specification for exported HTML Agenda files.
  170. If this variable contains a string, it will replace the default <style>
  171. section as produced by `htmlize'.
  172. Since there are different ways of setting style information, this variable
  173. needs to contain the full HTML structure to provide a style, including the
  174. surrounding HTML tags. The style specifications should include definitions
  175. the fonts used by the agenda, here is an example:
  176. <style type=\"text/css\">
  177. p { font-weight: normal; color: gray; }
  178. .org-agenda-structure {
  179. font-size: 110%;
  180. color: #003399;
  181. font-weight: 600;
  182. }
  183. .org-todo {
  184. color: #cc6666;
  185. font-weight: bold;
  186. }
  187. .org-agenda-done {
  188. color: #339933;
  189. }
  190. .org-done {
  191. color: #339933;
  192. }
  193. .title { text-align: center; }
  194. .todo, .deadline { color: red; }
  195. .done { color: green; }
  196. </style>
  197. or, if you want to keep the style in a file,
  198. <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
  199. As the value of this option simply gets inserted into the HTML <head> header,
  200. you can \"misuse\" it to also add other text to the header."
  201. :group 'org-agenda-export
  202. :group 'org-export-html
  203. :type '(choice
  204. (const nil)
  205. (string)))
  206. (defcustom org-agenda-persistent-filter nil
  207. "When set, keep filters from one agenda view to the next."
  208. :group 'org-agenda
  209. :type 'boolean)
  210. (defgroup org-agenda-custom-commands nil
  211. "Options concerning agenda views in Org-mode."
  212. :tag "Org Agenda Custom Commands"
  213. :group 'org-agenda)
  214. (defconst org-sorting-choice
  215. '(choice
  216. (const time-up) (const time-down)
  217. (const timestamp-up) (const timestamp-down)
  218. (const scheduled-up) (const scheduled-down)
  219. (const deadline-up) (const deadline-down)
  220. (const ts-up) (const ts-down)
  221. (const tsia-up) (const tsia-down)
  222. (const category-keep) (const category-up) (const category-down)
  223. (const tag-down) (const tag-up)
  224. (const priority-up) (const priority-down)
  225. (const todo-state-up) (const todo-state-down)
  226. (const effort-up) (const effort-down)
  227. (const habit-up) (const habit-down)
  228. (const alpha-up) (const alpha-down)
  229. (const user-defined-up) (const user-defined-down))
  230. "Sorting choices.")
  231. ;; Keep custom values for `org-agenda-filter-preset' compatible with
  232. ;; the new variable `org-agenda-tag-filter-preset'.
  233. (org-defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
  234. (org-defvaralias 'org-agenda-filter 'org-agenda-tag-filter)
  235. (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
  236. "List of types searched for when creating the daily/weekly agenda.
  237. This variable is a list of symbols that controls the types of
  238. items that appear in the daily/weekly agenda. Allowed symbols in this
  239. list are are
  240. :timestamp List items containing a date stamp or date range matching
  241. the selected date. This includes sexp entries in angular
  242. brackets.
  243. :sexp List entries resulting from plain diary-like sexps.
  244. :deadline List deadline due on that date. When the date is today,
  245. also list any deadlines past due, or due within
  246. `org-deadline-warning-days'. `:deadline' must appear before
  247. `:scheduled' if the setting of
  248. `org-agenda-skip-scheduled-if-deadline-is-shown' is to have
  249. any effect.
  250. :deadline* Same as above, but only include the deadline if it has an
  251. hour specification as [h]h:mm.
  252. :scheduled List all items which are scheduled for the given date.
  253. The diary for *today* also contains items which were
  254. scheduled earlier and are not yet marked DONE.
  255. :scheduled* Same as above, but only include the scheduled item if it
  256. has an hour specification as [h]h:mm.
  257. By default, all four non-starred types are turned on.
  258. When :scheduled* or :deadline* are included, :schedule or :deadline
  259. will be ignored.
  260. Never set this variable globally using `setq', because then it
  261. will apply to all future agenda commands. Instead, bind it with
  262. `let' to scope it dynamically into the agenda-constructing
  263. command. A good way to set it is through options in
  264. `org-agenda-custom-commands'. For a more flexible (though
  265. somewhat less efficient) way of determining what is included in
  266. the daily/weekly agenda, see `org-agenda-skip-function'.")
  267. (defconst org-agenda-custom-commands-local-options
  268. `(repeat :tag "Local settings for this command. Remember to quote values"
  269. (choice :tag "Setting"
  270. (list :tag "Heading for this block"
  271. (const org-agenda-overriding-header)
  272. (string :tag "Headline"))
  273. (list :tag "Files to be searched"
  274. (const org-agenda-files)
  275. (list
  276. (const :format "" quote)
  277. (repeat (file))))
  278. (list :tag "Sorting strategy"
  279. (const org-agenda-sorting-strategy)
  280. (list
  281. (const :format "" quote)
  282. (repeat
  283. ,org-sorting-choice)))
  284. (list :tag "Prefix format"
  285. (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
  286. (string))
  287. (list :tag "Number of days in agenda"
  288. (const org-agenda-span)
  289. (choice (const :tag "Day" day)
  290. (const :tag "Week" week)
  291. (const :tag "Fortnight" fortnight)
  292. (const :tag "Month" month)
  293. (const :tag "Year" year)
  294. (integer :tag "Custom")))
  295. (list :tag "Fixed starting date"
  296. (const org-agenda-start-day)
  297. (string :value "2007-11-01"))
  298. (list :tag "Start on day of week"
  299. (const org-agenda-start-on-weekday)
  300. (choice :value 1
  301. (const :tag "Today" nil)
  302. (integer :tag "Weekday No.")))
  303. (list :tag "Include data from diary"
  304. (const org-agenda-include-diary)
  305. (boolean))
  306. (list :tag "Deadline Warning days"
  307. (const org-deadline-warning-days)
  308. (integer :value 1))
  309. (list :tag "Category filter preset"
  310. (const org-agenda-category-filter-preset)
  311. (list
  312. (const :format "" quote)
  313. (repeat
  314. (string :tag "+category or -category"))))
  315. (list :tag "Tags filter preset"
  316. (const org-agenda-tag-filter-preset)
  317. (list
  318. (const :format "" quote)
  319. (repeat
  320. (string :tag "+tag or -tag"))))
  321. (list :tag "Effort filter preset"
  322. (const org-agenda-effort-filter-preset)
  323. (list
  324. (const :format "" quote)
  325. (repeat
  326. (string :tag "+=10 or -=10 or +<10 or ->10"))))
  327. (list :tag "Regexp filter preset"
  328. (const org-agenda-regexp-filter-preset)
  329. (list
  330. (const :format "" quote)
  331. (repeat
  332. (string :tag "+regexp or -regexp"))))
  333. (list :tag "Set daily/weekly entry types"
  334. (const org-agenda-entry-types)
  335. (list
  336. (const :format "" quote)
  337. (set :greedy t :value ,org-agenda-entry-types
  338. (const :deadline)
  339. (const :scheduled)
  340. (const :deadline*)
  341. (const :scheduled*)
  342. (const :timestamp)
  343. (const :sexp))))
  344. (list :tag "Standard skipping condition"
  345. :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
  346. (const org-agenda-skip-function)
  347. (list
  348. (const :format "" quote)
  349. (list
  350. (choice
  351. :tag "Skipping range"
  352. (const :tag "Skip entry" org-agenda-skip-entry-if)
  353. (const :tag "Skip subtree" org-agenda-skip-subtree-if))
  354. (repeat :inline t :tag "Conditions for skipping"
  355. (choice
  356. :tag "Condition type"
  357. (list :tag "Regexp matches" :inline t
  358. (const :format "" 'regexp)
  359. (regexp))
  360. (list :tag "Regexp does not match" :inline t
  361. (const :format "" 'notregexp)
  362. (regexp))
  363. (list :tag "TODO state is" :inline t
  364. (const 'todo)
  365. (choice
  366. (const :tag "Any not-done state" 'todo)
  367. (const :tag "Any done state" 'done)
  368. (const :tag "Any state" 'any)
  369. (list :tag "Keyword list"
  370. (const :format "" quote)
  371. (repeat (string :tag "Keyword")))))
  372. (list :tag "TODO state is not" :inline t
  373. (const 'nottodo)
  374. (choice
  375. (const :tag "Any not-done state" 'todo)
  376. (const :tag "Any done state" 'done)
  377. (const :tag "Any state" 'any)
  378. (list :tag "Keyword list"
  379. (const :format "" quote)
  380. (repeat (string :tag "Keyword")))))
  381. (const :tag "scheduled" 'scheduled)
  382. (const :tag "not scheduled" 'notscheduled)
  383. (const :tag "deadline" 'deadline)
  384. (const :tag "no deadline" 'notdeadline)
  385. (const :tag "timestamp" 'timestamp)
  386. (const :tag "no timestamp" 'nottimestamp))))))
  387. (list :tag "Non-standard skipping condition"
  388. :value (org-agenda-skip-function)
  389. (const org-agenda-skip-function)
  390. (sexp :tag "Function or form (quoted!)"))
  391. (list :tag "Any variable"
  392. (variable :tag "Variable")
  393. (sexp :tag "Value (sexp)"))))
  394. "Selection of examples for agenda command settings.
  395. This will be spliced into the custom type of
  396. `org-agenda-custom-commands'.")
  397. (defcustom org-agenda-custom-commands
  398. '(("n" "Agenda and all TODOs" ((agenda "") (alltodo ""))))
  399. "Custom commands for the agenda.
  400. These commands will be offered on the splash screen displayed by the
  401. agenda dispatcher \\[org-agenda]. Each entry is a list like this:
  402. (key desc type match settings files)
  403. key The key (one or more characters as a string) to be associated
  404. with the command.
  405. desc A description of the command, when omitted or nil, a default
  406. description is built using MATCH.
  407. type The command type, any of the following symbols:
  408. agenda The daily/weekly agenda.
  409. todo Entries with a specific TODO keyword, in all agenda files.
  410. search Entries containing search words entry or headline.
  411. tags Tags/Property/TODO match in all agenda files.
  412. tags-todo Tags/P/T match in all agenda files, TODO entries only.
  413. todo-tree Sparse tree of specific TODO keyword in *current* file.
  414. tags-tree Sparse tree with all tags matches in *current* file.
  415. occur-tree Occur sparse tree for *current* file.
  416. ... A user-defined function.
  417. match What to search for:
  418. - a single keyword for TODO keyword searches
  419. - a tags match expression for tags searches
  420. - a word search expression for text searches.
  421. - a regular expression for occur searches
  422. For all other commands, this should be the empty string.
  423. settings A list of option settings, similar to that in a let form, so like
  424. this: ((opt1 val1) (opt2 val2) ...). The values will be
  425. evaluated at the moment of execution, so quote them when needed.
  426. files A list of files file to write the produced agenda buffer to
  427. with the command `org-store-agenda-views'.
  428. If a file name ends in \".html\", an HTML version of the buffer
  429. is written out. If it ends in \".ps\", a postscript version is
  430. produced. Otherwise, only the plain text is written to the file.
  431. You can also define a set of commands, to create a composite agenda buffer.
  432. In this case, an entry looks like this:
  433. (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
  434. where
  435. desc A description string to be displayed in the dispatcher menu.
  436. cmd An agenda command, similar to the above. However, tree commands
  437. are not allowed, but instead you can get agenda and global todo list.
  438. So valid commands for a set are:
  439. (agenda \"\" settings)
  440. (alltodo \"\" settings)
  441. (stuck \"\" settings)
  442. (todo \"match\" settings files)
  443. (search \"match\" settings files)
  444. (tags \"match\" settings files)
  445. (tags-todo \"match\" settings files)
  446. Each command can carry a list of options, and another set of options can be
  447. given for the whole set of commands. Individual command options take
  448. precedence over the general options.
  449. When using several characters as key to a command, the first characters
  450. are prefix commands. For the dispatcher to display useful information, you
  451. should provide a description for the prefix, like
  452. (setq org-agenda-custom-commands
  453. \\='((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
  454. (\"hl\" tags \"+HOME+Lisa\")
  455. (\"hp\" tags \"+HOME+Peter\")
  456. (\"hk\" tags \"+HOME+Kim\")))"
  457. :group 'org-agenda-custom-commands
  458. :type `(repeat
  459. (choice :value ("x" "Describe command here" tags "" nil)
  460. (list :tag "Single command"
  461. (string :tag "Access Key(s) ")
  462. (option (string :tag "Description"))
  463. (choice
  464. (const :tag "Agenda" agenda)
  465. (const :tag "TODO list" alltodo)
  466. (const :tag "Search words" search)
  467. (const :tag "Stuck projects" stuck)
  468. (const :tag "Tags/Property match (all agenda files)" tags)
  469. (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
  470. (const :tag "TODO keyword search (all agenda files)" todo)
  471. (const :tag "Tags sparse tree (current buffer)" tags-tree)
  472. (const :tag "TODO keyword tree (current buffer)" todo-tree)
  473. (const :tag "Occur tree (current buffer)" occur-tree)
  474. (sexp :tag "Other, user-defined function"))
  475. (string :tag "Match (only for some commands)")
  476. ,org-agenda-custom-commands-local-options
  477. (option (repeat :tag "Export" (file :tag "Export to"))))
  478. (list :tag "Command series, all agenda files"
  479. (string :tag "Access Key(s)")
  480. (string :tag "Description ")
  481. (repeat :tag "Component"
  482. (choice
  483. (list :tag "Agenda"
  484. (const :format "" agenda)
  485. (const :tag "" :format "" "")
  486. ,org-agenda-custom-commands-local-options)
  487. (list :tag "TODO list (all keywords)"
  488. (const :format "" alltodo)
  489. (const :tag "" :format "" "")
  490. ,org-agenda-custom-commands-local-options)
  491. (list :tag "Search words"
  492. (const :format "" search)
  493. (string :tag "Match")
  494. ,org-agenda-custom-commands-local-options)
  495. (list :tag "Stuck projects"
  496. (const :format "" stuck)
  497. (const :tag "" :format "" "")
  498. ,org-agenda-custom-commands-local-options)
  499. (list :tag "Tags search"
  500. (const :format "" tags)
  501. (string :tag "Match")
  502. ,org-agenda-custom-commands-local-options)
  503. (list :tag "Tags search, TODO entries only"
  504. (const :format "" tags-todo)
  505. (string :tag "Match")
  506. ,org-agenda-custom-commands-local-options)
  507. (list :tag "TODO keyword search"
  508. (const :format "" todo)
  509. (string :tag "Match")
  510. ,org-agenda-custom-commands-local-options)
  511. (list :tag "Other, user-defined function"
  512. (symbol :tag "function")
  513. (string :tag "Match")
  514. ,org-agenda-custom-commands-local-options)))
  515. (repeat :tag "Settings for entire command set"
  516. (list (variable :tag "Any variable")
  517. (sexp :tag "Value")))
  518. (option (repeat :tag "Export" (file :tag "Export to"))))
  519. (cons :tag "Prefix key documentation"
  520. (string :tag "Access Key(s)")
  521. (string :tag "Description ")))))
  522. (defcustom org-agenda-query-register ?o
  523. "The register holding the current query string.
  524. The purpose of this is that if you construct a query string interactively,
  525. you can then use it to define a custom command."
  526. :group 'org-agenda-custom-commands
  527. :type 'character)
  528. (defcustom org-stuck-projects
  529. '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
  530. "How to identify stuck projects.
  531. This is a list of four items:
  532. 1. A tags/todo/property matcher string that is used to identify a project.
  533. See the manual for a description of tag and property searches.
  534. The entire tree below a headline matched by this is considered one project.
  535. 2. A list of TODO keywords identifying non-stuck projects.
  536. If the project subtree contains any headline with one of these todo
  537. keywords, the project is considered to be not stuck. If you specify
  538. \"*\" as a keyword, any TODO keyword will mark the project unstuck.
  539. 3. A list of tags identifying non-stuck projects.
  540. If the project subtree contains any headline with one of these tags,
  541. the project is considered to be not stuck. If you specify \"*\" as
  542. a tag, any tag will mark the project unstuck. Note that this is about
  543. the explicit presence of a tag somewhere in the subtree, inherited
  544. tags do not count here. If inherited tags make a project not stuck,
  545. use \"-TAG\" in the tags part of the matcher under (1.) above.
  546. 4. An arbitrary regular expression matching non-stuck projects.
  547. If the project turns out to be not stuck, search continues also in the
  548. subtree to see if any of the subtasks have project status.
  549. See also the variable `org-tags-match-list-sublevels' which applies
  550. to projects matched by this search as well.
  551. After defining this variable, you may use \\[org-agenda-list-stuck-projects]
  552. or `C-c a #' to produce the list."
  553. :group 'org-agenda-custom-commands
  554. :type '(list
  555. (string :tag "Tags/TODO match to identify a project")
  556. (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
  557. (repeat :tag "Projects are *not* stuck if they have an entry with TAG being any of" (string))
  558. (regexp :tag "Projects are *not* stuck if this regexp matches inside the subtree")))
  559. (defgroup org-agenda-skip nil
  560. "Options concerning skipping parts of agenda files."
  561. :tag "Org Agenda Skip"
  562. :group 'org-agenda)
  563. (defcustom org-agenda-skip-function-global nil
  564. "Function to be called at each match during agenda construction.
  565. If this function returns nil, the current match should not be skipped.
  566. If the function decided to skip an agenda match, is must return the
  567. buffer position from which the search should be continued.
  568. This may also be a Lisp form, which will be evaluated.
  569. This variable will be applied to every agenda match, including
  570. tags/property searches and TODO lists. So try to make the test function
  571. do its checking as efficiently as possible. To implement a skipping
  572. condition just for specific agenda commands, use the variable
  573. `org-agenda-skip-function' which can be set in the options section
  574. of custom agenda commands."
  575. :group 'org-agenda-skip
  576. :type 'sexp)
  577. (defgroup org-agenda-daily/weekly nil
  578. "Options concerning the daily/weekly agenda."
  579. :tag "Org Agenda Daily/Weekly"
  580. :group 'org-agenda)
  581. (defgroup org-agenda-todo-list nil
  582. "Options concerning the global todo list agenda view."
  583. :tag "Org Agenda Todo List"
  584. :group 'org-agenda)
  585. (defgroup org-agenda-match-view nil
  586. "Options concerning the general tags/property/todo match agenda view."
  587. :tag "Org Agenda Match View"
  588. :group 'org-agenda)
  589. (defgroup org-agenda-search-view nil
  590. "Options concerning the search agenda view."
  591. :tag "Org Agenda Search View"
  592. :group 'org-agenda)
  593. (defvar org-agenda-archives-mode nil
  594. "Non-nil means the agenda will include archived items.
  595. If this is the symbol `trees', trees in the selected agenda scope
  596. that are marked with the ARCHIVE tag will be included anyway. When this is
  597. t, also all archive files associated with the current selection of agenda
  598. files will be included.")
  599. (defcustom org-agenda-restriction-lock-highlight-subtree t
  600. "Non-nil means highlight the whole subtree when restriction is active.
  601. Otherwise only highlight the headline. Highlighting the whole subtree is
  602. useful to ensure no edits happen beyond the restricted region."
  603. :group 'org-agenda
  604. :type 'boolean)
  605. (defcustom org-agenda-skip-comment-trees t
  606. "Non-nil means skip trees that start with the COMMENT keyword.
  607. When nil, these trees are also scanned by agenda commands."
  608. :group 'org-agenda-skip
  609. :type 'boolean)
  610. (defcustom org-agenda-todo-list-sublevels t
  611. "Non-nil means check also the sublevels of a TODO entry for TODO entries.
  612. When nil, the sublevels of a TODO entry are not checked, resulting in
  613. potentially much shorter TODO lists."
  614. :group 'org-agenda-skip
  615. :group 'org-agenda-todo-list
  616. :type 'boolean)
  617. (defcustom org-agenda-todo-ignore-with-date nil
  618. "Non-nil means don't show entries with a date in the global todo list.
  619. You can use this if you prefer to mark mere appointments with a TODO keyword,
  620. but don't want them to show up in the TODO list.
  621. When this is set, it also covers deadlines and scheduled items, the settings
  622. of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
  623. will be ignored.
  624. See also the variable `org-agenda-tags-todo-honor-ignore-options'."
  625. :group 'org-agenda-skip
  626. :group 'org-agenda-todo-list
  627. :type 'boolean)
  628. (defcustom org-agenda-todo-ignore-timestamp nil
  629. "Non-nil means don't show entries with a timestamp.
  630. This applies when creating the global todo list.
  631. Valid values are:
  632. past Don't show entries for today or in the past.
  633. future Don't show entries with a timestamp in the future.
  634. The idea behind this is that if it has a future
  635. timestamp, you don't want to think about it until the
  636. date.
  637. all Don't show any entries with a timestamp in the global todo list.
  638. The idea behind this is that by setting a timestamp, you
  639. have already \"taken care\" of this item.
  640. This variable can also have an integer as a value. If positive (N),
  641. todos with a timestamp N or more days in the future will be ignored. If
  642. negative (-N), todos with a timestamp N or more days in the past will be
  643. ignored. If 0, todos with a timestamp either today or in the future will
  644. be ignored. For example, a value of -1 will exclude todos with a
  645. timestamp in the past (yesterday or earlier), while a value of 7 will
  646. exclude todos with a timestamp a week or more in the future.
  647. See also `org-agenda-todo-ignore-with-date'.
  648. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  649. to make his option also apply to the tags-todo list."
  650. :group 'org-agenda-skip
  651. :group 'org-agenda-todo-list
  652. :version "24.1"
  653. :type '(choice
  654. (const :tag "Ignore future timestamp todos" future)
  655. (const :tag "Ignore past or present timestamp todos" past)
  656. (const :tag "Ignore all timestamp todos" all)
  657. (const :tag "Show timestamp todos" nil)
  658. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  659. (defcustom org-agenda-todo-ignore-scheduled nil
  660. "Non-nil means, ignore some scheduled TODO items when making TODO list.
  661. This applies when creating the global todo list.
  662. Valid values are:
  663. past Don't show entries scheduled today or in the past.
  664. future Don't show entries scheduled in the future.
  665. The idea behind this is that by scheduling it, you don't want to
  666. think about it until the scheduled date.
  667. all Don't show any scheduled entries in the global todo list.
  668. The idea behind this is that by scheduling it, you have already
  669. \"taken care\" of this item.
  670. t Same as `all', for backward compatibility.
  671. This variable can also have an integer as a value. See
  672. `org-agenda-todo-ignore-timestamp' for more details.
  673. See also `org-agenda-todo-ignore-with-date'.
  674. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  675. to make his option also apply to the tags-todo list."
  676. :group 'org-agenda-skip
  677. :group 'org-agenda-todo-list
  678. :type '(choice
  679. (const :tag "Ignore future-scheduled todos" future)
  680. (const :tag "Ignore past- or present-scheduled todos" past)
  681. (const :tag "Ignore all scheduled todos" all)
  682. (const :tag "Ignore all scheduled todos (compatibility)" t)
  683. (const :tag "Show scheduled todos" nil)
  684. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  685. (defcustom org-agenda-todo-ignore-deadlines nil
  686. "Non-nil means ignore some deadline TODO items when making TODO list.
  687. There are different motivations for using different values, please think
  688. carefully when configuring this variable.
  689. This applies when creating the global todo list.
  690. Valid values are:
  691. near Don't show near deadline entries. A deadline is near when it is
  692. closer than `org-deadline-warning-days' days. The idea behind this
  693. is that such items will appear in the agenda anyway.
  694. far Don't show TODO entries where a deadline has been defined, but
  695. the deadline is not near. This is useful if you don't want to
  696. use the todo list to figure out what to do now.
  697. past Don't show entries with a deadline timestamp for today or in the past.
  698. future Don't show entries with a deadline timestamp in the future, not even
  699. when they become `near' ones. Use it with caution.
  700. all Ignore all TODO entries that do have a deadline.
  701. t Same as `near', for backward compatibility.
  702. This variable can also have an integer as a value. See
  703. `org-agenda-todo-ignore-timestamp' for more details.
  704. See also `org-agenda-todo-ignore-with-date'.
  705. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  706. to make his option also apply to the tags-todo list."
  707. :group 'org-agenda-skip
  708. :group 'org-agenda-todo-list
  709. :type '(choice
  710. (const :tag "Ignore near deadlines" near)
  711. (const :tag "Ignore near deadlines (compatibility)" t)
  712. (const :tag "Ignore far deadlines" far)
  713. (const :tag "Ignore all TODOs with a deadlines" all)
  714. (const :tag "Show all TODOs, even if they have a deadline" nil)
  715. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  716. (defcustom org-agenda-todo-ignore-time-comparison-use-seconds nil
  717. "Time unit to use when possibly ignoring an agenda item.
  718. See the docstring of various `org-agenda-todo-ignore-*' options.
  719. The default is to compare time stamps using days. An item is thus
  720. considered to be in the future if it is at least one day after today.
  721. Non-nil means to compare time stamps using seconds. An item is then
  722. considered future if it has a time value later than current time."
  723. :group 'org-agenda-skip
  724. :group 'org-agenda-todo-list
  725. :version "24.4"
  726. :package-version '(Org . "8.0")
  727. :type '(choice
  728. (const :tag "Compare time with days" nil)
  729. (const :tag "Compare time with seconds" t)))
  730. (defcustom org-agenda-tags-todo-honor-ignore-options nil
  731. "Non-nil means honor todo-list ignores options also in tags-todo search.
  732. The variables
  733. `org-agenda-todo-ignore-with-date',
  734. `org-agenda-todo-ignore-timestamp',
  735. `org-agenda-todo-ignore-scheduled',
  736. `org-agenda-todo-ignore-deadlines'
  737. make the global TODO list skip entries that have time stamps of certain
  738. kinds. If this option is set, the same options will also apply for the
  739. tags-todo search, which is the general tags/property matcher
  740. restricted to unfinished TODO entries only."
  741. :group 'org-agenda-skip
  742. :group 'org-agenda-todo-list
  743. :group 'org-agenda-match-view
  744. :type 'boolean)
  745. (defcustom org-agenda-skip-scheduled-if-done nil
  746. "Non-nil means don't show scheduled items in agenda when they are done.
  747. This is relevant for the daily/weekly agenda, not for the TODO list. And
  748. it applies only to the actual date of the scheduling. Warnings about
  749. an item with a past scheduling dates are always turned off when the item
  750. is DONE."
  751. :group 'org-agenda-skip
  752. :group 'org-agenda-daily/weekly
  753. :type 'boolean)
  754. (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
  755. "Non-nil means skip scheduling line if same entry shows because of deadline.
  756. In the agenda of today, an entry can show up multiple times
  757. because it is both scheduled and has a nearby deadline, and maybe
  758. a plain time stamp as well.
  759. When this variable is nil, the entry will be shown several times.
  760. When set to t, then only the deadline is shown and the fact that
  761. the entry is scheduled today or was scheduled previously is not
  762. shown.
  763. When set to the symbol `not-today', skip scheduled previously,
  764. but not scheduled today.
  765. When set to the symbol `repeated-after-deadline', skip scheduled
  766. items if they are repeated beyond the current deadline."
  767. :group 'org-agenda-skip
  768. :group 'org-agenda-daily/weekly
  769. :type '(choice
  770. (const :tag "Never" nil)
  771. (const :tag "Always" t)
  772. (const :tag "Not when scheduled today" not-today)
  773. (const :tag "When repeated past deadline" repeated-after-deadline)))
  774. (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
  775. "Non-nil means skip timestamp line if same entry shows because of deadline.
  776. In the agenda of today, an entry can show up multiple times
  777. because it has both a plain timestamp and has a nearby deadline.
  778. When this variable is t, then only the deadline is shown and the
  779. fact that the entry has a timestamp for or including today is not
  780. shown. When this variable is nil, the entry will be shown
  781. several times."
  782. :group 'org-agenda-skip
  783. :group 'org-agenda-daily/weekly
  784. :version "24.1"
  785. :type '(choice
  786. (const :tag "Never" nil)
  787. (const :tag "Always" t)))
  788. (defcustom org-agenda-skip-deadline-if-done nil
  789. "Non-nil means don't show deadlines when the corresponding item is done.
  790. When nil, the deadline is still shown and should give you a happy feeling.
  791. This is relevant for the daily/weekly agenda. And it applied only to the
  792. actually date of the deadline. Warnings about approaching and past-due
  793. deadlines are always turned off when the item is DONE."
  794. :group 'org-agenda-skip
  795. :group 'org-agenda-daily/weekly
  796. :type 'boolean)
  797. (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
  798. "Non-nil means skip deadline prewarning when entry is also scheduled.
  799. This will apply on all days where a prewarning for the deadline would
  800. be shown, but not at the day when the entry is actually due. On that day,
  801. the deadline will be shown anyway.
  802. This variable may be set to nil, t, the symbol `pre-scheduled',
  803. or a number which will then give the number of days before the actual
  804. deadline when the prewarnings should resume. The symbol `pre-scheduled'
  805. eliminates the deadline prewarning only prior to the scheduled date.
  806. This can be used in a workflow where the first showing of the deadline will
  807. trigger you to schedule it, and then you don't want to be reminded of it
  808. because you will take care of it on the day when scheduled."
  809. :group 'org-agenda-skip
  810. :group 'org-agenda-daily/weekly
  811. :version "24.1"
  812. :type '(choice
  813. (const :tag "Always show prewarning" nil)
  814. (const :tag "Remove prewarning prior to scheduled date" pre-scheduled)
  815. (const :tag "Remove prewarning if entry is scheduled" t)
  816. (integer :tag "Restart prewarning N days before deadline")))
  817. (defcustom org-agenda-skip-scheduled-delay-if-deadline nil
  818. "Non-nil means skip scheduled delay when entry also has a deadline.
  819. This variable may be set to nil, t, the symbol `post-deadline',
  820. or a number which will then give the number of days after the actual
  821. scheduled date when the delay should expire. The symbol `post-deadline'
  822. eliminates the schedule delay when the date is posterior to the deadline."
  823. :group 'org-agenda-skip
  824. :group 'org-agenda-daily/weekly
  825. :version "24.4"
  826. :package-version '(Org . "8.0")
  827. :type '(choice
  828. (const :tag "Always honor delay" nil)
  829. (const :tag "Ignore delay if posterior to the deadline" post-deadline)
  830. (const :tag "Ignore delay if entry has a deadline" t)
  831. (integer :tag "Honor delay up until N days after the scheduled date")))
  832. (defcustom org-agenda-skip-additional-timestamps-same-entry nil
  833. "When nil, multiple same-day timestamps in entry make multiple agenda lines.
  834. When non-nil, after the search for timestamps has matched once in an
  835. entry, the rest of the entry will not be searched."
  836. :group 'org-agenda-skip
  837. :type 'boolean)
  838. (defcustom org-agenda-skip-timestamp-if-done nil
  839. "Non-nil means don't select item by timestamp or -range if it is DONE."
  840. :group 'org-agenda-skip
  841. :group 'org-agenda-daily/weekly
  842. :type 'boolean)
  843. (defcustom org-agenda-dim-blocked-tasks t
  844. "Non-nil means dim blocked tasks in the agenda display.
  845. This causes some overhead during agenda construction, but if you
  846. have turned on `org-enforce-todo-dependencies',
  847. `org-enforce-todo-checkbox-dependencies', or any other blocking
  848. mechanism, this will create useful feedback in the agenda.
  849. Instead of t, this variable can also have the value `invisible'.
  850. Then blocked tasks will be invisible and only become visible when
  851. they become unblocked. An exemption to this behavior is when a task is
  852. blocked because of unchecked checkboxes below it. Since checkboxes do
  853. not show up in the agenda views, making this task invisible you remove any
  854. trace from agenda views that there is something to do. Therefore, a task
  855. that is blocked because of checkboxes will never be made invisible, it
  856. will only be dimmed."
  857. :group 'org-agenda-daily/weekly
  858. :group 'org-agenda-todo-list
  859. :version "24.3"
  860. :type '(choice
  861. (const :tag "Do not dim" nil)
  862. (const :tag "Dim to a gray face" t)
  863. (const :tag "Make invisible" invisible)))
  864. (defcustom org-timeline-show-empty-dates 3
  865. "Non-nil means `org-timeline' also shows dates without an entry.
  866. When nil, only the days which actually have entries are shown.
  867. When t, all days between the first and the last date are shown.
  868. When an integer, show also empty dates, but if there is a gap of more than
  869. N days, just insert a special line indicating the size of the gap."
  870. :group 'org-agenda-skip
  871. :type '(choice
  872. (const :tag "None" nil)
  873. (const :tag "All" t)
  874. (integer :tag "at most")))
  875. (defgroup org-agenda-startup nil
  876. "Options concerning initial settings in the Agenda in Org Mode."
  877. :tag "Org Agenda Startup"
  878. :group 'org-agenda)
  879. (defcustom org-agenda-menu-show-matcher t
  880. "Non-nil means show the match string in the agenda dispatcher menu.
  881. When nil, the matcher string is not shown, but is put into the help-echo
  882. property so than moving the mouse over the command shows it.
  883. Setting it to nil is good if matcher strings are very long and/or if
  884. you want to use two-columns display (see `org-agenda-menu-two-columns')."
  885. :group 'org-agenda
  886. :version "24.1"
  887. :type 'boolean)
  888. (define-obsolete-variable-alias 'org-agenda-menu-two-column 'org-agenda-menu-two-columns "24.3")
  889. (defcustom org-agenda-menu-two-columns nil
  890. "Non-nil means, use two columns to show custom commands in the dispatcher.
  891. If you use this, you probably want to set `org-agenda-menu-show-matcher'
  892. to nil."
  893. :group 'org-agenda
  894. :version "24.1"
  895. :type 'boolean)
  896. (define-obsolete-variable-alias 'org-finalize-agenda-hook 'org-agenda-finalize-hook "24.3")
  897. (defcustom org-agenda-finalize-hook nil
  898. "Hook run just before displaying an agenda buffer.
  899. The buffer is still writable when the hook is called.
  900. You can modify some of the buffer substrings but you should be
  901. extra careful not to modify the text properties of the agenda
  902. headlines as the agenda display heavily relies on them."
  903. :group 'org-agenda-startup
  904. :type 'hook)
  905. (defcustom org-agenda-mouse-1-follows-link nil
  906. "Non-nil means mouse-1 on a link will follow the link in the agenda.
  907. A longer mouse click will still set point. Does not work on XEmacs.
  908. Needs to be set before org.el is loaded."
  909. :group 'org-agenda-startup
  910. :type 'boolean)
  911. (defcustom org-agenda-start-with-follow-mode nil
  912. "The initial value of follow mode in a newly created agenda window."
  913. :group 'org-agenda-startup
  914. :type 'boolean)
  915. (defcustom org-agenda-follow-indirect nil
  916. "Non-nil means `org-agenda-follow-mode' displays only the
  917. current item's tree, in an indirect buffer."
  918. :group 'org-agenda
  919. :version "24.1"
  920. :type 'boolean)
  921. (defcustom org-agenda-show-outline-path t
  922. "Non-nil means show outline path in echo area after line motion."
  923. :group 'org-agenda-startup
  924. :type 'boolean)
  925. (defcustom org-agenda-start-with-entry-text-mode nil
  926. "The initial value of entry-text-mode in a newly created agenda window."
  927. :group 'org-agenda-startup
  928. :type 'boolean)
  929. (defcustom org-agenda-entry-text-maxlines 5
  930. "Number of text lines to be added when `E' is pressed in the agenda.
  931. Note that this variable only used during agenda display. Add add entry text
  932. when exporting the agenda, configure the variable
  933. `org-agenda-add-entry-ext-maxlines'."
  934. :group 'org-agenda
  935. :type 'integer)
  936. (defcustom org-agenda-entry-text-exclude-regexps nil
  937. "List of regular expressions to clean up entry text.
  938. The complete matches of all regular expressions in this list will be
  939. removed from entry text before it is shown in the agenda."
  940. :group 'org-agenda
  941. :type '(repeat (regexp)))
  942. (defcustom org-agenda-entry-text-leaders " > "
  943. "Text prepended to the entry text in agenda buffers."
  944. :version "24.4"
  945. :package-version '(Org . "8.0")
  946. :group 'org-agenda
  947. :type 'string)
  948. (defvar org-agenda-entry-text-cleanup-hook nil
  949. "Hook that is run after basic cleanup of entry text to be shown in agenda.
  950. This cleanup is done in a temporary buffer, so the function may inspect and
  951. change the entire buffer.
  952. Some default stuff like drawers and scheduling/deadline dates will already
  953. have been removed when this is called, as will any matches for regular
  954. expressions listed in `org-agenda-entry-text-exclude-regexps'.")
  955. (defvar org-agenda-include-inactive-timestamps nil
  956. "Non-nil means include inactive time stamps in agenda and timeline.
  957. Dynamically scoped.")
  958. (defgroup org-agenda-windows nil
  959. "Options concerning the windows used by the Agenda in Org Mode."
  960. :tag "Org Agenda Windows"
  961. :group 'org-agenda)
  962. (defcustom org-agenda-window-setup 'reorganize-frame
  963. "How the agenda buffer should be displayed.
  964. Possible values for this option are:
  965. current-window Show agenda in the current window, keeping all other windows.
  966. other-window Use `switch-to-buffer-other-window' to display agenda.
  967. only-window Show agenda, deleting all other windows.
  968. reorganize-frame Show only two windows on the current frame, the current
  969. window and the agenda.
  970. other-frame Use `switch-to-buffer-other-frame' to display agenda.
  971. Also, when exiting the agenda, kill that frame.
  972. See also the variable `org-agenda-restore-windows-after-quit'."
  973. :group 'org-agenda-windows
  974. :type '(choice
  975. (const current-window)
  976. (const other-frame)
  977. (const other-window)
  978. (const only-window)
  979. (const reorganize-frame)))
  980. (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
  981. "The min and max height of the agenda window as a fraction of frame height.
  982. The value of the variable is a cons cell with two numbers between 0 and 1.
  983. It only matters if `org-agenda-window-setup' is `reorganize-frame'."
  984. :group 'org-agenda-windows
  985. :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
  986. (defcustom org-agenda-restore-windows-after-quit nil
  987. "Non-nil means restore window configuration upon exiting agenda.
  988. Before the window configuration is changed for displaying the agenda,
  989. the current status is recorded. When the agenda is exited with
  990. `q' or `x' and this option is set, the old state is restored. If
  991. `org-agenda-window-setup' is `other-frame', the value of this
  992. option will be ignored."
  993. :group 'org-agenda-windows
  994. :type 'boolean)
  995. (defcustom org-agenda-ndays nil
  996. "Number of days to include in overview display.
  997. Should be 1 or 7.
  998. Obsolete, see `org-agenda-span'."
  999. :group 'org-agenda-daily/weekly
  1000. :type '(choice (const nil)
  1001. (integer)))
  1002. (make-obsolete-variable 'org-agenda-ndays 'org-agenda-span "24.1")
  1003. (defcustom org-agenda-span 'week
  1004. "Number of days to include in overview display.
  1005. Can be day, week, month, year, or any number of days.
  1006. Custom commands can set this variable in the options section."
  1007. :group 'org-agenda-daily/weekly
  1008. :type '(choice (const :tag "Day" day)
  1009. (const :tag "Week" week)
  1010. (const :tag "Fortnight" fortnight)
  1011. (const :tag "Month" month)
  1012. (const :tag "Year" year)
  1013. (integer :tag "Custom")))
  1014. (defcustom org-agenda-start-on-weekday 1
  1015. "Non-nil means start the overview always on the specified weekday.
  1016. 0 denotes Sunday, 1 denotes Monday, etc.
  1017. When nil, always start on the current day.
  1018. Custom commands can set this variable in the options section."
  1019. :group 'org-agenda-daily/weekly
  1020. :type '(choice (const :tag "Today" nil)
  1021. (integer :tag "Weekday No.")))
  1022. (defcustom org-agenda-show-all-dates t
  1023. "Non-nil means `org-agenda' shows every day in the selected range.
  1024. When nil, only the days which actually have entries are shown."
  1025. :group 'org-agenda-daily/weekly
  1026. :type 'boolean)
  1027. (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
  1028. "Format string for displaying dates in the agenda.
  1029. Used by the daily/weekly agenda and by the timeline. This should be
  1030. a format string understood by `format-time-string', or a function returning
  1031. the formatted date as a string. The function must take a single argument,
  1032. a calendar-style date list like (month day year)."
  1033. :group 'org-agenda-daily/weekly
  1034. :type '(choice
  1035. (string :tag "Format string")
  1036. (function :tag "Function")))
  1037. (defun org-agenda-format-date-aligned (date)
  1038. "Format a DATE string for display in the daily/weekly agenda, or timeline.
  1039. This function makes sure that dates are aligned for easy reading."
  1040. (require 'cal-iso)
  1041. (let* ((dayname (calendar-day-name date))
  1042. (day (cadr date))
  1043. (day-of-week (calendar-day-of-week date))
  1044. (month (car date))
  1045. (monthname (calendar-month-name month))
  1046. (year (nth 2 date))
  1047. (iso-week (org-days-to-iso-week
  1048. (calendar-absolute-from-gregorian date)))
  1049. (weekyear (cond ((and (= month 1) (>= iso-week 52))
  1050. (1- year))
  1051. ((and (= month 12) (<= iso-week 1))
  1052. (1+ year))
  1053. (t year)))
  1054. (weekstring (if (= day-of-week 1)
  1055. (format " W%02d" iso-week)
  1056. "")))
  1057. (format "%-10s %2d %s %4d%s"
  1058. dayname day monthname year weekstring)))
  1059. (defcustom org-agenda-time-leading-zero nil
  1060. "Non-nil means use leading zero for military times in agenda.
  1061. For example, 9:30am would become 09:30 rather than 9:30."
  1062. :group 'org-agenda-daily/weekly
  1063. :version "24.1"
  1064. :type 'boolean)
  1065. (defcustom org-agenda-timegrid-use-ampm nil
  1066. "When set, show AM/PM style timestamps on the timegrid."
  1067. :group 'org-agenda
  1068. :version "24.1"
  1069. :type 'boolean)
  1070. (defun org-agenda-time-of-day-to-ampm (time)
  1071. "Convert TIME of a string like \"13:45\" to an AM/PM style time string."
  1072. (let* ((hour-number (string-to-number (substring time 0 -3)))
  1073. (minute (substring time -2))
  1074. (ampm "am"))
  1075. (cond
  1076. ((equal hour-number 12)
  1077. (setq ampm "pm"))
  1078. ((> hour-number 12)
  1079. (setq ampm "pm")
  1080. (setq hour-number (- hour-number 12))))
  1081. (concat
  1082. (if org-agenda-time-leading-zero
  1083. (format "%02d" hour-number)
  1084. (format "%02s" (number-to-string hour-number)))
  1085. ":" minute ampm)))
  1086. (defun org-agenda-time-of-day-to-ampm-maybe (time)
  1087. "Conditionally convert TIME to AM/PM format based on `org-agenda-timegrid-use-ampm'."
  1088. (if org-agenda-timegrid-use-ampm
  1089. (org-agenda-time-of-day-to-ampm time)
  1090. time))
  1091. (defcustom org-agenda-weekend-days '(6 0)
  1092. "Which days are weekend?
  1093. These days get the special face `org-agenda-date-weekend' in the agenda
  1094. and timeline buffers."
  1095. :group 'org-agenda-daily/weekly
  1096. :type '(set :greedy t
  1097. (const :tag "Monday" 1)
  1098. (const :tag "Tuesday" 2)
  1099. (const :tag "Wednesday" 3)
  1100. (const :tag "Thursday" 4)
  1101. (const :tag "Friday" 5)
  1102. (const :tag "Saturday" 6)
  1103. (const :tag "Sunday" 0)))
  1104. (defcustom org-agenda-move-date-from-past-immediately-to-today t
  1105. "Non-nil means jump to today when moving a past date forward in time.
  1106. When using S-right in the agenda to move a a date forward, and the date
  1107. stamp currently points to the past, the first key press will move it
  1108. to today. WHen nil, just move one day forward even if the date stays
  1109. in the past."
  1110. :group 'org-agenda-daily/weekly
  1111. :version "24.1"
  1112. :type 'boolean)
  1113. (defcustom org-agenda-include-diary nil
  1114. "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
  1115. Custom commands can set this variable in the options section."
  1116. :group 'org-agenda-daily/weekly
  1117. :type 'boolean)
  1118. (defcustom org-agenda-include-deadlines t
  1119. "If non-nil, include entries within their deadline warning period.
  1120. Custom commands can set this variable in the options section."
  1121. :group 'org-agenda-daily/weekly
  1122. :version "24.1"
  1123. :type 'boolean)
  1124. (defcustom org-agenda-repeating-timestamp-show-all t
  1125. "Non-nil means show all occurrences of a repeating stamp in the agenda.
  1126. When set to a list of strings, only show occurrences of repeating
  1127. stamps for these TODO keywords. When nil, only one occurrence is
  1128. shown, either today or the nearest into the future."
  1129. :group 'org-agenda-daily/weekly
  1130. :type '(choice
  1131. (const :tag "Show repeating stamps" t)
  1132. (repeat :tag "Show repeating stamps for these TODO keywords"
  1133. (string :tag "TODO Keyword"))
  1134. (const :tag "Don't show repeating stamps" nil)))
  1135. (defcustom org-scheduled-past-days 10000
  1136. "Number of days to continue listing scheduled items not marked DONE.
  1137. When an item is scheduled on a date, it shows up in the agenda on this
  1138. day and will be listed until it is marked done for the number of days
  1139. given here."
  1140. :group 'org-agenda-daily/weekly
  1141. :type 'integer)
  1142. (defcustom org-agenda-log-mode-items '(closed clock)
  1143. "List of items that should be shown in agenda log mode.
  1144. \\<org-agenda-mode-map>\
  1145. This list may contain the following symbols:
  1146. closed Show entries that have been closed on that day.
  1147. clock Show entries that have received clocked time on that day.
  1148. state Show all logged state changes.
  1149. Note that instead of changing this variable, you can also press \
  1150. `\\[universal-argument] \\[org-agenda-log-mode]' in
  1151. the agenda to display all available LOG items temporarily."
  1152. :group 'org-agenda-daily/weekly
  1153. :type '(set :greedy t (const closed) (const clock) (const state)))
  1154. (defcustom org-agenda-clock-consistency-checks
  1155. '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
  1156. :gap-ok-around ("4:00")
  1157. :default-face ((:background "DarkRed") (:foreground "white"))
  1158. :overlap-face nil :gap-face nil :no-end-time-face nil
  1159. :long-face nil :short-face nil)
  1160. "This is a property list, with the following keys:
  1161. :max-duration Mark clocking chunks that are longer than this time.
  1162. This is a time string like \"HH:MM\", or the number
  1163. of minutes as an integer.
  1164. :min-duration Mark clocking chunks that are shorter that this.
  1165. This is a time string like \"HH:MM\", or the number
  1166. of minutes as an integer.
  1167. :max-gap Mark gaps between clocking chunks that are longer than
  1168. this duration. A number of minutes, or a string
  1169. like \"HH:MM\".
  1170. :gap-ok-around List of times during the day which are usually not working
  1171. times. When a gap is detected, but the gap contains any
  1172. of these times, the gap is *not* reported. For example,
  1173. if this is (\"4:00\" \"13:00\") then gaps that contain
  1174. 4:00 in the morning (i.e. the night) and 13:00
  1175. (i.e. a typical lunch time) do not cause a warning.
  1176. You should have at least one time during the night in this
  1177. list, or otherwise the first task each morning will trigger
  1178. a warning because it follows a long gap.
  1179. Furthermore, the following properties can be used to define faces for
  1180. issue display.
  1181. :default-face the default face, if the specific face is undefined
  1182. :overlap-face face for overlapping clocks
  1183. :gap-face face for gaps between clocks
  1184. :no-end-time-face face for incomplete clocks
  1185. :long-face face for clock intervals that are too long
  1186. :short-face face for clock intervals that are too short"
  1187. :group 'org-agenda-daily/weekly
  1188. :group 'org-clock
  1189. :version "24.1"
  1190. :type 'plist)
  1191. (defcustom org-agenda-log-mode-add-notes t
  1192. "Non-nil means add first line of notes to log entries in agenda views.
  1193. If a log item like a state change or a clock entry is associated with
  1194. notes, the first line of these notes will be added to the entry in the
  1195. agenda display."
  1196. :group 'org-agenda-daily/weekly
  1197. :type 'boolean)
  1198. (defcustom org-agenda-start-with-log-mode nil
  1199. "The initial value of log-mode in a newly created agenda window.
  1200. See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
  1201. explanations on the possible values."
  1202. :group 'org-agenda-startup
  1203. :group 'org-agenda-daily/weekly
  1204. :type '(choice (const :tag "Don't show log items" nil)
  1205. (const :tag "Show only log items" only)
  1206. (const :tag "Show all possible log items" clockcheck)
  1207. (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
  1208. (choice (const :tag "Show closed log items" closed)
  1209. (const :tag "Show clocked log items" clock)
  1210. (const :tag "Show all logged state changes" state)))))
  1211. (defcustom org-agenda-start-with-clockreport-mode nil
  1212. "The initial value of clockreport-mode in a newly created agenda window."
  1213. :group 'org-agenda-startup
  1214. :group 'org-agenda-daily/weekly
  1215. :type 'boolean)
  1216. (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
  1217. "Property list with parameters for the clocktable in clockreport mode.
  1218. This is the display mode that shows a clock table in the daily/weekly
  1219. agenda, the properties for this dynamic block can be set here.
  1220. The usual clocktable parameters are allowed here, but you cannot set
  1221. the properties :name, :tstart, :tend, :block, and :scope - these will
  1222. be overwritten to make sure the content accurately reflects the
  1223. current display in the agenda."
  1224. :group 'org-agenda-daily/weekly
  1225. :type 'plist)
  1226. (defcustom org-agenda-search-view-always-boolean nil
  1227. "Non-nil means the search string is interpreted as individual parts.
  1228. The search string for search view can either be interpreted as a phrase,
  1229. or as a list of snippets that define a boolean search for a number of
  1230. strings.
  1231. When this is non-nil, the string will be split on whitespace, and each
  1232. snippet will be searched individually, and all must match in order to
  1233. select an entry. A snippet is then a single string of non-white
  1234. characters, or a string in double quotes, or a regexp in {} braces.
  1235. If a snippet is preceded by \"-\", the snippet must *not* match.
  1236. \"+\" is syntactic sugar for positive selection. Each snippet may
  1237. be found as a full word or a partial word, but see the variable
  1238. `org-agenda-search-view-force-full-words'.
  1239. When this is nil, search will look for the entire search phrase as one,
  1240. with each space character matching any amount of whitespace, including
  1241. line breaks.
  1242. Even when this is nil, you can still switch to Boolean search dynamically
  1243. by preceding the first snippet with \"+\" or \"-\". If the first snippet
  1244. is a regexp marked with braces like \"{abc}\", this will also switch to
  1245. boolean search."
  1246. :group 'org-agenda-search-view
  1247. :version "24.1"
  1248. :type 'boolean)
  1249. (org-defvaralias 'org-agenda-search-view-search-words-only
  1250. 'org-agenda-search-view-always-boolean)
  1251. (defcustom org-agenda-search-view-force-full-words nil
  1252. "Non-nil means, search words must be matches as complete words.
  1253. When nil, they may also match part of a word."
  1254. :group 'org-agenda-search-view
  1255. :version "24.1"
  1256. :type 'boolean)
  1257. (defcustom org-agenda-search-view-max-outline-level 0
  1258. "Maximum outline level to display in search view.
  1259. E.g. when this is set to 1, the search view will only
  1260. show headlines of level 1. When set to 0, the default
  1261. value, don't limit agenda view by outline level."
  1262. :group 'org-agenda-search-view
  1263. :version "24.4"
  1264. :package-version '(Org . "8.3")
  1265. :type 'integer)
  1266. (defgroup org-agenda-time-grid nil
  1267. "Options concerning the time grid in the Org-mode Agenda."
  1268. :tag "Org Agenda Time Grid"
  1269. :group 'org-agenda)
  1270. (defcustom org-agenda-search-headline-for-time t
  1271. "Non-nil means search headline for a time-of-day.
  1272. If the headline contains a time-of-day in one format or another, it will
  1273. be used to sort the entry into the time sequence of items for a day.
  1274. Some people have time stamps in the headline that refer to the creation
  1275. time or so, and then this produces an unwanted side effect. If this is
  1276. the case for your, use this variable to turn off searching the headline
  1277. for a time."
  1278. :group 'org-agenda-time-grid
  1279. :type 'boolean)
  1280. (defcustom org-agenda-use-time-grid t
  1281. "Non-nil means show a time grid in the agenda schedule.
  1282. A time grid is a set of lines for specific times (like every two hours between
  1283. 8:00 and 20:00). The items scheduled for a day at specific times are
  1284. sorted in between these lines.
  1285. For details about when the grid will be shown, and what it will look like, see
  1286. the variable `org-agenda-time-grid'."
  1287. :group 'org-agenda-time-grid
  1288. :type 'boolean)
  1289. (defcustom org-agenda-time-grid
  1290. '((daily today require-timed)
  1291. "----------------"
  1292. (800 1000 1200 1400 1600 1800 2000))
  1293. "The settings for time grid for agenda display.
  1294. This is a list of three items. The first item is again a list. It contains
  1295. symbols specifying conditions when the grid should be displayed:
  1296. daily if the agenda shows a single day
  1297. weekly if the agenda shows an entire week
  1298. today show grid on current date, independent of daily/weekly display
  1299. require-timed show grid only if at least one item has a time specification
  1300. remove-match skip grid times already present in an entry
  1301. The second item is a string which will be placed behind the grid time.
  1302. The third item is a list of integers, indicating the times that should have
  1303. a grid line."
  1304. :group 'org-agenda-time-grid
  1305. :type
  1306. '(list
  1307. (set :greedy t :tag "Grid Display Options"
  1308. (const :tag "Show grid in single day agenda display" daily)
  1309. (const :tag "Show grid in weekly agenda display" weekly)
  1310. (const :tag "Always show grid for today" today)
  1311. (const :tag "Show grid only if any timed entries are present"
  1312. require-timed)
  1313. (const :tag "Skip grid times already present in an entry"
  1314. remove-match))
  1315. (string :tag "Grid String")
  1316. (repeat :tag "Grid Times" (integer :tag "Time"))))
  1317. (defcustom org-agenda-show-current-time-in-grid t
  1318. "Non-nil means show the current time in the time grid."
  1319. :group 'org-agenda-time-grid
  1320. :version "24.1"
  1321. :type 'boolean)
  1322. (defcustom org-agenda-current-time-string
  1323. "now - - - - - - - - - - - - - - - - - - - - - - - - -"
  1324. "The string for the current time marker in the agenda."
  1325. :group 'org-agenda-time-grid
  1326. :version "24.1"
  1327. :type 'string)
  1328. (defgroup org-agenda-sorting nil
  1329. "Options concerning sorting in the Org-mode Agenda."
  1330. :tag "Org Agenda Sorting"
  1331. :group 'org-agenda)
  1332. (defcustom org-agenda-sorting-strategy
  1333. '((agenda habit-down time-up priority-down category-keep)
  1334. (todo priority-down category-keep)
  1335. (tags priority-down category-keep)
  1336. (search category-keep))
  1337. "Sorting structure for the agenda items of a single day.
  1338. This is a list of symbols which will be used in sequence to determine
  1339. if an entry should be listed before another entry. The following
  1340. symbols are recognized:
  1341. time-up Put entries with time-of-day indications first, early first
  1342. time-down Put entries with time-of-day indications first, late first
  1343. timestamp-up Sort by any timestamp, early first
  1344. timestamp-down Sort by any timestamp, late first
  1345. scheduled-up Sort by scheduled timestamp, early first
  1346. scheduled-down Sort by scheduled timestamp, late first
  1347. deadline-up Sort by deadline timestamp, early first
  1348. deadline-down Sort by deadline timestamp, late first
  1349. ts-up Sort by active timestamp, early first
  1350. ts-down Sort by active timestamp, late first
  1351. tsia-up Sort by inactive timestamp, early first
  1352. tsia-down Sort by inactive timestamp, late first
  1353. category-keep Keep the default order of categories, corresponding to the
  1354. sequence in `org-agenda-files'.
  1355. category-up Sort alphabetically by category, A-Z.
  1356. category-down Sort alphabetically by category, Z-A.
  1357. tag-up Sort alphabetically by last tag, A-Z.
  1358. tag-down Sort alphabetically by last tag, Z-A.
  1359. priority-up Sort numerically by priority, high priority last.
  1360. priority-down Sort numerically by priority, high priority first.
  1361. todo-state-up Sort by todo state, tasks that are done last.
  1362. todo-state-down Sort by todo state, tasks that are done first.
  1363. effort-up Sort numerically by estimated effort, high effort last.
  1364. effort-down Sort numerically by estimated effort, high effort first.
  1365. user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
  1366. user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
  1367. habit-up Put entries that are habits first
  1368. habit-down Put entries that are habits last
  1369. alpha-up Sort headlines alphabetically
  1370. alpha-down Sort headlines alphabetically, reversed
  1371. The different possibilities will be tried in sequence, and testing stops
  1372. if one comparison returns a \"not-equal\". For example, the default
  1373. '(time-up category-keep priority-down)
  1374. means: Pull out all entries having a specified time of day and sort them,
  1375. in order to make a time schedule for the current day the first thing in the
  1376. agenda listing for the day. Of the entries without a time indication, keep
  1377. the grouped in categories, don't sort the categories, but keep them in
  1378. the sequence given in `org-agenda-files'. Within each category sort by
  1379. priority.
  1380. Leaving out `category-keep' would mean that items will be sorted across
  1381. categories by priority.
  1382. Instead of a single list, this can also be a set of list for specific
  1383. contents, with a context symbol in the car of the list, any of
  1384. `agenda', `todo', `tags', `search' for the corresponding agenda views.
  1385. Custom commands can bind this variable in the options section."
  1386. :group 'org-agenda-sorting
  1387. :type `(choice
  1388. (repeat :tag "General" ,org-sorting-choice)
  1389. (list :tag "Individually"
  1390. (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
  1391. (repeat ,org-sorting-choice))
  1392. (cons (const :tag "Strategy for TODO lists" todo)
  1393. (repeat ,org-sorting-choice))
  1394. (cons (const :tag "Strategy for Tags matches" tags)
  1395. (repeat ,org-sorting-choice))
  1396. (cons (const :tag "Strategy for search matches" search)
  1397. (repeat ,org-sorting-choice)))))
  1398. (defcustom org-agenda-cmp-user-defined nil
  1399. "A function to define the comparison `user-defined'.
  1400. This function must receive two arguments, agenda entry a and b.
  1401. If a>b, return +1. If a<b, return -1. If they are equal as seen by
  1402. the user comparison, return nil.
  1403. When this is defined, you can make `user-defined-up' and `user-defined-down'
  1404. part of an agenda sorting strategy."
  1405. :group 'org-agenda-sorting
  1406. :type 'symbol)
  1407. (defcustom org-sort-agenda-notime-is-late t
  1408. "Non-nil means items without time are considered late.
  1409. This is only relevant for sorting. When t, items which have no explicit
  1410. time like 15:30 will be considered as 99:01, i.e. later than any items which
  1411. do have a time. When nil, the default time is before 0:00. You can use this
  1412. option to decide if the schedule for today should come before or after timeless
  1413. agenda entries."
  1414. :group 'org-agenda-sorting
  1415. :type 'boolean)
  1416. (defcustom org-sort-agenda-noeffort-is-high t
  1417. "Non-nil means items without effort estimate are sorted as high effort.
  1418. This also applies when filtering an agenda view with respect to the
  1419. < or > effort operator. Then, tasks with no effort defined will be treated
  1420. as tasks with high effort.
  1421. When nil, such items are sorted as 0 minutes effort."
  1422. :group 'org-agenda-sorting
  1423. :type 'boolean)
  1424. (defgroup org-agenda-line-format nil
  1425. "Options concerning the entry prefix in the Org-mode agenda display."
  1426. :tag "Org Agenda Line Format"
  1427. :group 'org-agenda)
  1428. (defcustom org-agenda-prefix-format
  1429. '((agenda . " %i %-12:c%?-12t% s")
  1430. (timeline . " % s")
  1431. (todo . " %i %-12:c")
  1432. (tags . " %i %-12:c")
  1433. (search . " %i %-12:c"))
  1434. "Format specifications for the prefix of items in the agenda views.
  1435. An alist with five entries, each for the different agenda types. The
  1436. keys of the sublists are `agenda', `timeline', `todo', `search' and `tags'.
  1437. The values are format strings.
  1438. This format works similar to a printf format, with the following meaning:
  1439. %c the category of the item, \"Diary\" for entries from the diary,
  1440. or as given by the CATEGORY keyword or derived from the file name
  1441. %e the effort required by the item
  1442. %l the level of the item (insert X space(s) if item is of level X)
  1443. %i the icon category of the item, see `org-agenda-category-icon-alist'
  1444. %T the last tag of the item (ignore inherited tags, which come first)
  1445. %t the HH:MM time-of-day specification if one applies to the entry
  1446. %s Scheduling/Deadline information, a short string
  1447. %b show breadcrumbs, i.e., the names of the higher levels
  1448. %(expression) Eval EXPRESSION and replace the control string
  1449. by the result
  1450. All specifiers work basically like the standard `%s' of printf, but may
  1451. contain two additional characters: a question mark just after the `%'
  1452. and a whitespace/punctuation character just before the final letter.
  1453. If the first character after `%' is a question mark, the entire field
  1454. will only be included if the corresponding value applies to the current
  1455. entry. This is useful for fields which should have fixed width when
  1456. present, but zero width when absent. For example, \"%?-12t\" will
  1457. result in a 12 character time field if a time of the day is specified,
  1458. but will completely disappear in entries which do not contain a time.
  1459. If there is punctuation or whitespace character just before the
  1460. final format letter, this character will be appended to the field
  1461. value if the value is not empty. For example, the format
  1462. \"%-12:c\" leads to \"Diary: \" if the category is \"Diary\". If
  1463. the category is empty, no additional colon is inserted.
  1464. The default value for the agenda sublist is \" %-12:c%?-12t% s\",
  1465. which means:
  1466. - Indent the line with two space characters
  1467. - Give the category a 12 chars wide field, padded with whitespace on
  1468. the right (because of `-'). Append a colon if there is a category
  1469. (because of `:').
  1470. - If there is a time-of-day, put it into a 12 chars wide field. If no
  1471. time, don't put in an empty field, just skip it (because of '?').
  1472. - Finally, put the scheduling information.
  1473. See also the variables `org-agenda-remove-times-when-in-prefix' and
  1474. `org-agenda-remove-tags'.
  1475. Custom commands can set this variable in the options section."
  1476. :type '(choice
  1477. (string :tag "General format")
  1478. (list :greedy t :tag "View dependent"
  1479. (cons (const agenda) (string :tag "Format"))
  1480. (cons (const timeline) (string :tag "Format"))
  1481. (cons (const todo) (string :tag "Format"))
  1482. (cons (const tags) (string :tag "Format"))
  1483. (cons (const search) (string :tag "Format"))))
  1484. :group 'org-agenda-line-format)
  1485. (defvar org-prefix-format-compiled nil
  1486. "The compiled prefix format and associated variables.
  1487. This is a list where first element is a list of variable bindings, and second
  1488. element is the compiled format expression. See the variable
  1489. `org-agenda-prefix-format'.")
  1490. (defcustom org-agenda-todo-keyword-format "%-1s"
  1491. "Format for the TODO keyword in agenda lines.
  1492. Set this to something like \"%-12s\" if you want all TODO keywords
  1493. to occupy a fixed space in the agenda display."
  1494. :group 'org-agenda-line-format
  1495. :type 'string)
  1496. (defcustom org-agenda-diary-sexp-prefix nil
  1497. "A regexp that matches part of a diary sexp entry
  1498. which should be treated as scheduling/deadline information in
  1499. `org-agenda'.
  1500. For example, you can use this to extract the `diary-remind-message' from
  1501. `diary-remind' entries."
  1502. :group 'org-agenda-line-format
  1503. :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
  1504. (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
  1505. "Text preceding timerange entries in the agenda view.
  1506. This is a list with two strings. The first applies when the range
  1507. is entirely on one day. The second applies if the range spans several days.
  1508. The strings may have two \"%d\" format specifiers which will be filled
  1509. with the sequence number of the days, and the total number of days in the
  1510. range, respectively."
  1511. :group 'org-agenda-line-format
  1512. :type '(list
  1513. (string :tag "Deadline today ")
  1514. (choice :tag "Deadline relative"
  1515. (string :tag "Format string")
  1516. (function))))
  1517. (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
  1518. "Text preceding scheduled items in the agenda view.
  1519. This is a list with two strings. The first applies when the item is
  1520. scheduled on the current day. The second applies when it has been scheduled
  1521. previously, it may contain a %d indicating that this is the nth time that
  1522. this item is scheduled, due to automatic rescheduling of unfinished items
  1523. for the following day. So this number is one larger than the number of days
  1524. that passed since this item was scheduled first."
  1525. :group 'org-agenda-line-format
  1526. :version "24.4"
  1527. :package-version '(Org . "8.0")
  1528. :type '(list
  1529. (string :tag "Scheduled today ")
  1530. (string :tag "Scheduled previously")))
  1531. (defcustom org-agenda-inactive-leader "["
  1532. "Text preceding item pulled into the agenda by inactive time stamps.
  1533. These entries are added to the agenda when pressing \"[\"."
  1534. :group 'org-agenda-line-format
  1535. :version "24.1"
  1536. :type 'string)
  1537. (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: " "%2d d. ago: ")
  1538. "Text preceding deadline items in the agenda view.
  1539. This is a list with three strings. The first applies when the item has its
  1540. deadline on the current day. The second applies when the deadline is in the
  1541. future, the third one when it is in the past. The strings may contain %d
  1542. to capture the number of days."
  1543. :group 'org-agenda-line-format
  1544. :version "24.4"
  1545. :package-version '(Org . "8.0")
  1546. :type '(list
  1547. (string :tag "Deadline today ")
  1548. (string :tag "Deadline in the future ")
  1549. (string :tag "Deadline in the past ")))
  1550. (defcustom org-agenda-remove-times-when-in-prefix t
  1551. "Non-nil means remove duplicate time specifications in agenda items.
  1552. When the format `org-agenda-prefix-format' contains a `%t' specifier, a
  1553. time-of-day specification in a headline or diary entry is extracted and
  1554. placed into the prefix. If this option is non-nil, the original specification
  1555. \(a timestamp or -range, or just a plain time(range) specification like
  1556. 11:30-4pm) will be removed for agenda display. This makes the agenda less
  1557. cluttered.
  1558. The option can be t or nil. It may also be the symbol `beg', indicating
  1559. that the time should only be removed when it is located at the beginning of
  1560. the headline/diary entry."
  1561. :group 'org-agenda-line-format
  1562. :type '(choice
  1563. (const :tag "Always" t)
  1564. (const :tag "Never" nil)
  1565. (const :tag "When at beginning of entry" beg)))
  1566. (defcustom org-agenda-remove-timeranges-from-blocks nil
  1567. "Non-nil means remove time ranges specifications in agenda
  1568. items that span on several days."
  1569. :group 'org-agenda-line-format
  1570. :version "24.1"
  1571. :type 'boolean)
  1572. (defcustom org-agenda-default-appointment-duration nil
  1573. "Default duration for appointments that only have a starting time.
  1574. When nil, no duration is specified in such cases.
  1575. When non-nil, this must be the number of minutes, e.g. 60 for one hour."
  1576. :group 'org-agenda-line-format
  1577. :type '(choice
  1578. (integer :tag "Minutes")
  1579. (const :tag "No default duration")))
  1580. (defcustom org-agenda-show-inherited-tags t
  1581. "Non-nil means show inherited tags in each agenda line.
  1582. When this option is set to `always', it take precedences over
  1583. `org-agenda-use-tag-inheritance' and inherited tags are shown
  1584. in every agenda.
  1585. When this option is set to t (the default), inherited tags are
  1586. shown when they are available, i.e. when the value of
  1587. `org-agenda-use-tag-inheritance' has been taken into account.
  1588. This can be set to a list of agenda types in which the agenda
  1589. must display the inherited tags. Available types are `todo',
  1590. `agenda', `search' and `timeline'.
  1591. When set to nil, never show inherited tags in agenda lines."
  1592. :group 'org-agenda-line-format
  1593. :group 'org-agenda
  1594. :version "24.3"
  1595. :type '(choice
  1596. (const :tag "Show inherited tags when available" t)
  1597. (const :tag "Always show inherited tags" always)
  1598. (repeat :tag "Show inherited tags only in selected agenda types"
  1599. (symbol :tag "Agenda type"))))
  1600. (defcustom org-agenda-use-tag-inheritance '(todo search timeline agenda)
  1601. "List of agenda view types where to use tag inheritance.
  1602. In tags/tags-todo/tags-tree agenda views, tag inheritance is
  1603. controlled by `org-use-tag-inheritance'. In other agenda types,
  1604. `org-use-tag-inheritance' is not used for the selection of the
  1605. agenda entries. Still, you may want the agenda to be aware of
  1606. the inherited tags anyway, e.g. for later tag filtering.
  1607. Allowed value are `todo', `search', `timeline' and `agenda'.
  1608. This variable has no effect if `org-agenda-show-inherited-tags'
  1609. is set to `always'. In that case, the agenda is aware of those
  1610. tags.
  1611. The default value sets tags in every agenda type. Setting this
  1612. option to nil will speed up non-tags agenda view a lot."
  1613. :group 'org-agenda
  1614. :version "24.3"
  1615. :type '(choice
  1616. (const :tag "Use tag inheritance in all agenda types" t)
  1617. (repeat :tag "Use tag inheritance in selected agenda types"
  1618. (symbol :tag "Agenda type"))))
  1619. (defcustom org-agenda-hide-tags-regexp nil
  1620. "Regular expression used to filter away specific tags in agenda views.
  1621. This means that these tags will be present, but not be shown in the agenda
  1622. line. Secondary filtering will still work on the hidden tags.
  1623. Nil means don't hide any tags."
  1624. :group 'org-agenda-line-format
  1625. :type '(choice
  1626. (const :tag "Hide none" nil)
  1627. (string :tag "Regexp ")))
  1628. (defcustom org-agenda-remove-tags nil
  1629. "Non-nil means remove the tags from the headline copy in the agenda.
  1630. When this is the symbol `prefix', only remove tags when
  1631. `org-agenda-prefix-format' contains a `%T' specifier."
  1632. :group 'org-agenda-line-format
  1633. :type '(choice
  1634. (const :tag "Always" t)
  1635. (const :tag "Never" nil)
  1636. (const :tag "When prefix format contains %T" prefix)))
  1637. (org-defvaralias 'org-agenda-remove-tags-when-in-prefix
  1638. 'org-agenda-remove-tags)
  1639. (defcustom org-agenda-tags-column (if (featurep 'xemacs) -79 -80)
  1640. "Shift tags in agenda items to this column.
  1641. If this number is positive, it specifies the column. If it is negative,
  1642. it means that the tags should be flushright to that column. For example,
  1643. -80 works well for a normal 80 character screen."
  1644. :group 'org-agenda-line-format
  1645. :type 'integer)
  1646. (org-defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column)
  1647. (defcustom org-agenda-fontify-priorities 'cookies
  1648. "Non-nil means highlight low and high priorities in agenda.
  1649. When t, the highest priority entries are bold, lowest priority italic.
  1650. However, settings in `org-priority-faces' will overrule these faces.
  1651. When this variable is the symbol `cookies', only fontify the
  1652. cookies, not the entire task.
  1653. This may also be an association list of priority faces, whose
  1654. keys are the character values of `org-highest-priority',
  1655. `org-default-priority', and `org-lowest-priority' (the default values
  1656. are ?A, ?B, and ?C, respectively). The face may be a named face, a
  1657. color as a string, or a list like `(:background \"Red\")'.
  1658. If it is a color, the variable `org-faces-easy-properties'
  1659. determines if it is a foreground or a background color."
  1660. :group 'org-agenda-line-format
  1661. :type '(choice
  1662. (const :tag "Never" nil)
  1663. (const :tag "Defaults" t)
  1664. (const :tag "Cookies only" cookies)
  1665. (repeat :tag "Specify"
  1666. (list (character :tag "Priority" :value ?A)
  1667. (choice :tag "Face "
  1668. (string :tag "Color")
  1669. (sexp :tag "Face"))))))
  1670. (defcustom org-agenda-day-face-function nil
  1671. "Function called to determine what face should be used to display a day.
  1672. The only argument passed to that function is the day. It should
  1673. returns a face, or nil if does not want to specify a face and let
  1674. the normal rules apply."
  1675. :group 'org-agenda-line-format
  1676. :version "24.1"
  1677. :type '(choice (const nil) (function)))
  1678. (defcustom org-agenda-category-icon-alist nil
  1679. "Alist of category icon to be displayed in agenda views.
  1680. Each entry should have the following format:
  1681. (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
  1682. Where CATEGORY-REGEXP is a regexp matching the categories where
  1683. the icon should be displayed.
  1684. FILE-OR-DATA either a file path or a string containing image data.
  1685. The other fields can be omitted safely if not needed:
  1686. TYPE indicates the image type.
  1687. DATA-P is a boolean indicating whether the FILE-OR-DATA string is
  1688. image data.
  1689. PROPS are additional image attributes to assign to the image,
  1690. like, e.g. `:ascent center'.
  1691. (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
  1692. If you want to set the display properties yourself, just put a
  1693. list as second element:
  1694. (CATEGORY-REGEXP (MY PROPERTY LIST))
  1695. For example, to display a 16px horizontal space for Emacs
  1696. category, you can use:
  1697. (\"Emacs\" \\='(space . (:width (16))))"
  1698. :group 'org-agenda-line-format
  1699. :version "24.1"
  1700. :type '(alist :key-type (string :tag "Regexp matching category")
  1701. :value-type (choice (list :tag "Icon"
  1702. (string :tag "File or data")
  1703. (symbol :tag "Type")
  1704. (boolean :tag "Data?")
  1705. (repeat :tag "Extra image properties" :inline t symbol))
  1706. (list :tag "Display properties" sexp))))
  1707. (defgroup org-agenda-column-view nil
  1708. "Options concerning column view in the agenda."
  1709. :tag "Org Agenda Column View"
  1710. :group 'org-agenda)
  1711. (defcustom org-agenda-columns-show-summaries t
  1712. "Non-nil means show summaries for columns displayed in the agenda view."
  1713. :group 'org-agenda-column-view
  1714. :type 'boolean)
  1715. (defcustom org-agenda-columns-compute-summary-properties t
  1716. "Non-nil means recompute all summary properties before column view.
  1717. When column view in the agenda is listing properties that have a summary
  1718. operator, it can go to all relevant buffers and recompute the summaries
  1719. there. This can mean overhead for the agenda column view, but is necessary
  1720. to have thing up to date.
  1721. As a special case, a CLOCKSUM property also makes sure that the clock
  1722. computations are current."
  1723. :group 'org-agenda-column-view
  1724. :type 'boolean)
  1725. (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
  1726. "Non-nil means the duration of an appointment will add to day effort.
  1727. The property to which appointment durations will be added is the one given
  1728. in the option `org-effort-property'. If an appointment does not have
  1729. an end time, `org-agenda-default-appointment-duration' will be used. If that
  1730. is not set, an appointment without end time will not contribute to the time
  1731. estimate."
  1732. :group 'org-agenda-column-view
  1733. :type 'boolean)
  1734. (defcustom org-agenda-auto-exclude-function nil
  1735. "A function called with a tag to decide if it is filtered on \
  1736. \\<org-agenda-mode-map>`\\[org-agenda-filter-by-tag] RET'.
  1737. The sole argument to the function, which is called once for each
  1738. possible tag, is a string giving the name of the tag. The
  1739. function should return either nil if the tag should be included
  1740. as normal, or \"-<TAG>\" to exclude the tag.
  1741. Note that for the purpose of tag filtering, only the lower-case version of
  1742. all tags will be considered, so that this function will only ever see
  1743. the lower-case version of all tags."
  1744. :group 'org-agenda
  1745. :type '(choice (const nil) (function)))
  1746. (defcustom org-agenda-bulk-custom-functions nil
  1747. "Alist of characters and custom functions for bulk actions.
  1748. For example, this value makes those two functions available:
  1749. \\='((?R set-category)
  1750. (?C bulk-cut))
  1751. With selected entries in an agenda buffer, `B R' will call
  1752. the custom function `set-category' on the selected entries.
  1753. Note that functions in this alist don't need to be quoted."
  1754. :type '(alist :key-type character :value-type (group function))
  1755. :version "24.1"
  1756. :group 'org-agenda)
  1757. (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
  1758. "Execute BODY with point at location given by `org-hd-marker' property.
  1759. If STRING is non-nil, the text property will be fetched from position 0
  1760. in that string. If STRING is nil, it will be fetched from the beginning
  1761. of the current line."
  1762. (org-with-gensyms (marker)
  1763. `(let ((,marker (get-text-property (if ,string 0 (point-at-bol))
  1764. 'org-hd-marker ,string)))
  1765. (with-current-buffer (marker-buffer ,marker)
  1766. (save-excursion
  1767. (goto-char ,marker)
  1768. ,@body)))))
  1769. (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
  1770. (defun org-add-agenda-custom-command (entry)
  1771. "Replace or add a command in `org-agenda-custom-commands'.
  1772. This is mostly for hacking and trying a new command - once the command
  1773. works you probably want to add it to `org-agenda-custom-commands' for good."
  1774. (let ((ass (assoc (car entry) org-agenda-custom-commands)))
  1775. (if ass
  1776. (setcdr ass (cdr entry))
  1777. (push entry org-agenda-custom-commands))))
  1778. ;;; Define the org-agenda-mode
  1779. (defvar org-agenda-mode-map (make-sparse-keymap)
  1780. "Keymap for `org-agenda-mode'.")
  1781. (org-defvaralias 'org-agenda-keymap 'org-agenda-mode-map)
  1782. (defvar org-agenda-menu) ; defined later in this file.
  1783. (defvar org-agenda-restrict nil) ; defined later in this file.
  1784. (defvar org-agenda-follow-mode nil)
  1785. (defvar org-agenda-entry-text-mode nil)
  1786. (defvar org-agenda-clockreport-mode nil)
  1787. (defvar org-agenda-show-log nil)
  1788. (defvar org-agenda-redo-command nil)
  1789. (defvar org-agenda-query-string nil)
  1790. (defvar org-agenda-mode-hook nil
  1791. "Hook run after `org-agenda-mode' is turned on.
  1792. The buffer is still writable when this hook is called.")
  1793. (defvar org-agenda-type nil)
  1794. (defvar org-agenda-force-single-file nil)
  1795. (defvar org-agenda-bulk-marked-entries nil
  1796. "List of markers that refer to marked entries in the agenda.")
  1797. ;;; Multiple agenda buffers support
  1798. (defcustom org-agenda-sticky nil
  1799. "Non-nil means agenda q key will bury agenda buffers.
  1800. Agenda commands will then show existing buffer instead of generating new ones.
  1801. When nil, `q' will kill the single agenda buffer."
  1802. :group 'org-agenda
  1803. :version "24.3"
  1804. :type 'boolean)
  1805. ;;;###autoload
  1806. (defun org-toggle-sticky-agenda (&optional arg)
  1807. "Toggle `org-agenda-sticky'."
  1808. (interactive "P")
  1809. (let ((new-value (if arg
  1810. (> (prefix-numeric-value arg) 0)
  1811. (not org-agenda-sticky))))
  1812. (if (equal new-value org-agenda-sticky)
  1813. (and (org-called-interactively-p 'interactive)
  1814. (message "Sticky agenda was already %s"
  1815. (if org-agenda-sticky "enabled" "disabled")))
  1816. (setq org-agenda-sticky new-value)
  1817. (org-agenda-kill-all-agenda-buffers)
  1818. (and (org-called-interactively-p 'interactive)
  1819. (message "Sticky agenda %s"
  1820. (if org-agenda-sticky "enabled" "disabled"))))))
  1821. (defvar org-agenda-buffer nil
  1822. "Agenda buffer currently being generated.")
  1823. (defvar org-agenda-last-prefix-arg nil)
  1824. (defvar org-agenda-this-buffer-name nil)
  1825. (defvar org-agenda-doing-sticky-redo nil)
  1826. (defvar org-agenda-this-buffer-is-sticky nil)
  1827. (defvar org-agenda-last-indirect-buffer nil
  1828. "Last buffer loaded by `org-agenda-tree-to-indirect-buffer'.")
  1829. (defconst org-agenda-local-vars
  1830. '(org-agenda-this-buffer-name
  1831. org-agenda-undo-list
  1832. org-agenda-pending-undo-list
  1833. org-agenda-follow-mode
  1834. org-agenda-entry-text-mode
  1835. org-agenda-clockreport-mode
  1836. org-agenda-show-log
  1837. org-agenda-redo-command
  1838. org-agenda-query-string
  1839. org-agenda-type
  1840. org-agenda-bulk-marked-entries
  1841. org-agenda-undo-has-started-in
  1842. org-agenda-info
  1843. org-agenda-pre-window-conf
  1844. org-agenda-columns-active
  1845. org-agenda-tag-filter
  1846. org-agenda-category-filter
  1847. org-agenda-top-headline-filter
  1848. org-agenda-regexp-filter
  1849. org-agenda-effort-filter
  1850. org-agenda-markers
  1851. org-agenda-last-search-view-search-was-boolean
  1852. org-agenda-last-indirect-buffer
  1853. org-agenda-filtered-by-category
  1854. org-agenda-filter-form
  1855. org-agenda-cycle-counter
  1856. org-agenda-last-prefix-arg)
  1857. "Variables that must be local in agenda buffers to allow multiple buffers.")
  1858. (defun org-agenda-mode ()
  1859. "Mode for time-sorted view on action items in Org-mode files.
  1860. The following commands are available:
  1861. \\{org-agenda-mode-map}"
  1862. (interactive)
  1863. (cond (org-agenda-doing-sticky-redo
  1864. ;; Refreshing sticky agenda-buffer
  1865. ;;
  1866. ;; Preserve the value of `org-agenda-local-vars' variables,
  1867. ;; while letting `kill-all-local-variables' kill the rest
  1868. (let ((save (buffer-local-variables)))
  1869. (kill-all-local-variables)
  1870. (mapc 'make-local-variable org-agenda-local-vars)
  1871. (dolist (elem save)
  1872. (let ((var (car elem))
  1873. (val (cdr elem)))
  1874. (when (and val
  1875. (member var org-agenda-local-vars))
  1876. (set var val)))))
  1877. (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
  1878. (org-agenda-sticky
  1879. ;; Creating a sticky Agenda buffer for the first time
  1880. (kill-all-local-variables)
  1881. (mapc 'make-local-variable org-agenda-local-vars)
  1882. (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
  1883. (t
  1884. ;; Creating a non-sticky agenda buffer
  1885. (kill-all-local-variables)
  1886. (set (make-local-variable 'org-agenda-this-buffer-is-sticky) nil)))
  1887. (setq org-agenda-undo-list nil
  1888. org-agenda-pending-undo-list nil
  1889. org-agenda-bulk-marked-entries nil)
  1890. (setq major-mode 'org-agenda-mode)
  1891. ;; Keep global-font-lock-mode from turning on font-lock-mode
  1892. (org-set-local 'font-lock-global-modes (list 'not major-mode))
  1893. (setq mode-name "Org-Agenda")
  1894. (setq indent-tabs-mode nil)
  1895. (use-local-map org-agenda-mode-map)
  1896. (easy-menu-add org-agenda-menu)
  1897. (if org-startup-truncated (setq truncate-lines t))
  1898. (org-set-local 'line-move-visual nil)
  1899. (org-add-hook 'post-command-hook 'org-agenda-update-agenda-type nil 'local)
  1900. (org-add-hook 'pre-command-hook 'org-unhighlight nil 'local)
  1901. ;; Make sure properties are removed when copying text
  1902. (org-add-hook 'filter-buffer-substring-functions
  1903. (lambda (fun start end delete)
  1904. (substring-no-properties (funcall fun start end delete)))
  1905. nil t)
  1906. (unless org-agenda-keep-modes
  1907. (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
  1908. org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode))
  1909. (setq org-agenda-show-log org-agenda-start-with-log-mode)
  1910. (setq org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode)
  1911. (add-to-invisibility-spec '(org-filtered))
  1912. (add-to-invisibility-spec '(org-link))
  1913. (easy-menu-change
  1914. '("Agenda") "Agenda Files"
  1915. (append
  1916. (list
  1917. (vector
  1918. (if (get 'org-agenda-files 'org-restrict)
  1919. "Restricted to single file"
  1920. "Edit File List")
  1921. '(org-edit-agenda-file-list)
  1922. (not (get 'org-agenda-files 'org-restrict)))
  1923. "--")
  1924. (mapcar 'org-file-menu-entry (org-agenda-files))))
  1925. (org-agenda-set-mode-name)
  1926. (apply
  1927. (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
  1928. (list 'org-agenda-mode-hook)))
  1929. (substitute-key-definition 'undo 'org-agenda-undo
  1930. org-agenda-mode-map global-map)
  1931. (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
  1932. (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
  1933. (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
  1934. (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
  1935. (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
  1936. (org-defkey org-agenda-mode-map [(meta down)] 'org-agenda-drag-line-forward)
  1937. (org-defkey org-agenda-mode-map [(meta up)] 'org-agenda-drag-line-backward)
  1938. (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
  1939. (org-defkey org-agenda-mode-map "\M-m" 'org-agenda-bulk-toggle)
  1940. (org-defkey org-agenda-mode-map "*" 'org-agenda-bulk-mark-all)
  1941. (org-defkey org-agenda-mode-map "\M-*" 'org-agenda-bulk-toggle-all)
  1942. (org-defkey org-agenda-mode-map "#" 'org-agenda-dim-blocked-tasks)
  1943. (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
  1944. (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
  1945. (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-unmark-all)
  1946. (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
  1947. (org-defkey org-agenda-mode-map "k" 'org-agenda-capture)
  1948. (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
  1949. (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
  1950. (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
  1951. (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
  1952. (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
  1953. (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
  1954. (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
  1955. (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
  1956. (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
  1957. (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
  1958. (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
  1959. (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
  1960. (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
  1961. (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
  1962. (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
  1963. (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
  1964. (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
  1965. (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
  1966. (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
  1967. (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
  1968. (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
  1969. (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
  1970. (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
  1971. (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
  1972. (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
  1973. (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
  1974. (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
  1975. (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
  1976. (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
  1977. (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
  1978. (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
  1979. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
  1980. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
  1981. (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
  1982. (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
  1983. (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
  1984. (let ((l '(1 2 3 4 5 6 7 8 9 0)))
  1985. (while l (org-defkey org-agenda-mode-map
  1986. (int-to-string (pop l)) 'digit-argument)))
  1987. (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
  1988. (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
  1989. (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
  1990. (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
  1991. (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
  1992. (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
  1993. (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
  1994. (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
  1995. (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
  1996. (org-defkey org-agenda-mode-map "g" (lambda () (interactive) (org-agenda-redo t)))
  1997. (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
  1998. (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
  1999. (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
  2000. 'org-clock-modify-effort-estimate)
  2001. (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
  2002. (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
  2003. (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
  2004. (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
  2005. (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
  2006. (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
  2007. (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
  2008. (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
  2009. (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
  2010. (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
  2011. (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
  2012. (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
  2013. (substitute-key-definition 'next-line 'org-agenda-next-line
  2014. org-agenda-mode-map global-map)
  2015. (substitute-key-definition 'previous-line 'org-agenda-previous-line
  2016. org-agenda-mode-map global-map)
  2017. (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
  2018. (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
  2019. (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
  2020. (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
  2021. (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
  2022. (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
  2023. (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
  2024. (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
  2025. (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
  2026. (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
  2027. (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
  2028. (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
  2029. (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
  2030. (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
  2031. (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
  2032. (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
  2033. (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
  2034. (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
  2035. (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  2036. (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
  2037. (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
  2038. (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
  2039. (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
  2040. (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
  2041. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
  2042. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
  2043. (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
  2044. (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
  2045. (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
  2046. (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  2047. (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
  2048. (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
  2049. (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
  2050. (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
  2051. (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
  2052. (org-defkey org-agenda-mode-map "_" 'org-agenda-filter-by-effort)
  2053. (org-defkey org-agenda-mode-map "=" 'org-agenda-filter-by-regexp)
  2054. (org-defkey org-agenda-mode-map "|" 'org-agenda-filter-remove-all)
  2055. (org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag-refine)
  2056. (org-defkey org-agenda-mode-map "~" 'org-agenda-limit-interactively)
  2057. (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
  2058. (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-headline)
  2059. (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
  2060. (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
  2061. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  2062. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  2063. (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
  2064. (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
  2065. (define-key org-agenda-mode-map [remap forward-paragraph] 'org-agenda-forward-block)
  2066. (define-key org-agenda-mode-map [remap backward-paragraph] 'org-agenda-backward-block)
  2067. (when org-agenda-mouse-1-follows-link
  2068. (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
  2069. (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
  2070. '("Agenda"
  2071. ("Agenda Files")
  2072. "--"
  2073. ("Agenda Dates"
  2074. ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
  2075. ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
  2076. ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
  2077. ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
  2078. "--"
  2079. ("View"
  2080. ["Day View" org-agenda-day-view
  2081. :active (org-agenda-check-type nil 'agenda)
  2082. :style radio :selected (eq org-agenda-current-span 'day)
  2083. :keys "v d (or just d)"]
  2084. ["Week View" org-agenda-week-view
  2085. :active (org-agenda-check-type nil 'agenda)
  2086. :style radio :selected (eq org-agenda-current-span 'week)
  2087. :keys "v w"]
  2088. ["Fortnight View" org-agenda-fortnight-view
  2089. :active (org-agenda-check-type nil 'agenda)
  2090. :style radio :selected (eq org-agenda-current-span 'fortnight)
  2091. :keys "v f"]
  2092. ["Month View" org-agenda-month-view
  2093. :active (org-agenda-check-type nil 'agenda)
  2094. :style radio :selected (eq org-agenda-current-span 'month)
  2095. :keys "v m"]
  2096. ["Year View" org-agenda-year-view
  2097. :active (org-agenda-check-type nil 'agenda)
  2098. :style radio :selected (eq org-agenda-current-span 'year)
  2099. :keys "v y"]
  2100. "--"
  2101. ["Include Diary" org-agenda-toggle-diary
  2102. :style toggle :selected org-agenda-include-diary
  2103. :active (org-agenda-check-type nil 'agenda)]
  2104. ["Include Deadlines" org-agenda-toggle-deadlines
  2105. :style toggle :selected org-agenda-include-deadlines
  2106. :active (org-agenda-check-type nil 'agenda)]
  2107. ["Use Time Grid" org-agenda-toggle-time-grid
  2108. :style toggle :selected org-agenda-use-time-grid
  2109. :active (org-agenda-check-type nil 'agenda)]
  2110. "--"
  2111. ["Show clock report" org-agenda-clockreport-mode
  2112. :style toggle :selected org-agenda-clockreport-mode
  2113. :active (org-agenda-check-type nil 'agenda)]
  2114. ["Show some entry text" org-agenda-entry-text-mode
  2115. :style toggle :selected org-agenda-entry-text-mode
  2116. :active t]
  2117. "--"
  2118. ["Show Logbook entries" org-agenda-log-mode
  2119. :style toggle :selected org-agenda-show-log
  2120. :active (org-agenda-check-type nil 'agenda 'timeline)
  2121. :keys "v l (or just l)"]
  2122. ["Include archived trees" org-agenda-archives-mode
  2123. :style toggle :selected org-agenda-archives-mode :active t
  2124. :keys "v a"]
  2125. ["Include archive files" (org-agenda-archives-mode t)
  2126. :style toggle :selected (eq org-agenda-archives-mode t) :active t
  2127. :keys "v A"]
  2128. "--"
  2129. ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
  2130. ["Write view to file" org-agenda-write t]
  2131. ["Rebuild buffer" org-agenda-redo t]
  2132. ["Save all Org-mode Buffers" org-save-all-org-buffers t]
  2133. "--"
  2134. ["Show original entry" org-agenda-show t]
  2135. ["Go To (other window)" org-agenda-goto t]
  2136. ["Go To (this window)" org-agenda-switch-to t]
  2137. ["Capture with cursor date" org-agenda-capture t]
  2138. ["Follow Mode" org-agenda-follow-mode
  2139. :style toggle :selected org-agenda-follow-mode :active t]
  2140. ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
  2141. "--"
  2142. ("TODO"
  2143. ["Cycle TODO" org-agenda-todo t]
  2144. ["Next TODO set" org-agenda-todo-nextset t]
  2145. ["Previous TODO set" org-agenda-todo-previousset t]
  2146. ["Add note" org-agenda-add-note t])
  2147. ("Archive/Refile/Delete"
  2148. ["Archive default" org-agenda-archive-default t]
  2149. ["Archive default" org-agenda-archive-default-with-confirmation t]
  2150. ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
  2151. ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
  2152. ["Archive subtree" org-agenda-archive t]
  2153. "--"
  2154. ["Refile" org-agenda-refile t]
  2155. "--"
  2156. ["Delete subtree" org-agenda-kill t])
  2157. ("Bulk action"
  2158. ["Mark entry" org-agenda-bulk-mark t]
  2159. ["Mark all" org-agenda-bulk-mark-all t]
  2160. ["Unmark entry" org-agenda-bulk-unmark t]
  2161. ["Unmark all" org-agenda-bulk-unmark-all :active t :keys "U"]
  2162. ["Toggle mark" org-agenda-bulk-toggle t]
  2163. ["Toggle all" org-agenda-bulk-toggle-all t]
  2164. ["Mark regexp" org-agenda-bulk-mark-regexp t])
  2165. ["Act on all marked" org-agenda-bulk-action t]
  2166. "--"
  2167. ("Tags and Properties"
  2168. ["Show all Tags" org-agenda-show-tags t]
  2169. ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
  2170. ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
  2171. "--"
  2172. ["Column View" org-columns t])
  2173. ("Deadline/Schedule"
  2174. ["Schedule" org-agenda-schedule t]
  2175. ["Set Deadline" org-agenda-deadline t]
  2176. "--"
  2177. ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
  2178. ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
  2179. ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
  2180. ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
  2181. ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
  2182. ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
  2183. ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
  2184. ("Clock and Effort"
  2185. ["Clock in" org-agenda-clock-in t]
  2186. ["Clock out" org-agenda-clock-out t]
  2187. ["Clock cancel" org-agenda-clock-cancel t]
  2188. ["Goto running clock" org-clock-goto t]
  2189. "--"
  2190. ["Set Effort" org-agenda-set-effort t]
  2191. ["Change clocked effort" org-clock-modify-effort-estimate
  2192. (org-clock-is-active)])
  2193. ("Priority"
  2194. ["Set Priority" org-agenda-priority t]
  2195. ["Increase Priority" org-agenda-priority-up t]
  2196. ["Decrease Priority" org-agenda-priority-down t]
  2197. ["Show Priority" org-show-priority t])
  2198. ("Calendar/Diary"
  2199. ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
  2200. ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
  2201. ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
  2202. ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
  2203. ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
  2204. ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
  2205. "--"
  2206. ["Create iCalendar File" org-icalendar-combine-agenda-files t])
  2207. "--"
  2208. ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
  2209. "--"
  2210. ("MobileOrg"
  2211. ["Push Files and Views" org-mobile-push t]
  2212. ["Get Captured and Flagged" org-mobile-pull t]
  2213. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
  2214. ["Show note / unflag" org-agenda-show-the-flagging-note t]
  2215. "--"
  2216. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  2217. "--"
  2218. ["Quit" org-agenda-quit t]
  2219. ["Exit and Release Buffers" org-agenda-exit t]
  2220. ))
  2221. ;;; Agenda undo
  2222. (defvar org-agenda-allow-remote-undo t
  2223. "Non-nil means allow remote undo from the agenda buffer.")
  2224. (defvar org-agenda-undo-has-started-in nil
  2225. "Buffers that have already seen `undo-start' in the current undo sequence.")
  2226. (defun org-agenda-undo ()
  2227. "Undo a remote editing step in the agenda.
  2228. This undoes changes both in the agenda buffer and in the remote buffer
  2229. that have been changed along."
  2230. (interactive)
  2231. (or org-agenda-allow-remote-undo
  2232. (user-error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
  2233. (if (not (eq this-command last-command))
  2234. (setq org-agenda-undo-has-started-in nil
  2235. org-agenda-pending-undo-list org-agenda-undo-list))
  2236. (if (not org-agenda-pending-undo-list)
  2237. (user-error "No further undo information"))
  2238. (let* ((entry (pop org-agenda-pending-undo-list))
  2239. buf line cmd rembuf)
  2240. (setq cmd (pop entry) line (pop entry))
  2241. (setq rembuf (nth 2 entry))
  2242. (org-with-remote-undo rembuf
  2243. (while (bufferp (setq buf (pop entry)))
  2244. (if (pop entry)
  2245. (with-current-buffer buf
  2246. (let ((last-undo-buffer buf)
  2247. (inhibit-read-only t))
  2248. (unless (memq buf org-agenda-undo-has-started-in)
  2249. (push buf org-agenda-undo-has-started-in)
  2250. (make-local-variable 'pending-undo-list)
  2251. (undo-start))
  2252. (while (and pending-undo-list
  2253. (listp pending-undo-list)
  2254. (not (car pending-undo-list)))
  2255. (pop pending-undo-list))
  2256. (undo-more 1))))))
  2257. (org-goto-line line)
  2258. (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
  2259. (defun org-verify-change-for-undo (l1 l2)
  2260. "Verify that a real change occurred between the undo lists L1 and L2."
  2261. (while (and l1 (listp l1) (null (car l1))) (pop l1))
  2262. (while (and l2 (listp l2) (null (car l2))) (pop l2))
  2263. (not (eq l1 l2)))
  2264. ;;; Agenda dispatch
  2265. (defvar org-agenda-restrict-begin (make-marker))
  2266. (defvar org-agenda-restrict-end (make-marker))
  2267. (defvar org-agenda-last-dispatch-buffer nil)
  2268. (defvar org-agenda-overriding-restriction nil)
  2269. (defcustom org-agenda-custom-commands-contexts nil
  2270. "Alist of custom agenda keys and contextual rules.
  2271. For example, if you have a custom agenda command \"p\" and you
  2272. want this command to be accessible only from plain text files,
  2273. use this:
  2274. \\='((\"p\" ((in-file . \"\\\\.txt\\\\'\"))))
  2275. Here are the available contexts definitions:
  2276. in-file: command displayed only in matching files
  2277. in-mode: command displayed only in matching modes
  2278. not-in-file: command not displayed in matching files
  2279. not-in-mode: command not displayed in matching modes
  2280. in-buffer: command displayed only in matching buffers
  2281. not-in-buffer: command not displayed in matching buffers
  2282. [function]: a custom function taking no argument
  2283. If you define several checks, the agenda command will be
  2284. accessible if there is at least one valid check.
  2285. You can also bind a key to another agenda custom command
  2286. depending on contextual rules.
  2287. \\='((\"p\" \"q\" ((in-file . \"\\\\.txt\\\\'\"))))
  2288. Here it means: in .txt files, use \"p\" as the key for the
  2289. agenda command otherwise associated with \"q\". (The command
  2290. originally associated with \"q\" is not displayed to avoid
  2291. duplicates.)"
  2292. :version "24.3"
  2293. :group 'org-agenda-custom-commands
  2294. :type '(repeat (list :tag "Rule"
  2295. (string :tag " Agenda key")
  2296. (string :tag "Replace by command")
  2297. (repeat :tag "Available when"
  2298. (choice
  2299. (cons :tag "Condition"
  2300. (choice
  2301. (const :tag "In file" in-file)
  2302. (const :tag "Not in file" not-in-file)
  2303. (const :tag "In buffer" in-buffer)
  2304. (const :tag "Not in buffer" not-in-buffer)
  2305. (const :tag "In mode" in-mode)
  2306. (const :tag "Not in mode" not-in-mode))
  2307. (regexp))
  2308. (function :tag "Custom function"))))))
  2309. (defcustom org-agenda-max-entries nil
  2310. "Maximum number of entries to display in an agenda.
  2311. This can be nil (no limit) or an integer or an alist of agenda
  2312. types with an associated number of entries to display in this
  2313. type."
  2314. :version "24.4"
  2315. :package-version '(Org . "8.0")
  2316. :group 'org-agenda-custom-commands
  2317. :type '(choice (symbol :tag "No limit" nil)
  2318. (integer :tag "Max number of entries")
  2319. (repeat
  2320. (cons (choice :tag "Agenda type"
  2321. (const agenda)
  2322. (const todo)
  2323. (const tags)
  2324. (const search)
  2325. (const timeline))
  2326. (integer :tag "Max number of entries")))))
  2327. (defcustom org-agenda-max-todos nil
  2328. "Maximum number of TODOs to display in an agenda.
  2329. This can be nil (no limit) or an integer or an alist of agenda
  2330. types with an associated number of entries to display in this
  2331. type."
  2332. :version "24.4"
  2333. :package-version '(Org . "8.0")
  2334. :group 'org-agenda-custom-commands
  2335. :type '(choice (symbol :tag "No limit" nil)
  2336. (integer :tag "Max number of TODOs")
  2337. (repeat
  2338. (cons (choice :tag "Agenda type"
  2339. (const agenda)
  2340. (const todo)
  2341. (const tags)
  2342. (const search)
  2343. (const timeline))
  2344. (integer :tag "Max number of TODOs")))))
  2345. (defcustom org-agenda-max-tags nil
  2346. "Maximum number of tagged entries to display in an agenda.
  2347. This can be nil (no limit) or an integer or an alist of agenda
  2348. types with an associated number of entries to display in this
  2349. type."
  2350. :version "24.4"
  2351. :package-version '(Org . "8.0")
  2352. :group 'org-agenda-custom-commands
  2353. :type '(choice (symbol :tag "No limit" nil)
  2354. (integer :tag "Max number of tagged entries")
  2355. (repeat
  2356. (cons (choice :tag "Agenda type"
  2357. (const agenda)
  2358. (const todo)
  2359. (const tags)
  2360. (const search)
  2361. (const timeline))
  2362. (integer :tag "Max number of tagged entries")))))
  2363. (defcustom org-agenda-max-effort nil
  2364. "Maximum cumulated effort duration for the agenda.
  2365. This can be nil (no limit) or a number of minutes (as an integer)
  2366. or an alist of agenda types with an associated number of minutes
  2367. to limit entries to in this type."
  2368. :version "24.4"
  2369. :package-version '(Org . "8.0")
  2370. :group 'org-agenda-custom-commands
  2371. :type '(choice (symbol :tag "No limit" nil)
  2372. (integer :tag "Max number of minutes")
  2373. (repeat
  2374. (cons (choice :tag "Agenda type"
  2375. (const agenda)
  2376. (const todo)
  2377. (const tags)
  2378. (const search)
  2379. (const timeline))
  2380. (integer :tag "Max number of minutes")))))
  2381. (defvar org-keys nil)
  2382. (defvar org-match nil)
  2383. ;;;###autoload
  2384. (defun org-agenda (&optional arg org-keys restriction)
  2385. "Dispatch agenda commands to collect entries to the agenda buffer.
  2386. Prompts for a command to execute. Any prefix arg will be passed
  2387. on to the selected command. The default selections are:
  2388. a Call `org-agenda-list' to display the agenda for current day or week.
  2389. t Call `org-todo-list' to display the global todo list.
  2390. T Call `org-todo-list' to display the global todo list, select only
  2391. entries with a specific TODO keyword (the user gets a prompt).
  2392. m Call `org-tags-view' to display headlines with tags matching
  2393. a condition (the user is prompted for the condition).
  2394. M Like `m', but select only TODO entries, no ordinary headlines.
  2395. L Create a timeline for the current buffer.
  2396. e Export views to associated files.
  2397. s Search entries for keywords.
  2398. S Search entries for keywords, only with TODO keywords.
  2399. / Multi occur across all agenda files and also files listed
  2400. in `org-agenda-text-search-extra-files'.
  2401. < Restrict agenda commands to buffer, subtree, or region.
  2402. Press several times to get the desired effect.
  2403. > Remove a previous restriction.
  2404. # List \"stuck\" projects.
  2405. ! Configure what \"stuck\" means.
  2406. C Configure custom agenda commands.
  2407. More commands can be added by configuring the variable
  2408. `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
  2409. searches can be pre-defined in this way.
  2410. If the current buffer is in Org-mode and visiting a file, you can also
  2411. first press `<' once to indicate that the agenda should be temporarily
  2412. \(until the next use of \\[org-agenda]) restricted to the current file.
  2413. Pressing `<' twice means to restrict to the current subtree or region
  2414. \(if active)."
  2415. (interactive "P")
  2416. (catch 'exit
  2417. (let* ((prefix-descriptions nil)
  2418. (org-agenda-buffer-name org-agenda-buffer-name)
  2419. (org-agenda-window-setup (if (equal (buffer-name)
  2420. org-agenda-buffer-name)
  2421. 'current-window
  2422. org-agenda-window-setup))
  2423. (org-agenda-custom-commands-orig org-agenda-custom-commands)
  2424. (org-agenda-custom-commands
  2425. ;; normalize different versions
  2426. (delq nil
  2427. (mapcar
  2428. (lambda (x)
  2429. (cond ((stringp (cdr x))
  2430. (push x prefix-descriptions)
  2431. nil)
  2432. ((stringp (nth 1 x)) x)
  2433. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2434. (t (cons (car x) (cons "" (cdr x))))))
  2435. org-agenda-custom-commands)))
  2436. (org-agenda-custom-commands
  2437. (org-contextualize-keys
  2438. org-agenda-custom-commands org-agenda-custom-commands-contexts))
  2439. (buf (current-buffer))
  2440. (bfn (buffer-file-name (buffer-base-buffer)))
  2441. entry key type org-match lprops ans)
  2442. ;; Turn off restriction unless there is an overriding one,
  2443. (unless org-agenda-overriding-restriction
  2444. (unless (org-bound-and-true-p org-agenda-keep-restricted-file-list)
  2445. ;; There is a request to keep the file list in place
  2446. (put 'org-agenda-files 'org-restrict nil))
  2447. (setq org-agenda-restrict nil)
  2448. (move-marker org-agenda-restrict-begin nil)
  2449. (move-marker org-agenda-restrict-end nil))
  2450. ;; Delete old local properties
  2451. (put 'org-agenda-redo-command 'org-lprops nil)
  2452. ;; Delete previously set last-arguments
  2453. (put 'org-agenda-redo-command 'last-args nil)
  2454. ;; Remember where this call originated
  2455. (setq org-agenda-last-dispatch-buffer (current-buffer))
  2456. (unless org-keys
  2457. (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
  2458. org-keys (car ans)
  2459. restriction (cdr ans)))
  2460. ;; If we have sticky agenda buffers, set a name for the buffer,
  2461. ;; depending on the invoking keys. The user may still set this
  2462. ;; as a command option, which will overwrite what we do here.
  2463. (if org-agenda-sticky
  2464. (setq org-agenda-buffer-name
  2465. (format "*Org Agenda(%s)*" org-keys)))
  2466. ;; Establish the restriction, if any
  2467. (when (and (not org-agenda-overriding-restriction) restriction)
  2468. (put 'org-agenda-files 'org-restrict (list bfn))
  2469. (cond
  2470. ((eq restriction 'region)
  2471. (setq org-agenda-restrict (current-buffer))
  2472. (move-marker org-agenda-restrict-begin (region-beginning))
  2473. (move-marker org-agenda-restrict-end (region-end)))
  2474. ((eq restriction 'subtree)
  2475. (save-excursion
  2476. (setq org-agenda-restrict (current-buffer))
  2477. (org-back-to-heading t)
  2478. (move-marker org-agenda-restrict-begin (point))
  2479. (move-marker org-agenda-restrict-end
  2480. (progn (org-end-of-subtree t)))))))
  2481. ;; For example the todo list should not need it (but does...)
  2482. (cond
  2483. ((setq entry (assoc org-keys org-agenda-custom-commands))
  2484. (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
  2485. (progn
  2486. (setq type (nth 2 entry) org-match (eval (nth 3 entry))
  2487. lprops (nth 4 entry))
  2488. (if org-agenda-sticky
  2489. (setq org-agenda-buffer-name
  2490. (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
  2491. (format "*Org Agenda(%s)*" org-keys))))
  2492. (put 'org-agenda-redo-command 'org-lprops lprops)
  2493. (cond
  2494. ((eq type 'agenda)
  2495. (org-let lprops '(org-agenda-list current-prefix-arg)))
  2496. ((eq type 'agenda*)
  2497. (org-let lprops '(org-agenda-list current-prefix-arg nil nil t)))
  2498. ((eq type 'alltodo)
  2499. (org-let lprops '(org-todo-list current-prefix-arg)))
  2500. ((eq type 'search)
  2501. (org-let lprops '(org-search-view current-prefix-arg org-match nil)))
  2502. ((eq type 'stuck)
  2503. (org-let lprops '(org-agenda-list-stuck-projects
  2504. current-prefix-arg)))
  2505. ((eq type 'tags)
  2506. (org-let lprops '(org-tags-view current-prefix-arg org-match)))
  2507. ((eq type 'tags-todo)
  2508. (org-let lprops '(org-tags-view '(4) org-match)))
  2509. ((eq type 'todo)
  2510. (org-let lprops '(org-todo-list org-match)))
  2511. ((eq type 'tags-tree)
  2512. (org-check-for-org-mode)
  2513. (org-let lprops '(org-match-sparse-tree current-prefix-arg org-match)))
  2514. ((eq type 'todo-tree)
  2515. (org-check-for-org-mode)
  2516. (org-let lprops
  2517. '(org-occur (concat "^" org-outline-regexp "[ \t]*"
  2518. (regexp-quote org-match) "\\>"))))
  2519. ((eq type 'occur-tree)
  2520. (org-check-for-org-mode)
  2521. (org-let lprops '(org-occur org-match)))
  2522. ((functionp type)
  2523. (org-let lprops '(funcall type org-match)))
  2524. ((fboundp type)
  2525. (org-let lprops '(funcall type org-match)))
  2526. (t (user-error "Invalid custom agenda command type %s" type))))
  2527. (org-agenda-run-series (nth 1 entry) (cddr entry))))
  2528. ((equal org-keys "C")
  2529. (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
  2530. (customize-variable 'org-agenda-custom-commands))
  2531. ((equal org-keys "a") (call-interactively 'org-agenda-list))
  2532. ((equal org-keys "s") (call-interactively 'org-search-view))
  2533. ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
  2534. ((equal org-keys "t") (call-interactively 'org-todo-list))
  2535. ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
  2536. ((equal org-keys "m") (call-interactively 'org-tags-view))
  2537. ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
  2538. ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
  2539. ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
  2540. (org-add-hook
  2541. 'post-command-hook
  2542. (lambda ()
  2543. (unless (current-message)
  2544. (let* ((m (org-agenda-get-any-marker))
  2545. (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
  2546. (when note
  2547. (message (concat
  2548. "FLAGGING-NOTE ([?] for more info): "
  2549. (org-add-props
  2550. (replace-regexp-in-string
  2551. "\\\\n" "//"
  2552. (copy-sequence note))
  2553. nil 'face 'org-warning)))))))
  2554. t t))
  2555. ((equal org-keys "L")
  2556. (unless (derived-mode-p 'org-mode)
  2557. (user-error "This is not an Org-mode file"))
  2558. (unless restriction
  2559. (put 'org-agenda-files 'org-restrict (list bfn))
  2560. (org-call-with-arg 'org-timeline arg)))
  2561. ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
  2562. ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
  2563. ((equal org-keys "!") (customize-variable 'org-stuck-projects))
  2564. (t (user-error "Invalid agenda key"))))))
  2565. (defvar org-agenda-multi)
  2566. (defun org-agenda-append-agenda ()
  2567. "Append another agenda view to the current one.
  2568. This function allows interactive building of block agendas.
  2569. Agenda views are separated by `org-agenda-block-separator'."
  2570. (interactive)
  2571. (unless (derived-mode-p 'org-agenda-mode)
  2572. (user-error "Can only append from within agenda buffer"))
  2573. (let ((org-agenda-multi t))
  2574. (org-agenda)
  2575. (widen)
  2576. (org-agenda-finalize)
  2577. (setq buffer-read-only t)
  2578. (org-agenda-fit-window-to-buffer)))
  2579. (defun org-agenda-normalize-custom-commands (cmds)
  2580. "Normalize custom commands CMDS."
  2581. (delq nil
  2582. (mapcar
  2583. (lambda (x)
  2584. (cond ((stringp (cdr x)) nil)
  2585. ((stringp (nth 1 x)) x)
  2586. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2587. (t (cons (car x) (cons "" (cdr x))))))
  2588. cmds)))
  2589. (defun org-agenda-get-restriction-and-command (prefix-descriptions)
  2590. "The user interface for selecting an agenda command."
  2591. (catch 'exit
  2592. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  2593. (restrict-ok (and bfn (derived-mode-p 'org-mode)))
  2594. (region-p (org-region-active-p))
  2595. (custom org-agenda-custom-commands)
  2596. (selstring "")
  2597. restriction second-time
  2598. c entry key type match prefixes rmheader header-end custom1 desc
  2599. line lines left right n n1)
  2600. (save-window-excursion
  2601. (delete-other-windows)
  2602. (org-switch-to-buffer-other-window " *Agenda Commands*")
  2603. (erase-buffer)
  2604. (insert (eval-when-compile
  2605. (let ((header
  2606. "Press key for an agenda command: < Buffer, subtree/region restriction
  2607. -------------------------------- > Remove restriction
  2608. a Agenda for current week or day e Export agenda views
  2609. t List of all TODO entries T Entries with special TODO kwd
  2610. m Match a TAGS/PROP/TODO query M Like m, but only TODO entries
  2611. s Search for keywords S Like s, but only TODO entries
  2612. L Timeline for current buffer # List stuck projects (!=configure)
  2613. / Multi-occur C Configure custom agenda commands
  2614. ? Find :FLAGGED: entries * Toggle sticky agenda views
  2615. ")
  2616. (start 0))
  2617. (while (string-match
  2618. "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
  2619. header start)
  2620. (setq start (match-end 0))
  2621. (add-text-properties (match-beginning 2) (match-end 2)
  2622. '(face bold) header))
  2623. header)))
  2624. (setq header-end (point-marker))
  2625. (while t
  2626. (setq custom1 custom)
  2627. (when (eq rmheader t)
  2628. (org-goto-line 1)
  2629. (re-search-forward ":" nil t)
  2630. (delete-region (match-end 0) (point-at-eol))
  2631. (forward-char 1)
  2632. (looking-at "-+")
  2633. (delete-region (match-end 0) (point-at-eol))
  2634. (move-marker header-end (match-end 0)))
  2635. (goto-char header-end)
  2636. (delete-region (point) (point-max))
  2637. ;; Produce all the lines that describe custom commands and prefixes
  2638. (setq lines nil)
  2639. (while (setq entry (pop custom1))
  2640. (setq key (car entry) desc (nth 1 entry)
  2641. type (nth 2 entry)
  2642. match (nth 3 entry))
  2643. (if (> (length key) 1)
  2644. (add-to-list 'prefixes (string-to-char key))
  2645. (setq line
  2646. (format
  2647. "%-4s%-14s"
  2648. (org-add-props (copy-sequence key)
  2649. '(face bold))
  2650. (cond
  2651. ((string-match "\\S-" desc) desc)
  2652. ((eq type 'agenda) "Agenda for current week or day")
  2653. ((eq type 'agenda*) "Appointments for current week or day")
  2654. ((eq type 'alltodo) "List of all TODO entries")
  2655. ((eq type 'search) "Word search")
  2656. ((eq type 'stuck) "List of stuck projects")
  2657. ((eq type 'todo) "TODO keyword")
  2658. ((eq type 'tags) "Tags query")
  2659. ((eq type 'tags-todo) "Tags (TODO)")
  2660. ((eq type 'tags-tree) "Tags tree")
  2661. ((eq type 'todo-tree) "TODO kwd tree")
  2662. ((eq type 'occur-tree) "Occur tree")
  2663. ((functionp type) (if (symbolp type)
  2664. (symbol-name type)
  2665. "Lambda expression"))
  2666. (t "???"))))
  2667. (if org-agenda-menu-show-matcher
  2668. (setq line
  2669. (concat line ": "
  2670. (cond
  2671. ((stringp match)
  2672. (setq match (copy-sequence match))
  2673. (org-add-props match nil 'face 'org-warning))
  2674. ((listp type)
  2675. (format "set of %d commands" (length type))))))
  2676. (if (org-string-nw-p match)
  2677. (add-text-properties
  2678. 0 (length line) (list 'help-echo
  2679. (concat "Matcher: " match)) line)))
  2680. (push line lines)))
  2681. (setq lines (nreverse lines))
  2682. (when prefixes
  2683. (mapc (lambda (x)
  2684. (push
  2685. (format "%s %s"
  2686. (org-add-props (char-to-string x)
  2687. nil 'face 'bold)
  2688. (or (cdr (assoc (concat selstring
  2689. (char-to-string x))
  2690. prefix-descriptions))
  2691. "Prefix key"))
  2692. lines))
  2693. prefixes))
  2694. ;; Check if we should display in two columns
  2695. (if org-agenda-menu-two-columns
  2696. (progn
  2697. (setq n (length lines)
  2698. n1 (+ (/ n 2) (mod n 2))
  2699. right (nthcdr n1 lines)
  2700. left (copy-sequence lines))
  2701. (setcdr (nthcdr (1- n1) left) nil))
  2702. (setq left lines right nil))
  2703. (while left
  2704. (insert "\n" (pop left))
  2705. (when right
  2706. (if (< (current-column) 40)
  2707. (move-to-column 40 t)
  2708. (insert " "))
  2709. (insert (pop right))))
  2710. ;; Make the window the right size
  2711. (goto-char (point-min))
  2712. (if second-time
  2713. (if (not (pos-visible-in-window-p (point-max)))
  2714. (org-fit-window-to-buffer))
  2715. (setq second-time t)
  2716. (org-fit-window-to-buffer))
  2717. ;; Ask for selection
  2718. (message "Press key for agenda command%s:"
  2719. (if (or restrict-ok org-agenda-overriding-restriction)
  2720. (if org-agenda-overriding-restriction
  2721. " (restriction lock active)"
  2722. (if restriction
  2723. (format " (restricted to %s)" restriction)
  2724. " (unrestricted)"))
  2725. ""))
  2726. (setq c (read-char-exclusive))
  2727. (message "")
  2728. (cond
  2729. ((assoc (char-to-string c) custom)
  2730. (setq selstring (concat selstring (char-to-string c)))
  2731. (throw 'exit (cons selstring restriction)))
  2732. ((memq c prefixes)
  2733. (setq selstring (concat selstring (char-to-string c))
  2734. prefixes nil
  2735. rmheader (or rmheader t)
  2736. custom (delq nil (mapcar
  2737. (lambda (x)
  2738. (if (or (= (length (car x)) 1)
  2739. (/= (string-to-char (car x)) c))
  2740. nil
  2741. (cons (substring (car x) 1) (cdr x))))
  2742. custom))))
  2743. ((eq c ?*)
  2744. (call-interactively 'org-toggle-sticky-agenda)
  2745. (sit-for 2))
  2746. ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
  2747. (message "Restriction is only possible in Org-mode buffers")
  2748. (ding) (sit-for 1))
  2749. ((eq c ?1)
  2750. (org-agenda-remove-restriction-lock 'noupdate)
  2751. (setq restriction 'buffer))
  2752. ((eq c ?0)
  2753. (org-agenda-remove-restriction-lock 'noupdate)
  2754. (setq restriction (if region-p 'region 'subtree)))
  2755. ((eq c ?<)
  2756. (org-agenda-remove-restriction-lock 'noupdate)
  2757. (setq restriction
  2758. (cond
  2759. ((eq restriction 'buffer)
  2760. (if region-p 'region 'subtree))
  2761. ((memq restriction '(subtree region))
  2762. nil)
  2763. (t 'buffer))))
  2764. ((eq c ?>)
  2765. (org-agenda-remove-restriction-lock 'noupdate)
  2766. (setq restriction nil))
  2767. ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
  2768. (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
  2769. ((and (> (length selstring) 0) (eq c ?\d))
  2770. (delete-window)
  2771. (org-agenda-get-restriction-and-command prefix-descriptions))
  2772. ((equal c ?q) (error "Abort"))
  2773. (t (user-error "Invalid key %c" c))))))))
  2774. (defun org-agenda-fit-window-to-buffer ()
  2775. "Fit the window to the buffer size."
  2776. (and (memq org-agenda-window-setup '(reorganize-frame))
  2777. (fboundp 'fit-window-to-buffer)
  2778. (if (and (= (cdr org-agenda-window-frame-fractions) 1.0)
  2779. (= (car org-agenda-window-frame-fractions) 1.0))
  2780. (delete-other-windows)
  2781. (org-fit-window-to-buffer
  2782. nil
  2783. (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
  2784. (floor (* (frame-height) (car org-agenda-window-frame-fractions)))))))
  2785. (defvar org-cmd nil)
  2786. (defvar org-agenda-overriding-cmd nil)
  2787. (defvar org-agenda-overriding-arguments nil)
  2788. (defvar org-agenda-overriding-cmd-arguments nil)
  2789. (defun org-agenda-run-series (name series)
  2790. "Run agenda NAME as a SERIES of agenda commands."
  2791. (org-let (nth 1 series) '(org-agenda-prepare name))
  2792. ;; We need to reset agenda markers here, because when constructing a
  2793. ;; block agenda, the individual blocks do not do that.
  2794. (org-agenda-reset-markers)
  2795. (let* ((org-agenda-multi t)
  2796. (redo (list 'org-agenda-run-series name (list 'quote series)))
  2797. (cmds (car series))
  2798. (gprops (nth 1 series))
  2799. match ;; The byte compiler incorrectly complains about this. Keep it!
  2800. org-cmd type lprops)
  2801. (while (setq org-cmd (pop cmds))
  2802. (setq type (car org-cmd)
  2803. match (eval (nth 1 org-cmd))
  2804. lprops (nth 2 org-cmd))
  2805. (let ((org-agenda-overriding-arguments
  2806. (if (eq org-agenda-overriding-cmd org-cmd)
  2807. (or org-agenda-overriding-arguments
  2808. org-agenda-overriding-cmd-arguments))))
  2809. (cond
  2810. ((eq type 'agenda)
  2811. (org-let2 gprops lprops
  2812. '(call-interactively 'org-agenda-list)))
  2813. ((eq type 'agenda*)
  2814. (org-let2 gprops lprops
  2815. '(funcall 'org-agenda-list nil nil t)))
  2816. ((eq type 'alltodo)
  2817. (org-let2 gprops lprops
  2818. '(call-interactively 'org-todo-list)))
  2819. ((eq type 'search)
  2820. (org-let2 gprops lprops
  2821. '(org-search-view current-prefix-arg match nil)))
  2822. ((eq type 'stuck)
  2823. (org-let2 gprops lprops
  2824. '(call-interactively 'org-agenda-list-stuck-projects)))
  2825. ((eq type 'tags)
  2826. (org-let2 gprops lprops
  2827. '(org-tags-view current-prefix-arg match)))
  2828. ((eq type 'tags-todo)
  2829. (org-let2 gprops lprops
  2830. '(org-tags-view '(4) match)))
  2831. ((eq type 'todo)
  2832. (org-let2 gprops lprops
  2833. '(org-todo-list match)))
  2834. ((fboundp type)
  2835. (org-let2 gprops lprops
  2836. '(funcall type match)))
  2837. (t (error "Invalid type in command series")))))
  2838. (widen)
  2839. (let ((inhibit-read-only t))
  2840. (add-text-properties (point-min) (point-max)
  2841. `(org-series t org-series-redo-cmd ,redo)))
  2842. (setq org-agenda-redo-command redo)
  2843. (goto-char (point-min)))
  2844. (org-agenda-fit-window-to-buffer)
  2845. (org-let (nth 1 series) '(org-agenda-finalize)))
  2846. ;;;###autoload
  2847. (defmacro org-batch-agenda (cmd-key &rest parameters)
  2848. "Run an agenda command in batch mode and send the result to STDOUT.
  2849. If CMD-KEY is a string of length 1, it is used as a key in
  2850. `org-agenda-custom-commands' and triggers this command. If it is a
  2851. longer string it is used as a tags/todo match string.
  2852. Parameters are alternating variable names and values that will be bound
  2853. before running the agenda command."
  2854. (org-eval-in-environment (org-make-parameter-alist parameters)
  2855. (let (org-agenda-sticky)
  2856. (if (> (length cmd-key) 2)
  2857. (org-tags-view nil cmd-key)
  2858. (org-agenda nil cmd-key))))
  2859. (set-buffer org-agenda-buffer-name)
  2860. (princ (buffer-string)))
  2861. (defvar org-agenda-info nil)
  2862. ;;;###autoload
  2863. (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
  2864. "Run an agenda command in batch mode and send the result to STDOUT.
  2865. If CMD-KEY is a string of length 1, it is used as a key in
  2866. `org-agenda-custom-commands' and triggers this command. If it is a
  2867. longer string it is used as a tags/todo match string.
  2868. Parameters are alternating variable names and values that will be bound
  2869. before running the agenda command.
  2870. The output gives a line for each selected agenda item. Each
  2871. item is a list of comma-separated values, like this:
  2872. category,head,type,todo,tags,date,time,extra,priority-l,priority-n
  2873. category The category of the item
  2874. head The headline, without TODO kwd, TAGS and PRIORITY
  2875. type The type of the agenda entry, can be
  2876. todo selected in TODO match
  2877. tagsmatch selected in tags match
  2878. diary imported from diary
  2879. deadline a deadline on given date
  2880. scheduled scheduled on given date
  2881. timestamp entry has timestamp on given date
  2882. closed entry was closed on given date
  2883. upcoming-deadline warning about deadline
  2884. past-scheduled forwarded scheduled item
  2885. block entry has date block including g. date
  2886. todo The todo keyword, if any
  2887. tags All tags including inherited ones, separated by colons
  2888. date The relevant date, like 2007-2-14
  2889. time The time, like 15:00-16:50
  2890. extra Sting with extra planning info
  2891. priority-l The priority letter if any was given
  2892. priority-n The computed numerical priority
  2893. agenda-day The day in the agenda where this is listed"
  2894. (org-eval-in-environment (append '((org-agenda-remove-tags t))
  2895. (org-make-parameter-alist parameters))
  2896. (if (> (length cmd-key) 2)
  2897. (org-tags-view nil cmd-key)
  2898. (org-agenda nil cmd-key)))
  2899. (set-buffer org-agenda-buffer-name)
  2900. (let* ((lines (org-split-string (buffer-string) "\n"))
  2901. line)
  2902. (while (setq line (pop lines))
  2903. (catch 'next
  2904. (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
  2905. (setq org-agenda-info
  2906. (org-fix-agenda-info (text-properties-at 0 line)))
  2907. (princ
  2908. (mapconcat 'org-agenda-export-csv-mapper
  2909. '(org-category txt type todo tags date time extra
  2910. priority-letter priority agenda-day)
  2911. ","))
  2912. (princ "\n")))))
  2913. (defun org-fix-agenda-info (props)
  2914. "Make sure all properties on an agenda item have a canonical form.
  2915. This ensures the export commands can easily use it."
  2916. (let (tmp re)
  2917. (when (setq tmp (plist-get props 'tags))
  2918. (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
  2919. (when (setq tmp (plist-get props 'date))
  2920. (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2921. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2922. '((format "%4d, %9s %2s, %4s" dayname monthname day year))
  2923. (setq tmp (calendar-date-string tmp)))
  2924. (setq props (plist-put props 'date tmp)))
  2925. (when (setq tmp (plist-get props 'day))
  2926. (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2927. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2928. (setq tmp (calendar-date-string tmp)))
  2929. (setq props (plist-put props 'day tmp))
  2930. (setq props (plist-put props 'agenda-day tmp)))
  2931. (when (setq tmp (plist-get props 'txt))
  2932. (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
  2933. (plist-put props 'priority-letter (match-string 1 tmp))
  2934. (setq tmp (replace-match "" t t tmp)))
  2935. (when (and (setq re (plist-get props 'org-todo-regexp))
  2936. (setq re (concat "\\`\\.*" re " ?"))
  2937. (string-match re tmp))
  2938. (plist-put props 'todo (match-string 1 tmp))
  2939. (setq tmp (replace-match "" t t tmp)))
  2940. (plist-put props 'txt tmp)))
  2941. props)
  2942. (defun org-agenda-export-csv-mapper (prop)
  2943. (let ((res (plist-get org-agenda-info prop)))
  2944. (setq res
  2945. (cond
  2946. ((not res) "")
  2947. ((stringp res) res)
  2948. (t (prin1-to-string res))))
  2949. (while (string-match "," res)
  2950. (setq res (replace-match ";" t t res)))
  2951. (org-trim res)))
  2952. ;;;###autoload
  2953. (defun org-store-agenda-views (&rest parameters)
  2954. "Store agenda views."
  2955. (interactive)
  2956. (eval (list 'org-batch-store-agenda-views)))
  2957. ;;;###autoload
  2958. (defmacro org-batch-store-agenda-views (&rest parameters)
  2959. "Run all custom agenda commands that have a file argument."
  2960. (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
  2961. (pop-up-frames nil)
  2962. (dir default-directory)
  2963. (pars (org-make-parameter-alist parameters))
  2964. cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
  2965. (save-window-excursion
  2966. (while cmds
  2967. (setq cmd (pop cmds)
  2968. thiscmdkey (car cmd)
  2969. thiscmdcmd (cdr cmd)
  2970. match (nth 2 thiscmdcmd)
  2971. bufname (if org-agenda-sticky
  2972. (or (and (stringp match)
  2973. (format "*Org Agenda(%s:%s)*" thiscmdkey match))
  2974. (format "*Org Agenda(%s)*" thiscmdkey))
  2975. org-agenda-buffer-name)
  2976. cmd-or-set (nth 2 cmd)
  2977. opts (nth (if (listp cmd-or-set) 3 4) cmd)
  2978. files (nth (if (listp cmd-or-set) 4 5) cmd))
  2979. (if (stringp files) (setq files (list files)))
  2980. (when files
  2981. (org-eval-in-environment (append org-agenda-exporter-settings
  2982. opts pars)
  2983. (org-agenda nil thiscmdkey))
  2984. (set-buffer bufname)
  2985. (while files
  2986. (org-eval-in-environment (append org-agenda-exporter-settings
  2987. opts pars)
  2988. (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
  2989. (and (get-buffer bufname)
  2990. (kill-buffer bufname)))))))
  2991. (defvar org-agenda-current-span nil
  2992. "The current span used in the agenda view.") ; local variable in the agenda buffer
  2993. (defun org-agenda-mark-header-line (pos)
  2994. "Mark the line at POS as an agenda structure header."
  2995. (save-excursion
  2996. (goto-char pos)
  2997. (put-text-property (point-at-bol) (point-at-eol)
  2998. 'org-agenda-structural-header t)
  2999. (when org-agenda-title-append
  3000. (put-text-property (point-at-bol) (point-at-eol)
  3001. 'org-agenda-title-append org-agenda-title-append))))
  3002. (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
  3003. (defvar org-agenda-write-buffer-name "Agenda View")
  3004. (defun org-agenda-write (file &optional open nosettings agenda-bufname)
  3005. "Write the current buffer (an agenda view) as a file.
  3006. Depending on the extension of the file name, plain text (.txt),
  3007. HTML (.html or .htm), PDF (.pdf) or Postscript (.ps) is produced.
  3008. If the extension is .ics, translate visible agenda into iCalendar
  3009. format. If the extension is .org, collect all subtrees
  3010. corresponding to the agenda entries and add them in an .org file.
  3011. With prefix argument OPEN, open the new file immediately. If
  3012. NOSETTINGS is given, do not scope the settings of
  3013. `org-agenda-exporter-settings' into the export commands. This is
  3014. used when the settings have already been scoped and we do not
  3015. wish to overrule other, higher priority settings. If
  3016. AGENDA-BUFFER-NAME is provided, use this as the buffer name for
  3017. the agenda to write."
  3018. (interactive "FWrite agenda to file: \nP")
  3019. (if (or (not (file-writable-p file))
  3020. (and (file-exists-p file)
  3021. (if (org-called-interactively-p 'any)
  3022. (not (y-or-n-p (format "Overwrite existing file %s? " file))))))
  3023. (user-error "Cannot write agenda to file %s" file))
  3024. (org-let (if nosettings nil org-agenda-exporter-settings)
  3025. '(save-excursion
  3026. (save-window-excursion
  3027. (let ((bs (copy-sequence (buffer-string))) beg content)
  3028. (with-temp-buffer
  3029. (rename-buffer org-agenda-write-buffer-name t)
  3030. (set-buffer-modified-p nil)
  3031. (insert bs)
  3032. (org-agenda-remove-marked-text 'invisible 'org-filtered)
  3033. (run-hooks 'org-agenda-before-write-hook)
  3034. (cond
  3035. ((org-bound-and-true-p org-mobile-creating-agendas)
  3036. (org-mobile-write-agenda-for-mobile file))
  3037. ((string-match "\\.org\\'" file)
  3038. (let (content p m message-log-max)
  3039. (goto-char (point-min))
  3040. (while (setq p (next-single-property-change (point) 'org-hd-marker nil))
  3041. (goto-char p)
  3042. (setq m (get-text-property (point) 'org-hd-marker))
  3043. (when m
  3044. (push (save-excursion
  3045. (set-buffer (marker-buffer m))
  3046. (goto-char m)
  3047. (org-copy-subtree 1 nil t t)
  3048. org-subtree-clip)
  3049. content)))
  3050. (find-file file)
  3051. (erase-buffer)
  3052. (dolist (s content) (org-paste-subtree 1 s))
  3053. (write-file file)
  3054. (kill-buffer (current-buffer))
  3055. (message "Org file written to %s" file)))
  3056. ((string-match "\\.html?\\'" file)
  3057. (require 'htmlize)
  3058. (set-buffer (htmlize-buffer (current-buffer)))
  3059. (when org-agenda-export-html-style
  3060. ;; replace <style> section with org-agenda-export-html-style
  3061. (goto-char (point-min))
  3062. (kill-region (- (search-forward "<style") 6)
  3063. (search-forward "</style>"))
  3064. (insert org-agenda-export-html-style))
  3065. (write-file file)
  3066. (kill-buffer (current-buffer))
  3067. (message "HTML written to %s" file))
  3068. ((string-match "\\.ps\\'" file)
  3069. (require 'ps-print)
  3070. (ps-print-buffer-with-faces file)
  3071. (message "Postscript written to %s" file))
  3072. ((string-match "\\.pdf\\'" file)
  3073. (require 'ps-print)
  3074. (ps-print-buffer-with-faces
  3075. (concat (file-name-sans-extension file) ".ps"))
  3076. (call-process "ps2pdf" nil nil nil
  3077. (expand-file-name
  3078. (concat (file-name-sans-extension file) ".ps"))
  3079. (expand-file-name file))
  3080. (delete-file (concat (file-name-sans-extension file) ".ps"))
  3081. (message "PDF written to %s" file))
  3082. ((string-match "\\.ics\\'" file)
  3083. (require 'ox-icalendar)
  3084. (org-icalendar-export-current-agenda (expand-file-name file)))
  3085. (t
  3086. (let ((bs (buffer-string)))
  3087. (find-file file)
  3088. (erase-buffer)
  3089. (insert bs)
  3090. (save-buffer 0)
  3091. (kill-buffer (current-buffer))
  3092. (message "Plain text written to %s" file))))))))
  3093. (set-buffer (or agenda-bufname
  3094. (and (org-called-interactively-p 'any) (buffer-name))
  3095. org-agenda-buffer-name)))
  3096. (when open (org-open-file file)))
  3097. (defun org-agenda-remove-marked-text (property &optional value)
  3098. "Delete all text marked with VALUE of PROPERTY.
  3099. VALUE defaults to t."
  3100. (let (beg)
  3101. (setq value (or value t))
  3102. (while (setq beg (text-property-any (point-min) (point-max)
  3103. property value))
  3104. (delete-region
  3105. beg (or (next-single-property-change beg property)
  3106. (point-max))))))
  3107. (defun org-agenda-add-entry-text ()
  3108. "Add entry text to agenda lines.
  3109. This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
  3110. entry text following headings shown in the agenda.
  3111. Drawers will be excluded, also the line with scheduling/deadline info."
  3112. (when (and (> org-agenda-add-entry-text-maxlines 0)
  3113. (not (org-bound-and-true-p org-mobile-creating-agendas)))
  3114. (let (m txt)
  3115. (goto-char (point-min))
  3116. (while (not (eobp))
  3117. (if (not (setq m (org-get-at-bol 'org-hd-marker)))
  3118. (beginning-of-line 2)
  3119. (setq txt (org-agenda-get-some-entry-text
  3120. m org-agenda-add-entry-text-maxlines " > "))
  3121. (end-of-line 1)
  3122. (if (string-match "\\S-" txt)
  3123. (insert "\n" txt)
  3124. (or (eobp) (forward-char 1))))))))
  3125. (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
  3126. &rest keep)
  3127. "Extract entry text from MARKER, at most N-LINES lines.
  3128. This will ignore drawers etc, just get the text.
  3129. If INDENT is given, prefix every line with this string. If KEEP is
  3130. given, it is a list of symbols, defining stuff that should not be
  3131. removed from the entry content. Currently only `planning' is allowed here."
  3132. (let (txt drawer-re kwd-time-re ind)
  3133. (save-excursion
  3134. (with-current-buffer (marker-buffer marker)
  3135. (if (not (derived-mode-p 'org-mode))
  3136. (setq txt "")
  3137. (save-excursion
  3138. (save-restriction
  3139. (widen)
  3140. (goto-char marker)
  3141. (end-of-line 1)
  3142. (setq txt (buffer-substring
  3143. (min (1+ (point)) (point-max))
  3144. (progn (outline-next-heading) (point)))
  3145. drawer-re org-drawer-regexp
  3146. kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
  3147. ".*\n?"))
  3148. (with-temp-buffer
  3149. (insert txt)
  3150. (when org-agenda-add-entry-text-descriptive-links
  3151. (goto-char (point-min))
  3152. (while (org-activate-bracket-links (point-max))
  3153. (add-text-properties (match-beginning 0) (match-end 0)
  3154. '(face org-link))))
  3155. (goto-char (point-min))
  3156. (while (re-search-forward org-bracket-link-regexp (point-max) t)
  3157. (set-text-properties (match-beginning 0) (match-end 0)
  3158. nil))
  3159. (goto-char (point-min))
  3160. (while (re-search-forward drawer-re nil t)
  3161. (delete-region
  3162. (match-beginning 0)
  3163. (progn (re-search-forward
  3164. "^[ \t]*:END:.*\n?" nil 'move)
  3165. (point))))
  3166. (unless (member 'planning keep)
  3167. (goto-char (point-min))
  3168. (while (re-search-forward kwd-time-re nil t)
  3169. (replace-match "")))
  3170. (goto-char (point-min))
  3171. (when org-agenda-entry-text-exclude-regexps
  3172. (let ((re-list org-agenda-entry-text-exclude-regexps) re)
  3173. (while (setq re (pop re-list))
  3174. (goto-char (point-min))
  3175. (while (re-search-forward re nil t)
  3176. (replace-match "")))))
  3177. (goto-char (point-max))
  3178. (skip-chars-backward " \t\n")
  3179. (if (looking-at "[ \t\n]+\\'") (replace-match ""))
  3180. ;; find and remove min common indentation
  3181. (goto-char (point-min))
  3182. (untabify (point-min) (point-max))
  3183. (setq ind (org-get-indentation))
  3184. (while (not (eobp))
  3185. (unless (looking-at "[ \t]*$")
  3186. (setq ind (min ind (org-get-indentation))))
  3187. (beginning-of-line 2))
  3188. (goto-char (point-min))
  3189. (while (not (eobp))
  3190. (unless (looking-at "[ \t]*$")
  3191. (move-to-column ind)
  3192. (delete-region (point-at-bol) (point)))
  3193. (beginning-of-line 2))
  3194. (run-hooks 'org-agenda-entry-text-cleanup-hook)
  3195. (goto-char (point-min))
  3196. (when indent
  3197. (while (and (not (eobp)) (re-search-forward "^" nil t))
  3198. (replace-match indent t t)))
  3199. (goto-char (point-min))
  3200. (while (looking-at "[ \t]*\n") (replace-match ""))
  3201. (goto-char (point-max))
  3202. (when (> (org-current-line)
  3203. n-lines)
  3204. (org-goto-line (1+ n-lines))
  3205. (backward-char 1))
  3206. (setq txt (buffer-substring (point-min) (point)))))))))
  3207. txt))
  3208. (defun org-check-for-org-mode ()
  3209. "Make sure current buffer is in org-mode. Error if not."
  3210. (or (derived-mode-p 'org-mode)
  3211. (error "Cannot execute org-mode agenda command on buffer in %s"
  3212. major-mode)))
  3213. ;;; Agenda prepare and finalize
  3214. (defvar org-agenda-multi nil) ; dynamically scoped
  3215. (defvar org-agenda-pre-window-conf nil)
  3216. (defvar org-agenda-columns-active nil)
  3217. (defvar org-agenda-name nil)
  3218. (defvar org-agenda-tag-filter nil)
  3219. (defvar org-agenda-category-filter nil)
  3220. (defvar org-agenda-regexp-filter nil)
  3221. (defvar org-agenda-effort-filter nil)
  3222. (defvar org-agenda-top-headline-filter nil)
  3223. (defvar org-agenda-tag-filter-preset nil
  3224. "A preset of the tags filter used for secondary agenda filtering.
  3225. This must be a list of strings, each string must be a single tag preceded
  3226. by \"+\" or \"-\".
  3227. This variable should not be set directly, but agenda custom commands can
  3228. bind it in the options section. The preset filter is a global property of
  3229. the entire agenda view. In a block agenda, it will not work reliably to
  3230. define a filter for one of the individual blocks. You need to set it in
  3231. the global options and expect it to be applied to the entire view.")
  3232. (defvar org-agenda-category-filter-preset nil
  3233. "A preset of the category filter used for secondary agenda filtering.
  3234. This must be a list of strings, each string must be a single category
  3235. preceded by \"+\" or \"-\".
  3236. This variable should not be set directly, but agenda custom commands can
  3237. bind it in the options section. The preset filter is a global property of
  3238. the entire agenda view. In a block agenda, it will not work reliably to
  3239. define a filter for one of the individual blocks. You need to set it in
  3240. the global options and expect it to be applied to the entire view.")
  3241. (defvar org-agenda-regexp-filter-preset nil
  3242. "A preset of the regexp filter used for secondary agenda filtering.
  3243. This must be a list of strings, each string must be a single regexp
  3244. preceded by \"+\" or \"-\".
  3245. This variable should not be set directly, but agenda custom commands can
  3246. bind it in the options section. The preset filter is a global property of
  3247. the entire agenda view. In a block agenda, it will not work reliably to
  3248. define a filter for one of the individual blocks. You need to set it in
  3249. the global options and expect it to be applied to the entire view.")
  3250. (defvar org-agenda-effort-filter-preset nil
  3251. "A preset of the effort condition used for secondary agenda filtering.
  3252. This must be a list of strings, each string must be a single regexp
  3253. preceded by \"+\" or \"-\".
  3254. This variable should not be set directly, but agenda custom commands can
  3255. bind it in the options section. The preset filter is a global property of
  3256. the entire agenda view. In a block agenda, it will not work reliably to
  3257. define a filter for one of the individual blocks. You need to set it in
  3258. the global options and expect it to be applied to the entire view.")
  3259. (defun org-agenda-use-sticky-p ()
  3260. "Return non-nil if an agenda buffer named
  3261. `org-agenda-buffer-name' exists and should be shown instead of
  3262. generating a new one."
  3263. (and
  3264. ;; turned off by user
  3265. org-agenda-sticky
  3266. ;; For multi-agenda buffer already exists
  3267. (not org-agenda-multi)
  3268. ;; buffer found
  3269. (get-buffer org-agenda-buffer-name)
  3270. ;; C-u parameter is same as last call
  3271. (with-current-buffer (get-buffer org-agenda-buffer-name)
  3272. (and
  3273. (equal current-prefix-arg
  3274. org-agenda-last-prefix-arg)
  3275. ;; In case user turned stickiness on, while having existing
  3276. ;; Agenda buffer active, don't reuse that buffer, because it
  3277. ;; does not have org variables local
  3278. org-agenda-this-buffer-is-sticky))))
  3279. (defun org-agenda-prepare-window (abuf filter-alist)
  3280. "Setup agenda buffer in the window.
  3281. ABUF is the buffer for the agenda window.
  3282. FILTER-ALIST is an alist of filters we need to apply when
  3283. `org-agenda-persistent-filter' is non-nil."
  3284. (let* ((awin (get-buffer-window abuf)) wconf)
  3285. (cond
  3286. ((equal (current-buffer) abuf) nil)
  3287. (awin (select-window awin))
  3288. ((not (setq wconf (current-window-configuration))))
  3289. ((equal org-agenda-window-setup 'current-window)
  3290. (org-pop-to-buffer-same-window abuf))
  3291. ((equal org-agenda-window-setup 'other-window)
  3292. (org-switch-to-buffer-other-window abuf))
  3293. ((equal org-agenda-window-setup 'other-frame)
  3294. (switch-to-buffer-other-frame abuf))
  3295. ((eq org-agenda-window-setup 'only-window)
  3296. (delete-other-windows)
  3297. (org-pop-to-buffer-same-window abuf))
  3298. ((equal org-agenda-window-setup 'reorganize-frame)
  3299. (delete-other-windows)
  3300. (org-switch-to-buffer-other-window abuf)))
  3301. (setq org-agenda-tag-filter (cdr (assoc 'tag filter-alist)))
  3302. (setq org-agenda-category-filter (cdr (assoc 'cat filter-alist)))
  3303. (setq org-agenda-effort-filter (cdr (assoc 'effort filter-alist)))
  3304. (setq org-agenda-regexp-filter (cdr (assoc 're filter-alist)))
  3305. ;; Additional test in case agenda is invoked from within agenda
  3306. ;; buffer via elisp link.
  3307. (unless (equal (current-buffer) abuf)
  3308. (org-pop-to-buffer-same-window abuf))
  3309. (setq org-agenda-pre-window-conf
  3310. (or wconf org-agenda-pre-window-conf))))
  3311. (defun org-agenda-prepare (&optional name)
  3312. (let ((filter-alist (if org-agenda-persistent-filter
  3313. (with-current-buffer
  3314. (get-buffer-create org-agenda-buffer-name)
  3315. (list `(tag . ,org-agenda-tag-filter)
  3316. `(re . ,org-agenda-regexp-filter)
  3317. `(effort . ,org-agenda-effort-filter)
  3318. `(cat . ,org-agenda-category-filter))))))
  3319. (if (org-agenda-use-sticky-p)
  3320. (progn
  3321. (put 'org-agenda-tag-filter :preset-filter nil)
  3322. (put 'org-agenda-category-filter :preset-filter nil)
  3323. (put 'org-agenda-regexp-filter :preset-filter nil)
  3324. ;; Popup existing buffer
  3325. (org-agenda-prepare-window (get-buffer org-agenda-buffer-name)
  3326. filter-alist)
  3327. (message "Sticky Agenda buffer, use `r' to refresh")
  3328. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3329. (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
  3330. (setq org-todo-keywords-for-agenda nil)
  3331. (put 'org-agenda-tag-filter :preset-filter
  3332. org-agenda-tag-filter-preset)
  3333. (put 'org-agenda-category-filter :preset-filter
  3334. org-agenda-category-filter-preset)
  3335. (put 'org-agenda-regexp-filter :preset-filter
  3336. org-agenda-regexp-filter-preset)
  3337. (put 'org-agenda-effort-filter :preset-filter
  3338. org-agenda-effort-filter-preset)
  3339. (if org-agenda-multi
  3340. (progn
  3341. (setq buffer-read-only nil)
  3342. (goto-char (point-max))
  3343. (unless (or (bobp) org-agenda-compact-blocks
  3344. (not org-agenda-block-separator))
  3345. (insert "\n"
  3346. (if (stringp org-agenda-block-separator)
  3347. org-agenda-block-separator
  3348. (make-string (window-width) org-agenda-block-separator))
  3349. "\n"))
  3350. (narrow-to-region (point) (point-max)))
  3351. (setq org-done-keywords-for-agenda nil)
  3352. ;; Setting any org variables that are in org-agenda-local-vars
  3353. ;; list need to be done after the prepare call
  3354. (org-agenda-prepare-window
  3355. (get-buffer-create org-agenda-buffer-name) filter-alist)
  3356. (setq buffer-read-only nil)
  3357. (org-agenda-reset-markers)
  3358. (let ((inhibit-read-only t)) (erase-buffer))
  3359. (org-agenda-mode)
  3360. (setq org-agenda-buffer (current-buffer))
  3361. (setq org-agenda-contributing-files nil)
  3362. (setq org-agenda-columns-active nil)
  3363. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  3364. (setq org-todo-keywords-for-agenda
  3365. (org-uniquify org-todo-keywords-for-agenda))
  3366. (setq org-done-keywords-for-agenda
  3367. (org-uniquify org-done-keywords-for-agenda))
  3368. (setq org-agenda-last-prefix-arg current-prefix-arg)
  3369. (setq org-agenda-this-buffer-name org-agenda-buffer-name)
  3370. (and name (not org-agenda-name)
  3371. (org-set-local 'org-agenda-name name)))
  3372. (setq buffer-read-only nil))))
  3373. (defvar org-agenda-overriding-columns-format) ; From org-colview.el
  3374. (defun org-agenda-finalize ()
  3375. "Finishing touch for the agenda buffer, called just before displaying it."
  3376. (unless org-agenda-multi
  3377. (save-excursion
  3378. (let ((inhibit-read-only t))
  3379. (goto-char (point-min))
  3380. (save-excursion
  3381. (while (org-activate-bracket-links (point-max))
  3382. (add-text-properties (match-beginning 0) (match-end 0)
  3383. '(face org-link))))
  3384. (save-excursion
  3385. (while (org-activate-plain-links (point-max))
  3386. (add-text-properties (match-beginning 0) (match-end 0)
  3387. '(face org-link))))
  3388. (unless (eq org-agenda-remove-tags t)
  3389. (org-agenda-align-tags))
  3390. (unless org-agenda-with-colors
  3391. (remove-text-properties (point-min) (point-max) '(face nil)))
  3392. (if (and (boundp 'org-agenda-overriding-columns-format)
  3393. org-agenda-overriding-columns-format)
  3394. (org-set-local 'org-agenda-overriding-columns-format
  3395. org-agenda-overriding-columns-format))
  3396. (if (and (boundp 'org-agenda-view-columns-initially)
  3397. org-agenda-view-columns-initially)
  3398. (org-agenda-columns))
  3399. (when org-agenda-fontify-priorities
  3400. (org-agenda-fontify-priorities))
  3401. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  3402. (org-agenda-dim-blocked-tasks))
  3403. (org-agenda-mark-clocking-task)
  3404. (when org-agenda-entry-text-mode
  3405. (org-agenda-entry-text-hide)
  3406. (org-agenda-entry-text-show))
  3407. (if (and (functionp 'org-habit-insert-consistency-graphs)
  3408. (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
  3409. (org-habit-insert-consistency-graphs))
  3410. (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
  3411. (unless (or (eq org-agenda-show-inherited-tags 'always)
  3412. (and (listp org-agenda-show-inherited-tags)
  3413. (memq org-agenda-type org-agenda-show-inherited-tags))
  3414. (and (eq org-agenda-show-inherited-tags t)
  3415. (or (eq org-agenda-use-tag-inheritance t)
  3416. (and (listp org-agenda-use-tag-inheritance)
  3417. (not (memq org-agenda-type
  3418. org-agenda-use-tag-inheritance))))))
  3419. (let (mrk)
  3420. (save-excursion
  3421. (goto-char (point-min))
  3422. (while (equal (forward-line) 0)
  3423. (when (setq mrk (get-text-property (point) 'org-hd-marker))
  3424. (put-text-property (point-at-bol) (point-at-eol)
  3425. 'tags (org-with-point-at mrk
  3426. (delete-dups
  3427. (mapcar 'downcase (org-get-tags-at))))))))))
  3428. (run-hooks 'org-agenda-finalize-hook)
  3429. (when org-agenda-top-headline-filter
  3430. (org-agenda-filter-top-headline-apply
  3431. org-agenda-top-headline-filter))
  3432. (when org-agenda-tag-filter
  3433. (org-agenda-filter-apply org-agenda-tag-filter 'tag t))
  3434. (when (get 'org-agenda-tag-filter :preset-filter)
  3435. (org-agenda-filter-apply
  3436. (get 'org-agenda-tag-filter :preset-filter) 'tag t))
  3437. (when org-agenda-category-filter
  3438. (org-agenda-filter-apply org-agenda-category-filter 'category))
  3439. (when (get 'org-agenda-category-filter :preset-filter)
  3440. (org-agenda-filter-apply
  3441. (get 'org-agenda-category-filter :preset-filter) 'category))
  3442. (when org-agenda-regexp-filter
  3443. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
  3444. (when (get 'org-agenda-regexp-filter :preset-filter)
  3445. (org-agenda-filter-apply
  3446. (get 'org-agenda-regexp-filter :preset-filter) 'regexp))
  3447. (when org-agenda-effort-filter
  3448. (org-agenda-filter-apply org-agenda-effort-filter 'effort))
  3449. (when (get 'org-agenda-effort-filter :preset-filter)
  3450. (org-agenda-filter-apply
  3451. (get 'org-agenda-effort-filter :preset-filter) 'effort))
  3452. (org-add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)))))
  3453. (defun org-agenda-mark-clocking-task ()
  3454. "Mark the current clock entry in the agenda if it is present."
  3455. ;; We need to widen when `org-agenda-finalize' is called from
  3456. ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in')
  3457. (when org-clock-current-task
  3458. (save-restriction
  3459. (widen)
  3460. (org-agenda-unmark-clocking-task)
  3461. (when (marker-buffer org-clock-hd-marker)
  3462. (save-excursion
  3463. (goto-char (point-min))
  3464. (let (s ov)
  3465. (while (setq s (next-single-property-change (point) 'org-hd-marker))
  3466. (goto-char s)
  3467. (when (equal (org-get-at-bol 'org-hd-marker)
  3468. org-clock-hd-marker)
  3469. (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
  3470. (overlay-put ov 'type 'org-agenda-clocking)
  3471. (overlay-put ov 'face 'org-agenda-clocking)
  3472. (overlay-put ov 'help-echo
  3473. "The clock is running in this item")))))))))
  3474. (defun org-agenda-unmark-clocking-task ()
  3475. "Unmark the current clocking task."
  3476. (mapc (lambda (o)
  3477. (if (eq (overlay-get o 'type) 'org-agenda-clocking)
  3478. (delete-overlay o)))
  3479. (overlays-in (point-min) (point-max))))
  3480. (defun org-agenda-fontify-priorities ()
  3481. "Make highest priority lines bold, and lowest italic."
  3482. (interactive)
  3483. (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
  3484. (delete-overlay o)))
  3485. (overlays-in (point-min) (point-max)))
  3486. (save-excursion
  3487. (let (b e p ov h l)
  3488. (goto-char (point-min))
  3489. (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
  3490. (setq h (or (get-char-property (point) 'org-highest-priority)
  3491. org-highest-priority)
  3492. l (or (get-char-property (point) 'org-lowest-priority)
  3493. org-lowest-priority)
  3494. p (string-to-char (match-string 1))
  3495. b (match-beginning 0)
  3496. e (if (eq org-agenda-fontify-priorities 'cookies)
  3497. (match-end 0)
  3498. (point-at-eol))
  3499. ov (make-overlay b e))
  3500. (overlay-put
  3501. ov 'face
  3502. (let ((special-face
  3503. (cond ((org-face-from-face-or-color
  3504. 'priority nil
  3505. (cdr (assoc p org-priority-faces))))
  3506. ((and (listp org-agenda-fontify-priorities)
  3507. (org-face-from-face-or-color
  3508. 'priority nil
  3509. (cdr (assoc p org-agenda-fontify-priorities)))))
  3510. ((equal p l) 'italic)
  3511. ((equal p h) 'bold))))
  3512. (if special-face (list special-face 'org-priority) 'org-priority)))
  3513. (overlay-put ov 'org-type 'org-priority)))))
  3514. (defvar org-depend-tag-blocked)
  3515. (defun org-agenda-dim-blocked-tasks (&optional invisible)
  3516. "Dim currently blocked TODOs in the agenda display.
  3517. When INVISIBLE is non-nil, hide currently blocked TODO instead of
  3518. dimming them."
  3519. (interactive "P")
  3520. (when (org-called-interactively-p 'interactive)
  3521. (message "Dim or hide blocked tasks..."))
  3522. (dolist (o (overlays-in (point-min) (point-max)))
  3523. (when (eq (overlay-get o 'org-type) 'org-blocked-todo)
  3524. (delete-overlay o)))
  3525. (save-excursion
  3526. (let ((inhibit-read-only t)
  3527. (org-depend-tag-blocked nil)
  3528. org-blocked-by-checkboxes)
  3529. (goto-char (point-min))
  3530. (while (let ((pos (text-property-not-all
  3531. (point) (point-max) 'todo-state nil)))
  3532. (when pos (goto-char pos)))
  3533. (setq org-blocked-by-checkboxes nil)
  3534. (let ((marker (org-get-at-bol 'org-hd-marker)))
  3535. (when (and (markerp marker)
  3536. (with-current-buffer (marker-buffer marker)
  3537. (save-excursion (goto-char marker)
  3538. (org-entry-blocked-p))))
  3539. ;; Entries blocked by checkboxes cannot be made invisible.
  3540. ;; See `org-agenda-dim-blocked-tasks' for details.
  3541. (let* ((really-invisible
  3542. (and (not org-blocked-by-checkboxes)
  3543. (or invisible (eq org-agenda-dim-blocked-tasks
  3544. 'invisible))))
  3545. (ov (make-overlay (if really-invisible (line-end-position 0)
  3546. (line-beginning-position))
  3547. (line-end-position))))
  3548. (if really-invisible (overlay-put ov 'invisible t)
  3549. (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
  3550. (overlay-put ov 'org-type 'org-blocked-todo))))
  3551. (forward-line))))
  3552. (when (org-called-interactively-p 'interactive)
  3553. (message "Dim or hide blocked tasks...done")))
  3554. (defvar org-agenda-skip-function nil
  3555. "Function to be called at each match during agenda construction.
  3556. If this function returns nil, the current match should not be skipped.
  3557. Otherwise, the function must return a position from where the search
  3558. should be continued.
  3559. This may also be a Lisp form, it will be evaluated.
  3560. Never set this variable using `setq' or so, because then it will apply
  3561. to all future agenda commands. If you do want a global skipping condition,
  3562. use the option `org-agenda-skip-function-global' instead.
  3563. The correct usage for `org-agenda-skip-function' is to bind it with
  3564. `let' to scope it dynamically into the agenda-constructing command.
  3565. A good way to set it is through options in `org-agenda-custom-commands'.")
  3566. (defun org-agenda-skip ()
  3567. "Throw to `:skip' in places that should be skipped.
  3568. Also moves point to the end of the skipped region, so that search can
  3569. continue from there."
  3570. (let ((p (point-at-bol)) to)
  3571. (when (or
  3572. (save-excursion (goto-char p) (looking-at comment-start-skip))
  3573. (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
  3574. (get-text-property p :org-archived)
  3575. (org-end-of-subtree t))
  3576. (and org-agenda-skip-comment-trees
  3577. (get-text-property p :org-comment)
  3578. (org-end-of-subtree t))
  3579. (and (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
  3580. (org-agenda-skip-eval org-agenda-skip-function)))
  3581. (goto-char to))
  3582. (org-in-src-block-p t))
  3583. (throw :skip t))))
  3584. (defun org-agenda-skip-eval (form)
  3585. "If FORM is a function or a list, call (or eval) it and return the result.
  3586. `save-excursion' and `save-match-data' are wrapped around the call, so point
  3587. and match data are returned to the previous state no matter what these
  3588. functions do."
  3589. (let (fp)
  3590. (and form
  3591. (or (setq fp (functionp form))
  3592. (consp form))
  3593. (save-excursion
  3594. (save-match-data
  3595. (if fp
  3596. (funcall form)
  3597. (eval form)))))))
  3598. (defvar org-agenda-markers nil
  3599. "List of all currently active markers created by `org-agenda'.")
  3600. (defvar org-agenda-last-marker-time (org-float-time)
  3601. "Creation time of the last agenda marker.")
  3602. (defun org-agenda-new-marker (&optional pos)
  3603. "Return a new agenda marker.
  3604. Maker is at point, or at POS if non-nil. Org mode keeps a list of
  3605. these markers and resets them when they are no longer in use."
  3606. (let ((m (copy-marker (or pos (point)) t)))
  3607. (setq org-agenda-last-marker-time (org-float-time))
  3608. (if org-agenda-buffer
  3609. (with-current-buffer org-agenda-buffer
  3610. (push m org-agenda-markers))
  3611. (push m org-agenda-markers))
  3612. m))
  3613. (defun org-agenda-reset-markers ()
  3614. "Reset markers created by `org-agenda'."
  3615. (while org-agenda-markers
  3616. (move-marker (pop org-agenda-markers) nil)))
  3617. (defun org-agenda-save-markers-for-cut-and-paste (beg end)
  3618. "Save relative positions of markers in region.
  3619. This check for agenda markers in all agenda buffers currently active."
  3620. (dolist (buf (buffer-list))
  3621. (with-current-buffer buf
  3622. (when (eq major-mode 'org-agenda-mode)
  3623. (mapc (lambda (m) (org-check-and-save-marker m beg end))
  3624. org-agenda-markers)))))
  3625. ;;; Entry text mode
  3626. (defun org-agenda-entry-text-show-here ()
  3627. "Add some text from the entry as context to the current line."
  3628. (let (m txt o)
  3629. (setq m (org-get-at-bol 'org-hd-marker))
  3630. (unless (marker-buffer m)
  3631. (error "No marker points to an entry here"))
  3632. (setq txt (concat "\n" (org-no-properties
  3633. (org-agenda-get-some-entry-text
  3634. m org-agenda-entry-text-maxlines
  3635. org-agenda-entry-text-leaders))))
  3636. (when (string-match "\\S-" txt)
  3637. (setq o (make-overlay (point-at-bol) (point-at-eol)))
  3638. (overlay-put o 'evaporate t)
  3639. (overlay-put o 'org-overlay-type 'agenda-entry-content)
  3640. (overlay-put o 'after-string txt))))
  3641. (defun org-agenda-entry-text-show ()
  3642. "Add entry context for all agenda lines."
  3643. (interactive)
  3644. (save-excursion
  3645. (goto-char (point-max))
  3646. (beginning-of-line 1)
  3647. (while (not (bobp))
  3648. (when (org-get-at-bol 'org-hd-marker)
  3649. (org-agenda-entry-text-show-here))
  3650. (beginning-of-line 0))))
  3651. (defun org-agenda-entry-text-hide ()
  3652. "Remove any shown entry context."
  3653. (delq nil
  3654. (mapcar (lambda (o)
  3655. (if (eq (overlay-get o 'org-overlay-type)
  3656. 'agenda-entry-content)
  3657. (progn (delete-overlay o) t)))
  3658. (overlays-in (point-min) (point-max)))))
  3659. (defun org-agenda-get-day-face (date)
  3660. "Return the face DATE should be displayed with."
  3661. (or (and (functionp org-agenda-day-face-function)
  3662. (funcall org-agenda-day-face-function date))
  3663. (cond ((org-agenda-todayp date)
  3664. 'org-agenda-date-today)
  3665. ((member (calendar-day-of-week date) org-agenda-weekend-days)
  3666. 'org-agenda-date-weekend)
  3667. (t 'org-agenda-date))))
  3668. ;;; Agenda timeline
  3669. (defvar org-agenda-only-exact-dates nil) ; dynamically scoped
  3670. (defvar org-agenda-show-log-scoped) ;; dynamically scope in `org-timeline' or `org-agenda-list'
  3671. (defun org-timeline (&optional dotodo)
  3672. "Show a time-sorted view of the entries in the current org file.
  3673. Only entries with a time stamp of today or later will be listed. With
  3674. \\[universal-argument] prefix, all unfinished TODO items will also be shown,
  3675. under the current date.
  3676. If the buffer contains an active region, only check the region for
  3677. dates."
  3678. (interactive "P")
  3679. (let* ((dopast t)
  3680. (org-agenda-show-log-scoped org-agenda-show-log)
  3681. (org-agenda-show-log org-agenda-show-log-scoped)
  3682. (entry (buffer-file-name (or (buffer-base-buffer (current-buffer))
  3683. (current-buffer))))
  3684. (date (calendar-current-date))
  3685. (beg (if (org-region-active-p) (region-beginning) (point-min)))
  3686. (end (if (org-region-active-p) (region-end) (point-max)))
  3687. (day-numbers (org-get-all-dates
  3688. beg end 'no-ranges
  3689. t org-agenda-show-log-scoped ; always include today
  3690. org-timeline-show-empty-dates))
  3691. (org-deadline-warning-days 0)
  3692. (org-agenda-only-exact-dates t)
  3693. (today (org-today))
  3694. (past t)
  3695. args
  3696. s e rtn d emptyp)
  3697. (setq org-agenda-redo-command
  3698. (list 'let
  3699. (list (list 'org-agenda-show-log 'org-agenda-show-log))
  3700. (list 'org-switch-to-buffer-other-window (current-buffer))
  3701. (list 'org-timeline (list 'quote dotodo))))
  3702. (put 'org-agenda-redo-command 'org-lprops nil)
  3703. (if (not dopast)
  3704. ;; Remove past dates from the list of dates.
  3705. (setq day-numbers (delq nil (mapcar (lambda(x)
  3706. (if (>= x today) x nil))
  3707. day-numbers))))
  3708. (org-agenda-prepare (concat "Timeline " (file-name-nondirectory entry)))
  3709. (org-compile-prefix-format 'timeline)
  3710. (org-set-sorting-strategy 'timeline)
  3711. (if org-agenda-show-log-scoped (push :closed args))
  3712. (push :timestamp args)
  3713. (push :deadline args)
  3714. (push :scheduled args)
  3715. (push :sexp args)
  3716. (if dotodo (push :todo args))
  3717. (insert "Timeline of file " entry "\n")
  3718. (add-text-properties (point-min) (point)
  3719. (list 'face 'org-agenda-structure))
  3720. (org-agenda-mark-header-line (point-min))
  3721. (while (setq d (pop day-numbers))
  3722. (if (and (listp d) (eq (car d) :omitted))
  3723. (progn
  3724. (setq s (point))
  3725. (insert (format "\n[... %d empty days omitted]\n\n" (cdr d)))
  3726. (put-text-property s (1- (point)) 'face 'org-agenda-structure))
  3727. (if (listp d) (setq d (car d) emptyp t) (setq emptyp nil))
  3728. (if (and (>= d today)
  3729. dopast
  3730. past)
  3731. (progn
  3732. (setq past nil)
  3733. (insert (make-string 79 ?-) "\n")))
  3734. (setq date (calendar-gregorian-from-absolute d))
  3735. (setq s (point))
  3736. (setq rtn (and (not emptyp)
  3737. (apply 'org-agenda-get-day-entries entry
  3738. date args)))
  3739. (if (or rtn (equal d today) org-timeline-show-empty-dates)
  3740. (progn
  3741. (insert
  3742. (if (stringp org-agenda-format-date)
  3743. (format-time-string org-agenda-format-date
  3744. (org-time-from-absolute date))
  3745. (funcall org-agenda-format-date date))
  3746. "\n")
  3747. (put-text-property s (1- (point)) 'face
  3748. (org-agenda-get-day-face date))
  3749. (put-text-property s (1- (point)) 'org-date-line t)
  3750. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3751. (if (equal d today)
  3752. (put-text-property s (1- (point)) 'org-today t))
  3753. (and rtn (insert (org-agenda-finalize-entries rtn 'timeline) "\n"))
  3754. (put-text-property s (1- (point)) 'day d)))))
  3755. (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
  3756. (point-min)))
  3757. (add-text-properties
  3758. (point-min) (point-max)
  3759. `(org-agenda-type timeline org-redo-cmd ,org-agenda-redo-command))
  3760. (org-agenda-finalize)
  3761. (setq buffer-read-only t)))
  3762. (defun org-get-all-dates (beg end &optional no-ranges force-today inactive empty pre-re)
  3763. "Return a list of all relevant day numbers from BEG to END buffer positions.
  3764. If NO-RANGES is non-nil, include only the start and end dates of a range,
  3765. not every single day in the range. If FORCE-TODAY is non-nil, make
  3766. sure that TODAY is included in the list. If INACTIVE is non-nil, also
  3767. inactive time stamps (those in square brackets) are included.
  3768. When EMPTY is non-nil, also include days without any entries."
  3769. (let ((re (concat
  3770. (if pre-re pre-re "")
  3771. (if inactive org-ts-regexp-both org-ts-regexp)))
  3772. dates dates1 date day day1 day2 ts1 ts2 pos)
  3773. (if force-today
  3774. (setq dates (list (org-today))))
  3775. (save-excursion
  3776. (goto-char beg)
  3777. (while (re-search-forward re end t)
  3778. (setq day (time-to-days (org-time-string-to-time
  3779. (substring (match-string 1) 0 10)
  3780. (current-buffer) (match-beginning 0))))
  3781. (or (memq day dates) (push day dates)))
  3782. (unless no-ranges
  3783. (goto-char beg)
  3784. (while (re-search-forward org-tr-regexp end t)
  3785. (setq pos (match-beginning 0))
  3786. (setq ts1 (substring (match-string 1) 0 10)
  3787. ts2 (substring (match-string 2) 0 10)
  3788. day1 (time-to-days (org-time-string-to-time
  3789. ts1 (current-buffer) pos))
  3790. day2 (time-to-days (org-time-string-to-time
  3791. ts2 (current-buffer) pos)))
  3792. (while (< (setq day1 (1+ day1)) day2)
  3793. (or (memq day1 dates) (push day1 dates)))))
  3794. (setq dates (sort dates '<))
  3795. (when empty
  3796. (while (setq day (pop dates))
  3797. (setq day2 (car dates))
  3798. (push day dates1)
  3799. (when (and day2 empty)
  3800. (if (or (eq empty t)
  3801. (and (numberp empty) (<= (- day2 day) empty)))
  3802. (while (< (setq day (1+ day)) day2)
  3803. (push (list day) dates1))
  3804. (push (cons :omitted (- day2 day)) dates1))))
  3805. (setq dates (nreverse dates1)))
  3806. dates)))
  3807. ;;; Agenda Daily/Weekly
  3808. (defvar org-agenda-start-day nil ; dynamically scoped parameter
  3809. "Start day for the agenda view.
  3810. Custom commands can set this variable in the options section.
  3811. This is usually a string like \"2007-11-01\", \"+2d\" or any other
  3812. input allowed when reading a date through the Org calendar.
  3813. See the docstring of `org-read-date' for details.")
  3814. (defvar org-starting-day nil) ; local variable in the agenda buffer
  3815. (defvar org-arg-loc nil) ; local variable
  3816. (defvar org-agenda-buffer-tmp-name nil)
  3817. ;;;###autoload
  3818. (defun org-agenda-list (&optional arg start-day span with-hour)
  3819. "Produce a daily/weekly view from all files in variable `org-agenda-files'.
  3820. The view will be for the current day or week, but from the overview buffer
  3821. you will be able to go to other days/weeks.
  3822. With a numeric prefix argument in an interactive call, the agenda will
  3823. span ARG days. Lisp programs should instead specify SPAN to change
  3824. the number of days. SPAN defaults to `org-agenda-span'.
  3825. START-DAY defaults to TODAY, or to the most recent match for the weekday
  3826. given in `org-agenda-start-on-weekday'.
  3827. When WITH-HOUR is non-nil, only include scheduled and deadline
  3828. items if they have an hour specification like [h]h:mm."
  3829. (interactive "P")
  3830. (if org-agenda-overriding-arguments
  3831. (setq arg (car org-agenda-overriding-arguments)
  3832. start-day (nth 1 org-agenda-overriding-arguments)
  3833. span (nth 2 org-agenda-overriding-arguments)))
  3834. (if (and (integerp arg) (> arg 0))
  3835. (setq span arg arg nil))
  3836. (catch 'exit
  3837. (setq org-agenda-buffer-name
  3838. (or org-agenda-buffer-tmp-name
  3839. (if org-agenda-sticky
  3840. (cond ((and org-keys (stringp org-match))
  3841. (format "*Org Agenda(%s:%s)*" org-keys org-match))
  3842. (org-keys
  3843. (format "*Org Agenda(%s)*" org-keys))
  3844. (t "*Org Agenda(a)*")))
  3845. org-agenda-buffer-name))
  3846. (org-agenda-prepare "Day/Week")
  3847. (setq start-day (or start-day org-agenda-start-day))
  3848. (if (stringp start-day)
  3849. ;; Convert to an absolute day number
  3850. (setq start-day (time-to-days (org-read-date nil t start-day))))
  3851. (org-compile-prefix-format 'agenda)
  3852. (org-set-sorting-strategy 'agenda)
  3853. (let* ((span (org-agenda-ndays-to-span
  3854. (or span org-agenda-ndays org-agenda-span)))
  3855. (today (org-today))
  3856. (sd (or start-day today))
  3857. (ndays (org-agenda-span-to-ndays span sd))
  3858. (org-agenda-start-on-weekday
  3859. (if (or (eq ndays 7) (eq ndays 14))
  3860. org-agenda-start-on-weekday))
  3861. (thefiles (org-agenda-files nil 'ifmode))
  3862. (files thefiles)
  3863. (start (if (or (null org-agenda-start-on-weekday)
  3864. (< ndays 7))
  3865. sd
  3866. (let* ((nt (calendar-day-of-week
  3867. (calendar-gregorian-from-absolute sd)))
  3868. (n1 org-agenda-start-on-weekday)
  3869. (d (- nt n1)))
  3870. (- sd (+ (if (< d 0) 7 0) d)))))
  3871. (day-numbers (list start))
  3872. (day-cnt 0)
  3873. (inhibit-redisplay (not debug-on-error))
  3874. (org-agenda-show-log-scoped org-agenda-show-log)
  3875. s e rtn rtnall file date d start-pos end-pos todayp
  3876. clocktable-start clocktable-end filter)
  3877. (setq org-agenda-redo-command
  3878. (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span) with-hour))
  3879. (dotimes (n (1- ndays))
  3880. (push (1+ (car day-numbers)) day-numbers))
  3881. (setq day-numbers (nreverse day-numbers))
  3882. (setq clocktable-start (car day-numbers)
  3883. clocktable-end (1+ (or (org-last day-numbers) 0)))
  3884. (org-set-local 'org-starting-day (car day-numbers))
  3885. (org-set-local 'org-arg-loc arg)
  3886. (org-set-local 'org-agenda-current-span (org-agenda-ndays-to-span span))
  3887. (unless org-agenda-compact-blocks
  3888. (let* ((d1 (car day-numbers))
  3889. (d2 (org-last day-numbers))
  3890. (w1 (org-days-to-iso-week d1))
  3891. (w2 (org-days-to-iso-week d2)))
  3892. (setq s (point))
  3893. (if org-agenda-overriding-header
  3894. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  3895. nil 'face 'org-agenda-structure) "\n")
  3896. (insert (org-agenda-span-name span)
  3897. "-agenda"
  3898. (if (< (- d2 d1) 350)
  3899. (if (= w1 w2)
  3900. (format " (W%02d)" w1)
  3901. (format " (W%02d-W%02d)" w1 w2))
  3902. "")
  3903. ":\n")))
  3904. (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
  3905. 'org-date-line t))
  3906. (org-agenda-mark-header-line s))
  3907. (while (setq d (pop day-numbers))
  3908. (setq date (calendar-gregorian-from-absolute d)
  3909. s (point))
  3910. (if (or (setq todayp (= d today))
  3911. (and (not start-pos) (= d sd)))
  3912. (setq start-pos (point))
  3913. (if (and start-pos (not end-pos))
  3914. (setq end-pos (point))))
  3915. (setq files thefiles
  3916. rtnall nil)
  3917. (while (setq file (pop files))
  3918. (catch 'nextfile
  3919. (org-check-agenda-file file)
  3920. (let ((org-agenda-entry-types org-agenda-entry-types))
  3921. ;; Starred types override non-starred equivalents
  3922. (when (member :deadline* org-agenda-entry-types)
  3923. (setq org-agenda-entry-types
  3924. (delq :deadline org-agenda-entry-types)))
  3925. (when (member :scheduled* org-agenda-entry-types)
  3926. (setq org-agenda-entry-types
  3927. (delq :scheduled org-agenda-entry-types)))
  3928. ;; Honor with-hour
  3929. (when with-hour
  3930. (when (member :deadline org-agenda-entry-types)
  3931. (setq org-agenda-entry-types
  3932. (delq :deadline org-agenda-entry-types))
  3933. (push :deadline* org-agenda-entry-types))
  3934. (when (member :scheduled org-agenda-entry-types)
  3935. (setq org-agenda-entry-types
  3936. (delq :scheduled org-agenda-entry-types))
  3937. (push :scheduled* org-agenda-entry-types)))
  3938. (unless org-agenda-include-deadlines
  3939. (setq org-agenda-entry-types
  3940. (delq :deadline* (delq :deadline org-agenda-entry-types))))
  3941. (cond
  3942. ((memq org-agenda-show-log-scoped '(only clockcheck))
  3943. (setq rtn (org-agenda-get-day-entries
  3944. file date :closed)))
  3945. (org-agenda-show-log-scoped
  3946. (setq rtn (apply 'org-agenda-get-day-entries
  3947. file date
  3948. (append '(:closed) org-agenda-entry-types))))
  3949. (t
  3950. (setq rtn (apply 'org-agenda-get-day-entries
  3951. file date
  3952. org-agenda-entry-types)))))
  3953. (setq rtnall (append rtnall rtn)))) ;; all entries
  3954. (if org-agenda-include-diary
  3955. (let ((org-agenda-search-headline-for-time t))
  3956. (require 'diary-lib)
  3957. (setq rtn (org-get-entries-from-diary date))
  3958. (setq rtnall (append rtnall rtn))))
  3959. (if (or rtnall org-agenda-show-all-dates)
  3960. (progn
  3961. (setq day-cnt (1+ day-cnt))
  3962. (insert
  3963. (if (stringp org-agenda-format-date)
  3964. (format-time-string org-agenda-format-date
  3965. (org-time-from-absolute date))
  3966. (funcall org-agenda-format-date date))
  3967. "\n")
  3968. (put-text-property s (1- (point)) 'face
  3969. (org-agenda-get-day-face date))
  3970. (put-text-property s (1- (point)) 'org-date-line t)
  3971. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3972. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
  3973. (when todayp
  3974. (put-text-property s (1- (point)) 'org-today t))
  3975. (setq rtnall
  3976. (org-agenda-add-time-grid-maybe rtnall ndays todayp))
  3977. (if rtnall (insert ;; all entries
  3978. (org-agenda-finalize-entries rtnall 'agenda)
  3979. "\n"))
  3980. (put-text-property s (1- (point)) 'day d)
  3981. (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
  3982. (when (and org-agenda-clockreport-mode clocktable-start)
  3983. (let ((org-agenda-files (org-agenda-files nil 'ifmode))
  3984. ;; the above line is to ensure the restricted range!
  3985. (p (copy-sequence org-agenda-clockreport-parameter-plist))
  3986. tbl)
  3987. (setq p (org-plist-delete p :block))
  3988. (setq p (plist-put p :tstart clocktable-start))
  3989. (setq p (plist-put p :tend clocktable-end))
  3990. (setq p (plist-put p :scope 'agenda))
  3991. (setq tbl (apply 'org-clock-get-clocktable p))
  3992. (insert tbl)))
  3993. (goto-char (point-min))
  3994. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3995. (unless (and (pos-visible-in-window-p (point-min))
  3996. (pos-visible-in-window-p (point-max)))
  3997. (goto-char (1- (point-max)))
  3998. (recenter -1)
  3999. (if (not (pos-visible-in-window-p (or start-pos 1)))
  4000. (progn
  4001. (goto-char (or start-pos 1))
  4002. (recenter 1))))
  4003. (goto-char (or start-pos 1))
  4004. (add-text-properties (point-min) (point-max)
  4005. `(org-agenda-type agenda
  4006. org-last-args (,arg ,start-day ,span)
  4007. org-redo-cmd ,org-agenda-redo-command
  4008. org-series-cmd ,org-cmd))
  4009. (if (eq org-agenda-show-log-scoped 'clockcheck)
  4010. (org-agenda-show-clocking-issues))
  4011. (org-agenda-finalize)
  4012. (setq buffer-read-only t)
  4013. (message ""))))
  4014. (defun org-agenda-ndays-to-span (n)
  4015. "Return a span symbol for a span of N days, or N if none matches."
  4016. (cond ((symbolp n) n)
  4017. ((= n 1) 'day)
  4018. ((= n 7) 'week)
  4019. ((= n 14) 'fortnight)
  4020. (t n)))
  4021. (defun org-agenda-span-to-ndays (span &optional start-day)
  4022. "Return ndays from SPAN, possibly starting at START-DAY.
  4023. START-DAY is an absolute time value."
  4024. (cond ((numberp span) span)
  4025. ((eq span 'day) 1)
  4026. ((eq span 'week) 7)
  4027. ((eq span 'fortnight) 14)
  4028. ((eq span 'month)
  4029. (let ((date (calendar-gregorian-from-absolute start-day)))
  4030. (calendar-last-day-of-month (car date) (caddr date))))
  4031. ((eq span 'year)
  4032. (let ((date (calendar-gregorian-from-absolute start-day)))
  4033. (if (calendar-leap-year-p (caddr date)) 366 365)))))
  4034. (defun org-agenda-span-name (span)
  4035. "Return a SPAN name."
  4036. (if (null span)
  4037. ""
  4038. (if (symbolp span)
  4039. (capitalize (symbol-name span))
  4040. (format "%d days" span))))
  4041. ;;; Agenda word search
  4042. (defvar org-agenda-search-history nil)
  4043. (defvar org-search-syntax-table nil
  4044. "Special syntax table for org-mode search.
  4045. In this table, we have single quotes not as word constituents, to
  4046. that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
  4047. (defvar org-mode-syntax-table) ; From org.el
  4048. (defun org-search-syntax-table ()
  4049. (unless org-search-syntax-table
  4050. (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
  4051. (modify-syntax-entry ?' "." org-search-syntax-table)
  4052. (modify-syntax-entry ?` "." org-search-syntax-table))
  4053. org-search-syntax-table)
  4054. (defvar org-agenda-last-search-view-search-was-boolean nil)
  4055. ;;;###autoload
  4056. (defun org-search-view (&optional todo-only string edit-at)
  4057. "Show all entries that contain a phrase or words or regular expressions.
  4058. With optional prefix argument TODO-ONLY, only consider entries that are
  4059. TODO entries. The argument STRING can be used to pass a default search
  4060. string into this function. If EDIT-AT is non-nil, it means that the
  4061. user should get a chance to edit this string, with cursor at position
  4062. EDIT-AT.
  4063. The search string can be viewed either as a phrase that should be found as
  4064. is, or it can be broken into a number of snippets, each of which must match
  4065. in a Boolean way to select an entry. The default depends on the variable
  4066. `org-agenda-search-view-always-boolean'.
  4067. Even if this is turned off (the default) you can always switch to
  4068. Boolean search dynamically by preceding the first word with \"+\" or \"-\".
  4069. The default is a direct search of the whole phrase, where each space in
  4070. the search string can expand to an arbitrary amount of whitespace,
  4071. including newlines.
  4072. If using a Boolean search, the search string is split on whitespace and
  4073. each snippet is searched separately, with logical AND to select an entry.
  4074. Words prefixed with a minus must *not* occur in the entry. Words without
  4075. a prefix or prefixed with a plus must occur in the entry. Matching is
  4076. case-insensitive. Words are enclosed by word delimiters (i.e. they must
  4077. match whole words, not parts of a word) if
  4078. `org-agenda-search-view-force-full-words' is set (default is nil).
  4079. Boolean search snippets enclosed by curly braces are interpreted as
  4080. regular expressions that must or (when preceded with \"-\") must not
  4081. match in the entry. Snippets enclosed into double quotes will be taken
  4082. as a whole, to include whitespace.
  4083. - If the search string starts with an asterisk, search only in headlines.
  4084. - If (possibly after the leading star) the search string starts with an
  4085. exclamation mark, this also means to look at TODO entries only, an effect
  4086. that can also be achieved with a prefix argument.
  4087. - If (possibly after star and exclamation mark) the search string starts
  4088. with a colon, this will mean that the (non-regexp) snippets of the
  4089. Boolean search must match as full words.
  4090. This command searches the agenda files, and in addition the files listed
  4091. in `org-agenda-text-search-extra-files'."
  4092. (interactive "P")
  4093. (if org-agenda-overriding-arguments
  4094. (setq todo-only (car org-agenda-overriding-arguments)
  4095. string (nth 1 org-agenda-overriding-arguments)
  4096. edit-at (nth 2 org-agenda-overriding-arguments)))
  4097. (let* ((props (list 'face nil
  4098. 'done-face 'org-agenda-done
  4099. 'org-not-done-regexp org-not-done-regexp
  4100. 'org-todo-regexp org-todo-regexp
  4101. 'org-complex-heading-regexp org-complex-heading-regexp
  4102. 'mouse-face 'highlight
  4103. 'help-echo (format "mouse-2 or RET jump to location")))
  4104. (full-words org-agenda-search-view-force-full-words)
  4105. (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
  4106. regexp rtn rtnall files file pos inherited-tags
  4107. marker category level tags c neg re boolean
  4108. ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
  4109. (unless (and (not edit-at)
  4110. (stringp string)
  4111. (string-match "\\S-" string))
  4112. (setq string (read-string
  4113. (if org-agenda-search-view-always-boolean
  4114. "[+-]Word/{Regexp} ...: "
  4115. "Phrase or [+-]Word/{Regexp} ...: ")
  4116. (cond
  4117. ((integerp edit-at) (cons string edit-at))
  4118. (edit-at string))
  4119. 'org-agenda-search-history)))
  4120. (catch 'exit
  4121. (if org-agenda-sticky
  4122. (setq org-agenda-buffer-name
  4123. (if (stringp string)
  4124. (format "*Org Agenda(%s:%s)*"
  4125. (or org-keys (or (and todo-only "S") "s")) string)
  4126. (format "*Org Agenda(%s)*" (or (and todo-only "S") "s")))))
  4127. (org-agenda-prepare "SEARCH")
  4128. (org-compile-prefix-format 'search)
  4129. (org-set-sorting-strategy 'search)
  4130. (setq org-agenda-redo-command
  4131. (list 'org-search-view (if todo-only t nil)
  4132. (list 'if 'current-prefix-arg nil string)))
  4133. (setq org-agenda-query-string string)
  4134. (if (equal (string-to-char string) ?*)
  4135. (setq hdl-only t
  4136. words (substring string 1))
  4137. (setq words string))
  4138. (when (equal (string-to-char words) ?!)
  4139. (setq todo-only t
  4140. words (substring words 1)))
  4141. (when (equal (string-to-char words) ?:)
  4142. (setq full-words t
  4143. words (substring words 1)))
  4144. (if (or org-agenda-search-view-always-boolean
  4145. (member (string-to-char words) '(?- ?+ ?\{)))
  4146. (setq boolean t))
  4147. (setq words (org-split-string words))
  4148. (let (www w)
  4149. (while (setq w (pop words))
  4150. (while (and (string-match "\\\\\\'" w) words)
  4151. (setq w (concat (substring w 0 -1) " " (pop words))))
  4152. (push w www))
  4153. (setq words (nreverse www) www nil)
  4154. (while (setq w (pop words))
  4155. (when (and (string-match "\\`[-+]?{" w)
  4156. (not (string-match "}\\'" w)))
  4157. (while (and words (not (string-match "}\\'" (car words))))
  4158. (setq w (concat w " " (pop words))))
  4159. (setq w (concat w " " (pop words))))
  4160. (push w www))
  4161. (setq words (nreverse www)))
  4162. (setq org-agenda-last-search-view-search-was-boolean boolean)
  4163. (when boolean
  4164. (let (wds w)
  4165. (while (setq w (pop words))
  4166. (if (or (equal (substring w 0 1) "\"")
  4167. (and (> (length w) 1)
  4168. (member (substring w 0 1) '("+" "-"))
  4169. (equal (substring w 1 2) "\"")))
  4170. (while (and words (not (equal (substring w -1) "\"")))
  4171. (setq w (concat w " " (pop words)))))
  4172. (and (string-match "\\`\\([-+]?\\)\"" w)
  4173. (setq w (replace-match "\\1" nil nil w)))
  4174. (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
  4175. (push w wds))
  4176. (setq words (nreverse wds))))
  4177. (if boolean
  4178. (mapc (lambda (w)
  4179. (setq c (string-to-char w))
  4180. (if (equal c ?-)
  4181. (setq neg t w (substring w 1))
  4182. (if (equal c ?+)
  4183. (setq neg nil w (substring w 1))
  4184. (setq neg nil)))
  4185. (if (string-match "\\`{.*}\\'" w)
  4186. (setq re (substring w 1 -1))
  4187. (if full-words
  4188. (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
  4189. (setq re (regexp-quote (downcase w)))))
  4190. (if neg (push re regexps-) (push re regexps+)))
  4191. words)
  4192. (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
  4193. regexps+))
  4194. (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
  4195. (if (not regexps+)
  4196. (setq regexp org-outline-regexp-bol)
  4197. (setq regexp (pop regexps+))
  4198. (if hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
  4199. regexp))))
  4200. (setq files (org-agenda-files nil 'ifmode))
  4201. (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
  4202. (pop org-agenda-text-search-extra-files)
  4203. (setq files (org-add-archive-files files)))
  4204. (setq files (append files org-agenda-text-search-extra-files)
  4205. rtnall nil)
  4206. (while (setq file (pop files))
  4207. (setq ee nil)
  4208. (catch 'nextfile
  4209. (org-check-agenda-file file)
  4210. (setq buffer (if (file-exists-p file)
  4211. (org-get-agenda-file-buffer file)
  4212. (error "No such file %s" file)))
  4213. (if (not buffer)
  4214. ;; If file does not exist, make sure an error message is sent
  4215. (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
  4216. file))))
  4217. (with-current-buffer buffer
  4218. (with-syntax-table (org-search-syntax-table)
  4219. (unless (derived-mode-p 'org-mode)
  4220. (error "Agenda file %s is not in `org-mode'" file))
  4221. (let ((case-fold-search t))
  4222. (save-excursion
  4223. (save-restriction
  4224. (if (eq buffer org-agenda-restrict)
  4225. (narrow-to-region org-agenda-restrict-begin
  4226. org-agenda-restrict-end)
  4227. (widen))
  4228. (goto-char (point-min))
  4229. (unless (or (org-at-heading-p)
  4230. (outline-next-heading))
  4231. (throw 'nextfile t))
  4232. (goto-char (max (point-min) (1- (point))))
  4233. (while (re-search-forward regexp nil t)
  4234. (org-back-to-heading t)
  4235. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4236. (> (org-reduced-level (org-outline-level))
  4237. org-agenda-search-view-max-outline-level)
  4238. (forward-line -1)
  4239. (org-back-to-heading t)))
  4240. (skip-chars-forward "* ")
  4241. (setq beg (point-at-bol)
  4242. beg1 (point)
  4243. end (progn
  4244. (outline-next-heading)
  4245. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4246. (> (org-reduced-level (org-outline-level))
  4247. org-agenda-search-view-max-outline-level)
  4248. (forward-line 1)
  4249. (outline-next-heading)))
  4250. (point)))
  4251. (catch :skip
  4252. (goto-char beg)
  4253. (org-agenda-skip)
  4254. (setq str (buffer-substring-no-properties
  4255. (point-at-bol)
  4256. (if hdl-only (point-at-eol) end)))
  4257. (mapc (lambda (wr) (when (string-match wr str)
  4258. (goto-char (1- end))
  4259. (throw :skip t)))
  4260. regexps-)
  4261. (mapc (lambda (wr) (unless (string-match wr str)
  4262. (goto-char (1- end))
  4263. (throw :skip t)))
  4264. (if todo-only
  4265. (cons (concat "^\\*+[ \t]+"
  4266. org-not-done-regexp)
  4267. regexps+)
  4268. regexps+))
  4269. (goto-char beg)
  4270. (setq marker (org-agenda-new-marker (point))
  4271. category (org-get-category)
  4272. level (make-string (org-reduced-level (org-outline-level)) ? )
  4273. inherited-tags
  4274. (or (eq org-agenda-show-inherited-tags 'always)
  4275. (and (listp org-agenda-show-inherited-tags)
  4276. (memq 'todo org-agenda-show-inherited-tags))
  4277. (and (eq org-agenda-show-inherited-tags t)
  4278. (or (eq org-agenda-use-tag-inheritance t)
  4279. (memq 'todo org-agenda-use-tag-inheritance))))
  4280. tags (org-get-tags-at nil (not inherited-tags))
  4281. txt (org-agenda-format-item
  4282. ""
  4283. (buffer-substring-no-properties
  4284. beg1 (point-at-eol))
  4285. level category tags t))
  4286. (org-add-props txt props
  4287. 'org-marker marker 'org-hd-marker marker
  4288. 'org-todo-regexp org-todo-regexp
  4289. 'level level
  4290. 'org-complex-heading-regexp org-complex-heading-regexp
  4291. 'priority 1000
  4292. 'type "search")
  4293. (push txt ee)
  4294. (goto-char (1- end))))))))))
  4295. (setq rtn (nreverse ee))
  4296. (setq rtnall (append rtnall rtn)))
  4297. (if org-agenda-overriding-header
  4298. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4299. nil 'face 'org-agenda-structure) "\n")
  4300. (insert "Search words: ")
  4301. (add-text-properties (point-min) (1- (point))
  4302. (list 'face 'org-agenda-structure))
  4303. (setq pos (point))
  4304. (insert string "\n")
  4305. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4306. (setq pos (point))
  4307. (unless org-agenda-multi
  4308. (insert (substitute-command-keys "\
  4309. Press `\\[org-agenda-manipulate-query-add]', \
  4310. `\\[org-agenda-manipulate-query-subtract]' to add/sub word, \
  4311. `\\[org-agenda-manipulate-query-add-re]', \
  4312. `\\[org-agenda-manipulate-query-subtract-re]' to add/sub regexp, \
  4313. `\\[universal-argument] \\[org-agenda-redo]' to edit\n"))
  4314. (add-text-properties pos (1- (point))
  4315. (list 'face 'org-agenda-structure))))
  4316. (org-agenda-mark-header-line (point-min))
  4317. (when rtnall
  4318. (insert (org-agenda-finalize-entries rtnall 'search) "\n"))
  4319. (goto-char (point-min))
  4320. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4321. (add-text-properties (point-min) (point-max)
  4322. `(org-agenda-type search
  4323. org-last-args (,todo-only ,string ,edit-at)
  4324. org-redo-cmd ,org-agenda-redo-command
  4325. org-series-cmd ,org-cmd))
  4326. (org-agenda-finalize)
  4327. (setq buffer-read-only t))))
  4328. ;;; Agenda TODO list
  4329. (defun org-agenda-propertize-selected-todo-keywords (keywords)
  4330. "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
  4331. (concat
  4332. (if (or (equal keywords "ALL") (not keywords))
  4333. (propertize "ALL" 'face 'warning)
  4334. (mapconcat
  4335. (lambda (kw)
  4336. (propertize kw 'face (org-get-todo-face kw)))
  4337. (org-split-string keywords "|")
  4338. "|"))
  4339. "\n"))
  4340. (defvar org-select-this-todo-keyword nil)
  4341. (defvar org-last-arg nil)
  4342. ;;;###autoload
  4343. (defun org-todo-list (&optional arg)
  4344. "Show all (not done) TODO entries from all agenda file in a single list.
  4345. The prefix arg can be used to select a specific TODO keyword and limit
  4346. the list to these. When using \\[universal-argument], you will be prompted
  4347. for a keyword. A numeric prefix directly selects the Nth keyword in
  4348. `org-todo-keywords-1'."
  4349. (interactive "P")
  4350. (if org-agenda-overriding-arguments
  4351. (setq arg org-agenda-overriding-arguments))
  4352. (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
  4353. (let* ((today (org-today))
  4354. (date (calendar-gregorian-from-absolute today))
  4355. (kwds org-todo-keywords-for-agenda)
  4356. (completion-ignore-case t)
  4357. (org-select-this-todo-keyword
  4358. (if (stringp arg) arg
  4359. (and arg (integerp arg) (> arg 0)
  4360. (nth (1- arg) kwds))))
  4361. rtn rtnall files file pos)
  4362. (when (equal arg '(4))
  4363. (setq org-select-this-todo-keyword
  4364. (org-icompleting-read "Keyword (or KWD1|K2D2|...): "
  4365. (mapcar 'list kwds) nil nil)))
  4366. (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
  4367. (catch 'exit
  4368. (if org-agenda-sticky
  4369. (setq org-agenda-buffer-name
  4370. (if (stringp org-select-this-todo-keyword)
  4371. (format "*Org Agenda(%s:%s)*" (or org-keys "t")
  4372. org-select-this-todo-keyword)
  4373. (format "*Org Agenda(%s)*" (or org-keys "t")))))
  4374. (org-agenda-prepare "TODO")
  4375. (org-compile-prefix-format 'todo)
  4376. (org-set-sorting-strategy 'todo)
  4377. (setq org-agenda-redo-command
  4378. `(org-todo-list (or (and (numberp current-prefix-arg)
  4379. current-prefix-arg)
  4380. ,org-select-this-todo-keyword
  4381. current-prefix-arg ,arg)))
  4382. (setq files (org-agenda-files nil 'ifmode)
  4383. rtnall nil)
  4384. (while (setq file (pop files))
  4385. (catch 'nextfile
  4386. (org-check-agenda-file file)
  4387. (setq rtn (org-agenda-get-day-entries file date :todo))
  4388. (setq rtnall (append rtnall rtn))))
  4389. (if org-agenda-overriding-header
  4390. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4391. nil 'face 'org-agenda-structure) "\n")
  4392. (insert "Global list of TODO items of type: ")
  4393. (add-text-properties (point-min) (1- (point))
  4394. (list 'face 'org-agenda-structure
  4395. 'short-heading
  4396. (concat "ToDo: "
  4397. (or org-select-this-todo-keyword "ALL"))))
  4398. (org-agenda-mark-header-line (point-min))
  4399. (insert (org-agenda-propertize-selected-todo-keywords
  4400. org-select-this-todo-keyword))
  4401. (setq pos (point))
  4402. (unless org-agenda-multi
  4403. (insert (substitute-command-keys "Available with \
  4404. `N \\[org-agenda-redo]': (0)[ALL]"))
  4405. (let ((n 0) s)
  4406. (mapc (lambda (x)
  4407. (setq s (format "(%d)%s" (setq n (1+ n)) x))
  4408. (if (> (+ (current-column) (string-width s) 1) (frame-width))
  4409. (insert "\n "))
  4410. (insert " " s))
  4411. kwds))
  4412. (insert "\n"))
  4413. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
  4414. (org-agenda-mark-header-line (point-min))
  4415. (when rtnall
  4416. (insert (org-agenda-finalize-entries rtnall 'todo) "\n"))
  4417. (goto-char (point-min))
  4418. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4419. (add-text-properties (point-min) (point-max)
  4420. `(org-agenda-type todo
  4421. org-last-args ,arg
  4422. org-redo-cmd ,org-agenda-redo-command
  4423. org-series-cmd ,org-cmd))
  4424. (org-agenda-finalize)
  4425. (setq buffer-read-only t))))
  4426. ;;; Agenda tags match
  4427. ;;;###autoload
  4428. (defun org-tags-view (&optional todo-only match)
  4429. "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
  4430. The prefix arg TODO-ONLY limits the search to TODO entries."
  4431. (interactive "P")
  4432. (if org-agenda-overriding-arguments
  4433. (setq todo-only (car org-agenda-overriding-arguments)
  4434. match (nth 1 org-agenda-overriding-arguments)))
  4435. (let* ((org-tags-match-list-sublevels
  4436. org-tags-match-list-sublevels)
  4437. (completion-ignore-case t)
  4438. rtn rtnall files file pos matcher
  4439. buffer)
  4440. (when (and (stringp match) (not (string-match "\\S-" match)))
  4441. (setq match nil))
  4442. (catch 'exit
  4443. (if org-agenda-sticky
  4444. (setq org-agenda-buffer-name
  4445. (if (stringp match)
  4446. (format "*Org Agenda(%s:%s)*"
  4447. (or org-keys (or (and todo-only "M") "m")) match)
  4448. (format "*Org Agenda(%s)*" (or (and todo-only "M") "m")))))
  4449. ;; Prepare agendas (and `org-tag-alist-for-agenda') before
  4450. ;; expanding tags within `org-make-tags-matcher'
  4451. (org-agenda-prepare (concat "TAGS " match))
  4452. (setq matcher (org-make-tags-matcher match)
  4453. match (car matcher) matcher (cdr matcher))
  4454. (org-compile-prefix-format 'tags)
  4455. (org-set-sorting-strategy 'tags)
  4456. (setq org-agenda-query-string match)
  4457. (setq org-agenda-redo-command
  4458. (list 'org-tags-view `(quote ,todo-only)
  4459. (list 'if 'current-prefix-arg nil `(quote ,org-agenda-query-string))))
  4460. (setq files (org-agenda-files nil 'ifmode)
  4461. rtnall nil)
  4462. (while (setq file (pop files))
  4463. (catch 'nextfile
  4464. (org-check-agenda-file file)
  4465. (setq buffer (if (file-exists-p file)
  4466. (org-get-agenda-file-buffer file)
  4467. (error "No such file %s" file)))
  4468. (if (not buffer)
  4469. ;; If file does not exist, error message to agenda
  4470. (setq rtn (list
  4471. (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4472. rtnall (append rtnall rtn))
  4473. (with-current-buffer buffer
  4474. (unless (derived-mode-p 'org-mode)
  4475. (error "Agenda file %s is not in `org-mode'" file))
  4476. (save-excursion
  4477. (save-restriction
  4478. (if (eq buffer org-agenda-restrict)
  4479. (narrow-to-region org-agenda-restrict-begin
  4480. org-agenda-restrict-end)
  4481. (widen))
  4482. (setq rtn (org-scan-tags 'agenda matcher todo-only))
  4483. (setq rtnall (append rtnall rtn))))))))
  4484. (if org-agenda-overriding-header
  4485. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4486. nil 'face 'org-agenda-structure) "\n")
  4487. (insert "Headlines with TAGS match: ")
  4488. (add-text-properties (point-min) (1- (point))
  4489. (list 'face 'org-agenda-structure
  4490. 'short-heading
  4491. (concat "Match: " match)))
  4492. (setq pos (point))
  4493. (insert match "\n")
  4494. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4495. (setq pos (point))
  4496. (unless org-agenda-multi
  4497. (insert (substitute-command-keys
  4498. "Press `\\[universal-argument] \\[org-agenda-redo]' \
  4499. to search again with new search string\n")))
  4500. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
  4501. (org-agenda-mark-header-line (point-min))
  4502. (when rtnall
  4503. (insert (org-agenda-finalize-entries rtnall 'tags) "\n"))
  4504. (goto-char (point-min))
  4505. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4506. (add-text-properties (point-min) (point-max)
  4507. `(org-agenda-type tags
  4508. org-last-args (,todo-only ,match)
  4509. org-redo-cmd ,org-agenda-redo-command
  4510. org-series-cmd ,org-cmd))
  4511. (org-agenda-finalize)
  4512. (setq buffer-read-only t))))
  4513. ;;; Agenda Finding stuck projects
  4514. (defvar org-agenda-skip-regexp nil
  4515. "Regular expression used in skipping subtrees for the agenda.
  4516. This is basically a temporary global variable that can be set and then
  4517. used by user-defined selections using `org-agenda-skip-function'.")
  4518. (defvar org-agenda-overriding-header nil
  4519. "When set during agenda, todo and tags searches it replaces the header.
  4520. This variable should not be set directly, but custom commands can bind it
  4521. in the options section.")
  4522. (defun org-agenda-skip-entry-when-regexp-matches ()
  4523. "Check if the current entry contains match for `org-agenda-skip-regexp'.
  4524. If yes, it returns the end position of this entry, causing agenda commands
  4525. to skip the entry but continuing the search in the subtree. This is a
  4526. function that can be put into `org-agenda-skip-function' for the duration
  4527. of a command."
  4528. (let ((end (save-excursion (org-end-of-subtree t)))
  4529. skip)
  4530. (save-excursion
  4531. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  4532. (and skip end)))
  4533. (defun org-agenda-skip-subtree-when-regexp-matches ()
  4534. "Check if the current subtree contains match for `org-agenda-skip-regexp'.
  4535. If yes, it returns the end position of this tree, causing agenda commands
  4536. to skip this subtree. This is a function that can be put into
  4537. `org-agenda-skip-function' for the duration of a command."
  4538. (let ((end (save-excursion (org-end-of-subtree t)))
  4539. skip)
  4540. (save-excursion
  4541. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  4542. (and skip end)))
  4543. (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
  4544. "Check if the current subtree contains match for `org-agenda-skip-regexp'.
  4545. If yes, it returns the end position of the current entry (NOT the tree),
  4546. causing agenda commands to skip the entry but continuing the search in
  4547. the subtree. This is a function that can be put into
  4548. `org-agenda-skip-function' for the duration of a command. An important
  4549. use of this function is for the stuck project list."
  4550. (let ((end (save-excursion (org-end-of-subtree t)))
  4551. (entry-end (save-excursion (outline-next-heading) (1- (point))))
  4552. skip)
  4553. (save-excursion
  4554. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  4555. (and skip entry-end)))
  4556. (defun org-agenda-skip-entry-if (&rest conditions)
  4557. "Skip entry if any of CONDITIONS is true.
  4558. See `org-agenda-skip-if' for details."
  4559. (org-agenda-skip-if nil conditions))
  4560. (defun org-agenda-skip-subtree-if (&rest conditions)
  4561. "Skip subtree if any of CONDITIONS is true.
  4562. See `org-agenda-skip-if' for details."
  4563. (org-agenda-skip-if t conditions))
  4564. (defun org-agenda-skip-if (subtree conditions)
  4565. "Checks current entity for CONDITIONS.
  4566. If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
  4567. the entry (i.e. the text before the next heading) is checked.
  4568. CONDITIONS is a list of symbols, boolean OR is used to combine the results
  4569. from different tests. Valid conditions are:
  4570. scheduled Check if there is a scheduled cookie
  4571. notscheduled Check if there is no scheduled cookie
  4572. deadline Check if there is a deadline
  4573. notdeadline Check if there is no deadline
  4574. timestamp Check if there is a timestamp (also deadline or scheduled)
  4575. nottimestamp Check if there is no timestamp (also deadline or scheduled)
  4576. regexp Check if regexp matches
  4577. notregexp Check if regexp does not match.
  4578. todo Check if TODO keyword matches
  4579. nottodo Check if TODO keyword does not match
  4580. The regexp is taken from the conditions list, it must come right after
  4581. the `regexp' or `notregexp' element.
  4582. `todo' and `nottodo' accept as an argument a list of todo
  4583. keywords, which may include \"*\" to match any todo keyword.
  4584. (org-agenda-skip-entry-if \\='todo \\='(\"TODO\" \"WAITING\"))
  4585. would skip all entries with \"TODO\" or \"WAITING\" keywords.
  4586. Instead of a list, a keyword class may be given. For example:
  4587. (org-agenda-skip-entry-if \\='nottodo \\='done)
  4588. would skip entries that haven't been marked with any of \"DONE\"
  4589. keywords. Possible classes are: `todo', `done', `any'.
  4590. If any of these conditions is met, this function returns the end point of
  4591. the entity, causing the search to continue from there. This is a function
  4592. that can be put into `org-agenda-skip-function' for the duration of a command."
  4593. (let (beg end m)
  4594. (org-back-to-heading t)
  4595. (setq beg (point)
  4596. end (if subtree
  4597. (progn (org-end-of-subtree t) (point))
  4598. (progn (outline-next-heading) (1- (point)))))
  4599. (goto-char beg)
  4600. (and
  4601. (or
  4602. (and (memq 'scheduled conditions)
  4603. (re-search-forward org-scheduled-time-regexp end t))
  4604. (and (memq 'notscheduled conditions)
  4605. (not (re-search-forward org-scheduled-time-regexp end t)))
  4606. (and (memq 'deadline conditions)
  4607. (re-search-forward org-deadline-time-regexp end t))
  4608. (and (memq 'notdeadline conditions)
  4609. (not (re-search-forward org-deadline-time-regexp end t)))
  4610. (and (memq 'timestamp conditions)
  4611. (re-search-forward org-ts-regexp end t))
  4612. (and (memq 'nottimestamp conditions)
  4613. (not (re-search-forward org-ts-regexp end t)))
  4614. (and (setq m (memq 'regexp conditions))
  4615. (stringp (nth 1 m))
  4616. (re-search-forward (nth 1 m) end t))
  4617. (and (setq m (memq 'notregexp conditions))
  4618. (stringp (nth 1 m))
  4619. (not (re-search-forward (nth 1 m) end t)))
  4620. (and (or
  4621. (setq m (memq 'nottodo conditions))
  4622. (setq m (memq 'todo-unblocked conditions))
  4623. (setq m (memq 'nottodo-unblocked conditions))
  4624. (setq m (memq 'todo conditions)))
  4625. (org-agenda-skip-if-todo m end)))
  4626. end)))
  4627. (defun org-agenda-skip-if-todo (args end)
  4628. "Helper function for `org-agenda-skip-if', do not use it directly.
  4629. ARGS is a list with first element either `todo', `nottodo',
  4630. `todo-unblocked' or `nottodo-unblocked'. The remainder is either
  4631. a list of TODO keywords, or a state symbol `todo' or `done' or
  4632. `any'."
  4633. (let ((kw (car args))
  4634. (arg (cadr args))
  4635. todo-wds todo-re)
  4636. (setq todo-wds
  4637. (org-uniquify
  4638. (cond
  4639. ((listp arg) ;; list of keywords
  4640. (if (member "*" arg)
  4641. (mapcar 'substring-no-properties org-todo-keywords-1)
  4642. arg))
  4643. ((symbolp arg) ;; keyword class name
  4644. (cond
  4645. ((eq arg 'todo)
  4646. (org-delete-all org-done-keywords
  4647. (mapcar 'substring-no-properties
  4648. org-todo-keywords-1)))
  4649. ((eq arg 'done) org-done-keywords)
  4650. ((eq arg 'any)
  4651. (mapcar 'substring-no-properties org-todo-keywords-1)))))))
  4652. (setq todo-re
  4653. (concat "^\\*+[ \t]+\\<\\("
  4654. (mapconcat 'identity todo-wds "\\|")
  4655. "\\)\\>"))
  4656. (cond
  4657. ((eq kw 'todo) (re-search-forward todo-re end t))
  4658. ((eq kw 'nottodo) (not (re-search-forward todo-re end t)))
  4659. ((eq kw 'todo-unblocked)
  4660. (catch 'unblocked
  4661. (while (re-search-forward todo-re end t)
  4662. (or (org-entry-blocked-p) (throw 'unblocked t)))
  4663. nil))
  4664. ((eq kw 'nottodo-unblocked)
  4665. (catch 'unblocked
  4666. (while (re-search-forward todo-re end t)
  4667. (or (org-entry-blocked-p) (throw 'unblocked nil)))
  4668. t))
  4669. )))
  4670. ;;;###autoload
  4671. (defun org-agenda-list-stuck-projects (&rest ignore)
  4672. "Create agenda view for projects that are stuck.
  4673. Stuck projects are project that have no next actions. For the definitions
  4674. of what a project is and how to check if it stuck, customize the variable
  4675. `org-stuck-projects'."
  4676. (interactive)
  4677. (let* ((org-agenda-skip-function
  4678. 'org-agenda-skip-entry-when-regexp-matches-in-subtree)
  4679. ;; We could have used org-agenda-skip-if here.
  4680. (org-agenda-overriding-header
  4681. (or org-agenda-overriding-header "List of stuck projects: "))
  4682. (matcher (nth 0 org-stuck-projects))
  4683. (todo (nth 1 org-stuck-projects))
  4684. (todo-wds (if (member "*" todo)
  4685. (progn
  4686. (org-agenda-prepare-buffers (org-agenda-files
  4687. nil 'ifmode))
  4688. (org-delete-all
  4689. org-done-keywords-for-agenda
  4690. (copy-sequence org-todo-keywords-for-agenda)))
  4691. todo))
  4692. (todo-re (concat "^\\*+[ \t]+\\("
  4693. (mapconcat 'identity todo-wds "\\|")
  4694. "\\)\\>"))
  4695. (tags (nth 2 org-stuck-projects))
  4696. (tags-re (if (member "*" tags)
  4697. (concat org-outline-regexp-bol
  4698. (org-re ".*:[[:alnum:]_@#%]+:[ \t]*$"))
  4699. (if tags
  4700. (concat org-outline-regexp-bol
  4701. ".*:\\("
  4702. (mapconcat 'identity tags "\\|")
  4703. (org-re "\\):[[:alnum:]_@#%:]*[ \t]*$")))))
  4704. (gen-re (nth 3 org-stuck-projects))
  4705. (re-list
  4706. (delq nil
  4707. (list
  4708. (if todo todo-re)
  4709. (if tags tags-re)
  4710. (and gen-re (stringp gen-re) (string-match "\\S-" gen-re)
  4711. gen-re)))))
  4712. (setq org-agenda-skip-regexp
  4713. (if re-list
  4714. (mapconcat 'identity re-list "\\|")
  4715. (error "No information how to identify unstuck projects")))
  4716. (org-tags-view nil matcher)
  4717. (setq org-agenda-buffer-name (buffer-name))
  4718. (with-current-buffer org-agenda-buffer-name
  4719. (setq org-agenda-redo-command
  4720. `(org-agenda-list-stuck-projects ,current-prefix-arg)))))
  4721. ;;; Diary integration
  4722. (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
  4723. (defvar diary-list-entries-hook)
  4724. (defvar diary-time-regexp)
  4725. (defun org-get-entries-from-diary (date)
  4726. "Get the (Emacs Calendar) diary entries for DATE."
  4727. (require 'diary-lib)
  4728. (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
  4729. (diary-display-function 'diary-fancy-display)
  4730. (pop-up-frames nil)
  4731. (diary-list-entries-hook
  4732. (cons 'org-diary-default-entry diary-list-entries-hook))
  4733. (diary-file-name-prefix nil) ; turn this feature off
  4734. (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
  4735. entries
  4736. (org-disable-agenda-to-diary t))
  4737. (save-excursion
  4738. (save-window-excursion
  4739. (funcall (if (fboundp 'diary-list-entries)
  4740. 'diary-list-entries 'list-diary-entries)
  4741. date 1)))
  4742. (if (not (get-buffer diary-fancy-buffer))
  4743. (setq entries nil)
  4744. (with-current-buffer diary-fancy-buffer
  4745. (setq buffer-read-only nil)
  4746. (if (zerop (buffer-size))
  4747. ;; No entries
  4748. (setq entries nil)
  4749. ;; Omit the date and other unnecessary stuff
  4750. (org-agenda-cleanup-fancy-diary)
  4751. ;; Add prefix to each line and extend the text properties
  4752. (if (zerop (buffer-size))
  4753. (setq entries nil)
  4754. (setq entries (buffer-substring (point-min) (- (point-max) 1)))
  4755. (setq entries
  4756. (with-temp-buffer
  4757. (insert entries) (goto-char (point-min))
  4758. (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
  4759. (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
  4760. (replace-match (concat "; " (match-string 1)))))
  4761. (buffer-string)))))
  4762. (set-buffer-modified-p nil)
  4763. (kill-buffer diary-fancy-buffer)))
  4764. (when entries
  4765. (setq entries (org-split-string entries "\n"))
  4766. (setq entries
  4767. (mapcar
  4768. (lambda (x)
  4769. (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
  4770. ;; Extend the text properties to the beginning of the line
  4771. (org-add-props x (text-properties-at (1- (length x)) x)
  4772. 'type "diary" 'date date 'face 'org-agenda-diary))
  4773. entries)))))
  4774. (defvar org-agenda-cleanup-fancy-diary-hook nil
  4775. "Hook run when the fancy diary buffer is cleaned up.")
  4776. (defun org-agenda-cleanup-fancy-diary ()
  4777. "Remove unwanted stuff in buffer created by `fancy-diary-display'.
  4778. This gets rid of the date, the underline under the date, and
  4779. the dummy entry installed by `org-mode' to ensure non-empty diary for each
  4780. date. It also removes lines that contain only whitespace."
  4781. (goto-char (point-min))
  4782. (if (looking-at ".*?:[ \t]*")
  4783. (progn
  4784. (replace-match "")
  4785. (re-search-forward "\n=+$" nil t)
  4786. (replace-match "")
  4787. (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
  4788. (re-search-forward "\n=+$" nil t)
  4789. (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
  4790. (goto-char (point-min))
  4791. (while (re-search-forward "^ +\n" nil t)
  4792. (replace-match ""))
  4793. (goto-char (point-min))
  4794. (if (re-search-forward "^Org-mode dummy\n?" nil t)
  4795. (replace-match ""))
  4796. (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
  4797. ;; Make sure entries from the diary have the right text properties.
  4798. (eval-after-load "diary-lib"
  4799. '(if (boundp 'diary-modify-entry-list-string-function)
  4800. ;; We can rely on the hook, nothing to do
  4801. nil
  4802. ;; Hook not available, must use advice to make this work
  4803. (defadvice add-to-diary-list (before org-mark-diary-entry activate)
  4804. "Make the position visible."
  4805. (if (and org-disable-agenda-to-diary ;; called from org-agenda
  4806. (stringp string)
  4807. buffer-file-name)
  4808. (setq string (org-modify-diary-entry-string string))))))
  4809. (defun org-modify-diary-entry-string (string)
  4810. "Add text properties to string, allowing org-mode to act on it."
  4811. (org-add-props string nil
  4812. 'mouse-face 'highlight
  4813. 'help-echo (if buffer-file-name
  4814. (format "mouse-2 or RET jump to diary file %s"
  4815. (abbreviate-file-name buffer-file-name))
  4816. "")
  4817. 'org-agenda-diary-link t
  4818. 'org-marker (org-agenda-new-marker (point-at-bol))))
  4819. (defun org-diary-default-entry ()
  4820. "Add a dummy entry to the diary.
  4821. Needed to avoid empty dates which mess up holiday display."
  4822. ;; Catch the error if dealing with the new add-to-diary-alist
  4823. (when org-disable-agenda-to-diary
  4824. (condition-case nil
  4825. (org-add-to-diary-list original-date "Org-mode dummy" "")
  4826. (error
  4827. (org-add-to-diary-list original-date "Org-mode dummy" "" nil)))))
  4828. (defun org-add-to-diary-list (&rest args)
  4829. (if (fboundp 'diary-add-to-list)
  4830. (apply 'diary-add-to-list args)
  4831. (apply 'add-to-diary-list args)))
  4832. (defvar org-diary-last-run-time nil)
  4833. ;;;###autoload
  4834. (defun org-diary (&rest args)
  4835. "Return diary information from org files.
  4836. This function can be used in a \"sexp\" diary entry in the Emacs calendar.
  4837. It accesses org files and extracts information from those files to be
  4838. listed in the diary. The function accepts arguments specifying what
  4839. items should be listed. For a list of arguments allowed here, see the
  4840. variable `org-agenda-entry-types'.
  4841. The call in the diary file should look like this:
  4842. &%%(org-diary) ~/path/to/some/orgfile.org
  4843. Use a separate line for each org file to check. Or, if you omit the file name,
  4844. all files listed in `org-agenda-files' will be checked automatically:
  4845. &%%(org-diary)
  4846. If you don't give any arguments (as in the example above), the default value
  4847. of `org-agenda-entry-types' is used: (:deadline :scheduled :timestamp :sexp).
  4848. So the example above may also be written as
  4849. &%%(org-diary :deadline :timestamp :sexp :scheduled)
  4850. The function expects the lisp variables `entry' and `date' to be provided
  4851. by the caller, because this is how the calendar works. Don't use this
  4852. function from a program - use `org-agenda-get-day-entries' instead."
  4853. (when (> (- (org-float-time)
  4854. org-agenda-last-marker-time)
  4855. 5)
  4856. ;; I am not sure if this works with sticky agendas, because the marker
  4857. ;; list is then no longer a global variable.
  4858. (org-agenda-reset-markers))
  4859. (org-compile-prefix-format 'agenda)
  4860. (org-set-sorting-strategy 'agenda)
  4861. (setq args (or args org-agenda-entry-types))
  4862. (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
  4863. (list entry)
  4864. (org-agenda-files t)))
  4865. (time (org-float-time))
  4866. file rtn results)
  4867. (when (or (not org-diary-last-run-time)
  4868. (> (- time
  4869. org-diary-last-run-time)
  4870. 3))
  4871. (org-agenda-prepare-buffers files))
  4872. (setq org-diary-last-run-time time)
  4873. ;; If this is called during org-agenda, don't return any entries to
  4874. ;; the calendar. Org Agenda will list these entries itself.
  4875. (if org-disable-agenda-to-diary (setq files nil))
  4876. (while (setq file (pop files))
  4877. (setq rtn (apply 'org-agenda-get-day-entries file date args))
  4878. (setq results (append results rtn)))
  4879. (when results
  4880. (setq results
  4881. (mapcar (lambda (i) (replace-regexp-in-string
  4882. org-bracket-link-regexp "\\3" i)) results))
  4883. (concat (org-agenda-finalize-entries results) "\n"))))
  4884. ;;; Agenda entry finders
  4885. (defun org-agenda-get-day-entries (file date &rest args)
  4886. "Does the work for `org-diary' and `org-agenda'.
  4887. FILE is the path to a file to be checked for entries. DATE is date like
  4888. the one returned by `calendar-current-date'. ARGS are symbols indicating
  4889. which kind of entries should be extracted. For details about these, see
  4890. the documentation of `org-diary'."
  4891. (setq args (or args org-agenda-entry-types))
  4892. (let* ((org-startup-folded nil)
  4893. (org-startup-align-all-tables nil)
  4894. (buffer (if (file-exists-p file)
  4895. (org-get-agenda-file-buffer file)
  4896. (error "No such file %s" file)))
  4897. arg results rtn deadline-results)
  4898. (if (not buffer)
  4899. ;; If file does not exist, make sure an error message ends up in diary
  4900. (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4901. (with-current-buffer buffer
  4902. (unless (derived-mode-p 'org-mode)
  4903. (error "Agenda file %s is not in `org-mode'" file))
  4904. (setq org-agenda-buffer (or org-agenda-buffer buffer))
  4905. (let ((case-fold-search nil))
  4906. (save-excursion
  4907. (save-restriction
  4908. (if (eq buffer org-agenda-restrict)
  4909. (narrow-to-region org-agenda-restrict-begin
  4910. org-agenda-restrict-end)
  4911. (widen))
  4912. ;; The way we repeatedly append to `results' makes it O(n^2) :-(
  4913. (while (setq arg (pop args))
  4914. (cond
  4915. ((and (eq arg :todo)
  4916. (equal date (calendar-gregorian-from-absolute
  4917. (org-today))))
  4918. (setq rtn (org-agenda-get-todos))
  4919. (setq results (append results rtn)))
  4920. ((eq arg :timestamp)
  4921. (setq rtn (org-agenda-get-blocks))
  4922. (setq results (append results rtn))
  4923. (setq rtn (org-agenda-get-timestamps deadline-results))
  4924. (setq results (append results rtn)))
  4925. ((eq arg :sexp)
  4926. (setq rtn (org-agenda-get-sexps))
  4927. (setq results (append results rtn)))
  4928. ((eq arg :scheduled)
  4929. (setq rtn (org-agenda-get-scheduled deadline-results))
  4930. (setq results (append results rtn)))
  4931. ((eq arg :scheduled*)
  4932. (setq rtn (org-agenda-get-scheduled deadline-results t))
  4933. (setq results (append results rtn)))
  4934. ((eq arg :closed)
  4935. (setq rtn (org-agenda-get-progress))
  4936. (setq results (append results rtn)))
  4937. ((eq arg :deadline)
  4938. (setq rtn (org-agenda-get-deadlines))
  4939. (setq deadline-results (copy-sequence rtn))
  4940. (setq results (append results rtn)))
  4941. ((eq arg :deadline*)
  4942. (setq rtn (org-agenda-get-deadlines t))
  4943. (setq deadline-results (copy-sequence rtn))
  4944. (setq results (append results rtn))))))))
  4945. results))))
  4946. (defsubst org-em (x y list)
  4947. "Is X or Y a member of LIST?"
  4948. (or (memq x list) (memq y list)))
  4949. (defvar org-heading-keyword-regexp-format) ; defined in org.el
  4950. (defvar org-agenda-sorting-strategy-selected nil)
  4951. (defun org-agenda-entry-get-agenda-timestamp (pom)
  4952. "Retrieve timestamp information for sorting agenda views.
  4953. Given a point or marker POM, returns a cons cell of the timestamp
  4954. and the timestamp type relevant for the sorting strategy in
  4955. `org-agenda-sorting-strategy-selected'."
  4956. (let (ts ts-date-type)
  4957. (save-match-data
  4958. (cond ((org-em 'scheduled-up 'scheduled-down
  4959. org-agenda-sorting-strategy-selected)
  4960. (setq ts (org-entry-get pom "SCHEDULED")
  4961. ts-date-type " scheduled"))
  4962. ((org-em 'deadline-up 'deadline-down
  4963. org-agenda-sorting-strategy-selected)
  4964. (setq ts (org-entry-get pom "DEADLINE")
  4965. ts-date-type " deadline"))
  4966. ((org-em 'ts-up 'ts-down
  4967. org-agenda-sorting-strategy-selected)
  4968. (setq ts (org-entry-get pom "TIMESTAMP")
  4969. ts-date-type " timestamp"))
  4970. ((org-em 'tsia-up 'tsia-down
  4971. org-agenda-sorting-strategy-selected)
  4972. (setq ts (org-entry-get pom "TIMESTAMP_IA")
  4973. ts-date-type " timestamp_ia"))
  4974. ((org-em 'timestamp-up 'timestamp-down
  4975. org-agenda-sorting-strategy-selected)
  4976. (setq ts (or (org-entry-get pom "SCHEDULED")
  4977. (org-entry-get pom "DEADLINE")
  4978. (org-entry-get pom "TIMESTAMP")
  4979. (org-entry-get pom "TIMESTAMP_IA"))
  4980. ts-date-type ""))
  4981. (t (setq ts-date-type "")))
  4982. (cons (when ts (ignore-errors (org-time-string-to-absolute ts)))
  4983. ts-date-type))))
  4984. (defun org-agenda-get-todos ()
  4985. "Return the TODO information for agenda display."
  4986. (let* ((props (list 'face nil
  4987. 'done-face 'org-agenda-done
  4988. 'org-not-done-regexp org-not-done-regexp
  4989. 'org-todo-regexp org-todo-regexp
  4990. 'org-complex-heading-regexp org-complex-heading-regexp
  4991. 'mouse-face 'highlight
  4992. 'help-echo
  4993. (format "mouse-2 or RET jump to org file %s"
  4994. (abbreviate-file-name buffer-file-name))))
  4995. (regexp (format org-heading-keyword-regexp-format
  4996. (cond
  4997. ((and org-select-this-todo-keyword
  4998. (equal org-select-this-todo-keyword "*"))
  4999. org-todo-regexp)
  5000. (org-select-this-todo-keyword
  5001. (concat "\\("
  5002. (mapconcat 'identity
  5003. (org-split-string
  5004. org-select-this-todo-keyword
  5005. "|")
  5006. "\\|") "\\)"))
  5007. (t org-not-done-regexp))))
  5008. marker priority category level tags todo-state
  5009. ts-date ts-date-type ts-date-pair
  5010. ee txt beg end inherited-tags todo-state-end-pos)
  5011. (goto-char (point-min))
  5012. (while (re-search-forward regexp nil t)
  5013. (catch :skip
  5014. (save-match-data
  5015. (beginning-of-line)
  5016. (org-agenda-skip)
  5017. (setq beg (point) end (save-excursion (outline-next-heading) (point)))
  5018. (unless (and (setq todo-state (org-get-todo-state))
  5019. (setq todo-state-end-pos (match-end 2)))
  5020. (goto-char end)
  5021. (throw :skip nil))
  5022. (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
  5023. (goto-char (1+ beg))
  5024. (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
  5025. (throw :skip nil)))
  5026. (goto-char (match-beginning 2))
  5027. (setq marker (org-agenda-new-marker (match-beginning 0))
  5028. category (org-get-category)
  5029. ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
  5030. ts-date (car ts-date-pair)
  5031. ts-date-type (cdr ts-date-pair)
  5032. txt (org-trim (buffer-substring (match-beginning 2) (match-end 0)))
  5033. inherited-tags
  5034. (or (eq org-agenda-show-inherited-tags 'always)
  5035. (and (listp org-agenda-show-inherited-tags)
  5036. (memq 'todo org-agenda-show-inherited-tags))
  5037. (and (eq org-agenda-show-inherited-tags t)
  5038. (or (eq org-agenda-use-tag-inheritance t)
  5039. (memq 'todo org-agenda-use-tag-inheritance))))
  5040. tags (org-get-tags-at nil (not inherited-tags))
  5041. level (make-string (org-reduced-level (org-outline-level)) ? )
  5042. txt (org-agenda-format-item "" txt level category tags t)
  5043. priority (1+ (org-get-priority txt)))
  5044. (org-add-props txt props
  5045. 'org-marker marker 'org-hd-marker marker
  5046. 'priority priority
  5047. 'level level
  5048. 'ts-date ts-date
  5049. 'type (concat "todo" ts-date-type) 'todo-state todo-state)
  5050. (push txt ee)
  5051. (if org-agenda-todo-list-sublevels
  5052. (goto-char todo-state-end-pos)
  5053. (org-end-of-subtree 'invisible))))
  5054. (nreverse ee)))
  5055. (defun org-agenda-todo-custom-ignore-p (time n)
  5056. "Check whether timestamp is farther away than n number of days.
  5057. This function is invoked if `org-agenda-todo-ignore-deadlines',
  5058. `org-agenda-todo-ignore-scheduled' or
  5059. `org-agenda-todo-ignore-timestamp' is set to an integer."
  5060. (let ((days (org-time-stamp-to-now
  5061. time org-agenda-todo-ignore-time-comparison-use-seconds)))
  5062. (if (>= n 0)
  5063. (>= days n)
  5064. (<= days n))))
  5065. ;;;###autoload
  5066. (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  5067. (&optional end)
  5068. "Do we have a reason to ignore this TODO entry because it has a time stamp?"
  5069. (when (or org-agenda-todo-ignore-with-date
  5070. org-agenda-todo-ignore-scheduled
  5071. org-agenda-todo-ignore-deadlines
  5072. org-agenda-todo-ignore-timestamp)
  5073. (setq end (or end (save-excursion (outline-next-heading) (point))))
  5074. (save-excursion
  5075. (or (and org-agenda-todo-ignore-with-date
  5076. (re-search-forward org-ts-regexp end t))
  5077. (and org-agenda-todo-ignore-scheduled
  5078. (re-search-forward org-scheduled-time-regexp end t)
  5079. (cond
  5080. ((eq org-agenda-todo-ignore-scheduled 'future)
  5081. (> (org-time-stamp-to-now
  5082. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5083. ((eq org-agenda-todo-ignore-scheduled 'past)
  5084. (<= (org-time-stamp-to-now
  5085. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5086. ((numberp org-agenda-todo-ignore-scheduled)
  5087. (org-agenda-todo-custom-ignore-p
  5088. (match-string 1) org-agenda-todo-ignore-scheduled))
  5089. (t)))
  5090. (and org-agenda-todo-ignore-deadlines
  5091. (re-search-forward org-deadline-time-regexp end t)
  5092. (cond
  5093. ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
  5094. ((eq org-agenda-todo-ignore-deadlines 'far)
  5095. (not (org-deadline-close (match-string 1))))
  5096. ((eq org-agenda-todo-ignore-deadlines 'future)
  5097. (> (org-time-stamp-to-now
  5098. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5099. ((eq org-agenda-todo-ignore-deadlines 'past)
  5100. (<= (org-time-stamp-to-now
  5101. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5102. ((numberp org-agenda-todo-ignore-deadlines)
  5103. (org-agenda-todo-custom-ignore-p
  5104. (match-string 1) org-agenda-todo-ignore-deadlines))
  5105. (t (org-deadline-close (match-string 1)))))
  5106. (and org-agenda-todo-ignore-timestamp
  5107. (let ((buffer (current-buffer))
  5108. (regexp
  5109. (concat
  5110. org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
  5111. (start (point)))
  5112. ;; Copy current buffer into a temporary one
  5113. (with-temp-buffer
  5114. (insert-buffer-substring buffer start end)
  5115. (goto-char (point-min))
  5116. ;; Delete SCHEDULED and DEADLINE items
  5117. (while (re-search-forward regexp end t)
  5118. (delete-region (match-beginning 0) (match-end 0)))
  5119. (goto-char (point-min))
  5120. ;; No search for timestamp left
  5121. (when (re-search-forward org-ts-regexp nil t)
  5122. (cond
  5123. ((eq org-agenda-todo-ignore-timestamp 'future)
  5124. (> (org-time-stamp-to-now
  5125. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5126. ((eq org-agenda-todo-ignore-timestamp 'past)
  5127. (<= (org-time-stamp-to-now
  5128. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5129. ((numberp org-agenda-todo-ignore-timestamp)
  5130. (org-agenda-todo-custom-ignore-p
  5131. (match-string 1) org-agenda-todo-ignore-timestamp))
  5132. (t))))))))))
  5133. (defun org-agenda-get-timestamps (&optional deadline-results)
  5134. "Return the date stamp information for agenda display."
  5135. (let* ((props (list 'face 'org-agenda-calendar-event
  5136. 'org-not-done-regexp org-not-done-regexp
  5137. 'org-todo-regexp org-todo-regexp
  5138. 'org-complex-heading-regexp org-complex-heading-regexp
  5139. 'mouse-face 'highlight
  5140. 'help-echo
  5141. (format "mouse-2 or RET jump to org file %s"
  5142. (abbreviate-file-name buffer-file-name))))
  5143. (d1 (calendar-absolute-from-gregorian date))
  5144. mm
  5145. (deadline-position-alist
  5146. (mapcar (lambda (a) (and (setq mm (get-text-property
  5147. 0 'org-hd-marker a))
  5148. (cons (marker-position mm) a)))
  5149. deadline-results))
  5150. (remove-re org-ts-regexp)
  5151. (regexp
  5152. (concat
  5153. (if org-agenda-include-inactive-timestamps "[[<]" "<")
  5154. (regexp-quote
  5155. (substring
  5156. (format-time-string
  5157. (car org-time-stamp-formats)
  5158. (apply 'encode-time ; DATE bound by calendar
  5159. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  5160. 1 11))
  5161. "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
  5162. "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
  5163. marker hdmarker deadlinep scheduledp clockp closedp inactivep
  5164. donep tmp priority category level ee txt timestr tags
  5165. b0 b3 e3 head todo-state end-of-match show-all warntime habitp
  5166. inherited-tags ts-date)
  5167. (goto-char (point-min))
  5168. (while (setq end-of-match (re-search-forward regexp nil t))
  5169. (setq b0 (match-beginning 0)
  5170. b3 (match-beginning 3) e3 (match-end 3)
  5171. todo-state (save-match-data (ignore-errors (org-get-todo-state)))
  5172. habitp (and (functionp 'org-is-habit-p) (save-match-data (org-is-habit-p)))
  5173. show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  5174. (member todo-state
  5175. org-agenda-repeating-timestamp-show-all)))
  5176. (catch :skip
  5177. (and (org-at-date-range-p) (throw :skip nil))
  5178. (org-agenda-skip)
  5179. (if (and (match-end 1)
  5180. (not (= d1 (org-time-string-to-absolute
  5181. (match-string 1) d1 nil show-all
  5182. (current-buffer) b0))))
  5183. (throw :skip nil))
  5184. (if (and e3
  5185. (not (org-diary-sexp-entry (buffer-substring b3 e3) "" date)))
  5186. (throw :skip nil))
  5187. (setq tmp (buffer-substring (max (point-min)
  5188. (- b0 org-ds-keyword-length))
  5189. b0)
  5190. timestr (if b3 "" (buffer-substring b0 (point-at-eol)))
  5191. inactivep (= (char-after b0) ?\[)
  5192. deadlinep (string-match org-deadline-regexp tmp)
  5193. scheduledp (string-match org-scheduled-regexp tmp)
  5194. closedp (and org-agenda-include-inactive-timestamps
  5195. (string-match org-closed-string tmp))
  5196. clockp (and org-agenda-include-inactive-timestamps
  5197. (or (string-match org-clock-string tmp)
  5198. (string-match "]-+\\'" tmp)))
  5199. warntime (get-text-property (point) 'org-appt-warntime)
  5200. donep (member todo-state org-done-keywords))
  5201. (if (or scheduledp deadlinep closedp clockp
  5202. (and donep org-agenda-skip-timestamp-if-done))
  5203. (throw :skip t))
  5204. (if (string-match ">" timestr)
  5205. ;; substring should only run to end of time stamp
  5206. (setq timestr (substring timestr 0 (match-end 0))))
  5207. (setq marker (org-agenda-new-marker b0)
  5208. category (org-get-category b0))
  5209. (save-excursion
  5210. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5211. (throw :skip nil)
  5212. (goto-char (match-beginning 0))
  5213. (if (and (eq t org-agenda-skip-timestamp-if-deadline-is-shown)
  5214. (assoc (point) deadline-position-alist))
  5215. (throw :skip nil))
  5216. (setq hdmarker (org-agenda-new-marker)
  5217. inherited-tags
  5218. (or (eq org-agenda-show-inherited-tags 'always)
  5219. (and (listp org-agenda-show-inherited-tags)
  5220. (memq 'agenda org-agenda-show-inherited-tags))
  5221. (and (eq org-agenda-show-inherited-tags t)
  5222. (or (eq org-agenda-use-tag-inheritance t)
  5223. (memq 'agenda org-agenda-use-tag-inheritance))))
  5224. tags (org-get-tags-at nil (not inherited-tags))
  5225. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5226. (looking-at "\\*+[ \t]+\\(.*\\)")
  5227. (setq head (match-string 1))
  5228. (setq txt (org-agenda-format-item
  5229. (if inactivep org-agenda-inactive-leader nil)
  5230. head level category tags timestr
  5231. remove-re habitp)))
  5232. (setq priority (org-get-priority txt))
  5233. (org-add-props txt props 'priority priority
  5234. 'org-marker marker 'org-hd-marker hdmarker
  5235. 'date date
  5236. 'level level
  5237. 'ts-date
  5238. (ignore-errors (org-time-string-to-absolute timestr))
  5239. 'todo-state todo-state
  5240. 'warntime warntime
  5241. 'type "timestamp")
  5242. (push txt ee))
  5243. (if org-agenda-skip-additional-timestamps-same-entry
  5244. (outline-next-heading)
  5245. (goto-char end-of-match))))
  5246. (nreverse ee)))
  5247. (defun org-agenda-get-sexps ()
  5248. "Return the sexp information for agenda display."
  5249. (require 'diary-lib)
  5250. (let* ((props (list 'face 'org-agenda-calendar-sexp
  5251. 'mouse-face 'highlight
  5252. 'help-echo
  5253. (format "mouse-2 or RET jump to org file %s"
  5254. (abbreviate-file-name buffer-file-name))))
  5255. (regexp "^&?%%(")
  5256. marker category extra level ee txt tags entry
  5257. result beg b sexp sexp-entry todo-state warntime inherited-tags)
  5258. (goto-char (point-min))
  5259. (while (re-search-forward regexp nil t)
  5260. (catch :skip
  5261. (org-agenda-skip)
  5262. (setq beg (match-beginning 0))
  5263. (goto-char (1- (match-end 0)))
  5264. (setq b (point))
  5265. (forward-sexp 1)
  5266. (setq sexp (buffer-substring b (point)))
  5267. (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
  5268. (org-trim (match-string 1))
  5269. ""))
  5270. (setq result (org-diary-sexp-entry sexp sexp-entry date))
  5271. (when result
  5272. (setq marker (org-agenda-new-marker beg)
  5273. level (make-string (org-reduced-level (org-outline-level)) ? )
  5274. category (org-get-category beg)
  5275. inherited-tags
  5276. (or (eq org-agenda-show-inherited-tags 'always)
  5277. (and (listp org-agenda-show-inherited-tags)
  5278. (memq 'agenda org-agenda-show-inherited-tags))
  5279. (and (eq org-agenda-show-inherited-tags t)
  5280. (or (eq org-agenda-use-tag-inheritance t)
  5281. (memq 'agenda org-agenda-use-tag-inheritance))))
  5282. tags (org-get-tags-at nil (not inherited-tags))
  5283. todo-state (org-get-todo-state)
  5284. warntime (get-text-property (point) 'org-appt-warntime)
  5285. extra nil)
  5286. (dolist (r (if (stringp result)
  5287. (list result)
  5288. result)) ;; we expect a list here
  5289. (when (and org-agenda-diary-sexp-prefix
  5290. (string-match org-agenda-diary-sexp-prefix r))
  5291. (setq extra (match-string 0 r)
  5292. r (replace-match "" nil nil r)))
  5293. (if (string-match "\\S-" r)
  5294. (setq txt r)
  5295. (setq txt "SEXP entry returned empty string"))
  5296. (setq txt (org-agenda-format-item extra txt level category tags 'time))
  5297. (org-add-props txt props 'org-marker marker
  5298. 'date date 'todo-state todo-state
  5299. 'level level 'type "sexp" 'warntime warntime)
  5300. (push txt ee)))))
  5301. (nreverse ee)))
  5302. ;; Calendar sanity: define some functions that are independent of
  5303. ;; `calendar-date-style'.
  5304. ;; Normally I would like to use ISO format when calling the diary functions,
  5305. ;; but to make sure we still have Emacs 22 compatibility we bind
  5306. ;; also `european-calendar-style' and use european format
  5307. (defun org-anniversary (year month day &optional mark)
  5308. "Like `diary-anniversary', but with fixed (ISO) order of arguments."
  5309. (org-no-warnings
  5310. (let ((calendar-date-style 'european) (european-calendar-style t))
  5311. (diary-anniversary day month year mark))))
  5312. (defun org-cyclic (N year month day &optional mark)
  5313. "Like `diary-cyclic', but with fixed (ISO) order of arguments."
  5314. (org-no-warnings
  5315. (let ((calendar-date-style 'european) (european-calendar-style t))
  5316. (diary-cyclic N day month year mark))))
  5317. (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
  5318. "Like `diary-block', but with fixed (ISO) order of arguments."
  5319. (org-no-warnings
  5320. (let ((calendar-date-style 'european) (european-calendar-style t))
  5321. (diary-block D1 M1 Y1 D2 M2 Y2 mark))))
  5322. (defun org-date (year month day &optional mark)
  5323. "Like `diary-date', but with fixed (ISO) order of arguments."
  5324. (org-no-warnings
  5325. (let ((calendar-date-style 'european) (european-calendar-style t))
  5326. (diary-date day month year mark))))
  5327. ;; Define the `org-class' function
  5328. (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
  5329. "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
  5330. DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
  5331. SKIP-WEEKS is any number of ISO weeks in the block period for which the
  5332. item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
  5333. `holidays', then any date that is known by the Emacs calendar to be a
  5334. holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
  5335. then those holidays will be skipped."
  5336. (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
  5337. (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
  5338. (d (calendar-absolute-from-gregorian date))
  5339. (h (when skip-weeks (calendar-check-holidays date))))
  5340. (and
  5341. (<= date1 d)
  5342. (<= d date2)
  5343. (= (calendar-day-of-week date) dayname)
  5344. (or (not skip-weeks)
  5345. (progn
  5346. (require 'cal-iso)
  5347. (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
  5348. (not (or (and h (memq 'holidays skip-weeks))
  5349. (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
  5350. entry)))
  5351. (defun org-diary-class (m1 d1 y1 m2 d2 y2 dayname &rest skip-weeks)
  5352. "Like `org-class', but honor `calendar-date-style'.
  5353. The order of the first 2 times 3 arguments depends on the variable
  5354. `calendar-date-style' or, if that is not defined, on `european-calendar-style'.
  5355. So for American calendars, give this as MONTH DAY YEAR, for European as
  5356. DAY MONTH YEAR, and for ISO as YEAR MONTH DAY.
  5357. DAYNAME is a number between 0 (Sunday) and 6 (Saturday). SKIP-WEEKS
  5358. is any number of ISO weeks in the block period for which the item should
  5359. be skipped.
  5360. This function is here only for backward compatibility and it is deprecated,
  5361. please use `org-class' instead."
  5362. (let* ((date1 (org-order-calendar-date-args m1 d1 y1))
  5363. (date2 (org-order-calendar-date-args m2 d2 y2)))
  5364. (org-class
  5365. (nth 2 date1) (car date1) (nth 1 date1)
  5366. (nth 2 date2) (car date2) (nth 1 date2)
  5367. dayname skip-weeks)))
  5368. (make-obsolete 'org-diary-class 'org-class "")
  5369. (defalias 'org-get-closed 'org-agenda-get-progress)
  5370. (defun org-agenda-get-progress ()
  5371. "Return the logged TODO entries for agenda display."
  5372. (let* ((props (list 'mouse-face 'highlight
  5373. 'org-not-done-regexp org-not-done-regexp
  5374. 'org-todo-regexp org-todo-regexp
  5375. 'org-complex-heading-regexp org-complex-heading-regexp
  5376. 'help-echo
  5377. (format "mouse-2 or RET jump to org file %s"
  5378. (abbreviate-file-name buffer-file-name))))
  5379. (items (if (consp org-agenda-show-log-scoped)
  5380. org-agenda-show-log-scoped
  5381. (if (eq org-agenda-show-log-scoped 'clockcheck)
  5382. '(clock)
  5383. org-agenda-log-mode-items)))
  5384. (parts
  5385. (delq nil
  5386. (list
  5387. (if (memq 'closed items) (concat "\\<" org-closed-string))
  5388. (if (memq 'clock items) (concat "\\<" org-clock-string))
  5389. (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
  5390. (parts-re (if parts (mapconcat 'identity parts "\\|")
  5391. (error "`org-agenda-log-mode-items' is empty")))
  5392. (regexp (concat
  5393. "\\(" parts-re "\\)"
  5394. " *\\["
  5395. (regexp-quote
  5396. (substring
  5397. (format-time-string
  5398. (car org-time-stamp-formats)
  5399. (apply 'encode-time ; DATE bound by calendar
  5400. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  5401. 1 11))))
  5402. (org-agenda-search-headline-for-time nil)
  5403. marker hdmarker priority category level tags closedp
  5404. statep clockp state ee txt extra timestr rest clocked inherited-tags)
  5405. (goto-char (point-min))
  5406. (while (re-search-forward regexp nil t)
  5407. (catch :skip
  5408. (org-agenda-skip)
  5409. (setq marker (org-agenda-new-marker (match-beginning 0))
  5410. closedp (equal (match-string 1) org-closed-string)
  5411. statep (equal (string-to-char (match-string 1)) ?-)
  5412. clockp (not (or closedp statep))
  5413. state (and statep (match-string 2))
  5414. category (org-get-category (match-beginning 0))
  5415. timestr (buffer-substring (match-beginning 0) (point-at-eol)))
  5416. (when (string-match "\\]" timestr)
  5417. ;; substring should only run to end of time stamp
  5418. (setq rest (substring timestr (match-end 0))
  5419. timestr (substring timestr 0 (match-end 0)))
  5420. (if (and (not closedp) (not statep)
  5421. (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
  5422. rest))
  5423. (progn (setq timestr (concat (substring timestr 0 -1)
  5424. "-" (match-string 1 rest) "]"))
  5425. (setq clocked (match-string 2 rest)))
  5426. (setq clocked "-")))
  5427. (save-excursion
  5428. (setq extra
  5429. (cond
  5430. ((not org-agenda-log-mode-add-notes) nil)
  5431. (statep
  5432. (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
  5433. (match-string 1)))
  5434. (clockp
  5435. (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
  5436. (match-string 1)))))
  5437. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5438. (throw :skip nil)
  5439. (goto-char (match-beginning 0))
  5440. (setq hdmarker (org-agenda-new-marker)
  5441. inherited-tags
  5442. (or (eq org-agenda-show-inherited-tags 'always)
  5443. (and (listp org-agenda-show-inherited-tags)
  5444. (memq 'todo org-agenda-show-inherited-tags))
  5445. (and (eq org-agenda-show-inherited-tags t)
  5446. (or (eq org-agenda-use-tag-inheritance t)
  5447. (memq 'todo org-agenda-use-tag-inheritance))))
  5448. tags (org-get-tags-at nil (not inherited-tags))
  5449. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5450. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5451. (setq txt (match-string 1))
  5452. (when extra
  5453. (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
  5454. (setq txt (concat (substring txt 0 (match-beginning 1))
  5455. " - " extra " " (match-string 2 txt)))
  5456. (setq txt (concat txt " - " extra))))
  5457. (setq txt (org-agenda-format-item
  5458. (cond
  5459. (closedp "Closed: ")
  5460. (statep (concat "State: (" state ")"))
  5461. (t (concat "Clocked: (" clocked ")")))
  5462. txt level category tags timestr)))
  5463. (setq priority 100000)
  5464. (org-add-props txt props
  5465. 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
  5466. 'priority priority 'level level
  5467. 'type "closed" 'date date
  5468. 'undone-face 'org-warning 'done-face 'org-agenda-done)
  5469. (push txt ee))
  5470. (goto-char (point-at-eol))))
  5471. (nreverse ee)))
  5472. (defun org-agenda-show-clocking-issues ()
  5473. "Add overlays, showing issues with clocking.
  5474. See also the user option `org-agenda-clock-consistency-checks'."
  5475. (interactive)
  5476. (let* ((org-time-clocksum-use-effort-durations nil)
  5477. (pl org-agenda-clock-consistency-checks)
  5478. (re (concat "^[ \t]*"
  5479. org-clock-string
  5480. "[ \t]+"
  5481. "\\(\\[.*?\\]\\)" ; group 1 is first stamp
  5482. "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
  5483. (tlstart 0.)
  5484. (tlend 0.)
  5485. (maxtime (org-hh:mm-string-to-minutes
  5486. (or (plist-get pl :max-duration) "24:00")))
  5487. (mintime (org-hh:mm-string-to-minutes
  5488. (or (plist-get pl :min-duration) 0)))
  5489. (maxgap (org-hh:mm-string-to-minutes
  5490. ;; default 30:00 means never complain
  5491. (or (plist-get pl :max-gap) "30:00")))
  5492. (gapok (mapcar 'org-hh:mm-string-to-minutes
  5493. (plist-get pl :gap-ok-around)))
  5494. (def-face (or (plist-get pl :default-face)
  5495. '((:background "DarkRed") (:foreground "white"))))
  5496. issue face m te ts dt ov)
  5497. (goto-char (point-min))
  5498. (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
  5499. (setq issue nil face def-face)
  5500. (catch 'next
  5501. (setq m (org-get-at-bol 'org-marker)
  5502. te nil ts nil)
  5503. (unless (and m (markerp m))
  5504. (setq issue "No valid clock line") (throw 'next t))
  5505. (org-with-point-at m
  5506. (save-excursion
  5507. (goto-char (point-at-bol))
  5508. (unless (looking-at re)
  5509. (error "No valid Clock line")
  5510. (throw 'next t))
  5511. (unless (match-end 3)
  5512. (setq issue "No end time"
  5513. face (or (plist-get pl :no-end-time-face) face))
  5514. (throw 'next t))
  5515. (setq ts (match-string 1)
  5516. te (match-string 3)
  5517. ts (org-float-time
  5518. (apply 'encode-time (org-parse-time-string ts)))
  5519. te (org-float-time
  5520. (apply 'encode-time (org-parse-time-string te)))
  5521. dt (- te ts))))
  5522. (cond
  5523. ((> dt (* 60 maxtime))
  5524. ;; a very long clocking chunk
  5525. (setq issue (format "Clocking interval is very long: %s"
  5526. (org-minutes-to-clocksum-string
  5527. (floor (/ (float dt) 60.))))
  5528. face (or (plist-get pl :long-face) face)))
  5529. ((< dt (* 60 mintime))
  5530. ;; a very short clocking chunk
  5531. (setq issue (format "Clocking interval is very short: %s"
  5532. (org-minutes-to-clocksum-string
  5533. (floor (/ (float dt) 60.))))
  5534. face (or (plist-get pl :short-face) face)))
  5535. ((and (> tlend 0) (< ts tlend))
  5536. ;; Two clock entries are overlapping
  5537. (setq issue (format "Clocking overlap: %d minutes"
  5538. (/ (- tlend ts) 60))
  5539. face (or (plist-get pl :overlap-face) face)))
  5540. ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
  5541. ;; There is a gap, lets see if we need to report it
  5542. (unless (org-agenda-check-clock-gap tlend ts gapok)
  5543. (setq issue (format "Clocking gap: %d minutes"
  5544. (/ (- ts tlend) 60))
  5545. face (or (plist-get pl :gap-face) face))))
  5546. (t nil)))
  5547. (setq tlend (or te tlend) tlstart (or ts tlstart))
  5548. (when issue
  5549. ;; OK, there was some issue, add an overlay to show the issue
  5550. (setq ov (make-overlay (point-at-bol) (point-at-eol)))
  5551. (overlay-put ov 'before-string
  5552. (concat
  5553. (org-add-props
  5554. (format "%-43s" (concat " " issue))
  5555. nil
  5556. 'face face)
  5557. "\n"))
  5558. (overlay-put ov 'evaporate t)))))
  5559. (defun org-agenda-check-clock-gap (t1 t2 ok-list)
  5560. "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
  5561. (catch 'exit
  5562. (unless ok-list
  5563. ;; there are no OK times for gaps...
  5564. (throw 'exit nil))
  5565. (if (> (- (/ t2 36000) (/ t1 36000)) 24)
  5566. ;; This is more than 24 hours, so it is OK.
  5567. ;; because we have at least one OK time, that must be in the
  5568. ;; 24 hour interval.
  5569. (throw 'exit t))
  5570. ;; We have a shorter gap.
  5571. ;; Now we have to get the minute of the day when these times are
  5572. (let* ((t1dec (decode-time (seconds-to-time t1)))
  5573. (t2dec (decode-time (seconds-to-time t2)))
  5574. ;; compute the minute on the day
  5575. (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
  5576. (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
  5577. (when (< min2 min1)
  5578. ;; if min2 is smaller than min1, this means it is on the next day.
  5579. ;; Wrap it to after midnight.
  5580. (setq min2 (+ min2 1440)))
  5581. ;; Now check if any of the OK times is in the gap
  5582. (mapc (lambda (x)
  5583. ;; Wrap the time to after midnight if necessary
  5584. (if (< x min1) (setq x (+ x 1440)))
  5585. ;; Check if in interval
  5586. (and (<= min1 x) (>= min2 x) (throw 'exit t)))
  5587. ok-list)
  5588. ;; Nope, this gap is not OK
  5589. nil)))
  5590. (defun org-agenda-get-deadlines (&optional with-hour)
  5591. "Return the deadline information for agenda display.
  5592. When WITH-HOUR is non-nil, only return deadlines with an hour
  5593. specification like [h]h:mm."
  5594. (let* ((props (list 'mouse-face 'highlight
  5595. 'org-not-done-regexp org-not-done-regexp
  5596. 'org-todo-regexp org-todo-regexp
  5597. 'org-complex-heading-regexp org-complex-heading-regexp
  5598. 'help-echo
  5599. (format "mouse-2 or RET jump to org file %s"
  5600. (abbreviate-file-name buffer-file-name))))
  5601. (regexp (if with-hour
  5602. org-deadline-time-hour-regexp
  5603. org-deadline-time-regexp))
  5604. (todayp (org-agenda-todayp date)) ; DATE bound by calendar
  5605. (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
  5606. (dl0 (car org-agenda-deadline-leaders))
  5607. (dl1 (nth 1 org-agenda-deadline-leaders))
  5608. (dl2 (or (nth 2 org-agenda-deadline-leaders) dl1))
  5609. d2 diff dfrac wdays pos pos1 category level
  5610. tags suppress-prewarning ee txt head face s todo-state
  5611. show-all upcomingp donep timestr warntime inherited-tags ts-date)
  5612. (goto-char (point-min))
  5613. (while (re-search-forward regexp nil t)
  5614. (catch :skip
  5615. (org-agenda-skip)
  5616. (setq s (match-string 1)
  5617. txt nil
  5618. pos (1- (match-beginning 1))
  5619. todo-state (save-match-data (org-get-todo-state))
  5620. show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  5621. (member todo-state
  5622. org-agenda-repeating-timestamp-show-all))
  5623. d2 (org-time-string-to-absolute
  5624. s d1 'past show-all (current-buffer) pos)
  5625. diff (- d2 d1))
  5626. (setq suppress-prewarning
  5627. (let ((ds (and org-agenda-skip-deadline-prewarning-if-scheduled
  5628. (let ((item (buffer-substring (point-at-bol)
  5629. (point-at-eol))))
  5630. (save-match-data
  5631. (and (string-match
  5632. org-scheduled-time-regexp item)
  5633. (match-string 1 item)))))))
  5634. (cond
  5635. ((not ds) nil)
  5636. ;; The current item has a scheduled date (in ds), so
  5637. ;; evaluate its prewarning lead time.
  5638. ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
  5639. ;; Use global prewarning-restart lead time.
  5640. org-agenda-skip-deadline-prewarning-if-scheduled)
  5641. ((eq org-agenda-skip-deadline-prewarning-if-scheduled
  5642. 'pre-scheduled)
  5643. ;; Set prewarning to no earlier than scheduled.
  5644. (min (- d2 (org-time-string-to-absolute
  5645. ds d1 'past show-all (current-buffer) pos))
  5646. org-deadline-warning-days))
  5647. ;; Set prewarning to deadline.
  5648. (t 0))))
  5649. (setq wdays (if suppress-prewarning
  5650. (let ((org-deadline-warning-days suppress-prewarning))
  5651. (org-get-wdays s))
  5652. (org-get-wdays s))
  5653. dfrac (- 1 (/ (* 1.0 diff) (max wdays 1)))
  5654. upcomingp (and todayp (> diff 0)))
  5655. ;; When to show a deadline in the calendar:
  5656. ;; If the expiration is within wdays warning time.
  5657. ;; Past-due deadlines are only shown on the current date
  5658. (if (and (or (and (<= diff wdays)
  5659. (and todayp (not org-agenda-only-exact-dates)))
  5660. (= diff 0)))
  5661. (save-excursion
  5662. ;; (setq todo-state (org-get-todo-state))
  5663. (setq donep (member todo-state org-done-keywords))
  5664. (if (and donep
  5665. (or org-agenda-skip-deadline-if-done
  5666. (not (= diff 0))))
  5667. (setq txt nil)
  5668. (setq category (org-get-category)
  5669. warntime (get-text-property (point) 'org-appt-warntime))
  5670. (if (not (re-search-backward "^\\*+[ \t]+" nil t))
  5671. (throw :skip nil)
  5672. (goto-char (match-end 0))
  5673. (setq pos1 (match-beginning 0))
  5674. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  5675. (setq inherited-tags
  5676. (or (eq org-agenda-show-inherited-tags 'always)
  5677. (and (listp org-agenda-show-inherited-tags)
  5678. (memq 'agenda org-agenda-show-inherited-tags))
  5679. (and (eq org-agenda-show-inherited-tags t)
  5680. (or (eq org-agenda-use-tag-inheritance t)
  5681. (memq 'agenda org-agenda-use-tag-inheritance))))
  5682. tags (org-get-tags-at pos1 (not inherited-tags)))
  5683. (setq head (buffer-substring (point) (line-end-position)))
  5684. (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5685. (setq timestr
  5686. (concat (substring s (match-beginning 1)) " "))
  5687. (setq timestr 'time))
  5688. (setq txt (org-agenda-format-item
  5689. (cond ((= diff 0) dl0)
  5690. ((> diff 0)
  5691. (if (functionp dl1)
  5692. (funcall dl1 diff date)
  5693. (format dl1 diff)))
  5694. (t
  5695. (if (functionp dl2)
  5696. (funcall dl2 diff date)
  5697. (format dl2 (if (string= dl2 dl1)
  5698. diff (abs diff))))))
  5699. head level category tags
  5700. (if (not (= diff 0)) nil timestr)))))
  5701. (when txt
  5702. (setq face (org-agenda-deadline-face dfrac))
  5703. (org-add-props txt props
  5704. 'org-marker (org-agenda-new-marker pos)
  5705. 'warntime warntime
  5706. 'level level
  5707. 'ts-date d2
  5708. 'org-hd-marker (org-agenda-new-marker pos1)
  5709. 'priority (+ (- diff)
  5710. (org-get-priority txt))
  5711. 'todo-state todo-state
  5712. 'type (if upcomingp "upcoming-deadline" "deadline")
  5713. 'date (if upcomingp date d2)
  5714. 'face (if donep 'org-agenda-done face)
  5715. 'undone-face face 'done-face 'org-agenda-done)
  5716. (push txt ee))))))
  5717. (nreverse ee)))
  5718. (defun org-agenda-deadline-face (fraction)
  5719. "Return the face to displaying a deadline item.
  5720. FRACTION is what fraction of the head-warning time has passed."
  5721. (let ((faces org-agenda-deadline-faces) f)
  5722. (catch 'exit
  5723. (while (setq f (pop faces))
  5724. (if (>= fraction (car f)) (throw 'exit (cdr f)))))))
  5725. (defun org-agenda-get-scheduled (&optional deadline-results with-hour)
  5726. "Return the scheduled information for agenda display.
  5727. When WITH-HOUR is non-nil, only return scheduled items with
  5728. an hour specification like [h]h:mm."
  5729. (let* ((props (list 'org-not-done-regexp org-not-done-regexp
  5730. 'org-todo-regexp org-todo-regexp
  5731. 'org-complex-heading-regexp org-complex-heading-regexp
  5732. 'done-face 'org-agenda-done
  5733. 'mouse-face 'highlight
  5734. 'help-echo
  5735. (format "mouse-2 or RET jump to org file %s"
  5736. (abbreviate-file-name buffer-file-name))))
  5737. (regexp (if with-hour
  5738. org-scheduled-time-hour-regexp
  5739. org-scheduled-time-regexp))
  5740. (todayp (org-agenda-todayp date)) ; DATE bound by calendar
  5741. (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
  5742. mm
  5743. (deadline-position-alist
  5744. (mapcar (lambda (a) (and (setq mm (get-text-property
  5745. 0 'org-hd-marker a))
  5746. (cons (marker-position mm) a)))
  5747. deadline-results))
  5748. d2 diff pos pos1 category level tags donep
  5749. ee txt head pastschedp todo-state face timestr s habitp show-all
  5750. did-habit-check-p warntime inherited-tags ts-date suppress-delay
  5751. ddays)
  5752. (goto-char (point-min))
  5753. (while (re-search-forward regexp nil t)
  5754. (catch :skip
  5755. (org-agenda-skip)
  5756. (setq s (match-string 1)
  5757. txt nil
  5758. pos (1- (match-beginning 1))
  5759. todo-state (save-match-data (org-get-todo-state))
  5760. show-all (or (eq org-agenda-repeating-timestamp-show-all t)
  5761. (member todo-state
  5762. org-agenda-repeating-timestamp-show-all))
  5763. d2 (org-time-string-to-absolute
  5764. s d1 'past show-all (current-buffer) pos)
  5765. diff (- d2 d1)
  5766. warntime (get-text-property (point) 'org-appt-warntime))
  5767. (setq pastschedp (and todayp (< diff 0)))
  5768. (setq did-habit-check-p nil)
  5769. (setq suppress-delay
  5770. (let ((ds (and org-agenda-skip-scheduled-delay-if-deadline
  5771. (let ((item (buffer-substring (point-at-bol) (point-at-eol))))
  5772. (save-match-data
  5773. (and (string-match
  5774. org-deadline-time-regexp item)
  5775. (match-string 1 item)))))))
  5776. (cond
  5777. ((not ds) nil)
  5778. ;; The current item has a deadline date (in ds), so
  5779. ;; evaluate its delay time.
  5780. ((integerp org-agenda-skip-scheduled-delay-if-deadline)
  5781. ;; Use global delay time.
  5782. (- org-agenda-skip-scheduled-delay-if-deadline))
  5783. ((eq org-agenda-skip-scheduled-delay-if-deadline
  5784. 'post-deadline)
  5785. ;; Set delay to no later than deadline.
  5786. (min (- d2 (org-time-string-to-absolute
  5787. ds d1 'past show-all (current-buffer) pos))
  5788. org-scheduled-delay-days))
  5789. (t 0))))
  5790. (setq ddays (if suppress-delay
  5791. (let ((org-scheduled-delay-days suppress-delay))
  5792. (org-get-wdays s t t))
  5793. (org-get-wdays s t)))
  5794. ;; Use a delay of 0 when there is a repeater and the delay is
  5795. ;; of the form --3d
  5796. (when (and (save-match-data (string-match "--[0-9]+[hdwmy]" s))
  5797. (< (org-time-string-to-absolute s)
  5798. (org-time-string-to-absolute
  5799. s d2 'past nil (current-buffer) pos)))
  5800. (setq ddays 0))
  5801. ;; When to show a scheduled item in the calendar:
  5802. ;; If it is on or past the date.
  5803. (when (or (and (> ddays 0) (= diff (- ddays)))
  5804. (and (zerop ddays) (= diff 0))
  5805. (and (< (+ diff ddays) 0)
  5806. (< (abs diff) org-scheduled-past-days)
  5807. (and todayp (not org-agenda-only-exact-dates)))
  5808. ;; org-is-habit-p uses org-entry-get, which is expansive
  5809. ;; so we go extra mile to only call it once
  5810. (and todayp
  5811. (boundp 'org-habit-show-all-today)
  5812. org-habit-show-all-today
  5813. (setq did-habit-check-p t)
  5814. (setq habitp (and (functionp 'org-is-habit-p)
  5815. (org-is-habit-p)))))
  5816. (save-excursion
  5817. (setq donep (member todo-state org-done-keywords))
  5818. (if (and donep
  5819. (or org-agenda-skip-scheduled-if-done
  5820. (not (= diff 0))
  5821. (and (functionp 'org-is-habit-p)
  5822. (org-is-habit-p))))
  5823. (setq txt nil)
  5824. (setq habitp (if did-habit-check-p habitp
  5825. (and (functionp 'org-is-habit-p)
  5826. (org-is-habit-p))))
  5827. (setq category (org-get-category))
  5828. (if (and (eq org-agenda-skip-scheduled-if-deadline-is-shown
  5829. 'repeated-after-deadline)
  5830. (org-get-deadline-time (point))
  5831. (<= 0 (- d2 (time-to-days (org-get-deadline-time (point))))))
  5832. (throw :skip nil))
  5833. (if (not (re-search-backward "^\\*+[ \t]+" nil t))
  5834. (throw :skip nil)
  5835. (goto-char (match-end 0))
  5836. (setq pos1 (match-beginning 0))
  5837. (if habitp
  5838. (if (or (not org-habit-show-habits)
  5839. (and (not todayp)
  5840. (boundp 'org-habit-show-habits-only-for-today)
  5841. org-habit-show-habits-only-for-today))
  5842. (throw :skip nil))
  5843. (if (and
  5844. (or (eq t org-agenda-skip-scheduled-if-deadline-is-shown)
  5845. (and (eq org-agenda-skip-scheduled-if-deadline-is-shown 'not-today)
  5846. pastschedp))
  5847. (setq mm (assoc pos1 deadline-position-alist)))
  5848. (throw :skip nil)))
  5849. (setq inherited-tags
  5850. (or (eq org-agenda-show-inherited-tags 'always)
  5851. (and (listp org-agenda-show-inherited-tags)
  5852. (memq 'agenda org-agenda-show-inherited-tags))
  5853. (and (eq org-agenda-show-inherited-tags t)
  5854. (or (eq org-agenda-use-tag-inheritance t)
  5855. (memq 'agenda org-agenda-use-tag-inheritance))))
  5856. tags (org-get-tags-at nil (not inherited-tags)))
  5857. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  5858. (setq head (buffer-substring (point) (line-end-position)))
  5859. (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5860. (setq timestr
  5861. (concat (substring s (match-beginning 1)) " "))
  5862. (setq timestr 'time))
  5863. (setq txt (org-agenda-format-item
  5864. (if (= diff 0)
  5865. (car org-agenda-scheduled-leaders)
  5866. (format (nth 1 org-agenda-scheduled-leaders)
  5867. (- 1 diff)))
  5868. head level category tags
  5869. (if (not (= diff 0)) nil timestr)
  5870. nil habitp))))
  5871. (when txt
  5872. (setq face
  5873. (cond
  5874. ((and (not habitp) pastschedp)
  5875. 'org-scheduled-previously)
  5876. (todayp 'org-scheduled-today)
  5877. (t 'org-scheduled))
  5878. habitp (and habitp (org-habit-parse-todo)))
  5879. (org-add-props txt props
  5880. 'undone-face face
  5881. 'face (if donep 'org-agenda-done face)
  5882. 'org-marker (org-agenda-new-marker pos)
  5883. 'org-hd-marker (org-agenda-new-marker pos1)
  5884. 'type (if pastschedp "past-scheduled" "scheduled")
  5885. 'date (if pastschedp d2 date)
  5886. 'ts-date d2
  5887. 'warntime warntime
  5888. 'level level
  5889. 'priority (if habitp
  5890. (org-habit-get-priority habitp)
  5891. (+ 94 (- 5 diff) (org-get-priority txt)))
  5892. 'org-habit-p habitp
  5893. 'todo-state todo-state)
  5894. (push txt ee))))))
  5895. (nreverse ee)))
  5896. (defun org-agenda-get-blocks ()
  5897. "Return the date-range information for agenda display."
  5898. (let* ((props (list 'face nil
  5899. 'org-not-done-regexp org-not-done-regexp
  5900. 'org-todo-regexp org-todo-regexp
  5901. 'org-complex-heading-regexp org-complex-heading-regexp
  5902. 'mouse-face 'highlight
  5903. 'help-echo
  5904. (format "mouse-2 or RET jump to org file %s"
  5905. (abbreviate-file-name buffer-file-name))))
  5906. (regexp org-tr-regexp)
  5907. (d0 (calendar-absolute-from-gregorian date))
  5908. marker hdmarker ee txt d1 d2 s1 s2 category
  5909. level todo-state tags pos head donep inherited-tags)
  5910. (goto-char (point-min))
  5911. (while (re-search-forward regexp nil t)
  5912. (catch :skip
  5913. (org-agenda-skip)
  5914. (setq pos (point))
  5915. (let ((start-time (match-string 1))
  5916. (end-time (match-string 2)))
  5917. (setq s1 (match-string 1)
  5918. s2 (match-string 2)
  5919. d1 (time-to-days (org-time-string-to-time s1 (current-buffer) pos))
  5920. d2 (time-to-days (org-time-string-to-time s2 (current-buffer) pos)))
  5921. (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
  5922. ;; Only allow days between the limits, because the normal
  5923. ;; date stamps will catch the limits.
  5924. (save-excursion
  5925. (setq todo-state (org-get-todo-state))
  5926. (setq donep (member todo-state org-done-keywords))
  5927. (if (and donep org-agenda-skip-timestamp-if-done)
  5928. (throw :skip t))
  5929. (setq marker (org-agenda-new-marker (point))
  5930. category (org-get-category))
  5931. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5932. (throw :skip nil)
  5933. (goto-char (match-beginning 0))
  5934. (setq hdmarker (org-agenda-new-marker (point))
  5935. inherited-tags
  5936. (or (eq org-agenda-show-inherited-tags 'always)
  5937. (and (listp org-agenda-show-inherited-tags)
  5938. (memq 'agenda org-agenda-show-inherited-tags))
  5939. (and (eq org-agenda-show-inherited-tags t)
  5940. (or (eq org-agenda-use-tag-inheritance t)
  5941. (memq 'agenda org-agenda-use-tag-inheritance))))
  5942. tags (org-get-tags-at nil (not inherited-tags)))
  5943. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  5944. (looking-at "\\*+[ \t]+\\(.*\\)")
  5945. (setq head (match-string 1))
  5946. (let ((remove-re
  5947. (if org-agenda-remove-timeranges-from-blocks
  5948. (concat
  5949. "<" (regexp-quote s1) ".*?>"
  5950. "--"
  5951. "<" (regexp-quote s2) ".*?>")
  5952. nil)))
  5953. (setq txt (org-agenda-format-item
  5954. (format
  5955. (nth (if (= d1 d2) 0 1)
  5956. org-agenda-timerange-leaders)
  5957. (1+ (- d0 d1)) (1+ (- d2 d1)))
  5958. head level category tags
  5959. (cond ((and (= d1 d0) (= d2 d0))
  5960. (concat "<" start-time ">--<" end-time ">"))
  5961. ((= d1 d0)
  5962. (concat "<" start-time ">"))
  5963. ((= d2 d0)
  5964. (concat "<" end-time ">")))
  5965. remove-re))))
  5966. (org-add-props txt props
  5967. 'org-marker marker 'org-hd-marker hdmarker
  5968. 'type "block" 'date date
  5969. 'level level
  5970. 'todo-state todo-state
  5971. 'priority (org-get-priority txt))
  5972. (push txt ee))))
  5973. (goto-char pos)))
  5974. ;; Sort the entries by expiration date.
  5975. (nreverse ee)))
  5976. ;;; Agenda presentation and sorting
  5977. (defvar org-prefix-has-time nil
  5978. "A flag, set by `org-compile-prefix-format'.
  5979. The flag is set if the currently compiled format contains a `%t'.")
  5980. (defvar org-prefix-has-tag nil
  5981. "A flag, set by `org-compile-prefix-format'.
  5982. The flag is set if the currently compiled format contains a `%T'.")
  5983. (defvar org-prefix-has-effort nil
  5984. "A flag, set by `org-compile-prefix-format'.
  5985. The flag is set if the currently compiled format contains a `%e'.")
  5986. (defvar org-prefix-has-breadcrumbs nil
  5987. "A flag, set by `org-compile-prefix-format'.
  5988. The flag is set if the currently compiled format contains a `%b'.")
  5989. (defvar org-prefix-category-length nil
  5990. "Used by `org-compile-prefix-format' to remember the category field width.")
  5991. (defvar org-prefix-category-max-length nil
  5992. "Used by `org-compile-prefix-format' to remember the category field width.")
  5993. (defun org-agenda-get-category-icon (category)
  5994. "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
  5995. (dolist (entry org-agenda-category-icon-alist)
  5996. (when (org-string-match-p (car entry) category)
  5997. (if (listp (cadr entry))
  5998. (return (cadr entry))
  5999. (return (apply 'create-image (cdr entry)))))))
  6000. (defun org-agenda-format-item (extra txt &optional level category tags dotime
  6001. remove-re habitp)
  6002. "Format TXT to be inserted into the agenda buffer.
  6003. In particular, add the prefix and corresponding text properties.
  6004. EXTRA must be a string to replace the `%s' specifier in the prefix format.
  6005. LEVEL may be a string to replace the `%l' specifier.
  6006. CATEGORY (a string, a symbol or nil) may be used to overrule the default
  6007. category taken from local variable or file name. It will replace the `%c'
  6008. specifier in the format.
  6009. DOTIME, when non-nil, indicates that a time-of-day should be extracted from
  6010. TXT for sorting of this entry, and for the `%t' specifier in the format.
  6011. When DOTIME is a string, this string is searched for a time before TXT is.
  6012. TAGS can be the tags of the headline.
  6013. Any match of REMOVE-RE will be removed from TXT."
  6014. ;; We keep the org-prefix-* variable values along with a compiled
  6015. ;; formatter, so that multiple agendas existing at the same time do
  6016. ;; not step on each other toes.
  6017. ;;
  6018. ;; It was inconvenient to make these variables buffer local in
  6019. ;; Agenda buffers, because this function expects to be called with
  6020. ;; the buffer where item comes from being current, and not agenda
  6021. ;; buffer
  6022. (let* ((bindings (car org-prefix-format-compiled))
  6023. (formatter (cadr org-prefix-format-compiled)))
  6024. (loop for (var value) in bindings
  6025. do (set var value))
  6026. (save-match-data
  6027. ;; Diary entries sometimes have extra whitespace at the beginning
  6028. (setq txt (org-trim txt))
  6029. ;; Fix the tags part in txt
  6030. (setq txt (org-agenda-fix-displayed-tags
  6031. txt tags
  6032. org-agenda-show-inherited-tags
  6033. org-agenda-hide-tags-regexp))
  6034. (let* ((category (or category
  6035. (if buffer-file-name
  6036. (file-name-sans-extension
  6037. (file-name-nondirectory buffer-file-name))
  6038. "")))
  6039. (category-icon (org-agenda-get-category-icon category))
  6040. (category-icon (if category-icon
  6041. (propertize " " 'display category-icon)
  6042. ""))
  6043. (effort (and (not (string= txt ""))
  6044. (get-text-property 1 'effort txt)))
  6045. ;; time, tag, effort are needed for the eval of the prefix format
  6046. (tag (if tags (nth (1- (length tags)) tags) ""))
  6047. time
  6048. (ts (if dotime (concat
  6049. (if (stringp dotime) dotime "")
  6050. (and org-agenda-search-headline-for-time txt))))
  6051. (time-of-day (and dotime (org-get-time-of-day ts)))
  6052. stamp plain s0 s1 s2 rtn srp l
  6053. duration breadcrumbs)
  6054. (and (derived-mode-p 'org-mode) buffer-file-name
  6055. (add-to-list 'org-agenda-contributing-files buffer-file-name))
  6056. (when (and dotime time-of-day)
  6057. ;; Extract starting and ending time and move them to prefix
  6058. (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
  6059. (setq plain (string-match org-plain-time-of-day-regexp ts)))
  6060. (setq s0 (match-string 0 ts)
  6061. srp (and stamp (match-end 3))
  6062. s1 (match-string (if plain 1 2) ts)
  6063. s2 (match-string (if plain 8 (if srp 4 6)) ts))
  6064. ;; If the times are in TXT (not in DOTIMES), and the prefix will list
  6065. ;; them, we might want to remove them there to avoid duplication.
  6066. ;; The user can turn this off with a variable.
  6067. (if (and org-prefix-has-time
  6068. org-agenda-remove-times-when-in-prefix (or stamp plain)
  6069. (string-match (concat (regexp-quote s0) " *") txt)
  6070. (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
  6071. (if (eq org-agenda-remove-times-when-in-prefix 'beg)
  6072. (= (match-beginning 0) 0)
  6073. t))
  6074. (setq txt (replace-match "" nil nil txt))))
  6075. ;; Normalize the time(s) to 24 hour
  6076. (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
  6077. (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
  6078. ;; Try to set s2 if s1 and `org-agenda-default-appointment-duration' are set
  6079. (let (org-time-clocksum-use-effort-durations)
  6080. (when (and s1 (not s2) org-agenda-default-appointment-duration)
  6081. (setq s2
  6082. (org-minutes-to-clocksum-string
  6083. (+ (org-hh:mm-string-to-minutes s1)
  6084. org-agenda-default-appointment-duration)))))
  6085. ;; Compute the duration
  6086. (when s2
  6087. (setq duration (- (org-hh:mm-string-to-minutes s2)
  6088. (org-hh:mm-string-to-minutes s1)))))
  6089. (when (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
  6090. 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 (org-re "\\([ \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. (org-detach-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. (org-detach-overlay org-agenda-restriction-lock-overlay)
  6672. (org-detach-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 (org-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. (org-set-local 'org-global-tags-completion-table
  6999. (org-global-tags-completion-table)))
  7000. (let ((completion-ignore-case t))
  7001. (setq tag (org-icompleting-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-by-tag-refine (arg &optional char)
  7045. "Refine the current filter. See `org-agenda-filter-by-tag'."
  7046. (interactive "P")
  7047. (org-agenda-filter-by-tag arg char))
  7048. (make-obsolete 'org-agenda-filter-by-tag-refine
  7049. "use `org-agenda-filter-by-tag' instead." "8.3.4")
  7050. (defun org-agenda-filter-make-matcher (filter type &optional expand)
  7051. "Create the form that tests a line for agenda filter. Optional
  7052. argument EXPAND can be used for the TYPE tag and will expand the
  7053. tags in the FILTER if any of the tags in FILTER are grouptags."
  7054. (let (f f1)
  7055. (cond
  7056. ;; Tag filter
  7057. ((eq type 'tag)
  7058. (setq filter
  7059. (delete-dups
  7060. (append (get 'org-agenda-tag-filter :preset-filter)
  7061. filter)))
  7062. (dolist (x filter)
  7063. (let ((op (string-to-char x)))
  7064. (if expand (setq x (org-agenda-filter-expand-tags (list x) t))
  7065. (setq x (list x)))
  7066. (setq f1 (org-agenda-filter-make-matcher-tag-exp x op))
  7067. (push f1 f))))
  7068. ;; Category filter
  7069. ((eq type 'category)
  7070. (setq filter
  7071. (delete-dups
  7072. (append (get 'org-agenda-category-filter :preset-filter)
  7073. filter)))
  7074. (dolist (x filter)
  7075. (if (equal "-" (substring x 0 1))
  7076. (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
  7077. (setq f1 (list 'equal (substring x 1) 'cat)))
  7078. (push f1 f)))
  7079. ;; Regexp filter
  7080. ((eq type 'regexp)
  7081. (setq filter
  7082. (delete-dups
  7083. (append (get 'org-agenda-regexp-filter :preset-filter)
  7084. filter)))
  7085. (dolist (x filter)
  7086. (if (equal "-" (substring x 0 1))
  7087. (setq f1 (list 'not (list 'string-match (substring x 1) 'txt)))
  7088. (setq f1 (list 'string-match (substring x 1) 'txt)))
  7089. (push f1 f)))
  7090. ;; Effort filter
  7091. ((eq type 'effort)
  7092. (setq filter
  7093. (delete-dups
  7094. (append (get 'org-agenda-effort-filter :preset-filter)
  7095. filter)))
  7096. (dolist (x filter)
  7097. (push (org-agenda-filter-effort-form x) f))))
  7098. (cons 'and (nreverse f))))
  7099. (defun org-agenda-filter-make-matcher-tag-exp (tags op)
  7100. "Create the form that tests a line for agenda filter for
  7101. tag-expressions. Return a match-expression given TAGS. OP is an
  7102. operator of type CHAR that allows the function to set the right
  7103. switches in the returned form."
  7104. (let (f f1) ;f = return expression. f1 = working-area
  7105. (dolist (x tags)
  7106. (let* ((tag (substring x 1))
  7107. (isregexp (and (org-string-match-p "\\`{" tag)
  7108. (org-string-match-p "}\\'" tag)))
  7109. regexp)
  7110. (cond
  7111. (isregexp
  7112. (setq regexp (substring tag 1 -1))
  7113. (setq f1 (list 'org-match-any-p regexp 'tags)))
  7114. (t
  7115. (setq f1 (list 'member (downcase tag) 'tags))))
  7116. (when (eq op ?-)
  7117. (setq f1 (list 'not f1))))
  7118. (push f1 f))
  7119. ;; Any of the expressions can match if op = +
  7120. ;; all must match if the operator is -.
  7121. (if (eq op ?-)
  7122. (cons 'and f)
  7123. (cons 'or f))))
  7124. (defun org-agenda-filter-effort-form (e)
  7125. "Return the form to compare the effort of the current line with what E says.
  7126. E looks like \"+<2:25\"."
  7127. (let (op)
  7128. (setq e (substring e 1))
  7129. (setq op (string-to-char e) e (substring e 1))
  7130. (setq op (cond ((equal op ?<) '<=)
  7131. ((equal op ?>) '>=)
  7132. ((equal op ??) op)
  7133. (t '=)))
  7134. (list 'org-agenda-compare-effort (list 'quote op)
  7135. (org-duration-string-to-minutes e))))
  7136. (defun org-agenda-compare-effort (op value)
  7137. "Compare the effort of the current line with VALUE, using OP.
  7138. If the line does not have an effort defined, return nil."
  7139. (let ((eff (org-get-at-eol 'effort-minutes 1)))
  7140. (funcall op (or eff (if org-sort-agenda-noeffort-is-high 32767 -1))
  7141. value)))
  7142. (defun org-agenda-filter-expand-tags (filter &optional no-operator)
  7143. "Expand group tags in FILTER for the agenda.
  7144. When NO-OPERATOR is non-nil, do not add the + operator to returned tags."
  7145. (if org-group-tags
  7146. (let ((case-fold-search t) rtn)
  7147. (mapc
  7148. (lambda (f)
  7149. (let (f0 dir)
  7150. (if (string-match "^\\([+-]\\)\\(.+\\)" f)
  7151. (setq dir (match-string 1 f) f0 (match-string 2 f))
  7152. (setq dir (if no-operator "" "+") f0 f))
  7153. (setq rtn (append (mapcar (lambda(f1) (concat dir f1))
  7154. (org-tags-expand f0 t t))
  7155. rtn))))
  7156. filter)
  7157. (reverse rtn))
  7158. filter))
  7159. (defun org-agenda-filter-apply (filter type &optional expand)
  7160. "Set FILTER as the new agenda filter and apply it. Optional
  7161. argument EXPAND can be used for the TYPE tag and will expand the
  7162. tags in the FILTER if any of the tags in FILTER are grouptags."
  7163. ;; Deactivate `org-agenda-entry-text-mode' when filtering
  7164. (if org-agenda-entry-text-mode (org-agenda-entry-text-mode))
  7165. (let (tags cat txt)
  7166. (setq org-agenda-filter-form (org-agenda-filter-make-matcher filter type expand))
  7167. ;; Only set `org-agenda-filtered-by-category' to t when a unique
  7168. ;; category is used as the filter:
  7169. (setq org-agenda-filtered-by-category
  7170. (and (eq type 'category)
  7171. (not (equal (substring (car filter) 0 1) "-"))))
  7172. (org-agenda-set-mode-name)
  7173. (save-excursion
  7174. (goto-char (point-min))
  7175. (while (not (eobp))
  7176. (if (org-get-at-bol 'org-marker)
  7177. (progn
  7178. (setq tags (org-get-at-bol 'tags)
  7179. cat (org-get-at-eol 'org-category 1)
  7180. txt (org-get-at-bol 'txt))
  7181. (if (not (eval org-agenda-filter-form))
  7182. (org-agenda-filter-hide-line type))
  7183. (beginning-of-line 2))
  7184. (beginning-of-line 2))))
  7185. (if (get-char-property (point) 'invisible)
  7186. (ignore-errors (org-agenda-previous-line)))))
  7187. (defun org-agenda-filter-top-headline-apply (hl &optional negative)
  7188. "Filter by top headline HL."
  7189. (org-agenda-set-mode-name)
  7190. (save-excursion
  7191. (goto-char (point-min))
  7192. (while (not (eobp))
  7193. (let* ((pos (org-get-at-bol 'org-hd-marker))
  7194. (tophl (and pos (org-find-top-headline pos))))
  7195. (if (and tophl (funcall (if negative 'identity 'not)
  7196. (string= hl tophl)))
  7197. (org-agenda-filter-hide-line 'top-headline)))
  7198. (beginning-of-line 2)))
  7199. (if (get-char-property (point) 'invisible)
  7200. (org-agenda-previous-line))
  7201. (setq org-agenda-top-headline-filter hl
  7202. org-agenda-filtered-by-top-headline t))
  7203. (defun org-agenda-filter-hide-line (type)
  7204. "Hide lines with TYPE in the agenda buffer."
  7205. (let* ((b (max (point-min) (1- (point-at-bol))))
  7206. (e (point-at-eol)))
  7207. (let ((inhibit-read-only t))
  7208. (add-text-properties
  7209. b e `(invisible org-filtered org-filter-type ,type)))))
  7210. (defun org-agenda-remove-filter (type)
  7211. (interactive)
  7212. "Remove filter of type TYPE from the agenda buffer."
  7213. (save-excursion
  7214. (goto-char (point-min))
  7215. (let ((inhibit-read-only t) pos)
  7216. (while (setq pos (text-property-any (point) (point-max) 'org-filter-type type))
  7217. (goto-char pos)
  7218. (remove-text-properties
  7219. (point) (next-single-property-change (point) 'org-filter-type)
  7220. `(invisible org-filtered org-filter-type ,type))))
  7221. (set (intern (format "org-agenda-%s-filter" (intern-soft type))) nil)
  7222. (setq org-agenda-filter-form nil)
  7223. (org-agenda-set-mode-name)
  7224. (org-agenda-finalize)))
  7225. (defun org-agenda-filter-show-all-tag nil
  7226. (org-agenda-remove-filter 'tag))
  7227. (defun org-agenda-filter-show-all-re nil
  7228. (org-agenda-remove-filter 'regexp))
  7229. (defun org-agenda-filter-show-all-effort nil
  7230. (org-agenda-remove-filter 'effort))
  7231. (defun org-agenda-filter-show-all-cat nil
  7232. (org-agenda-remove-filter 'category))
  7233. (defun org-agenda-filter-show-all-top-filter nil
  7234. (org-agenda-remove-filter 'top-headline))
  7235. (defun org-agenda-manipulate-query-add ()
  7236. "Manipulate the query by adding a search term with positive selection.
  7237. Positive selection means the term must be matched for selection of an entry."
  7238. (interactive)
  7239. (org-agenda-manipulate-query ?\[))
  7240. (defun org-agenda-manipulate-query-subtract ()
  7241. "Manipulate the query by adding a search term with negative selection.
  7242. Negative selection means term must not be matched for selection of an entry."
  7243. (interactive)
  7244. (org-agenda-manipulate-query ?\]))
  7245. (defun org-agenda-manipulate-query-add-re ()
  7246. "Manipulate the query by adding a search regexp with positive selection.
  7247. Positive selection means the regexp must match for selection of an entry."
  7248. (interactive)
  7249. (org-agenda-manipulate-query ?\{))
  7250. (defun org-agenda-manipulate-query-subtract-re ()
  7251. "Manipulate the query by adding a search regexp with negative selection.
  7252. Negative selection means regexp must not match for selection of an entry."
  7253. (interactive)
  7254. (org-agenda-manipulate-query ?\}))
  7255. (defun org-agenda-manipulate-query (char)
  7256. (cond
  7257. ((memq org-agenda-type '(timeline agenda))
  7258. (let ((org-agenda-include-inactive-timestamps t))
  7259. (org-agenda-redo))
  7260. (message "Display now includes inactive timestamps as well"))
  7261. ((eq org-agenda-type 'search)
  7262. (org-add-to-string
  7263. 'org-agenda-query-string
  7264. (if org-agenda-last-search-view-search-was-boolean
  7265. (cdr (assoc char '((?\[ . " +") (?\] . " -")
  7266. (?\{ . " +{}") (?\} . " -{}"))))
  7267. " "))
  7268. (setq org-agenda-redo-command
  7269. (list 'org-search-view
  7270. (car (get-text-property (min (1- (point-max)) (point))
  7271. 'org-last-args))
  7272. org-agenda-query-string
  7273. (+ (length org-agenda-query-string)
  7274. (if (member char '(?\{ ?\})) 0 1))))
  7275. (set-register org-agenda-query-register org-agenda-query-string)
  7276. (let ((org-agenda-overriding-arguments
  7277. (cdr org-agenda-redo-command)))
  7278. (org-agenda-redo)))
  7279. (t (error "Cannot manipulate query for %s-type agenda buffers"
  7280. org-agenda-type))))
  7281. (defun org-add-to-string (var string)
  7282. (set var (concat (symbol-value var) string)))
  7283. (defun org-agenda-goto-date (span)
  7284. "Jump to DATE in agenda."
  7285. (interactive "P")
  7286. (let* ((org-read-date-prefer-future
  7287. (eval org-agenda-jump-prefer-future))
  7288. (date (org-read-date))
  7289. (day (time-to-days (org-time-string-to-time date)))
  7290. (org-agenda-sticky-orig org-agenda-sticky)
  7291. (org-agenda-buffer-tmp-name (buffer-name))
  7292. (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7293. (0-arg (or current-prefix-arg (car args)))
  7294. (2-arg (nth 2 args))
  7295. (with-hour-p (nth 4 org-agenda-redo-command))
  7296. (newcmd (list 'org-agenda-list 0-arg date
  7297. (org-agenda-span-to-ndays
  7298. 2-arg (org-time-string-to-absolute date))
  7299. with-hour-p))
  7300. (newargs (cdr newcmd))
  7301. (inhibit-read-only t)
  7302. org-agenda-sticky)
  7303. (if (not (org-agenda-check-type t 'agenda))
  7304. (error "Not available in non-agenda views")
  7305. (add-text-properties (point-min) (point-max)
  7306. `(org-redo-cmd ,newcmd org-last-args ,newargs))
  7307. (org-agenda-redo)
  7308. (goto-char (point-min))
  7309. (while (not (or (= (or (get-text-property (point) 'day) 0) day)
  7310. (save-excursion (move-beginning-of-line 2) (eobp))))
  7311. (move-beginning-of-line 2))
  7312. (setq org-agenda-sticky org-agenda-sticky-orig
  7313. org-agenda-this-buffer-is-sticky org-agenda-sticky))))
  7314. (defun org-agenda-goto-today ()
  7315. "Go to today."
  7316. (interactive)
  7317. (org-agenda-check-type t 'timeline 'agenda)
  7318. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7319. (curspan (nth 2 args))
  7320. (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
  7321. (cond
  7322. (tdpos (goto-char tdpos))
  7323. ((eq org-agenda-type 'agenda)
  7324. (let* ((sd (org-agenda-compute-starting-span
  7325. (org-today) (or curspan org-agenda-ndays org-agenda-span)))
  7326. (org-agenda-overriding-arguments args))
  7327. (setf (nth 1 org-agenda-overriding-arguments) sd)
  7328. (org-agenda-redo)
  7329. (org-agenda-find-same-or-today-or-agenda)))
  7330. (t (error "Cannot find today")))))
  7331. (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
  7332. (goto-char
  7333. (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
  7334. (text-property-any (point-min) (point-max) 'org-today t)
  7335. (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
  7336. (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
  7337. (org-agenda-backward-block))
  7338. (point-min))))
  7339. (defun org-agenda-backward-block ()
  7340. "Move backward by one agenda block."
  7341. (interactive)
  7342. (org-agenda-forward-block 'backward))
  7343. (defun org-agenda-forward-block (&optional backward)
  7344. "Move forward by one agenda block.
  7345. When optional argument BACKWARD is set, go backward"
  7346. (interactive)
  7347. (cond ((not (derived-mode-p 'org-agenda-mode))
  7348. (user-error
  7349. "Cannot execute this command outside of org-agenda-mode buffers"))
  7350. ((looking-at (if backward "\\`" "\\'"))
  7351. (message "Already at the %s block" (if backward "first" "last")))
  7352. (t (let ((pos (prog1 (point)
  7353. (ignore-errors (if backward (backward-char 1)
  7354. (move-end-of-line 1)))))
  7355. (f (if backward
  7356. 'previous-single-property-change
  7357. 'next-single-property-change))
  7358. moved dest)
  7359. (while (and (setq dest (funcall
  7360. f (point) 'org-agenda-structural-header))
  7361. (not (get-text-property
  7362. (point) 'org-agenda-structural-header)))
  7363. (setq moved t)
  7364. (goto-char dest))
  7365. (if moved (move-beginning-of-line 1)
  7366. (goto-char (if backward (point-min) (point-max)))
  7367. (move-beginning-of-line 1)
  7368. (message "No %s block" (if backward "previous" "further")))))))
  7369. (defun org-agenda-later (arg)
  7370. "Go forward in time by the current span.
  7371. With prefix ARG, go forward that many times the current span."
  7372. (interactive "p")
  7373. (org-agenda-check-type t 'agenda)
  7374. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7375. (span (or (nth 2 args) org-agenda-current-span))
  7376. (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
  7377. (greg (calendar-gregorian-from-absolute sd))
  7378. (cnt (org-get-at-bol 'org-day-cnt))
  7379. greg2)
  7380. (cond
  7381. ((numberp span)
  7382. (setq sd (+ (* span arg) sd)))
  7383. ((eq span 'day)
  7384. (setq sd (+ arg sd)))
  7385. ((eq span 'week)
  7386. (setq sd (+ (* 7 arg) sd)))
  7387. ((eq span 'fortnight)
  7388. (setq sd (+ (* 14 arg) sd)))
  7389. ((eq span 'month)
  7390. (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
  7391. sd (calendar-absolute-from-gregorian greg2))
  7392. (setcar greg2 (1+ (car greg2))))
  7393. ((eq span 'year)
  7394. (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
  7395. sd (calendar-absolute-from-gregorian greg2))
  7396. (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
  7397. (t
  7398. (setq sd (+ (* span arg) sd))))
  7399. (let ((org-agenda-overriding-cmd
  7400. ;; `cmd' may have been set by `org-agenda-run-series' which
  7401. ;; uses `org-agenda-overriding-cmd' to decide whether
  7402. ;; overriding is allowed for `cmd'
  7403. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7404. (org-agenda-overriding-arguments
  7405. (list (car args) sd span)))
  7406. (org-agenda-redo)
  7407. (org-agenda-find-same-or-today-or-agenda cnt))))
  7408. (defun org-agenda-earlier (arg)
  7409. "Go backward in time by the current span.
  7410. With prefix ARG, go backward that many times the current span."
  7411. (interactive "p")
  7412. (org-agenda-later (- arg)))
  7413. (defun org-agenda-view-mode-dispatch ()
  7414. "Call one of the view mode commands."
  7415. (interactive)
  7416. (message "View: [d]ay [w]eek for[t]night [m]onth [y]ear [SPC]reset [q]uit/abort
  7417. time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
  7418. [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
  7419. (let ((a (read-char-exclusive)))
  7420. (case a
  7421. (?\ (call-interactively 'org-agenda-reset-view))
  7422. (?d (call-interactively 'org-agenda-day-view))
  7423. (?w (call-interactively 'org-agenda-week-view))
  7424. (?t (call-interactively 'org-agenda-fortnight-view))
  7425. (?m (call-interactively 'org-agenda-month-view))
  7426. (?y (call-interactively 'org-agenda-year-view))
  7427. (?l (call-interactively 'org-agenda-log-mode))
  7428. (?L (org-agenda-log-mode '(4)))
  7429. (?c (org-agenda-log-mode 'clockcheck))
  7430. ((?F ?f) (call-interactively 'org-agenda-follow-mode))
  7431. (?a (call-interactively 'org-agenda-archives-mode))
  7432. (?A (org-agenda-archives-mode 'files))
  7433. ((?R ?r) (call-interactively 'org-agenda-clockreport-mode))
  7434. ((?E ?e) (call-interactively 'org-agenda-entry-text-mode))
  7435. (?G (call-interactively 'org-agenda-toggle-time-grid))
  7436. (?D (call-interactively 'org-agenda-toggle-diary))
  7437. (?\! (call-interactively 'org-agenda-toggle-deadlines))
  7438. (?\[ (let ((org-agenda-include-inactive-timestamps t))
  7439. (org-agenda-check-type t 'timeline 'agenda)
  7440. (org-agenda-redo))
  7441. (message "Display now includes inactive timestamps as well"))
  7442. (?q (message "Abort"))
  7443. (otherwise (error "Invalid key" )))))
  7444. (defun org-agenda-reset-view ()
  7445. "Switch to default view for agenda."
  7446. (interactive)
  7447. (org-agenda-change-time-span (or org-agenda-ndays org-agenda-span)))
  7448. (defun org-agenda-day-view (&optional day-of-month)
  7449. "Switch to daily view for agenda.
  7450. With argument DAY-OF-MONTH, switch to that day of the month."
  7451. (interactive "P")
  7452. (org-agenda-change-time-span 'day day-of-month))
  7453. (defun org-agenda-week-view (&optional iso-week)
  7454. "Switch to daily view for agenda.
  7455. With argument ISO-WEEK, switch to the corresponding ISO week.
  7456. If ISO-WEEK has more then 2 digits, only the last two encode the
  7457. week. Any digits before this encode a year. So 200712 means
  7458. week 12 of year 2007. Years in the range 1938-2037 can also be
  7459. written as 2-digit years."
  7460. (interactive "P")
  7461. (org-agenda-change-time-span 'week iso-week))
  7462. (defun org-agenda-fortnight-view (&optional iso-week)
  7463. "Switch to daily view for agenda.
  7464. With argument ISO-WEEK, switch to the corresponding ISO week.
  7465. If ISO-WEEK has more then 2 digits, only the last two encode the
  7466. week. Any digits before this encode a year. So 200712 means
  7467. week 12 of year 2007. Years in the range 1938-2037 can also be
  7468. written as 2-digit years."
  7469. (interactive "P")
  7470. (org-agenda-change-time-span 'fortnight iso-week))
  7471. (defun org-agenda-month-view (&optional month)
  7472. "Switch to monthly view for agenda.
  7473. With argument MONTH, switch to that month."
  7474. (interactive "P")
  7475. (org-agenda-change-time-span 'month month))
  7476. (defun org-agenda-year-view (&optional year)
  7477. "Switch to yearly view for agenda.
  7478. With argument YEAR, switch to that year.
  7479. If MONTH has more then 2 digits, only the last two encode the
  7480. month. Any digits before this encode a year. So 200712 means
  7481. December year 2007. Years in the range 1938-2037 can also be
  7482. written as 2-digit years."
  7483. (interactive "P")
  7484. (when year
  7485. (setq year (org-small-year-to-year year)))
  7486. (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
  7487. (org-agenda-change-time-span 'year year)
  7488. (error "Abort")))
  7489. (defun org-agenda-change-time-span (span &optional n)
  7490. "Change the agenda view to SPAN.
  7491. SPAN may be `day', `week', `fortnight', `month', `year'."
  7492. (org-agenda-check-type t 'agenda)
  7493. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7494. (curspan (nth 2 args)))
  7495. (if (and (not n) (equal curspan span))
  7496. (error "Viewing span is already \"%s\"" span))
  7497. (let* ((sd (or (org-get-at-bol 'day)
  7498. (nth 1 args)
  7499. org-starting-day))
  7500. (sd (org-agenda-compute-starting-span sd span n))
  7501. (org-agenda-overriding-cmd
  7502. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7503. (org-agenda-overriding-arguments
  7504. (list (car args) sd span)))
  7505. (org-agenda-redo)
  7506. (org-agenda-find-same-or-today-or-agenda))
  7507. (org-agenda-set-mode-name)
  7508. (message "Switched to %s view" span)))
  7509. (defun org-agenda-compute-starting-span (sd span &optional n)
  7510. "Compute starting date for agenda.
  7511. SPAN may be `day', `week', `fortnight', `month', `year'. The return value
  7512. is a cons cell with the starting date and the number of days,
  7513. so that the date SD will be in that range."
  7514. (let* ((greg (calendar-gregorian-from-absolute sd))
  7515. (dg (nth 1 greg))
  7516. (mg (car greg))
  7517. (yg (nth 2 greg)))
  7518. (cond
  7519. ((eq span 'day)
  7520. (when n
  7521. (setq sd (+ (calendar-absolute-from-gregorian
  7522. (list mg 1 yg))
  7523. n -1))))
  7524. ((or (eq span 'week) (eq span 'fortnight))
  7525. (let* ((nt (calendar-day-of-week
  7526. (calendar-gregorian-from-absolute sd)))
  7527. (d (if org-agenda-start-on-weekday
  7528. (- nt org-agenda-start-on-weekday)
  7529. 0))
  7530. y1)
  7531. (setq sd (- sd (+ (if (< d 0) 7 0) d)))
  7532. (when n
  7533. (require 'cal-iso)
  7534. (when (> n 99)
  7535. (setq y1 (org-small-year-to-year (/ n 100))
  7536. n (mod n 100)))
  7537. (setq sd
  7538. (calendar-iso-to-absolute
  7539. (list n 1
  7540. (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
  7541. ((eq span 'month)
  7542. (let (y1)
  7543. (when (and n (> n 99))
  7544. (setq y1 (org-small-year-to-year (/ n 100))
  7545. n (mod n 100)))
  7546. (setq sd (calendar-absolute-from-gregorian
  7547. (list (or n mg) 1 (or y1 yg))))))
  7548. ((eq span 'year)
  7549. (setq sd (calendar-absolute-from-gregorian
  7550. (list 1 1 (or n yg))))))
  7551. sd))
  7552. (defun org-agenda-next-date-line (&optional arg)
  7553. "Jump to the next line indicating a date in agenda buffer."
  7554. (interactive "p")
  7555. (org-agenda-check-type t 'agenda 'timeline)
  7556. (beginning-of-line 1)
  7557. ;; This does not work if user makes date format that starts with a blank
  7558. (if (looking-at "^\\S-") (forward-char 1))
  7559. (if (not (re-search-forward "^\\S-" nil t arg))
  7560. (progn
  7561. (backward-char 1)
  7562. (error "No next date after this line in this buffer")))
  7563. (goto-char (match-beginning 0)))
  7564. (defun org-agenda-previous-date-line (&optional arg)
  7565. "Jump to the previous line indicating a date in agenda buffer."
  7566. (interactive "p")
  7567. (org-agenda-check-type t 'agenda 'timeline)
  7568. (beginning-of-line 1)
  7569. (if (not (re-search-backward "^\\S-" nil t arg))
  7570. (error "No previous date before this line in this buffer")))
  7571. ;; Initialize the highlight
  7572. (defvar org-hl (make-overlay 1 1))
  7573. (overlay-put org-hl 'face 'highlight)
  7574. (defun org-highlight (begin end &optional buffer)
  7575. "Highlight a region with overlay."
  7576. (move-overlay org-hl begin end (or buffer (current-buffer))))
  7577. (defun org-unhighlight ()
  7578. "Detach overlay INDEX."
  7579. (org-detach-overlay org-hl))
  7580. (defun org-unhighlight-once ()
  7581. "Remove the highlight from its position, and this function from the hook."
  7582. (remove-hook 'pre-command-hook 'org-unhighlight-once)
  7583. (org-unhighlight))
  7584. (defvar org-agenda-pre-follow-window-conf nil)
  7585. (defun org-agenda-follow-mode ()
  7586. "Toggle follow mode in an agenda buffer."
  7587. (interactive)
  7588. (unless org-agenda-follow-mode
  7589. (setq org-agenda-pre-follow-window-conf
  7590. (current-window-configuration)))
  7591. (setq org-agenda-follow-mode (not org-agenda-follow-mode))
  7592. (unless org-agenda-follow-mode
  7593. (set-window-configuration org-agenda-pre-follow-window-conf))
  7594. (org-agenda-set-mode-name)
  7595. (org-agenda-do-context-action)
  7596. (message "Follow mode is %s"
  7597. (if org-agenda-follow-mode "on" "off")))
  7598. (defun org-agenda-entry-text-mode (&optional arg)
  7599. "Toggle entry text mode in an agenda buffer."
  7600. (interactive "P")
  7601. (if (or org-agenda-tag-filter
  7602. org-agenda-category-filter
  7603. org-agenda-regexp-filter
  7604. org-agenda-top-headline-filter)
  7605. (user-error "Can't show entry text in filtered views")
  7606. (setq org-agenda-entry-text-mode (or (integerp arg)
  7607. (not org-agenda-entry-text-mode)))
  7608. (org-agenda-entry-text-hide)
  7609. (and org-agenda-entry-text-mode
  7610. (let ((org-agenda-entry-text-maxlines
  7611. (if (integerp arg) arg org-agenda-entry-text-maxlines)))
  7612. (org-agenda-entry-text-show)))
  7613. (org-agenda-set-mode-name)
  7614. (message "Entry text mode is %s%s"
  7615. (if org-agenda-entry-text-mode "on" "off")
  7616. (if (not org-agenda-entry-text-mode) ""
  7617. (format " (maximum number of lines is %d)"
  7618. (if (integerp arg) arg org-agenda-entry-text-maxlines))))))
  7619. (defun org-agenda-clockreport-mode ()
  7620. "Toggle clocktable mode in an agenda buffer."
  7621. (interactive)
  7622. (org-agenda-check-type t 'agenda)
  7623. (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode))
  7624. (setq org-agenda-start-with-clockreport-mode org-agenda-clockreport-mode)
  7625. (org-agenda-set-mode-name)
  7626. (org-agenda-redo)
  7627. (message "Clocktable mode is %s"
  7628. (if org-agenda-clockreport-mode "on" "off")))
  7629. (defun org-agenda-log-mode (&optional special)
  7630. "Toggle log mode in an agenda buffer.
  7631. With argument SPECIAL, show all possible log items, not only the ones
  7632. configured in `org-agenda-log-mode-items'.
  7633. With a double \\[universal-argument] prefix arg, show *only* \
  7634. log items, nothing else."
  7635. (interactive "P")
  7636. (org-agenda-check-type t 'agenda 'timeline)
  7637. (setq org-agenda-show-log
  7638. (cond
  7639. ((equal special '(16)) 'only)
  7640. ((eq special 'clockcheck)
  7641. (if (eq org-agenda-show-log 'clockcheck)
  7642. nil 'clockcheck))
  7643. (special '(closed clock state))
  7644. (t (not org-agenda-show-log))))
  7645. (setq org-agenda-start-with-log-mode org-agenda-show-log)
  7646. (org-agenda-set-mode-name)
  7647. (org-agenda-redo)
  7648. (message "Log mode is %s"
  7649. (if org-agenda-show-log "on" "off")))
  7650. (defun org-agenda-archives-mode (&optional with-files)
  7651. "Toggle inclusion of items in trees marked with :ARCHIVE:.
  7652. When called with a prefix argument, include all archive files as well."
  7653. (interactive "P")
  7654. (setq org-agenda-archives-mode
  7655. (if with-files t (if org-agenda-archives-mode nil 'trees)))
  7656. (org-agenda-set-mode-name)
  7657. (org-agenda-redo)
  7658. (message
  7659. "%s"
  7660. (cond
  7661. ((eq org-agenda-archives-mode nil)
  7662. "No archives are included")
  7663. ((eq org-agenda-archives-mode 'trees)
  7664. (format "Trees with :%s: tag are included" org-archive-tag))
  7665. ((eq org-agenda-archives-mode t)
  7666. (format "Trees with :%s: tag and all active archive files are included"
  7667. org-archive-tag)))))
  7668. (defun org-agenda-toggle-diary ()
  7669. "Toggle diary inclusion in an agenda buffer."
  7670. (interactive)
  7671. (org-agenda-check-type t 'agenda)
  7672. (setq org-agenda-include-diary (not org-agenda-include-diary))
  7673. (org-agenda-redo)
  7674. (org-agenda-set-mode-name)
  7675. (message "Diary inclusion turned %s"
  7676. (if org-agenda-include-diary "on" "off")))
  7677. (defun org-agenda-toggle-deadlines ()
  7678. "Toggle inclusion of entries with a deadline in an agenda buffer."
  7679. (interactive)
  7680. (org-agenda-check-type t 'agenda)
  7681. (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
  7682. (org-agenda-redo)
  7683. (org-agenda-set-mode-name)
  7684. (message "Deadlines inclusion turned %s"
  7685. (if org-agenda-include-deadlines "on" "off")))
  7686. (defun org-agenda-toggle-time-grid ()
  7687. "Toggle time grid in an agenda buffer."
  7688. (interactive)
  7689. (org-agenda-check-type t 'agenda)
  7690. (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
  7691. (org-agenda-redo)
  7692. (org-agenda-set-mode-name)
  7693. (message "Time-grid turned %s"
  7694. (if org-agenda-use-time-grid "on" "off")))
  7695. (defun org-agenda-set-mode-name ()
  7696. "Set the mode name to indicate all the small mode settings."
  7697. (setq mode-name
  7698. (list "Org-Agenda"
  7699. (if (get 'org-agenda-files 'org-restrict) " []" "")
  7700. " "
  7701. '(:eval (org-agenda-span-name org-agenda-current-span))
  7702. (if org-agenda-follow-mode " Follow" "")
  7703. (if org-agenda-entry-text-mode " ETxt" "")
  7704. (if org-agenda-include-diary " Diary" "")
  7705. (if org-agenda-include-deadlines " Ddl" "")
  7706. (if org-agenda-use-time-grid " Grid" "")
  7707. (if (and (boundp 'org-habit-show-habits)
  7708. org-habit-show-habits) " Habit" "")
  7709. (cond
  7710. ((consp org-agenda-show-log) " LogAll")
  7711. ((eq org-agenda-show-log 'clockcheck) " ClkCk")
  7712. (org-agenda-show-log " Log")
  7713. (t ""))
  7714. (if (or org-agenda-category-filter
  7715. (get 'org-agenda-category-filter :preset-filter))
  7716. '(:eval (org-propertize
  7717. (concat " <"
  7718. (mapconcat
  7719. 'identity
  7720. (append
  7721. (get 'org-agenda-category-filter :preset-filter)
  7722. org-agenda-category-filter)
  7723. "")
  7724. ">")
  7725. 'face 'org-agenda-filter-category
  7726. 'help-echo "Category used in filtering")) "")
  7727. (if (or org-agenda-tag-filter
  7728. (get 'org-agenda-tag-filter :preset-filter))
  7729. '(:eval (org-propertize
  7730. (concat " {"
  7731. (mapconcat
  7732. 'identity
  7733. (append
  7734. (get 'org-agenda-tag-filter :preset-filter)
  7735. org-agenda-tag-filter)
  7736. "")
  7737. "}")
  7738. 'face 'org-agenda-filter-tags
  7739. 'help-echo "Tags used in filtering")) "")
  7740. (if (or org-agenda-effort-filter
  7741. (get 'org-agenda-effort-filter :preset-filter))
  7742. '(:eval (org-propertize
  7743. (concat " {"
  7744. (mapconcat
  7745. 'identity
  7746. (append
  7747. (get 'org-agenda-effort-filter :preset-filter)
  7748. org-agenda-effort-filter)
  7749. "")
  7750. "}")
  7751. 'face 'org-agenda-filter-effort
  7752. 'help-echo "Effort conditions used in filtering")) "")
  7753. (if (or org-agenda-regexp-filter
  7754. (get 'org-agenda-regexp-filter :preset-filter))
  7755. '(:eval (org-propertize
  7756. (concat " ["
  7757. (mapconcat
  7758. 'identity
  7759. (append
  7760. (get 'org-agenda-regexp-filter :preset-filter)
  7761. org-agenda-regexp-filter)
  7762. "")
  7763. "]")
  7764. 'face 'org-agenda-filter-regexp
  7765. 'help-echo "Regexp used in filtering")) "")
  7766. (if org-agenda-archives-mode
  7767. (if (eq org-agenda-archives-mode t)
  7768. " Archives"
  7769. (format " :%s:" org-archive-tag))
  7770. "")
  7771. (if org-agenda-clockreport-mode " Clock" "")))
  7772. (force-mode-line-update))
  7773. (define-obsolete-function-alias
  7774. 'org-agenda-post-command-hook 'org-agenda-update-agenda-type "24.3")
  7775. (defun org-agenda-update-agenda-type ()
  7776. "Update the agenda type after each command."
  7777. (setq org-agenda-type
  7778. (or (get-text-property (point) 'org-agenda-type)
  7779. (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
  7780. (defun org-agenda-next-line ()
  7781. "Move cursor to the next line, and show if follow mode is active."
  7782. (interactive)
  7783. (call-interactively 'next-line)
  7784. (org-agenda-do-context-action))
  7785. (defun org-agenda-previous-line ()
  7786. "Move cursor to the previous line, and show if follow-mode is active."
  7787. (interactive)
  7788. (call-interactively 'previous-line)
  7789. (org-agenda-do-context-action))
  7790. (defun org-agenda-next-item (n)
  7791. "Move cursor to next agenda item."
  7792. (interactive "p")
  7793. (let ((col (current-column)))
  7794. (dotimes (c n)
  7795. (when (next-single-property-change (point-at-eol) 'org-marker)
  7796. (move-end-of-line 1)
  7797. (goto-char (next-single-property-change (point) 'org-marker))))
  7798. (org-move-to-column col))
  7799. (org-agenda-do-context-action))
  7800. (defun org-agenda-previous-item (n)
  7801. "Move cursor to next agenda item."
  7802. (interactive "p")
  7803. (dotimes (c n)
  7804. (let ((col (current-column))
  7805. (goto (save-excursion
  7806. (move-end-of-line 0)
  7807. (previous-single-property-change (point) 'org-marker))))
  7808. (if goto (goto-char goto))
  7809. (org-move-to-column col)))
  7810. (org-agenda-do-context-action))
  7811. (defun org-agenda-do-context-action ()
  7812. "Show outline path and, maybe, follow mode window."
  7813. (let ((m (org-get-at-bol 'org-marker)))
  7814. (when (and (markerp m) (marker-buffer m))
  7815. (and org-agenda-follow-mode
  7816. (if org-agenda-follow-indirect
  7817. (org-agenda-tree-to-indirect-buffer nil)
  7818. (org-agenda-show)))
  7819. (and org-agenda-show-outline-path
  7820. (org-with-point-at m (org-display-outline-path t))))))
  7821. (defun org-agenda-show-tags ()
  7822. "Show the tags applicable to the current item."
  7823. (interactive)
  7824. (let* ((tags (org-get-at-bol 'tags)))
  7825. (if tags
  7826. (message "Tags are :%s:"
  7827. (org-no-properties (mapconcat 'identity tags ":")))
  7828. (message "No tags associated with this line"))))
  7829. (defun org-agenda-goto (&optional highlight)
  7830. "Go to the entry at point in the corresponding Org-mode file."
  7831. (interactive)
  7832. (let* ((marker (or (org-get-at-bol 'org-marker)
  7833. (org-agenda-error)))
  7834. (buffer (marker-buffer marker))
  7835. (pos (marker-position marker)))
  7836. (switch-to-buffer-other-window buffer)
  7837. (widen)
  7838. (push-mark)
  7839. (goto-char pos)
  7840. (when (derived-mode-p 'org-mode)
  7841. (org-show-context 'agenda)
  7842. (save-excursion
  7843. (and (outline-next-heading)
  7844. (org-flag-heading nil))) ; show the next heading
  7845. (when (outline-invisible-p)
  7846. (outline-show-entry)) ; display invisible text
  7847. (recenter (/ (window-height) 2))
  7848. (org-back-to-heading t)
  7849. (if (re-search-forward org-complex-heading-regexp nil t)
  7850. (goto-char (match-beginning 4))))
  7851. (run-hooks 'org-agenda-after-show-hook)
  7852. (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
  7853. (defvar org-agenda-after-show-hook nil
  7854. "Normal hook run after an item has been shown from the agenda.
  7855. Point is in the buffer where the item originated.")
  7856. (defun org-agenda-kill ()
  7857. "Kill the entry or subtree belonging to the current agenda entry."
  7858. (interactive)
  7859. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  7860. (let* ((bufname-orig (buffer-name))
  7861. (marker (or (org-get-at-bol 'org-marker)
  7862. (org-agenda-error)))
  7863. (buffer (marker-buffer marker))
  7864. (pos (marker-position marker))
  7865. (type (org-get-at-bol 'type))
  7866. dbeg dend (n 0) conf)
  7867. (org-with-remote-undo buffer
  7868. (with-current-buffer buffer
  7869. (save-excursion
  7870. (goto-char pos)
  7871. (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
  7872. (setq dbeg (progn (org-back-to-heading t) (point))
  7873. dend (org-end-of-subtree t t))
  7874. (setq dbeg (point-at-bol)
  7875. dend (min (point-max) (1+ (point-at-eol)))))
  7876. (goto-char dbeg)
  7877. (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
  7878. (setq conf (or (eq t org-agenda-confirm-kill)
  7879. (and (numberp org-agenda-confirm-kill)
  7880. (> n org-agenda-confirm-kill))))
  7881. (and conf
  7882. (not (y-or-n-p
  7883. (format "Delete entry with %d lines in buffer \"%s\"? "
  7884. n (buffer-name buffer))))
  7885. (error "Abort"))
  7886. (let ((org-agenda-buffer-name bufname-orig))
  7887. (org-remove-subtree-entries-from-agenda buffer dbeg dend))
  7888. (with-current-buffer buffer (delete-region dbeg dend))
  7889. (message "Agenda item and source killed"))))
  7890. (defvar org-archive-default-command) ; defined in org-archive.el
  7891. (defun org-agenda-archive-default ()
  7892. "Archive the entry or subtree belonging to the current agenda entry."
  7893. (interactive)
  7894. (require 'org-archive)
  7895. (org-agenda-archive-with org-archive-default-command))
  7896. (defun org-agenda-archive-default-with-confirmation ()
  7897. "Archive the entry or subtree belonging to the current agenda entry."
  7898. (interactive)
  7899. (require 'org-archive)
  7900. (org-agenda-archive-with org-archive-default-command 'confirm))
  7901. (defun org-agenda-archive ()
  7902. "Archive the entry or subtree belonging to the current agenda entry."
  7903. (interactive)
  7904. (org-agenda-archive-with 'org-archive-subtree))
  7905. (defun org-agenda-archive-to-archive-sibling ()
  7906. "Move the entry to the archive sibling."
  7907. (interactive)
  7908. (org-agenda-archive-with 'org-archive-to-archive-sibling))
  7909. (defun org-agenda-archive-with (cmd &optional confirm)
  7910. "Move the entry to the archive sibling."
  7911. (interactive)
  7912. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  7913. (let* ((bufname-orig (buffer-name))
  7914. (marker (or (org-get-at-bol 'org-marker)
  7915. (org-agenda-error)))
  7916. (buffer (marker-buffer marker))
  7917. (pos (marker-position marker)))
  7918. (org-with-remote-undo buffer
  7919. (with-current-buffer buffer
  7920. (if (derived-mode-p 'org-mode)
  7921. (if (and confirm
  7922. (not (y-or-n-p "Archive this subtree or entry? ")))
  7923. (error "Abort")
  7924. (save-window-excursion
  7925. (goto-char pos)
  7926. (let ((org-agenda-buffer-name bufname-orig))
  7927. (org-remove-subtree-entries-from-agenda))
  7928. (org-back-to-heading t)
  7929. (funcall cmd)))
  7930. (error "Archiving works only in Org-mode files"))))))
  7931. (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
  7932. "Remove all lines in the agenda that correspond to a given subtree.
  7933. The subtree is the one in buffer BUF, starting at BEG and ending at END.
  7934. If this information is not given, the function uses the tree at point."
  7935. (let ((buf (or buf (current-buffer))) m p)
  7936. (save-excursion
  7937. (unless (and beg end)
  7938. (org-back-to-heading t)
  7939. (setq beg (point))
  7940. (org-end-of-subtree t)
  7941. (setq end (point)))
  7942. (set-buffer (get-buffer org-agenda-buffer-name))
  7943. (save-excursion
  7944. (goto-char (point-max))
  7945. (beginning-of-line 1)
  7946. (while (not (bobp))
  7947. (when (and (setq m (org-get-at-bol 'org-marker))
  7948. (equal buf (marker-buffer m))
  7949. (setq p (marker-position m))
  7950. (>= p beg)
  7951. (< p end))
  7952. (let ((inhibit-read-only t))
  7953. (delete-region (point-at-bol) (1+ (point-at-eol)))))
  7954. (beginning-of-line 0))))))
  7955. (defun org-agenda-refile (&optional goto rfloc no-update)
  7956. "Refile the item at point.
  7957. When GOTO is 0 or \\='(64) or a triple \\[universal-argument] prefix argument,
  7958. clear the refile cache.
  7959. When GOTO is \\='(16) or a double \\[universal-argument] prefix argument,
  7960. go to the location of the last refiled item.
  7961. RFLOC can be a refile location obtained in a different way.
  7962. When NO-UPDATE is non-nil, don't redo the agenda buffer."
  7963. (interactive "P")
  7964. (cond
  7965. ((member goto '(0 (64)))
  7966. (org-refile-cache-clear))
  7967. ((equal goto '(16))
  7968. (org-refile-goto-last-stored))
  7969. (t
  7970. (let* ((buffer-orig (buffer-name))
  7971. (marker (or (org-get-at-bol 'org-hd-marker)
  7972. (org-agenda-error)))
  7973. (buffer (marker-buffer marker))
  7974. (pos (marker-position marker))
  7975. (rfloc (or rfloc
  7976. (org-refile-get-location
  7977. (if goto "Goto" "Refile to") buffer
  7978. org-refile-allow-creating-parent-nodes))))
  7979. (with-current-buffer buffer
  7980. (save-excursion
  7981. (save-restriction
  7982. (widen)
  7983. (goto-char marker)
  7984. (let ((org-agenda-buffer-name buffer-orig))
  7985. (org-remove-subtree-entries-from-agenda))
  7986. (org-refile goto buffer rfloc)))))
  7987. (unless no-update (org-agenda-redo)))))
  7988. (defun org-agenda-open-link (&optional arg)
  7989. "Open the link(s) in the current entry, if any.
  7990. This looks for a link in the displayed line in the agenda.
  7991. It also looks at the text of the entry itself."
  7992. (interactive "P")
  7993. (let* ((marker (or (org-get-at-bol 'org-hd-marker)
  7994. (org-get-at-bol 'org-marker)))
  7995. (buffer (and marker (marker-buffer marker)))
  7996. (prefix (buffer-substring (point-at-bol) (point-at-eol)))
  7997. (lkall (and buffer (org-offer-links-in-entry
  7998. buffer marker arg prefix)))
  7999. (lk0 (car lkall))
  8000. (lk (if (stringp lk0) (list lk0) lk0))
  8001. (lkend (cdr lkall))
  8002. trg)
  8003. (cond
  8004. ((and buffer lk)
  8005. (mapcar (lambda(l)
  8006. (with-current-buffer buffer
  8007. (setq trg (and (string-match org-bracket-link-regexp l)
  8008. (match-string 1 l)))
  8009. (if (or (not trg) (string-match org-any-link-re trg))
  8010. (save-excursion
  8011. (save-restriction
  8012. (widen)
  8013. (goto-char marker)
  8014. (when (search-forward l nil lkend)
  8015. (goto-char (match-beginning 0))
  8016. (org-open-at-point))))
  8017. ;; This is an internal link, widen the buffer
  8018. (switch-to-buffer-other-window buffer)
  8019. (widen)
  8020. (goto-char marker)
  8021. (when (search-forward l nil lkend)
  8022. (goto-char (match-beginning 0))
  8023. (org-open-at-point)))))
  8024. lk))
  8025. ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
  8026. (save-excursion
  8027. (beginning-of-line 1)
  8028. (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
  8029. (org-open-link-from-string (match-string 1)))
  8030. (t (message "No link to open here")))))
  8031. (defun org-agenda-copy-local-variable (var)
  8032. "Get a variable from a referenced buffer and install it here."
  8033. (let ((m (org-get-at-bol 'org-marker)))
  8034. (when (and m (buffer-live-p (marker-buffer m)))
  8035. (org-set-local var (with-current-buffer (marker-buffer m)
  8036. (symbol-value var))))))
  8037. (defun org-agenda-switch-to (&optional delete-other-windows)
  8038. "Go to the Org mode file which contains the item at point.
  8039. When optional argument DELETE-OTHER-WINDOWS is non-nil, the
  8040. displayed Org file fills the frame."
  8041. (interactive)
  8042. (if (and org-return-follows-link
  8043. (not (org-get-at-bol 'org-marker))
  8044. (org-in-regexp org-bracket-link-regexp))
  8045. (org-open-link-from-string (match-string 0))
  8046. (let* ((marker (or (org-get-at-bol 'org-marker)
  8047. (org-agenda-error)))
  8048. (buffer (marker-buffer marker))
  8049. (pos (marker-position marker)))
  8050. (unless buffer (user-error "Trying to switch to non-existent buffer"))
  8051. (org-pop-to-buffer-same-window buffer)
  8052. (when delete-other-windows (delete-other-windows))
  8053. (widen)
  8054. (goto-char pos)
  8055. (when (derived-mode-p 'org-mode)
  8056. (org-show-context 'agenda)
  8057. (run-hooks 'org-agenda-after-show-hook)))))
  8058. (defun org-agenda-goto-mouse (ev)
  8059. "Go to the Org-mode file which contains the item at the mouse click."
  8060. (interactive "e")
  8061. (mouse-set-point ev)
  8062. (org-agenda-goto))
  8063. (defun org-agenda-show (&optional full-entry)
  8064. "Display the Org-mode file which contains the item at point.
  8065. With prefix argument FULL-ENTRY, make the entire entry visible
  8066. if it was hidden in the outline."
  8067. (interactive "P")
  8068. (let ((win (selected-window)))
  8069. (org-agenda-goto t)
  8070. (when full-entry (org-show-entry))
  8071. (select-window win)))
  8072. (defvar org-agenda-show-window nil)
  8073. (defun org-agenda-show-and-scroll-up (&optional arg)
  8074. "Display the Org-mode file which contains the item at point.
  8075. When called repeatedly, scroll the window that is displaying the buffer.
  8076. With a \\[universal-argument] prefix, use `org-show-entry' instead of
  8077. `show-subtree' to display the item, so that drawers and logbooks stay
  8078. folded."
  8079. (interactive "P")
  8080. (let ((win (selected-window)))
  8081. (if (and (window-live-p org-agenda-show-window)
  8082. (eq this-command last-command))
  8083. (progn
  8084. (select-window org-agenda-show-window)
  8085. (ignore-errors (scroll-up)))
  8086. (org-agenda-goto t)
  8087. (if arg (org-show-entry) (outline-show-subtree))
  8088. (setq org-agenda-show-window (selected-window)))
  8089. (select-window win)))
  8090. (defun org-agenda-show-scroll-down ()
  8091. "Scroll down the window showing the agenda."
  8092. (interactive)
  8093. (let ((win (selected-window)))
  8094. (when (window-live-p org-agenda-show-window)
  8095. (select-window org-agenda-show-window)
  8096. (ignore-errors (scroll-down))
  8097. (select-window win))))
  8098. (defun org-agenda-show-1 (&optional more)
  8099. "Display the Org-mode file which contains the item at point.
  8100. The prefix arg selects the amount of information to display:
  8101. 0 hide the subtree
  8102. 1 just show the entry according to defaults.
  8103. 2 show the children view
  8104. 3 show the subtree view
  8105. 4 show the entire subtree and any LOGBOOK drawers
  8106. 5 show the entire subtree and any drawers
  8107. With prefix argument FULL-ENTRY, make the entire entry visible
  8108. if it was hidden in the outline."
  8109. (interactive "p")
  8110. (let ((win (selected-window)))
  8111. (org-agenda-goto t)
  8112. (org-back-to-heading)
  8113. (set-window-start (selected-window) (point-at-bol))
  8114. (cond
  8115. ((= more 0)
  8116. (outline-hide-subtree)
  8117. (save-excursion
  8118. (org-back-to-heading)
  8119. (run-hook-with-args 'org-cycle-hook 'folded))
  8120. (message "Remote: FOLDED"))
  8121. ((and (org-called-interactively-p 'any) (= more 1))
  8122. (message "Remote: show with default settings"))
  8123. ((= more 2)
  8124. (outline-show-entry)
  8125. (outline-show-children)
  8126. (save-excursion
  8127. (org-back-to-heading)
  8128. (run-hook-with-args 'org-cycle-hook 'children))
  8129. (message "Remote: CHILDREN"))
  8130. ((= more 3)
  8131. (outline-show-subtree)
  8132. (save-excursion
  8133. (org-back-to-heading)
  8134. (run-hook-with-args 'org-cycle-hook 'subtree))
  8135. (message "Remote: SUBTREE"))
  8136. ((= more 4)
  8137. (outline-show-subtree)
  8138. (save-excursion
  8139. (org-back-to-heading)
  8140. (org-cycle-hide-drawers 'subtree '("LOGBOOK")))
  8141. (message "Remote: SUBTREE AND LOGBOOK"))
  8142. ((> more 4)
  8143. (outline-show-subtree)
  8144. (message "Remote: SUBTREE AND ALL DRAWERS")))
  8145. (select-window win)))
  8146. (defvar org-agenda-cycle-counter nil)
  8147. (defun org-agenda-cycle-show (&optional n)
  8148. "Show the current entry in another window, with default settings.
  8149. Default settings are taken from `org-show-context-detail'. When
  8150. use repeatedly in immediate succession, the remote entry will
  8151. cycle through visibility
  8152. children -> subtree -> folded
  8153. When called with a numeric prefix arg, that arg will be passed through to
  8154. `org-agenda-show-1'. For the interpretation of that argument, see the
  8155. docstring of `org-agenda-show-1'."
  8156. (interactive "P")
  8157. (if (integerp n)
  8158. (setq org-agenda-cycle-counter n)
  8159. (if (not (eq last-command this-command))
  8160. (setq org-agenda-cycle-counter 1)
  8161. (if (equal org-agenda-cycle-counter 0)
  8162. (setq org-agenda-cycle-counter 2)
  8163. (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
  8164. (if (> org-agenda-cycle-counter 3)
  8165. (setq org-agenda-cycle-counter 0)))))
  8166. (org-agenda-show-1 org-agenda-cycle-counter))
  8167. (defun org-agenda-recenter (arg)
  8168. "Display the Org-mode file which contains the item at point and recenter."
  8169. (interactive "P")
  8170. (let ((win (selected-window)))
  8171. (org-agenda-goto t)
  8172. (recenter arg)
  8173. (select-window win)))
  8174. (defun org-agenda-show-mouse (ev)
  8175. "Display the Org-mode file which contains the item at the mouse click."
  8176. (interactive "e")
  8177. (mouse-set-point ev)
  8178. (org-agenda-show))
  8179. (defun org-agenda-check-no-diary ()
  8180. "Check if the entry is a diary link and abort if yes."
  8181. (if (org-get-at-bol 'org-agenda-diary-link)
  8182. (org-agenda-error)))
  8183. (defun org-agenda-error ()
  8184. "Throw an error when a command is not allowed in the agenda."
  8185. (user-error "Command not allowed in this line"))
  8186. (defun org-agenda-tree-to-indirect-buffer (arg)
  8187. "Show the subtree corresponding to the current entry in an indirect buffer.
  8188. This calls the command `org-tree-to-indirect-buffer' from the original buffer.
  8189. With a numerical prefix ARG, go up to this level and then take that tree.
  8190. With a negative numeric ARG, go up by this number of levels.
  8191. With a \\[universal-argument] prefix, make a separate frame for this tree (i.e. don't
  8192. use the dedicated frame)."
  8193. (interactive "P")
  8194. (if current-prefix-arg
  8195. (org-agenda-do-tree-to-indirect-buffer arg)
  8196. (let ((agenda-buffer (buffer-name))
  8197. (agenda-window (selected-window))
  8198. (indirect-window
  8199. (and org-last-indirect-buffer
  8200. (get-buffer-window org-last-indirect-buffer))))
  8201. (save-window-excursion (org-agenda-do-tree-to-indirect-buffer arg))
  8202. (unless (or (eq org-indirect-buffer-display 'new-frame)
  8203. (eq org-indirect-buffer-display 'dedicated-frame))
  8204. (unwind-protect
  8205. (unless (and indirect-window (window-live-p indirect-window))
  8206. (setq indirect-window (split-window agenda-window)))
  8207. (and indirect-window (select-window indirect-window))
  8208. (switch-to-buffer org-last-indirect-buffer :norecord)
  8209. (fit-window-to-buffer indirect-window)))
  8210. (select-window (get-buffer-window agenda-buffer))
  8211. (setq org-agenda-last-indirect-buffer org-last-indirect-buffer))))
  8212. (defun org-agenda-do-tree-to-indirect-buffer (arg)
  8213. "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
  8214. (org-agenda-check-no-diary)
  8215. (let* ((marker (or (org-get-at-bol 'org-marker)
  8216. (org-agenda-error)))
  8217. (buffer (marker-buffer marker))
  8218. (pos (marker-position marker)))
  8219. (with-current-buffer buffer
  8220. (save-excursion
  8221. (goto-char pos)
  8222. (funcall 'org-tree-to-indirect-buffer arg)))))
  8223. (defvar org-last-heading-marker (make-marker)
  8224. "Marker pointing to the headline that last changed its TODO state
  8225. by a remote command from the agenda.")
  8226. (defun org-agenda-todo-nextset ()
  8227. "Switch TODO entry to next sequence."
  8228. (interactive)
  8229. (org-agenda-todo 'nextset))
  8230. (defun org-agenda-todo-previousset ()
  8231. "Switch TODO entry to previous sequence."
  8232. (interactive)
  8233. (org-agenda-todo 'previousset))
  8234. (defun org-agenda-todo (&optional arg)
  8235. "Cycle TODO state of line at point, also in Org-mode file.
  8236. This changes the line at point, all other lines in the agenda referring to
  8237. the same tree node, and the headline of the tree node in the Org-mode file."
  8238. (interactive "P")
  8239. (org-agenda-check-no-diary)
  8240. (let* ((col (current-column))
  8241. (marker (or (org-get-at-bol 'org-marker)
  8242. (org-agenda-error)))
  8243. (buffer (marker-buffer marker))
  8244. (pos (marker-position marker))
  8245. (hdmarker (org-get-at-bol 'org-hd-marker))
  8246. (todayp (org-agenda-todayp (org-get-at-bol 'day)))
  8247. (inhibit-read-only t)
  8248. org-agenda-headline-snapshot-before-repeat newhead just-one)
  8249. (org-with-remote-undo buffer
  8250. (with-current-buffer buffer
  8251. (widen)
  8252. (goto-char pos)
  8253. (org-show-context 'agenda)
  8254. (save-excursion
  8255. (and (outline-next-heading)
  8256. (org-flag-heading nil))) ; show the next heading
  8257. (let ((current-prefix-arg arg))
  8258. (call-interactively 'org-todo))
  8259. (and (bolp) (forward-char 1))
  8260. (setq newhead (org-get-heading))
  8261. (when (and (org-bound-and-true-p
  8262. org-agenda-headline-snapshot-before-repeat)
  8263. (not (equal org-agenda-headline-snapshot-before-repeat
  8264. newhead))
  8265. todayp)
  8266. (setq newhead org-agenda-headline-snapshot-before-repeat
  8267. just-one t))
  8268. (save-excursion
  8269. (org-back-to-heading)
  8270. (move-marker org-last-heading-marker (point))))
  8271. (beginning-of-line 1)
  8272. (save-window-excursion
  8273. (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
  8274. (when (org-bound-and-true-p org-clock-out-when-done)
  8275. (string-match (concat "^" (regexp-opt org-done-keywords-for-agenda))
  8276. newhead)
  8277. (org-agenda-unmark-clocking-task))
  8278. (org-move-to-column col)
  8279. (org-agenda-mark-clocking-task))))
  8280. (defun org-agenda-add-note (&optional arg)
  8281. "Add a time-stamped note to the entry at point."
  8282. (interactive "P")
  8283. (org-agenda-check-no-diary)
  8284. (let* ((marker (or (org-get-at-bol 'org-marker)
  8285. (org-agenda-error)))
  8286. (buffer (marker-buffer marker))
  8287. (pos (marker-position marker))
  8288. (hdmarker (org-get-at-bol 'org-hd-marker))
  8289. (inhibit-read-only t))
  8290. (with-current-buffer buffer
  8291. (widen)
  8292. (goto-char pos)
  8293. (org-show-context 'agenda)
  8294. (save-excursion
  8295. (and (outline-next-heading)
  8296. (org-flag-heading nil))) ; show the next heading
  8297. (org-add-note))))
  8298. (defun org-agenda-change-all-lines (newhead hdmarker
  8299. &optional fixface just-this)
  8300. "Change all lines in the agenda buffer which match HDMARKER.
  8301. The new content of the line will be NEWHEAD (as modified by
  8302. `org-agenda-format-item'). HDMARKER is checked with
  8303. `equal' against all `org-hd-marker' text properties in the file.
  8304. If FIXFACE is non-nil, the face of each item is modified according to
  8305. the new TODO state.
  8306. If JUST-THIS is non-nil, change just the current line, not all.
  8307. If FORCE-TAGS is non nil, the car of it returns the new tags."
  8308. (let* ((inhibit-read-only t)
  8309. (line (org-current-line))
  8310. (org-agenda-buffer (current-buffer))
  8311. (thetags (with-current-buffer (marker-buffer hdmarker)
  8312. (save-excursion (save-restriction (widen)
  8313. (goto-char hdmarker)
  8314. (org-get-tags-at)))))
  8315. props m pl undone-face done-face finish new dotime level cat tags)
  8316. (save-excursion
  8317. (goto-char (point-max))
  8318. (beginning-of-line 1)
  8319. (while (not finish)
  8320. (setq finish (bobp))
  8321. (when (and (setq m (org-get-at-bol 'org-hd-marker))
  8322. (or (not just-this) (= (org-current-line) line))
  8323. (equal m hdmarker))
  8324. (setq props (text-properties-at (point))
  8325. dotime (org-get-at-bol 'dotime)
  8326. cat (org-get-at-eol 'org-category 1)
  8327. level (org-get-at-bol 'level)
  8328. tags thetags
  8329. new
  8330. (let ((org-prefix-format-compiled
  8331. (or (get-text-property (min (1- (point-max)) (point)) 'format)
  8332. org-prefix-format-compiled))
  8333. (extra (org-get-at-bol 'extra)))
  8334. (with-current-buffer (marker-buffer hdmarker)
  8335. (save-excursion
  8336. (save-restriction
  8337. (widen)
  8338. (org-agenda-format-item extra newhead level cat tags dotime)))))
  8339. pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
  8340. undone-face (org-get-at-bol 'undone-face)
  8341. done-face (org-get-at-bol 'done-face))
  8342. (beginning-of-line 1)
  8343. (cond
  8344. ((equal new "") (delete-region (point) (line-beginning-position 2)))
  8345. ((looking-at ".*")
  8346. ;; When replacing the whole line, preserve bulk mark
  8347. ;; overlay, if any.
  8348. (let ((mark (catch :overlay
  8349. (dolist (o (overlays-in (point) (+ 2 (point))))
  8350. (when (eq (overlay-get o 'type)
  8351. 'org-marked-entry-overlay)
  8352. (throw :overlay o))))))
  8353. (replace-match new t t)
  8354. (beginning-of-line)
  8355. (when mark (move-overlay mark (point) (+ 2 (point)))))
  8356. (add-text-properties (point-at-bol) (point-at-eol) props)
  8357. (when fixface
  8358. (add-text-properties
  8359. (point-at-bol) (point-at-eol)
  8360. (list 'face
  8361. (if org-last-todo-state-is-todo
  8362. undone-face done-face))))
  8363. (org-agenda-highlight-todo 'line)
  8364. (beginning-of-line 1))
  8365. (t (error "Line update did not work")))
  8366. (save-restriction
  8367. (narrow-to-region (point-at-bol) (point-at-eol))
  8368. (org-agenda-finalize)))
  8369. (beginning-of-line 0)))))
  8370. (defun org-agenda-align-tags (&optional line)
  8371. "Align all tags in agenda items to `org-agenda-tags-column'."
  8372. (let ((inhibit-read-only t) l c)
  8373. (save-excursion
  8374. (goto-char (if line (point-at-bol) (point-min)))
  8375. (while (re-search-forward (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
  8376. (if line (point-at-eol) nil) t)
  8377. (add-text-properties
  8378. (match-beginning 2) (match-end 2)
  8379. (list 'face (delq nil (let ((prop (get-text-property
  8380. (match-beginning 2) 'face)))
  8381. (or (listp prop) (setq prop (list prop)))
  8382. (if (memq 'org-tag prop)
  8383. prop
  8384. (cons 'org-tag prop))))))
  8385. (setq l (- (match-end 2) (match-beginning 2))
  8386. c (if (< org-agenda-tags-column 0)
  8387. (- (abs org-agenda-tags-column) l)
  8388. org-agenda-tags-column))
  8389. (delete-region (match-beginning 1) (match-end 1))
  8390. (goto-char (match-beginning 1))
  8391. (insert (org-add-props
  8392. (make-string (max 1 (- c (current-column))) ?\ )
  8393. (plist-put (copy-sequence (text-properties-at (point)))
  8394. 'face nil))))
  8395. (goto-char (point-min))
  8396. (org-font-lock-add-tag-faces (point-max)))))
  8397. (defun org-agenda-priority-up ()
  8398. "Increase the priority of line at point, also in Org-mode file."
  8399. (interactive)
  8400. (org-agenda-priority 'up))
  8401. (defun org-agenda-priority-down ()
  8402. "Decrease the priority of line at point, also in Org-mode file."
  8403. (interactive)
  8404. (org-agenda-priority 'down))
  8405. (defun org-agenda-priority (&optional force-direction)
  8406. "Set the priority of line at point, also in Org-mode file.
  8407. This changes the line at point, all other lines in the agenda referring to
  8408. the same tree node, and the headline of the tree node in the Org-mode file.
  8409. Called with a universal prefix arg, show the priority instead of setting it."
  8410. (interactive "P")
  8411. (if (equal force-direction '(4))
  8412. (org-show-priority)
  8413. (unless org-enable-priority-commands
  8414. (error "Priority commands are disabled"))
  8415. (org-agenda-check-no-diary)
  8416. (let* ((col (current-column))
  8417. (marker (or (org-get-at-bol 'org-marker)
  8418. (org-agenda-error)))
  8419. (hdmarker (org-get-at-bol 'org-hd-marker))
  8420. (buffer (marker-buffer hdmarker))
  8421. (pos (marker-position hdmarker))
  8422. (inhibit-read-only t)
  8423. newhead)
  8424. (org-with-remote-undo buffer
  8425. (with-current-buffer buffer
  8426. (widen)
  8427. (goto-char pos)
  8428. (org-show-context 'agenda)
  8429. (save-excursion
  8430. (and (outline-next-heading)
  8431. (org-flag-heading nil))) ; show the next heading
  8432. (funcall 'org-priority force-direction)
  8433. (end-of-line 1)
  8434. (setq newhead (org-get-heading)))
  8435. (org-agenda-change-all-lines newhead hdmarker)
  8436. (org-move-to-column col)))))
  8437. ;; FIXME: should fix the tags property of the agenda line.
  8438. (defun org-agenda-set-tags (&optional tag onoff)
  8439. "Set tags for the current headline."
  8440. (interactive)
  8441. (org-agenda-check-no-diary)
  8442. (if (and (org-region-active-p) (org-called-interactively-p 'any))
  8443. (call-interactively 'org-change-tag-in-region)
  8444. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8445. (org-agenda-error)))
  8446. (buffer (marker-buffer hdmarker))
  8447. (pos (marker-position hdmarker))
  8448. (inhibit-read-only t)
  8449. newhead)
  8450. (org-with-remote-undo buffer
  8451. (with-current-buffer buffer
  8452. (widen)
  8453. (goto-char pos)
  8454. (save-excursion
  8455. (org-show-context 'agenda))
  8456. (save-excursion
  8457. (and (outline-next-heading)
  8458. (org-flag-heading nil))) ; show the next heading
  8459. (goto-char pos)
  8460. (if tag
  8461. (org-toggle-tag tag onoff)
  8462. (call-interactively 'org-set-tags))
  8463. (end-of-line 1)
  8464. (setq newhead (org-get-heading)))
  8465. (org-agenda-change-all-lines newhead hdmarker)
  8466. (beginning-of-line 1)))))
  8467. (defun org-agenda-set-property ()
  8468. "Set a property for the current headline."
  8469. (interactive)
  8470. (org-agenda-check-no-diary)
  8471. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8472. (org-agenda-error)))
  8473. (buffer (marker-buffer hdmarker))
  8474. (pos (marker-position hdmarker))
  8475. (inhibit-read-only t)
  8476. newhead)
  8477. (org-with-remote-undo buffer
  8478. (with-current-buffer buffer
  8479. (widen)
  8480. (goto-char pos)
  8481. (save-excursion
  8482. (org-show-context 'agenda))
  8483. (save-excursion
  8484. (and (outline-next-heading)
  8485. (org-flag-heading nil))) ; show the next heading
  8486. (goto-char pos)
  8487. (call-interactively 'org-set-property)))))
  8488. (defun org-agenda-set-effort ()
  8489. "Set the effort property for the current headline."
  8490. (interactive)
  8491. (org-agenda-check-no-diary)
  8492. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8493. (org-agenda-error)))
  8494. (buffer (marker-buffer hdmarker))
  8495. (pos (marker-position hdmarker))
  8496. (inhibit-read-only t)
  8497. newhead)
  8498. (org-with-remote-undo buffer
  8499. (with-current-buffer buffer
  8500. (widen)
  8501. (goto-char pos)
  8502. (save-excursion
  8503. (org-show-context 'agenda))
  8504. (save-excursion
  8505. (and (outline-next-heading)
  8506. (org-flag-heading nil))) ; show the next heading
  8507. (goto-char pos)
  8508. (call-interactively 'org-set-effort)
  8509. (end-of-line 1)
  8510. (setq newhead (org-get-heading)))
  8511. (org-agenda-change-all-lines newhead hdmarker))))
  8512. (defun org-agenda-toggle-archive-tag ()
  8513. "Toggle the archive tag for the current entry."
  8514. (interactive)
  8515. (org-agenda-check-no-diary)
  8516. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8517. (org-agenda-error)))
  8518. (buffer (marker-buffer hdmarker))
  8519. (pos (marker-position hdmarker))
  8520. (inhibit-read-only t)
  8521. newhead)
  8522. (org-with-remote-undo buffer
  8523. (with-current-buffer buffer
  8524. (widen)
  8525. (goto-char pos)
  8526. (org-show-context 'agenda)
  8527. (save-excursion
  8528. (and (outline-next-heading)
  8529. (org-flag-heading nil))) ; show the next heading
  8530. (call-interactively 'org-toggle-archive-tag)
  8531. (end-of-line 1)
  8532. (setq newhead (org-get-heading)))
  8533. (org-agenda-change-all-lines newhead hdmarker)
  8534. (beginning-of-line 1))))
  8535. (defun org-agenda-do-date-later (arg)
  8536. (interactive "P")
  8537. (cond
  8538. ((or (equal arg '(16))
  8539. (memq last-command
  8540. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  8541. (setq this-command 'org-agenda-date-later-minutes)
  8542. (org-agenda-date-later-minutes 1))
  8543. ((or (equal arg '(4))
  8544. (memq last-command
  8545. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  8546. (setq this-command 'org-agenda-date-later-hours)
  8547. (org-agenda-date-later-hours 1))
  8548. (t
  8549. (org-agenda-date-later (prefix-numeric-value arg)))))
  8550. (defun org-agenda-do-date-earlier (arg)
  8551. (interactive "P")
  8552. (cond
  8553. ((or (equal arg '(16))
  8554. (memq last-command
  8555. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  8556. (setq this-command 'org-agenda-date-earlier-minutes)
  8557. (org-agenda-date-earlier-minutes 1))
  8558. ((or (equal arg '(4))
  8559. (memq last-command
  8560. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  8561. (setq this-command 'org-agenda-date-earlier-hours)
  8562. (org-agenda-date-earlier-hours 1))
  8563. (t
  8564. (org-agenda-date-earlier (prefix-numeric-value arg)))))
  8565. (defun org-agenda-date-later (arg &optional what)
  8566. "Change the date of this item to ARG day(s) later."
  8567. (interactive "p")
  8568. (org-agenda-check-type t 'agenda 'timeline)
  8569. (org-agenda-check-no-diary)
  8570. (let* ((marker (or (org-get-at-bol 'org-marker)
  8571. (org-agenda-error)))
  8572. (buffer (marker-buffer marker))
  8573. (pos (marker-position marker))
  8574. cdate today)
  8575. (org-with-remote-undo buffer
  8576. (with-current-buffer buffer
  8577. (widen)
  8578. (goto-char pos)
  8579. (if (not (org-at-timestamp-p))
  8580. (error "Cannot find time stamp"))
  8581. (when (and org-agenda-move-date-from-past-immediately-to-today
  8582. (equal arg 1)
  8583. (or (not what) (eq what 'day))
  8584. (not (save-match-data (org-at-date-range-p))))
  8585. (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
  8586. cdate (calendar-absolute-from-gregorian
  8587. (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
  8588. today (org-today))
  8589. (if (> today cdate)
  8590. ;; immediately shift to today
  8591. (setq arg (- today cdate))))
  8592. (org-timestamp-change arg (or what 'day))
  8593. (when (and (org-at-date-range-p)
  8594. (re-search-backward org-tr-regexp-both (point-at-bol)))
  8595. (let ((end org-last-changed-timestamp))
  8596. (org-timestamp-change arg (or what 'day))
  8597. (setq org-last-changed-timestamp
  8598. (concat org-last-changed-timestamp "--" end)))))
  8599. (org-agenda-show-new-time marker org-last-changed-timestamp))
  8600. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  8601. (defun org-agenda-date-earlier (arg &optional what)
  8602. "Change the date of this item to ARG day(s) earlier."
  8603. (interactive "p")
  8604. (org-agenda-date-later (- arg) what))
  8605. (defun org-agenda-date-later-minutes (arg)
  8606. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  8607. (interactive "p")
  8608. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  8609. (org-agenda-date-later arg 'minute))
  8610. (defun org-agenda-date-earlier-minutes (arg)
  8611. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  8612. (interactive "p")
  8613. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  8614. (org-agenda-date-earlier arg 'minute))
  8615. (defun org-agenda-date-later-hours (arg)
  8616. "Change the time of this item, in hour steps."
  8617. <