org-agenda.el 396 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289
  1. ;;; org-agenda.el --- Dynamic task and appointment lists for Org
  2. ;; Copyright (C) 2004-2019 Free Software Foundation, Inc.
  3. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; Homepage: https://orgmode.org
  6. ;;
  7. ;; This file is part of GNU Emacs.
  8. ;;
  9. ;; GNU Emacs is free software: you can redistribute it and/or modify
  10. ;; it under the terms of the GNU General Public License as published by
  11. ;; the Free Software Foundation, either version 3 of the License, or
  12. ;; (at your option) any later version.
  13. ;; GNU Emacs is distributed in the hope that it will be useful,
  14. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. ;; GNU General Public License for more details.
  17. ;; You should have received a copy of the GNU General Public License
  18. ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
  19. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  20. ;;
  21. ;;; Commentary:
  22. ;; This file contains the code for creating and using the Agenda for Org.
  23. ;;
  24. ;; The functions `org-batch-agenda', `org-batch-agenda-csv', and
  25. ;; `org-batch-store-agenda-views' are implemented as macros to provide
  26. ;; a convenient way for extracting agenda information from the command
  27. ;; line. The Lisp does not evaluate parameters of a macro call; thus
  28. ;; it is not necessary to quote the parameters passed to one of those
  29. ;; functions. E.g. you can write:
  30. ;;
  31. ;; emacs -batch -l ~/.emacs -eval '(org-batch-agenda "a" org-agenda-span 7)'
  32. ;;
  33. ;; To export an agenda spanning 7 days. If `org-batch-agenda' would
  34. ;; have been implemented as a regular function you'd have to quote the
  35. ;; symbol org-agenda-span. Moreover: To use a symbol as parameter
  36. ;; value you would have to double quote the symbol.
  37. ;;
  38. ;; This is a hack, but it works even when running Org byte-compiled.
  39. ;;
  40. ;;; Code:
  41. (require 'cl-lib)
  42. (require 'org)
  43. (require 'org-macs)
  44. (declare-function diary-add-to-list "diary-lib"
  45. (date string specifier &optional marker globcolor literal))
  46. (declare-function calendar-iso-to-absolute "cal-iso" (date))
  47. (declare-function calendar-astro-date-string "cal-julian" (&optional date))
  48. (declare-function calendar-bahai-date-string "cal-bahai" (&optional date))
  49. (declare-function calendar-chinese-date-string "cal-china" (&optional date))
  50. (declare-function calendar-coptic-date-string "cal-coptic" (&optional date))
  51. (declare-function calendar-ethiopic-date-string "cal-coptic" (&optional date))
  52. (declare-function calendar-french-date-string "cal-french" (&optional date))
  53. (declare-function calendar-goto-date "cal-move" (date))
  54. (declare-function calendar-hebrew-date-string "cal-hebrew" (&optional date))
  55. (declare-function calendar-islamic-date-string "cal-islam" (&optional date))
  56. (declare-function calendar-iso-date-string "cal-iso" (&optional date))
  57. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  58. (declare-function calendar-julian-date-string "cal-julian" (&optional date))
  59. (declare-function calendar-mayan-date-string "cal-mayan" (&optional date))
  60. (declare-function calendar-persian-date-string "cal-persia" (&optional date))
  61. (declare-function calendar-check-holidays "holidays" (date))
  62. (declare-function org-columns-remove-overlays "org-colview" ())
  63. (declare-function org-datetree-find-date-create "org-datetree"
  64. (date &optional keep-restriction))
  65. (declare-function org-columns-quit "org-colview" ())
  66. (declare-function diary-date-display-form "diary-lib" (&optional type))
  67. (declare-function org-mobile-write-agenda-for-mobile "org-mobile" (file))
  68. (declare-function org-habit-insert-consistency-graphs
  69. "org-habit" (&optional line))
  70. (declare-function org-is-habit-p "org-habit" (&optional pom))
  71. (declare-function org-habit-parse-todo "org-habit" (&optional pom))
  72. (declare-function org-habit-get-priority "org-habit" (habit &optional moment))
  73. (declare-function org-agenda-columns "org-colview" ())
  74. (declare-function org-add-archive-files "org-archive" (files))
  75. (declare-function org-capture "org-capture" (&optional goto keys))
  76. (defvar calendar-mode-map)
  77. (defvar org-clock-current-task)
  78. (defvar org-current-tag-alist)
  79. (defvar org-mobile-force-id-on-agenda-items)
  80. (defvar org-habit-show-habits)
  81. (defvar org-habit-show-habits-only-for-today)
  82. (defvar org-habit-show-all-today)
  83. (defvar org-habit-scheduled-past-days)
  84. ;; Defined somewhere in this file, but used before definition.
  85. (defvar org-agenda-buffer-name "*Org Agenda*")
  86. (defvar org-agenda-overriding-header nil)
  87. (defvar org-agenda-title-append nil)
  88. (with-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  89. (with-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  90. (defvar original-date) ; dynamically scoped, calendar.el does scope this
  91. (defvar org-agenda-undo-list nil
  92. "List of undoable operations in the agenda since last refresh.")
  93. (defvar org-agenda-pending-undo-list nil
  94. "In a series of undo commands, this is the list of remaining undo items.")
  95. (defcustom org-agenda-confirm-kill 1
  96. "When set, remote killing from the agenda buffer needs confirmation.
  97. When t, a confirmation is always needed. When a number N, confirmation is
  98. only needed when the text to be killed contains more than N non-white lines."
  99. :group 'org-agenda
  100. :type '(choice
  101. (const :tag "Never" nil)
  102. (const :tag "Always" t)
  103. (integer :tag "When more than N lines")))
  104. (defcustom org-agenda-compact-blocks nil
  105. "Non-nil means make the block agenda more compact.
  106. This is done globally by leaving out lines like the agenda span
  107. name and week number or the separator lines."
  108. :group 'org-agenda
  109. :type 'boolean)
  110. (defcustom org-agenda-block-separator ?=
  111. "The separator between blocks in the agenda.
  112. If this is a string, it will be used as the separator, with a newline added.
  113. If it is a character, it will be repeated to fill the window width.
  114. If nil the separator is disabled. In `org-agenda-custom-commands' this
  115. addresses the separator between the current and the previous block."
  116. :group 'org-agenda
  117. :type '(choice
  118. (const :tag "Disabled" nil)
  119. (character)
  120. (string)))
  121. (defgroup org-agenda-export nil
  122. "Options concerning exporting agenda views in Org mode."
  123. :tag "Org Agenda Export"
  124. :group 'org-agenda)
  125. (defcustom org-agenda-with-colors t
  126. "Non-nil means use colors in agenda views."
  127. :group 'org-agenda-export
  128. :type 'boolean)
  129. (defcustom org-agenda-exporter-settings nil
  130. "Alist of variable/value pairs that should be active during agenda export.
  131. This is a good place to set options for ps-print and for htmlize.
  132. Note that the way this is implemented, the values will be evaluated
  133. before assigned to the variables. So make sure to quote values you do
  134. *not* want evaluated, for example
  135. (setq org-agenda-exporter-settings
  136. \\='((ps-print-color-p \\='black-white)))"
  137. :group 'org-agenda-export
  138. :type '(repeat
  139. (list
  140. (variable)
  141. (sexp :tag "Value"))))
  142. (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
  143. "Hook run in a temporary buffer before writing the agenda to an export file.
  144. A useful function for this hook is `org-agenda-add-entry-text'."
  145. :group 'org-agenda-export
  146. :type 'hook
  147. :options '(org-agenda-add-entry-text))
  148. (defcustom org-agenda-add-entry-text-maxlines 0
  149. "Maximum number of entry text lines to be added to agenda.
  150. This is only relevant when `org-agenda-add-entry-text' is part of
  151. `org-agenda-before-write-hook', which is the default.
  152. When this is 0, nothing will happen. When it is greater than 0, it
  153. specifies the maximum number of lines that will be added for each entry
  154. that is listed in the agenda view.
  155. Note that this variable is not used during display, only when exporting
  156. the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
  157. and `org-agenda-entry-text-maxlines'."
  158. :group 'org-agenda
  159. :type 'integer)
  160. (defcustom org-agenda-add-entry-text-descriptive-links t
  161. "Non-nil means export org-links as descriptive links in agenda added text.
  162. This variable applies to the text added to the agenda when
  163. `org-agenda-add-entry-text-maxlines' is larger than 0.
  164. When this variable nil, the URL will (also) be shown."
  165. :group 'org-agenda
  166. :type 'boolean)
  167. (defcustom org-agenda-export-html-style nil
  168. "The style specification for exported HTML Agenda files.
  169. If this variable contains a string, it will replace the default <style>
  170. section as produced by `htmlize'.
  171. Since there are different ways of setting style information, this variable
  172. needs to contain the full HTML structure to provide a style, including the
  173. surrounding HTML tags. The style specifications should include definitions
  174. the fonts used by the agenda, here is an example:
  175. <style type=\"text/css\">
  176. p { font-weight: normal; color: gray; }
  177. .org-agenda-structure {
  178. font-size: 110%;
  179. color: #003399;
  180. font-weight: 600;
  181. }
  182. .org-todo {
  183. color: #cc6666;
  184. font-weight: bold;
  185. }
  186. .org-agenda-done {
  187. color: #339933;
  188. }
  189. .org-done {
  190. color: #339933;
  191. }
  192. .title { text-align: center; }
  193. .todo, .deadline { color: red; }
  194. .done { color: green; }
  195. </style>
  196. or, if you want to keep the style in a file,
  197. <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
  198. As the value of this option simply gets inserted into the HTML <head> header,
  199. you can \"misuse\" it to also add other text to the header."
  200. :group 'org-agenda-export
  201. :group 'org-export-html
  202. :type '(choice
  203. (const nil)
  204. (string)))
  205. (defcustom org-agenda-persistent-filter nil
  206. "When set, keep filters from one agenda view to the next."
  207. :group 'org-agenda
  208. :type 'boolean)
  209. (defgroup org-agenda-custom-commands nil
  210. "Options concerning agenda views in Org mode."
  211. :tag "Org Agenda Custom Commands"
  212. :group 'org-agenda)
  213. (defconst org-sorting-choice
  214. '(choice
  215. (const time-up) (const time-down)
  216. (const timestamp-up) (const timestamp-down)
  217. (const scheduled-up) (const scheduled-down)
  218. (const deadline-up) (const deadline-down)
  219. (const ts-up) (const ts-down)
  220. (const tsia-up) (const tsia-down)
  221. (const category-keep) (const category-up) (const category-down)
  222. (const tag-down) (const tag-up)
  223. (const priority-up) (const priority-down)
  224. (const todo-state-up) (const todo-state-down)
  225. (const effort-up) (const effort-down)
  226. (const habit-up) (const habit-down)
  227. (const alpha-up) (const alpha-down)
  228. (const user-defined-up) (const user-defined-down))
  229. "Sorting choices.")
  230. ;; Keep custom values for `org-agenda-filter-preset' compatible with
  231. ;; the new variable `org-agenda-tag-filter-preset'.
  232. (defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
  233. (defvaralias 'org-agenda-filter 'org-agenda-tag-filter)
  234. (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
  235. "List of types searched for when creating the daily/weekly agenda.
  236. This variable is a list of symbols that controls the types of
  237. items that appear in the daily/weekly agenda. Allowed symbols in this
  238. list are are
  239. :timestamp List items containing a date stamp or date range matching
  240. the selected date. This includes sexp entries in angular
  241. brackets.
  242. :sexp List entries resulting from plain diary-like sexps.
  243. :deadline List deadline due on that date. When the date is today,
  244. also list any deadlines past due, or due within
  245. `org-deadline-warning-days'.
  246. :deadline* Same as above, but only include the deadline if it has an
  247. hour specification as [h]h:mm.
  248. :scheduled List all items which are scheduled for the given date.
  249. The diary for *today* also contains items which were
  250. scheduled earlier and are not yet marked DONE.
  251. :scheduled* Same as above, but only include the scheduled item if it
  252. has an hour specification as [h]h:mm.
  253. By default, all four non-starred types are turned on.
  254. When :scheduled* or :deadline* are included, :schedule or :deadline
  255. will be ignored.
  256. Never set this variable globally using `setq', because then it
  257. will apply to all future agenda commands. Instead, bind it with
  258. `let' to scope it dynamically into the agenda-constructing
  259. command. A good way to set it is through options in
  260. `org-agenda-custom-commands'. For a more flexible (though
  261. somewhat less efficient) way of determining what is included in
  262. the daily/weekly agenda, see `org-agenda-skip-function'.")
  263. (defconst org-agenda-custom-commands-local-options
  264. `(repeat :tag "Local settings for this command. Remember to quote values"
  265. (choice :tag "Setting"
  266. (list :tag "Heading for this block"
  267. (const org-agenda-overriding-header)
  268. (string :tag "Headline"))
  269. (list :tag "Files to be searched"
  270. (const org-agenda-files)
  271. (list
  272. (const :format "" quote)
  273. (repeat (file))))
  274. (list :tag "Sorting strategy"
  275. (const org-agenda-sorting-strategy)
  276. (list
  277. (const :format "" quote)
  278. (repeat
  279. ,org-sorting-choice)))
  280. (list :tag "Prefix format"
  281. (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
  282. (string))
  283. (list :tag "Number of days in agenda"
  284. (const org-agenda-span)
  285. (list
  286. (const :format "" quote)
  287. (choice (const :tag "Day" day)
  288. (const :tag "Week" week)
  289. (const :tag "Fortnight" fortnight)
  290. (const :tag "Month" month)
  291. (const :tag "Year" year)
  292. (integer :tag "Custom"))))
  293. (list :tag "Fixed starting date"
  294. (const org-agenda-start-day)
  295. (string :value "2007-11-01"))
  296. (list :tag "Start on day of week"
  297. (const org-agenda-start-on-weekday)
  298. (choice :value 1
  299. (const :tag "Today" nil)
  300. (integer :tag "Weekday No.")))
  301. (list :tag "Include data from diary"
  302. (const org-agenda-include-diary)
  303. (boolean))
  304. (list :tag "Deadline Warning days"
  305. (const org-deadline-warning-days)
  306. (integer :value 1))
  307. (list :tag "Category filter preset"
  308. (const org-agenda-category-filter-preset)
  309. (list
  310. (const :format "" quote)
  311. (repeat
  312. (string :tag "+category or -category"))))
  313. (list :tag "Tags filter preset"
  314. (const org-agenda-tag-filter-preset)
  315. (list
  316. (const :format "" quote)
  317. (repeat
  318. (string :tag "+tag or -tag"))))
  319. (list :tag "Effort filter preset"
  320. (const org-agenda-effort-filter-preset)
  321. (list
  322. (const :format "" quote)
  323. (repeat
  324. (string :tag "+=10 or -=10 or +<10 or ->10"))))
  325. (list :tag "Regexp filter preset"
  326. (const org-agenda-regexp-filter-preset)
  327. (list
  328. (const :format "" quote)
  329. (repeat
  330. (string :tag "+regexp or -regexp"))))
  331. (list :tag "Set daily/weekly entry types"
  332. (const org-agenda-entry-types)
  333. (list
  334. (const :format "" quote)
  335. (set :greedy t :value ,org-agenda-entry-types
  336. (const :deadline)
  337. (const :scheduled)
  338. (const :deadline*)
  339. (const :scheduled*)
  340. (const :timestamp)
  341. (const :sexp))))
  342. (list :tag "Standard skipping condition"
  343. :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
  344. (const org-agenda-skip-function)
  345. (list
  346. (const :format "" quote)
  347. (list
  348. (choice
  349. :tag "Skipping range"
  350. (const :tag "Skip entry" org-agenda-skip-entry-if)
  351. (const :tag "Skip subtree" org-agenda-skip-subtree-if))
  352. (repeat :inline t :tag "Conditions for skipping"
  353. (choice
  354. :tag "Condition type"
  355. (list :tag "Regexp matches" :inline t
  356. (const :format "" regexp)
  357. (regexp))
  358. (list :tag "Regexp does not match" :inline t
  359. (const :format "" notregexp)
  360. (regexp))
  361. (list :tag "TODO state is" :inline t
  362. (const todo)
  363. (choice
  364. (const :tag "Any not-done state" todo)
  365. (const :tag "Any done state" done)
  366. (const :tag "Any state" any)
  367. (list :tag "Keyword list"
  368. (const :format "" quote)
  369. (repeat (string :tag "Keyword")))))
  370. (list :tag "TODO state is not" :inline t
  371. (const nottodo)
  372. (choice
  373. (const :tag "Any not-done state" todo)
  374. (const :tag "Any done state" done)
  375. (const :tag "Any state" any)
  376. (list :tag "Keyword list"
  377. (const :format "" quote)
  378. (repeat (string :tag "Keyword")))))
  379. (const :tag "scheduled" scheduled)
  380. (const :tag "not scheduled" notscheduled)
  381. (const :tag "deadline" deadline)
  382. (const :tag "no deadline" notdeadline)
  383. (const :tag "timestamp" timestamp)
  384. (const :tag "no timestamp" nottimestamp))))))
  385. (list :tag "Non-standard skipping condition"
  386. :value (org-agenda-skip-function)
  387. (const org-agenda-skip-function)
  388. (sexp :tag "Function or form (quoted!)"))
  389. (list :tag "Any variable"
  390. (variable :tag "Variable")
  391. (sexp :tag "Value (sexp)"))))
  392. "Selection of examples for agenda command settings.
  393. This will be spliced into the custom type of
  394. `org-agenda-custom-commands'.")
  395. (defcustom org-agenda-custom-commands
  396. '(("n" "Agenda and all TODOs" ((agenda "") (alltodo ""))))
  397. "Custom commands for the agenda.
  398. \\<org-mode-map>
  399. These commands will be offered on the splash screen displayed by the
  400. agenda dispatcher `\\[org-agenda]'. Each entry is a list like this:
  401. (key desc type match settings files)
  402. key The key (one or more characters as a string) to be associated
  403. with the command.
  404. desc A description of the command, when omitted or nil, a default
  405. description is built using MATCH.
  406. type The command type, any of the following symbols:
  407. agenda The daily/weekly agenda.
  408. todo Entries with a specific TODO keyword, in all agenda files.
  409. search Entries containing search words entry or headline.
  410. tags Tags/Property/TODO match in all agenda files.
  411. tags-todo Tags/P/T match in all agenda files, TODO entries only.
  412. todo-tree Sparse tree of specific TODO keyword in *current* file.
  413. tags-tree Sparse tree with all tags matches in *current* file.
  414. occur-tree Occur sparse tree for *current* file.
  415. ... A user-defined function.
  416. match What to search for:
  417. - a single keyword for TODO keyword searches
  418. - a tags match expression for tags searches
  419. - a word search expression for text searches.
  420. - a regular expression for occur searches
  421. For all other commands, this should be the empty string.
  422. settings A list of option settings, similar to that in a let form, so like
  423. this: ((opt1 val1) (opt2 val2) ...). The values will be
  424. evaluated at the moment of execution, so quote them when needed.
  425. files A list of files to write the produced agenda buffer to with
  426. the command `org-store-agenda-views'.
  427. If a file name ends in \".html\", an HTML version of the buffer
  428. is written out. If it ends in \".ps\", a postscript version is
  429. produced. Otherwise, only the plain text is written to the file.
  430. You can also define a set of commands, to create a composite agenda buffer.
  431. In this case, an entry looks like this:
  432. (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
  433. where
  434. desc A description string to be displayed in the dispatcher menu.
  435. cmd An agenda command, similar to the above. However, tree commands
  436. are not allowed, but instead you can get agenda and global todo list.
  437. So valid commands for a set are:
  438. (agenda \"\" settings)
  439. (alltodo \"\" settings)
  440. (stuck \"\" settings)
  441. (todo \"match\" settings files)
  442. (search \"match\" settings files)
  443. (tags \"match\" settings files)
  444. (tags-todo \"match\" settings files)
  445. Each command can carry a list of options, and another set of options can be
  446. given for the whole set of commands. Individual command options take
  447. precedence over the general options.
  448. When using several characters as key to a command, the first characters
  449. are prefix commands. For the dispatcher to display useful information, you
  450. should provide a description for the prefix, like
  451. (setq org-agenda-custom-commands
  452. \\='((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
  453. (\"hl\" tags \"+HOME+Lisa\")
  454. (\"hp\" tags \"+HOME+Peter\")
  455. (\"hk\" tags \"+HOME+Kim\")))"
  456. :group 'org-agenda-custom-commands
  457. :type `(repeat
  458. (choice :value ("x" "Describe command here" tags "" nil)
  459. (list :tag "Single command"
  460. (string :tag "Access Key(s) ")
  461. (option (string :tag "Description"))
  462. (choice
  463. (const :tag "Agenda" agenda)
  464. (const :tag "TODO list" alltodo)
  465. (const :tag "Search words" search)
  466. (const :tag "Stuck projects" stuck)
  467. (const :tag "Tags/Property match (all agenda files)" tags)
  468. (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
  469. (const :tag "TODO keyword search (all agenda files)" todo)
  470. (const :tag "Tags sparse tree (current buffer)" tags-tree)
  471. (const :tag "TODO keyword tree (current buffer)" todo-tree)
  472. (const :tag "Occur tree (current buffer)" occur-tree)
  473. (sexp :tag "Other, user-defined function"))
  474. (string :tag "Match (only for some commands)")
  475. ,org-agenda-custom-commands-local-options
  476. (option (repeat :tag "Export" (file :tag "Export to"))))
  477. (list :tag "Command series, all agenda files"
  478. (string :tag "Access Key(s)")
  479. (string :tag "Description ")
  480. (repeat :tag "Component"
  481. (choice
  482. (list :tag "Agenda"
  483. (const :format "" agenda)
  484. (const :tag "" :format "" "")
  485. ,org-agenda-custom-commands-local-options)
  486. (list :tag "TODO list (all keywords)"
  487. (const :format "" alltodo)
  488. (const :tag "" :format "" "")
  489. ,org-agenda-custom-commands-local-options)
  490. (list :tag "Search words"
  491. (const :format "" search)
  492. (string :tag "Match")
  493. ,org-agenda-custom-commands-local-options)
  494. (list :tag "Stuck projects"
  495. (const :format "" stuck)
  496. (const :tag "" :format "" "")
  497. ,org-agenda-custom-commands-local-options)
  498. (list :tag "Tags search"
  499. (const :format "" tags)
  500. (string :tag "Match")
  501. ,org-agenda-custom-commands-local-options)
  502. (list :tag "Tags search, TODO entries only"
  503. (const :format "" tags-todo)
  504. (string :tag "Match")
  505. ,org-agenda-custom-commands-local-options)
  506. (list :tag "TODO keyword search"
  507. (const :format "" todo)
  508. (string :tag "Match")
  509. ,org-agenda-custom-commands-local-options)
  510. (list :tag "Other, user-defined function"
  511. (symbol :tag "function")
  512. (string :tag "Match")
  513. ,org-agenda-custom-commands-local-options)))
  514. (repeat :tag "Settings for entire command set"
  515. (list (variable :tag "Any variable")
  516. (sexp :tag "Value")))
  517. (option (repeat :tag "Export" (file :tag "Export to"))))
  518. (cons :tag "Prefix key documentation"
  519. (string :tag "Access Key(s)")
  520. (string :tag "Description ")))))
  521. (defcustom org-agenda-query-register ?o
  522. "The register holding the current query string.
  523. The purpose of this is that if you construct a query string interactively,
  524. you can then use it to define a custom command."
  525. :group 'org-agenda-custom-commands
  526. :type 'character)
  527. (defcustom org-stuck-projects
  528. '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
  529. "How to identify stuck projects.
  530. This is a list of four items:
  531. 1. A tags/todo/property matcher string that is used to identify a project.
  532. See the manual for a description of tag and property searches.
  533. The entire tree below a headline matched by this is considered one project.
  534. 2. A list of TODO keywords identifying non-stuck projects.
  535. If the project subtree contains any headline with one of these todo
  536. keywords, the project is considered to be not stuck. If you specify
  537. \"*\" as a keyword, any TODO keyword will mark the project unstuck.
  538. 3. A list of tags identifying non-stuck projects.
  539. If the project subtree contains any headline with one of these tags,
  540. the project is considered to be not stuck. If you specify \"*\" as
  541. a tag, any tag will mark the project unstuck. Note that this is about
  542. the explicit presence of a tag somewhere in the subtree, inherited
  543. tags do not count here. If inherited tags make a project not stuck,
  544. use \"-TAG\" in the tags part of the matcher under (1.) above.
  545. 4. An arbitrary regular expression matching non-stuck projects.
  546. If the project turns out to be not stuck, search continues also in the
  547. subtree to see if any of the subtasks have project status.
  548. See also the variable `org-tags-match-list-sublevels' which applies
  549. to projects matched by this search as well.
  550. After defining this variable, you may use `org-agenda-list-stuck-projects'
  551. \(bound to `\\[org-agenda] #') to produce the list."
  552. :group 'org-agenda-custom-commands
  553. :type '(list
  554. (string :tag "Tags/TODO match to identify a project")
  555. (repeat :tag "Projects are *not* stuck if they have an entry with \
  556. TODO keyword any of" (string))
  557. (repeat :tag "Projects are *not* stuck if they have an entry with \
  558. TAG being any of" (string))
  559. (regexp :tag "Projects are *not* stuck if this regexp matches inside \
  560. the subtree")))
  561. (defgroup org-agenda-skip nil
  562. "Options concerning skipping parts of agenda files."
  563. :tag "Org Agenda Skip"
  564. :group 'org-agenda)
  565. (defcustom org-agenda-skip-function-global nil
  566. "Function to be called at each match during agenda construction.
  567. If this function returns nil, the current match should not be skipped.
  568. If the function decided to skip an agenda match, is must return the
  569. buffer position from which the search should be continued.
  570. This may also be a Lisp form, which will be evaluated.
  571. This variable will be applied to every agenda match, including
  572. tags/property searches and TODO lists. So try to make the test function
  573. do its checking as efficiently as possible. To implement a skipping
  574. condition just for specific agenda commands, use the variable
  575. `org-agenda-skip-function' which can be set in the options section
  576. of custom agenda commands."
  577. :group 'org-agenda-skip
  578. :type 'sexp)
  579. (defgroup org-agenda-daily/weekly nil
  580. "Options concerning the daily/weekly agenda."
  581. :tag "Org Agenda Daily/Weekly"
  582. :group 'org-agenda)
  583. (defgroup org-agenda-todo-list nil
  584. "Options concerning the global todo list agenda view."
  585. :tag "Org Agenda Todo List"
  586. :group 'org-agenda)
  587. (defgroup org-agenda-match-view nil
  588. "Options concerning the general tags/property/todo match agenda view."
  589. :tag "Org Agenda Match View"
  590. :group 'org-agenda)
  591. (defgroup org-agenda-search-view nil
  592. "Options concerning the search agenda view."
  593. :tag "Org Agenda Search View"
  594. :group 'org-agenda)
  595. (defvar org-agenda-archives-mode nil
  596. "Non-nil means the agenda will include archived items.
  597. If this is the symbol `trees', trees in the selected agenda scope
  598. that are marked with the ARCHIVE tag will be included anyway. When this is
  599. t, also all archive files associated with the current selection of agenda
  600. files will be included.")
  601. (defcustom org-agenda-restriction-lock-highlight-subtree t
  602. "Non-nil means highlight the whole subtree when restriction is active.
  603. Otherwise only highlight the headline. Highlighting the whole subtree is
  604. useful to ensure no edits happen beyond the restricted region."
  605. :group 'org-agenda
  606. :type 'boolean)
  607. (defcustom org-agenda-skip-comment-trees t
  608. "Non-nil means skip trees that start with the COMMENT keyword.
  609. When nil, these trees are also scanned by agenda commands."
  610. :group 'org-agenda-skip
  611. :type 'boolean)
  612. (defcustom org-agenda-todo-list-sublevels t
  613. "Non-nil means check also the sublevels of a TODO entry for TODO entries.
  614. When nil, the sublevels of a TODO entry are not checked, resulting in
  615. potentially much shorter TODO lists."
  616. :group 'org-agenda-skip
  617. :group 'org-agenda-todo-list
  618. :type 'boolean)
  619. (defcustom org-agenda-todo-ignore-with-date nil
  620. "Non-nil means don't show entries with a date in the global todo list.
  621. You can use this if you prefer to mark mere appointments with a TODO keyword,
  622. but don't want them to show up in the TODO list.
  623. When this is set, it also covers deadlines and scheduled items, the settings
  624. of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
  625. will be ignored.
  626. See also the variable `org-agenda-tags-todo-honor-ignore-options'."
  627. :group 'org-agenda-skip
  628. :group 'org-agenda-todo-list
  629. :type 'boolean)
  630. (defcustom org-agenda-todo-ignore-timestamp nil
  631. "Non-nil means don't show entries with a timestamp.
  632. This applies when creating the global todo list.
  633. Valid values are:
  634. past Don't show entries for today or in the past.
  635. future Don't show entries with a timestamp in the future.
  636. The idea behind this is that if it has a future
  637. timestamp, you don't want to think about it until the
  638. date.
  639. all Don't show any entries with a timestamp in the global todo list.
  640. The idea behind this is that by setting a timestamp, you
  641. have already \"taken care\" of this item.
  642. This variable can also have an integer as a value. If positive (N),
  643. todos with a timestamp N or more days in the future will be ignored. If
  644. negative (-N), todos with a timestamp N or more days in the past will be
  645. ignored. If 0, todos with a timestamp either today or in the future will
  646. be ignored. For example, a value of -1 will exclude todos with a
  647. timestamp in the past (yesterday or earlier), while a value of 7 will
  648. exclude todos with a timestamp a week or more in the future.
  649. See also `org-agenda-todo-ignore-with-date'.
  650. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  651. to make his option also apply to the tags-todo list."
  652. :group 'org-agenda-skip
  653. :group 'org-agenda-todo-list
  654. :version "24.1"
  655. :type '(choice
  656. (const :tag "Ignore future timestamp todos" future)
  657. (const :tag "Ignore past or present timestamp todos" past)
  658. (const :tag "Ignore all timestamp todos" all)
  659. (const :tag "Show timestamp todos" nil)
  660. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  661. (defcustom org-agenda-todo-ignore-scheduled nil
  662. "Non-nil means, ignore some scheduled TODO items when making TODO list.
  663. This applies when creating the global todo list.
  664. Valid values are:
  665. past Don't show entries scheduled today or in the past.
  666. future Don't show entries scheduled in the future.
  667. The idea behind this is that by scheduling it, you don't want to
  668. think about it until the scheduled date.
  669. all Don't show any scheduled entries in the global todo list.
  670. The idea behind this is that by scheduling it, you have already
  671. \"taken care\" of this item.
  672. t Same as `all', for backward compatibility.
  673. This variable can also have an integer as a value. See
  674. `org-agenda-todo-ignore-timestamp' for more details.
  675. See also `org-agenda-todo-ignore-with-date'.
  676. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  677. to make his option also apply to the tags-todo list."
  678. :group 'org-agenda-skip
  679. :group 'org-agenda-todo-list
  680. :type '(choice
  681. (const :tag "Ignore future-scheduled todos" future)
  682. (const :tag "Ignore past- or present-scheduled todos" past)
  683. (const :tag "Ignore all scheduled todos" all)
  684. (const :tag "Ignore all scheduled todos (compatibility)" t)
  685. (const :tag "Show scheduled todos" nil)
  686. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  687. (defcustom org-agenda-todo-ignore-deadlines nil
  688. "Non-nil means ignore some deadline TODO items when making TODO list.
  689. There are different motivations for using different values, please think
  690. carefully when configuring this variable.
  691. This applies when creating the global TODO list.
  692. Valid values are:
  693. near Don't show near deadline entries. A deadline is near when it is
  694. closer than `org-deadline-warning-days' days. The idea behind this
  695. is that such items will appear in the agenda anyway.
  696. far Don't show TODO entries where a deadline has been defined, but
  697. is not going to happen anytime soon. This is useful if you want to use
  698. the TODO list to figure out what to do now.
  699. past Don't show entries with a deadline timestamp for today or in the past.
  700. future Don't show entries with a deadline timestamp in the future, not even
  701. when they become `near' ones. Use it with caution.
  702. all Ignore all TODO entries that do have a deadline.
  703. t Same as `near', for backward compatibility.
  704. This variable can also have an integer as a value. See
  705. `org-agenda-todo-ignore-timestamp' for more details.
  706. See also `org-agenda-todo-ignore-with-date'.
  707. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  708. to make his option also apply to the tags-todo list."
  709. :group 'org-agenda-skip
  710. :group 'org-agenda-todo-list
  711. :type '(choice
  712. (const :tag "Ignore near deadlines" near)
  713. (const :tag "Ignore near deadlines (compatibility)" t)
  714. (const :tag "Ignore far deadlines" far)
  715. (const :tag "Ignore all TODOs with a deadlines" all)
  716. (const :tag "Show all TODOs, even if they have a deadline" nil)
  717. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  718. (defcustom org-agenda-todo-ignore-time-comparison-use-seconds nil
  719. "Time unit to use when possibly ignoring an agenda item.
  720. See the docstring of various `org-agenda-todo-ignore-*' options.
  721. The default is to compare time stamps using days. An item is thus
  722. considered to be in the future if it is at least one day after today.
  723. Non-nil means to compare time stamps using seconds. An item is then
  724. considered future if it has a time value later than current time."
  725. :group 'org-agenda-skip
  726. :group 'org-agenda-todo-list
  727. :version "24.4"
  728. :package-version '(Org . "8.0")
  729. :type '(choice
  730. (const :tag "Compare time with days" nil)
  731. (const :tag "Compare time with seconds" t)))
  732. (defcustom org-agenda-tags-todo-honor-ignore-options nil
  733. "Non-nil means honor todo-list ignores options also in tags-todo search.
  734. The variables
  735. `org-agenda-todo-ignore-with-date',
  736. `org-agenda-todo-ignore-timestamp',
  737. `org-agenda-todo-ignore-scheduled',
  738. `org-agenda-todo-ignore-deadlines'
  739. make the global TODO list skip entries that have time stamps of certain
  740. kinds. If this option is set, the same options will also apply for the
  741. tags-todo search, which is the general tags/property matcher
  742. restricted to unfinished TODO entries only."
  743. :group 'org-agenda-skip
  744. :group 'org-agenda-todo-list
  745. :group 'org-agenda-match-view
  746. :type 'boolean)
  747. (defcustom org-agenda-skip-scheduled-if-done nil
  748. "Non-nil means don't show scheduled items in agenda when they are done.
  749. This is relevant for the daily/weekly agenda, not for the TODO list. It
  750. applies only to the actual date of the scheduling. Warnings about an item
  751. with a past scheduling dates are always turned off when the item is DONE."
  752. :group 'org-agenda-skip
  753. :group 'org-agenda-daily/weekly
  754. :type 'boolean)
  755. (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
  756. "Non-nil means skip scheduling line if same entry shows because of deadline.
  757. In the agenda of today, an entry can show up multiple times
  758. because it is both scheduled and has a nearby deadline, and maybe
  759. a plain time stamp as well.
  760. When this variable is nil, the entry will be shown several times.
  761. When set to t, then only the deadline is shown and the fact that
  762. the entry is scheduled today or was scheduled previously is not
  763. shown.
  764. When set to the symbol `not-today', skip scheduled previously,
  765. but not scheduled today.
  766. When set to the symbol `repeated-after-deadline', skip scheduled
  767. items if they are repeated beyond the current deadline."
  768. :group 'org-agenda-skip
  769. :group 'org-agenda-daily/weekly
  770. :type '(choice
  771. (const :tag "Never" nil)
  772. (const :tag "Always" t)
  773. (const :tag "Not when scheduled today" not-today)
  774. (const :tag "When repeated past deadline" repeated-after-deadline)))
  775. (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
  776. "Non-nil means skip timestamp line if same entry shows because of deadline.
  777. In the agenda of today, an entry can show up multiple times
  778. because it has both a plain timestamp and has a nearby deadline.
  779. When this variable is t, then only the deadline is shown and the
  780. fact that the entry has a timestamp for or including today is not
  781. shown. When this variable is nil, the entry will be shown
  782. several times."
  783. :group 'org-agenda-skip
  784. :group 'org-agenda-daily/weekly
  785. :version "24.1"
  786. :type '(choice
  787. (const :tag "Never" nil)
  788. (const :tag "Always" t)))
  789. (defcustom org-agenda-skip-deadline-if-done nil
  790. "Non-nil means don't show deadlines when the corresponding item is done.
  791. When nil, the deadline is still shown and should give you a happy feeling.
  792. This is relevant for the daily/weekly agenda. It applies only to the
  793. actual date of the deadline. Warnings about approaching and past-due
  794. deadlines are always turned off when the item is DONE."
  795. :group 'org-agenda-skip
  796. :group 'org-agenda-daily/weekly
  797. :type 'boolean)
  798. (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
  799. "Non-nil means skip deadline prewarning when entry is also scheduled.
  800. This will apply on all days where a prewarning for the deadline would
  801. be shown, but not at the day when the entry is actually due. On that day,
  802. the deadline will be shown anyway.
  803. This variable may be set to nil, t, the symbol `pre-scheduled',
  804. or a number which will then give the number of days before the actual
  805. deadline when the prewarnings should resume. The symbol `pre-scheduled'
  806. eliminates the deadline prewarning only prior to the scheduled date.
  807. This can be used in a workflow where the first showing of the deadline will
  808. trigger you to schedule it, and then you don't want to be reminded of it
  809. because you will take care of it on the day when scheduled."
  810. :group 'org-agenda-skip
  811. :group 'org-agenda-daily/weekly
  812. :version "24.1"
  813. :type '(choice
  814. (const :tag "Always show prewarning" nil)
  815. (const :tag "Remove prewarning prior to scheduled date" pre-scheduled)
  816. (const :tag "Remove prewarning if entry is scheduled" t)
  817. (integer :tag "Restart prewarning N days before deadline")))
  818. (defcustom org-agenda-skip-scheduled-delay-if-deadline nil
  819. "Non-nil means skip scheduled delay when entry also has a deadline.
  820. This variable may be set to nil, t, the symbol `post-deadline',
  821. or a number which will then give the number of days after the actual
  822. scheduled date when the delay should expire. The symbol `post-deadline'
  823. eliminates the schedule delay when the date is posterior to the deadline."
  824. :group 'org-agenda-skip
  825. :group 'org-agenda-daily/weekly
  826. :version "24.4"
  827. :package-version '(Org . "8.0")
  828. :type '(choice
  829. (const :tag "Always honor delay" nil)
  830. (const :tag "Ignore delay if posterior to the deadline" post-deadline)
  831. (const :tag "Ignore delay if entry has a deadline" t)
  832. (integer :tag "Honor delay up until N days after the scheduled date")))
  833. (defcustom org-agenda-skip-additional-timestamps-same-entry nil
  834. "When nil, multiple same-day timestamps in entry make multiple agenda lines.
  835. When non-nil, after the search for timestamps has matched once in an
  836. entry, the rest of the entry will not be searched."
  837. :group 'org-agenda-skip
  838. :type 'boolean)
  839. (defcustom org-agenda-skip-timestamp-if-done nil
  840. "Non-nil means don't select item by timestamp or -range if it is DONE."
  841. :group 'org-agenda-skip
  842. :group 'org-agenda-daily/weekly
  843. :type 'boolean)
  844. (defcustom org-agenda-dim-blocked-tasks t
  845. "Non-nil means dim blocked tasks in the agenda display.
  846. This causes some overhead during agenda construction, but if you
  847. have turned on `org-enforce-todo-dependencies',
  848. `org-enforce-todo-checkbox-dependencies', or any other blocking
  849. mechanism, this will create useful feedback in the agenda.
  850. Instead of t, this variable can also have the value `invisible'.
  851. Then blocked tasks will be invisible and only become visible when
  852. they become unblocked. An exemption to this behavior is when a task is
  853. blocked because of unchecked checkboxes below it. Since checkboxes do
  854. not show up in the agenda views, making this task invisible you remove any
  855. trace from agenda views that there is something to do. Therefore, a task
  856. that is blocked because of checkboxes will never be made invisible, it
  857. will only be dimmed."
  858. :group 'org-agenda-daily/weekly
  859. :group 'org-agenda-todo-list
  860. :version "24.3"
  861. :type '(choice
  862. (const :tag "Do not dim" nil)
  863. (const :tag "Dim to a gray face" t)
  864. (const :tag "Make invisible" invisible)))
  865. (defgroup org-agenda-startup nil
  866. "Options concerning initial settings in the Agenda in Org Mode."
  867. :tag "Org Agenda Startup"
  868. :group 'org-agenda)
  869. (defcustom org-agenda-menu-show-matcher t
  870. "Non-nil means show the match string in the agenda dispatcher menu.
  871. When nil, the matcher string is not shown, but is put into the help-echo
  872. property so than moving the mouse over the command shows it.
  873. Setting it to nil is good if matcher strings are very long and/or if
  874. you want to use two-columns display (see `org-agenda-menu-two-columns')."
  875. :group 'org-agenda
  876. :version "24.1"
  877. :type 'boolean)
  878. (defcustom org-agenda-menu-two-columns nil
  879. "Non-nil means, use two columns to show custom commands in the dispatcher.
  880. If you use this, you probably want to set `org-agenda-menu-show-matcher'
  881. to nil."
  882. :group 'org-agenda
  883. :version "24.1"
  884. :type 'boolean)
  885. (defcustom org-agenda-finalize-hook nil
  886. "Hook run just before displaying an agenda buffer.
  887. The buffer is still writable when the hook is called.
  888. You can modify some of the buffer substrings but you should be
  889. extra careful not to modify the text properties of the agenda
  890. headlines as the agenda display heavily relies on them."
  891. :group 'org-agenda-startup
  892. :type 'hook)
  893. (defcustom org-agenda-mouse-1-follows-link nil
  894. "Non-nil means mouse-1 on a link will follow the link in the agenda.
  895. A longer mouse click will still set point. Needs to be set
  896. before org.el is loaded."
  897. :group 'org-agenda-startup
  898. :type 'boolean)
  899. (defcustom org-agenda-start-with-follow-mode nil
  900. "The initial value of follow mode in a newly created agenda window."
  901. :group 'org-agenda-startup
  902. :type 'boolean)
  903. (defcustom org-agenda-follow-indirect nil
  904. "Non-nil means `org-agenda-follow-mode' displays only the
  905. current item's tree, in an indirect buffer."
  906. :group 'org-agenda
  907. :version "24.1"
  908. :type 'boolean)
  909. (defcustom org-agenda-show-outline-path t
  910. "Non-nil means show outline path in echo area after line motion."
  911. :group 'org-agenda-startup
  912. :type 'boolean)
  913. (defcustom org-agenda-start-with-entry-text-mode nil
  914. "The initial value of entry-text-mode in a newly created agenda window."
  915. :group 'org-agenda-startup
  916. :type 'boolean)
  917. (defcustom org-agenda-entry-text-maxlines 5
  918. "Number of text lines to be added when `E' is pressed in the agenda.
  919. Note that this variable only used during agenda display. To add entry text
  920. when exporting the agenda, configure the variable
  921. `org-agenda-add-entry-text-maxlines'."
  922. :group 'org-agenda
  923. :type 'integer)
  924. (defcustom org-agenda-entry-text-exclude-regexps nil
  925. "List of regular expressions to clean up entry text.
  926. The complete matches of all regular expressions in this list will be
  927. removed from entry text before it is shown in the agenda."
  928. :group 'org-agenda
  929. :type '(repeat (regexp)))
  930. (defcustom org-agenda-entry-text-leaders " > "
  931. "Text prepended to the entry text in agenda buffers."
  932. :version "24.4"
  933. :package-version '(Org . "8.0")
  934. :group 'org-agenda
  935. :type 'string)
  936. (defvar org-agenda-entry-text-cleanup-hook nil
  937. "Hook that is run after basic cleanup of entry text to be shown in agenda.
  938. This cleanup is done in a temporary buffer, so the function may inspect and
  939. change the entire buffer.
  940. Some default stuff like drawers and scheduling/deadline dates will already
  941. have been removed when this is called, as will any matches for regular
  942. expressions listed in `org-agenda-entry-text-exclude-regexps'.")
  943. (defvar org-agenda-include-inactive-timestamps nil
  944. "Non-nil means include inactive time stamps in agenda.
  945. Dynamically scoped.")
  946. (defgroup org-agenda-windows nil
  947. "Options concerning the windows used by the Agenda in Org Mode."
  948. :tag "Org Agenda Windows"
  949. :group 'org-agenda)
  950. (defcustom org-agenda-window-setup 'reorganize-frame
  951. "How the agenda buffer should be displayed.
  952. Possible values for this option are:
  953. current-window Show agenda in the current window, keeping all other windows.
  954. other-window Use `switch-to-buffer-other-window' to display agenda.
  955. only-window Show agenda, deleting all other windows.
  956. reorganize-frame Show only two windows on the current frame, the current
  957. window and the agenda.
  958. other-frame Use `switch-to-buffer-other-frame' to display agenda.
  959. Also, when exiting the agenda, kill that frame.
  960. See also the variable `org-agenda-restore-windows-after-quit'."
  961. :group 'org-agenda-windows
  962. :type '(choice
  963. (const current-window)
  964. (const other-frame)
  965. (const other-window)
  966. (const only-window)
  967. (const reorganize-frame)))
  968. (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
  969. "The min and max height of the agenda window as a fraction of frame height.
  970. The value of the variable is a cons cell with two numbers between 0 and 1.
  971. It only matters if `org-agenda-window-setup' is `reorganize-frame'."
  972. :group 'org-agenda-windows
  973. :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
  974. (defcustom org-agenda-restore-windows-after-quit nil
  975. "Non-nil means restore window configuration upon exiting agenda.
  976. Before the window configuration is changed for displaying the agenda,
  977. the current status is recorded. When the agenda is exited with
  978. `q' or `x' and this option is set, the old state is restored. If
  979. `org-agenda-window-setup' is `other-frame', the value of this
  980. option will be ignored."
  981. :group 'org-agenda-windows
  982. :type 'boolean)
  983. (defcustom org-agenda-span 'week
  984. "Number of days to include in overview display.
  985. Can be day, week, month, year, or any number of days.
  986. Custom commands can set this variable in the options section."
  987. :group 'org-agenda-daily/weekly
  988. :type '(choice (const :tag "Day" day)
  989. (const :tag "Week" week)
  990. (const :tag "Fortnight" fortnight)
  991. (const :tag "Month" month)
  992. (const :tag "Year" year)
  993. (integer :tag "Custom")))
  994. (defcustom org-agenda-start-on-weekday 1
  995. "Non-nil means start the overview always on the specified weekday.
  996. 0 denotes Sunday, 1 denotes Monday, etc.
  997. When nil, always start on the current day.
  998. Custom commands can set this variable in the options section."
  999. :group 'org-agenda-daily/weekly
  1000. :type '(choice (const :tag "Today" nil)
  1001. (integer :tag "Weekday No.")))
  1002. (defcustom org-agenda-show-all-dates t
  1003. "Non-nil means `org-agenda' shows every day in the selected range.
  1004. When nil, only the days which actually have entries are shown."
  1005. :group 'org-agenda-daily/weekly
  1006. :type 'boolean)
  1007. (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
  1008. "Format string for displaying dates in the agenda.
  1009. Used by the daily/weekly agenda. This should be a format string
  1010. understood by `format-time-string', or a function returning the
  1011. formatted date as a string. The function must take a single
  1012. argument, a calendar-style date list like (month day year)."
  1013. :group 'org-agenda-daily/weekly
  1014. :type '(choice
  1015. (string :tag "Format string")
  1016. (function :tag "Function")))
  1017. (defun org-agenda-format-date-aligned (date)
  1018. "Format a DATE string for display in the daily/weekly agenda.
  1019. This function makes sure that dates are aligned for easy reading."
  1020. (require 'cal-iso)
  1021. (let* ((dayname (calendar-day-name date))
  1022. (day (cadr date))
  1023. (day-of-week (calendar-day-of-week date))
  1024. (month (car date))
  1025. (monthname (calendar-month-name month))
  1026. (year (nth 2 date))
  1027. (iso-week (org-days-to-iso-week
  1028. (calendar-absolute-from-gregorian date)))
  1029. (weekyear (cond ((and (= month 1) (>= iso-week 52))
  1030. (1- year))
  1031. ((and (= month 12) (<= iso-week 1))
  1032. (1+ year))
  1033. (t year)))
  1034. (weekstring (if (= day-of-week 1)
  1035. (format " W%02d" iso-week)
  1036. "")))
  1037. (format "%-10s %2d %s %4d%s"
  1038. dayname day monthname year weekstring)))
  1039. (defcustom org-agenda-time-leading-zero nil
  1040. "Non-nil means use leading zero for military times in agenda.
  1041. For example, 9:30am would become 09:30 rather than 9:30."
  1042. :group 'org-agenda-daily/weekly
  1043. :version "24.1"
  1044. :type 'boolean)
  1045. (defcustom org-agenda-timegrid-use-ampm nil
  1046. "When set, show AM/PM style timestamps on the timegrid."
  1047. :group 'org-agenda
  1048. :version "24.1"
  1049. :type 'boolean)
  1050. (defun org-agenda-time-of-day-to-ampm (time)
  1051. "Convert TIME of a string like \"13:45\" to an AM/PM style time string."
  1052. (let* ((hour-number (string-to-number (substring time 0 -3)))
  1053. (minute (substring time -2))
  1054. (ampm "am"))
  1055. (cond
  1056. ((equal hour-number 12)
  1057. (setq ampm "pm"))
  1058. ((> hour-number 12)
  1059. (setq ampm "pm")
  1060. (setq hour-number (- hour-number 12))))
  1061. (concat
  1062. (if org-agenda-time-leading-zero
  1063. (format "%02d" hour-number)
  1064. (format "%02s" (number-to-string hour-number)))
  1065. ":" minute ampm)))
  1066. (defun org-agenda-time-of-day-to-ampm-maybe (time)
  1067. "Conditionally convert TIME to AM/PM format based on `org-agenda-timegrid-use-ampm'."
  1068. (if org-agenda-timegrid-use-ampm
  1069. (org-agenda-time-of-day-to-ampm time)
  1070. time))
  1071. (defcustom org-agenda-weekend-days '(6 0)
  1072. "Which days are weekend?
  1073. These days get the special face `org-agenda-date-weekend' in the agenda."
  1074. :group 'org-agenda-daily/weekly
  1075. :type '(set :greedy t
  1076. (const :tag "Monday" 1)
  1077. (const :tag "Tuesday" 2)
  1078. (const :tag "Wednesday" 3)
  1079. (const :tag "Thursday" 4)
  1080. (const :tag "Friday" 5)
  1081. (const :tag "Saturday" 6)
  1082. (const :tag "Sunday" 0)))
  1083. (defcustom org-agenda-move-date-from-past-immediately-to-today t
  1084. "Non-nil means jump to today when moving a past date forward in time.
  1085. When using S-right in the agenda to move a a date forward, and the date
  1086. stamp currently points to the past, the first key press will move it
  1087. to today. When nil, just move one day forward even if the date stays
  1088. in the past."
  1089. :group 'org-agenda-daily/weekly
  1090. :version "24.1"
  1091. :type 'boolean)
  1092. (defcustom org-agenda-include-diary nil
  1093. "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
  1094. Custom commands can set this variable in the options section."
  1095. :group 'org-agenda-daily/weekly
  1096. :type 'boolean)
  1097. (defcustom org-agenda-include-deadlines t
  1098. "If non-nil, include entries within their deadline warning period.
  1099. Custom commands can set this variable in the options section."
  1100. :group 'org-agenda-daily/weekly
  1101. :version "24.1"
  1102. :type 'boolean)
  1103. (defcustom org-agenda-show-future-repeats t
  1104. "Non-nil shows repeated entries in the future part of the agenda.
  1105. When set to the symbol `next' only the first future repeat is shown."
  1106. :group 'org-agenda-daily/weekly
  1107. :type '(choice
  1108. (const :tag "Show all repeated entries" t)
  1109. (const :tag "Show next repeated entry" next)
  1110. (const :tag "Do not show repeated entries" nil))
  1111. :version "26.1"
  1112. :package-version '(Org . "9.1")
  1113. :safe #'symbolp)
  1114. (defcustom org-agenda-prefer-last-repeat nil
  1115. "Non-nil sets date for repeated entries to their last repeat.
  1116. When nil, display SCHEDULED and DEADLINE dates at their base
  1117. date, and in today's agenda, as a reminder. Display plain
  1118. time-stamps, on the other hand, at every repeat date in the past
  1119. in addition to the base date.
  1120. When non-nil, show a repeated entry at its latest repeat date,
  1121. possibly being today even if it wasn't marked as done. This
  1122. setting is useful if you do not always mark repeated entries as
  1123. done and, yet, consider that reaching repeat date starts the task
  1124. anew.
  1125. When set to a list of strings, prefer last repeats only for
  1126. entries with these TODO keywords."
  1127. :group 'org-agenda-daily/weekly
  1128. :type '(choice
  1129. (const :tag "Prefer last repeat" t)
  1130. (const :tag "Prefer base date" nil)
  1131. (repeat :tag "Prefer last repeat for entries with these TODO keywords"
  1132. (string :tag "TODO keyword")))
  1133. :version "26.1"
  1134. :package-version '(Org . "9.1")
  1135. :safe (lambda (x) (or (booleanp x) (consp x))))
  1136. (defcustom org-scheduled-past-days 10000
  1137. "Number of days to continue listing scheduled items not marked DONE.
  1138. When an item is scheduled on a date, it shows up in the agenda on
  1139. this day and will be listed until it is marked done or for the
  1140. number of days given here."
  1141. :group 'org-agenda-daily/weekly
  1142. :type 'integer
  1143. :safe 'integerp)
  1144. (defcustom org-deadline-past-days 10000
  1145. "Number of days to warn about missed deadlines.
  1146. When an item has deadline on a date, it shows up in the agenda on
  1147. this day and will appear as a reminder until it is marked DONE or
  1148. for the number of days given here."
  1149. :group 'org-agenda-daily/weekly
  1150. :type 'integer
  1151. :version "26.1"
  1152. :package-version '(Org . "9.1")
  1153. :safe 'integerp)
  1154. (defcustom org-agenda-log-mode-items '(closed clock)
  1155. "List of items that should be shown in agenda log mode.
  1156. \\<org-agenda-mode-map>\
  1157. This list may contain the following symbols:
  1158. closed Show entries that have been closed on that day.
  1159. clock Show entries that have received clocked time on that day.
  1160. state Show all logged state changes.
  1161. Note that instead of changing this variable, you can also press \
  1162. `\\[universal-argument] \\[org-agenda-log-mode]' in
  1163. the agenda to display all available LOG items temporarily."
  1164. :group 'org-agenda-daily/weekly
  1165. :type '(set :greedy t (const closed) (const clock) (const state)))
  1166. (defcustom org-agenda-clock-consistency-checks
  1167. '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
  1168. :gap-ok-around ("4:00")
  1169. :default-face ((:background "DarkRed") (:foreground "white"))
  1170. :overlap-face nil :gap-face nil :no-end-time-face nil
  1171. :long-face nil :short-face nil)
  1172. "This is a property list, with the following keys:
  1173. :max-duration Mark clocking chunks that are longer than this time.
  1174. This is a time string like \"HH:MM\", or the number
  1175. of minutes as an integer.
  1176. :min-duration Mark clocking chunks that are shorter that this.
  1177. This is a time string like \"HH:MM\", or the number
  1178. of minutes as an integer.
  1179. :max-gap Mark gaps between clocking chunks that are longer than
  1180. this duration. A number of minutes, or a string
  1181. like \"HH:MM\".
  1182. :gap-ok-around List of times during the day which are usually not working
  1183. times. When a gap is detected, but the gap contains any
  1184. of these times, the gap is *not* reported. For example,
  1185. if this is (\"4:00\" \"13:00\") then gaps that contain
  1186. 4:00 in the morning (i.e. the night) and 13:00
  1187. (i.e. a typical lunch time) do not cause a warning.
  1188. You should have at least one time during the night in this
  1189. list, or otherwise the first task each morning will trigger
  1190. a warning because it follows a long gap.
  1191. Furthermore, the following properties can be used to define faces for
  1192. issue display.
  1193. :default-face the default face, if the specific face is undefined
  1194. :overlap-face face for overlapping clocks
  1195. :gap-face face for gaps between clocks
  1196. :no-end-time-face face for incomplete clocks
  1197. :long-face face for clock intervals that are too long
  1198. :short-face face for clock intervals that are too short"
  1199. :group 'org-agenda-daily/weekly
  1200. :group 'org-clock
  1201. :version "24.1"
  1202. :type 'plist)
  1203. (defcustom org-agenda-log-mode-add-notes t
  1204. "Non-nil means add first line of notes to log entries in agenda views.
  1205. If a log item like a state change or a clock entry is associated with
  1206. notes, the first line of these notes will be added to the entry in the
  1207. agenda display."
  1208. :group 'org-agenda-daily/weekly
  1209. :type 'boolean)
  1210. (defcustom org-agenda-start-with-log-mode nil
  1211. "The initial value of log-mode in a newly created agenda window.
  1212. See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
  1213. explanations on the possible values."
  1214. :group 'org-agenda-startup
  1215. :group 'org-agenda-daily/weekly
  1216. :type '(choice (const :tag "Don't show log items" nil)
  1217. (const :tag "Show only log items" only)
  1218. (const :tag "Show all possible log items" clockcheck)
  1219. (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
  1220. (choice (const :tag "Show closed log items" closed)
  1221. (const :tag "Show clocked log items" clock)
  1222. (const :tag "Show all logged state changes" state)))))
  1223. (defcustom org-agenda-start-with-clockreport-mode nil
  1224. "The initial value of clockreport-mode in a newly created agenda window."
  1225. :group 'org-agenda-startup
  1226. :group 'org-agenda-daily/weekly
  1227. :type 'boolean)
  1228. (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
  1229. "Property list with parameters for the clocktable in clockreport mode.
  1230. This is the display mode that shows a clock table in the daily/weekly
  1231. agenda, the properties for this dynamic block can be set here.
  1232. The usual clocktable parameters are allowed here, but you cannot set
  1233. the properties :name, :tstart, :tend, :block, and :scope - these will
  1234. be overwritten to make sure the content accurately reflects the
  1235. current display in the agenda."
  1236. :group 'org-agenda-daily/weekly
  1237. :type 'plist)
  1238. (defvaralias 'org-agenda-search-view-search-words-only
  1239. 'org-agenda-search-view-always-boolean)
  1240. (defcustom org-agenda-search-view-always-boolean nil
  1241. "Non-nil means the search string is interpreted as individual parts.
  1242. The search string for search view can either be interpreted as a phrase,
  1243. or as a list of snippets that define a boolean search for a number of
  1244. strings.
  1245. When this is non-nil, the string will be split on whitespace, and each
  1246. snippet will be searched individually, and all must match in order to
  1247. select an entry. A snippet is then a single string of non-white
  1248. characters, or a string in double quotes, or a regexp in {} braces.
  1249. If a snippet is preceded by \"-\", the snippet must *not* match.
  1250. \"+\" is syntactic sugar for positive selection. Each snippet may
  1251. be found as a full word or a partial word, but see the variable
  1252. `org-agenda-search-view-force-full-words'.
  1253. When this is nil, search will look for the entire search phrase as one,
  1254. with each space character matching any amount of whitespace, including
  1255. line breaks.
  1256. Even when this is nil, you can still switch to Boolean search dynamically
  1257. by preceding the first snippet with \"+\" or \"-\". If the first snippet
  1258. is a regexp marked with braces like \"{abc}\", this will also switch to
  1259. boolean search."
  1260. :group 'org-agenda-search-view
  1261. :version "24.1"
  1262. :type 'boolean)
  1263. (defcustom org-agenda-search-view-force-full-words nil
  1264. "Non-nil means, search words must be matches as complete words.
  1265. When nil, they may also match part of a word."
  1266. :group 'org-agenda-search-view
  1267. :version "24.1"
  1268. :type 'boolean)
  1269. (defcustom org-agenda-search-view-max-outline-level 0
  1270. "Maximum outline level to display in search view.
  1271. E.g. when this is set to 1, the search view will only
  1272. show headlines of level 1. When set to 0, the default
  1273. value, don't limit agenda view by outline level."
  1274. :group 'org-agenda-search-view
  1275. :version "26.1"
  1276. :package-version '(Org . "8.3")
  1277. :type 'integer)
  1278. (defgroup org-agenda-time-grid nil
  1279. "Options concerning the time grid in the Org Agenda."
  1280. :tag "Org Agenda Time Grid"
  1281. :group 'org-agenda)
  1282. (defcustom org-agenda-search-headline-for-time t
  1283. "Non-nil means search headline for a time-of-day.
  1284. If the headline contains a time-of-day in one format or another, it will
  1285. be used to sort the entry into the time sequence of items for a day.
  1286. Some people have time stamps in the headline that refer to the creation
  1287. time or so, and then this produces an unwanted side effect. If this is
  1288. the case for your, use this variable to turn off searching the headline
  1289. for a time."
  1290. :group 'org-agenda-time-grid
  1291. :type 'boolean)
  1292. (defcustom org-agenda-use-time-grid t
  1293. "Non-nil means show a time grid in the agenda schedule.
  1294. A time grid is a set of lines for specific times (like every two hours between
  1295. 8:00 and 20:00). The items scheduled for a day at specific times are
  1296. sorted in between these lines.
  1297. For details about when the grid will be shown, and what it will look like, see
  1298. the variable `org-agenda-time-grid'."
  1299. :group 'org-agenda-time-grid
  1300. :type 'boolean)
  1301. (defcustom org-agenda-time-grid
  1302. '((daily today require-timed)
  1303. (800 1000 1200 1400 1600 1800 2000)
  1304. "......"
  1305. "----------------")
  1306. "The settings for time grid for agenda display.
  1307. This is a list of four items. The first item is again a list. It contains
  1308. symbols specifying conditions when the grid should be displayed:
  1309. daily if the agenda shows a single day
  1310. weekly if the agenda shows an entire week
  1311. today show grid on current date, independent of daily/weekly display
  1312. require-timed show grid only if at least one item has a time specification
  1313. remove-match skip grid times already present in an entry
  1314. The second item is a list of integers, indicating the times that
  1315. should have a grid line.
  1316. The third item is a string which will be placed right after the
  1317. times that have a grid line.
  1318. The fourth item is a string placed after the grid times. This
  1319. will align with agenda items"
  1320. :group 'org-agenda-time-grid
  1321. :type
  1322. '(list
  1323. (set :greedy t :tag "Grid Display Options"
  1324. (const :tag "Show grid in single day agenda display" daily)
  1325. (const :tag "Show grid in weekly agenda display" weekly)
  1326. (const :tag "Always show grid for today" today)
  1327. (const :tag "Show grid only if any timed entries are present"
  1328. require-timed)
  1329. (const :tag "Skip grid times already present in an entry"
  1330. remove-match))
  1331. (repeat :tag "Grid Times" (integer :tag "Time"))
  1332. (string :tag "Grid String (after agenda times)")
  1333. (string :tag "Grid String (aligns with agenda items)")))
  1334. (defcustom org-agenda-show-current-time-in-grid t
  1335. "Non-nil means show the current time in the time grid."
  1336. :group 'org-agenda-time-grid
  1337. :version "24.1"
  1338. :type 'boolean)
  1339. (defcustom org-agenda-current-time-string
  1340. "now - - - - - - - - - - - - - - - - - - - - - - - - -"
  1341. "The string for the current time marker in the agenda."
  1342. :group 'org-agenda-time-grid
  1343. :version "24.1"
  1344. :type 'string)
  1345. (defgroup org-agenda-sorting nil
  1346. "Options concerning sorting in the Org Agenda."
  1347. :tag "Org Agenda Sorting"
  1348. :group 'org-agenda)
  1349. (defcustom org-agenda-sorting-strategy
  1350. '((agenda habit-down time-up priority-down category-keep)
  1351. (todo priority-down category-keep)
  1352. (tags priority-down category-keep)
  1353. (search category-keep))
  1354. "Sorting structure for the agenda items of a single day.
  1355. This is a list of symbols which will be used in sequence to determine
  1356. if an entry should be listed before another entry. The following
  1357. symbols are recognized:
  1358. time-up Put entries with time-of-day indications first, early first
  1359. time-down Put entries with time-of-day indications first, late first
  1360. timestamp-up Sort by any timestamp, early first
  1361. timestamp-down Sort by any timestamp, late first
  1362. scheduled-up Sort by scheduled timestamp, early first
  1363. scheduled-down Sort by scheduled timestamp, late first
  1364. deadline-up Sort by deadline timestamp, early first
  1365. deadline-down Sort by deadline timestamp, late first
  1366. ts-up Sort by active timestamp, early first
  1367. ts-down Sort by active timestamp, late first
  1368. tsia-up Sort by inactive timestamp, early first
  1369. tsia-down Sort by inactive timestamp, late first
  1370. category-keep Keep the default order of categories, corresponding to the
  1371. sequence in `org-agenda-files'.
  1372. category-up Sort alphabetically by category, A-Z.
  1373. category-down Sort alphabetically by category, Z-A.
  1374. tag-up Sort alphabetically by last tag, A-Z.
  1375. tag-down Sort alphabetically by last tag, Z-A.
  1376. priority-up Sort numerically by priority, high priority last.
  1377. priority-down Sort numerically by priority, high priority first.
  1378. todo-state-up Sort by todo state, tasks that are done last.
  1379. todo-state-down Sort by todo state, tasks that are done first.
  1380. effort-up Sort numerically by estimated effort, high effort last.
  1381. effort-down Sort numerically by estimated effort, high effort first.
  1382. user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
  1383. user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
  1384. habit-up Put entries that are habits first
  1385. habit-down Put entries that are habits last
  1386. alpha-up Sort headlines alphabetically
  1387. alpha-down Sort headlines alphabetically, reversed
  1388. The different possibilities will be tried in sequence, and testing stops
  1389. if one comparison returns a \"not-equal\". For example, the default
  1390. '(time-up category-keep priority-down)
  1391. means: Pull out all entries having a specified time of day and sort them,
  1392. in order to make a time schedule for the current day the first thing in the
  1393. agenda listing for the day. Of the entries without a time indication, keep
  1394. the grouped in categories, don't sort the categories, but keep them in
  1395. the sequence given in `org-agenda-files'. Within each category sort by
  1396. priority.
  1397. Leaving out `category-keep' would mean that items will be sorted across
  1398. categories by priority.
  1399. Instead of a single list, this can also be a set of list for specific
  1400. contents, with a context symbol in the car of the list, any of
  1401. `agenda', `todo', `tags', `search' for the corresponding agenda views.
  1402. Custom commands can bind this variable in the options section."
  1403. :group 'org-agenda-sorting
  1404. :type `(choice
  1405. (repeat :tag "General" ,org-sorting-choice)
  1406. (list :tag "Individually"
  1407. (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
  1408. (repeat ,org-sorting-choice))
  1409. (cons (const :tag "Strategy for TODO lists" todo)
  1410. (repeat ,org-sorting-choice))
  1411. (cons (const :tag "Strategy for Tags matches" tags)
  1412. (repeat ,org-sorting-choice))
  1413. (cons (const :tag "Strategy for search matches" search)
  1414. (repeat ,org-sorting-choice)))))
  1415. (defcustom org-agenda-cmp-user-defined nil
  1416. "A function to define the comparison `user-defined'.
  1417. This function must receive two arguments, agenda entry a and b.
  1418. If a>b, return +1. If a<b, return -1. If they are equal as seen by
  1419. the user comparison, return nil.
  1420. When this is defined, you can make `user-defined-up' and `user-defined-down'
  1421. part of an agenda sorting strategy."
  1422. :group 'org-agenda-sorting
  1423. :type 'symbol)
  1424. (defcustom org-sort-agenda-notime-is-late t
  1425. "Non-nil means items without time are considered late.
  1426. This is only relevant for sorting. When t, items which have no explicit
  1427. time like 15:30 will be considered as 99:01, i.e. later than any items which
  1428. do have a time. When nil, the default time is before 0:00. You can use this
  1429. option to decide if the schedule for today should come before or after timeless
  1430. agenda entries."
  1431. :group 'org-agenda-sorting
  1432. :type 'boolean)
  1433. (defcustom org-sort-agenda-noeffort-is-high t
  1434. "Non-nil means items without effort estimate are sorted as high effort.
  1435. This also applies when filtering an agenda view with respect to the
  1436. < or > effort operator. Then, tasks with no effort defined will be treated
  1437. as tasks with high effort.
  1438. When nil, such items are sorted as 0 minutes effort."
  1439. :group 'org-agenda-sorting
  1440. :type 'boolean)
  1441. (defgroup org-agenda-line-format nil
  1442. "Options concerning the entry prefix in the Org agenda display."
  1443. :tag "Org Agenda Line Format"
  1444. :group 'org-agenda)
  1445. (defcustom org-agenda-prefix-format
  1446. '((agenda . " %i %-12:c%?-12t% s")
  1447. (todo . " %i %-12:c")
  1448. (tags . " %i %-12:c")
  1449. (search . " %i %-12:c"))
  1450. "Format specifications for the prefix of items in the agenda views.
  1451. An alist with one entry per agenda type. The keys of the
  1452. sublists are `agenda', `todo', `search' and `tags'. The values
  1453. are format strings.
  1454. This format works similar to a printf format, with the following meaning:
  1455. %c the category of the item, \"Diary\" for entries from the diary,
  1456. or as given by the CATEGORY keyword or derived from the file name
  1457. %e the effort required by the item
  1458. %l the level of the item (insert X space(s) if item is of level X)
  1459. %i the icon category of the item, see `org-agenda-category-icon-alist'
  1460. %T the last tag of the item (ignore inherited tags, which come first)
  1461. %t the HH:MM time-of-day specification if one applies to the entry
  1462. %s Scheduling/Deadline information, a short string
  1463. %b show breadcrumbs, i.e., the names of the higher levels
  1464. %(expression) Eval EXPRESSION and replace the control string
  1465. by the result
  1466. All specifiers work basically like the standard `%s' of printf, but may
  1467. contain two additional characters: a question mark just after the `%'
  1468. and a whitespace/punctuation character just before the final letter.
  1469. If the first character after `%' is a question mark, the entire field
  1470. will only be included if the corresponding value applies to the current
  1471. entry. This is useful for fields which should have fixed width when
  1472. present, but zero width when absent. For example, \"%?-12t\" will
  1473. result in a 12 character time field if a time of the day is specified,
  1474. but will completely disappear in entries which do not contain a time.
  1475. If there is punctuation or whitespace character just before the
  1476. final format letter, this character will be appended to the field
  1477. value if the value is not empty. For example, the format
  1478. \"%-12:c\" leads to \"Diary: \" if the category is \"Diary\". If
  1479. the category is empty, no additional colon is inserted.
  1480. The default value for the agenda sublist is \" %-12:c%?-12t% s\",
  1481. which means:
  1482. - Indent the line with two space characters
  1483. - Give the category a 12 chars wide field, padded with whitespace on
  1484. the right (because of `-'). Append a colon if there is a category
  1485. (because of `:').
  1486. - If there is a time-of-day, put it into a 12 chars wide field. If no
  1487. time, don't put in an empty field, just skip it (because of '?').
  1488. - Finally, put the scheduling information.
  1489. See also the variables `org-agenda-remove-times-when-in-prefix' and
  1490. `org-agenda-remove-tags'.
  1491. Custom commands can set this variable in the options section."
  1492. :type '(choice
  1493. (string :tag "General format")
  1494. (list :greedy t :tag "View dependent"
  1495. (cons (const agenda) (string :tag "Format"))
  1496. (cons (const todo) (string :tag "Format"))
  1497. (cons (const tags) (string :tag "Format"))
  1498. (cons (const search) (string :tag "Format"))))
  1499. :group 'org-agenda-line-format
  1500. :version "26.1"
  1501. :package-version '(Org . "9.1"))
  1502. (defvar org-prefix-format-compiled nil
  1503. "The compiled prefix format and associated variables.
  1504. This is a list where first element is a list of variable bindings, and second
  1505. element is the compiled format expression. See the variable
  1506. `org-agenda-prefix-format'.")
  1507. (defcustom org-agenda-todo-keyword-format "%-1s"
  1508. "Format for the TODO keyword in agenda lines.
  1509. Set this to something like \"%-12s\" if you want all TODO keywords
  1510. to occupy a fixed space in the agenda display."
  1511. :group 'org-agenda-line-format
  1512. :type 'string)
  1513. (defcustom org-agenda-diary-sexp-prefix nil
  1514. "A regexp that matches part of a diary sexp entry
  1515. which should be treated as scheduling/deadline information in
  1516. `org-agenda'.
  1517. For example, you can use this to extract the `diary-remind-message' from
  1518. `diary-remind' entries."
  1519. :group 'org-agenda-line-format
  1520. :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
  1521. (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
  1522. "Text preceding timerange entries in the agenda view.
  1523. This is a list with two strings. The first applies when the range
  1524. is entirely on one day. The second applies if the range spans several days.
  1525. The strings may have two \"%d\" format specifiers which will be filled
  1526. with the sequence number of the days, and the total number of days in the
  1527. range, respectively."
  1528. :group 'org-agenda-line-format
  1529. :type '(list
  1530. (string :tag "Deadline today ")
  1531. (choice :tag "Deadline relative"
  1532. (string :tag "Format string")
  1533. (function))))
  1534. (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
  1535. "Text preceding scheduled items in the agenda view.
  1536. This is a list with two strings. The first applies when the item is
  1537. scheduled on the current day. The second applies when it has been scheduled
  1538. previously, it may contain a %d indicating that this is the nth time that
  1539. this item is scheduled, due to automatic rescheduling of unfinished items
  1540. for the following day. So this number is one larger than the number of days
  1541. that passed since this item was scheduled first."
  1542. :group 'org-agenda-line-format
  1543. :version "24.4"
  1544. :package-version '(Org . "8.0")
  1545. :type '(list
  1546. (string :tag "Scheduled today ")
  1547. (string :tag "Scheduled previously")))
  1548. (defcustom org-agenda-inactive-leader "["
  1549. "Text preceding item pulled into the agenda by inactive time stamps.
  1550. These entries are added to the agenda when pressing \"[\"."
  1551. :group 'org-agenda-line-format
  1552. :version "24.1"
  1553. :type 'string)
  1554. (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: " "%2d d. ago: ")
  1555. "Text preceding deadline items in the agenda view.
  1556. This is a list with three strings. The first applies when the item has its
  1557. deadline on the current day. The second applies when the deadline is in the
  1558. future, the third one when it is in the past. The strings may contain %d
  1559. to capture the number of days."
  1560. :group 'org-agenda-line-format
  1561. :version "24.4"
  1562. :package-version '(Org . "8.0")
  1563. :type '(list
  1564. (string :tag "Deadline today ")
  1565. (string :tag "Deadline in the future ")
  1566. (string :tag "Deadline in the past ")))
  1567. (defcustom org-agenda-remove-times-when-in-prefix t
  1568. "Non-nil means remove duplicate time specifications in agenda items.
  1569. When the format `org-agenda-prefix-format' contains a `%t' specifier, a
  1570. time-of-day specification in a headline or diary entry is extracted and
  1571. placed into the prefix. If this option is non-nil, the original specification
  1572. \(a timestamp or -range, or just a plain time(range) specification like
  1573. 11:30-4pm) will be removed for agenda display. This makes the agenda less
  1574. cluttered.
  1575. The option can be t or nil. It may also be the symbol `beg', indicating
  1576. that the time should only be removed when it is located at the beginning of
  1577. the headline/diary entry."
  1578. :group 'org-agenda-line-format
  1579. :type '(choice
  1580. (const :tag "Always" t)
  1581. (const :tag "Never" nil)
  1582. (const :tag "When at beginning of entry" beg)))
  1583. (defcustom org-agenda-remove-timeranges-from-blocks nil
  1584. "Non-nil means remove time ranges specifications in agenda
  1585. items that span on several days."
  1586. :group 'org-agenda-line-format
  1587. :version "24.1"
  1588. :type 'boolean)
  1589. (defcustom org-agenda-default-appointment-duration nil
  1590. "Default duration for appointments that only have a starting time.
  1591. When nil, no duration is specified in such cases.
  1592. When non-nil, this must be the number of minutes, e.g. 60 for one hour."
  1593. :group 'org-agenda-line-format
  1594. :type '(choice
  1595. (integer :tag "Minutes")
  1596. (const :tag "No default duration")))
  1597. (defcustom org-agenda-show-inherited-tags t
  1598. "Non-nil means show inherited tags in each agenda line.
  1599. When this option is set to `always', it takes precedence over
  1600. `org-agenda-use-tag-inheritance' and inherited tags are shown
  1601. in every agenda.
  1602. When this option is set to t (the default), inherited tags are
  1603. shown when they are available, i.e. when the value of
  1604. `org-agenda-use-tag-inheritance' enables tag inheritance for the
  1605. given agenda type.
  1606. This can be set to a list of agenda types in which the agenda
  1607. must display the inherited tags. Available types are `todo',
  1608. `agenda' and `search'.
  1609. When set to nil, never show inherited tags in agenda lines."
  1610. :group 'org-agenda-line-format
  1611. :group 'org-agenda
  1612. :version "24.3"
  1613. :type '(choice
  1614. (const :tag "Show inherited tags when available" t)
  1615. (const :tag "Always show inherited tags" always)
  1616. (repeat :tag "Show inherited tags only in selected agenda types"
  1617. (symbol :tag "Agenda type"))))
  1618. (defcustom org-agenda-use-tag-inheritance '(todo search agenda)
  1619. "List of agenda view types where to use tag inheritance.
  1620. In tags/tags-todo/tags-tree agenda views, tag inheritance is
  1621. controlled by `org-use-tag-inheritance'. In other agenda types,
  1622. `org-use-tag-inheritance' is not used for the selection of the
  1623. agenda entries. Still, you may want the agenda to be aware of
  1624. the inherited tags anyway, e.g. for later tag filtering.
  1625. Allowed value are `todo', `search' and `agenda'.
  1626. This variable has no effect if `org-agenda-show-inherited-tags'
  1627. is set to `always'. In that case, the agenda is aware of those
  1628. tags.
  1629. The default value sets tags in every agenda type. Setting this
  1630. option to nil will speed up non-tags agenda view a lot."
  1631. :group 'org-agenda
  1632. :version "26.1"
  1633. :package-version '(Org . "9.1")
  1634. :type '(choice
  1635. (const :tag "Use tag inheritance in all agenda types" t)
  1636. (repeat :tag "Use tag inheritance in selected agenda types"
  1637. (symbol :tag "Agenda type"))))
  1638. (defcustom org-agenda-hide-tags-regexp nil
  1639. "Regular expression used to filter away specific tags in agenda views.
  1640. This means that these tags will be present, but not be shown in the agenda
  1641. line. Secondary filtering will still work on the hidden tags.
  1642. Nil means don't hide any tags."
  1643. :group 'org-agenda-line-format
  1644. :type '(choice
  1645. (const :tag "Hide none" nil)
  1646. (string :tag "Regexp ")))
  1647. (defvaralias 'org-agenda-remove-tags-when-in-prefix
  1648. 'org-agenda-remove-tags)
  1649. (defcustom org-agenda-remove-tags nil
  1650. "Non-nil means remove the tags from the headline copy in the agenda.
  1651. When this is the symbol `prefix', only remove tags when
  1652. `org-agenda-prefix-format' contains a `%T' specifier."
  1653. :group 'org-agenda-line-format
  1654. :type '(choice
  1655. (const :tag "Always" t)
  1656. (const :tag "Never" nil)
  1657. (const :tag "When prefix format contains %T" prefix)))
  1658. (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column)
  1659. (defcustom org-agenda-tags-column 'auto
  1660. "Shift tags in agenda items to this column.
  1661. If set to `auto', tags will be automatically aligned to the right
  1662. edge of the window.
  1663. If set to a positive number, tags will be left-aligned to that
  1664. column. If set to a negative number, tags will be right-aligned
  1665. to that column. For example, -80 works well for a normal 80
  1666. character screen."
  1667. :group 'org-agenda-line-format
  1668. :type '(choice
  1669. (const :tag "Automatically align to right edge of window" auto)
  1670. (integer :tag "Specific column" -80))
  1671. :package-version '(Org . "9.1")
  1672. :version "26.1")
  1673. (defcustom org-agenda-fontify-priorities 'cookies
  1674. "Non-nil means highlight low and high priorities in agenda.
  1675. When t, the highest priority entries are bold, lowest priority italic.
  1676. However, settings in `org-priority-faces' will overrule these faces.
  1677. When this variable is the symbol `cookies', only fontify the
  1678. cookies, not the entire task.
  1679. This may also be an association list of priority faces, whose
  1680. keys are the character values of `org-highest-priority',
  1681. `org-default-priority', and `org-lowest-priority' (the default values
  1682. are ?A, ?B, and ?C, respectively). The face may be a named face, a
  1683. color as a string, or a list like `(:background \"Red\")'.
  1684. If it is a color, the variable `org-faces-easy-properties'
  1685. determines if it is a foreground or a background color."
  1686. :group 'org-agenda-line-format
  1687. :type '(choice
  1688. (const :tag "Never" nil)
  1689. (const :tag "Defaults" t)
  1690. (const :tag "Cookies only" cookies)
  1691. (repeat :tag "Specify"
  1692. (list (character :tag "Priority" :value ?A)
  1693. (choice :tag "Face "
  1694. (string :tag "Color")
  1695. (sexp :tag "Face"))))))
  1696. (defcustom org-agenda-day-face-function nil
  1697. "Function called to determine what face should be used to display a day.
  1698. The only argument passed to that function is the day. It should
  1699. returns a face, or nil if does not want to specify a face and let
  1700. the normal rules apply."
  1701. :group 'org-agenda-line-format
  1702. :version "24.1"
  1703. :type '(choice (const nil) (function)))
  1704. (defcustom org-agenda-category-icon-alist nil
  1705. "Alist of category icon to be displayed in agenda views.
  1706. Each entry should have the following format:
  1707. (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
  1708. Where CATEGORY-REGEXP is a regexp matching the categories where
  1709. the icon should be displayed.
  1710. FILE-OR-DATA either a file path or a string containing image data.
  1711. The other fields can be omitted safely if not needed:
  1712. TYPE indicates the image type.
  1713. DATA-P is a boolean indicating whether the FILE-OR-DATA string is
  1714. image data.
  1715. PROPS are additional image attributes to assign to the image,
  1716. like, e.g. `:ascent center'.
  1717. (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
  1718. If you want to set the display properties yourself, just put a
  1719. list as second element:
  1720. (CATEGORY-REGEXP (MY PROPERTY LIST))
  1721. For example, to display a 16px horizontal space for Emacs
  1722. category, you can use:
  1723. (\"Emacs\" \\='(space . (:width (16))))"
  1724. :group 'org-agenda-line-format
  1725. :version "24.1"
  1726. :type '(alist :key-type (string :tag "Regexp matching category")
  1727. :value-type (choice (list :tag "Icon"
  1728. (string :tag "File or data")
  1729. (symbol :tag "Type")
  1730. (boolean :tag "Data?")
  1731. (repeat :tag "Extra image properties" :inline t symbol))
  1732. (list :tag "Display properties" sexp))))
  1733. (defgroup org-agenda-column-view nil
  1734. "Options concerning column view in the agenda."
  1735. :tag "Org Agenda Column View"
  1736. :group 'org-agenda)
  1737. (defcustom org-agenda-view-columns-initially nil
  1738. "When non-nil, switch to columns view right after creating the agenda."
  1739. :group 'org-agenda-column-view
  1740. :type 'boolean
  1741. :version "26.1"
  1742. :package-version '(Org . "9.0")
  1743. :safe #'booleanp)
  1744. (defcustom org-agenda-columns-show-summaries t
  1745. "Non-nil means show summaries for columns displayed in the agenda view."
  1746. :group 'org-agenda-column-view
  1747. :type 'boolean)
  1748. (defcustom org-agenda-columns-compute-summary-properties t
  1749. "Non-nil means recompute all summary properties before column view.
  1750. When column view in the agenda is listing properties that have a summary
  1751. operator, it can go to all relevant buffers and recompute the summaries
  1752. there. This can mean overhead for the agenda column view, but is necessary
  1753. to have thing up to date.
  1754. As a special case, a CLOCKSUM property also makes sure that the clock
  1755. computations are current."
  1756. :group 'org-agenda-column-view
  1757. :type 'boolean)
  1758. (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
  1759. "Non-nil means the duration of an appointment will add to day effort.
  1760. The property to which appointment durations will be added is the one given
  1761. in the option `org-effort-property'. If an appointment does not have
  1762. an end time, `org-agenda-default-appointment-duration' will be used. If that
  1763. is not set, an appointment without end time will not contribute to the time
  1764. estimate."
  1765. :group 'org-agenda-column-view
  1766. :type 'boolean)
  1767. (defcustom org-agenda-auto-exclude-function nil
  1768. "A function called with a tag to decide if it is filtered on \
  1769. \\<org-agenda-mode-map>`\\[org-agenda-filter-by-tag] RET'.
  1770. The sole argument to the function, which is called once for each
  1771. possible tag, is a string giving the name of the tag. The
  1772. function should return either nil if the tag should be included
  1773. as normal, or \"-<TAG>\" to exclude the tag.
  1774. Note that for the purpose of tag filtering, only the lower-case version of
  1775. all tags will be considered, so that this function will only ever see
  1776. the lower-case version of all tags."
  1777. :group 'org-agenda
  1778. :type '(choice (const nil) (function)))
  1779. (defcustom org-agenda-bulk-custom-functions nil
  1780. "Alist of characters and custom functions for bulk actions.
  1781. For example, this value makes those two functions available:
  1782. \\='((?R set-category)
  1783. (?C bulk-cut))
  1784. With selected entries in an agenda buffer, `B R' will call
  1785. the custom function `set-category' on the selected entries.
  1786. Note that functions in this alist don't need to be quoted."
  1787. :type '(alist :key-type character :value-type (group function))
  1788. :version "24.1"
  1789. :group 'org-agenda)
  1790. (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
  1791. "Execute BODY with point at location given by `org-hd-marker' property.
  1792. If STRING is non-nil, the text property will be fetched from position 0
  1793. in that string. If STRING is nil, it will be fetched from the beginning
  1794. of the current line."
  1795. (org-with-gensyms (marker)
  1796. `(let ((,marker (get-text-property (if ,string 0 (point-at-bol))
  1797. 'org-hd-marker ,string)))
  1798. (with-current-buffer (marker-buffer ,marker)
  1799. (save-excursion
  1800. (goto-char ,marker)
  1801. ,@body)))))
  1802. (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
  1803. (defun org-add-agenda-custom-command (entry)
  1804. "Replace or add a command in `org-agenda-custom-commands'.
  1805. This is mostly for hacking and trying a new command - once the command
  1806. works you probably want to add it to `org-agenda-custom-commands' for good."
  1807. (let ((ass (assoc (car entry) org-agenda-custom-commands)))
  1808. (if ass
  1809. (setcdr ass (cdr entry))
  1810. (push entry org-agenda-custom-commands))))
  1811. (defmacro org-agenda--insert-overriding-header (default)
  1812. "Insert header into agenda view.
  1813. The inserted header depends on `org-agenda-overriding-header'.
  1814. If the empty string, don't insert a header. If any other string,
  1815. insert it as a header. If nil, insert DEFAULT, which should
  1816. evaluate to a string."
  1817. (declare (debug (form)) (indent defun))
  1818. `(cond
  1819. ((not org-agenda-overriding-header) (insert ,default))
  1820. ((equal org-agenda-overriding-header "") nil)
  1821. ((stringp org-agenda-overriding-header)
  1822. (insert (propertize org-agenda-overriding-header
  1823. 'face 'org-agenda-structure)
  1824. "\n"))
  1825. (t (user-error "Invalid value for `org-agenda-overriding-header': %S"
  1826. org-agenda-overriding-header))))
  1827. ;;; Define the org-agenda-mode
  1828. (defvaralias 'org-agenda-keymap 'org-agenda-mode-map)
  1829. (defvar org-agenda-mode-map (make-sparse-keymap)
  1830. "Keymap for `org-agenda-mode'.")
  1831. (defvar org-agenda-menu) ; defined later in this file.
  1832. (defvar org-agenda-restrict nil) ; defined later in this file.
  1833. (defvar org-agenda-follow-mode nil)
  1834. (defvar org-agenda-entry-text-mode nil)
  1835. (defvar org-agenda-clockreport-mode nil)
  1836. (defvar org-agenda-show-log nil
  1837. "When non-nil, show the log in the agenda.
  1838. Do not set this directly; instead use
  1839. `org-agenda-start-with-log-mode', which see.")
  1840. (defvar org-agenda-redo-command nil)
  1841. (defvar org-agenda-query-string nil)
  1842. (defvar org-agenda-mode-hook nil
  1843. "Hook run after `org-agenda-mode' is turned on.
  1844. The buffer is still writable when this hook is called.")
  1845. (defvar org-agenda-type nil)
  1846. (defvar org-agenda-force-single-file nil)
  1847. (defvar org-agenda-bulk-marked-entries nil
  1848. "List of markers that refer to marked entries in the agenda.")
  1849. (defvar org-agenda-current-date nil
  1850. "Active date when building the agenda.")
  1851. ;;; Multiple agenda buffers support
  1852. (defcustom org-agenda-sticky nil
  1853. "Non-nil means agenda q key will bury agenda buffers.
  1854. Agenda commands will then show existing buffer instead of generating new ones.
  1855. When nil, `q' will kill the single agenda buffer."
  1856. :group 'org-agenda
  1857. :version "24.3"
  1858. :type 'boolean)
  1859. ;;;###autoload
  1860. (defun org-toggle-sticky-agenda (&optional arg)
  1861. "Toggle `org-agenda-sticky'."
  1862. (interactive "P")
  1863. (let ((new-value (if arg
  1864. (> (prefix-numeric-value arg) 0)
  1865. (not org-agenda-sticky))))
  1866. (if (equal new-value org-agenda-sticky)
  1867. (and (called-interactively-p 'interactive)
  1868. (message "Sticky agenda was already %s"
  1869. (if org-agenda-sticky "enabled" "disabled")))
  1870. (setq org-agenda-sticky new-value)
  1871. (org-agenda-kill-all-agenda-buffers)
  1872. (and (called-interactively-p 'interactive)
  1873. (message "Sticky agenda %s"
  1874. (if org-agenda-sticky "enabled" "disabled"))))))
  1875. (defvar org-agenda-buffer nil
  1876. "Agenda buffer currently being generated.")
  1877. (defvar org-agenda-last-prefix-arg nil)
  1878. (defvar org-agenda-this-buffer-name nil)
  1879. (defvar org-agenda-doing-sticky-redo nil)
  1880. (defvar org-agenda-this-buffer-is-sticky nil)
  1881. (defvar org-agenda-last-indirect-buffer nil
  1882. "Last buffer loaded by `org-agenda-tree-to-indirect-buffer'.")
  1883. (defconst org-agenda-local-vars
  1884. '(org-agenda-this-buffer-name
  1885. org-agenda-undo-list
  1886. org-agenda-pending-undo-list
  1887. org-agenda-follow-mode
  1888. org-agenda-entry-text-mode
  1889. org-agenda-clockreport-mode
  1890. org-agenda-show-log
  1891. org-agenda-redo-command
  1892. org-agenda-query-string
  1893. org-agenda-type
  1894. org-agenda-bulk-marked-entries
  1895. org-agenda-undo-has-started-in
  1896. org-agenda-info
  1897. org-agenda-pre-window-conf
  1898. org-agenda-columns-active
  1899. org-agenda-tag-filter
  1900. org-agenda-category-filter
  1901. org-agenda-top-headline-filter
  1902. org-agenda-regexp-filter
  1903. org-agenda-effort-filter
  1904. org-agenda-markers
  1905. org-agenda-last-search-view-search-was-boolean
  1906. org-agenda-last-indirect-buffer
  1907. org-agenda-filtered-by-category
  1908. org-agenda-filter-form
  1909. org-agenda-cycle-counter
  1910. org-agenda-last-prefix-arg)
  1911. "Variables that must be local in agenda buffers to allow multiple buffers.")
  1912. (defun org-agenda-mode ()
  1913. "Mode for time-sorted view on action items in Org files.
  1914. The following commands are available:
  1915. \\{org-agenda-mode-map}"
  1916. (interactive)
  1917. (let ((agenda-local-vars-to-keep
  1918. '(text-scale-mode-amount
  1919. text-scale-mode
  1920. text-scale-mode-lighter
  1921. face-remapping-alist))
  1922. (save (buffer-local-variables)))
  1923. (kill-all-local-variables)
  1924. (cl-flet ((reset-saved (var-set)
  1925. "Reset variables in VAR-SET to possibly stored value in SAVE."
  1926. (dolist (elem save)
  1927. (pcase elem
  1928. (`(,var . ,val) ;ignore unbound variables
  1929. (when (and val (memq var var-set))
  1930. (set var val)))))))
  1931. (cond (org-agenda-doing-sticky-redo
  1932. ;; Refreshing sticky agenda-buffer
  1933. ;;
  1934. ;; Preserve the value of `org-agenda-local-vars' variables.
  1935. (mapc #'make-local-variable org-agenda-local-vars)
  1936. (reset-saved org-agenda-local-vars)
  1937. (setq-local org-agenda-this-buffer-is-sticky t))
  1938. (org-agenda-sticky
  1939. ;; Creating a sticky Agenda buffer for the first time
  1940. (mapc 'make-local-variable org-agenda-local-vars)
  1941. (setq-local org-agenda-this-buffer-is-sticky t))
  1942. (t
  1943. ;; Creating a non-sticky agenda buffer
  1944. (setq-local org-agenda-this-buffer-is-sticky nil)))
  1945. (mapc #'make-local-variable agenda-local-vars-to-keep)
  1946. (reset-saved agenda-local-vars-to-keep)))
  1947. (setq org-agenda-undo-list nil
  1948. org-agenda-pending-undo-list nil
  1949. org-agenda-bulk-marked-entries nil)
  1950. (setq major-mode 'org-agenda-mode)
  1951. ;; Keep global-font-lock-mode from turning on font-lock-mode
  1952. (setq-local font-lock-global-modes (list 'not major-mode))
  1953. (setq mode-name "Org-Agenda")
  1954. (setq indent-tabs-mode nil)
  1955. (use-local-map org-agenda-mode-map)
  1956. (easy-menu-add org-agenda-menu)
  1957. (when org-startup-truncated (setq truncate-lines t))
  1958. (setq-local line-move-visual nil)
  1959. (add-hook 'post-command-hook 'org-agenda-update-agenda-type nil 'local)
  1960. (add-hook 'pre-command-hook 'org-unhighlight nil 'local)
  1961. ;; Make sure properties are removed when copying text
  1962. (if (boundp 'filter-buffer-substring-functions)
  1963. (add-hook 'filter-buffer-substring-functions
  1964. (lambda (fun start end delete)
  1965. (substring-no-properties (funcall fun start end delete)))
  1966. nil t)
  1967. ;; Emacs >= 24.4.
  1968. (add-function :filter-return (local 'filter-buffer-substring-function)
  1969. #'substring-no-properties))
  1970. (unless org-agenda-keep-modes
  1971. (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
  1972. org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
  1973. org-agenda-show-log org-agenda-start-with-log-mode
  1974. org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode))
  1975. (add-to-invisibility-spec '(org-filtered))
  1976. (add-to-invisibility-spec '(org-link))
  1977. (easy-menu-change
  1978. '("Agenda") "Agenda Files"
  1979. (append
  1980. (list
  1981. (vector
  1982. (if (get 'org-agenda-files 'org-restrict)
  1983. "Restricted to single file"
  1984. "Edit File List")
  1985. '(org-edit-agenda-file-list)
  1986. (not (get 'org-agenda-files 'org-restrict)))
  1987. "--")
  1988. (mapcar 'org-file-menu-entry (org-agenda-files))))
  1989. (org-agenda-set-mode-name)
  1990. (apply
  1991. (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
  1992. (list 'org-agenda-mode-hook)))
  1993. (substitute-key-definition 'undo 'org-agenda-undo
  1994. org-agenda-mode-map global-map)
  1995. (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
  1996. (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
  1997. (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
  1998. (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
  1999. (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
  2000. (org-defkey org-agenda-mode-map [(meta down)] 'org-agenda-drag-line-forward)
  2001. (org-defkey org-agenda-mode-map [(meta up)] 'org-agenda-drag-line-backward)
  2002. (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
  2003. (org-defkey org-agenda-mode-map "\M-m" 'org-agenda-bulk-toggle)
  2004. (org-defkey org-agenda-mode-map "*" 'org-agenda-bulk-mark-all)
  2005. (org-defkey org-agenda-mode-map "\M-*" 'org-agenda-bulk-toggle-all)
  2006. (org-defkey org-agenda-mode-map "#" 'org-agenda-dim-blocked-tasks)
  2007. (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
  2008. (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
  2009. (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-unmark-all)
  2010. (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
  2011. (org-defkey org-agenda-mode-map "k" 'org-agenda-capture)
  2012. (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
  2013. (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
  2014. (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
  2015. (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
  2016. (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
  2017. (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
  2018. (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
  2019. (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
  2020. (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
  2021. (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
  2022. (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
  2023. (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
  2024. (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
  2025. (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
  2026. (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
  2027. (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
  2028. (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
  2029. (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
  2030. (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
  2031. (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
  2032. (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
  2033. (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
  2034. (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
  2035. (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
  2036. (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
  2037. (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
  2038. (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
  2039. (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
  2040. (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
  2041. (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
  2042. (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
  2043. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
  2044. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
  2045. (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
  2046. (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
  2047. (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
  2048. (let ((l '(1 2 3 4 5 6 7 8 9 0)))
  2049. (while l (org-defkey org-agenda-mode-map
  2050. (int-to-string (pop l)) 'digit-argument)))
  2051. (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
  2052. (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
  2053. (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
  2054. (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
  2055. (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
  2056. (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
  2057. (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
  2058. (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
  2059. (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
  2060. (org-defkey org-agenda-mode-map "g" 'org-agenda-redo-all)
  2061. (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
  2062. (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
  2063. (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
  2064. 'org-clock-modify-effort-estimate)
  2065. (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
  2066. (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
  2067. (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
  2068. (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
  2069. (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
  2070. (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
  2071. (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
  2072. (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
  2073. (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
  2074. (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
  2075. (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
  2076. (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
  2077. (substitute-key-definition 'next-line 'org-agenda-next-line
  2078. org-agenda-mode-map global-map)
  2079. (substitute-key-definition 'previous-line 'org-agenda-previous-line
  2080. org-agenda-mode-map global-map)
  2081. (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
  2082. (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
  2083. (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
  2084. (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
  2085. (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
  2086. (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
  2087. (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
  2088. (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
  2089. (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
  2090. (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
  2091. (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
  2092. (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
  2093. (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
  2094. (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
  2095. (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
  2096. (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
  2097. (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
  2098. (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
  2099. (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  2100. (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
  2101. (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
  2102. (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
  2103. (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
  2104. (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
  2105. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
  2106. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
  2107. (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
  2108. (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
  2109. (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
  2110. (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  2111. (org-defkey org-agenda-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock-from-agenda)
  2112. (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
  2113. (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
  2114. (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
  2115. (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
  2116. (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
  2117. (org-defkey org-agenda-mode-map "_" 'org-agenda-filter-by-effort)
  2118. (org-defkey org-agenda-mode-map "=" 'org-agenda-filter-by-regexp)
  2119. (org-defkey org-agenda-mode-map "|" 'org-agenda-filter-remove-all)
  2120. (org-defkey org-agenda-mode-map "~" 'org-agenda-limit-interactively)
  2121. (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
  2122. (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-headline)
  2123. (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
  2124. (org-defkey org-agenda-mode-map "\C-c\C-x_" 'org-timer-stop)
  2125. (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
  2126. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  2127. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  2128. (org-defkey org-agenda-mode-map "\C-c\C-xI" 'org-info-find-node)
  2129. (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
  2130. (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
  2131. (define-key org-agenda-mode-map [remap forward-paragraph] 'org-agenda-forward-block)
  2132. (define-key org-agenda-mode-map [remap backward-paragraph] 'org-agenda-backward-block)
  2133. (when org-agenda-mouse-1-follows-link
  2134. (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
  2135. (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
  2136. '("Agenda"
  2137. ("Agenda Files")
  2138. "--"
  2139. ("Agenda Dates"
  2140. ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda)]
  2141. ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
  2142. ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
  2143. ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
  2144. "--"
  2145. ("View"
  2146. ["Day View" org-agenda-day-view
  2147. :active (org-agenda-check-type nil 'agenda)
  2148. :style radio :selected (eq org-agenda-current-span 'day)
  2149. :keys "v d (or just d)"]
  2150. ["Week View" org-agenda-week-view
  2151. :active (org-agenda-check-type nil 'agenda)
  2152. :style radio :selected (eq org-agenda-current-span 'week)
  2153. :keys "v w"]
  2154. ["Fortnight View" org-agenda-fortnight-view
  2155. :active (org-agenda-check-type nil 'agenda)
  2156. :style radio :selected (eq org-agenda-current-span 'fortnight)
  2157. :keys "v t"]
  2158. ["Month View" org-agenda-month-view
  2159. :active (org-agenda-check-type nil 'agenda)
  2160. :style radio :selected (eq org-agenda-current-span 'month)
  2161. :keys "v m"]
  2162. ["Year View" org-agenda-year-view
  2163. :active (org-agenda-check-type nil 'agenda)
  2164. :style radio :selected (eq org-agenda-current-span 'year)
  2165. :keys "v y"]
  2166. "--"
  2167. ["Include Diary" org-agenda-toggle-diary
  2168. :style toggle :selected org-agenda-include-diary
  2169. :active (org-agenda-check-type nil 'agenda)]
  2170. ["Include Deadlines" org-agenda-toggle-deadlines
  2171. :style toggle :selected org-agenda-include-deadlines
  2172. :active (org-agenda-check-type nil 'agenda)]
  2173. ["Use Time Grid" org-agenda-toggle-time-grid
  2174. :style toggle :selected org-agenda-use-time-grid
  2175. :active (org-agenda-check-type nil 'agenda)]
  2176. "--"
  2177. ["Show clock report" org-agenda-clockreport-mode
  2178. :style toggle :selected org-agenda-clockreport-mode
  2179. :active (org-agenda-check-type nil 'agenda)]
  2180. ["Show some entry text" org-agenda-entry-text-mode
  2181. :style toggle :selected org-agenda-entry-text-mode
  2182. :active t]
  2183. "--"
  2184. ["Show Logbook entries" org-agenda-log-mode
  2185. :style toggle :selected org-agenda-show-log
  2186. :active (org-agenda-check-type nil 'agenda)
  2187. :keys "v l (or just l)"]
  2188. ["Include archived trees" org-agenda-archives-mode
  2189. :style toggle :selected org-agenda-archives-mode :active t
  2190. :keys "v a"]
  2191. ["Include archive files" (org-agenda-archives-mode t)
  2192. :style toggle :selected (eq org-agenda-archives-mode t) :active t
  2193. :keys "v A"]
  2194. "--"
  2195. ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
  2196. ["Write view to file" org-agenda-write t]
  2197. ["Rebuild buffer" org-agenda-redo t]
  2198. ["Save all Org buffers" org-save-all-org-buffers t]
  2199. "--"
  2200. ["Show original entry" org-agenda-show t]
  2201. ["Go To (other window)" org-agenda-goto t]
  2202. ["Go To (this window)" org-agenda-switch-to t]
  2203. ["Capture with cursor date" org-agenda-capture t]
  2204. ["Follow Mode" org-agenda-follow-mode
  2205. :style toggle :selected org-agenda-follow-mode :active t]
  2206. ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
  2207. "--"
  2208. ("TODO"
  2209. ["Cycle TODO" org-agenda-todo t]
  2210. ["Next TODO set" org-agenda-todo-nextset t]
  2211. ["Previous TODO set" org-agenda-todo-previousset t]
  2212. ["Add note" org-agenda-add-note t])
  2213. ("Archive/Refile/Delete"
  2214. ["Archive default" org-agenda-archive-default t]
  2215. ["Archive default" org-agenda-archive-default-with-confirmation t]
  2216. ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
  2217. ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
  2218. ["Archive subtree" org-agenda-archive t]
  2219. "--"
  2220. ["Refile" org-agenda-refile t]
  2221. "--"
  2222. ["Delete subtree" org-agenda-kill t])
  2223. ("Bulk action"
  2224. ["Mark entry" org-agenda-bulk-mark t]
  2225. ["Mark all" org-agenda-bulk-mark-all t]
  2226. ["Unmark entry" org-agenda-bulk-unmark t]
  2227. ["Unmark all" org-agenda-bulk-unmark-all :active t :keys "U"]
  2228. ["Toggle mark" org-agenda-bulk-toggle t]
  2229. ["Toggle all" org-agenda-bulk-toggle-all t]
  2230. ["Mark regexp" org-agenda-bulk-mark-regexp t])
  2231. ["Act on all marked" org-agenda-bulk-action t]
  2232. "--"
  2233. ("Tags and Properties"
  2234. ["Show all Tags" org-agenda-show-tags t]
  2235. ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
  2236. ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
  2237. "--"
  2238. ["Column View" org-columns t])
  2239. ("Deadline/Schedule"
  2240. ["Schedule" org-agenda-schedule t]
  2241. ["Set Deadline" org-agenda-deadline t]
  2242. "--"
  2243. ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda)]
  2244. ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda)]
  2245. ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda) :keys "C-u S-right"]
  2246. ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda) :keys "C-u S-left"]
  2247. ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda) :keys "C-u C-u S-right"]
  2248. ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda) :keys "C-u C-u S-left"]
  2249. ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda)])
  2250. ("Clock and Effort"
  2251. ["Clock in" org-agenda-clock-in t]
  2252. ["Clock out" org-agenda-clock-out t]
  2253. ["Clock cancel" org-agenda-clock-cancel t]
  2254. ["Goto running clock" org-clock-goto t]
  2255. "--"
  2256. ["Set Effort" org-agenda-set-effort t]
  2257. ["Change clocked effort" org-clock-modify-effort-estimate
  2258. (org-clock-is-active)])
  2259. ("Priority"
  2260. ["Set Priority" org-agenda-priority t]
  2261. ["Increase Priority" org-agenda-priority-up t]
  2262. ["Decrease Priority" org-agenda-priority-down t]
  2263. ["Show Priority" org-show-priority t])
  2264. ("Calendar/Diary"
  2265. ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda)]
  2266. ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda)]
  2267. ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda)]
  2268. ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda)]
  2269. ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda)]
  2270. ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda)]
  2271. "--"
  2272. ["Create iCalendar File" org-icalendar-combine-agenda-files t])
  2273. "--"
  2274. ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
  2275. "--"
  2276. ("MobileOrg"
  2277. ["Push Files and Views" org-mobile-push t]
  2278. ["Get Captured and Flagged" org-mobile-pull t]
  2279. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "\\[org-agenda] ?"]
  2280. ["Show note / unflag" org-agenda-show-the-flagging-note t]
  2281. "--"
  2282. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  2283. "--"
  2284. ["Quit" org-agenda-quit t]
  2285. ["Exit and Release Buffers" org-agenda-exit t]
  2286. ))
  2287. ;;; Agenda undo
  2288. (defvar org-agenda-allow-remote-undo t
  2289. "Non-nil means allow remote undo from the agenda buffer.")
  2290. (defvar org-agenda-undo-has-started-in nil
  2291. "Buffers that have already seen `undo-start' in the current undo sequence.")
  2292. (defun org-agenda-undo ()
  2293. "Undo a remote editing step in the agenda.
  2294. This undoes changes both in the agenda buffer and in the remote buffer
  2295. that have been changed along."
  2296. (interactive)
  2297. (or org-agenda-allow-remote-undo
  2298. (user-error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
  2299. (when (not (eq this-command last-command))
  2300. (setq org-agenda-undo-has-started-in nil
  2301. org-agenda-pending-undo-list org-agenda-undo-list))
  2302. (when (not org-agenda-pending-undo-list)
  2303. (user-error "No further undo information"))
  2304. (let* ((entry (pop org-agenda-pending-undo-list))
  2305. buf line cmd rembuf)
  2306. (setq cmd (pop entry) line (pop entry))
  2307. (setq rembuf (nth 2 entry))
  2308. (org-with-remote-undo rembuf
  2309. (while (bufferp (setq buf (pop entry)))
  2310. (when (pop entry)
  2311. (with-current-buffer buf
  2312. (let ((last-undo-buffer buf)
  2313. (inhibit-read-only t))
  2314. (unless (memq buf org-agenda-undo-has-started-in)
  2315. (push buf org-agenda-undo-has-started-in)
  2316. (make-local-variable 'pending-undo-list)
  2317. (undo-start))
  2318. (while (and pending-undo-list
  2319. (listp pending-undo-list)
  2320. (not (car pending-undo-list)))
  2321. (pop pending-undo-list))
  2322. (undo-more 1))))))
  2323. (org-goto-line line)
  2324. (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
  2325. (defun org-verify-change-for-undo (l1 l2)
  2326. "Verify that a real change occurred between the undo lists L1 and L2."
  2327. (while (and l1 (listp l1) (null (car l1))) (pop l1))
  2328. (while (and l2 (listp l2) (null (car l2))) (pop l2))
  2329. (not (eq l1 l2)))
  2330. ;;; Agenda dispatch
  2331. (defvar org-agenda-restrict-begin (make-marker))
  2332. (defvar org-agenda-restrict-end (make-marker))
  2333. (defvar org-agenda-last-dispatch-buffer nil)
  2334. (defvar org-agenda-overriding-restriction nil)
  2335. (defcustom org-agenda-custom-commands-contexts nil
  2336. "Alist of custom agenda keys and contextual rules.
  2337. For example, if you have a custom agenda command \"p\" and you
  2338. want this command to be accessible only from plain text files,
  2339. use this:
  2340. \\='((\"p\" ((in-file . \"\\\\.txt\\\\'\"))))
  2341. Here are the available contexts definitions:
  2342. in-file: command displayed only in matching files
  2343. in-mode: command displayed only in matching modes
  2344. not-in-file: command not displayed in matching files
  2345. not-in-mode: command not displayed in matching modes
  2346. in-buffer: command displayed only in matching buffers
  2347. not-in-buffer: command not displayed in matching buffers
  2348. [function]: a custom function taking no argument
  2349. If you define several checks, the agenda command will be
  2350. accessible if there is at least one valid check.
  2351. You can also bind a key to another agenda custom command
  2352. depending on contextual rules.
  2353. \\='((\"p\" \"q\" ((in-file . \"\\\\.txt\\\\'\"))))
  2354. Here it means: in .txt files, use \"p\" as the key for the
  2355. agenda command otherwise associated with \"q\". (The command
  2356. originally associated with \"q\" is not displayed to avoid
  2357. duplicates.)"
  2358. :version "24.3"
  2359. :group 'org-agenda-custom-commands
  2360. :type '(repeat (list :tag "Rule"
  2361. (string :tag " Agenda key")
  2362. (string :tag "Replace by command")
  2363. (repeat :tag "Available when"
  2364. (choice
  2365. (cons :tag "Condition"
  2366. (choice
  2367. (const :tag "In file" in-file)
  2368. (const :tag "Not in file" not-in-file)
  2369. (const :tag "In buffer" in-buffer)
  2370. (const :tag "Not in buffer" not-in-buffer)
  2371. (const :tag "In mode" in-mode)
  2372. (const :tag "Not in mode" not-in-mode))
  2373. (regexp))
  2374. (function :tag "Custom function"))))))
  2375. (defcustom org-agenda-max-entries nil
  2376. "Maximum number of entries to display in an agenda.
  2377. This can be nil (no limit) or an integer or an alist of agenda
  2378. types with an associated number of entries to display in this
  2379. type."
  2380. :version "24.4"
  2381. :package-version '(Org . "8.0")
  2382. :group 'org-agenda-custom-commands
  2383. :type '(choice (symbol :tag "No limit" nil)
  2384. (integer :tag "Max number of entries")
  2385. (repeat
  2386. (cons (choice :tag "Agenda type"
  2387. (const agenda)
  2388. (const todo)
  2389. (const tags)
  2390. (const search))
  2391. (integer :tag "Max number of entries")))))
  2392. (defcustom org-agenda-max-todos nil
  2393. "Maximum number of TODOs to display in an agenda.
  2394. This can be nil (no limit) or an integer or an alist of agenda
  2395. types with an associated number of entries to display in this
  2396. type."
  2397. :version "24.4"
  2398. :package-version '(Org . "8.0")
  2399. :group 'org-agenda-custom-commands
  2400. :type '(choice (symbol :tag "No limit" nil)
  2401. (integer :tag "Max number of TODOs")
  2402. (repeat
  2403. (cons (choice :tag "Agenda type"
  2404. (const agenda)
  2405. (const todo)
  2406. (const tags)
  2407. (const search))
  2408. (integer :tag "Max number of TODOs")))))
  2409. (defcustom org-agenda-max-tags nil
  2410. "Maximum number of tagged entries to display in an agenda.
  2411. This can be nil (no limit) or an integer or an alist of agenda
  2412. types with an associated number of entries to display in this
  2413. type."
  2414. :version "24.4"
  2415. :package-version '(Org . "8.0")
  2416. :group 'org-agenda-custom-commands
  2417. :type '(choice (symbol :tag "No limit" nil)
  2418. (integer :tag "Max number of tagged entries")
  2419. (repeat
  2420. (cons (choice :tag "Agenda type"
  2421. (const agenda)
  2422. (const todo)
  2423. (const tags)
  2424. (const search))
  2425. (integer :tag "Max number of tagged entries")))))
  2426. (defcustom org-agenda-max-effort nil
  2427. "Maximum cumulated effort duration for the agenda.
  2428. This can be nil (no limit) or a number of minutes (as an integer)
  2429. or an alist of agenda types with an associated number of minutes
  2430. to limit entries to in this type."
  2431. :version "24.4"
  2432. :package-version '(Org . "8.0")
  2433. :group 'org-agenda-custom-commands
  2434. :type '(choice (symbol :tag "No limit" nil)
  2435. (integer :tag "Max number of minutes")
  2436. (repeat
  2437. (cons (choice :tag "Agenda type"
  2438. (const agenda)
  2439. (const todo)
  2440. (const tags)
  2441. (const search))
  2442. (integer :tag "Max number of minutes")))))
  2443. (defvar org-agenda-keep-restricted-file-list nil)
  2444. (defvar org-keys nil)
  2445. (defvar org-match nil)
  2446. ;;;###autoload
  2447. (defun org-agenda (&optional arg org-keys restriction)
  2448. "Dispatch agenda commands to collect entries to the agenda buffer.
  2449. Prompts for a command to execute. Any prefix arg will be passed
  2450. on to the selected command. The default selections are:
  2451. a Call `org-agenda-list' to display the agenda for current day or week.
  2452. t Call `org-todo-list' to display the global todo list.
  2453. T Call `org-todo-list' to display the global todo list, select only
  2454. entries with a specific TODO keyword (the user gets a prompt).
  2455. m Call `org-tags-view' to display headlines with tags matching
  2456. a condition (the user is prompted for the condition).
  2457. M Like `m', but select only TODO entries, no ordinary headlines.
  2458. e Export views to associated files.
  2459. s Search entries for keywords.
  2460. S Search entries for keywords, only with TODO keywords.
  2461. / Multi occur across all agenda files and also files listed
  2462. in `org-agenda-text-search-extra-files'.
  2463. < Restrict agenda commands to buffer, subtree, or region.
  2464. Press several times to get the desired effect.
  2465. > Remove a previous restriction.
  2466. # List \"stuck\" projects.
  2467. ! Configure what \"stuck\" means.
  2468. C Configure custom agenda commands.
  2469. More commands can be added by configuring the variable
  2470. `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
  2471. searches can be pre-defined in this way.
  2472. If the current buffer is in Org mode and visiting a file, you can also
  2473. first press `<' once to indicate that the agenda should be temporarily
  2474. \(until the next use of `\\[org-agenda]') restricted to the current file.
  2475. Pressing `<' twice means to restrict to the current subtree or region
  2476. \(if active)."
  2477. (interactive "P")
  2478. (catch 'exit
  2479. (let* ((prefix-descriptions nil)
  2480. (org-agenda-buffer-name org-agenda-buffer-name)
  2481. (org-agenda-window-setup (if (equal (buffer-name)
  2482. org-agenda-buffer-name)
  2483. 'current-window
  2484. org-agenda-window-setup))
  2485. (org-agenda-custom-commands-orig org-agenda-custom-commands)
  2486. (org-agenda-custom-commands
  2487. ;; normalize different versions
  2488. (delq nil
  2489. (mapcar
  2490. (lambda (x)
  2491. (cond ((stringp (cdr x))
  2492. (push x prefix-descriptions)
  2493. nil)
  2494. ((stringp (nth 1 x)) x)
  2495. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2496. (t (cons (car x) (cons "" (cdr x))))))
  2497. org-agenda-custom-commands)))
  2498. (org-agenda-custom-commands
  2499. (org-contextualize-keys
  2500. org-agenda-custom-commands org-agenda-custom-commands-contexts))
  2501. (buf (current-buffer))
  2502. (bfn (buffer-file-name (buffer-base-buffer)))
  2503. entry key type org-match lprops ans)
  2504. ;; Turn off restriction unless there is an overriding one,
  2505. (unless org-agenda-overriding-restriction
  2506. (unless org-agenda-keep-restricted-file-list
  2507. ;; There is a request to keep the file list in place
  2508. (put 'org-agenda-files 'org-restrict nil))
  2509. (setq org-agenda-restrict nil)
  2510. (move-marker org-agenda-restrict-begin nil)
  2511. (move-marker org-agenda-restrict-end nil))
  2512. ;; Delete old local properties
  2513. (put 'org-agenda-redo-command 'org-lprops nil)
  2514. ;; Delete previously set last-arguments
  2515. (put 'org-agenda-redo-command 'last-args nil)
  2516. ;; Remember where this call originated
  2517. (setq org-agenda-last-dispatch-buffer (current-buffer))
  2518. (unless org-keys
  2519. (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
  2520. org-keys (car ans)
  2521. restriction (cdr ans)))
  2522. ;; If we have sticky agenda buffers, set a name for the buffer,
  2523. ;; depending on the invoking keys. The user may still set this
  2524. ;; as a command option, which will overwrite what we do here.
  2525. (when org-agenda-sticky
  2526. (setq org-agenda-buffer-name
  2527. (format "*Org Agenda(%s)*" org-keys)))
  2528. ;; Establish the restriction, if any
  2529. (when (and (not org-agenda-overriding-restriction) restriction)
  2530. (put 'org-agenda-files 'org-restrict (list bfn))
  2531. (cond
  2532. ((eq restriction 'region)
  2533. (setq org-agenda-restrict (current-buffer))
  2534. (move-marker org-agenda-restrict-begin (region-beginning))
  2535. (move-marker org-agenda-restrict-end (region-end)))
  2536. ((eq restriction 'subtree)
  2537. (save-excursion
  2538. (setq org-agenda-restrict (current-buffer))
  2539. (org-back-to-heading t)
  2540. (move-marker org-agenda-restrict-begin (point))
  2541. (move-marker org-agenda-restrict-end
  2542. (progn (org-end-of-subtree t)))))))
  2543. ;; For example the todo list should not need it (but does...)
  2544. (cond
  2545. ((setq entry (assoc org-keys org-agenda-custom-commands))
  2546. (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
  2547. (progn
  2548. (setq type (nth 2 entry) org-match (eval (nth 3 entry))
  2549. lprops (nth 4 entry))
  2550. (when org-agenda-sticky
  2551. (setq org-agenda-buffer-name
  2552. (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
  2553. (format "*Org Agenda(%s)*" org-keys))))
  2554. (put 'org-agenda-redo-command 'org-lprops lprops)
  2555. (cond
  2556. ((eq type 'agenda)
  2557. (org-let lprops '(org-agenda-list current-prefix-arg)))
  2558. ((eq type 'agenda*)
  2559. (org-let lprops '(org-agenda-list current-prefix-arg nil nil t)))
  2560. ((eq type 'alltodo)
  2561. (org-let lprops '(org-todo-list current-prefix-arg)))
  2562. ((eq type 'search)
  2563. (org-let lprops '(org-search-view current-prefix-arg org-match nil)))
  2564. ((eq type 'stuck)
  2565. (org-let lprops '(org-agenda-list-stuck-projects
  2566. current-prefix-arg)))
  2567. ((eq type 'tags)
  2568. (org-let lprops '(org-tags-view current-prefix-arg org-match)))
  2569. ((eq type 'tags-todo)
  2570. (org-let lprops '(org-tags-view '(4) org-match)))
  2571. ((eq type 'todo)
  2572. (org-let lprops '(org-todo-list org-match)))
  2573. ((eq type 'tags-tree)
  2574. (org-check-for-org-mode)
  2575. (org-let lprops '(org-match-sparse-tree current-prefix-arg org-match)))
  2576. ((eq type 'todo-tree)
  2577. (org-check-for-org-mode)
  2578. (org-let lprops
  2579. '(org-occur (concat "^" org-outline-regexp "[ \t]*"
  2580. (regexp-quote org-match) "\\>"))))
  2581. ((eq type 'occur-tree)
  2582. (org-check-for-org-mode)
  2583. (org-let lprops '(org-occur org-match)))
  2584. ((functionp type)
  2585. (org-let lprops '(funcall type org-match)))
  2586. ((fboundp type)
  2587. (org-let lprops '(funcall type org-match)))
  2588. (t (user-error "Invalid custom agenda command type %s" type))))
  2589. (org-agenda-run-series (nth 1 entry) (cddr entry))))
  2590. ((equal org-keys "C")
  2591. (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
  2592. (customize-variable 'org-agenda-custom-commands))
  2593. ((equal org-keys "a") (call-interactively 'org-agenda-list))
  2594. ((equal org-keys "s") (call-interactively 'org-search-view))
  2595. ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
  2596. ((equal org-keys "t") (call-interactively 'org-todo-list))
  2597. ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
  2598. ((equal org-keys "m") (call-interactively 'org-tags-view))
  2599. ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
  2600. ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
  2601. ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
  2602. (add-hook
  2603. 'post-command-hook
  2604. (lambda ()
  2605. (unless (current-message)
  2606. (let* ((m (org-agenda-get-any-marker))
  2607. (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
  2608. (when note
  2609. (message (concat
  2610. "FLAGGING-NOTE ([?] for more info): "
  2611. (org-add-props
  2612. (replace-regexp-in-string
  2613. "\\\\n" "//"
  2614. (copy-sequence note))
  2615. nil 'face 'org-warning)))))))
  2616. t t))
  2617. ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
  2618. ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
  2619. ((equal org-keys "!") (customize-variable 'org-stuck-projects))
  2620. (t (user-error "Invalid agenda key"))))))
  2621. (defvar org-agenda-multi)
  2622. (defun org-agenda-append-agenda ()
  2623. "Append another agenda view to the current one.
  2624. This function allows interactive building of block agendas.
  2625. Agenda views are separated by `org-agenda-block-separator'."
  2626. (interactive)
  2627. (unless (derived-mode-p 'org-agenda-mode)
  2628. (user-error "Can only append from within agenda buffer"))
  2629. (let ((org-agenda-multi t))
  2630. (org-agenda)
  2631. (widen)
  2632. (org-agenda-finalize)
  2633. (setq buffer-read-only t)
  2634. (org-agenda-fit-window-to-buffer)))
  2635. (defun org-agenda-normalize-custom-commands (cmds)
  2636. "Normalize custom commands CMDS."
  2637. (delq nil
  2638. (mapcar
  2639. (lambda (x)
  2640. (cond ((stringp (cdr x)) nil)
  2641. ((stringp (nth 1 x)) x)
  2642. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2643. (t (cons (car x) (cons "" (cdr x))))))
  2644. cmds)))
  2645. (defun org-agenda-get-restriction-and-command (prefix-descriptions)
  2646. "The user interface for selecting an agenda command."
  2647. (catch 'exit
  2648. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  2649. (restrict-ok (and bfn (derived-mode-p 'org-mode)))
  2650. (region-p (org-region-active-p))
  2651. (custom org-agenda-custom-commands)
  2652. (selstring "")
  2653. restriction second-time
  2654. c entry key type match prefixes rmheader header-end custom1 desc
  2655. line lines left right n n1)
  2656. (save-window-excursion
  2657. (delete-other-windows)
  2658. (org-switch-to-buffer-other-window " *Agenda Commands*")
  2659. (erase-buffer)
  2660. (insert (eval-when-compile
  2661. (let ((header
  2662. "Press key for an agenda command:
  2663. -------------------------------- < Buffer, subtree/region restriction
  2664. a Agenda for current week or day > Remove restriction
  2665. t List of all TODO entries e Export agenda views
  2666. m Match a TAGS/PROP/TODO query T Entries with special TODO kwd
  2667. s Search for keywords M Like m, but only TODO entries
  2668. / Multi-occur S Like s, but only TODO entries
  2669. ? Find :FLAGGED: entries C Configure custom agenda commands
  2670. * Toggle sticky agenda views # List stuck projects (!=configure)
  2671. ")
  2672. (start 0))
  2673. (while (string-match
  2674. "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
  2675. header start)
  2676. (setq start (match-end 0))
  2677. (add-text-properties (match-beginning 2) (match-end 2)
  2678. '(face bold) header))
  2679. header)))
  2680. (setq header-end (point-marker))
  2681. (while t
  2682. (setq custom1 custom)
  2683. (when (eq rmheader t)
  2684. (org-goto-line 1)
  2685. (re-search-forward ":" nil t)
  2686. (delete-region (match-end 0) (point-at-eol))
  2687. (forward-char 1)
  2688. (looking-at "-+")
  2689. (delete-region (match-end 0) (point-at-eol))
  2690. (move-marker header-end (match-end 0)))
  2691. (goto-char header-end)
  2692. (delete-region (point) (point-max))
  2693. ;; Produce all the lines that describe custom commands and prefixes
  2694. (setq lines nil)
  2695. (while (setq entry (pop custom1))
  2696. (setq key (car entry) desc (nth 1 entry)
  2697. type (nth 2 entry)
  2698. match (nth 3 entry))
  2699. (if (> (length key) 1)
  2700. (cl-pushnew (string-to-char key) prefixes :test #'equal)
  2701. (setq line
  2702. (format
  2703. "%-4s%-14s"
  2704. (org-add-props (copy-sequence key)
  2705. '(face bold))
  2706. (cond
  2707. ((string-match "\\S-" desc) desc)
  2708. ((eq type 'agenda) "Agenda for current week or day")
  2709. ((eq type 'agenda*) "Appointments for current week or day")
  2710. ((eq type 'alltodo) "List of all TODO entries")
  2711. ((eq type 'search) "Word search")
  2712. ((eq type 'stuck) "List of stuck projects")
  2713. ((eq type 'todo) "TODO keyword")
  2714. ((eq type 'tags) "Tags query")
  2715. ((eq type 'tags-todo) "Tags (TODO)")
  2716. ((eq type 'tags-tree) "Tags tree")
  2717. ((eq type 'todo-tree) "TODO kwd tree")
  2718. ((eq type 'occur-tree) "Occur tree")
  2719. ((functionp type) (if (symbolp type)
  2720. (symbol-name type)
  2721. "Lambda expression"))
  2722. (t "???"))))
  2723. (if org-agenda-menu-show-matcher
  2724. (setq line
  2725. (concat line ": "
  2726. (cond
  2727. ((stringp match)
  2728. (setq match (copy-sequence match))
  2729. (org-add-props match nil 'face 'org-warning))
  2730. ((listp type)
  2731. (format "set of %d commands" (length type))))))
  2732. (when (org-string-nw-p match)
  2733. (add-text-properties
  2734. 0 (length line) (list 'help-echo
  2735. (concat "Matcher: " match)) line)))
  2736. (push line lines)))
  2737. (setq lines (nreverse lines))
  2738. (when prefixes
  2739. (mapc (lambda (x)
  2740. (push
  2741. (format "%s %s"
  2742. (org-add-props (char-to-string x)
  2743. nil 'face 'bold)
  2744. (or (cdr (assoc (concat selstring
  2745. (char-to-string x))
  2746. prefix-descriptions))
  2747. "Prefix key"))
  2748. lines))
  2749. prefixes))
  2750. ;; Check if we should display in two columns
  2751. (if org-agenda-menu-two-columns
  2752. (progn
  2753. (setq n (length lines)
  2754. n1 (+ (/ n 2) (mod n 2))
  2755. right (nthcdr n1 lines)
  2756. left (copy-sequence lines))
  2757. (setcdr (nthcdr (1- n1) left) nil))
  2758. (setq left lines right nil))
  2759. (while left
  2760. (insert "\n" (pop left))
  2761. (when right
  2762. (if (< (current-column) 40)
  2763. (move-to-column 40 t)
  2764. (insert " "))
  2765. (insert (pop right))))
  2766. ;; Make the window the right size
  2767. (goto-char (point-min))
  2768. (if second-time
  2769. (when (not (pos-visible-in-window-p (point-max)))
  2770. (org-fit-window-to-buffer))
  2771. (setq second-time t)
  2772. (org-fit-window-to-buffer))
  2773. ;; Ask for selection
  2774. (message "Press key for agenda command%s:"
  2775. (if (or restrict-ok org-agenda-overriding-restriction)
  2776. (if org-agenda-overriding-restriction
  2777. " (restriction lock active)"
  2778. (if restriction
  2779. (format " (restricted to %s)" restriction)
  2780. " (unrestricted)"))
  2781. ""))
  2782. (setq c (read-char-exclusive))
  2783. (message "")
  2784. (cond
  2785. ((assoc (char-to-string c) custom)
  2786. (setq selstring (concat selstring (char-to-string c)))
  2787. (throw 'exit (cons selstring restriction)))
  2788. ((memq c prefixes)
  2789. (setq selstring (concat selstring (char-to-string c))
  2790. prefixes nil
  2791. rmheader (or rmheader t)
  2792. custom (delq nil (mapcar
  2793. (lambda (x)
  2794. (if (or (= (length (car x)) 1)
  2795. (/= (string-to-char (car x)) c))
  2796. nil
  2797. (cons (substring (car x) 1) (cdr x))))
  2798. custom))))
  2799. ((eq c ?*)
  2800. (call-interactively 'org-toggle-sticky-agenda)
  2801. (sit-for 2))
  2802. ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
  2803. (message "Restriction is only possible in Org buffers")
  2804. (ding) (sit-for 1))
  2805. ((eq c ?1)
  2806. (org-agenda-remove-restriction-lock 'noupdate)
  2807. (setq restriction 'buffer))
  2808. ((eq c ?0)
  2809. (org-agenda-remove-restriction-lock 'noupdate)
  2810. (setq restriction (if region-p 'region 'subtree)))
  2811. ((eq c ?<)
  2812. (org-agenda-remove-restriction-lock 'noupdate)
  2813. (setq restriction
  2814. (cond
  2815. ((eq restriction 'buffer)
  2816. (if region-p 'region 'subtree))
  2817. ((memq restriction '(subtree region))
  2818. nil)
  2819. (t 'buffer))))
  2820. ((eq c ?>)
  2821. (org-agenda-remove-restriction-lock 'noupdate)
  2822. (setq restriction nil))
  2823. ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
  2824. (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
  2825. ((and (> (length selstring) 0) (eq c ?\d))
  2826. (delete-window)
  2827. (org-agenda-get-restriction-and-command prefix-descriptions))
  2828. ((equal c ?q) (error "Abort"))
  2829. (t (user-error "Invalid key %c" c))))))))
  2830. (defun org-agenda-fit-window-to-buffer ()
  2831. "Fit the window to the buffer size."
  2832. (and (memq org-agenda-window-setup '(reorganize-frame))
  2833. (fboundp 'fit-window-to-buffer)
  2834. (if (and (= (cdr org-agenda-window-frame-fractions) 1.0)
  2835. (= (car org-agenda-window-frame-fractions) 1.0))
  2836. (delete-other-windows)
  2837. (org-fit-window-to-buffer
  2838. nil
  2839. (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
  2840. (floor (* (frame-height) (car org-agenda-window-frame-fractions)))))))
  2841. (defvar org-cmd nil)
  2842. (defvar org-agenda-overriding-cmd nil)
  2843. (defvar org-agenda-overriding-arguments nil)
  2844. (defvar org-agenda-overriding-cmd-arguments nil)
  2845. (defun org-agenda-run-series (name series)
  2846. "Run agenda NAME as a SERIES of agenda commands."
  2847. (org-let (nth 1 series) '(org-agenda-prepare name))
  2848. ;; We need to reset agenda markers here, because when constructing a
  2849. ;; block agenda, the individual blocks do not do that.
  2850. (org-agenda-reset-markers)
  2851. (let* ((org-agenda-multi t)
  2852. (redo (list 'org-agenda-run-series name (list 'quote series)))
  2853. (cmds (car series))
  2854. (gprops (nth 1 series))
  2855. match ;; The byte compiler incorrectly complains about this. Keep it!
  2856. org-cmd type lprops)
  2857. (while (setq org-cmd (pop cmds))
  2858. (setq type (car org-cmd))
  2859. (setq match (eval (nth 1 org-cmd)))
  2860. (setq lprops (nth 2 org-cmd))
  2861. (let ((org-agenda-overriding-arguments
  2862. (if (eq org-agenda-overriding-cmd org-cmd)
  2863. (or org-agenda-overriding-arguments
  2864. org-agenda-overriding-cmd-arguments))))
  2865. (cond
  2866. ((eq type 'agenda)
  2867. (org-let2 gprops lprops
  2868. '(call-interactively 'org-agenda-list)))
  2869. ((eq type 'agenda*)
  2870. (org-let2 gprops lprops
  2871. '(funcall 'org-agenda-list nil nil t)))
  2872. ((eq type 'alltodo)
  2873. (org-let2 gprops lprops
  2874. '(call-interactively 'org-todo-list)))
  2875. ((eq type 'search)
  2876. (org-let2 gprops lprops
  2877. '(org-search-view current-prefix-arg match nil)))
  2878. ((eq type 'stuck)
  2879. (org-let2 gprops lprops
  2880. '(call-interactively 'org-agenda-list-stuck-projects)))
  2881. ((eq type 'tags)
  2882. (org-let2 gprops lprops
  2883. '(org-tags-view current-prefix-arg match)))
  2884. ((eq type 'tags-todo)
  2885. (org-let2 gprops lprops
  2886. '(org-tags-view '(4) match)))
  2887. ((eq type 'todo)
  2888. (org-let2 gprops lprops
  2889. '(org-todo-list match)))
  2890. ((fboundp type)
  2891. (org-let2 gprops lprops
  2892. '(funcall type match)))
  2893. (t (error "Invalid type in command series")))))
  2894. (widen)
  2895. (let ((inhibit-read-only t))
  2896. (add-text-properties (point-min) (point-max)
  2897. `(org-series t org-series-redo-cmd ,redo)))
  2898. (setq org-agenda-redo-command redo)
  2899. (goto-char (point-min)))
  2900. (org-agenda-fit-window-to-buffer)
  2901. (org-let (nth 1 series) '(org-agenda-finalize)))
  2902. ;;;###autoload
  2903. (defmacro org-batch-agenda (cmd-key &rest parameters)
  2904. "Run an agenda command in batch mode and send the result to STDOUT.
  2905. If CMD-KEY is a string of length 1, it is used as a key in
  2906. `org-agenda-custom-commands' and triggers this command. If it is a
  2907. longer string it is used as a tags/todo match string.
  2908. Parameters are alternating variable names and values that will be bound
  2909. before running the agenda command."
  2910. (org-eval-in-environment (org-make-parameter-alist parameters)
  2911. (let (org-agenda-sticky)
  2912. (if (> (length cmd-key) 1)
  2913. (org-tags-view nil cmd-key)
  2914. (org-agenda nil cmd-key))))
  2915. (set-buffer org-agenda-buffer-name)
  2916. (princ (buffer-string)))
  2917. (defvar org-agenda-info nil)
  2918. ;;;###autoload
  2919. (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
  2920. "Run an agenda command in batch mode and send the result to STDOUT.
  2921. If CMD-KEY is a string of length 1, it is used as a key in
  2922. `org-agenda-custom-commands' and triggers this command. If it is a
  2923. longer string it is used as a tags/todo match string.
  2924. Parameters are alternating variable names and values that will be bound
  2925. before running the agenda command.
  2926. The output gives a line for each selected agenda item. Each
  2927. item is a list of comma-separated values, like this:
  2928. category,head,type,todo,tags,date,time,extra,priority-l,priority-n
  2929. category The category of the item
  2930. head The headline, without TODO kwd, TAGS and PRIORITY
  2931. type The type of the agenda entry, can be
  2932. todo selected in TODO match
  2933. tagsmatch selected in tags match
  2934. diary imported from diary
  2935. deadline a deadline on given date
  2936. scheduled scheduled on given date
  2937. timestamp entry has timestamp on given date
  2938. closed entry was closed on given date
  2939. upcoming-deadline warning about deadline
  2940. past-scheduled forwarded scheduled item
  2941. block entry has date block including g. date
  2942. todo The todo keyword, if any
  2943. tags All tags including inherited ones, separated by colons
  2944. date The relevant date, like 2007-2-14
  2945. time The time, like 15:00-16:50
  2946. extra Sting with extra planning info
  2947. priority-l The priority letter if any was given
  2948. priority-n The computed numerical priority
  2949. agenda-day The day in the agenda where this is listed"
  2950. (org-eval-in-environment (append '((org-agenda-remove-tags t))
  2951. (org-make-parameter-alist parameters))
  2952. (if (> (length cmd-key) 2)
  2953. (org-tags-view nil cmd-key)
  2954. (org-agenda nil cmd-key)))
  2955. (set-buffer org-agenda-buffer-name)
  2956. (let ((lines (org-split-string (buffer-string) "\n")))
  2957. (dolist (line lines)
  2958. (when (get-text-property 0 'org-category line)
  2959. (setq org-agenda-info
  2960. (org-fix-agenda-info (text-properties-at 0 line)))
  2961. (princ
  2962. (mapconcat 'org-agenda-export-csv-mapper
  2963. '(org-category txt type todo tags date time extra
  2964. priority-letter priority agenda-day)
  2965. ","))
  2966. (princ "\n")))))
  2967. (defun org-fix-agenda-info (props)
  2968. "Make sure all properties on an agenda item have a canonical form.
  2969. This ensures the export commands can easily use it."
  2970. (let (tmp re)
  2971. (when (setq tmp (plist-get props 'tags))
  2972. (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
  2973. (when (setq tmp (plist-get props 'date))
  2974. (when (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2975. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2976. '((format "%4d, %9s %2s, %4s" dayname monthname day year))
  2977. (setq tmp (calendar-date-string tmp)))
  2978. (setq props (plist-put props 'date tmp)))
  2979. (when (setq tmp (plist-get props 'day))
  2980. (when (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2981. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2982. (setq tmp (calendar-date-string tmp)))
  2983. (setq props (plist-put props 'day tmp))
  2984. (setq props (plist-put props 'agenda-day tmp)))
  2985. (when (setq tmp (plist-get props 'txt))
  2986. (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
  2987. (plist-put props 'priority-letter (match-string 1 tmp))
  2988. (setq tmp (replace-match "" t t tmp)))
  2989. (when (and (setq re (plist-get props 'org-todo-regexp))
  2990. (setq re (concat "\\`\\.*" re " ?"))
  2991. (let ((case-fold-search nil)) (string-match re tmp)))
  2992. (plist-put props 'todo (match-string 1 tmp))
  2993. (setq tmp (replace-match "" t t tmp)))
  2994. (plist-put props 'txt tmp)))
  2995. props)
  2996. (defun org-agenda-export-csv-mapper (prop)
  2997. (let ((res (plist-get org-agenda-info prop)))
  2998. (setq res
  2999. (cond
  3000. ((not res) "")
  3001. ((stringp res) res)
  3002. (t (prin1-to-string res))))
  3003. (org-trim (replace-regexp-in-string "," ";" res nil t))))
  3004. ;;;###autoload
  3005. (defun org-store-agenda-views (&rest parameters)
  3006. "Store agenda views."
  3007. (interactive)
  3008. (eval (list 'org-batch-store-agenda-views)))
  3009. ;;;###autoload
  3010. (defmacro org-batch-store-agenda-views (&rest parameters)
  3011. "Run all custom agenda commands that have a file argument."
  3012. (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
  3013. (pop-up-frames nil)
  3014. (dir default-directory)
  3015. (pars (org-make-parameter-alist parameters))
  3016. cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
  3017. (save-window-excursion
  3018. (while cmds
  3019. (setq cmd (pop cmds)
  3020. thiscmdkey (car cmd)
  3021. thiscmdcmd (cdr cmd)
  3022. match (nth 2 thiscmdcmd)
  3023. bufname (if org-agenda-sticky
  3024. (or (and (stringp match)
  3025. (format "*Org Agenda(%s:%s)*" thiscmdkey match))
  3026. (format "*Org Agenda(%s)*" thiscmdkey))
  3027. org-agenda-buffer-name)
  3028. cmd-or-set (nth 2 cmd)
  3029. opts (nth (if (listp cmd-or-set) 3 4) cmd)
  3030. files (nth (if (listp cmd-or-set) 4 5) cmd))
  3031. (if (stringp files) (setq files (list files)))
  3032. (when files
  3033. (org-eval-in-environment (append org-agenda-exporter-settings
  3034. opts pars)
  3035. (org-agenda nil thiscmdkey))
  3036. (set-buffer bufname)
  3037. (while files
  3038. (org-eval-in-environment (append org-agenda-exporter-settings
  3039. opts pars)
  3040. (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
  3041. (and (get-buffer bufname)
  3042. (kill-buffer bufname)))))))
  3043. (defvar org-agenda-current-span nil
  3044. "The current span used in the agenda view.") ; local variable in the agenda buffer
  3045. (defun org-agenda-mark-header-line (pos)
  3046. "Mark the line at POS as an agenda structure header."
  3047. (save-excursion
  3048. (goto-char pos)
  3049. (put-text-property (point-at-bol) (point-at-eol)
  3050. 'org-agenda-structural-header t)
  3051. (when org-agenda-title-append
  3052. (put-text-property (point-at-bol) (point-at-eol)
  3053. 'org-agenda-title-append org-agenda-title-append))))
  3054. (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
  3055. (defvar org-agenda-write-buffer-name "Agenda View")
  3056. (defun org-agenda-write (file &optional open nosettings agenda-bufname)
  3057. "Write the current buffer (an agenda view) as a file.
  3058. Depending on the extension of the file name, plain text (.txt),
  3059. HTML (.html or .htm), PDF (.pdf) or Postscript (.ps) is produced.
  3060. If the extension is .ics, translate visible agenda into iCalendar
  3061. format. If the extension is .org, collect all subtrees
  3062. corresponding to the agenda entries and add them in an .org file.
  3063. With prefix argument OPEN, open the new file immediately. If
  3064. NOSETTINGS is given, do not scope the settings of
  3065. `org-agenda-exporter-settings' into the export commands. This is
  3066. used when the settings have already been scoped and we do not
  3067. wish to overrule other, higher priority settings. If
  3068. AGENDA-BUFFER-NAME is provided, use this as the buffer name for
  3069. the agenda to write."
  3070. (interactive "FWrite agenda to file: \nP")
  3071. (if (or (not (file-writable-p file))
  3072. (and (file-exists-p file)
  3073. (if (called-interactively-p 'any)
  3074. (not (y-or-n-p (format "Overwrite existing file %s? " file))))))
  3075. (user-error "Cannot write agenda to file %s" file))
  3076. (org-let (if nosettings nil org-agenda-exporter-settings)
  3077. '(save-excursion
  3078. (save-window-excursion
  3079. (let ((bs (copy-sequence (buffer-string)))
  3080. (extension (file-name-extension file))
  3081. (default-directory (file-name-directory file))
  3082. beg content)
  3083. (with-temp-buffer
  3084. (rename-buffer org-agenda-write-buffer-name t)
  3085. (set-buffer-modified-p nil)
  3086. (insert bs)
  3087. (org-agenda-remove-marked-text 'invisible 'org-filtered)
  3088. (run-hooks 'org-agenda-before-write-hook)
  3089. (cond
  3090. ((bound-and-true-p org-mobile-creating-agendas)
  3091. (org-mobile-write-agenda-for-mobile file))
  3092. ((string= "org" extension)
  3093. (let (content p m message-log-max)
  3094. (goto-char (point-min))
  3095. (while (setq p (next-single-property-change (point) 'org-hd-marker nil))
  3096. (goto-char p)
  3097. (setq m (get-text-property (point) 'org-hd-marker))
  3098. (when m
  3099. (push (save-excursion
  3100. (set-buffer (marker-buffer m))
  3101. (goto-char m)
  3102. (org-copy-subtree 1 nil t t)
  3103. org-subtree-clip)
  3104. content)))
  3105. (find-file file)
  3106. (erase-buffer)
  3107. (dolist (s content) (org-paste-subtree 1 s))
  3108. (write-file file)
  3109. (kill-buffer (current-buffer))
  3110. (message "Org file written to %s" file)))
  3111. ((member extension '("html" "htm"))
  3112. (or (require 'htmlize nil t)
  3113. (error "Please install htmlize from https://github.com/hniksic/emacs-htmlize"))
  3114. (set-buffer (htmlize-buffer (current-buffer)))
  3115. (when org-agenda-export-html-style
  3116. ;; replace <style> section with org-agenda-export-html-style
  3117. (goto-char (point-min))
  3118. (kill-region (- (search-forward "<style") 6)
  3119. (search-forward "</style>"))
  3120. (insert org-agenda-export-html-style))
  3121. (write-file file)
  3122. (kill-buffer (current-buffer))
  3123. (message "HTML written to %s" file))
  3124. ((string= "ps" extension)
  3125. (require 'ps-print)
  3126. (ps-print-buffer-with-faces file)
  3127. (message "Postscript written to %s" file))
  3128. ((string= "pdf" extension)
  3129. (require 'ps-print)
  3130. (ps-print-buffer-with-faces
  3131. (concat (file-name-sans-extension file) ".ps"))
  3132. (call-process "ps2pdf" nil nil nil
  3133. (expand-file-name
  3134. (concat (file-name-sans-extension file) ".ps"))
  3135. (expand-file-name file))
  3136. (delete-file (concat (file-name-sans-extension file) ".ps"))
  3137. (message "PDF written to %s" file))
  3138. ((string= "ics" extension)
  3139. (require 'ox-icalendar)
  3140. (org-icalendar-export-current-agenda (expand-file-name file)))
  3141. (t
  3142. (let ((bs (buffer-string)))
  3143. (find-file file)
  3144. (erase-buffer)
  3145. (insert bs)
  3146. (save-buffer 0)
  3147. (kill-buffer (current-buffer))
  3148. (message "Plain text written to %s" file))))))))
  3149. (set-buffer (or agenda-bufname
  3150. (and (called-interactively-p 'any) (buffer-name))
  3151. org-agenda-buffer-name)))
  3152. (when open (org-open-file file)))
  3153. (defun org-agenda-remove-marked-text (property &optional value)
  3154. "Delete all text marked with VALUE of PROPERTY.
  3155. VALUE defaults to t."
  3156. (let (beg)
  3157. (setq value (or value t))
  3158. (while (setq beg (text-property-any (point-min) (point-max)
  3159. property value))
  3160. (delete-region
  3161. beg (or (next-single-property-change beg property)
  3162. (point-max))))))
  3163. (defun org-agenda-add-entry-text ()
  3164. "Add entry text to agenda lines.
  3165. This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
  3166. entry text following headings shown in the agenda.
  3167. Drawers will be excluded, also the line with scheduling/deadline info."
  3168. (when (and (> org-agenda-add-entry-text-maxlines 0)
  3169. (not (bound-and-true-p org-mobile-creating-agendas)))
  3170. (let (m txt)
  3171. (goto-char (point-min))
  3172. (while (not (eobp))
  3173. (if (not (setq m (org-get-at-bol 'org-hd-marker)))
  3174. (beginning-of-line 2)
  3175. (setq txt (org-agenda-get-some-entry-text
  3176. m org-agenda-add-entry-text-maxlines " > "))
  3177. (end-of-line 1)
  3178. (if (string-match "\\S-" txt)
  3179. (insert "\n" txt)
  3180. (or (eobp) (forward-char 1))))))))
  3181. (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
  3182. &rest keep)
  3183. "Extract entry text from MARKER, at most N-LINES lines.
  3184. This will ignore drawers etc, just get the text.
  3185. If INDENT is given, prefix every line with this string. If KEEP is
  3186. given, it is a list of symbols, defining stuff that should not be
  3187. removed from the entry content. Currently only `planning' is allowed here."
  3188. (let (txt drawer-re kwd-time-re ind)
  3189. (save-excursion
  3190. (with-current-buffer (marker-buffer marker)
  3191. (if (not (derived-mode-p 'org-mode))
  3192. (setq txt "")
  3193. (org-with-wide-buffer
  3194. (goto-char marker)
  3195. (end-of-line 1)
  3196. (setq txt (buffer-substring
  3197. (min (1+ (point)) (point-max))
  3198. (progn (outline-next-heading) (point)))
  3199. drawer-re org-drawer-regexp
  3200. kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
  3201. ".*\n?"))
  3202. (with-temp-buffer
  3203. (insert txt)
  3204. (when org-agenda-add-entry-text-descriptive-links
  3205. (goto-char (point-min))
  3206. (while (org-activate-links (point-max))
  3207. (add-text-properties (match-beginning 0) (match-end 0)
  3208. '(face org-link))))
  3209. (goto-char (point-min))
  3210. (while (re-search-forward org-bracket-link-regexp (point-max) t)
  3211. (set-text-properties (match-beginning 0) (match-end 0)
  3212. nil))
  3213. (goto-char (point-min))
  3214. (while (re-search-forward drawer-re nil t)
  3215. (delete-region
  3216. (match-beginning 0)
  3217. (progn (re-search-forward
  3218. "^[ \t]*:END:.*\n?" nil 'move)
  3219. (point))))
  3220. (unless (member 'planning keep)
  3221. (goto-char (point-min))
  3222. (while (re-search-forward kwd-time-re nil t)
  3223. (replace-match "")))
  3224. (goto-char (point-min))
  3225. (when org-agenda-entry-text-exclude-regexps
  3226. (let ((re-list org-agenda-entry-text-exclude-regexps) re)
  3227. (while (setq re (pop re-list))
  3228. (goto-char (point-min))
  3229. (while (re-search-forward re nil t)
  3230. (replace-match "")))))
  3231. (goto-char (point-max))
  3232. (skip-chars-backward " \t\n")
  3233. (when (looking-at "[ \t\n]+\\'") (replace-match ""))
  3234. ;; find and remove min common indentation
  3235. (goto-char (point-min))
  3236. (untabify (point-min) (point-max))
  3237. (setq ind (current-indentation))
  3238. (while (not (eobp))
  3239. (unless (looking-at "[ \t]*$")
  3240. (setq ind (min ind (current-indentation))))
  3241. (beginning-of-line 2))
  3242. (goto-char (point-min))
  3243. (while (not (eobp))
  3244. (unless (looking-at "[ \t]*$")
  3245. (move-to-column ind)
  3246. (delete-region (point-at-bol) (point)))
  3247. (beginning-of-line 2))
  3248. (run-hooks 'org-agenda-entry-text-cleanup-hook)
  3249. (goto-char (point-min))
  3250. (when indent
  3251. (while (and (not (eobp)) (re-search-forward "^" nil t))
  3252. (replace-match indent t t)))
  3253. (goto-char (point-min))
  3254. (while (looking-at "[ \t]*\n") (replace-match ""))
  3255. (goto-char (point-max))
  3256. (when (> (org-current-line)
  3257. n-lines)
  3258. (org-goto-line (1+ n-lines))
  3259. (backward-char 1))
  3260. (setq txt (buffer-substring (point-min) (point))))))))
  3261. txt))
  3262. (defun org-check-for-org-mode ()
  3263. "Make sure current buffer is in Org mode. Error if not."
  3264. (or (derived-mode-p 'org-mode)
  3265. (error "Cannot execute Org agenda command on buffer in %s"
  3266. major-mode)))
  3267. ;;; Agenda prepare and finalize
  3268. (defvar org-agenda-multi nil) ; dynamically scoped
  3269. (defvar org-agenda-pre-window-conf nil)
  3270. (defvar org-agenda-columns-active nil)
  3271. (defvar org-agenda-name nil)
  3272. (defvar org-agenda-tag-filter nil)
  3273. (defvar org-agenda-category-filter nil)
  3274. (defvar org-agenda-regexp-filter nil)
  3275. (defvar org-agenda-effort-filter nil)
  3276. (defvar org-agenda-top-headline-filter nil)
  3277. (defvar org-agenda-tag-filter-preset nil
  3278. "A preset of the tags filter used for secondary agenda filtering.
  3279. This must be a list of strings, each string must be a single tag preceded
  3280. by \"+\" or \"-\".
  3281. This variable should not be set directly, but agenda custom commands can
  3282. bind it in the options section. The preset filter is a global property of
  3283. the entire agenda view. In a block agenda, it will not work reliably to
  3284. define a filter for one of the individual blocks. You need to set it in
  3285. the global options and expect it to be applied to the entire view.")
  3286. (defvar org-agenda-category-filter-preset nil
  3287. "A preset of the category filter used for secondary agenda filtering.
  3288. This must be a list of strings, each string must be a single category
  3289. preceded by \"+\" or \"-\".
  3290. This variable should not be set directly, but agenda custom commands can
  3291. bind it in the options section. The preset filter is a global property of
  3292. the entire agenda view. In a block agenda, it will not work reliably to
  3293. define a filter for one of the individual blocks. You need to set it in
  3294. the global options and expect it to be applied to the entire view.")
  3295. (defvar org-agenda-regexp-filter-preset nil
  3296. "A preset of the regexp filter used for secondary agenda filtering.
  3297. This must be a list of strings, each string must be a single regexp
  3298. preceded by \"+\" or \"-\".
  3299. This variable should not be set directly, but agenda custom commands can
  3300. bind it in the options section. The preset filter is a global property of
  3301. the entire agenda view. In a block agenda, it will not work reliably to
  3302. define a filter for one of the individual blocks. You need to set it in
  3303. the global options and expect it to be applied to the entire view.")
  3304. (defvar org-agenda-effort-filter-preset nil
  3305. "A preset of the effort condition used for secondary agenda filtering.
  3306. This must be a list of strings, each string must be a single regexp
  3307. preceded by \"+\" or \"-\".
  3308. This variable should not be set directly, but agenda custom commands can
  3309. bind it in the options section. The preset filter is a global property of
  3310. the entire agenda view. In a block agenda, it will not work reliably to
  3311. define a filter for one of the individual blocks. You need to set it in
  3312. the global options and expect it to be applied to the entire view.")
  3313. (defun org-agenda-use-sticky-p ()
  3314. "Return non-nil if an agenda buffer named
  3315. `org-agenda-buffer-name' exists and should be shown instead of
  3316. generating a new one."
  3317. (and
  3318. ;; turned off by user
  3319. org-agenda-sticky
  3320. ;; For multi-agenda buffer already exists
  3321. (not org-agenda-multi)
  3322. ;; buffer found
  3323. (get-buffer org-agenda-buffer-name)
  3324. ;; C-u parameter is same as last call
  3325. (with-current-buffer (get-buffer org-agenda-buffer-name)
  3326. (and
  3327. (equal current-prefix-arg
  3328. org-agenda-last-prefix-arg)
  3329. ;; In case user turned stickiness on, while having existing
  3330. ;; Agenda buffer active, don't reuse that buffer, because it
  3331. ;; does not have org variables local
  3332. org-agenda-this-buffer-is-sticky))))
  3333. (defun org-agenda-prepare-window (abuf filter-alist)
  3334. "Setup agenda buffer in the window.
  3335. ABUF is the buffer for the agenda window.
  3336. FILTER-ALIST is an alist of filters we need to apply when
  3337. `org-agenda-persistent-filter' is non-nil."
  3338. (let* ((awin (get-buffer-window abuf)) wconf)
  3339. (cond
  3340. ((equal (current-buffer) abuf) nil)
  3341. (awin (select-window awin))
  3342. ((not (setq wconf (current-window-configuration))))
  3343. ((eq org-agenda-window-setup 'current-window)
  3344. (pop-to-buffer-same-window abuf))
  3345. ((eq org-agenda-window-setup 'other-window)
  3346. (org-switch-to-buffer-other-window abuf))
  3347. ((eq org-agenda-window-setup 'other-frame)
  3348. (switch-to-buffer-other-frame abuf))
  3349. ((eq org-agenda-window-setup 'only-window)
  3350. (delete-other-windows)
  3351. (pop-to-buffer-same-window abuf))
  3352. ((eq org-agenda-window-setup 'reorganize-frame)
  3353. (delete-other-windows)
  3354. (org-switch-to-buffer-other-window abuf)))
  3355. (setq org-agenda-tag-filter (cdr (assq 'tag filter-alist)))
  3356. (setq org-agenda-category-filter (cdr (assq 'cat filter-alist)))
  3357. (setq org-agenda-effort-filter (cdr (assq 'effort filter-alist)))
  3358. (setq org-agenda-regexp-filter (cdr (assq 're filter-alist)))
  3359. ;; Additional test in case agenda is invoked from within agenda
  3360. ;; buffer via elisp link.
  3361. (unless (equal (current-buffer) abuf)
  3362. (pop-to-buffer-same-window abuf))
  3363. (setq org-agenda-pre-window-conf
  3364. (or wconf org-agenda-pre-window-conf))))
  3365. (defun org-agenda-prepare (&optional name)
  3366. (let ((filter-alist (when org-agenda-persistent-filter
  3367. (with-current-buffer
  3368. (get-buffer-create org-agenda-buffer-name)
  3369. `((tag . ,org-agenda-tag-filter)
  3370. (re . ,org-agenda-regexp-filter)
  3371. (effort . ,org-agenda-effort-filter)
  3372. (cat . ,org-agenda-category-filter))))))
  3373. (if (org-agenda-use-sticky-p)
  3374. (progn
  3375. (put 'org-agenda-tag-filter :preset-filter nil)
  3376. (put 'org-agenda-category-filter :preset-filter nil)
  3377. (put 'org-agenda-regexp-filter :preset-filter nil)
  3378. ;; Popup existing buffer
  3379. (org-agenda-prepare-window (get-buffer org-agenda-buffer-name)
  3380. filter-alist)
  3381. (message "Sticky Agenda buffer, use `r' to refresh")
  3382. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3383. (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
  3384. (setq org-todo-keywords-for-agenda nil)
  3385. (put 'org-agenda-tag-filter :preset-filter
  3386. org-agenda-tag-filter-preset)
  3387. (put 'org-agenda-category-filter :preset-filter
  3388. org-agenda-category-filter-preset)
  3389. (put 'org-agenda-regexp-filter :preset-filter
  3390. org-agenda-regexp-filter-preset)
  3391. (put 'org-agenda-effort-filter :preset-filter
  3392. org-agenda-effort-filter-preset)
  3393. (if org-agenda-multi
  3394. (progn
  3395. (setq buffer-read-only nil)
  3396. (goto-char (point-max))
  3397. (unless (or (bobp) org-agenda-compact-blocks
  3398. (not org-agenda-block-separator))
  3399. (insert "\n"
  3400. (if (stringp org-agenda-block-separator)
  3401. org-agenda-block-separator
  3402. (make-string (window-width) org-agenda-block-separator))
  3403. "\n"))
  3404. (narrow-to-region (point) (point-max)))
  3405. (setq org-done-keywords-for-agenda nil)
  3406. ;; Setting any org variables that are in org-agenda-local-vars
  3407. ;; list need to be done after the prepare call
  3408. (org-agenda-prepare-window
  3409. (get-buffer-create org-agenda-buffer-name) filter-alist)
  3410. (setq buffer-read-only nil)
  3411. (org-agenda-reset-markers)
  3412. (let ((inhibit-read-only t)) (erase-buffer))
  3413. (org-agenda-mode)
  3414. (setq org-agenda-buffer (current-buffer))
  3415. (setq org-agenda-contributing-files nil)
  3416. (setq org-agenda-columns-active nil)
  3417. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  3418. (setq org-todo-keywords-for-agenda
  3419. (org-uniquify org-todo-keywords-for-agenda))
  3420. (setq org-done-keywords-for-agenda
  3421. (org-uniquify org-done-keywords-for-agenda))
  3422. (setq org-agenda-last-prefix-arg current-prefix-arg)
  3423. (setq org-agenda-this-buffer-name org-agenda-buffer-name)
  3424. (and name (not org-agenda-name)
  3425. (setq-local org-agenda-name name)))
  3426. (setq buffer-read-only nil))))
  3427. (defvar org-agenda-overriding-columns-format) ; From org-colview.el
  3428. (defun org-agenda-finalize ()
  3429. "Finishing touch for the agenda buffer, called just before displaying it."
  3430. (unless org-agenda-multi
  3431. (save-excursion
  3432. (let ((inhibit-read-only t))
  3433. (goto-char (point-min))
  3434. (save-excursion
  3435. (while (org-activate-links (point-max))
  3436. (add-text-properties (match-beginning 0) (match-end 0)
  3437. '(face org-link))))
  3438. (unless (eq org-agenda-remove-tags t)
  3439. (org-agenda-align-tags))
  3440. (unless org-agenda-with-colors
  3441. (remove-text-properties (point-min) (point-max) '(face nil)))
  3442. (when (bound-and-true-p org-agenda-overriding-columns-format)
  3443. (setq-local org-agenda-overriding-columns-format
  3444. org-agenda-overriding-columns-format))
  3445. (when org-agenda-view-columns-initially
  3446. (org-agenda-columns))
  3447. (when org-agenda-fontify-priorities
  3448. (org-agenda-fontify-priorities))
  3449. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  3450. (org-agenda-dim-blocked-tasks))
  3451. (org-agenda-mark-clocking-task)
  3452. (when org-agenda-entry-text-mode
  3453. (org-agenda-entry-text-hide)
  3454. (org-agenda-entry-text-show))
  3455. (when (and (featurep 'org-habit)
  3456. (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
  3457. (org-habit-insert-consistency-graphs))
  3458. (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
  3459. (unless (or (eq org-agenda-show-inherited-tags 'always)
  3460. (and (listp org-agenda-show-inherited-tags)
  3461. (memq org-agenda-type org-agenda-show-inherited-tags))
  3462. (and (eq org-agenda-show-inherited-tags t)
  3463. (or (eq org-agenda-use-tag-inheritance t)
  3464. (and (listp org-agenda-use-tag-inheritance)
  3465. (not (memq org-agenda-type
  3466. org-agenda-use-tag-inheritance))))))
  3467. (let (mrk)
  3468. (save-excursion
  3469. (goto-char (point-min))
  3470. (while (equal (forward-line) 0)
  3471. (when (setq mrk (get-text-property (point) 'org-hd-marker))
  3472. (put-text-property (point-at-bol) (point-at-eol)
  3473. 'tags
  3474. (org-with-point-at mrk
  3475. (mapcar #'downcase (org-get-tags)))))))))
  3476. (run-hooks 'org-agenda-finalize-hook)
  3477. (when org-agenda-top-headline-filter
  3478. (org-agenda-filter-top-headline-apply
  3479. org-agenda-top-headline-filter))
  3480. (when org-agenda-tag-filter
  3481. (org-agenda-filter-apply org-agenda-tag-filter 'tag t))
  3482. (when (get 'org-agenda-tag-filter :preset-filter)
  3483. (org-agenda-filter-apply
  3484. (get 'org-agenda-tag-filter :preset-filter) 'tag t))
  3485. (when org-agenda-category-filter
  3486. (org-agenda-filter-apply org-agenda-category-filter 'category))
  3487. (when (get 'org-agenda-category-filter :preset-filter)
  3488. (org-agenda-filter-apply
  3489. (get 'org-agenda-category-filter :preset-filter) 'category))
  3490. (when org-agenda-regexp-filter
  3491. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
  3492. (when (get 'org-agenda-regexp-filter :preset-filter)
  3493. (org-agenda-filter-apply
  3494. (get 'org-agenda-regexp-filter :preset-filter) 'regexp))
  3495. (when org-agenda-effort-filter
  3496. (org-agenda-filter-apply org-agenda-effort-filter 'effort))
  3497. (when (get 'org-agenda-effort-filter :preset-filter)
  3498. (org-agenda-filter-apply
  3499. (get 'org-agenda-effort-filter :preset-filter) 'effort))
  3500. (add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)))))
  3501. (defun org-agenda-mark-clocking-task ()
  3502. "Mark the current clock entry in the agenda if it is present."
  3503. ;; We need to widen when `org-agenda-finalize' is called from
  3504. ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in')
  3505. (when (bound-and-true-p org-clock-current-task)
  3506. (save-restriction
  3507. (widen)
  3508. (org-agenda-unmark-clocking-task)
  3509. (when (marker-buffer org-clock-hd-marker)
  3510. (save-excursion
  3511. (goto-char (point-min))
  3512. (let (s ov)
  3513. (while (setq s (next-single-property-change (point) 'org-hd-marker))
  3514. (goto-char s)
  3515. (when (equal (org-get-at-bol 'org-hd-marker)
  3516. org-clock-hd-marker)
  3517. (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
  3518. (overlay-put ov 'type 'org-agenda-clocking)
  3519. (overlay-put ov 'face 'org-agenda-clocking)
  3520. (overlay-put ov 'help-echo
  3521. "The clock is running in this item")))))))))
  3522. (defun org-agenda-unmark-clocking-task ()
  3523. "Unmark the current clocking task."
  3524. (mapc (lambda (o)
  3525. (when (eq (overlay-get o 'type) 'org-agenda-clocking)
  3526. (delete-overlay o)))
  3527. (overlays-in (point-min) (point-max))))
  3528. (defun org-agenda-fontify-priorities ()
  3529. "Make highest priority lines bold, and lowest italic."
  3530. (interactive)
  3531. (mapc (lambda (o) (when (eq (overlay-get o 'org-type) 'org-priority)
  3532. (delete-overlay o)))
  3533. (overlays-in (point-min) (point-max)))
  3534. (save-excursion
  3535. (let (b e p ov h l)
  3536. (goto-char (point-min))
  3537. (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
  3538. (setq h (or (get-char-property (point) 'org-highest-priority)
  3539. org-highest-priority)
  3540. l (or (get-char-property (point) 'org-lowest-priority)
  3541. org-lowest-priority)
  3542. p (string-to-char (match-string 1))
  3543. b (match-beginning 0)
  3544. e (if (eq org-agenda-fontify-priorities 'cookies)
  3545. (match-end 0)
  3546. (point-at-eol))
  3547. ov (make-overlay b e))
  3548. (overlay-put
  3549. ov 'face
  3550. (let ((special-face
  3551. (cond ((org-face-from-face-or-color
  3552. 'priority 'org-priority
  3553. (cdr (assoc p org-priority-faces))))
  3554. ((and (listp org-agenda-fontify-priorities)
  3555. (org-face-from-face-or-color
  3556. 'priority 'org-priority
  3557. (cdr (assoc p org-agenda-fontify-priorities)))))
  3558. ((equal p l) 'italic)
  3559. ((equal p h) 'bold))))
  3560. (if special-face (list special-face 'org-priority) 'org-priority)))
  3561. (overlay-put ov 'org-type 'org-priority)))))
  3562. (defvar org-depend-tag-blocked)
  3563. (defun org-agenda-dim-blocked-tasks (&optional invisible)
  3564. "Dim currently blocked TODOs in the agenda display.
  3565. When INVISIBLE is non-nil, hide currently blocked TODO instead of
  3566. dimming them."
  3567. (interactive "P")
  3568. (when (called-interactively-p 'interactive)
  3569. (message "Dim or hide blocked tasks..."))
  3570. (dolist (o (overlays-in (point-min) (point-max)))
  3571. (when (eq (overlay-get o 'org-type) 'org-blocked-todo)
  3572. (delete-overlay o)))
  3573. (save-excursion
  3574. (let ((inhibit-read-only t))
  3575. (goto-char (point-min))
  3576. (while (let ((pos (text-property-not-all
  3577. (point) (point-max) 'org-todo-blocked nil)))
  3578. (when pos (goto-char pos)))
  3579. (let* ((invisible (eq (org-get-at-bol 'org-todo-blocked) 'invisible))
  3580. (ov (make-overlay (if invisible
  3581. (line-end-position 0)
  3582. (line-beginning-position))
  3583. (line-end-position))))
  3584. (if invisible
  3585. (overlay-put ov 'invisible t)
  3586. (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
  3587. (overlay-put ov 'org-type 'org-blocked-todo))
  3588. (forward-line))))
  3589. (when (called-interactively-p 'interactive)
  3590. (message "Dim or hide blocked tasks...done")))
  3591. (defun org-agenda--mark-blocked-entry (entry)
  3592. "For ENTRY a string with the text property `org-hd-marker', if
  3593. the header at `org-hd-marker' is blocked according to
  3594. `org-entry-blocked-p', then if `org-agenda-dim-blocked-tasks' is
  3595. 'invisible and the header is not blocked by checkboxes, set the
  3596. text property `org-todo-blocked' to 'invisible, otherwise set it
  3597. to t."
  3598. (when (get-text-property 0 'todo-state entry)
  3599. (let ((entry-marker (get-text-property 0 'org-hd-marker entry))
  3600. (org-blocked-by-checkboxes nil)
  3601. ;; Necessary so that `org-entry-blocked-p' does not change
  3602. ;; the buffer.
  3603. (org-depend-tag-blocked nil))
  3604. (when entry-marker
  3605. (let ((blocked
  3606. (with-current-buffer (marker-buffer entry-marker)
  3607. (save-excursion
  3608. (goto-char entry-marker)
  3609. (org-entry-blocked-p)))))
  3610. (when blocked
  3611. (let ((really-invisible
  3612. (and (not org-blocked-by-checkboxes)
  3613. (eq org-agenda-dim-blocked-tasks 'invisible))))
  3614. (put-text-property
  3615. 0 (length entry) 'org-todo-blocked
  3616. (if really-invisible 'invisible t)
  3617. entry)))))))
  3618. entry)
  3619. (defvar org-agenda-skip-function nil
  3620. "Function to be called at each match during agenda construction.
  3621. If this function returns nil, the current match should not be skipped.
  3622. Otherwise, the function must return a position from where the search
  3623. should be continued.
  3624. This may also be a Lisp form, it will be evaluated.
  3625. Never set this variable using `setq' or so, because then it will apply
  3626. to all future agenda commands. If you do want a global skipping condition,
  3627. use the option `org-agenda-skip-function-global' instead.
  3628. The correct usage for `org-agenda-skip-function' is to bind it with
  3629. `let' to scope it dynamically into the agenda-constructing command.
  3630. A good way to set it is through options in `org-agenda-custom-commands'.")
  3631. (defun org-agenda-skip ()
  3632. "Throw to `:skip' in places that should be skipped.
  3633. Also moves point to the end of the skipped region, so that search can
  3634. continue from there."
  3635. (let ((p (point-at-bol)) to)
  3636. (when (or
  3637. (save-excursion (goto-char p) (looking-at comment-start-skip))
  3638. (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
  3639. (get-text-property p :org-archived)
  3640. (org-end-of-subtree t))
  3641. (and org-agenda-skip-comment-trees
  3642. (get-text-property p :org-comment)
  3643. (org-end-of-subtree t))
  3644. (and (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
  3645. (org-agenda-skip-eval org-agenda-skip-function)))
  3646. (goto-char to))
  3647. (org-in-src-block-p t))
  3648. (throw :skip t))))
  3649. (defun org-agenda-skip-eval (form)
  3650. "If FORM is a function or a list, call (or eval) it and return the result.
  3651. `save-excursion' and `save-match-data' are wrapped around the call, so point
  3652. and match data are returned to the previous state no matter what these
  3653. functions do."
  3654. (let (fp)
  3655. (and form
  3656. (or (setq fp (functionp form))
  3657. (consp form))
  3658. (save-excursion
  3659. (save-match-data
  3660. (if fp
  3661. (funcall form)
  3662. (eval form)))))))
  3663. (defvar org-agenda-markers nil
  3664. "List of all currently active markers created by `org-agenda'.")
  3665. (defvar org-agenda-last-marker-time (float-time)
  3666. "Creation time of the last agenda marker.")
  3667. (defun org-agenda-new-marker (&optional pos)
  3668. "Return a new agenda marker.
  3669. Maker is at point, or at POS if non-nil. Org mode keeps a list of
  3670. these markers and resets them when they are no longer in use."
  3671. (let ((m (copy-marker (or pos (point)) t)))
  3672. (setq org-agenda-last-marker-time (float-time))
  3673. (if org-agenda-buffer
  3674. (with-current-buffer org-agenda-buffer
  3675. (push m org-agenda-markers))
  3676. (push m org-agenda-markers))
  3677. m))
  3678. (defun org-agenda-reset-markers ()
  3679. "Reset markers created by `org-agenda'."
  3680. (while org-agenda-markers
  3681. (move-marker (pop org-agenda-markers) nil)))
  3682. (defun org-agenda-save-markers-for-cut-and-paste (beg end)
  3683. "Save relative positions of markers in region.
  3684. This check for agenda markers in all agenda buffers currently active."
  3685. (dolist (buf (buffer-list))
  3686. (with-current-buffer buf
  3687. (when (eq major-mode 'org-agenda-mode)
  3688. (mapc (lambda (m) (org-check-and-save-marker m beg end))
  3689. org-agenda-markers)))))
  3690. ;;; Entry text mode
  3691. (defun org-agenda-entry-text-show-here ()
  3692. "Add some text from the entry as context to the current line."
  3693. (let (m txt o)
  3694. (setq m (org-get-at-bol 'org-hd-marker))
  3695. (unless (marker-buffer m)
  3696. (error "No marker points to an entry here"))
  3697. (setq txt (concat "\n" (org-no-properties
  3698. (org-agenda-get-some-entry-text
  3699. m org-agenda-entry-text-maxlines
  3700. org-agenda-entry-text-leaders))))
  3701. (when (string-match "\\S-" txt)
  3702. (setq o (make-overlay (point-at-bol) (point-at-eol)))
  3703. (overlay-put o 'evaporate t)
  3704. (overlay-put o 'org-overlay-type 'agenda-entry-content)
  3705. (overlay-put o 'after-string txt))))
  3706. (defun org-agenda-entry-text-show ()
  3707. "Add entry context for all agenda lines."
  3708. (interactive)
  3709. (save-excursion
  3710. (goto-char (point-max))
  3711. (beginning-of-line 1)
  3712. (while (not (bobp))
  3713. (when (org-get-at-bol 'org-hd-marker)
  3714. (org-agenda-entry-text-show-here))
  3715. (beginning-of-line 0))))
  3716. (defun org-agenda-entry-text-hide ()
  3717. "Remove any shown entry context."
  3718. (mapc (lambda (o)
  3719. (when (eq (overlay-get o 'org-overlay-type)
  3720. 'agenda-entry-content)
  3721. (delete-overlay o)))
  3722. (overlays-in (point-min) (point-max))))
  3723. (defun org-agenda-get-day-face (date)
  3724. "Return the face DATE should be displayed with."
  3725. (cond ((and (functionp org-agenda-day-face-function)
  3726. (funcall org-agenda-day-face-function date)))
  3727. ((org-agenda-today-p date) 'org-agenda-date-today)
  3728. ((memq (calendar-day-of-week date) org-agenda-weekend-days)
  3729. 'org-agenda-date-weekend)
  3730. (t 'org-agenda-date)))
  3731. (defvar org-agenda-show-log-scoped)
  3732. ;;; Agenda Daily/Weekly
  3733. (defvar org-agenda-start-day nil ; dynamically scoped parameter
  3734. "Start day for the agenda view.
  3735. Custom commands can set this variable in the options section.
  3736. This is usually a string like \"2007-11-01\", \"+2d\" or any other
  3737. input allowed when reading a date through the Org calendar.
  3738. See the docstring of `org-read-date' for details.")
  3739. (defvar org-starting-day nil) ; local variable in the agenda buffer
  3740. (defvar org-arg-loc nil) ; local variable
  3741. (defvar org-agenda-buffer-tmp-name nil)
  3742. ;;;###autoload
  3743. (defun org-agenda-list (&optional arg start-day span with-hour)
  3744. "Produce a daily/weekly view from all files in variable `org-agenda-files'.
  3745. The view will be for the current day or week, but from the overview buffer
  3746. you will be able to go to other days/weeks.
  3747. With a numeric prefix argument in an interactive call, the agenda will
  3748. span ARG days. Lisp programs should instead specify SPAN to change
  3749. the number of days. SPAN defaults to `org-agenda-span'.
  3750. START-DAY defaults to TODAY, or to the most recent match for the weekday
  3751. given in `org-agenda-start-on-weekday'.
  3752. When WITH-HOUR is non-nil, only include scheduled and deadline
  3753. items if they have an hour specification like [h]h:mm."
  3754. (interactive "P")
  3755. (when org-agenda-overriding-arguments
  3756. (setq arg (car org-agenda-overriding-arguments)
  3757. start-day (nth 1 org-agenda-overriding-arguments)
  3758. span (nth 2 org-agenda-overriding-arguments)))
  3759. (when (and (integerp arg) (> arg 0))
  3760. (setq span arg arg nil))
  3761. (catch 'exit
  3762. (setq org-agenda-buffer-name
  3763. (or org-agenda-buffer-tmp-name
  3764. (and org-agenda-doing-sticky-redo org-agenda-buffer-name)
  3765. (when org-agenda-sticky
  3766. (cond ((and org-keys (stringp org-match))
  3767. (format "*Org Agenda(%s:%s)*" org-keys org-match))
  3768. (org-keys
  3769. (format "*Org Agenda(%s)*" org-keys))
  3770. (t "*Org Agenda(a)*")))
  3771. "*Org Agenda*"))
  3772. (org-agenda-prepare "Day/Week")
  3773. (setq start-day (or start-day org-agenda-start-day))
  3774. (when (stringp start-day)
  3775. ;; Convert to an absolute day number
  3776. (setq start-day (time-to-days (org-read-date nil t start-day))))
  3777. (org-compile-prefix-format 'agenda)
  3778. (org-set-sorting-strategy 'agenda)
  3779. (let* ((span (org-agenda-ndays-to-span (or span org-agenda-span)))
  3780. (today (org-today))
  3781. (sd (or start-day today))
  3782. (ndays (org-agenda-span-to-ndays span sd))
  3783. (org-agenda-start-on-weekday
  3784. (and (or (eq ndays 7) (eq ndays 14))
  3785. org-agenda-start-on-weekday))
  3786. (thefiles (org-agenda-files nil 'ifmode))
  3787. (files thefiles)
  3788. (start (if (or (null org-agenda-start-on-weekday)
  3789. (< ndays 7))
  3790. sd
  3791. (let* ((nt (calendar-day-of-week
  3792. (calendar-gregorian-from-absolute sd)))
  3793. (n1 org-agenda-start-on-weekday)
  3794. (d (- nt n1)))
  3795. (- sd (+ (if (< d 0) 7 0) d)))))
  3796. (day-numbers (list start))
  3797. (day-cnt 0)
  3798. (inhibit-redisplay (not debug-on-error))
  3799. (org-agenda-show-log-scoped org-agenda-show-log)
  3800. s e rtn rtnall file date d start-pos end-pos todayp
  3801. clocktable-start clocktable-end filter)
  3802. (setq org-agenda-redo-command
  3803. (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span) with-hour))
  3804. (dotimes (n (1- ndays))
  3805. (push (1+ (car day-numbers)) day-numbers))
  3806. (setq day-numbers (nreverse day-numbers))
  3807. (setq clocktable-start (car day-numbers)
  3808. clocktable-end (1+ (or (org-last day-numbers) 0)))
  3809. (setq-local org-starting-day (car day-numbers))
  3810. (setq-local org-arg-loc arg)
  3811. (setq-local org-agenda-current-span (org-agenda-ndays-to-span span))
  3812. (unless org-agenda-compact-blocks
  3813. (let* ((d1 (car day-numbers))
  3814. (d2 (org-last day-numbers))
  3815. (w1 (org-days-to-iso-week d1))
  3816. (w2 (org-days-to-iso-week d2)))
  3817. (setq s (point))
  3818. (org-agenda--insert-overriding-header
  3819. (concat (org-agenda-span-name span)
  3820. "-agenda"
  3821. (cond ((<= 350 (- d2 d1)) "")
  3822. ((= w1 w2) (format " (W%02d)" w1))
  3823. (t (format " (W%02d-W%02d)" w1 w2)))
  3824. ":\n")))
  3825. (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
  3826. 'org-date-line t))
  3827. (org-agenda-mark-header-line s))
  3828. (while (setq d (pop day-numbers))
  3829. (setq date (calendar-gregorian-from-absolute d)
  3830. s (point))
  3831. (if (or (setq todayp (= d today))
  3832. (and (not start-pos) (= d sd)))
  3833. (setq start-pos (point))
  3834. (when (and start-pos (not end-pos))
  3835. (setq end-pos (point))))
  3836. (setq files thefiles
  3837. rtnall nil)
  3838. (while (setq file (pop files))
  3839. (catch 'nextfile
  3840. (org-check-agenda-file file)
  3841. (let ((org-agenda-entry-types org-agenda-entry-types))
  3842. ;; Starred types override non-starred equivalents
  3843. (when (member :deadline* org-agenda-entry-types)
  3844. (setq org-agenda-entry-types
  3845. (delq :deadline org-agenda-entry-types)))
  3846. (when (member :scheduled* org-agenda-entry-types)
  3847. (setq org-agenda-entry-types
  3848. (delq :scheduled org-agenda-entry-types)))
  3849. ;; Honor with-hour
  3850. (when with-hour
  3851. (when (member :deadline org-agenda-entry-types)
  3852. (setq org-agenda-entry-types
  3853. (delq :deadline org-agenda-entry-types))
  3854. (push :deadline* org-agenda-entry-types))
  3855. (when (member :scheduled org-agenda-entry-types)
  3856. (setq org-agenda-entry-types
  3857. (delq :scheduled org-agenda-entry-types))
  3858. (push :scheduled* org-agenda-entry-types)))
  3859. (unless org-agenda-include-deadlines
  3860. (setq org-agenda-entry-types
  3861. (delq :deadline* (delq :deadline org-agenda-entry-types))))
  3862. (cond
  3863. ((memq org-agenda-show-log-scoped '(only clockcheck))
  3864. (setq rtn (org-agenda-get-day-entries
  3865. file date :closed)))
  3866. (org-agenda-show-log-scoped
  3867. (setq rtn (apply 'org-agenda-get-day-entries
  3868. file date
  3869. (append '(:closed) org-agenda-entry-types))))
  3870. (t
  3871. (setq rtn (apply 'org-agenda-get-day-entries
  3872. file date
  3873. org-agenda-entry-types)))))
  3874. (setq rtnall (append rtnall rtn)))) ;; all entries
  3875. (when org-agenda-include-diary
  3876. (let ((org-agenda-search-headline-for-time t))
  3877. (require 'diary-lib)
  3878. (setq rtn (org-get-entries-from-diary date))
  3879. (setq rtnall (append rtnall rtn))))
  3880. (when (or rtnall org-agenda-show-all-dates)
  3881. (setq day-cnt (1+ day-cnt))
  3882. (insert
  3883. (if (stringp org-agenda-format-date)
  3884. (format-time-string org-agenda-format-date
  3885. (org-time-from-absolute date))
  3886. (funcall org-agenda-format-date date))
  3887. "\n")
  3888. (put-text-property s (1- (point)) 'face
  3889. (org-agenda-get-day-face date))
  3890. (put-text-property s (1- (point)) 'org-date-line t)
  3891. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3892. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
  3893. (when todayp
  3894. (put-text-property s (1- (point)) 'org-today t))
  3895. (setq rtnall
  3896. (org-agenda-add-time-grid-maybe rtnall ndays todayp))
  3897. (when rtnall (insert ;; all entries
  3898. (org-agenda-finalize-entries rtnall 'agenda)
  3899. "\n"))
  3900. (put-text-property s (1- (point)) 'day d)
  3901. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)))
  3902. (when (and org-agenda-clockreport-mode clocktable-start)
  3903. (let ((org-agenda-files (org-agenda-files nil 'ifmode))
  3904. ;; the above line is to ensure the restricted range!
  3905. (p (copy-sequence org-agenda-clockreport-parameter-plist))
  3906. tbl)
  3907. (setq p (org-plist-delete p :block))
  3908. (setq p (plist-put p :tstart clocktable-start))
  3909. (setq p (plist-put p :tend clocktable-end))
  3910. (setq p (plist-put p :scope 'agenda))
  3911. (setq tbl (apply 'org-clock-get-clocktable p))
  3912. (insert tbl)))
  3913. (goto-char (point-min))
  3914. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3915. (unless (or (not (get-buffer-window))
  3916. (and (pos-visible-in-window-p (point-min))
  3917. (pos-visible-in-window-p (point-max))))
  3918. (goto-char (1- (point-max)))
  3919. (recenter -1)
  3920. (when (not (pos-visible-in-window-p (or start-pos 1)))
  3921. (goto-char (or start-pos 1))
  3922. (recenter 1)))
  3923. (goto-char (or start-pos 1))
  3924. (add-text-properties (point-min) (point-max)
  3925. `(org-agenda-type agenda
  3926. org-last-args (,arg ,start-day ,span)
  3927. org-redo-cmd ,org-agenda-redo-command
  3928. org-series-cmd ,org-cmd))
  3929. (when (eq org-agenda-show-log-scoped 'clockcheck)
  3930. (org-agenda-show-clocking-issues))
  3931. (org-agenda-finalize)
  3932. (setq buffer-read-only t)
  3933. (message ""))))
  3934. (defun org-agenda-ndays-to-span (n)
  3935. "Return a span symbol for a span of N days, or N if none matches."
  3936. (cond ((symbolp n) n)
  3937. ((= n 1) 'day)
  3938. ((= n 7) 'week)
  3939. ((= n 14) 'fortnight)
  3940. (t n)))
  3941. (defun org-agenda-span-to-ndays (span &optional start-day)
  3942. "Return ndays from SPAN, possibly starting at START-DAY.
  3943. START-DAY is an absolute time value."
  3944. (cond ((numberp span) span)
  3945. ((eq span 'day) 1)
  3946. ((eq span 'week) 7)
  3947. ((eq span 'fortnight) 14)
  3948. ((eq span 'month)
  3949. (let ((date (calendar-gregorian-from-absolute start-day)))
  3950. (calendar-last-day-of-month (car date) (cl-caddr date))))
  3951. ((eq span 'year)
  3952. (let ((date (calendar-gregorian-from-absolute start-day)))
  3953. (if (calendar-leap-year-p (cl-caddr date)) 366 365)))))
  3954. (defun org-agenda-span-name (span)
  3955. "Return a SPAN name."
  3956. (if (null span)
  3957. ""
  3958. (if (symbolp span)
  3959. (capitalize (symbol-name span))
  3960. (format "%d days" span))))
  3961. ;;; Agenda word search
  3962. (defvar org-agenda-search-history nil)
  3963. (defvar org-search-syntax-table nil
  3964. "Special syntax table for Org search.
  3965. In this table, we have single quotes not as word constituents, to
  3966. that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
  3967. (defvar org-mode-syntax-table) ; From org.el
  3968. (defun org-search-syntax-table ()
  3969. (unless org-search-syntax-table
  3970. (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
  3971. (modify-syntax-entry ?' "." org-search-syntax-table)
  3972. (modify-syntax-entry ?` "." org-search-syntax-table))
  3973. org-search-syntax-table)
  3974. (defvar org-agenda-last-search-view-search-was-boolean nil)
  3975. ;;;###autoload
  3976. (defun org-search-view (&optional todo-only string edit-at)
  3977. "Show all entries that contain a phrase or words or regular expressions.
  3978. With optional prefix argument TODO-ONLY, only consider entries that are
  3979. TODO entries. The argument STRING can be used to pass a default search
  3980. string into this function. If EDIT-AT is non-nil, it means that the
  3981. user should get a chance to edit this string, with cursor at position
  3982. EDIT-AT.
  3983. The search string can be viewed either as a phrase that should be found as
  3984. is, or it can be broken into a number of snippets, each of which must match
  3985. in a Boolean way to select an entry. The default depends on the variable
  3986. `org-agenda-search-view-always-boolean'.
  3987. Even if this is turned off (the default) you can always switch to
  3988. Boolean search dynamically by preceding the first word with \"+\" or \"-\".
  3989. The default is a direct search of the whole phrase, where each space in
  3990. the search string can expand to an arbitrary amount of whitespace,
  3991. including newlines.
  3992. If using a Boolean search, the search string is split on whitespace and
  3993. each snippet is searched separately, with logical AND to select an entry.
  3994. Words prefixed with a minus must *not* occur in the entry. Words without
  3995. a prefix or prefixed with a plus must occur in the entry. Matching is
  3996. case-insensitive. Words are enclosed by word delimiters (i.e. they must
  3997. match whole words, not parts of a word) if
  3998. `org-agenda-search-view-force-full-words' is set (default is nil).
  3999. Boolean search snippets enclosed by curly braces are interpreted as
  4000. regular expressions that must or (when preceded with \"-\") must not
  4001. match in the entry. Snippets enclosed into double quotes will be taken
  4002. as a whole, to include whitespace.
  4003. - If the search string starts with an asterisk, search only in headlines.
  4004. - If (possibly after the leading star) the search string starts with an
  4005. exclamation mark, this also means to look at TODO entries only, an effect
  4006. that can also be achieved with a prefix argument.
  4007. - If (possibly after star and exclamation mark) the search string starts
  4008. with a colon, this will mean that the (non-regexp) snippets of the
  4009. Boolean search must match as full words.
  4010. This command searches the agenda files, and in addition the files
  4011. listed in `org-agenda-text-search-extra-files' unless a restriction lock
  4012. is active."
  4013. (interactive "P")
  4014. (when org-agenda-overriding-arguments
  4015. (setq todo-only (car org-agenda-overriding-arguments)
  4016. string (nth 1 org-agenda-overriding-arguments)
  4017. edit-at (nth 2 org-agenda-overriding-arguments)))
  4018. (let* ((props (list 'face nil
  4019. 'done-face 'org-agenda-done
  4020. 'org-not-done-regexp org-not-done-regexp
  4021. 'org-todo-regexp org-todo-regexp
  4022. 'org-complex-heading-regexp org-complex-heading-regexp
  4023. 'mouse-face 'highlight
  4024. 'help-echo (format "mouse-2 or RET jump to location")))
  4025. (full-words org-agenda-search-view-force-full-words)
  4026. (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
  4027. regexp rtn rtnall files file pos inherited-tags
  4028. marker category level tags c neg re boolean
  4029. ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
  4030. (unless (and (not edit-at)
  4031. (stringp string)
  4032. (string-match "\\S-" string))
  4033. (setq string (read-string
  4034. (if org-agenda-search-view-always-boolean
  4035. "[+-]Word/{Regexp} ...: "
  4036. "Phrase or [+-]Word/{Regexp} ...: ")
  4037. (cond
  4038. ((integerp edit-at) (cons string edit-at))
  4039. (edit-at string))
  4040. 'org-agenda-search-history)))
  4041. (catch 'exit
  4042. (when org-agenda-sticky
  4043. (setq org-agenda-buffer-name
  4044. (if (stringp string)
  4045. (format "*Org Agenda(%s:%s)*"
  4046. (or org-keys (or (and todo-only "S") "s")) string)
  4047. (format "*Org Agenda(%s)*" (or (and todo-only "S") "s")))))
  4048. (org-agenda-prepare "SEARCH")
  4049. (org-compile-prefix-format 'search)
  4050. (org-set-sorting-strategy 'search)
  4051. (setq org-agenda-redo-command
  4052. (list 'org-search-view (if todo-only t nil)
  4053. (list 'if 'current-prefix-arg nil string)))
  4054. (setq org-agenda-query-string string)
  4055. (if (equal (string-to-char string) ?*)
  4056. (setq hdl-only t
  4057. words (substring string 1))
  4058. (setq words string))
  4059. (when (equal (string-to-char words) ?!)
  4060. (setq todo-only t
  4061. words (substring words 1)))
  4062. (when (equal (string-to-char words) ?:)
  4063. (setq full-words t
  4064. words (substring words 1)))
  4065. (when (or org-agenda-search-view-always-boolean
  4066. (member (string-to-char words) '(?- ?+ ?\{)))
  4067. (setq boolean t))
  4068. (setq words (split-string words))
  4069. (let (www w)
  4070. (while (setq w (pop words))
  4071. (while (and (string-match "\\\\\\'" w) words)
  4072. (setq w (concat (substring w 0 -1) " " (pop words))))
  4073. (push w www))
  4074. (setq words (nreverse www) www nil)
  4075. (while (setq w (pop words))
  4076. (when (and (string-match "\\`[-+]?{" w)
  4077. (not (string-match "}\\'" w)))
  4078. (while (and words (not (string-match "}\\'" (car words))))
  4079. (setq w (concat w " " (pop words))))
  4080. (setq w (concat w " " (pop words))))
  4081. (push w www))
  4082. (setq words (nreverse www)))
  4083. (setq org-agenda-last-search-view-search-was-boolean boolean)
  4084. (when boolean
  4085. (let (wds w)
  4086. (while (setq w (pop words))
  4087. (when (or (equal (substring w 0 1) "\"")
  4088. (and (> (length w) 1)
  4089. (member (substring w 0 1) '("+" "-"))
  4090. (equal (substring w 1 2) "\"")))
  4091. (while (and words (not (equal (substring w -1) "\"")))
  4092. (setq w (concat w " " (pop words)))))
  4093. (and (string-match "\\`\\([-+]?\\)\"" w)
  4094. (setq w (replace-match "\\1" nil nil w)))
  4095. (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
  4096. (push w wds))
  4097. (setq words (nreverse wds))))
  4098. (if boolean
  4099. (mapc (lambda (w)
  4100. (setq c (string-to-char w))
  4101. (if (equal c ?-)
  4102. (setq neg t w (substring w 1))
  4103. (if (equal c ?+)
  4104. (setq neg nil w (substring w 1))
  4105. (setq neg nil)))
  4106. (if (string-match "\\`{.*}\\'" w)
  4107. (setq re (substring w 1 -1))
  4108. (if full-words
  4109. (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
  4110. (setq re (regexp-quote (downcase w)))))
  4111. (if neg (push re regexps-) (push re regexps+)))
  4112. words)
  4113. (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
  4114. regexps+))
  4115. (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
  4116. (if (not regexps+)
  4117. (setq regexp org-outline-regexp-bol)
  4118. (setq regexp (pop regexps+))
  4119. (when hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
  4120. regexp))))
  4121. (setq files (org-agenda-files nil 'ifmode))
  4122. ;; Add `org-agenda-text-search-extra-files' unless there is some
  4123. ;; restriction.
  4124. (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
  4125. (pop org-agenda-text-search-extra-files)
  4126. (unless (get 'org-agenda-files 'org-restrict)
  4127. (setq files (org-add-archive-files files))))
  4128. ;; Uniquify files. However, let `org-check-agenda-file' handle
  4129. ;; non-existent ones.
  4130. (setq files (cl-remove-duplicates
  4131. (append files org-agenda-text-search-extra-files)
  4132. :test (lambda (a b)
  4133. (and (file-exists-p a)
  4134. (file-exists-p b)
  4135. (file-equal-p a b))))
  4136. rtnall nil)
  4137. (while (setq file (pop files))
  4138. (setq ee nil)
  4139. (catch 'nextfile
  4140. (org-check-agenda-file file)
  4141. (setq buffer (if (file-exists-p file)
  4142. (org-get-agenda-file-buffer file)
  4143. (error "No such file %s" file)))
  4144. (unless buffer
  4145. ;; If file does not exist, make sure an error message is sent
  4146. (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
  4147. file))))
  4148. (with-current-buffer buffer
  4149. (with-syntax-table (org-search-syntax-table)
  4150. (unless (derived-mode-p 'org-mode)
  4151. (error "Agenda file %s is not in Org mode" file))
  4152. (let ((case-fold-search t))
  4153. (save-excursion
  4154. (save-restriction
  4155. (if (eq buffer org-agenda-restrict)
  4156. (narrow-to-region org-agenda-restrict-begin
  4157. org-agenda-restrict-end)
  4158. (widen))
  4159. (goto-char (point-min))
  4160. (unless (or (org-at-heading-p)
  4161. (outline-next-heading))
  4162. (throw 'nextfile t))
  4163. (goto-char (max (point-min) (1- (point))))
  4164. (while (re-search-forward regexp nil t)
  4165. (org-back-to-heading t)
  4166. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4167. (> (org-reduced-level (org-outline-level))
  4168. org-agenda-search-view-max-outline-level)
  4169. (forward-line -1)
  4170. (org-back-to-heading t)))
  4171. (skip-chars-forward "* ")
  4172. (setq beg (point-at-bol)
  4173. beg1 (point)
  4174. end (progn
  4175. (outline-next-heading)
  4176. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4177. (> (org-reduced-level (org-outline-level))
  4178. org-agenda-search-view-max-outline-level)
  4179. (forward-line 1)
  4180. (outline-next-heading)))
  4181. (point)))
  4182. (catch :skip
  4183. (goto-char beg)
  4184. (org-agenda-skip)
  4185. (setq str (buffer-substring-no-properties
  4186. (point-at-bol)
  4187. (if hdl-only (point-at-eol) end)))
  4188. (mapc (lambda (wr) (when (string-match wr str)
  4189. (goto-char (1- end))
  4190. (throw :skip t)))
  4191. regexps-)
  4192. (mapc (lambda (wr) (unless (string-match wr str)
  4193. (goto-char (1- end))
  4194. (throw :skip t)))
  4195. (if todo-only
  4196. (cons (concat "^\\*+[ \t]+"
  4197. org-not-done-regexp)
  4198. regexps+)
  4199. regexps+))
  4200. (goto-char beg)
  4201. (setq marker (org-agenda-new-marker (point))
  4202. category (org-get-category)
  4203. level (make-string (org-reduced-level (org-outline-level)) ? )
  4204. inherited-tags
  4205. (or (eq org-agenda-show-inherited-tags 'always)
  4206. (and (listp org-agenda-show-inherited-tags)
  4207. (memq 'todo org-agenda-show-inherited-tags))
  4208. (and (eq org-agenda-show-inherited-tags t)
  4209. (or (eq org-agenda-use-tag-inheritance t)
  4210. (memq 'todo org-agenda-use-tag-inheritance))))
  4211. tags (org-get-tags nil (not inherited-tags))
  4212. txt (org-agenda-format-item
  4213. ""
  4214. (buffer-substring-no-properties
  4215. beg1 (point-at-eol))
  4216. level category tags t))
  4217. (org-add-props txt props
  4218. 'org-marker marker 'org-hd-marker marker
  4219. 'org-todo-regexp org-todo-regexp
  4220. 'level level
  4221. 'org-complex-heading-regexp org-complex-heading-regexp
  4222. 'priority 1000
  4223. 'type "search")
  4224. (push txt ee)
  4225. (goto-char (1- end))))))))))
  4226. (setq rtn (nreverse ee))
  4227. (setq rtnall (append rtnall rtn)))
  4228. (org-agenda--insert-overriding-header
  4229. (with-temp-buffer
  4230. (insert "Search words: ")
  4231. (add-text-properties (point-min) (1- (point))
  4232. (list 'face 'org-agenda-structure))
  4233. (setq pos (point))
  4234. (insert string "\n")
  4235. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4236. (setq pos (point))
  4237. (unless org-agenda-multi
  4238. (insert (substitute-command-keys "\\<org-agenda-mode-map>\
  4239. Press `\\[org-agenda-manipulate-query-add]', \
  4240. `\\[org-agenda-manipulate-query-subtract]' to add/sub word, \
  4241. `\\[org-agenda-manipulate-query-add-re]', \
  4242. `\\[org-agenda-manipulate-query-subtract-re]' to add/sub regexp, \
  4243. `\\[universal-argument] \\[org-agenda-redo]' to edit\n"))
  4244. (add-text-properties pos (1- (point))
  4245. (list 'face 'org-agenda-structure)))
  4246. (buffer-string)))
  4247. (org-agenda-mark-header-line (point-min))
  4248. (when rtnall
  4249. (insert (org-agenda-finalize-entries rtnall 'search) "\n"))
  4250. (goto-char (point-min))
  4251. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4252. (add-text-properties (point-min) (point-max)
  4253. `(org-agenda-type search
  4254. org-last-args (,todo-only ,string ,edit-at)
  4255. org-redo-cmd ,org-agenda-redo-command
  4256. org-series-cmd ,org-cmd))
  4257. (org-agenda-finalize)
  4258. (setq buffer-read-only t))))
  4259. ;;; Agenda TODO list
  4260. (defun org-agenda-propertize-selected-todo-keywords (keywords)
  4261. "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
  4262. (concat
  4263. (if (or (equal keywords "ALL") (not keywords))
  4264. (propertize "ALL" 'face 'warning)
  4265. (mapconcat
  4266. (lambda (kw)
  4267. (propertize kw 'face (org-get-todo-face kw)))
  4268. (org-split-string keywords "|")
  4269. "|"))
  4270. "\n"))
  4271. (defvar org-select-this-todo-keyword nil)
  4272. (defvar org-last-arg nil)
  4273. ;;;###autoload
  4274. (defun org-todo-list (&optional arg)
  4275. "Show all (not done) TODO entries from all agenda file in a single list.
  4276. The prefix arg can be used to select a specific TODO keyword and limit
  4277. the list to these. When using `\\[universal-argument]', you will be prompted
  4278. for a keyword. A numeric prefix directly selects the Nth keyword in
  4279. `org-todo-keywords-1'."
  4280. (interactive "P")
  4281. (when org-agenda-overriding-arguments
  4282. (setq arg org-agenda-overriding-arguments))
  4283. (when (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
  4284. (let* ((today (org-today))
  4285. (date (calendar-gregorian-from-absolute today))
  4286. (kwds org-todo-keywords-for-agenda)
  4287. (completion-ignore-case t)
  4288. (org-select-this-todo-keyword
  4289. (if (stringp arg) arg
  4290. (and arg (integerp arg) (> arg 0)
  4291. (nth (1- arg) kwds))))
  4292. rtn rtnall files file pos)
  4293. (when (equal arg '(4))
  4294. (setq org-select-this-todo-keyword
  4295. (completing-read "Keyword (or KWD1|K2D2|...): "
  4296. (mapcar #'list kwds) nil nil)))
  4297. (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
  4298. (catch 'exit
  4299. (when org-agenda-sticky
  4300. (setq org-agenda-buffer-name
  4301. (if (stringp org-select-this-todo-keyword)
  4302. (format "*Org Agenda(%s:%s)*" (or org-keys "t")
  4303. org-select-this-todo-keyword)
  4304. (format "*Org Agenda(%s)*" (or org-keys "t")))))
  4305. (org-agenda-prepare "TODO")
  4306. (org-compile-prefix-format 'todo)
  4307. (org-set-sorting-strategy 'todo)
  4308. (setq org-agenda-redo-command
  4309. `(org-todo-list (or (and (numberp current-prefix-arg)
  4310. current-prefix-arg)
  4311. ,org-select-this-todo-keyword
  4312. current-prefix-arg ,arg)))
  4313. (setq files (org-agenda-files nil 'ifmode)
  4314. rtnall nil)
  4315. (while (setq file (pop files))
  4316. (catch 'nextfile
  4317. (org-check-agenda-file file)
  4318. (setq rtn (org-agenda-get-day-entries file date :todo))
  4319. (setq rtnall (append rtnall rtn))))
  4320. (org-agenda--insert-overriding-header
  4321. (with-temp-buffer
  4322. (insert "Global list of TODO items of type: ")
  4323. (add-text-properties (point-min) (1- (point))
  4324. (list 'face 'org-agenda-structure
  4325. 'short-heading
  4326. (concat "ToDo: "
  4327. (or org-select-this-todo-keyword "ALL"))))
  4328. (org-agenda-mark-header-line (point-min))
  4329. (insert (org-agenda-propertize-selected-todo-keywords
  4330. org-select-this-todo-keyword))
  4331. (setq pos (point))
  4332. (unless org-agenda-multi
  4333. (insert (substitute-command-keys "Press \
  4334. \\<org-agenda-mode-map>`N \\[org-agenda-redo]' (e.g. `0 \\[org-agenda-redo]') \
  4335. to search again: (0)[ALL]"))
  4336. (let ((n 0))
  4337. (dolist (k kwds)
  4338. (let ((s (format "(%d)%s" (cl-incf n) k)))
  4339. (when (> (+ (current-column) (string-width s) 1) (window-width))
  4340. (insert "\n "))
  4341. (insert " " s))))
  4342. (insert "\n"))
  4343. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure))
  4344. (buffer-string)))
  4345. (org-agenda-mark-header-line (point-min))
  4346. (when rtnall
  4347. (insert (org-agenda-finalize-entries rtnall 'todo) "\n"))
  4348. (goto-char (point-min))
  4349. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4350. (add-text-properties (point-min) (point-max)
  4351. `(org-agenda-type todo
  4352. org-last-args ,arg
  4353. org-redo-cmd ,org-agenda-redo-command
  4354. org-series-cmd ,org-cmd))
  4355. (org-agenda-finalize)
  4356. (setq buffer-read-only t))))
  4357. ;;; Agenda tags match
  4358. ;;;###autoload
  4359. (defun org-tags-view (&optional todo-only match)
  4360. "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
  4361. The prefix arg TODO-ONLY limits the search to TODO entries."
  4362. (interactive "P")
  4363. (when org-agenda-overriding-arguments
  4364. (setq todo-only (car org-agenda-overriding-arguments)
  4365. match (nth 1 org-agenda-overriding-arguments)))
  4366. (let* ((org-tags-match-list-sublevels
  4367. org-tags-match-list-sublevels)
  4368. (completion-ignore-case t)
  4369. (org--matcher-tags-todo-only todo-only)
  4370. rtn rtnall files file pos matcher
  4371. buffer)
  4372. (when (and (stringp match) (not (string-match "\\S-" match)))
  4373. (setq match nil))
  4374. (catch 'exit
  4375. ;; TODO: this code is repeated a lot...
  4376. (when org-agenda-sticky
  4377. (setq org-agenda-buffer-name
  4378. (if (stringp match)
  4379. (format "*Org Agenda(%s:%s)*"
  4380. (or org-keys (or (and todo-only "M") "m")) match)
  4381. (format "*Org Agenda(%s)*" (or (and todo-only "M") "m")))))
  4382. (setq matcher (org-make-tags-matcher match))
  4383. ;; Prepare agendas (and `org-tag-alist-for-agenda') before
  4384. ;; expanding tags within `org-make-tags-matcher'
  4385. (org-agenda-prepare (concat "TAGS " match))
  4386. (setq match (car matcher)
  4387. matcher (cdr matcher))
  4388. (org-compile-prefix-format 'tags)
  4389. (org-set-sorting-strategy 'tags)
  4390. (setq org-agenda-query-string match)
  4391. (setq org-agenda-redo-command
  4392. (list 'org-tags-view
  4393. `(quote ,org--matcher-tags-todo-only)
  4394. `(if current-prefix-arg nil ,org-agenda-query-string)))
  4395. (setq files (org-agenda-files nil 'ifmode)
  4396. rtnall nil)
  4397. (while (setq file (pop files))
  4398. (catch 'nextfile
  4399. (org-check-agenda-file file)
  4400. (setq buffer (if (file-exists-p file)
  4401. (org-get-agenda-file-buffer file)
  4402. (error "No such file %s" file)))
  4403. (if (not buffer)
  4404. ;; If file does not exist, error message to agenda
  4405. (setq rtn (list
  4406. (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4407. rtnall (append rtnall rtn))
  4408. (with-current-buffer buffer
  4409. (unless (derived-mode-p 'org-mode)
  4410. (error "Agenda file %s is not in Org mode" file))
  4411. (save-excursion
  4412. (save-restriction
  4413. (if (eq buffer org-agenda-restrict)
  4414. (narrow-to-region org-agenda-restrict-begin
  4415. org-agenda-restrict-end)
  4416. (widen))
  4417. (setq rtn (org-scan-tags 'agenda
  4418. matcher
  4419. org--matcher-tags-todo-only))
  4420. (setq rtnall (append rtnall rtn))))))))
  4421. (org-agenda--insert-overriding-header
  4422. (with-temp-buffer
  4423. (insert "Headlines with TAGS match: ")
  4424. (add-text-properties (point-min) (1- (point))
  4425. (list 'face 'org-agenda-structure
  4426. 'short-heading
  4427. (concat "Match: " match)))
  4428. (setq pos (point))
  4429. (insert match "\n")
  4430. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4431. (setq pos (point))
  4432. (unless org-agenda-multi
  4433. (insert (substitute-command-keys
  4434. "Press \
  4435. \\<org-agenda-mode-map>`\\[universal-argument] \\[org-agenda-redo]' \
  4436. to search again\n")))
  4437. (add-text-properties pos (1- (point))
  4438. (list 'face 'org-agenda-structure))
  4439. (buffer-string)))
  4440. (org-agenda-mark-header-line (point-min))
  4441. (when rtnall
  4442. (insert (org-agenda-finalize-entries rtnall 'tags) "\n"))
  4443. (goto-char (point-min))
  4444. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4445. (add-text-properties
  4446. (point-min) (point-max)
  4447. `(org-agenda-type tags
  4448. org-last-args (,org--matcher-tags-todo-only ,match)
  4449. org-redo-cmd ,org-agenda-redo-command
  4450. org-series-cmd ,org-cmd))
  4451. (org-agenda-finalize)
  4452. (setq buffer-read-only t))))
  4453. ;;; Agenda Finding stuck projects
  4454. (defvar org-agenda-skip-regexp nil
  4455. "Regular expression used in skipping subtrees for the agenda.
  4456. This is basically a temporary global variable that can be set and then
  4457. used by user-defined selections using `org-agenda-skip-function'.")
  4458. (defvar org-agenda-overriding-header nil
  4459. "When set during agenda, todo and tags searches it replaces the header.
  4460. If an empty string, no header will be inserted. If any other
  4461. string, it will be inserted as a header. If nil, a header will
  4462. be generated automatically according to the command. This
  4463. variable should not be set directly, but custom commands can bind
  4464. it in the options section.")
  4465. (defun org-agenda-skip-entry-if (&rest conditions)
  4466. "Skip entry if any of CONDITIONS is true.
  4467. See `org-agenda-skip-if' for details."
  4468. (org-agenda-skip-if nil conditions))
  4469. (defun org-agenda-skip-subtree-if (&rest conditions)
  4470. "Skip subtree if any of CONDITIONS is true.
  4471. See `org-agenda-skip-if' for details."
  4472. (org-agenda-skip-if t conditions))
  4473. (defun org-agenda-skip-if (subtree conditions)
  4474. "Checks current entity for CONDITIONS.
  4475. If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
  4476. the entry (i.e. the text before the next heading) is checked.
  4477. CONDITIONS is a list of symbols, boolean OR is used to combine the results
  4478. from different tests. Valid conditions are:
  4479. scheduled Check if there is a scheduled cookie
  4480. notscheduled Check if there is no scheduled cookie
  4481. deadline Check if there is a deadline
  4482. notdeadline Check if there is no deadline
  4483. timestamp Check if there is a timestamp (also deadline or scheduled)
  4484. nottimestamp Check if there is no timestamp (also deadline or scheduled)
  4485. regexp Check if regexp matches
  4486. notregexp Check if regexp does not match.
  4487. todo Check if TODO keyword matches
  4488. nottodo Check if TODO keyword does not match
  4489. The regexp is taken from the conditions list, it must come right after
  4490. the `regexp' or `notregexp' element.
  4491. `todo' and `nottodo' accept as an argument a list of todo
  4492. keywords, which may include \"*\" to match any todo keyword.
  4493. (org-agenda-skip-entry-if \\='todo \\='(\"TODO\" \"WAITING\"))
  4494. would skip all entries with \"TODO\" or \"WAITING\" keywords.
  4495. Instead of a list, a keyword class may be given. For example:
  4496. (org-agenda-skip-entry-if \\='nottodo \\='done)
  4497. would skip entries that haven't been marked with any of \"DONE\"
  4498. keywords. Possible classes are: `todo', `done', `any'.
  4499. If any of these conditions is met, this function returns the end point of
  4500. the entity, causing the search to continue from there. This is a function
  4501. that can be put into `org-agenda-skip-function' for the duration of a command."
  4502. (org-back-to-heading t)
  4503. (let* ((beg (point))
  4504. (end (if subtree (save-excursion (org-end-of-subtree t) (point))
  4505. (org-entry-end-position)))
  4506. (planning-end (if subtree end (line-end-position 2)))
  4507. m)
  4508. (and
  4509. (or (and (memq 'scheduled conditions)
  4510. (re-search-forward org-scheduled-time-regexp planning-end t))
  4511. (and (memq 'notscheduled conditions)
  4512. (not
  4513. (save-excursion
  4514. (re-search-forward org-scheduled-time-regexp planning-end t))))
  4515. (and (memq 'deadline conditions)
  4516. (re-search-forward org-deadline-time-regexp planning-end t))
  4517. (and (memq 'notdeadline conditions)
  4518. (not
  4519. (save-excursion
  4520. (re-search-forward org-deadline-time-regexp planning-end t))))
  4521. (and (memq 'timestamp conditions)
  4522. (re-search-forward org-ts-regexp end t))
  4523. (and (memq 'nottimestamp conditions)
  4524. (not (save-excursion (re-search-forward org-ts-regexp end t))))
  4525. (and (setq m (memq 'regexp conditions))
  4526. (stringp (nth 1 m))
  4527. (re-search-forward (nth 1 m) end t))
  4528. (and (setq m (memq 'notregexp conditions))
  4529. (stringp (nth 1 m))
  4530. (not (save-excursion (re-search-forward (nth 1 m) end t))))
  4531. (and (or
  4532. (setq m (memq 'nottodo conditions))
  4533. (setq m (memq 'todo-unblocked conditions))
  4534. (setq m (memq 'nottodo-unblocked conditions))
  4535. (setq m (memq 'todo conditions)))
  4536. (org-agenda-skip-if-todo m end)))
  4537. end)))
  4538. (defun org-agenda-skip-if-todo (args end)
  4539. "Helper function for `org-agenda-skip-if', do not use it directly.
  4540. ARGS is a list with first element either `todo', `nottodo',
  4541. `todo-unblocked' or `nottodo-unblocked'. The remainder is either
  4542. a list of TODO keywords, or a state symbol `todo' or `done' or
  4543. `any'."
  4544. (let ((todo-re
  4545. (concat "^\\*+[ \t]+"
  4546. (regexp-opt
  4547. (pcase args
  4548. (`(,_ todo)
  4549. (org-delete-all org-done-keywords
  4550. (copy-sequence org-todo-keywords-1)))
  4551. (`(,_ done) org-done-keywords)
  4552. (`(,_ any) org-todo-keywords-1)
  4553. (`(,_ ,(pred atom))
  4554. (error "Invalid TODO class or type: %S" args))
  4555. (`(,_ ,(pred (member "*"))) org-todo-keywords-1)
  4556. (`(,_ ,todo-list) todo-list))
  4557. 'words))))
  4558. (pcase args
  4559. (`(todo . ,_)
  4560. (let (case-fold-search) (re-search-forward todo-re end t)))
  4561. (`(nottodo . ,_)
  4562. (not (let (case-fold-search) (re-search-forward todo-re end t))))
  4563. (`(todo-unblocked . ,_)
  4564. (catch :unblocked
  4565. (while (let (case-fold-search) (re-search-forward todo-re end t))
  4566. (when (org-entry-blocked-p) (throw :unblocked t)))
  4567. nil))
  4568. (`(nottodo-unblocked . ,_)
  4569. (catch :unblocked
  4570. (while (let (case-fold-search) (re-search-forward todo-re end t))
  4571. (when (org-entry-blocked-p) (throw :unblocked nil)))
  4572. t))
  4573. (`(,type . ,_) (error "Unknown TODO skip type: %S" type)))))
  4574. ;;;###autoload
  4575. (defun org-agenda-list-stuck-projects (&rest ignore)
  4576. "Create agenda view for projects that are stuck.
  4577. Stuck projects are project that have no next actions. For the definitions
  4578. of what a project is and how to check if it stuck, customize the variable
  4579. `org-stuck-projects'."
  4580. (interactive)
  4581. (let* ((org-agenda-overriding-header
  4582. (or org-agenda-overriding-header "List of stuck projects: "))
  4583. (matcher (nth 0 org-stuck-projects))
  4584. (todo (nth 1 org-stuck-projects))
  4585. (tags (nth 2 org-stuck-projects))
  4586. (gen-re (org-string-nw-p (nth 3 org-stuck-projects)))
  4587. (todo-wds
  4588. (if (not (member "*" todo)) todo
  4589. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  4590. (org-delete-all org-done-keywords-for-agenda
  4591. (copy-sequence org-todo-keywords-for-agenda))))
  4592. (todo-re (and todo
  4593. (format "^\\*+[ \t]+\\(%s\\)\\>"
  4594. (mapconcat #'identity todo-wds "\\|"))))
  4595. (tags-re (cond ((null tags) nil)
  4596. ((member "*" tags) org-tag-line-re)
  4597. (tags
  4598. (let ((other-tags (format "\\(?:%s:\\)*" org-tag-re)))
  4599. (concat org-outline-regexp-bol
  4600. ".*?[ \t]:"
  4601. other-tags
  4602. (regexp-opt tags t)
  4603. ":" other-tags "[ \t]*$")))
  4604. (t nil)))
  4605. (re-list (delq nil (list todo-re tags-re gen-re)))
  4606. (skip-re
  4607. (if (null re-list)
  4608. (error "Missing information to identify unstuck projects")
  4609. (mapconcat #'identity re-list "\\|")))
  4610. (org-agenda-skip-function
  4611. ;; Skip entry if `org-agenda-skip-regexp' matches anywhere
  4612. ;; in the subtree.
  4613. `(lambda ()
  4614. (and (save-excursion
  4615. (let ((case-fold-search nil))
  4616. (re-search-forward
  4617. ,skip-re (save-excursion (org-end-of-subtree t)) t)))
  4618. (progn (outline-next-heading) (point))))))
  4619. (org-tags-view nil matcher)
  4620. (setq org-agenda-buffer-name (buffer-name))
  4621. (with-current-buffer org-agenda-buffer-name
  4622. (setq org-agenda-redo-command
  4623. `(org-agenda-list-stuck-projects ,current-prefix-arg))
  4624. (let ((inhibit-read-only t))
  4625. (add-text-properties
  4626. (point-min) (point-max)
  4627. `(org-redo-cmd ,org-agenda-redo-command))))))
  4628. ;;; Diary integration
  4629. (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
  4630. (defvar diary-list-entries-hook)
  4631. (defvar diary-time-regexp)
  4632. (defun org-get-entries-from-diary (date)
  4633. "Get the (Emacs Calendar) diary entries for DATE."
  4634. (require 'diary-lib)
  4635. (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
  4636. (diary-display-function 'diary-fancy-display)
  4637. (pop-up-frames nil)
  4638. (diary-list-entries-hook
  4639. (cons 'org-diary-default-entry diary-list-entries-hook))
  4640. (diary-file-name-prefix nil) ; turn this feature off
  4641. (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
  4642. entries
  4643. (org-disable-agenda-to-diary t))
  4644. (save-excursion
  4645. (save-window-excursion
  4646. (funcall (if (fboundp 'diary-list-entries)
  4647. 'diary-list-entries 'list-diary-entries)
  4648. date 1)))
  4649. (if (not (get-buffer diary-fancy-buffer))
  4650. (setq entries nil)
  4651. (with-current-buffer diary-fancy-buffer
  4652. (setq buffer-read-only nil)
  4653. (if (zerop (buffer-size))
  4654. ;; No entries
  4655. (setq entries nil)
  4656. ;; Omit the date and other unnecessary stuff
  4657. (org-agenda-cleanup-fancy-diary)
  4658. ;; Add prefix to each line and extend the text properties
  4659. (if (zerop (buffer-size))
  4660. (setq entries nil)
  4661. (setq entries (buffer-substring (point-min) (- (point-max) 1)))
  4662. (setq entries
  4663. (with-temp-buffer
  4664. (insert entries) (goto-char (point-min))
  4665. (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
  4666. (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
  4667. (replace-match (concat "; " (match-string 1)))))
  4668. (buffer-string)))))
  4669. (set-buffer-modified-p nil)
  4670. (kill-buffer diary-fancy-buffer)))
  4671. (when entries
  4672. (setq entries (org-split-string entries "\n"))
  4673. (setq entries
  4674. (mapcar
  4675. (lambda (x)
  4676. (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
  4677. ;; Extend the text properties to the beginning of the line
  4678. (org-add-props x (text-properties-at (1- (length x)) x)
  4679. 'type "diary" 'date date 'face 'org-agenda-diary))
  4680. entries)))))
  4681. (defvar org-agenda-cleanup-fancy-diary-hook nil
  4682. "Hook run when the fancy diary buffer is cleaned up.")
  4683. (defun org-agenda-cleanup-fancy-diary ()
  4684. "Remove unwanted stuff in buffer created by `fancy-diary-display'.
  4685. This gets rid of the date, the underline under the date, and the
  4686. dummy entry installed by Org mode to ensure non-empty diary for
  4687. each date. It also removes lines that contain only whitespace."
  4688. (goto-char (point-min))
  4689. (if (looking-at ".*?:[ \t]*")
  4690. (progn
  4691. (replace-match "")
  4692. (re-search-forward "\n=+$" nil t)
  4693. (replace-match "")
  4694. (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
  4695. (re-search-forward "\n=+$" nil t)
  4696. (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
  4697. (goto-char (point-min))
  4698. (while (re-search-forward "^ +\n" nil t)
  4699. (replace-match ""))
  4700. (goto-char (point-min))
  4701. (when (re-search-forward "^Org mode dummy\n?" nil t)
  4702. (replace-match ""))
  4703. (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
  4704. (defun org-modify-diary-entry-string (string)
  4705. "Add text properties to string, allowing Org to act on it."
  4706. (org-add-props string nil
  4707. 'mouse-face 'highlight
  4708. 'help-echo (if buffer-file-name
  4709. (format "mouse-2 or RET jump to diary file %s"
  4710. (abbreviate-file-name buffer-file-name))
  4711. "")
  4712. 'org-agenda-diary-link t
  4713. 'org-marker (org-agenda-new-marker (point-at-bol))))
  4714. (defun org-diary-default-entry ()
  4715. "Add a dummy entry to the diary.
  4716. Needed to avoid empty dates which mess up holiday display."
  4717. ;; Catch the error if dealing with the new add-to-diary-alist
  4718. (when org-disable-agenda-to-diary
  4719. (condition-case nil
  4720. (org-add-to-diary-list original-date "Org mode dummy" "")
  4721. (error
  4722. (org-add-to-diary-list original-date "Org mode dummy" "" nil)))))
  4723. (defun org-add-to-diary-list (&rest args)
  4724. (if (fboundp 'diary-add-to-list)
  4725. (apply 'diary-add-to-list args)
  4726. (apply 'add-to-diary-list args)))
  4727. (defvar org-diary-last-run-time nil)
  4728. ;;;###autoload
  4729. (defun org-diary (&rest args)
  4730. "Return diary information from org files.
  4731. This function can be used in a \"sexp\" diary entry in the Emacs calendar.
  4732. It accesses org files and extracts information from those files to be
  4733. listed in the diary. The function accepts arguments specifying what
  4734. items should be listed. For a list of arguments allowed here, see the
  4735. variable `org-agenda-entry-types'.
  4736. The call in the diary file should look like this:
  4737. &%%(org-diary) ~/path/to/some/orgfile.org
  4738. Use a separate line for each org file to check. Or, if you omit the file name,
  4739. all files listed in `org-agenda-files' will be checked automatically:
  4740. &%%(org-diary)
  4741. If you don't give any arguments (as in the example above), the default value
  4742. of `org-agenda-entry-types' is used: (:deadline :scheduled :timestamp :sexp).
  4743. So the example above may also be written as
  4744. &%%(org-diary :deadline :timestamp :sexp :scheduled)
  4745. The function expects the lisp variables `entry' and `date' to be provided
  4746. by the caller, because this is how the calendar works. Don't use this
  4747. function from a program - use `org-agenda-get-day-entries' instead."
  4748. (when (> (- (float-time)
  4749. org-agenda-last-marker-time)
  4750. 5)
  4751. ;; I am not sure if this works with sticky agendas, because the marker
  4752. ;; list is then no longer a global variable.
  4753. (org-agenda-reset-markers))
  4754. (org-compile-prefix-format 'agenda)
  4755. (org-set-sorting-strategy 'agenda)
  4756. (setq args (or args org-agenda-entry-types))
  4757. (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
  4758. (list entry)
  4759. (org-agenda-files t)))
  4760. (time (float-time))
  4761. file rtn results)
  4762. (when (or (not org-diary-last-run-time)
  4763. (> (- time
  4764. org-diary-last-run-time)
  4765. 3))
  4766. (org-agenda-prepare-buffers files))
  4767. (setq org-diary-last-run-time time)
  4768. ;; If this is called during org-agenda, don't return any entries to
  4769. ;; the calendar. Org Agenda will list these entries itself.
  4770. (when org-disable-agenda-to-diary (setq files nil))
  4771. (while (setq file (pop files))
  4772. (setq rtn (apply 'org-agenda-get-day-entries file date args))
  4773. (setq results (append results rtn)))
  4774. (when results
  4775. (setq results
  4776. (mapcar (lambda (i) (replace-regexp-in-string
  4777. org-bracket-link-regexp "\\3" i)) results))
  4778. (concat (org-agenda-finalize-entries results) "\n"))))
  4779. ;;; Agenda entry finders
  4780. (defun org-agenda--timestamp-to-absolute (&rest args)
  4781. "Call `org-time-string-to-absolute' with ARGS.
  4782. However, throw `:skip' whenever an error is raised."
  4783. (condition-case e
  4784. (apply #'org-time-string-to-absolute args)
  4785. (org-diary-sexp-no-match (throw :skip nil))
  4786. (error
  4787. (message "%s; Skipping entry" (error-message-string e))
  4788. (throw :skip nil))))
  4789. (defun org-agenda-get-day-entries (file date &rest args)
  4790. "Does the work for `org-diary' and `org-agenda'.
  4791. FILE is the path to a file to be checked for entries. DATE is date like
  4792. the one returned by `calendar-current-date'. ARGS are symbols indicating
  4793. which kind of entries should be extracted. For details about these, see
  4794. the documentation of `org-diary'."
  4795. (let* ((org-startup-folded nil)
  4796. (org-startup-align-all-tables nil)
  4797. (buffer (if (file-exists-p file) (org-get-agenda-file-buffer file)
  4798. (error "No such file %s" file))))
  4799. (if (not buffer)
  4800. ;; If file does not exist, signal it in diary nonetheless.
  4801. (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4802. (with-current-buffer buffer
  4803. (unless (derived-mode-p 'org-mode)
  4804. (error "Agenda file %s is not in Org mode" file))
  4805. (setq org-agenda-buffer (or org-agenda-buffer buffer))
  4806. (setf org-agenda-current-date date)
  4807. (save-excursion
  4808. (save-restriction
  4809. (if (eq buffer org-agenda-restrict)
  4810. (narrow-to-region org-agenda-restrict-begin
  4811. org-agenda-restrict-end)
  4812. (widen))
  4813. ;; Rationalize ARGS. Also make sure `:deadline' comes
  4814. ;; first in order to populate DEADLINES before passing it.
  4815. ;;
  4816. ;; We use `delq' since `org-uniquify' duplicates ARGS,
  4817. ;; guarding us from modifying `org-agenda-entry-types'.
  4818. (setf args (org-uniquify (or args org-agenda-entry-types)))
  4819. (when (and (memq :scheduled args) (memq :scheduled* args))
  4820. (setf args (delq :scheduled* args)))
  4821. (cond
  4822. ((memq :deadline args)
  4823. (setf args (cons :deadline
  4824. (delq :deadline (delq :deadline* args)))))
  4825. ((memq :deadline* args)
  4826. (setf args (cons :deadline* (delq :deadline* args)))))
  4827. ;; Collect list of headlines. Return them flattened.
  4828. (let ((case-fold-search nil) results deadlines)
  4829. (dolist (arg args (apply #'nconc (nreverse results)))
  4830. (pcase arg
  4831. ((and :todo (guard (org-agenda-today-p date)))
  4832. (push (org-agenda-get-todos) results))
  4833. (:timestamp
  4834. (push (org-agenda-get-blocks) results)
  4835. (push (org-agenda-get-timestamps deadlines) results))
  4836. (:sexp
  4837. (push (org-agenda-get-sexps) results))
  4838. (:scheduled
  4839. (push (org-agenda-get-scheduled deadlines) results))
  4840. (:scheduled*
  4841. (push (org-agenda-get-scheduled deadlines t) results))
  4842. (:closed
  4843. (push (org-agenda-get-progress) results))
  4844. (:deadline
  4845. (setf deadlines (org-agenda-get-deadlines))
  4846. (push deadlines results))
  4847. (:deadline*
  4848. (setf deadlines (org-agenda-get-deadlines t))
  4849. (push deadlines results)))))))))))
  4850. (defsubst org-em (x y list)
  4851. "Is X or Y a member of LIST?"
  4852. (or (memq x list) (memq y list)))
  4853. (defvar org-heading-keyword-regexp-format) ; defined in org.el
  4854. (defvar org-agenda-sorting-strategy-selected nil)
  4855. (defun org-agenda-entry-get-agenda-timestamp (pom)
  4856. "Retrieve timestamp information for sorting agenda views.
  4857. Given a point or marker POM, returns a cons cell of the timestamp
  4858. and the timestamp type relevant for the sorting strategy in
  4859. `org-agenda-sorting-strategy-selected'."
  4860. (let (ts ts-date-type)
  4861. (save-match-data
  4862. (cond ((org-em 'scheduled-up 'scheduled-down
  4863. org-agenda-sorting-strategy-selected)
  4864. (setq ts (org-entry-get pom "SCHEDULED")
  4865. ts-date-type " scheduled"))
  4866. ((org-em 'deadline-up 'deadline-down
  4867. org-agenda-sorting-strategy-selected)
  4868. (setq ts (org-entry-get pom "DEADLINE")
  4869. ts-date-type " deadline"))
  4870. ((org-em 'ts-up 'ts-down
  4871. org-agenda-sorting-strategy-selected)
  4872. (setq ts (org-entry-get pom "TIMESTAMP")
  4873. ts-date-type " timestamp"))
  4874. ((org-em 'tsia-up 'tsia-down
  4875. org-agenda-sorting-strategy-selected)
  4876. (setq ts (org-entry-get pom "TIMESTAMP_IA")
  4877. ts-date-type " timestamp_ia"))
  4878. ((org-em 'timestamp-up 'timestamp-down
  4879. org-agenda-sorting-strategy-selected)
  4880. (setq ts (or (org-entry-get pom "SCHEDULED")
  4881. (org-entry-get pom "DEADLINE")
  4882. (org-entry-get pom "TIMESTAMP")
  4883. (org-entry-get pom "TIMESTAMP_IA"))
  4884. ts-date-type ""))
  4885. (t (setq ts-date-type "")))
  4886. (cons (when ts (ignore-errors (org-time-string-to-absolute ts)))
  4887. ts-date-type))))
  4888. (defun org-agenda-get-todos ()
  4889. "Return the TODO information for agenda display."
  4890. (let* ((props (list 'face nil
  4891. 'done-face 'org-agenda-done
  4892. 'org-not-done-regexp org-not-done-regexp
  4893. 'org-todo-regexp org-todo-regexp
  4894. 'org-complex-heading-regexp org-complex-heading-regexp
  4895. 'mouse-face 'highlight
  4896. 'help-echo
  4897. (format "mouse-2 or RET jump to org file %s"
  4898. (abbreviate-file-name buffer-file-name))))
  4899. (case-fold-search nil)
  4900. (regexp (format org-heading-keyword-regexp-format
  4901. (cond
  4902. ((and org-select-this-todo-keyword
  4903. (equal org-select-this-todo-keyword "*"))
  4904. org-todo-regexp)
  4905. (org-select-this-todo-keyword
  4906. (concat "\\("
  4907. (mapconcat 'identity
  4908. (org-split-string
  4909. org-select-this-todo-keyword
  4910. "|")
  4911. "\\|") "\\)"))
  4912. (t org-not-done-regexp))))
  4913. marker priority category level tags todo-state
  4914. ts-date ts-date-type ts-date-pair
  4915. ee txt beg end inherited-tags todo-state-end-pos)
  4916. (goto-char (point-min))
  4917. (while (re-search-forward regexp nil t)
  4918. (catch :skip
  4919. (save-match-data
  4920. (beginning-of-line)
  4921. (org-agenda-skip)
  4922. (setq beg (point) end (save-excursion (outline-next-heading) (point)))
  4923. (unless (and (setq todo-state (org-get-todo-state))
  4924. (setq todo-state-end-pos (match-end 2)))
  4925. (goto-char end)
  4926. (throw :skip nil))
  4927. (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
  4928. (goto-char (1+ beg))
  4929. (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
  4930. (throw :skip nil)))
  4931. (goto-char (match-beginning 2))
  4932. (setq marker (org-agenda-new-marker (match-beginning 0))
  4933. category (org-get-category)
  4934. ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
  4935. ts-date (car ts-date-pair)
  4936. ts-date-type (cdr ts-date-pair)
  4937. txt (org-trim (buffer-substring (match-beginning 2) (match-end 0)))
  4938. inherited-tags
  4939. (or (eq org-agenda-show-inherited-tags 'always)
  4940. (and (listp org-agenda-show-inherited-tags)
  4941. (memq 'todo org-agenda-show-inherited-tags))
  4942. (and (eq org-agenda-show-inherited-tags t)
  4943. (or (eq org-agenda-use-tag-inheritance t)
  4944. (memq 'todo org-agenda-use-tag-inheritance))))
  4945. tags (org-get-tags nil (not inherited-tags))
  4946. level (make-string (org-reduced-level (org-outline-level)) ? )
  4947. txt (org-agenda-format-item "" txt level category tags t)
  4948. priority (1+ (org-get-priority txt)))
  4949. (org-add-props txt props
  4950. 'org-marker marker 'org-hd-marker marker
  4951. 'priority priority
  4952. 'level level
  4953. 'ts-date ts-date
  4954. 'type (concat "todo" ts-date-type) 'todo-state todo-state)
  4955. (push txt ee)
  4956. (if org-agenda-todo-list-sublevels
  4957. (goto-char todo-state-end-pos)
  4958. (org-end-of-subtree 'invisible))))
  4959. (nreverse ee)))
  4960. (defun org-agenda-todo-custom-ignore-p (time n)
  4961. "Check whether timestamp is farther away than n number of days.
  4962. This function is invoked if `org-agenda-todo-ignore-deadlines',
  4963. `org-agenda-todo-ignore-scheduled' or
  4964. `org-agenda-todo-ignore-timestamp' is set to an integer."
  4965. (let ((days (org-time-stamp-to-now
  4966. time org-agenda-todo-ignore-time-comparison-use-seconds)))
  4967. (if (>= n 0)
  4968. (>= days n)
  4969. (<= days n))))
  4970. ;;;###autoload
  4971. (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  4972. (&optional end)
  4973. "Do we have a reason to ignore this TODO entry because it has a time stamp?"
  4974. (when (or org-agenda-todo-ignore-with-date
  4975. org-agenda-todo-ignore-scheduled
  4976. org-agenda-todo-ignore-deadlines
  4977. org-agenda-todo-ignore-timestamp)
  4978. (setq end (or end (save-excursion (outline-next-heading) (point))))
  4979. (save-excursion
  4980. (or (and org-agenda-todo-ignore-with-date
  4981. (re-search-forward org-ts-regexp end t))
  4982. (and org-agenda-todo-ignore-scheduled
  4983. (re-search-forward org-scheduled-time-regexp end t)
  4984. (cond
  4985. ((eq org-agenda-todo-ignore-scheduled 'future)
  4986. (> (org-time-stamp-to-now
  4987. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4988. ((eq org-agenda-todo-ignore-scheduled 'past)
  4989. (<= (org-time-stamp-to-now
  4990. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4991. ((numberp org-agenda-todo-ignore-scheduled)
  4992. (org-agenda-todo-custom-ignore-p
  4993. (match-string 1) org-agenda-todo-ignore-scheduled))
  4994. (t)))
  4995. (and org-agenda-todo-ignore-deadlines
  4996. (re-search-forward org-deadline-time-regexp end t)
  4997. (cond
  4998. ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
  4999. ((eq org-agenda-todo-ignore-deadlines 'far)
  5000. (not (org-deadline-close-p (match-string 1))))
  5001. ((eq org-agenda-todo-ignore-deadlines 'future)
  5002. (> (org-time-stamp-to-now
  5003. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5004. ((eq org-agenda-todo-ignore-deadlines 'past)
  5005. (<= (org-time-stamp-to-now
  5006. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5007. ((numberp org-agenda-todo-ignore-deadlines)
  5008. (org-agenda-todo-custom-ignore-p
  5009. (match-string 1) org-agenda-todo-ignore-deadlines))
  5010. (t (org-deadline-close-p (match-string 1)))))
  5011. (and org-agenda-todo-ignore-timestamp
  5012. (let ((buffer (current-buffer))
  5013. (regexp
  5014. (concat
  5015. org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
  5016. (start (point)))
  5017. ;; Copy current buffer into a temporary one
  5018. (with-temp-buffer
  5019. (insert-buffer-substring buffer start end)
  5020. (goto-char (point-min))
  5021. ;; Delete SCHEDULED and DEADLINE items
  5022. (while (re-search-forward regexp end t)
  5023. (delete-region (match-beginning 0) (match-end 0)))
  5024. (goto-char (point-min))
  5025. ;; No search for timestamp left
  5026. (when (re-search-forward org-ts-regexp nil t)
  5027. (cond
  5028. ((eq org-agenda-todo-ignore-timestamp 'future)
  5029. (> (org-time-stamp-to-now
  5030. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5031. ((eq org-agenda-todo-ignore-timestamp 'past)
  5032. (<= (org-time-stamp-to-now
  5033. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5034. ((numberp org-agenda-todo-ignore-timestamp)
  5035. (org-agenda-todo-custom-ignore-p
  5036. (match-string 1) org-agenda-todo-ignore-timestamp))
  5037. (t))))))))))
  5038. (defun org-agenda-get-timestamps (&optional deadlines)
  5039. "Return the date stamp information for agenda display.
  5040. Optional argument DEADLINES is a list of deadline items to be
  5041. displayed in agenda view."
  5042. (let* ((props (list 'face 'org-agenda-calendar-event
  5043. 'org-not-done-regexp org-not-done-regexp
  5044. 'org-todo-regexp org-todo-regexp
  5045. 'org-complex-heading-regexp org-complex-heading-regexp
  5046. 'mouse-face 'highlight
  5047. 'help-echo
  5048. (format "mouse-2 or RET jump to Org file %s"
  5049. (abbreviate-file-name buffer-file-name))))
  5050. (current (calendar-absolute-from-gregorian date))
  5051. (today (org-today))
  5052. (deadline-position-alist
  5053. (mapcar (lambda (d)
  5054. (let ((m (get-text-property 0 'org-hd-marker d)))
  5055. (and m (marker-position m))))
  5056. deadlines))
  5057. ;; Match time-stamps set to current date, time-stamps with
  5058. ;; a repeater, and S-exp time-stamps.
  5059. (regexp
  5060. (concat
  5061. (if org-agenda-include-inactive-timestamps "[[<]" "<")
  5062. (regexp-quote
  5063. (substring
  5064. (format-time-string
  5065. (car org-time-stamp-formats)
  5066. (apply #'encode-time ; DATE bound by calendar
  5067. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  5068. 1 11))
  5069. "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
  5070. "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
  5071. timestamp-items)
  5072. (goto-char (point-min))
  5073. (while (re-search-forward regexp nil t)
  5074. ;; Skip date ranges, scheduled and deadlines, which are handled
  5075. ;; specially. Also skip time-stamps before first headline as
  5076. ;; there would be no entry to add to the agenda. Eventually,
  5077. ;; ignore clock entries.
  5078. (catch :skip
  5079. (save-match-data
  5080. (when (or (org-at-date-range-p)
  5081. (org-at-planning-p)
  5082. (org-before-first-heading-p)
  5083. (and org-agenda-include-inactive-timestamps
  5084. (org-at-clock-log-p)))
  5085. (throw :skip nil))
  5086. (org-agenda-skip))
  5087. (let* ((pos (match-beginning 0))
  5088. (repeat (match-string 1))
  5089. (sexp-entry (match-string 3))
  5090. (time-stamp (if (or repeat sexp-entry) (match-string 0)
  5091. (save-excursion
  5092. (goto-char pos)
  5093. (looking-at org-ts-regexp-both)
  5094. (match-string 0))))
  5095. (todo-state (org-get-todo-state))
  5096. (warntime (get-text-property (point) 'org-appt-warntime))
  5097. (done? (member todo-state org-done-keywords)))
  5098. ;; Possibly skip done tasks.
  5099. (when (and done? org-agenda-skip-timestamp-if-done)
  5100. (throw :skip t))
  5101. ;; S-exp entry doesn't match current day: skip it.
  5102. (when (and sexp-entry (not (org-diary-sexp-entry sexp-entry "" date)))
  5103. (throw :skip nil))
  5104. (when repeat
  5105. (let* ((past
  5106. ;; A repeating time stamp is shown at its base
  5107. ;; date and every repeated date up to TODAY. If
  5108. ;; `org-agenda-prefer-last-repeat' is non-nil,
  5109. ;; however, only the last repeat before today
  5110. ;; (inclusive) is shown.
  5111. (org-agenda--timestamp-to-absolute
  5112. repeat
  5113. (if (or (> current today)
  5114. (eq org-agenda-prefer-last-repeat t)
  5115. (member todo-state org-agenda-prefer-last-repeat))
  5116. today
  5117. current)
  5118. 'past (current-buffer) pos))
  5119. (future
  5120. ;; Display every repeated date past TODAY
  5121. ;; (exclusive) unless
  5122. ;; `org-agenda-show-future-repeats' is nil. If
  5123. ;; this variable is set to `next', only display
  5124. ;; the first repeated date after TODAY
  5125. ;; (exclusive).
  5126. (cond
  5127. ((<= current today) past)
  5128. ((not org-agenda-show-future-repeats) past)
  5129. (t
  5130. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5131. (1+ today)
  5132. current)))
  5133. (org-agenda--timestamp-to-absolute
  5134. repeat base 'future (current-buffer) pos))))))
  5135. (when (and (/= current past) (/= current future))
  5136. (throw :skip nil))))
  5137. (save-excursion
  5138. (re-search-backward org-outline-regexp-bol nil t)
  5139. ;; Possibly skip time-stamp when a deadline is set.
  5140. (when (and org-agenda-skip-timestamp-if-deadline-is-shown
  5141. (assq (point) deadline-position-alist))
  5142. (throw :skip nil))
  5143. (let* ((category (org-get-category pos))
  5144. (inherited-tags
  5145. (or (eq org-agenda-show-inherited-tags 'always)
  5146. (and (consp org-agenda-show-inherited-tags)
  5147. (memq 'agenda org-agenda-show-inherited-tags))
  5148. (and (eq org-agenda-show-inherited-tags t)
  5149. (or (eq org-agenda-use-tag-inheritance t)
  5150. (memq 'agenda
  5151. org-agenda-use-tag-inheritance)))))
  5152. (tags (org-get-tags nil (not inherited-tags)))
  5153. (level (make-string (org-reduced-level (org-outline-level))
  5154. ?\s))
  5155. (head (and (looking-at "\\*+[ \t]+\\(.*\\)")
  5156. (match-string 1)))
  5157. (inactive? (= (char-after pos) ?\[))
  5158. (habit? (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  5159. (item
  5160. (org-agenda-format-item
  5161. (and inactive? org-agenda-inactive-leader)
  5162. head level category tags time-stamp org-ts-regexp habit?)))
  5163. (org-add-props item props
  5164. 'priority (if habit?
  5165. (org-habit-get-priority (org-habit-parse-todo))
  5166. (org-get-priority item))
  5167. 'org-marker (org-agenda-new-marker pos)
  5168. 'org-hd-marker (org-agenda-new-marker)
  5169. 'date date
  5170. 'level level
  5171. 'ts-date (if repeat (org-agenda--timestamp-to-absolute repeat)
  5172. current)
  5173. 'todo-state todo-state
  5174. 'warntime warntime
  5175. 'type "timestamp")
  5176. (push item timestamp-items))))
  5177. (when org-agenda-skip-additional-timestamps-same-entry
  5178. (outline-next-heading))))
  5179. (nreverse timestamp-items)))
  5180. (defun org-agenda-get-sexps ()
  5181. "Return the sexp information for agenda display."
  5182. (require 'diary-lib)
  5183. (let* ((props (list 'face 'org-agenda-calendar-sexp
  5184. 'mouse-face 'highlight
  5185. 'help-echo
  5186. (format "mouse-2 or RET jump to org file %s"
  5187. (abbreviate-file-name buffer-file-name))))
  5188. (regexp "^&?%%(")
  5189. marker category extra level ee txt tags entry
  5190. result beg b sexp sexp-entry todo-state warntime inherited-tags)
  5191. (goto-char (point-min))
  5192. (while (re-search-forward regexp nil t)
  5193. (catch :skip
  5194. (org-agenda-skip)
  5195. (setq beg (match-beginning 0))
  5196. (goto-char (1- (match-end 0)))
  5197. (setq b (point))
  5198. (forward-sexp 1)
  5199. (setq sexp (buffer-substring b (point)))
  5200. (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
  5201. (org-trim (match-string 1))
  5202. ""))
  5203. (setq result (org-diary-sexp-entry sexp sexp-entry date))
  5204. (when result
  5205. (setq marker (org-agenda-new-marker beg)
  5206. level (make-string (org-reduced-level (org-outline-level)) ? )
  5207. category (org-get-category beg)
  5208. inherited-tags
  5209. (or (eq org-agenda-show-inherited-tags 'always)
  5210. (and (listp org-agenda-show-inherited-tags)
  5211. (memq 'agenda org-agenda-show-inherited-tags))
  5212. (and (eq org-agenda-show-inherited-tags t)
  5213. (or (eq org-agenda-use-tag-inheritance t)
  5214. (memq 'agenda org-agenda-use-tag-inheritance))))
  5215. tags (org-get-tags nil (not inherited-tags))
  5216. todo-state (org-get-todo-state)
  5217. warntime (get-text-property (point) 'org-appt-warntime)
  5218. extra nil)
  5219. (dolist (r (if (stringp result)
  5220. (list result)
  5221. result)) ;; we expect a list here
  5222. (when (and org-agenda-diary-sexp-prefix
  5223. (string-match org-agenda-diary-sexp-prefix r))
  5224. (setq extra (match-string 0 r)
  5225. r (replace-match "" nil nil r)))
  5226. (if (string-match "\\S-" r)
  5227. (setq txt r)
  5228. (setq txt "SEXP entry returned empty string"))
  5229. (setq txt (org-agenda-format-item extra txt level category tags 'time))
  5230. (org-add-props txt props 'org-marker marker
  5231. 'date date 'todo-state todo-state
  5232. 'level level 'type "sexp" 'warntime warntime)
  5233. (push txt ee)))))
  5234. (nreverse ee)))
  5235. ;; Calendar sanity: define some functions that are independent of
  5236. ;; `calendar-date-style'.
  5237. (defun org-anniversary (year month day &optional mark)
  5238. "Like `diary-anniversary', but with fixed (ISO) order of arguments."
  5239. (with-no-warnings
  5240. (let ((calendar-date-style 'iso))
  5241. (diary-anniversary year month day mark))))
  5242. (defun org-cyclic (N year month day &optional mark)
  5243. "Like `diary-cyclic', but with fixed (ISO) order of arguments."
  5244. (with-no-warnings
  5245. (let ((calendar-date-style 'iso))
  5246. (diary-cyclic N year month day mark))))
  5247. (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
  5248. "Like `diary-block', but with fixed (ISO) order of arguments."
  5249. (with-no-warnings
  5250. (let ((calendar-date-style 'iso))
  5251. (diary-block Y1 M1 D1 Y2 M2 D2 mark))))
  5252. (defun org-date (year month day &optional mark)
  5253. "Like `diary-date', but with fixed (ISO) order of arguments."
  5254. (with-no-warnings
  5255. (let ((calendar-date-style 'iso))
  5256. (diary-date year month day mark))))
  5257. ;; Define the `org-class' function
  5258. (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
  5259. "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
  5260. DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
  5261. SKIP-WEEKS is any number of ISO weeks in the block period for which the
  5262. item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
  5263. `holidays', then any date that is known by the Emacs calendar to be a
  5264. holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
  5265. then those holidays will be skipped."
  5266. (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
  5267. (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
  5268. (d (calendar-absolute-from-gregorian date))
  5269. (h (when skip-weeks (calendar-check-holidays date))))
  5270. (and
  5271. (<= date1 d)
  5272. (<= d date2)
  5273. (= (calendar-day-of-week date) dayname)
  5274. (or (not skip-weeks)
  5275. (progn
  5276. (require 'cal-iso)
  5277. (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
  5278. (not (or (and h (memq 'holidays skip-weeks))
  5279. (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
  5280. entry)))
  5281. (defalias 'org-get-closed 'org-agenda-get-progress)
  5282. (defun org-agenda-get-progress ()
  5283. "Return the logged TODO entries for agenda display."
  5284. (let* ((props (list 'mouse-face 'highlight
  5285. 'org-not-done-regexp org-not-done-regexp
  5286. 'org-todo-regexp org-todo-regexp
  5287. 'org-complex-heading-regexp org-complex-heading-regexp
  5288. 'help-echo
  5289. (format "mouse-2 or RET jump to org file %s"
  5290. (abbreviate-file-name buffer-file-name))))
  5291. (items (if (consp org-agenda-show-log-scoped)
  5292. org-agenda-show-log-scoped
  5293. (if (eq org-agenda-show-log-scoped 'clockcheck)
  5294. '(clock)
  5295. org-agenda-log-mode-items)))
  5296. (parts
  5297. (delq nil
  5298. (list
  5299. (when (memq 'closed items) (concat "\\<" org-closed-string))
  5300. (when (memq 'clock items) (concat "\\<" org-clock-string))
  5301. (when (memq 'state items)
  5302. (format "- +State \"%s\".*?" org-todo-regexp)))))
  5303. (parts-re (if parts (mapconcat 'identity parts "\\|")
  5304. (error "`org-agenda-log-mode-items' is empty")))
  5305. (regexp (concat
  5306. "\\(" parts-re "\\)"
  5307. " *\\["
  5308. (regexp-quote
  5309. (substring
  5310. (format-time-string
  5311. (car org-time-stamp-formats)
  5312. (apply 'encode-time ; DATE bound by calendar
  5313. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  5314. 1 11))))
  5315. (org-agenda-search-headline-for-time nil)
  5316. marker hdmarker priority category level tags closedp type
  5317. statep clockp state ee txt extra timestr rest clocked inherited-tags)
  5318. (goto-char (point-min))
  5319. (while (re-search-forward regexp nil t)
  5320. (catch :skip
  5321. (org-agenda-skip)
  5322. (setq marker (org-agenda-new-marker (match-beginning 0))
  5323. closedp (equal (match-string 1) org-closed-string)
  5324. statep (equal (string-to-char (match-string 1)) ?-)
  5325. clockp (not (or closedp statep))
  5326. state (and statep (match-string 2))
  5327. category (org-get-category (match-beginning 0))
  5328. timestr (buffer-substring (match-beginning 0) (point-at-eol)))
  5329. (when (string-match "\\]" timestr)
  5330. ;; substring should only run to end of time stamp
  5331. (setq rest (substring timestr (match-end 0))
  5332. timestr (substring timestr 0 (match-end 0)))
  5333. (if (and (not closedp) (not statep)
  5334. (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
  5335. rest))
  5336. (progn (setq timestr (concat (substring timestr 0 -1)
  5337. "-" (match-string 1 rest) "]"))
  5338. (setq clocked (match-string 2 rest)))
  5339. (setq clocked "-")))
  5340. (save-excursion
  5341. (setq extra
  5342. (cond
  5343. ((not org-agenda-log-mode-add-notes) nil)
  5344. (statep
  5345. (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
  5346. (match-string 1)))
  5347. (clockp
  5348. (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
  5349. (match-string 1)))))
  5350. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5351. (throw :skip nil)
  5352. (goto-char (match-beginning 0))
  5353. (setq hdmarker (org-agenda-new-marker)
  5354. inherited-tags
  5355. (or (eq org-agenda-show-inherited-tags 'always)
  5356. (and (listp org-agenda-show-inherited-tags)
  5357. (memq 'todo org-agenda-show-inherited-tags))
  5358. (and (eq org-agenda-show-inherited-tags t)
  5359. (or (eq org-agenda-use-tag-inheritance t)
  5360. (memq 'todo org-agenda-use-tag-inheritance))))
  5361. tags (org-get-tags nil (not inherited-tags))
  5362. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5363. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5364. (setq txt (match-string 1))
  5365. (when extra
  5366. (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
  5367. (setq txt (concat (substring txt 0 (match-beginning 1))
  5368. " - " extra " " (match-string 2 txt)))
  5369. (setq txt (concat txt " - " extra))))
  5370. (setq txt (org-agenda-format-item
  5371. (cond
  5372. (closedp "Closed: ")
  5373. (statep (concat "State: (" state ")"))
  5374. (t (concat "Clocked: (" clocked ")")))
  5375. txt level category tags timestr)))
  5376. (setq type (cond (closedp "closed")
  5377. (statep "state")
  5378. (t "clock")))
  5379. (setq priority 100000)
  5380. (org-add-props txt props
  5381. 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
  5382. 'priority priority 'level level
  5383. 'type type 'date date
  5384. 'undone-face 'org-warning 'done-face 'org-agenda-done)
  5385. (push txt ee))
  5386. (goto-char (point-at-eol))))
  5387. (nreverse ee)))
  5388. (defun org-agenda-show-clocking-issues ()
  5389. "Add overlays, showing issues with clocking.
  5390. See also the user option `org-agenda-clock-consistency-checks'."
  5391. (interactive)
  5392. (let* ((pl org-agenda-clock-consistency-checks)
  5393. (re (concat "^[ \t]*"
  5394. org-clock-string
  5395. "[ \t]+"
  5396. "\\(\\[.*?\\]\\)" ; group 1 is first stamp
  5397. "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
  5398. (tlstart 0.)
  5399. (tlend 0.)
  5400. (maxtime (org-duration-to-minutes
  5401. (or (plist-get pl :max-duration) "24:00")))
  5402. (mintime (org-duration-to-minutes
  5403. (or (plist-get pl :min-duration) 0)))
  5404. (maxgap (org-duration-to-minutes
  5405. ;; default 30:00 means never complain
  5406. (or (plist-get pl :max-gap) "30:00")))
  5407. (gapok (mapcar #'org-duration-to-minutes
  5408. (plist-get pl :gap-ok-around)))
  5409. (def-face (or (plist-get pl :default-face)
  5410. '((:background "DarkRed") (:foreground "white"))))
  5411. issue face m te ts dt ov)
  5412. (goto-char (point-min))
  5413. (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
  5414. (setq issue nil face def-face)
  5415. (catch 'next
  5416. (setq m (org-get-at-bol 'org-marker)
  5417. te nil ts nil)
  5418. (unless (and m (markerp m))
  5419. (setq issue "No valid clock line") (throw 'next t))
  5420. (org-with-point-at m
  5421. (save-excursion
  5422. (goto-char (point-at-bol))
  5423. (unless (looking-at re)
  5424. (error "No valid Clock line")
  5425. (throw 'next t))
  5426. (unless (match-end 3)
  5427. (setq issue "No end time"
  5428. face (or (plist-get pl :no-end-time-face) face))
  5429. (throw 'next t))
  5430. (setq ts (match-string 1)
  5431. te (match-string 3)
  5432. ts (float-time
  5433. (apply #'encode-time (org-parse-time-string ts)))
  5434. te (float-time
  5435. (apply #'encode-time (org-parse-time-string te)))
  5436. dt (- te ts))))
  5437. (cond
  5438. ((> dt (* 60 maxtime))
  5439. ;; a very long clocking chunk
  5440. (setq issue (format "Clocking interval is very long: %s"
  5441. (org-duration-from-minutes (floor (/ dt 60.))))
  5442. face (or (plist-get pl :long-face) face)))
  5443. ((< dt (* 60 mintime))
  5444. ;; a very short clocking chunk
  5445. (setq issue (format "Clocking interval is very short: %s"
  5446. (org-duration-from-minutes (floor (/ dt 60.))))
  5447. face (or (plist-get pl :short-face) face)))
  5448. ((and (> tlend 0) (< ts tlend))
  5449. ;; Two clock entries are overlapping
  5450. (setq issue (format "Clocking overlap: %d minutes"
  5451. (/ (- tlend ts) 60))
  5452. face (or (plist-get pl :overlap-face) face)))
  5453. ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
  5454. ;; There is a gap, lets see if we need to report it
  5455. (unless (org-agenda-check-clock-gap tlend ts gapok)
  5456. (setq issue (format "Clocking gap: %d minutes"
  5457. (/ (- ts tlend) 60))
  5458. face (or (plist-get pl :gap-face) face))))
  5459. (t nil)))
  5460. (setq tlend (or te tlend) tlstart (or ts tlstart))
  5461. (when issue
  5462. ;; OK, there was some issue, add an overlay to show the issue
  5463. (setq ov (make-overlay (point-at-bol) (point-at-eol)))
  5464. (overlay-put ov 'before-string
  5465. (concat
  5466. (org-add-props
  5467. (format "%-43s" (concat " " issue))
  5468. nil
  5469. 'face face)
  5470. "\n"))
  5471. (overlay-put ov 'evaporate t)))))
  5472. (defun org-agenda-check-clock-gap (t1 t2 ok-list)
  5473. "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
  5474. (catch 'exit
  5475. (unless ok-list
  5476. ;; there are no OK times for gaps...
  5477. (throw 'exit nil))
  5478. (when (> (- (/ t2 36000) (/ t1 36000)) 24)
  5479. ;; This is more than 24 hours, so it is OK.
  5480. ;; because we have at least one OK time, that must be in the
  5481. ;; 24 hour interval.
  5482. (throw 'exit t))
  5483. ;; We have a shorter gap.
  5484. ;; Now we have to get the minute of the day when these times are
  5485. (let* ((t1dec (decode-time (seconds-to-time t1)))
  5486. (t2dec (decode-time (seconds-to-time t2)))
  5487. ;; compute the minute on the day
  5488. (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
  5489. (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
  5490. (when (< min2 min1)
  5491. ;; if min2 is smaller than min1, this means it is on the next day.
  5492. ;; Wrap it to after midnight.
  5493. (setq min2 (+ min2 1440)))
  5494. ;; Now check if any of the OK times is in the gap
  5495. (mapc (lambda (x)
  5496. ;; Wrap the time to after midnight if necessary
  5497. (when (< x min1) (setq x (+ x 1440)))
  5498. ;; Check if in interval
  5499. (and (<= min1 x) (>= min2 x) (throw 'exit t)))
  5500. ok-list)
  5501. ;; Nope, this gap is not OK
  5502. nil)))
  5503. (defun org-agenda-get-deadlines (&optional with-hour)
  5504. "Return the deadline information for agenda display.
  5505. When WITH-HOUR is non-nil, only return deadlines with an hour
  5506. specification like [h]h:mm."
  5507. (let* ((props (list 'mouse-face 'highlight
  5508. 'org-not-done-regexp org-not-done-regexp
  5509. 'org-todo-regexp org-todo-regexp
  5510. 'org-complex-heading-regexp org-complex-heading-regexp
  5511. 'help-echo
  5512. (format "mouse-2 or RET jump to org file %s"
  5513. (abbreviate-file-name buffer-file-name))))
  5514. (regexp (if with-hour
  5515. org-deadline-time-hour-regexp
  5516. org-deadline-time-regexp))
  5517. (today (org-today))
  5518. (today? (org-agenda-today-p date)) ; DATE bound by calendar.
  5519. (current (calendar-absolute-from-gregorian date))
  5520. deadline-items)
  5521. (goto-char (point-min))
  5522. (while (re-search-forward regexp nil t)
  5523. (catch :skip
  5524. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5525. (org-agenda-skip)
  5526. (let* ((s (match-string 1))
  5527. (pos (1- (match-beginning 1)))
  5528. (todo-state (save-match-data (org-get-todo-state)))
  5529. (done? (member todo-state org-done-keywords))
  5530. (sexp? (string-prefix-p "%%" s))
  5531. ;; DEADLINE is the deadline date for the entry. It is
  5532. ;; either the base date or the last repeat, according
  5533. ;; to `org-agenda-prefer-last-repeat'.
  5534. (deadline
  5535. (cond
  5536. (sexp? (org-agenda--timestamp-to-absolute s current))
  5537. ((or (eq org-agenda-prefer-last-repeat t)
  5538. (member todo-state org-agenda-prefer-last-repeat))
  5539. (org-agenda--timestamp-to-absolute
  5540. s today 'past (current-buffer) pos))
  5541. (t (org-agenda--timestamp-to-absolute s))))
  5542. ;; REPEAT is the future repeat closest from CURRENT,
  5543. ;; according to `org-agenda-show-future-repeats'. If
  5544. ;; the latter is nil, or if the time stamp has no
  5545. ;; repeat part, default to DEADLINE.
  5546. (repeat
  5547. (cond
  5548. (sexp? deadline)
  5549. ((<= current today) deadline)
  5550. ((not org-agenda-show-future-repeats) deadline)
  5551. (t
  5552. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5553. (1+ today)
  5554. current)))
  5555. (org-agenda--timestamp-to-absolute
  5556. s base 'future (current-buffer) pos)))))
  5557. (diff (- deadline current))
  5558. (suppress-prewarning
  5559. (let ((scheduled
  5560. (and org-agenda-skip-deadline-prewarning-if-scheduled
  5561. (org-entry-get nil "SCHEDULED"))))
  5562. (cond
  5563. ((not scheduled) nil)
  5564. ;; The current item has a scheduled date, so
  5565. ;; evaluate its prewarning lead time.
  5566. ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
  5567. ;; Use global prewarning-restart lead time.
  5568. org-agenda-skip-deadline-prewarning-if-scheduled)
  5569. ((eq org-agenda-skip-deadline-prewarning-if-scheduled
  5570. 'pre-scheduled)
  5571. ;; Set pre-warning to no earlier than SCHEDULED.
  5572. (min (- deadline
  5573. (org-agenda--timestamp-to-absolute scheduled))
  5574. org-deadline-warning-days))
  5575. ;; Set pre-warning to deadline.
  5576. (t 0))))
  5577. (wdays (or suppress-prewarning (org-get-wdays s))))
  5578. (cond
  5579. ;; Only display deadlines at their base date, at future
  5580. ;; repeat occurrences or in today agenda.
  5581. ((= current deadline) nil)
  5582. ((= current repeat) nil)
  5583. ((not today?) (throw :skip nil))
  5584. ;; Upcoming deadline: display within warning period WDAYS.
  5585. ((> deadline current) (when (> diff wdays) (throw :skip nil)))
  5586. ;; Overdue deadline: warn about it for
  5587. ;; `org-deadline-past-days' duration.
  5588. (t (when (< org-deadline-past-days (- diff)) (throw :skip nil))))
  5589. ;; Possibly skip done tasks.
  5590. (when (and done?
  5591. (or org-agenda-skip-deadline-if-done
  5592. (/= deadline current)))
  5593. (throw :skip nil))
  5594. (save-excursion
  5595. (re-search-backward "^\\*+[ \t]+" nil t)
  5596. (goto-char (match-end 0))
  5597. (let* ((category (org-get-category))
  5598. (level (make-string (org-reduced-level (org-outline-level))
  5599. ?\s))
  5600. (head (buffer-substring (point) (line-end-position)))
  5601. (inherited-tags
  5602. (or (eq org-agenda-show-inherited-tags 'always)
  5603. (and (listp org-agenda-show-inherited-tags)
  5604. (memq 'agenda org-agenda-show-inherited-tags))
  5605. (and (eq org-agenda-show-inherited-tags t)
  5606. (or (eq org-agenda-use-tag-inheritance t)
  5607. (memq 'agenda
  5608. org-agenda-use-tag-inheritance)))))
  5609. (tags (org-get-tags nil (not inherited-tags)))
  5610. (time
  5611. (cond
  5612. ;; No time of day designation if it is only
  5613. ;; a reminder.
  5614. ((and (/= current deadline) (/= current repeat)) nil)
  5615. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5616. (concat (substring s (match-beginning 1)) " "))
  5617. (t 'time)))
  5618. (item
  5619. (org-agenda-format-item
  5620. ;; Insert appropriate suffixes before deadlines.
  5621. ;; Those only apply to today agenda.
  5622. (pcase-let ((`(,now ,future ,past)
  5623. org-agenda-deadline-leaders))
  5624. (cond
  5625. ((and today? (< deadline today)) (format past (- diff)))
  5626. ((and today? (> deadline today)) (format future diff))
  5627. (t now)))
  5628. head level category tags time))
  5629. (face (org-agenda-deadline-face
  5630. (- 1 (/ (float diff) (max wdays 1)))))
  5631. (upcoming? (and today? (> deadline today)))
  5632. (warntime (get-text-property (point) 'org-appt-warntime)))
  5633. (org-add-props item props
  5634. 'org-marker (org-agenda-new-marker pos)
  5635. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  5636. 'warntime warntime
  5637. 'level level
  5638. 'ts-date deadline
  5639. 'priority
  5640. ;; Adjust priority to today reminders about deadlines.
  5641. ;; Overdue deadlines get the highest priority
  5642. ;; increase, then imminent deadlines and eventually
  5643. ;; more distant deadlines.
  5644. (let ((adjust (if today? (- diff) 0)))
  5645. (+ adjust (org-get-priority item)))
  5646. 'todo-state todo-state
  5647. 'type (if upcoming? "upcoming-deadline" "deadline")
  5648. 'date (if upcoming? date deadline)
  5649. 'face (if done? 'org-agenda-done face)
  5650. 'undone-face face
  5651. 'done-face 'org-agenda-done)
  5652. (push item deadline-items))))))
  5653. (nreverse deadline-items)))
  5654. (defun org-agenda-deadline-face (fraction)
  5655. "Return the face to displaying a deadline item.
  5656. FRACTION is what fraction of the head-warning time has passed."
  5657. (assoc-default fraction org-agenda-deadline-faces #'<=))
  5658. (defun org-agenda-get-scheduled (&optional deadlines with-hour)
  5659. "Return the scheduled information for agenda display.
  5660. Optional argument DEADLINES is a list of deadline items to be
  5661. displayed in agenda view. When WITH-HOUR is non-nil, only return
  5662. scheduled items with an hour specification like [h]h:mm."
  5663. (let* ((props (list 'org-not-done-regexp org-not-done-regexp
  5664. 'org-todo-regexp org-todo-regexp
  5665. 'org-complex-heading-regexp org-complex-heading-regexp
  5666. 'done-face 'org-agenda-done
  5667. 'mouse-face 'highlight
  5668. 'help-echo
  5669. (format "mouse-2 or RET jump to Org file %s"
  5670. (abbreviate-file-name buffer-file-name))))
  5671. (regexp (if with-hour
  5672. org-scheduled-time-hour-regexp
  5673. org-scheduled-time-regexp))
  5674. (today (org-today))
  5675. (todayp (org-agenda-today-p date)) ; DATE bound by calendar.
  5676. (current (calendar-absolute-from-gregorian date))
  5677. (deadline-pos
  5678. (mapcar (lambda (d)
  5679. (let ((m (get-text-property 0 'org-hd-marker d)))
  5680. (and m (marker-position m))))
  5681. deadlines))
  5682. scheduled-items)
  5683. (goto-char (point-min))
  5684. (while (re-search-forward regexp nil t)
  5685. (catch :skip
  5686. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5687. (org-agenda-skip)
  5688. (let* ((s (match-string 1))
  5689. (pos (1- (match-beginning 1)))
  5690. (todo-state (save-match-data (org-get-todo-state)))
  5691. (donep (member todo-state org-done-keywords))
  5692. (sexp? (string-prefix-p "%%" s))
  5693. ;; SCHEDULE is the scheduled date for the entry. It is
  5694. ;; either the bare date or the last repeat, according
  5695. ;; to `org-agenda-prefer-last-repeat'.
  5696. (schedule
  5697. (cond
  5698. (sexp? (org-agenda--timestamp-to-absolute s current))
  5699. ((or (eq org-agenda-prefer-last-repeat t)
  5700. (member todo-state org-agenda-prefer-last-repeat))
  5701. (org-agenda--timestamp-to-absolute
  5702. s today 'past (current-buffer) pos))
  5703. (t (org-agenda--timestamp-to-absolute s))))
  5704. ;; REPEAT is the future repeat closest from CURRENT,
  5705. ;; according to `org-agenda-show-future-repeats'. If
  5706. ;; the latter is nil, or if the time stamp has no
  5707. ;; repeat part, default to SCHEDULE.
  5708. (repeat
  5709. (cond
  5710. (sexp? schedule)
  5711. ((<= current today) schedule)
  5712. ((not org-agenda-show-future-repeats) schedule)
  5713. (t
  5714. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5715. (1+ today)
  5716. current)))
  5717. (org-agenda--timestamp-to-absolute
  5718. s base 'future (current-buffer) pos)))))
  5719. (diff (- current schedule))
  5720. (warntime (get-text-property (point) 'org-appt-warntime))
  5721. (pastschedp (< schedule today))
  5722. (futureschedp (> schedule today))
  5723. (habitp (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  5724. (suppress-delay
  5725. (let ((deadline (and org-agenda-skip-scheduled-delay-if-deadline
  5726. (org-entry-get nil "DEADLINE"))))
  5727. (cond
  5728. ((not deadline) nil)
  5729. ;; The current item has a deadline date, so
  5730. ;; evaluate its delay time.
  5731. ((integerp org-agenda-skip-scheduled-delay-if-deadline)
  5732. ;; Use global delay time.
  5733. (- org-agenda-skip-scheduled-delay-if-deadline))
  5734. ((eq org-agenda-skip-scheduled-delay-if-deadline
  5735. 'post-deadline)
  5736. ;; Set delay to no later than DEADLINE.
  5737. (min (- schedule
  5738. (org-agenda--timestamp-to-absolute deadline))
  5739. org-scheduled-delay-days))
  5740. (t 0))))
  5741. (ddays
  5742. (cond
  5743. ;; Nullify delay when a repeater triggered already
  5744. ;; and the delay is of the form --Xd.
  5745. ((and (string-match-p "--[0-9]+[hdwmy]" s)
  5746. (> schedule (org-agenda--timestamp-to-absolute s)))
  5747. 0)
  5748. (suppress-delay
  5749. (let ((org-scheduled-delay-days suppress-delay))
  5750. (org-get-wdays s t t)))
  5751. (t (org-get-wdays s t)))))
  5752. ;; Display scheduled items at base date (SCHEDULE), today if
  5753. ;; scheduled before the current date, and at any repeat past
  5754. ;; today. However, skip delayed items and items that have
  5755. ;; been displayed for more than `org-scheduled-past-days'.
  5756. (unless (and todayp
  5757. habitp
  5758. (bound-and-true-p org-habit-show-all-today))
  5759. (when (or (and (> ddays 0) (< diff ddays))
  5760. (> diff (or (and habitp org-habit-scheduled-past-days)
  5761. org-scheduled-past-days))
  5762. (> schedule current)
  5763. (and (/= current schedule)
  5764. (/= current today)
  5765. (/= current repeat)))
  5766. (throw :skip nil)))
  5767. ;; Possibly skip done tasks.
  5768. (when (and donep
  5769. (or org-agenda-skip-scheduled-if-done
  5770. (/= schedule current)))
  5771. (throw :skip nil))
  5772. ;; Skip entry if it already appears as a deadline, per
  5773. ;; `org-agenda-skip-scheduled-if-deadline-is-shown'. This
  5774. ;; doesn't apply to habits.
  5775. (when (pcase org-agenda-skip-scheduled-if-deadline-is-shown
  5776. ((guard
  5777. (or (not (memq (line-beginning-position 0) deadline-pos))
  5778. habitp))
  5779. nil)
  5780. (`repeated-after-deadline
  5781. (let ((deadline (time-to-days
  5782. (org-get-deadline-time (point)))))
  5783. (and (<= schedule deadline) (> current deadline))))
  5784. (`not-today pastschedp)
  5785. (`t t)
  5786. (_ nil))
  5787. (throw :skip nil))
  5788. ;; Skip habits if `org-habit-show-habits' is nil, or if we
  5789. ;; only show them for today. Also skip done habits.
  5790. (when (and habitp
  5791. (or donep
  5792. (not (bound-and-true-p org-habit-show-habits))
  5793. (and (not todayp)
  5794. (bound-and-true-p
  5795. org-habit-show-habits-only-for-today))))
  5796. (throw :skip nil))
  5797. (save-excursion
  5798. (re-search-backward "^\\*+[ \t]+" nil t)
  5799. (goto-char (match-end 0))
  5800. (let* ((category (org-get-category))
  5801. (inherited-tags
  5802. (or (eq org-agenda-show-inherited-tags 'always)
  5803. (and (listp org-agenda-show-inherited-tags)
  5804. (memq 'agenda org-agenda-show-inherited-tags))
  5805. (and (eq org-agenda-show-inherited-tags t)
  5806. (or (eq org-agenda-use-tag-inheritance t)
  5807. (memq 'agenda
  5808. org-agenda-use-tag-inheritance)))))
  5809. (tags (org-get-tags nil (not inherited-tags)))
  5810. (level (make-string (org-reduced-level (org-outline-level))
  5811. ?\s))
  5812. (head (buffer-substring (point) (line-end-position)))
  5813. (time
  5814. (cond
  5815. ;; No time of day designation if it is only a
  5816. ;; reminder, except for habits, which always show
  5817. ;; the time of day. Habits are an exception
  5818. ;; because if there is a time of day, that is
  5819. ;; interpreted to mean they should usually happen
  5820. ;; then, even if doing the habit was missed.
  5821. ((and
  5822. (not habitp)
  5823. (/= current schedule)
  5824. (/= current repeat))
  5825. nil)
  5826. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5827. (concat (substring s (match-beginning 1)) " "))
  5828. (t 'time)))
  5829. (item
  5830. (org-agenda-format-item
  5831. (pcase-let ((`(,first ,past) org-agenda-scheduled-leaders))
  5832. ;; Show a reminder of a past scheduled today.
  5833. (if (and todayp pastschedp)
  5834. (format past diff)
  5835. first))
  5836. head level category tags time nil habitp))
  5837. (face (cond ((and (not habitp) pastschedp)
  5838. 'org-scheduled-previously)
  5839. ((and habitp futureschedp)
  5840. 'org-agenda-done)
  5841. (todayp 'org-scheduled-today)
  5842. (t 'org-scheduled)))
  5843. (habitp (and habitp (org-habit-parse-todo))))
  5844. (org-add-props item props
  5845. 'undone-face face
  5846. 'face (if donep 'org-agenda-done face)
  5847. 'org-marker (org-agenda-new-marker pos)
  5848. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  5849. 'type (if pastschedp "past-scheduled" "scheduled")
  5850. 'date (if pastschedp schedule date)
  5851. 'ts-date schedule
  5852. 'warntime warntime
  5853. 'level level
  5854. 'priority (if habitp (org-habit-get-priority habitp)
  5855. (+ 99 diff (org-get-priority item)))
  5856. 'org-habit-p habitp
  5857. 'todo-state todo-state)
  5858. (push item scheduled-items))))))
  5859. (nreverse scheduled-items)))
  5860. (defun org-agenda-get-blocks ()
  5861. "Return the date-range information for agenda display."
  5862. (let* ((props (list 'face nil
  5863. 'org-not-done-regexp org-not-done-regexp
  5864. 'org-todo-regexp org-todo-regexp
  5865. 'org-complex-heading-regexp org-complex-heading-regexp
  5866. 'mouse-face 'highlight
  5867. 'help-echo
  5868. (format "mouse-2 or RET jump to org file %s"
  5869. (abbreviate-file-name buffer-file-name))))
  5870. (regexp org-tr-regexp)
  5871. (d0 (calendar-absolute-from-gregorian date))
  5872. marker hdmarker ee txt d1 d2 s1 s2 category
  5873. level todo-state tags pos head donep inherited-tags)
  5874. (goto-char (point-min))
  5875. (while (re-search-forward regexp nil t)
  5876. (catch :skip
  5877. (org-agenda-skip)
  5878. (setq pos (point))
  5879. (let ((start-time (match-string 1))
  5880. (end-time (match-string 2)))
  5881. (setq s1 (match-string 1)
  5882. s2 (match-string 2)
  5883. d1 (time-to-days
  5884. (condition-case err
  5885. (org-time-string-to-time s1)
  5886. (error
  5887. (error
  5888. "Bad timestamp %S at %d in buffer %S\nError was: %s"
  5889. s1
  5890. pos
  5891. (current-buffer)
  5892. (error-message-string err)))))
  5893. d2 (time-to-days
  5894. (condition-case err
  5895. (org-time-string-to-time s2)
  5896. (error
  5897. (error
  5898. "Bad timestamp %S at %d in buffer %S\nError was: %s"
  5899. s2
  5900. pos
  5901. (current-buffer)
  5902. (error-message-string err))))))
  5903. (when (and (> (- d0 d1) -1) (> (- d2 d0) -1))
  5904. ;; Only allow days between the limits, because the normal
  5905. ;; date stamps will catch the limits.
  5906. (save-excursion
  5907. (setq todo-state (org-get-todo-state))
  5908. (setq donep (member todo-state org-done-keywords))
  5909. (when (and donep org-agenda-skip-timestamp-if-done)
  5910. (throw :skip t))
  5911. (setq marker (org-agenda-new-marker (point))
  5912. category (org-get-category))
  5913. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5914. (throw :skip nil)
  5915. (goto-char (match-beginning 0))
  5916. (setq hdmarker (org-agenda-new-marker (point))
  5917. inherited-tags
  5918. (or (eq org-agenda-show-inherited-tags 'always)
  5919. (and (listp org-agenda-show-inherited-tags)
  5920. (memq 'agenda org-agenda-show-inherited-tags))
  5921. (and (eq org-agenda-show-inherited-tags t)
  5922. (or (eq org-agenda-use-tag-inheritance t)
  5923. (memq 'agenda org-agenda-use-tag-inheritance))))
  5924. tags (org-get-tags nil (not inherited-tags)))
  5925. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  5926. (looking-at "\\*+[ \t]+\\(.*\\)")
  5927. (setq head (match-string 1))
  5928. (let ((remove-re
  5929. (if org-agenda-remove-timeranges-from-blocks
  5930. (concat
  5931. "<" (regexp-quote s1) ".*?>"
  5932. "--"
  5933. "<" (regexp-quote s2) ".*?>")
  5934. nil)))
  5935. (setq txt (org-agenda-format-item
  5936. (format
  5937. (nth (if (= d1 d2) 0 1)
  5938. org-agenda-timerange-leaders)
  5939. (1+ (- d0 d1)) (1+ (- d2 d1)))
  5940. head level category tags
  5941. (cond ((and (= d1 d0) (= d2 d0))
  5942. (concat "<" start-time ">--<" end-time ">"))
  5943. ((= d1 d0)
  5944. (concat "<" start-time ">"))
  5945. ((= d2 d0)
  5946. (concat "<" end-time ">")))
  5947. remove-re))))
  5948. (org-add-props txt props
  5949. 'org-marker marker 'org-hd-marker hdmarker
  5950. 'type "block" 'date date
  5951. 'level level
  5952. 'todo-state todo-state
  5953. 'priority (org-get-priority txt))
  5954. (push txt ee))))
  5955. (goto-char pos)))
  5956. ;; Sort the entries by expiration date.
  5957. (nreverse ee)))
  5958. ;;; Agenda presentation and sorting
  5959. (defvar org-prefix-has-time nil
  5960. "A flag, set by `org-compile-prefix-format'.
  5961. The flag is set if the currently compiled format contains a `%t'.")
  5962. (defvar org-prefix-has-tag nil
  5963. "A flag, set by `org-compile-prefix-format'.
  5964. The flag is set if the currently compiled format contains a `%T'.")
  5965. (defvar org-prefix-has-effort nil
  5966. "A flag, set by `org-compile-prefix-format'.
  5967. The flag is set if the currently compiled format contains a `%e'.")
  5968. (defvar org-prefix-has-breadcrumbs nil
  5969. "A flag, set by `org-compile-prefix-format'.
  5970. The flag is set if the currently compiled format contains a `%b'.")
  5971. (defvar org-prefix-category-length nil
  5972. "Used by `org-compile-prefix-format' to remember the category field width.")
  5973. (defvar org-prefix-category-max-length nil
  5974. "Used by `org-compile-prefix-format' to remember the category field width.")
  5975. (defun org-agenda-get-category-icon (category)
  5976. "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
  5977. (cl-dolist (entry org-agenda-category-icon-alist)
  5978. (when (string-match-p (car entry) category)
  5979. (if (listp (cadr entry))
  5980. (cl-return (cadr entry))
  5981. (cl-return (apply #'create-image (cdr entry)))))))
  5982. (defun org-agenda-format-item (extra txt &optional level category tags dotime
  5983. remove-re habitp)
  5984. "Format TXT to be inserted into the agenda buffer.
  5985. In particular, add the prefix and corresponding text properties.
  5986. EXTRA must be a string to replace the `%s' specifier in the prefix format.
  5987. LEVEL may be a string to replace the `%l' specifier.
  5988. CATEGORY (a string, a symbol or nil) may be used to overrule the default
  5989. category taken from local variable or file name. It will replace the `%c'
  5990. specifier in the format.
  5991. DOTIME, when non-nil, indicates that a time-of-day should be extracted from
  5992. TXT for sorting of this entry, and for the `%t' specifier in the format.
  5993. When DOTIME is a string, this string is searched for a time before TXT is.
  5994. TAGS can be the tags of the headline.
  5995. Any match of REMOVE-RE will be removed from TXT."
  5996. ;; We keep the org-prefix-* variable values along with a compiled
  5997. ;; formatter, so that multiple agendas existing at the same time do
  5998. ;; not step on each other toes.
  5999. ;;
  6000. ;; It was inconvenient to make these variables buffer local in
  6001. ;; Agenda buffers, because this function expects to be called with
  6002. ;; the buffer where item comes from being current, and not agenda
  6003. ;; buffer
  6004. (let* ((bindings (car org-prefix-format-compiled))
  6005. (formatter (cadr org-prefix-format-compiled)))
  6006. (cl-loop for (var value) in bindings
  6007. do (set var value))
  6008. (save-match-data
  6009. ;; Diary entries sometimes have extra whitespace at the beginning
  6010. (setq txt (org-trim txt))
  6011. ;; Fix the tags part in txt
  6012. (setq txt (org-agenda-fix-displayed-tags
  6013. txt tags
  6014. org-agenda-show-inherited-tags
  6015. org-agenda-hide-tags-regexp))
  6016. (let* ((category (or category
  6017. (if buffer-file-name
  6018. (file-name-sans-extension
  6019. (file-name-nondirectory buffer-file-name))
  6020. "")))
  6021. (category-icon (org-agenda-get-category-icon category))
  6022. (category-icon (if category-icon
  6023. (propertize " " 'display category-icon)
  6024. ""))
  6025. (effort (and (not (string= txt ""))
  6026. (get-text-property 1 'effort txt)))
  6027. ;; time, tag, effort are needed for the eval of the prefix format
  6028. (tag (if tags (nth (1- (length tags)) tags) ""))
  6029. (time-grid-trailing-characters (nth 2 org-agenda-time-grid))
  6030. time
  6031. (ts (when dotime (concat
  6032. (if (stringp dotime) dotime "")
  6033. (and org-agenda-search-headline-for-time txt))))
  6034. (time-of-day (and dotime (org-get-time-of-day ts)))
  6035. stamp plain s0 s1 s2 rtn srp l
  6036. duration breadcrumbs)
  6037. (and (derived-mode-p 'org-mode) buffer-file-name
  6038. (add-to-list 'org-agenda-contributing-files buffer-file-name))
  6039. (when (and dotime time-of-day)
  6040. ;; Extract starting and ending time and move them to prefix
  6041. (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
  6042. (setq plain (string-match org-plain-time-of-day-regexp ts)))
  6043. (setq s0 (match-string 0 ts)
  6044. srp (and stamp (match-end 3))
  6045. s1 (match-string (if plain 1 2) ts)
  6046. s2 (match-string (if plain 8 (if srp 4 6)) ts))
  6047. ;; If the times are in TXT (not in DOTIMES), and the prefix will list
  6048. ;; them, we might want to remove them there to avoid duplication.
  6049. ;; The user can turn this off with a variable.
  6050. (when (and org-prefix-has-time
  6051. org-agenda-remove-times-when-in-prefix (or stamp plain)
  6052. (string-match (concat (regexp-quote s0) " *") txt)
  6053. (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
  6054. (if (eq org-agenda-remove-times-when-in-prefix 'beg)
  6055. (= (match-beginning 0) 0)
  6056. t))
  6057. (setq txt (replace-match "" nil nil txt))))
  6058. ;; Normalize the time(s) to 24 hour
  6059. (when s1 (setq s1 (org-get-time-of-day s1 'string t)))
  6060. (when s2 (setq s2 (org-get-time-of-day s2 'string t)))
  6061. ;; Try to set s2 if s1 and
  6062. ;; `org-agenda-default-appointment-duration' are set
  6063. (when (and s1 (not s2) org-agenda-default-appointment-duration)
  6064. (setq s2
  6065. (org-duration-from-minutes
  6066. (+ (org-duration-to-minutes s1 t)
  6067. org-agenda-default-appointment-duration)
  6068. nil t)))
  6069. ;; Compute the duration
  6070. (when s2
  6071. (setq duration (- (org-duration-to-minutes s2)
  6072. (org-duration-to-minutes s1)))))
  6073. (when (string-match org-tag-group-re txt)
  6074. ;; Tags are in the string
  6075. (if (or (eq org-agenda-remove-tags t)
  6076. (and org-agenda-remove-tags
  6077. org-prefix-has-tag))
  6078. (setq txt (replace-match "" t t txt))
  6079. (setq txt (replace-match
  6080. (concat (make-string (max (- 50 (length txt)) 1) ?\ )
  6081. (match-string 1 txt))
  6082. t t txt))))
  6083. (when remove-re
  6084. (while (string-match remove-re txt)
  6085. (setq txt (replace-match "" t t txt))))
  6086. ;; Set org-heading property on `txt' to mark the start of the
  6087. ;; heading.
  6088. (add-text-properties 0 (length txt) '(org-heading t) txt)
  6089. ;; Prepare the variables needed in the eval of the compiled format
  6090. (when org-prefix-has-breadcrumbs
  6091. (setq breadcrumbs (org-with-point-at (org-get-at-bol 'org-marker)
  6092. (let ((s (org-format-outline-path (org-get-outline-path)
  6093. (1- (frame-width))
  6094. nil "->")))
  6095. (if (eq "" s) "" (concat s "->"))))))
  6096. (setq time (cond (s2 (concat
  6097. (org-agenda-time-of-day-to-ampm-maybe s1)
  6098. "-" (org-agenda-time-of-day-to-ampm-maybe s2)
  6099. (when org-agenda-timegrid-use-ampm " ")))
  6100. (s1 (concat
  6101. (org-agenda-time-of-day-to-ampm-maybe s1)
  6102. (if org-agenda-timegrid-use-ampm
  6103. (concat time-grid-trailing-characters " ")
  6104. time-grid-trailing-characters)))
  6105. (t ""))
  6106. extra (or (and (not habitp) extra) "")
  6107. category (if (symbolp category) (symbol-name category) category)
  6108. level (or level ""))
  6109. (if (string-match org-bracket-link-regexp category)
  6110. (progn
  6111. (setq l (if (match-end 3)
  6112. (- (match-end 3) (match-beginning 3))
  6113. (- (match-end 1) (match-beginning 1))))
  6114. (when (< l (or org-prefix-category-length 0))
  6115. (setq category (copy-sequence category))
  6116. (org-add-props category nil
  6117. 'extra-space (make-string
  6118. (- org-prefix-category-length l 1) ?\ ))))
  6119. (when (and org-prefix-category-max-length
  6120. (>= (length category) org-prefix-category-max-length))
  6121. (setq category (substring category 0 (1- org-prefix-category-max-length)))))
  6122. ;; Evaluate the compiled format
  6123. (setq rtn (concat (eval formatter) txt))
  6124. ;; And finally add the text properties
  6125. (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
  6126. (org-add-props rtn nil
  6127. 'org-category category
  6128. 'tags (mapcar 'org-downcase-keep-props tags)
  6129. 'org-highest-priority org-highest-priority
  6130. 'org-lowest-priority org-lowest-priority
  6131. 'time-of-day time-of-day
  6132. 'duration duration
  6133. 'breadcrumbs breadcrumbs
  6134. 'txt txt
  6135. 'level level
  6136. 'time time
  6137. 'extra extra
  6138. 'format org-prefix-format-compiled
  6139. 'dotime dotime)))))
  6140. (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
  6141. "Remove tags string from TXT, and add a modified list of tags.
  6142. The modified list may contain inherited tags, and tags matched by
  6143. `org-agenda-hide-tags-regexp' will be removed."
  6144. (when (or add-inherited hide-re)
  6145. (when (string-match org-tag-group-re txt)
  6146. (setq txt (substring txt 0 (match-beginning 0))))
  6147. (setq tags
  6148. (delq nil
  6149. (mapcar (lambda (tg)
  6150. (if (or (and hide-re (string-match hide-re tg))
  6151. (and (not add-inherited)
  6152. (get-text-property 0 'inherited tg)))
  6153. nil
  6154. tg))
  6155. tags)))
  6156. (when tags
  6157. (let ((have-i (get-text-property 0 'inherited (car tags)))
  6158. i)
  6159. (setq txt (concat txt " :"
  6160. (mapconcat
  6161. (lambda (x)
  6162. (setq i (get-text-property 0 'inherited x))
  6163. (if (and have-i (not i))
  6164. (progn
  6165. (setq have-i nil)
  6166. (concat ":" x))
  6167. x))
  6168. tags ":")
  6169. (if have-i "::" ":"))))))
  6170. txt)
  6171. (defun org-downcase-keep-props (s)
  6172. (let ((props (text-properties-at 0 s)))
  6173. (setq s (downcase s))
  6174. (add-text-properties 0 (length s) props s)
  6175. s))
  6176. (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
  6177. (defun org-agenda-add-time-grid-maybe (list ndays todayp)
  6178. "Add a time-grid for agenda items which need it.
  6179. LIST is the list of agenda items formatted by `org-agenda-list'.
  6180. NDAYS is the span of the current agenda view.
  6181. TODAYP is t when the current agenda view is on today."
  6182. (catch 'exit
  6183. (cond ((not org-agenda-use-time-grid) (throw 'exit list))
  6184. ((and todayp (member 'today (car org-agenda-time-grid))))
  6185. ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
  6186. ((member 'weekly (car org-agenda-time-grid)))
  6187. (t (throw 'exit list)))
  6188. (let* ((have (delq nil (mapcar
  6189. (lambda (x) (get-text-property 1 'time-of-day x))
  6190. list)))
  6191. (string (nth 3 org-agenda-time-grid))
  6192. (gridtimes (nth 1 org-agenda-time-grid))
  6193. (req (car org-agenda-time-grid))
  6194. (remove (member 'remove-match req))
  6195. new time)
  6196. (when (and (member 'require-timed req) (not have))
  6197. ;; don't show empty grid
  6198. (throw 'exit list))
  6199. (while (setq time (pop gridtimes))
  6200. (unless (and remove (member time have))
  6201. (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
  6202. (push (org-agenda-format-item
  6203. nil string nil "" nil
  6204. (concat (substring time 0 -2) ":" (substring time -2)))
  6205. new)
  6206. (put-text-property
  6207. 2 (length (car new)) 'face 'org-time-grid (car new))))
  6208. (when (and todayp org-agenda-show-current-time-in-grid)
  6209. (push (org-agenda-format-item
  6210. nil org-agenda-current-time-string nil "" nil
  6211. (format-time-string "%H:%M "))
  6212. new)
  6213. (put-text-property
  6214. 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
  6215. (if (member 'time-up org-agenda-sorting-strategy-selected)
  6216. (append new list)
  6217. (append list new)))))
  6218. (defun org-compile-prefix-format (key)
  6219. "Compile the prefix format into a Lisp form that can be evaluated.
  6220. The resulting form and associated variable bindings is returned
  6221. and stored in the variable `org-prefix-format-compiled'."
  6222. (setq org-prefix-has-time nil
  6223. org-prefix-has-tag nil
  6224. org-prefix-category-length nil
  6225. org-prefix-has-effort nil
  6226. org-prefix-has-breadcrumbs nil)
  6227. (let ((s (cond
  6228. ((stringp org-agenda-prefix-format)
  6229. org-agenda-prefix-format)
  6230. ((assq key org-agenda-prefix-format)
  6231. (cdr (assq key org-agenda-prefix-format)))
  6232. (t " %-12:c%?-12t% s")))
  6233. (start 0)
  6234. varform vars var e c f opt)
  6235. (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cltseib]\\|(.+)\\)"
  6236. s start)
  6237. (setq var (or (cdr (assoc (match-string 4 s)
  6238. '(("c" . category) ("t" . time) ("l" . level) ("s" . extra)
  6239. ("i" . category-icon) ("T" . tag) ("e" . effort) ("b" . breadcrumbs))))
  6240. 'eval)
  6241. c (or (match-string 3 s) "")
  6242. opt (match-beginning 1)
  6243. start (1+ (match-beginning 0)))
  6244. (cl-case var
  6245. (time (setq org-prefix-has-time t))
  6246. (tag (setq org-prefix-has-tag t))
  6247. (effort (setq org-prefix-has-effort t))
  6248. (breadcrumbs (setq org-prefix-has-breadcrumbs t)))
  6249. (setq f (concat "%" (match-string 2 s) "s"))
  6250. (when (eq var 'category)
  6251. (setq org-prefix-category-length
  6252. (floor (abs (string-to-number (match-string 2 s)))))
  6253. (setq org-prefix-category-max-length
  6254. (let ((x (match-string 2 s)))
  6255. (when (string-match-p "\\.[0-9]+" x)
  6256. (string-to-number (substring (match-string 0 x) 1))))))
  6257. (if (eq var 'eval)
  6258. (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
  6259. (if opt
  6260. (setq varform
  6261. `(if (or (equal "" ,var) (equal nil ,var))
  6262. ""
  6263. (format ,f (concat ,var ,c))))
  6264. (setq varform
  6265. `(format ,f (if (or (equal ,var "")
  6266. (equal ,var nil)) ""
  6267. (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
  6268. (setq s (replace-match "%s" t nil s))
  6269. (push varform vars))
  6270. (setq vars (nreverse vars))
  6271. (with-current-buffer (or org-agenda-buffer (current-buffer))
  6272. (setq org-prefix-format-compiled
  6273. (list
  6274. `((org-prefix-has-time ,org-prefix-has-time)
  6275. (org-prefix-has-tag ,org-prefix-has-tag)
  6276. (org-prefix-category-length ,org-prefix-category-length)
  6277. (org-prefix-has-effort ,org-prefix-has-effort)
  6278. (org-prefix-has-breadcrumbs ,org-prefix-has-breadcrumbs))
  6279. `(format ,s ,@vars))))))
  6280. (defun org-set-sorting-strategy (key)
  6281. (if (symbolp (car org-agenda-sorting-strategy))
  6282. ;; the old format
  6283. (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
  6284. (setq org-agenda-sorting-strategy-selected
  6285. (or (cdr (assq key org-agenda-sorting-strategy))
  6286. (cdr (assq 'agenda org-agenda-sorting-strategy))
  6287. '(time-up category-keep priority-down)))))
  6288. (defun org-get-time-of-day (s &optional string mod24)
  6289. "Check string S for a time of day.
  6290. If found, return it as a military time number between 0 and 2400.
  6291. If not found, return nil.
  6292. The optional STRING argument forces conversion into a 5 character wide string
  6293. HH:MM."
  6294. (save-match-data
  6295. (when
  6296. (and
  6297. (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
  6298. (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
  6299. (not (eq (get-text-property 1 'face s) 'org-link)))
  6300. (let* ((h (string-to-number (match-string 1 s)))
  6301. (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
  6302. (ampm (when (match-end 4) (downcase (match-string 4 s))))
  6303. (am-p (equal ampm "am"))
  6304. (h1 (cond ((not ampm) h)
  6305. ((= h 12) (if am-p 0 12))
  6306. (t (+ h (if am-p 0 12)))))
  6307. (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
  6308. (mod h1 24) h1))
  6309. (t0 (+ (* 100 h2) m))
  6310. (t1 (concat (if (>= h1 24) "+" " ")
  6311. (if (and org-agenda-time-leading-zero
  6312. (< t0 1000)) "0" "")
  6313. (if (< t0 100) "0" "")
  6314. (if (< t0 10) "0" "")
  6315. (int-to-string t0))))
  6316. (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
  6317. (defvar org-agenda-before-sorting-filter-function nil
  6318. "Function to be applied to agenda items prior to sorting.
  6319. Prior to sorting also means just before they are inserted into the agenda.
  6320. To aid sorting, you may revisit the original entries and add more text
  6321. properties which will later be used by the sorting functions.
  6322. The function should take a string argument, an agenda line.
  6323. It has access to the text properties in that line, which contain among
  6324. other things, the property `org-hd-marker' that points to the entry
  6325. where the line comes from. Note that not all lines going into the agenda
  6326. have this property, only most.
  6327. The function should return the modified string. It is probably best
  6328. to ONLY change text properties.
  6329. You can also use this function as a filter, by returning nil for lines
  6330. you don't want to have in the agenda at all. For this application, you
  6331. could bind the variable in the options section of a custom command.")
  6332. (defun org-agenda-finalize-entries (list &optional type)
  6333. "Sort, limit and concatenate the LIST of agenda items.
  6334. The optional argument TYPE tells the agenda type."
  6335. (let ((max-effort (cond ((listp org-agenda-max-effort)
  6336. (cdr (assoc type org-agenda-max-effort)))
  6337. (t org-agenda-max-effort)))
  6338. (max-todo (cond ((listp org-agenda-max-todos)
  6339. (cdr (assoc type org-agenda-max-todos)))
  6340. (t org-agenda-max-todos)))
  6341. (max-tags (cond ((listp org-agenda-max-tags)
  6342. (cdr (assoc type org-agenda-max-tags)))
  6343. (t org-agenda-max-tags)))
  6344. (max-entries (cond ((listp org-agenda-max-entries)
  6345. (cdr (assoc type org-agenda-max-entries)))
  6346. (t org-agenda-max-entries))))
  6347. (when org-agenda-before-sorting-filter-function
  6348. (setq list
  6349. (delq nil
  6350. (mapcar
  6351. org-agenda-before-sorting-filter-function list))))
  6352. (setq list (mapcar 'org-agenda-highlight-todo list)
  6353. list (mapcar 'identity (sort list 'org-entries-lessp)))
  6354. (when max-effort
  6355. (setq list (org-agenda-limit-entries
  6356. list 'effort-minutes max-effort
  6357. (lambda (e) (or e (if org-sort-agenda-noeffort-is-high
  6358. 32767 -1))))))
  6359. (when max-todo
  6360. (setq list (org-agenda-limit-entries list 'todo-state max-todo)))
  6361. (when max-tags
  6362. (setq list (org-agenda-limit-entries list 'tags max-tags)))
  6363. (when max-entries
  6364. (setq list (org-agenda-limit-entries list 'org-hd-marker max-entries)))
  6365. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  6366. (setq list (mapcar #'org-agenda--mark-blocked-entry list)))
  6367. (mapconcat 'identity list "\n")))
  6368. (defun org-agenda-limit-entries (list prop limit &optional fn)
  6369. "Limit the number of agenda entries."
  6370. (let ((include (and limit (< limit 0))))
  6371. (if limit
  6372. (let ((fun (or fn (lambda (p) (when p 1))))
  6373. (lim 0))
  6374. (delq nil
  6375. (mapcar
  6376. (lambda (e)
  6377. (let ((pval (funcall
  6378. fun (get-text-property (1- (length e))
  6379. prop e))))
  6380. (when pval (setq lim (+ lim pval)))
  6381. (cond ((and pval (<= lim (abs limit))) e)
  6382. ((and include (not pval)) e))))
  6383. list)))
  6384. list)))
  6385. (defun org-agenda-limit-interactively (remove)
  6386. "In agenda, interactively limit entries to various maximums."
  6387. (interactive "P")
  6388. (if remove
  6389. (progn (setq org-agenda-max-entries nil
  6390. org-agenda-max-todos nil
  6391. org-agenda-max-tags nil
  6392. org-agenda-max-effort nil)
  6393. (org-agenda-redo))
  6394. (let* ((max (read-char "Number of [e]ntries [t]odos [T]ags [E]ffort? "))
  6395. (msg (cond ((= max ?E) "How many minutes? ")
  6396. ((= max ?e) "How many entries? ")
  6397. ((= max ?t) "How many TODO entries? ")
  6398. ((= max ?T) "How many tagged entries? ")
  6399. (t (user-error "Wrong input"))))
  6400. (num (string-to-number (read-from-minibuffer msg))))
  6401. (cond ((equal max ?e)
  6402. (let ((org-agenda-max-entries num)) (org-agenda-redo)))
  6403. ((equal max ?t)
  6404. (let ((org-agenda-max-todos num)) (org-agenda-redo)))
  6405. ((equal max ?T)
  6406. (let ((org-agenda-max-tags num)) (org-agenda-redo)))
  6407. ((equal max ?E)
  6408. (let ((org-agenda-max-effort num)) (org-agenda-redo))))))
  6409. (org-agenda-fit-window-to-buffer))
  6410. (defun org-agenda-highlight-todo (x)
  6411. (let ((org-done-keywords org-done-keywords-for-agenda)
  6412. (case-fold-search nil)
  6413. re)
  6414. (if (eq x 'line)
  6415. (save-excursion
  6416. (beginning-of-line 1)
  6417. (setq re (org-get-at-bol 'org-todo-regexp))
  6418. (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
  6419. (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
  6420. (add-text-properties (match-beginning 0) (match-end 1)
  6421. (list 'face (org-get-todo-face 1)))
  6422. (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
  6423. (delete-region (match-beginning 1) (1- (match-end 0)))
  6424. (goto-char (match-beginning 1))
  6425. (insert (format org-agenda-todo-keyword-format s)))))
  6426. (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
  6427. (setq re (get-text-property 0 'org-todo-regexp x))
  6428. (when (and re
  6429. ;; Test `pl' because if there's no heading content,
  6430. ;; there's no point matching to highlight. Note
  6431. ;; that if we didn't test `pl' first, and there
  6432. ;; happened to be no keyword from `org-todo-regexp'
  6433. ;; on this heading line, then the `equal' comparison
  6434. ;; afterwards would spuriously succeed in the case
  6435. ;; where `pl' is nil -- causing an args-out-of-range
  6436. ;; error when we try to add text properties to text
  6437. ;; that isn't there.
  6438. pl
  6439. (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
  6440. x pl) pl))
  6441. (add-text-properties
  6442. (or (match-end 1) (match-end 0)) (match-end 0)
  6443. (list 'face (org-get-todo-face (match-string 2 x)))
  6444. x)
  6445. (when (match-end 1)
  6446. (setq x
  6447. (concat
  6448. (substring x 0 (match-end 1))
  6449. (format org-agenda-todo-keyword-format
  6450. (match-string 2 x))
  6451. ;; Remove `display' property as the icon could leak
  6452. ;; on the white space.
  6453. (org-add-props " " (org-plist-delete (text-properties-at 0 x)
  6454. 'display))
  6455. (substring x (match-end 3)))))))
  6456. x)))
  6457. (defsubst org-cmp-values (a b property)
  6458. "Compare the numeric value of text PROPERTY for string A and B."
  6459. (let ((pa (or (get-text-property (1- (length a)) property a) 0))
  6460. (pb (or (get-text-property (1- (length b)) property b) 0)))
  6461. (cond ((> pa pb) +1)
  6462. ((< pa pb) -1))))
  6463. (defsubst org-cmp-effort (a b)
  6464. "Compare the effort values of string A and B."
  6465. (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
  6466. ;; `effort-minutes' property is not directly accessible from
  6467. ;; the strings, but is stored as a property in `txt'.
  6468. (ea (or (get-text-property
  6469. 0 'effort-minutes (get-text-property 0 'txt a))
  6470. def))
  6471. (eb (or (get-text-property
  6472. 0 'effort-minutes (get-text-property 0 'txt b))
  6473. def)))
  6474. (cond ((> ea eb) +1)
  6475. ((< ea eb) -1))))
  6476. (defsubst org-cmp-category (a b)
  6477. "Compare the string values of categories of strings A and B."
  6478. (let ((ca (or (get-text-property (1- (length a)) 'org-category a) ""))
  6479. (cb (or (get-text-property (1- (length b)) 'org-category b) "")))
  6480. (cond ((string-lessp ca cb) -1)
  6481. ((string-lessp cb ca) +1))))
  6482. (defsubst org-cmp-todo-state (a b)
  6483. "Compare the todo states of strings A and B."
  6484. (let* ((ma (or (get-text-property 1 'org-marker a)
  6485. (get-text-property 1 'org-hd-marker a)))
  6486. (mb (or (get-text-property 1 'org-marker b)
  6487. (get-text-property 1 'org-hd-marker b)))
  6488. (fa (and ma (marker-buffer ma)))
  6489. (fb (and mb (marker-buffer mb)))
  6490. (todo-kwds
  6491. (or (and fa (with-current-buffer fa org-todo-keywords-1))
  6492. (and fb (with-current-buffer fb org-todo-keywords-1))))
  6493. (ta (or (get-text-property 1 'todo-state a) ""))
  6494. (tb (or (get-text-property 1 'todo-state b) ""))
  6495. (la (- (length (member ta todo-kwds))))
  6496. (lb (- (length (member tb todo-kwds))))
  6497. (donepa (member ta org-done-keywords-for-agenda))
  6498. (donepb (member tb org-done-keywords-for-agenda)))
  6499. (cond ((and donepa (not donepb)) -1)
  6500. ((and (not donepa) donepb) +1)
  6501. ((< la lb) -1)
  6502. ((< lb la) +1))))
  6503. (defsubst org-cmp-alpha (a b)
  6504. "Compare the headlines, alphabetically."
  6505. (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
  6506. (plb (text-property-any 0 (length b) 'org-heading t b))
  6507. (ta (and pla (substring a pla)))
  6508. (tb (and plb (substring b plb)))
  6509. (case-fold-search nil))
  6510. (when pla
  6511. (when (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
  6512. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
  6513. (setq ta (substring ta (match-end 0))))
  6514. (setq ta (downcase ta)))
  6515. (when plb
  6516. (when (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
  6517. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
  6518. (setq tb (substring tb (match-end 0))))
  6519. (setq tb (downcase tb)))
  6520. (cond ((not ta) +1)
  6521. ((not tb) -1)
  6522. ((string-lessp ta tb) -1)
  6523. ((string-lessp tb ta) +1))))
  6524. (defsubst org-cmp-tag (a b)
  6525. "Compare the string values of the first tags of A and B."
  6526. (let ((ta (car (last (get-text-property 1 'tags a))))
  6527. (tb (car (last (get-text-property 1 'tags b)))))
  6528. (cond ((not ta) +1)
  6529. ((not tb) -1)
  6530. ((string-lessp ta tb) -1)
  6531. ((string-lessp tb ta) +1))))
  6532. (defsubst org-cmp-time (a b)
  6533. "Compare the time-of-day values of strings A and B."
  6534. (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
  6535. (ta (or (get-text-property 1 'time-of-day a) def))
  6536. (tb (or (get-text-property 1 'time-of-day b) def)))
  6537. (cond ((< ta tb) -1)
  6538. ((< tb ta) +1))))
  6539. (defsubst org-cmp-ts (a b type)
  6540. "Compare the timestamps values of entries A and B.
  6541. When TYPE is \"scheduled\", \"deadline\", \"timestamp\" or
  6542. \"timestamp_ia\", compare within each of these type. When TYPE
  6543. is the empty string, compare all timestamps without respect of
  6544. their type."
  6545. (let* ((def (and (not org-sort-agenda-notime-is-late) -1))
  6546. (ta (or (and (string-match type (or (get-text-property 1 'type a) ""))
  6547. (get-text-property 1 'ts-date a))
  6548. def))
  6549. (tb (or (and (string-match type (or (get-text-property 1 'type b) ""))
  6550. (get-text-property 1 'ts-date b))
  6551. def)))
  6552. (cond ((if ta (and tb (< ta tb)) tb) -1)
  6553. ((if tb (and ta (< tb ta)) ta) +1))))
  6554. (defsubst org-cmp-habit-p (a b)
  6555. "Compare the todo states of strings A and B."
  6556. (let ((ha (get-text-property 1 'org-habit-p a))
  6557. (hb (get-text-property 1 'org-habit-p b)))
  6558. (cond ((and ha (not hb)) -1)
  6559. ((and (not ha) hb) +1))))
  6560. (defun org-entries-lessp (a b)
  6561. "Predicate for sorting agenda entries."
  6562. ;; The following variables will be used when the form is evaluated.
  6563. ;; So even though the compiler complains, keep them.
  6564. (let* ((ss org-agenda-sorting-strategy-selected)
  6565. (timestamp-up (and (org-em 'timestamp-up 'timestamp-down ss)
  6566. (org-cmp-ts a b "")))
  6567. (timestamp-down (if timestamp-up (- timestamp-up) nil))
  6568. (scheduled-up (and (org-em 'scheduled-up 'scheduled-down ss)
  6569. (org-cmp-ts a b "scheduled")))
  6570. (scheduled-down (if scheduled-up (- scheduled-up) nil))
  6571. (deadline-up (and (org-em 'deadline-up 'deadline-down ss)
  6572. (org-cmp-ts a b "deadline")))
  6573. (deadline-down (if deadline-up (- deadline-up) nil))
  6574. (tsia-up (and (org-em 'tsia-up 'tsia-down ss)
  6575. (org-cmp-ts a b "timestamp_ia")))
  6576. (tsia-down (if tsia-up (- tsia-up) nil))
  6577. (ts-up (and (org-em 'ts-up 'ts-down ss)
  6578. (org-cmp-ts a b "timestamp")))
  6579. (ts-down (if ts-up (- ts-up) nil))
  6580. (time-up (and (org-em 'time-up 'time-down ss)
  6581. (org-cmp-time a b)))
  6582. (time-down (if time-up (- time-up) nil))
  6583. (stats-up (and (org-em 'stats-up 'stats-down ss)
  6584. (org-cmp-values a b 'org-stats)))
  6585. (stats-down (if stats-up (- stats-up) nil))
  6586. (priority-up (and (org-em 'priority-up 'priority-down ss)
  6587. (org-cmp-values a b 'priority)))
  6588. (priority-down (if priority-up (- priority-up) nil))
  6589. (effort-up (and (org-em 'effort-up 'effort-down ss)
  6590. (org-cmp-effort a b)))
  6591. (effort-down (if effort-up (- effort-up) nil))
  6592. (category-up (and (or (org-em 'category-up 'category-down ss)
  6593. (memq 'category-keep ss))
  6594. (org-cmp-category a b)))
  6595. (category-down (if category-up (- category-up) nil))
  6596. (category-keep (if category-up +1 nil))
  6597. (tag-up (and (org-em 'tag-up 'tag-down ss)
  6598. (org-cmp-tag a b)))
  6599. (tag-down (if tag-up (- tag-up) nil))
  6600. (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
  6601. (org-cmp-todo-state a b)))
  6602. (todo-state-down (if todo-state-up (- todo-state-up) nil))
  6603. (habit-up (and (org-em 'habit-up 'habit-down ss)
  6604. (org-cmp-habit-p a b)))
  6605. (habit-down (if habit-up (- habit-up) nil))
  6606. (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
  6607. (org-cmp-alpha a b)))
  6608. (alpha-down (if alpha-up (- alpha-up) nil))
  6609. (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
  6610. user-defined-up user-defined-down)
  6611. (when (and need-user-cmp org-agenda-cmp-user-defined
  6612. (functionp org-agenda-cmp-user-defined))
  6613. (setq user-defined-up
  6614. (funcall org-agenda-cmp-user-defined a b)
  6615. user-defined-down (if user-defined-up (- user-defined-up) nil)))
  6616. (cdr (assoc
  6617. (eval (cons 'or org-agenda-sorting-strategy-selected))
  6618. '((-1 . t) (1 . nil) (nil . nil))))))
  6619. ;;; Agenda restriction lock
  6620. (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
  6621. "Overlay to mark the headline to which agenda commands are restricted.")
  6622. (overlay-put org-agenda-restriction-lock-overlay
  6623. 'face 'org-agenda-restriction-lock)
  6624. (overlay-put org-agenda-restriction-lock-overlay
  6625. 'help-echo "Agendas are currently limited to this subtree.")
  6626. (delete-overlay org-agenda-restriction-lock-overlay)
  6627. (defun org-agenda-set-restriction-lock-from-agenda (arg)
  6628. "Set the restriction lock to the agenda item at point from within the agenda.
  6629. When called with a `\\[universal-argument]' prefix, restrict to
  6630. the file which contains the item.
  6631. Argument ARG is the prefix argument."
  6632. (interactive "P")
  6633. (unless (derived-mode-p 'org-agenda-mode)
  6634. (user-error "Not in an Org agenda buffer"))
  6635. (let* ((marker (or (org-get-at-bol 'org-marker)
  6636. (org-agenda-error)))
  6637. (buffer (marker-buffer marker))
  6638. (pos (marker-position marker)))
  6639. (with-current-buffer buffer
  6640. (goto-char pos)
  6641. (org-agenda-set-restriction-lock arg))))
  6642. ;;;###autoload
  6643. (defun org-agenda-set-restriction-lock (&optional type)
  6644. "Set restriction lock for agenda to current subtree or file.
  6645. When in a restricted subtree, remove it.
  6646. The restriction will span over the entire file if TYPE is `file',
  6647. or if type is '(4), or if the cursor is before the first headline
  6648. in the file. Otherwise, only apply the restriction to the current
  6649. subtree."
  6650. (interactive "P")
  6651. (if (and org-agenda-overriding-restriction
  6652. (member org-agenda-restriction-lock-overlay
  6653. (overlays-at (point)))
  6654. (equal (overlay-start org-agenda-restriction-lock-overlay)
  6655. (point)))
  6656. (org-agenda-remove-restriction-lock 'noupdate)
  6657. (org-agenda-remove-restriction-lock 'noupdate)
  6658. (and (equal type '(4)) (setq type 'file))
  6659. (setq type (cond
  6660. (type type)
  6661. ((org-at-heading-p) 'subtree)
  6662. ((condition-case nil (org-back-to-heading t) (error nil))
  6663. 'subtree)
  6664. (t 'file)))
  6665. (if (eq type 'subtree)
  6666. (progn
  6667. (setq org-agenda-restrict (current-buffer))
  6668. (setq org-agenda-overriding-restriction 'subtree)
  6669. (put 'org-agenda-files 'org-restrict
  6670. (list (buffer-file-name (buffer-base-buffer))))
  6671. (org-back-to-heading t)
  6672. (move-overlay org-agenda-restriction-lock-overlay
  6673. (point)
  6674. (if org-agenda-restriction-lock-highlight-subtree
  6675. (save-excursion (org-end-of-subtree t t) (point))
  6676. (point-at-eol)))
  6677. (move-marker org-agenda-restrict-begin (point))
  6678. (move-marker org-agenda-restrict-end
  6679. (save-excursion (org-end-of-subtree t t)))
  6680. (message "Locking agenda restriction to subtree"))
  6681. (put 'org-agenda-files 'org-restrict
  6682. (list (buffer-file-name (buffer-base-buffer))))
  6683. (setq org-agenda-restrict nil)
  6684. (setq org-agenda-overriding-restriction 'file)
  6685. (move-marker org-agenda-restrict-begin nil)
  6686. (move-marker org-agenda-restrict-end nil)
  6687. (message "Locking agenda restriction to file"))
  6688. (setq current-prefix-arg nil))
  6689. (org-agenda-maybe-redo))
  6690. (defun org-agenda-remove-restriction-lock (&optional noupdate)
  6691. "Remove agenda restriction lock."
  6692. (interactive "P")
  6693. (if (not org-agenda-restrict)
  6694. (message "No agenda restriction to remove.")
  6695. (delete-overlay org-agenda-restriction-lock-overlay)
  6696. (delete-overlay org-speedbar-restriction-lock-overlay)
  6697. (setq org-agenda-overriding-restriction nil)
  6698. (setq org-agenda-restrict nil)
  6699. (put 'org-agenda-files 'org-restrict nil)
  6700. (move-marker org-agenda-restrict-begin nil)
  6701. (move-marker org-agenda-restrict-end nil)
  6702. (setq current-prefix-arg nil)
  6703. (message "Agenda restriction lock removed")
  6704. (or noupdate (org-agenda-maybe-redo))))
  6705. (defun org-agenda-maybe-redo ()
  6706. "If there is any window showing the agenda view, update it."
  6707. (let ((w (get-buffer-window (or org-agenda-this-buffer-name
  6708. org-agenda-buffer-name)
  6709. t))
  6710. (w0 (selected-window)))
  6711. (when w
  6712. (select-window w)
  6713. (org-agenda-redo)
  6714. (select-window w0)
  6715. (if org-agenda-overriding-restriction
  6716. (message "Agenda view shifted to new %s restriction"
  6717. org-agenda-overriding-restriction)
  6718. (message "Agenda restriction lock removed")))))
  6719. ;;; Agenda commands
  6720. (defun org-agenda-check-type (error &rest types)
  6721. "Check if agenda buffer is of allowed type.
  6722. If ERROR is non-nil, throw an error, otherwise just return nil.
  6723. Allowed types are `agenda' `todo' `tags' `search'."
  6724. (cond ((not org-agenda-type)
  6725. (error "No Org agenda currently displayed"))
  6726. ((memq org-agenda-type types) t)
  6727. (error
  6728. (error "Not allowed in %s-type agenda buffers" org-agenda-type))
  6729. (t nil)))
  6730. (defun org-agenda-Quit ()
  6731. "Exit the agenda, killing the agenda buffer.
  6732. Like `org-agenda-quit', but kill the buffer even when
  6733. `org-agenda-sticky' is non-nil."
  6734. (interactive)
  6735. (org-agenda--quit))
  6736. (defun org-agenda-quit ()
  6737. "Exit the agenda.
  6738. When `org-agenda-sticky' is non-nil, bury the agenda buffer
  6739. instead of killing it.
  6740. When `org-agenda-restore-windows-after-quit' is non-nil, restore
  6741. the pre-agenda window configuration.
  6742. When column view is active, exit column view instead of the
  6743. agenda."
  6744. (interactive)
  6745. (org-agenda--quit org-agenda-sticky))
  6746. (defun org-agenda--quit (&optional bury)
  6747. (if org-agenda-columns-active
  6748. (org-columns-quit)
  6749. (let ((wconf org-agenda-pre-window-conf)
  6750. (buf (current-buffer))
  6751. (org-agenda-last-indirect-window
  6752. (and (eq org-indirect-buffer-display 'other-window)
  6753. org-agenda-last-indirect-buffer
  6754. (get-buffer-window org-agenda-last-indirect-buffer))))
  6755. (cond
  6756. ((eq org-agenda-window-setup 'other-frame)
  6757. (delete-frame))
  6758. ((and org-agenda-restore-windows-after-quit
  6759. wconf)
  6760. ;; Maybe restore the pre-agenda window configuration. Reset
  6761. ;; `org-agenda-pre-window-conf' before running
  6762. ;; `set-window-configuration', which loses the current buffer.
  6763. (setq org-agenda-pre-window-conf nil)
  6764. (set-window-configuration wconf))
  6765. (t
  6766. (when org-agenda-last-indirect-window
  6767. (delete-window org-agenda-last-indirect-window))
  6768. (and (not (eq org-agenda-window-setup 'current-window))
  6769. (not (one-window-p))
  6770. (delete-window))))
  6771. (if bury
  6772. ;; Set the agenda buffer as the current buffer instead of
  6773. ;; passing it as an argument to `bury-buffer' so that
  6774. ;; `bury-buffer' removes it from the window.
  6775. (with-current-buffer buf
  6776. (bury-buffer))
  6777. (kill-buffer buf)
  6778. (setq org-agenda-archives-mode nil
  6779. org-agenda-buffer nil)))))
  6780. (defun org-agenda-exit ()
  6781. "Exit the agenda, killing Org buffers loaded by the agenda.
  6782. Like `org-agenda-Quit', but kill any buffers that were created by
  6783. the agenda. Org buffers visited directly by the user will not be
  6784. touched. Also, exit the agenda even if it is in column view."
  6785. (interactive)
  6786. (when org-agenda-columns-active
  6787. (org-columns-quit))
  6788. (org-release-buffers org-agenda-new-buffers)
  6789. (setq org-agenda-new-buffers nil)
  6790. (org-agenda-Quit))
  6791. (defun org-agenda-kill-all-agenda-buffers ()
  6792. "Kill all buffers in `org-agenda-mode'.
  6793. This is used when toggling sticky agendas."
  6794. (interactive)
  6795. (let (blist)
  6796. (dolist (buf (buffer-list))
  6797. (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
  6798. (push buf blist)))
  6799. (mapc 'kill-buffer blist)))
  6800. (defun org-agenda-execute (arg)
  6801. "Execute another agenda command, keeping same window.
  6802. So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
  6803. in the agenda."
  6804. (interactive "P")
  6805. (let ((org-agenda-window-setup 'current-window))
  6806. (org-agenda arg)))
  6807. (defun org-agenda-redo (&optional all)
  6808. "Rebuild possibly ALL agenda view(s) in the current buffer."
  6809. (interactive "P")
  6810. (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
  6811. (cpa (unless (eq all t) current-prefix-arg))
  6812. (org-agenda-doing-sticky-redo org-agenda-sticky)
  6813. (org-agenda-sticky nil)
  6814. (org-agenda-buffer-name (or org-agenda-this-buffer-name
  6815. org-agenda-buffer-name))
  6816. (org-agenda-keep-modes t)
  6817. (tag-filter org-agenda-tag-filter)
  6818. (tag-preset (get 'org-agenda-tag-filter :preset-filter))
  6819. (top-hl-filter org-agenda-top-headline-filter)
  6820. (cat-filter org-agenda-category-filter)
  6821. (cat-preset (get 'org-agenda-category-filter :preset-filter))
  6822. (re-filter org-agenda-regexp-filter)
  6823. (re-preset (get 'org-agenda-regexp-filter :preset-filter))
  6824. (effort-filter org-agenda-effort-filter)
  6825. (effort-preset (get 'org-agenda-effort-filter :preset-filter))
  6826. (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
  6827. (cols org-agenda-columns-active)
  6828. (line (org-current-line))
  6829. (window-line (- line (org-current-line (window-start))))
  6830. (lprops (get 'org-agenda-redo-command 'org-lprops))
  6831. (redo-cmd (get-text-property p 'org-redo-cmd))
  6832. (last-args (get-text-property p 'org-last-args))
  6833. (org-agenda-overriding-cmd (get-text-property p 'org-series-cmd))
  6834. (org-agenda-overriding-cmd-arguments
  6835. (unless (eq all t)
  6836. (cond ((listp last-args)
  6837. (cons (or cpa (car last-args)) (cdr last-args)))
  6838. ((stringp last-args)
  6839. last-args))))
  6840. (series-redo-cmd (get-text-property p 'org-series-redo-cmd)))
  6841. (put 'org-agenda-tag-filter :preset-filter nil)
  6842. (put 'org-agenda-category-filter :preset-filter nil)
  6843. (put 'org-agenda-regexp-filter :preset-filter nil)
  6844. (put 'org-agenda-effort-filter :preset-filter nil)
  6845. (and cols (org-columns-quit))
  6846. (message "Rebuilding agenda buffer...")
  6847. (if series-redo-cmd
  6848. (eval series-redo-cmd)
  6849. (org-let lprops redo-cmd))
  6850. (setq org-agenda-undo-list nil
  6851. org-agenda-pending-undo-list nil
  6852. org-agenda-tag-filter tag-filter
  6853. org-agenda-category-filter cat-filter
  6854. org-agenda-regexp-filter re-filter
  6855. org-agenda-effort-filter effort-filter
  6856. org-agenda-top-headline-filter top-hl-filter)
  6857. (message "Rebuilding agenda buffer...done")
  6858. (put 'org-agenda-tag-filter :preset-filter tag-preset)
  6859. (put 'org-agenda-category-filter :preset-filter cat-preset)
  6860. (put 'org-agenda-regexp-filter :preset-filter re-preset)
  6861. (put 'org-agenda-effort-filter :preset-filter effort-preset)
  6862. (let ((tag (or tag-filter tag-preset))
  6863. (cat (or cat-filter cat-preset))
  6864. (effort (or effort-filter effort-preset))
  6865. (re (or re-filter re-preset)))
  6866. (when tag (org-agenda-filter-apply tag 'tag t))
  6867. (when cat (org-agenda-filter-apply cat 'category))
  6868. (when effort (org-agenda-filter-apply effort 'effort))
  6869. (when re (org-agenda-filter-apply re 'regexp)))
  6870. (and top-hl-filter (org-agenda-filter-top-headline-apply top-hl-filter))
  6871. (and cols (called-interactively-p 'any) (org-agenda-columns))
  6872. (org-goto-line line)
  6873. (recenter window-line)))
  6874. (defun org-agenda-redo-all (&optional exhaustive)
  6875. "Rebuild all agenda views in the current buffer.
  6876. With a prefix argument, do so in all agenda buffers."
  6877. (interactive "P")
  6878. (if exhaustive
  6879. (dolist (buffer (buffer-list))
  6880. (with-current-buffer buffer
  6881. (when (derived-mode-p 'org-agenda-mode)
  6882. (org-agenda-redo t))))
  6883. (org-agenda-redo t)))
  6884. (defvar org-global-tags-completion-table nil)
  6885. (defvar org-agenda-filter-form nil)
  6886. (defvar org-agenda-filtered-by-category nil)
  6887. (defsubst org-agenda-get-category ()
  6888. "Return the category of the agenda line."
  6889. (org-get-at-bol 'org-category))
  6890. (defun org-agenda-filter-by-category (strip)
  6891. "Filter lines in the agenda buffer that have a specific category.
  6892. The category is that of the current line.
  6893. Without prefix argument, keep only the lines of that category.
  6894. With a prefix argument, exclude the lines of that category.
  6895. "
  6896. (interactive "P")
  6897. (if (and org-agenda-filtered-by-category
  6898. org-agenda-category-filter)
  6899. (org-agenda-filter-show-all-cat)
  6900. (let ((cat (org-no-properties (org-agenda-get-category))))
  6901. (cond
  6902. ((and cat strip)
  6903. (org-agenda-filter-apply
  6904. (push (concat "-" cat) org-agenda-category-filter) 'category))
  6905. (cat
  6906. (org-agenda-filter-apply
  6907. (setq org-agenda-category-filter
  6908. (list (concat "+" cat))) 'category))
  6909. (t (error "No category at point"))))))
  6910. (defun org-find-top-headline (&optional pos)
  6911. "Find the topmost parent headline and return it.
  6912. POS when non-nil is the marker or buffer position to start the
  6913. search from."
  6914. (save-excursion
  6915. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  6916. (when pos (goto-char pos))
  6917. ;; Skip up to the topmost parent.
  6918. (while (org-up-heading-safe))
  6919. (ignore-errors (nth 4 (org-heading-components))))))
  6920. (defvar org-agenda-filtered-by-top-headline nil)
  6921. (defun org-agenda-filter-by-top-headline (strip)
  6922. "Keep only those lines that are descendants from the same top headline.
  6923. The top headline is that of the current line."
  6924. (interactive "P")
  6925. (if org-agenda-filtered-by-top-headline
  6926. (progn
  6927. (setq org-agenda-filtered-by-top-headline nil
  6928. org-agenda-top-headline-filter nil)
  6929. (org-agenda-filter-show-all-top-filter))
  6930. (let ((toph (org-find-top-headline (org-get-at-bol 'org-hd-marker))))
  6931. (if toph (org-agenda-filter-top-headline-apply toph strip)
  6932. (error "No top-level headline at point")))))
  6933. (defvar org-agenda-regexp-filter nil)
  6934. (defun org-agenda-filter-by-regexp (strip)
  6935. "Filter agenda entries by regular expressions.
  6936. With one prefix argument, filter out entries matching the regexp.
  6937. If there is already a regexp filter, remove it unless called with
  6938. two prefix arguments."
  6939. (interactive "P")
  6940. (cond
  6941. ((and org-agenda-regexp-filter (not (equal strip '(16))))
  6942. (org-agenda-filter-show-all-re)
  6943. (message "Regexp filter removed"))
  6944. (t (let ((flt (concat (if (equal strip '(4)) "-" "+")
  6945. (read-from-minibuffer
  6946. (if (equal strip '(4))
  6947. "Filter out entries matching regexp: "
  6948. "Narrow to entries matching regexp: ")))))
  6949. (push flt org-agenda-regexp-filter)
  6950. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp)))))
  6951. (defvar org-agenda-effort-filter nil)
  6952. (defun org-agenda-filter-by-effort (strip)
  6953. "Filter agenda entries by effort.
  6954. With no prefix argument, keep entries matching the effort condition.
  6955. With one prefix argument, filter out entries matching the condition.
  6956. With two prefix arguments, remove the effort filters."
  6957. (interactive "P")
  6958. (cond
  6959. ((member strip '(nil 4))
  6960. (let* ((efforts (split-string
  6961. (or (cdr (assoc (concat org-effort-property "_ALL")
  6962. org-global-properties))
  6963. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00")))
  6964. ;; XXX: the following handles only up to 10 different
  6965. ;; effort values.
  6966. (allowed-keys (if (null efforts) nil
  6967. (mapcar (lambda (n) (mod n 10)) ;turn 10 into 0
  6968. (number-sequence 1 (length efforts)))))
  6969. (op nil))
  6970. (while (not (memq op '(?< ?> ?=)))
  6971. (setq op (read-char-exclusive "Effort operator? (> = or <)")))
  6972. ;; Select appropriate duration. Ignore non-digit characters.
  6973. (let ((prompt
  6974. (apply #'format
  6975. (concat "Effort %c "
  6976. (mapconcat (lambda (s) (concat "[%d]" s))
  6977. efforts
  6978. " "))
  6979. op allowed-keys))
  6980. (eff -1))
  6981. (while (not (memq eff allowed-keys))
  6982. (message prompt)
  6983. (setq eff (- (read-char-exclusive) 48)))
  6984. (setq org-agenda-effort-filter
  6985. (list (concat (if strip "-" "+")
  6986. (char-to-string op)
  6987. ;; Numbering is 1 2 3 ... 9 0, but we want
  6988. ;; 0 1 2 ... 8 9.
  6989. (nth (mod (1- eff) 10) efforts)))))
  6990. (org-agenda-filter-apply org-agenda-effort-filter 'effort)))
  6991. (t (org-agenda-filter-show-all-effort)
  6992. (message "Effort filter removed"))))
  6993. (defun org-agenda-filter-remove-all ()
  6994. "Remove all filters from the current agenda buffer."
  6995. (interactive)
  6996. (when org-agenda-tag-filter
  6997. (org-agenda-filter-show-all-tag))
  6998. (when org-agenda-category-filter
  6999. (org-agenda-filter-show-all-cat))
  7000. (when org-agenda-regexp-filter
  7001. (org-agenda-filter-show-all-re))
  7002. (when org-agenda-top-headline-filter
  7003. (org-agenda-filter-show-all-top-filter))
  7004. (when org-agenda-effort-filter
  7005. (org-agenda-filter-show-all-effort))
  7006. (org-agenda-finalize))
  7007. (defun org-agenda-filter-by-tag (arg &optional char exclude)
  7008. "Keep only those lines in the agenda buffer that have a specific tag.
  7009. The tag is selected with its fast selection letter, as configured.
  7010. With a `\\[universal-argument]' prefix, exclude the agenda search.
  7011. With a `\\[universal-argument] \\[universal-argument]' prefix, filter the literal tag, \
  7012. i.e. don't
  7013. filter on all its group members.
  7014. A lisp caller can specify CHAR. EXCLUDE means that the new tag
  7015. should be used to exclude the search - the interactive user can
  7016. also press `-' or `+' to switch between filtering and excluding."
  7017. (interactive "P")
  7018. (let* ((alist org-tag-alist-for-agenda)
  7019. (tag-chars (mapconcat
  7020. (lambda (x) (if (and (not (symbolp (car x)))
  7021. (cdr x))
  7022. (char-to-string (cdr x))
  7023. ""))
  7024. org-tag-alist-for-agenda ""))
  7025. (valid-char-list (append '(?\t ?\r ?/ ?. ?\s ?q)
  7026. (string-to-list tag-chars)))
  7027. (exclude (or exclude (equal arg '(4))))
  7028. (expand (not (equal arg '(16))))
  7029. (inhibit-read-only t)
  7030. (current org-agenda-tag-filter)
  7031. a n tag)
  7032. (unless char
  7033. (while (not (memq char valid-char-list))
  7034. (org-unlogged-message
  7035. "%s by tag [%s ]:tag-char, [TAB]:tag, %s[/]:off, [+/-]:filter/exclude%s, [q]:quit"
  7036. (if exclude "Exclude" "Filter")
  7037. tag-chars
  7038. (if org-agenda-auto-exclude-function "[RET], " "")
  7039. (if expand "" ", no grouptag expand"))
  7040. (setq char (read-char-exclusive))
  7041. ;; Excluding or filtering down
  7042. (cond ((eq char ?-) (setq exclude t))
  7043. ((eq char ?+) (setq exclude nil)))))
  7044. (when (eq char ?\t)
  7045. (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
  7046. (setq-local org-global-tags-completion-table
  7047. (org-global-tags-completion-table)))
  7048. (let ((completion-ignore-case t))
  7049. (setq tag (completing-read
  7050. "Tag: " org-global-tags-completion-table nil t))))
  7051. (cond
  7052. ((eq char ?\r)
  7053. (org-agenda-filter-show-all-tag)
  7054. (when org-agenda-auto-exclude-function
  7055. (setq org-agenda-tag-filter nil)
  7056. (dolist (tag (org-agenda-get-represented-tags))
  7057. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  7058. (when modifier
  7059. (push modifier org-agenda-tag-filter))))
  7060. (unless (null org-agenda-tag-filter)
  7061. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))))
  7062. ((eq char ?/)
  7063. (org-agenda-filter-show-all-tag)
  7064. (when (get 'org-agenda-tag-filter :preset-filter)
  7065. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand)))
  7066. ((eq char ?.)
  7067. (setq org-agenda-tag-filter
  7068. (mapcar (lambda(tag) (concat "+" tag))
  7069. (org-get-at-bol 'tags)))
  7070. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  7071. ((eq char ?q)) ;If q, abort (even if there is a q-key for a tag...)
  7072. ((or (eq char ?\s)
  7073. (setq a (rassoc char alist))
  7074. (and tag (setq a (cons tag nil))))
  7075. (org-agenda-filter-show-all-tag)
  7076. (setq tag (car a))
  7077. (setq org-agenda-tag-filter
  7078. (cons (concat (if exclude "-" "+") tag)
  7079. current))
  7080. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  7081. (t (error "Invalid tag selection character %c" char)))))
  7082. (defun org-agenda-get-represented-tags ()
  7083. "Get a list of all tags currently represented in the agenda."
  7084. (let (p tags)
  7085. (save-excursion
  7086. (goto-char (point-min))
  7087. (while (setq p (next-single-property-change (point) 'tags))
  7088. (goto-char p)
  7089. (mapc (lambda (x) (add-to-list 'tags x))
  7090. (get-text-property (point) 'tags))))
  7091. tags))
  7092. (defun org-agenda-filter-make-matcher (filter type &optional expand)
  7093. "Create the form that tests a line for agenda filter. Optional
  7094. argument EXPAND can be used for the TYPE tag and will expand the
  7095. tags in the FILTER if any of the tags in FILTER are grouptags."
  7096. (let (f f1)
  7097. (cond
  7098. ;; Tag filter
  7099. ((eq type 'tag)
  7100. (setq filter
  7101. (delete-dups
  7102. (append (get 'org-agenda-tag-filter :preset-filter)
  7103. filter)))
  7104. (dolist (x filter)
  7105. (let ((op (string-to-char x)))
  7106. (if expand (setq x (org-agenda-filter-expand-tags (list x) t))
  7107. (setq x (list x)))
  7108. (setq f1 (org-agenda-filter-make-matcher-tag-exp x op))
  7109. (push f1 f))))
  7110. ;; Category filter
  7111. ((eq type 'category)
  7112. (setq filter
  7113. (delete-dups
  7114. (append (get 'org-agenda-category-filter :preset-filter)
  7115. filter)))
  7116. (dolist (x filter)
  7117. (if (equal "-" (substring x 0 1))
  7118. (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
  7119. (setq f1 (list 'equal (substring x 1) 'cat)))
  7120. (push f1 f)))
  7121. ;; Regexp filter
  7122. ((eq type 'regexp)
  7123. (setq filter
  7124. (delete-dups
  7125. (append (get 'org-agenda-regexp-filter :preset-filter)
  7126. filter)))
  7127. (dolist (x filter)
  7128. (if (equal "-" (substring x 0 1))
  7129. (setq f1 (list 'not (list 'string-match (substring x 1) 'txt)))
  7130. (setq f1 (list 'string-match (substring x 1) 'txt)))
  7131. (push f1 f)))
  7132. ;; Effort filter
  7133. ((eq type 'effort)
  7134. (setq filter
  7135. (delete-dups
  7136. (append (get 'org-agenda-effort-filter :preset-filter)
  7137. filter)))
  7138. (dolist (x filter)
  7139. (push (org-agenda-filter-effort-form x) f))))
  7140. (cons 'and (nreverse f))))
  7141. (defun org-agenda-filter-make-matcher-tag-exp (tags op)
  7142. "Return a form associated to tag-expression TAGS.
  7143. Build a form testing a line for agenda filter for
  7144. tag-expressions. OP is an operator of type CHAR that allows the
  7145. function to set the right switches in the returned form."
  7146. (let (form)
  7147. ;; Any of the expressions can match if OP is +, all must match if
  7148. ;; the operator is -.
  7149. (dolist (x tags (cons (if (eq op ?-) 'and 'or) form))
  7150. (let* ((tag (substring x 1))
  7151. (f (cond
  7152. ((string= "" tag) '(not tags))
  7153. ((and (string-match-p "\\`{" tag) (string-match-p "}\\'" tag))
  7154. ;; TAG is a regexp.
  7155. (list 'org-match-any-p (substring tag 1 -1) 'tags))
  7156. (t (list 'member (downcase tag) 'tags)))))
  7157. (push (if (eq op ?-) (list 'not f) f) form)))))
  7158. (defun org-agenda-filter-effort-form (e)
  7159. "Return the form to compare the effort of the current line with what E says.
  7160. E looks like \"+<2:25\"."
  7161. (let (op)
  7162. (setq e (substring e 1))
  7163. (setq op (string-to-char e) e (substring e 1))
  7164. (setq op (cond ((equal op ?<) '<=)
  7165. ((equal op ?>) '>=)
  7166. ((equal op ??) op)
  7167. (t '=)))
  7168. (list 'org-agenda-compare-effort (list 'quote op)
  7169. (org-duration-to-minutes e))))
  7170. (defun org-agenda-compare-effort (op value)
  7171. "Compare the effort of the current line with VALUE, using OP.
  7172. If the line does not have an effort defined, return nil."
  7173. ;; `effort-minutes' property cannot be extracted directly from
  7174. ;; current line but is stored as a property in `txt'.
  7175. (let ((effort (get-text-property 0 'effort-minutes (org-get-at-bol 'txt))))
  7176. (funcall op
  7177. (or effort (if org-sort-agenda-noeffort-is-high 32767 -1))
  7178. value)))
  7179. (defun org-agenda-filter-expand-tags (filter &optional no-operator)
  7180. "Expand group tags in FILTER for the agenda.
  7181. When NO-OPERATOR is non-nil, do not add the + operator to returned tags."
  7182. (if org-group-tags
  7183. (let ((case-fold-search t) rtn)
  7184. (mapc
  7185. (lambda (f)
  7186. (let (f0 dir)
  7187. (if (string-match "^\\([+-]\\)\\(.+\\)" f)
  7188. (setq dir (match-string 1 f) f0 (match-string 2 f))
  7189. (setq dir (if no-operator "" "+") f0 f))
  7190. (setq rtn (append (mapcar (lambda(f1) (concat dir f1))
  7191. (org-tags-expand f0 t t))
  7192. rtn))))
  7193. filter)
  7194. (reverse rtn))
  7195. filter))
  7196. (defun org-agenda-filter-apply (filter type &optional expand)
  7197. "Set FILTER as the new agenda filter and apply it. Optional
  7198. argument EXPAND can be used for the TYPE tag and will expand the
  7199. tags in the FILTER if any of the tags in FILTER are grouptags."
  7200. ;; Deactivate `org-agenda-entry-text-mode' when filtering
  7201. (when org-agenda-entry-text-mode (org-agenda-entry-text-mode))
  7202. (let (tags cat txt)
  7203. (setq org-agenda-filter-form (org-agenda-filter-make-matcher filter type expand))
  7204. ;; Only set `org-agenda-filtered-by-category' to t when a unique
  7205. ;; category is used as the filter:
  7206. (setq org-agenda-filtered-by-category
  7207. (and (eq type 'category)
  7208. (not (equal (substring (car filter) 0 1) "-"))))
  7209. (org-agenda-set-mode-name)
  7210. (save-excursion
  7211. (goto-char (point-min))
  7212. (while (not (eobp))
  7213. (if (org-get-at-bol 'org-marker)
  7214. (progn
  7215. (setq tags (org-get-at-bol 'tags)
  7216. cat (org-agenda-get-category)
  7217. txt (org-get-at-bol 'txt))
  7218. (unless (eval org-agenda-filter-form)
  7219. (org-agenda-filter-hide-line type))
  7220. (beginning-of-line 2))
  7221. (beginning-of-line 2))))
  7222. (when (get-char-property (point) 'invisible)
  7223. (ignore-errors (org-agenda-previous-line)))))
  7224. (defun org-agenda-filter-top-headline-apply (hl &optional negative)
  7225. "Filter by top headline HL."
  7226. (org-agenda-set-mode-name)
  7227. (save-excursion
  7228. (goto-char (point-min))
  7229. (while (not (eobp))
  7230. (let* ((pos (org-get-at-bol 'org-hd-marker))
  7231. (tophl (and pos (org-find-top-headline pos))))
  7232. (when (and tophl (funcall (if negative 'identity 'not)
  7233. (string= hl tophl)))
  7234. (org-agenda-filter-hide-line 'top-headline)))
  7235. (beginning-of-line 2)))
  7236. (when (get-char-property (point) 'invisible)
  7237. (org-agenda-previous-line))
  7238. (setq org-agenda-top-headline-filter hl
  7239. org-agenda-filtered-by-top-headline t))
  7240. (defun org-agenda-filter-hide-line (type)
  7241. "Hide lines with TYPE in the agenda buffer."
  7242. (let* ((b (max (point-min) (1- (point-at-bol))))
  7243. (e (point-at-eol)))
  7244. (let ((inhibit-read-only t))
  7245. (add-text-properties
  7246. b e `(invisible org-filtered org-filter-type ,type)))))
  7247. (defun org-agenda-remove-filter (type)
  7248. (interactive)
  7249. "Remove filter of type TYPE from the agenda buffer."
  7250. (save-excursion
  7251. (goto-char (point-min))
  7252. (let ((inhibit-read-only t) pos)
  7253. (while (setq pos (text-property-any (point) (point-max) 'org-filter-type type))
  7254. (goto-char pos)
  7255. (remove-text-properties
  7256. (point) (next-single-property-change (point) 'org-filter-type)
  7257. `(invisible org-filtered org-filter-type ,type))))
  7258. (set (intern (format "org-agenda-%s-filter" (intern-soft type))) nil)
  7259. (setq org-agenda-filter-form nil)
  7260. (org-agenda-set-mode-name)
  7261. (org-agenda-finalize)))
  7262. (defun org-agenda-filter-show-all-tag nil
  7263. (org-agenda-remove-filter 'tag))
  7264. (defun org-agenda-filter-show-all-re nil
  7265. (org-agenda-remove-filter 'regexp))
  7266. (defun org-agenda-filter-show-all-effort nil
  7267. (org-agenda-remove-filter 'effort))
  7268. (defun org-agenda-filter-show-all-cat nil
  7269. (org-agenda-remove-filter 'category))
  7270. (defun org-agenda-filter-show-all-top-filter nil
  7271. (org-agenda-remove-filter 'top-headline))
  7272. (defun org-agenda-manipulate-query-add ()
  7273. "Manipulate the query by adding a search term with positive selection.
  7274. Positive selection means the term must be matched for selection of an entry."
  7275. (interactive)
  7276. (org-agenda-manipulate-query ?\[))
  7277. (defun org-agenda-manipulate-query-subtract ()
  7278. "Manipulate the query by adding a search term with negative selection.
  7279. Negative selection means term must not be matched for selection of an entry."
  7280. (interactive)
  7281. (org-agenda-manipulate-query ?\]))
  7282. (defun org-agenda-manipulate-query-add-re ()
  7283. "Manipulate the query by adding a search regexp with positive selection.
  7284. Positive selection means the regexp must match for selection of an entry."
  7285. (interactive)
  7286. (org-agenda-manipulate-query ?\{))
  7287. (defun org-agenda-manipulate-query-subtract-re ()
  7288. "Manipulate the query by adding a search regexp with negative selection.
  7289. Negative selection means regexp must not match for selection of an entry."
  7290. (interactive)
  7291. (org-agenda-manipulate-query ?\}))
  7292. (defun org-agenda-manipulate-query (char)
  7293. (cond
  7294. ((eq org-agenda-type 'agenda)
  7295. (let ((org-agenda-include-inactive-timestamps t))
  7296. (org-agenda-redo))
  7297. (message "Display now includes inactive timestamps as well"))
  7298. ((eq org-agenda-type 'search)
  7299. (org-add-to-string
  7300. 'org-agenda-query-string
  7301. (if org-agenda-last-search-view-search-was-boolean
  7302. (cdr (assoc char '((?\[ . " +") (?\] . " -")
  7303. (?\{ . " +{}") (?\} . " -{}"))))
  7304. " "))
  7305. (setq org-agenda-redo-command
  7306. (list 'org-search-view
  7307. (car (get-text-property (min (1- (point-max)) (point))
  7308. 'org-last-args))
  7309. org-agenda-query-string
  7310. (+ (length org-agenda-query-string)
  7311. (if (member char '(?\{ ?\})) 0 1))))
  7312. (set-register org-agenda-query-register org-agenda-query-string)
  7313. (let ((org-agenda-overriding-arguments
  7314. (cdr org-agenda-redo-command)))
  7315. (org-agenda-redo)))
  7316. (t (error "Cannot manipulate query for %s-type agenda buffers"
  7317. org-agenda-type))))
  7318. (defun org-add-to-string (var string)
  7319. (set var (concat (symbol-value var) string)))
  7320. (defun org-agenda-goto-date (span)
  7321. "Jump to DATE in agenda."
  7322. (interactive "P")
  7323. (let* ((org-read-date-prefer-future
  7324. (eval org-agenda-jump-prefer-future))
  7325. (date (org-read-date))
  7326. (day (time-to-days (org-time-string-to-time date)))
  7327. (org-agenda-sticky-orig org-agenda-sticky)
  7328. (org-agenda-buffer-tmp-name (buffer-name))
  7329. (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7330. (0-arg (or current-prefix-arg (car args)))
  7331. (2-arg (nth 2 args))
  7332. (with-hour-p (nth 4 org-agenda-redo-command))
  7333. (newcmd (list 'org-agenda-list 0-arg date
  7334. (org-agenda-span-to-ndays
  7335. 2-arg (org-time-string-to-absolute date))
  7336. with-hour-p))
  7337. (newargs (cdr newcmd))
  7338. (inhibit-read-only t)
  7339. org-agenda-sticky)
  7340. (if (not (org-agenda-check-type t 'agenda))
  7341. (error "Not available in non-agenda views")
  7342. (add-text-properties (point-min) (point-max)
  7343. `(org-redo-cmd ,newcmd org-last-args ,newargs))
  7344. (org-agenda-redo)
  7345. (goto-char (point-min))
  7346. (while (not (or (= (or (get-text-property (point) 'day) 0) day)
  7347. (save-excursion (move-beginning-of-line 2) (eobp))))
  7348. (move-beginning-of-line 2))
  7349. (setq org-agenda-sticky org-agenda-sticky-orig
  7350. org-agenda-this-buffer-is-sticky org-agenda-sticky))))
  7351. (defun org-agenda-goto-today ()
  7352. "Go to today."
  7353. (interactive)
  7354. (org-agenda-check-type t 'agenda)
  7355. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7356. (curspan (nth 2 args))
  7357. (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
  7358. (cond
  7359. (tdpos (goto-char tdpos))
  7360. ((eq org-agenda-type 'agenda)
  7361. (let* ((sd (org-agenda-compute-starting-span
  7362. (org-today) (or curspan org-agenda-span)))
  7363. (org-agenda-overriding-arguments args))
  7364. (setf (nth 1 org-agenda-overriding-arguments) sd)
  7365. (org-agenda-redo)
  7366. (org-agenda-find-same-or-today-or-agenda)))
  7367. (t (error "Cannot find today")))))
  7368. (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
  7369. (goto-char
  7370. (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
  7371. (text-property-any (point-min) (point-max) 'org-today t)
  7372. (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
  7373. (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
  7374. (org-agenda-backward-block))
  7375. (point-min))))
  7376. (defun org-agenda-backward-block ()
  7377. "Move backward by one agenda block."
  7378. (interactive)
  7379. (org-agenda-forward-block 'backward))
  7380. (defun org-agenda-forward-block (&optional backward)
  7381. "Move forward by one agenda block.
  7382. When optional argument BACKWARD is set, go backward"
  7383. (interactive)
  7384. (cond ((not (derived-mode-p 'org-agenda-mode))
  7385. (user-error
  7386. "Cannot execute this command outside of org-agenda-mode buffers"))
  7387. ((looking-at (if backward "\\`" "\\'"))
  7388. (message "Already at the %s block" (if backward "first" "last")))
  7389. (t (let ((pos (prog1 (point)
  7390. (ignore-errors (if backward (backward-char 1)
  7391. (move-end-of-line 1)))))
  7392. (f (if backward
  7393. 'previous-single-property-change
  7394. 'next-single-property-change))
  7395. moved dest)
  7396. (while (and (setq dest (funcall
  7397. f (point) 'org-agenda-structural-header))
  7398. (not (get-text-property
  7399. (point) 'org-agenda-structural-header)))
  7400. (setq moved t)
  7401. (goto-char dest))
  7402. (if moved (move-beginning-of-line 1)
  7403. (goto-char (if backward (point-min) (point-max)))
  7404. (move-beginning-of-line 1)
  7405. (message "No %s block" (if backward "previous" "further")))))))
  7406. (defun org-agenda-later (arg)
  7407. "Go forward in time by the current span.
  7408. With prefix ARG, go forward that many times the current span."
  7409. (interactive "p")
  7410. (org-agenda-check-type t 'agenda)
  7411. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7412. (span (or (nth 2 args) org-agenda-current-span))
  7413. (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
  7414. (greg (calendar-gregorian-from-absolute sd))
  7415. (cnt (org-get-at-bol 'org-day-cnt))
  7416. greg2)
  7417. (cond
  7418. ((numberp span)
  7419. (setq sd (+ (* span arg) sd)))
  7420. ((eq span 'day)
  7421. (setq sd (+ arg sd)))
  7422. ((eq span 'week)
  7423. (setq sd (+ (* 7 arg) sd)))
  7424. ((eq span 'fortnight)
  7425. (setq sd (+ (* 14 arg) sd)))
  7426. ((eq span 'month)
  7427. (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
  7428. sd (calendar-absolute-from-gregorian greg2))
  7429. (setcar greg2 (1+ (car greg2))))
  7430. ((eq span 'year)
  7431. (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
  7432. sd (calendar-absolute-from-gregorian greg2))
  7433. (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
  7434. (t
  7435. (setq sd (+ (* span arg) sd))))
  7436. (let ((org-agenda-overriding-cmd
  7437. ;; `cmd' may have been set by `org-agenda-run-series' which
  7438. ;; uses `org-agenda-overriding-cmd' to decide whether
  7439. ;; overriding is allowed for `cmd'
  7440. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7441. (org-agenda-overriding-arguments
  7442. (list (car args) sd span)))
  7443. (org-agenda-redo)
  7444. (org-agenda-find-same-or-today-or-agenda cnt))))
  7445. (defun org-agenda-earlier (arg)
  7446. "Go backward in time by the current span.
  7447. With prefix ARG, go backward that many times the current span."
  7448. (interactive "p")
  7449. (org-agenda-later (- arg)))
  7450. (defun org-agenda-view-mode-dispatch ()
  7451. "Call one of the view mode commands."
  7452. (interactive)
  7453. (org-unlogged-message
  7454. "View: [d]ay [w]eek for[t]night [m]onth [y]ear [SPC]reset [q]uit/abort
  7455. time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
  7456. [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
  7457. (pcase (read-char-exclusive)
  7458. (?\ (call-interactively 'org-agenda-reset-view))
  7459. (?d (call-interactively 'org-agenda-day-view))
  7460. (?w (call-interactively 'org-agenda-week-view))
  7461. (?t (call-interactively 'org-agenda-fortnight-view))
  7462. (?m (call-interactively 'org-agenda-month-view))
  7463. (?y (call-interactively 'org-agenda-year-view))
  7464. (?l (call-interactively 'org-agenda-log-mode))
  7465. (?L (org-agenda-log-mode '(4)))
  7466. (?c (org-agenda-log-mode 'clockcheck))
  7467. ((or ?F ?f) (call-interactively 'org-agenda-follow-mode))
  7468. (?a (call-interactively 'org-agenda-archives-mode))
  7469. (?A (org-agenda-archives-mode 'files))
  7470. ((or ?R ?r) (call-interactively 'org-agenda-clockreport-mode))
  7471. ((or ?E ?e) (call-interactively 'org-agenda-entry-text-mode))
  7472. (?G (call-interactively 'org-agenda-toggle-time-grid))
  7473. (?D (call-interactively 'org-agenda-toggle-diary))
  7474. (?\! (call-interactively 'org-agenda-toggle-deadlines))
  7475. (?\[ (let ((org-agenda-include-inactive-timestamps t))
  7476. (org-agenda-check-type t 'agenda)
  7477. (org-agenda-redo))
  7478. (message "Display now includes inactive timestamps as well"))
  7479. (?q (message "Abort"))
  7480. (key (user-error "Invalid key: %s" key))))
  7481. (defun org-agenda-reset-view ()
  7482. "Switch to default view for agenda."
  7483. (interactive)
  7484. (org-agenda-change-time-span org-agenda-span))
  7485. (defun org-agenda-day-view (&optional day-of-month)
  7486. "Switch to daily view for agenda.
  7487. With argument DAY-OF-MONTH, switch to that day of the month."
  7488. (interactive "P")
  7489. (org-agenda-change-time-span 'day day-of-month))
  7490. (defun org-agenda-week-view (&optional iso-week)
  7491. "Switch to weekly view for agenda.
  7492. With argument ISO-WEEK, switch to the corresponding ISO week.
  7493. If ISO-WEEK has more then 2 digits, only the last two encode
  7494. the week. Any digits before this encode a year. So 200712
  7495. means week 12 of year 2007. Years ranging from 70 years ago
  7496. to 30 years in the future can also be written as 2-digit years."
  7497. (interactive "P")
  7498. (org-agenda-change-time-span 'week iso-week))
  7499. (defun org-agenda-fortnight-view (&optional iso-week)
  7500. "Switch to fortnightly view for agenda.
  7501. With argument ISO-WEEK, switch to the corresponding ISO week.
  7502. If ISO-WEEK has more then 2 digits, only the last two encode
  7503. the week. Any digits before this encode a year. So 200712
  7504. means week 12 of year 2007. Years ranging from 70 years ago
  7505. to 30 years in the future can also be written as 2-digit years."
  7506. (interactive "P")
  7507. (org-agenda-change-time-span 'fortnight iso-week))
  7508. (defun org-agenda-month-view (&optional month)
  7509. "Switch to monthly view for agenda.
  7510. With argument MONTH, switch to that month. If MONTH has more
  7511. then 2 digits, only the last two encode the month. Any digits
  7512. before this encode a year. So 200712 means December year 2007.
  7513. Years ranging from 70 years ago to 30 years in the future can
  7514. also be written as 2-digit years."
  7515. (interactive "P")
  7516. (org-agenda-change-time-span 'month month))
  7517. (defun org-agenda-year-view (&optional year)
  7518. "Switch to yearly view for agenda.
  7519. With argument YEAR, switch to that year. Years ranging from 70
  7520. years ago to 30 years in the future can also be written as
  7521. 2-digit years."
  7522. (interactive "P")
  7523. (when year
  7524. (setq year (org-small-year-to-year year)))
  7525. (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
  7526. (org-agenda-change-time-span 'year year)
  7527. (error "Abort")))
  7528. (defun org-agenda-change-time-span (span &optional n)
  7529. "Change the agenda view to SPAN.
  7530. SPAN may be `day', `week', `fortnight', `month', `year'."
  7531. (org-agenda-check-type t 'agenda)
  7532. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7533. (curspan (nth 2 args)))
  7534. (when (and (not n) (equal curspan span))
  7535. (error "Viewing span is already \"%s\"" span))
  7536. (let* ((sd (or (org-get-at-bol 'day)
  7537. (nth 1 args)
  7538. org-starting-day))
  7539. (sd (org-agenda-compute-starting-span sd span n))
  7540. (org-agenda-overriding-cmd
  7541. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7542. (org-agenda-overriding-arguments
  7543. (list (car args) sd span)))
  7544. (org-agenda-redo)
  7545. (org-agenda-find-same-or-today-or-agenda))
  7546. (org-agenda-set-mode-name)
  7547. (message "Switched to %s view" span)))
  7548. (defun org-agenda-compute-starting-span (sd span &optional n)
  7549. "Compute starting date for agenda.
  7550. SPAN may be `day', `week', `fortnight', `month', `year'. The return value
  7551. is a cons cell with the starting date and the number of days,
  7552. so that the date SD will be in that range."
  7553. (let* ((greg (calendar-gregorian-from-absolute sd))
  7554. (dg (nth 1 greg))
  7555. (mg (car greg))
  7556. (yg (nth 2 greg)))
  7557. (cond
  7558. ((eq span 'day)
  7559. (when n
  7560. (setq sd (+ (calendar-absolute-from-gregorian
  7561. (list mg 1 yg))
  7562. n -1))))
  7563. ((or (eq span 'week) (eq span 'fortnight))
  7564. (let* ((nt (calendar-day-of-week
  7565. (calendar-gregorian-from-absolute sd)))
  7566. (d (if org-agenda-start-on-weekday
  7567. (- nt org-agenda-start-on-weekday)
  7568. 0))
  7569. y1)
  7570. (setq sd (- sd (+ (if (< d 0) 7 0) d)))
  7571. (when n
  7572. (require 'cal-iso)
  7573. (when (> n 99)
  7574. (setq y1 (org-small-year-to-year (/ n 100))
  7575. n (mod n 100)))
  7576. (setq sd
  7577. (calendar-iso-to-absolute
  7578. (list n 1
  7579. (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
  7580. ((eq span 'month)
  7581. (let (y1)
  7582. (when (and n (> n 99))
  7583. (setq y1 (org-small-year-to-year (/ n 100))
  7584. n (mod n 100)))
  7585. (setq sd (calendar-absolute-from-gregorian
  7586. (list (or n mg) 1 (or y1 yg))))))
  7587. ((eq span 'year)
  7588. (setq sd (calendar-absolute-from-gregorian
  7589. (list 1 1 (or n yg))))))
  7590. sd))
  7591. (defun org-agenda-next-date-line (&optional arg)
  7592. "Jump to the next line indicating a date in agenda buffer."
  7593. (interactive "p")
  7594. (org-agenda-check-type t 'agenda)
  7595. (beginning-of-line 1)
  7596. ;; This does not work if user makes date format that starts with a blank
  7597. (when (looking-at-p "^\\S-") (forward-char 1))
  7598. (unless (re-search-forward "^\\S-" nil t arg)
  7599. (backward-char 1)
  7600. (error "No next date after this line in this buffer"))
  7601. (goto-char (match-beginning 0)))
  7602. (defun org-agenda-previous-date-line (&optional arg)
  7603. "Jump to the previous line indicating a date in agenda buffer."
  7604. (interactive "p")
  7605. (org-agenda-check-type t 'agenda)
  7606. (beginning-of-line 1)
  7607. (unless (re-search-backward "^\\S-" nil t arg)
  7608. (error "No previous date before this line in this buffer")))
  7609. ;; Initialize the highlight
  7610. (defvar org-hl (make-overlay 1 1))
  7611. (overlay-put org-hl 'face 'highlight)
  7612. (defun org-highlight (begin end &optional buffer)
  7613. "Highlight a region with overlay."
  7614. (move-overlay org-hl begin end (or buffer (current-buffer))))
  7615. (defun org-unhighlight ()
  7616. "Detach overlay INDEX."
  7617. (delete-overlay org-hl))
  7618. (defun org-unhighlight-once ()
  7619. "Remove the highlight from its position, and this function from the hook."
  7620. (remove-hook 'pre-command-hook 'org-unhighlight-once)
  7621. (org-unhighlight))
  7622. (defvar org-agenda-pre-follow-window-conf nil)
  7623. (defun org-agenda-follow-mode ()
  7624. "Toggle follow mode in an agenda buffer."
  7625. (interactive)
  7626. (unless org-agenda-follow-mode
  7627. (setq org-agenda-pre-follow-window-conf
  7628. (current-window-configuration)))
  7629. (setq org-agenda-follow-mode (not org-agenda-follow-mode))
  7630. (unless org-agenda-follow-mode
  7631. (set-window-configuration org-agenda-pre-follow-window-conf))
  7632. (org-agenda-set-mode-name)
  7633. (org-agenda-do-context-action)
  7634. (message "Follow mode is %s"
  7635. (if org-agenda-follow-mode "on" "off")))
  7636. (defun org-agenda-entry-text-mode (&optional arg)
  7637. "Toggle entry text mode in an agenda buffer."
  7638. (interactive "P")
  7639. (if (or org-agenda-tag-filter
  7640. org-agenda-category-filter
  7641. org-agenda-regexp-filter
  7642. org-agenda-top-headline-filter)
  7643. (user-error "Can't show entry text in filtered views")
  7644. (setq org-agenda-entry-text-mode (or (integerp arg)
  7645. (not org-agenda-entry-text-mode)))
  7646. (org-agenda-entry-text-hide)
  7647. (and org-agenda-entry-text-mode
  7648. (let ((org-agenda-entry-text-maxlines
  7649. (if (integerp arg) arg org-agenda-entry-text-maxlines)))
  7650. (org-agenda-entry-text-show)))
  7651. (org-agenda-set-mode-name)
  7652. (message "Entry text mode is %s%s"
  7653. (if org-agenda-entry-text-mode "on" "off")
  7654. (if (not org-agenda-entry-text-mode) ""
  7655. (format " (maximum number of lines is %d)"
  7656. (if (integerp arg) arg org-agenda-entry-text-maxlines))))))
  7657. (defun org-agenda-clockreport-mode ()
  7658. "Toggle clocktable mode in an agenda buffer."
  7659. (interactive)
  7660. (org-agenda-check-type t 'agenda)
  7661. (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode))
  7662. (org-agenda-set-mode-name)
  7663. (org-agenda-redo)
  7664. (message "Clocktable mode is %s"
  7665. (if org-agenda-clockreport-mode "on" "off")))
  7666. (defun org-agenda-log-mode (&optional special)
  7667. "Toggle log mode in an agenda buffer.
  7668. With argument SPECIAL, show all possible log items, not only the ones
  7669. configured in `org-agenda-log-mode-items'.
  7670. With a `\\[universal-argument] \\[universal-argument]' prefix, show *only* \
  7671. log items, nothing else."
  7672. (interactive "P")
  7673. (org-agenda-check-type t 'agenda)
  7674. (setq org-agenda-show-log
  7675. (cond
  7676. ((equal special '(16)) 'only)
  7677. ((eq special 'clockcheck)
  7678. (if (eq org-agenda-show-log 'clockcheck)
  7679. nil 'clockcheck))
  7680. (special '(closed clock state))
  7681. (t (not org-agenda-show-log))))
  7682. (org-agenda-set-mode-name)
  7683. (org-agenda-redo)
  7684. (message "Log mode is %s" (if org-agenda-show-log "on" "off")))
  7685. (defun org-agenda-archives-mode (&optional with-files)
  7686. "Toggle inclusion of items in trees marked with :ARCHIVE:.
  7687. When called with a prefix argument, include all archive files as well."
  7688. (interactive "P")
  7689. (setq org-agenda-archives-mode
  7690. (if with-files t (if org-agenda-archives-mode nil 'trees)))
  7691. (org-agenda-set-mode-name)
  7692. (org-agenda-redo)
  7693. (message
  7694. "%s"
  7695. (cond
  7696. ((eq org-agenda-archives-mode nil)
  7697. "No archives are included")
  7698. ((eq org-agenda-archives-mode 'trees)
  7699. (format "Trees with :%s: tag are included" org-archive-tag))
  7700. ((eq org-agenda-archives-mode t)
  7701. (format "Trees with :%s: tag and all active archive files are included"
  7702. org-archive-tag)))))
  7703. (defun org-agenda-toggle-diary ()
  7704. "Toggle diary inclusion in an agenda buffer."
  7705. (interactive)
  7706. (org-agenda-check-type t 'agenda)
  7707. (setq org-agenda-include-diary (not org-agenda-include-diary))
  7708. (org-agenda-redo)
  7709. (org-agenda-set-mode-name)
  7710. (message "Diary inclusion turned %s"
  7711. (if org-agenda-include-diary "on" "off")))
  7712. (defun org-agenda-toggle-deadlines ()
  7713. "Toggle inclusion of entries with a deadline in an agenda buffer."
  7714. (interactive)
  7715. (org-agenda-check-type t 'agenda)
  7716. (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
  7717. (org-agenda-redo)
  7718. (org-agenda-set-mode-name)
  7719. (message "Deadlines inclusion turned %s"
  7720. (if org-agenda-include-deadlines "on" "off")))
  7721. (defun org-agenda-toggle-time-grid ()
  7722. "Toggle time grid in an agenda buffer."
  7723. (interactive)
  7724. (org-agenda-check-type t 'agenda)
  7725. (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
  7726. (org-agenda-redo)
  7727. (org-agenda-set-mode-name)
  7728. (message "Time-grid turned %s"
  7729. (if org-agenda-use-time-grid "on" "off")))
  7730. (defun org-agenda-set-mode-name ()
  7731. "Set the mode name to indicate all the small mode settings."
  7732. (setq mode-name
  7733. (list "Org-Agenda"
  7734. (if (get 'org-agenda-files 'org-restrict) " []" "")
  7735. " "
  7736. '(:eval (org-agenda-span-name org-agenda-current-span))
  7737. (if org-agenda-follow-mode " Follow" "")
  7738. (if org-agenda-entry-text-mode " ETxt" "")
  7739. (if org-agenda-include-diary " Diary" "")
  7740. (if org-agenda-include-deadlines " Ddl" "")
  7741. (if org-agenda-use-time-grid " Grid" "")
  7742. (if (and (boundp 'org-habit-show-habits)
  7743. org-habit-show-habits) " Habit" "")
  7744. (cond
  7745. ((consp org-agenda-show-log) " LogAll")
  7746. ((eq org-agenda-show-log 'clockcheck) " ClkCk")
  7747. (org-agenda-show-log " Log")
  7748. (t ""))
  7749. (if (or org-agenda-category-filter
  7750. (get 'org-agenda-category-filter :preset-filter))
  7751. '(:eval (propertize
  7752. (concat " <"
  7753. (mapconcat
  7754. 'identity
  7755. (append
  7756. (get 'org-agenda-category-filter :preset-filter)
  7757. org-agenda-category-filter)
  7758. "")
  7759. ">")
  7760. 'face 'org-agenda-filter-category
  7761. 'help-echo "Category used in filtering")) "")
  7762. (if (or org-agenda-tag-filter
  7763. (get 'org-agenda-tag-filter :preset-filter))
  7764. '(:eval (propertize
  7765. (concat " {"
  7766. (mapconcat
  7767. 'identity
  7768. (append
  7769. (get 'org-agenda-tag-filter :preset-filter)
  7770. org-agenda-tag-filter)
  7771. "")
  7772. "}")
  7773. 'face 'org-agenda-filter-tags
  7774. 'help-echo "Tags used in filtering")) "")
  7775. (if (or org-agenda-effort-filter
  7776. (get 'org-agenda-effort-filter :preset-filter))
  7777. '(:eval (propertize
  7778. (concat " {"
  7779. (mapconcat
  7780. 'identity
  7781. (append
  7782. (get 'org-agenda-effort-filter :preset-filter)
  7783. org-agenda-effort-filter)
  7784. "")
  7785. "}")
  7786. 'face 'org-agenda-filter-effort
  7787. 'help-echo "Effort conditions used in filtering")) "")
  7788. (if (or org-agenda-regexp-filter
  7789. (get 'org-agenda-regexp-filter :preset-filter))
  7790. '(:eval (propertize
  7791. (concat " ["
  7792. (mapconcat
  7793. 'identity
  7794. (append
  7795. (get 'org-agenda-regexp-filter :preset-filter)
  7796. org-agenda-regexp-filter)
  7797. "")
  7798. "]")
  7799. 'face 'org-agenda-filter-regexp
  7800. 'help-echo "Regexp used in filtering")) "")
  7801. (if org-agenda-archives-mode
  7802. (if (eq org-agenda-archives-mode t)
  7803. " Archives"
  7804. (format " :%s:" org-archive-tag))
  7805. "")
  7806. (if org-agenda-clockreport-mode " Clock" "")))
  7807. (force-mode-line-update))
  7808. (defun org-agenda-update-agenda-type ()
  7809. "Update the agenda type after each command."
  7810. (setq org-agenda-type
  7811. (or (get-text-property (point) 'org-agenda-type)
  7812. (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
  7813. (defun org-agenda-next-line ()
  7814. "Move cursor to the next line, and show if follow mode is active."
  7815. (interactive)
  7816. (call-interactively 'next-line)
  7817. (org-agenda-do-context-action))
  7818. (defun org-agenda-previous-line ()
  7819. "Move cursor to the previous line, and show if follow-mode is active."
  7820. (interactive)
  7821. (call-interactively 'previous-line)
  7822. (org-agenda-do-context-action))
  7823. (defun org-agenda-next-item (n)
  7824. "Move cursor to next agenda item."
  7825. (interactive "p")
  7826. (let ((col (current-column)))
  7827. (dotimes (c n)
  7828. (when (next-single-property-change (point-at-eol) 'org-marker)
  7829. (move-end-of-line 1)
  7830. (goto-char (next-single-property-change (point) 'org-marker))))
  7831. (org-move-to-column col))
  7832. (org-agenda-do-context-action))
  7833. (defun org-agenda-previous-item (n)
  7834. "Move cursor to next agenda item."
  7835. (interactive "p")
  7836. (dotimes (c n)
  7837. (let ((col (current-column))
  7838. (goto (save-excursion
  7839. (move-end-of-line 0)
  7840. (previous-single-property-change (point) 'org-marker))))
  7841. (when goto (goto-char goto))
  7842. (org-move-to-column col)))
  7843. (org-agenda-do-context-action))
  7844. (defun org-agenda-do-context-action ()
  7845. "Show outline path and, maybe, follow mode window."
  7846. (let ((m (org-get-at-bol 'org-marker)))
  7847. (when (and (markerp m) (marker-buffer m))
  7848. (and org-agenda-follow-mode
  7849. (if org-agenda-follow-indirect
  7850. (org-agenda-tree-to-indirect-buffer nil)
  7851. (org-agenda-show)))
  7852. (and org-agenda-show-outline-path
  7853. (org-with-point-at m (org-display-outline-path t))))))
  7854. (defun org-agenda-show-tags ()
  7855. "Show the tags applicable to the current item."
  7856. (interactive)
  7857. (let* ((tags (org-get-at-bol 'tags)))
  7858. (if tags
  7859. (message "Tags are :%s:"
  7860. (org-no-properties (mapconcat 'identity tags ":")))
  7861. (message "No tags associated with this line"))))
  7862. (defun org-agenda-goto (&optional highlight)
  7863. "Go to the entry at point in the corresponding Org file."
  7864. (interactive)
  7865. (let* ((marker (or (org-get-at-bol 'org-marker)
  7866. (org-agenda-error)))
  7867. (buffer (marker-buffer marker))
  7868. (pos (marker-position marker)))
  7869. (switch-to-buffer-other-window buffer)
  7870. (widen)
  7871. (push-mark)
  7872. (goto-char pos)
  7873. (when (derived-mode-p 'org-mode)
  7874. (org-show-context 'agenda)
  7875. (recenter (/ (window-height) 2))
  7876. (org-back-to-heading t)
  7877. (let ((case-fold-search nil))
  7878. (when (re-search-forward org-complex-heading-regexp nil t)
  7879. (goto-char (match-beginning 4)))))
  7880. (run-hooks 'org-agenda-after-show-hook)
  7881. (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
  7882. (defvar org-agenda-after-show-hook nil
  7883. "Normal hook run after an item has been shown from the agenda.
  7884. Point is in the buffer where the item originated.")
  7885. (defun org-agenda-kill ()
  7886. "Kill the entry or subtree belonging to the current agenda entry."
  7887. (interactive)
  7888. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  7889. (let* ((bufname-orig (buffer-name))
  7890. (marker (or (org-get-at-bol 'org-marker)
  7891. (org-agenda-error)))
  7892. (buffer (marker-buffer marker))
  7893. (pos (marker-position marker))
  7894. (type (org-get-at-bol 'type))
  7895. dbeg dend (n 0) conf)
  7896. (org-with-remote-undo buffer
  7897. (with-current-buffer buffer
  7898. (save-excursion
  7899. (goto-char pos)
  7900. (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
  7901. (setq dbeg (progn (org-back-to-heading t) (point))
  7902. dend (org-end-of-subtree t t))
  7903. (setq dbeg (point-at-bol)
  7904. dend (min (point-max) (1+ (point-at-eol)))))
  7905. (goto-char dbeg)
  7906. (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
  7907. (setq conf (or (eq t org-agenda-confirm-kill)
  7908. (and (numberp org-agenda-confirm-kill)
  7909. (> n org-agenda-confirm-kill))))
  7910. (and conf
  7911. (not (y-or-n-p
  7912. (format "Delete entry with %d lines in buffer \"%s\"? "
  7913. n (buffer-name buffer))))
  7914. (error "Abort"))
  7915. (let ((org-agenda-buffer-name bufname-orig))
  7916. (org-remove-subtree-entries-from-agenda buffer dbeg dend))
  7917. (with-current-buffer buffer (delete-region dbeg dend))
  7918. (message "Agenda item and source killed"))))
  7919. (defvar org-archive-default-command) ; defined in org-archive.el
  7920. (defun org-agenda-archive-default ()
  7921. "Archive the entry or subtree belonging to the current agenda entry."
  7922. (interactive)
  7923. (require 'org-archive)
  7924. (org-agenda-archive-with org-archive-default-command))
  7925. (defun org-agenda-archive-default-with-confirmation ()
  7926. "Archive the entry or subtree belonging to the current agenda entry."
  7927. (interactive)
  7928. (require 'org-archive)
  7929. (org-agenda-archive-with org-archive-default-command 'confirm))
  7930. (defun org-agenda-archive ()
  7931. "Archive the entry or subtree belonging to the current agenda entry."
  7932. (interactive)
  7933. (org-agenda-archive-with 'org-archive-subtree))
  7934. (defun org-agenda-archive-to-archive-sibling ()
  7935. "Move the entry to the archive sibling."
  7936. (interactive)
  7937. (org-agenda-archive-with 'org-archive-to-archive-sibling))
  7938. (defun org-agenda-archive-with (cmd &optional confirm)
  7939. "Move the entry to the archive sibling."
  7940. (interactive)
  7941. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  7942. (let* ((bufname-orig (buffer-name))
  7943. (marker (or (org-get-at-bol 'org-marker)
  7944. (org-agenda-error)))
  7945. (buffer (marker-buffer marker))
  7946. (pos (marker-position marker)))
  7947. (org-with-remote-undo buffer
  7948. (with-current-buffer buffer
  7949. (if (derived-mode-p 'org-mode)
  7950. (if (and confirm
  7951. (not (y-or-n-p "Archive this subtree or entry? ")))
  7952. (error "Abort")
  7953. (save-window-excursion
  7954. (goto-char pos)
  7955. (let ((org-agenda-buffer-name bufname-orig))
  7956. (org-remove-subtree-entries-from-agenda))
  7957. (org-back-to-heading t)
  7958. (funcall cmd)))
  7959. (error "Archiving works only in Org files"))))))
  7960. (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
  7961. "Remove all lines in the agenda that correspond to a given subtree.
  7962. The subtree is the one in buffer BUF, starting at BEG and ending at END.
  7963. If this information is not given, the function uses the tree at point."
  7964. (let ((buf (or buf (current-buffer))) m p)
  7965. (save-excursion
  7966. (unless (and beg end)
  7967. (org-back-to-heading t)
  7968. (setq beg (point))
  7969. (org-end-of-subtree t)
  7970. (setq end (point)))
  7971. (set-buffer (get-buffer org-agenda-buffer-name))
  7972. (save-excursion
  7973. (goto-char (point-max))
  7974. (beginning-of-line 1)
  7975. (while (not (bobp))
  7976. (when (and (setq m (org-get-at-bol 'org-marker))
  7977. (equal buf (marker-buffer m))
  7978. (setq p (marker-position m))
  7979. (>= p beg)
  7980. (< p end))
  7981. (let ((inhibit-read-only t))
  7982. (delete-region (point-at-bol) (1+ (point-at-eol)))))
  7983. (beginning-of-line 0))))))
  7984. (defun org-agenda-refile (&optional goto rfloc no-update)
  7985. "Refile the item at point.
  7986. When called with `\\[universal-argument] \\[universal-argument]', \
  7987. go to the location of the last
  7988. refiled item.
  7989. When called with `\\[universal-argument] \\[universal-argument] \
  7990. \\[universal-argument]' prefix or when GOTO is 0, clear
  7991. the refile cache.
  7992. RFLOC can be a refile location obtained in a different way.
  7993. When NO-UPDATE is non-nil, don't redo the agenda buffer."
  7994. (interactive "P")
  7995. (cond
  7996. ((member goto '(0 (64)))
  7997. (org-refile-cache-clear))
  7998. ((equal goto '(16))
  7999. (org-refile-goto-last-stored))
  8000. (t
  8001. (let* ((buffer-orig (buffer-name))
  8002. (marker (or (org-get-at-bol 'org-hd-marker)
  8003. (org-agenda-error)))
  8004. (buffer (marker-buffer marker))
  8005. (pos (marker-position marker))
  8006. (rfloc (or rfloc
  8007. (org-refile-get-location
  8008. (if goto "Goto" "Refile to") buffer
  8009. org-refile-allow-creating-parent-nodes))))
  8010. (with-current-buffer buffer
  8011. (org-with-wide-buffer
  8012. (goto-char marker)
  8013. (let ((org-agenda-buffer-name buffer-orig))
  8014. (org-remove-subtree-entries-from-agenda))
  8015. (org-refile goto buffer rfloc))))
  8016. (unless no-update (org-agenda-redo)))))
  8017. (defun org-agenda-open-link (&optional arg)
  8018. "Open the link(s) in the current entry, if any.
  8019. This looks for a link in the displayed line in the agenda.
  8020. It also looks at the text of the entry itself."
  8021. (interactive "P")
  8022. (let* ((marker (or (org-get-at-bol 'org-hd-marker)
  8023. (org-get-at-bol 'org-marker)))
  8024. (buffer (and marker (marker-buffer marker)))
  8025. (prefix (buffer-substring (point-at-bol) (point-at-eol)))
  8026. (lkall (and buffer (org-offer-links-in-entry
  8027. buffer marker arg prefix)))
  8028. (lk0 (car lkall))
  8029. (lk (if (stringp lk0) (list lk0) lk0))
  8030. (lkend (cdr lkall))
  8031. trg)
  8032. (cond
  8033. ((and buffer lk)
  8034. (mapcar (lambda(l)
  8035. (with-current-buffer buffer
  8036. (setq trg (and (string-match org-bracket-link-regexp l)
  8037. (match-string 1 l)))
  8038. (if (or (not trg) (string-match org-any-link-re trg))
  8039. (org-with-wide-buffer
  8040. (goto-char marker)
  8041. (when (search-forward l nil lkend)
  8042. (goto-char (match-beginning 0))
  8043. (org-open-at-point)))
  8044. ;; This is an internal link, widen the buffer
  8045. (switch-to-buffer-other-window buffer)
  8046. (widen)
  8047. (goto-char marker)
  8048. (when (search-forward l nil lkend)
  8049. (goto-char (match-beginning 0))
  8050. (org-open-at-point)))))
  8051. lk))
  8052. ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
  8053. (save-excursion
  8054. (beginning-of-line 1)
  8055. (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
  8056. (org-open-link-from-string (match-string 1)))
  8057. (t (message "No link to open here")))))
  8058. (defun org-agenda-copy-local-variable (var)
  8059. "Get a variable from a referenced buffer and install it here."
  8060. (let ((m (org-get-at-bol 'org-marker)))
  8061. (when (and m (buffer-live-p (marker-buffer m)))
  8062. (set (make-local-variable var)
  8063. (with-current-buffer (marker-buffer m)
  8064. (symbol-value var))))))
  8065. (defun org-agenda-switch-to (&optional delete-other-windows)
  8066. "Go to the Org mode file which contains the item at point.
  8067. When optional argument DELETE-OTHER-WINDOWS is non-nil, the
  8068. displayed Org file fills the frame."
  8069. (interactive)
  8070. (if (and org-return-follows-link
  8071. (not (org-get-at-bol 'org-marker))
  8072. (org-in-regexp org-bracket-link-regexp))
  8073. (org-open-link-from-string (match-string 0))
  8074. (let* ((marker (or (org-get-at-bol 'org-marker)
  8075. (org-agenda-error)))
  8076. (buffer (marker-buffer marker))
  8077. (pos (marker-position marker)))
  8078. (unless buffer (user-error "Trying to switch to non-existent buffer"))
  8079. (pop-to-buffer-same-window buffer)
  8080. (when delete-other-windows (delete-other-windows))
  8081. (widen)
  8082. (goto-char pos)
  8083. (when (derived-mode-p 'org-mode)
  8084. (org-show-context 'agenda)
  8085. (run-hooks 'org-agenda-after-show-hook)))))
  8086. (defun org-agenda-goto-mouse (ev)
  8087. "Go to the Org file which contains the item at the mouse click."
  8088. (interactive "e")
  8089. (mouse-set-point ev)
  8090. (org-agenda-goto))
  8091. (defun org-agenda-show (&optional full-entry)
  8092. "Display the Org file which contains the item at point.
  8093. With prefix argument FULL-ENTRY, make the entire entry visible
  8094. if it was hidden in the outline."
  8095. (interactive "P")
  8096. (let ((win (selected-window)))
  8097. (org-agenda-goto t)
  8098. (when full-entry (org-show-entry))
  8099. (select-window win)))
  8100. (defvar org-agenda-show-window nil)
  8101. (defun org-agenda-show-and-scroll-up (&optional arg)
  8102. "Display the Org file which contains the item at point.
  8103. When called repeatedly, scroll the window that is displaying the buffer.
  8104. With a `\\[universal-argument]' prefix argument, display the item, but \
  8105. fold drawers."
  8106. (interactive "P")
  8107. (let ((win (selected-window)))
  8108. (if (and (window-live-p org-agenda-show-window)
  8109. (eq this-command last-command))
  8110. (progn
  8111. (select-window org-agenda-show-window)
  8112. (ignore-errors (scroll-up)))
  8113. (org-agenda-goto t)
  8114. (org-show-entry)
  8115. (if arg (org-cycle-hide-drawers 'children)
  8116. (org-with-wide-buffer
  8117. (narrow-to-region (org-entry-beginning-position)
  8118. (org-entry-end-position))
  8119. (org-show-all '(drawers))))
  8120. (when arg )
  8121. (setq org-agenda-show-window (selected-window)))
  8122. (select-window win)))
  8123. (defun org-agenda-show-scroll-down ()
  8124. "Scroll down the window showing the agenda."
  8125. (interactive)
  8126. (let ((win (selected-window)))
  8127. (when (window-live-p org-agenda-show-window)
  8128. (select-window org-agenda-show-window)
  8129. (ignore-errors (scroll-down))
  8130. (select-window win))))
  8131. (defun org-agenda-show-1 (&optional more)
  8132. "Display the Org file which contains the item at point.
  8133. The prefix arg selects the amount of information to display:
  8134. 0 hide the subtree
  8135. 1 just show the entry according to defaults.
  8136. 2 show the children view
  8137. 3 show the subtree view
  8138. 4 show the entire subtree and any LOGBOOK drawers
  8139. 5 show the entire subtree and any drawers
  8140. With prefix argument FULL-ENTRY, make the entire entry visible
  8141. if it was hidden in the outline."
  8142. (interactive "p")
  8143. (let ((win (selected-window)))
  8144. (org-agenda-goto t)
  8145. (org-back-to-heading)
  8146. (set-window-start (selected-window) (point-at-bol))
  8147. (cond
  8148. ((= more 0)
  8149. (outline-hide-subtree)
  8150. (save-excursion
  8151. (org-back-to-heading)
  8152. (run-hook-with-args 'org-cycle-hook 'folded))
  8153. (message "Remote: FOLDED"))
  8154. ((and (called-interactively-p 'any) (= more 1))
  8155. (message "Remote: show with default settings"))
  8156. ((= more 2)
  8157. (outline-show-entry)
  8158. (org-show-children)
  8159. (save-excursion
  8160. (org-back-to-heading)
  8161. (run-hook-with-args 'org-cycle-hook 'children))
  8162. (message "Remote: CHILDREN"))
  8163. ((= more 3)
  8164. (outline-show-subtree)
  8165. (save-excursion
  8166. (org-back-to-heading)
  8167. (run-hook-with-args 'org-cycle-hook 'subtree))
  8168. (message "Remote: SUBTREE"))
  8169. ((= more 4)
  8170. (outline-show-subtree)
  8171. (save-excursion
  8172. (org-back-to-heading)
  8173. (org-cycle-hide-drawers 'subtree '("LOGBOOK")))
  8174. (message "Remote: SUBTREE AND LOGBOOK"))
  8175. ((> more 4)
  8176. (outline-show-subtree)
  8177. (message "Remote: SUBTREE AND ALL DRAWERS")))
  8178. (select-window win)))
  8179. (defvar org-agenda-cycle-counter nil)
  8180. (defun org-agenda-cycle-show (&optional n)
  8181. "Show the current entry in another window, with default settings.
  8182. Default settings are taken from `org-show-context-detail'. When
  8183. use repeatedly in immediate succession, the remote entry will
  8184. cycle through visibility
  8185. children -> subtree -> folded
  8186. When called with a numeric prefix arg, that arg will be passed through to
  8187. `org-agenda-show-1'. For the interpretation of that argument, see the
  8188. docstring of `org-agenda-show-1'."
  8189. (interactive "P")
  8190. (if (integerp n)
  8191. (setq org-agenda-cycle-counter n)
  8192. (if (not (eq last-command this-command))
  8193. (setq org-agenda-cycle-counter 1)
  8194. (if (equal org-agenda-cycle-counter 0)
  8195. (setq org-agenda-cycle-counter 2)
  8196. (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
  8197. (when (> org-agenda-cycle-counter 3)
  8198. (setq org-agenda-cycle-counter 0)))))
  8199. (org-agenda-show-1 org-agenda-cycle-counter))
  8200. (defun org-agenda-recenter (arg)
  8201. "Display the Org file which contains the item at point and recenter."
  8202. (interactive "P")
  8203. (let ((win (selected-window)))
  8204. (org-agenda-goto t)
  8205. (recenter arg)
  8206. (select-window win)))
  8207. (defun org-agenda-show-mouse (ev)
  8208. "Display the Org file which contains the item at the mouse click."
  8209. (interactive "e")
  8210. (mouse-set-point ev)
  8211. (org-agenda-show))
  8212. (defun org-agenda-check-no-diary ()
  8213. "Check if the entry is a diary link and abort if yes."
  8214. (when (org-get-at-bol 'org-agenda-diary-link)
  8215. (org-agenda-error)))
  8216. (defun org-agenda-error ()
  8217. "Throw an error when a command is not allowed in the agenda."
  8218. (user-error "Command not allowed in this line"))
  8219. (defun org-agenda-tree-to-indirect-buffer (arg)
  8220. "Show the subtree corresponding to the current entry in an indirect buffer.
  8221. This calls the command `org-tree-to-indirect-buffer' from the original buffer.
  8222. With a numerical prefix ARG, go up to this level and then take that tree.
  8223. With a negative numeric ARG, go up by this number of levels.
  8224. With a `\\[universal-argument]' prefix, make a separate frame for this tree, \
  8225. i.e. don't use
  8226. the dedicated frame."
  8227. (interactive "P")
  8228. (if current-prefix-arg
  8229. (org-agenda-do-tree-to-indirect-buffer arg)
  8230. (let ((agenda-buffer (buffer-name))
  8231. (agenda-window (selected-window))
  8232. (indirect-window
  8233. (and org-last-indirect-buffer
  8234. (get-buffer-window org-last-indirect-buffer))))
  8235. (save-window-excursion (org-agenda-do-tree-to-indirect-buffer arg))
  8236. (unless (or (eq org-indirect-buffer-display 'new-frame)
  8237. (eq org-indirect-buffer-display 'dedicated-frame))
  8238. (unwind-protect
  8239. (unless (and indirect-window (window-live-p indirect-window))
  8240. (setq indirect-window (split-window agenda-window)))
  8241. (and indirect-window (select-window indirect-window))
  8242. (switch-to-buffer org-last-indirect-buffer :norecord)
  8243. (fit-window-to-buffer indirect-window)))
  8244. (select-window (get-buffer-window agenda-buffer))
  8245. (setq org-agenda-last-indirect-buffer org-last-indirect-buffer))))
  8246. (defun org-agenda-do-tree-to-indirect-buffer (arg)
  8247. "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
  8248. (org-agenda-check-no-diary)
  8249. (let* ((marker (or (org-get-at-bol 'org-marker)
  8250. (org-agenda-error)))
  8251. (buffer (marker-buffer marker))
  8252. (pos (marker-position marker)))
  8253. (with-current-buffer buffer
  8254. (save-excursion
  8255. (goto-char pos)
  8256. (org-tree-to-indirect-buffer arg)))))
  8257. (defvar org-last-heading-marker (make-marker)
  8258. "Marker pointing to the headline that last changed its TODO state
  8259. by a remote command from the agenda.")
  8260. (defun org-agenda-todo-nextset ()
  8261. "Switch TODO entry to next sequence."
  8262. (interactive)
  8263. (org-agenda-todo 'nextset))
  8264. (defun org-agenda-todo-previousset ()
  8265. "Switch TODO entry to previous sequence."
  8266. (interactive)
  8267. (org-agenda-todo 'previousset))
  8268. (defun org-agenda-todo (&optional arg)
  8269. "Cycle TODO state of line at point, also in Org file.
  8270. This changes the line at point, all other lines in the agenda referring to
  8271. the same tree node, and the headline of the tree node in the Org file."
  8272. (interactive "P")
  8273. (org-agenda-check-no-diary)
  8274. (let* ((col (current-column))
  8275. (marker (or (org-get-at-bol 'org-marker)
  8276. (org-agenda-error)))
  8277. (buffer (marker-buffer marker))
  8278. (pos (marker-position marker))
  8279. (hdmarker (org-get-at-bol 'org-hd-marker))
  8280. (todayp (org-agenda-today-p (org-get-at-bol 'day)))
  8281. (inhibit-read-only t)
  8282. org-agenda-headline-snapshot-before-repeat newhead just-one)
  8283. (org-with-remote-undo buffer
  8284. (with-current-buffer buffer
  8285. (widen)
  8286. (goto-char pos)
  8287. (org-show-context 'agenda)
  8288. (let ((current-prefix-arg arg))
  8289. (call-interactively 'org-todo))
  8290. (and (bolp) (forward-char 1))
  8291. (setq newhead (org-get-heading))
  8292. (when (and (bound-and-true-p
  8293. org-agenda-headline-snapshot-before-repeat)
  8294. (not (equal org-agenda-headline-snapshot-before-repeat
  8295. newhead))
  8296. todayp)
  8297. (setq newhead org-agenda-headline-snapshot-before-repeat
  8298. just-one t))
  8299. (save-excursion
  8300. (org-back-to-heading)
  8301. (move-marker org-last-heading-marker (point))))
  8302. (beginning-of-line 1)
  8303. (save-window-excursion
  8304. (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
  8305. (when (bound-and-true-p org-clock-out-when-done)
  8306. (string-match (concat "^" (regexp-opt org-done-keywords-for-agenda))
  8307. newhead)
  8308. (org-agenda-unmark-clocking-task))
  8309. (org-move-to-column col)
  8310. (org-agenda-mark-clocking-task))))
  8311. (defun org-agenda-add-note (&optional arg)
  8312. "Add a time-stamped note to the entry at point."
  8313. (interactive "P")
  8314. (org-agenda-check-no-diary)
  8315. (let* ((marker (or (org-get-at-bol 'org-marker)
  8316. (org-agenda-error)))
  8317. (buffer (marker-buffer marker))
  8318. (pos (marker-position marker))
  8319. (hdmarker (org-get-at-bol 'org-hd-marker))
  8320. (inhibit-read-only t))
  8321. (with-current-buffer buffer
  8322. (widen)
  8323. (goto-char pos)
  8324. (org-show-context 'agenda)
  8325. (org-add-note))))
  8326. (defun org-agenda-change-all-lines (newhead hdmarker
  8327. &optional fixface just-this)
  8328. "Change all lines in the agenda buffer which match HDMARKER.
  8329. The new content of the line will be NEWHEAD (as modified by
  8330. `org-agenda-format-item'). HDMARKER is checked with
  8331. `equal' against all `org-hd-marker' text properties in the file.
  8332. If FIXFACE is non-nil, the face of each item is modified according to
  8333. the new TODO state.
  8334. If JUST-THIS is non-nil, change just the current line, not all.
  8335. If FORCE-TAGS is non nil, the car of it returns the new tags."
  8336. (let* ((inhibit-read-only t)
  8337. (line (org-current-line))
  8338. (org-agenda-buffer (current-buffer))
  8339. (thetags (with-current-buffer (marker-buffer hdmarker)
  8340. (org-get-tags hdmarker)))
  8341. props m pl undone-face done-face finish new dotime level cat tags)
  8342. (save-excursion
  8343. (goto-char (point-max))
  8344. (beginning-of-line 1)
  8345. (while (not finish)
  8346. (setq finish (bobp))
  8347. (when (and (setq m (org-get-at-bol 'org-hd-marker))
  8348. (or (not just-this) (= (org-current-line) line))
  8349. (equal m hdmarker))
  8350. (setq props (text-properties-at (point))
  8351. dotime (org-get-at-bol 'dotime)
  8352. cat (org-agenda-get-category)
  8353. level (org-get-at-bol 'level)
  8354. tags thetags
  8355. new
  8356. (let ((org-prefix-format-compiled
  8357. (or (get-text-property (min (1- (point-max)) (point)) 'format)
  8358. org-prefix-format-compiled))
  8359. (extra (org-get-at-bol 'extra)))
  8360. (with-current-buffer (marker-buffer hdmarker)
  8361. (org-with-wide-buffer
  8362. (org-agenda-format-item extra newhead level cat tags dotime))))
  8363. pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
  8364. undone-face (org-get-at-bol 'undone-face)
  8365. done-face (org-get-at-bol 'done-face))
  8366. (beginning-of-line 1)
  8367. (cond
  8368. ((equal new "") (delete-region (point) (line-beginning-position 2)))
  8369. ((looking-at ".*")
  8370. ;; When replacing the whole line, preserve bulk mark
  8371. ;; overlay, if any.
  8372. (let ((mark (catch :overlay
  8373. (dolist (o (overlays-in (point) (+ 2 (point))))
  8374. (when (eq (overlay-get o 'type)
  8375. 'org-marked-entry-overlay)
  8376. (throw :overlay o))))))
  8377. (replace-match new t t)
  8378. (beginning-of-line)
  8379. (when mark (move-overlay mark (point) (+ 2 (point)))))
  8380. (add-text-properties (point-at-bol) (point-at-eol) props)
  8381. (when fixface
  8382. (add-text-properties
  8383. (point-at-bol) (point-at-eol)
  8384. (list 'face
  8385. (if org-last-todo-state-is-todo
  8386. undone-face done-face))))
  8387. (org-agenda-highlight-todo 'line)
  8388. (beginning-of-line 1))
  8389. (t (error "Line update did not work")))
  8390. (save-restriction
  8391. (narrow-to-region (point-at-bol) (point-at-eol))
  8392. (org-agenda-finalize)))
  8393. (beginning-of-line 0)))))
  8394. (defun org-agenda-align-tags (&optional line)
  8395. "Align all tags in agenda items to `org-agenda-tags-column'.
  8396. When optional argument LINE is non-nil, align tags only on the
  8397. current line."
  8398. (let ((inhibit-read-only t)
  8399. (org-agenda-tags-column (if (eq 'auto org-agenda-tags-column)
  8400. (- (window-text-width))
  8401. org-agenda-tags-column))
  8402. (end (and line (line-end-position)))
  8403. l c)
  8404. (save-excursion
  8405. (goto-char (if line (line-beginning-position) (point-min)))
  8406. (while (re-search-forward org-tag-group-re end t)
  8407. (add-text-properties
  8408. (match-beginning 1) (match-end 1)
  8409. (list 'face (delq nil (let ((prop (get-text-property
  8410. (match-beginning 1) 'face)))
  8411. (or (listp prop) (setq prop (list prop)))
  8412. (if (memq 'org-tag prop)
  8413. prop
  8414. (cons 'org-tag prop))))))
  8415. (setq l (- (match-end 1) (match-beginning 1))
  8416. c (if (< org-agenda-tags-column 0)
  8417. (- (abs org-agenda-tags-column) l)
  8418. org-agenda-tags-column))
  8419. (goto-char (match-beginning 1))
  8420. (delete-region (save-excursion (skip-chars-backward " \t") (point))
  8421. (point))
  8422. (insert (org-add-props
  8423. (make-string (max 1 (- c (current-column))) ?\s)
  8424. (plist-put (copy-sequence (text-properties-at (point)))
  8425. 'face nil))))
  8426. (goto-char (point-min))
  8427. (org-font-lock-add-tag-faces (point-max)))))
  8428. (defun org-agenda-priority-up ()
  8429. "Increase the priority of line at point, also in Org file."
  8430. (interactive)
  8431. (org-agenda-priority 'up))
  8432. (defun org-agenda-priority-down ()
  8433. "Decrease the priority of line at point, also in Org file."
  8434. (interactive)
  8435. (org-agenda-priority 'down))
  8436. (defun org-agenda-priority (&optional force-direction)
  8437. "Set the priority of line at point, also in Org file.
  8438. This changes the line at point, all other lines in the agenda referring to
  8439. the same tree node, and the headline of the tree node in the Org file.
  8440. Called with a universal prefix arg, show the priority instead of setting it."
  8441. (interactive "P")
  8442. (if (equal force-direction '(4))
  8443. (org-show-priority)
  8444. (unless org-enable-priority-commands
  8445. (error "Priority commands are disabled"))
  8446. (org-agenda-check-no-diary)
  8447. (let* ((col (current-column))
  8448. (marker (or (org-get-at-bol 'org-marker)
  8449. (org-agenda-error)))
  8450. (hdmarker (org-get-at-bol 'org-hd-marker))
  8451. (buffer (marker-buffer hdmarker))
  8452. (pos (marker-position hdmarker))
  8453. (inhibit-read-only t)
  8454. newhead)
  8455. (org-with-remote-undo buffer
  8456. (with-current-buffer buffer
  8457. (widen)
  8458. (goto-char pos)
  8459. (org-show-context 'agenda)
  8460. (org-priority force-direction)
  8461. (end-of-line 1)
  8462. (setq newhead (org-get-heading)))
  8463. (org-agenda-change-all-lines newhead hdmarker)
  8464. (org-move-to-column col)))))
  8465. ;; FIXME: should fix the tags property of the agenda line.
  8466. (defun org-agenda-set-tags (&optional tag onoff)
  8467. "Set tags for the current headline."
  8468. (interactive)
  8469. (org-agenda-check-no-diary)
  8470. (if (and (org-region-active-p) (called-interactively-p 'any))
  8471. (call-interactively 'org-change-tag-in-region)
  8472. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8473. (org-agenda-error)))
  8474. (buffer (marker-buffer hdmarker))
  8475. (pos (marker-position hdmarker))
  8476. (inhibit-read-only t)
  8477. newhead)
  8478. (org-with-remote-undo buffer
  8479. (with-current-buffer buffer
  8480. (widen)
  8481. (goto-char pos)
  8482. (org-show-context 'agenda)
  8483. (if tag
  8484. (org-toggle-tag tag onoff)
  8485. (call-interactively #'org-set-tags-command))
  8486. (end-of-line 1)
  8487. (setq newhead (org-get-heading)))
  8488. (org-agenda-change-all-lines newhead hdmarker)
  8489. (beginning-of-line 1)))))
  8490. (defun org-agenda-set-property ()
  8491. "Set a property for the current headline."
  8492. (interactive)
  8493. (org-agenda-check-no-diary)
  8494. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8495. (org-agenda-error)))
  8496. (buffer (marker-buffer hdmarker))
  8497. (pos (marker-position hdmarker))
  8498. (inhibit-read-only t)
  8499. newhead)
  8500. (org-with-remote-undo buffer
  8501. (with-current-buffer buffer
  8502. (widen)
  8503. (goto-char pos)
  8504. (org-show-context 'agenda)
  8505. (call-interactively 'org-set-property)))))
  8506. (defun org-agenda-set-effort ()
  8507. "Set the effort property for the current headline."
  8508. (interactive)
  8509. (org-agenda-check-no-diary)
  8510. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8511. (org-agenda-error)))
  8512. (buffer (marker-buffer hdmarker))
  8513. (pos (marker-position hdmarker))
  8514. (inhibit-read-only t)
  8515. newhead)
  8516. (org-with-remote-undo buffer
  8517. (with-current-buffer buffer
  8518. (widen)
  8519. (goto-char pos)
  8520. (org-show-context 'agenda)
  8521. (call-interactively 'org-set-effort)
  8522. (end-of-line 1)
  8523. (setq newhead (org-get-heading)))
  8524. (org-agenda-change-all-lines newhead hdmarker))))
  8525. (defun org-agenda-toggle-archive-tag ()
  8526. "Toggle the archive tag for the current entry."
  8527. (interactive)
  8528. (org-agenda-check-no-diary)
  8529. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8530. (org-agenda-error)))
  8531. (buffer (marker-buffer hdmarker))
  8532. (pos (marker-position hdmarker))
  8533. (inhibit-read-only t)
  8534. newhead)
  8535. (org-with-remote-undo buffer
  8536. (with-current-buffer buffer
  8537. (widen)
  8538. (goto-char pos)
  8539. (org-show-context 'agenda)
  8540. (call-interactively 'org-toggle-archive-tag)
  8541. (end-of-line 1)
  8542. (setq newhead (org-get-heading)))
  8543. (org-agenda-change-all-lines newhead hdmarker)
  8544. (beginning-of-line 1))))
  8545. (defun org-agenda-do-date-later (arg)
  8546. (interactive "P")
  8547. (cond
  8548. ((or (equal arg '(16))
  8549. (memq last-command
  8550. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  8551. (setq this-command 'org-agenda-date-later-minutes)
  8552. (org-agenda-date-later-minutes 1))
  8553. ((or (equal arg '(4))
  8554. (memq last-command
  8555. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  8556. (setq this-command 'org-agenda-date-later-hours)
  8557. (org-agenda-date-later-hours 1))
  8558. (t
  8559. (org-agenda-date-later (prefix-numeric-value arg)))))
  8560. (defun org-agenda-do-date-earlier (arg)
  8561. (interactive "P")
  8562. (cond
  8563. ((or (equal arg '(16))
  8564. (memq last-command
  8565. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  8566. (setq this-command 'org-agenda-date-earlier-minutes)
  8567. (org-agenda-date-earlier-minutes 1))
  8568. ((or (equal arg '(4))
  8569. (memq last-command
  8570. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  8571. (setq this-command 'org-agenda-date-earlier-hours)
  8572. (org-agenda-date-earlier-hours 1))
  8573. (t
  8574. (org-agenda-date-earlier (prefix-numeric-value arg)))))
  8575. (defun org-agenda-date-later (arg &optional what)
  8576. "Change the date of this item to ARG day(s) later."
  8577. (interactive "p")
  8578. (org-agenda-check-type t 'agenda)
  8579. (org-agenda-check-no-diary)
  8580. (let* ((marker (or (org-get-at-bol 'org-marker)
  8581. (org-agenda-error)))
  8582. (buffer (marker-buffer marker))
  8583. (pos (marker-position marker))
  8584. cdate today)
  8585. (org-with-remote-undo buffer
  8586. (with-current-buffer buffer
  8587. (widen)
  8588. (goto-char pos)
  8589. (unless (org-at-timestamp-p 'lax) (error "Cannot find time stamp"))
  8590. (when (and org-agenda-move-date-from-past-immediately-to-today
  8591. (equal arg 1)
  8592. (or (not what) (eq what 'day))
  8593. (not (save-match-data (org-at-date-range-p))))
  8594. (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
  8595. cdate (calendar-absolute-from-gregorian
  8596. (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
  8597. today (org-today))
  8598. (when (> today cdate)
  8599. ;; immediately shift to today
  8600. (setq arg (- today cdate))))
  8601. (org-timestamp-change arg (or what 'day))
  8602. (when (and (org-at-date-range-p)
  8603. (re-search-backward org-tr-regexp-both (point-at-bol)))
  8604. (let ((end org-last-changed-timestamp))
  8605. (org-timestamp-change arg (or what 'day))
  8606. (setq org-last-changed-timestamp
  8607. (concat org-last-changed-timestamp "--" end)))))
  8608. (org-agenda-show-new-time marker org-last-changed-timestamp))
  8609. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  8610. (defun org-agenda-date-earlier (arg &optional what)
  8611. "Change the date of this item to ARG day(s) earlier."
  8612. (interactive "p")
  8613. (org-agenda-date-later (- arg) what))
  8614. (defun org-agenda-date-later-minutes (arg)
  8615. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  8616. (interactive "p")
  8617. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  8618. (org-agenda-date-later arg 'minute))
  8619. (defun org-agenda-date-earlier-minutes (arg)
  8620. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."