org-agenda.el 407 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577
  1. ;;; org-agenda.el --- Dynamic task and appointment lists for Org
  2. ;; Copyright (C) 2004-2020 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 'ol)
  43. (require 'org)
  44. (require 'org-macs)
  45. (declare-function diary-add-to-list "diary-lib"
  46. (date string specifier &optional marker globcolor literal))
  47. (declare-function calendar-iso-to-absolute "cal-iso" (date))
  48. (declare-function calendar-astro-date-string "cal-julian" (&optional date))
  49. (declare-function calendar-bahai-date-string "cal-bahai" (&optional date))
  50. (declare-function calendar-chinese-date-string "cal-china" (&optional date))
  51. (declare-function calendar-coptic-date-string "cal-coptic" (&optional date))
  52. (declare-function calendar-ethiopic-date-string "cal-coptic" (&optional date))
  53. (declare-function calendar-french-date-string "cal-french" (&optional date))
  54. (declare-function calendar-goto-date "cal-move" (date))
  55. (declare-function calendar-hebrew-date-string "cal-hebrew" (&optional date))
  56. (declare-function calendar-islamic-date-string "cal-islam" (&optional date))
  57. (declare-function calendar-iso-date-string "cal-iso" (&optional date))
  58. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  59. (declare-function calendar-julian-date-string "cal-julian" (&optional date))
  60. (declare-function calendar-mayan-date-string "cal-mayan" (&optional date))
  61. (declare-function calendar-persian-date-string "cal-persia" (&optional date))
  62. (declare-function calendar-check-holidays "holidays" (date))
  63. (declare-function org-columns-remove-overlays "org-colview" ())
  64. (declare-function org-datetree-find-date-create "org-datetree"
  65. (date &optional keep-restriction))
  66. (declare-function org-columns-quit "org-colview" ())
  67. (declare-function diary-date-display-form "diary-lib" (&optional type))
  68. (declare-function org-mobile-write-agenda-for-mobile "org-mobile" (file))
  69. (declare-function org-habit-insert-consistency-graphs
  70. "org-habit" (&optional line))
  71. (declare-function org-is-habit-p "org-habit" (&optional pom))
  72. (declare-function org-habit-parse-todo "org-habit" (&optional pom))
  73. (declare-function org-habit-get-priority "org-habit" (habit &optional moment))
  74. (declare-function org-agenda-columns "org-colview" ())
  75. (declare-function org-add-archive-files "org-archive" (files))
  76. (declare-function org-capture "org-capture" (&optional goto keys))
  77. (defvar calendar-mode-map)
  78. (defvar org-clock-current-task)
  79. (defvar org-current-tag-alist)
  80. (defvar org-mobile-force-id-on-agenda-items)
  81. (defvar org-habit-show-habits)
  82. (defvar org-habit-show-habits-only-for-today)
  83. (defvar org-habit-show-all-today)
  84. (defvar org-habit-scheduled-past-days)
  85. (org-remap org-agenda-mode-map 'move-end-of-line 'org-agenda-end-of-line)
  86. ;; Defined somewhere in this file, but used before definition.
  87. (defvar org-agenda-buffer-name "*Org Agenda*")
  88. (defvar org-agenda-overriding-header nil)
  89. (defvar org-agenda-title-append nil)
  90. (with-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  91. (with-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  92. (defvar original-date) ; dynamically scoped, calendar.el does scope this
  93. (defvar org-agenda-undo-list nil
  94. "List of undoable operations in the agenda since last refresh.")
  95. (defvar org-agenda-pending-undo-list nil
  96. "In a series of undo commands, this is the list of remaining undo items.")
  97. (defcustom org-agenda-confirm-kill 1
  98. "When set, remote killing from the agenda buffer needs confirmation.
  99. When t, a confirmation is always needed. When a number N, confirmation is
  100. only needed when the text to be killed contains more than N non-white lines."
  101. :group 'org-agenda
  102. :type '(choice
  103. (const :tag "Never" nil)
  104. (const :tag "Always" t)
  105. (integer :tag "When more than N lines")))
  106. (defcustom org-agenda-compact-blocks nil
  107. "Non-nil means make the block agenda more compact.
  108. This is done globally by leaving out lines like the agenda span
  109. name and week number or the separator lines."
  110. :group 'org-agenda
  111. :type 'boolean)
  112. (defcustom org-agenda-block-separator ?=
  113. "The separator between blocks in the agenda.
  114. If this is a string, it will be used as the separator, with a newline added.
  115. If it is a character, it will be repeated to fill the window width.
  116. If nil the separator is disabled. In `org-agenda-custom-commands' this
  117. addresses the separator between the current and the previous block."
  118. :group 'org-agenda
  119. :type '(choice
  120. (const :tag "Disabled" nil)
  121. (character)
  122. (string)))
  123. (defgroup org-agenda-export nil
  124. "Options concerning exporting agenda views in Org mode."
  125. :tag "Org Agenda Export"
  126. :group 'org-agenda)
  127. (defcustom org-agenda-with-colors t
  128. "Non-nil means use colors in agenda views."
  129. :group 'org-agenda-export
  130. :type 'boolean)
  131. (defcustom org-agenda-exporter-settings nil
  132. "Alist of variable/value pairs that should be active during agenda export.
  133. This is a good place to set options for ps-print and for htmlize.
  134. Note that the way this is implemented, the values will be evaluated
  135. before assigned to the variables. So make sure to quote values you do
  136. *not* want evaluated, for example
  137. (setq org-agenda-exporter-settings
  138. \\='((ps-print-color-p \\='black-white)))"
  139. :group 'org-agenda-export
  140. :type '(repeat
  141. (list
  142. (variable)
  143. (sexp :tag "Value"))))
  144. (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
  145. "Hook run in a temporary buffer before writing the agenda to an export file.
  146. A useful function for this hook is `org-agenda-add-entry-text'."
  147. :group 'org-agenda-export
  148. :type 'hook
  149. :options '(org-agenda-add-entry-text))
  150. (defcustom org-agenda-add-entry-text-maxlines 0
  151. "Maximum number of entry text lines to be added to agenda.
  152. This is only relevant when `org-agenda-add-entry-text' is part of
  153. `org-agenda-before-write-hook', which is the default.
  154. When this is 0, nothing will happen. When it is greater than 0, it
  155. specifies the maximum number of lines that will be added for each entry
  156. that is listed in the agenda view.
  157. Note that this variable is not used during display, only when exporting
  158. the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
  159. and `org-agenda-entry-text-maxlines'."
  160. :group 'org-agenda
  161. :type 'integer)
  162. (defcustom org-agenda-add-entry-text-descriptive-links t
  163. "Non-nil means export org-links as descriptive links in agenda added text.
  164. This variable applies to the text added to the agenda when
  165. `org-agenda-add-entry-text-maxlines' is larger than 0.
  166. When this variable nil, the URL will (also) be shown."
  167. :group 'org-agenda
  168. :type 'boolean)
  169. (defcustom org-agenda-export-html-style nil
  170. "The style specification for exported HTML Agenda files.
  171. If this variable contains a string, it will replace the default <style>
  172. section as produced by `htmlize'.
  173. Since there are different ways of setting style information, this variable
  174. needs to contain the full HTML structure to provide a style, including the
  175. surrounding HTML tags. The style specifications should include definitions
  176. the fonts used by the agenda, here is an example:
  177. <style type=\"text/css\">
  178. p { font-weight: normal; color: gray; }
  179. .org-agenda-structure {
  180. font-size: 110%;
  181. color: #003399;
  182. font-weight: 600;
  183. }
  184. .org-todo {
  185. color: #cc6666;
  186. font-weight: bold;
  187. }
  188. .org-agenda-done {
  189. color: #339933;
  190. }
  191. .org-done {
  192. color: #339933;
  193. }
  194. .title { text-align: center; }
  195. .todo, .deadline { color: red; }
  196. .done { color: green; }
  197. </style>
  198. or, if you want to keep the style in a file,
  199. <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
  200. As the value of this option simply gets inserted into the HTML <head> header,
  201. you can \"misuse\" it to also add other text to the header."
  202. :group 'org-agenda-export
  203. :group 'org-export-html
  204. :type '(choice
  205. (const nil)
  206. (string)))
  207. (defcustom org-agenda-persistent-filter nil
  208. "When set, keep filters from one agenda view to the next."
  209. :group 'org-agenda
  210. :type 'boolean)
  211. (defgroup org-agenda-custom-commands nil
  212. "Options concerning agenda views in Org mode."
  213. :tag "Org Agenda Custom Commands"
  214. :group 'org-agenda)
  215. (defconst org-sorting-choice
  216. '(choice
  217. (const time-up) (const time-down)
  218. (const timestamp-up) (const timestamp-down)
  219. (const scheduled-up) (const scheduled-down)
  220. (const deadline-up) (const deadline-down)
  221. (const ts-up) (const ts-down)
  222. (const tsia-up) (const tsia-down)
  223. (const category-keep) (const category-up) (const category-down)
  224. (const tag-down) (const tag-up)
  225. (const priority-up) (const priority-down)
  226. (const todo-state-up) (const todo-state-down)
  227. (const effort-up) (const effort-down)
  228. (const habit-up) (const habit-down)
  229. (const alpha-up) (const alpha-down)
  230. (const user-defined-up) (const user-defined-down))
  231. "Sorting choices.")
  232. ;; Keep custom values for `org-agenda-filter-preset' compatible with
  233. ;; the new variable `org-agenda-tag-filter-preset'.
  234. (defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
  235. (defvaralias 'org-agenda-filter 'org-agenda-tag-filter)
  236. (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
  237. "List of types searched for when creating the daily/weekly agenda.
  238. This variable is a list of symbols that controls the types of
  239. items that appear in the daily/weekly agenda. Allowed symbols in this
  240. list are
  241. :timestamp List items containing a date stamp or date range matching
  242. the selected date. This includes sexp entries in angular
  243. brackets.
  244. :sexp List entries resulting from plain diary-like sexps.
  245. :deadline List deadline due on that date. When the date is today,
  246. also list any deadlines past due, or due within
  247. `org-deadline-warning-days'.
  248. :deadline* Same as above, but only include the deadline if it has an
  249. hour specification as [h]h:mm.
  250. :scheduled List all items which are scheduled for the given date.
  251. The diary for *today* also contains items which were
  252. scheduled earlier and are not yet marked DONE.
  253. :scheduled* Same as above, but only include the scheduled item if it
  254. has an hour specification as [h]h:mm.
  255. By default, all four non-starred types are turned on.
  256. When :scheduled* or :deadline* are included, :schedule or :deadline
  257. will be ignored.
  258. Never set this variable globally using `setq', because then it
  259. will apply to all future agenda commands. Instead, bind it with
  260. `let' to scope it dynamically into the agenda-constructing
  261. command. A good way to set it is through options in
  262. `org-agenda-custom-commands'. For a more flexible (though
  263. somewhat less efficient) way of determining what is included in
  264. the daily/weekly agenda, see `org-agenda-skip-function'.")
  265. (defconst org-agenda-custom-commands-local-options
  266. `(repeat :tag "Local settings for this command. Remember to quote values"
  267. (choice :tag "Setting"
  268. (list :tag "Heading for this block"
  269. (const org-agenda-overriding-header)
  270. (string :tag "Headline"))
  271. (list :tag "Files to be searched"
  272. (const org-agenda-files)
  273. (list
  274. (const :format "" quote)
  275. (repeat (file))))
  276. (list :tag "Sorting strategy"
  277. (const org-agenda-sorting-strategy)
  278. (list
  279. (const :format "" quote)
  280. (repeat
  281. ,org-sorting-choice)))
  282. (list :tag "Prefix format"
  283. (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
  284. (string))
  285. (list :tag "Number of days in agenda"
  286. (const org-agenda-span)
  287. (list
  288. (const :format "" quote)
  289. (choice (const :tag "Day" day)
  290. (const :tag "Week" week)
  291. (const :tag "Fortnight" fortnight)
  292. (const :tag "Month" month)
  293. (const :tag "Year" year)
  294. (integer :tag "Custom"))))
  295. (list :tag "Fixed starting date"
  296. (const org-agenda-start-day)
  297. (string :value "2007-11-01"))
  298. (list :tag "Start on day of week"
  299. (const org-agenda-start-on-weekday)
  300. (choice :value 1
  301. (const :tag "Today" nil)
  302. (integer :tag "Weekday No.")))
  303. (list :tag "Include data from diary"
  304. (const org-agenda-include-diary)
  305. (boolean))
  306. (list :tag "Deadline Warning days"
  307. (const org-deadline-warning-days)
  308. (integer :value 1))
  309. (list :tag "Category filter preset"
  310. (const org-agenda-category-filter-preset)
  311. (list
  312. (const :format "" quote)
  313. (repeat
  314. (string :tag "+category or -category"))))
  315. (list :tag "Tags filter preset"
  316. (const org-agenda-tag-filter-preset)
  317. (list
  318. (const :format "" quote)
  319. (repeat
  320. (string :tag "+tag or -tag"))))
  321. (list :tag "Effort filter preset"
  322. (const org-agenda-effort-filter-preset)
  323. (list
  324. (const :format "" quote)
  325. (repeat
  326. (string :tag "+=10 or -=10 or +<10 or ->10"))))
  327. (list :tag "Regexp filter preset"
  328. (const org-agenda-regexp-filter-preset)
  329. (list
  330. (const :format "" quote)
  331. (repeat
  332. (string :tag "+regexp or -regexp"))))
  333. (list :tag "Set daily/weekly entry types"
  334. (const org-agenda-entry-types)
  335. (list
  336. (const :format "" quote)
  337. (set :greedy t :value ,org-agenda-entry-types
  338. (const :deadline)
  339. (const :scheduled)
  340. (const :deadline*)
  341. (const :scheduled*)
  342. (const :timestamp)
  343. (const :sexp))))
  344. (list :tag "Columns format"
  345. (const org-overriding-columns-format)
  346. (string :tag "Format"))
  347. (list :tag "Standard skipping condition"
  348. :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
  349. (const org-agenda-skip-function)
  350. (list
  351. (const :format "" quote)
  352. (list
  353. (choice
  354. :tag "Skipping range"
  355. (const :tag "Skip entry" org-agenda-skip-entry-if)
  356. (const :tag "Skip subtree" org-agenda-skip-subtree-if))
  357. (repeat :inline t :tag "Conditions for skipping"
  358. (choice
  359. :tag "Condition type"
  360. (list :tag "Regexp matches" :inline t
  361. (const :format "" regexp)
  362. (regexp))
  363. (list :tag "Regexp does not match" :inline t
  364. (const :format "" notregexp)
  365. (regexp))
  366. (list :tag "TODO state is" :inline t
  367. (const todo)
  368. (choice
  369. (const :tag "Any not-done state" todo)
  370. (const :tag "Any done state" done)
  371. (const :tag "Any state" any)
  372. (list :tag "Keyword list"
  373. (const :format "" quote)
  374. (repeat (string :tag "Keyword")))))
  375. (list :tag "TODO state is not" :inline t
  376. (const nottodo)
  377. (choice
  378. (const :tag "Any not-done state" todo)
  379. (const :tag "Any done state" done)
  380. (const :tag "Any state" any)
  381. (list :tag "Keyword list"
  382. (const :format "" quote)
  383. (repeat (string :tag "Keyword")))))
  384. (const :tag "scheduled" scheduled)
  385. (const :tag "not scheduled" notscheduled)
  386. (const :tag "deadline" deadline)
  387. (const :tag "no deadline" notdeadline)
  388. (const :tag "timestamp" timestamp)
  389. (const :tag "no timestamp" nottimestamp))))))
  390. (list :tag "Non-standard skipping condition"
  391. :value (org-agenda-skip-function)
  392. (const org-agenda-skip-function)
  393. (sexp :tag "Function or form (quoted!)"))
  394. (list :tag "Any variable"
  395. (variable :tag "Variable")
  396. (sexp :tag "Value (sexp)"))))
  397. "Selection of examples for agenda command settings.
  398. This will be spliced into the custom type of
  399. `org-agenda-custom-commands'.")
  400. (defcustom org-agenda-custom-commands
  401. '(("n" "Agenda and all TODOs" ((agenda "") (alltodo ""))))
  402. "Custom commands for the agenda.
  403. \\<org-mode-map>
  404. These commands will be offered on the splash screen displayed by the
  405. agenda dispatcher `\\[org-agenda]'. Each entry is a list like this:
  406. (key desc type match settings files)
  407. key The key (one or more characters as a string) to be associated
  408. with the command.
  409. desc A description of the command, when omitted or nil, a default
  410. description is built using MATCH.
  411. type The command type, any of the following symbols:
  412. agenda The daily/weekly agenda.
  413. todo Entries with a specific TODO keyword, in all agenda files.
  414. search Entries containing search words entry or headline.
  415. tags Tags/Property/TODO match in all agenda files.
  416. tags-todo Tags/P/T match in all agenda files, TODO entries only.
  417. todo-tree Sparse tree of specific TODO keyword in *current* file.
  418. tags-tree Sparse tree with all tags matches in *current* file.
  419. occur-tree Occur sparse tree for *current* file.
  420. ... A user-defined function.
  421. match What to search for:
  422. - a single keyword for TODO keyword searches
  423. - a tags/property/todo match expression for searches
  424. - a word search expression for text searches.
  425. - a regular expression for occur searches
  426. For all other commands, this should be the empty string.
  427. settings A list of option settings, similar to that in a let form, so like
  428. this: ((opt1 val1) (opt2 val2) ...). The values will be
  429. evaluated at the moment of execution, so quote them when needed.
  430. files A list of files to write the produced agenda buffer to with
  431. the command `org-store-agenda-views'.
  432. If a file name ends in \".html\", an HTML version of the buffer
  433. is written out. If it ends in \".ps\", a postscript version is
  434. produced. Otherwise, only the plain text is written to the file.
  435. You can also define a set of commands, to create a composite agenda buffer.
  436. In this case, an entry looks like this:
  437. (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
  438. where
  439. desc A description string to be displayed in the dispatcher menu.
  440. cmd An agenda command, similar to the above. However, tree commands
  441. are not allowed, but instead you can get agenda and global todo list.
  442. So valid commands for a set are:
  443. (agenda \"\" settings)
  444. (alltodo \"\" settings)
  445. (stuck \"\" settings)
  446. (todo \"match\" settings files)
  447. (search \"match\" settings files)
  448. (tags \"match\" settings files)
  449. (tags-todo \"match\" settings files)
  450. Each command can carry a list of options, and another set of options can be
  451. given for the whole set of commands. Individual command options take
  452. precedence over the general options.
  453. When using several characters as key to a command, the first characters
  454. are prefix commands. For the dispatcher to display useful information, you
  455. should provide a description for the prefix, like
  456. (setq org-agenda-custom-commands
  457. \\='((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
  458. (\"hl\" tags \"+HOME+Lisa\")
  459. (\"hp\" tags \"+HOME+Peter\")
  460. (\"hk\" tags \"+HOME+Kim\")))"
  461. :group 'org-agenda-custom-commands
  462. :type `(repeat
  463. (choice :value ("x" "Describe command here" tags "" nil)
  464. (list :tag "Single command"
  465. (string :tag "Access Key(s) ")
  466. (option (string :tag "Description"))
  467. (choice
  468. (const :tag "Agenda" agenda)
  469. (const :tag "TODO list" alltodo)
  470. (const :tag "Search words" search)
  471. (const :tag "Stuck projects" stuck)
  472. (const :tag "Tags/Property match (all agenda files)" tags)
  473. (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
  474. (const :tag "TODO keyword search (all agenda files)" todo)
  475. (const :tag "Tags sparse tree (current buffer)" tags-tree)
  476. (const :tag "TODO keyword tree (current buffer)" todo-tree)
  477. (const :tag "Occur tree (current buffer)" occur-tree)
  478. (sexp :tag "Other, user-defined function"))
  479. (string :tag "Match (only for some commands)")
  480. ,org-agenda-custom-commands-local-options
  481. (option (repeat :tag "Export" (file :tag "Export to"))))
  482. (list :tag "Command series, all agenda files"
  483. (string :tag "Access Key(s)")
  484. (string :tag "Description ")
  485. (repeat :tag "Component"
  486. (choice
  487. (list :tag "Agenda"
  488. (const :format "" agenda)
  489. (const :tag "" :format "" "")
  490. ,org-agenda-custom-commands-local-options)
  491. (list :tag "TODO list (all keywords)"
  492. (const :format "" alltodo)
  493. (const :tag "" :format "" "")
  494. ,org-agenda-custom-commands-local-options)
  495. (list :tag "Search words"
  496. (const :format "" search)
  497. (string :tag "Match")
  498. ,org-agenda-custom-commands-local-options)
  499. (list :tag "Stuck projects"
  500. (const :format "" stuck)
  501. (const :tag "" :format "" "")
  502. ,org-agenda-custom-commands-local-options)
  503. (list :tag "Tags/Property match (all agenda files)"
  504. (const :format "" tags)
  505. (string :tag "Match")
  506. ,org-agenda-custom-commands-local-options)
  507. (list :tag "Tags/Property match of TODO entries (all agenda files)"
  508. (const :format "" tags-todo)
  509. (string :tag "Match")
  510. ,org-agenda-custom-commands-local-options)
  511. (list :tag "TODO keyword search"
  512. (const :format "" todo)
  513. (string :tag "Match")
  514. ,org-agenda-custom-commands-local-options)
  515. (list :tag "Other, user-defined function"
  516. (symbol :tag "function")
  517. (string :tag "Match")
  518. ,org-agenda-custom-commands-local-options)))
  519. (repeat :tag "Settings for entire command set"
  520. (list (variable :tag "Any variable")
  521. (sexp :tag "Value")))
  522. (option (repeat :tag "Export" (file :tag "Export to"))))
  523. (cons :tag "Prefix key documentation"
  524. (string :tag "Access Key(s)")
  525. (string :tag "Description ")))))
  526. (defcustom org-agenda-query-register ?o
  527. "The register holding the current query string.
  528. The purpose of this is that if you construct a query string interactively,
  529. you can then use it to define a custom command."
  530. :group 'org-agenda-custom-commands
  531. :type 'character)
  532. (defcustom org-stuck-projects
  533. '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
  534. "How to identify stuck projects.
  535. This is a list of four items:
  536. 1. A tags/todo/property matcher string that is used to identify a project.
  537. See the manual for a description of tag and property searches.
  538. The entire tree below a headline matched by this is considered one project.
  539. 2. A list of TODO keywords identifying non-stuck projects.
  540. If the project subtree contains any headline with one of these todo
  541. keywords, the project is considered to be not stuck. If you specify
  542. \"*\" as a keyword, any TODO keyword will mark the project unstuck.
  543. 3. A list of tags identifying non-stuck projects.
  544. If the project subtree contains any headline with one of these tags,
  545. the project is considered to be not stuck. If you specify \"*\" as
  546. a tag, any tag will mark the project unstuck. Note that this is about
  547. the explicit presence of a tag somewhere in the subtree, inherited
  548. tags do not count here. If inherited tags make a project not stuck,
  549. use \"-TAG\" in the tags part of the matcher under (1.) above.
  550. 4. An arbitrary regular expression matching non-stuck projects.
  551. If the project turns out to be not stuck, search continues also in the
  552. subtree to see if any of the subtasks have project status.
  553. See also the variable `org-tags-match-list-sublevels' which applies
  554. to projects matched by this search as well.
  555. After defining this variable, you may use `org-agenda-list-stuck-projects'
  556. \(bound to `\\[org-agenda] #') to produce the list."
  557. :group 'org-agenda-custom-commands
  558. :type '(list
  559. (string :tag "Tags/TODO match to identify a project")
  560. (repeat :tag "Projects are *not* stuck if they have an entry with \
  561. TODO keyword any of" (string))
  562. (repeat :tag "Projects are *not* stuck if they have an entry with \
  563. TAG being any of" (string))
  564. (regexp :tag "Projects are *not* stuck if this regexp matches inside \
  565. the subtree")))
  566. (defgroup org-agenda-skip nil
  567. "Options concerning skipping parts of agenda files."
  568. :tag "Org Agenda Skip"
  569. :group 'org-agenda)
  570. (defcustom org-agenda-skip-function-global nil
  571. "Function to be called at each match during agenda construction.
  572. If this function returns nil, the current match should not be skipped.
  573. If the function decided to skip an agenda match, is must return the
  574. buffer position from which the search should be continued.
  575. This may also be a Lisp form, which will be evaluated.
  576. This variable will be applied to every agenda match, including
  577. tags/property searches and TODO lists. So try to make the test function
  578. do its checking as efficiently as possible. To implement a skipping
  579. condition just for specific agenda commands, use the variable
  580. `org-agenda-skip-function' which can be set in the options section
  581. of custom agenda commands."
  582. :group 'org-agenda-skip
  583. :type 'sexp)
  584. (defgroup org-agenda-daily/weekly nil
  585. "Options concerning the daily/weekly agenda."
  586. :tag "Org Agenda Daily/Weekly"
  587. :group 'org-agenda)
  588. (defgroup org-agenda-todo-list nil
  589. "Options concerning the global todo list agenda view."
  590. :tag "Org Agenda Todo List"
  591. :group 'org-agenda)
  592. (defgroup org-agenda-match-view nil
  593. "Options concerning the general tags/property/todo match agenda view."
  594. :tag "Org Agenda Match View"
  595. :group 'org-agenda)
  596. (defgroup org-agenda-search-view nil
  597. "Options concerning the search agenda view."
  598. :tag "Org Agenda Search View"
  599. :group 'org-agenda)
  600. (defvar org-agenda-archives-mode nil
  601. "Non-nil means the agenda will include archived items.
  602. If this is the symbol `trees', trees in the selected agenda scope
  603. that are marked with the ARCHIVE tag will be included anyway. When this is
  604. t, also all archive files associated with the current selection of agenda
  605. files will be included.")
  606. (defcustom org-agenda-restriction-lock-highlight-subtree t
  607. "Non-nil means highlight the whole subtree when restriction is active.
  608. Otherwise only highlight the headline. Highlighting the whole subtree is
  609. useful to ensure no edits happen beyond the restricted region."
  610. :group 'org-agenda
  611. :type 'boolean)
  612. (defcustom org-agenda-skip-comment-trees t
  613. "Non-nil means skip trees that start with the COMMENT keyword.
  614. When nil, these trees are also scanned by agenda commands."
  615. :group 'org-agenda-skip
  616. :type 'boolean)
  617. (defcustom org-agenda-todo-list-sublevels t
  618. "Non-nil means check also the sublevels of a TODO entry for TODO entries.
  619. When nil, the sublevels of a TODO entry are not checked, resulting in
  620. potentially much shorter TODO lists."
  621. :group 'org-agenda-skip
  622. :group 'org-agenda-todo-list
  623. :type 'boolean)
  624. (defcustom org-agenda-todo-ignore-with-date nil
  625. "Non-nil means don't show entries with a date in the global todo list.
  626. You can use this if you prefer to mark mere appointments with a TODO keyword,
  627. but don't want them to show up in the TODO list.
  628. When this is set, it also covers deadlines and scheduled items, the settings
  629. of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
  630. will be ignored.
  631. See also the variable `org-agenda-tags-todo-honor-ignore-options'."
  632. :group 'org-agenda-skip
  633. :group 'org-agenda-todo-list
  634. :type 'boolean)
  635. (defcustom org-agenda-todo-ignore-timestamp nil
  636. "Non-nil means don't show entries with a timestamp.
  637. This applies when creating the global todo list.
  638. Valid values are:
  639. past Don't show entries for today or in the past.
  640. future Don't show entries with a timestamp in the future.
  641. The idea behind this is that if it has a future
  642. timestamp, you don't want to think about it until the
  643. date.
  644. all Don't show any entries with a timestamp in the global todo list.
  645. The idea behind this is that by setting a timestamp, you
  646. have already \"taken care\" of this item.
  647. This variable can also have an integer as a value. If positive (N),
  648. todos with a timestamp N or more days in the future will be ignored. If
  649. negative (-N), todos with a timestamp N or more days in the past will be
  650. ignored. If 0, todos with a timestamp either today or in the future will
  651. be ignored. For example, a value of -1 will exclude todos with a
  652. timestamp in the past (yesterday or earlier), while a value of 7 will
  653. exclude todos with a timestamp a week or more in the future.
  654. See also `org-agenda-todo-ignore-with-date'.
  655. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  656. to make his option also apply to the tags-todo list."
  657. :group 'org-agenda-skip
  658. :group 'org-agenda-todo-list
  659. :version "24.1"
  660. :type '(choice
  661. (const :tag "Ignore future timestamp todos" future)
  662. (const :tag "Ignore past or present timestamp todos" past)
  663. (const :tag "Ignore all timestamp todos" all)
  664. (const :tag "Show timestamp todos" nil)
  665. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  666. (defcustom org-agenda-todo-ignore-scheduled nil
  667. "Non-nil means, ignore some scheduled TODO items when making TODO list.
  668. This applies when creating the global todo list.
  669. Valid values are:
  670. past Don't show entries scheduled today or in the past.
  671. future Don't show entries scheduled in the future.
  672. The idea behind this is that by scheduling it, you don't want to
  673. think about it until the scheduled date.
  674. all Don't show any scheduled entries in the global todo list.
  675. The idea behind this is that by scheduling it, you have already
  676. \"taken care\" of this item.
  677. t Same as `all', for backward compatibility.
  678. This variable can also have an integer as a value. See
  679. `org-agenda-todo-ignore-timestamp' for more details.
  680. See also `org-agenda-todo-ignore-with-date'.
  681. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  682. to make his option also apply to the tags-todo list."
  683. :group 'org-agenda-skip
  684. :group 'org-agenda-todo-list
  685. :type '(choice
  686. (const :tag "Ignore future-scheduled todos" future)
  687. (const :tag "Ignore past- or present-scheduled todos" past)
  688. (const :tag "Ignore all scheduled todos" all)
  689. (const :tag "Ignore all scheduled todos (compatibility)" t)
  690. (const :tag "Show scheduled todos" nil)
  691. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  692. (defcustom org-agenda-todo-ignore-deadlines nil
  693. "Non-nil means ignore some deadline TODO items when making TODO list.
  694. There are different motivations for using different values, please think
  695. carefully when configuring this variable.
  696. This applies when creating the global TODO list.
  697. Valid values are:
  698. near Don't show near deadline entries. A deadline is near when it is
  699. closer than `org-deadline-warning-days' days. The idea behind this
  700. is that such items will appear in the agenda anyway.
  701. far Don't show TODO entries where a deadline has been defined, but
  702. is not going to happen anytime soon. This is useful if you want to use
  703. the TODO list to figure out what to do now.
  704. past Don't show entries with a deadline timestamp for today or in the past.
  705. future Don't show entries with a deadline timestamp in the future, not even
  706. when they become `near' ones. Use it with caution.
  707. all Ignore all TODO entries that do have a deadline.
  708. t Same as `near', for backward compatibility.
  709. This variable can also have an integer as a value. See
  710. `org-agenda-todo-ignore-timestamp' for more details.
  711. See also `org-agenda-todo-ignore-with-date'.
  712. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  713. to make his option also apply to the tags-todo list."
  714. :group 'org-agenda-skip
  715. :group 'org-agenda-todo-list
  716. :type '(choice
  717. (const :tag "Ignore near deadlines" near)
  718. (const :tag "Ignore near deadlines (compatibility)" t)
  719. (const :tag "Ignore far deadlines" far)
  720. (const :tag "Ignore all TODOs with a deadlines" all)
  721. (const :tag "Show all TODOs, even if they have a deadline" nil)
  722. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  723. (defcustom org-agenda-todo-ignore-time-comparison-use-seconds nil
  724. "Time unit to use when possibly ignoring an agenda item.
  725. See the docstring of various `org-agenda-todo-ignore-*' options.
  726. The default is to compare time stamps using days. An item is thus
  727. considered to be in the future if it is at least one day after today.
  728. Non-nil means to compare time stamps using seconds. An item is then
  729. considered future if it has a time value later than current time."
  730. :group 'org-agenda-skip
  731. :group 'org-agenda-todo-list
  732. :version "24.4"
  733. :package-version '(Org . "8.0")
  734. :type '(choice
  735. (const :tag "Compare time with days" nil)
  736. (const :tag "Compare time with seconds" t)))
  737. (defcustom org-agenda-tags-todo-honor-ignore-options nil
  738. "Non-nil means honor todo-list ignores options also in tags-todo search.
  739. The variables
  740. `org-agenda-todo-ignore-with-date',
  741. `org-agenda-todo-ignore-timestamp',
  742. `org-agenda-todo-ignore-scheduled',
  743. `org-agenda-todo-ignore-deadlines'
  744. make the global TODO list skip entries that have time stamps of certain
  745. kinds. If this option is set, the same options will also apply for the
  746. tags-todo search, which is the general tags/property matcher
  747. restricted to unfinished TODO entries only."
  748. :group 'org-agenda-skip
  749. :group 'org-agenda-todo-list
  750. :group 'org-agenda-match-view
  751. :type 'boolean)
  752. (defcustom org-agenda-skip-scheduled-if-done nil
  753. "Non-nil means don't show scheduled items in agenda when they are done.
  754. This is relevant for the daily/weekly agenda, not for the TODO list. It
  755. applies only to the actual date of the scheduling. Warnings about an item
  756. with a past scheduling dates are always turned off when the item is DONE."
  757. :group 'org-agenda-skip
  758. :group 'org-agenda-daily/weekly
  759. :type 'boolean)
  760. (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
  761. "Non-nil means skip scheduling line if same entry shows because of deadline.
  762. In the agenda of today, an entry can show up multiple times
  763. because it is both scheduled and has a nearby deadline, and maybe
  764. a plain time stamp as well.
  765. When this variable is nil, the entry will be shown several times.
  766. When set to t, then only the deadline is shown and the fact that
  767. the entry is scheduled today or was scheduled previously is not
  768. shown.
  769. When set to the symbol `not-today', skip scheduled previously,
  770. but not scheduled today.
  771. When set to the symbol `repeated-after-deadline', skip scheduled
  772. items if they are repeated beyond the current deadline."
  773. :group 'org-agenda-skip
  774. :group 'org-agenda-daily/weekly
  775. :type '(choice
  776. (const :tag "Never" nil)
  777. (const :tag "Always" t)
  778. (const :tag "Not when scheduled today" not-today)
  779. (const :tag "When repeated past deadline" repeated-after-deadline)))
  780. (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
  781. "Non-nil means skip timestamp line if same entry shows because of deadline.
  782. In the agenda of today, an entry can show up multiple times
  783. because it has both a plain timestamp and has a nearby deadline.
  784. When this variable is t, then only the deadline is shown and the
  785. fact that the entry has a timestamp for or including today is not
  786. shown. When this variable is nil, the entry will be shown
  787. several times."
  788. :group 'org-agenda-skip
  789. :group 'org-agenda-daily/weekly
  790. :version "24.1"
  791. :type '(choice
  792. (const :tag "Never" nil)
  793. (const :tag "Always" t)))
  794. (defcustom org-agenda-skip-deadline-if-done nil
  795. "Non-nil means don't show deadlines when the corresponding item is done.
  796. When nil, the deadline is still shown and should give you a happy feeling.
  797. This is relevant for the daily/weekly agenda. It applies only to the
  798. actual date of the deadline. Warnings about approaching and past-due
  799. deadlines are always turned off when the item is DONE."
  800. :group 'org-agenda-skip
  801. :group 'org-agenda-daily/weekly
  802. :type 'boolean)
  803. (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
  804. "Non-nil means skip deadline prewarning when entry is also scheduled.
  805. This will apply on all days where a prewarning for the deadline would
  806. be shown, but not at the day when the entry is actually due. On that day,
  807. the deadline will be shown anyway.
  808. This variable may be set to nil, t, the symbol `pre-scheduled',
  809. or a number which will then give the number of days before the actual
  810. deadline when the prewarnings should resume. The symbol `pre-scheduled'
  811. eliminates the deadline prewarning only prior to the scheduled date.
  812. This can be used in a workflow where the first showing of the deadline will
  813. trigger you to schedule it, and then you don't want to be reminded of it
  814. because you will take care of it on the day when scheduled."
  815. :group 'org-agenda-skip
  816. :group 'org-agenda-daily/weekly
  817. :version "24.1"
  818. :type '(choice
  819. (const :tag "Always show prewarning" nil)
  820. (const :tag "Remove prewarning prior to scheduled date" pre-scheduled)
  821. (const :tag "Remove prewarning if entry is scheduled" t)
  822. (integer :tag "Restart prewarning N days before deadline")))
  823. (defcustom org-agenda-skip-scheduled-delay-if-deadline nil
  824. "Non-nil means skip scheduled delay when entry also has a deadline.
  825. This variable may be set to nil, t, the symbol `post-deadline',
  826. or a number which will then give the number of days after the actual
  827. scheduled date when the delay should expire. The symbol `post-deadline'
  828. eliminates the schedule delay when the date is posterior to the deadline."
  829. :group 'org-agenda-skip
  830. :group 'org-agenda-daily/weekly
  831. :version "24.4"
  832. :package-version '(Org . "8.0")
  833. :type '(choice
  834. (const :tag "Always honor delay" nil)
  835. (const :tag "Ignore delay if posterior to the deadline" post-deadline)
  836. (const :tag "Ignore delay if entry has a deadline" t)
  837. (integer :tag "Honor delay up until N days after the scheduled date")))
  838. (defcustom org-agenda-skip-additional-timestamps-same-entry nil
  839. "When nil, multiple same-day timestamps in entry make multiple agenda lines.
  840. When non-nil, after the search for timestamps has matched once in an
  841. entry, the rest of the entry will not be searched."
  842. :group 'org-agenda-skip
  843. :type 'boolean)
  844. (defcustom org-agenda-skip-timestamp-if-done nil
  845. "Non-nil means don't select item by timestamp or -range if it is DONE."
  846. :group 'org-agenda-skip
  847. :group 'org-agenda-daily/weekly
  848. :type 'boolean)
  849. (defcustom org-agenda-dim-blocked-tasks t
  850. "Non-nil means dim blocked tasks in the agenda display.
  851. This causes some overhead during agenda construction, but if you
  852. have turned on `org-enforce-todo-dependencies',
  853. `org-enforce-todo-checkbox-dependencies', or any other blocking
  854. mechanism, this will create useful feedback in the agenda.
  855. Instead of t, this variable can also have the value `invisible'.
  856. Then blocked tasks will be invisible and only become visible when
  857. they become unblocked. An exemption to this behavior is when a task is
  858. blocked because of unchecked checkboxes below it. Since checkboxes do
  859. not show up in the agenda views, making this task invisible you remove any
  860. trace from agenda views that there is something to do. Therefore, a task
  861. that is blocked because of checkboxes will never be made invisible, it
  862. will only be dimmed."
  863. :group 'org-agenda-daily/weekly
  864. :group 'org-agenda-todo-list
  865. :version "24.3"
  866. :type '(choice
  867. (const :tag "Do not dim" nil)
  868. (const :tag "Dim to a gray face" t)
  869. (const :tag "Make invisible" invisible)))
  870. (defgroup org-agenda-startup nil
  871. "Options concerning initial settings in the Agenda in Org Mode."
  872. :tag "Org Agenda Startup"
  873. :group 'org-agenda)
  874. (defcustom org-agenda-menu-show-matcher t
  875. "Non-nil means show the match string in the agenda dispatcher menu.
  876. When nil, the matcher string is not shown, but is put into the help-echo
  877. property so than moving the mouse over the command shows it.
  878. Setting it to nil is good if matcher strings are very long and/or if
  879. you want to use two-columns display (see `org-agenda-menu-two-columns')."
  880. :group 'org-agenda
  881. :version "24.1"
  882. :type 'boolean)
  883. (defcustom org-agenda-menu-two-columns nil
  884. "Non-nil means, use two columns to show custom commands in the dispatcher.
  885. If you use this, you probably want to set `org-agenda-menu-show-matcher'
  886. to nil."
  887. :group 'org-agenda
  888. :version "24.1"
  889. :type 'boolean)
  890. (defcustom org-agenda-finalize-hook nil
  891. "Hook run just before displaying an agenda buffer.
  892. The buffer is still writable when the hook is called.
  893. You can modify some of the buffer substrings but you should be
  894. extra careful not to modify the text properties of the agenda
  895. headlines as the agenda display heavily relies on them."
  896. :group 'org-agenda-startup
  897. :type 'hook)
  898. (defcustom org-agenda-mouse-1-follows-link nil
  899. "Non-nil means mouse-1 on a link will follow the link in the agenda.
  900. A longer mouse click will still set point. Needs to be set
  901. before org.el is loaded."
  902. :group 'org-agenda-startup
  903. :type 'boolean)
  904. (defcustom org-agenda-start-with-follow-mode nil
  905. "The initial value of follow mode in a newly created agenda window."
  906. :group 'org-agenda-startup
  907. :type 'boolean)
  908. (defcustom org-agenda-follow-indirect nil
  909. "Non-nil means `org-agenda-follow-mode' displays only the
  910. current item's tree, in an indirect buffer."
  911. :group 'org-agenda
  912. :version "24.1"
  913. :type 'boolean)
  914. (defcustom org-agenda-show-outline-path t
  915. "Non-nil means show outline path in echo area after line motion."
  916. :group 'org-agenda-startup
  917. :type 'boolean)
  918. (defcustom org-agenda-start-with-entry-text-mode nil
  919. "The initial value of entry-text-mode in a newly created agenda window."
  920. :group 'org-agenda-startup
  921. :type 'boolean)
  922. (defcustom org-agenda-entry-text-maxlines 5
  923. "Number of text lines to be added when `E' is pressed in the agenda.
  924. Note that this variable only used during agenda display. To add entry text
  925. when exporting the agenda, configure the variable
  926. `org-agenda-add-entry-text-maxlines'."
  927. :group 'org-agenda
  928. :type 'integer)
  929. (defcustom org-agenda-entry-text-exclude-regexps nil
  930. "List of regular expressions to clean up entry text.
  931. The complete matches of all regular expressions in this list will be
  932. removed from entry text before it is shown in the agenda."
  933. :group 'org-agenda
  934. :type '(repeat (regexp)))
  935. (defcustom org-agenda-entry-text-leaders " > "
  936. "Text prepended to the entry text in agenda buffers."
  937. :version "24.4"
  938. :package-version '(Org . "8.0")
  939. :group 'org-agenda
  940. :type 'string)
  941. (defvar org-agenda-entry-text-cleanup-hook nil
  942. "Hook that is run after basic cleanup of entry text to be shown in agenda.
  943. This cleanup is done in a temporary buffer, so the function may inspect and
  944. change the entire buffer.
  945. Some default stuff like drawers and scheduling/deadline dates will already
  946. have been removed when this is called, as will any matches for regular
  947. expressions listed in `org-agenda-entry-text-exclude-regexps'.")
  948. (defvar org-agenda-include-inactive-timestamps nil
  949. "Non-nil means include inactive time stamps in agenda.
  950. Dynamically scoped.")
  951. (defgroup org-agenda-windows nil
  952. "Options concerning the windows used by the Agenda in Org Mode."
  953. :tag "Org Agenda Windows"
  954. :group 'org-agenda)
  955. (defcustom org-agenda-window-setup 'reorganize-frame
  956. "How the agenda buffer should be displayed.
  957. Possible values for this option are:
  958. current-window Show agenda in the current window, keeping all other windows.
  959. other-window Use `switch-to-buffer-other-window' to display agenda.
  960. only-window Show agenda, deleting all other windows.
  961. reorganize-frame Show only two windows on the current frame, the current
  962. window and the agenda.
  963. other-frame Use `switch-to-buffer-other-frame' to display agenda.
  964. Also, when exiting the agenda, kill that frame.
  965. See also the variable `org-agenda-restore-windows-after-quit'."
  966. :group 'org-agenda-windows
  967. :type '(choice
  968. (const current-window)
  969. (const other-frame)
  970. (const other-window)
  971. (const only-window)
  972. (const reorganize-frame)))
  973. (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
  974. "The min and max height of the agenda window as a fraction of frame height.
  975. The value of the variable is a cons cell with two numbers between 0 and 1.
  976. It only matters if `org-agenda-window-setup' is `reorganize-frame'."
  977. :group 'org-agenda-windows
  978. :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
  979. (defcustom org-agenda-restore-windows-after-quit nil
  980. "Non-nil means restore window configuration upon exiting agenda.
  981. Before the window configuration is changed for displaying the agenda,
  982. the current status is recorded. When the agenda is exited with
  983. `q' or `x' and this option is set, the old state is restored. If
  984. `org-agenda-window-setup' is `other-frame', the value of this
  985. option will be ignored."
  986. :group 'org-agenda-windows
  987. :type 'boolean)
  988. (defcustom org-agenda-span 'week
  989. "Number of days to include in overview display.
  990. Can be day, week, month, year, or any number of days.
  991. Custom commands can set this variable in the options section."
  992. :group 'org-agenda-daily/weekly
  993. :type '(choice (const :tag "Day" day)
  994. (const :tag "Week" week)
  995. (const :tag "Fortnight" fortnight)
  996. (const :tag "Month" month)
  997. (const :tag "Year" year)
  998. (integer :tag "Custom")))
  999. (defcustom org-agenda-start-on-weekday 1
  1000. "Non-nil means start the overview always on the specified weekday.
  1001. 0 denotes Sunday, 1 denotes Monday, etc.
  1002. When nil, always start on the current day.
  1003. Custom commands can set this variable in the options section."
  1004. :group 'org-agenda-daily/weekly
  1005. :type '(choice (const :tag "Today" nil)
  1006. (integer :tag "Weekday No.")))
  1007. (defcustom org-agenda-show-all-dates t
  1008. "Non-nil means `org-agenda' shows every day in the selected range.
  1009. When nil, only the days which actually have entries are shown."
  1010. :group 'org-agenda-daily/weekly
  1011. :type 'boolean)
  1012. (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
  1013. "Format string for displaying dates in the agenda.
  1014. Used by the daily/weekly agenda. This should be a format string
  1015. understood by `format-time-string', or a function returning the
  1016. formatted date as a string. The function must take a single
  1017. argument, a calendar-style date list like (month day year)."
  1018. :group 'org-agenda-daily/weekly
  1019. :type '(choice
  1020. (string :tag "Format string")
  1021. (function :tag "Function")))
  1022. (defun org-agenda-end-of-line ()
  1023. "Go to the end of visible line."
  1024. (interactive)
  1025. (goto-char (line-end-position)))
  1026. (defun org-agenda-format-date-aligned (date)
  1027. "Format a DATE string for display in the daily/weekly agenda.
  1028. This function makes sure that dates are aligned for easy reading."
  1029. (require 'cal-iso)
  1030. (let* ((dayname (calendar-day-name date))
  1031. (day (cadr date))
  1032. (day-of-week (calendar-day-of-week date))
  1033. (month (car date))
  1034. (monthname (calendar-month-name month))
  1035. (year (nth 2 date))
  1036. (iso-week (org-days-to-iso-week
  1037. (calendar-absolute-from-gregorian date)))
  1038. (weekyear (cond ((and (= month 1) (>= iso-week 52))
  1039. (1- year))
  1040. ((and (= month 12) (<= iso-week 1))
  1041. (1+ year))
  1042. (t year)))
  1043. (weekstring (if (= day-of-week 1)
  1044. (format " W%02d" iso-week)
  1045. "")))
  1046. (format "%-10s %2d %s %4d%s"
  1047. dayname day monthname year weekstring)))
  1048. (defcustom org-agenda-time-leading-zero nil
  1049. "Non-nil means use leading zero for military times in agenda.
  1050. For example, 9:30am would become 09:30 rather than 9:30."
  1051. :group 'org-agenda-daily/weekly
  1052. :version "24.1"
  1053. :type 'boolean)
  1054. (defcustom org-agenda-timegrid-use-ampm nil
  1055. "When set, show AM/PM style timestamps on the timegrid."
  1056. :group 'org-agenda
  1057. :version "24.1"
  1058. :type 'boolean)
  1059. (defun org-agenda-time-of-day-to-ampm (time)
  1060. "Convert TIME of a string like \"13:45\" to an AM/PM style time string."
  1061. (let* ((hour-number (string-to-number (substring time 0 -3)))
  1062. (minute (substring time -2))
  1063. (ampm "am"))
  1064. (cond
  1065. ((equal hour-number 12)
  1066. (setq ampm "pm"))
  1067. ((> hour-number 12)
  1068. (setq ampm "pm")
  1069. (setq hour-number (- hour-number 12))))
  1070. (concat
  1071. (if org-agenda-time-leading-zero
  1072. (format "%02d" hour-number)
  1073. (format "%02s" (number-to-string hour-number)))
  1074. ":" minute ampm)))
  1075. (defun org-agenda-time-of-day-to-ampm-maybe (time)
  1076. "Conditionally convert TIME to AM/PM format based on `org-agenda-timegrid-use-ampm'."
  1077. (if org-agenda-timegrid-use-ampm
  1078. (org-agenda-time-of-day-to-ampm time)
  1079. time))
  1080. (defcustom org-agenda-weekend-days '(6 0)
  1081. "Which days are weekend?
  1082. These days get the special face `org-agenda-date-weekend' in the agenda."
  1083. :group 'org-agenda-daily/weekly
  1084. :type '(set :greedy t
  1085. (const :tag "Monday" 1)
  1086. (const :tag "Tuesday" 2)
  1087. (const :tag "Wednesday" 3)
  1088. (const :tag "Thursday" 4)
  1089. (const :tag "Friday" 5)
  1090. (const :tag "Saturday" 6)
  1091. (const :tag "Sunday" 0)))
  1092. (defcustom org-agenda-move-date-from-past-immediately-to-today t
  1093. "Non-nil means jump to today when moving a past date forward in time.
  1094. When using S-right in the agenda to move a date forward, and the date
  1095. stamp currently points to the past, the first key press will move it
  1096. to today. When nil, just move one day forward even if the date stays
  1097. in the past."
  1098. :group 'org-agenda-daily/weekly
  1099. :version "24.1"
  1100. :type 'boolean)
  1101. (defcustom org-agenda-include-diary nil
  1102. "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
  1103. Custom commands can set this variable in the options section."
  1104. :group 'org-agenda-daily/weekly
  1105. :type 'boolean)
  1106. (defcustom org-agenda-include-deadlines t
  1107. "If non-nil, include entries within their deadline warning period.
  1108. Custom commands can set this variable in the options section."
  1109. :group 'org-agenda-daily/weekly
  1110. :version "24.1"
  1111. :type 'boolean)
  1112. (defcustom org-agenda-show-future-repeats t
  1113. "Non-nil shows repeated entries in the future part of the agenda.
  1114. When set to the symbol `next' only the first future repeat is shown."
  1115. :group 'org-agenda-daily/weekly
  1116. :type '(choice
  1117. (const :tag "Show all repeated entries" t)
  1118. (const :tag "Show next repeated entry" next)
  1119. (const :tag "Do not show repeated entries" nil))
  1120. :version "26.1"
  1121. :package-version '(Org . "9.1")
  1122. :safe #'symbolp)
  1123. (defcustom org-agenda-prefer-last-repeat nil
  1124. "Non-nil sets date for repeated entries to their last repeat.
  1125. When nil, display SCHEDULED and DEADLINE dates at their base
  1126. date, and in today's agenda, as a reminder. Display plain
  1127. time-stamps, on the other hand, at every repeat date in the past
  1128. in addition to the base date.
  1129. When non-nil, show a repeated entry at its latest repeat date,
  1130. possibly being today even if it wasn't marked as done. This
  1131. setting is useful if you do not always mark repeated entries as
  1132. done and, yet, consider that reaching repeat date starts the task
  1133. anew.
  1134. When set to a list of strings, prefer last repeats only for
  1135. entries with these TODO keywords."
  1136. :group 'org-agenda-daily/weekly
  1137. :type '(choice
  1138. (const :tag "Prefer last repeat" t)
  1139. (const :tag "Prefer base date" nil)
  1140. (repeat :tag "Prefer last repeat for entries with these TODO keywords"
  1141. (string :tag "TODO keyword")))
  1142. :version "26.1"
  1143. :package-version '(Org . "9.1")
  1144. :safe (lambda (x) (or (booleanp x) (consp x))))
  1145. (defcustom org-scheduled-past-days 10000
  1146. "Number of days to continue listing scheduled items not marked DONE.
  1147. When an item is scheduled on a date, it shows up in the agenda on
  1148. this day and will be listed until it is marked done or for the
  1149. number of days given here."
  1150. :group 'org-agenda-daily/weekly
  1151. :type 'integer
  1152. :safe 'integerp)
  1153. (defcustom org-deadline-past-days 10000
  1154. "Number of days to warn about missed deadlines.
  1155. When an item has deadline on a date, it shows up in the agenda on
  1156. this day and will appear as a reminder until it is marked DONE or
  1157. for the number of days given here."
  1158. :group 'org-agenda-daily/weekly
  1159. :type 'integer
  1160. :version "26.1"
  1161. :package-version '(Org . "9.1")
  1162. :safe 'integerp)
  1163. (defcustom org-agenda-log-mode-items '(closed clock)
  1164. "List of items that should be shown in agenda log mode.
  1165. \\<org-agenda-mode-map>\
  1166. This list may contain the following symbols:
  1167. closed Show entries that have been closed on that day.
  1168. clock Show entries that have received clocked time on that day.
  1169. state Show all logged state changes.
  1170. Note that instead of changing this variable, you can also press \
  1171. `\\[universal-argument] \\[org-agenda-log-mode]' in
  1172. the agenda to display all available LOG items temporarily."
  1173. :group 'org-agenda-daily/weekly
  1174. :type '(set :greedy t (const closed) (const clock) (const state)))
  1175. (defcustom org-agenda-clock-consistency-checks
  1176. '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
  1177. :gap-ok-around ("4:00")
  1178. :default-face ((:background "DarkRed") (:foreground "white"))
  1179. :overlap-face nil :gap-face nil :no-end-time-face nil
  1180. :long-face nil :short-face nil)
  1181. "This is a property list, with the following keys:
  1182. :max-duration Mark clocking chunks that are longer than this time.
  1183. This is a time string like \"HH:MM\", or the number
  1184. of minutes as an integer.
  1185. :min-duration Mark clocking chunks that are shorter that this.
  1186. This is a time string like \"HH:MM\", or the number
  1187. of minutes as an integer.
  1188. :max-gap Mark gaps between clocking chunks that are longer than
  1189. this duration. A number of minutes, or a string
  1190. like \"HH:MM\".
  1191. :gap-ok-around List of times during the day which are usually not working
  1192. times. When a gap is detected, but the gap contains any
  1193. of these times, the gap is *not* reported. For example,
  1194. if this is (\"4:00\" \"13:00\") then gaps that contain
  1195. 4:00 in the morning (i.e. the night) and 13:00
  1196. (i.e. a typical lunch time) do not cause a warning.
  1197. You should have at least one time during the night in this
  1198. list, or otherwise the first task each morning will trigger
  1199. a warning because it follows a long gap.
  1200. Furthermore, the following properties can be used to define faces for
  1201. issue display.
  1202. :default-face the default face, if the specific face is undefined
  1203. :overlap-face face for overlapping clocks
  1204. :gap-face face for gaps between clocks
  1205. :no-end-time-face face for incomplete clocks
  1206. :long-face face for clock intervals that are too long
  1207. :short-face face for clock intervals that are too short"
  1208. :group 'org-agenda-daily/weekly
  1209. :group 'org-clock
  1210. :version "24.1"
  1211. :type 'plist)
  1212. (defcustom org-agenda-log-mode-add-notes t
  1213. "Non-nil means add first line of notes to log entries in agenda views.
  1214. If a log item like a state change or a clock entry is associated with
  1215. notes, the first line of these notes will be added to the entry in the
  1216. agenda display."
  1217. :group 'org-agenda-daily/weekly
  1218. :type 'boolean)
  1219. (defcustom org-agenda-start-with-log-mode nil
  1220. "The initial value of log-mode in a newly created agenda window.
  1221. See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
  1222. explanations on the possible values."
  1223. :group 'org-agenda-startup
  1224. :group 'org-agenda-daily/weekly
  1225. :type '(choice (const :tag "Don't show log items" nil)
  1226. (const :tag "Show only log items" only)
  1227. (const :tag "Show all possible log items" clockcheck)
  1228. (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
  1229. (choice (const :tag "Show closed log items" closed)
  1230. (const :tag "Show clocked log items" clock)
  1231. (const :tag "Show all logged state changes" state)))))
  1232. (defcustom org-agenda-start-with-clockreport-mode nil
  1233. "The initial value of clockreport-mode in a newly created agenda window."
  1234. :group 'org-agenda-startup
  1235. :group 'org-agenda-daily/weekly
  1236. :type 'boolean)
  1237. (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
  1238. "Property list with parameters for the clocktable in clockreport mode.
  1239. This is the display mode that shows a clock table in the daily/weekly
  1240. agenda, the properties for this dynamic block can be set here.
  1241. The usual clocktable parameters are allowed here, but you cannot set
  1242. the properties :name, :tstart, :tend, :block, and :scope - these will
  1243. be overwritten to make sure the content accurately reflects the
  1244. current display in the agenda."
  1245. :group 'org-agenda-daily/weekly
  1246. :type 'plist)
  1247. (defvaralias 'org-agenda-search-view-search-words-only
  1248. 'org-agenda-search-view-always-boolean)
  1249. (defcustom org-agenda-search-view-always-boolean nil
  1250. "Non-nil means the search string is interpreted as individual parts.
  1251. The search string for search view can either be interpreted as a phrase,
  1252. or as a list of snippets that define a boolean search for a number of
  1253. strings.
  1254. When this is non-nil, the string will be split on whitespace, and each
  1255. snippet will be searched individually, and all must match in order to
  1256. select an entry. A snippet is then a single string of non-white
  1257. characters, or a string in double quotes, or a regexp in {} braces.
  1258. If a snippet is preceded by \"-\", the snippet must *not* match.
  1259. \"+\" is syntactic sugar for positive selection. Each snippet may
  1260. be found as a full word or a partial word, but see the variable
  1261. `org-agenda-search-view-force-full-words'.
  1262. When this is nil, search will look for the entire search phrase as one,
  1263. with each space character matching any amount of whitespace, including
  1264. line breaks.
  1265. Even when this is nil, you can still switch to Boolean search dynamically
  1266. by preceding the first snippet with \"+\" or \"-\". If the first snippet
  1267. is a regexp marked with braces like \"{abc}\", this will also switch to
  1268. boolean search."
  1269. :group 'org-agenda-search-view
  1270. :version "24.1"
  1271. :type 'boolean)
  1272. (defcustom org-agenda-search-view-force-full-words nil
  1273. "Non-nil means, search words must be matches as complete words.
  1274. When nil, they may also match part of a word."
  1275. :group 'org-agenda-search-view
  1276. :version "24.1"
  1277. :type 'boolean)
  1278. (defcustom org-agenda-search-view-max-outline-level 0
  1279. "Maximum outline level to display in search view.
  1280. E.g. when this is set to 1, the search view will only
  1281. show headlines of level 1. When set to 0, the default
  1282. value, don't limit agenda view by outline level."
  1283. :group 'org-agenda-search-view
  1284. :version "26.1"
  1285. :package-version '(Org . "8.3")
  1286. :type 'integer)
  1287. (defgroup org-agenda-time-grid nil
  1288. "Options concerning the time grid in the Org Agenda."
  1289. :tag "Org Agenda Time Grid"
  1290. :group 'org-agenda)
  1291. (defcustom org-agenda-search-headline-for-time t
  1292. "Non-nil means search headline for a time-of-day.
  1293. If the headline contains a time-of-day in one format or another, it will
  1294. be used to sort the entry into the time sequence of items for a day.
  1295. Some people have time stamps in the headline that refer to the creation
  1296. time or so, and then this produces an unwanted side effect. If this is
  1297. the case for your, use this variable to turn off searching the headline
  1298. for a time."
  1299. :group 'org-agenda-time-grid
  1300. :type 'boolean)
  1301. (defcustom org-agenda-use-time-grid t
  1302. "Non-nil means show a time grid in the agenda schedule.
  1303. A time grid is a set of lines for specific times (like every two hours between
  1304. 8:00 and 20:00). The items scheduled for a day at specific times are
  1305. sorted in between these lines.
  1306. For details about when the grid will be shown, and what it will look like, see
  1307. the variable `org-agenda-time-grid'."
  1308. :group 'org-agenda-time-grid
  1309. :type 'boolean)
  1310. (defcustom org-agenda-time-grid
  1311. '((daily today require-timed)
  1312. (800 1000 1200 1400 1600 1800 2000)
  1313. "......"
  1314. "----------------")
  1315. "The settings for time grid for agenda display.
  1316. This is a list of four items. The first item is again a list. It contains
  1317. symbols specifying conditions when the grid should be displayed:
  1318. daily if the agenda shows a single day
  1319. weekly if the agenda shows an entire week
  1320. today show grid on current date, independent of daily/weekly display
  1321. require-timed show grid only if at least one item has a time specification
  1322. remove-match skip grid times already present in an entry
  1323. The second item is a list of integers, indicating the times that
  1324. should have a grid line.
  1325. The third item is a string which will be placed right after the
  1326. times that have a grid line.
  1327. The fourth item is a string placed after the grid times. This
  1328. will align with agenda items."
  1329. :group 'org-agenda-time-grid
  1330. :type
  1331. '(list
  1332. (set :greedy t :tag "Grid Display Options"
  1333. (const :tag "Show grid in single day agenda display" daily)
  1334. (const :tag "Show grid in weekly agenda display" weekly)
  1335. (const :tag "Always show grid for today" today)
  1336. (const :tag "Show grid only if any timed entries are present"
  1337. require-timed)
  1338. (const :tag "Skip grid times already present in an entry"
  1339. remove-match))
  1340. (repeat :tag "Grid Times" (integer :tag "Time"))
  1341. (string :tag "Grid String (after agenda times)")
  1342. (string :tag "Grid String (aligns with agenda items)")))
  1343. (defcustom org-agenda-show-current-time-in-grid t
  1344. "Non-nil means show the current time in the time grid."
  1345. :group 'org-agenda-time-grid
  1346. :version "24.1"
  1347. :type 'boolean)
  1348. (defcustom org-agenda-current-time-string
  1349. "now - - - - - - - - - - - - - - - - - - - - - - - - -"
  1350. "The string for the current time marker in the agenda."
  1351. :group 'org-agenda-time-grid
  1352. :version "24.1"
  1353. :type 'string)
  1354. (defgroup org-agenda-sorting nil
  1355. "Options concerning sorting in the Org Agenda."
  1356. :tag "Org Agenda Sorting"
  1357. :group 'org-agenda)
  1358. (defcustom org-agenda-sorting-strategy
  1359. '((agenda habit-down time-up priority-down category-keep)
  1360. (todo priority-down category-keep)
  1361. (tags priority-down category-keep)
  1362. (search category-keep))
  1363. "Sorting structure for the agenda items of a single day.
  1364. This is a list of symbols which will be used in sequence to determine
  1365. if an entry should be listed before another entry. The following
  1366. symbols are recognized:
  1367. time-up Put entries with time-of-day indications first, early first.
  1368. time-down Put entries with time-of-day indications first, late first.
  1369. timestamp-up Sort by any timestamp, early first.
  1370. timestamp-down Sort by any timestamp, late first.
  1371. scheduled-up Sort by scheduled timestamp, early first.
  1372. scheduled-down Sort by scheduled timestamp, late first.
  1373. deadline-up Sort by deadline timestamp, early first.
  1374. deadline-down Sort by deadline timestamp, late first.
  1375. ts-up Sort by active timestamp, early first.
  1376. ts-down Sort by active timestamp, late first.
  1377. tsia-up Sort by inactive timestamp, early first.
  1378. tsia-down Sort by inactive timestamp, late first.
  1379. category-keep Keep the default order of categories, corresponding to the
  1380. sequence in `org-agenda-files'.
  1381. category-up Sort alphabetically by category, A-Z.
  1382. category-down Sort alphabetically by category, Z-A.
  1383. tag-up Sort alphabetically by last tag, A-Z.
  1384. tag-down Sort alphabetically by last tag, Z-A.
  1385. priority-up Sort numerically by priority, high priority last.
  1386. priority-down Sort numerically by priority, high priority first.
  1387. todo-state-up Sort by todo state, tasks that are done last.
  1388. todo-state-down Sort by todo state, tasks that are done first.
  1389. effort-up Sort numerically by estimated effort, high effort last.
  1390. effort-down Sort numerically by estimated effort, high effort first.
  1391. user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
  1392. user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
  1393. habit-up Put entries that are habits first.
  1394. habit-down Put entries that are habits last.
  1395. alpha-up Sort headlines alphabetically.
  1396. alpha-down Sort headlines alphabetically, reversed.
  1397. The different possibilities will be tried in sequence, and testing stops
  1398. if one comparison returns a \"not-equal\". For example, the default
  1399. '(time-up category-keep priority-down)
  1400. means: Pull out all entries having a specified time of day and sort them,
  1401. in order to make a time schedule for the current day the first thing in the
  1402. agenda listing for the day. Of the entries without a time indication, keep
  1403. the grouped in categories, don't sort the categories, but keep them in
  1404. the sequence given in `org-agenda-files'. Within each category sort by
  1405. priority.
  1406. Leaving out `category-keep' would mean that items will be sorted across
  1407. categories by priority.
  1408. Instead of a single list, this can also be a set of list for specific
  1409. contents, with a context symbol in the car of the list, any of
  1410. `agenda', `todo', `tags', `search' for the corresponding agenda views.
  1411. Custom commands can bind this variable in the options section."
  1412. :group 'org-agenda-sorting
  1413. :type `(choice
  1414. (repeat :tag "General" ,org-sorting-choice)
  1415. (list :tag "Individually"
  1416. (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
  1417. (repeat ,org-sorting-choice))
  1418. (cons (const :tag "Strategy for TODO lists" todo)
  1419. (repeat ,org-sorting-choice))
  1420. (cons (const :tag "Strategy for Tags matches" tags)
  1421. (repeat ,org-sorting-choice))
  1422. (cons (const :tag "Strategy for search matches" search)
  1423. (repeat ,org-sorting-choice)))))
  1424. (defcustom org-agenda-cmp-user-defined nil
  1425. "A function to define the comparison `user-defined'.
  1426. This function must receive two arguments, agenda entry a and b.
  1427. If a>b, return +1. If a<b, return -1. If they are equal as seen by
  1428. the user comparison, return nil.
  1429. When this is defined, you can make `user-defined-up' and `user-defined-down'
  1430. part of an agenda sorting strategy."
  1431. :group 'org-agenda-sorting
  1432. :type 'symbol)
  1433. (defcustom org-sort-agenda-notime-is-late t
  1434. "Non-nil means items without time are considered late.
  1435. This is only relevant for sorting. When t, items which have no explicit
  1436. time like 15:30 will be considered as 99:01, i.e. later than any items which
  1437. do have a time. When nil, the default time is before 0:00. You can use this
  1438. option to decide if the schedule for today should come before or after timeless
  1439. agenda entries."
  1440. :group 'org-agenda-sorting
  1441. :type 'boolean)
  1442. (defcustom org-sort-agenda-noeffort-is-high t
  1443. "Non-nil means items without effort estimate are sorted as high effort.
  1444. This also applies when filtering an agenda view with respect to the
  1445. < or > effort operator. Then, tasks with no effort defined will be treated
  1446. as tasks with high effort.
  1447. When nil, such items are sorted as 0 minutes effort."
  1448. :group 'org-agenda-sorting
  1449. :type 'boolean)
  1450. (defgroup org-agenda-line-format nil
  1451. "Options concerning the entry prefix in the Org agenda display."
  1452. :tag "Org Agenda Line Format"
  1453. :group 'org-agenda)
  1454. (defcustom org-agenda-prefix-format
  1455. '((agenda . " %i %-12:c%?-12t% s")
  1456. (todo . " %i %-12:c")
  1457. (tags . " %i %-12:c")
  1458. (search . " %i %-12:c"))
  1459. "Format specifications for the prefix of items in the agenda views.
  1460. An alist with one entry per agenda type. The keys of the
  1461. sublists are `agenda', `todo', `search' and `tags'. The values
  1462. are format strings.
  1463. This format works similar to a printf format, with the following meaning:
  1464. %c the category of the item, \"Diary\" for entries from the diary,
  1465. or as given by the CATEGORY keyword or derived from the file name
  1466. %e the effort required by the item
  1467. %l the level of the item (insert X space(s) if item is of level X)
  1468. %i the icon category of the item, see `org-agenda-category-icon-alist'
  1469. %T the last tag of the item (ignore inherited tags, which come first)
  1470. %t the HH:MM time-of-day specification if one applies to the entry
  1471. %s Scheduling/Deadline information, a short string
  1472. %b show breadcrumbs, i.e., the names of the higher levels
  1473. %(expression) Eval EXPRESSION and replace the control string
  1474. by the result
  1475. All specifiers work basically like the standard `%s' of printf, but may
  1476. contain two additional characters: a question mark just after the `%'
  1477. and a whitespace/punctuation character just before the final letter.
  1478. If the first character after `%' is a question mark, the entire field
  1479. will only be included if the corresponding value applies to the current
  1480. entry. This is useful for fields which should have fixed width when
  1481. present, but zero width when absent. For example, \"%?-12t\" will
  1482. result in a 12 character time field if a time of the day is specified,
  1483. but will completely disappear in entries which do not contain a time.
  1484. If there is punctuation or whitespace character just before the
  1485. final format letter, this character will be appended to the field
  1486. value if the value is not empty. For example, the format
  1487. \"%-12:c\" leads to \"Diary: \" if the category is \"Diary\". If
  1488. the category is empty, no additional colon is inserted.
  1489. The default value for the agenda sublist is \" %-12:c%?-12t% s\",
  1490. which means:
  1491. - Indent the line with two space characters
  1492. - Give the category a 12 chars wide field, padded with whitespace on
  1493. the right (because of `-'). Append a colon if there is a category
  1494. (because of `:').
  1495. - If there is a time-of-day, put it into a 12 chars wide field. If no
  1496. time, don't put in an empty field, just skip it (because of '?').
  1497. - Finally, put the scheduling information.
  1498. See also the variables `org-agenda-remove-times-when-in-prefix' and
  1499. `org-agenda-remove-tags'.
  1500. Custom commands can set this variable in the options section."
  1501. :type '(choice
  1502. (string :tag "General format")
  1503. (list :greedy t :tag "View dependent"
  1504. (cons (const agenda) (string :tag "Format"))
  1505. (cons (const todo) (string :tag "Format"))
  1506. (cons (const tags) (string :tag "Format"))
  1507. (cons (const search) (string :tag "Format"))))
  1508. :group 'org-agenda-line-format
  1509. :version "26.1"
  1510. :package-version '(Org . "9.1"))
  1511. (defcustom org-agenda-breadcrumbs-separator "->"
  1512. "The separator of breadcrumbs in agenda lines."
  1513. :group 'org-agenda-line-format
  1514. :package-version '(Org . "9.3")
  1515. :type 'string
  1516. :safe #'stringp)
  1517. (defvar org-prefix-format-compiled nil
  1518. "The compiled prefix format and associated variables.
  1519. This is a list where first element is a list of variable bindings, and second
  1520. element is the compiled format expression. See the variable
  1521. `org-agenda-prefix-format'.")
  1522. (defcustom org-agenda-todo-keyword-format "%-1s"
  1523. "Format for the TODO keyword in agenda lines.
  1524. Set this to something like \"%-12s\" if you want all TODO keywords
  1525. to occupy a fixed space in the agenda display."
  1526. :group 'org-agenda-line-format
  1527. :type 'string)
  1528. (defcustom org-agenda-diary-sexp-prefix nil
  1529. "A regexp that matches part of a diary sexp entry
  1530. which should be treated as scheduling/deadline information in
  1531. `org-agenda'.
  1532. For example, you can use this to extract the `diary-remind-message' from
  1533. `diary-remind' entries."
  1534. :group 'org-agenda-line-format
  1535. :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
  1536. (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
  1537. "Text preceding timerange entries in the agenda view.
  1538. This is a list with two strings. The first applies when the range
  1539. is entirely on one day. The second applies if the range spans several days.
  1540. The strings may have two \"%d\" format specifiers which will be filled
  1541. with the sequence number of the days, and the total number of days in the
  1542. range, respectively."
  1543. :group 'org-agenda-line-format
  1544. :type '(list
  1545. (string :tag "Deadline today ")
  1546. (choice :tag "Deadline relative"
  1547. (string :tag "Format string")
  1548. (function))))
  1549. (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
  1550. "Text preceding scheduled items in the agenda view.
  1551. This is a list with two strings. The first applies when the item is
  1552. scheduled on the current day. The second applies when it has been scheduled
  1553. previously, it may contain a %d indicating that this is the nth time that
  1554. this item is scheduled, due to automatic rescheduling of unfinished items
  1555. for the following day. So this number is one larger than the number of days
  1556. that passed since this item was scheduled first."
  1557. :group 'org-agenda-line-format
  1558. :version "24.4"
  1559. :package-version '(Org . "8.0")
  1560. :type '(list
  1561. (string :tag "Scheduled today ")
  1562. (string :tag "Scheduled previously")))
  1563. (defcustom org-agenda-inactive-leader "["
  1564. "Text preceding item pulled into the agenda by inactive time stamps.
  1565. These entries are added to the agenda when pressing \"[\"."
  1566. :group 'org-agenda-line-format
  1567. :version "24.1"
  1568. :type 'string)
  1569. (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: " "%2d d. ago: ")
  1570. "Text preceding deadline items in the agenda view.
  1571. This is a list with three strings. The first applies when the item has its
  1572. deadline on the current day. The second applies when the deadline is in the
  1573. future, the third one when it is in the past. The strings may contain %d
  1574. to capture the number of days."
  1575. :group 'org-agenda-line-format
  1576. :version "24.4"
  1577. :package-version '(Org . "8.0")
  1578. :type '(list
  1579. (string :tag "Deadline today ")
  1580. (string :tag "Deadline in the future ")
  1581. (string :tag "Deadline in the past ")))
  1582. (defcustom org-agenda-remove-times-when-in-prefix t
  1583. "Non-nil means remove duplicate time specifications in agenda items.
  1584. When the format `org-agenda-prefix-format' contains a `%t' specifier, a
  1585. time-of-day specification in a headline or diary entry is extracted and
  1586. placed into the prefix. If this option is non-nil, the original specification
  1587. \(a timestamp or -range, or just a plain time(range) specification like
  1588. 11:30-4pm) will be removed for agenda display. This makes the agenda less
  1589. cluttered.
  1590. The option can be t or nil. It may also be the symbol `beg', indicating
  1591. that the time should only be removed when it is located at the beginning of
  1592. the headline/diary entry."
  1593. :group 'org-agenda-line-format
  1594. :type '(choice
  1595. (const :tag "Always" t)
  1596. (const :tag "Never" nil)
  1597. (const :tag "When at beginning of entry" beg)))
  1598. (defcustom org-agenda-remove-timeranges-from-blocks nil
  1599. "Non-nil means remove time ranges specifications in agenda
  1600. items that span on several days."
  1601. :group 'org-agenda-line-format
  1602. :version "24.1"
  1603. :type 'boolean)
  1604. (defcustom org-agenda-default-appointment-duration nil
  1605. "Default duration for appointments that only have a starting time.
  1606. When nil, no duration is specified in such cases.
  1607. When non-nil, this must be the number of minutes, e.g. 60 for one hour."
  1608. :group 'org-agenda-line-format
  1609. :type '(choice
  1610. (integer :tag "Minutes")
  1611. (const :tag "No default duration")))
  1612. (defcustom org-agenda-show-inherited-tags t
  1613. "Non-nil means show inherited tags in each agenda line.
  1614. When this option is set to `always', it takes precedence over
  1615. `org-agenda-use-tag-inheritance' and inherited tags are shown
  1616. in every agenda.
  1617. When this option is set to t (the default), inherited tags are
  1618. shown when they are available, i.e. when the value of
  1619. `org-agenda-use-tag-inheritance' enables tag inheritance for the
  1620. given agenda type.
  1621. This can be set to a list of agenda types in which the agenda
  1622. must display the inherited tags. Available types are `todo',
  1623. `agenda' and `search'.
  1624. When set to nil, never show inherited tags in agenda lines."
  1625. :group 'org-agenda-line-format
  1626. :group 'org-agenda
  1627. :version "24.3"
  1628. :type '(choice
  1629. (const :tag "Show inherited tags when available" t)
  1630. (const :tag "Always show inherited tags" always)
  1631. (repeat :tag "Show inherited tags only in selected agenda types"
  1632. (symbol :tag "Agenda type"))))
  1633. (defcustom org-agenda-use-tag-inheritance '(todo search agenda)
  1634. "List of agenda view types where to use tag inheritance.
  1635. In tags/tags-todo/tags-tree agenda views, tag inheritance is
  1636. controlled by `org-use-tag-inheritance'. In other agenda types,
  1637. `org-use-tag-inheritance' is not used for the selection of the
  1638. agenda entries. Still, you may want the agenda to be aware of
  1639. the inherited tags anyway, e.g. for later tag filtering.
  1640. Allowed value are `todo', `search' and `agenda'.
  1641. This variable has no effect if `org-agenda-show-inherited-tags'
  1642. is set to `always'. In that case, the agenda is aware of those
  1643. tags.
  1644. The default value sets tags in every agenda type. Setting this
  1645. option to nil will speed up non-tags agenda view a lot."
  1646. :group 'org-agenda
  1647. :version "26.1"
  1648. :package-version '(Org . "9.1")
  1649. :type '(choice
  1650. (const :tag "Use tag inheritance in all agenda types" t)
  1651. (repeat :tag "Use tag inheritance in selected agenda types"
  1652. (symbol :tag "Agenda type"))))
  1653. (defcustom org-agenda-hide-tags-regexp nil
  1654. "Regular expression used to filter away specific tags in agenda views.
  1655. This means that these tags will be present, but not be shown in the agenda
  1656. line. Secondary filtering will still work on the hidden tags.
  1657. Nil means don't hide any tags."
  1658. :group 'org-agenda-line-format
  1659. :type '(choice
  1660. (const :tag "Hide none" nil)
  1661. (string :tag "Regexp ")))
  1662. (defvaralias 'org-agenda-remove-tags-when-in-prefix
  1663. 'org-agenda-remove-tags)
  1664. (defcustom org-agenda-remove-tags nil
  1665. "Non-nil means remove the tags from the headline copy in the agenda.
  1666. When this is the symbol `prefix', only remove tags when
  1667. `org-agenda-prefix-format' contains a `%T' specifier."
  1668. :group 'org-agenda-line-format
  1669. :type '(choice
  1670. (const :tag "Always" t)
  1671. (const :tag "Never" nil)
  1672. (const :tag "When prefix format contains %T" prefix)))
  1673. (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column)
  1674. (defcustom org-agenda-tags-column 'auto
  1675. "Shift tags in agenda items to this column.
  1676. If set to `auto', tags will be automatically aligned to the right
  1677. edge of the window.
  1678. If set to a positive number, tags will be left-aligned to that
  1679. column. If set to a negative number, tags will be right-aligned
  1680. to that column. For example, -80 works well for a normal 80
  1681. character screen."
  1682. :group 'org-agenda-line-format
  1683. :type '(choice
  1684. (const :tag "Automatically align to right edge of window" auto)
  1685. (integer :tag "Specific column" -80))
  1686. :package-version '(Org . "9.1")
  1687. :version "26.1")
  1688. (defcustom org-agenda-fontify-priorities 'cookies
  1689. "Non-nil means highlight low and high priorities in agenda.
  1690. When t, the highest priority entries are bold, lowest priority italic.
  1691. However, settings in `org-priority-faces' will overrule these faces.
  1692. When this variable is the symbol `cookies', only fontify the
  1693. cookies, not the entire task.
  1694. This may also be an association list of priority faces, whose
  1695. keys are the character values of `org-highest-priority',
  1696. `org-default-priority', and `org-lowest-priority' (the default values
  1697. are ?A, ?B, and ?C, respectively). The face may be a named face, a
  1698. color as a string, or a list like `(:background \"Red\")'.
  1699. If it is a color, the variable `org-faces-easy-properties'
  1700. determines if it is a foreground or a background color."
  1701. :group 'org-agenda-line-format
  1702. :type '(choice
  1703. (const :tag "Never" nil)
  1704. (const :tag "Defaults" t)
  1705. (const :tag "Cookies only" cookies)
  1706. (repeat :tag "Specify"
  1707. (list (character :tag "Priority" :value ?A)
  1708. (choice :tag "Face "
  1709. (string :tag "Color")
  1710. (sexp :tag "Face"))))))
  1711. (defcustom org-agenda-day-face-function nil
  1712. "Function called to determine what face should be used to display a day.
  1713. The only argument passed to that function is the day. It should
  1714. returns a face, or nil if does not want to specify a face and let
  1715. the normal rules apply."
  1716. :group 'org-agenda-line-format
  1717. :version "24.1"
  1718. :type '(choice (const nil) (function)))
  1719. (defcustom org-agenda-category-icon-alist nil
  1720. "Alist of category icon to be displayed in agenda views.
  1721. Each entry should have the following format:
  1722. (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
  1723. Where CATEGORY-REGEXP is a regexp matching the categories where
  1724. the icon should be displayed.
  1725. FILE-OR-DATA either a file path or a string containing image data.
  1726. The other fields can be omitted safely if not needed:
  1727. TYPE indicates the image type.
  1728. DATA-P is a boolean indicating whether the FILE-OR-DATA string is
  1729. image data.
  1730. PROPS are additional image attributes to assign to the image,
  1731. like, e.g. `:ascent center'.
  1732. (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
  1733. If you want to set the display properties yourself, just put a
  1734. list as second element:
  1735. (CATEGORY-REGEXP (MY PROPERTY LIST))
  1736. For example, to display a 16px horizontal space for Emacs
  1737. category, you can use:
  1738. (\"Emacs\" \\='(space . (:width (16))))"
  1739. :group 'org-agenda-line-format
  1740. :version "24.1"
  1741. :type '(alist :key-type (string :tag "Regexp matching category")
  1742. :value-type (choice (list :tag "Icon"
  1743. (string :tag "File or data")
  1744. (symbol :tag "Type")
  1745. (boolean :tag "Data?")
  1746. (repeat :tag "Extra image properties" :inline t symbol))
  1747. (list :tag "Display properties" sexp))))
  1748. (defgroup org-agenda-column-view nil
  1749. "Options concerning column view in the agenda."
  1750. :tag "Org Agenda Column View"
  1751. :group 'org-agenda)
  1752. (defcustom org-agenda-view-columns-initially nil
  1753. "When non-nil, switch to columns view right after creating the agenda."
  1754. :group 'org-agenda-column-view
  1755. :type 'boolean
  1756. :version "26.1"
  1757. :package-version '(Org . "9.0")
  1758. :safe #'booleanp)
  1759. (defcustom org-agenda-columns-show-summaries t
  1760. "Non-nil means show summaries for columns displayed in the agenda view."
  1761. :group 'org-agenda-column-view
  1762. :type 'boolean)
  1763. (defcustom org-agenda-columns-compute-summary-properties t
  1764. "Non-nil means recompute all summary properties before column view.
  1765. When column view in the agenda is listing properties that have a summary
  1766. operator, it can go to all relevant buffers and recompute the summaries
  1767. there. This can mean overhead for the agenda column view, but is necessary
  1768. to have thing up to date.
  1769. As a special case, a CLOCKSUM property also makes sure that the clock
  1770. computations are current."
  1771. :group 'org-agenda-column-view
  1772. :type 'boolean)
  1773. (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
  1774. "Non-nil means the duration of an appointment will add to day effort.
  1775. The property to which appointment durations will be added is the one given
  1776. in the option `org-effort-property'. If an appointment does not have
  1777. an end time, `org-agenda-default-appointment-duration' will be used. If that
  1778. is not set, an appointment without end time will not contribute to the time
  1779. estimate."
  1780. :group 'org-agenda-column-view
  1781. :type 'boolean)
  1782. (defcustom org-agenda-auto-exclude-function nil
  1783. "A function called with a tag to decide if it is filtered on \
  1784. \\<org-agenda-mode-map>`\\[org-agenda-filter-by-tag] RET'.
  1785. The sole argument to the function, which is called once for each
  1786. possible tag, is a string giving the name of the tag. The
  1787. function should return either nil if the tag should be included
  1788. as normal, \"-<TAG>\" to exclude the tag, or \"+<TAG>\" to exclude
  1789. lines not carrying this tag.
  1790. Note that for the purpose of tag filtering, only the lower-case version of
  1791. all tags will be considered, so that this function will only ever see
  1792. the lower-case version of all tags."
  1793. :group 'org-agenda
  1794. :type '(choice (const nil) (function)))
  1795. (defcustom org-agenda-bulk-custom-functions nil
  1796. "Alist of characters and custom functions for bulk actions.
  1797. For example, this value makes those two functions available:
  1798. \\='((?R set-category)
  1799. (?C bulk-cut))
  1800. With selected entries in an agenda buffer, `B R' will call
  1801. the custom function `set-category' on the selected entries.
  1802. Note that functions in this alist don't need to be quoted."
  1803. :type '(alist :key-type character :value-type (group function))
  1804. :version "24.1"
  1805. :group 'org-agenda)
  1806. (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
  1807. "Execute BODY with point at location given by `org-hd-marker' property.
  1808. If STRING is non-nil, the text property will be fetched from position 0
  1809. in that string. If STRING is nil, it will be fetched from the beginning
  1810. of the current line."
  1811. (org-with-gensyms (marker)
  1812. `(let ((,marker (get-text-property (if ,string 0 (point-at-bol))
  1813. 'org-hd-marker ,string)))
  1814. (with-current-buffer (marker-buffer ,marker)
  1815. (save-excursion
  1816. (goto-char ,marker)
  1817. ,@body)))))
  1818. (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
  1819. (defun org-add-agenda-custom-command (entry)
  1820. "Replace or add a command in `org-agenda-custom-commands'.
  1821. This is mostly for hacking and trying a new command - once the command
  1822. works you probably want to add it to `org-agenda-custom-commands' for good."
  1823. (let ((ass (assoc (car entry) org-agenda-custom-commands)))
  1824. (if ass
  1825. (setcdr ass (cdr entry))
  1826. (push entry org-agenda-custom-commands))))
  1827. (defmacro org-agenda--insert-overriding-header (default)
  1828. "Insert header into agenda view.
  1829. The inserted header depends on `org-agenda-overriding-header'.
  1830. If the empty string, don't insert a header. If any other string,
  1831. insert it as a header. If nil, insert DEFAULT, which should
  1832. evaluate to a string."
  1833. (declare (debug (form)) (indent defun))
  1834. `(cond
  1835. ((not org-agenda-overriding-header) (insert ,default))
  1836. ((equal org-agenda-overriding-header "") nil)
  1837. ((stringp org-agenda-overriding-header)
  1838. (insert (propertize org-agenda-overriding-header
  1839. 'face 'org-agenda-structure)
  1840. "\n"))
  1841. (t (user-error "Invalid value for `org-agenda-overriding-header': %S"
  1842. org-agenda-overriding-header))))
  1843. ;;; Define the org-agenda-mode
  1844. (defvaralias 'org-agenda-keymap 'org-agenda-mode-map)
  1845. (defvar org-agenda-mode-map (make-sparse-keymap)
  1846. "Keymap for `org-agenda-mode'.")
  1847. (defvar org-agenda-menu) ; defined later in this file.
  1848. (defvar org-agenda-restrict nil) ; defined later in this file.
  1849. (defvar org-agenda-follow-mode nil)
  1850. (defvar org-agenda-entry-text-mode nil)
  1851. (defvar org-agenda-clockreport-mode nil)
  1852. (defvar org-agenda-show-log nil
  1853. "When non-nil, show the log in the agenda.
  1854. Do not set this directly; instead use
  1855. `org-agenda-start-with-log-mode', which see.")
  1856. (defvar org-agenda-redo-command nil)
  1857. (defvar org-agenda-query-string nil)
  1858. (defvar org-agenda-mode-hook nil
  1859. "Hook run after `org-agenda-mode' is turned on.
  1860. The buffer is still writable when this hook is called.")
  1861. (defvar org-agenda-type nil)
  1862. (defvar org-agenda-force-single-file nil)
  1863. (defvar org-agenda-bulk-marked-entries nil
  1864. "List of markers that refer to marked entries in the agenda.")
  1865. (defvar org-agenda-current-date nil
  1866. "Active date when building the agenda.")
  1867. ;;; Multiple agenda buffers support
  1868. (defcustom org-agenda-sticky nil
  1869. "Non-nil means agenda q key will bury agenda buffers.
  1870. Agenda commands will then show existing buffer instead of generating new ones.
  1871. When nil, `q' will kill the single agenda buffer."
  1872. :group 'org-agenda
  1873. :version "24.3"
  1874. :type 'boolean)
  1875. ;;;###autoload
  1876. (defun org-toggle-sticky-agenda (&optional arg)
  1877. "Toggle `org-agenda-sticky'."
  1878. (interactive "P")
  1879. (let ((new-value (if arg
  1880. (> (prefix-numeric-value arg) 0)
  1881. (not org-agenda-sticky))))
  1882. (if (equal new-value org-agenda-sticky)
  1883. (and (called-interactively-p 'interactive)
  1884. (message "Sticky agenda was already %s"
  1885. (if org-agenda-sticky "enabled" "disabled")))
  1886. (setq org-agenda-sticky new-value)
  1887. (org-agenda-kill-all-agenda-buffers)
  1888. (and (called-interactively-p 'interactive)
  1889. (message "Sticky agenda %s"
  1890. (if org-agenda-sticky "enabled" "disabled"))))))
  1891. (defvar org-agenda-buffer nil
  1892. "Agenda buffer currently being generated.")
  1893. (defvar org-agenda-last-prefix-arg nil)
  1894. (defvar org-agenda-this-buffer-name nil)
  1895. (defvar org-agenda-doing-sticky-redo nil)
  1896. (defvar org-agenda-this-buffer-is-sticky nil)
  1897. (defvar org-agenda-last-indirect-buffer nil
  1898. "Last buffer loaded by `org-agenda-tree-to-indirect-buffer'.")
  1899. (defconst org-agenda-local-vars
  1900. '(org-agenda-this-buffer-name
  1901. org-agenda-undo-list
  1902. org-agenda-pending-undo-list
  1903. org-agenda-follow-mode
  1904. org-agenda-entry-text-mode
  1905. org-agenda-clockreport-mode
  1906. org-agenda-show-log
  1907. org-agenda-redo-command
  1908. org-agenda-query-string
  1909. org-agenda-type
  1910. org-agenda-bulk-marked-entries
  1911. org-agenda-undo-has-started-in
  1912. org-agenda-info
  1913. org-agenda-pre-window-conf
  1914. org-agenda-columns-active
  1915. org-agenda-tag-filter
  1916. org-agenda-category-filter
  1917. org-agenda-top-headline-filter
  1918. org-agenda-regexp-filter
  1919. org-agenda-effort-filter
  1920. org-agenda-markers
  1921. org-agenda-last-search-view-search-was-boolean
  1922. org-agenda-last-indirect-buffer
  1923. org-agenda-filtered-by-category
  1924. org-agenda-filter-form
  1925. org-agenda-cycle-counter
  1926. org-agenda-last-prefix-arg)
  1927. "Variables that must be local in agenda buffers to allow multiple buffers.")
  1928. (defun org-agenda-mode ()
  1929. "Mode for time-sorted view on action items in Org files.
  1930. The following commands are available:
  1931. \\{org-agenda-mode-map}"
  1932. (interactive)
  1933. (ignore-errors (require 'face-remap))
  1934. (let ((agenda-local-vars-to-keep
  1935. '(text-scale-mode-amount
  1936. text-scale-mode
  1937. text-scale-mode-lighter
  1938. face-remapping-alist))
  1939. (save (buffer-local-variables)))
  1940. (kill-all-local-variables)
  1941. (cl-flet ((reset-saved (var-set)
  1942. "Reset variables in VAR-SET to possibly stored value in SAVE."
  1943. (dolist (elem save)
  1944. (pcase elem
  1945. (`(,var . ,val) ;ignore unbound variables
  1946. (when (and val (memq var var-set))
  1947. (set var val)))))))
  1948. (cond (org-agenda-doing-sticky-redo
  1949. ;; Refreshing sticky agenda-buffer
  1950. ;;
  1951. ;; Preserve the value of `org-agenda-local-vars' variables.
  1952. (mapc #'make-local-variable org-agenda-local-vars)
  1953. (reset-saved org-agenda-local-vars)
  1954. (setq-local org-agenda-this-buffer-is-sticky t))
  1955. (org-agenda-sticky
  1956. ;; Creating a sticky Agenda buffer for the first time
  1957. (mapc 'make-local-variable org-agenda-local-vars)
  1958. (setq-local org-agenda-this-buffer-is-sticky t))
  1959. (t
  1960. ;; Creating a non-sticky agenda buffer
  1961. (setq-local org-agenda-this-buffer-is-sticky nil)))
  1962. (mapc #'make-local-variable agenda-local-vars-to-keep)
  1963. (reset-saved agenda-local-vars-to-keep)))
  1964. (setq org-agenda-undo-list nil
  1965. org-agenda-pending-undo-list nil
  1966. org-agenda-bulk-marked-entries nil)
  1967. (setq major-mode 'org-agenda-mode)
  1968. ;; Keep global-font-lock-mode from turning on font-lock-mode
  1969. (setq-local font-lock-global-modes (list 'not major-mode))
  1970. (setq mode-name "Org-Agenda")
  1971. (setq indent-tabs-mode nil)
  1972. (use-local-map org-agenda-mode-map)
  1973. (easy-menu-add org-agenda-menu)
  1974. (when org-startup-truncated (setq truncate-lines t))
  1975. (setq-local line-move-visual nil)
  1976. (add-hook 'post-command-hook 'org-agenda-update-agenda-type nil 'local)
  1977. (add-hook 'pre-command-hook 'org-unhighlight nil 'local)
  1978. ;; Make sure properties are removed when copying text
  1979. (if (boundp 'filter-buffer-substring-functions)
  1980. (add-hook 'filter-buffer-substring-functions
  1981. (lambda (fun start end delete)
  1982. (substring-no-properties (funcall fun start end delete)))
  1983. nil t)
  1984. ;; Emacs >= 24.4.
  1985. (add-function :filter-return (local 'filter-buffer-substring-function)
  1986. #'substring-no-properties))
  1987. (unless org-agenda-keep-modes
  1988. (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
  1989. org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
  1990. org-agenda-show-log org-agenda-start-with-log-mode
  1991. org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode))
  1992. (add-to-invisibility-spec '(org-filtered))
  1993. (add-to-invisibility-spec '(org-link))
  1994. (easy-menu-change
  1995. '("Agenda") "Agenda Files"
  1996. (append
  1997. (list
  1998. (vector
  1999. (if (get 'org-agenda-files 'org-restrict)
  2000. "Restricted to single file"
  2001. "Edit File List")
  2002. '(org-edit-agenda-file-list)
  2003. (not (get 'org-agenda-files 'org-restrict)))
  2004. "--")
  2005. (mapcar 'org-file-menu-entry (org-agenda-files))))
  2006. (org-agenda-set-mode-name)
  2007. (apply
  2008. (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
  2009. (list 'org-agenda-mode-hook)))
  2010. (substitute-key-definition 'undo 'org-agenda-undo
  2011. org-agenda-mode-map global-map)
  2012. (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
  2013. (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
  2014. (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
  2015. (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
  2016. (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
  2017. (org-defkey org-agenda-mode-map [(meta down)] 'org-agenda-drag-line-forward)
  2018. (org-defkey org-agenda-mode-map [(meta up)] 'org-agenda-drag-line-backward)
  2019. (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
  2020. (org-defkey org-agenda-mode-map "\M-m" 'org-agenda-bulk-toggle)
  2021. (org-defkey org-agenda-mode-map "*" 'org-agenda-bulk-mark-all)
  2022. (org-defkey org-agenda-mode-map "\M-*" 'org-agenda-bulk-toggle-all)
  2023. (org-defkey org-agenda-mode-map "#" 'org-agenda-dim-blocked-tasks)
  2024. (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
  2025. (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
  2026. (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-unmark-all)
  2027. (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
  2028. (org-defkey org-agenda-mode-map "k" 'org-agenda-capture)
  2029. (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
  2030. (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
  2031. (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
  2032. (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
  2033. (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
  2034. (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
  2035. (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
  2036. (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
  2037. (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
  2038. (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
  2039. (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
  2040. (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
  2041. (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
  2042. (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
  2043. (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
  2044. (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
  2045. (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
  2046. (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
  2047. (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
  2048. (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
  2049. (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
  2050. (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
  2051. (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
  2052. (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
  2053. (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
  2054. (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
  2055. (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
  2056. (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
  2057. (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
  2058. (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
  2059. (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
  2060. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
  2061. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
  2062. (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
  2063. (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
  2064. (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
  2065. (let ((l '(1 2 3 4 5 6 7 8 9 0)))
  2066. (while l (org-defkey org-agenda-mode-map
  2067. (int-to-string (pop l)) 'digit-argument)))
  2068. (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
  2069. (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
  2070. (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
  2071. (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
  2072. (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
  2073. (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
  2074. (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
  2075. (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
  2076. (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
  2077. (org-defkey org-agenda-mode-map "g" 'org-agenda-redo-all)
  2078. (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
  2079. (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
  2080. (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
  2081. 'org-clock-modify-effort-estimate)
  2082. (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
  2083. (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
  2084. (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
  2085. (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
  2086. (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
  2087. (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
  2088. (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
  2089. (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
  2090. (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
  2091. (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
  2092. (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
  2093. (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
  2094. (substitute-key-definition 'next-line 'org-agenda-next-line
  2095. org-agenda-mode-map global-map)
  2096. (substitute-key-definition 'previous-line 'org-agenda-previous-line
  2097. org-agenda-mode-map global-map)
  2098. (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
  2099. (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
  2100. (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
  2101. (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
  2102. (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
  2103. (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
  2104. (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
  2105. (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
  2106. (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
  2107. (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
  2108. (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
  2109. (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
  2110. (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
  2111. (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
  2112. (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
  2113. (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
  2114. (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
  2115. (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
  2116. (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  2117. (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
  2118. (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
  2119. (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
  2120. (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
  2121. (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
  2122. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
  2123. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
  2124. (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
  2125. (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
  2126. (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
  2127. (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  2128. (org-defkey org-agenda-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock-from-agenda)
  2129. (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
  2130. (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
  2131. (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
  2132. (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
  2133. (org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag)
  2134. (org-defkey org-agenda-mode-map "_" 'org-agenda-filter-by-effort)
  2135. (org-defkey org-agenda-mode-map "=" 'org-agenda-filter-by-regexp)
  2136. (org-defkey org-agenda-mode-map "/" 'org-agenda-filter)
  2137. (org-defkey org-agenda-mode-map "|" 'org-agenda-filter-remove-all)
  2138. (org-defkey org-agenda-mode-map "~" 'org-agenda-limit-interactively)
  2139. (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
  2140. (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-headline)
  2141. (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
  2142. (org-defkey org-agenda-mode-map "\C-c\C-x_" 'org-timer-stop)
  2143. (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
  2144. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  2145. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  2146. (org-defkey org-agenda-mode-map "\C-c\C-xI" 'org-info-find-node)
  2147. (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
  2148. (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
  2149. (define-key org-agenda-mode-map [remap forward-paragraph] 'org-agenda-forward-block)
  2150. (define-key org-agenda-mode-map [remap backward-paragraph] 'org-agenda-backward-block)
  2151. (when org-agenda-mouse-1-follows-link
  2152. (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
  2153. (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
  2154. '("Agenda"
  2155. ("Agenda Files")
  2156. "--"
  2157. ("Agenda Dates"
  2158. ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda)]
  2159. ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
  2160. ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
  2161. ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
  2162. "--"
  2163. ("View"
  2164. ["Day View" org-agenda-day-view
  2165. :active (org-agenda-check-type nil 'agenda)
  2166. :style radio :selected (eq org-agenda-current-span 'day)
  2167. :keys "v d (or just d)"]
  2168. ["Week View" org-agenda-week-view
  2169. :active (org-agenda-check-type nil 'agenda)
  2170. :style radio :selected (eq org-agenda-current-span 'week)
  2171. :keys "v w"]
  2172. ["Fortnight View" org-agenda-fortnight-view
  2173. :active (org-agenda-check-type nil 'agenda)
  2174. :style radio :selected (eq org-agenda-current-span 'fortnight)
  2175. :keys "v t"]
  2176. ["Month View" org-agenda-month-view
  2177. :active (org-agenda-check-type nil 'agenda)
  2178. :style radio :selected (eq org-agenda-current-span 'month)
  2179. :keys "v m"]
  2180. ["Year View" org-agenda-year-view
  2181. :active (org-agenda-check-type nil 'agenda)
  2182. :style radio :selected (eq org-agenda-current-span 'year)
  2183. :keys "v y"]
  2184. "--"
  2185. ["Include Diary" org-agenda-toggle-diary
  2186. :style toggle :selected org-agenda-include-diary
  2187. :active (org-agenda-check-type nil 'agenda)]
  2188. ["Include Deadlines" org-agenda-toggle-deadlines
  2189. :style toggle :selected org-agenda-include-deadlines
  2190. :active (org-agenda-check-type nil 'agenda)]
  2191. ["Use Time Grid" org-agenda-toggle-time-grid
  2192. :style toggle :selected org-agenda-use-time-grid
  2193. :active (org-agenda-check-type nil 'agenda)]
  2194. "--"
  2195. ["Show clock report" org-agenda-clockreport-mode
  2196. :style toggle :selected org-agenda-clockreport-mode
  2197. :active (org-agenda-check-type nil 'agenda)]
  2198. ["Show some entry text" org-agenda-entry-text-mode
  2199. :style toggle :selected org-agenda-entry-text-mode
  2200. :active t]
  2201. "--"
  2202. ["Show Logbook entries" org-agenda-log-mode
  2203. :style toggle :selected org-agenda-show-log
  2204. :active (org-agenda-check-type nil 'agenda)
  2205. :keys "v l (or just l)"]
  2206. ["Include archived trees" org-agenda-archives-mode
  2207. :style toggle :selected org-agenda-archives-mode :active t
  2208. :keys "v a"]
  2209. ["Include archive files" (org-agenda-archives-mode t)
  2210. :style toggle :selected (eq org-agenda-archives-mode t) :active t
  2211. :keys "v A"]
  2212. "--"
  2213. ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
  2214. ("Filter current view"
  2215. ["with generic interface" org-agenda-filter t]
  2216. "--"
  2217. ["by category at cursor" org-agenda-filter-by-category t]
  2218. ["by tag" org-agenda-filter-by-tag t]
  2219. ["by effort" org-agenda-filter-by-effort t]
  2220. ["by regexp" org-agenda-filter-by-regexp t]
  2221. ["by top-level headline" org-agenda-filter-by-top-headline t]
  2222. "--"
  2223. ["Remove all filtering" org-agenda-filter-remove-all t]
  2224. "--"
  2225. ["limit" org-agenda-limit-interactively t])
  2226. ["Rebuild buffer" org-agenda-redo t]
  2227. ["Write view to file" org-agenda-write t]
  2228. ["Save all Org buffers" org-save-all-org-buffers t]
  2229. "--"
  2230. ["Show original entry" org-agenda-show t]
  2231. ["Go To (other window)" org-agenda-goto t]
  2232. ["Go To (this window)" org-agenda-switch-to t]
  2233. ["Capture with cursor date" org-agenda-capture t]
  2234. ["Follow Mode" org-agenda-follow-mode
  2235. :style toggle :selected org-agenda-follow-mode :active t]
  2236. ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
  2237. "--"
  2238. ("TODO"
  2239. ["Cycle TODO" org-agenda-todo t]
  2240. ["Next TODO set" org-agenda-todo-nextset t]
  2241. ["Previous TODO set" org-agenda-todo-previousset t]
  2242. ["Add note" org-agenda-add-note t])
  2243. ("Archive/Refile/Delete"
  2244. ["Archive default" org-agenda-archive-default t]
  2245. ["Archive default" org-agenda-archive-default-with-confirmation t]
  2246. ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
  2247. ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
  2248. ["Archive subtree" org-agenda-archive t]
  2249. "--"
  2250. ["Refile" org-agenda-refile t]
  2251. "--"
  2252. ["Delete subtree" org-agenda-kill t])
  2253. ("Bulk action"
  2254. ["Mark entry" org-agenda-bulk-mark t]
  2255. ["Mark all" org-agenda-bulk-mark-all t]
  2256. ["Unmark entry" org-agenda-bulk-unmark t]
  2257. ["Unmark all" org-agenda-bulk-unmark-all :active t :keys "U"]
  2258. ["Toggle mark" org-agenda-bulk-toggle t]
  2259. ["Toggle all" org-agenda-bulk-toggle-all t]
  2260. ["Mark regexp" org-agenda-bulk-mark-regexp t])
  2261. ["Act on all marked" org-agenda-bulk-action t]
  2262. "--"
  2263. ("Tags and Properties"
  2264. ["Show all Tags" org-agenda-show-tags t]
  2265. ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
  2266. ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
  2267. "--"
  2268. ["Column View" org-columns t])
  2269. ("Deadline/Schedule"
  2270. ["Schedule" org-agenda-schedule t]
  2271. ["Set Deadline" org-agenda-deadline t]
  2272. "--"
  2273. ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda)]
  2274. ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda)]
  2275. ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda) :keys "C-u S-right"]
  2276. ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda) :keys "C-u S-left"]
  2277. ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda) :keys "C-u C-u S-right"]
  2278. ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda) :keys "C-u C-u S-left"]
  2279. ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda)])
  2280. ("Clock and Effort"
  2281. ["Clock in" org-agenda-clock-in t]
  2282. ["Clock out" org-agenda-clock-out t]
  2283. ["Clock cancel" org-agenda-clock-cancel t]
  2284. ["Goto running clock" org-clock-goto t]
  2285. "--"
  2286. ["Set Effort" org-agenda-set-effort t]
  2287. ["Change clocked effort" org-clock-modify-effort-estimate
  2288. (org-clock-is-active)])
  2289. ("Priority"
  2290. ["Set Priority" org-agenda-priority t]
  2291. ["Increase Priority" org-agenda-priority-up t]
  2292. ["Decrease Priority" org-agenda-priority-down t]
  2293. ["Show Priority" org-show-priority t])
  2294. ("Calendar/Diary"
  2295. ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda)]
  2296. ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda)]
  2297. ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda)]
  2298. ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda)]
  2299. ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda)]
  2300. ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda)]
  2301. "--"
  2302. ["Create iCalendar File" org-icalendar-combine-agenda-files t])
  2303. "--"
  2304. ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
  2305. "--"
  2306. ("MobileOrg"
  2307. ["Push Files and Views" org-mobile-push t]
  2308. ["Get Captured and Flagged" org-mobile-pull t]
  2309. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "\\[org-agenda] ?"]
  2310. ["Show note / unflag" org-agenda-show-the-flagging-note t]
  2311. "--"
  2312. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  2313. "--"
  2314. ["Quit" org-agenda-quit t]
  2315. ["Exit and Release Buffers" org-agenda-exit t]
  2316. ))
  2317. ;;; Agenda undo
  2318. (defvar org-agenda-allow-remote-undo t
  2319. "Non-nil means allow remote undo from the agenda buffer.")
  2320. (defvar org-agenda-undo-has-started-in nil
  2321. "Buffers that have already seen `undo-start' in the current undo sequence.")
  2322. (defun org-agenda-undo ()
  2323. "Undo a remote editing step in the agenda.
  2324. This undoes changes both in the agenda buffer and in the remote buffer
  2325. that have been changed along."
  2326. (interactive)
  2327. (or org-agenda-allow-remote-undo
  2328. (user-error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
  2329. (when (not (eq this-command last-command))
  2330. (setq org-agenda-undo-has-started-in nil
  2331. org-agenda-pending-undo-list org-agenda-undo-list))
  2332. (when (not org-agenda-pending-undo-list)
  2333. (user-error "No further undo information"))
  2334. (let* ((entry (pop org-agenda-pending-undo-list))
  2335. buf line cmd rembuf)
  2336. (setq cmd (pop entry) line (pop entry))
  2337. (setq rembuf (nth 2 entry))
  2338. (org-with-remote-undo rembuf
  2339. (while (bufferp (setq buf (pop entry)))
  2340. (when (pop entry)
  2341. (with-current-buffer buf
  2342. (let ((last-undo-buffer buf)
  2343. (inhibit-read-only t))
  2344. (unless (memq buf org-agenda-undo-has-started-in)
  2345. (push buf org-agenda-undo-has-started-in)
  2346. (make-local-variable 'pending-undo-list)
  2347. (undo-start))
  2348. (while (and pending-undo-list
  2349. (listp pending-undo-list)
  2350. (not (car pending-undo-list)))
  2351. (pop pending-undo-list))
  2352. (undo-more 1))))))
  2353. (org-goto-line line)
  2354. (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
  2355. (defun org-verify-change-for-undo (l1 l2)
  2356. "Verify that a real change occurred between the undo lists L1 and L2."
  2357. (while (and l1 (listp l1) (null (car l1))) (pop l1))
  2358. (while (and l2 (listp l2) (null (car l2))) (pop l2))
  2359. (not (eq l1 l2)))
  2360. ;;; Agenda dispatch
  2361. (defvar org-agenda-restrict-begin (make-marker))
  2362. (defvar org-agenda-restrict-end (make-marker))
  2363. (defvar org-agenda-last-dispatch-buffer nil)
  2364. (defvar org-agenda-overriding-restriction nil)
  2365. (defcustom org-agenda-custom-commands-contexts nil
  2366. "Alist of custom agenda keys and contextual rules.
  2367. For example, if you have a custom agenda command \"p\" and you
  2368. want this command to be accessible only from plain text files,
  2369. use this:
  2370. \\='((\"p\" ((in-file . \"\\\\.txt\\\\'\"))))
  2371. Here are the available contexts definitions:
  2372. in-file: command displayed only in matching files
  2373. in-mode: command displayed only in matching modes
  2374. not-in-file: command not displayed in matching files
  2375. not-in-mode: command not displayed in matching modes
  2376. in-buffer: command displayed only in matching buffers
  2377. not-in-buffer: command not displayed in matching buffers
  2378. [function]: a custom function taking no argument
  2379. If you define several checks, the agenda command will be
  2380. accessible if there is at least one valid check.
  2381. You can also bind a key to another agenda custom command
  2382. depending on contextual rules.
  2383. \\='((\"p\" \"q\" ((in-file . \"\\\\.txt\\\\'\"))))
  2384. Here it means: in .txt files, use \"p\" as the key for the
  2385. agenda command otherwise associated with \"q\". (The command
  2386. originally associated with \"q\" is not displayed to avoid
  2387. duplicates.)"
  2388. :version "24.3"
  2389. :group 'org-agenda-custom-commands
  2390. :type '(repeat (list :tag "Rule"
  2391. (string :tag " Agenda key")
  2392. (string :tag "Replace by command")
  2393. (repeat :tag "Available when"
  2394. (choice
  2395. (cons :tag "Condition"
  2396. (choice
  2397. (const :tag "In file" in-file)
  2398. (const :tag "Not in file" not-in-file)
  2399. (const :tag "In buffer" in-buffer)
  2400. (const :tag "Not in buffer" not-in-buffer)
  2401. (const :tag "In mode" in-mode)
  2402. (const :tag "Not in mode" not-in-mode))
  2403. (regexp))
  2404. (function :tag "Custom function"))))))
  2405. (defcustom org-agenda-max-entries nil
  2406. "Maximum number of entries to display in an agenda.
  2407. This can be nil (no limit) or an integer or an alist of agenda
  2408. types with an associated number of entries to display in this
  2409. type."
  2410. :version "24.4"
  2411. :package-version '(Org . "8.0")
  2412. :group 'org-agenda-custom-commands
  2413. :type '(choice (symbol :tag "No limit" nil)
  2414. (integer :tag "Max number of entries")
  2415. (repeat
  2416. (cons (choice :tag "Agenda type"
  2417. (const agenda)
  2418. (const todo)
  2419. (const tags)
  2420. (const search))
  2421. (integer :tag "Max number of entries")))))
  2422. (defcustom org-agenda-max-todos nil
  2423. "Maximum number of TODOs to display in an agenda.
  2424. This can be nil (no limit) or an integer or an alist of agenda
  2425. types with an associated number of entries to display in this
  2426. type."
  2427. :version "24.4"
  2428. :package-version '(Org . "8.0")
  2429. :group 'org-agenda-custom-commands
  2430. :type '(choice (symbol :tag "No limit" nil)
  2431. (integer :tag "Max number of TODOs")
  2432. (repeat
  2433. (cons (choice :tag "Agenda type"
  2434. (const agenda)
  2435. (const todo)
  2436. (const tags)
  2437. (const search))
  2438. (integer :tag "Max number of TODOs")))))
  2439. (defcustom org-agenda-max-tags nil
  2440. "Maximum number of tagged entries to display in an agenda.
  2441. This can be nil (no limit) or an integer or an alist of agenda
  2442. types with an associated number of entries to display in this
  2443. type."
  2444. :version "24.4"
  2445. :package-version '(Org . "8.0")
  2446. :group 'org-agenda-custom-commands
  2447. :type '(choice (symbol :tag "No limit" nil)
  2448. (integer :tag "Max number of tagged entries")
  2449. (repeat
  2450. (cons (choice :tag "Agenda type"
  2451. (const agenda)
  2452. (const todo)
  2453. (const tags)
  2454. (const search))
  2455. (integer :tag "Max number of tagged entries")))))
  2456. (defcustom org-agenda-max-effort nil
  2457. "Maximum cumulated effort duration for the agenda.
  2458. This can be nil (no limit) or a number of minutes (as an integer)
  2459. or an alist of agenda types with an associated number of minutes
  2460. to limit entries to in this type."
  2461. :version "24.4"
  2462. :package-version '(Org . "8.0")
  2463. :group 'org-agenda-custom-commands
  2464. :type '(choice (symbol :tag "No limit" nil)
  2465. (integer :tag "Max number of minutes")
  2466. (repeat
  2467. (cons (choice :tag "Agenda type"
  2468. (const agenda)
  2469. (const todo)
  2470. (const tags)
  2471. (const search))
  2472. (integer :tag "Max number of minutes")))))
  2473. (defvar org-agenda-keep-restricted-file-list nil)
  2474. (defvar org-keys nil)
  2475. (defvar org-match nil)
  2476. ;;;###autoload
  2477. (defun org-agenda (&optional arg org-keys restriction)
  2478. "Dispatch agenda commands to collect entries to the agenda buffer.
  2479. Prompts for a command to execute. Any prefix arg will be passed
  2480. on to the selected command. The default selections are:
  2481. a Call `org-agenda-list' to display the agenda for current day or week.
  2482. t Call `org-todo-list' to display the global todo list.
  2483. T Call `org-todo-list' to display the global todo list, select only
  2484. entries with a specific TODO keyword (the user gets a prompt).
  2485. m Call `org-tags-view' to display headlines with tags matching
  2486. a condition (the user is prompted for the condition).
  2487. M Like `m', but select only TODO entries, no ordinary headlines.
  2488. e Export views to associated files.
  2489. s Search entries for keywords.
  2490. S Search entries for keywords, only with TODO keywords.
  2491. / Multi occur across all agenda files and also files listed
  2492. in `org-agenda-text-search-extra-files'.
  2493. < Restrict agenda commands to buffer, subtree, or region.
  2494. Press several times to get the desired effect.
  2495. > Remove a previous restriction.
  2496. # List \"stuck\" projects.
  2497. ! Configure what \"stuck\" means.
  2498. C Configure custom agenda commands.
  2499. More commands can be added by configuring the variable
  2500. `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
  2501. searches can be pre-defined in this way.
  2502. If the current buffer is in Org mode and visiting a file, you can also
  2503. first press `<' once to indicate that the agenda should be temporarily
  2504. \(until the next use of `\\[org-agenda]') restricted to the current file.
  2505. Pressing `<' twice means to restrict to the current subtree or region
  2506. \(if active)."
  2507. (interactive "P")
  2508. (catch 'exit
  2509. (let* ((prefix-descriptions nil)
  2510. (org-agenda-buffer-name org-agenda-buffer-name)
  2511. (org-agenda-window-setup (if (equal (buffer-name)
  2512. org-agenda-buffer-name)
  2513. 'current-window
  2514. org-agenda-window-setup))
  2515. (org-agenda-custom-commands-orig org-agenda-custom-commands)
  2516. (org-agenda-custom-commands
  2517. ;; normalize different versions
  2518. (delq nil
  2519. (mapcar
  2520. (lambda (x)
  2521. (cond ((stringp (cdr x))
  2522. (push x prefix-descriptions)
  2523. nil)
  2524. ((stringp (nth 1 x)) x)
  2525. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2526. (t (cons (car x) (cons "" (cdr x))))))
  2527. org-agenda-custom-commands)))
  2528. (org-agenda-custom-commands
  2529. (org-contextualize-keys
  2530. org-agenda-custom-commands org-agenda-custom-commands-contexts))
  2531. (buf (current-buffer))
  2532. (bfn (buffer-file-name (buffer-base-buffer)))
  2533. entry key type org-match lprops ans)
  2534. ;; Turn off restriction unless there is an overriding one,
  2535. (unless org-agenda-overriding-restriction
  2536. (unless org-agenda-keep-restricted-file-list
  2537. ;; There is a request to keep the file list in place
  2538. (put 'org-agenda-files 'org-restrict nil))
  2539. (setq org-agenda-restrict nil)
  2540. (move-marker org-agenda-restrict-begin nil)
  2541. (move-marker org-agenda-restrict-end nil))
  2542. ;; Delete old local properties
  2543. (put 'org-agenda-redo-command 'org-lprops nil)
  2544. ;; Delete previously set last-arguments
  2545. (put 'org-agenda-redo-command 'last-args nil)
  2546. ;; Remember where this call originated
  2547. (setq org-agenda-last-dispatch-buffer (current-buffer))
  2548. (unless org-keys
  2549. (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
  2550. org-keys (car ans)
  2551. restriction (cdr ans)))
  2552. ;; If we have sticky agenda buffers, set a name for the buffer,
  2553. ;; depending on the invoking keys. The user may still set this
  2554. ;; as a command option, which will overwrite what we do here.
  2555. (when org-agenda-sticky
  2556. (setq org-agenda-buffer-name
  2557. (format "*Org Agenda(%s)*" org-keys)))
  2558. ;; Establish the restriction, if any
  2559. (when (and (not org-agenda-overriding-restriction) restriction)
  2560. (put 'org-agenda-files 'org-restrict (list bfn))
  2561. (cond
  2562. ((eq restriction 'region)
  2563. (setq org-agenda-restrict (current-buffer))
  2564. (move-marker org-agenda-restrict-begin (region-beginning))
  2565. (move-marker org-agenda-restrict-end (region-end)))
  2566. ((eq restriction 'subtree)
  2567. (save-excursion
  2568. (setq org-agenda-restrict (current-buffer))
  2569. (org-back-to-heading t)
  2570. (move-marker org-agenda-restrict-begin (point))
  2571. (move-marker org-agenda-restrict-end
  2572. (progn (org-end-of-subtree t)))))
  2573. ((and (eq restriction 'buffer)
  2574. (or (< 1 (point-min))
  2575. (< (point-max) (1+ (buffer-size)))))
  2576. (setq org-agenda-restrict (current-buffer))
  2577. (move-marker org-agenda-restrict-begin (point-min))
  2578. (move-marker org-agenda-restrict-end (point-max)))))
  2579. ;; For example the todo list should not need it (but does...)
  2580. (cond
  2581. ((setq entry (assoc org-keys org-agenda-custom-commands))
  2582. (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
  2583. (progn
  2584. (setq type (nth 2 entry) org-match (eval (nth 3 entry))
  2585. lprops (nth 4 entry))
  2586. (when org-agenda-sticky
  2587. (setq org-agenda-buffer-name
  2588. (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
  2589. (format "*Org Agenda(%s)*" org-keys))))
  2590. (put 'org-agenda-redo-command 'org-lprops lprops)
  2591. (cond
  2592. ((eq type 'agenda)
  2593. (org-let lprops '(org-agenda-list current-prefix-arg)))
  2594. ((eq type 'agenda*)
  2595. (org-let lprops '(org-agenda-list current-prefix-arg nil nil t)))
  2596. ((eq type 'alltodo)
  2597. (org-let lprops '(org-todo-list current-prefix-arg)))
  2598. ((eq type 'search)
  2599. (org-let lprops '(org-search-view current-prefix-arg org-match nil)))
  2600. ((eq type 'stuck)
  2601. (org-let lprops '(org-agenda-list-stuck-projects
  2602. current-prefix-arg)))
  2603. ((eq type 'tags)
  2604. (org-let lprops '(org-tags-view current-prefix-arg org-match)))
  2605. ((eq type 'tags-todo)
  2606. (org-let lprops '(org-tags-view '(4) org-match)))
  2607. ((eq type 'todo)
  2608. (org-let lprops '(org-todo-list org-match)))
  2609. ((eq type 'tags-tree)
  2610. (org-check-for-org-mode)
  2611. (org-let lprops '(org-match-sparse-tree current-prefix-arg org-match)))
  2612. ((eq type 'todo-tree)
  2613. (org-check-for-org-mode)
  2614. (org-let lprops
  2615. '(org-occur (concat "^" org-outline-regexp "[ \t]*"
  2616. (regexp-quote org-match) "\\>"))))
  2617. ((eq type 'occur-tree)
  2618. (org-check-for-org-mode)
  2619. (org-let lprops '(org-occur org-match)))
  2620. ((functionp type)
  2621. (org-let lprops '(funcall type org-match)))
  2622. ((fboundp type)
  2623. (org-let lprops '(funcall type org-match)))
  2624. (t (user-error "Invalid custom agenda command type %s" type))))
  2625. (org-agenda-run-series (nth 1 entry) (cddr entry))))
  2626. ((equal org-keys "C")
  2627. (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
  2628. (customize-variable 'org-agenda-custom-commands))
  2629. ((equal org-keys "a") (call-interactively 'org-agenda-list))
  2630. ((equal org-keys "s") (call-interactively 'org-search-view))
  2631. ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
  2632. ((equal org-keys "t") (call-interactively 'org-todo-list))
  2633. ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
  2634. ((equal org-keys "m") (call-interactively 'org-tags-view))
  2635. ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
  2636. ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
  2637. ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
  2638. (add-hook
  2639. 'post-command-hook
  2640. (lambda ()
  2641. (unless (current-message)
  2642. (let* ((m (org-agenda-get-any-marker))
  2643. (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
  2644. (when note
  2645. (message "FLAGGING-NOTE ([?] for more info): %s"
  2646. (org-add-props
  2647. (replace-regexp-in-string
  2648. "\\\\n" "//"
  2649. (copy-sequence note))
  2650. nil 'face 'org-warning))))))
  2651. t t))
  2652. ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
  2653. ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
  2654. ((equal org-keys "!") (customize-variable 'org-stuck-projects))
  2655. (t (user-error "Invalid agenda key"))))))
  2656. (defvar org-agenda-multi)
  2657. (defun org-agenda-append-agenda ()
  2658. "Append another agenda view to the current one.
  2659. This function allows interactive building of block agendas.
  2660. Agenda views are separated by `org-agenda-block-separator'."
  2661. (interactive)
  2662. (unless (derived-mode-p 'org-agenda-mode)
  2663. (user-error "Can only append from within agenda buffer"))
  2664. (let ((org-agenda-multi t))
  2665. (org-agenda)
  2666. (widen)
  2667. (org-agenda-finalize)
  2668. (setq buffer-read-only t)
  2669. (org-agenda-fit-window-to-buffer)))
  2670. (defun org-agenda-normalize-custom-commands (cmds)
  2671. "Normalize custom commands CMDS."
  2672. (delq nil
  2673. (mapcar
  2674. (lambda (x)
  2675. (cond ((stringp (cdr x)) nil)
  2676. ((stringp (nth 1 x)) x)
  2677. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2678. (t (cons (car x) (cons "" (cdr x))))))
  2679. cmds)))
  2680. (defun org-agenda-get-restriction-and-command (prefix-descriptions)
  2681. "The user interface for selecting an agenda command."
  2682. (catch 'exit
  2683. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  2684. (restrict-ok (and bfn (derived-mode-p 'org-mode)))
  2685. (region-p (org-region-active-p))
  2686. (custom org-agenda-custom-commands)
  2687. (selstring "")
  2688. restriction second-time
  2689. c entry key type match prefixes rmheader header-end custom1 desc
  2690. line lines left right n n1)
  2691. (save-window-excursion
  2692. (delete-other-windows)
  2693. (org-switch-to-buffer-other-window " *Agenda Commands*")
  2694. (erase-buffer)
  2695. (insert (eval-when-compile
  2696. (let ((header
  2697. "Press key for an agenda command:
  2698. -------------------------------- < Buffer, subtree/region restriction
  2699. a Agenda for current week or day > Remove restriction
  2700. t List of all TODO entries e Export agenda views
  2701. m Match a TAGS/PROP/TODO query T Entries with special TODO kwd
  2702. s Search for keywords M Like m, but only TODO entries
  2703. / Multi-occur S Like s, but only TODO entries
  2704. ? Find :FLAGGED: entries C Configure custom agenda commands
  2705. * Toggle sticky agenda views # List stuck projects (!=configure)
  2706. ")
  2707. (start 0))
  2708. (while (string-match
  2709. "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
  2710. header start)
  2711. (setq start (match-end 0))
  2712. (add-text-properties (match-beginning 2) (match-end 2)
  2713. '(face bold) header))
  2714. header)))
  2715. (setq header-end (point-marker))
  2716. (while t
  2717. (setq custom1 custom)
  2718. (when (eq rmheader t)
  2719. (org-goto-line 1)
  2720. (re-search-forward ":" nil t)
  2721. (delete-region (match-end 0) (point-at-eol))
  2722. (forward-char 1)
  2723. (looking-at "-+")
  2724. (delete-region (match-end 0) (point-at-eol))
  2725. (move-marker header-end (match-end 0)))
  2726. (goto-char header-end)
  2727. (delete-region (point) (point-max))
  2728. ;; Produce all the lines that describe custom commands and prefixes
  2729. (setq lines nil)
  2730. (while (setq entry (pop custom1))
  2731. (setq key (car entry) desc (nth 1 entry)
  2732. type (nth 2 entry)
  2733. match (nth 3 entry))
  2734. (if (> (length key) 1)
  2735. (cl-pushnew (string-to-char key) prefixes :test #'equal)
  2736. (setq line
  2737. (format
  2738. "%-4s%-14s"
  2739. (org-add-props (copy-sequence key)
  2740. '(face bold))
  2741. (cond
  2742. ((string-match "\\S-" desc) desc)
  2743. ((eq type 'agenda) "Agenda for current week or day")
  2744. ((eq type 'agenda*) "Appointments for current week or day")
  2745. ((eq type 'alltodo) "List of all TODO entries")
  2746. ((eq type 'search) "Word search")
  2747. ((eq type 'stuck) "List of stuck projects")
  2748. ((eq type 'todo) "TODO keyword")
  2749. ((eq type 'tags) "Tags query")
  2750. ((eq type 'tags-todo) "Tags (TODO)")
  2751. ((eq type 'tags-tree) "Tags tree")
  2752. ((eq type 'todo-tree) "TODO kwd tree")
  2753. ((eq type 'occur-tree) "Occur tree")
  2754. ((functionp type) (if (symbolp type)
  2755. (symbol-name type)
  2756. "Lambda expression"))
  2757. (t "???"))))
  2758. (cond
  2759. ((not (org-string-nw-p match)) nil)
  2760. (org-agenda-menu-show-matcher
  2761. (setq line
  2762. (concat line ": "
  2763. (cond
  2764. ((stringp match)
  2765. (propertize match 'face 'org-warning))
  2766. ((listp type)
  2767. (format "set of %d commands" (length type)))))))
  2768. (t
  2769. (org-add-props line nil 'help-echo (concat "Matcher: " match))))
  2770. (push line lines)))
  2771. (setq lines (nreverse lines))
  2772. (when prefixes
  2773. (mapc (lambda (x)
  2774. (push
  2775. (format "%s %s"
  2776. (org-add-props (char-to-string x)
  2777. nil 'face 'bold)
  2778. (or (cdr (assoc (concat selstring
  2779. (char-to-string x))
  2780. prefix-descriptions))
  2781. "Prefix key"))
  2782. lines))
  2783. prefixes))
  2784. ;; Check if we should display in two columns
  2785. (if org-agenda-menu-two-columns
  2786. (progn
  2787. (setq n (length lines)
  2788. n1 (+ (/ n 2) (mod n 2))
  2789. right (nthcdr n1 lines)
  2790. left (copy-sequence lines))
  2791. (setcdr (nthcdr (1- n1) left) nil))
  2792. (setq left lines right nil))
  2793. (while left
  2794. (insert "\n" (pop left))
  2795. (when right
  2796. (if (< (current-column) 40)
  2797. (move-to-column 40 t)
  2798. (insert " "))
  2799. (insert (pop right))))
  2800. ;; Make the window the right size
  2801. (goto-char (point-min))
  2802. (if second-time
  2803. (when (not (pos-visible-in-window-p (point-max)))
  2804. (org-fit-window-to-buffer))
  2805. (setq second-time t)
  2806. (org-fit-window-to-buffer))
  2807. ;; Hint to navigation if window too small for all information
  2808. (setq header-line-format
  2809. (when (not (pos-visible-in-window-p (point-max)))
  2810. "Use SPC, DEL, C-n or C-p to navigate."))
  2811. ;; Ask for selection
  2812. (cl-loop
  2813. do (progn
  2814. (message "Press key for agenda command%s:"
  2815. (if (or restrict-ok org-agenda-overriding-restriction)
  2816. (if org-agenda-overriding-restriction
  2817. " (restriction lock active)"
  2818. (if restriction
  2819. (format " (restricted to %s)" restriction)
  2820. " (unrestricted)"))
  2821. ""))
  2822. (setq c (read-char-exclusive)))
  2823. until (not (memq c '(14 16 ?\s ?\d)))
  2824. do (cl-case c
  2825. (14 (if (not (pos-visible-in-window-p (point-max)))
  2826. (ignore-errors (scroll-up 1))
  2827. (message "End of buffer")
  2828. (sit-for 1)))
  2829. (16 (if (not (pos-visible-in-window-p (point-min)))
  2830. (ignore-errors (scroll-down 1))
  2831. (message "Beginning of buffer")
  2832. (sit-for 1)))
  2833. (?\s (if (not (pos-visible-in-window-p (point-max)))
  2834. (scroll-up nil)
  2835. (message "End of buffer")
  2836. (sit-for 1)))
  2837. (?\d (if (not (pos-visible-in-window-p (point-min)))
  2838. (scroll-down nil)
  2839. (message "Beginning of buffer")
  2840. (sit-for 1)))))
  2841. (message "")
  2842. (cond
  2843. ((assoc (char-to-string c) custom)
  2844. (setq selstring (concat selstring (char-to-string c)))
  2845. (throw 'exit (cons selstring restriction)))
  2846. ((memq c prefixes)
  2847. (setq selstring (concat selstring (char-to-string c))
  2848. prefixes nil
  2849. rmheader (or rmheader t)
  2850. custom (delq nil (mapcar
  2851. (lambda (x)
  2852. (if (or (= (length (car x)) 1)
  2853. (/= (string-to-char (car x)) c))
  2854. nil
  2855. (cons (substring (car x) 1) (cdr x))))
  2856. custom))))
  2857. ((eq c ?*)
  2858. (call-interactively 'org-toggle-sticky-agenda)
  2859. (sit-for 2))
  2860. ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
  2861. (message "Restriction is only possible in Org buffers")
  2862. (ding) (sit-for 1))
  2863. ((eq c ?1)
  2864. (org-agenda-remove-restriction-lock 'noupdate)
  2865. (setq restriction 'buffer))
  2866. ((eq c ?0)
  2867. (org-agenda-remove-restriction-lock 'noupdate)
  2868. (setq restriction (if region-p 'region 'subtree)))
  2869. ((eq c ?<)
  2870. (org-agenda-remove-restriction-lock 'noupdate)
  2871. (setq restriction
  2872. (cond
  2873. ((eq restriction 'buffer)
  2874. (if region-p 'region 'subtree))
  2875. ((memq restriction '(subtree region))
  2876. nil)
  2877. (t 'buffer))))
  2878. ((eq c ?>)
  2879. (org-agenda-remove-restriction-lock 'noupdate)
  2880. (setq restriction nil))
  2881. ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
  2882. (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
  2883. ((and (> (length selstring) 0) (eq c ?\d))
  2884. (delete-window)
  2885. (org-agenda-get-restriction-and-command prefix-descriptions))
  2886. ((equal c ?q) (error "Abort"))
  2887. (t (user-error "Invalid key %c" c))))))))
  2888. (defun org-agenda-fit-window-to-buffer ()
  2889. "Fit the window to the buffer size."
  2890. (and (memq org-agenda-window-setup '(reorganize-frame))
  2891. (fboundp 'fit-window-to-buffer)
  2892. (if (and (= (cdr org-agenda-window-frame-fractions) 1.0)
  2893. (= (car org-agenda-window-frame-fractions) 1.0))
  2894. (delete-other-windows)
  2895. (org-fit-window-to-buffer
  2896. nil
  2897. (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
  2898. (floor (* (frame-height) (car org-agenda-window-frame-fractions)))))))
  2899. (defvar org-cmd nil)
  2900. (defvar org-agenda-overriding-cmd nil)
  2901. (defvar org-agenda-overriding-arguments nil)
  2902. (defvar org-agenda-overriding-cmd-arguments nil)
  2903. (defun org-agenda-run-series (name series)
  2904. "Run agenda NAME as a SERIES of agenda commands."
  2905. (org-let (nth 1 series) '(org-agenda-prepare name))
  2906. ;; We need to reset agenda markers here, because when constructing a
  2907. ;; block agenda, the individual blocks do not do that.
  2908. (org-agenda-reset-markers)
  2909. (let* ((org-agenda-multi t)
  2910. (redo (list 'org-agenda-run-series name (list 'quote series)))
  2911. (cmds (car series))
  2912. (gprops (nth 1 series))
  2913. match ;; The byte compiler incorrectly complains about this. Keep it!
  2914. org-cmd type lprops)
  2915. (while (setq org-cmd (pop cmds))
  2916. (setq type (car org-cmd))
  2917. (setq match (eval (nth 1 org-cmd)))
  2918. (setq lprops (nth 2 org-cmd))
  2919. (let ((org-agenda-overriding-arguments
  2920. (if (eq org-agenda-overriding-cmd org-cmd)
  2921. (or org-agenda-overriding-arguments
  2922. org-agenda-overriding-cmd-arguments))))
  2923. (cond
  2924. ((eq type 'agenda)
  2925. (org-let2 gprops lprops
  2926. '(call-interactively 'org-agenda-list)))
  2927. ((eq type 'agenda*)
  2928. (org-let2 gprops lprops
  2929. '(funcall 'org-agenda-list nil nil t)))
  2930. ((eq type 'alltodo)
  2931. (org-let2 gprops lprops
  2932. '(call-interactively 'org-todo-list)))
  2933. ((eq type 'search)
  2934. (org-let2 gprops lprops
  2935. '(org-search-view current-prefix-arg match nil)))
  2936. ((eq type 'stuck)
  2937. (org-let2 gprops lprops
  2938. '(call-interactively 'org-agenda-list-stuck-projects)))
  2939. ((eq type 'tags)
  2940. (org-let2 gprops lprops
  2941. '(org-tags-view current-prefix-arg match)))
  2942. ((eq type 'tags-todo)
  2943. (org-let2 gprops lprops
  2944. '(org-tags-view '(4) match)))
  2945. ((eq type 'todo)
  2946. (org-let2 gprops lprops
  2947. '(org-todo-list match)))
  2948. ((fboundp type)
  2949. (org-let2 gprops lprops
  2950. '(funcall type match)))
  2951. (t (error "Invalid type in command series")))))
  2952. (widen)
  2953. (let ((inhibit-read-only t))
  2954. (add-text-properties (point-min) (point-max)
  2955. `(org-series t org-series-redo-cmd ,redo)))
  2956. (setq org-agenda-redo-command redo)
  2957. (goto-char (point-min)))
  2958. (org-agenda-fit-window-to-buffer)
  2959. (org-let (nth 1 series) '(org-agenda-finalize)))
  2960. ;;;###autoload
  2961. (defmacro org-batch-agenda (cmd-key &rest parameters)
  2962. "Run an agenda command in batch mode and send the result to STDOUT.
  2963. If CMD-KEY is a string of length 1, it is used as a key in
  2964. `org-agenda-custom-commands' and triggers this command. If it is a
  2965. longer string it is used as a tags/todo match string.
  2966. Parameters are alternating variable names and values that will be bound
  2967. before running the agenda command."
  2968. (org-eval-in-environment (org-make-parameter-alist parameters)
  2969. (let (org-agenda-sticky)
  2970. (if (> (length cmd-key) 1)
  2971. (org-tags-view nil cmd-key)
  2972. (org-agenda nil cmd-key))))
  2973. (set-buffer org-agenda-buffer-name)
  2974. (princ (buffer-string)))
  2975. (defvar org-agenda-info nil)
  2976. ;;;###autoload
  2977. (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
  2978. "Run an agenda command in batch mode and send the result to STDOUT.
  2979. If CMD-KEY is a string of length 1, it is used as a key in
  2980. `org-agenda-custom-commands' and triggers this command. If it is a
  2981. longer string it is used as a tags/todo match string.
  2982. Parameters are alternating variable names and values that will be bound
  2983. before running the agenda command.
  2984. The output gives a line for each selected agenda item. Each
  2985. item is a list of comma-separated values, like this:
  2986. category,head,type,todo,tags,date,time,extra,priority-l,priority-n
  2987. category The category of the item
  2988. head The headline, without TODO kwd, TAGS and PRIORITY
  2989. type The type of the agenda entry, can be
  2990. todo selected in TODO match
  2991. tagsmatch selected in tags match
  2992. diary imported from diary
  2993. deadline a deadline on given date
  2994. scheduled scheduled on given date
  2995. timestamp entry has timestamp on given date
  2996. closed entry was closed on given date
  2997. upcoming-deadline warning about deadline
  2998. past-scheduled forwarded scheduled item
  2999. block entry has date block including g. date
  3000. todo The todo keyword, if any
  3001. tags All tags including inherited ones, separated by colons
  3002. date The relevant date, like 2007-2-14
  3003. time The time, like 15:00-16:50
  3004. extra String with extra planning info
  3005. priority-l The priority letter if any was given
  3006. priority-n The computed numerical priority
  3007. agenda-day The day in the agenda where this is listed"
  3008. (org-eval-in-environment (append '((org-agenda-remove-tags t))
  3009. (org-make-parameter-alist parameters))
  3010. (if (> (length cmd-key) 2)
  3011. (org-tags-view nil cmd-key)
  3012. (org-agenda nil cmd-key)))
  3013. (set-buffer org-agenda-buffer-name)
  3014. (let ((lines (org-split-string (buffer-string) "\n")))
  3015. (dolist (line lines)
  3016. (when (get-text-property 0 'org-category line)
  3017. (setq org-agenda-info
  3018. (org-fix-agenda-info (text-properties-at 0 line)))
  3019. (princ
  3020. (mapconcat 'org-agenda-export-csv-mapper
  3021. '(org-category txt type todo tags date time extra
  3022. priority-letter priority agenda-day)
  3023. ","))
  3024. (princ "\n")))))
  3025. (defun org-fix-agenda-info (props)
  3026. "Make sure all properties on an agenda item have a canonical form.
  3027. This ensures the export commands can easily use it."
  3028. (let (tmp re)
  3029. (when (setq tmp (plist-get props 'tags))
  3030. (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
  3031. (when (setq tmp (plist-get props 'date))
  3032. (when (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  3033. (let ((calendar-date-display-form '(year "-" month "-" day)))
  3034. '((format "%4d, %9s %2s, %4s" dayname monthname day year))
  3035. (setq tmp (calendar-date-string tmp)))
  3036. (setq props (plist-put props 'date tmp)))
  3037. (when (setq tmp (plist-get props 'day))
  3038. (when (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  3039. (let ((calendar-date-display-form '(year "-" month "-" day)))
  3040. (setq tmp (calendar-date-string tmp)))
  3041. (setq props (plist-put props 'day tmp))
  3042. (setq props (plist-put props 'agenda-day tmp)))
  3043. (when (setq tmp (plist-get props 'txt))
  3044. (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
  3045. (plist-put props 'priority-letter (match-string 1 tmp))
  3046. (setq tmp (replace-match "" t t tmp)))
  3047. (when (and (setq re (plist-get props 'org-todo-regexp))
  3048. (setq re (concat "\\`\\.*" re " ?"))
  3049. (let ((case-fold-search nil)) (string-match re tmp)))
  3050. (plist-put props 'todo (match-string 1 tmp))
  3051. (setq tmp (replace-match "" t t tmp)))
  3052. (plist-put props 'txt tmp)))
  3053. props)
  3054. (defun org-agenda-export-csv-mapper (prop)
  3055. (let ((res (plist-get org-agenda-info prop)))
  3056. (setq res
  3057. (cond
  3058. ((not res) "")
  3059. ((stringp res) res)
  3060. (t (prin1-to-string res))))
  3061. (org-trim (replace-regexp-in-string "," ";" res nil t))))
  3062. ;;;###autoload
  3063. (defun org-store-agenda-views (&rest parameters)
  3064. "Store agenda views."
  3065. (interactive)
  3066. (eval (list 'org-batch-store-agenda-views)))
  3067. ;;;###autoload
  3068. (defmacro org-batch-store-agenda-views (&rest parameters)
  3069. "Run all custom agenda commands that have a file argument."
  3070. (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
  3071. (pop-up-frames nil)
  3072. (dir default-directory)
  3073. (pars (org-make-parameter-alist parameters))
  3074. cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
  3075. (save-window-excursion
  3076. (while cmds
  3077. (setq cmd (pop cmds)
  3078. thiscmdkey (car cmd)
  3079. thiscmdcmd (cdr cmd)
  3080. match (nth 2 thiscmdcmd)
  3081. bufname (if org-agenda-sticky
  3082. (or (and (stringp match)
  3083. (format "*Org Agenda(%s:%s)*" thiscmdkey match))
  3084. (format "*Org Agenda(%s)*" thiscmdkey))
  3085. org-agenda-buffer-name)
  3086. cmd-or-set (nth 2 cmd)
  3087. opts (nth (if (listp cmd-or-set) 3 4) cmd)
  3088. files (nth (if (listp cmd-or-set) 4 5) cmd))
  3089. (if (stringp files) (setq files (list files)))
  3090. (when files
  3091. (org-eval-in-environment (append org-agenda-exporter-settings
  3092. opts pars)
  3093. (org-agenda nil thiscmdkey))
  3094. (set-buffer bufname)
  3095. (while files
  3096. (org-eval-in-environment (append org-agenda-exporter-settings
  3097. opts pars)
  3098. (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
  3099. (and (get-buffer bufname)
  3100. (kill-buffer bufname)))))))
  3101. (defvar org-agenda-current-span nil
  3102. "The current span used in the agenda view.") ; local variable in the agenda buffer
  3103. (defun org-agenda-mark-header-line (pos)
  3104. "Mark the line at POS as an agenda structure header."
  3105. (save-excursion
  3106. (goto-char pos)
  3107. (put-text-property (point-at-bol) (point-at-eol)
  3108. 'org-agenda-structural-header t)
  3109. (when org-agenda-title-append
  3110. (put-text-property (point-at-bol) (point-at-eol)
  3111. 'org-agenda-title-append org-agenda-title-append))))
  3112. (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
  3113. (defvar org-agenda-write-buffer-name "Agenda View")
  3114. (defun org-agenda-write (file &optional open nosettings agenda-bufname)
  3115. "Write the current buffer (an agenda view) as a file.
  3116. Depending on the extension of the file name, plain text (.txt),
  3117. HTML (.html or .htm), PDF (.pdf) or Postscript (.ps) is produced.
  3118. If the extension is .ics, translate visible agenda into iCalendar
  3119. format. If the extension is .org, collect all subtrees
  3120. corresponding to the agenda entries and add them in an .org file.
  3121. With prefix argument OPEN, open the new file immediately. If
  3122. NOSETTINGS is given, do not scope the settings of
  3123. `org-agenda-exporter-settings' into the export commands. This is
  3124. used when the settings have already been scoped and we do not
  3125. wish to overrule other, higher priority settings. If
  3126. AGENDA-BUFFER-NAME is provided, use this as the buffer name for
  3127. the agenda to write."
  3128. (interactive "FWrite agenda to file: \nP")
  3129. (if (or (not (file-writable-p file))
  3130. (and (file-exists-p file)
  3131. (if (called-interactively-p 'any)
  3132. (not (y-or-n-p (format "Overwrite existing file %s? " file))))))
  3133. (user-error "Cannot write agenda to file %s" file))
  3134. (org-let (if nosettings nil org-agenda-exporter-settings)
  3135. '(save-excursion
  3136. (save-window-excursion
  3137. (let ((bs (copy-sequence (buffer-string)))
  3138. (extension (file-name-extension file))
  3139. (default-directory (file-name-directory file))
  3140. beg content)
  3141. (with-temp-buffer
  3142. (rename-buffer org-agenda-write-buffer-name t)
  3143. (set-buffer-modified-p nil)
  3144. (insert bs)
  3145. (org-agenda-remove-marked-text 'invisible 'org-filtered)
  3146. (run-hooks 'org-agenda-before-write-hook)
  3147. (cond
  3148. ((bound-and-true-p org-mobile-creating-agendas)
  3149. (org-mobile-write-agenda-for-mobile file))
  3150. ((string= "org" extension)
  3151. (let (content p m message-log-max)
  3152. (goto-char (point-min))
  3153. (while (setq p (next-single-property-change (point) 'org-hd-marker nil))
  3154. (goto-char p)
  3155. (setq m (get-text-property (point) 'org-hd-marker))
  3156. (when m
  3157. (push (save-excursion
  3158. (set-buffer (marker-buffer m))
  3159. (goto-char m)
  3160. (org-copy-subtree 1 nil t t)
  3161. org-subtree-clip)
  3162. content)))
  3163. (find-file file)
  3164. (erase-buffer)
  3165. (dolist (s content) (org-paste-subtree 1 s))
  3166. (write-file file)
  3167. (kill-buffer (current-buffer))
  3168. (message "Org file written to %s" file)))
  3169. ((member extension '("html" "htm"))
  3170. (or (require 'htmlize nil t)
  3171. (error "Please install htmlize from https://github.com/hniksic/emacs-htmlize"))
  3172. (set-buffer (htmlize-buffer (current-buffer)))
  3173. (when org-agenda-export-html-style
  3174. ;; replace <style> section with org-agenda-export-html-style
  3175. (goto-char (point-min))
  3176. (kill-region (- (search-forward "<style") 6)
  3177. (search-forward "</style>"))
  3178. (insert org-agenda-export-html-style))
  3179. (write-file file)
  3180. (kill-buffer (current-buffer))
  3181. (message "HTML written to %s" file))
  3182. ((string= "ps" extension)
  3183. (require 'ps-print)
  3184. (ps-print-buffer-with-faces file)
  3185. (message "Postscript written to %s" file))
  3186. ((string= "pdf" extension)
  3187. (require 'ps-print)
  3188. (ps-print-buffer-with-faces
  3189. (concat (file-name-sans-extension file) ".ps"))
  3190. (call-process "ps2pdf" nil nil nil
  3191. (expand-file-name
  3192. (concat (file-name-sans-extension file) ".ps"))
  3193. (expand-file-name file))
  3194. (delete-file (concat (file-name-sans-extension file) ".ps"))
  3195. (message "PDF written to %s" file))
  3196. ((string= "ics" extension)
  3197. (require 'ox-icalendar)
  3198. (org-icalendar-export-current-agenda (expand-file-name file)))
  3199. (t
  3200. (let ((bs (buffer-string)))
  3201. (find-file file)
  3202. (erase-buffer)
  3203. (insert bs)
  3204. (save-buffer 0)
  3205. (kill-buffer (current-buffer))
  3206. (message "Plain text written to %s" file))))))))
  3207. (set-buffer (or agenda-bufname
  3208. (and (called-interactively-p 'any) (buffer-name))
  3209. org-agenda-buffer-name)))
  3210. (when open (org-open-file file)))
  3211. (defun org-agenda-remove-marked-text (property &optional value)
  3212. "Delete all text marked with VALUE of PROPERTY.
  3213. VALUE defaults to t."
  3214. (let (beg)
  3215. (setq value (or value t))
  3216. (while (setq beg (text-property-any (point-min) (point-max)
  3217. property value))
  3218. (delete-region
  3219. beg (or (next-single-property-change beg property)
  3220. (point-max))))))
  3221. (defun org-agenda-add-entry-text ()
  3222. "Add entry text to agenda lines.
  3223. This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
  3224. entry text following headings shown in the agenda.
  3225. Drawers will be excluded, also the line with scheduling/deadline info."
  3226. (when (and (> org-agenda-add-entry-text-maxlines 0)
  3227. (not (bound-and-true-p org-mobile-creating-agendas)))
  3228. (let (m txt)
  3229. (goto-char (point-min))
  3230. (while (not (eobp))
  3231. (if (not (setq m (org-get-at-bol 'org-hd-marker)))
  3232. (beginning-of-line 2)
  3233. (setq txt (org-agenda-get-some-entry-text
  3234. m org-agenda-add-entry-text-maxlines " > "))
  3235. (end-of-line 1)
  3236. (if (string-match "\\S-" txt)
  3237. (insert "\n" txt)
  3238. (or (eobp) (forward-char 1))))))))
  3239. (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
  3240. &rest keep)
  3241. "Extract entry text from MARKER, at most N-LINES lines.
  3242. This will ignore drawers etc, just get the text.
  3243. If INDENT is given, prefix every line with this string. If KEEP is
  3244. given, it is a list of symbols, defining stuff that should not be
  3245. removed from the entry content. Currently only `planning' is allowed here."
  3246. (let (txt drawer-re kwd-time-re ind)
  3247. (save-excursion
  3248. (with-current-buffer (marker-buffer marker)
  3249. (if (not (derived-mode-p 'org-mode))
  3250. (setq txt "")
  3251. (org-with-wide-buffer
  3252. (goto-char marker)
  3253. (end-of-line 1)
  3254. (setq txt (buffer-substring
  3255. (min (1+ (point)) (point-max))
  3256. (progn (outline-next-heading) (point)))
  3257. drawer-re org-drawer-regexp
  3258. kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
  3259. ".*\n?"))
  3260. (with-temp-buffer
  3261. (insert txt)
  3262. (when org-agenda-add-entry-text-descriptive-links
  3263. (goto-char (point-min))
  3264. (while (org-activate-links (point-max))
  3265. (add-text-properties (match-beginning 0) (match-end 0)
  3266. '(face org-link))))
  3267. (goto-char (point-min))
  3268. (while (re-search-forward org-link-bracket-re (point-max) t)
  3269. (set-text-properties (match-beginning 0) (match-end 0)
  3270. nil))
  3271. (goto-char (point-min))
  3272. (while (re-search-forward drawer-re nil t)
  3273. (delete-region
  3274. (match-beginning 0)
  3275. (progn (re-search-forward
  3276. "^[ \t]*:END:.*\n?" nil 'move)
  3277. (point))))
  3278. (unless (member 'planning keep)
  3279. (goto-char (point-min))
  3280. (while (re-search-forward kwd-time-re nil t)
  3281. (replace-match "")))
  3282. (goto-char (point-min))
  3283. (when org-agenda-entry-text-exclude-regexps
  3284. (let ((re-list org-agenda-entry-text-exclude-regexps) re)
  3285. (while (setq re (pop re-list))
  3286. (goto-char (point-min))
  3287. (while (re-search-forward re nil t)
  3288. (replace-match "")))))
  3289. (goto-char (point-max))
  3290. (skip-chars-backward " \t\n")
  3291. (when (looking-at "[ \t\n]+\\'") (replace-match ""))
  3292. ;; find and remove min common indentation
  3293. (goto-char (point-min))
  3294. (untabify (point-min) (point-max))
  3295. (setq ind (current-indentation))
  3296. (while (not (eobp))
  3297. (unless (looking-at "[ \t]*$")
  3298. (setq ind (min ind (current-indentation))))
  3299. (beginning-of-line 2))
  3300. (goto-char (point-min))
  3301. (while (not (eobp))
  3302. (unless (looking-at "[ \t]*$")
  3303. (move-to-column ind)
  3304. (delete-region (point-at-bol) (point)))
  3305. (beginning-of-line 2))
  3306. (run-hooks 'org-agenda-entry-text-cleanup-hook)
  3307. (goto-char (point-min))
  3308. (when indent
  3309. (while (and (not (eobp)) (re-search-forward "^" nil t))
  3310. (replace-match indent t t)))
  3311. (goto-char (point-min))
  3312. (while (looking-at "[ \t]*\n") (replace-match ""))
  3313. (goto-char (point-max))
  3314. (when (> (org-current-line)
  3315. n-lines)
  3316. (org-goto-line (1+ n-lines))
  3317. (backward-char 1))
  3318. (setq txt (buffer-substring (point-min) (point))))))))
  3319. txt))
  3320. (defun org-check-for-org-mode ()
  3321. "Make sure current buffer is in Org mode. Error if not."
  3322. (or (derived-mode-p 'org-mode)
  3323. (error "Cannot execute Org agenda command on buffer in %s"
  3324. major-mode)))
  3325. ;;; Agenda prepare and finalize
  3326. (defvar org-agenda-multi nil) ; dynamically scoped
  3327. (defvar org-agenda-pre-window-conf nil)
  3328. (defvar org-agenda-columns-active nil)
  3329. (defvar org-agenda-name nil)
  3330. (defvar org-agenda-tag-filter nil)
  3331. (defvar org-agenda-category-filter nil)
  3332. (defvar org-agenda-regexp-filter nil)
  3333. (defvar org-agenda-effort-filter nil)
  3334. (defvar org-agenda-top-headline-filter nil)
  3335. (defvar org-agenda-represented-categories nil
  3336. "Cache for the list of all categories in the agenda.")
  3337. (defvar org-agenda-represented-tags nil
  3338. "Cache for the list of all categories in the agenda.")
  3339. (defvar org-agenda-tag-filter-preset nil
  3340. "A preset of the tags filter used for secondary agenda filtering.
  3341. This must be a list of strings, each string must be a single tag preceded
  3342. by \"+\" or \"-\".
  3343. This variable should not be set directly, but agenda custom commands can
  3344. bind it in the options section. The preset filter is a global property of
  3345. the entire agenda view. In a block agenda, it will not work reliably to
  3346. define a filter for one of the individual blocks. You need to set it in
  3347. the global options and expect it to be applied to the entire view.")
  3348. (defconst org-agenda-filter-variables
  3349. '((category . org-agenda-category-filter)
  3350. (tag . org-agenda-tag-filter)
  3351. (effort . org-agenda-effort-filter)
  3352. (regexp . org-agenda-regexp-filter))
  3353. "Alist of filter types and associated variables")
  3354. (defun org-agenda-filter-any ()
  3355. "Is any filter active?"
  3356. (let ((form (cons 'or (mapcar (lambda (x)
  3357. (if (or (symbol-value (cdr x))
  3358. (get :preset-filter x))
  3359. t nil))
  3360. org-agenda-filter-variables))))
  3361. (eval form)))
  3362. (defvar org-agenda-category-filter-preset nil
  3363. "A preset of the category filter used for secondary agenda filtering.
  3364. This must be a list of strings, each string must be a single category
  3365. preceded by \"+\" or \"-\".
  3366. This variable should not be set directly, but agenda custom commands can
  3367. bind it in the options section. The preset filter is a global property of
  3368. the entire agenda view. In a block agenda, it will not work reliably to
  3369. define a filter for one of the individual blocks. You need to set it in
  3370. the global options and expect it to be applied to the entire view.")
  3371. (defvar org-agenda-regexp-filter-preset nil
  3372. "A preset of the regexp filter used for secondary agenda filtering.
  3373. This must be a list of strings, each string must be a single regexp
  3374. preceded by \"+\" or \"-\".
  3375. This variable should not be set directly, but agenda custom commands can
  3376. bind it in the options section. The preset filter is a global property of
  3377. the entire agenda view. In a block agenda, it will not work reliably to
  3378. define a filter for one of the individual blocks. You need to set it in
  3379. the global options and expect it to be applied to the entire view.")
  3380. (defvar org-agenda-effort-filter-preset nil
  3381. "A preset of the effort condition used for secondary agenda filtering.
  3382. This must be a list of strings, each string must be a single regexp
  3383. preceded by \"+\" or \"-\".
  3384. This variable should not be set directly, but agenda custom commands can
  3385. bind it in the options section. The preset filter is a global property of
  3386. the entire agenda view. In a block agenda, it will not work reliably to
  3387. define a filter for one of the individual blocks. You need to set it in
  3388. the global options and expect it to be applied to the entire view.")
  3389. (defun org-agenda-use-sticky-p ()
  3390. "Return non-nil if an agenda buffer named
  3391. `org-agenda-buffer-name' exists and should be shown instead of
  3392. generating a new one."
  3393. (and
  3394. ;; turned off by user
  3395. org-agenda-sticky
  3396. ;; For multi-agenda buffer already exists
  3397. (not org-agenda-multi)
  3398. ;; buffer found
  3399. (get-buffer org-agenda-buffer-name)
  3400. ;; C-u parameter is same as last call
  3401. (with-current-buffer (get-buffer org-agenda-buffer-name)
  3402. (and
  3403. (equal current-prefix-arg
  3404. org-agenda-last-prefix-arg)
  3405. ;; In case user turned stickiness on, while having existing
  3406. ;; Agenda buffer active, don't reuse that buffer, because it
  3407. ;; does not have org variables local
  3408. org-agenda-this-buffer-is-sticky))))
  3409. (defun org-agenda-prepare-window (abuf filter-alist)
  3410. "Setup agenda buffer in the window.
  3411. ABUF is the buffer for the agenda window.
  3412. FILTER-ALIST is an alist of filters we need to apply when
  3413. `org-agenda-persistent-filter' is non-nil."
  3414. (let* ((awin (get-buffer-window abuf)) wconf)
  3415. (cond
  3416. ((equal (current-buffer) abuf) nil)
  3417. (awin (select-window awin))
  3418. ((not (setq wconf (current-window-configuration))))
  3419. ((eq org-agenda-window-setup 'current-window)
  3420. (pop-to-buffer-same-window abuf))
  3421. ((eq org-agenda-window-setup 'other-window)
  3422. (org-switch-to-buffer-other-window abuf))
  3423. ((eq org-agenda-window-setup 'other-frame)
  3424. (switch-to-buffer-other-frame abuf))
  3425. ((eq org-agenda-window-setup 'only-window)
  3426. (delete-other-windows)
  3427. (pop-to-buffer-same-window abuf))
  3428. ((eq org-agenda-window-setup 'reorganize-frame)
  3429. (delete-other-windows)
  3430. (org-switch-to-buffer-other-window abuf)))
  3431. (setq org-agenda-tag-filter (cdr (assq 'tag filter-alist)))
  3432. (setq org-agenda-category-filter (cdr (assq 'cat filter-alist)))
  3433. (setq org-agenda-effort-filter (cdr (assq 'effort filter-alist)))
  3434. (setq org-agenda-regexp-filter (cdr (assq 're filter-alist)))
  3435. ;; Additional test in case agenda is invoked from within agenda
  3436. ;; buffer via elisp link.
  3437. (unless (equal (current-buffer) abuf)
  3438. (pop-to-buffer-same-window abuf))
  3439. (setq org-agenda-pre-window-conf
  3440. (or wconf org-agenda-pre-window-conf))))
  3441. (defun org-agenda-prepare (&optional name)
  3442. (let ((filter-alist (when org-agenda-persistent-filter
  3443. (with-current-buffer
  3444. (get-buffer-create org-agenda-buffer-name)
  3445. `((tag . ,org-agenda-tag-filter)
  3446. (re . ,org-agenda-regexp-filter)
  3447. (effort . ,org-agenda-effort-filter)
  3448. (cat . ,org-agenda-category-filter))))))
  3449. (if (org-agenda-use-sticky-p)
  3450. (progn
  3451. (put 'org-agenda-tag-filter :preset-filter nil)
  3452. (put 'org-agenda-category-filter :preset-filter nil)
  3453. (put 'org-agenda-regexp-filter :preset-filter nil)
  3454. (put 'org-agenda-effort-filter :preset-filter nil)
  3455. ;; Popup existing buffer
  3456. (org-agenda-prepare-window (get-buffer org-agenda-buffer-name)
  3457. filter-alist)
  3458. (message "Sticky Agenda buffer, use `r' to refresh")
  3459. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3460. (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
  3461. (setq org-todo-keywords-for-agenda nil)
  3462. (put 'org-agenda-tag-filter :preset-filter
  3463. org-agenda-tag-filter-preset)
  3464. (put 'org-agenda-category-filter :preset-filter
  3465. org-agenda-category-filter-preset)
  3466. (put 'org-agenda-regexp-filter :preset-filter
  3467. org-agenda-regexp-filter-preset)
  3468. (put 'org-agenda-effort-filter :preset-filter
  3469. org-agenda-effort-filter-preset)
  3470. (if org-agenda-multi
  3471. (progn
  3472. (setq buffer-read-only nil)
  3473. (goto-char (point-max))
  3474. (unless (or (bobp) org-agenda-compact-blocks
  3475. (not org-agenda-block-separator))
  3476. (insert "\n"
  3477. (if (stringp org-agenda-block-separator)
  3478. org-agenda-block-separator
  3479. (make-string (window-width) org-agenda-block-separator))
  3480. "\n"))
  3481. (narrow-to-region (point) (point-max)))
  3482. (setq org-done-keywords-for-agenda nil)
  3483. ;; Setting any org variables that are in org-agenda-local-vars
  3484. ;; list need to be done after the prepare call
  3485. (org-agenda-prepare-window
  3486. (get-buffer-create org-agenda-buffer-name) filter-alist)
  3487. (setq buffer-read-only nil)
  3488. (org-agenda-reset-markers)
  3489. (let ((inhibit-read-only t)) (erase-buffer))
  3490. (org-agenda-mode)
  3491. (setq org-agenda-buffer (current-buffer))
  3492. (setq org-agenda-contributing-files nil)
  3493. (setq org-agenda-columns-active nil)
  3494. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  3495. (setq org-todo-keywords-for-agenda
  3496. (org-uniquify org-todo-keywords-for-agenda))
  3497. (setq org-done-keywords-for-agenda
  3498. (org-uniquify org-done-keywords-for-agenda))
  3499. (setq org-agenda-last-prefix-arg current-prefix-arg)
  3500. (setq org-agenda-this-buffer-name org-agenda-buffer-name)
  3501. (and name (not org-agenda-name)
  3502. (setq-local org-agenda-name name)))
  3503. (setq buffer-read-only nil))))
  3504. (defvar org-overriding-columns-format)
  3505. (defvar org-local-columns-format)
  3506. (defun org-agenda-finalize ()
  3507. "Finishing touch for the agenda buffer, called just before displaying it."
  3508. (unless org-agenda-multi
  3509. (save-excursion
  3510. (let ((inhibit-read-only t))
  3511. (goto-char (point-min))
  3512. (save-excursion
  3513. (while (org-activate-links (point-max))
  3514. (add-text-properties (match-beginning 0) (match-end 0)
  3515. '(face org-link))))
  3516. (unless (eq org-agenda-remove-tags t)
  3517. (org-agenda-align-tags))
  3518. (unless org-agenda-with-colors
  3519. (remove-text-properties (point-min) (point-max) '(face nil)))
  3520. (when (bound-and-true-p org-overriding-columns-format)
  3521. (setq-local org-local-columns-format
  3522. org-overriding-columns-format))
  3523. (when org-agenda-view-columns-initially
  3524. (org-agenda-columns))
  3525. (when org-agenda-fontify-priorities
  3526. (org-agenda-fontify-priorities))
  3527. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  3528. (org-agenda-dim-blocked-tasks))
  3529. (org-agenda-mark-clocking-task)
  3530. (when org-agenda-entry-text-mode
  3531. (org-agenda-entry-text-hide)
  3532. (org-agenda-entry-text-show))
  3533. (when (and (featurep 'org-habit)
  3534. (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
  3535. (org-habit-insert-consistency-graphs))
  3536. (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
  3537. (unless (or (eq org-agenda-show-inherited-tags 'always)
  3538. (and (listp org-agenda-show-inherited-tags)
  3539. (memq org-agenda-type org-agenda-show-inherited-tags))
  3540. (and (eq org-agenda-show-inherited-tags t)
  3541. (or (eq org-agenda-use-tag-inheritance t)
  3542. (and (listp org-agenda-use-tag-inheritance)
  3543. (not (memq org-agenda-type
  3544. org-agenda-use-tag-inheritance))))))
  3545. (let (mrk)
  3546. (save-excursion
  3547. (goto-char (point-min))
  3548. (while (equal (forward-line) 0)
  3549. (when (setq mrk (get-text-property (point) 'org-hd-marker))
  3550. (put-text-property (point-at-bol) (point-at-eol)
  3551. 'tags
  3552. (org-with-point-at mrk
  3553. (mapcar #'downcase (org-get-tags)))))))))
  3554. (run-hooks 'org-agenda-finalize-hook)
  3555. (setq org-agenda-represented-tags nil
  3556. org-agenda-represented-categories nil)
  3557. (when org-agenda-top-headline-filter
  3558. (org-agenda-filter-top-headline-apply
  3559. org-agenda-top-headline-filter))
  3560. (when org-agenda-tag-filter
  3561. (org-agenda-filter-apply org-agenda-tag-filter 'tag t))
  3562. (when (get 'org-agenda-tag-filter :preset-filter)
  3563. (org-agenda-filter-apply
  3564. (get 'org-agenda-tag-filter :preset-filter) 'tag t))
  3565. (when org-agenda-category-filter
  3566. (org-agenda-filter-apply org-agenda-category-filter 'category))
  3567. (when (get 'org-agenda-category-filter :preset-filter)
  3568. (org-agenda-filter-apply
  3569. (get 'org-agenda-category-filter :preset-filter) 'category))
  3570. (when org-agenda-regexp-filter
  3571. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
  3572. (when (get 'org-agenda-regexp-filter :preset-filter)
  3573. (org-agenda-filter-apply
  3574. (get 'org-agenda-regexp-filter :preset-filter) 'regexp))
  3575. (when org-agenda-effort-filter
  3576. (org-agenda-filter-apply org-agenda-effort-filter 'effort))
  3577. (when (get 'org-agenda-effort-filter :preset-filter)
  3578. (org-agenda-filter-apply
  3579. (get 'org-agenda-effort-filter :preset-filter) 'effort))
  3580. (add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)))))
  3581. (defun org-agenda-mark-clocking-task ()
  3582. "Mark the current clock entry in the agenda if it is present."
  3583. ;; We need to widen when `org-agenda-finalize' is called from
  3584. ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in')
  3585. (when (bound-and-true-p org-clock-current-task)
  3586. (save-restriction
  3587. (widen)
  3588. (org-agenda-unmark-clocking-task)
  3589. (when (marker-buffer org-clock-hd-marker)
  3590. (save-excursion
  3591. (goto-char (point-min))
  3592. (let (s ov)
  3593. (while (setq s (next-single-property-change (point) 'org-hd-marker))
  3594. (goto-char s)
  3595. (when (equal (org-get-at-bol 'org-hd-marker)
  3596. org-clock-hd-marker)
  3597. (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
  3598. (overlay-put ov 'type 'org-agenda-clocking)
  3599. (overlay-put ov 'face 'org-agenda-clocking)
  3600. (overlay-put ov 'help-echo
  3601. "The clock is running in this item")))))))))
  3602. (defun org-agenda-unmark-clocking-task ()
  3603. "Unmark the current clocking task."
  3604. (mapc (lambda (o)
  3605. (when (eq (overlay-get o 'type) 'org-agenda-clocking)
  3606. (delete-overlay o)))
  3607. (overlays-in (point-min) (point-max))))
  3608. (defun org-agenda-fontify-priorities ()
  3609. "Make highest priority lines bold, and lowest italic."
  3610. (interactive)
  3611. (mapc (lambda (o) (when (eq (overlay-get o 'org-type) 'org-priority)
  3612. (delete-overlay o)))
  3613. (overlays-in (point-min) (point-max)))
  3614. (save-excursion
  3615. (let (b e p ov h l)
  3616. (goto-char (point-min))
  3617. (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
  3618. (setq h (or (get-char-property (point) 'org-highest-priority)
  3619. org-highest-priority)
  3620. l (or (get-char-property (point) 'org-lowest-priority)
  3621. org-lowest-priority)
  3622. p (string-to-char (match-string 1))
  3623. b (match-beginning 0)
  3624. e (if (eq org-agenda-fontify-priorities 'cookies)
  3625. (match-end 0)
  3626. (point-at-eol))
  3627. ov (make-overlay b e))
  3628. (overlay-put
  3629. ov 'face
  3630. (let ((special-face
  3631. (cond ((org-face-from-face-or-color
  3632. 'priority 'org-priority
  3633. (cdr (assoc p org-priority-faces))))
  3634. ((and (listp org-agenda-fontify-priorities)
  3635. (org-face-from-face-or-color
  3636. 'priority 'org-priority
  3637. (cdr (assoc p org-agenda-fontify-priorities)))))
  3638. ((equal p l) 'italic)
  3639. ((equal p h) 'bold))))
  3640. (if special-face (list special-face 'org-priority) 'org-priority)))
  3641. (overlay-put ov 'org-type 'org-priority)))))
  3642. (defvar org-depend-tag-blocked)
  3643. (defun org-agenda-dim-blocked-tasks (&optional invisible)
  3644. "Dim currently blocked TODOs in the agenda display.
  3645. When INVISIBLE is non-nil, hide currently blocked TODO instead of
  3646. dimming them."
  3647. (interactive "P")
  3648. (when (called-interactively-p 'interactive)
  3649. (message "Dim or hide blocked tasks..."))
  3650. (dolist (o (overlays-in (point-min) (point-max)))
  3651. (when (eq (overlay-get o 'org-type) 'org-blocked-todo)
  3652. (delete-overlay o)))
  3653. (save-excursion
  3654. (let ((inhibit-read-only t))
  3655. (goto-char (point-min))
  3656. (while (let ((pos (text-property-not-all
  3657. (point) (point-max) 'org-todo-blocked nil)))
  3658. (when pos (goto-char pos)))
  3659. (let* ((invisible (eq (org-get-at-bol 'org-todo-blocked) 'invisible))
  3660. (ov (make-overlay (if invisible
  3661. (line-end-position 0)
  3662. (line-beginning-position))
  3663. (line-end-position))))
  3664. (if invisible
  3665. (overlay-put ov 'invisible t)
  3666. (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
  3667. (overlay-put ov 'org-type 'org-blocked-todo))
  3668. (forward-line))))
  3669. (when (called-interactively-p 'interactive)
  3670. (message "Dim or hide blocked tasks...done")))
  3671. (defun org-agenda--mark-blocked-entry (entry)
  3672. "For ENTRY a string with the text property `org-hd-marker', if
  3673. the header at `org-hd-marker' is blocked according to
  3674. `org-entry-blocked-p', then if `org-agenda-dim-blocked-tasks' is
  3675. 'invisible and the header is not blocked by checkboxes, set the
  3676. text property `org-todo-blocked' to `invisible', otherwise set it
  3677. to t."
  3678. (when (get-text-property 0 'todo-state entry)
  3679. (let ((entry-marker (get-text-property 0 'org-hd-marker entry))
  3680. (org-blocked-by-checkboxes nil)
  3681. ;; Necessary so that `org-entry-blocked-p' does not change
  3682. ;; the buffer.
  3683. (org-depend-tag-blocked nil))
  3684. (when entry-marker
  3685. (let ((blocked
  3686. (with-current-buffer (marker-buffer entry-marker)
  3687. (save-excursion
  3688. (goto-char entry-marker)
  3689. (org-entry-blocked-p)))))
  3690. (when blocked
  3691. (let ((really-invisible
  3692. (and (not org-blocked-by-checkboxes)
  3693. (eq org-agenda-dim-blocked-tasks 'invisible))))
  3694. (put-text-property
  3695. 0 (length entry) 'org-todo-blocked
  3696. (if really-invisible 'invisible t)
  3697. entry)))))))
  3698. entry)
  3699. (defvar org-agenda-skip-function nil
  3700. "Function to be called at each match during agenda construction.
  3701. If this function returns nil, the current match should not be skipped.
  3702. Otherwise, the function must return a position from where the search
  3703. should be continued.
  3704. This may also be a Lisp form, it will be evaluated.
  3705. Never set this variable using `setq' or so, because then it will apply
  3706. to all future agenda commands. If you do want a global skipping condition,
  3707. use the option `org-agenda-skip-function-global' instead.
  3708. The correct usage for `org-agenda-skip-function' is to bind it with
  3709. `let' to scope it dynamically into the agenda-constructing command.
  3710. A good way to set it is through options in `org-agenda-custom-commands'.")
  3711. (defun org-agenda-skip ()
  3712. "Throw to `:skip' in places that should be skipped.
  3713. Also moves point to the end of the skipped region, so that search can
  3714. continue from there."
  3715. (let ((p (point-at-bol)) to)
  3716. (when (or
  3717. (save-excursion (goto-char p) (looking-at comment-start-skip))
  3718. (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
  3719. (get-text-property p :org-archived)
  3720. (org-end-of-subtree t))
  3721. (and org-agenda-skip-comment-trees
  3722. (get-text-property p :org-comment)
  3723. (org-end-of-subtree t))
  3724. (and (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
  3725. (org-agenda-skip-eval org-agenda-skip-function)))
  3726. (goto-char to))
  3727. (org-in-src-block-p t))
  3728. (throw :skip t))))
  3729. (defun org-agenda-skip-eval (form)
  3730. "If FORM is a function or a list, call (or eval) it and return the result.
  3731. `save-excursion' and `save-match-data' are wrapped around the call, so point
  3732. and match data are returned to the previous state no matter what these
  3733. functions do."
  3734. (let (fp)
  3735. (and form
  3736. (or (setq fp (functionp form))
  3737. (consp form))
  3738. (save-excursion
  3739. (save-match-data
  3740. (if fp
  3741. (funcall form)
  3742. (eval form)))))))
  3743. (defvar org-agenda-markers nil
  3744. "List of all currently active markers created by `org-agenda'.")
  3745. (defvar org-agenda-last-marker-time (float-time)
  3746. "Creation time of the last agenda marker.")
  3747. (defun org-agenda-new-marker (&optional pos)
  3748. "Return a new agenda marker.
  3749. Maker is at point, or at POS if non-nil. Org mode keeps a list of
  3750. these markers and resets them when they are no longer in use."
  3751. (let ((m (copy-marker (or pos (point)) t)))
  3752. (setq org-agenda-last-marker-time (float-time))
  3753. (if org-agenda-buffer
  3754. (with-current-buffer org-agenda-buffer
  3755. (push m org-agenda-markers))
  3756. (push m org-agenda-markers))
  3757. m))
  3758. (defun org-agenda-reset-markers ()
  3759. "Reset markers created by `org-agenda'."
  3760. (while org-agenda-markers
  3761. (move-marker (pop org-agenda-markers) nil)))
  3762. (defun org-agenda-save-markers-for-cut-and-paste (beg end)
  3763. "Save relative positions of markers in region.
  3764. This check for agenda markers in all agenda buffers currently active."
  3765. (dolist (buf (buffer-list))
  3766. (with-current-buffer buf
  3767. (when (eq major-mode 'org-agenda-mode)
  3768. (mapc (lambda (m) (org-check-and-save-marker m beg end))
  3769. org-agenda-markers)))))
  3770. ;;; Entry text mode
  3771. (defun org-agenda-entry-text-show-here ()
  3772. "Add some text from the entry as context to the current line."
  3773. (let (m txt o)
  3774. (setq m (org-get-at-bol 'org-hd-marker))
  3775. (unless (marker-buffer m)
  3776. (error "No marker points to an entry here"))
  3777. (setq txt (concat "\n" (org-no-properties
  3778. (org-agenda-get-some-entry-text
  3779. m org-agenda-entry-text-maxlines
  3780. org-agenda-entry-text-leaders))))
  3781. (when (string-match "\\S-" txt)
  3782. (setq o (make-overlay (point-at-bol) (point-at-eol)))
  3783. (overlay-put o 'evaporate t)
  3784. (overlay-put o 'org-overlay-type 'agenda-entry-content)
  3785. (overlay-put o 'after-string txt))))
  3786. (defun org-agenda-entry-text-show ()
  3787. "Add entry context for all agenda lines."
  3788. (interactive)
  3789. (save-excursion
  3790. (goto-char (point-max))
  3791. (beginning-of-line 1)
  3792. (while (not (bobp))
  3793. (when (org-get-at-bol 'org-hd-marker)
  3794. (org-agenda-entry-text-show-here))
  3795. (beginning-of-line 0))))
  3796. (defun org-agenda-entry-text-hide ()
  3797. "Remove any shown entry context."
  3798. (mapc (lambda (o)
  3799. (when (eq (overlay-get o 'org-overlay-type)
  3800. 'agenda-entry-content)
  3801. (delete-overlay o)))
  3802. (overlays-in (point-min) (point-max))))
  3803. (defun org-agenda-get-day-face (date)
  3804. "Return the face DATE should be displayed with."
  3805. (cond ((and (functionp org-agenda-day-face-function)
  3806. (funcall org-agenda-day-face-function date)))
  3807. ((org-agenda-today-p date) 'org-agenda-date-today)
  3808. ((memq (calendar-day-of-week date) org-agenda-weekend-days)
  3809. 'org-agenda-date-weekend)
  3810. (t 'org-agenda-date)))
  3811. (defvar org-agenda-show-log-scoped)
  3812. ;;; Agenda Daily/Weekly
  3813. (defvar org-agenda-start-day nil ; dynamically scoped parameter
  3814. "Start day for the agenda view.
  3815. Custom commands can set this variable in the options section.
  3816. This is usually a string like \"2007-11-01\", \"+2d\" or any other
  3817. input allowed when reading a date through the Org calendar.
  3818. See the docstring of `org-read-date' for details.")
  3819. (defvar org-starting-day nil) ; local variable in the agenda buffer
  3820. (defvar org-arg-loc nil) ; local variable
  3821. (defvar org-agenda-buffer-tmp-name nil)
  3822. ;;;###autoload
  3823. (defun org-agenda-list (&optional arg start-day span with-hour)
  3824. "Produce a daily/weekly view from all files in variable `org-agenda-files'.
  3825. The view will be for the current day or week, but from the overview buffer
  3826. you will be able to go to other days/weeks.
  3827. With a numeric prefix argument in an interactive call, the agenda will
  3828. span ARG days. Lisp programs should instead specify SPAN to change
  3829. the number of days. SPAN defaults to `org-agenda-span'.
  3830. START-DAY defaults to TODAY, or to the most recent match for the weekday
  3831. given in `org-agenda-start-on-weekday'.
  3832. When WITH-HOUR is non-nil, only include scheduled and deadline
  3833. items if they have an hour specification like [h]h:mm."
  3834. (interactive "P")
  3835. (when org-agenda-overriding-arguments
  3836. (setq arg (car org-agenda-overriding-arguments)
  3837. start-day (nth 1 org-agenda-overriding-arguments)
  3838. span (nth 2 org-agenda-overriding-arguments)))
  3839. (when (and (integerp arg) (> arg 0))
  3840. (setq span arg arg nil))
  3841. (when (numberp span)
  3842. (unless (< 0 span)
  3843. (user-error "Agenda creation impossible for this span(=%d days)." span)))
  3844. (catch 'exit
  3845. (setq org-agenda-buffer-name
  3846. (or org-agenda-buffer-tmp-name
  3847. (and org-agenda-doing-sticky-redo org-agenda-buffer-name)
  3848. (when org-agenda-sticky
  3849. (cond ((and org-keys (stringp org-match))
  3850. (format "*Org Agenda(%s:%s)*" org-keys org-match))
  3851. (org-keys
  3852. (format "*Org Agenda(%s)*" org-keys))
  3853. (t "*Org Agenda(a)*")))
  3854. "*Org Agenda*"))
  3855. (org-agenda-prepare "Day/Week")
  3856. (setq start-day (or start-day org-agenda-start-day))
  3857. (when (stringp start-day)
  3858. ;; Convert to an absolute day number
  3859. (setq start-day (time-to-days (org-read-date nil t start-day))))
  3860. (org-compile-prefix-format 'agenda)
  3861. (org-set-sorting-strategy 'agenda)
  3862. (let* ((span (org-agenda-ndays-to-span (or span org-agenda-span)))
  3863. (today (org-today))
  3864. (sd (or start-day today))
  3865. (ndays (org-agenda-span-to-ndays span sd))
  3866. (org-agenda-start-on-weekday
  3867. (and (or (eq ndays 7) (eq ndays 14))
  3868. org-agenda-start-on-weekday))
  3869. (thefiles (org-agenda-files nil 'ifmode))
  3870. (files thefiles)
  3871. (start (if (or (null org-agenda-start-on-weekday)
  3872. (< ndays 7))
  3873. sd
  3874. (let* ((nt (calendar-day-of-week
  3875. (calendar-gregorian-from-absolute sd)))
  3876. (n1 org-agenda-start-on-weekday)
  3877. (d (- nt n1)))
  3878. (- sd (+ (if (< d 0) 7 0) d)))))
  3879. (day-numbers (list start))
  3880. (day-cnt 0)
  3881. (inhibit-redisplay (not debug-on-error))
  3882. (org-agenda-show-log-scoped org-agenda-show-log)
  3883. s e rtn rtnall file date d start-pos end-pos todayp
  3884. clocktable-start clocktable-end filter)
  3885. (setq org-agenda-redo-command
  3886. (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span) with-hour))
  3887. (dotimes (n (1- ndays))
  3888. (push (1+ (car day-numbers)) day-numbers))
  3889. (setq day-numbers (nreverse day-numbers))
  3890. (setq clocktable-start (car day-numbers)
  3891. clocktable-end (1+ (or (org-last day-numbers) 0)))
  3892. (setq-local org-starting-day (car day-numbers))
  3893. (setq-local org-arg-loc arg)
  3894. (setq-local org-agenda-current-span (org-agenda-ndays-to-span span))
  3895. (unless org-agenda-compact-blocks
  3896. (let* ((d1 (car day-numbers))
  3897. (d2 (org-last day-numbers))
  3898. (w1 (org-days-to-iso-week d1))
  3899. (w2 (org-days-to-iso-week d2)))
  3900. (setq s (point))
  3901. (org-agenda--insert-overriding-header
  3902. (concat (org-agenda-span-name span)
  3903. "-agenda"
  3904. (cond ((<= 350 (- d2 d1)) "")
  3905. ((= w1 w2) (format " (W%02d)" w1))
  3906. (t (format " (W%02d-W%02d)" w1 w2)))
  3907. ":\n")))
  3908. ;; Add properties if we actually inserted a header.
  3909. (when (> (point) s)
  3910. (add-text-properties s (1- (point))
  3911. (list 'face 'org-agenda-structure
  3912. 'org-date-line t))
  3913. (org-agenda-mark-header-line s)))
  3914. (while (setq d (pop day-numbers))
  3915. (setq date (calendar-gregorian-from-absolute d)
  3916. s (point))
  3917. (if (or (setq todayp (= d today))
  3918. (and (not start-pos) (= d sd)))
  3919. (setq start-pos (point))
  3920. (when (and start-pos (not end-pos))
  3921. (setq end-pos (point))))
  3922. (setq files thefiles
  3923. rtnall nil)
  3924. (while (setq file (pop files))
  3925. (catch 'nextfile
  3926. (org-check-agenda-file file)
  3927. (let ((org-agenda-entry-types org-agenda-entry-types))
  3928. ;; Starred types override non-starred equivalents
  3929. (when (member :deadline* org-agenda-entry-types)
  3930. (setq org-agenda-entry-types
  3931. (delq :deadline org-agenda-entry-types)))
  3932. (when (member :scheduled* org-agenda-entry-types)
  3933. (setq org-agenda-entry-types
  3934. (delq :scheduled org-agenda-entry-types)))
  3935. ;; Honor with-hour
  3936. (when with-hour
  3937. (when (member :deadline org-agenda-entry-types)
  3938. (setq org-agenda-entry-types
  3939. (delq :deadline org-agenda-entry-types))
  3940. (push :deadline* org-agenda-entry-types))
  3941. (when (member :scheduled org-agenda-entry-types)
  3942. (setq org-agenda-entry-types
  3943. (delq :scheduled org-agenda-entry-types))
  3944. (push :scheduled* org-agenda-entry-types)))
  3945. (unless org-agenda-include-deadlines
  3946. (setq org-agenda-entry-types
  3947. (delq :deadline* (delq :deadline org-agenda-entry-types))))
  3948. (cond
  3949. ((memq org-agenda-show-log-scoped '(only clockcheck))
  3950. (setq rtn (org-agenda-get-day-entries
  3951. file date :closed)))
  3952. (org-agenda-show-log-scoped
  3953. (setq rtn (apply 'org-agenda-get-day-entries
  3954. file date
  3955. (append '(:closed) org-agenda-entry-types))))
  3956. (t
  3957. (setq rtn (apply 'org-agenda-get-day-entries
  3958. file date
  3959. org-agenda-entry-types)))))
  3960. (setq rtnall (append rtnall rtn)))) ;; all entries
  3961. (when org-agenda-include-diary
  3962. (let ((org-agenda-search-headline-for-time t))
  3963. (require 'diary-lib)
  3964. (setq rtn (org-get-entries-from-diary date))
  3965. (setq rtnall (append rtnall rtn))))
  3966. (when (or rtnall org-agenda-show-all-dates)
  3967. (setq day-cnt (1+ day-cnt))
  3968. (insert
  3969. (if (stringp org-agenda-format-date)
  3970. (format-time-string org-agenda-format-date
  3971. (org-time-from-absolute date))
  3972. (funcall org-agenda-format-date date))
  3973. "\n")
  3974. (put-text-property s (1- (point)) 'face
  3975. (org-agenda-get-day-face date))
  3976. (put-text-property s (1- (point)) 'org-date-line t)
  3977. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3978. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
  3979. (when todayp
  3980. (put-text-property s (1- (point)) 'org-today t))
  3981. (setq rtnall
  3982. (org-agenda-add-time-grid-maybe rtnall ndays todayp))
  3983. (when rtnall (insert ;; all entries
  3984. (org-agenda-finalize-entries rtnall 'agenda)
  3985. "\n"))
  3986. (put-text-property s (1- (point)) 'day d)
  3987. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)))
  3988. (when (and org-agenda-clockreport-mode clocktable-start)
  3989. (let ((org-agenda-files (org-agenda-files nil 'ifmode))
  3990. ;; the above line is to ensure the restricted range!
  3991. (p (copy-sequence org-agenda-clockreport-parameter-plist))
  3992. tbl)
  3993. (setq p (org-plist-delete p :block))
  3994. (setq p (plist-put p :tstart clocktable-start))
  3995. (setq p (plist-put p :tend clocktable-end))
  3996. (setq p (plist-put p :scope 'agenda))
  3997. (setq tbl (apply 'org-clock-get-clocktable p))
  3998. (insert tbl)))
  3999. (goto-char (point-min))
  4000. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4001. (unless (or (not (get-buffer-window))
  4002. (and (pos-visible-in-window-p (point-min))
  4003. (pos-visible-in-window-p (point-max))))
  4004. (goto-char (1- (point-max)))
  4005. (recenter -1)
  4006. (when (not (pos-visible-in-window-p (or start-pos 1)))
  4007. (goto-char (or start-pos 1))
  4008. (recenter 1)))
  4009. (goto-char (or start-pos 1))
  4010. (add-text-properties (point-min) (point-max)
  4011. `(org-agenda-type agenda
  4012. org-last-args (,arg ,start-day ,span)
  4013. org-redo-cmd ,org-agenda-redo-command
  4014. org-series-cmd ,org-cmd))
  4015. (when (eq org-agenda-show-log-scoped 'clockcheck)
  4016. (org-agenda-show-clocking-issues))
  4017. (org-agenda-finalize)
  4018. (setq buffer-read-only t)
  4019. (message ""))))
  4020. (defun org-agenda-ndays-to-span (n)
  4021. "Return a span symbol for a span of N days, or N if none matches."
  4022. (cond ((symbolp n) n)
  4023. ((= n 1) 'day)
  4024. ((= n 7) 'week)
  4025. ((= n 14) 'fortnight)
  4026. (t n)))
  4027. (defun org-agenda-span-to-ndays (span &optional start-day)
  4028. "Return ndays from SPAN, possibly starting at START-DAY.
  4029. START-DAY is an absolute time value."
  4030. (cond ((numberp span) span)
  4031. ((eq span 'day) 1)
  4032. ((eq span 'week) 7)
  4033. ((eq span 'fortnight) 14)
  4034. ((eq span 'month)
  4035. (let ((date (calendar-gregorian-from-absolute start-day)))
  4036. (calendar-last-day-of-month (car date) (cl-caddr date))))
  4037. ((eq span 'year)
  4038. (let ((date (calendar-gregorian-from-absolute start-day)))
  4039. (if (calendar-leap-year-p (cl-caddr date)) 366 365)))))
  4040. (defun org-agenda-span-name (span)
  4041. "Return a SPAN name."
  4042. (if (null span)
  4043. ""
  4044. (if (symbolp span)
  4045. (capitalize (symbol-name span))
  4046. (format "%d days" span))))
  4047. ;;; Agenda word search
  4048. (defvar org-agenda-search-history nil)
  4049. (defvar org-search-syntax-table nil
  4050. "Special syntax table for Org search.
  4051. In this table, we have single quotes not as word constituents, to
  4052. that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
  4053. (defvar org-mode-syntax-table) ; From org.el
  4054. (defun org-search-syntax-table ()
  4055. (unless org-search-syntax-table
  4056. (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
  4057. (modify-syntax-entry ?' "." org-search-syntax-table)
  4058. (modify-syntax-entry ?` "." org-search-syntax-table))
  4059. org-search-syntax-table)
  4060. (defvar org-agenda-last-search-view-search-was-boolean nil)
  4061. ;;;###autoload
  4062. (defun org-search-view (&optional todo-only string edit-at)
  4063. "Show all entries that contain a phrase or words or regular expressions.
  4064. With optional prefix argument TODO-ONLY, only consider entries that are
  4065. TODO entries. The argument STRING can be used to pass a default search
  4066. string into this function. If EDIT-AT is non-nil, it means that the
  4067. user should get a chance to edit this string, with cursor at position
  4068. EDIT-AT.
  4069. The search string can be viewed either as a phrase that should be found as
  4070. is, or it can be broken into a number of snippets, each of which must match
  4071. in a Boolean way to select an entry. The default depends on the variable
  4072. `org-agenda-search-view-always-boolean'.
  4073. Even if this is turned off (the default) you can always switch to
  4074. Boolean search dynamically by preceding the first word with \"+\" or \"-\".
  4075. The default is a direct search of the whole phrase, where each space in
  4076. the search string can expand to an arbitrary amount of whitespace,
  4077. including newlines.
  4078. If using a Boolean search, the search string is split on whitespace and
  4079. each snippet is searched separately, with logical AND to select an entry.
  4080. Words prefixed with a minus must *not* occur in the entry. Words without
  4081. a prefix or prefixed with a plus must occur in the entry. Matching is
  4082. case-insensitive. Words are enclosed by word delimiters (i.e. they must
  4083. match whole words, not parts of a word) if
  4084. `org-agenda-search-view-force-full-words' is set (default is nil).
  4085. Boolean search snippets enclosed by curly braces are interpreted as
  4086. regular expressions that must or (when preceded with \"-\") must not
  4087. match in the entry. Snippets enclosed into double quotes will be taken
  4088. as a whole, to include whitespace.
  4089. - If the search string starts with an asterisk, search only in headlines.
  4090. - If (possibly after the leading star) the search string starts with an
  4091. exclamation mark, this also means to look at TODO entries only, an effect
  4092. that can also be achieved with a prefix argument.
  4093. - If (possibly after star and exclamation mark) the search string starts
  4094. with a colon, this will mean that the (non-regexp) snippets of the
  4095. Boolean search must match as full words.
  4096. This command searches the agenda files, and in addition the files
  4097. listed in `org-agenda-text-search-extra-files' unless a restriction lock
  4098. is active."
  4099. (interactive "P")
  4100. (when org-agenda-overriding-arguments
  4101. (setq todo-only (car org-agenda-overriding-arguments)
  4102. string (nth 1 org-agenda-overriding-arguments)
  4103. edit-at (nth 2 org-agenda-overriding-arguments)))
  4104. (let* ((props (list 'face nil
  4105. 'done-face 'org-agenda-done
  4106. 'org-not-done-regexp org-not-done-regexp
  4107. 'org-todo-regexp org-todo-regexp
  4108. 'org-complex-heading-regexp org-complex-heading-regexp
  4109. 'mouse-face 'highlight
  4110. 'help-echo (format "mouse-2 or RET jump to location")))
  4111. (full-words org-agenda-search-view-force-full-words)
  4112. (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
  4113. regexp rtn rtnall files file pos inherited-tags
  4114. marker category level tags c neg re boolean
  4115. ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
  4116. (unless (and (not edit-at)
  4117. (stringp string)
  4118. (string-match "\\S-" string))
  4119. (setq string (read-string
  4120. (if org-agenda-search-view-always-boolean
  4121. "[+-]Word/{Regexp} ...: "
  4122. "Phrase or [+-]Word/{Regexp} ...: ")
  4123. (cond
  4124. ((integerp edit-at) (cons string edit-at))
  4125. (edit-at string))
  4126. 'org-agenda-search-history)))
  4127. (catch 'exit
  4128. (when org-agenda-sticky
  4129. (setq org-agenda-buffer-name
  4130. (if (stringp string)
  4131. (format "*Org Agenda(%s:%s)*"
  4132. (or org-keys (or (and todo-only "S") "s")) string)
  4133. (format "*Org Agenda(%s)*" (or (and todo-only "S") "s")))))
  4134. (org-agenda-prepare "SEARCH")
  4135. (org-compile-prefix-format 'search)
  4136. (org-set-sorting-strategy 'search)
  4137. (setq org-agenda-redo-command
  4138. (list 'org-search-view (if todo-only t nil)
  4139. (list 'if 'current-prefix-arg nil string)))
  4140. (setq org-agenda-query-string string)
  4141. (if (equal (string-to-char string) ?*)
  4142. (setq hdl-only t
  4143. words (substring string 1))
  4144. (setq words string))
  4145. (when (equal (string-to-char words) ?!)
  4146. (setq todo-only t
  4147. words (substring words 1)))
  4148. (when (equal (string-to-char words) ?:)
  4149. (setq full-words t
  4150. words (substring words 1)))
  4151. (when (or org-agenda-search-view-always-boolean
  4152. (member (string-to-char words) '(?- ?+ ?\{)))
  4153. (setq boolean t))
  4154. (setq words (split-string words))
  4155. (let (www w)
  4156. (while (setq w (pop words))
  4157. (while (and (string-match "\\\\\\'" w) words)
  4158. (setq w (concat (substring w 0 -1) " " (pop words))))
  4159. (push w www))
  4160. (setq words (nreverse www) www nil)
  4161. (while (setq w (pop words))
  4162. (when (and (string-match "\\`[-+]?{" w)
  4163. (not (string-match "}\\'" w)))
  4164. (while (and words (not (string-match "}\\'" (car words))))
  4165. (setq w (concat w " " (pop words))))
  4166. (setq w (concat w " " (pop words))))
  4167. (push w www))
  4168. (setq words (nreverse www)))
  4169. (setq org-agenda-last-search-view-search-was-boolean boolean)
  4170. (when boolean
  4171. (let (wds w)
  4172. (while (setq w (pop words))
  4173. (when (or (equal (substring w 0 1) "\"")
  4174. (and (> (length w) 1)
  4175. (member (substring w 0 1) '("+" "-"))
  4176. (equal (substring w 1 2) "\"")))
  4177. (while (and words (not (equal (substring w -1) "\"")))
  4178. (setq w (concat w " " (pop words)))))
  4179. (and (string-match "\\`\\([-+]?\\)\"" w)
  4180. (setq w (replace-match "\\1" nil nil w)))
  4181. (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
  4182. (push w wds))
  4183. (setq words (nreverse wds))))
  4184. (if boolean
  4185. (mapc (lambda (w)
  4186. (setq c (string-to-char w))
  4187. (if (equal c ?-)
  4188. (setq neg t w (substring w 1))
  4189. (if (equal c ?+)
  4190. (setq neg nil w (substring w 1))
  4191. (setq neg nil)))
  4192. (if (string-match "\\`{.*}\\'" w)
  4193. (setq re (substring w 1 -1))
  4194. (if full-words
  4195. (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
  4196. (setq re (regexp-quote (downcase w)))))
  4197. (if neg (push re regexps-) (push re regexps+)))
  4198. words)
  4199. (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
  4200. regexps+))
  4201. (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
  4202. (if (not regexps+)
  4203. (setq regexp org-outline-regexp-bol)
  4204. (setq regexp (pop regexps+))
  4205. (when hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
  4206. regexp))))
  4207. (setq files (org-agenda-files nil 'ifmode))
  4208. ;; Add `org-agenda-text-search-extra-files' unless there is some
  4209. ;; restriction.
  4210. (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
  4211. (pop org-agenda-text-search-extra-files)
  4212. (unless (get 'org-agenda-files 'org-restrict)
  4213. (setq files (org-add-archive-files files))))
  4214. ;; Uniquify files. However, let `org-check-agenda-file' handle
  4215. ;; non-existent ones.
  4216. (setq files (cl-remove-duplicates
  4217. (append files org-agenda-text-search-extra-files)
  4218. :test (lambda (a b)
  4219. (and (file-exists-p a)
  4220. (file-exists-p b)
  4221. (file-equal-p a b))))
  4222. rtnall nil)
  4223. (while (setq file (pop files))
  4224. (setq ee nil)
  4225. (catch 'nextfile
  4226. (org-check-agenda-file file)
  4227. (setq buffer (if (file-exists-p file)
  4228. (org-get-agenda-file-buffer file)
  4229. (error "No such file %s" file)))
  4230. (unless buffer
  4231. ;; If file does not exist, make sure an error message is sent
  4232. (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
  4233. file))))
  4234. (with-current-buffer buffer
  4235. (with-syntax-table (org-search-syntax-table)
  4236. (unless (derived-mode-p 'org-mode)
  4237. (error "Agenda file %s is not in Org mode" file))
  4238. (let ((case-fold-search t))
  4239. (save-excursion
  4240. (save-restriction
  4241. (if (eq buffer org-agenda-restrict)
  4242. (narrow-to-region org-agenda-restrict-begin
  4243. org-agenda-restrict-end)
  4244. (widen))
  4245. (goto-char (point-min))
  4246. (unless (or (org-at-heading-p)
  4247. (outline-next-heading))
  4248. (throw 'nextfile t))
  4249. (goto-char (max (point-min) (1- (point))))
  4250. (while (re-search-forward regexp nil t)
  4251. (org-back-to-heading t)
  4252. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4253. (> (org-reduced-level (org-outline-level))
  4254. org-agenda-search-view-max-outline-level)
  4255. (forward-line -1)
  4256. (org-back-to-heading t)))
  4257. (skip-chars-forward "* ")
  4258. (setq beg (point-at-bol)
  4259. beg1 (point)
  4260. end (progn
  4261. (outline-next-heading)
  4262. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4263. (> (org-reduced-level (org-outline-level))
  4264. org-agenda-search-view-max-outline-level)
  4265. (forward-line 1)
  4266. (outline-next-heading)))
  4267. (point)))
  4268. (catch :skip
  4269. (goto-char beg)
  4270. (org-agenda-skip)
  4271. (setq str (buffer-substring-no-properties
  4272. (point-at-bol)
  4273. (if hdl-only (point-at-eol) end)))
  4274. (mapc (lambda (wr) (when (string-match wr str)
  4275. (goto-char (1- end))
  4276. (throw :skip t)))
  4277. regexps-)
  4278. (mapc (lambda (wr) (unless (string-match wr str)
  4279. (goto-char (1- end))
  4280. (throw :skip t)))
  4281. (if todo-only
  4282. (cons (concat "^\\*+[ \t]+"
  4283. org-not-done-regexp)
  4284. regexps+)
  4285. regexps+))
  4286. (goto-char beg)
  4287. (setq marker (org-agenda-new-marker (point))
  4288. category (org-get-category)
  4289. level (make-string (org-reduced-level (org-outline-level)) ? )
  4290. inherited-tags
  4291. (or (eq org-agenda-show-inherited-tags 'always)
  4292. (and (listp org-agenda-show-inherited-tags)
  4293. (memq 'todo org-agenda-show-inherited-tags))
  4294. (and (eq org-agenda-show-inherited-tags t)
  4295. (or (eq org-agenda-use-tag-inheritance t)
  4296. (memq 'todo org-agenda-use-tag-inheritance))))
  4297. tags (org-get-tags nil (not inherited-tags))
  4298. txt (org-agenda-format-item
  4299. ""
  4300. (buffer-substring-no-properties
  4301. beg1 (point-at-eol))
  4302. level category tags t))
  4303. (org-add-props txt props
  4304. 'org-marker marker 'org-hd-marker marker
  4305. 'org-todo-regexp org-todo-regexp
  4306. 'level level
  4307. 'org-complex-heading-regexp org-complex-heading-regexp
  4308. 'priority 1000
  4309. 'type "search")
  4310. (push txt ee)
  4311. (goto-char (1- end))))))))))
  4312. (setq rtn (nreverse ee))
  4313. (setq rtnall (append rtnall rtn)))
  4314. (org-agenda--insert-overriding-header
  4315. (with-temp-buffer
  4316. (insert "Search words: ")
  4317. (add-text-properties (point-min) (1- (point))
  4318. (list 'face 'org-agenda-structure))
  4319. (setq pos (point))
  4320. (insert string "\n")
  4321. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4322. (setq pos (point))
  4323. (unless org-agenda-multi
  4324. (insert (substitute-command-keys "\\<org-agenda-mode-map>\
  4325. Press `\\[org-agenda-manipulate-query-add]', \
  4326. `\\[org-agenda-manipulate-query-subtract]' to add/sub word, \
  4327. `\\[org-agenda-manipulate-query-add-re]', \
  4328. `\\[org-agenda-manipulate-query-subtract-re]' to add/sub regexp, \
  4329. `\\[universal-argument] \\[org-agenda-redo]' for a fresh search\n"))
  4330. (add-text-properties pos (1- (point))
  4331. (list 'face 'org-agenda-structure)))
  4332. (buffer-string)))
  4333. (org-agenda-mark-header-line (point-min))
  4334. (when rtnall
  4335. (insert (org-agenda-finalize-entries rtnall 'search) "\n"))
  4336. (goto-char (point-min))
  4337. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4338. (add-text-properties (point-min) (point-max)
  4339. `(org-agenda-type search
  4340. org-last-args (,todo-only ,string ,edit-at)
  4341. org-redo-cmd ,org-agenda-redo-command
  4342. org-series-cmd ,org-cmd))
  4343. (org-agenda-finalize)
  4344. (setq buffer-read-only t))))
  4345. ;;; Agenda TODO list
  4346. (defun org-agenda-propertize-selected-todo-keywords (keywords)
  4347. "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
  4348. (concat
  4349. (if (or (equal keywords "ALL") (not keywords))
  4350. (propertize "ALL" 'face 'warning)
  4351. (mapconcat
  4352. (lambda (kw)
  4353. (propertize kw 'face (org-get-todo-face kw)))
  4354. (org-split-string keywords "|")
  4355. "|"))
  4356. "\n"))
  4357. (defvar org-select-this-todo-keyword nil)
  4358. (defvar org-last-arg nil)
  4359. ;;;###autoload
  4360. (defun org-todo-list (&optional arg)
  4361. "Show all (not done) TODO entries from all agenda file in a single list.
  4362. The prefix arg can be used to select a specific TODO keyword and limit
  4363. the list to these. When using `\\[universal-argument]', you will be prompted
  4364. for a keyword. A numeric prefix directly selects the Nth keyword in
  4365. `org-todo-keywords-1'."
  4366. (interactive "P")
  4367. (when org-agenda-overriding-arguments
  4368. (setq arg org-agenda-overriding-arguments))
  4369. (when (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
  4370. (let* ((today (org-today))
  4371. (date (calendar-gregorian-from-absolute today))
  4372. (completion-ignore-case t)
  4373. kwds org-select-this-todo-keyword rtn rtnall files file pos)
  4374. (catch 'exit
  4375. (when org-agenda-sticky
  4376. (setq org-agenda-buffer-name
  4377. (if (stringp org-select-this-todo-keyword)
  4378. (format "*Org Agenda(%s:%s)*" (or org-keys "t")
  4379. org-select-this-todo-keyword)
  4380. (format "*Org Agenda(%s)*" (or org-keys "t")))))
  4381. (org-agenda-prepare "TODO")
  4382. (setq kwds org-todo-keywords-for-agenda
  4383. org-select-this-todo-keyword (if (stringp arg) arg
  4384. (and (integerp arg)
  4385. (> arg 0)
  4386. (nth (1- arg) kwds))))
  4387. (when (equal arg '(4))
  4388. (setq org-select-this-todo-keyword
  4389. (completing-read "Keyword (or KWD1|K2D2|...): "
  4390. (mapcar #'list kwds) nil nil)))
  4391. (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
  4392. (org-compile-prefix-format 'todo)
  4393. (org-set-sorting-strategy 'todo)
  4394. (setq org-agenda-redo-command
  4395. `(org-todo-list (or (and (numberp current-prefix-arg)
  4396. current-prefix-arg)
  4397. ,org-select-this-todo-keyword
  4398. current-prefix-arg ,arg)))
  4399. (setq files (org-agenda-files nil 'ifmode)
  4400. rtnall nil)
  4401. (while (setq file (pop files))
  4402. (catch 'nextfile
  4403. (org-check-agenda-file file)
  4404. (setq rtn (org-agenda-get-day-entries file date :todo))
  4405. (setq rtnall (append rtnall rtn))))
  4406. (org-agenda--insert-overriding-header
  4407. (with-temp-buffer
  4408. (insert "Global list of TODO items of type: ")
  4409. (add-text-properties (point-min) (1- (point))
  4410. (list 'face 'org-agenda-structure
  4411. 'short-heading
  4412. (concat "ToDo: "
  4413. (or org-select-this-todo-keyword "ALL"))))
  4414. (org-agenda-mark-header-line (point-min))
  4415. (insert (org-agenda-propertize-selected-todo-keywords
  4416. org-select-this-todo-keyword))
  4417. (setq pos (point))
  4418. (unless org-agenda-multi
  4419. (insert (substitute-command-keys "Press \
  4420. \\<org-agenda-mode-map>`N \\[org-agenda-redo]' (e.g. `0 \\[org-agenda-redo]') \
  4421. to search again: (0)[ALL]"))
  4422. (let ((n 0))
  4423. (dolist (k kwds)
  4424. (let ((s (format "(%d)%s" (cl-incf n) k)))
  4425. (when (> (+ (current-column) (string-width s) 1) (window-width))
  4426. (insert "\n "))
  4427. (insert " " s))))
  4428. (insert "\n"))
  4429. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure))
  4430. (buffer-string)))
  4431. (org-agenda-mark-header-line (point-min))
  4432. (when rtnall
  4433. (insert (org-agenda-finalize-entries rtnall 'todo) "\n"))
  4434. (goto-char (point-min))
  4435. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4436. (add-text-properties (point-min) (point-max)
  4437. `(org-agenda-type todo
  4438. org-last-args ,arg
  4439. org-redo-cmd ,org-agenda-redo-command
  4440. org-series-cmd ,org-cmd))
  4441. (org-agenda-finalize)
  4442. (setq buffer-read-only t))))
  4443. ;;; Agenda tags match
  4444. ;;;###autoload
  4445. (defun org-tags-view (&optional todo-only match)
  4446. "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
  4447. The prefix arg TODO-ONLY limits the search to TODO entries."
  4448. (interactive "P")
  4449. (when org-agenda-overriding-arguments
  4450. (setq todo-only (car org-agenda-overriding-arguments)
  4451. match (nth 1 org-agenda-overriding-arguments)))
  4452. (let* ((org-tags-match-list-sublevels
  4453. org-tags-match-list-sublevels)
  4454. (completion-ignore-case t)
  4455. (org--matcher-tags-todo-only todo-only)
  4456. rtn rtnall files file pos matcher
  4457. buffer)
  4458. (when (and (stringp match) (not (string-match "\\S-" match)))
  4459. (setq match nil))
  4460. (catch 'exit
  4461. ;; TODO: this code is repeated a lot...
  4462. (when org-agenda-sticky
  4463. (setq org-agenda-buffer-name
  4464. (if (stringp match)
  4465. (format "*Org Agenda(%s:%s)*"
  4466. (or org-keys (or (and todo-only "M") "m")) match)
  4467. (format "*Org Agenda(%s)*" (or (and todo-only "M") "m")))))
  4468. (setq matcher (org-make-tags-matcher match))
  4469. ;; Prepare agendas (and `org-tag-alist-for-agenda') before
  4470. ;; expanding tags within `org-make-tags-matcher'
  4471. (org-agenda-prepare (concat "TAGS " match))
  4472. (setq match (car matcher)
  4473. matcher (cdr matcher))
  4474. (org-compile-prefix-format 'tags)
  4475. (org-set-sorting-strategy 'tags)
  4476. (setq org-agenda-query-string match)
  4477. (setq org-agenda-redo-command
  4478. (list 'org-tags-view
  4479. `(quote ,org--matcher-tags-todo-only)
  4480. `(if current-prefix-arg nil ,org-agenda-query-string)))
  4481. (setq files (org-agenda-files nil 'ifmode)
  4482. rtnall nil)
  4483. (while (setq file (pop files))
  4484. (catch 'nextfile
  4485. (org-check-agenda-file file)
  4486. (setq buffer (if (file-exists-p file)
  4487. (org-get-agenda-file-buffer file)
  4488. (error "No such file %s" file)))
  4489. (if (not buffer)
  4490. ;; If file does not exist, error message to agenda
  4491. (setq rtn (list
  4492. (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4493. rtnall (append rtnall rtn))
  4494. (with-current-buffer buffer
  4495. (unless (derived-mode-p 'org-mode)
  4496. (error "Agenda file %s is not in Org mode" file))
  4497. (save-excursion
  4498. (save-restriction
  4499. (if (eq buffer org-agenda-restrict)
  4500. (narrow-to-region org-agenda-restrict-begin
  4501. org-agenda-restrict-end)
  4502. (widen))
  4503. (setq rtn (org-scan-tags 'agenda
  4504. matcher
  4505. org--matcher-tags-todo-only))
  4506. (setq rtnall (append rtnall rtn))))))))
  4507. (org-agenda--insert-overriding-header
  4508. (with-temp-buffer
  4509. (insert "Headlines with TAGS match: ")
  4510. (add-text-properties (point-min) (1- (point))
  4511. (list 'face 'org-agenda-structure
  4512. 'short-heading
  4513. (concat "Match: " match)))
  4514. (setq pos (point))
  4515. (insert match "\n")
  4516. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4517. (setq pos (point))
  4518. (unless org-agenda-multi
  4519. (insert (substitute-command-keys
  4520. "Press \
  4521. \\<org-agenda-mode-map>`\\[universal-argument] \\[org-agenda-redo]' \
  4522. to search again\n")))
  4523. (add-text-properties pos (1- (point))
  4524. (list 'face 'org-agenda-structure))
  4525. (buffer-string)))
  4526. (org-agenda-mark-header-line (point-min))
  4527. (when rtnall
  4528. (insert (org-agenda-finalize-entries rtnall 'tags) "\n"))
  4529. (goto-char (point-min))
  4530. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4531. (add-text-properties
  4532. (point-min) (point-max)
  4533. `(org-agenda-type tags
  4534. org-last-args (,org--matcher-tags-todo-only ,match)
  4535. org-redo-cmd ,org-agenda-redo-command
  4536. org-series-cmd ,org-cmd))
  4537. (org-agenda-finalize)
  4538. (setq buffer-read-only t))))
  4539. ;;; Agenda Finding stuck projects
  4540. (defvar org-agenda-skip-regexp nil
  4541. "Regular expression used in skipping subtrees for the agenda.
  4542. This is basically a temporary global variable that can be set and then
  4543. used by user-defined selections using `org-agenda-skip-function'.")
  4544. (defvar org-agenda-overriding-header nil
  4545. "When set during agenda, todo and tags searches it replaces the header.
  4546. If an empty string, no header will be inserted. If any other
  4547. string, it will be inserted as a header. If nil, a header will
  4548. be generated automatically according to the command. This
  4549. variable should not be set directly, but custom commands can bind
  4550. it in the options section.")
  4551. (defun org-agenda-skip-entry-if (&rest conditions)
  4552. "Skip entry if any of CONDITIONS is true.
  4553. See `org-agenda-skip-if' for details."
  4554. (org-agenda-skip-if nil conditions))
  4555. (defun org-agenda-skip-subtree-if (&rest conditions)
  4556. "Skip subtree if any of CONDITIONS is true.
  4557. See `org-agenda-skip-if' for details."
  4558. (org-agenda-skip-if t conditions))
  4559. (defun org-agenda-skip-if (subtree conditions)
  4560. "Checks current entity for CONDITIONS.
  4561. If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
  4562. the entry (i.e. the text before the next heading) is checked.
  4563. CONDITIONS is a list of symbols, boolean OR is used to combine the results
  4564. from different tests. Valid conditions are:
  4565. scheduled Check if there is a scheduled cookie
  4566. notscheduled Check if there is no scheduled cookie
  4567. deadline Check if there is a deadline
  4568. notdeadline Check if there is no deadline
  4569. timestamp Check if there is a timestamp (also deadline or scheduled)
  4570. nottimestamp Check if there is no timestamp (also deadline or scheduled)
  4571. regexp Check if regexp matches
  4572. notregexp Check if regexp does not match.
  4573. todo Check if TODO keyword matches
  4574. nottodo Check if TODO keyword does not match
  4575. The regexp is taken from the conditions list, it must come right after
  4576. the `regexp' or `notregexp' element.
  4577. `todo' and `nottodo' accept as an argument a list of todo
  4578. keywords, which may include \"*\" to match any todo keyword.
  4579. (org-agenda-skip-entry-if \\='todo \\='(\"TODO\" \"WAITING\"))
  4580. would skip all entries with \"TODO\" or \"WAITING\" keywords.
  4581. Instead of a list, a keyword class may be given. For example:
  4582. (org-agenda-skip-entry-if \\='nottodo \\='done)
  4583. would skip entries that haven't been marked with any of \"DONE\"
  4584. keywords. Possible classes are: `todo', `done', `any'.
  4585. If any of these conditions is met, this function returns the end point of
  4586. the entity, causing the search to continue from there. This is a function
  4587. that can be put into `org-agenda-skip-function' for the duration of a command."
  4588. (org-back-to-heading t)
  4589. (let* ((beg (point))
  4590. (end (if subtree (save-excursion (org-end-of-subtree t) (point))
  4591. (org-entry-end-position)))
  4592. (planning-end (if subtree end (line-end-position 2)))
  4593. m)
  4594. (and
  4595. (or (and (memq 'scheduled conditions)
  4596. (re-search-forward org-scheduled-time-regexp planning-end t))
  4597. (and (memq 'notscheduled conditions)
  4598. (not
  4599. (save-excursion
  4600. (re-search-forward org-scheduled-time-regexp planning-end t))))
  4601. (and (memq 'deadline conditions)
  4602. (re-search-forward org-deadline-time-regexp planning-end t))
  4603. (and (memq 'notdeadline conditions)
  4604. (not
  4605. (save-excursion
  4606. (re-search-forward org-deadline-time-regexp planning-end t))))
  4607. (and (memq 'timestamp conditions)
  4608. (re-search-forward org-ts-regexp end t))
  4609. (and (memq 'nottimestamp conditions)
  4610. (not (save-excursion (re-search-forward org-ts-regexp end t))))
  4611. (and (setq m (memq 'regexp conditions))
  4612. (stringp (nth 1 m))
  4613. (re-search-forward (nth 1 m) end t))
  4614. (and (setq m (memq 'notregexp conditions))
  4615. (stringp (nth 1 m))
  4616. (not (save-excursion (re-search-forward (nth 1 m) end t))))
  4617. (and (or
  4618. (setq m (memq 'nottodo conditions))
  4619. (setq m (memq 'todo-unblocked conditions))
  4620. (setq m (memq 'nottodo-unblocked conditions))
  4621. (setq m (memq 'todo conditions)))
  4622. (org-agenda-skip-if-todo m end)))
  4623. end)))
  4624. (defun org-agenda-skip-if-todo (args end)
  4625. "Helper function for `org-agenda-skip-if', do not use it directly.
  4626. ARGS is a list with first element either `todo', `nottodo',
  4627. `todo-unblocked' or `nottodo-unblocked'. The remainder is either
  4628. a list of TODO keywords, or a state symbol `todo' or `done' or
  4629. `any'."
  4630. (let ((todo-re
  4631. (concat "^\\*+[ \t]+"
  4632. (regexp-opt
  4633. (pcase args
  4634. (`(,_ todo)
  4635. (org-delete-all org-done-keywords
  4636. (copy-sequence org-todo-keywords-1)))
  4637. (`(,_ done) org-done-keywords)
  4638. (`(,_ any) org-todo-keywords-1)
  4639. (`(,_ ,(pred atom))
  4640. (error "Invalid TODO class or type: %S" args))
  4641. (`(,_ ,(pred (member "*"))) org-todo-keywords-1)
  4642. (`(,_ ,todo-list) todo-list))
  4643. 'words))))
  4644. (pcase args
  4645. (`(todo . ,_)
  4646. (let (case-fold-search) (re-search-forward todo-re end t)))
  4647. (`(nottodo . ,_)
  4648. (not (let (case-fold-search) (re-search-forward todo-re end t))))
  4649. (`(todo-unblocked . ,_)
  4650. (catch :unblocked
  4651. (while (let (case-fold-search) (re-search-forward todo-re end t))
  4652. (when (org-entry-blocked-p) (throw :unblocked t)))
  4653. nil))
  4654. (`(nottodo-unblocked . ,_)
  4655. (catch :unblocked
  4656. (while (let (case-fold-search) (re-search-forward todo-re end t))
  4657. (when (org-entry-blocked-p) (throw :unblocked nil)))
  4658. t))
  4659. (`(,type . ,_) (error "Unknown TODO skip type: %S" type)))))
  4660. ;;;###autoload
  4661. (defun org-agenda-list-stuck-projects (&rest ignore)
  4662. "Create agenda view for projects that are stuck.
  4663. Stuck projects are project that have no next actions. For the definitions
  4664. of what a project is and how to check if it stuck, customize the variable
  4665. `org-stuck-projects'."
  4666. (interactive)
  4667. (let* ((org-agenda-overriding-header
  4668. (or org-agenda-overriding-header "List of stuck projects: "))
  4669. (matcher (nth 0 org-stuck-projects))
  4670. (todo (nth 1 org-stuck-projects))
  4671. (tags (nth 2 org-stuck-projects))
  4672. (gen-re (org-string-nw-p (nth 3 org-stuck-projects)))
  4673. (todo-wds
  4674. (if (not (member "*" todo)) todo
  4675. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  4676. (org-delete-all org-done-keywords-for-agenda
  4677. (copy-sequence org-todo-keywords-for-agenda))))
  4678. (todo-re (and todo
  4679. (format "^\\*+[ \t]+\\(%s\\)\\>"
  4680. (mapconcat #'identity todo-wds "\\|"))))
  4681. (tags-re (cond ((null tags) nil)
  4682. ((member "*" tags) org-tag-line-re)
  4683. (tags
  4684. (let ((other-tags (format "\\(?:%s:\\)*" org-tag-re)))
  4685. (concat org-outline-regexp-bol
  4686. ".*?[ \t]:"
  4687. other-tags
  4688. (regexp-opt tags t)
  4689. ":" other-tags "[ \t]*$")))
  4690. (t nil)))
  4691. (re-list (delq nil (list todo-re tags-re gen-re)))
  4692. (skip-re
  4693. (if (null re-list)
  4694. (error "Missing information to identify unstuck projects")
  4695. (mapconcat #'identity re-list "\\|")))
  4696. (org-agenda-skip-function
  4697. ;; Skip entry if `org-agenda-skip-regexp' matches anywhere
  4698. ;; in the subtree.
  4699. `(lambda ()
  4700. (and (save-excursion
  4701. (let ((case-fold-search nil))
  4702. (re-search-forward
  4703. ,skip-re (save-excursion (org-end-of-subtree t)) t)))
  4704. (progn (outline-next-heading) (point))))))
  4705. (org-tags-view nil matcher)
  4706. (setq org-agenda-buffer-name (buffer-name))
  4707. (with-current-buffer org-agenda-buffer-name
  4708. (setq org-agenda-redo-command
  4709. `(org-agenda-list-stuck-projects ,current-prefix-arg))
  4710. (let ((inhibit-read-only t))
  4711. (add-text-properties
  4712. (point-min) (point-max)
  4713. `(org-redo-cmd ,org-agenda-redo-command))))))
  4714. ;;; Diary integration
  4715. (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
  4716. (defvar diary-list-entries-hook)
  4717. (defvar diary-time-regexp)
  4718. (defun org-get-entries-from-diary (date)
  4719. "Get the (Emacs Calendar) diary entries for DATE."
  4720. (require 'diary-lib)
  4721. (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
  4722. (diary-display-function 'diary-fancy-display)
  4723. (pop-up-frames nil)
  4724. (diary-list-entries-hook
  4725. (cons 'org-diary-default-entry diary-list-entries-hook))
  4726. (diary-file-name-prefix nil) ; turn this feature off
  4727. (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
  4728. (diary-time-regexp (concat "^" diary-time-regexp))
  4729. entries
  4730. (org-disable-agenda-to-diary t))
  4731. (save-excursion
  4732. (save-window-excursion
  4733. (funcall (if (fboundp 'diary-list-entries)
  4734. 'diary-list-entries 'list-diary-entries)
  4735. date 1)))
  4736. (if (not (get-buffer diary-fancy-buffer))
  4737. (setq entries nil)
  4738. (with-current-buffer diary-fancy-buffer
  4739. (setq buffer-read-only nil)
  4740. (if (zerop (buffer-size))
  4741. ;; No entries
  4742. (setq entries nil)
  4743. ;; Omit the date and other unnecessary stuff
  4744. (org-agenda-cleanup-fancy-diary)
  4745. ;; Add prefix to each line and extend the text properties
  4746. (if (zerop (buffer-size))
  4747. (setq entries nil)
  4748. (setq entries (buffer-substring (point-min) (- (point-max) 1)))
  4749. (setq entries
  4750. (with-temp-buffer
  4751. (insert entries) (goto-char (point-min))
  4752. (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
  4753. (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
  4754. (replace-match (concat "; " (match-string 1)))))
  4755. (buffer-string)))))
  4756. (set-buffer-modified-p nil)
  4757. (kill-buffer diary-fancy-buffer)))
  4758. (when entries
  4759. (setq entries (org-split-string entries "\n"))
  4760. (setq entries
  4761. (mapcar
  4762. (lambda (x)
  4763. (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
  4764. ;; Extend the text properties to the beginning of the line
  4765. (org-add-props x (text-properties-at (1- (length x)) x)
  4766. 'type "diary" 'date date 'face 'org-agenda-diary))
  4767. entries)))))
  4768. (defvar org-agenda-cleanup-fancy-diary-hook nil
  4769. "Hook run when the fancy diary buffer is cleaned up.")
  4770. (defun org-agenda-cleanup-fancy-diary ()
  4771. "Remove unwanted stuff in buffer created by `fancy-diary-display'.
  4772. This gets rid of the date, the underline under the date, and the
  4773. dummy entry installed by Org mode to ensure non-empty diary for
  4774. each date. It also removes lines that contain only whitespace."
  4775. (goto-char (point-min))
  4776. (if (looking-at ".*?:[ \t]*")
  4777. (progn
  4778. (replace-match "")
  4779. (re-search-forward "\n=+$" nil t)
  4780. (replace-match "")
  4781. (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
  4782. (re-search-forward "\n=+$" nil t)
  4783. (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
  4784. (goto-char (point-min))
  4785. (while (re-search-forward "^ +\n" nil t)
  4786. (replace-match ""))
  4787. (goto-char (point-min))
  4788. (when (re-search-forward "^Org mode dummy\n?" nil t)
  4789. (replace-match ""))
  4790. (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
  4791. (defun org-modify-diary-entry-string (string)
  4792. "Add text properties to string, allowing Org to act on it."
  4793. (org-add-props string nil
  4794. 'mouse-face 'highlight
  4795. 'help-echo (if buffer-file-name
  4796. (format "mouse-2 or RET jump to diary file %s"
  4797. (abbreviate-file-name buffer-file-name))
  4798. "")
  4799. 'org-agenda-diary-link t
  4800. 'org-marker (org-agenda-new-marker (point-at-bol))))
  4801. (defun org-diary-default-entry ()
  4802. "Add a dummy entry to the diary.
  4803. Needed to avoid empty dates which mess up holiday display."
  4804. ;; Catch the error if dealing with the new add-to-diary-alist
  4805. (when org-disable-agenda-to-diary
  4806. (condition-case nil
  4807. (org-add-to-diary-list original-date "Org mode dummy" "")
  4808. (error
  4809. (org-add-to-diary-list original-date "Org mode dummy" "" nil)))))
  4810. (defun org-add-to-diary-list (&rest args)
  4811. (if (fboundp 'diary-add-to-list)
  4812. (apply 'diary-add-to-list args)
  4813. (apply 'add-to-diary-list args)))
  4814. (defvar org-diary-last-run-time nil)
  4815. ;;;###autoload
  4816. (defun org-diary (&rest args)
  4817. "Return diary information from org files.
  4818. This function can be used in a \"sexp\" diary entry in the Emacs calendar.
  4819. It accesses org files and extracts information from those files to be
  4820. listed in the diary. The function accepts arguments specifying what
  4821. items should be listed. For a list of arguments allowed here, see the
  4822. variable `org-agenda-entry-types'.
  4823. The call in the diary file should look like this:
  4824. &%%(org-diary) ~/path/to/some/orgfile.org
  4825. Use a separate line for each org file to check. Or, if you omit the file name,
  4826. all files listed in `org-agenda-files' will be checked automatically:
  4827. &%%(org-diary)
  4828. If you don't give any arguments (as in the example above), the default value
  4829. of `org-agenda-entry-types' is used: (:deadline :scheduled :timestamp :sexp).
  4830. So the example above may also be written as
  4831. &%%(org-diary :deadline :timestamp :sexp :scheduled)
  4832. The function expects the lisp variables `entry' and `date' to be provided
  4833. by the caller, because this is how the calendar works. Don't use this
  4834. function from a program - use `org-agenda-get-day-entries' instead."
  4835. (when (> (- (float-time)
  4836. org-agenda-last-marker-time)
  4837. 5)
  4838. ;; I am not sure if this works with sticky agendas, because the marker
  4839. ;; list is then no longer a global variable.
  4840. (org-agenda-reset-markers))
  4841. (org-compile-prefix-format 'agenda)
  4842. (org-set-sorting-strategy 'agenda)
  4843. (setq args (or args org-agenda-entry-types))
  4844. (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
  4845. (list entry)
  4846. (org-agenda-files t)))
  4847. (time (float-time))
  4848. file rtn results)
  4849. (when (or (not org-diary-last-run-time)
  4850. (> (- time
  4851. org-diary-last-run-time)
  4852. 3))
  4853. (org-agenda-prepare-buffers files))
  4854. (setq org-diary-last-run-time time)
  4855. ;; If this is called during org-agenda, don't return any entries to
  4856. ;; the calendar. Org Agenda will list these entries itself.
  4857. (when org-disable-agenda-to-diary (setq files nil))
  4858. (while (setq file (pop files))
  4859. (setq rtn (apply 'org-agenda-get-day-entries file date args))
  4860. (setq results (append results rtn)))
  4861. (when results
  4862. (setq results
  4863. (mapcar (lambda (i) (replace-regexp-in-string
  4864. org-link-bracket-re "\\2" i)) results))
  4865. (concat (org-agenda-finalize-entries results) "\n"))))
  4866. ;;; Agenda entry finders
  4867. (defun org-agenda--timestamp-to-absolute (&rest args)
  4868. "Call `org-time-string-to-absolute' with ARGS.
  4869. However, throw `:skip' whenever an error is raised."
  4870. (condition-case e
  4871. (apply #'org-time-string-to-absolute args)
  4872. (org-diary-sexp-no-match (throw :skip nil))
  4873. (error
  4874. (message "%s; Skipping entry" (error-message-string e))
  4875. (throw :skip nil))))
  4876. (defun org-agenda-get-day-entries (file date &rest args)
  4877. "Does the work for `org-diary' and `org-agenda'.
  4878. FILE is the path to a file to be checked for entries. DATE is date like
  4879. the one returned by `calendar-current-date'. ARGS are symbols indicating
  4880. which kind of entries should be extracted. For details about these, see
  4881. the documentation of `org-diary'."
  4882. (let* ((org-startup-folded nil)
  4883. (org-startup-align-all-tables nil)
  4884. (buffer (if (file-exists-p file) (org-get-agenda-file-buffer file)
  4885. (error "No such file %s" file))))
  4886. (if (not buffer)
  4887. ;; If file does not exist, signal it in diary nonetheless.
  4888. (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4889. (with-current-buffer buffer
  4890. (unless (derived-mode-p 'org-mode)
  4891. (error "Agenda file %s is not in Org mode" file))
  4892. (setq org-agenda-buffer (or org-agenda-buffer buffer))
  4893. (setf org-agenda-current-date date)
  4894. (save-excursion
  4895. (save-restriction
  4896. (if (eq buffer org-agenda-restrict)
  4897. (narrow-to-region org-agenda-restrict-begin
  4898. org-agenda-restrict-end)
  4899. (widen))
  4900. ;; Rationalize ARGS. Also make sure `:deadline' comes
  4901. ;; first in order to populate DEADLINES before passing it.
  4902. ;;
  4903. ;; We use `delq' since `org-uniquify' duplicates ARGS,
  4904. ;; guarding us from modifying `org-agenda-entry-types'.
  4905. (setf args (org-uniquify (or args org-agenda-entry-types)))
  4906. (when (and (memq :scheduled args) (memq :scheduled* args))
  4907. (setf args (delq :scheduled* args)))
  4908. (cond
  4909. ((memq :deadline args)
  4910. (setf args (cons :deadline
  4911. (delq :deadline (delq :deadline* args)))))
  4912. ((memq :deadline* args)
  4913. (setf args (cons :deadline* (delq :deadline* args)))))
  4914. ;; Collect list of headlines. Return them flattened.
  4915. (let ((case-fold-search nil) results deadlines)
  4916. (dolist (arg args (apply #'nconc (nreverse results)))
  4917. (pcase arg
  4918. ((and :todo (guard (org-agenda-today-p date)))
  4919. (push (org-agenda-get-todos) results))
  4920. (:timestamp
  4921. (push (org-agenda-get-blocks) results)
  4922. (push (org-agenda-get-timestamps deadlines) results))
  4923. (:sexp
  4924. (push (org-agenda-get-sexps) results))
  4925. (:scheduled
  4926. (push (org-agenda-get-scheduled deadlines) results))
  4927. (:scheduled*
  4928. (push (org-agenda-get-scheduled deadlines t) results))
  4929. (:closed
  4930. (push (org-agenda-get-progress) results))
  4931. (:deadline
  4932. (setf deadlines (org-agenda-get-deadlines))
  4933. (push deadlines results))
  4934. (:deadline*
  4935. (setf deadlines (org-agenda-get-deadlines t))
  4936. (push deadlines results)))))))))))
  4937. (defsubst org-em (x y list)
  4938. "Is X or Y a member of LIST?"
  4939. (or (memq x list) (memq y list)))
  4940. (defvar org-heading-keyword-regexp-format) ; defined in org.el
  4941. (defvar org-agenda-sorting-strategy-selected nil)
  4942. (defun org-agenda-entry-get-agenda-timestamp (pom)
  4943. "Retrieve timestamp information for sorting agenda views.
  4944. Given a point or marker POM, returns a cons cell of the timestamp
  4945. and the timestamp type relevant for the sorting strategy in
  4946. `org-agenda-sorting-strategy-selected'."
  4947. (let (ts ts-date-type)
  4948. (save-match-data
  4949. (cond ((org-em 'scheduled-up 'scheduled-down
  4950. org-agenda-sorting-strategy-selected)
  4951. (setq ts (org-entry-get pom "SCHEDULED")
  4952. ts-date-type " scheduled"))
  4953. ((org-em 'deadline-up 'deadline-down
  4954. org-agenda-sorting-strategy-selected)
  4955. (setq ts (org-entry-get pom "DEADLINE")
  4956. ts-date-type " deadline"))
  4957. ((org-em 'ts-up 'ts-down
  4958. org-agenda-sorting-strategy-selected)
  4959. (setq ts (org-entry-get pom "TIMESTAMP")
  4960. ts-date-type " timestamp"))
  4961. ((org-em 'tsia-up 'tsia-down
  4962. org-agenda-sorting-strategy-selected)
  4963. (setq ts (org-entry-get pom "TIMESTAMP_IA")
  4964. ts-date-type " timestamp_ia"))
  4965. ((org-em 'timestamp-up 'timestamp-down
  4966. org-agenda-sorting-strategy-selected)
  4967. (setq ts (or (org-entry-get pom "SCHEDULED")
  4968. (org-entry-get pom "DEADLINE")
  4969. (org-entry-get pom "TIMESTAMP")
  4970. (org-entry-get pom "TIMESTAMP_IA"))
  4971. ts-date-type ""))
  4972. (t (setq ts-date-type "")))
  4973. (cons (when ts (ignore-errors (org-time-string-to-absolute ts)))
  4974. ts-date-type))))
  4975. (defun org-agenda-get-todos ()
  4976. "Return the TODO information for agenda display."
  4977. (let* ((props (list 'face nil
  4978. 'done-face 'org-agenda-done
  4979. 'org-not-done-regexp org-not-done-regexp
  4980. 'org-todo-regexp org-todo-regexp
  4981. 'org-complex-heading-regexp org-complex-heading-regexp
  4982. 'mouse-face 'highlight
  4983. 'help-echo
  4984. (format "mouse-2 or RET jump to org file %s"
  4985. (abbreviate-file-name buffer-file-name))))
  4986. (case-fold-search nil)
  4987. (regexp (format org-heading-keyword-regexp-format
  4988. (cond
  4989. ((and org-select-this-todo-keyword
  4990. (equal org-select-this-todo-keyword "*"))
  4991. org-todo-regexp)
  4992. (org-select-this-todo-keyword
  4993. (concat "\\("
  4994. (mapconcat 'identity
  4995. (org-split-string
  4996. org-select-this-todo-keyword
  4997. "|")
  4998. "\\|") "\\)"))
  4999. (t org-not-done-regexp))))
  5000. marker priority category level tags todo-state
  5001. ts-date ts-date-type ts-date-pair
  5002. ee txt beg end inherited-tags todo-state-end-pos)
  5003. (goto-char (point-min))
  5004. (while (re-search-forward regexp nil t)
  5005. (catch :skip
  5006. (save-match-data
  5007. (beginning-of-line)
  5008. (org-agenda-skip)
  5009. (setq beg (point) end (save-excursion (outline-next-heading) (point)))
  5010. (unless (and (setq todo-state (org-get-todo-state))
  5011. (setq todo-state-end-pos (match-end 2)))
  5012. (goto-char end)
  5013. (throw :skip nil))
  5014. (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
  5015. (goto-char (1+ beg))
  5016. (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
  5017. (throw :skip nil)))
  5018. (goto-char (match-beginning 2))
  5019. (setq marker (org-agenda-new-marker (match-beginning 0))
  5020. category (org-get-category)
  5021. ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
  5022. ts-date (car ts-date-pair)
  5023. ts-date-type (cdr ts-date-pair)
  5024. txt (org-trim (buffer-substring (match-beginning 2) (match-end 0)))
  5025. inherited-tags
  5026. (or (eq org-agenda-show-inherited-tags 'always)
  5027. (and (listp org-agenda-show-inherited-tags)
  5028. (memq 'todo org-agenda-show-inherited-tags))
  5029. (and (eq org-agenda-show-inherited-tags t)
  5030. (or (eq org-agenda-use-tag-inheritance t)
  5031. (memq 'todo org-agenda-use-tag-inheritance))))
  5032. tags (org-get-tags nil (not inherited-tags))
  5033. level (make-string (org-reduced-level (org-outline-level)) ? )
  5034. txt (org-agenda-format-item "" txt level category tags t)
  5035. priority (1+ (org-get-priority txt)))
  5036. (org-add-props txt props
  5037. 'org-marker marker 'org-hd-marker marker
  5038. 'priority priority
  5039. 'level level
  5040. 'ts-date ts-date
  5041. 'type (concat "todo" ts-date-type) 'todo-state todo-state)
  5042. (push txt ee)
  5043. (if org-agenda-todo-list-sublevels
  5044. (goto-char todo-state-end-pos)
  5045. (org-end-of-subtree 'invisible))))
  5046. (nreverse ee)))
  5047. (defun org-agenda-todo-custom-ignore-p (time n)
  5048. "Check whether timestamp is farther away than n number of days.
  5049. This function is invoked if `org-agenda-todo-ignore-deadlines',
  5050. `org-agenda-todo-ignore-scheduled' or
  5051. `org-agenda-todo-ignore-timestamp' is set to an integer."
  5052. (let ((days (org-time-stamp-to-now
  5053. time org-agenda-todo-ignore-time-comparison-use-seconds)))
  5054. (if (>= n 0)
  5055. (>= days n)
  5056. (<= days n))))
  5057. ;;;###autoload
  5058. (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  5059. (&optional end)
  5060. "Do we have a reason to ignore this TODO entry because it has a time stamp?"
  5061. (when (or org-agenda-todo-ignore-with-date
  5062. org-agenda-todo-ignore-scheduled
  5063. org-agenda-todo-ignore-deadlines
  5064. org-agenda-todo-ignore-timestamp)
  5065. (setq end (or end (save-excursion (outline-next-heading) (point))))
  5066. (save-excursion
  5067. (or (and org-agenda-todo-ignore-with-date
  5068. (re-search-forward org-ts-regexp end t))
  5069. (and org-agenda-todo-ignore-scheduled
  5070. (re-search-forward org-scheduled-time-regexp end t)
  5071. (cond
  5072. ((eq org-agenda-todo-ignore-scheduled 'future)
  5073. (> (org-time-stamp-to-now
  5074. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5075. ((eq org-agenda-todo-ignore-scheduled 'past)
  5076. (<= (org-time-stamp-to-now
  5077. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5078. ((numberp org-agenda-todo-ignore-scheduled)
  5079. (org-agenda-todo-custom-ignore-p
  5080. (match-string 1) org-agenda-todo-ignore-scheduled))
  5081. (t)))
  5082. (and org-agenda-todo-ignore-deadlines
  5083. (re-search-forward org-deadline-time-regexp end t)
  5084. (cond
  5085. ((eq org-agenda-todo-ignore-deadlines 'all) t)
  5086. ((eq org-agenda-todo-ignore-deadlines 'far)
  5087. (not (org-deadline-close-p (match-string 1))))
  5088. ((eq org-agenda-todo-ignore-deadlines 'future)
  5089. (> (org-time-stamp-to-now
  5090. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5091. ((eq org-agenda-todo-ignore-deadlines 'past)
  5092. (<= (org-time-stamp-to-now
  5093. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5094. ((numberp org-agenda-todo-ignore-deadlines)
  5095. (org-agenda-todo-custom-ignore-p
  5096. (match-string 1) org-agenda-todo-ignore-deadlines))
  5097. (t (org-deadline-close-p (match-string 1)))))
  5098. (and org-agenda-todo-ignore-timestamp
  5099. (let ((buffer (current-buffer))
  5100. (regexp
  5101. (concat
  5102. org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
  5103. (start (point)))
  5104. ;; Copy current buffer into a temporary one
  5105. (with-temp-buffer
  5106. (insert-buffer-substring buffer start end)
  5107. (goto-char (point-min))
  5108. ;; Delete SCHEDULED and DEADLINE items
  5109. (while (re-search-forward regexp end t)
  5110. (delete-region (match-beginning 0) (match-end 0)))
  5111. (goto-char (point-min))
  5112. ;; No search for timestamp left
  5113. (when (re-search-forward org-ts-regexp nil t)
  5114. (cond
  5115. ((eq org-agenda-todo-ignore-timestamp 'future)
  5116. (> (org-time-stamp-to-now
  5117. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5118. ((eq org-agenda-todo-ignore-timestamp 'past)
  5119. (<= (org-time-stamp-to-now
  5120. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5121. ((numberp org-agenda-todo-ignore-timestamp)
  5122. (org-agenda-todo-custom-ignore-p
  5123. (match-string 1) org-agenda-todo-ignore-timestamp))
  5124. (t))))))))))
  5125. (defun org-agenda-get-timestamps (&optional deadlines)
  5126. "Return the date stamp information for agenda display.
  5127. Optional argument DEADLINES is a list of deadline items to be
  5128. displayed in agenda view."
  5129. (let* ((props (list 'face 'org-agenda-calendar-event
  5130. 'org-not-done-regexp org-not-done-regexp
  5131. 'org-todo-regexp org-todo-regexp
  5132. 'org-complex-heading-regexp org-complex-heading-regexp
  5133. 'mouse-face 'highlight
  5134. 'help-echo
  5135. (format "mouse-2 or RET jump to Org file %s"
  5136. (abbreviate-file-name buffer-file-name))))
  5137. (current (calendar-absolute-from-gregorian date))
  5138. (today (org-today))
  5139. (deadline-position-alist
  5140. (mapcar (lambda (d)
  5141. (let ((m (get-text-property 0 'org-hd-marker d)))
  5142. (and m (marker-position m))))
  5143. deadlines))
  5144. ;; Match time-stamps set to current date, time-stamps with
  5145. ;; a repeater, and S-exp time-stamps.
  5146. (regexp
  5147. (concat
  5148. (if org-agenda-include-inactive-timestamps "[[<]" "<")
  5149. (regexp-quote
  5150. (substring
  5151. (format-time-string
  5152. (car org-time-stamp-formats)
  5153. (encode-time ; DATE bound by calendar
  5154. 0 0 0 (nth 1 date) (car date) (nth 2 date)))
  5155. 1 11))
  5156. "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
  5157. "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
  5158. timestamp-items)
  5159. (goto-char (point-min))
  5160. (while (re-search-forward regexp nil t)
  5161. ;; Skip date ranges, scheduled and deadlines, which are handled
  5162. ;; specially. Also skip time-stamps before first headline as
  5163. ;; there would be no entry to add to the agenda. Eventually,
  5164. ;; ignore clock entries.
  5165. (catch :skip
  5166. (save-match-data
  5167. (when (or (org-at-date-range-p)
  5168. (org-at-planning-p)
  5169. (org-before-first-heading-p)
  5170. (and org-agenda-include-inactive-timestamps
  5171. (org-at-clock-log-p)))
  5172. (throw :skip nil))
  5173. (org-agenda-skip))
  5174. (let* ((pos (match-beginning 0))
  5175. (repeat (match-string 1))
  5176. (sexp-entry (match-string 3))
  5177. (time-stamp (if (or repeat sexp-entry) (match-string 0)
  5178. (save-excursion
  5179. (goto-char pos)
  5180. (looking-at org-ts-regexp-both)
  5181. (match-string 0))))
  5182. (todo-state (org-get-todo-state))
  5183. (warntime (get-text-property (point) 'org-appt-warntime))
  5184. (done? (member todo-state org-done-keywords)))
  5185. ;; Possibly skip done tasks.
  5186. (when (and done? org-agenda-skip-timestamp-if-done)
  5187. (throw :skip t))
  5188. ;; S-exp entry doesn't match current day: skip it.
  5189. (when (and sexp-entry (not (org-diary-sexp-entry sexp-entry "" date)))
  5190. (throw :skip nil))
  5191. (when repeat
  5192. (let* ((past
  5193. ;; A repeating time stamp is shown at its base
  5194. ;; date and every repeated date up to TODAY. If
  5195. ;; `org-agenda-prefer-last-repeat' is non-nil,
  5196. ;; however, only the last repeat before today
  5197. ;; (inclusive) is shown.
  5198. (org-agenda--timestamp-to-absolute
  5199. repeat
  5200. (if (or (> current today)
  5201. (eq org-agenda-prefer-last-repeat t)
  5202. (member todo-state org-agenda-prefer-last-repeat))
  5203. today
  5204. current)
  5205. 'past (current-buffer) pos))
  5206. (future
  5207. ;; Display every repeated date past TODAY
  5208. ;; (exclusive) unless
  5209. ;; `org-agenda-show-future-repeats' is nil. If
  5210. ;; this variable is set to `next', only display
  5211. ;; the first repeated date after TODAY
  5212. ;; (exclusive).
  5213. (cond
  5214. ((<= current today) past)
  5215. ((not org-agenda-show-future-repeats) past)
  5216. (t
  5217. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5218. (1+ today)
  5219. current)))
  5220. (org-agenda--timestamp-to-absolute
  5221. repeat base 'future (current-buffer) pos))))))
  5222. (when (and (/= current past) (/= current future))
  5223. (throw :skip nil))))
  5224. (save-excursion
  5225. (re-search-backward org-outline-regexp-bol nil t)
  5226. ;; Possibly skip time-stamp when a deadline is set.
  5227. (when (and org-agenda-skip-timestamp-if-deadline-is-shown
  5228. (assq (point) deadline-position-alist))
  5229. (throw :skip nil))
  5230. (let* ((category (org-get-category pos))
  5231. (inherited-tags
  5232. (or (eq org-agenda-show-inherited-tags 'always)
  5233. (and (consp org-agenda-show-inherited-tags)
  5234. (memq 'agenda org-agenda-show-inherited-tags))
  5235. (and (eq org-agenda-show-inherited-tags t)
  5236. (or (eq org-agenda-use-tag-inheritance t)
  5237. (memq 'agenda
  5238. org-agenda-use-tag-inheritance)))))
  5239. (tags (org-get-tags nil (not inherited-tags)))
  5240. (level (make-string (org-reduced-level (org-outline-level))
  5241. ?\s))
  5242. (head (and (looking-at "\\*+[ \t]+\\(.*\\)")
  5243. (match-string 1)))
  5244. (inactive? (= (char-after pos) ?\[))
  5245. (habit? (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  5246. (item
  5247. (org-agenda-format-item
  5248. (and inactive? org-agenda-inactive-leader)
  5249. head level category tags time-stamp org-ts-regexp habit?)))
  5250. (org-add-props item props
  5251. 'priority (if habit?
  5252. (org-habit-get-priority (org-habit-parse-todo))
  5253. (org-get-priority item))
  5254. 'org-marker (org-agenda-new-marker pos)
  5255. 'org-hd-marker (org-agenda-new-marker)
  5256. 'date date
  5257. 'level level
  5258. 'ts-date (if repeat (org-agenda--timestamp-to-absolute repeat)
  5259. current)
  5260. 'todo-state todo-state
  5261. 'warntime warntime
  5262. 'type "timestamp")
  5263. (push item timestamp-items))))
  5264. (when org-agenda-skip-additional-timestamps-same-entry
  5265. (outline-next-heading))))
  5266. (nreverse timestamp-items)))
  5267. (defun org-agenda-get-sexps ()
  5268. "Return the sexp information for agenda display."
  5269. (require 'diary-lib)
  5270. (let* ((props (list 'face 'org-agenda-calendar-sexp
  5271. 'mouse-face 'highlight
  5272. 'help-echo
  5273. (format "mouse-2 or RET jump to org file %s"
  5274. (abbreviate-file-name buffer-file-name))))
  5275. (regexp "^&?%%(")
  5276. marker category extra level ee txt tags entry
  5277. result beg b sexp sexp-entry todo-state warntime inherited-tags)
  5278. (goto-char (point-min))
  5279. (while (re-search-forward regexp nil t)
  5280. (catch :skip
  5281. (org-agenda-skip)
  5282. (setq beg (match-beginning 0))
  5283. (goto-char (1- (match-end 0)))
  5284. (setq b (point))
  5285. (forward-sexp 1)
  5286. (setq sexp (buffer-substring b (point)))
  5287. (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
  5288. (org-trim (match-string 1))
  5289. ""))
  5290. (setq result (org-diary-sexp-entry sexp sexp-entry date))
  5291. (when result
  5292. (setq marker (org-agenda-new-marker beg)
  5293. level (make-string (org-reduced-level (org-outline-level)) ? )
  5294. category (org-get-category beg)
  5295. inherited-tags
  5296. (or (eq org-agenda-show-inherited-tags 'always)
  5297. (and (listp org-agenda-show-inherited-tags)
  5298. (memq 'agenda org-agenda-show-inherited-tags))
  5299. (and (eq org-agenda-show-inherited-tags t)
  5300. (or (eq org-agenda-use-tag-inheritance t)
  5301. (memq 'agenda org-agenda-use-tag-inheritance))))
  5302. tags (org-get-tags nil (not inherited-tags))
  5303. todo-state (org-get-todo-state)
  5304. warntime (get-text-property (point) 'org-appt-warntime)
  5305. extra nil)
  5306. (dolist (r (if (stringp result)
  5307. (list result)
  5308. result)) ;; we expect a list here
  5309. (when (and org-agenda-diary-sexp-prefix
  5310. (string-match org-agenda-diary-sexp-prefix r))
  5311. (setq extra (match-string 0 r)
  5312. r (replace-match "" nil nil r)))
  5313. (if (string-match "\\S-" r)
  5314. (setq txt r)
  5315. (setq txt "SEXP entry returned empty string"))
  5316. (setq txt (org-agenda-format-item extra txt level category tags 'time))
  5317. (org-add-props txt props 'org-marker marker
  5318. 'date date 'todo-state todo-state
  5319. 'level level 'type "sexp" 'warntime warntime)
  5320. (push txt ee)))))
  5321. (nreverse ee)))
  5322. ;; Calendar sanity: define some functions that are independent of
  5323. ;; `calendar-date-style'.
  5324. (defun org-anniversary (year month day &optional mark)
  5325. "Like `diary-anniversary', but with fixed (ISO) order of arguments."
  5326. (with-no-warnings
  5327. (let ((calendar-date-style 'iso))
  5328. (diary-anniversary year month day mark))))
  5329. (defun org-cyclic (N year month day &optional mark)
  5330. "Like `diary-cyclic', but with fixed (ISO) order of arguments."
  5331. (with-no-warnings
  5332. (let ((calendar-date-style 'iso))
  5333. (diary-cyclic N year month day mark))))
  5334. (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
  5335. "Like `diary-block', but with fixed (ISO) order of arguments."
  5336. (with-no-warnings
  5337. (let ((calendar-date-style 'iso))
  5338. (diary-block Y1 M1 D1 Y2 M2 D2 mark))))
  5339. (defun org-date (year month day &optional mark)
  5340. "Like `diary-date', but with fixed (ISO) order of arguments."
  5341. (with-no-warnings
  5342. (let ((calendar-date-style 'iso))
  5343. (diary-date year month day mark))))
  5344. ;; Define the `org-class' function
  5345. (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
  5346. "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
  5347. DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
  5348. SKIP-WEEKS is any number of ISO weeks in the block period for which the
  5349. item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
  5350. `holidays', then any date that is known by the Emacs calendar to be a
  5351. holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
  5352. then those holidays will be skipped."
  5353. (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
  5354. (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
  5355. (d (calendar-absolute-from-gregorian date))
  5356. (h (when skip-weeks (calendar-check-holidays date))))
  5357. (and
  5358. (<= date1 d)
  5359. (<= d date2)
  5360. (= (calendar-day-of-week date) dayname)
  5361. (or (not skip-weeks)
  5362. (progn
  5363. (require 'cal-iso)
  5364. (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
  5365. (not (or (and h (memq 'holidays skip-weeks))
  5366. (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
  5367. entry)))
  5368. (defalias 'org-get-closed 'org-agenda-get-progress)
  5369. (defun org-agenda-get-progress ()
  5370. "Return the logged TODO entries for agenda display."
  5371. (let* ((props (list 'mouse-face 'highlight
  5372. 'org-not-done-regexp org-not-done-regexp
  5373. 'org-todo-regexp org-todo-regexp
  5374. 'org-complex-heading-regexp org-complex-heading-regexp
  5375. 'help-echo
  5376. (format "mouse-2 or RET jump to org file %s"
  5377. (abbreviate-file-name buffer-file-name))))
  5378. (items (if (consp org-agenda-show-log-scoped)
  5379. org-agenda-show-log-scoped
  5380. (if (eq org-agenda-show-log-scoped 'clockcheck)
  5381. '(clock)
  5382. org-agenda-log-mode-items)))
  5383. (parts
  5384. (delq nil
  5385. (list
  5386. (when (memq 'closed items) (concat "\\<" org-closed-string))
  5387. (when (memq 'clock items) (concat "\\<" org-clock-string))
  5388. (when (memq 'state items)
  5389. (format "- +State \"%s\".*?" org-todo-regexp)))))
  5390. (parts-re (if parts (mapconcat 'identity parts "\\|")
  5391. (error "`org-agenda-log-mode-items' is empty")))
  5392. (regexp (concat
  5393. "\\(" parts-re "\\)"
  5394. " *\\["
  5395. (regexp-quote
  5396. (substring
  5397. (format-time-string
  5398. (car org-time-stamp-formats)
  5399. (encode-time ; DATE bound by calendar
  5400. 0 0 0 (nth 1 date) (car date) (nth 2 date)))
  5401. 1 11))))
  5402. (org-agenda-search-headline-for-time nil)
  5403. marker hdmarker priority category level tags closedp type
  5404. statep clockp state ee txt extra timestr rest clocked inherited-tags)
  5405. (goto-char (point-min))
  5406. (while (re-search-forward regexp nil t)
  5407. (catch :skip
  5408. (org-agenda-skip)
  5409. (setq marker (org-agenda-new-marker (match-beginning 0))
  5410. closedp (equal (match-string 1) org-closed-string)
  5411. statep (equal (string-to-char (match-string 1)) ?-)
  5412. clockp (not (or closedp statep))
  5413. state (and statep (match-string 2))
  5414. category (org-get-category (match-beginning 0))
  5415. timestr (buffer-substring (match-beginning 0) (point-at-eol)))
  5416. (when (string-match "\\]" timestr)
  5417. ;; substring should only run to end of time stamp
  5418. (setq rest (substring timestr (match-end 0))
  5419. timestr (substring timestr 0 (match-end 0)))
  5420. (if (and (not closedp) (not statep)
  5421. (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
  5422. rest))
  5423. (progn (setq timestr (concat (substring timestr 0 -1)
  5424. "-" (match-string 1 rest) "]"))
  5425. (setq clocked (match-string 2 rest)))
  5426. (setq clocked "-")))
  5427. (save-excursion
  5428. (setq extra
  5429. (cond
  5430. ((not org-agenda-log-mode-add-notes) nil)
  5431. (statep
  5432. (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
  5433. (match-string 1)))
  5434. (clockp
  5435. (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
  5436. (match-string 1)))))
  5437. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5438. (throw :skip nil)
  5439. (goto-char (match-beginning 0))
  5440. (setq hdmarker (org-agenda-new-marker)
  5441. inherited-tags
  5442. (or (eq org-agenda-show-inherited-tags 'always)
  5443. (and (listp org-agenda-show-inherited-tags)
  5444. (memq 'todo org-agenda-show-inherited-tags))
  5445. (and (eq org-agenda-show-inherited-tags t)
  5446. (or (eq org-agenda-use-tag-inheritance t)
  5447. (memq 'todo org-agenda-use-tag-inheritance))))
  5448. tags (org-get-tags nil (not inherited-tags))
  5449. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5450. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5451. (setq txt (match-string 1))
  5452. (when extra
  5453. (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
  5454. (setq txt (concat (substring txt 0 (match-beginning 1))
  5455. " - " extra " " (match-string 2 txt)))
  5456. (setq txt (concat txt " - " extra))))
  5457. (setq txt (org-agenda-format-item
  5458. (cond
  5459. (closedp "Closed: ")
  5460. (statep (concat "State: (" state ")"))
  5461. (t (concat "Clocked: (" clocked ")")))
  5462. txt level category tags timestr)))
  5463. (setq type (cond (closedp "closed")
  5464. (statep "state")
  5465. (t "clock")))
  5466. (setq priority 100000)
  5467. (org-add-props txt props
  5468. 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
  5469. 'priority priority 'level level
  5470. 'type type 'date date
  5471. 'undone-face 'org-warning 'done-face 'org-agenda-done)
  5472. (push txt ee))
  5473. (goto-char (point-at-eol))))
  5474. (nreverse ee)))
  5475. (defun org-agenda-show-clocking-issues ()
  5476. "Add overlays, showing issues with clocking.
  5477. See also the user option `org-agenda-clock-consistency-checks'."
  5478. (interactive)
  5479. (let* ((pl org-agenda-clock-consistency-checks)
  5480. (re (concat "^[ \t]*"
  5481. org-clock-string
  5482. "[ \t]+"
  5483. "\\(\\[.*?\\]\\)" ; group 1 is first stamp
  5484. "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
  5485. (tlstart 0.)
  5486. (tlend 0.)
  5487. (maxtime (org-duration-to-minutes
  5488. (or (plist-get pl :max-duration) "24:00")))
  5489. (mintime (org-duration-to-minutes
  5490. (or (plist-get pl :min-duration) 0)))
  5491. (maxgap (org-duration-to-minutes
  5492. ;; default 30:00 means never complain
  5493. (or (plist-get pl :max-gap) "30:00")))
  5494. (gapok (mapcar #'org-duration-to-minutes
  5495. (plist-get pl :gap-ok-around)))
  5496. (def-face (or (plist-get pl :default-face)
  5497. '((:background "DarkRed") (:foreground "white"))))
  5498. issue face m te ts dt ov)
  5499. (goto-char (point-min))
  5500. (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
  5501. (setq issue nil face def-face)
  5502. (catch 'next
  5503. (setq m (org-get-at-bol 'org-marker)
  5504. te nil ts nil)
  5505. (unless (and m (markerp m))
  5506. (setq issue "No valid clock line") (throw 'next t))
  5507. (org-with-point-at m
  5508. (save-excursion
  5509. (goto-char (point-at-bol))
  5510. (unless (looking-at re)
  5511. (error "No valid Clock line")
  5512. (throw 'next t))
  5513. (unless (match-end 3)
  5514. (setq issue
  5515. (format
  5516. "No end time: (%s)"
  5517. (org-duration-from-minutes
  5518. (floor
  5519. (- (float-time (org-current-time))
  5520. (float-time (org-time-string-to-time (match-string 1))))
  5521. 60)))
  5522. face (or (plist-get pl :no-end-time-face) face))
  5523. (throw 'next t))
  5524. (setq ts (match-string 1)
  5525. te (match-string 3)
  5526. ts (float-time (org-time-string-to-time ts))
  5527. te (float-time (org-time-string-to-time te))
  5528. dt (- te ts))))
  5529. (cond
  5530. ((> dt (* 60 maxtime))
  5531. ;; a very long clocking chunk
  5532. (setq issue (format "Clocking interval is very long: %s"
  5533. (org-duration-from-minutes (floor dt 60)))
  5534. face (or (plist-get pl :long-face) face)))
  5535. ((< dt (* 60 mintime))
  5536. ;; a very short clocking chunk
  5537. (setq issue (format "Clocking interval is very short: %s"
  5538. (org-duration-from-minutes (floor dt 60)))
  5539. face (or (plist-get pl :short-face) face)))
  5540. ((and (> tlend 0) (< ts tlend))
  5541. ;; Two clock entries are overlapping
  5542. (setq issue (format "Clocking overlap: %d minutes"
  5543. (/ (- tlend ts) 60))
  5544. face (or (plist-get pl :overlap-face) face)))
  5545. ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
  5546. ;; There is a gap, lets see if we need to report it
  5547. (unless (org-agenda-check-clock-gap tlend ts gapok)
  5548. (setq issue (format "Clocking gap: %d minutes"
  5549. (/ (- ts tlend) 60))
  5550. face (or (plist-get pl :gap-face) face))))
  5551. (t nil)))
  5552. (setq tlend (or te tlend) tlstart (or ts tlstart))
  5553. (when issue
  5554. ;; OK, there was some issue, add an overlay to show the issue
  5555. (setq ov (make-overlay (point-at-bol) (point-at-eol)))
  5556. (overlay-put ov 'before-string
  5557. (concat
  5558. (org-add-props
  5559. (format "%-43s" (concat " " issue))
  5560. nil
  5561. 'face face)
  5562. "\n"))
  5563. (overlay-put ov 'evaporate t)))))
  5564. (defun org-agenda-check-clock-gap (t1 t2 ok-list)
  5565. "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
  5566. (catch 'exit
  5567. (unless ok-list
  5568. ;; there are no OK times for gaps...
  5569. (throw 'exit nil))
  5570. (when (> (- (/ t2 36000) (/ t1 36000)) 24)
  5571. ;; This is more than 24 hours, so it is OK.
  5572. ;; because we have at least one OK time, that must be in the
  5573. ;; 24 hour interval.
  5574. (throw 'exit t))
  5575. ;; We have a shorter gap.
  5576. ;; Now we have to get the minute of the day when these times are
  5577. (let* ((t1dec (org-decode-time t1))
  5578. (t2dec (org-decode-time t2))
  5579. ;; compute the minute on the day
  5580. (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
  5581. (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
  5582. (when (< min2 min1)
  5583. ;; if min2 is smaller than min1, this means it is on the next day.
  5584. ;; Wrap it to after midnight.
  5585. (setq min2 (+ min2 1440)))
  5586. ;; Now check if any of the OK times is in the gap
  5587. (mapc (lambda (x)
  5588. ;; Wrap the time to after midnight if necessary
  5589. (when (< x min1) (setq x (+ x 1440)))
  5590. ;; Check if in interval
  5591. (and (<= min1 x) (>= min2 x) (throw 'exit t)))
  5592. ok-list)
  5593. ;; Nope, this gap is not OK
  5594. nil)))
  5595. (defun org-agenda-get-deadlines (&optional with-hour)
  5596. "Return the deadline information for agenda display.
  5597. When WITH-HOUR is non-nil, only return deadlines with an hour
  5598. specification like [h]h:mm."
  5599. (let* ((props (list 'mouse-face 'highlight
  5600. 'org-not-done-regexp org-not-done-regexp
  5601. 'org-todo-regexp org-todo-regexp
  5602. 'org-complex-heading-regexp org-complex-heading-regexp
  5603. 'help-echo
  5604. (format "mouse-2 or RET jump to org file %s"
  5605. (abbreviate-file-name buffer-file-name))))
  5606. (regexp (if with-hour
  5607. org-deadline-time-hour-regexp
  5608. org-deadline-time-regexp))
  5609. (today (org-today))
  5610. (today? (org-agenda-today-p date)) ; DATE bound by calendar.
  5611. (current (calendar-absolute-from-gregorian date))
  5612. deadline-items)
  5613. (goto-char (point-min))
  5614. (while (re-search-forward regexp nil t)
  5615. (catch :skip
  5616. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5617. (org-agenda-skip)
  5618. (let* ((s (match-string 1))
  5619. (pos (1- (match-beginning 1)))
  5620. (todo-state (save-match-data (org-get-todo-state)))
  5621. (done? (member todo-state org-done-keywords))
  5622. (sexp? (string-prefix-p "%%" s))
  5623. ;; DEADLINE is the deadline date for the entry. It is
  5624. ;; either the base date or the last repeat, according
  5625. ;; to `org-agenda-prefer-last-repeat'.
  5626. (deadline
  5627. (cond
  5628. (sexp? (org-agenda--timestamp-to-absolute s current))
  5629. ((or (eq org-agenda-prefer-last-repeat t)
  5630. (member todo-state org-agenda-prefer-last-repeat))
  5631. (org-agenda--timestamp-to-absolute
  5632. s today 'past (current-buffer) pos))
  5633. (t (org-agenda--timestamp-to-absolute s))))
  5634. ;; REPEAT is the future repeat closest from CURRENT,
  5635. ;; according to `org-agenda-show-future-repeats'. If
  5636. ;; the latter is nil, or if the time stamp has no
  5637. ;; repeat part, default to DEADLINE.
  5638. (repeat
  5639. (cond
  5640. (sexp? deadline)
  5641. ((<= current today) deadline)
  5642. ((not org-agenda-show-future-repeats) deadline)
  5643. (t
  5644. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5645. (1+ today)
  5646. current)))
  5647. (org-agenda--timestamp-to-absolute
  5648. s base 'future (current-buffer) pos)))))
  5649. (diff (- deadline current))
  5650. (suppress-prewarning
  5651. (let ((scheduled
  5652. (and org-agenda-skip-deadline-prewarning-if-scheduled
  5653. (org-entry-get nil "SCHEDULED"))))
  5654. (cond
  5655. ((not scheduled) nil)
  5656. ;; The current item has a scheduled date, so
  5657. ;; evaluate its prewarning lead time.
  5658. ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
  5659. ;; Use global prewarning-restart lead time.
  5660. org-agenda-skip-deadline-prewarning-if-scheduled)
  5661. ((eq org-agenda-skip-deadline-prewarning-if-scheduled
  5662. 'pre-scheduled)
  5663. ;; Set pre-warning to no earlier than SCHEDULED.
  5664. (min (- deadline
  5665. (org-agenda--timestamp-to-absolute scheduled))
  5666. org-deadline-warning-days))
  5667. ;; Set pre-warning to deadline.
  5668. (t 0))))
  5669. (wdays (or suppress-prewarning (org-get-wdays s))))
  5670. (cond
  5671. ;; Only display deadlines at their base date, at future
  5672. ;; repeat occurrences or in today agenda.
  5673. ((= current deadline) nil)
  5674. ((= current repeat) nil)
  5675. ((not today?) (throw :skip nil))
  5676. ;; Upcoming deadline: display within warning period WDAYS.
  5677. ((> deadline current) (when (> diff wdays) (throw :skip nil)))
  5678. ;; Overdue deadline: warn about it for
  5679. ;; `org-deadline-past-days' duration.
  5680. (t (when (< org-deadline-past-days (- diff)) (throw :skip nil))))
  5681. ;; Possibly skip done tasks.
  5682. (when (and done?
  5683. (or org-agenda-skip-deadline-if-done
  5684. (/= deadline current)))
  5685. (throw :skip nil))
  5686. (save-excursion
  5687. (re-search-backward "^\\*+[ \t]+" nil t)
  5688. (goto-char (match-end 0))
  5689. (let* ((category (org-get-category))
  5690. (level (make-string (org-reduced-level (org-outline-level))
  5691. ?\s))
  5692. (head (buffer-substring (point) (line-end-position)))
  5693. (inherited-tags
  5694. (or (eq org-agenda-show-inherited-tags 'always)
  5695. (and (listp org-agenda-show-inherited-tags)
  5696. (memq 'agenda org-agenda-show-inherited-tags))
  5697. (and (eq org-agenda-show-inherited-tags t)
  5698. (or (eq org-agenda-use-tag-inheritance t)
  5699. (memq 'agenda
  5700. org-agenda-use-tag-inheritance)))))
  5701. (tags (org-get-tags nil (not inherited-tags)))
  5702. (time
  5703. (cond
  5704. ;; No time of day designation if it is only
  5705. ;; a reminder.
  5706. ((and (/= current deadline) (/= current repeat)) nil)
  5707. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5708. (concat (substring s (match-beginning 1)) " "))
  5709. (t 'time)))
  5710. (item
  5711. (org-agenda-format-item
  5712. ;; Insert appropriate suffixes before deadlines.
  5713. ;; Those only apply to today agenda.
  5714. (pcase-let ((`(,now ,future ,past)
  5715. org-agenda-deadline-leaders))
  5716. (cond
  5717. ((and today? (< deadline today)) (format past (- diff)))
  5718. ((and today? (> deadline today)) (format future diff))
  5719. (t now)))
  5720. head level category tags time))
  5721. (face (org-agenda-deadline-face
  5722. (- 1 (/ (float diff) (max wdays 1)))))
  5723. (upcoming? (and today? (> deadline today)))
  5724. (warntime (get-text-property (point) 'org-appt-warntime)))
  5725. (org-add-props item props
  5726. 'org-marker (org-agenda-new-marker pos)
  5727. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  5728. 'warntime warntime
  5729. 'level level
  5730. 'ts-date deadline
  5731. 'priority
  5732. ;; Adjust priority to today reminders about deadlines.
  5733. ;; Overdue deadlines get the highest priority
  5734. ;; increase, then imminent deadlines and eventually
  5735. ;; more distant deadlines.
  5736. (let ((adjust (if today? (- diff) 0)))
  5737. (+ adjust (org-get-priority item)))
  5738. 'todo-state todo-state
  5739. 'type (if upcoming? "upcoming-deadline" "deadline")
  5740. 'date (if upcoming? date deadline)
  5741. 'face (if done? 'org-agenda-done face)
  5742. 'undone-face face
  5743. 'done-face 'org-agenda-done)
  5744. (push item deadline-items))))))
  5745. (nreverse deadline-items)))
  5746. (defun org-agenda-deadline-face (fraction)
  5747. "Return the face to displaying a deadline item.
  5748. FRACTION is what fraction of the head-warning time has passed."
  5749. (assoc-default fraction org-agenda-deadline-faces #'<=))
  5750. (defun org-agenda-get-scheduled (&optional deadlines with-hour)
  5751. "Return the scheduled information for agenda display.
  5752. Optional argument DEADLINES is a list of deadline items to be
  5753. displayed in agenda view. When WITH-HOUR is non-nil, only return
  5754. scheduled items with an hour specification like [h]h:mm."
  5755. (let* ((props (list 'org-not-done-regexp org-not-done-regexp
  5756. 'org-todo-regexp org-todo-regexp
  5757. 'org-complex-heading-regexp org-complex-heading-regexp
  5758. 'done-face 'org-agenda-done
  5759. 'mouse-face 'highlight
  5760. 'help-echo
  5761. (format "mouse-2 or RET jump to Org file %s"
  5762. (abbreviate-file-name buffer-file-name))))
  5763. (regexp (if with-hour
  5764. org-scheduled-time-hour-regexp
  5765. org-scheduled-time-regexp))
  5766. (today (org-today))
  5767. (todayp (org-agenda-today-p date)) ; DATE bound by calendar.
  5768. (current (calendar-absolute-from-gregorian date))
  5769. (deadline-pos
  5770. (mapcar (lambda (d)
  5771. (let ((m (get-text-property 0 'org-hd-marker d)))
  5772. (and m (marker-position m))))
  5773. deadlines))
  5774. scheduled-items)
  5775. (goto-char (point-min))
  5776. (while (re-search-forward regexp nil t)
  5777. (catch :skip
  5778. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5779. (org-agenda-skip)
  5780. (let* ((s (match-string 1))
  5781. (pos (1- (match-beginning 1)))
  5782. (todo-state (save-match-data (org-get-todo-state)))
  5783. (donep (member todo-state org-done-keywords))
  5784. (sexp? (string-prefix-p "%%" s))
  5785. ;; SCHEDULE is the scheduled date for the entry. It is
  5786. ;; either the bare date or the last repeat, according
  5787. ;; to `org-agenda-prefer-last-repeat'.
  5788. (schedule
  5789. (cond
  5790. (sexp? (org-agenda--timestamp-to-absolute s current))
  5791. ((or (eq org-agenda-prefer-last-repeat t)
  5792. (member todo-state org-agenda-prefer-last-repeat))
  5793. (org-agenda--timestamp-to-absolute
  5794. s today 'past (current-buffer) pos))
  5795. (t (org-agenda--timestamp-to-absolute s))))
  5796. ;; REPEAT is the future repeat closest from CURRENT,
  5797. ;; according to `org-agenda-show-future-repeats'. If
  5798. ;; the latter is nil, or if the time stamp has no
  5799. ;; repeat part, default to SCHEDULE.
  5800. (repeat
  5801. (cond
  5802. (sexp? schedule)
  5803. ((<= current today) schedule)
  5804. ((not org-agenda-show-future-repeats) schedule)
  5805. (t
  5806. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5807. (1+ today)
  5808. current)))
  5809. (org-agenda--timestamp-to-absolute
  5810. s base 'future (current-buffer) pos)))))
  5811. (diff (- current schedule))
  5812. (warntime (get-text-property (point) 'org-appt-warntime))
  5813. (pastschedp (< schedule today))
  5814. (futureschedp (> schedule today))
  5815. (habitp (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  5816. (suppress-delay
  5817. (let ((deadline (and org-agenda-skip-scheduled-delay-if-deadline
  5818. (org-entry-get nil "DEADLINE"))))
  5819. (cond
  5820. ((not deadline) nil)
  5821. ;; The current item has a deadline date, so
  5822. ;; evaluate its delay time.
  5823. ((integerp org-agenda-skip-scheduled-delay-if-deadline)
  5824. ;; Use global delay time.
  5825. (- org-agenda-skip-scheduled-delay-if-deadline))
  5826. ((eq org-agenda-skip-scheduled-delay-if-deadline
  5827. 'post-deadline)
  5828. ;; Set delay to no later than DEADLINE.
  5829. (min (- schedule
  5830. (org-agenda--timestamp-to-absolute deadline))
  5831. org-scheduled-delay-days))
  5832. (t 0))))
  5833. (diff-r (abs (- repeat current)))
  5834. (ddays-once (or (and (string-match "--\\([0-9]+\\)[hdwmy]" s)
  5835. (string-to-number (match-string 1 s)))
  5836. 0))
  5837. (ddays
  5838. (cond
  5839. ;; Nullify delay when a repeater triggered already
  5840. ;; and the delay is of the form --Xd.
  5841. ((and (string-match-p "--[0-9]+[hdwmy]" s)
  5842. (> schedule (org-agenda--timestamp-to-absolute s)))
  5843. 0)
  5844. (suppress-delay
  5845. (let ((org-scheduled-delay-days suppress-delay))
  5846. (org-get-wdays s t t)))
  5847. (t (org-get-wdays s t)))))
  5848. ;; Display scheduled items at base date (SCHEDULE), today if
  5849. ;; scheduled before the current date, and at any repeat past
  5850. ;; today. However, skip delayed items and items that have
  5851. ;; been displayed for more than `org-scheduled-past-days'.
  5852. (unless (and todayp
  5853. habitp
  5854. (bound-and-true-p org-habit-show-all-today))
  5855. (when (or
  5856. ;; no one-time delay, not repeated delay
  5857. (and (not ddays-once) (not (= ddays diff-r)))
  5858. ;; one-time delay, but not for today
  5859. (and ddays-once
  5860. (not (= diff diff-r))
  5861. (= ddays-once diff-r))
  5862. ;; normal delay, but already in the past
  5863. (and (> ddays 0) (< diff ddays))
  5864. ;; a habit, but past `org-habit-scheduled-past-days'
  5865. (> diff (or (and habitp org-habit-scheduled-past-days)
  5866. org-scheduled-past-days))
  5867. ;; schedule in the future
  5868. (> schedule current)
  5869. ;; no delay, not scheduled today, no deadline for today
  5870. (and (= ddays 0)
  5871. (/= current schedule)
  5872. (/= current today)
  5873. (/= current repeat)))
  5874. (throw :skip nil)))
  5875. ;; Possibly skip done tasks.
  5876. (when (and donep
  5877. (or org-agenda-skip-scheduled-if-done
  5878. (/= schedule current)))
  5879. (throw :skip nil))
  5880. ;; Skip entry if it already appears as a deadline, per
  5881. ;; `org-agenda-skip-scheduled-if-deadline-is-shown'. This
  5882. ;; doesn't apply to habits.
  5883. (when (pcase org-agenda-skip-scheduled-if-deadline-is-shown
  5884. ((guard
  5885. (or (not (memq (line-beginning-position 0) deadline-pos))
  5886. habitp))
  5887. nil)
  5888. (`repeated-after-deadline
  5889. (let ((deadline (time-to-days
  5890. (org-get-deadline-time (point)))))
  5891. (and (<= schedule deadline) (> current deadline))))
  5892. (`not-today pastschedp)
  5893. (`t t)
  5894. (_ nil))
  5895. (throw :skip nil))
  5896. ;; Skip habits if `org-habit-show-habits' is nil, or if we
  5897. ;; only show them for today. Also skip done habits.
  5898. (when (and habitp
  5899. (or donep
  5900. (not (bound-and-true-p org-habit-show-habits))
  5901. (and (not todayp)
  5902. (bound-and-true-p
  5903. org-habit-show-habits-only-for-today))))
  5904. (throw :skip nil))
  5905. (save-excursion
  5906. (re-search-backward "^\\*+[ \t]+" nil t)
  5907. (goto-char (match-end 0))
  5908. (let* ((category (org-get-category))
  5909. (inherited-tags
  5910. (or (eq org-agenda-show-inherited-tags 'always)
  5911. (and (listp org-agenda-show-inherited-tags)
  5912. (memq 'agenda org-agenda-show-inherited-tags))
  5913. (and (eq org-agenda-show-inherited-tags t)
  5914. (or (eq org-agenda-use-tag-inheritance t)
  5915. (memq 'agenda
  5916. org-agenda-use-tag-inheritance)))))
  5917. (tags (org-get-tags nil (not inherited-tags)))
  5918. (level (make-string (org-reduced-level (org-outline-level))
  5919. ?\s))
  5920. (head (buffer-substring (point) (line-end-position)))
  5921. (time
  5922. (cond
  5923. ;; No time of day designation if it is only a
  5924. ;; reminder, except for habits, which always show
  5925. ;; the time of day. Habits are an exception
  5926. ;; because if there is a time of day, that is
  5927. ;; interpreted to mean they should usually happen
  5928. ;; then, even if doing the habit was missed.
  5929. ((and
  5930. (not habitp)
  5931. (/= current schedule)
  5932. (/= current repeat))
  5933. nil)
  5934. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5935. (concat (substring s (match-beginning 1)) " "))
  5936. (t 'time)))
  5937. (item
  5938. (org-agenda-format-item
  5939. (pcase-let ((`(,first ,past) org-agenda-scheduled-leaders))
  5940. ;; Show a reminder of a past scheduled today.
  5941. (if (and todayp pastschedp)
  5942. (format past diff)
  5943. first))
  5944. head level category tags time nil habitp))
  5945. (face (cond ((and (not habitp) pastschedp)
  5946. 'org-scheduled-previously)
  5947. ((and habitp futureschedp)
  5948. 'org-agenda-done)
  5949. (todayp 'org-scheduled-today)
  5950. (t 'org-scheduled)))
  5951. (habitp (and habitp (org-habit-parse-todo))))
  5952. (org-add-props item props
  5953. 'undone-face face
  5954. 'face (if donep 'org-agenda-done face)
  5955. 'org-marker (org-agenda-new-marker pos)
  5956. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  5957. 'type (if pastschedp "past-scheduled" "scheduled")
  5958. 'date (if pastschedp schedule date)
  5959. 'ts-date schedule
  5960. 'warntime warntime
  5961. 'level level
  5962. 'priority (if habitp (org-habit-get-priority habitp)
  5963. (+ 99 diff (org-get-priority item)))
  5964. 'org-habit-p habitp
  5965. 'todo-state todo-state)
  5966. (push item scheduled-items))))))
  5967. (nreverse scheduled-items)))
  5968. (defun org-agenda-get-blocks ()
  5969. "Return the date-range information for agenda display."
  5970. (let* ((props (list 'face nil
  5971. 'org-not-done-regexp org-not-done-regexp
  5972. 'org-todo-regexp org-todo-regexp
  5973. 'org-complex-heading-regexp org-complex-heading-regexp
  5974. 'mouse-face 'highlight
  5975. 'help-echo
  5976. (format "mouse-2 or RET jump to org file %s"
  5977. (abbreviate-file-name buffer-file-name))))
  5978. (regexp org-tr-regexp)
  5979. (d0 (calendar-absolute-from-gregorian date))
  5980. marker hdmarker ee txt d1 d2 s1 s2 category
  5981. level todo-state tags pos head donep inherited-tags)
  5982. (goto-char (point-min))
  5983. (while (re-search-forward regexp nil t)
  5984. (catch :skip
  5985. (org-agenda-skip)
  5986. (setq pos (point))
  5987. (let ((start-time (match-string 1))
  5988. (end-time (match-string 2)))
  5989. (setq s1 (match-string 1)
  5990. s2 (match-string 2)
  5991. d1 (time-to-days
  5992. (condition-case err
  5993. (org-time-string-to-time s1)
  5994. (error
  5995. (error
  5996. "Bad timestamp %S at %d in buffer %S\nError was: %s"
  5997. s1
  5998. pos
  5999. (current-buffer)
  6000. (error-message-string err)))))
  6001. d2 (time-to-days
  6002. (condition-case err
  6003. (org-time-string-to-time s2)
  6004. (error
  6005. (error
  6006. "Bad timestamp %S at %d in buffer %S\nError was: %s"
  6007. s2
  6008. pos
  6009. (current-buffer)
  6010. (error-message-string err))))))
  6011. (when (and (> (- d0 d1) -1) (> (- d2 d0) -1))
  6012. ;; Only allow days between the limits, because the normal
  6013. ;; date stamps will catch the limits.
  6014. (save-excursion
  6015. (setq todo-state (org-get-todo-state))
  6016. (setq donep (member todo-state org-done-keywords))
  6017. (when (and donep org-agenda-skip-timestamp-if-done)
  6018. (throw :skip t))
  6019. (setq marker (org-agenda-new-marker (point))
  6020. category (org-get-category))
  6021. (if (not (re-search-backward org-outline-regexp-bol nil t))
  6022. (throw :skip nil)
  6023. (goto-char (match-beginning 0))
  6024. (setq hdmarker (org-agenda-new-marker (point))
  6025. inherited-tags
  6026. (or (eq org-agenda-show-inherited-tags 'always)
  6027. (and (listp org-agenda-show-inherited-tags)
  6028. (memq 'agenda org-agenda-show-inherited-tags))
  6029. (and (eq org-agenda-show-inherited-tags t)
  6030. (or (eq org-agenda-use-tag-inheritance t)
  6031. (memq 'agenda org-agenda-use-tag-inheritance))))
  6032. tags (org-get-tags nil (not inherited-tags)))
  6033. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  6034. (looking-at "\\*+[ \t]+\\(.*\\)")
  6035. (setq head (match-string 1))
  6036. (let ((remove-re
  6037. (if org-agenda-remove-timeranges-from-blocks
  6038. (concat
  6039. "<" (regexp-quote s1) ".*?>"
  6040. "--"
  6041. "<" (regexp-quote s2) ".*?>")
  6042. nil)))
  6043. (setq txt (org-agenda-format-item
  6044. (format
  6045. (nth (if (= d1 d2) 0 1)
  6046. org-agenda-timerange-leaders)
  6047. (1+ (- d0 d1)) (1+ (- d2 d1)))
  6048. head level category tags
  6049. (cond ((and (= d1 d0) (= d2 d0))
  6050. (concat "<" start-time ">--<" end-time ">"))
  6051. ((= d1 d0)
  6052. (concat "<" start-time ">"))
  6053. ((= d2 d0)
  6054. (concat "<" end-time ">")))
  6055. remove-re))))
  6056. (org-add-props txt props
  6057. 'org-marker marker 'org-hd-marker hdmarker
  6058. 'type "block" 'date date
  6059. 'level level
  6060. 'todo-state todo-state
  6061. 'priority (org-get-priority txt))
  6062. (push txt ee))))
  6063. (goto-char pos)))
  6064. ;; Sort the entries by expiration date.
  6065. (nreverse ee)))
  6066. ;;; Agenda presentation and sorting
  6067. (defvar org-prefix-has-time nil
  6068. "A flag, set by `org-compile-prefix-format'.
  6069. The flag is set if the currently compiled format contains a `%t'.")
  6070. (defvar org-prefix-has-tag nil
  6071. "A flag, set by `org-compile-prefix-format'.
  6072. The flag is set if the currently compiled format contains a `%T'.")
  6073. (defvar org-prefix-has-effort nil
  6074. "A flag, set by `org-compile-prefix-format'.
  6075. The flag is set if the currently compiled format contains a `%e'.")
  6076. (defvar org-prefix-has-breadcrumbs nil
  6077. "A flag, set by `org-compile-prefix-format'.
  6078. The flag is set if the currently compiled format contains a `%b'.")
  6079. (defvar org-prefix-category-length nil
  6080. "Used by `org-compile-prefix-format' to remember the category field width.")
  6081. (defvar org-prefix-category-max-length nil
  6082. "Used by `org-compile-prefix-format' to remember the category field width.")
  6083. (defun org-agenda-get-category-icon (category)
  6084. "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
  6085. (cl-dolist (entry org-agenda-category-icon-alist)
  6086. (when (string-match-p (car entry) category)
  6087. (if (listp (cadr entry))
  6088. (cl-return (cadr entry))
  6089. (cl-return (apply #'create-image (cdr entry)))))))
  6090. (defun org-agenda-format-item (extra txt &optional level category tags dotime
  6091. remove-re habitp)
  6092. "Format TXT to be inserted into the agenda buffer.
  6093. In particular, add the prefix and corresponding text properties.
  6094. EXTRA must be a string to replace the `%s' specifier in the prefix format.
  6095. LEVEL may be a string to replace the `%l' specifier.
  6096. CATEGORY (a string, a symbol or nil) may be used to overrule the default
  6097. category taken from local variable or file name. It will replace the `%c'
  6098. specifier in the format.
  6099. DOTIME, when non-nil, indicates that a time-of-day should be extracted from
  6100. TXT for sorting of this entry, and for the `%t' specifier in the format.
  6101. When DOTIME is a string, this string is searched for a time before TXT is.
  6102. TAGS can be the tags of the headline.
  6103. Any match of REMOVE-RE will be removed from TXT."
  6104. ;; We keep the org-prefix-* variable values along with a compiled
  6105. ;; formatter, so that multiple agendas existing at the same time do
  6106. ;; not step on each other toes.
  6107. ;;
  6108. ;; It was inconvenient to make these variables buffer local in
  6109. ;; Agenda buffers, because this function expects to be called with
  6110. ;; the buffer where item comes from being current, and not agenda
  6111. ;; buffer
  6112. (let* ((bindings (car org-prefix-format-compiled))
  6113. (formatter (cadr org-prefix-format-compiled)))
  6114. (cl-loop for (var value) in bindings
  6115. do (set var value))
  6116. (save-match-data
  6117. ;; Diary entries sometimes have extra whitespace at the beginning
  6118. (setq txt (org-trim txt))
  6119. ;; Fix the tags part in txt
  6120. (setq txt (org-agenda-fix-displayed-tags
  6121. txt tags
  6122. org-agenda-show-inherited-tags
  6123. org-agenda-hide-tags-regexp))
  6124. (let* ((category (or category
  6125. (if buffer-file-name
  6126. (file-name-sans-extension
  6127. (file-name-nondirectory buffer-file-name))
  6128. "")))
  6129. (category-icon (org-agenda-get-category-icon category))
  6130. (category-icon (if category-icon
  6131. (propertize " " 'display category-icon)
  6132. ""))
  6133. (effort (and (not (string= txt ""))
  6134. (get-text-property 1 'effort txt)))
  6135. ;; time, tag, effort are needed for the eval of the prefix format
  6136. (tag (if tags (nth (1- (length tags)) tags) ""))
  6137. (time-grid-trailing-characters (nth 2 org-agenda-time-grid))
  6138. time
  6139. (ts (when dotime (concat
  6140. (if (stringp dotime) dotime "")
  6141. (and org-agenda-search-headline-for-time txt))))
  6142. (time-of-day (and dotime (org-get-time-of-day ts)))
  6143. stamp plain s0 s1 s2 rtn srp l
  6144. duration breadcrumbs)
  6145. (and (derived-mode-p 'org-mode) buffer-file-name
  6146. (add-to-list 'org-agenda-contributing-files buffer-file-name))
  6147. (when (and dotime time-of-day)
  6148. ;; Extract starting and ending time and move them to prefix
  6149. (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
  6150. (setq plain (string-match org-plain-time-of-day-regexp ts)))
  6151. (setq s0 (match-string 0 ts)
  6152. srp (and stamp (match-end 3))
  6153. s1 (match-string (if plain 1 2) ts)
  6154. s2 (match-string (if plain 8 (if srp 4 6)) ts))
  6155. ;; If the times are in TXT (not in DOTIMES), and the prefix will list
  6156. ;; them, we might want to remove them there to avoid duplication.
  6157. ;; The user can turn this off with a variable.
  6158. (when (and org-prefix-has-time
  6159. org-agenda-remove-times-when-in-prefix (or stamp plain)
  6160. (string-match (concat (regexp-quote s0) " *") txt)
  6161. (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
  6162. (if (eq org-agenda-remove-times-when-in-prefix 'beg)
  6163. (= (match-beginning 0) 0)
  6164. t))
  6165. (setq txt (replace-match "" nil nil txt))))
  6166. ;; Normalize the time(s) to 24 hour
  6167. (when s1 (setq s1 (org-get-time-of-day s1 'string t)))
  6168. (when s2 (setq s2 (org-get-time-of-day s2 'string t)))
  6169. ;; Try to set s2 if s1 and
  6170. ;; `org-agenda-default-appointment-duration' are set
  6171. (when (and s1 (not s2) org-agenda-default-appointment-duration)
  6172. (setq s2
  6173. (org-duration-from-minutes
  6174. (+ (org-duration-to-minutes s1 t)
  6175. org-agenda-default-appointment-duration)
  6176. nil t)))
  6177. ;; Compute the duration
  6178. (when s2
  6179. (setq duration (- (org-duration-to-minutes s2)
  6180. (org-duration-to-minutes s1)))))
  6181. (when (string-match org-tag-group-re txt)
  6182. ;; Tags are in the string
  6183. (if (or (eq org-agenda-remove-tags t)
  6184. (and org-agenda-remove-tags
  6185. org-prefix-has-tag))
  6186. (setq txt (replace-match "" t t txt))
  6187. (setq txt (replace-match
  6188. (concat (make-string (max (- 50 (length txt)) 1) ?\ )
  6189. (match-string 1 txt))
  6190. t t txt))))
  6191. (when remove-re
  6192. (while (string-match remove-re txt)
  6193. (setq txt (replace-match "" t t txt))))
  6194. ;; Set org-heading property on `txt' to mark the start of the
  6195. ;; heading.
  6196. (add-text-properties 0 (length txt) '(org-heading t) txt)
  6197. ;; Prepare the variables needed in the eval of the compiled format
  6198. (when org-prefix-has-breadcrumbs
  6199. (setq breadcrumbs (org-with-point-at (org-get-at-bol 'org-marker)
  6200. (let ((s (org-format-outline-path (org-get-outline-path)
  6201. (1- (frame-width))
  6202. nil org-agenda-breadcrumbs-separator)))
  6203. (if (eq "" s) "" (concat s org-agenda-breadcrumbs-separator))))))
  6204. (setq time (cond (s2 (concat
  6205. (org-agenda-time-of-day-to-ampm-maybe s1)
  6206. "-" (org-agenda-time-of-day-to-ampm-maybe s2)
  6207. (when org-agenda-timegrid-use-ampm " ")))
  6208. (s1 (concat
  6209. (org-agenda-time-of-day-to-ampm-maybe s1)
  6210. (if org-agenda-timegrid-use-ampm
  6211. (concat time-grid-trailing-characters " ")
  6212. time-grid-trailing-characters)))
  6213. (t ""))
  6214. extra (or (and (not habitp) extra) "")
  6215. category (if (symbolp category) (symbol-name category) category)
  6216. level (or level ""))
  6217. (if (string-match org-link-bracket-re category)
  6218. (progn
  6219. (setq l (string-width (or (match-string 2) (match-string 1))))
  6220. (when (< l (or org-prefix-category-length 0))
  6221. (setq category (copy-sequence category))
  6222. (org-add-props category nil
  6223. 'extra-space (make-string
  6224. (- org-prefix-category-length l 1) ?\ ))))
  6225. (when (and org-prefix-category-max-length
  6226. (>= (length category) org-prefix-category-max-length))
  6227. (setq category (substring category 0 (1- org-prefix-category-max-length)))))
  6228. ;; Evaluate the compiled format
  6229. (setq rtn (concat (eval formatter) txt))
  6230. ;; And finally add the text properties
  6231. (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
  6232. (org-add-props rtn nil
  6233. 'org-category category
  6234. 'tags (mapcar 'org-downcase-keep-props tags)
  6235. 'org-highest-priority org-highest-priority
  6236. 'org-lowest-priority org-lowest-priority
  6237. 'time-of-day time-of-day
  6238. 'duration duration
  6239. 'breadcrumbs breadcrumbs
  6240. 'txt txt
  6241. 'level level
  6242. 'time time
  6243. 'extra extra
  6244. 'format org-prefix-format-compiled
  6245. 'dotime dotime)))))
  6246. (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
  6247. "Remove tags string from TXT, and add a modified list of tags.
  6248. The modified list may contain inherited tags, and tags matched by
  6249. `org-agenda-hide-tags-regexp' will be removed."
  6250. (when (or add-inherited hide-re)
  6251. (when (string-match org-tag-group-re txt)
  6252. (setq txt (substring txt 0 (match-beginning 0))))
  6253. (setq tags
  6254. (delq nil
  6255. (mapcar (lambda (tg)
  6256. (if (or (and hide-re (string-match hide-re tg))
  6257. (and (not add-inherited)
  6258. (get-text-property 0 'inherited tg)))
  6259. nil
  6260. tg))
  6261. tags)))
  6262. (when tags
  6263. (let ((have-i (get-text-property 0 'inherited (car tags)))
  6264. i)
  6265. (setq txt (concat txt " :"
  6266. (mapconcat
  6267. (lambda (x)
  6268. (setq i (get-text-property 0 'inherited x))
  6269. (if (and have-i (not i))
  6270. (progn
  6271. (setq have-i nil)
  6272. (concat ":" x))
  6273. x))
  6274. tags ":")
  6275. (if have-i "::" ":"))))))
  6276. txt)
  6277. (defun org-downcase-keep-props (s)
  6278. (let ((props (text-properties-at 0 s)))
  6279. (setq s (downcase s))
  6280. (add-text-properties 0 (length s) props s)
  6281. s))
  6282. (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
  6283. (defun org-agenda-add-time-grid-maybe (list ndays todayp)
  6284. "Add a time-grid for agenda items which need it.
  6285. LIST is the list of agenda items formatted by `org-agenda-list'.
  6286. NDAYS is the span of the current agenda view.
  6287. TODAYP is t when the current agenda view is on today."
  6288. (catch 'exit
  6289. (cond ((not org-agenda-use-time-grid) (throw 'exit list))
  6290. ((and todayp (member 'today (car org-agenda-time-grid))))
  6291. ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
  6292. ((member 'weekly (car org-agenda-time-grid)))
  6293. (t (throw 'exit list)))
  6294. (let* ((have (delq nil (mapcar
  6295. (lambda (x) (get-text-property 1 'time-of-day x))
  6296. list)))
  6297. (string (nth 3 org-agenda-time-grid))
  6298. (gridtimes (nth 1 org-agenda-time-grid))
  6299. (req (car org-agenda-time-grid))
  6300. (remove (member 'remove-match req))
  6301. new time)
  6302. (when (and (member 'require-timed req) (not have))
  6303. ;; don't show empty grid
  6304. (throw 'exit list))
  6305. (while (setq time (pop gridtimes))
  6306. (unless (and remove (member time have))
  6307. (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
  6308. (push (org-agenda-format-item
  6309. nil string nil "" nil
  6310. (concat (substring time 0 -2) ":" (substring time -2)))
  6311. new)
  6312. (put-text-property
  6313. 2 (length (car new)) 'face 'org-time-grid (car new))))
  6314. (when (and todayp org-agenda-show-current-time-in-grid)
  6315. (push (org-agenda-format-item
  6316. nil org-agenda-current-time-string nil "" nil
  6317. (format-time-string "%H:%M "))
  6318. new)
  6319. (put-text-property
  6320. 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
  6321. (if (member 'time-up org-agenda-sorting-strategy-selected)
  6322. (append new list)
  6323. (append list new)))))
  6324. (defun org-compile-prefix-format (key)
  6325. "Compile the prefix format into a Lisp form that can be evaluated.
  6326. The resulting form and associated variable bindings is returned
  6327. and stored in the variable `org-prefix-format-compiled'."
  6328. (setq org-prefix-has-time nil
  6329. org-prefix-has-tag nil
  6330. org-prefix-category-length nil
  6331. org-prefix-has-effort nil
  6332. org-prefix-has-breadcrumbs nil)
  6333. (let ((s (cond
  6334. ((stringp org-agenda-prefix-format)
  6335. org-agenda-prefix-format)
  6336. ((assq key org-agenda-prefix-format)
  6337. (cdr (assq key org-agenda-prefix-format)))
  6338. (t " %-12:c%?-12t% s")))
  6339. (start 0)
  6340. varform vars var e c f opt)
  6341. (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cltseib]\\|(.+)\\)"
  6342. s start)
  6343. (setq var (or (cdr (assoc (match-string 4 s)
  6344. '(("c" . category) ("t" . time) ("l" . level) ("s" . extra)
  6345. ("i" . category-icon) ("T" . tag) ("e" . effort) ("b" . breadcrumbs))))
  6346. 'eval)
  6347. c (or (match-string 3 s) "")
  6348. opt (match-beginning 1)
  6349. start (1+ (match-beginning 0)))
  6350. (cl-case var
  6351. (time (setq org-prefix-has-time t))
  6352. (tag (setq org-prefix-has-tag t))
  6353. (effort (setq org-prefix-has-effort t))
  6354. (breadcrumbs (setq org-prefix-has-breadcrumbs t)))
  6355. (setq f (concat "%" (match-string 2 s) "s"))
  6356. (when (eq var 'category)
  6357. (setq org-prefix-category-length
  6358. (floor (abs (string-to-number (match-string 2 s)))))
  6359. (setq org-prefix-category-max-length
  6360. (let ((x (match-string 2 s)))
  6361. (save-match-data
  6362. (and (string-match "\\.[0-9]+" x)
  6363. (string-to-number (substring (match-string 0 x) 1)))))))
  6364. (if (eq var 'eval)
  6365. (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
  6366. (if opt
  6367. (setq varform
  6368. `(if (or (equal "" ,var) (equal nil ,var))
  6369. ""
  6370. (format ,f (concat ,var ,c))))
  6371. (setq varform
  6372. `(format ,f (if (or (equal ,var "")
  6373. (equal ,var nil)) ""
  6374. (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
  6375. (setq s (replace-match "%s" t nil s))
  6376. (push varform vars))
  6377. (setq vars (nreverse vars))
  6378. (with-current-buffer (or org-agenda-buffer (current-buffer))
  6379. (setq org-prefix-format-compiled
  6380. (list
  6381. `((org-prefix-has-time ,org-prefix-has-time)
  6382. (org-prefix-has-tag ,org-prefix-has-tag)
  6383. (org-prefix-category-length ,org-prefix-category-length)
  6384. (org-prefix-has-effort ,org-prefix-has-effort)
  6385. (org-prefix-has-breadcrumbs ,org-prefix-has-breadcrumbs))
  6386. `(format ,s ,@vars))))))
  6387. (defun org-set-sorting-strategy (key)
  6388. (if (symbolp (car org-agenda-sorting-strategy))
  6389. ;; the old format
  6390. (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
  6391. (setq org-agenda-sorting-strategy-selected
  6392. (or (cdr (assq key org-agenda-sorting-strategy))
  6393. (cdr (assq 'agenda org-agenda-sorting-strategy))
  6394. '(time-up category-keep priority-down)))))
  6395. (defun org-get-time-of-day (s &optional string mod24)
  6396. "Check string S for a time of day.
  6397. If found, return it as a military time number between 0 and 2400.
  6398. If not found, return nil.
  6399. The optional STRING argument forces conversion into a 5 character wide string
  6400. HH:MM."
  6401. (save-match-data
  6402. (when
  6403. (and
  6404. (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
  6405. (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
  6406. (not (eq (get-text-property 1 'face s) 'org-link)))
  6407. (let* ((h (string-to-number (match-string 1 s)))
  6408. (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
  6409. (ampm (when (match-end 4) (downcase (match-string 4 s))))
  6410. (am-p (equal ampm "am"))
  6411. (h1 (cond ((not ampm) h)
  6412. ((= h 12) (if am-p 0 12))
  6413. (t (+ h (if am-p 0 12)))))
  6414. (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
  6415. (mod h1 24) h1))
  6416. (t0 (+ (* 100 h2) m))
  6417. (t1 (concat (if (>= h1 24) "+" " ")
  6418. (if (and org-agenda-time-leading-zero
  6419. (< t0 1000)) "0" "")
  6420. (if (< t0 100) "0" "")
  6421. (if (< t0 10) "0" "")
  6422. (int-to-string t0))))
  6423. (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
  6424. (defvar org-agenda-before-sorting-filter-function nil
  6425. "Function to be applied to agenda items prior to sorting.
  6426. Prior to sorting also means just before they are inserted into the agenda.
  6427. To aid sorting, you may revisit the original entries and add more text
  6428. properties which will later be used by the sorting functions.
  6429. The function should take a string argument, an agenda line.
  6430. It has access to the text properties in that line, which contain among
  6431. other things, the property `org-hd-marker' that points to the entry
  6432. where the line comes from. Note that not all lines going into the agenda
  6433. have this property, only most.
  6434. The function should return the modified string. It is probably best
  6435. to ONLY change text properties.
  6436. You can also use this function as a filter, by returning nil for lines
  6437. you don't want to have in the agenda at all. For this application, you
  6438. could bind the variable in the options section of a custom command.")
  6439. (defun org-agenda-finalize-entries (list &optional type)
  6440. "Sort, limit and concatenate the LIST of agenda items.
  6441. The optional argument TYPE tells the agenda type."
  6442. (let ((max-effort (cond ((listp org-agenda-max-effort)
  6443. (cdr (assoc type org-agenda-max-effort)))
  6444. (t org-agenda-max-effort)))
  6445. (max-todo (cond ((listp org-agenda-max-todos)
  6446. (cdr (assoc type org-agenda-max-todos)))
  6447. (t org-agenda-max-todos)))
  6448. (max-tags (cond ((listp org-agenda-max-tags)
  6449. (cdr (assoc type org-agenda-max-tags)))
  6450. (t org-agenda-max-tags)))
  6451. (max-entries (cond ((listp org-agenda-max-entries)
  6452. (cdr (assoc type org-agenda-max-entries)))
  6453. (t org-agenda-max-entries))))
  6454. (when org-agenda-before-sorting-filter-function
  6455. (setq list
  6456. (delq nil
  6457. (mapcar
  6458. org-agenda-before-sorting-filter-function list))))
  6459. (setq list (mapcar 'org-agenda-highlight-todo list)
  6460. list (mapcar 'identity (sort list 'org-entries-lessp)))
  6461. (when max-effort
  6462. (setq list (org-agenda-limit-entries
  6463. list 'effort-minutes max-effort
  6464. (lambda (e) (or e (if org-sort-agenda-noeffort-is-high
  6465. 32767 -1))))))
  6466. (when max-todo
  6467. (setq list (org-agenda-limit-entries list 'todo-state max-todo)))
  6468. (when max-tags
  6469. (setq list (org-agenda-limit-entries list 'tags max-tags)))
  6470. (when max-entries
  6471. (setq list (org-agenda-limit-entries list 'org-hd-marker max-entries)))
  6472. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  6473. (setq list (mapcar #'org-agenda--mark-blocked-entry list)))
  6474. (mapconcat 'identity list "\n")))
  6475. (defun org-agenda-limit-entries (list prop limit &optional fn)
  6476. "Limit the number of agenda entries."
  6477. (let ((include (and limit (< limit 0))))
  6478. (if limit
  6479. (let ((fun (or fn (lambda (p) (when p 1))))
  6480. (lim 0))
  6481. (delq nil
  6482. (mapcar
  6483. (lambda (e)
  6484. (let ((pval (funcall
  6485. fun (get-text-property (1- (length e))
  6486. prop e))))
  6487. (when pval (setq lim (+ lim pval)))
  6488. (cond ((and pval (<= lim (abs limit))) e)
  6489. ((and include (not pval)) e))))
  6490. list)))
  6491. list)))
  6492. (defun org-agenda-limit-interactively (remove)
  6493. "In agenda, interactively limit entries to various maximums."
  6494. (interactive "P")
  6495. (if remove
  6496. (progn (setq org-agenda-max-entries nil
  6497. org-agenda-max-todos nil
  6498. org-agenda-max-tags nil
  6499. org-agenda-max-effort nil)
  6500. (org-agenda-redo))
  6501. (let* ((max (read-char "Number of [e]ntries [t]odos [T]ags [E]ffort? "))
  6502. (msg (cond ((= max ?E) "How many minutes? ")
  6503. ((= max ?e) "How many entries? ")
  6504. ((= max ?t) "How many TODO entries? ")
  6505. ((= max ?T) "How many tagged entries? ")
  6506. (t (user-error "Wrong input"))))
  6507. (num (string-to-number (read-from-minibuffer msg))))
  6508. (cond ((equal max ?e)
  6509. (let ((org-agenda-max-entries num)) (org-agenda-redo)))
  6510. ((equal max ?t)
  6511. (let ((org-agenda-max-todos num)) (org-agenda-redo)))
  6512. ((equal max ?T)
  6513. (let ((org-agenda-max-tags num)) (org-agenda-redo)))
  6514. ((equal max ?E)
  6515. (let ((org-agenda-max-effort num)) (org-agenda-redo))))))
  6516. (org-agenda-fit-window-to-buffer))
  6517. (defun org-agenda-highlight-todo (x)
  6518. (let ((org-done-keywords org-done-keywords-for-agenda)
  6519. (case-fold-search nil)
  6520. re)
  6521. (if (eq x 'line)
  6522. (save-excursion
  6523. (beginning-of-line 1)
  6524. (setq re (org-get-at-bol 'org-todo-regexp))
  6525. (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
  6526. (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
  6527. (add-text-properties (match-beginning 0) (match-end 1)
  6528. (list 'face (org-get-todo-face 1)))
  6529. (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
  6530. (delete-region (match-beginning 1) (1- (match-end 0)))
  6531. (goto-char (match-beginning 1))
  6532. (insert (format org-agenda-todo-keyword-format s)))))
  6533. (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
  6534. (setq re (get-text-property 0 'org-todo-regexp x))
  6535. (when (and re
  6536. ;; Test `pl' because if there's no heading content,
  6537. ;; there's no point matching to highlight. Note
  6538. ;; that if we didn't test `pl' first, and there
  6539. ;; happened to be no keyword from `org-todo-regexp'
  6540. ;; on this heading line, then the `equal' comparison
  6541. ;; afterwards would spuriously succeed in the case
  6542. ;; where `pl' is nil -- causing an args-out-of-range
  6543. ;; error when we try to add text properties to text
  6544. ;; that isn't there.
  6545. pl
  6546. (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
  6547. x pl) pl))
  6548. (add-text-properties
  6549. (or (match-end 1) (match-end 0)) (match-end 0)
  6550. (list 'face (org-get-todo-face (match-string 2 x)))
  6551. x)
  6552. (when (match-end 1)
  6553. (setq x
  6554. (concat
  6555. (substring x 0 (match-end 1))
  6556. (format org-agenda-todo-keyword-format
  6557. (match-string 2 x))
  6558. ;; Remove `display' property as the icon could leak
  6559. ;; on the white space.
  6560. (org-add-props " " (org-plist-delete (text-properties-at 0 x)
  6561. 'display))
  6562. (substring x (match-end 3)))))))
  6563. x)))
  6564. (defsubst org-cmp-values (a b property)
  6565. "Compare the numeric value of text PROPERTY for string A and B."
  6566. (let ((pa (or (get-text-property (1- (length a)) property a) 0))
  6567. (pb (or (get-text-property (1- (length b)) property b) 0)))
  6568. (cond ((> pa pb) +1)
  6569. ((< pa pb) -1))))
  6570. (defsubst org-cmp-effort (a b)
  6571. "Compare the effort values of string A and B."
  6572. (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
  6573. ;; `effort-minutes' property is not directly accessible from
  6574. ;; the strings, but is stored as a property in `txt'.
  6575. (ea (or (get-text-property
  6576. 0 'effort-minutes (get-text-property 0 'txt a))
  6577. def))
  6578. (eb (or (get-text-property
  6579. 0 'effort-minutes (get-text-property 0 'txt b))
  6580. def)))
  6581. (cond ((> ea eb) +1)
  6582. ((< ea eb) -1))))
  6583. (defsubst org-cmp-category (a b)
  6584. "Compare the string values of categories of strings A and B."
  6585. (let ((ca (or (get-text-property (1- (length a)) 'org-category a) ""))
  6586. (cb (or (get-text-property (1- (length b)) 'org-category b) "")))
  6587. (cond ((string-lessp ca cb) -1)
  6588. ((string-lessp cb ca) +1))))
  6589. (defsubst org-cmp-todo-state (a b)
  6590. "Compare the todo states of strings A and B."
  6591. (let* ((ma (or (get-text-property 1 'org-marker a)
  6592. (get-text-property 1 'org-hd-marker a)))
  6593. (mb (or (get-text-property 1 'org-marker b)
  6594. (get-text-property 1 'org-hd-marker b)))
  6595. (fa (and ma (marker-buffer ma)))
  6596. (fb (and mb (marker-buffer mb)))
  6597. (todo-kwds
  6598. (or (and fa (with-current-buffer fa org-todo-keywords-1))
  6599. (and fb (with-current-buffer fb org-todo-keywords-1))))
  6600. (ta (or (get-text-property 1 'todo-state a) ""))
  6601. (tb (or (get-text-property 1 'todo-state b) ""))
  6602. (la (- (length (member ta todo-kwds))))
  6603. (lb (- (length (member tb todo-kwds))))
  6604. (donepa (member ta org-done-keywords-for-agenda))
  6605. (donepb (member tb org-done-keywords-for-agenda)))
  6606. (cond ((and donepa (not donepb)) -1)
  6607. ((and (not donepa) donepb) +1)
  6608. ((< la lb) -1)
  6609. ((< lb la) +1))))
  6610. (defsubst org-cmp-alpha (a b)
  6611. "Compare the headlines, alphabetically."
  6612. (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
  6613. (plb (text-property-any 0 (length b) 'org-heading t b))
  6614. (ta (and pla (substring a pla)))
  6615. (tb (and plb (substring b plb)))
  6616. (case-fold-search nil))
  6617. (when pla
  6618. (when (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
  6619. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
  6620. (setq ta (substring ta (match-end 0))))
  6621. (setq ta (downcase ta)))
  6622. (when plb
  6623. (when (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
  6624. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
  6625. (setq tb (substring tb (match-end 0))))
  6626. (setq tb (downcase tb)))
  6627. (cond ((not (or ta tb)) nil)
  6628. ((not ta) +1)
  6629. ((not tb) -1)
  6630. ((string-lessp ta tb) -1)
  6631. ((string-lessp tb ta) +1))))
  6632. (defsubst org-cmp-tag (a b)
  6633. "Compare the string values of the first tags of A and B."
  6634. (let ((ta (car (last (get-text-property 1 'tags a))))
  6635. (tb (car (last (get-text-property 1 'tags b)))))
  6636. (cond ((not (or ta tb)) nil)
  6637. ((not ta) +1)
  6638. ((not tb) -1)
  6639. ((string-lessp ta tb) -1)
  6640. ((string-lessp tb ta) +1))))
  6641. (defsubst org-cmp-time (a b)
  6642. "Compare the time-of-day values of strings A and B."
  6643. (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
  6644. (ta (or (get-text-property 1 'time-of-day a) def))
  6645. (tb (or (get-text-property 1 'time-of-day b) def)))
  6646. (cond ((< ta tb) -1)
  6647. ((< tb ta) +1))))
  6648. (defsubst org-cmp-ts (a b type)
  6649. "Compare the timestamps values of entries A and B.
  6650. When TYPE is \"scheduled\", \"deadline\", \"timestamp\" or
  6651. \"timestamp_ia\", compare within each of these type. When TYPE
  6652. is the empty string, compare all timestamps without respect of
  6653. their type."
  6654. (let* ((def (and (not org-sort-agenda-notime-is-late) -1))
  6655. (ta (or (and (string-match type (or (get-text-property 1 'type a) ""))
  6656. (get-text-property 1 'ts-date a))
  6657. def))
  6658. (tb (or (and (string-match type (or (get-text-property 1 'type b) ""))
  6659. (get-text-property 1 'ts-date b))
  6660. def)))
  6661. (cond ((if ta (and tb (< ta tb)) tb) -1)
  6662. ((if tb (and ta (< tb ta)) ta) +1))))
  6663. (defsubst org-cmp-habit-p (a b)
  6664. "Compare the todo states of strings A and B."
  6665. (let ((ha (get-text-property 1 'org-habit-p a))
  6666. (hb (get-text-property 1 'org-habit-p b)))
  6667. (cond ((and ha (not hb)) -1)
  6668. ((and (not ha) hb) +1))))
  6669. (defun org-entries-lessp (a b)
  6670. "Predicate for sorting agenda entries."
  6671. ;; The following variables will be used when the form is evaluated.
  6672. ;; So even though the compiler complains, keep them.
  6673. (let* ((ss org-agenda-sorting-strategy-selected)
  6674. (timestamp-up (and (org-em 'timestamp-up 'timestamp-down ss)
  6675. (org-cmp-ts a b "")))
  6676. (timestamp-down (if timestamp-up (- timestamp-up) nil))
  6677. (scheduled-up (and (org-em 'scheduled-up 'scheduled-down ss)
  6678. (org-cmp-ts a b "scheduled")))
  6679. (scheduled-down (if scheduled-up (- scheduled-up) nil))
  6680. (deadline-up (and (org-em 'deadline-up 'deadline-down ss)
  6681. (org-cmp-ts a b "deadline")))
  6682. (deadline-down (if deadline-up (- deadline-up) nil))
  6683. (tsia-up (and (org-em 'tsia-up 'tsia-down ss)
  6684. (org-cmp-ts a b "timestamp_ia")))
  6685. (tsia-down (if tsia-up (- tsia-up) nil))
  6686. (ts-up (and (org-em 'ts-up 'ts-down ss)
  6687. (org-cmp-ts a b "timestamp")))
  6688. (ts-down (if ts-up (- ts-up) nil))
  6689. (time-up (and (org-em 'time-up 'time-down ss)
  6690. (org-cmp-time a b)))
  6691. (time-down (if time-up (- time-up) nil))
  6692. (stats-up (and (org-em 'stats-up 'stats-down ss)
  6693. (org-cmp-values a b 'org-stats)))
  6694. (stats-down (if stats-up (- stats-up) nil))
  6695. (priority-up (and (org-em 'priority-up 'priority-down ss)
  6696. (org-cmp-values a b 'priority)))
  6697. (priority-down (if priority-up (- priority-up) nil))
  6698. (effort-up (and (org-em 'effort-up 'effort-down ss)
  6699. (org-cmp-effort a b)))
  6700. (effort-down (if effort-up (- effort-up) nil))
  6701. (category-up (and (or (org-em 'category-up 'category-down ss)
  6702. (memq 'category-keep ss))
  6703. (org-cmp-category a b)))
  6704. (category-down (if category-up (- category-up) nil))
  6705. (category-keep (if category-up +1 nil))
  6706. (tag-up (and (org-em 'tag-up 'tag-down ss)
  6707. (org-cmp-tag a b)))
  6708. (tag-down (if tag-up (- tag-up) nil))
  6709. (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
  6710. (org-cmp-todo-state a b)))
  6711. (todo-state-down (if todo-state-up (- todo-state-up) nil))
  6712. (habit-up (and (org-em 'habit-up 'habit-down ss)
  6713. (org-cmp-habit-p a b)))
  6714. (habit-down (if habit-up (- habit-up) nil))
  6715. (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
  6716. (org-cmp-alpha a b)))
  6717. (alpha-down (if alpha-up (- alpha-up) nil))
  6718. (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
  6719. user-defined-up user-defined-down)
  6720. (when (and need-user-cmp org-agenda-cmp-user-defined
  6721. (functionp org-agenda-cmp-user-defined))
  6722. (setq user-defined-up
  6723. (funcall org-agenda-cmp-user-defined a b)
  6724. user-defined-down (if user-defined-up (- user-defined-up) nil)))
  6725. (cdr (assoc
  6726. (eval (cons 'or org-agenda-sorting-strategy-selected))
  6727. '((-1 . t) (1 . nil) (nil . nil))))))
  6728. ;;; Agenda restriction lock
  6729. (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
  6730. "Overlay to mark the headline to which agenda commands are restricted.")
  6731. (overlay-put org-agenda-restriction-lock-overlay
  6732. 'face 'org-agenda-restriction-lock)
  6733. (overlay-put org-agenda-restriction-lock-overlay
  6734. 'help-echo "Agendas are currently limited to this subtree.")
  6735. (delete-overlay org-agenda-restriction-lock-overlay)
  6736. (defun org-agenda-set-restriction-lock-from-agenda (arg)
  6737. "Set the restriction lock to the agenda item at point from within the agenda.
  6738. When called with a `\\[universal-argument]' prefix, restrict to
  6739. the file which contains the item.
  6740. Argument ARG is the prefix argument."
  6741. (interactive "P")
  6742. (unless (derived-mode-p 'org-agenda-mode)
  6743. (user-error "Not in an Org agenda buffer"))
  6744. (let* ((marker (or (org-get-at-bol 'org-marker)
  6745. (org-agenda-error)))
  6746. (buffer (marker-buffer marker))
  6747. (pos (marker-position marker)))
  6748. (with-current-buffer buffer
  6749. (goto-char pos)
  6750. (org-agenda-set-restriction-lock arg))))
  6751. ;;;###autoload
  6752. (defun org-agenda-set-restriction-lock (&optional type)
  6753. "Set restriction lock for agenda to current subtree or file.
  6754. When in a restricted subtree, remove it.
  6755. The restriction will span over the entire file if TYPE is `file',
  6756. or if type is '(4), or if the cursor is before the first headline
  6757. in the file. Otherwise, only apply the restriction to the current
  6758. subtree."
  6759. (interactive "P")
  6760. (if (and org-agenda-overriding-restriction
  6761. (member org-agenda-restriction-lock-overlay
  6762. (overlays-at (point)))
  6763. (equal (overlay-start org-agenda-restriction-lock-overlay)
  6764. (point)))
  6765. (org-agenda-remove-restriction-lock 'noupdate)
  6766. (org-agenda-remove-restriction-lock 'noupdate)
  6767. (and (equal type '(4)) (setq type 'file))
  6768. (setq type (cond
  6769. (type type)
  6770. ((org-at-heading-p) 'subtree)
  6771. ((condition-case nil (org-back-to-heading t) (error nil))
  6772. 'subtree)
  6773. (t 'file)))
  6774. (if (eq type 'subtree)
  6775. (progn
  6776. (setq org-agenda-restrict (current-buffer))
  6777. (setq org-agenda-overriding-restriction 'subtree)
  6778. (put 'org-agenda-files 'org-restrict
  6779. (list (buffer-file-name (buffer-base-buffer))))
  6780. (org-back-to-heading t)
  6781. (move-overlay org-agenda-restriction-lock-overlay
  6782. (point)
  6783. (if org-agenda-restriction-lock-highlight-subtree
  6784. (save-excursion (org-end-of-subtree t t) (point))
  6785. (point-at-eol)))
  6786. (move-marker org-agenda-restrict-begin (point))
  6787. (move-marker org-agenda-restrict-end
  6788. (save-excursion (org-end-of-subtree t t)))
  6789. (message "Locking agenda restriction to subtree"))
  6790. (put 'org-agenda-files 'org-restrict
  6791. (list (buffer-file-name (buffer-base-buffer))))
  6792. (setq org-agenda-restrict nil)
  6793. (setq org-agenda-overriding-restriction 'file)
  6794. (move-marker org-agenda-restrict-begin nil)
  6795. (move-marker org-agenda-restrict-end nil)
  6796. (message "Locking agenda restriction to file"))
  6797. (setq current-prefix-arg nil))
  6798. (org-agenda-maybe-redo))
  6799. (defun org-agenda-remove-restriction-lock (&optional noupdate)
  6800. "Remove agenda restriction lock."
  6801. (interactive "P")
  6802. (if (not org-agenda-restrict)
  6803. (message "No agenda restriction to remove.")
  6804. (delete-overlay org-agenda-restriction-lock-overlay)
  6805. (delete-overlay org-speedbar-restriction-lock-overlay)
  6806. (setq org-agenda-overriding-restriction nil)
  6807. (setq org-agenda-restrict nil)
  6808. (put 'org-agenda-files 'org-restrict nil)
  6809. (move-marker org-agenda-restrict-begin nil)
  6810. (move-marker org-agenda-restrict-end nil)
  6811. (setq current-prefix-arg nil)
  6812. (message "Agenda restriction lock removed")
  6813. (or noupdate (org-agenda-maybe-redo))))
  6814. (defun org-agenda-maybe-redo ()
  6815. "If there is any window showing the agenda view, update it."
  6816. (let ((w (get-buffer-window (or org-agenda-this-buffer-name
  6817. org-agenda-buffer-name)
  6818. t))
  6819. (w0 (selected-window)))
  6820. (when w
  6821. (select-window w)
  6822. (org-agenda-redo)
  6823. (select-window w0)
  6824. (if org-agenda-overriding-restriction
  6825. (message "Agenda view shifted to new %s restriction"
  6826. org-agenda-overriding-restriction)
  6827. (message "Agenda restriction lock removed")))))
  6828. ;;; Agenda commands
  6829. (defun org-agenda-check-type (error &rest types)
  6830. "Check if agenda buffer or component is of allowed type.
  6831. If ERROR is non-nil, throw an error, otherwise just return nil.
  6832. Allowed types are `agenda' `todo' `tags' `search'."
  6833. (cond ((not org-agenda-type)
  6834. (error "No Org agenda currently displayed"))
  6835. ((memq org-agenda-type types) t)
  6836. (error
  6837. (error "Not allowed in '%s'-type agenda buffer or component" org-agenda-type))
  6838. (t nil)))
  6839. (defun org-agenda-Quit ()
  6840. "Exit the agenda, killing the agenda buffer.
  6841. Like `org-agenda-quit', but kill the buffer even when
  6842. `org-agenda-sticky' is non-nil."
  6843. (interactive)
  6844. (org-agenda--quit))
  6845. (defun org-agenda-quit ()
  6846. "Exit the agenda.
  6847. When `org-agenda-sticky' is non-nil, bury the agenda buffer
  6848. instead of killing it.
  6849. When `org-agenda-restore-windows-after-quit' is non-nil, restore
  6850. the pre-agenda window configuration.
  6851. When column view is active, exit column view instead of the
  6852. agenda."
  6853. (interactive)
  6854. (org-agenda--quit org-agenda-sticky))
  6855. (defun org-agenda--quit (&optional bury)
  6856. (if org-agenda-columns-active
  6857. (org-columns-quit)
  6858. (let ((wconf org-agenda-pre-window-conf)
  6859. (buf (current-buffer))
  6860. (org-agenda-last-indirect-window
  6861. (and (eq org-indirect-buffer-display 'other-window)
  6862. org-agenda-last-indirect-buffer
  6863. (get-buffer-window org-agenda-last-indirect-buffer))))
  6864. (cond
  6865. ((eq org-agenda-window-setup 'other-frame)
  6866. (delete-frame))
  6867. ((and org-agenda-restore-windows-after-quit
  6868. wconf)
  6869. ;; Maybe restore the pre-agenda window configuration. Reset
  6870. ;; `org-agenda-pre-window-conf' before running
  6871. ;; `set-window-configuration', which loses the current buffer.
  6872. (setq org-agenda-pre-window-conf nil)
  6873. (set-window-configuration wconf))
  6874. (t
  6875. (when org-agenda-last-indirect-window
  6876. (delete-window org-agenda-last-indirect-window))
  6877. (and (not (eq org-agenda-window-setup 'current-window))
  6878. (not (one-window-p))
  6879. (delete-window))))
  6880. (if bury
  6881. ;; Set the agenda buffer as the current buffer instead of
  6882. ;; passing it as an argument to `bury-buffer' so that
  6883. ;; `bury-buffer' removes it from the window.
  6884. (with-current-buffer buf
  6885. (bury-buffer))
  6886. (kill-buffer buf)
  6887. (setq org-agenda-archives-mode nil
  6888. org-agenda-buffer nil)))))
  6889. (defun org-agenda-exit ()
  6890. "Exit the agenda, killing Org buffers loaded by the agenda.
  6891. Like `org-agenda-Quit', but kill any buffers that were created by
  6892. the agenda. Org buffers visited directly by the user will not be
  6893. touched. Also, exit the agenda even if it is in column view."
  6894. (interactive)
  6895. (when org-agenda-columns-active
  6896. (org-columns-quit))
  6897. (org-release-buffers org-agenda-new-buffers)
  6898. (setq org-agenda-new-buffers nil)
  6899. (org-agenda-Quit))
  6900. (defun org-agenda-kill-all-agenda-buffers ()
  6901. "Kill all buffers in `org-agenda-mode'.
  6902. This is used when toggling sticky agendas."
  6903. (interactive)
  6904. (let (blist)
  6905. (dolist (buf (buffer-list))
  6906. (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
  6907. (push buf blist)))
  6908. (mapc 'kill-buffer blist)))
  6909. (defun org-agenda-execute (arg)
  6910. "Execute another agenda command, keeping same window.
  6911. So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
  6912. in the agenda."
  6913. (interactive "P")
  6914. (let ((org-agenda-window-setup 'current-window))
  6915. (org-agenda arg)))
  6916. (defun org-agenda-redo (&optional all)
  6917. "Rebuild possibly ALL agenda view(s) in the current buffer."
  6918. (interactive "P")
  6919. (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
  6920. (cpa (unless (eq all t) current-prefix-arg))
  6921. (org-agenda-doing-sticky-redo org-agenda-sticky)
  6922. (org-agenda-sticky nil)
  6923. (org-agenda-buffer-name (or org-agenda-this-buffer-name
  6924. org-agenda-buffer-name))
  6925. (org-agenda-keep-modes t)
  6926. (tag-filter org-agenda-tag-filter)
  6927. (tag-preset (get 'org-agenda-tag-filter :preset-filter))
  6928. (top-hl-filter org-agenda-top-headline-filter)
  6929. (cat-filter org-agenda-category-filter)
  6930. (cat-preset (get 'org-agenda-category-filter :preset-filter))
  6931. (re-filter org-agenda-regexp-filter)
  6932. (re-preset (get 'org-agenda-regexp-filter :preset-filter))
  6933. (effort-filter org-agenda-effort-filter)
  6934. (effort-preset (get 'org-agenda-effort-filter :preset-filter))
  6935. (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
  6936. (cols org-agenda-columns-active)
  6937. (line (org-current-line))
  6938. (window-line (- line (org-current-line (window-start))))
  6939. (lprops (get 'org-agenda-redo-command 'org-lprops))
  6940. (redo-cmd (get-text-property p 'org-redo-cmd))
  6941. (last-args (get-text-property p 'org-last-args))
  6942. (org-agenda-overriding-cmd (get-text-property p 'org-series-cmd))
  6943. (org-agenda-overriding-cmd-arguments
  6944. (unless (eq all t)
  6945. (cond ((listp last-args)
  6946. (cons (or cpa (car last-args)) (cdr last-args)))
  6947. ((stringp last-args)
  6948. last-args))))
  6949. (series-redo-cmd (get-text-property p 'org-series-redo-cmd)))
  6950. (put 'org-agenda-tag-filter :preset-filter nil)
  6951. (put 'org-agenda-category-filter :preset-filter nil)
  6952. (put 'org-agenda-regexp-filter :preset-filter nil)
  6953. (put 'org-agenda-effort-filter :preset-filter nil)
  6954. (and cols (org-columns-quit))
  6955. (message "Rebuilding agenda buffer...")
  6956. (if series-redo-cmd
  6957. (eval series-redo-cmd)
  6958. (org-let lprops redo-cmd))
  6959. (setq org-agenda-undo-list nil
  6960. org-agenda-pending-undo-list nil
  6961. org-agenda-tag-filter tag-filter
  6962. org-agenda-category-filter cat-filter
  6963. org-agenda-regexp-filter re-filter
  6964. org-agenda-effort-filter effort-filter
  6965. org-agenda-top-headline-filter top-hl-filter)
  6966. (message "Rebuilding agenda buffer...done")
  6967. (put 'org-agenda-tag-filter :preset-filter tag-preset)
  6968. (put 'org-agenda-category-filter :preset-filter cat-preset)
  6969. (put 'org-agenda-regexp-filter :preset-filter re-preset)
  6970. (put 'org-agenda-effort-filter :preset-filter effort-preset)
  6971. (let ((tag (or tag-filter tag-preset))
  6972. (cat (or cat-filter cat-preset))
  6973. (effort (or effort-filter effort-preset))
  6974. (re (or re-filter re-preset)))
  6975. (when tag (org-agenda-filter-apply tag 'tag t))
  6976. (when cat (org-agenda-filter-apply cat 'category))
  6977. (when effort (org-agenda-filter-apply effort 'effort))
  6978. (when re (org-agenda-filter-apply re 'regexp)))
  6979. (and top-hl-filter (org-agenda-filter-top-headline-apply top-hl-filter))
  6980. (and cols (called-interactively-p 'any) (org-agenda-columns))
  6981. (org-goto-line line)
  6982. (recenter window-line)))
  6983. (defun org-agenda-redo-all (&optional exhaustive)
  6984. "Rebuild all agenda views in the current buffer.
  6985. With a prefix argument, do so in all agenda buffers."
  6986. (interactive "P")
  6987. (if exhaustive
  6988. (dolist (buffer (buffer-list))
  6989. (with-current-buffer buffer
  6990. (when (derived-mode-p 'org-agenda-mode)
  6991. (org-agenda-redo t))))
  6992. (org-agenda-redo t)))
  6993. (defvar org-global-tags-completion-table nil)
  6994. (defvar org-agenda-filter-form nil)
  6995. (defvar org-agenda-filtered-by-category nil)
  6996. (defsubst org-agenda-get-category ()
  6997. "Return the category of the agenda line."
  6998. (org-get-at-bol 'org-category))
  6999. (defun org-agenda-filter-by-category (strip)
  7000. "Filter lines in the agenda buffer that have a specific category.
  7001. The category is that of the current line.
  7002. With a `\\[universal-argument]' prefix argument, exclude the lines of that category.
  7003. When there is already a category filter in place, this command removes the filter."
  7004. (interactive "P")
  7005. (if (and org-agenda-filtered-by-category
  7006. org-agenda-category-filter)
  7007. (org-agenda-filter-show-all-cat)
  7008. (let ((cat (org-no-properties (org-get-at-eol 'org-category 1))))
  7009. (cond
  7010. ((and cat strip)
  7011. (org-agenda-filter-apply
  7012. (push (concat "-" cat) org-agenda-category-filter) 'category))
  7013. (cat
  7014. (org-agenda-filter-apply
  7015. (setq org-agenda-category-filter
  7016. (list (concat "+" cat))) 'category))
  7017. (t (error "No category at point"))))))
  7018. (defun org-find-top-headline (&optional pos)
  7019. "Find the topmost parent headline and return it.
  7020. POS when non-nil is the marker or buffer position to start the
  7021. search from."
  7022. (save-excursion
  7023. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  7024. (when pos (goto-char pos))
  7025. ;; Skip up to the topmost parent.
  7026. (while (org-up-heading-safe))
  7027. (ignore-errors (nth 4 (org-heading-components))))))
  7028. (defvar org-agenda-filtered-by-top-headline nil)
  7029. (defun org-agenda-filter-by-top-headline (strip)
  7030. "Keep only those lines that are descendants from the same top headline.
  7031. The top headline is that of the current line. With prefix arg STRIP, hide
  7032. all lines of the category at point."
  7033. (interactive "P")
  7034. (if org-agenda-filtered-by-top-headline
  7035. (progn
  7036. (setq org-agenda-filtered-by-top-headline nil
  7037. org-agenda-top-headline-filter nil)
  7038. (org-agenda-filter-show-all-top-filter))
  7039. (let ((toph (org-find-top-headline (org-get-at-bol 'org-hd-marker))))
  7040. (if toph (org-agenda-filter-top-headline-apply toph strip)
  7041. (error "No top-level headline at point")))))
  7042. (defvar org-agenda-regexp-filter nil)
  7043. (defun org-agenda-filter-by-regexp (strip-or-accumulate)
  7044. "Filter agenda entries by a regular expressions.
  7045. You will be prompted for the regular expression, and the agenda
  7046. view will only show entries that are matched by that expression.
  7047. With one `\\[universal-argument]' prefix argument, hide entries matching the regexp.
  7048. When there is already a regexp filter active, this command removed the
  7049. filter. However, with two `\\[universal-argument]' prefix arguments, add a new condition to
  7050. an already existing regexp filter."
  7051. (interactive "P")
  7052. (let* ((strip (equal strip-or-accumulate '(4)))
  7053. (accumulate (equal strip-or-accumulate '(16))))
  7054. (cond
  7055. ((and org-agenda-regexp-filter (not accumulate))
  7056. (org-agenda-filter-show-all-re)
  7057. (message "Regexp filter removed"))
  7058. (t (let ((flt (concat (if strip "-" "+")
  7059. (read-from-minibuffer
  7060. (if strip
  7061. "Hide entries matching regexp: "
  7062. "Narrow to entries matching regexp: ")))))
  7063. (push flt org-agenda-regexp-filter)
  7064. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))))))
  7065. (defvar org-agenda-effort-filter nil)
  7066. (defun org-agenda-filter-by-effort (strip-or-accumulate)
  7067. "Filter agenda entries by effort.
  7068. With no `\\[universal-argument]' prefix argument, keep entries matching the effort condition.
  7069. With one `\\[universal-argument]' prefix argument, filter out entries matching the condition.
  7070. With two `\\[universal-argument]' prefix arguments, add a second condition to the existing filter.
  7071. This last option is in practice not very useful, but it is available for
  7072. consistency with the other filter commands."
  7073. (interactive "P")
  7074. (let* ((efforts (split-string
  7075. (or (cdr (assoc (concat org-effort-property "_ALL")
  7076. org-global-properties))
  7077. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00")))
  7078. ;; XXX: the following handles only up to 10 different
  7079. ;; effort values.
  7080. (allowed-keys (if (null efforts) nil
  7081. (mapcar (lambda (n) (mod n 10)) ;turn 10 into 0
  7082. (number-sequence 1 (length efforts)))))
  7083. (keep (equal strip-or-accumulate '(16)))
  7084. (negative (equal strip-or-accumulate '(4)))
  7085. (current org-agenda-effort-filter)
  7086. (op nil))
  7087. (while (not (memq op '(?< ?> ?= ?_)))
  7088. (setq op (read-char-exclusive
  7089. "Effort operator? (> = or <) or press `_' again to remove filter")))
  7090. ;; Select appropriate duration. Ignore non-digit characters.
  7091. (if (eq op ?_)
  7092. (progn
  7093. (org-agenda-filter-show-all-effort)
  7094. (message "Effort filter removed"))
  7095. (let ((prompt
  7096. (apply #'format
  7097. (concat "Effort %c "
  7098. (mapconcat (lambda (s) (concat "[%d]" s))
  7099. efforts
  7100. " "))
  7101. op allowed-keys))
  7102. (eff -1))
  7103. (while (not (memq eff allowed-keys))
  7104. (message prompt)
  7105. (setq eff (- (read-char-exclusive) 48)))
  7106. (org-agenda-filter-show-all-effort)
  7107. (setq org-agenda-effort-filter
  7108. (append
  7109. (list (concat (if negative "-" "+")
  7110. (char-to-string op)
  7111. ;; Numbering is 1 2 3 ... 9 0, but we want
  7112. ;; 0 1 2 ... 8 9.
  7113. (nth (mod (1- eff) 10) efforts)))
  7114. (if keep current nil)))
  7115. (org-agenda-filter-apply org-agenda-effort-filter 'effort)))))
  7116. (defun org-agenda-filter (&optional strip-or-accumulate)
  7117. "Prompt for a general filter string and apply it to the agenda.
  7118. The string may contain filter elements like
  7119. +category
  7120. +tag
  7121. +<effort > and = are also allowed as effort operators
  7122. +/regexp/
  7123. Instead of `+', `-' is allowed to strip the agenda of matching entries.
  7124. `+' is optional if it is not required to separate two string parts.
  7125. Multiple filter elements can be concatenated without spaces, for example
  7126. +work-John<0:10-/plot/
  7127. selects entries with category `work' and effort estimates below 10 minutes,
  7128. and deselects entries with tag `John' or matching the regexp `plot'.
  7129. During entry of the filter, completion for tags, categories and effort
  7130. values is offered. Since the syntax for categories and tags is identical
  7131. there should be no overlap between categories and tags. If there is, tags
  7132. get priority.
  7133. A single `\\[universal-argument]' prefix arg STRIP-OR-ACCUMULATE will negate the
  7134. entire filter, which can be useful in connection with the prompt history.
  7135. A double `\\[universal-argument] \\[universal-argument]' prefix arg will add the new filter elements to the
  7136. existing ones. A shortcut for this is to add an additional `+' at the
  7137. beginning of the string, like `+-John'.
  7138. With a triple prefix argument, execute the computed filtering defined in
  7139. the variable `org-agenda-auto-exclude-function'."
  7140. (interactive "P")
  7141. (if (equal strip-or-accumulate '(64))
  7142. ;; Execute the auto-exclude action
  7143. (if (not org-agenda-auto-exclude-function)
  7144. (user-error "`org-agenda-auto-exclude-function' is undefined")
  7145. (org-agenda-filter-show-all-tag)
  7146. (setq org-agenda-tag-filter nil)
  7147. (dolist (tag (org-agenda-get-represented-tags))
  7148. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  7149. (when modifier
  7150. (push modifier org-agenda-tag-filter))))
  7151. (unless (null org-agenda-tag-filter)
  7152. (org-agenda-filter-apply org-agenda-tag-filter 'tag 'expand)))
  7153. ;; Prompt for a filter and act
  7154. (let* ((tag-list (org-agenda-get-represented-tags))
  7155. (category-list (org-agenda-get-represented-categories))
  7156. (negate (equal strip-or-accumulate '(4)))
  7157. (f-string (completing-read
  7158. (concat
  7159. (if negate "Negative filter" "Filter")
  7160. " [+cat-tag<0:10-/regexp/]: ")
  7161. 'org-agenda-filter-completion-function))
  7162. (keep (or (if (string-match "^\\+[+-]" f-string)
  7163. (progn (setq f-string (substring f-string 1)) t))
  7164. (equal strip-or-accumulate '(16))))
  7165. (fc (if keep org-agenda-category-filter))
  7166. (ft (if keep org-agenda-tag-filter))
  7167. (fe (if keep org-agenda-effort-filter))
  7168. (fr (if keep org-agenda-regexp-filter))
  7169. pm s)
  7170. (while (string-match "^[ \t]*\\([-+]\\)?\\(\\([^-+<>=/ \t]+\\)\\|\\([<>=][0-9:]+\\)\\|\\(/\\([^/]+\\)/?\\)\\)" f-string)
  7171. (setq pm (if (match-beginning 1) (match-string 1 f-string) "+"))
  7172. (when negate
  7173. (setq pm (if (equal pm "+") "-" "+")))
  7174. (cond
  7175. ((match-beginning 3)
  7176. ;; category or tag
  7177. (setq s (match-string 3 f-string))
  7178. (cond
  7179. ((member s tag-list)
  7180. (add-to-list 'ft (concat pm s) 'append 'equal))
  7181. ((member s category-list)
  7182. (add-to-list 'fc (concat pm s) 'append 'equal))
  7183. (t (message
  7184. "`%s%s' filter ignored because tag/category is not represented"
  7185. pm s))))
  7186. ((match-beginning 4)
  7187. ;; effort
  7188. (add-to-list 'fe (concat pm (match-string 4 f-string)) t 'equal))
  7189. ((match-beginning 5)
  7190. ;; regexp
  7191. (add-to-list 'fr (concat pm (match-string 6 f-string)) t 'equal)))
  7192. (setq f-string (substring f-string (match-end 0))))
  7193. (org-agenda-filter-remove-all)
  7194. (and fc (org-agenda-filter-apply
  7195. (setq org-agenda-category-filter fc) 'category))
  7196. (and ft (org-agenda-filter-apply
  7197. (setq org-agenda-tag-filter ft) 'tag))
  7198. (and fe (org-agenda-filter-apply
  7199. (setq org-agenda-effort-filter fe) 'effort))
  7200. (and fr (org-agenda-filter-apply
  7201. (setq org-agenda-regexp-filter fr) 'regexp)))))
  7202. (defun org-agenda-filter-completion-function (string _predicate &optional flag)
  7203. "Complete a complex filter string.
  7204. FLAG specifies the type of completion operation to perform. This
  7205. function is passed as a collection function to `completing-read',
  7206. which see."
  7207. (let ((completion-ignore-case t) ;tags are case-sensitive
  7208. (confirm (lambda (x) (stringp x)))
  7209. (prefix "")
  7210. (operator "")
  7211. table)
  7212. (when (string-match "^\\(.*\\([-+<>=]\\)\\)\\([^-+<>=]*\\)$" string)
  7213. (setq prefix (match-string 1 string)
  7214. operator (match-string 2 string)
  7215. string (match-string 3 string)))
  7216. (cond
  7217. ((member operator '("+" "-" "" nil))
  7218. (setq table (append (org-agenda-get-represented-categories)
  7219. (org-agenda-get-represented-tags))))
  7220. ((member operator '("<" ">" "="))
  7221. (setq table (split-string
  7222. (or (cdr (assoc (concat org-effort-property "_ALL")
  7223. org-global-properties))
  7224. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00")
  7225. " +")))
  7226. (t (setq table nil)))
  7227. (pcase flag
  7228. (`t (all-completions string table confirm))
  7229. (`lambda (assoc string table)) ;exact match?
  7230. (`nil
  7231. (pcase (try-completion string table confirm)
  7232. ((and completion (pred stringp))
  7233. (concat prefix completion))
  7234. (completion completion)))
  7235. (_ nil))))
  7236. (defun org-agenda-filter-remove-all ()
  7237. "Remove all filters from the current agenda buffer."
  7238. (interactive)
  7239. (when org-agenda-tag-filter
  7240. (org-agenda-filter-show-all-tag))
  7241. (when org-agenda-category-filter
  7242. (org-agenda-filter-show-all-cat))
  7243. (when org-agenda-regexp-filter
  7244. (org-agenda-filter-show-all-re))
  7245. (when org-agenda-top-headline-filter
  7246. (org-agenda-filter-show-all-top-filter))
  7247. (when org-agenda-effort-filter
  7248. (org-agenda-filter-show-all-effort))
  7249. (org-agenda-finalize))
  7250. (defun org-agenda-filter-by-tag (strip-or-accumulate &optional char exclude)
  7251. "Keep only those lines in the agenda buffer that have a specific tag.
  7252. The tag is selected with its fast selection letter, as configured.
  7253. With a `\\[universal-argument]' prefix, apply the filter negatively, stripping all matches.
  7254. With a `\\[universal-argument] \\[universal-argument]' prefix, add the new tag to the existing filter
  7255. instead of replacing it.
  7256. With a `\\[universal-argument] \\[universal-argument] \\[universal-argument]' prefix, filter the literal tag, \
  7257. i.e. don't
  7258. filter on all its group members.
  7259. A lisp caller can specify CHAR. EXCLUDE means that the new tag
  7260. should be used to exclude the search - the interactive user can
  7261. also press `-' or `+' to switch between filtering and excluding."
  7262. (interactive "P")
  7263. (let* ((alist org-tag-alist-for-agenda)
  7264. (seen-chars nil)
  7265. (tag-chars (mapconcat
  7266. (lambda (x) (if (and (not (symbolp (car x)))
  7267. (cdr x)
  7268. (not (member (cdr x) seen-chars)))
  7269. (progn
  7270. (push (cdr x) seen-chars)
  7271. (char-to-string (cdr x)))
  7272. ""))
  7273. org-tag-alist-for-agenda ""))
  7274. (valid-char-list (append '(?\t ?\r ?\\ ?. ?\s ?q)
  7275. (string-to-list tag-chars)))
  7276. (exclude (or exclude (equal strip-or-accumulate '(4))))
  7277. (accumulate (equal strip-or-accumulate '(16)))
  7278. (expand (not (equal strip-or-accumulate '(64))))
  7279. (inhibit-read-only t)
  7280. (current org-agenda-tag-filter)
  7281. a n tag)
  7282. (unless char
  7283. (while (not (memq char valid-char-list))
  7284. (org-unlogged-message
  7285. "%s by tag%s: [%s ]tag-char [TAB]tag %s[\\]off [q]uit"
  7286. (if exclude "Exclude[+]" "Filter[-]")
  7287. (if expand "" " (no grouptag expand)")
  7288. tag-chars
  7289. (if org-agenda-auto-exclude-function "[RET] " ""))
  7290. (setq char (read-char-exclusive))
  7291. ;; Excluding or filtering down
  7292. (cond ((eq char ?-) (setq exclude t))
  7293. ((eq char ?+) (setq exclude nil)))))
  7294. (when (eq char ?\t)
  7295. (unless (local-variable-p 'org-global-tags-completion-table)
  7296. (setq-local org-global-tags-completion-table
  7297. (org-global-tags-completion-table)))
  7298. (let ((completion-ignore-case t))
  7299. (setq tag (completing-read
  7300. "Tag: " org-global-tags-completion-table nil t))))
  7301. (cond
  7302. ((eq char ?\r)
  7303. (org-agenda-filter-show-all-tag)
  7304. (when org-agenda-auto-exclude-function
  7305. (setq org-agenda-tag-filter nil)
  7306. (dolist (tag (org-agenda-get-represented-tags))
  7307. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  7308. (when modifier
  7309. (push modifier org-agenda-tag-filter))))
  7310. (unless (null org-agenda-tag-filter)
  7311. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))))
  7312. ((eq char ?\\)
  7313. (org-agenda-filter-show-all-tag)
  7314. (when (get 'org-agenda-tag-filter :preset-filter)
  7315. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand)))
  7316. ((eq char ?.)
  7317. (setq org-agenda-tag-filter
  7318. (mapcar (lambda(tag) (concat "+" tag))
  7319. (org-get-at-bol 'tags)))
  7320. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  7321. ((eq char ?q)) ;If q, abort (even if there is a q-key for a tag...)
  7322. ((or (eq char ?\s)
  7323. (setq a (rassoc char alist))
  7324. (and tag (setq a (cons tag nil))))
  7325. (org-agenda-filter-show-all-tag)
  7326. (setq tag (car a))
  7327. (setq org-agenda-tag-filter
  7328. (cons (concat (if exclude "-" "+") tag)
  7329. (if accumulate current nil)))
  7330. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  7331. (t (error "Invalid tag selection character %c" char)))))
  7332. (defun org-agenda-get-represented-categories ()
  7333. "Return a list of all categories used in this agenda buffer."
  7334. (or org-agenda-represented-categories
  7335. (when (derived-mode-p 'org-agenda-mode)
  7336. (let ((pos (point-min)) categories)
  7337. (while (and (< pos (point-max))
  7338. (setq pos (next-single-property-change
  7339. pos 'org-category nil (point-max))))
  7340. (push (get-text-property pos 'org-category) categories))
  7341. (setq org-agenda-represented-categories
  7342. (nreverse (org-uniquify (delq nil categories))))))))
  7343. (defun org-agenda-get-represented-tags ()
  7344. "Return a list of all tags used in this agenda buffer.
  7345. These will be lower-case, for filtering."
  7346. (or org-agenda-represented-tags
  7347. (when (derived-mode-p 'org-agenda-mode)
  7348. (let ((pos (point-min)) tags-lists tt)
  7349. (while (and (< pos (point-max))
  7350. (setq pos (next-single-property-change
  7351. pos 'tags nil (point-max))))
  7352. (setq tt (get-text-property pos 'tags))
  7353. (if tt (push tt tags-lists)))
  7354. (setq org-agenda-represented-tags
  7355. (nreverse (org-uniquify
  7356. (delq nil (apply 'append tags-lists)))))))))
  7357. (defun org-agenda-filter-make-matcher (filter type &optional expand)
  7358. "Create the form that tests a line for agenda filter. Optional
  7359. argument EXPAND can be used for the TYPE tag and will expand the
  7360. tags in the FILTER if any of the tags in FILTER are grouptags."
  7361. (let (f f1)
  7362. (cond
  7363. ;; Tag filter
  7364. ((eq type 'tag)
  7365. (setq filter
  7366. (delete-dups
  7367. (append (get 'org-agenda-tag-filter :preset-filter)
  7368. filter)))
  7369. (dolist (x filter)
  7370. (let ((op (string-to-char x)))
  7371. (if expand (setq x (org-agenda-filter-expand-tags (list x) t))
  7372. (setq x (list x)))
  7373. (setq f1 (org-agenda-filter-make-matcher-tag-exp x op))
  7374. (push f1 f))))
  7375. ;; Category filter
  7376. ((eq type 'category)
  7377. (setq filter
  7378. (delete-dups
  7379. (append (get 'org-agenda-category-filter :preset-filter)
  7380. filter)))
  7381. (dolist (x filter)
  7382. (if (equal "-" (substring x 0 1))
  7383. (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
  7384. (setq f1 (list 'equal (substring x 1) 'cat)))
  7385. (push f1 f)))
  7386. ;; Regexp filter
  7387. ((eq type 'regexp)
  7388. (setq filter
  7389. (delete-dups
  7390. (append (get 'org-agenda-regexp-filter :preset-filter)
  7391. filter)))
  7392. (dolist (x filter)
  7393. (if (equal "-" (substring x 0 1))
  7394. (setq f1 (list 'not (list 'string-match (substring x 1) 'txt)))
  7395. (setq f1 (list 'string-match (substring x 1) 'txt)))
  7396. (push f1 f)))
  7397. ;; Effort filter
  7398. ((eq type 'effort)
  7399. (setq filter
  7400. (delete-dups
  7401. (append (get 'org-agenda-effort-filter :preset-filter)
  7402. filter)))
  7403. (dolist (x filter)
  7404. (push (org-agenda-filter-effort-form x) f))))
  7405. (cons (if (eq type 'category) 'or 'and) (nreverse f))))
  7406. (defun org-agenda-filter-make-matcher-tag-exp (tags op)
  7407. "Return a form associated to tag-expression TAGS.
  7408. Build a form testing a line for agenda filter for
  7409. tag-expressions. OP is an operator of type CHAR that allows the
  7410. function to set the right switches in the returned form."
  7411. (let (form)
  7412. ;; Any of the expressions can match if OP is +, all must match if
  7413. ;; the operator is -.
  7414. (dolist (x tags (cons (if (eq op ?-) 'and 'or) form))
  7415. (let* ((tag (substring x 1))
  7416. (f (cond
  7417. ((string= "" tag) 'tags)
  7418. ((and (string-match-p "\\`{" tag) (string-match-p "}\\'" tag))
  7419. ;; TAG is a regexp.
  7420. (list 'org-match-any-p (substring tag 1 -1) 'tags))
  7421. (t (list 'member (downcase tag) 'tags)))))
  7422. (push (if (eq op ?-) (list 'not f) f) form)))))
  7423. (defun org-agenda-filter-effort-form (e)
  7424. "Return the form to compare the effort of the current line with what E says.
  7425. E looks like \"+<2:25\"."
  7426. (let (op)
  7427. (setq e (substring e 1))
  7428. (setq op (string-to-char e) e (substring e 1))
  7429. (setq op (cond ((equal op ?<) '<=)
  7430. ((equal op ?>) '>=)
  7431. ((equal op ??) op)
  7432. (t '=)))
  7433. (list 'org-agenda-compare-effort (list 'quote op)
  7434. (org-duration-to-minutes e))))
  7435. (defun org-agenda-compare-effort (op value)
  7436. "Compare the effort of the current line with VALUE, using OP.
  7437. If the line does not have an effort defined, return nil."
  7438. ;; `effort-minutes' property cannot be extracted directly from
  7439. ;; current line but is stored as a property in `txt'.
  7440. (let ((effort (get-text-property 0 'effort-minutes (org-get-at-bol 'txt))))
  7441. (funcall op
  7442. (or effort (if org-sort-agenda-noeffort-is-high 32767 -1))
  7443. value)))
  7444. (defun org-agenda-filter-expand-tags (filter &optional no-operator)
  7445. "Expand group tags in FILTER for the agenda.
  7446. When NO-OPERATOR is non-nil, do not add the + operator to returned tags."
  7447. (if org-group-tags
  7448. (let ((case-fold-search t) rtn)
  7449. (mapc
  7450. (lambda (f)
  7451. (let (f0 dir)
  7452. (if (string-match "^\\([+-]\\)\\(.+\\)" f)
  7453. (setq dir (match-string 1 f) f0 (match-string 2 f))
  7454. (setq dir (if no-operator "" "+") f0 f))
  7455. (setq rtn (append (mapcar (lambda(f1) (concat dir f1))
  7456. (org-tags-expand f0 t t))
  7457. rtn))))
  7458. filter)
  7459. (reverse rtn))
  7460. filter))
  7461. (defun org-agenda-filter-apply (filter type &optional expand)
  7462. "Set FILTER as the new agenda filter and apply it. Optional
  7463. argument EXPAND can be used for the TYPE tag and will expand the
  7464. tags in the FILTER if any of the tags in FILTER are grouptags."
  7465. ;; Deactivate `org-agenda-entry-text-mode' when filtering
  7466. (when org-agenda-entry-text-mode (org-agenda-entry-text-mode))
  7467. (let (tags cat txt)
  7468. (setq org-agenda-filter-form (org-agenda-filter-make-matcher
  7469. filter type expand))
  7470. ;; Only set `org-agenda-filtered-by-category' to t when a unique
  7471. ;; category is used as the filter:
  7472. (setq org-agenda-filtered-by-category
  7473. (and (eq type 'category)
  7474. (not (equal (substring (car filter) 0 1) "-"))))
  7475. (org-agenda-set-mode-name)
  7476. (save-excursion
  7477. (goto-char (point-min))
  7478. (while (not (eobp))
  7479. (if (org-get-at-bol 'org-hd-marker)
  7480. (progn
  7481. (setq tags (org-get-at-bol 'tags)
  7482. cat (org-agenda-get-category)
  7483. txt (org-get-at-bol 'txt))
  7484. (unless (eval org-agenda-filter-form)
  7485. (org-agenda-filter-hide-line type))
  7486. (beginning-of-line 2))
  7487. (beginning-of-line 2))))
  7488. (when (get-char-property (point) 'invisible)
  7489. (ignore-errors (org-agenda-previous-line)))))
  7490. (defun org-agenda-filter-top-headline-apply (hl &optional negative)
  7491. "Filter by top headline HL."
  7492. (org-agenda-set-mode-name)
  7493. (save-excursion
  7494. (goto-char (point-min))
  7495. (while (not (eobp))
  7496. (let* ((pos (org-get-at-bol 'org-hd-marker))
  7497. (tophl (and pos (org-find-top-headline pos))))
  7498. (when (and tophl (funcall (if negative 'identity 'not)
  7499. (string= hl tophl)))
  7500. (org-agenda-filter-hide-line 'top-headline)))
  7501. (beginning-of-line 2)))
  7502. (when (get-char-property (point) 'invisible)
  7503. (org-agenda-previous-line))
  7504. (setq org-agenda-top-headline-filter hl
  7505. org-agenda-filtered-by-top-headline t))
  7506. (defun org-agenda-filter-hide-line (type)
  7507. "Hide lines with TYPE in the agenda buffer."
  7508. (let* (buffer-invisibility-spec
  7509. (b (max (point-min) (1- (point-at-bol))))
  7510. (e (point-at-eol)))
  7511. (let ((inhibit-read-only t))
  7512. (add-text-properties
  7513. b e `(invisible org-filtered org-filter-type ,type)))))
  7514. (defun org-agenda-remove-filter (type)
  7515. (interactive)
  7516. "Remove filter of type TYPE from the agenda buffer."
  7517. (save-excursion
  7518. (goto-char (point-min))
  7519. (let ((inhibit-read-only t) pos)
  7520. (while (setq pos (text-property-any (point) (point-max)
  7521. 'org-filter-type type))
  7522. (goto-char pos)
  7523. (remove-text-properties
  7524. (point) (next-single-property-change (point) 'org-filter-type)
  7525. `(invisible org-filtered org-filter-type ,type))))
  7526. (set (intern (format "org-agenda-%s-filter" (intern-soft type))) nil)
  7527. (setq org-agenda-filter-form nil)
  7528. (org-agenda-set-mode-name)
  7529. (org-agenda-finalize)))
  7530. (defun org-agenda-filter-show-all-tag nil
  7531. (org-agenda-remove-filter 'tag))
  7532. (defun org-agenda-filter-show-all-re nil
  7533. (org-agenda-remove-filter 'regexp))
  7534. (defun org-agenda-filter-show-all-effort nil
  7535. (org-agenda-remove-filter 'effort))
  7536. (defun org-agenda-filter-show-all-cat nil
  7537. (org-agenda-remove-filter 'category))
  7538. (defun org-agenda-filter-show-all-top-filter nil
  7539. (org-agenda-remove-filter 'top-headline))
  7540. (defun org-agenda-manipulate-query-add ()
  7541. "Manipulate the query by adding a search term with positive selection.
  7542. Positive selection means the term must be matched for selection of an entry."
  7543. (interactive)
  7544. (org-agenda-manipulate-query ?\[))
  7545. (defun org-agenda-manipulate-query-subtract ()
  7546. "Manipulate the query by adding a search term with negative selection.
  7547. Negative selection means term must not be matched for selection of an entry."
  7548. (interactive)
  7549. (org-agenda-manipulate-query ?\]))
  7550. (defun org-agenda-manipulate-query-add-re ()
  7551. "Manipulate the query by adding a search regexp with positive selection.
  7552. Positive selection means the regexp must match for selection of an entry."
  7553. (interactive)
  7554. (org-agenda-manipulate-query ?\{))
  7555. (defun org-agenda-manipulate-query-subtract-re ()
  7556. "Manipulate the query by adding a search regexp with negative selection.
  7557. Negative selection means regexp must not match for selection of an entry."
  7558. (interactive)
  7559. (org-agenda-manipulate-query ?\}))
  7560. (defun org-agenda-manipulate-query (char)
  7561. (cond
  7562. ((eq org-agenda-type 'agenda)
  7563. (let ((org-agenda-include-inactive-timestamps t))
  7564. (org-agenda-redo))
  7565. (message "Display now includes inactive timestamps as well"))
  7566. ((eq org-agenda-type 'search)
  7567. (org-add-to-string
  7568. 'org-agenda-query-string
  7569. (if org-agenda-last-search-view-search-was-boolean
  7570. (cdr (assoc char '((?\[ . " +") (?\] . " -")
  7571. (?\{ . " +{}") (?\} . " -{}"))))
  7572. " "))
  7573. (setq org-agenda-redo-command
  7574. (list 'org-search-view
  7575. (car (get-text-property (min (1- (point-max)) (point))
  7576. 'org-last-args))
  7577. org-agenda-query-string
  7578. (+ (length org-agenda-query-string)
  7579. (if (member char '(?\{ ?\})) 0 1))))
  7580. (set-register org-agenda-query-register org-agenda-query-string)
  7581. (let ((org-agenda-overriding-arguments
  7582. (cdr org-agenda-redo-command)))
  7583. (org-agenda-redo)))
  7584. (t (error "Cannot manipulate query for %s-type agenda buffers"
  7585. org-agenda-type))))
  7586. (defun org-add-to-string (var string)
  7587. (set var (concat (symbol-value var) string)))
  7588. (defun org-agenda-goto-date (span)
  7589. "Jump to DATE in agenda."
  7590. (interactive "P")
  7591. (let* ((org-read-date-prefer-future
  7592. (eval org-agenda-jump-prefer-future))
  7593. (date (org-read-date))
  7594. (day (time-to-days (org-time-string-to-time date)))
  7595. (org-agenda-sticky-orig org-agenda-sticky)
  7596. (org-agenda-buffer-tmp-name (buffer-name))
  7597. (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7598. (0-arg (or current-prefix-arg (car args)))
  7599. (2-arg (nth 2 args))
  7600. (with-hour-p (nth 4 org-agenda-redo-command))
  7601. (newcmd (list 'org-agenda-list 0-arg date
  7602. (org-agenda-span-to-ndays
  7603. 2-arg (org-time-string-to-absolute date))
  7604. with-hour-p))
  7605. (newargs (cdr newcmd))
  7606. (inhibit-read-only t)
  7607. org-agenda-sticky)
  7608. (if (not (org-agenda-check-type t 'agenda))
  7609. (error "Not available in non-agenda views")
  7610. (add-text-properties (point-min) (point-max)
  7611. `(org-redo-cmd ,newcmd org-last-args ,newargs))
  7612. (org-agenda-redo)
  7613. (goto-char (point-min))
  7614. (while (not (or (= (or (get-text-property (point) 'day) 0) day)
  7615. (save-excursion (move-beginning-of-line 2) (eobp))))
  7616. (move-beginning-of-line 2))
  7617. (setq org-agenda-sticky org-agenda-sticky-orig
  7618. org-agenda-this-buffer-is-sticky org-agenda-sticky))))
  7619. (defun org-agenda-goto-today ()
  7620. "Go to today."
  7621. (interactive)
  7622. (org-agenda-check-type t 'agenda)
  7623. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7624. (curspan (nth 2 args))
  7625. (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
  7626. (cond
  7627. (tdpos (goto-char tdpos))
  7628. ((eq org-agenda-type 'agenda)
  7629. (let* ((sd (org-agenda-compute-starting-span
  7630. (org-today) (or curspan org-agenda-span)))
  7631. (org-agenda-overriding-arguments args))
  7632. (setf (nth 1 org-agenda-overriding-arguments) sd)
  7633. (org-agenda-redo)
  7634. (org-agenda-find-same-or-today-or-agenda)))
  7635. (t (error "Cannot find today")))))
  7636. (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
  7637. (goto-char
  7638. (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
  7639. (text-property-any (point-min) (point-max) 'org-today t)
  7640. (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
  7641. (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
  7642. (org-agenda-backward-block))
  7643. (point-min))))
  7644. (defun org-agenda-backward-block ()
  7645. "Move backward by one agenda block."
  7646. (interactive)
  7647. (org-agenda-forward-block 'backward))
  7648. (defun org-agenda-forward-block (&optional backward)
  7649. "Move forward by one agenda block.
  7650. When optional argument BACKWARD is set, go backward."
  7651. (interactive)
  7652. (cond ((not (derived-mode-p 'org-agenda-mode))
  7653. (user-error
  7654. "Cannot execute this command outside of org-agenda-mode buffers"))
  7655. ((looking-at (if backward "\\`" "\\'"))
  7656. (message "Already at the %s block" (if backward "first" "last")))
  7657. (t (let ((pos (prog1 (point)
  7658. (ignore-errors (if backward (backward-char 1)
  7659. (move-end-of-line 1)))))
  7660. (f (if backward
  7661. 'previous-single-property-change
  7662. 'next-single-property-change))
  7663. moved dest)
  7664. (while (and (setq dest (funcall
  7665. f (point) 'org-agenda-structural-header))
  7666. (not (get-text-property
  7667. (point) 'org-agenda-structural-header)))
  7668. (setq moved t)
  7669. (goto-char dest))
  7670. (if moved (move-beginning-of-line 1)
  7671. (goto-char (if backward (point-min) (point-max)))
  7672. (move-beginning-of-line 1)
  7673. (message "No %s block" (if backward "previous" "further")))))))
  7674. (defun org-agenda-later (arg)
  7675. "Go forward in time by the current span.
  7676. With prefix ARG, go forward that many times the current span."
  7677. (interactive "p")
  7678. (org-agenda-check-type t 'agenda)
  7679. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7680. (span (or (nth 2 args) org-agenda-current-span))
  7681. (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
  7682. (greg (calendar-gregorian-from-absolute sd))
  7683. (cnt (org-get-at-bol 'org-day-cnt))
  7684. greg2)
  7685. (cond
  7686. ((numberp span)
  7687. (setq sd (+ (* span arg) sd)))
  7688. ((eq span 'day)
  7689. (setq sd (+ arg sd)))
  7690. ((eq span 'week)
  7691. (setq sd (+ (* 7 arg) sd)))
  7692. ((eq span 'fortnight)
  7693. (setq sd (+ (* 14 arg) sd)))
  7694. ((eq span 'month)
  7695. (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
  7696. sd (calendar-absolute-from-gregorian greg2))
  7697. (setcar greg2 (1+ (car greg2))))
  7698. ((eq span 'year)
  7699. (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
  7700. sd (calendar-absolute-from-gregorian greg2))
  7701. (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
  7702. (t
  7703. (setq sd (+ (* span arg) sd))))
  7704. (let ((org-agenda-overriding-cmd
  7705. ;; `cmd' may have been set by `org-agenda-run-series' which
  7706. ;; uses `org-agenda-overriding-cmd' to decide whether
  7707. ;; overriding is allowed for `cmd'
  7708. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7709. (org-agenda-overriding-arguments
  7710. (list (car args) sd span)))
  7711. (org-agenda-redo)
  7712. (org-agenda-find-same-or-today-or-agenda cnt))))
  7713. (defun org-agenda-earlier (arg)
  7714. "Go backward in time by the current span.
  7715. With prefix ARG, go backward that many times the current span."
  7716. (interactive "p")
  7717. (org-agenda-later (- arg)))
  7718. (defun org-agenda-view-mode-dispatch ()
  7719. "Call one of the view mode commands."
  7720. (interactive)
  7721. (org-unlogged-message
  7722. "View: [d]ay [w]eek for[t]night [m]onth [y]ear [SPC]reset [q]uit/abort
  7723. time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
  7724. [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
  7725. (pcase (read-char-exclusive)
  7726. (?\ (call-interactively 'org-agenda-reset-view))
  7727. (?d (call-interactively 'org-agenda-day-view))
  7728. (?w (call-interactively 'org-agenda-week-view))
  7729. (?t (call-interactively 'org-agenda-fortnight-view))
  7730. (?m (call-interactively 'org-agenda-month-view))
  7731. (?y (call-interactively 'org-agenda-year-view))
  7732. (?l (call-interactively 'org-agenda-log-mode))
  7733. (?L (org-agenda-log-mode '(4)))
  7734. (?c (org-agenda-log-mode 'clockcheck))
  7735. ((or ?F ?f) (call-interactively 'org-agenda-follow-mode))
  7736. (?a (call-interactively 'org-agenda-archives-mode))
  7737. (?A (org-agenda-archives-mode 'files))
  7738. ((or ?R ?r) (call-interactively 'org-agenda-clockreport-mode))
  7739. ((or ?E ?e) (call-interactively 'org-agenda-entry-text-mode))
  7740. (?G (call-interactively 'org-agenda-toggle-time-grid))
  7741. (?D (call-interactively 'org-agenda-toggle-diary))
  7742. (?\! (call-interactively 'org-agenda-toggle-deadlines))
  7743. (?\[ (let ((org-agenda-include-inactive-timestamps t))
  7744. (org-agenda-check-type t 'agenda)
  7745. (org-agenda-redo))
  7746. (message "Display now includes inactive timestamps as well"))
  7747. (?q (message "Abort"))
  7748. (key (user-error "Invalid key: %s" key))))
  7749. (defun org-agenda-reset-view ()
  7750. "Switch to default view for agenda."
  7751. (interactive)
  7752. (org-agenda-change-time-span org-agenda-span))
  7753. (defun org-agenda-day-view (&optional day-of-month)
  7754. "Switch to daily view for agenda.
  7755. With argument DAY-OF-MONTH, switch to that day of the month."
  7756. (interactive "P")
  7757. (org-agenda-change-time-span 'day day-of-month))
  7758. (defun org-agenda-week-view (&optional iso-week)
  7759. "Switch to weekly view for agenda.
  7760. With argument ISO-WEEK, switch to the corresponding ISO week.
  7761. If ISO-WEEK has more then 2 digits, only the last two encode
  7762. the week. Any digits before this encode a year. So 200712
  7763. means week 12 of year 2007. Years ranging from 70 years ago
  7764. to 30 years in the future can also be written as 2-digit years."
  7765. (interactive "P")
  7766. (org-agenda-change-time-span 'week iso-week))
  7767. (defun org-agenda-fortnight-view (&optional iso-week)
  7768. "Switch to fortnightly view for agenda.
  7769. With argument ISO-WEEK, switch to the corresponding ISO week.
  7770. If ISO-WEEK has more then 2 digits, only the last two encode
  7771. the week. Any digits before this encode a year. So 200712
  7772. means week 12 of year 2007. Years ranging from 70 years ago
  7773. to 30 years in the future can also be written as 2-digit years."
  7774. (interactive "P")
  7775. (org-agenda-change-time-span 'fortnight iso-week))
  7776. (defun org-agenda-month-view (&optional month)
  7777. "Switch to monthly view for agenda.
  7778. With argument MONTH, switch to that month. If MONTH has more
  7779. then 2 digits, only the last two encode the month. Any digits
  7780. before this encode a year. So 200712 means December year 2007.
  7781. Years ranging from 70 years ago to 30 years in the future can
  7782. also be written as 2-digit years."
  7783. (interactive "P")
  7784. (org-agenda-change-time-span 'month month))
  7785. (defun org-agenda-year-view (&optional year)
  7786. "Switch to yearly view for agenda.
  7787. With argument YEAR, switch to that year. Years ranging from 70
  7788. years ago to 30 years in the future can also be written as
  7789. 2-digit years."
  7790. (interactive "P")
  7791. (when year
  7792. (setq year (org-small-year-to-year year)))
  7793. (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
  7794. (org-agenda-change-time-span 'year year)
  7795. (error "Abort")))
  7796. (defun org-agenda-change-time-span (span &optional n)
  7797. "Change the agenda view to SPAN.
  7798. SPAN may be `day', `week', `fortnight', `month', `year'."
  7799. (org-agenda-check-type t 'agenda)
  7800. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7801. (curspan (nth 2 args)))
  7802. (when (and (not n) (equal curspan span))
  7803. (error "Viewing span is already \"%s\"" span))
  7804. (let* ((sd (or (org-get-at-bol 'day)
  7805. (nth 1 args)
  7806. org-starting-day))
  7807. (sd (org-agenda-compute-starting-span sd span n))
  7808. (org-agenda-overriding-cmd
  7809. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7810. (org-agenda-overriding-arguments
  7811. (list (car args) sd span)))
  7812. (org-agenda-redo)
  7813. (org-agenda-find-same-or-today-or-agenda))
  7814. (org-agenda-set-mode-name)
  7815. (message "Switched to %s view" span)))
  7816. (defun org-agenda-compute-starting-span (sd span &optional n)
  7817. "Compute starting date for agenda.
  7818. SPAN may be `day', `week', `fortnight', `month', `year'. The return value
  7819. is a cons cell with the starting date and the number of days,
  7820. so that the date SD will be in that range."
  7821. (let* ((greg (calendar-gregorian-from-absolute sd))
  7822. (dg (nth 1 greg))
  7823. (mg (car greg))
  7824. (yg (nth 2 greg)))
  7825. (cond
  7826. ((eq span 'day)
  7827. (when n
  7828. (setq sd (+ (calendar-absolute-from-gregorian
  7829. (list mg 1 yg))
  7830. n -1))))
  7831. ((or (eq span 'week) (eq span 'fortnight))
  7832. (let* ((nt (calendar-day-of-week
  7833. (calendar-gregorian-from-absolute sd)))
  7834. (d (if org-agenda-start-on-weekday
  7835. (- nt org-agenda-start-on-weekday)
  7836. 0))
  7837. y1)
  7838. (setq sd (- sd (+ (if (< d 0) 7 0) d)))
  7839. (when n
  7840. (require 'cal-iso)
  7841. (when (> n 99)
  7842. (setq y1 (org-small-year-to-year (/ n 100))
  7843. n (mod n 100)))
  7844. (setq sd
  7845. (calendar-iso-to-absolute
  7846. (list n 1
  7847. (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
  7848. ((eq span 'month)
  7849. (let (y1)
  7850. (when (and n (> n 99))
  7851. (setq y1 (org-small-year-to-year (/ n 100))
  7852. n (mod n 100)))
  7853. (setq sd (calendar-absolute-from-gregorian
  7854. (list (or n mg) 1 (or y1 yg))))))
  7855. ((eq span 'year)
  7856. (setq sd (calendar-absolute-from-gregorian
  7857. (list 1 1 (or n yg))))))
  7858. sd))
  7859. (defun org-agenda-next-date-line (&optional arg)
  7860. "Jump to the next line indicating a date in agenda buffer."
  7861. (interactive "p")
  7862. (org-agenda-check-type t 'agenda)
  7863. (beginning-of-line 1)
  7864. ;; This does not work if user makes date format that starts with a blank
  7865. (when (looking-at-p "^\\S-") (forward-char 1))
  7866. (unless (re-search-forward "^\\S-" nil t arg)
  7867. (backward-char 1)
  7868. (error "No next date after this line in this buffer"))
  7869. (goto-char (match-beginning 0)))
  7870. (defun org-agenda-previous-date-line (&optional arg)
  7871. "Jump to the previous line indicating a date in agenda buffer."
  7872. (interactive "p")
  7873. (org-agenda-check-type t 'agenda)
  7874. (beginning-of-line 1)
  7875. (unless (re-search-backward "^\\S-" nil t arg)
  7876. (error "No previous date before this line in this buffer")))
  7877. ;; Initialize the highlight
  7878. (defvar org-hl (make-overlay 1 1))
  7879. (overlay-put org-hl 'face 'highlight)
  7880. (defun org-highlight (begin end &optional buffer)
  7881. "Highlight a region with overlay."
  7882. (move-overlay org-hl begin end (or buffer (current-buffer))))
  7883. (defun org-unhighlight ()
  7884. "Detach overlay INDEX."
  7885. (delete-overlay org-hl))
  7886. (defun org-unhighlight-once ()
  7887. "Remove the highlight from its position, and this function from the hook."
  7888. (remove-hook 'pre-command-hook 'org-unhighlight-once)
  7889. (org-unhighlight))
  7890. (defvar org-agenda-pre-follow-window-conf nil)
  7891. (defun org-agenda-follow-mode ()
  7892. "Toggle follow mode in an agenda buffer."
  7893. (interactive)
  7894. (unless org-agenda-follow-mode
  7895. (setq org-agenda-pre-follow-window-conf
  7896. (current-window-configuration)))
  7897. (setq org-agenda-follow-mode (not org-agenda-follow-mode))
  7898. (unless org-agenda-follow-mode
  7899. (set-window-configuration org-agenda-pre-follow-window-conf))
  7900. (org-agenda-set-mode-name)
  7901. (org-agenda-do-context-action)
  7902. (message "Follow mode is %s"
  7903. (if org-agenda-follow-mode "on" "off")))
  7904. (defun org-agenda-entry-text-mode (&optional arg)
  7905. "Toggle entry text mode in an agenda buffer."
  7906. (interactive "P")
  7907. (if (or org-agenda-tag-filter
  7908. org-agenda-category-filter
  7909. org-agenda-regexp-filter
  7910. org-agenda-top-headline-filter)
  7911. (user-error "Can't show entry text in filtered views")
  7912. (setq org-agenda-entry-text-mode (or (integerp arg)
  7913. (not org-agenda-entry-text-mode)))
  7914. (org-agenda-entry-text-hide)
  7915. (and org-agenda-entry-text-mode
  7916. (let ((org-agenda-entry-text-maxlines
  7917. (if (integerp arg) arg org-agenda-entry-text-maxlines)))
  7918. (org-agenda-entry-text-show)))
  7919. (org-agenda-set-mode-name)
  7920. (message "Entry text mode is %s%s"
  7921. (if org-agenda-entry-text-mode "on" "off")
  7922. (if (not org-agenda-entry-text-mode) ""
  7923. (format " (maximum number of lines is %d)"
  7924. (if (integerp arg) arg org-agenda-entry-text-maxlines))))))
  7925. (defun org-agenda-clockreport-mode ()
  7926. "Toggle clocktable mode in an agenda buffer."
  7927. (interactive)
  7928. (org-agenda-check-type t 'agenda)
  7929. (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode))
  7930. (org-agenda-set-mode-name)
  7931. (org-agenda-redo)
  7932. (message "Clocktable mode is %s"
  7933. (if org-agenda-clockreport-mode "on" "off")))
  7934. (defun org-agenda-log-mode (&optional special)
  7935. "Toggle log mode in an agenda buffer.
  7936. With argument SPECIAL, show all possible log items, not only the ones
  7937. configured in `org-agenda-log-mode-items'.
  7938. With a `\\[universal-argument] \\[universal-argument]' prefix, show *only* \
  7939. log items, nothing else."
  7940. (interactive "P")
  7941. (org-agenda-check-type t 'agenda)
  7942. (setq org-agenda-show-log
  7943. (cond
  7944. ((equal special '(16)) 'only)
  7945. ((eq special 'clockcheck)
  7946. (if (eq org-agenda-show-log 'clockcheck)
  7947. nil 'clockcheck))
  7948. (special '(closed clock state))
  7949. (t (not org-agenda-show-log))))
  7950. (org-agenda-set-mode-name)
  7951. (org-agenda-redo)
  7952. (message "Log mode is %s" (if org-agenda-show-log "on" "off")))
  7953. (defun org-agenda-archives-mode (&optional with-files)
  7954. "Toggle inclusion of items in trees marked with :ARCHIVE:.
  7955. When called with a prefix argument, include all archive files as well."
  7956. (interactive "P")
  7957. (setq org-agenda-archives-mode
  7958. (if with-files t (if org-agenda-archives-mode nil 'trees)))
  7959. (org-agenda-set-mode-name)
  7960. (org-agenda-redo)
  7961. (message
  7962. "%s"
  7963. (cond
  7964. ((eq org-agenda-archives-mode nil)
  7965. "No archives are included")
  7966. ((eq org-agenda-archives-mode 'trees)
  7967. (format "Trees with :%s: tag are included" org-archive-tag))
  7968. ((eq org-agenda-archives-mode t)
  7969. (format "Trees with :%s: tag and all active archive files are included"
  7970. org-archive-tag)))))
  7971. (defun org-agenda-toggle-diary ()
  7972. "Toggle diary inclusion in an agenda buffer."
  7973. (interactive)
  7974. (org-agenda-check-type t 'agenda)
  7975. (setq org-agenda-include-diary (not org-agenda-include-diary))
  7976. (org-agenda-redo)
  7977. (org-agenda-set-mode-name)
  7978. (message "Diary inclusion turned %s"
  7979. (if org-agenda-include-diary "on" "off")))
  7980. (defun org-agenda-toggle-deadlines ()
  7981. "Toggle inclusion of entries with a deadline in an agenda buffer."
  7982. (interactive)
  7983. (org-agenda-check-type t 'agenda)
  7984. (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
  7985. (org-agenda-redo)
  7986. (org-agenda-set-mode-name)
  7987. (message "Deadlines inclusion turned %s"
  7988. (if org-agenda-include-deadlines "on" "off")))
  7989. (defun org-agenda-toggle-time-grid ()
  7990. "Toggle time grid in an agenda buffer."
  7991. (interactive)
  7992. (org-agenda-check-type t 'agenda)
  7993. (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
  7994. (org-agenda-redo)
  7995. (org-agenda-set-mode-name)
  7996. (message "Time-grid turned %s"
  7997. (if org-agenda-use-time-grid "on" "off")))
  7998. (defun org-agenda-set-mode-name ()
  7999. "Set the mode name to indicate all the small mode settings."
  8000. (setq mode-name
  8001. (list "Org-Agenda"
  8002. (if (get 'org-agenda-files 'org-restrict) " []" "")
  8003. " "
  8004. '(:eval (org-agenda-span-name org-agenda-current-span))
  8005. (if org-agenda-follow-mode " Follow" "")
  8006. (if org-agenda-entry-text-mode " ETxt" "")
  8007. (if org-agenda-include-diary " Diary" "")
  8008. (if org-agenda-include-deadlines " Ddl" "")
  8009. (if org-agenda-use-time-grid " Grid" "")
  8010. (if (and (boundp 'org-habit-show-habits)
  8011. org-habit-show-habits) " Habit" "")
  8012. (cond
  8013. ((consp org-agenda-show-log) " LogAll")
  8014. ((eq org-agenda-show-log 'clockcheck) " ClkCk")
  8015. (org-agenda-show-log " Log")
  8016. (t ""))
  8017. (if (org-agenda-filter-any) " " "")
  8018. (if (or org-agenda-category-filter
  8019. (get 'org-agenda-category-filter :preset-filter))
  8020. '(:eval (propertize
  8021. (concat "["
  8022. (mapconcat
  8023. 'identity
  8024. (append
  8025. (get 'org-agenda-category-filter :preset-filter)
  8026. org-agenda-category-filter)
  8027. "")
  8028. "]")
  8029. 'face 'org-agenda-filter-category
  8030. 'help-echo "Category used in filtering")) "")
  8031. (if (or org-agenda-tag-filter
  8032. (get 'org-agenda-tag-filter :preset-filter))
  8033. '(:eval (propertize
  8034. (concat (mapconcat
  8035. 'identity
  8036. (append
  8037. (get 'org-agenda-tag-filter :preset-filter)
  8038. org-agenda-tag-filter)
  8039. ""))
  8040. 'face 'org-agenda-filter-tags
  8041. 'help-echo "Tags used in filtering")) "")
  8042. (if (or org-agenda-effort-filter
  8043. (get 'org-agenda-effort-filter :preset-filter))
  8044. '(:eval (propertize
  8045. (concat (mapconcat
  8046. 'identity
  8047. (append
  8048. (get 'org-agenda-effort-filter :preset-filter)
  8049. org-agenda-effort-filter)
  8050. ""))
  8051. 'face 'org-agenda-filter-effort
  8052. 'help-echo "Effort conditions used in filtering")) "")
  8053. (if (or org-agenda-regexp-filter
  8054. (get 'org-agenda-regexp-filter :preset-filter))
  8055. '(:eval (propertize
  8056. (concat (mapconcat
  8057. (lambda (x) (concat (substring x 0 1) "/" (substring x 1) "/"))
  8058. (append
  8059. (get 'org-agenda-regexp-filter :preset-filter)
  8060. org-agenda-regexp-filter)
  8061. ""))
  8062. 'face 'org-agenda-filter-regexp
  8063. 'help-echo "Regexp used in filtering")) "")
  8064. (if org-agenda-archives-mode
  8065. (if (eq org-agenda-archives-mode t)
  8066. " Archives"
  8067. (format " :%s:" org-archive-tag))
  8068. "")
  8069. (if org-agenda-clockreport-mode " Clock" "")))
  8070. (force-mode-line-update))
  8071. (defun org-agenda-update-agenda-type ()
  8072. "Update the agenda type after each command."
  8073. (setq org-agenda-type
  8074. (or (get-text-property (point) 'org-agenda-type)
  8075. (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
  8076. (defun org-agenda-next-line ()
  8077. "Move cursor to the next line, and show if follow mode is active."
  8078. (interactive)
  8079. (call-interactively 'next-line)
  8080. (org-agenda-do-context-action))
  8081. (defun org-agenda-previous-line ()
  8082. "Move cursor to the previous line, and show if follow-mode is active."
  8083. (interactive)
  8084. (call-interactively 'previous-line)
  8085. (org-agenda-do-context-action))
  8086. (defun org-agenda-next-item (n)
  8087. "Move cursor to next agenda item."
  8088. (interactive "p")
  8089. (let ((col (current-column)))
  8090. (dotimes (c n)
  8091. (when (next-single-property-change (point-at-eol) 'org-marker)
  8092. (move-end-of-line 1)
  8093. (goto-char (next-single-property-change (point) 'org-marker))))
  8094. (org-move-to-column col))
  8095. (org-agenda-do-context-action))
  8096. (defun org-agenda-previous-item (n)
  8097. "Move cursor to next agenda item."
  8098. (interactive "p")
  8099. (dotimes (c n)
  8100. (let ((col (current-column))
  8101. (goto (save-excursion
  8102. (move-end-of-line 0)
  8103. (previous-single-property-change (point) 'org-marker))))
  8104. (when goto (goto-char goto))
  8105. (org-move-to-column col)))
  8106. (org-agenda-do-context-action))
  8107. (defun org-agenda-do-context-action ()
  8108. "Show outline path and, maybe, follow mode window."
  8109. (let ((m (org-get-at-bol 'org-marker)))
  8110. (when (and (markerp m) (marker-buffer m))
  8111. (and org-agenda-follow-mode
  8112. (if org-agenda-follow-indirect
  8113. (org-agenda-tree-to-indirect-buffer nil)
  8114. (org-agenda-show)))
  8115. (and org-agenda-show-outline-path
  8116. (org-with-point-at m (org-display-outline-path t))))))
  8117. (defun org-agenda-show-tags ()
  8118. "Show the tags applicable to the current item."
  8119. (interactive)
  8120. (let* ((tags (org-get-at-bol 'tags)))
  8121. (if tags
  8122. (message "Tags are :%s:"
  8123. (org-no-properties (mapconcat 'identity tags ":")))
  8124. (message "No tags associated with this line"))))
  8125. (defun org-agenda-goto (&optional highlight)
  8126. "Go to the entry at point in the corresponding Org file."
  8127. (interactive)
  8128. (let* ((marker (or (org-get-at-bol 'org-marker)
  8129. (org-agenda-error)))
  8130. (buffer (marker-buffer marker))
  8131. (pos (marker-position marker)))
  8132. (switch-to-buffer-other-window buffer)
  8133. (widen)
  8134. (push-mark)
  8135. (goto-char pos)
  8136. (when (derived-mode-p 'org-mode)
  8137. (org-show-context 'agenda)
  8138. (recenter (/ (window-height) 2))
  8139. (org-back-to-heading t)
  8140. (let ((case-fold-search nil))
  8141. (when (re-search-forward org-complex-heading-regexp nil t)
  8142. (goto-char (match-beginning 4)))))
  8143. (run-hooks 'org-agenda-after-show-hook)
  8144. (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
  8145. (defvar org-agenda-after-show-hook nil
  8146. "Normal hook run after an item has been shown from the agenda.
  8147. Point is in the buffer where the item originated.")
  8148. (defun org-agenda-kill ()
  8149. "Kill the entry or subtree belonging to the current agenda entry."
  8150. (interactive)
  8151. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  8152. (let* ((bufname-orig (buffer-name))
  8153. (marker (or (org-get-at-bol 'org-marker)
  8154. (org-agenda-error)))
  8155. (buffer (marker-buffer marker))
  8156. (pos (marker-position marker))
  8157. (type (org-get-at-bol 'type))
  8158. dbeg dend (n 0))
  8159. (org-with-remote-undo buffer
  8160. (with-current-buffer buffer
  8161. (save-excursion
  8162. (goto-char pos)
  8163. (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
  8164. (setq dbeg (progn (org-back-to-heading t) (point))
  8165. dend (org-end-of-subtree t t))
  8166. (setq dbeg (point-at-bol)
  8167. dend (min (point-max) (1+ (point-at-eol)))))
  8168. (goto-char dbeg)
  8169. (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
  8170. (when (or (eq t org-agenda-confirm-kill)
  8171. (and (numberp org-agenda-confirm-kill)
  8172. (> n org-agenda-confirm-kill)))
  8173. (let ((win-conf (current-window-configuration)))
  8174. (unwind-protect
  8175. (and
  8176. (prog2
  8177. (org-agenda-tree-to-indirect-buffer nil)
  8178. (not (y-or-n-p
  8179. (format "Delete entry with %d lines in buffer \"%s\"? "
  8180. n (buffer-name buffer))))
  8181. (kill-buffer org-last-indirect-buffer))
  8182. (error "Abort"))
  8183. (set-window-configuration win-conf))))
  8184. (let ((org-agenda-buffer-name bufname-orig))
  8185. (org-remove-subtree-entries-from-agenda buffer dbeg dend))
  8186. (with-current-buffer buffer (delete-region dbeg dend))
  8187. (message "Agenda item and source killed"))))
  8188. (defvar org-archive-default-command) ; defined in org-archive.el
  8189. (defun org-agenda-archive-default ()
  8190. "Archive the entry or subtree belonging to the current agenda entry."
  8191. (interactive)
  8192. (require 'org-archive)
  8193. (org-agenda-archive-with org-archive-default-command))
  8194. (defun org-agenda-archive-default-with-confirmation ()
  8195. "Archive the entry or subtree belonging to the current agenda entry."
  8196. (interactive)
  8197. (require 'org-archive)
  8198. (org-agenda-archive-with org-archive-default-command 'confirm))
  8199. (defun org-agenda-archive ()
  8200. "Archive the entry or subtree belonging to the current agenda entry."
  8201. (interactive)
  8202. (org-agenda-archive-with 'org-archive-subtree))
  8203. (defun org-agenda-archive-to-archive-sibling ()
  8204. "Move the entry to the archive sibling."
  8205. (interactive)
  8206. (org-agenda-archive-with 'org-archive-to-archive-sibling))
  8207. (defun org-agenda-archive-with (cmd &optional confirm)
  8208. "Move the entry to the archive sibling."
  8209. (interactive)
  8210. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  8211. (let* ((bufname-orig (buffer-name))
  8212. (marker (or (org-get-at-bol 'org-marker)
  8213. (org-agenda-error)))
  8214. (buffer (marker-buffer marker))
  8215. (pos (marker-position marker)))
  8216. (org-with-remote-undo buffer
  8217. (with-current-buffer buffer
  8218. (if (derived-mode-p 'org-mode)
  8219. (if (and confirm
  8220. (not (y-or-n-p "Archive this subtree or entry? ")))
  8221. (error "Abort")
  8222. (save-window-excursion
  8223. (goto-char pos)
  8224. (let ((org-agenda-buffer-name bufname-orig))
  8225. (org-remove-subtree-entries-from-agenda))
  8226. (org-back-to-heading t)
  8227. (funcall cmd)))
  8228. (error "Archiving works only in Org files"))))))
  8229. (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
  8230. "Remove all lines in the agenda that correspond to a given subtree.
  8231. The subtree is the one in buffer BUF, starting at BEG and ending at END.
  8232. If this information is not given, the function uses the tree at point."
  8233. (let ((buf (or buf (current-buffer))) m p)
  8234. (save-excursion
  8235. (unless (and beg end)
  8236. (org-back-to-heading t)
  8237. (setq beg (point))
  8238. (org-end-of-subtree t)
  8239. (setq end (point)))
  8240. (set-buffer (get-buffer org-agenda-buffer-name))
  8241. (save-excursion
  8242. (goto-char (point-max))
  8243. (beginning-of-line 1)
  8244. (while (not (bobp))
  8245. (when (and (setq m (org-get-at-bol 'org-marker))
  8246. (equal buf (marker-buffer m))
  8247. (setq p (marker-position m))
  8248. (>= p beg)
  8249. (< p end))
  8250. (let ((inhibit-read-only t))
  8251. (delete-region (point-at-bol) (1+ (point-at-eol)))))
  8252. (beginning-of-line 0))))))
  8253. (defun org-agenda-refile (&optional goto rfloc no-update)
  8254. "Refile the item at point.
  8255. When called with `\\[universal-argument] \\[universal-argument]', \
  8256. go to the location of the last
  8257. refiled item.
  8258. When called with `\\[universal-argument] \\[universal-argument] \
  8259. \\[universal-argument]' prefix or when GOTO is 0, clear
  8260. the refile cache.
  8261. RFLOC can be a refile location obtained in a different way.
  8262. When NO-UPDATE is non-nil, don't redo the agenda buffer."
  8263. (interactive "P")
  8264. (cond
  8265. ((member goto '(0 (64)))
  8266. (org-refile-cache-clear))
  8267. ((equal goto '(16))
  8268. (org-refile-goto-last-stored))
  8269. (t
  8270. (let* ((buffer-orig (buffer-name))
  8271. (marker (or (org-get-at-bol 'org-hd-marker)
  8272. (org-agenda-error)))
  8273. (buffer (marker-buffer marker))
  8274. (pos (marker-position marker))
  8275. (rfloc (or rfloc
  8276. (org-refile-get-location
  8277. (if goto "Goto" "Refile to") buffer
  8278. org-refile-allow-creating-parent-nodes))))
  8279. (with-current-buffer buffer
  8280. (org-with-wide-buffer
  8281. (goto-char marker)
  8282. (let ((org-agenda-buffer-name buffer-orig))
  8283. (org-remove-subtree-entries-from-agenda))
  8284. (org-refile goto buffer rfloc))))
  8285. (unless no-update (org-agenda-redo)))))
  8286. (defun org-agenda-open-link (&optional arg)
  8287. "Open the link(s) in the current entry, if any.
  8288. This looks for a link in the displayed line in the agenda.
  8289. It also looks at the text of the entry itself."
  8290. (interactive "P")
  8291. (let* ((marker (or (org-get-at-bol 'org-hd-marker)
  8292. (org-get-at-bol 'org-marker)))
  8293. (buffer (and marker (marker-buffer marker)))
  8294. (prefix (buffer-substring (point-at-bol) (point-at-eol)))
  8295. (lkall (and buffer (org-offer-links-in-entry
  8296. buffer marker arg prefix)))
  8297. (lk0 (car lkall))
  8298. (lk (if (stringp lk0) (list lk0) lk0))
  8299. (lkend (cdr lkall))
  8300. trg)
  8301. (cond
  8302. ((and buffer lk)
  8303. (mapcar (lambda(l)
  8304. (with-current-buffer buffer
  8305. (setq trg (and (string-match org-link-bracket-re l)
  8306. (match-string 1 l)))
  8307. (if (or (not trg) (string-match org-link-any-re trg))
  8308. (org-with-wide-buffer
  8309. (goto-char marker)
  8310. (when (search-forward l nil lkend)
  8311. (goto-char (match-beginning 0))
  8312. (org-open-at-point)))
  8313. ;; This is an internal link, widen the buffer
  8314. (switch-to-buffer-other-window buffer)
  8315. (widen)
  8316. (goto-char marker)
  8317. (when (search-forward l nil lkend)
  8318. (goto-char (match-beginning 0))
  8319. (org-open-at-point)))))
  8320. lk))
  8321. ((or (org-in-regexp (concat "\\(" org-link-bracket-re "\\)"))
  8322. (save-excursion
  8323. (beginning-of-line 1)
  8324. (looking-at (concat ".*?\\(" org-link-bracket-re "\\)"))))
  8325. (org-link-open-from-string (match-string 1)))
  8326. (t (message "No link to open here")))))
  8327. (defun org-agenda-copy-local-variable (var)
  8328. "Get a variable from a referenced buffer and install it here."
  8329. (let ((m (org-get-at-bol 'org-marker)))
  8330. (when (and m (buffer-live-p (marker-buffer m)))
  8331. (set (make-local-variable var)
  8332. (with-current-buffer (marker-buffer m)
  8333. (symbol-value var))))))
  8334. (defun org-agenda-switch-to (&optional delete-other-windows)
  8335. "Go to the Org mode file which contains the item at point.
  8336. When optional argument DELETE-OTHER-WINDOWS is non-nil, the
  8337. displayed Org file fills the frame."
  8338. (interactive)
  8339. (if (and org-return-follows-link
  8340. (not (org-get-at-bol 'org-marker))
  8341. (org-in-regexp org-link-bracket-re))
  8342. (org-link-open-from-string (match-string 0))
  8343. (let* ((marker (or (org-get-at-bol 'org-marker)
  8344. (org-agenda-error)))
  8345. (buffer (marker-buffer marker))
  8346. (pos (marker-position marker)))
  8347. (unless buffer (user-error "Trying to switch to non-existent buffer"))
  8348. (pop-to-buffer-same-window buffer)
  8349. (when delete-other-windows (delete-other-windows))
  8350. (widen)
  8351. (goto-char pos)
  8352. (when (derived-mode-p 'org-mode)
  8353. (org-show-context 'agenda)
  8354. (run-hooks 'org-agenda-after-show-hook)))))
  8355. (defun org-agenda-goto-mouse (ev)
  8356. "Go to the Org file which contains the item at the mouse click."
  8357. (interactive "e")
  8358. (mouse-set-point ev)
  8359. (org-agenda-goto))
  8360. (defun org-agenda-show (&optional full-entry)
  8361. "Display the Org file which contains the item at point.
  8362. With prefix argument FULL-ENTRY, make the entire entry visible
  8363. if it was hidden in the outline."
  8364. (interactive "P")
  8365. (let ((win (selected-window)))
  8366. (org-agenda-goto t)
  8367. (when full-entry (org-show-entry))
  8368. (select-window win)))
  8369. (defvar org-agenda-show-window nil)
  8370. (defun org-agenda-show-and-scroll-up (&optional arg)
  8371. "Display the Org file which contains the item at point.
  8372. When called repeatedly, scroll the window that is displaying the buffer.
  8373. With a `\\[universal-argument]' prefix argument, display the item, but \
  8374. fold drawers."
  8375. (interactive "P")
  8376. (let ((win (selected-window)))
  8377. (if (and (window-live-p org-agenda-show-window)
  8378. (eq this-command last-command))
  8379. (progn
  8380. (select-window org-agenda-show-window)
  8381. (ignore-errors (scroll-up)))
  8382. (org-agenda-goto t)
  8383. (org-show-entry)
  8384. (if arg (org-cycle-hide-drawers 'children)
  8385. (org-with-wide-buffer
  8386. (narrow-to-region (org-entry-beginning-position)
  8387. (org-entry-end-position))
  8388. (org-show-all '(drawers))))
  8389. (setq org-agenda-show-window (selected-window)))
  8390. (select-window win)))
  8391. (defun org-agenda-show-scroll-down ()
  8392. "Scroll down the window showing the agenda."
  8393. (interactive)
  8394. (let ((win (selected-window)))
  8395. (when (window-live-p org-agenda-show-window)
  8396. (select-window org-agenda-show-window)
  8397. (ignore-errors (scroll-down))
  8398. (select-window win))))
  8399. (defun org-agenda-show-1 (&optional more)
  8400. "Display the Org file which contains the item at point.
  8401. The prefix arg selects the amount of information to display:
  8402. 0 hide the subtree
  8403. 1 just show the entry according to defaults.
  8404. 2 show the children view
  8405. 3 show the subtree view
  8406. 4 show the entire subtree and any LOGBOOK drawers
  8407. 5 show the entire subtree and any drawers
  8408. With prefix argument FULL-ENTRY, make the entire entry visible
  8409. if it was hidden in the outline."
  8410. (interactive "p")
  8411. (let ((win (selected-window)))
  8412. (org-agenda-goto t)
  8413. (org-back-to-heading)
  8414. (set-window-start (selected-window) (point-at-bol))
  8415. (cond
  8416. ((= more 0)
  8417. (org-flag-subtree t)
  8418. (save-excursion
  8419. (org-back-to-heading)
  8420. (run-hook-with-args 'org-cycle-hook 'folded))
  8421. (message "Remote: FOLDED"))
  8422. ((and (called-interactively-p 'any) (= more 1))
  8423. (message "Remote: show with default settings"))
  8424. ((= more 2)
  8425. (outline-show-entry)
  8426. (org-show-children)
  8427. (save-excursion
  8428. (org-back-to-heading)
  8429. (run-hook-with-args 'org-cycle-hook 'children))
  8430. (message "Remote: CHILDREN"))
  8431. ((= more 3)
  8432. (outline-show-subtree)
  8433. (save-excursion
  8434. (org-back-to-heading)
  8435. (run-hook-with-args 'org-cycle-hook 'subtree))
  8436. (message "Remote: SUBTREE"))
  8437. ((= more 4)
  8438. (outline-show-subtree)
  8439. (save-excursion
  8440. (org-back-to-heading)
  8441. (org-cycle-hide-drawers 'subtree '("LOGBOOK")))
  8442. (message "Remote: SUBTREE AND LOGBOOK"))
  8443. ((> more 4)
  8444. (outline-show-subtree)
  8445. (message "Remote: SUBTREE AND ALL DRAWERS")))
  8446. (select-window win)))
  8447. (defvar org-agenda-cycle-counter nil)
  8448. (defun org-agenda-cycle-show (&optional n)
  8449. "Show the current entry in another window, with default settings.
  8450. Default settings are taken from `org-show-context-detail'. When
  8451. use repeatedly in immediate succession, the remote entry will
  8452. cycle through visibility
  8453. children -> subtree -> folded
  8454. When called with a numeric prefix arg, that arg will be passed through to
  8455. `org-agenda-show-1'. For the interpretation of that argument, see the
  8456. docstring of `org-agenda-show-1'."
  8457. (interactive "P")
  8458. (if (integerp n)
  8459. (setq org-agenda-cycle-counter n)
  8460. (if (not (eq last-command this-command))