org-agenda.el 409 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607
  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. ;; Defined somewhere in this file, but used before definition.
  86. (defvar org-agenda-buffer-name "*Org Agenda*")
  87. (defvar org-agenda-overriding-header nil)
  88. (defvar org-agenda-title-append nil)
  89. (with-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  90. (with-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  91. (defvar original-date) ; dynamically scoped, calendar.el does scope this
  92. (defvar org-agenda-undo-list nil
  93. "List of undoable operations in the agenda since last refresh.")
  94. (defvar org-agenda-pending-undo-list nil
  95. "In a series of undo commands, this is the list of remaining undo items.")
  96. (defcustom org-agenda-confirm-kill 1
  97. "When set, remote killing from the agenda buffer needs confirmation.
  98. When t, a confirmation is always needed. When a number N, confirmation is
  99. only needed when the text to be killed contains more than N non-white lines."
  100. :group 'org-agenda
  101. :type '(choice
  102. (const :tag "Never" nil)
  103. (const :tag "Always" t)
  104. (integer :tag "When more than N lines")))
  105. (defcustom org-agenda-compact-blocks nil
  106. "Non-nil means make the block agenda more compact.
  107. This is done globally by leaving out lines like the agenda span
  108. name and week number or the separator lines."
  109. :group 'org-agenda
  110. :type 'boolean)
  111. (defcustom org-agenda-block-separator ?=
  112. "The separator between blocks in the agenda.
  113. If this is a string, it will be used as the separator, with a newline added.
  114. If it is a character, it will be repeated to fill the window width.
  115. If nil the separator is disabled. In `org-agenda-custom-commands' this
  116. addresses the separator between the current and the previous block."
  117. :group 'org-agenda
  118. :type '(choice
  119. (const :tag "Disabled" nil)
  120. (character)
  121. (string)))
  122. (defgroup org-agenda-export nil
  123. "Options concerning exporting agenda views in Org mode."
  124. :tag "Org Agenda Export"
  125. :group 'org-agenda)
  126. (defcustom org-agenda-with-colors t
  127. "Non-nil means use colors in agenda views."
  128. :group 'org-agenda-export
  129. :type 'boolean)
  130. (defcustom org-agenda-exporter-settings nil
  131. "Alist of variable/value pairs that should be active during agenda export.
  132. This is a good place to set options for ps-print and for htmlize.
  133. Note that the way this is implemented, the values will be evaluated
  134. before assigned to the variables. So make sure to quote values you do
  135. *not* want evaluated, for example
  136. (setq org-agenda-exporter-settings
  137. \\='((ps-print-color-p \\='black-white)))"
  138. :group 'org-agenda-export
  139. :type '(repeat
  140. (list
  141. (variable)
  142. (sexp :tag "Value"))))
  143. (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
  144. "Hook run in a temporary buffer before writing the agenda to an export file.
  145. A useful function for this hook is `org-agenda-add-entry-text'."
  146. :group 'org-agenda-export
  147. :type 'hook
  148. :options '(org-agenda-add-entry-text))
  149. (defcustom org-agenda-add-entry-text-maxlines 0
  150. "Maximum number of entry text lines to be added to agenda.
  151. This is only relevant when `org-agenda-add-entry-text' is part of
  152. `org-agenda-before-write-hook', which is the default.
  153. When this is 0, nothing will happen. When it is greater than 0, it
  154. specifies the maximum number of lines that will be added for each entry
  155. that is listed in the agenda view.
  156. Note that this variable is not used during display, only when exporting
  157. the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
  158. and `org-agenda-entry-text-maxlines'."
  159. :group 'org-agenda
  160. :type 'integer)
  161. (defcustom org-agenda-add-entry-text-descriptive-links t
  162. "Non-nil means export org-links as descriptive links in agenda added text.
  163. This variable applies to the text added to the agenda when
  164. `org-agenda-add-entry-text-maxlines' is larger than 0.
  165. When this variable is nil, the URL will (also) be shown."
  166. :group 'org-agenda
  167. :type 'boolean)
  168. (defcustom org-agenda-export-html-style nil
  169. "The style specification for exported HTML Agenda files.
  170. If this variable contains a string, it will replace the default <style>
  171. section as produced by `htmlize'.
  172. Since there are different ways of setting style information, this variable
  173. needs to contain the full HTML structure to provide a style, including the
  174. surrounding HTML tags. The style specifications should include definitions
  175. the fonts used by the agenda, here is an example:
  176. <style type=\"text/css\">
  177. p { font-weight: normal; color: gray; }
  178. .org-agenda-structure {
  179. font-size: 110%;
  180. color: #003399;
  181. font-weight: 600;
  182. }
  183. .org-todo {
  184. color: #cc6666;
  185. font-weight: bold;
  186. }
  187. .org-agenda-done {
  188. color: #339933;
  189. }
  190. .org-done {
  191. color: #339933;
  192. }
  193. .title { text-align: center; }
  194. .todo, .deadline { color: red; }
  195. .done { color: green; }
  196. </style>
  197. or, if you want to keep the style in a file,
  198. <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
  199. As the value of this option simply gets inserted into the HTML <head> header,
  200. you can \"misuse\" it to also add other text to the header."
  201. :group 'org-agenda-export
  202. :group 'org-export-html
  203. :type '(choice
  204. (const nil)
  205. (string)))
  206. (defcustom org-agenda-persistent-filter nil
  207. "When set, keep filters from one agenda view to the next."
  208. :group 'org-agenda
  209. :type 'boolean)
  210. (defgroup org-agenda-custom-commands nil
  211. "Options concerning agenda views in Org mode."
  212. :tag "Org Agenda Custom Commands"
  213. :group 'org-agenda)
  214. (defconst org-sorting-choice
  215. '(choice
  216. (const time-up) (const time-down)
  217. (const timestamp-up) (const timestamp-down)
  218. (const scheduled-up) (const scheduled-down)
  219. (const deadline-up) (const deadline-down)
  220. (const ts-up) (const ts-down)
  221. (const tsia-up) (const tsia-down)
  222. (const category-keep) (const category-up) (const category-down)
  223. (const tag-down) (const tag-up)
  224. (const priority-up) (const priority-down)
  225. (const todo-state-up) (const todo-state-down)
  226. (const effort-up) (const effort-down)
  227. (const habit-up) (const habit-down)
  228. (const alpha-up) (const alpha-down)
  229. (const user-defined-up) (const user-defined-down))
  230. "Sorting choices.")
  231. ;; Keep custom values for `org-agenda-filter-preset' compatible with
  232. ;; the new variable `org-agenda-tag-filter-preset'.
  233. (defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
  234. (defvaralias 'org-agenda-filter 'org-agenda-tag-filter)
  235. (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
  236. "List of types searched for when creating the daily/weekly agenda.
  237. This variable is a list of symbols that controls the types of
  238. items that appear in the daily/weekly agenda. Allowed symbols in this
  239. list are
  240. :timestamp List items containing a date stamp or date range matching
  241. the selected date. This includes sexp entries in angular
  242. brackets.
  243. :sexp List entries resulting from plain diary-like sexps.
  244. :deadline List deadline due on that date. When the date is today,
  245. also list any deadlines past due, or due within
  246. `org-deadline-warning-days'.
  247. :deadline* Same as above, but only include the deadline if it has an
  248. hour specification as [h]h:mm.
  249. :scheduled List all items which are scheduled for the given date.
  250. The diary for *today* also contains items which were
  251. scheduled earlier and are not yet marked DONE.
  252. :scheduled* Same as above, but only include the scheduled item if it
  253. has an hour specification as [h]h:mm.
  254. By default, all four non-starred types are turned on.
  255. When :scheduled* or :deadline* are included, :schedule or :deadline
  256. will be ignored.
  257. Never set this variable globally using `setq', because then it
  258. will apply to all future agenda commands. Instead, bind it with
  259. `let' to scope it dynamically into the agenda-constructing
  260. command. A good way to set it is through options in
  261. `org-agenda-custom-commands'. For a more flexible (though
  262. somewhat less efficient) way of determining what is included in
  263. the daily/weekly agenda, see `org-agenda-skip-function'.")
  264. (defconst org-agenda-custom-commands-local-options
  265. `(repeat :tag "Local settings for this command. Remember to quote values"
  266. (choice :tag "Setting"
  267. (list :tag "Heading for this block"
  268. (const org-agenda-overriding-header)
  269. (string :tag "Headline"))
  270. (list :tag "Files to be searched"
  271. (const org-agenda-files)
  272. (list
  273. (const :format "" quote)
  274. (repeat (file))))
  275. (list :tag "Sorting strategy"
  276. (const org-agenda-sorting-strategy)
  277. (list
  278. (const :format "" quote)
  279. (repeat
  280. ,org-sorting-choice)))
  281. (list :tag "Prefix format"
  282. (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
  283. (string))
  284. (list :tag "Number of days in agenda"
  285. (const org-agenda-span)
  286. (list
  287. (const :format "" quote)
  288. (choice (const :tag "Day" day)
  289. (const :tag "Week" week)
  290. (const :tag "Fortnight" fortnight)
  291. (const :tag "Month" month)
  292. (const :tag "Year" year)
  293. (integer :tag "Custom"))))
  294. (list :tag "Fixed starting date"
  295. (const org-agenda-start-day)
  296. (string :value "2007-11-01"))
  297. (list :tag "Start on day of week"
  298. (const org-agenda-start-on-weekday)
  299. (choice :value 1
  300. (const :tag "Today" nil)
  301. (integer :tag "Weekday No.")))
  302. (list :tag "Include data from diary"
  303. (const org-agenda-include-diary)
  304. (boolean))
  305. (list :tag "Deadline Warning days"
  306. (const org-deadline-warning-days)
  307. (integer :value 1))
  308. (list :tag "Category filter preset"
  309. (const org-agenda-category-filter-preset)
  310. (list
  311. (const :format "" quote)
  312. (repeat
  313. (string :tag "+category or -category"))))
  314. (list :tag "Tags filter preset"
  315. (const org-agenda-tag-filter-preset)
  316. (list
  317. (const :format "" quote)
  318. (repeat
  319. (string :tag "+tag or -tag"))))
  320. (list :tag "Effort filter preset"
  321. (const org-agenda-effort-filter-preset)
  322. (list
  323. (const :format "" quote)
  324. (repeat
  325. (string :tag "+=10 or -=10 or +<10 or ->10"))))
  326. (list :tag "Regexp filter preset"
  327. (const org-agenda-regexp-filter-preset)
  328. (list
  329. (const :format "" quote)
  330. (repeat
  331. (string :tag "+regexp or -regexp"))))
  332. (list :tag "Set daily/weekly entry types"
  333. (const org-agenda-entry-types)
  334. (list
  335. (const :format "" quote)
  336. (set :greedy t :value ,org-agenda-entry-types
  337. (const :deadline)
  338. (const :scheduled)
  339. (const :deadline*)
  340. (const :scheduled*)
  341. (const :timestamp)
  342. (const :sexp))))
  343. (list :tag "Columns format"
  344. (const org-overriding-columns-format)
  345. (string :tag "Format"))
  346. (list :tag "Standard skipping condition"
  347. :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
  348. (const org-agenda-skip-function)
  349. (list
  350. (const :format "" quote)
  351. (list
  352. (choice
  353. :tag "Skipping range"
  354. (const :tag "Skip entry" org-agenda-skip-entry-if)
  355. (const :tag "Skip subtree" org-agenda-skip-subtree-if))
  356. (repeat :inline t :tag "Conditions for skipping"
  357. (choice
  358. :tag "Condition type"
  359. (list :tag "Regexp matches" :inline t
  360. (const :format "" regexp)
  361. (regexp))
  362. (list :tag "Regexp does not match" :inline t
  363. (const :format "" notregexp)
  364. (regexp))
  365. (list :tag "TODO state is" :inline t
  366. (const todo)
  367. (choice
  368. (const :tag "Any not-done state" todo)
  369. (const :tag "Any done state" done)
  370. (const :tag "Any state" any)
  371. (list :tag "Keyword list"
  372. (const :format "" quote)
  373. (repeat (string :tag "Keyword")))))
  374. (list :tag "TODO state is not" :inline t
  375. (const nottodo)
  376. (choice
  377. (const :tag "Any not-done state" todo)
  378. (const :tag "Any done state" done)
  379. (const :tag "Any state" any)
  380. (list :tag "Keyword list"
  381. (const :format "" quote)
  382. (repeat (string :tag "Keyword")))))
  383. (const :tag "scheduled" scheduled)
  384. (const :tag "not scheduled" notscheduled)
  385. (const :tag "deadline" deadline)
  386. (const :tag "no deadline" notdeadline)
  387. (const :tag "timestamp" timestamp)
  388. (const :tag "no timestamp" nottimestamp))))))
  389. (list :tag "Non-standard skipping condition"
  390. :value (org-agenda-skip-function)
  391. (const org-agenda-skip-function)
  392. (sexp :tag "Function or form (quoted!)"))
  393. (list :tag "Any variable"
  394. (variable :tag "Variable")
  395. (sexp :tag "Value (sexp)"))))
  396. "Selection of examples for agenda command settings.
  397. This will be spliced into the custom type of
  398. `org-agenda-custom-commands'.")
  399. (defcustom org-agenda-custom-commands
  400. '(("n" "Agenda and all TODOs" ((agenda "") (alltodo ""))))
  401. "Custom commands for the agenda.
  402. \\<org-mode-map>
  403. These commands will be offered on the splash screen displayed by the
  404. agenda dispatcher `\\[org-agenda]'. Each entry is a list like this:
  405. (key desc type match settings files)
  406. key The key (one or more characters as a string) to be associated
  407. with the command.
  408. desc A description of the command, when omitted or nil, a default
  409. description is built using MATCH.
  410. type The command type, any of the following symbols:
  411. agenda The daily/weekly agenda.
  412. todo Entries with a specific TODO keyword, in all agenda files.
  413. search Entries containing search words entry or headline.
  414. tags Tags/Property/TODO match in all agenda files.
  415. tags-todo Tags/P/T match in all agenda files, TODO entries only.
  416. todo-tree Sparse tree of specific TODO keyword in *current* file.
  417. tags-tree Sparse tree with all tags matches in *current* file.
  418. occur-tree Occur sparse tree for *current* file.
  419. ... A user-defined function.
  420. match What to search for:
  421. - a single keyword for TODO keyword searches
  422. - a tags/property/todo match expression for searches
  423. - a word search expression for text searches.
  424. - a regular expression for occur searches
  425. For all other commands, this should be the empty string.
  426. settings A list of option settings, similar to that in a let form, so like
  427. this: ((opt1 val1) (opt2 val2) ...). The values will be
  428. evaluated at the moment of execution, so quote them when needed.
  429. files A list of files to write the produced agenda buffer to with
  430. the command `org-store-agenda-views'.
  431. If a file name ends in \".html\", an HTML version of the buffer
  432. is written out. If it ends in \".ps\", a postscript version is
  433. produced. Otherwise, only the plain text is written to the file.
  434. You can also define a set of commands, to create a composite agenda buffer.
  435. In this case, an entry looks like this:
  436. (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
  437. where
  438. desc A description string to be displayed in the dispatcher menu.
  439. cmd An agenda command, similar to the above. However, tree commands
  440. are not allowed, but instead you can get agenda and global todo list.
  441. So valid commands for a set are:
  442. (agenda \"\" settings)
  443. (alltodo \"\" settings)
  444. (stuck \"\" settings)
  445. (todo \"match\" settings files)
  446. (search \"match\" settings files)
  447. (tags \"match\" settings files)
  448. (tags-todo \"match\" settings files)
  449. Each command can carry a list of options, and another set of options can be
  450. given for the whole set of commands. Individual command options take
  451. precedence over the general options.
  452. When using several characters as key to a command, the first characters
  453. are prefix commands. For the dispatcher to display useful information, you
  454. should provide a description for the prefix, like
  455. (setq org-agenda-custom-commands
  456. \\='((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
  457. (\"hl\" tags \"+HOME+Lisa\")
  458. (\"hp\" tags \"+HOME+Peter\")
  459. (\"hk\" tags \"+HOME+Kim\")))"
  460. :group 'org-agenda-custom-commands
  461. :type `(repeat
  462. (choice :value ("x" "Describe command here" tags "" nil)
  463. (list :tag "Single command"
  464. (string :tag "Access Key(s) ")
  465. (option (string :tag "Description"))
  466. (choice
  467. (const :tag "Agenda" agenda)
  468. (const :tag "TODO list" alltodo)
  469. (const :tag "Search words" search)
  470. (const :tag "Stuck projects" stuck)
  471. (const :tag "Tags/Property match (all agenda files)" tags)
  472. (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
  473. (const :tag "TODO keyword search (all agenda files)" todo)
  474. (const :tag "Tags sparse tree (current buffer)" tags-tree)
  475. (const :tag "TODO keyword tree (current buffer)" todo-tree)
  476. (const :tag "Occur tree (current buffer)" occur-tree)
  477. (sexp :tag "Other, user-defined function"))
  478. (string :tag "Match (only for some commands)")
  479. ,org-agenda-custom-commands-local-options
  480. (option (repeat :tag "Export" (file :tag "Export to"))))
  481. (list :tag "Command series, all agenda files"
  482. (string :tag "Access Key(s)")
  483. (string :tag "Description ")
  484. (repeat :tag "Component"
  485. (choice
  486. (list :tag "Agenda"
  487. (const :format "" agenda)
  488. (const :tag "" :format "" "")
  489. ,org-agenda-custom-commands-local-options)
  490. (list :tag "TODO list (all keywords)"
  491. (const :format "" alltodo)
  492. (const :tag "" :format "" "")
  493. ,org-agenda-custom-commands-local-options)
  494. (list :tag "Search words"
  495. (const :format "" search)
  496. (string :tag "Match")
  497. ,org-agenda-custom-commands-local-options)
  498. (list :tag "Stuck projects"
  499. (const :format "" stuck)
  500. (const :tag "" :format "" "")
  501. ,org-agenda-custom-commands-local-options)
  502. (list :tag "Tags/Property match (all agenda files)"
  503. (const :format "" tags)
  504. (string :tag "Match")
  505. ,org-agenda-custom-commands-local-options)
  506. (list :tag "Tags/Property match of TODO entries (all agenda files)"
  507. (const :format "" tags-todo)
  508. (string :tag "Match")
  509. ,org-agenda-custom-commands-local-options)
  510. (list :tag "TODO keyword search"
  511. (const :format "" todo)
  512. (string :tag "Match")
  513. ,org-agenda-custom-commands-local-options)
  514. (list :tag "Other, user-defined function"
  515. (symbol :tag "function")
  516. (string :tag "Match")
  517. ,org-agenda-custom-commands-local-options)))
  518. (repeat :tag "Settings for entire command set"
  519. (list (variable :tag "Any variable")
  520. (sexp :tag "Value")))
  521. (option (repeat :tag "Export" (file :tag "Export to"))))
  522. (cons :tag "Prefix key documentation"
  523. (string :tag "Access Key(s)")
  524. (string :tag "Description ")))))
  525. (defcustom org-agenda-query-register ?o
  526. "The register holding the current query string.
  527. The purpose of this is that if you construct a query string interactively,
  528. you can then use it to define a custom command."
  529. :group 'org-agenda-custom-commands
  530. :type 'character)
  531. (defcustom org-stuck-projects
  532. '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
  533. "How to identify stuck projects.
  534. This is a list of four items:
  535. 1. A tags/todo/property matcher string that is used to identify a project.
  536. See the manual for a description of tag and property searches.
  537. The entire tree below a headline matched by this is considered one project.
  538. 2. A list of TODO keywords identifying non-stuck projects.
  539. If the project subtree contains any headline with one of these todo
  540. keywords, the project is considered to be not stuck. If you specify
  541. \"*\" as a keyword, any TODO keyword will mark the project unstuck.
  542. 3. A list of tags identifying non-stuck projects.
  543. If the project subtree contains any headline with one of these tags,
  544. the project is considered to be not stuck. If you specify \"*\" as
  545. a tag, any tag will mark the project unstuck. Note that this is about
  546. the explicit presence of a tag somewhere in the subtree, inherited
  547. tags do not count here. If inherited tags make a project not stuck,
  548. use \"-TAG\" in the tags part of the matcher under (1.) above.
  549. 4. An arbitrary regular expression matching non-stuck projects.
  550. If the project turns out to be not stuck, search continues also in the
  551. subtree to see if any of the subtasks have project status.
  552. See also the variable `org-tags-match-list-sublevels' which applies
  553. to projects matched by this search as well.
  554. After defining this variable, you may use `org-agenda-list-stuck-projects'
  555. \(bound to `\\[org-agenda] #') to produce the list."
  556. :group 'org-agenda-custom-commands
  557. :type '(list
  558. (string :tag "Tags/TODO match to identify a project")
  559. (repeat :tag "Projects are *not* stuck if they have an entry with \
  560. TODO keyword any of" (string))
  561. (repeat :tag "Projects are *not* stuck if they have an entry with \
  562. TAG being any of" (string))
  563. (regexp :tag "Projects are *not* stuck if this regexp matches inside \
  564. the subtree")))
  565. (defgroup org-agenda-skip nil
  566. "Options concerning skipping parts of agenda files."
  567. :tag "Org Agenda Skip"
  568. :group 'org-agenda)
  569. (defcustom org-agenda-skip-function-global nil
  570. "Function to be called at each match during agenda construction.
  571. If this function returns nil, the current match should not be skipped.
  572. If the function decided to skip an agenda match, is must return the
  573. buffer position from which the search should be continued.
  574. This may also be a Lisp form, which will be evaluated.
  575. This variable will be applied to every agenda match, including
  576. tags/property searches and TODO lists. So try to make the test function
  577. do its checking as efficiently as possible. To implement a skipping
  578. condition just for specific agenda commands, use the variable
  579. `org-agenda-skip-function' which can be set in the options section
  580. of custom agenda commands."
  581. :group 'org-agenda-skip
  582. :type 'sexp)
  583. (defgroup org-agenda-daily/weekly nil
  584. "Options concerning the daily/weekly agenda."
  585. :tag "Org Agenda Daily/Weekly"
  586. :group 'org-agenda)
  587. (defgroup org-agenda-todo-list nil
  588. "Options concerning the global todo list agenda view."
  589. :tag "Org Agenda Todo List"
  590. :group 'org-agenda)
  591. (defgroup org-agenda-match-view nil
  592. "Options concerning the general tags/property/todo match agenda view."
  593. :tag "Org Agenda Match View"
  594. :group 'org-agenda)
  595. (defgroup org-agenda-search-view nil
  596. "Options concerning the search agenda view."
  597. :tag "Org Agenda Search View"
  598. :group 'org-agenda)
  599. (defvar org-agenda-archives-mode nil
  600. "Non-nil means the agenda will include archived items.
  601. If this is the symbol `trees', trees in the selected agenda scope
  602. that are marked with the ARCHIVE tag will be included anyway. When this is
  603. t, also all archive files associated with the current selection of agenda
  604. files will be included.")
  605. (defcustom org-agenda-restriction-lock-highlight-subtree t
  606. "Non-nil means highlight the whole subtree when restriction is active.
  607. Otherwise only highlight the headline. Highlighting the whole subtree is
  608. useful to ensure no edits happen beyond the restricted region."
  609. :group 'org-agenda
  610. :type 'boolean)
  611. (defcustom org-agenda-skip-comment-trees t
  612. "Non-nil means skip trees that start with the COMMENT keyword.
  613. When nil, these trees are also scanned by agenda commands."
  614. :group 'org-agenda-skip
  615. :type 'boolean)
  616. (defcustom org-agenda-todo-list-sublevels t
  617. "Non-nil means check also the sublevels of a TODO entry for TODO entries.
  618. When nil, the sublevels of a TODO entry are not checked, resulting in
  619. potentially much shorter TODO lists."
  620. :group 'org-agenda-skip
  621. :group 'org-agenda-todo-list
  622. :type 'boolean)
  623. (defcustom org-agenda-todo-ignore-with-date nil
  624. "Non-nil means don't show entries with a date in the global todo list.
  625. You can use this if you prefer to mark mere appointments with a TODO keyword,
  626. but don't want them to show up in the TODO list.
  627. When this is set, it also covers deadlines and scheduled items, the settings
  628. of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
  629. will be ignored.
  630. See also the variable `org-agenda-tags-todo-honor-ignore-options'."
  631. :group 'org-agenda-skip
  632. :group 'org-agenda-todo-list
  633. :type 'boolean)
  634. (defcustom org-agenda-todo-ignore-timestamp nil
  635. "Non-nil means don't show entries with a timestamp.
  636. This applies when creating the global todo list.
  637. Valid values are:
  638. past Don't show entries for today or in the past.
  639. future Don't show entries with a timestamp in the future.
  640. The idea behind this is that if it has a future
  641. timestamp, you don't want to think about it until the
  642. date.
  643. all Don't show any entries with a timestamp in the global todo list.
  644. The idea behind this is that by setting a timestamp, you
  645. have already \"taken care\" of this item.
  646. This variable can also have an integer as a value. If positive (N),
  647. todos with a timestamp N or more days in the future will be ignored. If
  648. negative (-N), todos with a timestamp N or more days in the past will be
  649. ignored. If 0, todos with a timestamp either today or in the future will
  650. be ignored. For example, a value of -1 will exclude todos with a
  651. timestamp in the past (yesterday or earlier), while a value of 7 will
  652. exclude todos with a timestamp a week or more in the future.
  653. See also `org-agenda-todo-ignore-with-date'.
  654. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  655. to make his option also apply to the tags-todo list."
  656. :group 'org-agenda-skip
  657. :group 'org-agenda-todo-list
  658. :version "24.1"
  659. :type '(choice
  660. (const :tag "Ignore future timestamp todos" future)
  661. (const :tag "Ignore past or present timestamp todos" past)
  662. (const :tag "Ignore all timestamp todos" all)
  663. (const :tag "Show timestamp todos" nil)
  664. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  665. (defcustom org-agenda-todo-ignore-scheduled nil
  666. "Non-nil means, ignore some scheduled TODO items when making TODO list.
  667. This applies when creating the global todo list.
  668. Valid values are:
  669. past Don't show entries scheduled today or in the past.
  670. future Don't show entries scheduled in the future.
  671. The idea behind this is that by scheduling it, you don't want to
  672. think about it until the scheduled date.
  673. all Don't show any scheduled entries in the global todo list.
  674. The idea behind this is that by scheduling it, you have already
  675. \"taken care\" of this item.
  676. t Same as `all', for backward compatibility.
  677. This variable can also have an integer as a value. See
  678. `org-agenda-todo-ignore-timestamp' for more details.
  679. See also `org-agenda-todo-ignore-with-date'.
  680. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  681. to make his option also apply to the tags-todo list."
  682. :group 'org-agenda-skip
  683. :group 'org-agenda-todo-list
  684. :type '(choice
  685. (const :tag "Ignore future-scheduled todos" future)
  686. (const :tag "Ignore past- or present-scheduled todos" past)
  687. (const :tag "Ignore all scheduled todos" all)
  688. (const :tag "Ignore all scheduled todos (compatibility)" t)
  689. (const :tag "Show scheduled todos" nil)
  690. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  691. (defcustom org-agenda-todo-ignore-deadlines nil
  692. "Non-nil means ignore some deadline TODO items when making TODO list.
  693. There are different motivations for using different values, please think
  694. carefully when configuring this variable.
  695. This applies when creating the global TODO list.
  696. Valid values are:
  697. near Don't show near deadline entries. A deadline is near when it is
  698. closer than `org-deadline-warning-days' days. The idea behind this
  699. is that such items will appear in the agenda anyway.
  700. far Don't show TODO entries where a deadline has been defined, but
  701. is not going to happen anytime soon. This is useful if you want to use
  702. the TODO list to figure out what to do now.
  703. past Don't show entries with a deadline timestamp for today or in the past.
  704. future Don't show entries with a deadline timestamp in the future, not even
  705. when they become `near' ones. Use it with caution.
  706. all Ignore all TODO entries that do have a deadline.
  707. t Same as `near', for backward compatibility.
  708. This variable can also have an integer as a value. See
  709. `org-agenda-todo-ignore-timestamp' for more details.
  710. See also `org-agenda-todo-ignore-with-date'.
  711. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  712. to make his option also apply to the tags-todo list."
  713. :group 'org-agenda-skip
  714. :group 'org-agenda-todo-list
  715. :type '(choice
  716. (const :tag "Ignore near deadlines" near)
  717. (const :tag "Ignore near deadlines (compatibility)" t)
  718. (const :tag "Ignore far deadlines" far)
  719. (const :tag "Ignore all TODOs with a deadlines" all)
  720. (const :tag "Show all TODOs, even if they have a deadline" nil)
  721. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  722. (defcustom org-agenda-todo-ignore-time-comparison-use-seconds nil
  723. "Time unit to use when possibly ignoring an agenda item.
  724. See the docstring of various `org-agenda-todo-ignore-*' options.
  725. The default is to compare time stamps using days. An item is thus
  726. considered to be in the future if it is at least one day after today.
  727. Non-nil means to compare time stamps using seconds. An item is then
  728. considered future if it has a time value later than current time."
  729. :group 'org-agenda-skip
  730. :group 'org-agenda-todo-list
  731. :version "24.4"
  732. :package-version '(Org . "8.0")
  733. :type '(choice
  734. (const :tag "Compare time with days" nil)
  735. (const :tag "Compare time with seconds" t)))
  736. (defcustom org-agenda-tags-todo-honor-ignore-options nil
  737. "Non-nil means honor todo-list ignores options also in tags-todo search.
  738. The variables
  739. `org-agenda-todo-ignore-with-date',
  740. `org-agenda-todo-ignore-timestamp',
  741. `org-agenda-todo-ignore-scheduled',
  742. `org-agenda-todo-ignore-deadlines'
  743. make the global TODO list skip entries that have time stamps of certain
  744. kinds. If this option is set, the same options will also apply for the
  745. tags-todo search, which is the general tags/property matcher
  746. restricted to unfinished TODO entries only."
  747. :group 'org-agenda-skip
  748. :group 'org-agenda-todo-list
  749. :group 'org-agenda-match-view
  750. :type 'boolean)
  751. (defcustom org-agenda-skip-scheduled-if-done nil
  752. "Non-nil means don't show scheduled items in agenda when they are done.
  753. This is relevant for the daily/weekly agenda, not for the TODO list. It
  754. applies only to the actual date of the scheduling. Warnings about an item
  755. with a past scheduling dates are always turned off when the item is DONE."
  756. :group 'org-agenda-skip
  757. :group 'org-agenda-daily/weekly
  758. :type 'boolean)
  759. (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
  760. "Non-nil means skip scheduling line if same entry shows because of deadline.
  761. In the agenda of today, an entry can show up multiple times
  762. because it is both scheduled and has a nearby deadline, and maybe
  763. a plain time stamp as well.
  764. When this variable is nil, the entry will be shown several times.
  765. When set to t, then only the deadline is shown and the fact that
  766. the entry is scheduled today or was scheduled previously is not
  767. shown.
  768. When set to the symbol `not-today', skip scheduled previously,
  769. but not scheduled today.
  770. When set to the symbol `repeated-after-deadline', skip scheduled
  771. items if they are repeated beyond the current deadline."
  772. :group 'org-agenda-skip
  773. :group 'org-agenda-daily/weekly
  774. :type '(choice
  775. (const :tag "Never" nil)
  776. (const :tag "Always" t)
  777. (const :tag "Not when scheduled today" not-today)
  778. (const :tag "When repeated past deadline" repeated-after-deadline)))
  779. (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
  780. "Non-nil means skip timestamp line if same entry shows because of deadline.
  781. In the agenda of today, an entry can show up multiple times
  782. because it has both a plain timestamp and has a nearby deadline.
  783. When this variable is t, then only the deadline is shown and the
  784. fact that the entry has a timestamp for or including today is not
  785. shown. When this variable is nil, the entry will be shown
  786. several times."
  787. :group 'org-agenda-skip
  788. :group 'org-agenda-daily/weekly
  789. :version "24.1"
  790. :type '(choice
  791. (const :tag "Never" nil)
  792. (const :tag "Always" t)))
  793. (defcustom org-agenda-skip-deadline-if-done nil
  794. "Non-nil means don't show deadlines when the corresponding item is done.
  795. When nil, the deadline is still shown and should give you a happy feeling.
  796. This is relevant for the daily/weekly agenda. It applies only to the
  797. actual date of the deadline. Warnings about approaching and past-due
  798. deadlines are always turned off when the item is DONE."
  799. :group 'org-agenda-skip
  800. :group 'org-agenda-daily/weekly
  801. :type 'boolean)
  802. (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
  803. "Non-nil means skip deadline prewarning when entry is also scheduled.
  804. This will apply on all days where a prewarning for the deadline would
  805. be shown, but not at the day when the entry is actually due. On that day,
  806. the deadline will be shown anyway.
  807. This variable may be set to nil, t, the symbol `pre-scheduled',
  808. or a number which will then give the number of days before the actual
  809. deadline when the prewarnings should resume. The symbol `pre-scheduled'
  810. eliminates the deadline prewarning only prior to the scheduled date.
  811. This can be used in a workflow where the first showing of the deadline will
  812. trigger you to schedule it, and then you don't want to be reminded of it
  813. because you will take care of it on the day when scheduled."
  814. :group 'org-agenda-skip
  815. :group 'org-agenda-daily/weekly
  816. :version "24.1"
  817. :type '(choice
  818. (const :tag "Always show prewarning" nil)
  819. (const :tag "Remove prewarning prior to scheduled date" pre-scheduled)
  820. (const :tag "Remove prewarning if entry is scheduled" t)
  821. (integer :tag "Restart prewarning N days before deadline")))
  822. (defcustom org-agenda-skip-scheduled-delay-if-deadline nil
  823. "Non-nil means skip scheduled delay when entry also has a deadline.
  824. This variable may be set to nil, t, the symbol `post-deadline',
  825. or a number which will then give the number of days after the actual
  826. scheduled date when the delay should expire. The symbol `post-deadline'
  827. eliminates the schedule delay when the date is posterior to the deadline."
  828. :group 'org-agenda-skip
  829. :group 'org-agenda-daily/weekly
  830. :version "24.4"
  831. :package-version '(Org . "8.0")
  832. :type '(choice
  833. (const :tag "Always honor delay" nil)
  834. (const :tag "Ignore delay if posterior to the deadline" post-deadline)
  835. (const :tag "Ignore delay if entry has a deadline" t)
  836. (integer :tag "Honor delay up until N days after the scheduled date")))
  837. (defcustom org-agenda-skip-additional-timestamps-same-entry nil
  838. "When nil, multiple same-day timestamps in entry make multiple agenda lines.
  839. When non-nil, after the search for timestamps has matched once in an
  840. entry, the rest of the entry will not be searched."
  841. :group 'org-agenda-skip
  842. :type 'boolean)
  843. (defcustom org-agenda-skip-timestamp-if-done nil
  844. "Non-nil means don't select item by timestamp or -range if it is DONE."
  845. :group 'org-agenda-skip
  846. :group 'org-agenda-daily/weekly
  847. :type 'boolean)
  848. (defcustom org-agenda-dim-blocked-tasks t
  849. "Non-nil means dim blocked tasks in the agenda display.
  850. This causes some overhead during agenda construction, but if you
  851. have turned on `org-enforce-todo-dependencies',
  852. `org-enforce-todo-checkbox-dependencies', or any other blocking
  853. mechanism, this will create useful feedback in the agenda.
  854. Instead of t, this variable can also have the value `invisible'.
  855. Then blocked tasks will be invisible and only become visible when
  856. they become unblocked. An exemption to this behavior is when a task is
  857. blocked because of unchecked checkboxes below it. Since checkboxes do
  858. not show up in the agenda views, making this task invisible you remove any
  859. trace from agenda views that there is something to do. Therefore, a task
  860. that is blocked because of checkboxes will never be made invisible, it
  861. will only be dimmed."
  862. :group 'org-agenda-daily/weekly
  863. :group 'org-agenda-todo-list
  864. :version "24.3"
  865. :type '(choice
  866. (const :tag "Do not dim" nil)
  867. (const :tag "Dim to a gray face" t)
  868. (const :tag "Make invisible" invisible)))
  869. (defgroup org-agenda-startup nil
  870. "Options concerning initial settings in the Agenda in Org Mode."
  871. :tag "Org Agenda Startup"
  872. :group 'org-agenda)
  873. (defcustom org-agenda-menu-show-matcher t
  874. "Non-nil means show the match string in the agenda dispatcher menu.
  875. When nil, the matcher string is not shown, but is put into the help-echo
  876. property so than moving the mouse over the command shows it.
  877. Setting it to nil is good if matcher strings are very long and/or if
  878. you want to use two-columns display (see `org-agenda-menu-two-columns')."
  879. :group 'org-agenda
  880. :version "24.1"
  881. :type 'boolean)
  882. (defcustom org-agenda-menu-two-columns nil
  883. "Non-nil means, use two columns to show custom commands in the dispatcher.
  884. If you use this, you probably want to set `org-agenda-menu-show-matcher'
  885. to nil."
  886. :group 'org-agenda
  887. :version "24.1"
  888. :type 'boolean)
  889. (defcustom org-agenda-finalize-hook nil
  890. "Hook run just before displaying an agenda buffer.
  891. The buffer is still writable when the hook is called.
  892. You can modify some of the buffer substrings but you should be
  893. extra careful not to modify the text properties of the agenda
  894. headlines as the agenda display heavily relies on them."
  895. :group 'org-agenda-startup
  896. :type 'hook)
  897. (defcustom org-agenda-mouse-1-follows-link nil
  898. "Non-nil means mouse-1 on a link will follow the link in the agenda.
  899. A longer mouse click will still set point. Needs to be set
  900. before org.el is loaded."
  901. :group 'org-agenda-startup
  902. :type 'boolean)
  903. (defcustom org-agenda-start-with-follow-mode nil
  904. "The initial value of follow mode in a newly created agenda window."
  905. :group 'org-agenda-startup
  906. :type 'boolean)
  907. (defcustom org-agenda-follow-indirect nil
  908. "Non-nil means `org-agenda-follow-mode' displays only the
  909. current item's tree, in an indirect buffer."
  910. :group 'org-agenda
  911. :version "24.1"
  912. :type 'boolean)
  913. (defcustom org-agenda-show-outline-path t
  914. "Non-nil means show outline path in echo area after line motion."
  915. :group 'org-agenda-startup
  916. :type 'boolean)
  917. (defcustom org-agenda-start-with-entry-text-mode nil
  918. "The initial value of entry-text-mode in a newly created agenda window."
  919. :group 'org-agenda-startup
  920. :type 'boolean)
  921. (defcustom org-agenda-entry-text-maxlines 5
  922. "Number of text lines to be added when `E' is pressed in the agenda.
  923. Note that this variable only used during agenda display. To add entry text
  924. when exporting the agenda, configure the variable
  925. `org-agenda-add-entry-text-maxlines'."
  926. :group 'org-agenda
  927. :type 'integer)
  928. (defcustom org-agenda-entry-text-exclude-regexps nil
  929. "List of regular expressions to clean up entry text.
  930. The complete matches of all regular expressions in this list will be
  931. removed from entry text before it is shown in the agenda."
  932. :group 'org-agenda
  933. :type '(repeat (regexp)))
  934. (defcustom org-agenda-entry-text-leaders " > "
  935. "Text prepended to the entry text in agenda buffers."
  936. :version "24.4"
  937. :package-version '(Org . "8.0")
  938. :group 'org-agenda
  939. :type 'string)
  940. (defvar org-agenda-entry-text-cleanup-hook nil
  941. "Hook that is run after basic cleanup of entry text to be shown in agenda.
  942. This cleanup is done in a temporary buffer, so the function may inspect and
  943. change the entire buffer.
  944. Some default stuff like drawers and scheduling/deadline dates will already
  945. have been removed when this is called, as will any matches for regular
  946. expressions listed in `org-agenda-entry-text-exclude-regexps'.")
  947. (defvar org-agenda-include-inactive-timestamps nil
  948. "Non-nil means include inactive time stamps in agenda.
  949. Dynamically scoped.")
  950. (defgroup org-agenda-windows nil
  951. "Options concerning the windows used by the Agenda in Org Mode."
  952. :tag "Org Agenda Windows"
  953. :group 'org-agenda)
  954. (defcustom org-agenda-window-setup 'reorganize-frame
  955. "How the agenda buffer should be displayed.
  956. Possible values for this option are:
  957. current-window Show agenda in the current window, keeping all other windows.
  958. other-window Use `switch-to-buffer-other-window' to display agenda.
  959. only-window Show agenda, deleting all other windows.
  960. reorganize-frame Show only two windows on the current frame, the current
  961. window and the agenda.
  962. other-frame Use `switch-to-buffer-other-frame' to display agenda.
  963. Also, when exiting the agenda, kill that frame.
  964. See also the variable `org-agenda-restore-windows-after-quit'."
  965. :group 'org-agenda-windows
  966. :type '(choice
  967. (const current-window)
  968. (const other-frame)
  969. (const other-window)
  970. (const only-window)
  971. (const reorganize-frame)))
  972. (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
  973. "The min and max height of the agenda window as a fraction of frame height.
  974. The value of the variable is a cons cell with two numbers between 0 and 1.
  975. It only matters if `org-agenda-window-setup' is `reorganize-frame'."
  976. :group 'org-agenda-windows
  977. :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
  978. (defcustom org-agenda-restore-windows-after-quit nil
  979. "Non-nil means restore window configuration upon exiting agenda.
  980. Before the window configuration is changed for displaying the agenda,
  981. the current status is recorded. When the agenda is exited with
  982. `q' or `x' and this option is set, the old state is restored. If
  983. `org-agenda-window-setup' is `other-frame', the value of this
  984. option will be ignored."
  985. :group 'org-agenda-windows
  986. :type 'boolean)
  987. (defcustom org-agenda-span 'week
  988. "Number of days to include in overview display.
  989. Can be day, week, month, year, or any number of days.
  990. Custom commands can set this variable in the options section."
  991. :group 'org-agenda-daily/weekly
  992. :type '(choice (const :tag "Day" day)
  993. (const :tag "Week" week)
  994. (const :tag "Fortnight" fortnight)
  995. (const :tag "Month" month)
  996. (const :tag "Year" year)
  997. (integer :tag "Custom")))
  998. (defcustom org-agenda-start-on-weekday 1
  999. "Non-nil means start the overview always on the specified weekday.
  1000. 0 denotes Sunday, 1 denotes Monday, etc.
  1001. When nil, always start on the current day.
  1002. Custom commands can set this variable in the options section."
  1003. :group 'org-agenda-daily/weekly
  1004. :type '(choice (const :tag "Today" nil)
  1005. (integer :tag "Weekday No.")))
  1006. (defcustom org-agenda-show-all-dates t
  1007. "Non-nil means `org-agenda' shows every day in the selected range.
  1008. When nil, only the days which actually have entries are shown."
  1009. :group 'org-agenda-daily/weekly
  1010. :type 'boolean)
  1011. (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
  1012. "Format string for displaying dates in the agenda.
  1013. Used by the daily/weekly agenda. This should be a format string
  1014. understood by `format-time-string', or a function returning the
  1015. formatted date as a string. The function must take a single
  1016. argument, a calendar-style date list like (month day year)."
  1017. :group 'org-agenda-daily/weekly
  1018. :type '(choice
  1019. (string :tag "Format string")
  1020. (function :tag "Function")))
  1021. (defun org-agenda-end-of-line ()
  1022. "Go to the end of visible line."
  1023. (interactive)
  1024. (goto-char (line-end-position)))
  1025. (defun org-agenda-format-date-aligned (date)
  1026. "Format a DATE string for display in the daily/weekly agenda.
  1027. This function makes sure that dates are aligned for easy reading."
  1028. (require 'cal-iso)
  1029. (let* ((dayname (calendar-day-name date))
  1030. (day (cadr date))
  1031. (day-of-week (calendar-day-of-week date))
  1032. (month (car date))
  1033. (monthname (calendar-month-name month))
  1034. (year (nth 2 date))
  1035. (iso-week (org-days-to-iso-week
  1036. (calendar-absolute-from-gregorian date)))
  1037. (weekyear (cond ((and (= month 1) (>= iso-week 52))
  1038. (1- year))
  1039. ((and (= month 12) (<= iso-week 1))
  1040. (1+ year))
  1041. (t year)))
  1042. (weekstring (if (= day-of-week 1)
  1043. (format " W%02d" iso-week)
  1044. "")))
  1045. (format "%-10s %2d %s %4d%s"
  1046. dayname day monthname year weekstring)))
  1047. (defcustom org-agenda-time-leading-zero nil
  1048. "Non-nil means use leading zero for military times in agenda.
  1049. For example, 9:30am would become 09:30 rather than 9:30."
  1050. :group 'org-agenda-daily/weekly
  1051. :version "24.1"
  1052. :type 'boolean)
  1053. (defcustom org-agenda-timegrid-use-ampm nil
  1054. "When set, show AM/PM style timestamps on the timegrid."
  1055. :group 'org-agenda
  1056. :version "24.1"
  1057. :type 'boolean)
  1058. (defun org-agenda-time-of-day-to-ampm (time)
  1059. "Convert TIME of a string like \"13:45\" to an AM/PM style time string."
  1060. (let* ((hour-number (string-to-number (substring time 0 -3)))
  1061. (minute (substring time -2))
  1062. (ampm "am"))
  1063. (cond
  1064. ((equal hour-number 12)
  1065. (setq ampm "pm"))
  1066. ((> hour-number 12)
  1067. (setq ampm "pm")
  1068. (setq hour-number (- hour-number 12))))
  1069. (concat
  1070. (if org-agenda-time-leading-zero
  1071. (format "%02d" hour-number)
  1072. (format "%02s" (number-to-string hour-number)))
  1073. ":" minute ampm)))
  1074. (defun org-agenda-time-of-day-to-ampm-maybe (time)
  1075. "Conditionally convert TIME to AM/PM format based on `org-agenda-timegrid-use-ampm'."
  1076. (if org-agenda-timegrid-use-ampm
  1077. (org-agenda-time-of-day-to-ampm time)
  1078. time))
  1079. (defcustom org-agenda-weekend-days '(6 0)
  1080. "Which days are weekend?
  1081. These days get the special face `org-agenda-date-weekend' in the agenda."
  1082. :group 'org-agenda-daily/weekly
  1083. :type '(set :greedy t
  1084. (const :tag "Monday" 1)
  1085. (const :tag "Tuesday" 2)
  1086. (const :tag "Wednesday" 3)
  1087. (const :tag "Thursday" 4)
  1088. (const :tag "Friday" 5)
  1089. (const :tag "Saturday" 6)
  1090. (const :tag "Sunday" 0)))
  1091. (defcustom org-agenda-move-date-from-past-immediately-to-today t
  1092. "Non-nil means jump to today when moving a past date forward in time.
  1093. When using S-right in the agenda to move a date forward, and the date
  1094. stamp currently points to the past, the first key press will move it
  1095. to today. When nil, just move one day forward even if the date stays
  1096. in the past."
  1097. :group 'org-agenda-daily/weekly
  1098. :version "24.1"
  1099. :type 'boolean)
  1100. (defcustom org-agenda-diary-file 'diary-file
  1101. "File to which to add new entries with the `i' key in agenda and calendar.
  1102. When this is the symbol `diary-file', the functionality in the Emacs
  1103. calendar will be used to add entries to the `diary-file'. But when this
  1104. points to a file, `org-agenda-diary-entry' will be used instead."
  1105. :group 'org-agenda
  1106. :type '(choice
  1107. (const :tag "The standard Emacs diary file" diary-file)
  1108. (file :tag "Special Org file diary entries")))
  1109. (defcustom org-agenda-include-diary nil
  1110. "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
  1111. Custom commands can set this variable in the options section."
  1112. :group 'org-agenda-daily/weekly
  1113. :type 'boolean)
  1114. (defcustom org-agenda-include-deadlines t
  1115. "If non-nil, include entries within their deadline warning period.
  1116. Custom commands can set this variable in the options section."
  1117. :group 'org-agenda-daily/weekly
  1118. :version "24.1"
  1119. :type 'boolean)
  1120. (defcustom org-agenda-show-future-repeats t
  1121. "Non-nil shows repeated entries in the future part of the agenda.
  1122. When set to the symbol `next' only the first future repeat is shown."
  1123. :group 'org-agenda-daily/weekly
  1124. :type '(choice
  1125. (const :tag "Show all repeated entries" t)
  1126. (const :tag "Show next repeated entry" next)
  1127. (const :tag "Do not show repeated entries" nil))
  1128. :version "26.1"
  1129. :package-version '(Org . "9.1")
  1130. :safe #'symbolp)
  1131. (defcustom org-agenda-prefer-last-repeat nil
  1132. "Non-nil sets date for repeated entries to their last repeat.
  1133. When nil, display SCHEDULED and DEADLINE dates at their base
  1134. date, and in today's agenda, as a reminder. Display plain
  1135. time-stamps, on the other hand, at every repeat date in the past
  1136. in addition to the base date.
  1137. When non-nil, show a repeated entry at its latest repeat date,
  1138. possibly being today even if it wasn't marked as done. This
  1139. setting is useful if you do not always mark repeated entries as
  1140. done and, yet, consider that reaching repeat date starts the task
  1141. anew.
  1142. When set to a list of strings, prefer last repeats only for
  1143. entries with these TODO keywords."
  1144. :group 'org-agenda-daily/weekly
  1145. :type '(choice
  1146. (const :tag "Prefer last repeat" t)
  1147. (const :tag "Prefer base date" nil)
  1148. (repeat :tag "Prefer last repeat for entries with these TODO keywords"
  1149. (string :tag "TODO keyword")))
  1150. :version "26.1"
  1151. :package-version '(Org . "9.1")
  1152. :safe (lambda (x) (or (booleanp x) (consp x))))
  1153. (defcustom org-scheduled-past-days 10000
  1154. "Number of days to continue listing scheduled items not marked DONE.
  1155. When an item is scheduled on a date, it shows up in the agenda on
  1156. this day and will be listed until it is marked done or for the
  1157. number of days given here."
  1158. :group 'org-agenda-daily/weekly
  1159. :type 'integer
  1160. :safe 'integerp)
  1161. (defcustom org-deadline-past-days 10000
  1162. "Number of days to warn about missed deadlines.
  1163. When an item has deadline on a date, it shows up in the agenda on
  1164. this day and will appear as a reminder until it is marked DONE or
  1165. for the number of days given here."
  1166. :group 'org-agenda-daily/weekly
  1167. :type 'integer
  1168. :version "26.1"
  1169. :package-version '(Org . "9.1")
  1170. :safe 'integerp)
  1171. (defcustom org-agenda-log-mode-items '(closed clock)
  1172. "List of items that should be shown in agenda log mode.
  1173. \\<org-agenda-mode-map>\
  1174. This list may contain the following symbols:
  1175. closed Show entries that have been closed on that day.
  1176. clock Show entries that have received clocked time on that day.
  1177. state Show all logged state changes.
  1178. Note that instead of changing this variable, you can also press \
  1179. `\\[universal-argument] \\[org-agenda-log-mode]' in
  1180. the agenda to display all available LOG items temporarily."
  1181. :group 'org-agenda-daily/weekly
  1182. :type '(set :greedy t (const closed) (const clock) (const state)))
  1183. (defcustom org-agenda-clock-consistency-checks
  1184. '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
  1185. :gap-ok-around ("4:00")
  1186. :default-face ((:background "DarkRed") (:foreground "white"))
  1187. :overlap-face nil :gap-face nil :no-end-time-face nil
  1188. :long-face nil :short-face nil)
  1189. "This is a property list, with the following keys:
  1190. :max-duration Mark clocking chunks that are longer than this time.
  1191. This is a time string like \"HH:MM\", or the number
  1192. of minutes as an integer.
  1193. :min-duration Mark clocking chunks that are shorter that this.
  1194. This is a time string like \"HH:MM\", or the number
  1195. of minutes as an integer.
  1196. :max-gap Mark gaps between clocking chunks that are longer than
  1197. this duration. A number of minutes, or a string
  1198. like \"HH:MM\".
  1199. :gap-ok-around List of times during the day which are usually not working
  1200. times. When a gap is detected, but the gap contains any
  1201. of these times, the gap is *not* reported. For example,
  1202. if this is (\"4:00\" \"13:00\") then gaps that contain
  1203. 4:00 in the morning (i.e. the night) and 13:00
  1204. (i.e. a typical lunch time) do not cause a warning.
  1205. You should have at least one time during the night in this
  1206. list, or otherwise the first task each morning will trigger
  1207. a warning because it follows a long gap.
  1208. Furthermore, the following properties can be used to define faces for
  1209. issue display.
  1210. :default-face the default face, if the specific face is undefined
  1211. :overlap-face face for overlapping clocks
  1212. :gap-face face for gaps between clocks
  1213. :no-end-time-face face for incomplete clocks
  1214. :long-face face for clock intervals that are too long
  1215. :short-face face for clock intervals that are too short"
  1216. :group 'org-agenda-daily/weekly
  1217. :group 'org-clock
  1218. :version "24.1"
  1219. :type 'plist)
  1220. (defcustom org-agenda-log-mode-add-notes t
  1221. "Non-nil means add first line of notes to log entries in agenda views.
  1222. If a log item like a state change or a clock entry is associated with
  1223. notes, the first line of these notes will be added to the entry in the
  1224. agenda display."
  1225. :group 'org-agenda-daily/weekly
  1226. :type 'boolean)
  1227. (defcustom org-agenda-start-with-log-mode nil
  1228. "The initial value of log-mode in a newly created agenda window.
  1229. See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
  1230. explanations on the possible values."
  1231. :group 'org-agenda-startup
  1232. :group 'org-agenda-daily/weekly
  1233. :type '(choice (const :tag "Don't show log items" nil)
  1234. (const :tag "Show only log items" only)
  1235. (const :tag "Show all possible log items" clockcheck)
  1236. (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
  1237. (choice (const :tag "Show closed log items" closed)
  1238. (const :tag "Show clocked log items" clock)
  1239. (const :tag "Show all logged state changes" state)))))
  1240. (defcustom org-agenda-start-with-clockreport-mode nil
  1241. "The initial value of clockreport-mode in a newly created agenda window."
  1242. :group 'org-agenda-startup
  1243. :group 'org-agenda-daily/weekly
  1244. :type 'boolean)
  1245. (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
  1246. "Property list with parameters for the clocktable in clockreport mode.
  1247. This is the display mode that shows a clock table in the daily/weekly
  1248. agenda, the properties for this dynamic block can be set here.
  1249. The usual clocktable parameters are allowed here, but you cannot set
  1250. the properties :name, :tstart, :tend, :block, and :scope - these will
  1251. be overwritten to make sure the content accurately reflects the
  1252. current display in the agenda."
  1253. :group 'org-agenda-daily/weekly
  1254. :type 'plist)
  1255. (defvaralias 'org-agenda-search-view-search-words-only
  1256. 'org-agenda-search-view-always-boolean)
  1257. (defcustom org-agenda-search-view-always-boolean nil
  1258. "Non-nil means the search string is interpreted as individual parts.
  1259. The search string for search view can either be interpreted as a phrase,
  1260. or as a list of snippets that define a boolean search for a number of
  1261. strings.
  1262. When this is non-nil, the string will be split on whitespace, and each
  1263. snippet will be searched individually, and all must match in order to
  1264. select an entry. A snippet is then a single string of non-white
  1265. characters, or a string in double quotes, or a regexp in {} braces.
  1266. If a snippet is preceded by \"-\", the snippet must *not* match.
  1267. \"+\" is syntactic sugar for positive selection. Each snippet may
  1268. be found as a full word or a partial word, but see the variable
  1269. `org-agenda-search-view-force-full-words'.
  1270. When this is nil, search will look for the entire search phrase as one,
  1271. with each space character matching any amount of whitespace, including
  1272. line breaks.
  1273. Even when this is nil, you can still switch to Boolean search dynamically
  1274. by preceding the first snippet with \"+\" or \"-\". If the first snippet
  1275. is a regexp marked with braces like \"{abc}\", this will also switch to
  1276. boolean search."
  1277. :group 'org-agenda-search-view
  1278. :version "24.1"
  1279. :type 'boolean)
  1280. (defcustom org-agenda-search-view-force-full-words nil
  1281. "Non-nil means, search words must be matches as complete words.
  1282. When nil, they may also match part of a word."
  1283. :group 'org-agenda-search-view
  1284. :version "24.1"
  1285. :type 'boolean)
  1286. (defcustom org-agenda-search-view-max-outline-level 0
  1287. "Maximum outline level to display in search view.
  1288. E.g. when this is set to 1, the search view will only
  1289. show headlines of level 1. When set to 0, the default
  1290. value, don't limit agenda view by outline level."
  1291. :group 'org-agenda-search-view
  1292. :version "26.1"
  1293. :package-version '(Org . "8.3")
  1294. :type 'integer)
  1295. (defgroup org-agenda-time-grid nil
  1296. "Options concerning the time grid in the Org Agenda."
  1297. :tag "Org Agenda Time Grid"
  1298. :group 'org-agenda)
  1299. (defcustom org-agenda-search-headline-for-time t
  1300. "Non-nil means search headline for a time-of-day.
  1301. If the headline contains a time-of-day in one format or another, it will
  1302. be used to sort the entry into the time sequence of items for a day.
  1303. Some people have time stamps in the headline that refer to the creation
  1304. time or so, and then this produces an unwanted side effect. If this is
  1305. the case for your, use this variable to turn off searching the headline
  1306. for a time."
  1307. :group 'org-agenda-time-grid
  1308. :type 'boolean)
  1309. (defcustom org-agenda-use-time-grid t
  1310. "Non-nil means show a time grid in the agenda schedule.
  1311. A time grid is a set of lines for specific times (like every two hours between
  1312. 8:00 and 20:00). The items scheduled for a day at specific times are
  1313. sorted in between these lines.
  1314. For details about when the grid will be shown, and what it will look like, see
  1315. the variable `org-agenda-time-grid'."
  1316. :group 'org-agenda-time-grid
  1317. :type 'boolean)
  1318. (defcustom org-agenda-time-grid
  1319. '((daily today require-timed)
  1320. (800 1000 1200 1400 1600 1800 2000)
  1321. "......"
  1322. "----------------")
  1323. "The settings for time grid for agenda display.
  1324. This is a list of four items. The first item is again a list. It contains
  1325. symbols specifying conditions when the grid should be displayed:
  1326. daily if the agenda shows a single day
  1327. weekly if the agenda shows an entire week
  1328. today show grid on current date, independent of daily/weekly display
  1329. require-timed show grid only if at least one item has a time specification
  1330. remove-match skip grid times already present in an entry
  1331. The second item is a list of integers, indicating the times that
  1332. should have a grid line.
  1333. The third item is a string which will be placed right after the
  1334. times that have a grid line.
  1335. The fourth item is a string placed after the grid times. This
  1336. will align with agenda items."
  1337. :group 'org-agenda-time-grid
  1338. :type
  1339. '(list
  1340. (set :greedy t :tag "Grid Display Options"
  1341. (const :tag "Show grid in single day agenda display" daily)
  1342. (const :tag "Show grid in weekly agenda display" weekly)
  1343. (const :tag "Always show grid for today" today)
  1344. (const :tag "Show grid only if any timed entries are present"
  1345. require-timed)
  1346. (const :tag "Skip grid times already present in an entry"
  1347. remove-match))
  1348. (repeat :tag "Grid Times" (integer :tag "Time"))
  1349. (string :tag "Grid String (after agenda times)")
  1350. (string :tag "Grid String (aligns with agenda items)")))
  1351. (defcustom org-agenda-show-current-time-in-grid t
  1352. "Non-nil means show the current time in the time grid."
  1353. :group 'org-agenda-time-grid
  1354. :version "24.1"
  1355. :type 'boolean)
  1356. (defcustom org-agenda-current-time-string
  1357. "now - - - - - - - - - - - - - - - - - - - - - - - - -"
  1358. "The string for the current time marker in the agenda."
  1359. :group 'org-agenda-time-grid
  1360. :version "24.1"
  1361. :type 'string)
  1362. (defgroup org-agenda-sorting nil
  1363. "Options concerning sorting in the Org Agenda."
  1364. :tag "Org Agenda Sorting"
  1365. :group 'org-agenda)
  1366. (defcustom org-agenda-sorting-strategy
  1367. '((agenda habit-down time-up priority-down category-keep)
  1368. (todo priority-down category-keep)
  1369. (tags priority-down category-keep)
  1370. (search category-keep))
  1371. "Sorting structure for the agenda items of a single day.
  1372. This is a list of symbols which will be used in sequence to determine
  1373. if an entry should be listed before another entry. The following
  1374. symbols are recognized:
  1375. time-up Put entries with time-of-day indications first, early first.
  1376. time-down Put entries with time-of-day indications first, late first.
  1377. timestamp-up Sort by any timestamp, early first.
  1378. timestamp-down Sort by any timestamp, late first.
  1379. scheduled-up Sort by scheduled timestamp, early first.
  1380. scheduled-down Sort by scheduled timestamp, late first.
  1381. deadline-up Sort by deadline timestamp, early first.
  1382. deadline-down Sort by deadline timestamp, late first.
  1383. ts-up Sort by active timestamp, early first.
  1384. ts-down Sort by active timestamp, late first.
  1385. tsia-up Sort by inactive timestamp, early first.
  1386. tsia-down Sort by inactive timestamp, late first.
  1387. category-keep Keep the default order of categories, corresponding to the
  1388. sequence in `org-agenda-files'.
  1389. category-up Sort alphabetically by category, A-Z.
  1390. category-down Sort alphabetically by category, Z-A.
  1391. tag-up Sort alphabetically by last tag, A-Z.
  1392. tag-down Sort alphabetically by last tag, Z-A.
  1393. priority-up Sort numerically by priority, high priority last.
  1394. priority-down Sort numerically by priority, high priority first.
  1395. todo-state-up Sort by todo state, tasks that are done last.
  1396. todo-state-down Sort by todo state, tasks that are done first.
  1397. effort-up Sort numerically by estimated effort, high effort last.
  1398. effort-down Sort numerically by estimated effort, high effort first.
  1399. user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
  1400. user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
  1401. habit-up Put entries that are habits first.
  1402. habit-down Put entries that are habits last.
  1403. alpha-up Sort headlines alphabetically.
  1404. alpha-down Sort headlines alphabetically, reversed.
  1405. The different possibilities will be tried in sequence, and testing stops
  1406. if one comparison returns a \"not-equal\". For example, the default
  1407. '(time-up category-keep priority-down)
  1408. means: Pull out all entries having a specified time of day and sort them,
  1409. in order to make a time schedule for the current day the first thing in the
  1410. agenda listing for the day. Of the entries without a time indication, keep
  1411. the grouped in categories, don't sort the categories, but keep them in
  1412. the sequence given in `org-agenda-files'. Within each category sort by
  1413. priority.
  1414. Leaving out `category-keep' would mean that items will be sorted across
  1415. categories by priority.
  1416. Instead of a single list, this can also be a set of list for specific
  1417. contents, with a context symbol in the car of the list, any of
  1418. `agenda', `todo', `tags', `search' for the corresponding agenda views.
  1419. Custom commands can bind this variable in the options section."
  1420. :group 'org-agenda-sorting
  1421. :type `(choice
  1422. (repeat :tag "General" ,org-sorting-choice)
  1423. (list :tag "Individually"
  1424. (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
  1425. (repeat ,org-sorting-choice))
  1426. (cons (const :tag "Strategy for TODO lists" todo)
  1427. (repeat ,org-sorting-choice))
  1428. (cons (const :tag "Strategy for Tags matches" tags)
  1429. (repeat ,org-sorting-choice))
  1430. (cons (const :tag "Strategy for search matches" search)
  1431. (repeat ,org-sorting-choice)))))
  1432. (defcustom org-agenda-cmp-user-defined nil
  1433. "A function to define the comparison `user-defined'.
  1434. This function must receive two arguments, agenda entry a and b.
  1435. If a>b, return +1. If a<b, return -1. If they are equal as seen by
  1436. the user comparison, return nil.
  1437. When this is defined, you can make `user-defined-up' and `user-defined-down'
  1438. part of an agenda sorting strategy."
  1439. :group 'org-agenda-sorting
  1440. :type 'symbol)
  1441. (defcustom org-sort-agenda-notime-is-late t
  1442. "Non-nil means items without time are considered late.
  1443. This is only relevant for sorting. When t, items which have no explicit
  1444. time like 15:30 will be considered as 99:01, i.e. later than any items which
  1445. do have a time. When nil, the default time is before 0:00. You can use this
  1446. option to decide if the schedule for today should come before or after timeless
  1447. agenda entries."
  1448. :group 'org-agenda-sorting
  1449. :type 'boolean)
  1450. (defcustom org-sort-agenda-noeffort-is-high t
  1451. "Non-nil means items without effort estimate are sorted as high effort.
  1452. This also applies when filtering an agenda view with respect to the
  1453. < or > effort operator. Then, tasks with no effort defined will be treated
  1454. as tasks with high effort.
  1455. When nil, such items are sorted as 0 minutes effort."
  1456. :group 'org-agenda-sorting
  1457. :type 'boolean)
  1458. (defgroup org-agenda-line-format nil
  1459. "Options concerning the entry prefix in the Org agenda display."
  1460. :tag "Org Agenda Line Format"
  1461. :group 'org-agenda)
  1462. (defcustom org-agenda-prefix-format
  1463. '((agenda . " %i %-12:c%?-12t% s")
  1464. (todo . " %i %-12:c")
  1465. (tags . " %i %-12:c")
  1466. (search . " %i %-12:c"))
  1467. "Format specifications for the prefix of items in the agenda views.
  1468. An alist with one entry per agenda type. The keys of the
  1469. sublists are `agenda', `todo', `search' and `tags'. The values
  1470. are format strings.
  1471. This format works similar to a printf format, with the following meaning:
  1472. %c the category of the item, \"Diary\" for entries from the diary,
  1473. or as given by the CATEGORY keyword or derived from the file name
  1474. %e the effort required by the item
  1475. %l the level of the item (insert X space(s) if item is of level X)
  1476. %i the icon category of the item, see `org-agenda-category-icon-alist'
  1477. %T the last tag of the item (ignore inherited tags, which come first)
  1478. %t the HH:MM time-of-day specification if one applies to the entry
  1479. %s Scheduling/Deadline information, a short string
  1480. %b show breadcrumbs, i.e., the names of the higher levels
  1481. %(expression) Eval EXPRESSION and replace the control string
  1482. by the result
  1483. All specifiers work basically like the standard `%s' of printf, but may
  1484. contain two additional characters: a question mark just after the `%'
  1485. and a whitespace/punctuation character just before the final letter.
  1486. If the first character after `%' is a question mark, the entire field
  1487. will only be included if the corresponding value applies to the current
  1488. entry. This is useful for fields which should have fixed width when
  1489. present, but zero width when absent. For example, \"%?-12t\" will
  1490. result in a 12 character time field if a time of the day is specified,
  1491. but will completely disappear in entries which do not contain a time.
  1492. If there is punctuation or whitespace character just before the
  1493. final format letter, this character will be appended to the field
  1494. value if the value is not empty. For example, the format
  1495. \"%-12:c\" leads to \"Diary: \" if the category is \"Diary\". If
  1496. the category is empty, no additional colon is inserted.
  1497. The default value for the agenda sublist is \" %-12:c%?-12t% s\",
  1498. which means:
  1499. - Indent the line with two space characters
  1500. - Give the category a 12 chars wide field, padded with whitespace on
  1501. the right (because of `-'). Append a colon if there is a category
  1502. (because of `:').
  1503. - If there is a time-of-day, put it into a 12 chars wide field. If no
  1504. time, don't put in an empty field, just skip it (because of '?').
  1505. - Finally, put the scheduling information.
  1506. See also the variables `org-agenda-remove-times-when-in-prefix' and
  1507. `org-agenda-remove-tags'.
  1508. Custom commands can set this variable in the options section."
  1509. :type '(choice
  1510. (string :tag "General format")
  1511. (list :greedy t :tag "View dependent"
  1512. (cons (const agenda) (string :tag "Format"))
  1513. (cons (const todo) (string :tag "Format"))
  1514. (cons (const tags) (string :tag "Format"))
  1515. (cons (const search) (string :tag "Format"))))
  1516. :group 'org-agenda-line-format
  1517. :version "26.1"
  1518. :package-version '(Org . "9.1"))
  1519. (defcustom org-agenda-breadcrumbs-separator "->"
  1520. "The separator of breadcrumbs in agenda lines."
  1521. :group 'org-agenda-line-format
  1522. :package-version '(Org . "9.3")
  1523. :type 'string
  1524. :safe #'stringp)
  1525. (defvar org-prefix-format-compiled nil
  1526. "The compiled prefix format and associated variables.
  1527. This is a list where first element is a list of variable bindings, and second
  1528. element is the compiled format expression. See the variable
  1529. `org-agenda-prefix-format'.")
  1530. (defcustom org-agenda-todo-keyword-format "%-1s"
  1531. "Format for the TODO keyword in agenda lines.
  1532. Set this to something like \"%-12s\" if you want all TODO keywords
  1533. to occupy a fixed space in the agenda display."
  1534. :group 'org-agenda-line-format
  1535. :type 'string)
  1536. (defcustom org-agenda-diary-sexp-prefix nil
  1537. "A regexp that matches part of a diary sexp entry
  1538. which should be treated as scheduling/deadline information in
  1539. `org-agenda'.
  1540. For example, you can use this to extract the `diary-remind-message' from
  1541. `diary-remind' entries."
  1542. :group 'org-agenda-line-format
  1543. :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
  1544. (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
  1545. "Text preceding timerange entries in the agenda view.
  1546. This is a list with two strings. The first applies when the range
  1547. is entirely on one day. The second applies if the range spans several days.
  1548. The strings may have two \"%d\" format specifiers which will be filled
  1549. with the sequence number of the days, and the total number of days in the
  1550. range, respectively."
  1551. :group 'org-agenda-line-format
  1552. :type '(list
  1553. (string :tag "Deadline today ")
  1554. (choice :tag "Deadline relative"
  1555. (string :tag "Format string")
  1556. (function))))
  1557. (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
  1558. "Text preceding scheduled items in the agenda view.
  1559. This is a list with two strings. The first applies when the item is
  1560. scheduled on the current day. The second applies when it has been scheduled
  1561. previously, it may contain a %d indicating that this is the nth time that
  1562. this item is scheduled, due to automatic rescheduling of unfinished items
  1563. for the following day. So this number is one larger than the number of days
  1564. that passed since this item was scheduled first."
  1565. :group 'org-agenda-line-format
  1566. :version "24.4"
  1567. :package-version '(Org . "8.0")
  1568. :type '(list
  1569. (string :tag "Scheduled today ")
  1570. (string :tag "Scheduled previously")))
  1571. (defcustom org-agenda-inactive-leader "["
  1572. "Text preceding item pulled into the agenda by inactive time stamps.
  1573. These entries are added to the agenda when pressing \"[\"."
  1574. :group 'org-agenda-line-format
  1575. :version "24.1"
  1576. :type 'string)
  1577. (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: " "%2d d. ago: ")
  1578. "Text preceding deadline items in the agenda view.
  1579. This is a list with three strings. The first applies when the item has its
  1580. deadline on the current day. The second applies when the deadline is in the
  1581. future, the third one when it is in the past. The strings may contain %d
  1582. to capture the number of days."
  1583. :group 'org-agenda-line-format
  1584. :version "24.4"
  1585. :package-version '(Org . "8.0")
  1586. :type '(list
  1587. (string :tag "Deadline today ")
  1588. (string :tag "Deadline in the future ")
  1589. (string :tag "Deadline in the past ")))
  1590. (defcustom org-agenda-remove-times-when-in-prefix t
  1591. "Non-nil means remove duplicate time specifications in agenda items.
  1592. When the format `org-agenda-prefix-format' contains a `%t' specifier, a
  1593. time-of-day specification in a headline or diary entry is extracted and
  1594. placed into the prefix. If this option is non-nil, the original specification
  1595. \(a timestamp or -range, or just a plain time(range) specification like
  1596. 11:30-4pm) will be removed for agenda display. This makes the agenda less
  1597. cluttered.
  1598. The option can be t or nil. It may also be the symbol `beg', indicating
  1599. that the time should only be removed when it is located at the beginning of
  1600. the headline/diary entry."
  1601. :group 'org-agenda-line-format
  1602. :type '(choice
  1603. (const :tag "Always" t)
  1604. (const :tag "Never" nil)
  1605. (const :tag "When at beginning of entry" beg)))
  1606. (defcustom org-agenda-remove-timeranges-from-blocks nil
  1607. "Non-nil means remove time ranges specifications in agenda
  1608. items that span on several days."
  1609. :group 'org-agenda-line-format
  1610. :version "24.1"
  1611. :type 'boolean)
  1612. (defcustom org-agenda-default-appointment-duration nil
  1613. "Default duration for appointments that only have a starting time.
  1614. When nil, no duration is specified in such cases.
  1615. When non-nil, this must be the number of minutes, e.g. 60 for one hour."
  1616. :group 'org-agenda-line-format
  1617. :type '(choice
  1618. (integer :tag "Minutes")
  1619. (const :tag "No default duration")))
  1620. (defcustom org-agenda-show-inherited-tags t
  1621. "Non-nil means show inherited tags in each agenda line.
  1622. When this option is set to `always', it takes precedence over
  1623. `org-agenda-use-tag-inheritance' and inherited tags are shown
  1624. in every agenda.
  1625. When this option is set to t (the default), inherited tags are
  1626. shown when they are available, i.e. when the value of
  1627. `org-agenda-use-tag-inheritance' enables tag inheritance for the
  1628. given agenda type.
  1629. This can be set to a list of agenda types in which the agenda
  1630. must display the inherited tags. Available types are `todo',
  1631. `agenda' and `search'.
  1632. When set to nil, never show inherited tags in agenda lines."
  1633. :group 'org-agenda-line-format
  1634. :group 'org-agenda
  1635. :version "24.3"
  1636. :type '(choice
  1637. (const :tag "Show inherited tags when available" t)
  1638. (const :tag "Always show inherited tags" always)
  1639. (repeat :tag "Show inherited tags only in selected agenda types"
  1640. (symbol :tag "Agenda type"))))
  1641. (defcustom org-agenda-use-tag-inheritance '(todo search agenda)
  1642. "List of agenda view types where to use tag inheritance.
  1643. In tags/tags-todo/tags-tree agenda views, tag inheritance is
  1644. controlled by `org-use-tag-inheritance'. In other agenda types,
  1645. `org-use-tag-inheritance' is not used for the selection of the
  1646. agenda entries. Still, you may want the agenda to be aware of
  1647. the inherited tags anyway, e.g. for later tag filtering.
  1648. Allowed value are `todo', `search' and `agenda'.
  1649. This variable has no effect if `org-agenda-show-inherited-tags'
  1650. is set to `always'. In that case, the agenda is aware of those
  1651. tags.
  1652. The default value sets tags in every agenda type. Setting this
  1653. option to nil will speed up non-tags agenda view a lot."
  1654. :group 'org-agenda
  1655. :version "26.1"
  1656. :package-version '(Org . "9.1")
  1657. :type '(choice
  1658. (const :tag "Use tag inheritance in all agenda types" t)
  1659. (repeat :tag "Use tag inheritance in selected agenda types"
  1660. (symbol :tag "Agenda type"))))
  1661. (defcustom org-agenda-hide-tags-regexp nil
  1662. "Regular expression used to filter away specific tags in agenda views.
  1663. This means that these tags will be present, but not be shown in the agenda
  1664. line. Secondary filtering will still work on the hidden tags.
  1665. Nil means don't hide any tags."
  1666. :group 'org-agenda-line-format
  1667. :type '(choice
  1668. (const :tag "Hide none" nil)
  1669. (string :tag "Regexp ")))
  1670. (defvaralias 'org-agenda-remove-tags-when-in-prefix
  1671. 'org-agenda-remove-tags)
  1672. (defcustom org-agenda-remove-tags nil
  1673. "Non-nil means remove the tags from the headline copy in the agenda.
  1674. When this is the symbol `prefix', only remove tags when
  1675. `org-agenda-prefix-format' contains a `%T' specifier."
  1676. :group 'org-agenda-line-format
  1677. :type '(choice
  1678. (const :tag "Always" t)
  1679. (const :tag "Never" nil)
  1680. (const :tag "When prefix format contains %T" prefix)))
  1681. (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column)
  1682. (defcustom org-agenda-tags-column 'auto
  1683. "Shift tags in agenda items to this column.
  1684. If set to `auto', tags will be automatically aligned to the right
  1685. edge of the window.
  1686. If set to a positive number, tags will be left-aligned to that
  1687. column. If set to a negative number, tags will be right-aligned
  1688. to that column. For example, -80 works well for a normal 80
  1689. character screen."
  1690. :group 'org-agenda-line-format
  1691. :type '(choice
  1692. (const :tag "Automatically align to right edge of window" auto)
  1693. (integer :tag "Specific column" -80))
  1694. :package-version '(Org . "9.1")
  1695. :version "26.1")
  1696. (defcustom org-agenda-fontify-priorities 'cookies
  1697. "Non-nil means highlight low and high priorities in agenda.
  1698. When t, the highest priority entries are bold, lowest priority italic.
  1699. However, settings in `org-priority-faces' will overrule these faces.
  1700. When this variable is the symbol `cookies', only fontify the
  1701. cookies, not the entire task.
  1702. This may also be an association list of priority faces, whose
  1703. keys are the character values of `org-highest-priority',
  1704. `org-default-priority', and `org-lowest-priority' (the default values
  1705. are ?A, ?B, and ?C, respectively). The face may be a named face, a
  1706. color as a string, or a list like `(:background \"Red\")'.
  1707. If it is a color, the variable `org-faces-easy-properties'
  1708. determines if it is a foreground or a background color."
  1709. :group 'org-agenda-line-format
  1710. :type '(choice
  1711. (const :tag "Never" nil)
  1712. (const :tag "Defaults" t)
  1713. (const :tag "Cookies only" cookies)
  1714. (repeat :tag "Specify"
  1715. (list (character :tag "Priority" :value ?A)
  1716. (choice :tag "Face "
  1717. (string :tag "Color")
  1718. (sexp :tag "Face"))))))
  1719. (defcustom org-agenda-day-face-function nil
  1720. "Function called to determine what face should be used to display a day.
  1721. The only argument passed to that function is the day. It should
  1722. returns a face, or nil if does not want to specify a face and let
  1723. the normal rules apply."
  1724. :group 'org-agenda-line-format
  1725. :version "24.1"
  1726. :type '(choice (const nil) (function)))
  1727. (defcustom org-agenda-category-icon-alist nil
  1728. "Alist of category icon to be displayed in agenda views.
  1729. Each entry should have the following format:
  1730. (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
  1731. Where CATEGORY-REGEXP is a regexp matching the categories where
  1732. the icon should be displayed.
  1733. FILE-OR-DATA either a file path or a string containing image data.
  1734. The other fields can be omitted safely if not needed:
  1735. TYPE indicates the image type.
  1736. DATA-P is a boolean indicating whether the FILE-OR-DATA string is
  1737. image data.
  1738. PROPS are additional image attributes to assign to the image,
  1739. like, e.g. `:ascent center'.
  1740. (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
  1741. If you want to set the display properties yourself, just put a
  1742. list as second element:
  1743. (CATEGORY-REGEXP (MY PROPERTY LIST))
  1744. For example, to display a 16px horizontal space for Emacs
  1745. category, you can use:
  1746. (\"Emacs\" \\='(space . (:width (16))))"
  1747. :group 'org-agenda-line-format
  1748. :version "24.1"
  1749. :type '(alist :key-type (string :tag "Regexp matching category")
  1750. :value-type (choice (list :tag "Icon"
  1751. (string :tag "File or data")
  1752. (symbol :tag "Type")
  1753. (boolean :tag "Data?")
  1754. (repeat :tag "Extra image properties" :inline t symbol))
  1755. (list :tag "Display properties" sexp))))
  1756. (defgroup org-agenda-column-view nil
  1757. "Options concerning column view in the agenda."
  1758. :tag "Org Agenda Column View"
  1759. :group 'org-agenda)
  1760. (defcustom org-agenda-view-columns-initially nil
  1761. "When non-nil, switch to columns view right after creating the agenda."
  1762. :group 'org-agenda-column-view
  1763. :type 'boolean
  1764. :version "26.1"
  1765. :package-version '(Org . "9.0")
  1766. :safe #'booleanp)
  1767. (defcustom org-agenda-columns-show-summaries t
  1768. "Non-nil means show summaries for columns displayed in the agenda view."
  1769. :group 'org-agenda-column-view
  1770. :type 'boolean)
  1771. (defcustom org-agenda-columns-compute-summary-properties t
  1772. "Non-nil means recompute all summary properties before column view.
  1773. When column view in the agenda is listing properties that have a summary
  1774. operator, it can go to all relevant buffers and recompute the summaries
  1775. there. This can mean overhead for the agenda column view, but is necessary
  1776. to have thing up to date.
  1777. As a special case, a CLOCKSUM property also makes sure that the clock
  1778. computations are current."
  1779. :group 'org-agenda-column-view
  1780. :type 'boolean)
  1781. (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
  1782. "Non-nil means the duration of an appointment will add to day effort.
  1783. The property to which appointment durations will be added is the one given
  1784. in the option `org-effort-property'. If an appointment does not have
  1785. an end time, `org-agenda-default-appointment-duration' will be used. If that
  1786. is not set, an appointment without end time will not contribute to the time
  1787. estimate."
  1788. :group 'org-agenda-column-view
  1789. :type 'boolean)
  1790. (defcustom org-agenda-auto-exclude-function nil
  1791. "A function called with a tag to decide if it is filtered on \
  1792. \\<org-agenda-mode-map>`\\[org-agenda-filter-by-tag] RET'.
  1793. The sole argument to the function, which is called once for each
  1794. possible tag, is a string giving the name of the tag. The
  1795. function should return either nil if the tag should be included
  1796. as normal, \"-<TAG>\" to exclude the tag, or \"+<TAG>\" to exclude
  1797. lines not carrying this tag.
  1798. Note that for the purpose of tag filtering, only the lower-case version of
  1799. all tags will be considered, so that this function will only ever see
  1800. the lower-case version of all tags."
  1801. :group 'org-agenda
  1802. :type '(choice (const nil) (function)))
  1803. (defcustom org-agenda-bulk-custom-functions nil
  1804. "Alist of characters and custom functions for bulk actions.
  1805. For example, this value makes those two functions available:
  1806. \\='((?R set-category)
  1807. (?C bulk-cut))
  1808. With selected entries in an agenda buffer, `B R' will call
  1809. the custom function `set-category' on the selected entries.
  1810. Note that functions in this alist don't need to be quoted."
  1811. :type '(alist :key-type character :value-type (group function))
  1812. :version "24.1"
  1813. :group 'org-agenda)
  1814. (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
  1815. "Execute BODY with point at location given by `org-hd-marker' property.
  1816. If STRING is non-nil, the text property will be fetched from position 0
  1817. in that string. If STRING is nil, it will be fetched from the beginning
  1818. of the current line."
  1819. (org-with-gensyms (marker)
  1820. `(let ((,marker (get-text-property (if ,string 0 (point-at-bol))
  1821. 'org-hd-marker ,string)))
  1822. (with-current-buffer (marker-buffer ,marker)
  1823. (save-excursion
  1824. (goto-char ,marker)
  1825. ,@body)))))
  1826. (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
  1827. (defun org-add-agenda-custom-command (entry)
  1828. "Replace or add a command in `org-agenda-custom-commands'.
  1829. This is mostly for hacking and trying a new command - once the command
  1830. works you probably want to add it to `org-agenda-custom-commands' for good."
  1831. (let ((ass (assoc (car entry) org-agenda-custom-commands)))
  1832. (if ass
  1833. (setcdr ass (cdr entry))
  1834. (push entry org-agenda-custom-commands))))
  1835. (defmacro org-agenda--insert-overriding-header (default)
  1836. "Insert header into agenda view.
  1837. The inserted header depends on `org-agenda-overriding-header'.
  1838. If the empty string, don't insert a header. If any other string,
  1839. insert it as a header. If nil, insert DEFAULT, which should
  1840. evaluate to a string."
  1841. (declare (debug (form)) (indent defun))
  1842. `(cond
  1843. ((not org-agenda-overriding-header) (insert ,default))
  1844. ((equal org-agenda-overriding-header "") nil)
  1845. ((stringp org-agenda-overriding-header)
  1846. (insert (propertize org-agenda-overriding-header
  1847. 'face 'org-agenda-structure)
  1848. "\n"))
  1849. (t (user-error "Invalid value for `org-agenda-overriding-header': %S"
  1850. org-agenda-overriding-header))))
  1851. ;;; Define the org-agenda-mode
  1852. (defvaralias 'org-agenda-keymap 'org-agenda-mode-map)
  1853. (defvar org-agenda-mode-map (make-sparse-keymap)
  1854. "Keymap for `org-agenda-mode'.")
  1855. (org-remap org-agenda-mode-map 'move-end-of-line 'org-agenda-end-of-line)
  1856. (defvar org-agenda-menu) ; defined later in this file.
  1857. (defvar org-agenda-restrict nil) ; defined later in this file.
  1858. (defvar org-agenda-follow-mode nil)
  1859. (defvar org-agenda-entry-text-mode nil)
  1860. (defvar org-agenda-clockreport-mode nil)
  1861. (defvar org-agenda-show-log nil
  1862. "When non-nil, show the log in the agenda.
  1863. Do not set this directly; instead use
  1864. `org-agenda-start-with-log-mode', which see.")
  1865. (defvar org-agenda-redo-command nil)
  1866. (defvar org-agenda-query-string nil)
  1867. (defvar org-agenda-mode-hook nil
  1868. "Hook run after `org-agenda-mode' is turned on.
  1869. The buffer is still writable when this hook is called.")
  1870. (defvar org-agenda-type nil)
  1871. (defvar org-agenda-force-single-file nil)
  1872. (defvar org-agenda-bulk-marked-entries nil
  1873. "List of markers that refer to marked entries in the agenda.")
  1874. (defvar org-agenda-current-date nil
  1875. "Active date when building the agenda.")
  1876. ;;; Multiple agenda buffers support
  1877. (defcustom org-agenda-sticky nil
  1878. "Non-nil means agenda q key will bury agenda buffers.
  1879. Agenda commands will then show existing buffer instead of generating new ones.
  1880. When nil, `q' will kill the single agenda buffer."
  1881. :group 'org-agenda
  1882. :version "24.3"
  1883. :type 'boolean)
  1884. ;;;###autoload
  1885. (defun org-toggle-sticky-agenda (&optional arg)
  1886. "Toggle `org-agenda-sticky'."
  1887. (interactive "P")
  1888. (let ((new-value (if arg
  1889. (> (prefix-numeric-value arg) 0)
  1890. (not org-agenda-sticky))))
  1891. (if (equal new-value org-agenda-sticky)
  1892. (and (called-interactively-p 'interactive)
  1893. (message "Sticky agenda was already %s"
  1894. (if org-agenda-sticky "enabled" "disabled")))
  1895. (setq org-agenda-sticky new-value)
  1896. (org-agenda-kill-all-agenda-buffers)
  1897. (and (called-interactively-p 'interactive)
  1898. (message "Sticky agenda %s"
  1899. (if org-agenda-sticky "enabled" "disabled"))))))
  1900. (defvar org-agenda-buffer nil
  1901. "Agenda buffer currently being generated.")
  1902. (defvar org-agenda-last-prefix-arg nil)
  1903. (defvar org-agenda-this-buffer-name nil)
  1904. (defvar org-agenda-doing-sticky-redo nil)
  1905. (defvar org-agenda-this-buffer-is-sticky nil)
  1906. (defvar org-agenda-last-indirect-buffer nil
  1907. "Last buffer loaded by `org-agenda-tree-to-indirect-buffer'.")
  1908. (defconst org-agenda-local-vars
  1909. '(org-agenda-this-buffer-name
  1910. org-agenda-undo-list
  1911. org-agenda-pending-undo-list
  1912. org-agenda-follow-mode
  1913. org-agenda-entry-text-mode
  1914. org-agenda-clockreport-mode
  1915. org-agenda-show-log
  1916. org-agenda-redo-command
  1917. org-agenda-query-string
  1918. org-agenda-type
  1919. org-agenda-bulk-marked-entries
  1920. org-agenda-undo-has-started-in
  1921. org-agenda-info
  1922. org-agenda-pre-window-conf
  1923. org-agenda-columns-active
  1924. org-agenda-tag-filter
  1925. org-agenda-category-filter
  1926. org-agenda-top-headline-filter
  1927. org-agenda-regexp-filter
  1928. org-agenda-effort-filter
  1929. org-agenda-markers
  1930. org-agenda-last-search-view-search-was-boolean
  1931. org-agenda-last-indirect-buffer
  1932. org-agenda-filtered-by-category
  1933. org-agenda-filter-form
  1934. org-agenda-cycle-counter
  1935. org-agenda-last-prefix-arg)
  1936. "Variables that must be local in agenda buffers to allow multiple buffers.")
  1937. (defun org-agenda-mode ()
  1938. "Mode for time-sorted view on action items in Org files.
  1939. The following commands are available:
  1940. \\{org-agenda-mode-map}"
  1941. (interactive)
  1942. (ignore-errors (require 'face-remap))
  1943. (let ((agenda-local-vars-to-keep
  1944. '(text-scale-mode-amount
  1945. text-scale-mode
  1946. text-scale-mode-lighter
  1947. face-remapping-alist))
  1948. (save (buffer-local-variables)))
  1949. (kill-all-local-variables)
  1950. (cl-flet ((reset-saved (var-set)
  1951. "Reset variables in VAR-SET to possibly stored value in SAVE."
  1952. (dolist (elem save)
  1953. (pcase elem
  1954. (`(,var . ,val) ;ignore unbound variables
  1955. (when (and val (memq var var-set))
  1956. (set var val)))))))
  1957. (cond (org-agenda-doing-sticky-redo
  1958. ;; Refreshing sticky agenda-buffer
  1959. ;;
  1960. ;; Preserve the value of `org-agenda-local-vars' variables.
  1961. (mapc #'make-local-variable org-agenda-local-vars)
  1962. (reset-saved org-agenda-local-vars)
  1963. (setq-local org-agenda-this-buffer-is-sticky t))
  1964. (org-agenda-sticky
  1965. ;; Creating a sticky Agenda buffer for the first time
  1966. (mapc 'make-local-variable org-agenda-local-vars)
  1967. (setq-local org-agenda-this-buffer-is-sticky t))
  1968. (t
  1969. ;; Creating a non-sticky agenda buffer
  1970. (setq-local org-agenda-this-buffer-is-sticky nil)))
  1971. (mapc #'make-local-variable agenda-local-vars-to-keep)
  1972. (reset-saved agenda-local-vars-to-keep)))
  1973. (setq org-agenda-undo-list nil
  1974. org-agenda-pending-undo-list nil
  1975. org-agenda-bulk-marked-entries nil)
  1976. (setq major-mode 'org-agenda-mode)
  1977. ;; Keep global-font-lock-mode from turning on font-lock-mode
  1978. (setq-local font-lock-global-modes (list 'not major-mode))
  1979. (setq mode-name "Org-Agenda")
  1980. (setq indent-tabs-mode nil)
  1981. (use-local-map org-agenda-mode-map)
  1982. (easy-menu-add org-agenda-menu)
  1983. (when org-startup-truncated (setq truncate-lines t))
  1984. (setq-local line-move-visual nil)
  1985. (add-hook 'post-command-hook 'org-agenda-update-agenda-type nil 'local)
  1986. (add-hook 'pre-command-hook 'org-unhighlight nil 'local)
  1987. ;; Make sure properties are removed when copying text
  1988. (if (boundp 'filter-buffer-substring-functions)
  1989. (add-hook 'filter-buffer-substring-functions
  1990. (lambda (fun start end delete)
  1991. (substring-no-properties (funcall fun start end delete)))
  1992. nil t)
  1993. ;; Emacs >= 24.4.
  1994. (add-function :filter-return (local 'filter-buffer-substring-function)
  1995. #'substring-no-properties))
  1996. (unless org-agenda-keep-modes
  1997. (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
  1998. org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
  1999. org-agenda-show-log org-agenda-start-with-log-mode
  2000. org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode))
  2001. (add-to-invisibility-spec '(org-filtered))
  2002. (add-to-invisibility-spec '(org-link))
  2003. (easy-menu-change
  2004. '("Agenda") "Agenda Files"
  2005. (append
  2006. (list
  2007. (vector
  2008. (if (get 'org-agenda-files 'org-restrict)
  2009. "Restricted to single file"
  2010. "Edit File List")
  2011. '(org-edit-agenda-file-list)
  2012. (not (get 'org-agenda-files 'org-restrict)))
  2013. "--")
  2014. (mapcar 'org-file-menu-entry (org-agenda-files))))
  2015. (org-agenda-set-mode-name)
  2016. (apply
  2017. (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
  2018. (list 'org-agenda-mode-hook)))
  2019. (substitute-key-definition 'undo 'org-agenda-undo
  2020. org-agenda-mode-map global-map)
  2021. (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
  2022. (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
  2023. (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
  2024. (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
  2025. (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
  2026. (org-defkey org-agenda-mode-map [(meta down)] 'org-agenda-drag-line-forward)
  2027. (org-defkey org-agenda-mode-map [(meta up)] 'org-agenda-drag-line-backward)
  2028. (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
  2029. (org-defkey org-agenda-mode-map "\M-m" 'org-agenda-bulk-toggle)
  2030. (org-defkey org-agenda-mode-map "*" 'org-agenda-bulk-mark-all)
  2031. (org-defkey org-agenda-mode-map "\M-*" 'org-agenda-bulk-toggle-all)
  2032. (org-defkey org-agenda-mode-map "#" 'org-agenda-dim-blocked-tasks)
  2033. (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
  2034. (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
  2035. (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-unmark-all)
  2036. (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
  2037. (org-defkey org-agenda-mode-map "k" 'org-agenda-capture)
  2038. (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
  2039. (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
  2040. (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
  2041. (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
  2042. (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
  2043. (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
  2044. (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
  2045. (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
  2046. (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
  2047. (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
  2048. (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
  2049. (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
  2050. (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
  2051. (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
  2052. (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
  2053. (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
  2054. (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
  2055. (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
  2056. (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
  2057. (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
  2058. (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
  2059. (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
  2060. (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
  2061. (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
  2062. (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
  2063. (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
  2064. (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
  2065. (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
  2066. (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
  2067. (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
  2068. (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
  2069. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
  2070. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
  2071. (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
  2072. (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
  2073. (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
  2074. (let ((l '(1 2 3 4 5 6 7 8 9 0)))
  2075. (while l (org-defkey org-agenda-mode-map
  2076. (int-to-string (pop l)) 'digit-argument)))
  2077. (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
  2078. (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
  2079. (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
  2080. (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
  2081. (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
  2082. (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
  2083. (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
  2084. (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
  2085. (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
  2086. (org-defkey org-agenda-mode-map "g" 'org-agenda-redo-all)
  2087. (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
  2088. (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
  2089. (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
  2090. 'org-clock-modify-effort-estimate)
  2091. (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
  2092. (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
  2093. (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
  2094. (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
  2095. (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
  2096. (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
  2097. (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
  2098. (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
  2099. (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
  2100. (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
  2101. (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
  2102. (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
  2103. (substitute-key-definition 'next-line 'org-agenda-next-line
  2104. org-agenda-mode-map global-map)
  2105. (substitute-key-definition 'previous-line 'org-agenda-previous-line
  2106. org-agenda-mode-map global-map)
  2107. (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
  2108. (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
  2109. (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
  2110. (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
  2111. (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
  2112. (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
  2113. (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
  2114. (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
  2115. (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
  2116. (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
  2117. (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
  2118. (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
  2119. (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
  2120. (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
  2121. (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
  2122. (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
  2123. (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
  2124. (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
  2125. (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  2126. (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
  2127. (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
  2128. (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
  2129. (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
  2130. (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
  2131. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
  2132. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
  2133. (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
  2134. (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
  2135. (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
  2136. (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  2137. (org-defkey org-agenda-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock-from-agenda)
  2138. (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
  2139. (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
  2140. (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
  2141. (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
  2142. (org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag)
  2143. (org-defkey org-agenda-mode-map "_" 'org-agenda-filter-by-effort)
  2144. (org-defkey org-agenda-mode-map "=" 'org-agenda-filter-by-regexp)
  2145. (org-defkey org-agenda-mode-map "/" 'org-agenda-filter)
  2146. (org-defkey org-agenda-mode-map "|" 'org-agenda-filter-remove-all)
  2147. (org-defkey org-agenda-mode-map "~" 'org-agenda-limit-interactively)
  2148. (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
  2149. (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-headline)
  2150. (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
  2151. (org-defkey org-agenda-mode-map "\C-c\C-x_" 'org-timer-stop)
  2152. (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
  2153. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  2154. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  2155. (org-defkey org-agenda-mode-map "\C-c\C-xI" 'org-info-find-node)
  2156. (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
  2157. (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
  2158. (define-key org-agenda-mode-map [remap forward-paragraph] 'org-agenda-forward-block)
  2159. (define-key org-agenda-mode-map [remap backward-paragraph] 'org-agenda-backward-block)
  2160. (when org-agenda-mouse-1-follows-link
  2161. (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
  2162. (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
  2163. '("Agenda"
  2164. ("Agenda Files")
  2165. "--"
  2166. ("Agenda Dates"
  2167. ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda)]
  2168. ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
  2169. ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
  2170. ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
  2171. "--"
  2172. ("View"
  2173. ["Day View" org-agenda-day-view
  2174. :active (org-agenda-check-type nil 'agenda)
  2175. :style radio :selected (eq org-agenda-current-span 'day)
  2176. :keys "v d (or just d)"]
  2177. ["Week View" org-agenda-week-view
  2178. :active (org-agenda-check-type nil 'agenda)
  2179. :style radio :selected (eq org-agenda-current-span 'week)
  2180. :keys "v w"]
  2181. ["Fortnight View" org-agenda-fortnight-view
  2182. :active (org-agenda-check-type nil 'agenda)
  2183. :style radio :selected (eq org-agenda-current-span 'fortnight)
  2184. :keys "v t"]
  2185. ["Month View" org-agenda-month-view
  2186. :active (org-agenda-check-type nil 'agenda)
  2187. :style radio :selected (eq org-agenda-current-span 'month)
  2188. :keys "v m"]
  2189. ["Year View" org-agenda-year-view
  2190. :active (org-agenda-check-type nil 'agenda)
  2191. :style radio :selected (eq org-agenda-current-span 'year)
  2192. :keys "v y"]
  2193. "--"
  2194. ["Include Diary" org-agenda-toggle-diary
  2195. :style toggle :selected org-agenda-include-diary
  2196. :active (org-agenda-check-type nil 'agenda)]
  2197. ["Include Deadlines" org-agenda-toggle-deadlines
  2198. :style toggle :selected org-agenda-include-deadlines
  2199. :active (org-agenda-check-type nil 'agenda)]
  2200. ["Use Time Grid" org-agenda-toggle-time-grid
  2201. :style toggle :selected org-agenda-use-time-grid
  2202. :active (org-agenda-check-type nil 'agenda)]
  2203. "--"
  2204. ["Show clock report" org-agenda-clockreport-mode
  2205. :style toggle :selected org-agenda-clockreport-mode
  2206. :active (org-agenda-check-type nil 'agenda)]
  2207. ["Show some entry text" org-agenda-entry-text-mode
  2208. :style toggle :selected org-agenda-entry-text-mode
  2209. :active t]
  2210. "--"
  2211. ["Show Logbook entries" org-agenda-log-mode
  2212. :style toggle :selected org-agenda-show-log
  2213. :active (org-agenda-check-type nil 'agenda)
  2214. :keys "v l (or just l)"]
  2215. ["Include archived trees" org-agenda-archives-mode
  2216. :style toggle :selected org-agenda-archives-mode :active t
  2217. :keys "v a"]
  2218. ["Include archive files" (org-agenda-archives-mode t)
  2219. :style toggle :selected (eq org-agenda-archives-mode t) :active t
  2220. :keys "v A"]
  2221. "--"
  2222. ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
  2223. ("Filter current view"
  2224. ["with generic interface" org-agenda-filter t]
  2225. "--"
  2226. ["by category at cursor" org-agenda-filter-by-category t]
  2227. ["by tag" org-agenda-filter-by-tag t]
  2228. ["by effort" org-agenda-filter-by-effort t]
  2229. ["by regexp" org-agenda-filter-by-regexp t]
  2230. ["by top-level headline" org-agenda-filter-by-top-headline t]
  2231. "--"
  2232. ["Remove all filtering" org-agenda-filter-remove-all t]
  2233. "--"
  2234. ["limit" org-agenda-limit-interactively t])
  2235. ["Rebuild buffer" org-agenda-redo t]
  2236. ["Write view to file" org-agenda-write t]
  2237. ["Save all Org buffers" org-save-all-org-buffers t]
  2238. "--"
  2239. ["Show original entry" org-agenda-show t]
  2240. ["Go To (other window)" org-agenda-goto t]
  2241. ["Go To (this window)" org-agenda-switch-to t]
  2242. ["Capture with cursor date" org-agenda-capture t]
  2243. ["Follow Mode" org-agenda-follow-mode
  2244. :style toggle :selected org-agenda-follow-mode :active t]
  2245. ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
  2246. "--"
  2247. ("TODO"
  2248. ["Cycle TODO" org-agenda-todo t]
  2249. ["Next TODO set" org-agenda-todo-nextset t]
  2250. ["Previous TODO set" org-agenda-todo-previousset t]
  2251. ["Add note" org-agenda-add-note t])
  2252. ("Archive/Refile/Delete"
  2253. ["Archive default" org-agenda-archive-default t]
  2254. ["Archive default" org-agenda-archive-default-with-confirmation t]
  2255. ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
  2256. ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
  2257. ["Archive subtree" org-agenda-archive t]
  2258. "--"
  2259. ["Refile" org-agenda-refile t]
  2260. "--"
  2261. ["Delete subtree" org-agenda-kill t])
  2262. ("Bulk action"
  2263. ["Mark entry" org-agenda-bulk-mark t]
  2264. ["Mark all" org-agenda-bulk-mark-all t]
  2265. ["Unmark entry" org-agenda-bulk-unmark t]
  2266. ["Unmark all" org-agenda-bulk-unmark-all :active t :keys "U"]
  2267. ["Toggle mark" org-agenda-bulk-toggle t]
  2268. ["Toggle all" org-agenda-bulk-toggle-all t]
  2269. ["Mark regexp" org-agenda-bulk-mark-regexp t])
  2270. ["Act on all marked" org-agenda-bulk-action t]
  2271. "--"
  2272. ("Tags and Properties"
  2273. ["Show all Tags" org-agenda-show-tags t]
  2274. ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
  2275. ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
  2276. "--"
  2277. ["Column View" org-columns t])
  2278. ("Deadline/Schedule"
  2279. ["Schedule" org-agenda-schedule t]
  2280. ["Set Deadline" org-agenda-deadline t]
  2281. "--"
  2282. ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda)]
  2283. ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda)]
  2284. ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda) :keys "C-u S-right"]
  2285. ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda) :keys "C-u S-left"]
  2286. ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda) :keys "C-u C-u S-right"]
  2287. ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda) :keys "C-u C-u S-left"]
  2288. ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda)])
  2289. ("Clock and Effort"
  2290. ["Clock in" org-agenda-clock-in t]
  2291. ["Clock out" org-agenda-clock-out t]
  2292. ["Clock cancel" org-agenda-clock-cancel t]
  2293. ["Goto running clock" org-clock-goto t]
  2294. "--"
  2295. ["Set Effort" org-agenda-set-effort t]
  2296. ["Change clocked effort" org-clock-modify-effort-estimate
  2297. (org-clock-is-active)])
  2298. ("Priority"
  2299. ["Set Priority" org-agenda-priority t]
  2300. ["Increase Priority" org-agenda-priority-up t]
  2301. ["Decrease Priority" org-agenda-priority-down t]
  2302. ["Show Priority" org-show-priority t])
  2303. ("Calendar/Diary"
  2304. ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda)]
  2305. ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda)]
  2306. ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda)]
  2307. ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda)]
  2308. ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda)]
  2309. ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda)]
  2310. "--"
  2311. ["Create iCalendar File" org-icalendar-combine-agenda-files t])
  2312. "--"
  2313. ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
  2314. "--"
  2315. ("MobileOrg"
  2316. ["Push Files and Views" org-mobile-push t]
  2317. ["Get Captured and Flagged" org-mobile-pull t]
  2318. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "\\[org-agenda] ?"]
  2319. ["Show note / unflag" org-agenda-show-the-flagging-note t]
  2320. "--"
  2321. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  2322. "--"
  2323. ["Quit" org-agenda-quit t]
  2324. ["Exit and Release Buffers" org-agenda-exit t]
  2325. ))
  2326. ;;; Agenda undo
  2327. (defvar org-agenda-allow-remote-undo t
  2328. "Non-nil means allow remote undo from the agenda buffer.")
  2329. (defvar org-agenda-undo-has-started-in nil
  2330. "Buffers that have already seen `undo-start' in the current undo sequence.")
  2331. (defun org-agenda-undo ()
  2332. "Undo a remote editing step in the agenda.
  2333. This undoes changes both in the agenda buffer and in the remote buffer
  2334. that have been changed along."
  2335. (interactive)
  2336. (or org-agenda-allow-remote-undo
  2337. (user-error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
  2338. (when (not (eq this-command last-command))
  2339. (setq org-agenda-undo-has-started-in nil
  2340. org-agenda-pending-undo-list org-agenda-undo-list))
  2341. (when (not org-agenda-pending-undo-list)
  2342. (user-error "No further undo information"))
  2343. (let* ((entry (pop org-agenda-pending-undo-list))
  2344. buf line cmd rembuf)
  2345. (setq cmd (pop entry) line (pop entry))
  2346. (setq rembuf (nth 2 entry))
  2347. (org-with-remote-undo rembuf
  2348. (while (bufferp (setq buf (pop entry)))
  2349. (when (pop entry)
  2350. (with-current-buffer buf
  2351. (let ((last-undo-buffer buf)
  2352. (inhibit-read-only t))
  2353. (unless (memq buf org-agenda-undo-has-started-in)
  2354. (push buf org-agenda-undo-has-started-in)
  2355. (make-local-variable 'pending-undo-list)
  2356. (undo-start))
  2357. (while (and pending-undo-list
  2358. (listp pending-undo-list)
  2359. (not (car pending-undo-list)))
  2360. (pop pending-undo-list))
  2361. (undo-more 1))))))
  2362. (org-goto-line line)
  2363. (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
  2364. (defun org-verify-change-for-undo (l1 l2)
  2365. "Verify that a real change occurred between the undo lists L1 and L2."
  2366. (while (and l1 (listp l1) (null (car l1))) (pop l1))
  2367. (while (and l2 (listp l2) (null (car l2))) (pop l2))
  2368. (not (eq l1 l2)))
  2369. ;;; Agenda dispatch
  2370. (defvar org-agenda-restrict-begin (make-marker))
  2371. (defvar org-agenda-restrict-end (make-marker))
  2372. (defvar org-agenda-last-dispatch-buffer nil)
  2373. (defvar org-agenda-overriding-restriction nil)
  2374. (defcustom org-agenda-custom-commands-contexts nil
  2375. "Alist of custom agenda keys and contextual rules.
  2376. For example, if you have a custom agenda command \"p\" and you
  2377. want this command to be accessible only from plain text files,
  2378. use this:
  2379. \\='((\"p\" ((in-file . \"\\\\.txt\\\\'\"))))
  2380. Here are the available contexts definitions:
  2381. in-file: command displayed only in matching files
  2382. in-mode: command displayed only in matching modes
  2383. not-in-file: command not displayed in matching files
  2384. not-in-mode: command not displayed in matching modes
  2385. in-buffer: command displayed only in matching buffers
  2386. not-in-buffer: command not displayed in matching buffers
  2387. [function]: a custom function taking no argument
  2388. If you define several checks, the agenda command will be
  2389. accessible if there is at least one valid check.
  2390. You can also bind a key to another agenda custom command
  2391. depending on contextual rules.
  2392. \\='((\"p\" \"q\" ((in-file . \"\\\\.txt\\\\'\"))))
  2393. Here it means: in .txt files, use \"p\" as the key for the
  2394. agenda command otherwise associated with \"q\". (The command
  2395. originally associated with \"q\" is not displayed to avoid
  2396. duplicates.)"
  2397. :version "24.3"
  2398. :group 'org-agenda-custom-commands
  2399. :type '(repeat (list :tag "Rule"
  2400. (string :tag " Agenda key")
  2401. (string :tag "Replace by command")
  2402. (repeat :tag "Available when"
  2403. (choice
  2404. (cons :tag "Condition"
  2405. (choice
  2406. (const :tag "In file" in-file)
  2407. (const :tag "Not in file" not-in-file)
  2408. (const :tag "In buffer" in-buffer)
  2409. (const :tag "Not in buffer" not-in-buffer)
  2410. (const :tag "In mode" in-mode)
  2411. (const :tag "Not in mode" not-in-mode))
  2412. (regexp))
  2413. (function :tag "Custom function"))))))
  2414. (defcustom org-agenda-max-entries nil
  2415. "Maximum number of entries to display in an agenda.
  2416. This can be nil (no limit) or an integer or an alist of agenda
  2417. types with an associated number of entries to display in this
  2418. type."
  2419. :version "24.4"
  2420. :package-version '(Org . "8.0")
  2421. :group 'org-agenda-custom-commands
  2422. :type '(choice (symbol :tag "No limit" nil)
  2423. (integer :tag "Max number of entries")
  2424. (repeat
  2425. (cons (choice :tag "Agenda type"
  2426. (const agenda)
  2427. (const todo)
  2428. (const tags)
  2429. (const search))
  2430. (integer :tag "Max number of entries")))))
  2431. (defcustom org-agenda-max-todos nil
  2432. "Maximum number of TODOs to display in an agenda.
  2433. This can be nil (no limit) or an integer or an alist of agenda
  2434. types with an associated number of entries to display in this
  2435. type."
  2436. :version "24.4"
  2437. :package-version '(Org . "8.0")
  2438. :group 'org-agenda-custom-commands
  2439. :type '(choice (symbol :tag "No limit" nil)
  2440. (integer :tag "Max number of TODOs")
  2441. (repeat
  2442. (cons (choice :tag "Agenda type"
  2443. (const agenda)
  2444. (const todo)
  2445. (const tags)
  2446. (const search))
  2447. (integer :tag "Max number of TODOs")))))
  2448. (defcustom org-agenda-max-tags nil
  2449. "Maximum number of tagged entries to display in an agenda.
  2450. This can be nil (no limit) or an integer or an alist of agenda
  2451. types with an associated number of entries to display in this
  2452. type."
  2453. :version "24.4"
  2454. :package-version '(Org . "8.0")
  2455. :group 'org-agenda-custom-commands
  2456. :type '(choice (symbol :tag "No limit" nil)
  2457. (integer :tag "Max number of tagged entries")
  2458. (repeat
  2459. (cons (choice :tag "Agenda type"
  2460. (const agenda)
  2461. (const todo)
  2462. (const tags)
  2463. (const search))
  2464. (integer :tag "Max number of tagged entries")))))
  2465. (defcustom org-agenda-max-effort nil
  2466. "Maximum cumulated effort duration for the agenda.
  2467. This can be nil (no limit) or a number of minutes (as an integer)
  2468. or an alist of agenda types with an associated number of minutes
  2469. to limit entries to in this type."
  2470. :version "24.4"
  2471. :package-version '(Org . "8.0")
  2472. :group 'org-agenda-custom-commands
  2473. :type '(choice (symbol :tag "No limit" nil)
  2474. (integer :tag "Max number of minutes")
  2475. (repeat
  2476. (cons (choice :tag "Agenda type"
  2477. (const agenda)
  2478. (const todo)
  2479. (const tags)
  2480. (const search))
  2481. (integer :tag "Max number of minutes")))))
  2482. (defvar org-agenda-keep-restricted-file-list nil)
  2483. (defvar org-keys nil)
  2484. (defvar org-match nil)
  2485. ;;;###autoload
  2486. (defun org-agenda (&optional arg org-keys restriction)
  2487. "Dispatch agenda commands to collect entries to the agenda buffer.
  2488. Prompts for a command to execute. Any prefix arg will be passed
  2489. on to the selected command. The default selections are:
  2490. a Call `org-agenda-list' to display the agenda for current day or week.
  2491. t Call `org-todo-list' to display the global todo list.
  2492. T Call `org-todo-list' to display the global todo list, select only
  2493. entries with a specific TODO keyword (the user gets a prompt).
  2494. m Call `org-tags-view' to display headlines with tags matching
  2495. a condition (the user is prompted for the condition).
  2496. M Like `m', but select only TODO entries, no ordinary headlines.
  2497. e Export views to associated files.
  2498. s Search entries for keywords.
  2499. S Search entries for keywords, only with TODO keywords.
  2500. / Multi occur across all agenda files and also files listed
  2501. in `org-agenda-text-search-extra-files'.
  2502. < Restrict agenda commands to buffer, subtree, or region.
  2503. Press several times to get the desired effect.
  2504. > Remove a previous restriction.
  2505. # List \"stuck\" projects.
  2506. ! Configure what \"stuck\" means.
  2507. C Configure custom agenda commands.
  2508. More commands can be added by configuring the variable
  2509. `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
  2510. searches can be pre-defined in this way.
  2511. If the current buffer is in Org mode and visiting a file, you can also
  2512. first press `<' once to indicate that the agenda should be temporarily
  2513. \(until the next use of `\\[org-agenda]') restricted to the current file.
  2514. Pressing `<' twice means to restrict to the current subtree or region
  2515. \(if active)."
  2516. (interactive "P")
  2517. (catch 'exit
  2518. (let* ((prefix-descriptions nil)
  2519. (org-agenda-buffer-name org-agenda-buffer-name)
  2520. (org-agenda-window-setup (if (equal (buffer-name)
  2521. org-agenda-buffer-name)
  2522. 'current-window
  2523. org-agenda-window-setup))
  2524. (org-agenda-custom-commands-orig org-agenda-custom-commands)
  2525. (org-agenda-custom-commands
  2526. ;; normalize different versions
  2527. (delq nil
  2528. (mapcar
  2529. (lambda (x)
  2530. (cond ((stringp (cdr x))
  2531. (push x prefix-descriptions)
  2532. nil)
  2533. ((stringp (nth 1 x)) x)
  2534. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2535. (t (cons (car x) (cons "" (cdr x))))))
  2536. org-agenda-custom-commands)))
  2537. (org-agenda-custom-commands
  2538. (org-contextualize-keys
  2539. org-agenda-custom-commands org-agenda-custom-commands-contexts))
  2540. (buf (current-buffer))
  2541. (bfn (buffer-file-name (buffer-base-buffer)))
  2542. entry key type org-match lprops ans)
  2543. ;; Turn off restriction unless there is an overriding one,
  2544. (unless org-agenda-overriding-restriction
  2545. (unless org-agenda-keep-restricted-file-list
  2546. ;; There is a request to keep the file list in place
  2547. (put 'org-agenda-files 'org-restrict nil))
  2548. (setq org-agenda-restrict nil)
  2549. (move-marker org-agenda-restrict-begin nil)
  2550. (move-marker org-agenda-restrict-end nil))
  2551. ;; Delete old local properties
  2552. (put 'org-agenda-redo-command 'org-lprops nil)
  2553. ;; Delete previously set last-arguments
  2554. (put 'org-agenda-redo-command 'last-args nil)
  2555. ;; Remember where this call originated
  2556. (setq org-agenda-last-dispatch-buffer (current-buffer))
  2557. (unless org-keys
  2558. (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
  2559. org-keys (car ans)
  2560. restriction (cdr ans)))
  2561. ;; If we have sticky agenda buffers, set a name for the buffer,
  2562. ;; depending on the invoking keys. The user may still set this
  2563. ;; as a command option, which will overwrite what we do here.
  2564. (when org-agenda-sticky
  2565. (setq org-agenda-buffer-name
  2566. (format "*Org Agenda(%s)*" org-keys)))
  2567. ;; Establish the restriction, if any
  2568. (when (and (not org-agenda-overriding-restriction) restriction)
  2569. (put 'org-agenda-files 'org-restrict (list bfn))
  2570. (cond
  2571. ((eq restriction 'region)
  2572. (setq org-agenda-restrict (current-buffer))
  2573. (move-marker org-agenda-restrict-begin (region-beginning))
  2574. (move-marker org-agenda-restrict-end (region-end)))
  2575. ((eq restriction 'subtree)
  2576. (save-excursion
  2577. (setq org-agenda-restrict (current-buffer))
  2578. (org-back-to-heading t)
  2579. (move-marker org-agenda-restrict-begin (point))
  2580. (move-marker org-agenda-restrict-end
  2581. (progn (org-end-of-subtree t)))))
  2582. ((and (eq restriction 'buffer)
  2583. (or (< 1 (point-min))
  2584. (< (point-max) (1+ (buffer-size)))))
  2585. (setq org-agenda-restrict (current-buffer))
  2586. (move-marker org-agenda-restrict-begin (point-min))
  2587. (move-marker org-agenda-restrict-end (point-max)))))
  2588. ;; For example the todo list should not need it (but does...)
  2589. (cond
  2590. ((setq entry (assoc org-keys org-agenda-custom-commands))
  2591. (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
  2592. (progn
  2593. (setq type (nth 2 entry) org-match (eval (nth 3 entry))
  2594. lprops (nth 4 entry))
  2595. (when org-agenda-sticky
  2596. (setq org-agenda-buffer-name
  2597. (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
  2598. (format "*Org Agenda(%s)*" org-keys))))
  2599. (put 'org-agenda-redo-command 'org-lprops lprops)
  2600. (cond
  2601. ((eq type 'agenda)
  2602. (org-let lprops '(org-agenda-list current-prefix-arg)))
  2603. ((eq type 'agenda*)
  2604. (org-let lprops '(org-agenda-list current-prefix-arg nil nil t)))
  2605. ((eq type 'alltodo)
  2606. (org-let lprops '(org-todo-list current-prefix-arg)))
  2607. ((eq type 'search)
  2608. (org-let lprops '(org-search-view current-prefix-arg org-match nil)))
  2609. ((eq type 'stuck)
  2610. (org-let lprops '(org-agenda-list-stuck-projects
  2611. current-prefix-arg)))
  2612. ((eq type 'tags)
  2613. (org-let lprops '(org-tags-view current-prefix-arg org-match)))
  2614. ((eq type 'tags-todo)
  2615. (org-let lprops '(org-tags-view '(4) org-match)))
  2616. ((eq type 'todo)
  2617. (org-let lprops '(org-todo-list org-match)))
  2618. ((eq type 'tags-tree)
  2619. (org-check-for-org-mode)
  2620. (org-let lprops '(org-match-sparse-tree current-prefix-arg org-match)))
  2621. ((eq type 'todo-tree)
  2622. (org-check-for-org-mode)
  2623. (org-let lprops
  2624. '(org-occur (concat "^" org-outline-regexp "[ \t]*"
  2625. (regexp-quote org-match) "\\>"))))
  2626. ((eq type 'occur-tree)
  2627. (org-check-for-org-mode)
  2628. (org-let lprops '(org-occur org-match)))
  2629. ((functionp type)
  2630. (org-let lprops '(funcall type org-match)))
  2631. ((fboundp type)
  2632. (org-let lprops '(funcall type org-match)))
  2633. (t (user-error "Invalid custom agenda command type %s" type))))
  2634. (org-agenda-run-series (nth 1 entry) (cddr entry))))
  2635. ((equal org-keys "C")
  2636. (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
  2637. (customize-variable 'org-agenda-custom-commands))
  2638. ((equal org-keys "a") (call-interactively 'org-agenda-list))
  2639. ((equal org-keys "s") (call-interactively 'org-search-view))
  2640. ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
  2641. ((equal org-keys "t") (call-interactively 'org-todo-list))
  2642. ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
  2643. ((equal org-keys "m") (call-interactively 'org-tags-view))
  2644. ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
  2645. ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
  2646. ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
  2647. (add-hook
  2648. 'post-command-hook
  2649. (lambda ()
  2650. (unless (current-message)
  2651. (let* ((m (org-agenda-get-any-marker))
  2652. (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
  2653. (when note
  2654. (message "FLAGGING-NOTE ([?] for more info): %s"
  2655. (org-add-props
  2656. (replace-regexp-in-string
  2657. "\\\\n" "//"
  2658. (copy-sequence note))
  2659. nil 'face 'org-warning))))))
  2660. t t))
  2661. ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
  2662. ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
  2663. ((equal org-keys "!") (customize-variable 'org-stuck-projects))
  2664. (t (user-error "Invalid agenda key"))))))
  2665. (defvar org-agenda-multi)
  2666. (defun org-agenda-append-agenda ()
  2667. "Append another agenda view to the current one.
  2668. This function allows interactive building of block agendas.
  2669. Agenda views are separated by `org-agenda-block-separator'."
  2670. (interactive)
  2671. (unless (derived-mode-p 'org-agenda-mode)
  2672. (user-error "Can only append from within agenda buffer"))
  2673. (let ((org-agenda-multi t))
  2674. (org-agenda)
  2675. (widen)
  2676. (org-agenda-finalize)
  2677. (setq buffer-read-only t)
  2678. (org-agenda-fit-window-to-buffer)))
  2679. (defun org-agenda-normalize-custom-commands (cmds)
  2680. "Normalize custom commands CMDS."
  2681. (delq nil
  2682. (mapcar
  2683. (lambda (x)
  2684. (cond ((stringp (cdr x)) nil)
  2685. ((stringp (nth 1 x)) x)
  2686. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2687. (t (cons (car x) (cons "" (cdr x))))))
  2688. cmds)))
  2689. (defun org-agenda-get-restriction-and-command (prefix-descriptions)
  2690. "The user interface for selecting an agenda command."
  2691. (catch 'exit
  2692. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  2693. (restrict-ok (and bfn (derived-mode-p 'org-mode)))
  2694. (region-p (org-region-active-p))
  2695. (custom org-agenda-custom-commands)
  2696. (selstring "")
  2697. restriction second-time
  2698. c entry key type match prefixes rmheader header-end custom1 desc
  2699. line lines left right n n1)
  2700. (save-window-excursion
  2701. (delete-other-windows)
  2702. (org-switch-to-buffer-other-window " *Agenda Commands*")
  2703. (erase-buffer)
  2704. (insert (eval-when-compile
  2705. (let ((header
  2706. "Press key for an agenda command:
  2707. -------------------------------- < Buffer, subtree/region restriction
  2708. a Agenda for current week or day > Remove restriction
  2709. t List of all TODO entries e Export agenda views
  2710. m Match a TAGS/PROP/TODO query T Entries with special TODO kwd
  2711. s Search for keywords M Like m, but only TODO entries
  2712. / Multi-occur S Like s, but only TODO entries
  2713. ? Find :FLAGGED: entries C Configure custom agenda commands
  2714. * Toggle sticky agenda views # List stuck projects (!=configure)
  2715. ")
  2716. (start 0))
  2717. (while (string-match
  2718. "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
  2719. header start)
  2720. (setq start (match-end 0))
  2721. (add-text-properties (match-beginning 2) (match-end 2)
  2722. '(face bold) header))
  2723. header)))
  2724. (setq header-end (point-marker))
  2725. (while t
  2726. (setq custom1 custom)
  2727. (when (eq rmheader t)
  2728. (org-goto-line 1)
  2729. (re-search-forward ":" nil t)
  2730. (delete-region (match-end 0) (point-at-eol))
  2731. (forward-char 1)
  2732. (looking-at "-+")
  2733. (delete-region (match-end 0) (point-at-eol))
  2734. (move-marker header-end (match-end 0)))
  2735. (goto-char header-end)
  2736. (delete-region (point) (point-max))
  2737. ;; Produce all the lines that describe custom commands and prefixes
  2738. (setq lines nil)
  2739. (while (setq entry (pop custom1))
  2740. (setq key (car entry) desc (nth 1 entry)
  2741. type (nth 2 entry)
  2742. match (nth 3 entry))
  2743. (if (> (length key) 1)
  2744. (cl-pushnew (string-to-char key) prefixes :test #'equal)
  2745. (setq line
  2746. (format
  2747. "%-4s%-14s"
  2748. (org-add-props (copy-sequence key)
  2749. '(face bold))
  2750. (cond
  2751. ((string-match "\\S-" desc) desc)
  2752. ((eq type 'agenda) "Agenda for current week or day")
  2753. ((eq type 'agenda*) "Appointments for current week or day")
  2754. ((eq type 'alltodo) "List of all TODO entries")
  2755. ((eq type 'search) "Word search")
  2756. ((eq type 'stuck) "List of stuck projects")
  2757. ((eq type 'todo) "TODO keyword")
  2758. ((eq type 'tags) "Tags query")
  2759. ((eq type 'tags-todo) "Tags (TODO)")
  2760. ((eq type 'tags-tree) "Tags tree")
  2761. ((eq type 'todo-tree) "TODO kwd tree")
  2762. ((eq type 'occur-tree) "Occur tree")
  2763. ((functionp type) (if (symbolp type)
  2764. (symbol-name type)
  2765. "Lambda expression"))
  2766. (t "???"))))
  2767. (cond
  2768. ((not (org-string-nw-p match)) nil)
  2769. (org-agenda-menu-show-matcher
  2770. (setq line
  2771. (concat line ": "
  2772. (cond
  2773. ((stringp match)
  2774. (propertize match 'face 'org-warning))
  2775. ((listp type)
  2776. (format "set of %d commands" (length type)))))))
  2777. (t
  2778. (org-add-props line nil 'help-echo (concat "Matcher: " match))))
  2779. (push line lines)))
  2780. (setq lines (nreverse lines))
  2781. (when prefixes
  2782. (mapc (lambda (x)
  2783. (push
  2784. (format "%s %s"
  2785. (org-add-props (char-to-string x)
  2786. nil 'face 'bold)
  2787. (or (cdr (assoc (concat selstring
  2788. (char-to-string x))
  2789. prefix-descriptions))
  2790. "Prefix key"))
  2791. lines))
  2792. prefixes))
  2793. ;; Check if we should display in two columns
  2794. (if org-agenda-menu-two-columns
  2795. (progn
  2796. (setq n (length lines)
  2797. n1 (+ (/ n 2) (mod n 2))
  2798. right (nthcdr n1 lines)
  2799. left (copy-sequence lines))
  2800. (setcdr (nthcdr (1- n1) left) nil))
  2801. (setq left lines right nil))
  2802. (while left
  2803. (insert "\n" (pop left))
  2804. (when right
  2805. (if (< (current-column) 40)
  2806. (move-to-column 40 t)
  2807. (insert " "))
  2808. (insert (pop right))))
  2809. ;; Make the window the right size
  2810. (goto-char (point-min))
  2811. (if second-time
  2812. (when (not (pos-visible-in-window-p (point-max)))
  2813. (org-fit-window-to-buffer))
  2814. (setq second-time t)
  2815. (org-fit-window-to-buffer))
  2816. ;; Hint to navigation if window too small for all information
  2817. (setq header-line-format
  2818. (when (not (pos-visible-in-window-p (point-max)))
  2819. "Use SPC, DEL, C-n or C-p to navigate."))
  2820. ;; Ask for selection
  2821. (cl-loop
  2822. do (progn
  2823. (message "Press key for agenda command%s:"
  2824. (if (or restrict-ok org-agenda-overriding-restriction)
  2825. (if org-agenda-overriding-restriction
  2826. " (restriction lock active)"
  2827. (if restriction
  2828. (format " (restricted to %s)" restriction)
  2829. " (unrestricted)"))
  2830. ""))
  2831. (setq c (read-char-exclusive)))
  2832. until (not (memq c '(14 16 ?\s ?\d)))
  2833. do (cl-case c
  2834. (14 (if (not (pos-visible-in-window-p (point-max)))
  2835. (ignore-errors (scroll-up 1))
  2836. (message "End of buffer")
  2837. (sit-for 1)))
  2838. (16 (if (not (pos-visible-in-window-p (point-min)))
  2839. (ignore-errors (scroll-down 1))
  2840. (message "Beginning of buffer")
  2841. (sit-for 1)))
  2842. (?\s (if (not (pos-visible-in-window-p (point-max)))
  2843. (scroll-up nil)
  2844. (message "End of buffer")
  2845. (sit-for 1)))
  2846. (?\d (if (not (pos-visible-in-window-p (point-min)))
  2847. (scroll-down nil)
  2848. (message "Beginning of buffer")
  2849. (sit-for 1)))))
  2850. (message "")
  2851. (cond
  2852. ((assoc (char-to-string c) custom)
  2853. (setq selstring (concat selstring (char-to-string c)))
  2854. (throw 'exit (cons selstring restriction)))
  2855. ((memq c prefixes)
  2856. (setq selstring (concat selstring (char-to-string c))
  2857. prefixes nil
  2858. rmheader (or rmheader t)
  2859. custom (delq nil (mapcar
  2860. (lambda (x)
  2861. (if (or (= (length (car x)) 1)
  2862. (/= (string-to-char (car x)) c))
  2863. nil
  2864. (cons (substring (car x) 1) (cdr x))))
  2865. custom))))
  2866. ((eq c ?*)
  2867. (call-interactively 'org-toggle-sticky-agenda)
  2868. (sit-for 2))
  2869. ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
  2870. (message "Restriction is only possible in Org buffers")
  2871. (ding) (sit-for 1))
  2872. ((eq c ?1)
  2873. (org-agenda-remove-restriction-lock 'noupdate)
  2874. (setq restriction 'buffer))
  2875. ((eq c ?0)
  2876. (org-agenda-remove-restriction-lock 'noupdate)
  2877. (setq restriction (if region-p 'region 'subtree)))
  2878. ((eq c ?<)
  2879. (org-agenda-remove-restriction-lock 'noupdate)
  2880. (setq restriction
  2881. (cond
  2882. ((eq restriction 'buffer)
  2883. (if region-p 'region 'subtree))
  2884. ((memq restriction '(subtree region))
  2885. nil)
  2886. (t 'buffer))))
  2887. ((eq c ?>)
  2888. (org-agenda-remove-restriction-lock 'noupdate)
  2889. (setq restriction nil))
  2890. ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
  2891. (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
  2892. ((and (> (length selstring) 0) (eq c ?\d))
  2893. (delete-window)
  2894. (org-agenda-get-restriction-and-command prefix-descriptions))
  2895. ((equal c ?q) (error "Abort"))
  2896. (t (user-error "Invalid key %c" c))))))))
  2897. (defun org-agenda-fit-window-to-buffer ()
  2898. "Fit the window to the buffer size."
  2899. (and (memq org-agenda-window-setup '(reorganize-frame))
  2900. (fboundp 'fit-window-to-buffer)
  2901. (if (and (= (cdr org-agenda-window-frame-fractions) 1.0)
  2902. (= (car org-agenda-window-frame-fractions) 1.0))
  2903. (delete-other-windows)
  2904. (org-fit-window-to-buffer
  2905. nil
  2906. (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
  2907. (floor (* (frame-height) (car org-agenda-window-frame-fractions)))))))
  2908. (defvar org-cmd nil)
  2909. (defvar org-agenda-overriding-cmd nil)
  2910. (defvar org-agenda-overriding-arguments nil)
  2911. (defvar org-agenda-overriding-cmd-arguments nil)
  2912. (defun org-agenda-run-series (name series)
  2913. "Run agenda NAME as a SERIES of agenda commands."
  2914. (org-let (nth 1 series) '(org-agenda-prepare name))
  2915. ;; We need to reset agenda markers here, because when constructing a
  2916. ;; block agenda, the individual blocks do not do that.
  2917. (org-agenda-reset-markers)
  2918. (let* ((org-agenda-multi t)
  2919. (redo (list 'org-agenda-run-series name (list 'quote series)))
  2920. (cmds (car series))
  2921. (gprops (nth 1 series))
  2922. match ;; The byte compiler incorrectly complains about this. Keep it!
  2923. org-cmd type lprops)
  2924. (while (setq org-cmd (pop cmds))
  2925. (setq type (car org-cmd))
  2926. (setq match (eval (nth 1 org-cmd)))
  2927. (setq lprops (nth 2 org-cmd))
  2928. (let ((org-agenda-overriding-arguments
  2929. (if (eq org-agenda-overriding-cmd org-cmd)
  2930. (or org-agenda-overriding-arguments
  2931. org-agenda-overriding-cmd-arguments))))
  2932. (cond
  2933. ((eq type 'agenda)
  2934. (org-let2 gprops lprops
  2935. '(call-interactively 'org-agenda-list)))
  2936. ((eq type 'agenda*)
  2937. (org-let2 gprops lprops
  2938. '(funcall 'org-agenda-list nil nil t)))
  2939. ((eq type 'alltodo)
  2940. (org-let2 gprops lprops
  2941. '(call-interactively 'org-todo-list)))
  2942. ((eq type 'search)
  2943. (org-let2 gprops lprops
  2944. '(org-search-view current-prefix-arg match nil)))
  2945. ((eq type 'stuck)
  2946. (org-let2 gprops lprops
  2947. '(call-interactively 'org-agenda-list-stuck-projects)))
  2948. ((eq type 'tags)
  2949. (org-let2 gprops lprops
  2950. '(org-tags-view current-prefix-arg match)))
  2951. ((eq type 'tags-todo)
  2952. (org-let2 gprops lprops
  2953. '(org-tags-view '(4) match)))
  2954. ((eq type 'todo)
  2955. (org-let2 gprops lprops
  2956. '(org-todo-list match)))
  2957. ((fboundp type)
  2958. (org-let2 gprops lprops
  2959. '(funcall type match)))
  2960. (t (error "Invalid type in command series")))))
  2961. (widen)
  2962. (let ((inhibit-read-only t))
  2963. (add-text-properties (point-min) (point-max)
  2964. `(org-series t org-series-redo-cmd ,redo)))
  2965. (setq org-agenda-redo-command redo)
  2966. (goto-char (point-min)))
  2967. (org-agenda-fit-window-to-buffer)
  2968. (org-let (nth 1 series) '(org-agenda-finalize)))
  2969. ;;;###autoload
  2970. (defmacro org-batch-agenda (cmd-key &rest parameters)
  2971. "Run an agenda command in batch mode and send the result to STDOUT.
  2972. If CMD-KEY is a string of length 1, it is used as a key in
  2973. `org-agenda-custom-commands' and triggers this command. If it is a
  2974. longer string it is used as a tags/todo match string.
  2975. Parameters are alternating variable names and values that will be bound
  2976. before running the agenda command."
  2977. (org-eval-in-environment (org-make-parameter-alist parameters)
  2978. (let (org-agenda-sticky)
  2979. (if (> (length cmd-key) 1)
  2980. (org-tags-view nil cmd-key)
  2981. (org-agenda nil cmd-key))))
  2982. (set-buffer org-agenda-buffer-name)
  2983. (princ (buffer-string)))
  2984. (defvar org-agenda-info nil)
  2985. ;;;###autoload
  2986. (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
  2987. "Run an agenda command in batch mode and send the result to STDOUT.
  2988. If CMD-KEY is a string of length 1, it is used as a key in
  2989. `org-agenda-custom-commands' and triggers this command. If it is a
  2990. longer string it is used as a tags/todo match string.
  2991. Parameters are alternating variable names and values that will be bound
  2992. before running the agenda command.
  2993. The output gives a line for each selected agenda item. Each
  2994. item is a list of comma-separated values, like this:
  2995. category,head,type,todo,tags,date,time,extra,priority-l,priority-n
  2996. category The category of the item
  2997. head The headline, without TODO kwd, TAGS and PRIORITY
  2998. type The type of the agenda entry, can be
  2999. todo selected in TODO match
  3000. tagsmatch selected in tags match
  3001. diary imported from diary
  3002. deadline a deadline on given date
  3003. scheduled scheduled on given date
  3004. timestamp entry has timestamp on given date
  3005. closed entry was closed on given date
  3006. upcoming-deadline warning about deadline
  3007. past-scheduled forwarded scheduled item
  3008. block entry has date block including g. date
  3009. todo The todo keyword, if any
  3010. tags All tags including inherited ones, separated by colons
  3011. date The relevant date, like 2007-2-14
  3012. time The time, like 15:00-16:50
  3013. extra String with extra planning info
  3014. priority-l The priority letter if any was given
  3015. priority-n The computed numerical priority
  3016. agenda-day The day in the agenda where this is listed"
  3017. (org-eval-in-environment (append '((org-agenda-remove-tags t))
  3018. (org-make-parameter-alist parameters))
  3019. (if (> (length cmd-key) 2)
  3020. (org-tags-view nil cmd-key)
  3021. (org-agenda nil cmd-key)))
  3022. (set-buffer org-agenda-buffer-name)
  3023. (let ((lines (org-split-string (buffer-string) "\n")))
  3024. (dolist (line lines)
  3025. (when (get-text-property 0 'org-category line)
  3026. (setq org-agenda-info
  3027. (org-fix-agenda-info (text-properties-at 0 line)))
  3028. (princ
  3029. (mapconcat 'org-agenda-export-csv-mapper
  3030. '(org-category txt type todo tags date time extra
  3031. priority-letter priority agenda-day)
  3032. ","))
  3033. (princ "\n")))))
  3034. (defun org-fix-agenda-info (props)
  3035. "Make sure all properties on an agenda item have a canonical form.
  3036. This ensures the export commands can easily use it."
  3037. (let (tmp re)
  3038. (when (setq tmp (plist-get props 'tags))
  3039. (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
  3040. (when (setq tmp (plist-get props 'date))
  3041. (when (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  3042. (let ((calendar-date-display-form '(year "-" month "-" day)))
  3043. '((format "%4d, %9s %2s, %4s" dayname monthname day year))
  3044. (setq tmp (calendar-date-string tmp)))
  3045. (setq props (plist-put props 'date tmp)))
  3046. (when (setq tmp (plist-get props 'day))
  3047. (when (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  3048. (let ((calendar-date-display-form '(year "-" month "-" day)))
  3049. (setq tmp (calendar-date-string tmp)))
  3050. (setq props (plist-put props 'day tmp))
  3051. (setq props (plist-put props 'agenda-day tmp)))
  3052. (when (setq tmp (plist-get props 'txt))
  3053. (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
  3054. (plist-put props 'priority-letter (match-string 1 tmp))
  3055. (setq tmp (replace-match "" t t tmp)))
  3056. (when (and (setq re (plist-get props 'org-todo-regexp))
  3057. (setq re (concat "\\`\\.*" re " ?"))
  3058. (let ((case-fold-search nil)) (string-match re tmp)))
  3059. (plist-put props 'todo (match-string 1 tmp))
  3060. (setq tmp (replace-match "" t t tmp)))
  3061. (plist-put props 'txt tmp)))
  3062. props)
  3063. (defun org-agenda-export-csv-mapper (prop)
  3064. (let ((res (plist-get org-agenda-info prop)))
  3065. (setq res
  3066. (cond
  3067. ((not res) "")
  3068. ((stringp res) res)
  3069. (t (prin1-to-string res))))
  3070. (org-trim (replace-regexp-in-string "," ";" res nil t))))
  3071. ;;;###autoload
  3072. (defun org-store-agenda-views (&rest parameters)
  3073. "Store agenda views."
  3074. (interactive)
  3075. (eval (list 'org-batch-store-agenda-views)))
  3076. ;;;###autoload
  3077. (defmacro org-batch-store-agenda-views (&rest parameters)
  3078. "Run all custom agenda commands that have a file argument."
  3079. (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
  3080. (pop-up-frames nil)
  3081. (dir default-directory)
  3082. (pars (org-make-parameter-alist parameters))
  3083. cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
  3084. (save-window-excursion
  3085. (while cmds
  3086. (setq cmd (pop cmds)
  3087. thiscmdkey (car cmd)
  3088. thiscmdcmd (cdr cmd)
  3089. match (nth 2 thiscmdcmd)
  3090. bufname (if org-agenda-sticky
  3091. (or (and (stringp match)
  3092. (format "*Org Agenda(%s:%s)*" thiscmdkey match))
  3093. (format "*Org Agenda(%s)*" thiscmdkey))
  3094. org-agenda-buffer-name)
  3095. cmd-or-set (nth 2 cmd)
  3096. opts (nth (if (listp cmd-or-set) 3 4) cmd)
  3097. files (nth (if (listp cmd-or-set) 4 5) cmd))
  3098. (if (stringp files) (setq files (list files)))
  3099. (when files
  3100. (org-eval-in-environment (append org-agenda-exporter-settings
  3101. opts pars)
  3102. (org-agenda nil thiscmdkey))
  3103. (set-buffer bufname)
  3104. (while files
  3105. (org-eval-in-environment (append org-agenda-exporter-settings
  3106. opts pars)
  3107. (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
  3108. (and (get-buffer bufname)
  3109. (kill-buffer bufname)))))))
  3110. (defvar org-agenda-current-span nil
  3111. "The current span used in the agenda view.") ; local variable in the agenda buffer
  3112. (defun org-agenda-mark-header-line (pos)
  3113. "Mark the line at POS as an agenda structure header."
  3114. (save-excursion
  3115. (goto-char pos)
  3116. (put-text-property (point-at-bol) (point-at-eol)
  3117. 'org-agenda-structural-header t)
  3118. (when org-agenda-title-append
  3119. (put-text-property (point-at-bol) (point-at-eol)
  3120. 'org-agenda-title-append org-agenda-title-append))))
  3121. (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
  3122. (defvar org-agenda-write-buffer-name "Agenda View")
  3123. (defun org-agenda-write (file &optional open nosettings agenda-bufname)
  3124. "Write the current buffer (an agenda view) as a file.
  3125. Depending on the extension of the file name, plain text (.txt),
  3126. HTML (.html or .htm), PDF (.pdf) or Postscript (.ps) is produced.
  3127. If the extension is .ics, translate visible agenda into iCalendar
  3128. format. If the extension is .org, collect all subtrees
  3129. corresponding to the agenda entries and add them in an .org file.
  3130. With prefix argument OPEN, open the new file immediately. If
  3131. NOSETTINGS is given, do not scope the settings of
  3132. `org-agenda-exporter-settings' into the export commands. This is
  3133. used when the settings have already been scoped and we do not
  3134. wish to overrule other, higher priority settings. If
  3135. AGENDA-BUFFER-NAME is provided, use this as the buffer name for
  3136. the agenda to write."
  3137. (interactive "FWrite agenda to file: \nP")
  3138. (if (or (not (file-writable-p file))
  3139. (and (file-exists-p file)
  3140. (if (called-interactively-p 'any)
  3141. (not (y-or-n-p (format "Overwrite existing file %s? " file))))))
  3142. (user-error "Cannot write agenda to file %s" file))
  3143. (org-let (if nosettings nil org-agenda-exporter-settings)
  3144. '(save-excursion
  3145. (save-window-excursion
  3146. (let ((bs (copy-sequence (buffer-string)))
  3147. (extension (file-name-extension file))
  3148. (default-directory (file-name-directory file))
  3149. beg content)
  3150. (with-temp-buffer
  3151. (rename-buffer org-agenda-write-buffer-name t)
  3152. (set-buffer-modified-p nil)
  3153. (insert bs)
  3154. (org-agenda-remove-marked-text 'invisible 'org-filtered)
  3155. (run-hooks 'org-agenda-before-write-hook)
  3156. (cond
  3157. ((bound-and-true-p org-mobile-creating-agendas)
  3158. (org-mobile-write-agenda-for-mobile file))
  3159. ((string= "org" extension)
  3160. (let (content p m message-log-max)
  3161. (goto-char (point-min))
  3162. (while (setq p (next-single-property-change (point) 'org-hd-marker nil))
  3163. (goto-char p)
  3164. (setq m (get-text-property (point) 'org-hd-marker))
  3165. (when m
  3166. (push (save-excursion
  3167. (set-buffer (marker-buffer m))
  3168. (goto-char m)
  3169. (org-copy-subtree 1 nil t t)
  3170. org-subtree-clip)
  3171. content)))
  3172. (find-file file)
  3173. (erase-buffer)
  3174. (dolist (s content) (org-paste-subtree 1 s))
  3175. (write-file file)
  3176. (kill-buffer (current-buffer))
  3177. (message "Org file written to %s" file)))
  3178. ((member extension '("html" "htm"))
  3179. (or (require 'htmlize nil t)
  3180. (error "Please install htmlize from https://github.com/hniksic/emacs-htmlize"))
  3181. (set-buffer (htmlize-buffer (current-buffer)))
  3182. (when org-agenda-export-html-style
  3183. ;; replace <style> section with org-agenda-export-html-style
  3184. (goto-char (point-min))
  3185. (kill-region (- (search-forward "<style") 6)
  3186. (search-forward "</style>"))
  3187. (insert org-agenda-export-html-style))
  3188. (write-file file)
  3189. (kill-buffer (current-buffer))
  3190. (message "HTML written to %s" file))
  3191. ((string= "ps" extension)
  3192. (require 'ps-print)
  3193. (ps-print-buffer-with-faces file)
  3194. (message "Postscript written to %s" file))
  3195. ((string= "pdf" extension)
  3196. (require 'ps-print)
  3197. (ps-print-buffer-with-faces
  3198. (concat (file-name-sans-extension file) ".ps"))
  3199. (call-process "ps2pdf" nil nil nil
  3200. (expand-file-name
  3201. (concat (file-name-sans-extension file) ".ps"))
  3202. (expand-file-name file))
  3203. (delete-file (concat (file-name-sans-extension file) ".ps"))
  3204. (message "PDF written to %s" file))
  3205. ((string= "ics" extension)
  3206. (require 'ox-icalendar)
  3207. (org-icalendar-export-current-agenda (expand-file-name file)))
  3208. (t
  3209. (let ((bs (buffer-string)))
  3210. (find-file file)
  3211. (erase-buffer)
  3212. (insert bs)
  3213. (save-buffer 0)
  3214. (kill-buffer (current-buffer))
  3215. (message "Plain text written to %s" file))))))))
  3216. (set-buffer (or agenda-bufname
  3217. (and (called-interactively-p 'any) (buffer-name))
  3218. org-agenda-buffer-name)))
  3219. (when open (org-open-file file)))
  3220. (defun org-agenda-remove-marked-text (property &optional value)
  3221. "Delete all text marked with VALUE of PROPERTY.
  3222. VALUE defaults to t."
  3223. (let (beg)
  3224. (setq value (or value t))
  3225. (while (setq beg (text-property-any (point-min) (point-max)
  3226. property value))
  3227. (delete-region
  3228. beg (or (next-single-property-change beg property)
  3229. (point-max))))))
  3230. (defun org-agenda-add-entry-text ()
  3231. "Add entry text to agenda lines.
  3232. This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
  3233. entry text following headings shown in the agenda.
  3234. Drawers will be excluded, also the line with scheduling/deadline info."
  3235. (when (and (> org-agenda-add-entry-text-maxlines 0)
  3236. (not (bound-and-true-p org-mobile-creating-agendas)))
  3237. (let (m txt)
  3238. (goto-char (point-min))
  3239. (while (not (eobp))
  3240. (if (not (setq m (org-get-at-bol 'org-hd-marker)))
  3241. (beginning-of-line 2)
  3242. (setq txt (org-agenda-get-some-entry-text
  3243. m org-agenda-add-entry-text-maxlines " > "))
  3244. (end-of-line 1)
  3245. (if (string-match "\\S-" txt)
  3246. (insert "\n" txt)
  3247. (or (eobp) (forward-char 1))))))))
  3248. (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
  3249. &rest keep)
  3250. "Extract entry text from MARKER, at most N-LINES lines.
  3251. This will ignore drawers etc, just get the text.
  3252. If INDENT is given, prefix every line with this string. If KEEP is
  3253. given, it is a list of symbols, defining stuff that should not be
  3254. removed from the entry content. Currently only `planning' is allowed here."
  3255. (let (txt drawer-re kwd-time-re ind)
  3256. (save-excursion
  3257. (with-current-buffer (marker-buffer marker)
  3258. (if (not (derived-mode-p 'org-mode))
  3259. (setq txt "")
  3260. (org-with-wide-buffer
  3261. (goto-char marker)
  3262. (end-of-line 1)
  3263. (setq txt (buffer-substring
  3264. (min (1+ (point)) (point-max))
  3265. (progn (outline-next-heading) (point)))
  3266. drawer-re org-drawer-regexp
  3267. kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
  3268. ".*\n?"))
  3269. (with-temp-buffer
  3270. (insert txt)
  3271. (when org-agenda-add-entry-text-descriptive-links
  3272. (goto-char (point-min))
  3273. (while (org-activate-links (point-max))
  3274. (add-text-properties (match-beginning 0) (match-end 0)
  3275. '(face org-link))))
  3276. (goto-char (point-min))
  3277. (while (re-search-forward org-link-bracket-re (point-max) t)
  3278. (set-text-properties (match-beginning 0) (match-end 0)
  3279. nil))
  3280. (goto-char (point-min))
  3281. (while (re-search-forward drawer-re nil t)
  3282. (delete-region
  3283. (match-beginning 0)
  3284. (progn (re-search-forward
  3285. "^[ \t]*:END:.*\n?" nil 'move)
  3286. (point))))
  3287. (unless (member 'planning keep)
  3288. (goto-char (point-min))
  3289. (while (re-search-forward kwd-time-re nil t)
  3290. (replace-match "")))
  3291. (goto-char (point-min))
  3292. (when org-agenda-entry-text-exclude-regexps
  3293. (let ((re-list org-agenda-entry-text-exclude-regexps) re)
  3294. (while (setq re (pop re-list))
  3295. (goto-char (point-min))
  3296. (while (re-search-forward re nil t)
  3297. (replace-match "")))))
  3298. (goto-char (point-max))
  3299. (skip-chars-backward " \t\n")
  3300. (when (looking-at "[ \t\n]+\\'") (replace-match ""))
  3301. ;; find and remove min common indentation
  3302. (goto-char (point-min))
  3303. (untabify (point-min) (point-max))
  3304. (setq ind (current-indentation))
  3305. (while (not (eobp))
  3306. (unless (looking-at "[ \t]*$")
  3307. (setq ind (min ind (current-indentation))))
  3308. (beginning-of-line 2))
  3309. (goto-char (point-min))
  3310. (while (not (eobp))
  3311. (unless (looking-at "[ \t]*$")
  3312. (move-to-column ind)
  3313. (delete-region (point-at-bol) (point)))
  3314. (beginning-of-line 2))
  3315. (run-hooks 'org-agenda-entry-text-cleanup-hook)
  3316. (goto-char (point-min))
  3317. (when indent
  3318. (while (and (not (eobp)) (re-search-forward "^" nil t))
  3319. (replace-match indent t t)))
  3320. (goto-char (point-min))
  3321. (while (looking-at "[ \t]*\n") (replace-match ""))
  3322. (goto-char (point-max))
  3323. (when (> (org-current-line)
  3324. n-lines)
  3325. (org-goto-line (1+ n-lines))
  3326. (backward-char 1))
  3327. (setq txt (buffer-substring (point-min) (point))))))))
  3328. txt))
  3329. (defun org-check-for-org-mode ()
  3330. "Make sure current buffer is in Org mode. Error if not."
  3331. (or (derived-mode-p 'org-mode)
  3332. (error "Cannot execute Org agenda command on buffer in %s"
  3333. major-mode)))
  3334. ;;; Agenda prepare and finalize
  3335. (defvar org-agenda-multi nil) ; dynamically scoped
  3336. (defvar org-agenda-pre-window-conf nil)
  3337. (defvar org-agenda-columns-active nil)
  3338. (defvar org-agenda-name nil)
  3339. (defvar org-agenda-tag-filter nil)
  3340. (defvar org-agenda-category-filter nil)
  3341. (defvar org-agenda-regexp-filter nil)
  3342. (defvar org-agenda-effort-filter nil)
  3343. (defvar org-agenda-top-headline-filter nil)
  3344. (defvar org-agenda-represented-categories nil
  3345. "Cache for the list of all categories in the agenda.")
  3346. (defvar org-agenda-represented-tags nil
  3347. "Cache for the list of all categories in the agenda.")
  3348. (defvar org-agenda-tag-filter-preset nil
  3349. "A preset of the tags filter used for secondary agenda filtering.
  3350. This must be a list of strings, each string must be a single tag preceded
  3351. by \"+\" or \"-\".
  3352. This variable should not be set directly, but agenda custom commands can
  3353. bind it in the options section. The preset filter is a global property of
  3354. the entire agenda view. In a block agenda, it will not work reliably to
  3355. define a filter for one of the individual blocks. You need to set it in
  3356. the global options and expect it to be applied to the entire view.")
  3357. (defconst org-agenda-filter-variables
  3358. '((category . org-agenda-category-filter)
  3359. (tag . org-agenda-tag-filter)
  3360. (effort . org-agenda-effort-filter)
  3361. (regexp . org-agenda-regexp-filter))
  3362. "Alist of filter types and associated variables")
  3363. (defun org-agenda-filter-any ()
  3364. "Is any filter active?"
  3365. (let ((form (cons 'or (mapcar (lambda (x)
  3366. (if (or (symbol-value (cdr x))
  3367. (get :preset-filter x))
  3368. t nil))
  3369. org-agenda-filter-variables))))
  3370. (eval form)))
  3371. (defvar org-agenda-category-filter-preset nil
  3372. "A preset of the category filter used for secondary agenda filtering.
  3373. This must be a list of strings, each string must be a single category
  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-regexp-filter-preset nil
  3381. "A preset of the regexp filter 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. (defvar org-agenda-effort-filter-preset nil
  3390. "A preset of the effort condition used for secondary agenda filtering.
  3391. This must be a list of strings, each string must be a single regexp
  3392. preceded by \"+\" or \"-\".
  3393. This variable should not be set directly, but agenda custom commands can
  3394. bind it in the options section. The preset filter is a global property of
  3395. the entire agenda view. In a block agenda, it will not work reliably to
  3396. define a filter for one of the individual blocks. You need to set it in
  3397. the global options and expect it to be applied to the entire view.")
  3398. (defun org-agenda-use-sticky-p ()
  3399. "Return non-nil if an agenda buffer named
  3400. `org-agenda-buffer-name' exists and should be shown instead of
  3401. generating a new one."
  3402. (and
  3403. ;; turned off by user
  3404. org-agenda-sticky
  3405. ;; For multi-agenda buffer already exists
  3406. (not org-agenda-multi)
  3407. ;; buffer found
  3408. (get-buffer org-agenda-buffer-name)
  3409. ;; C-u parameter is same as last call
  3410. (with-current-buffer (get-buffer org-agenda-buffer-name)
  3411. (and
  3412. (equal current-prefix-arg
  3413. org-agenda-last-prefix-arg)
  3414. ;; In case user turned stickiness on, while having existing
  3415. ;; Agenda buffer active, don't reuse that buffer, because it
  3416. ;; does not have org variables local
  3417. org-agenda-this-buffer-is-sticky))))
  3418. (defun org-agenda-prepare-window (abuf filter-alist)
  3419. "Setup agenda buffer in the window.
  3420. ABUF is the buffer for the agenda window.
  3421. FILTER-ALIST is an alist of filters we need to apply when
  3422. `org-agenda-persistent-filter' is non-nil."
  3423. (let* ((awin (get-buffer-window abuf)) wconf)
  3424. (cond
  3425. ((equal (current-buffer) abuf) nil)
  3426. (awin (select-window awin))
  3427. ((not (setq wconf (current-window-configuration))))
  3428. ((eq org-agenda-window-setup 'current-window)
  3429. (pop-to-buffer-same-window abuf))
  3430. ((eq org-agenda-window-setup 'other-window)
  3431. (org-switch-to-buffer-other-window abuf))
  3432. ((eq org-agenda-window-setup 'other-frame)
  3433. (switch-to-buffer-other-frame abuf))
  3434. ((eq org-agenda-window-setup 'only-window)
  3435. (delete-other-windows)
  3436. (pop-to-buffer-same-window abuf))
  3437. ((eq org-agenda-window-setup 'reorganize-frame)
  3438. (delete-other-windows)
  3439. (org-switch-to-buffer-other-window abuf)))
  3440. (setq org-agenda-tag-filter (cdr (assq 'tag filter-alist)))
  3441. (setq org-agenda-category-filter (cdr (assq 'cat filter-alist)))
  3442. (setq org-agenda-effort-filter (cdr (assq 'effort filter-alist)))
  3443. (setq org-agenda-regexp-filter (cdr (assq 're filter-alist)))
  3444. ;; Additional test in case agenda is invoked from within agenda
  3445. ;; buffer via elisp link.
  3446. (unless (equal (current-buffer) abuf)
  3447. (pop-to-buffer-same-window abuf))
  3448. (setq org-agenda-pre-window-conf
  3449. (or wconf org-agenda-pre-window-conf))))
  3450. (defun org-agenda-prepare (&optional name)
  3451. (let ((filter-alist (when org-agenda-persistent-filter
  3452. (with-current-buffer
  3453. (get-buffer-create org-agenda-buffer-name)
  3454. `((tag . ,org-agenda-tag-filter)
  3455. (re . ,org-agenda-regexp-filter)
  3456. (effort . ,org-agenda-effort-filter)
  3457. (cat . ,org-agenda-category-filter))))))
  3458. (if (org-agenda-use-sticky-p)
  3459. (progn
  3460. (put 'org-agenda-tag-filter :preset-filter nil)
  3461. (put 'org-agenda-category-filter :preset-filter nil)
  3462. (put 'org-agenda-regexp-filter :preset-filter nil)
  3463. (put 'org-agenda-effort-filter :preset-filter nil)
  3464. ;; Popup existing buffer
  3465. (org-agenda-prepare-window (get-buffer org-agenda-buffer-name)
  3466. filter-alist)
  3467. (message "Sticky Agenda buffer, use `r' to refresh")
  3468. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3469. (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
  3470. (setq org-todo-keywords-for-agenda nil)
  3471. (put 'org-agenda-tag-filter :preset-filter
  3472. org-agenda-tag-filter-preset)
  3473. (put 'org-agenda-category-filter :preset-filter
  3474. org-agenda-category-filter-preset)
  3475. (put 'org-agenda-regexp-filter :preset-filter
  3476. org-agenda-regexp-filter-preset)
  3477. (put 'org-agenda-effort-filter :preset-filter
  3478. org-agenda-effort-filter-preset)
  3479. (if org-agenda-multi
  3480. (progn
  3481. (setq buffer-read-only nil)
  3482. (goto-char (point-max))
  3483. (unless (or (bobp) org-agenda-compact-blocks
  3484. (not org-agenda-block-separator))
  3485. (insert "\n"
  3486. (if (stringp org-agenda-block-separator)
  3487. org-agenda-block-separator
  3488. (make-string (window-width) org-agenda-block-separator))
  3489. "\n"))
  3490. (narrow-to-region (point) (point-max)))
  3491. (setq org-done-keywords-for-agenda nil)
  3492. ;; Setting any org variables that are in org-agenda-local-vars
  3493. ;; list need to be done after the prepare call
  3494. (org-agenda-prepare-window
  3495. (get-buffer-create org-agenda-buffer-name) filter-alist)
  3496. (setq buffer-read-only nil)
  3497. (org-agenda-reset-markers)
  3498. (let ((inhibit-read-only t)) (erase-buffer))
  3499. (org-agenda-mode)
  3500. (setq org-agenda-buffer (current-buffer))
  3501. (setq org-agenda-contributing-files nil)
  3502. (setq org-agenda-columns-active nil)
  3503. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  3504. (setq org-todo-keywords-for-agenda
  3505. (org-uniquify org-todo-keywords-for-agenda))
  3506. (setq org-done-keywords-for-agenda
  3507. (org-uniquify org-done-keywords-for-agenda))
  3508. (setq org-agenda-last-prefix-arg current-prefix-arg)
  3509. (setq org-agenda-this-buffer-name org-agenda-buffer-name)
  3510. (and name (not org-agenda-name)
  3511. (setq-local org-agenda-name name)))
  3512. (setq buffer-read-only nil))))
  3513. (defvar org-overriding-columns-format)
  3514. (defvar org-local-columns-format)
  3515. (defun org-agenda-finalize ()
  3516. "Finishing touch for the agenda buffer, called just before displaying it."
  3517. (unless org-agenda-multi
  3518. (save-excursion
  3519. (let ((inhibit-read-only t))
  3520. (goto-char (point-min))
  3521. (save-excursion
  3522. (while (org-activate-links (point-max))
  3523. (add-text-properties (match-beginning 0) (match-end 0)
  3524. '(face org-link))))
  3525. (unless (eq org-agenda-remove-tags t)
  3526. (org-agenda-align-tags))
  3527. (unless org-agenda-with-colors
  3528. (remove-text-properties (point-min) (point-max) '(face nil)))
  3529. (when (bound-and-true-p org-overriding-columns-format)
  3530. (setq-local org-local-columns-format
  3531. org-overriding-columns-format))
  3532. (when org-agenda-view-columns-initially
  3533. (org-agenda-columns))
  3534. (when org-agenda-fontify-priorities
  3535. (org-agenda-fontify-priorities))
  3536. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  3537. (org-agenda-dim-blocked-tasks))
  3538. (org-agenda-mark-clocking-task)
  3539. (when org-agenda-entry-text-mode
  3540. (org-agenda-entry-text-hide)
  3541. (org-agenda-entry-text-show))
  3542. (when (and (featurep 'org-habit)
  3543. (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
  3544. (org-habit-insert-consistency-graphs))
  3545. (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
  3546. (unless (or (eq org-agenda-show-inherited-tags 'always)
  3547. (and (listp org-agenda-show-inherited-tags)
  3548. (memq org-agenda-type org-agenda-show-inherited-tags))
  3549. (and (eq org-agenda-show-inherited-tags t)
  3550. (or (eq org-agenda-use-tag-inheritance t)
  3551. (and (listp org-agenda-use-tag-inheritance)
  3552. (not (memq org-agenda-type
  3553. org-agenda-use-tag-inheritance))))))
  3554. (let (mrk)
  3555. (save-excursion
  3556. (goto-char (point-min))
  3557. (while (equal (forward-line) 0)
  3558. (when (setq mrk (get-text-property (point) 'org-hd-marker))
  3559. (put-text-property (point-at-bol) (point-at-eol)
  3560. 'tags
  3561. (org-with-point-at mrk
  3562. (mapcar #'downcase (org-get-tags)))))))))
  3563. (setq org-agenda-represented-tags nil
  3564. org-agenda-represented-categories nil)
  3565. (when org-agenda-top-headline-filter
  3566. (org-agenda-filter-top-headline-apply
  3567. org-agenda-top-headline-filter))
  3568. (when org-agenda-tag-filter
  3569. (org-agenda-filter-apply org-agenda-tag-filter 'tag t))
  3570. (when (get 'org-agenda-tag-filter :preset-filter)
  3571. (org-agenda-filter-apply
  3572. (get 'org-agenda-tag-filter :preset-filter) 'tag t))
  3573. (when org-agenda-category-filter
  3574. (org-agenda-filter-apply org-agenda-category-filter 'category))
  3575. (when (get 'org-agenda-category-filter :preset-filter)
  3576. (org-agenda-filter-apply
  3577. (get 'org-agenda-category-filter :preset-filter) 'category))
  3578. (when org-agenda-regexp-filter
  3579. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
  3580. (when (get 'org-agenda-regexp-filter :preset-filter)
  3581. (org-agenda-filter-apply
  3582. (get 'org-agenda-regexp-filter :preset-filter) 'regexp))
  3583. (when org-agenda-effort-filter
  3584. (org-agenda-filter-apply org-agenda-effort-filter 'effort))
  3585. (when (get 'org-agenda-effort-filter :preset-filter)
  3586. (org-agenda-filter-apply
  3587. (get 'org-agenda-effort-filter :preset-filter) 'effort))
  3588. (add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)
  3589. (run-hooks 'org-agenda-finalize-hook)))))
  3590. (defun org-agenda-mark-clocking-task ()
  3591. "Mark the current clock entry in the agenda if it is present."
  3592. ;; We need to widen when `org-agenda-finalize' is called from
  3593. ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in')
  3594. (when (bound-and-true-p org-clock-current-task)
  3595. (save-restriction
  3596. (widen)
  3597. (org-agenda-unmark-clocking-task)
  3598. (when (marker-buffer org-clock-hd-marker)
  3599. (save-excursion
  3600. (goto-char (point-min))
  3601. (let (s ov)
  3602. (while (setq s (next-single-property-change (point) 'org-hd-marker))
  3603. (goto-char s)
  3604. (when (equal (org-get-at-bol 'org-hd-marker)
  3605. org-clock-hd-marker)
  3606. (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
  3607. (overlay-put ov 'type 'org-agenda-clocking)
  3608. (overlay-put ov 'face 'org-agenda-clocking)
  3609. (overlay-put ov 'help-echo
  3610. "The clock is running in this item")))))))))
  3611. (defun org-agenda-unmark-clocking-task ()
  3612. "Unmark the current clocking task."
  3613. (mapc (lambda (o)
  3614. (when (eq (overlay-get o 'type) 'org-agenda-clocking)
  3615. (delete-overlay o)))
  3616. (overlays-in (point-min) (point-max))))
  3617. (defun org-agenda-fontify-priorities ()
  3618. "Make highest priority lines bold, and lowest italic."
  3619. (interactive)
  3620. (mapc (lambda (o) (when (eq (overlay-get o 'org-type) 'org-priority)
  3621. (delete-overlay o)))
  3622. (overlays-in (point-min) (point-max)))
  3623. (save-excursion
  3624. (let (b e p ov h l)
  3625. (goto-char (point-min))
  3626. (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
  3627. (setq h (or (get-char-property (point) 'org-highest-priority)
  3628. org-highest-priority)
  3629. l (or (get-char-property (point) 'org-lowest-priority)
  3630. org-lowest-priority)
  3631. p (string-to-char (match-string 1))
  3632. b (match-beginning 0)
  3633. e (if (eq org-agenda-fontify-priorities 'cookies)
  3634. (match-end 0)
  3635. (point-at-eol))
  3636. ov (make-overlay b e))
  3637. (overlay-put
  3638. ov 'face
  3639. (let ((special-face
  3640. (cond ((org-face-from-face-or-color
  3641. 'priority 'org-priority
  3642. (cdr (assoc p org-priority-faces))))
  3643. ((and (listp org-agenda-fontify-priorities)
  3644. (org-face-from-face-or-color
  3645. 'priority 'org-priority
  3646. (cdr (assoc p org-agenda-fontify-priorities)))))
  3647. ((equal p l) 'italic)
  3648. ((equal p h) 'bold))))
  3649. (if special-face (list special-face 'org-priority) 'org-priority)))
  3650. (overlay-put ov 'org-type 'org-priority)))))
  3651. (defvar org-depend-tag-blocked)
  3652. (defun org-agenda-dim-blocked-tasks (&optional invisible)
  3653. "Dim currently blocked TODOs in the agenda display.
  3654. When INVISIBLE is non-nil, hide currently blocked TODO instead of
  3655. dimming them."
  3656. (interactive "P")
  3657. (when (called-interactively-p 'interactive)
  3658. (message "Dim or hide blocked tasks..."))
  3659. (dolist (o (overlays-in (point-min) (point-max)))
  3660. (when (eq (overlay-get o 'face) 'org-agenda-dimmed-todo-face)
  3661. (delete-overlay o)))
  3662. (save-excursion
  3663. (let ((inhibit-read-only t))
  3664. (goto-char (point-min))
  3665. (while (let ((pos (text-property-not-all
  3666. (point) (point-max) 'org-todo-blocked nil)))
  3667. (when pos (goto-char pos)))
  3668. (let* ((invisible
  3669. (eq (org-get-at-bol 'org-todo-blocked) 'invisible))
  3670. (todo-blocked
  3671. (eq (org-get-at-bol 'org-filter-type) 'todo-blocked))
  3672. (ov (make-overlay (if invisible
  3673. (line-end-position 0)
  3674. (line-beginning-position))
  3675. (line-end-position))))
  3676. (when todo-blocked
  3677. (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
  3678. (when invisible
  3679. (org-agenda-filter-hide-line 'todo-blocked)))
  3680. (move-beginning-of-line 2))))
  3681. (when (called-interactively-p 'interactive)
  3682. (message "Dim or hide blocked tasks...done")))
  3683. (defun org-agenda--mark-blocked-entry (entry)
  3684. "If ENTRY is blocked, mark it for fontification or invisibility.
  3685. If the header at `org-hd-marker' is blocked according to
  3686. `org-entry-blocked-p', then if `org-agenda-dim-blocked-tasks' is
  3687. 'invisible and the header is not blocked by checkboxes, set the
  3688. text property `org-todo-blocked' to `invisible', otherwise set it
  3689. to t."
  3690. (when (get-text-property 0 'todo-state entry)
  3691. (let ((entry-marker (get-text-property 0 'org-hd-marker entry))
  3692. (org-blocked-by-checkboxes nil)
  3693. ;; Necessary so that `org-entry-blocked-p' does not change
  3694. ;; the buffer.
  3695. (org-depend-tag-blocked nil))
  3696. (when entry-marker
  3697. (let ((blocked
  3698. (with-current-buffer (marker-buffer entry-marker)
  3699. (save-excursion
  3700. (goto-char entry-marker)
  3701. (org-entry-blocked-p)))))
  3702. (when blocked
  3703. (let ((really-invisible
  3704. (and (not org-blocked-by-checkboxes)
  3705. (eq org-agenda-dim-blocked-tasks 'invisible))))
  3706. (put-text-property
  3707. 0 (length entry) 'org-todo-blocked
  3708. (if really-invisible 'invisible t)
  3709. entry)
  3710. (put-text-property
  3711. 0 (length entry) 'org-filter-type 'todo-blocked entry)))))))
  3712. entry)
  3713. (defvar org-agenda-skip-function nil
  3714. "Function to be called at each match during agenda construction.
  3715. If this function returns nil, the current match should not be skipped.
  3716. Otherwise, the function must return a position from where the search
  3717. should be continued.
  3718. This may also be a Lisp form, it will be evaluated.
  3719. Never set this variable using `setq' or so, because then it will apply
  3720. to all future agenda commands. If you do want a global skipping condition,
  3721. use the option `org-agenda-skip-function-global' instead.
  3722. The correct usage for `org-agenda-skip-function' is to bind it with
  3723. `let' to scope it dynamically into the agenda-constructing command.
  3724. A good way to set it is through options in `org-agenda-custom-commands'.")
  3725. (defun org-agenda-skip ()
  3726. "Throw to `:skip' in places that should be skipped.
  3727. Also moves point to the end of the skipped region, so that search can
  3728. continue from there."
  3729. (let ((p (point-at-bol)) to)
  3730. (when (or
  3731. (save-excursion (goto-char p) (looking-at comment-start-skip))
  3732. (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
  3733. (get-text-property p :org-archived)
  3734. (org-end-of-subtree t))
  3735. (and org-agenda-skip-comment-trees
  3736. (get-text-property p :org-comment)
  3737. (org-end-of-subtree t))
  3738. (and (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
  3739. (org-agenda-skip-eval org-agenda-skip-function)))
  3740. (goto-char to))
  3741. (org-in-src-block-p t))
  3742. (throw :skip t))))
  3743. (defun org-agenda-skip-eval (form)
  3744. "If FORM is a function or a list, call (or eval) it and return the result.
  3745. `save-excursion' and `save-match-data' are wrapped around the call, so point
  3746. and match data are returned to the previous state no matter what these
  3747. functions do."
  3748. (let (fp)
  3749. (and form
  3750. (or (setq fp (functionp form))
  3751. (consp form))
  3752. (save-excursion
  3753. (save-match-data
  3754. (if fp
  3755. (funcall form)
  3756. (eval form)))))))
  3757. (defvar org-agenda-markers nil
  3758. "List of all currently active markers created by `org-agenda'.")
  3759. (defvar org-agenda-last-marker-time (float-time)
  3760. "Creation time of the last agenda marker.")
  3761. (defun org-agenda-new-marker (&optional pos)
  3762. "Return a new agenda marker.
  3763. Maker is at point, or at POS if non-nil. Org mode keeps a list of
  3764. these markers and resets them when they are no longer in use."
  3765. (let ((m (copy-marker (or pos (point)) t)))
  3766. (setq org-agenda-last-marker-time (float-time))
  3767. (if org-agenda-buffer
  3768. (with-current-buffer org-agenda-buffer
  3769. (push m org-agenda-markers))
  3770. (push m org-agenda-markers))
  3771. m))
  3772. (defun org-agenda-reset-markers ()
  3773. "Reset markers created by `org-agenda'."
  3774. (while org-agenda-markers
  3775. (move-marker (pop org-agenda-markers) nil)))
  3776. (defun org-agenda-save-markers-for-cut-and-paste (beg end)
  3777. "Save relative positions of markers in region.
  3778. This check for agenda markers in all agenda buffers currently active."
  3779. (dolist (buf (buffer-list))
  3780. (with-current-buffer buf
  3781. (when (eq major-mode 'org-agenda-mode)
  3782. (mapc (lambda (m) (org-check-and-save-marker m beg end))
  3783. org-agenda-markers)))))
  3784. ;;; Entry text mode
  3785. (defun org-agenda-entry-text-show-here ()
  3786. "Add some text from the entry as context to the current line."
  3787. (let (m txt o)
  3788. (setq m (org-get-at-bol 'org-hd-marker))
  3789. (unless (marker-buffer m)
  3790. (error "No marker points to an entry here"))
  3791. (setq txt (concat "\n" (org-no-properties
  3792. (org-agenda-get-some-entry-text
  3793. m org-agenda-entry-text-maxlines
  3794. org-agenda-entry-text-leaders))))
  3795. (when (string-match "\\S-" txt)
  3796. (setq o (make-overlay (point-at-bol) (point-at-eol)))
  3797. (overlay-put o 'evaporate t)
  3798. (overlay-put o 'org-overlay-type 'agenda-entry-content)
  3799. (overlay-put o 'after-string txt))))
  3800. (defun org-agenda-entry-text-show ()
  3801. "Add entry context for all agenda lines."
  3802. (interactive)
  3803. (save-excursion
  3804. (goto-char (point-max))
  3805. (beginning-of-line 1)
  3806. (while (not (bobp))
  3807. (when (org-get-at-bol 'org-hd-marker)
  3808. (org-agenda-entry-text-show-here))
  3809. (beginning-of-line 0))))
  3810. (defun org-agenda-entry-text-hide ()
  3811. "Remove any shown entry context."
  3812. (mapc (lambda (o)
  3813. (when (eq (overlay-get o 'org-overlay-type)
  3814. 'agenda-entry-content)
  3815. (delete-overlay o)))
  3816. (overlays-in (point-min) (point-max))))
  3817. (defun org-agenda-get-day-face (date)
  3818. "Return the face DATE should be displayed with."
  3819. (cond ((and (functionp org-agenda-day-face-function)
  3820. (funcall org-agenda-day-face-function date)))
  3821. ((org-agenda-today-p date) 'org-agenda-date-today)
  3822. ((memq (calendar-day-of-week date) org-agenda-weekend-days)
  3823. 'org-agenda-date-weekend)
  3824. (t 'org-agenda-date)))
  3825. (defvar org-agenda-show-log-scoped)
  3826. ;;; Agenda Daily/Weekly
  3827. (defvar org-agenda-start-day nil ; dynamically scoped parameter
  3828. "Start day for the agenda view.
  3829. Custom commands can set this variable in the options section.
  3830. This is usually a string like \"2007-11-01\", \"+2d\" or any other
  3831. input allowed when reading a date through the Org calendar.
  3832. See the docstring of `org-read-date' for details.")
  3833. (defvar org-starting-day nil) ; local variable in the agenda buffer
  3834. (defvar org-arg-loc nil) ; local variable
  3835. (defvar org-agenda-buffer-tmp-name nil)
  3836. ;;;###autoload
  3837. (defun org-agenda-list (&optional arg start-day span with-hour)
  3838. "Produce a daily/weekly view from all files in variable `org-agenda-files'.
  3839. The view will be for the current day or week, but from the overview buffer
  3840. you will be able to go to other days/weeks.
  3841. With a numeric prefix argument in an interactive call, the agenda will
  3842. span ARG days. Lisp programs should instead specify SPAN to change
  3843. the number of days. SPAN defaults to `org-agenda-span'.
  3844. START-DAY defaults to TODAY, or to the most recent match for the weekday
  3845. given in `org-agenda-start-on-weekday'.
  3846. When WITH-HOUR is non-nil, only include scheduled and deadline
  3847. items if they have an hour specification like [h]h:mm."
  3848. (interactive "P")
  3849. (when org-agenda-overriding-arguments
  3850. (setq arg (car org-agenda-overriding-arguments)
  3851. start-day (nth 1 org-agenda-overriding-arguments)
  3852. span (nth 2 org-agenda-overriding-arguments)))
  3853. (when (and (integerp arg) (> arg 0))
  3854. (setq span arg arg nil))
  3855. (when (numberp span)
  3856. (unless (< 0 span)
  3857. (user-error "Agenda creation impossible for this span(=%d days)." span)))
  3858. (catch 'exit
  3859. (setq org-agenda-buffer-name
  3860. (or org-agenda-buffer-tmp-name
  3861. (and org-agenda-doing-sticky-redo org-agenda-buffer-name)
  3862. (when org-agenda-sticky
  3863. (cond ((and org-keys (stringp org-match))
  3864. (format "*Org Agenda(%s:%s)*" org-keys org-match))
  3865. (org-keys
  3866. (format "*Org Agenda(%s)*" org-keys))
  3867. (t "*Org Agenda(a)*")))
  3868. "*Org Agenda*"))
  3869. (org-agenda-prepare "Day/Week")
  3870. (setq start-day (or start-day org-agenda-start-day))
  3871. (when (stringp start-day)
  3872. ;; Convert to an absolute day number
  3873. (setq start-day (time-to-days (org-read-date nil t start-day))))
  3874. (org-compile-prefix-format 'agenda)
  3875. (org-set-sorting-strategy 'agenda)
  3876. (let* ((span (org-agenda-ndays-to-span (or span org-agenda-span)))
  3877. (today (org-today))
  3878. (sd (or start-day today))
  3879. (ndays (org-agenda-span-to-ndays span sd))
  3880. (org-agenda-start-on-weekday
  3881. (and (or (eq ndays 7) (eq ndays 14))
  3882. org-agenda-start-on-weekday))
  3883. (thefiles (org-agenda-files nil 'ifmode))
  3884. (files thefiles)
  3885. (start (if (or (null org-agenda-start-on-weekday)
  3886. (< ndays 7))
  3887. sd
  3888. (let* ((nt (calendar-day-of-week
  3889. (calendar-gregorian-from-absolute sd)))
  3890. (n1 org-agenda-start-on-weekday)
  3891. (d (- nt n1)))
  3892. (- sd (+ (if (< d 0) 7 0) d)))))
  3893. (day-numbers (list start))
  3894. (day-cnt 0)
  3895. (inhibit-redisplay (not debug-on-error))
  3896. (org-agenda-show-log-scoped org-agenda-show-log)
  3897. s e rtn rtnall file date d start-pos end-pos todayp
  3898. clocktable-start clocktable-end filter)
  3899. (setq org-agenda-redo-command
  3900. (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span) with-hour))
  3901. (dotimes (n (1- ndays))
  3902. (push (1+ (car day-numbers)) day-numbers))
  3903. (setq day-numbers (nreverse day-numbers))
  3904. (setq clocktable-start (car day-numbers)
  3905. clocktable-end (1+ (or (org-last day-numbers) 0)))
  3906. (setq-local org-starting-day (car day-numbers))
  3907. (setq-local org-arg-loc arg)
  3908. (setq-local org-agenda-current-span (org-agenda-ndays-to-span span))
  3909. (unless org-agenda-compact-blocks
  3910. (let* ((d1 (car day-numbers))
  3911. (d2 (org-last day-numbers))
  3912. (w1 (org-days-to-iso-week d1))
  3913. (w2 (org-days-to-iso-week d2)))
  3914. (setq s (point))
  3915. (org-agenda--insert-overriding-header
  3916. (concat (org-agenda-span-name span)
  3917. "-agenda"
  3918. (cond ((<= 350 (- d2 d1)) "")
  3919. ((= w1 w2) (format " (W%02d)" w1))
  3920. (t (format " (W%02d-W%02d)" w1 w2)))
  3921. ":\n")))
  3922. ;; Add properties if we actually inserted a header.
  3923. (when (> (point) s)
  3924. (add-text-properties s (1- (point))
  3925. (list 'face 'org-agenda-structure
  3926. 'org-date-line t))
  3927. (org-agenda-mark-header-line s)))
  3928. (while (setq d (pop day-numbers))
  3929. (setq date (calendar-gregorian-from-absolute d)
  3930. s (point))
  3931. (if (or (setq todayp (= d today))
  3932. (and (not start-pos) (= d sd)))
  3933. (setq start-pos (point))
  3934. (when (and start-pos (not end-pos))
  3935. (setq end-pos (point))))
  3936. (setq files thefiles
  3937. rtnall nil)
  3938. (while (setq file (pop files))
  3939. (catch 'nextfile
  3940. (org-check-agenda-file file)
  3941. (let ((org-agenda-entry-types org-agenda-entry-types))
  3942. ;; Starred types override non-starred equivalents
  3943. (when (member :deadline* org-agenda-entry-types)
  3944. (setq org-agenda-entry-types
  3945. (delq :deadline org-agenda-entry-types)))
  3946. (when (member :scheduled* org-agenda-entry-types)
  3947. (setq org-agenda-entry-types
  3948. (delq :scheduled org-agenda-entry-types)))
  3949. ;; Honor with-hour
  3950. (when with-hour
  3951. (when (member :deadline org-agenda-entry-types)
  3952. (setq org-agenda-entry-types
  3953. (delq :deadline org-agenda-entry-types))
  3954. (push :deadline* org-agenda-entry-types))
  3955. (when (member :scheduled org-agenda-entry-types)
  3956. (setq org-agenda-entry-types
  3957. (delq :scheduled org-agenda-entry-types))
  3958. (push :scheduled* org-agenda-entry-types)))
  3959. (unless org-agenda-include-deadlines
  3960. (setq org-agenda-entry-types
  3961. (delq :deadline* (delq :deadline org-agenda-entry-types))))
  3962. (cond
  3963. ((memq org-agenda-show-log-scoped '(only clockcheck))
  3964. (setq rtn (org-agenda-get-day-entries
  3965. file date :closed)))
  3966. (org-agenda-show-log-scoped
  3967. (setq rtn (apply 'org-agenda-get-day-entries
  3968. file date
  3969. (append '(:closed) org-agenda-entry-types))))
  3970. (t
  3971. (setq rtn (apply 'org-agenda-get-day-entries
  3972. file date
  3973. org-agenda-entry-types)))))
  3974. (setq rtnall (append rtnall rtn)))) ;; all entries
  3975. (when org-agenda-include-diary
  3976. (let ((org-agenda-search-headline-for-time t))
  3977. (require 'diary-lib)
  3978. (setq rtn (org-get-entries-from-diary date))
  3979. (setq rtnall (append rtnall rtn))))
  3980. (when (or rtnall org-agenda-show-all-dates)
  3981. (setq day-cnt (1+ day-cnt))
  3982. (insert
  3983. (if (stringp org-agenda-format-date)
  3984. (format-time-string org-agenda-format-date
  3985. (org-time-from-absolute date))
  3986. (funcall org-agenda-format-date date))
  3987. "\n")
  3988. (put-text-property s (1- (point)) 'face
  3989. (org-agenda-get-day-face date))
  3990. (put-text-property s (1- (point)) 'org-date-line t)
  3991. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3992. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
  3993. (when todayp
  3994. (put-text-property s (1- (point)) 'org-today t))
  3995. (setq rtnall
  3996. (org-agenda-add-time-grid-maybe rtnall ndays todayp))
  3997. (when rtnall (insert ;; all entries
  3998. (org-agenda-finalize-entries rtnall 'agenda)
  3999. "\n"))
  4000. (put-text-property s (1- (point)) 'day d)
  4001. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)))
  4002. (when (and org-agenda-clockreport-mode clocktable-start)
  4003. (let ((org-agenda-files (org-agenda-files nil 'ifmode))
  4004. ;; the above line is to ensure the restricted range!
  4005. (p (copy-sequence org-agenda-clockreport-parameter-plist))
  4006. tbl)
  4007. (setq p (org-plist-delete p :block))
  4008. (setq p (plist-put p :tstart clocktable-start))
  4009. (setq p (plist-put p :tend clocktable-end))
  4010. (setq p (plist-put p :scope 'agenda))
  4011. (setq tbl (apply 'org-clock-get-clocktable p))
  4012. (insert tbl)))
  4013. (goto-char (point-min))
  4014. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4015. (unless (or (not (get-buffer-window org-agenda-buffer-name))
  4016. (and (pos-visible-in-window-p (point-min))
  4017. (pos-visible-in-window-p (point-max))))
  4018. (goto-char (1- (point-max)))
  4019. (recenter -1)
  4020. (when (not (pos-visible-in-window-p (or start-pos 1)))
  4021. (goto-char (or start-pos 1))
  4022. (recenter 1)))
  4023. (goto-char (or start-pos 1))
  4024. (add-text-properties (point-min) (point-max)
  4025. `(org-agenda-type agenda
  4026. org-last-args (,arg ,start-day ,span)
  4027. org-redo-cmd ,org-agenda-redo-command
  4028. org-series-cmd ,org-cmd))
  4029. (when (eq org-agenda-show-log-scoped 'clockcheck)
  4030. (org-agenda-show-clocking-issues))
  4031. (org-agenda-finalize)
  4032. (setq buffer-read-only t)
  4033. (message ""))))
  4034. (defun org-agenda-ndays-to-span (n)
  4035. "Return a span symbol for a span of N days, or N if none matches."
  4036. (cond ((symbolp n) n)
  4037. ((= n 1) 'day)
  4038. ((= n 7) 'week)
  4039. ((= n 14) 'fortnight)
  4040. (t n)))
  4041. (defun org-agenda-span-to-ndays (span &optional start-day)
  4042. "Return ndays from SPAN, possibly starting at START-DAY.
  4043. START-DAY is an absolute time value."
  4044. (cond ((numberp span) span)
  4045. ((eq span 'day) 1)
  4046. ((eq span 'week) 7)
  4047. ((eq span 'fortnight) 14)
  4048. ((eq span 'month)
  4049. (let ((date (calendar-gregorian-from-absolute start-day)))
  4050. (calendar-last-day-of-month (car date) (cl-caddr date))))
  4051. ((eq span 'year)
  4052. (let ((date (calendar-gregorian-from-absolute start-day)))
  4053. (if (calendar-leap-year-p (cl-caddr date)) 366 365)))))
  4054. (defun org-agenda-span-name (span)
  4055. "Return a SPAN name."
  4056. (if (null span)
  4057. ""
  4058. (if (symbolp span)
  4059. (capitalize (symbol-name span))
  4060. (format "%d days" span))))
  4061. ;;; Agenda word search
  4062. (defvar org-agenda-search-history nil)
  4063. (defvar org-search-syntax-table nil
  4064. "Special syntax table for Org search.
  4065. In this table, we have single quotes not as word constituents, to
  4066. that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
  4067. (defvar org-mode-syntax-table) ; From org.el
  4068. (defun org-search-syntax-table ()
  4069. (unless org-search-syntax-table
  4070. (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
  4071. (modify-syntax-entry ?' "." org-search-syntax-table)
  4072. (modify-syntax-entry ?` "." org-search-syntax-table))
  4073. org-search-syntax-table)
  4074. (defvar org-agenda-last-search-view-search-was-boolean nil)
  4075. ;;;###autoload
  4076. (defun org-search-view (&optional todo-only string edit-at)
  4077. "Show all entries that contain a phrase or words or regular expressions.
  4078. With optional prefix argument TODO-ONLY, only consider entries that are
  4079. TODO entries. The argument STRING can be used to pass a default search
  4080. string into this function. If EDIT-AT is non-nil, it means that the
  4081. user should get a chance to edit this string, with cursor at position
  4082. EDIT-AT.
  4083. The search string can be viewed either as a phrase that should be found as
  4084. is, or it can be broken into a number of snippets, each of which must match
  4085. in a Boolean way to select an entry. The default depends on the variable
  4086. `org-agenda-search-view-always-boolean'.
  4087. Even if this is turned off (the default) you can always switch to
  4088. Boolean search dynamically by preceding the first word with \"+\" or \"-\".
  4089. The default is a direct search of the whole phrase, where each space in
  4090. the search string can expand to an arbitrary amount of whitespace,
  4091. including newlines.
  4092. If using a Boolean search, the search string is split on whitespace and
  4093. each snippet is searched separately, with logical AND to select an entry.
  4094. Words prefixed with a minus must *not* occur in the entry. Words without
  4095. a prefix or prefixed with a plus must occur in the entry. Matching is
  4096. case-insensitive. Words are enclosed by word delimiters (i.e. they must
  4097. match whole words, not parts of a word) if
  4098. `org-agenda-search-view-force-full-words' is set (default is nil).
  4099. Boolean search snippets enclosed by curly braces are interpreted as
  4100. regular expressions that must or (when preceded with \"-\") must not
  4101. match in the entry. Snippets enclosed into double quotes will be taken
  4102. as a whole, to include whitespace.
  4103. - If the search string starts with an asterisk, search only in headlines.
  4104. - If (possibly after the leading star) the search string starts with an
  4105. exclamation mark, this also means to look at TODO entries only, an effect
  4106. that can also be achieved with a prefix argument.
  4107. - If (possibly after star and exclamation mark) the search string starts
  4108. with a colon, this will mean that the (non-regexp) snippets of the
  4109. Boolean search must match as full words.
  4110. This command searches the agenda files, and in addition the files
  4111. listed in `org-agenda-text-search-extra-files' unless a restriction lock
  4112. is active."
  4113. (interactive "P")
  4114. (when org-agenda-overriding-arguments
  4115. (setq todo-only (car org-agenda-overriding-arguments)
  4116. string (nth 1 org-agenda-overriding-arguments)
  4117. edit-at (nth 2 org-agenda-overriding-arguments)))
  4118. (let* ((props (list 'face nil
  4119. 'done-face 'org-agenda-done
  4120. 'org-not-done-regexp org-not-done-regexp
  4121. 'org-todo-regexp org-todo-regexp
  4122. 'org-complex-heading-regexp org-complex-heading-regexp
  4123. 'mouse-face 'highlight
  4124. 'help-echo (format "mouse-2 or RET jump to location")))
  4125. (full-words org-agenda-search-view-force-full-words)
  4126. (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
  4127. regexp rtn rtnall files file pos inherited-tags
  4128. marker category level tags c neg re boolean
  4129. ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
  4130. (unless (and (not edit-at)
  4131. (stringp string)
  4132. (string-match "\\S-" string))
  4133. (setq string (read-string
  4134. (if org-agenda-search-view-always-boolean
  4135. "[+-]Word/{Regexp} ...: "
  4136. "Phrase or [+-]Word/{Regexp} ...: ")
  4137. (cond
  4138. ((integerp edit-at) (cons string edit-at))
  4139. (edit-at string))
  4140. 'org-agenda-search-history)))
  4141. (catch 'exit
  4142. (when org-agenda-sticky
  4143. (setq org-agenda-buffer-name
  4144. (if (stringp string)
  4145. (format "*Org Agenda(%s:%s)*"
  4146. (or org-keys (or (and todo-only "S") "s")) string)
  4147. (format "*Org Agenda(%s)*" (or (and todo-only "S") "s")))))
  4148. (org-agenda-prepare "SEARCH")
  4149. (org-compile-prefix-format 'search)
  4150. (org-set-sorting-strategy 'search)
  4151. (setq org-agenda-redo-command
  4152. (list 'org-search-view (if todo-only t nil)
  4153. (list 'if 'current-prefix-arg nil string)))
  4154. (setq org-agenda-query-string string)
  4155. (if (equal (string-to-char string) ?*)
  4156. (setq hdl-only t
  4157. words (substring string 1))
  4158. (setq words string))
  4159. (when (equal (string-to-char words) ?!)
  4160. (setq todo-only t
  4161. words (substring words 1)))
  4162. (when (equal (string-to-char words) ?:)
  4163. (setq full-words t
  4164. words (substring words 1)))
  4165. (when (or org-agenda-search-view-always-boolean
  4166. (member (string-to-char words) '(?- ?+ ?\{)))
  4167. (setq boolean t))
  4168. (setq words (split-string words))
  4169. (let (www w)
  4170. (while (setq w (pop words))
  4171. (while (and (string-match "\\\\\\'" w) words)
  4172. (setq w (concat (substring w 0 -1) " " (pop words))))
  4173. (push w www))
  4174. (setq words (nreverse www) www nil)
  4175. (while (setq w (pop words))
  4176. (when (and (string-match "\\`[-+]?{" w)
  4177. (not (string-match "}\\'" w)))
  4178. (while (and words (not (string-match "}\\'" (car words))))
  4179. (setq w (concat w " " (pop words))))
  4180. (setq w (concat w " " (pop words))))
  4181. (push w www))
  4182. (setq words (nreverse www)))
  4183. (setq org-agenda-last-search-view-search-was-boolean boolean)
  4184. (when boolean
  4185. (let (wds w)
  4186. (while (setq w (pop words))
  4187. (when (or (equal (substring w 0 1) "\"")
  4188. (and (> (length w) 1)
  4189. (member (substring w 0 1) '("+" "-"))
  4190. (equal (substring w 1 2) "\"")))
  4191. (while (and words (not (equal (substring w -1) "\"")))
  4192. (setq w (concat w " " (pop words)))))
  4193. (and (string-match "\\`\\([-+]?\\)\"" w)
  4194. (setq w (replace-match "\\1" nil nil w)))
  4195. (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
  4196. (push w wds))
  4197. (setq words (nreverse wds))))
  4198. (if boolean
  4199. (mapc (lambda (w)
  4200. (setq c (string-to-char w))
  4201. (if (equal c ?-)
  4202. (setq neg t w (substring w 1))
  4203. (if (equal c ?+)
  4204. (setq neg nil w (substring w 1))
  4205. (setq neg nil)))
  4206. (if (string-match "\\`{.*}\\'" w)
  4207. (setq re (substring w 1 -1))
  4208. (if full-words
  4209. (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
  4210. (setq re (regexp-quote (downcase w)))))
  4211. (if neg (push re regexps-) (push re regexps+)))
  4212. words)
  4213. (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
  4214. regexps+))
  4215. (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
  4216. (if (not regexps+)
  4217. (setq regexp org-outline-regexp-bol)
  4218. (setq regexp (pop regexps+))
  4219. (when hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
  4220. regexp))))
  4221. (setq files (org-agenda-files nil 'ifmode))
  4222. ;; Add `org-agenda-text-search-extra-files' unless there is some
  4223. ;; restriction.
  4224. (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
  4225. (pop org-agenda-text-search-extra-files)
  4226. (unless (get 'org-agenda-files 'org-restrict)
  4227. (setq files (org-add-archive-files files))))
  4228. ;; Uniquify files. However, let `org-check-agenda-file' handle
  4229. ;; non-existent ones.
  4230. (setq files (cl-remove-duplicates
  4231. (append files org-agenda-text-search-extra-files)
  4232. :test (lambda (a b)
  4233. (and (file-exists-p a)
  4234. (file-exists-p b)
  4235. (file-equal-p a b))))
  4236. rtnall nil)
  4237. (while (setq file (pop files))
  4238. (setq ee nil)
  4239. (catch 'nextfile
  4240. (org-check-agenda-file file)
  4241. (setq buffer (if (file-exists-p file)
  4242. (org-get-agenda-file-buffer file)
  4243. (error "No such file %s" file)))
  4244. (unless buffer
  4245. ;; If file does not exist, make sure an error message is sent
  4246. (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
  4247. file))))
  4248. (with-current-buffer buffer
  4249. (with-syntax-table (org-search-syntax-table)
  4250. (unless (derived-mode-p 'org-mode)
  4251. (error "Agenda file %s is not in Org mode" file))
  4252. (let ((case-fold-search t))
  4253. (save-excursion
  4254. (save-restriction
  4255. (if (eq buffer org-agenda-restrict)
  4256. (narrow-to-region org-agenda-restrict-begin
  4257. org-agenda-restrict-end)
  4258. (widen))
  4259. (goto-char (point-min))
  4260. (unless (or (org-at-heading-p)
  4261. (outline-next-heading))
  4262. (throw 'nextfile t))
  4263. (goto-char (max (point-min) (1- (point))))
  4264. (while (re-search-forward regexp nil t)
  4265. (org-back-to-heading t)
  4266. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4267. (> (org-reduced-level (org-outline-level))
  4268. org-agenda-search-view-max-outline-level)
  4269. (forward-line -1)
  4270. (org-back-to-heading t)))
  4271. (skip-chars-forward "* ")
  4272. (setq beg (point-at-bol)
  4273. beg1 (point)
  4274. end (progn
  4275. (outline-next-heading)
  4276. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4277. (> (org-reduced-level (org-outline-level))
  4278. org-agenda-search-view-max-outline-level)
  4279. (forward-line 1)
  4280. (outline-next-heading)))
  4281. (point)))
  4282. (catch :skip
  4283. (goto-char beg)
  4284. (org-agenda-skip)
  4285. (setq str (buffer-substring-no-properties
  4286. (point-at-bol)
  4287. (if hdl-only (point-at-eol) end)))
  4288. (mapc (lambda (wr) (when (string-match wr str)
  4289. (goto-char (1- end))
  4290. (throw :skip t)))
  4291. regexps-)
  4292. (mapc (lambda (wr) (unless (string-match wr str)
  4293. (goto-char (1- end))
  4294. (throw :skip t)))
  4295. (if todo-only
  4296. (cons (concat "^\\*+[ \t]+"
  4297. org-not-done-regexp)
  4298. regexps+)
  4299. regexps+))
  4300. (goto-char beg)
  4301. (setq marker (org-agenda-new-marker (point))
  4302. category (org-get-category)
  4303. level (make-string (org-reduced-level (org-outline-level)) ? )
  4304. inherited-tags
  4305. (or (eq org-agenda-show-inherited-tags 'always)
  4306. (and (listp org-agenda-show-inherited-tags)
  4307. (memq 'todo org-agenda-show-inherited-tags))
  4308. (and (eq org-agenda-show-inherited-tags t)
  4309. (or (eq org-agenda-use-tag-inheritance t)
  4310. (memq 'todo org-agenda-use-tag-inheritance))))
  4311. tags (org-get-tags nil (not inherited-tags))
  4312. txt (org-agenda-format-item
  4313. ""
  4314. (buffer-substring-no-properties
  4315. beg1 (point-at-eol))
  4316. level category tags t))
  4317. (org-add-props txt props
  4318. 'org-marker marker 'org-hd-marker marker
  4319. 'org-todo-regexp org-todo-regexp
  4320. 'level level
  4321. 'org-complex-heading-regexp org-complex-heading-regexp
  4322. 'priority 1000
  4323. 'type "search")
  4324. (push txt ee)
  4325. (goto-char (1- end))))))))))
  4326. (setq rtn (nreverse ee))
  4327. (setq rtnall (append rtnall rtn)))
  4328. (org-agenda--insert-overriding-header
  4329. (with-temp-buffer
  4330. (insert "Search words: ")
  4331. (add-text-properties (point-min) (1- (point))
  4332. (list 'face 'org-agenda-structure))
  4333. (setq pos (point))
  4334. (insert string "\n")
  4335. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4336. (setq pos (point))
  4337. (unless org-agenda-multi
  4338. (insert (substitute-command-keys "\\<org-agenda-mode-map>\
  4339. Press `\\[org-agenda-manipulate-query-add]', \
  4340. `\\[org-agenda-manipulate-query-subtract]' to add/sub word, \
  4341. `\\[org-agenda-manipulate-query-add-re]', \
  4342. `\\[org-agenda-manipulate-query-subtract-re]' to add/sub regexp, \
  4343. `\\[universal-argument] \\[org-agenda-redo]' for a fresh search\n"))
  4344. (add-text-properties pos (1- (point))
  4345. (list 'face 'org-agenda-structure)))
  4346. (buffer-string)))
  4347. (org-agenda-mark-header-line (point-min))
  4348. (when rtnall
  4349. (insert (org-agenda-finalize-entries rtnall 'search) "\n"))
  4350. (goto-char (point-min))
  4351. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4352. (add-text-properties (point-min) (point-max)
  4353. `(org-agenda-type search
  4354. org-last-args (,todo-only ,string ,edit-at)
  4355. org-redo-cmd ,org-agenda-redo-command
  4356. org-series-cmd ,org-cmd))
  4357. (org-agenda-finalize)
  4358. (setq buffer-read-only t))))
  4359. ;;; Agenda TODO list
  4360. (defun org-agenda-propertize-selected-todo-keywords (keywords)
  4361. "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
  4362. (concat
  4363. (if (or (equal keywords "ALL") (not keywords))
  4364. (propertize "ALL" 'face 'warning)
  4365. (mapconcat
  4366. (lambda (kw)
  4367. (propertize kw 'face (org-get-todo-face kw)))
  4368. (org-split-string keywords "|")
  4369. "|"))
  4370. "\n"))
  4371. (defvar org-select-this-todo-keyword nil)
  4372. (defvar org-last-arg nil)
  4373. ;;;###autoload
  4374. (defun org-todo-list (&optional arg)
  4375. "Show all (not done) TODO entries from all agenda file in a single list.
  4376. The prefix arg can be used to select a specific TODO keyword and limit
  4377. the list to these. When using `\\[universal-argument]', you will be prompted
  4378. for a keyword. A numeric prefix directly selects the Nth keyword in
  4379. `org-todo-keywords-1'."
  4380. (interactive "P")
  4381. (when org-agenda-overriding-arguments
  4382. (setq arg org-agenda-overriding-arguments))
  4383. (when (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
  4384. (let* ((today (org-today))
  4385. (date (calendar-gregorian-from-absolute today))
  4386. (completion-ignore-case t)
  4387. kwds org-select-this-todo-keyword rtn rtnall files file pos)
  4388. (catch 'exit
  4389. (when org-agenda-sticky
  4390. (setq org-agenda-buffer-name
  4391. (if (stringp org-select-this-todo-keyword)
  4392. (format "*Org Agenda(%s:%s)*" (or org-keys "t")
  4393. org-select-this-todo-keyword)
  4394. (format "*Org Agenda(%s)*" (or org-keys "t")))))
  4395. (org-agenda-prepare "TODO")
  4396. (setq kwds org-todo-keywords-for-agenda
  4397. org-select-this-todo-keyword (if (stringp arg) arg
  4398. (and (integerp arg)
  4399. (> arg 0)
  4400. (nth (1- arg) kwds))))
  4401. (when (equal arg '(4))
  4402. (setq org-select-this-todo-keyword
  4403. (completing-read "Keyword (or KWD1|K2D2|...): "
  4404. (mapcar #'list kwds) nil nil)))
  4405. (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
  4406. (org-compile-prefix-format 'todo)
  4407. (org-set-sorting-strategy 'todo)
  4408. (setq org-agenda-redo-command
  4409. `(org-todo-list (or (and (numberp current-prefix-arg)
  4410. current-prefix-arg)
  4411. ,org-select-this-todo-keyword
  4412. current-prefix-arg ,arg)))
  4413. (setq files (org-agenda-files nil 'ifmode)
  4414. rtnall nil)
  4415. (while (setq file (pop files))
  4416. (catch 'nextfile
  4417. (org-check-agenda-file file)
  4418. (setq rtn (org-agenda-get-day-entries file date :todo))
  4419. (setq rtnall (append rtnall rtn))))
  4420. (org-agenda--insert-overriding-header
  4421. (with-temp-buffer
  4422. (insert "Global list of TODO items of type: ")
  4423. (add-text-properties (point-min) (1- (point))
  4424. (list 'face 'org-agenda-structure
  4425. 'short-heading
  4426. (concat "ToDo: "
  4427. (or org-select-this-todo-keyword "ALL"))))
  4428. (org-agenda-mark-header-line (point-min))
  4429. (insert (org-agenda-propertize-selected-todo-keywords
  4430. org-select-this-todo-keyword))
  4431. (setq pos (point))
  4432. (unless org-agenda-multi
  4433. (insert (substitute-command-keys "Press \
  4434. \\<org-agenda-mode-map>`N \\[org-agenda-redo]' (e.g. `0 \\[org-agenda-redo]') \
  4435. to search again: (0)[ALL]"))
  4436. (let ((n 0))
  4437. (dolist (k kwds)
  4438. (let ((s (format "(%d)%s" (cl-incf n) k)))
  4439. (when (> (+ (current-column) (string-width s) 1) (window-width))
  4440. (insert "\n "))
  4441. (insert " " s))))
  4442. (insert "\n"))
  4443. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure))
  4444. (buffer-string)))
  4445. (org-agenda-mark-header-line (point-min))
  4446. (when rtnall
  4447. (insert (org-agenda-finalize-entries rtnall 'todo) "\n"))
  4448. (goto-char (point-min))
  4449. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4450. (add-text-properties (point-min) (point-max)
  4451. `(org-agenda-type todo
  4452. org-last-args ,arg
  4453. org-redo-cmd ,org-agenda-redo-command
  4454. org-series-cmd ,org-cmd))
  4455. (org-agenda-finalize)
  4456. (setq buffer-read-only t))))
  4457. ;;; Agenda tags match
  4458. ;;;###autoload
  4459. (defun org-tags-view (&optional todo-only match)
  4460. "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
  4461. The prefix arg TODO-ONLY limits the search to TODO entries."
  4462. (interactive "P")
  4463. (when org-agenda-overriding-arguments
  4464. (setq todo-only (car org-agenda-overriding-arguments)
  4465. match (nth 1 org-agenda-overriding-arguments)))
  4466. (let* ((org-tags-match-list-sublevels
  4467. org-tags-match-list-sublevels)
  4468. (completion-ignore-case t)
  4469. (org--matcher-tags-todo-only todo-only)
  4470. rtn rtnall files file pos matcher
  4471. buffer)
  4472. (when (and (stringp match) (not (string-match "\\S-" match)))
  4473. (setq match nil))
  4474. (catch 'exit
  4475. ;; TODO: this code is repeated a lot...
  4476. (when org-agenda-sticky
  4477. (setq org-agenda-buffer-name
  4478. (if (stringp match)
  4479. (format "*Org Agenda(%s:%s)*"
  4480. (or org-keys (or (and todo-only "M") "m")) match)
  4481. (format "*Org Agenda(%s)*" (or (and todo-only "M") "m")))))
  4482. (setq matcher (org-make-tags-matcher match))
  4483. ;; Prepare agendas (and `org-tag-alist-for-agenda') before
  4484. ;; expanding tags within `org-make-tags-matcher'
  4485. (org-agenda-prepare (concat "TAGS " match))
  4486. (setq match (car matcher)
  4487. matcher (cdr matcher))
  4488. (org-compile-prefix-format 'tags)
  4489. (org-set-sorting-strategy 'tags)
  4490. (setq org-agenda-query-string match)
  4491. (setq org-agenda-redo-command
  4492. (list 'org-tags-view
  4493. `(quote ,org--matcher-tags-todo-only)
  4494. `(if current-prefix-arg nil ,org-agenda-query-string)))
  4495. (setq files (org-agenda-files nil 'ifmode)
  4496. rtnall nil)
  4497. (while (setq file (pop files))
  4498. (catch 'nextfile
  4499. (org-check-agenda-file file)
  4500. (setq buffer (if (file-exists-p file)
  4501. (org-get-agenda-file-buffer file)
  4502. (error "No such file %s" file)))
  4503. (if (not buffer)
  4504. ;; If file does not exist, error message to agenda
  4505. (setq rtn (list
  4506. (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4507. rtnall (append rtnall rtn))
  4508. (with-current-buffer buffer
  4509. (unless (derived-mode-p 'org-mode)
  4510. (error "Agenda file %s is not in Org mode" file))
  4511. (save-excursion
  4512. (save-restriction
  4513. (if (eq buffer org-agenda-restrict)
  4514. (narrow-to-region org-agenda-restrict-begin
  4515. org-agenda-restrict-end)
  4516. (widen))
  4517. (setq rtn (org-scan-tags 'agenda
  4518. matcher
  4519. org--matcher-tags-todo-only))
  4520. (setq rtnall (append rtnall rtn))))))))
  4521. (org-agenda--insert-overriding-header
  4522. (with-temp-buffer
  4523. (insert "Headlines with TAGS match: ")
  4524. (add-text-properties (point-min) (1- (point))
  4525. (list 'face 'org-agenda-structure
  4526. 'short-heading
  4527. (concat "Match: " match)))
  4528. (setq pos (point))
  4529. (insert match "\n")
  4530. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4531. (setq pos (point))
  4532. (unless org-agenda-multi
  4533. (insert (substitute-command-keys
  4534. "Press \
  4535. \\<org-agenda-mode-map>`\\[universal-argument] \\[org-agenda-redo]' \
  4536. to search again\n")))
  4537. (add-text-properties pos (1- (point))
  4538. (list 'face 'org-agenda-structure))
  4539. (buffer-string)))
  4540. (org-agenda-mark-header-line (point-min))
  4541. (when rtnall
  4542. (insert (org-agenda-finalize-entries rtnall 'tags) "\n"))
  4543. (goto-char (point-min))
  4544. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4545. (add-text-properties
  4546. (point-min) (point-max)
  4547. `(org-agenda-type tags
  4548. org-last-args (,org--matcher-tags-todo-only ,match)
  4549. org-redo-cmd ,org-agenda-redo-command
  4550. org-series-cmd ,org-cmd))
  4551. (org-agenda-finalize)
  4552. (setq buffer-read-only t))))
  4553. ;;; Agenda Finding stuck projects
  4554. (defvar org-agenda-skip-regexp nil
  4555. "Regular expression used in skipping subtrees for the agenda.
  4556. This is basically a temporary global variable that can be set and then
  4557. used by user-defined selections using `org-agenda-skip-function'.")
  4558. (defvar org-agenda-overriding-header nil
  4559. "When set during agenda, todo and tags searches it replaces the header.
  4560. If an empty string, no header will be inserted. If any other
  4561. string, it will be inserted as a header. If nil, a header will
  4562. be generated automatically according to the command. This
  4563. variable should not be set directly, but custom commands can bind
  4564. it in the options section.")
  4565. (defun org-agenda-skip-entry-if (&rest conditions)
  4566. "Skip entry if any of CONDITIONS is true.
  4567. See `org-agenda-skip-if' for details."
  4568. (org-agenda-skip-if nil conditions))
  4569. (defun org-agenda-skip-subtree-if (&rest conditions)
  4570. "Skip subtree if any of CONDITIONS is true.
  4571. See `org-agenda-skip-if' for details."
  4572. (org-agenda-skip-if t conditions))
  4573. (defun org-agenda-skip-if (subtree conditions)
  4574. "Checks current entity for CONDITIONS.
  4575. If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
  4576. the entry (i.e. the text before the next heading) is checked.
  4577. CONDITIONS is a list of symbols, boolean OR is used to combine the results
  4578. from different tests. Valid conditions are:
  4579. scheduled Check if there is a scheduled cookie
  4580. notscheduled Check if there is no scheduled cookie
  4581. deadline Check if there is a deadline
  4582. notdeadline Check if there is no deadline
  4583. timestamp Check if there is a timestamp (also deadline or scheduled)
  4584. nottimestamp Check if there is no timestamp (also deadline or scheduled)
  4585. regexp Check if regexp matches
  4586. notregexp Check if regexp does not match.
  4587. todo Check if TODO keyword matches
  4588. nottodo Check if TODO keyword does not match
  4589. The regexp is taken from the conditions list, it must come right after
  4590. the `regexp' or `notregexp' element.
  4591. `todo' and `nottodo' accept as an argument a list of todo
  4592. keywords, which may include \"*\" to match any todo keyword.
  4593. (org-agenda-skip-entry-if \\='todo \\='(\"TODO\" \"WAITING\"))
  4594. would skip all entries with \"TODO\" or \"WAITING\" keywords.
  4595. Instead of a list, a keyword class may be given. For example:
  4596. (org-agenda-skip-entry-if \\='nottodo \\='done)
  4597. would skip entries that haven't been marked with any of \"DONE\"
  4598. keywords. Possible classes are: `todo', `done', `any'.
  4599. If any of these conditions is met, this function returns the end point of
  4600. the entity, causing the search to continue from there. This is a function
  4601. that can be put into `org-agenda-skip-function' for the duration of a command."
  4602. (org-back-to-heading t)
  4603. (let* ((beg (point))
  4604. (end (if subtree (save-excursion (org-end-of-subtree t) (point))
  4605. (org-entry-end-position)))
  4606. (planning-end (if subtree end (line-end-position 2)))
  4607. m)
  4608. (and
  4609. (or (and (memq 'scheduled conditions)
  4610. (re-search-forward org-scheduled-time-regexp planning-end t))
  4611. (and (memq 'notscheduled conditions)
  4612. (not
  4613. (save-excursion
  4614. (re-search-forward org-scheduled-time-regexp planning-end t))))
  4615. (and (memq 'deadline conditions)
  4616. (re-search-forward org-deadline-time-regexp planning-end t))
  4617. (and (memq 'notdeadline conditions)
  4618. (not
  4619. (save-excursion
  4620. (re-search-forward org-deadline-time-regexp planning-end t))))
  4621. (and (memq 'timestamp conditions)
  4622. (re-search-forward org-ts-regexp end t))
  4623. (and (memq 'nottimestamp conditions)
  4624. (not (save-excursion (re-search-forward org-ts-regexp end t))))
  4625. (and (setq m (memq 'regexp conditions))
  4626. (stringp (nth 1 m))
  4627. (re-search-forward (nth 1 m) end t))
  4628. (and (setq m (memq 'notregexp conditions))
  4629. (stringp (nth 1 m))
  4630. (not (save-excursion (re-search-forward (nth 1 m) end t))))
  4631. (and (or
  4632. (setq m (memq 'nottodo conditions))
  4633. (setq m (memq 'todo-unblocked conditions))
  4634. (setq m (memq 'nottodo-unblocked conditions))
  4635. (setq m (memq 'todo conditions)))
  4636. (org-agenda-skip-if-todo m end)))
  4637. end)))
  4638. (defun org-agenda-skip-if-todo (args end)
  4639. "Helper function for `org-agenda-skip-if', do not use it directly.
  4640. ARGS is a list with first element either `todo', `nottodo',
  4641. `todo-unblocked' or `nottodo-unblocked'. The remainder is either
  4642. a list of TODO keywords, or a state symbol `todo' or `done' or
  4643. `any'."
  4644. (let ((todo-re
  4645. (concat "^\\*+[ \t]+"
  4646. (regexp-opt
  4647. (pcase args
  4648. (`(,_ todo)
  4649. (org-delete-all org-done-keywords
  4650. (copy-sequence org-todo-keywords-1)))
  4651. (`(,_ done) org-done-keywords)
  4652. (`(,_ any) org-todo-keywords-1)
  4653. (`(,_ ,(pred atom))
  4654. (error "Invalid TODO class or type: %S" args))
  4655. (`(,_ ,(pred (member "*"))) org-todo-keywords-1)
  4656. (`(,_ ,todo-list) todo-list))
  4657. 'words))))
  4658. (pcase args
  4659. (`(todo . ,_)
  4660. (let (case-fold-search) (re-search-forward todo-re end t)))
  4661. (`(nottodo . ,_)
  4662. (not (let (case-fold-search) (re-search-forward todo-re end t))))
  4663. (`(todo-unblocked . ,_)
  4664. (catch :unblocked
  4665. (while (let (case-fold-search) (re-search-forward todo-re end t))
  4666. (when (org-entry-blocked-p) (throw :unblocked t)))
  4667. nil))
  4668. (`(nottodo-unblocked . ,_)
  4669. (catch :unblocked
  4670. (while (let (case-fold-search) (re-search-forward todo-re end t))
  4671. (when (org-entry-blocked-p) (throw :unblocked nil)))
  4672. t))
  4673. (`(,type . ,_) (error "Unknown TODO skip type: %S" type)))))
  4674. ;;;###autoload
  4675. (defun org-agenda-list-stuck-projects (&rest ignore)
  4676. "Create agenda view for projects that are stuck.
  4677. Stuck projects are project that have no next actions. For the definitions
  4678. of what a project is and how to check if it stuck, customize the variable
  4679. `org-stuck-projects'."
  4680. (interactive)
  4681. (let* ((org-agenda-overriding-header
  4682. (or org-agenda-overriding-header "List of stuck projects: "))
  4683. (matcher (nth 0 org-stuck-projects))
  4684. (todo (nth 1 org-stuck-projects))
  4685. (tags (nth 2 org-stuck-projects))
  4686. (gen-re (org-string-nw-p (nth 3 org-stuck-projects)))
  4687. (todo-wds
  4688. (if (not (member "*" todo)) todo
  4689. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  4690. (org-delete-all org-done-keywords-for-agenda
  4691. (copy-sequence org-todo-keywords-for-agenda))))
  4692. (todo-re (and todo
  4693. (format "^\\*+[ \t]+\\(%s\\)\\>"
  4694. (mapconcat #'identity todo-wds "\\|"))))
  4695. (tags-re (cond ((null tags) nil)
  4696. ((member "*" tags) org-tag-line-re)
  4697. (tags
  4698. (let ((other-tags (format "\\(?:%s:\\)*" org-tag-re)))
  4699. (concat org-outline-regexp-bol
  4700. ".*?[ \t]:"
  4701. other-tags
  4702. (regexp-opt tags t)
  4703. ":" other-tags "[ \t]*$")))
  4704. (t nil)))
  4705. (re-list (delq nil (list todo-re tags-re gen-re)))
  4706. (skip-re
  4707. (if (null re-list)
  4708. (error "Missing information to identify unstuck projects")
  4709. (mapconcat #'identity re-list "\\|")))
  4710. (org-agenda-skip-function
  4711. ;; Skip entry if `org-agenda-skip-regexp' matches anywhere
  4712. ;; in the subtree.
  4713. `(lambda ()
  4714. (and (save-excursion
  4715. (let ((case-fold-search nil))
  4716. (re-search-forward
  4717. ,skip-re (save-excursion (org-end-of-subtree t)) t)))
  4718. (progn (outline-next-heading) (point))))))
  4719. (org-tags-view nil matcher)
  4720. (setq org-agenda-buffer-name (buffer-name))
  4721. (with-current-buffer org-agenda-buffer-name
  4722. (setq org-agenda-redo-command
  4723. `(org-agenda-list-stuck-projects ,current-prefix-arg))
  4724. (let ((inhibit-read-only t))
  4725. (add-text-properties
  4726. (point-min) (point-max)
  4727. `(org-redo-cmd ,org-agenda-redo-command))))))
  4728. ;;; Diary integration
  4729. (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
  4730. (defvar diary-list-entries-hook)
  4731. (defvar diary-time-regexp)
  4732. (defun org-get-entries-from-diary (date)
  4733. "Get the (Emacs Calendar) diary entries for DATE."
  4734. (require 'diary-lib)
  4735. (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
  4736. (diary-display-function 'diary-fancy-display)
  4737. (pop-up-frames nil)
  4738. (diary-list-entries-hook
  4739. (cons 'org-diary-default-entry diary-list-entries-hook))
  4740. (diary-file-name-prefix nil) ; turn this feature off
  4741. (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
  4742. (diary-time-regexp (concat "^" diary-time-regexp))
  4743. entries
  4744. (org-disable-agenda-to-diary t))
  4745. (save-excursion
  4746. (save-window-excursion
  4747. (funcall (if (fboundp 'diary-list-entries)
  4748. 'diary-list-entries 'list-diary-entries)
  4749. date 1)))
  4750. (if (not (get-buffer diary-fancy-buffer))
  4751. (setq entries nil)
  4752. (with-current-buffer diary-fancy-buffer
  4753. (setq buffer-read-only nil)
  4754. (if (zerop (buffer-size))
  4755. ;; No entries
  4756. (setq entries nil)
  4757. ;; Omit the date and other unnecessary stuff
  4758. (org-agenda-cleanup-fancy-diary)
  4759. ;; Add prefix to each line and extend the text properties
  4760. (if (zerop (buffer-size))
  4761. (setq entries nil)
  4762. (setq entries (buffer-substring (point-min) (- (point-max) 1)))
  4763. (setq entries
  4764. (with-temp-buffer
  4765. (insert entries) (goto-char (point-min))
  4766. (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
  4767. (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
  4768. (replace-match (concat "; " (match-string 1)))))
  4769. (buffer-string)))))
  4770. (set-buffer-modified-p nil)
  4771. (kill-buffer diary-fancy-buffer)))
  4772. (when entries
  4773. (setq entries (org-split-string entries "\n"))
  4774. (setq entries
  4775. (mapcar
  4776. (lambda (x)
  4777. (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
  4778. ;; Extend the text properties to the beginning of the line
  4779. (org-add-props x (text-properties-at (1- (length x)) x)
  4780. 'type "diary" 'date date 'face 'org-agenda-diary))
  4781. entries)))))
  4782. (defvar org-agenda-cleanup-fancy-diary-hook nil
  4783. "Hook run when the fancy diary buffer is cleaned up.")
  4784. (defun org-agenda-cleanup-fancy-diary ()
  4785. "Remove unwanted stuff in buffer created by `fancy-diary-display'.
  4786. This gets rid of the date, the underline under the date, and the
  4787. dummy entry installed by Org mode to ensure non-empty diary for
  4788. each date. It also removes lines that contain only whitespace."
  4789. (goto-char (point-min))
  4790. (if (looking-at ".*?:[ \t]*")
  4791. (progn
  4792. (replace-match "")
  4793. (re-search-forward "\n=+$" nil t)
  4794. (replace-match "")
  4795. (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
  4796. (re-search-forward "\n=+$" nil t)
  4797. (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
  4798. (goto-char (point-min))
  4799. (while (re-search-forward "^ +\n" nil t)
  4800. (replace-match ""))
  4801. (goto-char (point-min))
  4802. (when (re-search-forward "^Org mode dummy\n?" nil t)
  4803. (replace-match ""))
  4804. (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
  4805. (defun org-modify-diary-entry-string (string)
  4806. "Add text properties to string, allowing Org to act on it."
  4807. (org-add-props string nil
  4808. 'mouse-face 'highlight
  4809. 'help-echo (if buffer-file-name
  4810. (format "mouse-2 or RET jump to diary file %s"
  4811. (abbreviate-file-name buffer-file-name))
  4812. "")
  4813. 'org-agenda-diary-link t
  4814. 'org-marker (org-agenda-new-marker (point-at-bol))))
  4815. (defun org-diary-default-entry ()
  4816. "Add a dummy entry to the diary.
  4817. Needed to avoid empty dates which mess up holiday display."
  4818. ;; Catch the error if dealing with the new add-to-diary-alist
  4819. (when org-disable-agenda-to-diary
  4820. (condition-case nil
  4821. (org-add-to-diary-list original-date "Org mode dummy" "")
  4822. (error
  4823. (org-add-to-diary-list original-date "Org mode dummy" "" nil)))))
  4824. (defun org-add-to-diary-list (&rest args)
  4825. (if (fboundp 'diary-add-to-list)
  4826. (apply 'diary-add-to-list args)
  4827. (apply 'add-to-diary-list args)))
  4828. (defvar org-diary-last-run-time nil)
  4829. ;;;###autoload
  4830. (defun org-diary (&rest args)
  4831. "Return diary information from org files.
  4832. This function can be used in a \"sexp\" diary entry in the Emacs calendar.
  4833. It accesses org files and extracts information from those files to be
  4834. listed in the diary. The function accepts arguments specifying what
  4835. items should be listed. For a list of arguments allowed here, see the
  4836. variable `org-agenda-entry-types'.
  4837. The call in the diary file should look like this:
  4838. &%%(org-diary) ~/path/to/some/orgfile.org
  4839. Use a separate line for each org file to check. Or, if you omit the file name,
  4840. all files listed in `org-agenda-files' will be checked automatically:
  4841. &%%(org-diary)
  4842. If you don't give any arguments (as in the example above), the default value
  4843. of `org-agenda-entry-types' is used: (:deadline :scheduled :timestamp :sexp).
  4844. So the example above may also be written as
  4845. &%%(org-diary :deadline :timestamp :sexp :scheduled)
  4846. The function expects the lisp variables `entry' and `date' to be provided
  4847. by the caller, because this is how the calendar works. Don't use this
  4848. function from a program - use `org-agenda-get-day-entries' instead."
  4849. (when (> (- (float-time)
  4850. org-agenda-last-marker-time)
  4851. 5)
  4852. ;; I am not sure if this works with sticky agendas, because the marker
  4853. ;; list is then no longer a global variable.
  4854. (org-agenda-reset-markers))
  4855. (org-compile-prefix-format 'agenda)
  4856. (org-set-sorting-strategy 'agenda)
  4857. (setq args (or args org-agenda-entry-types))
  4858. (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
  4859. (list entry)
  4860. (org-agenda-files t)))
  4861. (time (float-time))
  4862. file rtn results)
  4863. (when (or (not org-diary-last-run-time)
  4864. (> (- time
  4865. org-diary-last-run-time)
  4866. 3))
  4867. (org-agenda-prepare-buffers files))
  4868. (setq org-diary-last-run-time time)
  4869. ;; If this is called during org-agenda, don't return any entries to
  4870. ;; the calendar. Org Agenda will list these entries itself.
  4871. (when org-disable-agenda-to-diary (setq files nil))
  4872. (while (setq file (pop files))
  4873. (setq rtn (apply 'org-agenda-get-day-entries file date args))
  4874. (setq results (append results rtn)))
  4875. (when results
  4876. (setq results
  4877. (mapcar (lambda (i) (replace-regexp-in-string
  4878. org-link-bracket-re "\\2" i)) results))
  4879. (concat (org-agenda-finalize-entries results) "\n"))))
  4880. ;;; Agenda entry finders
  4881. (defun org-agenda--timestamp-to-absolute (&rest args)
  4882. "Call `org-time-string-to-absolute' with ARGS.
  4883. However, throw `:skip' whenever an error is raised."
  4884. (condition-case e
  4885. (apply #'org-time-string-to-absolute args)
  4886. (org-diary-sexp-no-match (throw :skip nil))
  4887. (error
  4888. (message "%s; Skipping entry" (error-message-string e))
  4889. (throw :skip nil))))
  4890. (defun org-agenda-get-day-entries (file date &rest args)
  4891. "Does the work for `org-diary' and `org-agenda'.
  4892. FILE is the path to a file to be checked for entries. DATE is date like
  4893. the one returned by `calendar-current-date'. ARGS are symbols indicating
  4894. which kind of entries should be extracted. For details about these, see
  4895. the documentation of `org-diary'."
  4896. (let* ((org-startup-folded nil)
  4897. (org-startup-align-all-tables nil)
  4898. (buffer (if (file-exists-p file) (org-get-agenda-file-buffer file)
  4899. (error "No such file %s" file))))
  4900. (if (not buffer)
  4901. ;; If file does not exist, signal it in diary nonetheless.
  4902. (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4903. (with-current-buffer buffer
  4904. (unless (derived-mode-p 'org-mode)
  4905. (error "Agenda file %s is not in Org mode" file))
  4906. (setq org-agenda-buffer (or org-agenda-buffer buffer))
  4907. (setf org-agenda-current-date date)
  4908. (save-excursion
  4909. (save-restriction
  4910. (if (eq buffer org-agenda-restrict)
  4911. (narrow-to-region org-agenda-restrict-begin
  4912. org-agenda-restrict-end)
  4913. (widen))
  4914. ;; Rationalize ARGS. Also make sure `:deadline' comes
  4915. ;; first in order to populate DEADLINES before passing it.
  4916. ;;
  4917. ;; We use `delq' since `org-uniquify' duplicates ARGS,
  4918. ;; guarding us from modifying `org-agenda-entry-types'.
  4919. (setf args (org-uniquify (or args org-agenda-entry-types)))
  4920. (when (and (memq :scheduled args) (memq :scheduled* args))
  4921. (setf args (delq :scheduled* args)))
  4922. (cond
  4923. ((memq :deadline args)
  4924. (setf args (cons :deadline
  4925. (delq :deadline (delq :deadline* args)))))
  4926. ((memq :deadline* args)
  4927. (setf args (cons :deadline* (delq :deadline* args)))))
  4928. ;; Collect list of headlines. Return them flattened.
  4929. (let ((case-fold-search nil) results deadlines)
  4930. (dolist (arg args (apply #'nconc (nreverse results)))
  4931. (pcase arg
  4932. ((and :todo (guard (org-agenda-today-p date)))
  4933. (push (org-agenda-get-todos) results))
  4934. (:timestamp
  4935. (push (org-agenda-get-blocks) results)
  4936. (push (org-agenda-get-timestamps deadlines) results))
  4937. (:sexp
  4938. (push (org-agenda-get-sexps) results))
  4939. (:scheduled
  4940. (push (org-agenda-get-scheduled deadlines) results))
  4941. (:scheduled*
  4942. (push (org-agenda-get-scheduled deadlines t) results))
  4943. (:closed
  4944. (push (org-agenda-get-progress) results))
  4945. (:deadline
  4946. (setf deadlines (org-agenda-get-deadlines))
  4947. (push deadlines results))
  4948. (:deadline*
  4949. (setf deadlines (org-agenda-get-deadlines t))
  4950. (push deadlines results)))))))))))
  4951. (defsubst org-em (x y list)
  4952. "Is X or Y a member of LIST?"
  4953. (or (memq x list) (memq y list)))
  4954. (defvar org-heading-keyword-regexp-format) ; defined in org.el
  4955. (defvar org-agenda-sorting-strategy-selected nil)
  4956. (defun org-agenda-entry-get-agenda-timestamp (pom)
  4957. "Retrieve timestamp information for sorting agenda views.
  4958. Given a point or marker POM, returns a cons cell of the timestamp
  4959. and the timestamp type relevant for the sorting strategy in
  4960. `org-agenda-sorting-strategy-selected'."
  4961. (let (ts ts-date-type)
  4962. (save-match-data
  4963. (cond ((org-em 'scheduled-up 'scheduled-down
  4964. org-agenda-sorting-strategy-selected)
  4965. (setq ts (org-entry-get pom "SCHEDULED")
  4966. ts-date-type " scheduled"))
  4967. ((org-em 'deadline-up 'deadline-down
  4968. org-agenda-sorting-strategy-selected)
  4969. (setq ts (org-entry-get pom "DEADLINE")
  4970. ts-date-type " deadline"))
  4971. ((org-em 'ts-up 'ts-down
  4972. org-agenda-sorting-strategy-selected)
  4973. (setq ts (org-entry-get pom "TIMESTAMP")
  4974. ts-date-type " timestamp"))
  4975. ((org-em 'tsia-up 'tsia-down
  4976. org-agenda-sorting-strategy-selected)
  4977. (setq ts (org-entry-get pom "TIMESTAMP_IA")
  4978. ts-date-type " timestamp_ia"))
  4979. ((org-em 'timestamp-up 'timestamp-down
  4980. org-agenda-sorting-strategy-selected)
  4981. (setq ts (or (org-entry-get pom "SCHEDULED")
  4982. (org-entry-get pom "DEADLINE")
  4983. (org-entry-get pom "TIMESTAMP")
  4984. (org-entry-get pom "TIMESTAMP_IA"))
  4985. ts-date-type ""))
  4986. (t (setq ts-date-type "")))
  4987. (cons (when ts (ignore-errors (org-time-string-to-absolute ts)))
  4988. ts-date-type))))
  4989. (defun org-agenda-get-todos ()
  4990. "Return the TODO information for agenda display."
  4991. (let* ((props (list 'face nil
  4992. 'done-face 'org-agenda-done
  4993. 'org-not-done-regexp org-not-done-regexp
  4994. 'org-todo-regexp org-todo-regexp
  4995. 'org-complex-heading-regexp org-complex-heading-regexp
  4996. 'mouse-face 'highlight
  4997. 'help-echo
  4998. (format "mouse-2 or RET jump to org file %s"
  4999. (abbreviate-file-name buffer-file-name))))
  5000. (case-fold-search nil)
  5001. (regexp (format org-heading-keyword-regexp-format
  5002. (cond
  5003. ((and org-select-this-todo-keyword
  5004. (equal org-select-this-todo-keyword "*"))
  5005. org-todo-regexp)
  5006. (org-select-this-todo-keyword
  5007. (concat "\\("
  5008. (mapconcat 'identity
  5009. (org-split-string
  5010. org-select-this-todo-keyword
  5011. "|")
  5012. "\\|") "\\)"))
  5013. (t org-not-done-regexp))))
  5014. marker priority category level tags todo-state
  5015. ts-date ts-date-type ts-date-pair
  5016. ee txt beg end inherited-tags todo-state-end-pos)
  5017. (goto-char (point-min))
  5018. (while (re-search-forward regexp nil t)
  5019. (catch :skip
  5020. (save-match-data
  5021. (beginning-of-line)
  5022. (org-agenda-skip)
  5023. (setq beg (point) end (save-excursion (outline-next-heading) (point)))
  5024. (unless (and (setq todo-state (org-get-todo-state))
  5025. (setq todo-state-end-pos (match-end 2)))
  5026. (goto-char end)
  5027. (throw :skip nil))
  5028. (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
  5029. (goto-char (1+ beg))
  5030. (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
  5031. (throw :skip nil)))
  5032. (goto-char (match-beginning 2))
  5033. (setq marker (org-agenda-new-marker (match-beginning 0))
  5034. category (org-get-category)
  5035. ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
  5036. ts-date (car ts-date-pair)
  5037. ts-date-type (cdr ts-date-pair)
  5038. txt (org-trim (buffer-substring (match-beginning 2) (match-end 0)))
  5039. inherited-tags
  5040. (or (eq org-agenda-show-inherited-tags 'always)
  5041. (and (listp org-agenda-show-inherited-tags)
  5042. (memq 'todo org-agenda-show-inherited-tags))
  5043. (and (eq org-agenda-show-inherited-tags t)
  5044. (or (eq org-agenda-use-tag-inheritance t)
  5045. (memq 'todo org-agenda-use-tag-inheritance))))
  5046. tags (org-get-tags nil (not inherited-tags))
  5047. level (make-string (org-reduced-level (org-outline-level)) ? )
  5048. txt (org-agenda-format-item "" txt level category tags t)
  5049. priority (1+ (org-get-priority txt)))
  5050. (org-add-props txt props
  5051. 'org-marker marker 'org-hd-marker marker
  5052. 'priority priority
  5053. 'level level
  5054. 'ts-date ts-date
  5055. 'type (concat "todo" ts-date-type) 'todo-state todo-state)
  5056. (push txt ee)
  5057. (if org-agenda-todo-list-sublevels
  5058. (goto-char todo-state-end-pos)
  5059. (org-end-of-subtree 'invisible))))
  5060. (nreverse ee)))
  5061. (defun org-agenda-todo-custom-ignore-p (time n)
  5062. "Check whether timestamp is farther away than n number of days.
  5063. This function is invoked if `org-agenda-todo-ignore-deadlines',
  5064. `org-agenda-todo-ignore-scheduled' or
  5065. `org-agenda-todo-ignore-timestamp' is set to an integer."
  5066. (let ((days (org-time-stamp-to-now
  5067. time org-agenda-todo-ignore-time-comparison-use-seconds)))
  5068. (if (>= n 0)
  5069. (>= days n)
  5070. (<= days n))))
  5071. ;;;###autoload
  5072. (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  5073. (&optional end)
  5074. "Do we have a reason to ignore this TODO entry because it has a time stamp?"
  5075. (when (or org-agenda-todo-ignore-with-date
  5076. org-agenda-todo-ignore-scheduled
  5077. org-agenda-todo-ignore-deadlines
  5078. org-agenda-todo-ignore-timestamp)
  5079. (setq end (or end (save-excursion (outline-next-heading) (point))))
  5080. (save-excursion
  5081. (or (and org-agenda-todo-ignore-with-date
  5082. (re-search-forward org-ts-regexp end t))
  5083. (and org-agenda-todo-ignore-scheduled
  5084. (re-search-forward org-scheduled-time-regexp end t)
  5085. (cond
  5086. ((eq org-agenda-todo-ignore-scheduled 'future)
  5087. (> (org-time-stamp-to-now
  5088. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5089. ((eq org-agenda-todo-ignore-scheduled 'past)
  5090. (<= (org-time-stamp-to-now
  5091. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5092. ((numberp org-agenda-todo-ignore-scheduled)
  5093. (org-agenda-todo-custom-ignore-p
  5094. (match-string 1) org-agenda-todo-ignore-scheduled))
  5095. (t)))
  5096. (and org-agenda-todo-ignore-deadlines
  5097. (re-search-forward org-deadline-time-regexp end t)
  5098. (cond
  5099. ((eq org-agenda-todo-ignore-deadlines 'all) t)
  5100. ((eq org-agenda-todo-ignore-deadlines 'far)
  5101. (not (org-deadline-close-p (match-string 1))))
  5102. ((eq org-agenda-todo-ignore-deadlines 'future)
  5103. (> (org-time-stamp-to-now
  5104. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5105. ((eq org-agenda-todo-ignore-deadlines 'past)
  5106. (<= (org-time-stamp-to-now
  5107. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5108. ((numberp org-agenda-todo-ignore-deadlines)
  5109. (org-agenda-todo-custom-ignore-p
  5110. (match-string 1) org-agenda-todo-ignore-deadlines))
  5111. (t (org-deadline-close-p (match-string 1)))))
  5112. (and org-agenda-todo-ignore-timestamp
  5113. (let ((buffer (current-buffer))
  5114. (regexp
  5115. (concat
  5116. org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
  5117. (start (point)))
  5118. ;; Copy current buffer into a temporary one
  5119. (with-temp-buffer
  5120. (insert-buffer-substring buffer start end)
  5121. (goto-char (point-min))
  5122. ;; Delete SCHEDULED and DEADLINE items
  5123. (while (re-search-forward regexp end t)
  5124. (delete-region (match-beginning 0) (match-end 0)))
  5125. (goto-char (point-min))
  5126. ;; No search for timestamp left
  5127. (when (re-search-forward org-ts-regexp nil t)
  5128. (cond
  5129. ((eq org-agenda-todo-ignore-timestamp 'future)
  5130. (> (org-time-stamp-to-now
  5131. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5132. ((eq org-agenda-todo-ignore-timestamp 'past)
  5133. (<= (org-time-stamp-to-now
  5134. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  5135. ((numberp org-agenda-todo-ignore-timestamp)
  5136. (org-agenda-todo-custom-ignore-p
  5137. (match-string 1) org-agenda-todo-ignore-timestamp))
  5138. (t))))))))))
  5139. (defun org-agenda-get-timestamps (&optional deadlines)
  5140. "Return the date stamp information for agenda display.
  5141. Optional argument DEADLINES is a list of deadline items to be
  5142. displayed in agenda view."
  5143. (let* ((props (list 'face 'org-agenda-calendar-event
  5144. 'org-not-done-regexp org-not-done-regexp
  5145. 'org-todo-regexp org-todo-regexp
  5146. 'org-complex-heading-regexp org-complex-heading-regexp
  5147. 'mouse-face 'highlight
  5148. 'help-echo
  5149. (format "mouse-2 or RET jump to Org file %s"
  5150. (abbreviate-file-name buffer-file-name))))
  5151. (current (calendar-absolute-from-gregorian date))
  5152. (today (org-today))
  5153. (deadline-position-alist
  5154. (mapcar (lambda (d)
  5155. (let ((m (get-text-property 0 'org-hd-marker d)))
  5156. (and m (marker-position m))))
  5157. deadlines))
  5158. ;; Match time-stamps set to current date, time-stamps with
  5159. ;; a repeater, and S-exp time-stamps.
  5160. (regexp
  5161. (concat
  5162. (if org-agenda-include-inactive-timestamps "[[<]" "<")
  5163. (regexp-quote
  5164. (substring
  5165. (format-time-string
  5166. (car org-time-stamp-formats)
  5167. (encode-time ; DATE bound by calendar
  5168. 0 0 0 (nth 1 date) (car date) (nth 2 date)))
  5169. 1 11))
  5170. "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
  5171. "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
  5172. timestamp-items)
  5173. (goto-char (point-min))
  5174. (while (re-search-forward regexp nil t)
  5175. ;; Skip date ranges, scheduled and deadlines, which are handled
  5176. ;; specially. Also skip time-stamps before first headline as
  5177. ;; there would be no entry to add to the agenda. Eventually,
  5178. ;; ignore clock entries.
  5179. (catch :skip
  5180. (save-match-data
  5181. (when (or (org-at-date-range-p)
  5182. (org-at-planning-p)
  5183. (org-before-first-heading-p)
  5184. (and org-agenda-include-inactive-timestamps
  5185. (org-at-clock-log-p)))
  5186. (throw :skip nil))
  5187. (org-agenda-skip))
  5188. (let* ((pos (match-beginning 0))
  5189. (repeat (match-string 1))
  5190. (sexp-entry (match-string 3))
  5191. (time-stamp (if (or repeat sexp-entry) (match-string 0)
  5192. (save-excursion
  5193. (goto-char pos)
  5194. (looking-at org-ts-regexp-both)
  5195. (match-string 0))))
  5196. (todo-state (org-get-todo-state))
  5197. (warntime (get-text-property (point) 'org-appt-warntime))
  5198. (done? (member todo-state org-done-keywords)))
  5199. ;; Possibly skip done tasks.
  5200. (when (and done? org-agenda-skip-timestamp-if-done)
  5201. (throw :skip t))
  5202. ;; S-exp entry doesn't match current day: skip it.
  5203. (when (and sexp-entry (not (org-diary-sexp-entry sexp-entry "" date)))
  5204. (throw :skip nil))
  5205. (when repeat
  5206. (let* ((past
  5207. ;; A repeating time stamp is shown at its base
  5208. ;; date and every repeated date up to TODAY. If
  5209. ;; `org-agenda-prefer-last-repeat' is non-nil,
  5210. ;; however, only the last repeat before today
  5211. ;; (inclusive) is shown.
  5212. (org-agenda--timestamp-to-absolute
  5213. repeat
  5214. (if (or (> current today)
  5215. (eq org-agenda-prefer-last-repeat t)
  5216. (member todo-state org-agenda-prefer-last-repeat))
  5217. today
  5218. current)
  5219. 'past (current-buffer) pos))
  5220. (future
  5221. ;; Display every repeated date past TODAY
  5222. ;; (exclusive) unless
  5223. ;; `org-agenda-show-future-repeats' is nil. If
  5224. ;; this variable is set to `next', only display
  5225. ;; the first repeated date after TODAY
  5226. ;; (exclusive).
  5227. (cond
  5228. ((<= current today) past)
  5229. ((not org-agenda-show-future-repeats) past)
  5230. (t
  5231. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5232. (1+ today)
  5233. current)))
  5234. (org-agenda--timestamp-to-absolute
  5235. repeat base 'future (current-buffer) pos))))))
  5236. (when (and (/= current past) (/= current future))
  5237. (throw :skip nil))))
  5238. (save-excursion
  5239. (re-search-backward org-outline-regexp-bol nil t)
  5240. ;; Possibly skip time-stamp when a deadline is set.
  5241. (when (and org-agenda-skip-timestamp-if-deadline-is-shown
  5242. (assq (point) deadline-position-alist))
  5243. (throw :skip nil))
  5244. (let* ((category (org-get-category pos))
  5245. (inherited-tags
  5246. (or (eq org-agenda-show-inherited-tags 'always)
  5247. (and (consp org-agenda-show-inherited-tags)
  5248. (memq 'agenda org-agenda-show-inherited-tags))
  5249. (and (eq org-agenda-show-inherited-tags t)
  5250. (or (eq org-agenda-use-tag-inheritance t)
  5251. (memq 'agenda
  5252. org-agenda-use-tag-inheritance)))))
  5253. (tags (org-get-tags nil (not inherited-tags)))
  5254. (level (make-string (org-reduced-level (org-outline-level))
  5255. ?\s))
  5256. (head (and (looking-at "\\*+[ \t]+\\(.*\\)")
  5257. (match-string 1)))
  5258. (inactive? (= (char-after pos) ?\[))
  5259. (habit? (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  5260. (item
  5261. (org-agenda-format-item
  5262. (and inactive? org-agenda-inactive-leader)
  5263. head level category tags time-stamp org-ts-regexp habit?)))
  5264. (org-add-props item props
  5265. 'priority (if habit?
  5266. (org-habit-get-priority (org-habit-parse-todo))
  5267. (org-get-priority item))
  5268. 'org-marker (org-agenda-new-marker pos)
  5269. 'org-hd-marker (org-agenda-new-marker)
  5270. 'date date
  5271. 'level level
  5272. 'ts-date (if repeat (org-agenda--timestamp-to-absolute repeat)
  5273. current)
  5274. 'todo-state todo-state
  5275. 'warntime warntime
  5276. 'type "timestamp")
  5277. (push item timestamp-items))))
  5278. (when org-agenda-skip-additional-timestamps-same-entry
  5279. (outline-next-heading))))
  5280. (nreverse timestamp-items)))
  5281. (defun org-agenda-get-sexps ()
  5282. "Return the sexp information for agenda display."
  5283. (require 'diary-lib)
  5284. (let* ((props (list 'face 'org-agenda-calendar-sexp
  5285. 'mouse-face 'highlight
  5286. 'help-echo
  5287. (format "mouse-2 or RET jump to org file %s"
  5288. (abbreviate-file-name buffer-file-name))))
  5289. (regexp "^&?%%(")
  5290. marker category extra level ee txt tags entry
  5291. result beg b sexp sexp-entry todo-state warntime inherited-tags)
  5292. (goto-char (point-min))
  5293. (while (re-search-forward regexp nil t)
  5294. (catch :skip
  5295. (org-agenda-skip)
  5296. (setq beg (match-beginning 0))
  5297. (goto-char (1- (match-end 0)))
  5298. (setq b (point))
  5299. (forward-sexp 1)
  5300. (setq sexp (buffer-substring b (point)))
  5301. (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
  5302. (org-trim (match-string 1))
  5303. ""))
  5304. (setq result (org-diary-sexp-entry sexp sexp-entry date))
  5305. (when result
  5306. (setq marker (org-agenda-new-marker beg)
  5307. level (make-string (org-reduced-level (org-outline-level)) ? )
  5308. category (org-get-category beg)
  5309. inherited-tags
  5310. (or (eq org-agenda-show-inherited-tags 'always)
  5311. (and (listp org-agenda-show-inherited-tags)
  5312. (memq 'agenda org-agenda-show-inherited-tags))
  5313. (and (eq org-agenda-show-inherited-tags t)
  5314. (or (eq org-agenda-use-tag-inheritance t)
  5315. (memq 'agenda org-agenda-use-tag-inheritance))))
  5316. tags (org-get-tags nil (not inherited-tags))
  5317. todo-state (org-get-todo-state)
  5318. warntime (get-text-property (point) 'org-appt-warntime)
  5319. extra nil)
  5320. (dolist (r (if (stringp result)
  5321. (list result)
  5322. result)) ;; we expect a list here
  5323. (when (and org-agenda-diary-sexp-prefix
  5324. (string-match org-agenda-diary-sexp-prefix r))
  5325. (setq extra (match-string 0 r)
  5326. r (replace-match "" nil nil r)))
  5327. (if (string-match "\\S-" r)
  5328. (setq txt r)
  5329. (setq txt "SEXP entry returned empty string"))
  5330. (setq txt (org-agenda-format-item extra txt level category tags 'time))
  5331. (org-add-props txt props 'org-marker marker
  5332. 'date date 'todo-state todo-state
  5333. 'level level 'type "sexp" 'warntime warntime)
  5334. (push txt ee)))))
  5335. (nreverse ee)))
  5336. ;; Calendar sanity: define some functions that are independent of
  5337. ;; `calendar-date-style'.
  5338. (defun org-anniversary (year month day &optional mark)
  5339. "Like `diary-anniversary', but with fixed (ISO) order of arguments."
  5340. (with-no-warnings
  5341. (let ((calendar-date-style 'iso))
  5342. (diary-anniversary year month day mark))))
  5343. (defun org-cyclic (N year month day &optional mark)
  5344. "Like `diary-cyclic', but with fixed (ISO) order of arguments."
  5345. (with-no-warnings
  5346. (let ((calendar-date-style 'iso))
  5347. (diary-cyclic N year month day mark))))
  5348. (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
  5349. "Like `diary-block', but with fixed (ISO) order of arguments."
  5350. (with-no-warnings
  5351. (let ((calendar-date-style 'iso))
  5352. (diary-block Y1 M1 D1 Y2 M2 D2 mark))))
  5353. (defun org-date (year month day &optional mark)
  5354. "Like `diary-date', but with fixed (ISO) order of arguments."
  5355. (with-no-warnings
  5356. (let ((calendar-date-style 'iso))
  5357. (diary-date year month day mark))))
  5358. ;; Define the `org-class' function
  5359. (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
  5360. "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
  5361. DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
  5362. SKIP-WEEKS is any number of ISO weeks in the block period for which the
  5363. item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
  5364. `holidays', then any date that is known by the Emacs calendar to be a
  5365. holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
  5366. then those holidays will be skipped."
  5367. (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
  5368. (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
  5369. (d (calendar-absolute-from-gregorian date))
  5370. (h (when skip-weeks (calendar-check-holidays date))))
  5371. (and
  5372. (<= date1 d)
  5373. (<= d date2)
  5374. (= (calendar-day-of-week date) dayname)
  5375. (or (not skip-weeks)
  5376. (progn
  5377. (require 'cal-iso)
  5378. (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
  5379. (not (or (and h (memq 'holidays skip-weeks))
  5380. (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
  5381. entry)))
  5382. (defalias 'org-get-closed 'org-agenda-get-progress)
  5383. (defun org-agenda-get-progress ()
  5384. "Return the logged TODO entries for agenda display."
  5385. (let* ((props (list 'mouse-face 'highlight
  5386. 'org-not-done-regexp org-not-done-regexp
  5387. 'org-todo-regexp org-todo-regexp
  5388. 'org-complex-heading-regexp org-complex-heading-regexp
  5389. 'help-echo
  5390. (format "mouse-2 or RET jump to org file %s"
  5391. (abbreviate-file-name buffer-file-name))))
  5392. (items (if (consp org-agenda-show-log-scoped)
  5393. org-agenda-show-log-scoped
  5394. (if (eq org-agenda-show-log-scoped 'clockcheck)
  5395. '(clock)
  5396. org-agenda-log-mode-items)))
  5397. (parts
  5398. (delq nil
  5399. (list
  5400. (when (memq 'closed items) (concat "\\<" org-closed-string))
  5401. (when (memq 'clock items) (concat "\\<" org-clock-string))
  5402. (when (memq 'state items)
  5403. (format "- +State \"%s\".*?" org-todo-regexp)))))
  5404. (parts-re (if parts (mapconcat 'identity parts "\\|")
  5405. (error "`org-agenda-log-mode-items' is empty")))
  5406. (regexp (concat
  5407. "\\(" parts-re "\\)"
  5408. " *\\["
  5409. (regexp-quote
  5410. (substring
  5411. (format-time-string
  5412. (car org-time-stamp-formats)
  5413. (encode-time ; DATE bound by calendar
  5414. 0 0 0 (nth 1 date) (car date) (nth 2 date)))
  5415. 1 11))))
  5416. (org-agenda-search-headline-for-time nil)
  5417. marker hdmarker priority category level tags closedp type
  5418. statep clockp state ee txt extra timestr rest clocked inherited-tags)
  5419. (goto-char (point-min))
  5420. (while (re-search-forward regexp nil t)
  5421. (catch :skip
  5422. (org-agenda-skip)
  5423. (setq marker (org-agenda-new-marker (match-beginning 0))
  5424. closedp (equal (match-string 1) org-closed-string)
  5425. statep (equal (string-to-char (match-string 1)) ?-)
  5426. clockp (not (or closedp statep))
  5427. state (and statep (match-string 2))
  5428. category (org-get-category (match-beginning 0))
  5429. timestr (buffer-substring (match-beginning 0) (point-at-eol)))
  5430. (when (string-match "\\]" timestr)
  5431. ;; substring should only run to end of time stamp
  5432. (setq rest (substring timestr (match-end 0))
  5433. timestr (substring timestr 0 (match-end 0)))
  5434. (if (and (not closedp) (not statep)
  5435. (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
  5436. rest))
  5437. (progn (setq timestr (concat (substring timestr 0 -1)
  5438. "-" (match-string 1 rest) "]"))
  5439. (setq clocked (match-string 2 rest)))
  5440. (setq clocked "-")))
  5441. (save-excursion
  5442. (setq extra
  5443. (cond
  5444. ((not org-agenda-log-mode-add-notes) nil)
  5445. (statep
  5446. (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
  5447. (match-string 1)))
  5448. (clockp
  5449. (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
  5450. (match-string 1)))))
  5451. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5452. (throw :skip nil)
  5453. (goto-char (match-beginning 0))
  5454. (setq hdmarker (org-agenda-new-marker)
  5455. inherited-tags
  5456. (or (eq org-agenda-show-inherited-tags 'always)
  5457. (and (listp org-agenda-show-inherited-tags)
  5458. (memq 'todo org-agenda-show-inherited-tags))
  5459. (and (eq org-agenda-show-inherited-tags t)
  5460. (or (eq org-agenda-use-tag-inheritance t)
  5461. (memq 'todo org-agenda-use-tag-inheritance))))
  5462. tags (org-get-tags nil (not inherited-tags))
  5463. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5464. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5465. (setq txt (match-string 1))
  5466. (when extra
  5467. (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
  5468. (setq txt (concat (substring txt 0 (match-beginning 1))
  5469. " - " extra " " (match-string 2 txt)))
  5470. (setq txt (concat txt " - " extra))))
  5471. (setq txt (org-agenda-format-item
  5472. (cond
  5473. (closedp "Closed: ")
  5474. (statep (concat "State: (" state ")"))
  5475. (t (concat "Clocked: (" clocked ")")))
  5476. txt level category tags timestr)))
  5477. (setq type (cond (closedp "closed")
  5478. (statep "state")
  5479. (t "clock")))
  5480. (setq priority 100000)
  5481. (org-add-props txt props
  5482. 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
  5483. 'priority priority 'level level
  5484. 'type type 'date date
  5485. 'undone-face 'org-warning 'done-face 'org-agenda-done)
  5486. (push txt ee))
  5487. (goto-char (point-at-eol))))
  5488. (nreverse ee)))
  5489. (defun org-agenda-show-clocking-issues ()
  5490. "Add overlays, showing issues with clocking.
  5491. See also the user option `org-agenda-clock-consistency-checks'."
  5492. (interactive)
  5493. (let* ((pl org-agenda-clock-consistency-checks)
  5494. (re (concat "^[ \t]*"
  5495. org-clock-string
  5496. "[ \t]+"
  5497. "\\(\\[.*?\\]\\)" ; group 1 is first stamp
  5498. "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
  5499. (tlstart 0.)
  5500. (tlend 0.)
  5501. (maxtime (org-duration-to-minutes
  5502. (or (plist-get pl :max-duration) "24:00")))
  5503. (mintime (org-duration-to-minutes
  5504. (or (plist-get pl :min-duration) 0)))
  5505. (maxgap (org-duration-to-minutes
  5506. ;; default 30:00 means never complain
  5507. (or (plist-get pl :max-gap) "30:00")))
  5508. (gapok (mapcar #'org-duration-to-minutes
  5509. (plist-get pl :gap-ok-around)))
  5510. (def-face (or (plist-get pl :default-face)
  5511. '((:background "DarkRed") (:foreground "white"))))
  5512. issue face m te ts dt ov)
  5513. (goto-char (point-min))
  5514. (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
  5515. (setq issue nil face def-face)
  5516. (catch 'next
  5517. (setq m (org-get-at-bol 'org-marker)
  5518. te nil ts nil)
  5519. (unless (and m (markerp m))
  5520. (setq issue "No valid clock line") (throw 'next t))
  5521. (org-with-point-at m
  5522. (save-excursion
  5523. (goto-char (point-at-bol))
  5524. (unless (looking-at re)
  5525. (error "No valid Clock line")
  5526. (throw 'next t))
  5527. (unless (match-end 3)
  5528. (setq issue
  5529. (format
  5530. "No end time: (%s)"
  5531. (org-duration-from-minutes
  5532. (floor
  5533. (- (float-time (org-current-time))
  5534. (float-time (org-time-string-to-time (match-string 1))))
  5535. 60)))
  5536. face (or (plist-get pl :no-end-time-face) face))
  5537. (throw 'next t))
  5538. (setq ts (match-string 1)
  5539. te (match-string 3)
  5540. ts (float-time (org-time-string-to-time ts))
  5541. te (float-time (org-time-string-to-time te))
  5542. dt (- te ts))))
  5543. (cond
  5544. ((> dt (* 60 maxtime))
  5545. ;; a very long clocking chunk
  5546. (setq issue (format "Clocking interval is very long: %s"
  5547. (org-duration-from-minutes (floor dt 60)))
  5548. face (or (plist-get pl :long-face) face)))
  5549. ((< dt (* 60 mintime))
  5550. ;; a very short clocking chunk
  5551. (setq issue (format "Clocking interval is very short: %s"
  5552. (org-duration-from-minutes (floor dt 60)))
  5553. face (or (plist-get pl :short-face) face)))
  5554. ((and (> tlend 0) (< ts tlend))
  5555. ;; Two clock entries are overlapping
  5556. (setq issue (format "Clocking overlap: %d minutes"
  5557. (/ (- tlend ts) 60))
  5558. face (or (plist-get pl :overlap-face) face)))
  5559. ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
  5560. ;; There is a gap, lets see if we need to report it
  5561. (unless (org-agenda-check-clock-gap tlend ts gapok)
  5562. (setq issue (format "Clocking gap: %d minutes"
  5563. (/ (- ts tlend) 60))
  5564. face (or (plist-get pl :gap-face) face))))
  5565. (t nil)))
  5566. (setq tlend (or te tlend) tlstart (or ts tlstart))
  5567. (when issue
  5568. ;; OK, there was some issue, add an overlay to show the issue
  5569. (setq ov (make-overlay (point-at-bol) (point-at-eol)))
  5570. (overlay-put ov 'before-string
  5571. (concat
  5572. (org-add-props
  5573. (format "%-43s" (concat " " issue))
  5574. nil
  5575. 'face face)
  5576. "\n"))
  5577. (overlay-put ov 'evaporate t)))))
  5578. (defun org-agenda-check-clock-gap (t1 t2 ok-list)
  5579. "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
  5580. (catch 'exit
  5581. (unless ok-list
  5582. ;; there are no OK times for gaps...
  5583. (throw 'exit nil))
  5584. (when (> (- (/ t2 36000) (/ t1 36000)) 24)
  5585. ;; This is more than 24 hours, so it is OK.
  5586. ;; because we have at least one OK time, that must be in the
  5587. ;; 24 hour interval.
  5588. (throw 'exit t))
  5589. ;; We have a shorter gap.
  5590. ;; Now we have to get the minute of the day when these times are
  5591. (let* ((t1dec (org-decode-time t1))
  5592. (t2dec (org-decode-time t2))
  5593. ;; compute the minute on the day
  5594. (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
  5595. (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
  5596. (when (< min2 min1)
  5597. ;; if min2 is smaller than min1, this means it is on the next day.
  5598. ;; Wrap it to after midnight.
  5599. (setq min2 (+ min2 1440)))
  5600. ;; Now check if any of the OK times is in the gap
  5601. (mapc (lambda (x)
  5602. ;; Wrap the time to after midnight if necessary
  5603. (when (< x min1) (setq x (+ x 1440)))
  5604. ;; Check if in interval
  5605. (and (<= min1 x) (>= min2 x) (throw 'exit t)))
  5606. ok-list)
  5607. ;; Nope, this gap is not OK
  5608. nil)))
  5609. (defun org-agenda-get-deadlines (&optional with-hour)
  5610. "Return the deadline information for agenda display.
  5611. When WITH-HOUR is non-nil, only return deadlines with an hour
  5612. specification like [h]h:mm."
  5613. (let* ((props (list 'mouse-face 'highlight
  5614. 'org-not-done-regexp org-not-done-regexp
  5615. 'org-todo-regexp org-todo-regexp
  5616. 'org-complex-heading-regexp org-complex-heading-regexp
  5617. 'help-echo
  5618. (format "mouse-2 or RET jump to org file %s"
  5619. (abbreviate-file-name buffer-file-name))))
  5620. (regexp (if with-hour
  5621. org-deadline-time-hour-regexp
  5622. org-deadline-time-regexp))
  5623. (today (org-today))
  5624. (today? (org-agenda-today-p date)) ; DATE bound by calendar.
  5625. (current (calendar-absolute-from-gregorian date))
  5626. deadline-items)
  5627. (goto-char (point-min))
  5628. (while (re-search-forward regexp nil t)
  5629. (catch :skip
  5630. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5631. (org-agenda-skip)
  5632. (let* ((s (match-string 1))
  5633. (pos (1- (match-beginning 1)))
  5634. (todo-state (save-match-data (org-get-todo-state)))
  5635. (done? (member todo-state org-done-keywords))
  5636. (sexp? (string-prefix-p "%%" s))
  5637. ;; DEADLINE is the deadline date for the entry. It is
  5638. ;; either the base date or the last repeat, according
  5639. ;; to `org-agenda-prefer-last-repeat'.
  5640. (deadline
  5641. (cond
  5642. (sexp? (org-agenda--timestamp-to-absolute s current))
  5643. ((or (eq org-agenda-prefer-last-repeat t)
  5644. (member todo-state org-agenda-prefer-last-repeat))
  5645. (org-agenda--timestamp-to-absolute
  5646. s today 'past (current-buffer) pos))
  5647. (t (org-agenda--timestamp-to-absolute s))))
  5648. ;; REPEAT is the future repeat closest from CURRENT,
  5649. ;; according to `org-agenda-show-future-repeats'. If
  5650. ;; the latter is nil, or if the time stamp has no
  5651. ;; repeat part, default to DEADLINE.
  5652. (repeat
  5653. (cond
  5654. (sexp? deadline)
  5655. ((<= current today) deadline)
  5656. ((not org-agenda-show-future-repeats) deadline)
  5657. (t
  5658. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5659. (1+ today)
  5660. current)))
  5661. (org-agenda--timestamp-to-absolute
  5662. s base 'future (current-buffer) pos)))))
  5663. (diff (- deadline current))
  5664. (suppress-prewarning
  5665. (let ((scheduled
  5666. (and org-agenda-skip-deadline-prewarning-if-scheduled
  5667. (org-entry-get nil "SCHEDULED"))))
  5668. (cond
  5669. ((not scheduled) nil)
  5670. ;; The current item has a scheduled date, so
  5671. ;; evaluate its prewarning lead time.
  5672. ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
  5673. ;; Use global prewarning-restart lead time.
  5674. org-agenda-skip-deadline-prewarning-if-scheduled)
  5675. ((eq org-agenda-skip-deadline-prewarning-if-scheduled
  5676. 'pre-scheduled)
  5677. ;; Set pre-warning to no earlier than SCHEDULED.
  5678. (min (- deadline
  5679. (org-agenda--timestamp-to-absolute scheduled))
  5680. org-deadline-warning-days))
  5681. ;; Set pre-warning to deadline.
  5682. (t 0))))
  5683. (wdays (or suppress-prewarning (org-get-wdays s))))
  5684. (cond
  5685. ;; Only display deadlines at their base date, at future
  5686. ;; repeat occurrences or in today agenda.
  5687. ((= current deadline) nil)
  5688. ((= current repeat) nil)
  5689. ((not today?) (throw :skip nil))
  5690. ;; Upcoming deadline: display within warning period WDAYS.
  5691. ((> deadline current) (when (> diff wdays) (throw :skip nil)))
  5692. ;; Overdue deadline: warn about it for
  5693. ;; `org-deadline-past-days' duration.
  5694. (t (when (< org-deadline-past-days (- diff)) (throw :skip nil))))
  5695. ;; Possibly skip done tasks.
  5696. (when (and done?
  5697. (or org-agenda-skip-deadline-if-done
  5698. (/= deadline current)))
  5699. (throw :skip nil))
  5700. (save-excursion
  5701. (re-search-backward "^\\*+[ \t]+" nil t)
  5702. (goto-char (match-end 0))
  5703. (let* ((category (org-get-category))
  5704. (level (make-string (org-reduced-level (org-outline-level))
  5705. ?\s))
  5706. (head (buffer-substring (point) (line-end-position)))
  5707. (inherited-tags
  5708. (or (eq org-agenda-show-inherited-tags 'always)
  5709. (and (listp org-agenda-show-inherited-tags)
  5710. (memq 'agenda org-agenda-show-inherited-tags))
  5711. (and (eq org-agenda-show-inherited-tags t)
  5712. (or (eq org-agenda-use-tag-inheritance t)
  5713. (memq 'agenda
  5714. org-agenda-use-tag-inheritance)))))
  5715. (tags (org-get-tags nil (not inherited-tags)))
  5716. (time
  5717. (cond
  5718. ;; No time of day designation if it is only
  5719. ;; a reminder.
  5720. ((and (/= current deadline) (/= current repeat)) nil)
  5721. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5722. (concat (substring s (match-beginning 1)) " "))
  5723. (t 'time)))
  5724. (item
  5725. (org-agenda-format-item
  5726. ;; Insert appropriate suffixes before deadlines.
  5727. ;; Those only apply to today agenda.
  5728. (pcase-let ((`(,now ,future ,past)
  5729. org-agenda-deadline-leaders))
  5730. (cond
  5731. ((and today? (< deadline today)) (format past (- diff)))
  5732. ((and today? (> deadline today)) (format future diff))
  5733. (t now)))
  5734. head level category tags time))
  5735. (face (org-agenda-deadline-face
  5736. (- 1 (/ (float diff) (max wdays 1)))))
  5737. (upcoming? (and today? (> deadline today)))
  5738. (warntime (get-text-property (point) 'org-appt-warntime)))
  5739. (org-add-props item props
  5740. 'org-marker (org-agenda-new-marker pos)
  5741. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  5742. 'warntime warntime
  5743. 'level level
  5744. 'ts-date deadline
  5745. 'priority
  5746. ;; Adjust priority to today reminders about deadlines.
  5747. ;; Overdue deadlines get the highest priority
  5748. ;; increase, then imminent deadlines and eventually
  5749. ;; more distant deadlines.
  5750. (let ((adjust (if today? (- diff) 0)))
  5751. (+ adjust (org-get-priority item)))
  5752. 'todo-state todo-state
  5753. 'type (if upcoming? "upcoming-deadline" "deadline")
  5754. 'date (if upcoming? date deadline)
  5755. 'face (if done? 'org-agenda-done face)
  5756. 'undone-face face
  5757. 'done-face 'org-agenda-done)
  5758. (push item deadline-items))))))
  5759. (nreverse deadline-items)))
  5760. (defun org-agenda-deadline-face (fraction)
  5761. "Return the face to displaying a deadline item.
  5762. FRACTION is what fraction of the head-warning time has passed."
  5763. (assoc-default fraction org-agenda-deadline-faces #'<=))
  5764. (defun org-agenda-get-scheduled (&optional deadlines with-hour)
  5765. "Return the scheduled information for agenda display.
  5766. Optional argument DEADLINES is a list of deadline items to be
  5767. displayed in agenda view. When WITH-HOUR is non-nil, only return
  5768. scheduled items with an hour specification like [h]h:mm."
  5769. (let* ((props (list 'org-not-done-regexp org-not-done-regexp
  5770. 'org-todo-regexp org-todo-regexp
  5771. 'org-complex-heading-regexp org-complex-heading-regexp
  5772. 'done-face 'org-agenda-done
  5773. 'mouse-face 'highlight
  5774. 'help-echo
  5775. (format "mouse-2 or RET jump to Org file %s"
  5776. (abbreviate-file-name buffer-file-name))))
  5777. (regexp (if with-hour
  5778. org-scheduled-time-hour-regexp
  5779. org-scheduled-time-regexp))
  5780. (today (org-today))
  5781. (todayp (org-agenda-today-p date)) ; DATE bound by calendar.
  5782. (current (calendar-absolute-from-gregorian date))
  5783. (deadline-pos
  5784. (mapcar (lambda (d)
  5785. (let ((m (get-text-property 0 'org-hd-marker d)))
  5786. (and m (marker-position m))))
  5787. deadlines))
  5788. scheduled-items)
  5789. (goto-char (point-min))
  5790. (while (re-search-forward regexp nil t)
  5791. (catch :skip
  5792. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5793. (org-agenda-skip)
  5794. (let* ((s (match-string 1))
  5795. (pos (1- (match-beginning 1)))
  5796. (todo-state (save-match-data (org-get-todo-state)))
  5797. (donep (member todo-state org-done-keywords))
  5798. (sexp? (string-prefix-p "%%" s))
  5799. ;; SCHEDULE is the scheduled date for the entry. It is
  5800. ;; either the bare date or the last repeat, according
  5801. ;; to `org-agenda-prefer-last-repeat'.
  5802. (schedule
  5803. (cond
  5804. (sexp? (org-agenda--timestamp-to-absolute s current))
  5805. ((or (eq org-agenda-prefer-last-repeat t)
  5806. (member todo-state org-agenda-prefer-last-repeat))
  5807. (org-agenda--timestamp-to-absolute
  5808. s today 'past (current-buffer) pos))
  5809. (t (org-agenda--timestamp-to-absolute s))))
  5810. ;; REPEAT is the future repeat closest from CURRENT,
  5811. ;; according to `org-agenda-show-future-repeats'. If
  5812. ;; the latter is nil, or if the time stamp has no
  5813. ;; repeat part, default to SCHEDULE.
  5814. (repeat
  5815. (cond
  5816. (sexp? schedule)
  5817. ((<= current today) schedule)
  5818. ((not org-agenda-show-future-repeats) schedule)
  5819. (t
  5820. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5821. (1+ today)
  5822. current)))
  5823. (org-agenda--timestamp-to-absolute
  5824. s base 'future (current-buffer) pos)))))
  5825. (diff (- current schedule))
  5826. (warntime (get-text-property (point) 'org-appt-warntime))
  5827. (pastschedp (< schedule today))
  5828. (futureschedp (> schedule today))
  5829. (habitp (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  5830. (suppress-delay
  5831. (let ((deadline (and org-agenda-skip-scheduled-delay-if-deadline
  5832. (org-entry-get nil "DEADLINE"))))
  5833. (cond
  5834. ((not deadline) nil)
  5835. ;; The current item has a deadline date, so
  5836. ;; evaluate its delay time.
  5837. ((integerp org-agenda-skip-scheduled-delay-if-deadline)
  5838. ;; Use global delay time.
  5839. (- org-agenda-skip-scheduled-delay-if-deadline))
  5840. ((eq org-agenda-skip-scheduled-delay-if-deadline
  5841. 'post-deadline)
  5842. ;; Set delay to no later than DEADLINE.
  5843. (min (- schedule
  5844. (org-agenda--timestamp-to-absolute deadline))
  5845. org-scheduled-delay-days))
  5846. (t 0))))
  5847. (diff-r (abs (- repeat current)))
  5848. (ddays-once (or (and (string-match "--\\([0-9]+\\)[hdwmy]" s)
  5849. (string-to-number (match-string 1 s)))
  5850. 0))
  5851. (ddays
  5852. (cond
  5853. ;; Nullify delay when a repeater triggered already
  5854. ;; and the delay is of the form --Xd.
  5855. ((and (string-match-p "--[0-9]+[hdwmy]" s)
  5856. (> schedule (org-agenda--timestamp-to-absolute s)))
  5857. 0)
  5858. (suppress-delay
  5859. (let ((org-scheduled-delay-days suppress-delay))
  5860. (org-get-wdays s t t)))
  5861. (t (org-get-wdays s t)))))
  5862. ;; Display scheduled items at base date (SCHEDULE), today if
  5863. ;; scheduled before the current date, and at any repeat past
  5864. ;; today. However, skip delayed items and items that have
  5865. ;; been displayed for more than `org-scheduled-past-days'.
  5866. (unless (and todayp
  5867. habitp
  5868. (bound-and-true-p org-habit-show-all-today))
  5869. (when (or
  5870. ;; no one-time delay, not repeated delay
  5871. (and (not ddays-once) (not (= ddays diff-r)))
  5872. ;; one-time delay, but not for today
  5873. (and ddays-once
  5874. (not (= diff diff-r))
  5875. (= ddays-once diff-r))
  5876. ;; normal delay, but already in the past
  5877. (and (> ddays 0) (< diff ddays))
  5878. ;; a habit, but past `org-habit-scheduled-past-days'
  5879. (> diff (or (and habitp org-habit-scheduled-past-days)
  5880. org-scheduled-past-days))
  5881. ;; schedule in the future
  5882. (> schedule current)
  5883. ;; no delay, not scheduled today, no deadline for today
  5884. (and (= ddays 0)
  5885. (/= current schedule)
  5886. (/= current today)
  5887. (/= current repeat)))
  5888. (throw :skip nil)))
  5889. ;; Possibly skip done tasks.
  5890. (when (and donep
  5891. (or org-agenda-skip-scheduled-if-done
  5892. (/= schedule current)))
  5893. (throw :skip nil))
  5894. ;; Skip entry if it already appears as a deadline, per
  5895. ;; `org-agenda-skip-scheduled-if-deadline-is-shown'. This
  5896. ;; doesn't apply to habits.
  5897. (when (pcase org-agenda-skip-scheduled-if-deadline-is-shown
  5898. ((guard
  5899. (or (not (memq (line-beginning-position 0) deadline-pos))
  5900. habitp))
  5901. nil)
  5902. (`repeated-after-deadline
  5903. (let ((deadline (time-to-days
  5904. (org-get-deadline-time (point)))))
  5905. (and (<= schedule deadline) (> current deadline))))
  5906. (`not-today pastschedp)
  5907. (`t t)
  5908. (_ nil))
  5909. (throw :skip nil))
  5910. ;; Skip habits if `org-habit-show-habits' is nil, or if we
  5911. ;; only show them for today. Also skip done habits.
  5912. (when (and habitp
  5913. (or donep
  5914. (not (bound-and-true-p org-habit-show-habits))
  5915. (and (not todayp)
  5916. (bound-and-true-p
  5917. org-habit-show-habits-only-for-today))))
  5918. (throw :skip nil))
  5919. (save-excursion
  5920. (re-search-backward "^\\*+[ \t]+" nil t)
  5921. (goto-char (match-end 0))
  5922. (let* ((category (org-get-category))
  5923. (inherited-tags
  5924. (or (eq org-agenda-show-inherited-tags 'always)
  5925. (and (listp org-agenda-show-inherited-tags)
  5926. (memq 'agenda org-agenda-show-inherited-tags))
  5927. (and (eq org-agenda-show-inherited-tags t)
  5928. (or (eq org-agenda-use-tag-inheritance t)
  5929. (memq 'agenda
  5930. org-agenda-use-tag-inheritance)))))
  5931. (tags (org-get-tags nil (not inherited-tags)))
  5932. (level (make-string (org-reduced-level (org-outline-level))
  5933. ?\s))
  5934. (head (buffer-substring (point) (line-end-position)))
  5935. (time
  5936. (cond
  5937. ;; No time of day designation if it is only a
  5938. ;; reminder, except for habits, which always show
  5939. ;; the time of day. Habits are an exception
  5940. ;; because if there is a time of day, that is
  5941. ;; interpreted to mean they should usually happen
  5942. ;; then, even if doing the habit was missed.
  5943. ((and
  5944. (not habitp)
  5945. (/= current schedule)
  5946. (/= current repeat))
  5947. nil)
  5948. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5949. (concat (substring s (match-beginning 1)) " "))
  5950. (t 'time)))
  5951. (item
  5952. (org-agenda-format-item
  5953. (pcase-let ((`(,first ,past) org-agenda-scheduled-leaders))
  5954. ;; Show a reminder of a past scheduled today.
  5955. (if (and todayp pastschedp)
  5956. (format past diff)
  5957. first))
  5958. head level category tags time nil habitp))
  5959. (face (cond ((and (not habitp) pastschedp)
  5960. 'org-scheduled-previously)
  5961. ((and habitp futureschedp)
  5962. 'org-agenda-done)
  5963. (todayp 'org-scheduled-today)
  5964. (t 'org-scheduled)))
  5965. (habitp (and habitp (org-habit-parse-todo))))
  5966. (org-add-props item props
  5967. 'undone-face face
  5968. 'face (if donep 'org-agenda-done face)
  5969. 'org-marker (org-agenda-new-marker pos)
  5970. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  5971. 'type (if pastschedp "past-scheduled" "scheduled")
  5972. 'date (if pastschedp schedule date)
  5973. 'ts-date schedule
  5974. 'warntime warntime
  5975. 'level level
  5976. 'priority (if habitp (org-habit-get-priority habitp)
  5977. (+ 99 diff (org-get-priority item)))
  5978. 'org-habit-p habitp
  5979. 'todo-state todo-state)
  5980. (push item scheduled-items))))))
  5981. (nreverse scheduled-items)))
  5982. (defun org-agenda-get-blocks ()
  5983. "Return the date-range information for agenda display."
  5984. (let* ((props (list 'face nil
  5985. 'org-not-done-regexp org-not-done-regexp
  5986. 'org-todo-regexp org-todo-regexp
  5987. 'org-complex-heading-regexp org-complex-heading-regexp
  5988. 'mouse-face 'highlight
  5989. 'help-echo
  5990. (format "mouse-2 or RET jump to org file %s"
  5991. (abbreviate-file-name buffer-file-name))))
  5992. (regexp org-tr-regexp)
  5993. (d0 (calendar-absolute-from-gregorian date))
  5994. marker hdmarker ee txt d1 d2 s1 s2 category
  5995. level todo-state tags pos head donep inherited-tags)
  5996. (goto-char (point-min))
  5997. (while (re-search-forward regexp nil t)
  5998. (catch :skip
  5999. (org-agenda-skip)
  6000. (setq pos (point))
  6001. (let ((start-time (match-string 1))
  6002. (end-time (match-string 2)))
  6003. (setq s1 (match-string 1)
  6004. s2 (match-string 2)
  6005. d1 (time-to-days
  6006. (condition-case err
  6007. (org-time-string-to-time s1)
  6008. (error
  6009. (error
  6010. "Bad timestamp %S at %d in buffer %S\nError was: %s"
  6011. s1
  6012. pos
  6013. (current-buffer)
  6014. (error-message-string err)))))
  6015. d2 (time-to-days
  6016. (condition-case err
  6017. (org-time-string-to-time s2)
  6018. (error
  6019. (error
  6020. "Bad timestamp %S at %d in buffer %S\nError was: %s"
  6021. s2
  6022. pos
  6023. (current-buffer)
  6024. (error-message-string err))))))
  6025. (when (and (> (- d0 d1) -1) (> (- d2 d0) -1))
  6026. ;; Only allow days between the limits, because the normal
  6027. ;; date stamps will catch the limits.
  6028. (save-excursion
  6029. (setq todo-state (org-get-todo-state))
  6030. (setq donep (member todo-state org-done-keywords))
  6031. (when (and donep org-agenda-skip-timestamp-if-done)
  6032. (throw :skip t))
  6033. (setq marker (org-agenda-new-marker (point))
  6034. category (org-get-category))
  6035. (if (not (re-search-backward org-outline-regexp-bol nil t))
  6036. (throw :skip nil)
  6037. (goto-char (match-beginning 0))
  6038. (setq hdmarker (org-agenda-new-marker (point))
  6039. inherited-tags
  6040. (or (eq org-agenda-show-inherited-tags 'always)
  6041. (and (listp org-agenda-show-inherited-tags)
  6042. (memq 'agenda org-agenda-show-inherited-tags))
  6043. (and (eq org-agenda-show-inherited-tags t)
  6044. (or (eq org-agenda-use-tag-inheritance t)
  6045. (memq 'agenda org-agenda-use-tag-inheritance))))
  6046. tags (org-get-tags nil (not inherited-tags)))
  6047. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  6048. (looking-at "\\*+[ \t]+\\(.*\\)")
  6049. (setq head (match-string 1))
  6050. (let ((remove-re
  6051. (if org-agenda-remove-timeranges-from-blocks
  6052. (concat
  6053. "<" (regexp-quote s1) ".*?>"
  6054. "--"
  6055. "<" (regexp-quote s2) ".*?>")
  6056. nil)))
  6057. (setq txt (org-agenda-format-item
  6058. (format
  6059. (nth (if (= d1 d2) 0 1)
  6060. org-agenda-timerange-leaders)
  6061. (1+ (- d0 d1)) (1+ (- d2 d1)))
  6062. head level category tags
  6063. (save-match-data
  6064. (let ((hhmm1 (and (string-match org-ts-regexp1 s1)
  6065. (match-string 6 s1)))
  6066. (hhmm2 (and (string-match org-ts-regexp1 s2)
  6067. (match-string 6 s2))))
  6068. (cond ((string= hhmm1 hhmm2)
  6069. (concat "<" start-time ">--<" end-time ">"))
  6070. ((and (= d1 d0) (= d2 d0))
  6071. (concat "<" start-time ">--<" end-time ">"))
  6072. ((= d1 d0)
  6073. (concat "<" start-time ">"))
  6074. ((= d2 d0)
  6075. (concat "<" end-time ">")))))
  6076. remove-re))))
  6077. (org-add-props txt props
  6078. 'org-marker marker 'org-hd-marker hdmarker
  6079. 'type "block" 'date date
  6080. 'level level
  6081. 'todo-state todo-state
  6082. 'priority (org-get-priority txt))
  6083. (push txt ee))))
  6084. (goto-char pos)))
  6085. ;; Sort the entries by expiration date.
  6086. (nreverse ee)))
  6087. ;;; Agenda presentation and sorting
  6088. (defvar org-prefix-has-time nil
  6089. "A flag, set by `org-compile-prefix-format'.
  6090. The flag is set if the currently compiled format contains a `%t'.")
  6091. (defvar org-prefix-has-tag nil
  6092. "A flag, set by `org-compile-prefix-format'.
  6093. The flag is set if the currently compiled format contains a `%T'.")
  6094. (defvar org-prefix-has-effort nil
  6095. "A flag, set by `org-compile-prefix-format'.
  6096. The flag is set if the currently compiled format contains a `%e'.")
  6097. (defvar org-prefix-has-breadcrumbs nil
  6098. "A flag, set by `org-compile-prefix-format'.
  6099. The flag is set if the currently compiled format contains a `%b'.")
  6100. (defvar org-prefix-category-length nil
  6101. "Used by `org-compile-prefix-format' to remember the category field width.")
  6102. (defvar org-prefix-category-max-length nil
  6103. "Used by `org-compile-prefix-format' to remember the category field width.")
  6104. (defun org-agenda-get-category-icon (category)
  6105. "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
  6106. (cl-dolist (entry org-agenda-category-icon-alist)
  6107. (when (string-match-p (car entry) category)
  6108. (if (listp (cadr entry))
  6109. (cl-return (cadr entry))
  6110. (cl-return (apply #'create-image (cdr entry)))))))
  6111. (defun org-agenda-format-item (extra txt &optional level category tags dotime
  6112. remove-re habitp)
  6113. "Format TXT to be inserted into the agenda buffer.
  6114. In particular, add the prefix and corresponding text properties.
  6115. EXTRA must be a string to replace the `%s' specifier in the prefix format.
  6116. LEVEL may be a string to replace the `%l' specifier.
  6117. CATEGORY (a string, a symbol or nil) may be used to overrule the default
  6118. category taken from local variable or file name. It will replace the `%c'
  6119. specifier in the format.
  6120. DOTIME, when non-nil, indicates that a time-of-day should be extracted from
  6121. TXT for sorting of this entry, and for the `%t' specifier in the format.
  6122. When DOTIME is a string, this string is searched for a time before TXT is.
  6123. TAGS can be the tags of the headline.
  6124. Any match of REMOVE-RE will be removed from TXT."
  6125. ;; We keep the org-prefix-* variable values along with a compiled
  6126. ;; formatter, so that multiple agendas existing at the same time do
  6127. ;; not step on each other toes.
  6128. ;;
  6129. ;; It was inconvenient to make these variables buffer local in
  6130. ;; Agenda buffers, because this function expects to be called with
  6131. ;; the buffer where item comes from being current, and not agenda
  6132. ;; buffer
  6133. (let* ((bindings (car org-prefix-format-compiled))
  6134. (formatter (cadr org-prefix-format-compiled)))
  6135. (cl-loop for (var value) in bindings
  6136. do (set var value))
  6137. (save-match-data
  6138. ;; Diary entries sometimes have extra whitespace at the beginning
  6139. (setq txt (org-trim txt))
  6140. ;; Fix the tags part in txt
  6141. (setq txt (org-agenda-fix-displayed-tags
  6142. txt tags
  6143. org-agenda-show-inherited-tags
  6144. org-agenda-hide-tags-regexp))
  6145. (let* ((category (or category
  6146. (if buffer-file-name
  6147. (file-name-sans-extension
  6148. (file-name-nondirectory buffer-file-name))
  6149. "")))
  6150. (category-icon (org-agenda-get-category-icon category))
  6151. (category-icon (if category-icon
  6152. (propertize " " 'display category-icon)
  6153. ""))
  6154. (effort (and (not (string= txt ""))
  6155. (get-text-property 1 'effort txt)))
  6156. ;; time, tag, effort are needed for the eval of the prefix format
  6157. (tag (if tags (nth (1- (length tags)) tags) ""))
  6158. (time-grid-trailing-characters (nth 2 org-agenda-time-grid))
  6159. time
  6160. (ts (when dotime (concat
  6161. (if (stringp dotime) dotime "")
  6162. (and org-agenda-search-headline-for-time txt))))
  6163. (time-of-day (and dotime (org-get-time-of-day ts)))
  6164. stamp plain s0 s1 s2 rtn srp l
  6165. duration breadcrumbs)
  6166. (and (derived-mode-p 'org-mode) buffer-file-name
  6167. (add-to-list 'org-agenda-contributing-files buffer-file-name))
  6168. (when (and dotime time-of-day)
  6169. ;; Extract starting and ending time and move them to prefix
  6170. (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
  6171. (setq plain (string-match org-plain-time-of-day-regexp ts)))
  6172. (setq s0 (match-string 0 ts)
  6173. srp (and stamp (match-end 3))
  6174. s1 (match-string (if plain 1 2) ts)
  6175. s2 (match-string (if plain 8 (if srp 4 6)) ts))
  6176. ;; If the times are in TXT (not in DOTIMES), and the prefix will list
  6177. ;; them, we might want to remove them there to avoid duplication.
  6178. ;; The user can turn this off with a variable.
  6179. (when (and org-prefix-has-time
  6180. org-agenda-remove-times-when-in-prefix (or stamp plain)
  6181. (string-match (concat (regexp-quote s0) " *") txt)
  6182. (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
  6183. (if (eq org-agenda-remove-times-when-in-prefix 'beg)
  6184. (= (match-beginning 0) 0)
  6185. t))
  6186. (setq txt (replace-match "" nil nil txt))))
  6187. ;; Normalize the time(s) to 24 hour
  6188. (when s1 (setq s1 (org-get-time-of-day s1 'string t)))
  6189. (when s2 (setq s2 (org-get-time-of-day s2 'string t)))
  6190. ;; Try to set s2 if s1 and
  6191. ;; `org-agenda-default-appointment-duration' are set
  6192. (when (and s1 (not s2) org-agenda-default-appointment-duration)
  6193. (setq s2
  6194. (org-duration-from-minutes
  6195. (+ (org-duration-to-minutes s1 t)
  6196. org-agenda-default-appointment-duration)
  6197. nil t)))
  6198. ;; Compute the duration
  6199. (when s2
  6200. (setq duration (- (org-duration-to-minutes s2)
  6201. (org-duration-to-minutes s1)))))
  6202. (when (string-match org-tag-group-re txt)
  6203. ;; Tags are in the string
  6204. (if (or (eq org-agenda-remove-tags t)
  6205. (and org-agenda-remove-tags
  6206. org-prefix-has-tag))
  6207. (setq txt (replace-match "" t t txt))
  6208. (setq txt (replace-match
  6209. (concat (make-string (max (- 50 (length txt)) 1) ?\ )
  6210. (match-string 1 txt))
  6211. t t txt))))
  6212. (when remove-re
  6213. (while (string-match remove-re txt)
  6214. (setq txt (replace-match "" t t txt))))
  6215. ;; Set org-heading property on `txt' to mark the start of the
  6216. ;; heading.
  6217. (add-text-properties 0 (length txt) '(org-heading t) txt)
  6218. ;; Prepare the variables needed in the eval of the compiled format
  6219. (when org-prefix-has-breadcrumbs
  6220. (setq breadcrumbs (org-with-point-at (org-get-at-bol 'org-marker)
  6221. (let ((s (org-format-outline-path (org-get-outline-path)
  6222. (1- (frame-width))
  6223. nil org-agenda-breadcrumbs-separator)))
  6224. (if (eq "" s) "" (concat s org-agenda-breadcrumbs-separator))))))
  6225. (setq time (cond (s2 (concat
  6226. (org-agenda-time-of-day-to-ampm-maybe s1)
  6227. "-" (org-agenda-time-of-day-to-ampm-maybe s2)
  6228. (when org-agenda-timegrid-use-ampm " ")))
  6229. (s1 (concat
  6230. (org-agenda-time-of-day-to-ampm-maybe s1)
  6231. (if org-agenda-timegrid-use-ampm
  6232. (concat time-grid-trailing-characters " ")
  6233. time-grid-trailing-characters)))
  6234. (t ""))
  6235. extra (or (and (not habitp) extra) "")
  6236. category (if (symbolp category) (symbol-name category) category)
  6237. level (or level ""))
  6238. (if (string-match org-link-bracket-re category)
  6239. (progn
  6240. (setq l (string-width (or (match-string 2) (match-string 1))))
  6241. (when (< l (or org-prefix-category-length 0))
  6242. (setq category (copy-sequence category))
  6243. (org-add-props category nil
  6244. 'extra-space (make-string
  6245. (- org-prefix-category-length l 1) ?\ ))))
  6246. (when (and org-prefix-category-max-length
  6247. (>= (length category) org-prefix-category-max-length))
  6248. (setq category (substring category 0 (1- org-prefix-category-max-length)))))
  6249. ;; Evaluate the compiled format
  6250. (setq rtn (concat (eval formatter) txt))
  6251. ;; And finally add the text properties
  6252. (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
  6253. (org-add-props rtn nil
  6254. 'org-category category
  6255. 'tags (mapcar 'org-downcase-keep-props tags)
  6256. 'org-highest-priority org-highest-priority
  6257. 'org-lowest-priority org-lowest-priority
  6258. 'time-of-day time-of-day
  6259. 'duration duration
  6260. 'breadcrumbs breadcrumbs
  6261. 'txt txt
  6262. 'level level
  6263. 'time time
  6264. 'extra extra
  6265. 'format org-prefix-format-compiled
  6266. 'dotime dotime)))))
  6267. (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
  6268. "Remove tags string from TXT, and add a modified list of tags.
  6269. The modified list may contain inherited tags, and tags matched by
  6270. `org-agenda-hide-tags-regexp' will be removed."
  6271. (when (or add-inherited hide-re)
  6272. (when (string-match org-tag-group-re txt)
  6273. (setq txt (substring txt 0 (match-beginning 0))))
  6274. (setq tags
  6275. (delq nil
  6276. (mapcar (lambda (tg)
  6277. (if (or (and hide-re (string-match hide-re tg))
  6278. (and (not add-inherited)
  6279. (get-text-property 0 'inherited tg)))
  6280. nil
  6281. tg))
  6282. tags)))
  6283. (when tags
  6284. (let ((have-i (get-text-property 0 'inherited (car tags)))
  6285. i)
  6286. (setq txt (concat txt " :"
  6287. (mapconcat
  6288. (lambda (x)
  6289. (setq i (get-text-property 0 'inherited x))
  6290. (if (and have-i (not i))
  6291. (progn
  6292. (setq have-i nil)
  6293. (concat ":" x))
  6294. x))
  6295. tags ":")
  6296. (if have-i "::" ":"))))))
  6297. txt)
  6298. (defun org-downcase-keep-props (s)
  6299. (let ((props (text-properties-at 0 s)))
  6300. (setq s (downcase s))
  6301. (add-text-properties 0 (length s) props s)
  6302. s))
  6303. (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
  6304. (defun org-agenda-add-time-grid-maybe (list ndays todayp)
  6305. "Add a time-grid for agenda items which need it.
  6306. LIST is the list of agenda items formatted by `org-agenda-list'.
  6307. NDAYS is the span of the current agenda view.
  6308. TODAYP is t when the current agenda view is on today."
  6309. (catch 'exit
  6310. (cond ((not org-agenda-use-time-grid) (throw 'exit list))
  6311. ((and todayp (member 'today (car org-agenda-time-grid))))
  6312. ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
  6313. ((member 'weekly (car org-agenda-time-grid)))
  6314. (t (throw 'exit list)))
  6315. (let* ((have (delq nil (mapcar
  6316. (lambda (x) (get-text-property 1 'time-of-day x))
  6317. list)))
  6318. (string (nth 3 org-agenda-time-grid))
  6319. (gridtimes (nth 1 org-agenda-time-grid))
  6320. (req (car org-agenda-time-grid))
  6321. (remove (member 'remove-match req))
  6322. new time)
  6323. (when (and (member 'require-timed req) (not have))
  6324. ;; don't show empty grid
  6325. (throw 'exit list))
  6326. (while (setq time (pop gridtimes))
  6327. (unless (and remove (member time have))
  6328. (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
  6329. (push (org-agenda-format-item
  6330. nil string nil "" nil
  6331. (concat (substring time 0 -2) ":" (substring time -2)))
  6332. new)
  6333. (put-text-property
  6334. 2 (length (car new)) 'face 'org-time-grid (car new))))
  6335. (when (and todayp org-agenda-show-current-time-in-grid)
  6336. (push (org-agenda-format-item
  6337. nil org-agenda-current-time-string nil "" nil
  6338. (format-time-string "%H:%M "))
  6339. new)
  6340. (put-text-property
  6341. 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
  6342. (if (member 'time-up org-agenda-sorting-strategy-selected)
  6343. (append new list)
  6344. (append list new)))))
  6345. (defun org-compile-prefix-format (key)
  6346. "Compile the prefix format into a Lisp form that can be evaluated.
  6347. The resulting form and associated variable bindings is returned
  6348. and stored in the variable `org-prefix-format-compiled'."
  6349. (setq org-prefix-has-time nil
  6350. org-prefix-has-tag nil
  6351. org-prefix-category-length nil
  6352. org-prefix-has-effort nil
  6353. org-prefix-has-breadcrumbs nil)
  6354. (let ((s (cond
  6355. ((stringp org-agenda-prefix-format)
  6356. org-agenda-prefix-format)
  6357. ((assq key org-agenda-prefix-format)
  6358. (cdr (assq key org-agenda-prefix-format)))
  6359. (t " %-12:c%?-12t% s")))
  6360. (start 0)
  6361. varform vars var e c f opt)
  6362. (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cltseib]\\|(.+)\\)"
  6363. s start)
  6364. (setq var (or (cdr (assoc (match-string 4 s)
  6365. '(("c" . category) ("t" . time) ("l" . level) ("s" . extra)
  6366. ("i" . category-icon) ("T" . tag) ("e" . effort) ("b" . breadcrumbs))))
  6367. 'eval)
  6368. c (or (match-string 3 s) "")
  6369. opt (match-beginning 1)
  6370. start (1+ (match-beginning 0)))
  6371. (cl-case var
  6372. (time (setq org-prefix-has-time t))
  6373. (tag (setq org-prefix-has-tag t))
  6374. (effort (setq org-prefix-has-effort t))
  6375. (breadcrumbs (setq org-prefix-has-breadcrumbs t)))
  6376. (setq f (concat "%" (match-string 2 s) "s"))
  6377. (when (eq var 'category)
  6378. (setq org-prefix-category-length
  6379. (floor (abs (string-to-number (match-string 2 s)))))
  6380. (setq org-prefix-category-max-length
  6381. (let ((x (match-string 2 s)))
  6382. (save-match-data
  6383. (and (string-match "\\.[0-9]+" x)
  6384. (string-to-number (substring (match-string 0 x) 1)))))))
  6385. (if (eq var 'eval)
  6386. (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
  6387. (if opt
  6388. (setq varform
  6389. `(if (or (equal "" ,var) (equal nil ,var))
  6390. ""
  6391. (format ,f (concat ,var ,c))))
  6392. (setq varform
  6393. `(format ,f (if (or (equal ,var "")
  6394. (equal ,var nil)) ""
  6395. (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
  6396. (setq s (replace-match "%s" t nil s))
  6397. (push varform vars))
  6398. (setq vars (nreverse vars))
  6399. (with-current-buffer (or org-agenda-buffer (current-buffer))
  6400. (setq org-prefix-format-compiled
  6401. (list
  6402. `((org-prefix-has-time ,org-prefix-has-time)
  6403. (org-prefix-has-tag ,org-prefix-has-tag)
  6404. (org-prefix-category-length ,org-prefix-category-length)
  6405. (org-prefix-has-effort ,org-prefix-has-effort)
  6406. (org-prefix-has-breadcrumbs ,org-prefix-has-breadcrumbs))
  6407. `(format ,s ,@vars))))))
  6408. (defun org-set-sorting-strategy (key)
  6409. (if (symbolp (car org-agenda-sorting-strategy))
  6410. ;; the old format
  6411. (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
  6412. (setq org-agenda-sorting-strategy-selected
  6413. (or (cdr (assq key org-agenda-sorting-strategy))
  6414. (cdr (assq 'agenda org-agenda-sorting-strategy))
  6415. '(time-up category-keep priority-down)))))
  6416. (defun org-get-time-of-day (s &optional string mod24)
  6417. "Check string S for a time of day.
  6418. If found, return it as a military time number between 0 and 2400.
  6419. If not found, return nil.
  6420. The optional STRING argument forces conversion into a 5 character wide string
  6421. HH:MM."
  6422. (save-match-data
  6423. (when
  6424. (and
  6425. (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
  6426. (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
  6427. (not (eq (get-text-property 1 'face s) 'org-link)))
  6428. (let* ((h (string-to-number (match-string 1 s)))
  6429. (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
  6430. (ampm (when (match-end 4) (downcase (match-string 4 s))))
  6431. (am-p (equal ampm "am"))
  6432. (h1 (cond ((not ampm) h)
  6433. ((= h 12) (if am-p 0 12))
  6434. (t (+ h (if am-p 0 12)))))
  6435. (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
  6436. (mod h1 24) h1))
  6437. (t0 (+ (* 100 h2) m))
  6438. (t1 (concat (if (>= h1 24) "+" " ")
  6439. (if (and org-agenda-time-leading-zero
  6440. (< t0 1000)) "0" "")
  6441. (if (< t0 100) "0" "")
  6442. (if (< t0 10) "0" "")
  6443. (int-to-string t0))))
  6444. (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
  6445. (defvar org-agenda-before-sorting-filter-function nil
  6446. "Function to be applied to agenda items prior to sorting.
  6447. Prior to sorting also means just before they are inserted into the agenda.
  6448. To aid sorting, you may revisit the original entries and add more text
  6449. properties which will later be used by the sorting functions.
  6450. The function should take a string argument, an agenda line.
  6451. It has access to the text properties in that line, which contain among
  6452. other things, the property `org-hd-marker' that points to the entry
  6453. where the line comes from. Note that not all lines going into the agenda
  6454. have this property, only most.
  6455. The function should return the modified string. It is probably best
  6456. to ONLY change text properties.
  6457. You can also use this function as a filter, by returning nil for lines
  6458. you don't want to have in the agenda at all. For this application, you
  6459. could bind the variable in the options section of a custom command.")
  6460. (defun org-agenda-finalize-entries (list &optional type)
  6461. "Sort, limit and concatenate the LIST of agenda items.
  6462. The optional argument TYPE tells the agenda type."
  6463. (let ((max-effort (cond ((listp org-agenda-max-effort)
  6464. (cdr (assoc type org-agenda-max-effort)))
  6465. (t org-agenda-max-effort)))
  6466. (max-todo (cond ((listp org-agenda-max-todos)
  6467. (cdr (assoc type org-agenda-max-todos)))
  6468. (t org-agenda-max-todos)))
  6469. (max-tags (cond ((listp org-agenda-max-tags)
  6470. (cdr (assoc type org-agenda-max-tags)))
  6471. (t org-agenda-max-tags)))
  6472. (max-entries (cond ((listp org-agenda-max-entries)
  6473. (cdr (assoc type org-agenda-max-entries)))
  6474. (t org-agenda-max-entries))))
  6475. (when org-agenda-before-sorting-filter-function
  6476. (setq list
  6477. (delq nil
  6478. (mapcar
  6479. org-agenda-before-sorting-filter-function list))))
  6480. (setq list (mapcar 'org-agenda-highlight-todo list)
  6481. list (mapcar 'identity (sort list 'org-entries-lessp)))
  6482. (when max-effort
  6483. (setq list (org-agenda-limit-entries
  6484. list 'effort-minutes max-effort
  6485. (lambda (e) (or e (if org-sort-agenda-noeffort-is-high
  6486. 32767 -1))))))
  6487. (when max-todo
  6488. (setq list (org-agenda-limit-entries list 'todo-state max-todo)))
  6489. (when max-tags
  6490. (setq list (org-agenda-limit-entries list 'tags max-tags)))
  6491. (when max-entries
  6492. (setq list (org-agenda-limit-entries list 'org-hd-marker max-entries)))
  6493. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  6494. (setq list (mapcar #'org-agenda--mark-blocked-entry list)))
  6495. (mapconcat 'identity list "\n")))
  6496. (defun org-agenda-limit-entries (list prop limit &optional fn)
  6497. "Limit the number of agenda entries."
  6498. (let ((include (and limit (< limit 0))))
  6499. (if limit
  6500. (let ((fun (or fn (lambda (p) (when p 1))))
  6501. (lim 0))
  6502. (delq nil
  6503. (mapcar
  6504. (lambda (e)
  6505. (let ((pval (funcall
  6506. fun (get-text-property (1- (length e))
  6507. prop e))))
  6508. (when pval (setq lim (+ lim pval)))
  6509. (cond ((and pval (<= lim (abs limit))) e)
  6510. ((and include (not pval)) e))))
  6511. list)))
  6512. list)))
  6513. (defun org-agenda-limit-interactively (remove)
  6514. "In agenda, interactively limit entries to various maximums."
  6515. (interactive "P")
  6516. (if remove
  6517. (progn (setq org-agenda-max-entries nil
  6518. org-agenda-max-todos nil
  6519. org-agenda-max-tags nil
  6520. org-agenda-max-effort nil)
  6521. (org-agenda-redo))
  6522. (let* ((max (read-char "Number of [e]ntries [t]odos [T]ags [E]ffort? "))
  6523. (msg (cond ((= max ?E) "How many minutes? ")
  6524. ((= max ?e) "How many entries? ")
  6525. ((= max ?t) "How many TODO entries? ")
  6526. ((= max ?T) "How many tagged entries? ")
  6527. (t (user-error "Wrong input"))))
  6528. (num (string-to-number (read-from-minibuffer msg))))
  6529. (cond ((equal max ?e)
  6530. (let ((org-agenda-max-entries num)) (org-agenda-redo)))
  6531. ((equal max ?t)
  6532. (let ((org-agenda-max-todos num)) (org-agenda-redo)))
  6533. ((equal max ?T)
  6534. (let ((org-agenda-max-tags num)) (org-agenda-redo)))
  6535. ((equal max ?E)
  6536. (let ((org-agenda-max-effort num)) (org-agenda-redo))))))
  6537. (org-agenda-fit-window-to-buffer))
  6538. (defun org-agenda-highlight-todo (x)
  6539. (let ((org-done-keywords org-done-keywords-for-agenda)
  6540. (case-fold-search nil)
  6541. re)
  6542. (if (eq x 'line)
  6543. (save-excursion
  6544. (beginning-of-line 1)
  6545. (setq re (org-get-at-bol 'org-todo-regexp))
  6546. (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
  6547. (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
  6548. (add-text-properties (match-beginning 0) (match-end 1)
  6549. (list 'face (org-get-todo-face 1)))
  6550. (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
  6551. (delete-region (match-beginning 1) (1- (match-end 0)))
  6552. (goto-char (match-beginning 1))
  6553. (insert (format org-agenda-todo-keyword-format s)))))
  6554. (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
  6555. (setq re (get-text-property 0 'org-todo-regexp x))
  6556. (when (and re
  6557. ;; Test `pl' because if there's no heading content,
  6558. ;; there's no point matching to highlight. Note
  6559. ;; that if we didn't test `pl' first, and there
  6560. ;; happened to be no keyword from `org-todo-regexp'
  6561. ;; on this heading line, then the `equal' comparison
  6562. ;; afterwards would spuriously succeed in the case
  6563. ;; where `pl' is nil -- causing an args-out-of-range
  6564. ;; error when we try to add text properties to text
  6565. ;; that isn't there.
  6566. pl
  6567. (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
  6568. x pl) pl))
  6569. (add-text-properties
  6570. (or (match-end 1) (match-end 0)) (match-end 0)
  6571. (list 'face (org-get-todo-face (match-string 2 x)))
  6572. x)
  6573. (when (match-end 1)
  6574. (setq x
  6575. (concat
  6576. (substring x 0 (match-end 1))
  6577. (format org-agenda-todo-keyword-format
  6578. (match-string 2 x))
  6579. ;; Remove `display' property as the icon could leak
  6580. ;; on the white space.
  6581. (org-add-props " " (org-plist-delete (text-properties-at 0 x)
  6582. 'display))
  6583. (substring x (match-end 3)))))))
  6584. x)))
  6585. (defsubst org-cmp-values (a b property)
  6586. "Compare the numeric value of text PROPERTY for string A and B."
  6587. (let ((pa (or (get-text-property (1- (length a)) property a) 0))
  6588. (pb (or (get-text-property (1- (length b)) property b) 0)))
  6589. (cond ((> pa pb) +1)
  6590. ((< pa pb) -1))))
  6591. (defsubst org-cmp-effort (a b)
  6592. "Compare the effort values of string A and B."
  6593. (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
  6594. ;; `effort-minutes' property is not directly accessible from
  6595. ;; the strings, but is stored as a property in `txt'.
  6596. (ea (or (get-text-property
  6597. 0 'effort-minutes (get-text-property 0 'txt a))
  6598. def))
  6599. (eb (or (get-text-property
  6600. 0 'effort-minutes (get-text-property 0 'txt b))
  6601. def)))
  6602. (cond ((> ea eb) +1)
  6603. ((< ea eb) -1))))
  6604. (defsubst org-cmp-category (a b)
  6605. "Compare the string values of categories of strings A and B."
  6606. (let ((ca (or (get-text-property (1- (length a)) 'org-category a) ""))
  6607. (cb (or (get-text-property (1- (length b)) 'org-category b) "")))
  6608. (cond ((string-lessp ca cb) -1)
  6609. ((string-lessp cb ca) +1))))
  6610. (defsubst org-cmp-todo-state (a b)
  6611. "Compare the todo states of strings A and B."
  6612. (let* ((ma (or (get-text-property 1 'org-marker a)
  6613. (get-text-property 1 'org-hd-marker a)))
  6614. (mb (or (get-text-property 1 'org-marker b)
  6615. (get-text-property 1 'org-hd-marker b)))
  6616. (fa (and ma (marker-buffer ma)))
  6617. (fb (and mb (marker-buffer mb)))
  6618. (todo-kwds
  6619. (or (and fa (with-current-buffer fa org-todo-keywords-1))
  6620. (and fb (with-current-buffer fb org-todo-keywords-1))))
  6621. (ta (or (get-text-property 1 'todo-state a) ""))
  6622. (tb (or (get-text-property 1 'todo-state b) ""))
  6623. (la (- (length (member ta todo-kwds))))
  6624. (lb (- (length (member tb todo-kwds))))
  6625. (donepa (member ta org-done-keywords-for-agenda))
  6626. (donepb (member tb org-done-keywords-for-agenda)))
  6627. (cond ((and donepa (not donepb)) -1)
  6628. ((and (not donepa) donepb) +1)
  6629. ((< la lb) -1)
  6630. ((< lb la) +1))))
  6631. (defsubst org-cmp-alpha (a b)
  6632. "Compare the headlines, alphabetically."
  6633. (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
  6634. (plb (text-property-any 0 (length b) 'org-heading t b))
  6635. (ta (and pla (substring a pla)))
  6636. (tb (and plb (substring b plb)))
  6637. (case-fold-search nil))
  6638. (when pla
  6639. (when (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
  6640. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
  6641. (setq ta (substring ta (match-end 0))))
  6642. (setq ta (downcase ta)))
  6643. (when plb
  6644. (when (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
  6645. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
  6646. (setq tb (substring tb (match-end 0))))
  6647. (setq tb (downcase tb)))
  6648. (cond ((not (or ta tb)) nil)
  6649. ((not ta) +1)
  6650. ((not tb) -1)
  6651. ((string-lessp ta tb) -1)
  6652. ((string-lessp tb ta) +1))))
  6653. (defsubst org-cmp-tag (a b)
  6654. "Compare the string values of the first tags of A and B."
  6655. (let ((ta (car (last (get-text-property 1 'tags a))))
  6656. (tb (car (last (get-text-property 1 'tags b)))))
  6657. (cond ((not (or ta tb)) nil)
  6658. ((not ta) +1)
  6659. ((not tb) -1)
  6660. ((string-lessp ta tb) -1)
  6661. ((string-lessp tb ta) +1))))
  6662. (defsubst org-cmp-time (a b)
  6663. "Compare the time-of-day values of strings A and B."
  6664. (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
  6665. (ta (or (get-text-property 1 'time-of-day a) def))
  6666. (tb (or (get-text-property 1 'time-of-day b) def)))
  6667. (cond ((< ta tb) -1)
  6668. ((< tb ta) +1))))
  6669. (defsubst org-cmp-ts (a b type)
  6670. "Compare the timestamps values of entries A and B.
  6671. When TYPE is \"scheduled\", \"deadline\", \"timestamp\" or
  6672. \"timestamp_ia\", compare within each of these type. When TYPE
  6673. is the empty string, compare all timestamps without respect of
  6674. their type."
  6675. (let* ((def (and (not org-sort-agenda-notime-is-late) -1))
  6676. (ta (or (and (string-match type (or (get-text-property 1 'type a) ""))
  6677. (get-text-property 1 'ts-date a))
  6678. def))
  6679. (tb (or (and (string-match type (or (get-text-property 1 'type b) ""))
  6680. (get-text-property 1 'ts-date b))
  6681. def)))
  6682. (cond ((if ta (and tb (< ta tb)) tb) -1)
  6683. ((if tb (and ta (< tb ta)) ta) +1))))
  6684. (defsubst org-cmp-habit-p (a b)
  6685. "Compare the todo states of strings A and B."
  6686. (let ((ha (get-text-property 1 'org-habit-p a))
  6687. (hb (get-text-property 1 'org-habit-p b)))
  6688. (cond ((and ha (not hb)) -1)
  6689. ((and (not ha) hb) +1))))
  6690. (defun org-entries-lessp (a b)
  6691. "Predicate for sorting agenda entries."
  6692. ;; The following variables will be used when the form is evaluated.
  6693. ;; So even though the compiler complains, keep them.
  6694. (let* ((ss org-agenda-sorting-strategy-selected)
  6695. (timestamp-up (and (org-em 'timestamp-up 'timestamp-down ss)
  6696. (org-cmp-ts a b "")))
  6697. (timestamp-down (if timestamp-up (- timestamp-up) nil))
  6698. (scheduled-up (and (org-em 'scheduled-up 'scheduled-down ss)
  6699. (org-cmp-ts a b "scheduled")))
  6700. (scheduled-down (if scheduled-up (- scheduled-up) nil))
  6701. (deadline-up (and (org-em 'deadline-up 'deadline-down ss)
  6702. (org-cmp-ts a b "deadline")))
  6703. (deadline-down (if deadline-up (- deadline-up) nil))
  6704. (tsia-up (and (org-em 'tsia-up 'tsia-down ss)
  6705. (org-cmp-ts a b "timestamp_ia")))
  6706. (tsia-down (if tsia-up (- tsia-up) nil))
  6707. (ts-up (and (org-em 'ts-up 'ts-down ss)
  6708. (org-cmp-ts a b "timestamp")))
  6709. (ts-down (if ts-up (- ts-up) nil))
  6710. (time-up (and (org-em 'time-up 'time-down ss)
  6711. (org-cmp-time a b)))
  6712. (time-down (if time-up (- time-up) nil))
  6713. (stats-up (and (org-em 'stats-up 'stats-down ss)
  6714. (org-cmp-values a b 'org-stats)))
  6715. (stats-down (if stats-up (- stats-up) nil))
  6716. (priority-up (and (org-em 'priority-up 'priority-down ss)
  6717. (org-cmp-values a b 'priority)))
  6718. (priority-down (if priority-up (- priority-up) nil))
  6719. (effort-up (and (org-em 'effort-up 'effort-down ss)
  6720. (org-cmp-effort a b)))
  6721. (effort-down (if effort-up (- effort-up) nil))
  6722. (category-up (and (or (org-em 'category-up 'category-down ss)
  6723. (memq 'category-keep ss))
  6724. (org-cmp-category a b)))
  6725. (category-down (if category-up (- category-up) nil))
  6726. (category-keep (if category-up +1 nil))
  6727. (tag-up (and (org-em 'tag-up 'tag-down ss)
  6728. (org-cmp-tag a b)))
  6729. (tag-down (if tag-up (- tag-up) nil))
  6730. (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
  6731. (org-cmp-todo-state a b)))
  6732. (todo-state-down (if todo-state-up (- todo-state-up) nil))
  6733. (habit-up (and (org-em 'habit-up 'habit-down ss)
  6734. (org-cmp-habit-p a b)))
  6735. (habit-down (if habit-up (- habit-up) nil))
  6736. (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
  6737. (org-cmp-alpha a b)))
  6738. (alpha-down (if alpha-up (- alpha-up) nil))
  6739. (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
  6740. user-defined-up user-defined-down)
  6741. (when (and need-user-cmp org-agenda-cmp-user-defined
  6742. (functionp org-agenda-cmp-user-defined))
  6743. (setq user-defined-up
  6744. (funcall org-agenda-cmp-user-defined a b)
  6745. user-defined-down (if user-defined-up (- user-defined-up) nil)))
  6746. (cdr (assoc
  6747. (eval (cons 'or org-agenda-sorting-strategy-selected))
  6748. '((-1 . t) (1 . nil) (nil . nil))))))
  6749. ;;; Agenda restriction lock
  6750. (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
  6751. "Overlay to mark the headline to which agenda commands are restricted.")
  6752. (overlay-put org-agenda-restriction-lock-overlay
  6753. 'face 'org-agenda-restriction-lock)
  6754. (overlay-put org-agenda-restriction-lock-overlay
  6755. 'help-echo "Agendas are currently limited to this subtree.")
  6756. (delete-overlay org-agenda-restriction-lock-overlay)
  6757. (defun org-agenda-set-restriction-lock-from-agenda (arg)
  6758. "Set the restriction lock to the agenda item at point from within the agenda.
  6759. When called with a `\\[universal-argument]' prefix, restrict to
  6760. the file which contains the item.
  6761. Argument ARG is the prefix argument."
  6762. (interactive "P")
  6763. (unless (derived-mode-p 'org-agenda-mode)
  6764. (user-error "Not in an Org agenda buffer"))
  6765. (let* ((marker (or (org-get-at-bol 'org-marker)
  6766. (org-agenda-error)))
  6767. (buffer (marker-buffer marker))
  6768. (pos (marker-position marker)))
  6769. (with-current-buffer buffer
  6770. (goto-char pos)
  6771. (org-agenda-set-restriction-lock arg))))
  6772. ;;;###autoload
  6773. (defun org-agenda-set-restriction-lock (&optional type)
  6774. "Set restriction lock for agenda to current subtree or file.
  6775. When in a restricted subtree, remove it.
  6776. The restriction will span over the entire file if TYPE is `file',
  6777. or if type is '(4), or if the cursor is before the first headline
  6778. in the file. Otherwise, only apply the restriction to the current
  6779. subtree."
  6780. (interactive "P")
  6781. (if (and org-agenda-overriding-restriction
  6782. (member org-agenda-restriction-lock-overlay
  6783. (overlays-at (point)))
  6784. (equal (overlay-start org-agenda-restriction-lock-overlay)
  6785. (point)))
  6786. (org-agenda-remove-restriction-lock 'noupdate)
  6787. (org-agenda-remove-restriction-lock 'noupdate)
  6788. (and (equal type '(4)) (setq type 'file))
  6789. (setq type (cond
  6790. (type type)
  6791. ((org-at-heading-p) 'subtree)
  6792. ((condition-case nil (org-back-to-heading t) (error nil))
  6793. 'subtree)
  6794. (t 'file)))
  6795. (if (eq type 'subtree)
  6796. (progn
  6797. (setq org-agenda-restrict (current-buffer))
  6798. (setq org-agenda-overriding-restriction 'subtree)
  6799. (put 'org-agenda-files 'org-restrict
  6800. (list (buffer-file-name (buffer-base-buffer))))
  6801. (org-back-to-heading t)
  6802. (move-overlay org-agenda-restriction-lock-overlay
  6803. (point)
  6804. (if org-agenda-restriction-lock-highlight-subtree
  6805. (save-excursion (org-end-of-subtree t t) (point))
  6806. (point-at-eol)))
  6807. (move-marker org-agenda-restrict-begin (point))
  6808. (move-marker org-agenda-restrict-end
  6809. (save-excursion (org-end-of-subtree t t)))
  6810. (message "Locking agenda restriction to subtree"))
  6811. (put 'org-agenda-files 'org-restrict
  6812. (list (buffer-file-name (buffer-base-buffer))))
  6813. (setq org-agenda-restrict nil)
  6814. (setq org-agenda-overriding-restriction 'file)
  6815. (move-marker org-agenda-restrict-begin nil)
  6816. (move-marker org-agenda-restrict-end nil)
  6817. (message "Locking agenda restriction to file"))
  6818. (setq current-prefix-arg nil))
  6819. (org-agenda-maybe-redo))
  6820. (defun org-agenda-remove-restriction-lock (&optional noupdate)
  6821. "Remove agenda restriction lock."
  6822. (interactive "P")
  6823. (if (not org-agenda-restrict)
  6824. (message "No agenda restriction to remove.")
  6825. (delete-overlay org-agenda-restriction-lock-overlay)
  6826. (delete-overlay org-speedbar-restriction-lock-overlay)
  6827. (setq org-agenda-overriding-restriction nil)
  6828. (setq org-agenda-restrict nil)
  6829. (put 'org-agenda-files 'org-restrict nil)
  6830. (move-marker org-agenda-restrict-begin nil)
  6831. (move-marker org-agenda-restrict-end nil)
  6832. (setq current-prefix-arg nil)
  6833. (message "Agenda restriction lock removed")
  6834. (or noupdate (org-agenda-maybe-redo))))
  6835. (defun org-agenda-maybe-redo ()
  6836. "If there is any window showing the agenda view, update it."
  6837. (let ((w (get-buffer-window (or org-agenda-this-buffer-name
  6838. org-agenda-buffer-name)
  6839. t))
  6840. (w0 (selected-window)))
  6841. (when w
  6842. (select-window w)
  6843. (org-agenda-redo)
  6844. (select-window w0)
  6845. (if org-agenda-overriding-restriction
  6846. (message "Agenda view shifted to new %s restriction"
  6847. org-agenda-overriding-restriction)
  6848. (message "Agenda restriction lock removed")))))
  6849. ;;; Agenda commands
  6850. (defun org-agenda-check-type (error &rest types)
  6851. "Check if agenda buffer or component is of allowed type.
  6852. If ERROR is non-nil, throw an error, otherwise just return nil.
  6853. Allowed types are `agenda' `todo' `tags' `search'."
  6854. (cond ((not org-agenda-type)
  6855. (error "No Org agenda currently displayed"))
  6856. ((memq org-agenda-type types) t)
  6857. (error
  6858. (error "Not allowed in '%s'-type agenda buffer or component" org-agenda-type))
  6859. (t nil)))
  6860. (defun org-agenda-Quit ()
  6861. "Exit the agenda, killing the agenda buffer.
  6862. Like `org-agenda-quit', but kill the buffer even when
  6863. `org-agenda-sticky' is non-nil."
  6864. (interactive)
  6865. (org-agenda--quit))
  6866. (defun org-agenda-quit ()
  6867. "Exit the agenda.
  6868. When `org-agenda-sticky' is non-nil, bury the agenda buffer
  6869. instead of killing it.
  6870. When `org-agenda-restore-windows-after-quit' is non-nil, restore
  6871. the pre-agenda window configuration.
  6872. When column view is active, exit column view instead of the
  6873. agenda."
  6874. (interactive)
  6875. (org-agenda--quit org-agenda-sticky))
  6876. (defun org-agenda--quit (&optional bury)
  6877. (if org-agenda-columns-active
  6878. (org-columns-quit)
  6879. (let ((wconf org-agenda-pre-window-conf)
  6880. (buf (current-buffer))
  6881. (org-agenda-last-indirect-window
  6882. (and (eq org-indirect-buffer-display 'other-window)
  6883. org-agenda-last-indirect-buffer
  6884. (get-buffer-window org-agenda-last-indirect-buffer))))
  6885. (cond
  6886. ((eq org-agenda-window-setup 'other-frame)
  6887. (delete-frame))
  6888. ((and org-agenda-restore-windows-after-quit
  6889. wconf)
  6890. ;; Maybe restore the pre-agenda window configuration. Reset
  6891. ;; `org-agenda-pre-window-conf' before running
  6892. ;; `set-window-configuration', which loses the current buffer.
  6893. (setq org-agenda-pre-window-conf nil)
  6894. (set-window-configuration wconf))
  6895. (t
  6896. (when org-agenda-last-indirect-window
  6897. (delete-window org-agenda-last-indirect-window))
  6898. (and (not (eq org-agenda-window-setup 'current-window))
  6899. (not (one-window-p))
  6900. (delete-window))))
  6901. (if bury
  6902. ;; Set the agenda buffer as the current buffer instead of
  6903. ;; passing it as an argument to `bury-buffer' so that
  6904. ;; `bury-buffer' removes it from the window.
  6905. (with-current-buffer buf
  6906. (bury-buffer))
  6907. (kill-buffer buf)
  6908. (setq org-agenda-archives-mode nil
  6909. org-agenda-buffer nil)))))
  6910. (defun org-agenda-exit ()
  6911. "Exit the agenda, killing Org buffers loaded by the agenda.
  6912. Like `org-agenda-Quit', but kill any buffers that were created by
  6913. the agenda. Org buffers visited directly by the user will not be
  6914. touched. Also, exit the agenda even if it is in column view."
  6915. (interactive)
  6916. (when org-agenda-columns-active
  6917. (org-columns-quit))
  6918. (org-release-buffers org-agenda-new-buffers)
  6919. (setq org-agenda-new-buffers nil)
  6920. (org-agenda-Quit))
  6921. (defun org-agenda-kill-all-agenda-buffers ()
  6922. "Kill all buffers in `org-agenda-mode'.
  6923. This is used when toggling sticky agendas."
  6924. (interactive)
  6925. (let (blist)
  6926. (dolist (buf (buffer-list))
  6927. (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
  6928. (push buf blist)))
  6929. (mapc 'kill-buffer blist)))
  6930. (defun org-agenda-execute (arg)
  6931. "Execute another agenda command, keeping same window.
  6932. So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
  6933. in the agenda."
  6934. (interactive "P")
  6935. (let ((org-agenda-window-setup 'current-window))
  6936. (org-agenda arg)))
  6937. (defun org-agenda-redo (&optional all)
  6938. "Rebuild possibly ALL agenda view(s) in the current buffer."
  6939. (interactive "P")
  6940. (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
  6941. (cpa (unless (eq all t) current-prefix-arg))
  6942. (org-agenda-doing-sticky-redo org-agenda-sticky)
  6943. (org-agenda-sticky nil)
  6944. (org-agenda-buffer-name (or org-agenda-this-buffer-name
  6945. org-agenda-buffer-name))
  6946. (org-agenda-keep-modes t)
  6947. (tag-filter org-agenda-tag-filter)
  6948. (tag-preset (get 'org-agenda-tag-filter :preset-filter))
  6949. (top-hl-filter org-agenda-top-headline-filter)
  6950. (cat-filter org-agenda-category-filter)
  6951. (cat-preset (get 'org-agenda-category-filter :preset-filter))
  6952. (re-filter org-agenda-regexp-filter)
  6953. (re-preset (get 'org-agenda-regexp-filter :preset-filter))
  6954. (effort-filter org-agenda-effort-filter)
  6955. (effort-preset (get 'org-agenda-effort-filter :preset-filter))
  6956. (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
  6957. (cols org-agenda-columns-active)
  6958. (line (org-current-line))
  6959. (window-line (- line (org-current-line (window-start))))
  6960. (lprops (get 'org-agenda-redo-command 'org-lprops))
  6961. (redo-cmd (get-text-property p 'org-redo-cmd))
  6962. (last-args (get-text-property p 'org-last-args))
  6963. (org-agenda-overriding-cmd (get-text-property p 'org-series-cmd))
  6964. (org-agenda-overriding-cmd-arguments
  6965. (unless (eq all t)
  6966. (cond ((listp last-args)
  6967. (cons (or cpa (car last-args)) (cdr last-args)))
  6968. ((stringp last-args)
  6969. last-args))))
  6970. (series-redo-cmd (get-text-property p 'org-series-redo-cmd)))
  6971. (put 'org-agenda-tag-filter :preset-filter nil)
  6972. (put 'org-agenda-category-filter :preset-filter nil)
  6973. (put 'org-agenda-regexp-filter :preset-filter nil)
  6974. (put 'org-agenda-effort-filter :preset-filter nil)
  6975. (and cols (org-columns-quit))
  6976. (message "Rebuilding agenda buffer...")
  6977. (if series-redo-cmd
  6978. (eval series-redo-cmd)
  6979. (org-let lprops redo-cmd))
  6980. (setq org-agenda-undo-list nil
  6981. org-agenda-pending-undo-list nil
  6982. org-agenda-tag-filter tag-filter
  6983. org-agenda-category-filter cat-filter
  6984. org-agenda-regexp-filter re-filter
  6985. org-agenda-effort-filter effort-filter
  6986. org-agenda-top-headline-filter top-hl-filter)
  6987. (message "Rebuilding agenda buffer...done")
  6988. (put 'org-agenda-tag-filter :preset-filter tag-preset)
  6989. (put 'org-agenda-category-filter :preset-filter cat-preset)
  6990. (put 'org-agenda-regexp-filter :preset-filter re-preset)
  6991. (put 'org-agenda-effort-filter :preset-filter effort-preset)
  6992. (let ((tag (or tag-filter tag-preset))
  6993. (cat (or cat-filter cat-preset))
  6994. (effort (or effort-filter effort-preset))
  6995. (re (or re-filter re-preset)))
  6996. (when tag (org-agenda-filter-apply tag 'tag t))
  6997. (when cat (org-agenda-filter-apply cat 'category))
  6998. (when effort (org-agenda-filter-apply effort 'effort))
  6999. (when re (org-agenda-filter-apply re 'regexp)))
  7000. (and top-hl-filter (org-agenda-filter-top-headline-apply top-hl-filter))
  7001. (and cols (called-interactively-p 'any) (org-agenda-columns))
  7002. (org-goto-line line)
  7003. (recenter window-line)))
  7004. (defun org-agenda-redo-all (&optional exhaustive)
  7005. "Rebuild all agenda views in the current buffer.
  7006. With a prefix argument, do so in all agenda buffers."
  7007. (interactive "P")
  7008. (if exhaustive
  7009. (dolist (buffer (buffer-list))
  7010. (with-current-buffer buffer
  7011. (when (derived-mode-p 'org-agenda-mode)
  7012. (org-agenda-redo t))))
  7013. (org-agenda-redo t)))
  7014. (defvar org-global-tags-completion-table nil)
  7015. (defvar org-agenda-filter-form nil)
  7016. (defvar org-agenda-filtered-by-category nil)
  7017. (defsubst org-agenda-get-category ()
  7018. "Return the category of the agenda line."
  7019. (org-get-at-bol 'org-category))
  7020. (defun org-agenda-filter-by-category (strip)
  7021. "Filter lines in the agenda buffer that have a specific category.
  7022. The category is that of the current line.
  7023. With a `\\[universal-argument]' prefix argument, exclude the lines of that category.
  7024. When there is already a category filter in place, this command removes the filter."
  7025. (interactive "P")
  7026. (if (and org-agenda-filtered-by-category
  7027. org-agenda-category-filter)
  7028. (org-agenda-filter-show-all-cat)
  7029. (let ((cat (org-no-properties (org-get-at-eol 'org-category 1))))
  7030. (cond
  7031. ((and cat strip)
  7032. (org-agenda-filter-apply
  7033. (push (concat "-" cat) org-agenda-category-filter) 'category))
  7034. (cat
  7035. (org-agenda-filter-apply
  7036. (setq org-agenda-category-filter
  7037. (list (concat "+" cat))) 'category))
  7038. (t (error "No category at point"))))))
  7039. (defun org-find-top-headline (&optional pos)
  7040. "Find the topmost parent headline and return it.
  7041. POS when non-nil is the marker or buffer position to start the
  7042. search from."
  7043. (save-excursion
  7044. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  7045. (when pos (goto-char pos))
  7046. ;; Skip up to the topmost parent.
  7047. (while (org-up-heading-safe))
  7048. (ignore-errors (nth 4 (org-heading-components))))))
  7049. (defvar org-agenda-filtered-by-top-headline nil)
  7050. (defun org-agenda-filter-by-top-headline (strip)
  7051. "Keep only those lines that are descendants from the same top headline.
  7052. The top headline is that of the current line. With prefix arg STRIP, hide
  7053. all lines of the category at point."
  7054. (interactive "P")
  7055. (if org-agenda-filtered-by-top-headline
  7056. (progn
  7057. (setq org-agenda-filtered-by-top-headline nil
  7058. org-agenda-top-headline-filter nil)
  7059. (org-agenda-filter-show-all-top-filter))
  7060. (let ((toph (org-find-top-headline (org-get-at-bol 'org-hd-marker))))
  7061. (if toph (org-agenda-filter-top-headline-apply toph strip)
  7062. (error "No top-level headline at point")))))
  7063. (defvar org-agenda-regexp-filter nil)
  7064. (defun org-agenda-filter-by-regexp (strip-or-accumulate)
  7065. "Filter agenda entries by a regular expressions.
  7066. You will be prompted for the regular expression, and the agenda
  7067. view will only show entries that are matched by that expression.
  7068. With one `\\[universal-argument]' prefix argument, hide entries matching the regexp.
  7069. When there is already a regexp filter active, this command removed the
  7070. filter. However, with two `\\[universal-argument]' prefix arguments, add a new condition to
  7071. an already existing regexp filter."
  7072. (interactive "P")
  7073. (let* ((strip (equal strip-or-accumulate '(4)))
  7074. (accumulate (equal strip-or-accumulate '(16))))
  7075. (cond
  7076. ((and org-agenda-regexp-filter (not accumulate))
  7077. (org-agenda-filter-show-all-re)
  7078. (message "Regexp filter removed"))
  7079. (t (let ((flt (concat (if strip "-" "+")
  7080. (read-from-minibuffer
  7081. (if strip
  7082. "Hide entries matching regexp: "
  7083. "Narrow to entries matching regexp: ")))))
  7084. (push flt org-agenda-regexp-filter)
  7085. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))))))
  7086. (defvar org-agenda-effort-filter nil)
  7087. (defun org-agenda-filter-by-effort (strip-or-accumulate)
  7088. "Filter agenda entries by effort.
  7089. With no `\\[universal-argument]' prefix argument, keep entries matching the effort condition.
  7090. With one `\\[universal-argument]' prefix argument, filter out entries matching the condition.
  7091. With two `\\[universal-argument]' prefix arguments, add a second condition to the existing filter.
  7092. This last option is in practice not very useful, but it is available for
  7093. consistency with the other filter commands."
  7094. (interactive "P")
  7095. (let* ((efforts (split-string
  7096. (or (cdr (assoc (concat org-effort-property "_ALL")
  7097. org-global-properties))
  7098. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00")))
  7099. ;; XXX: the following handles only up to 10 different
  7100. ;; effort values.
  7101. (allowed-keys (if (null efforts) nil
  7102. (mapcar (lambda (n) (mod n 10)) ;turn 10 into 0
  7103. (number-sequence 1 (length efforts)))))
  7104. (keep (equal strip-or-accumulate '(16)))
  7105. (negative (equal strip-or-accumulate '(4)))
  7106. (current org-agenda-effort-filter)
  7107. (op nil))
  7108. (while (not (memq op '(?< ?> ?= ?_)))
  7109. (setq op (read-char-exclusive
  7110. "Effort operator? (> = or <) or press `_' again to remove filter")))
  7111. ;; Select appropriate duration. Ignore non-digit characters.
  7112. (if (eq op ?_)
  7113. (progn
  7114. (org-agenda-filter-show-all-effort)
  7115. (message "Effort filter removed"))
  7116. (let ((prompt
  7117. (apply #'format
  7118. (concat "Effort %c "
  7119. (mapconcat (lambda (s) (concat "[%d]" s))
  7120. efforts
  7121. " "))
  7122. op allowed-keys))
  7123. (eff -1))
  7124. (while (not (memq eff allowed-keys))
  7125. (message prompt)
  7126. (setq eff (- (read-char-exclusive) 48)))
  7127. (org-agenda-filter-show-all-effort)
  7128. (setq org-agenda-effort-filter
  7129. (append
  7130. (list (concat (if negative "-" "+")
  7131. (char-to-string op)
  7132. ;; Numbering is 1 2 3 ... 9 0, but we want
  7133. ;; 0 1 2 ... 8 9.
  7134. (nth (mod (1- eff) 10) efforts)))
  7135. (if keep current nil)))
  7136. (org-agenda-filter-apply org-agenda-effort-filter 'effort)))))
  7137. (defun org-agenda-filter (&optional strip-or-accumulate)
  7138. "Prompt for a general filter string and apply it to the agenda.
  7139. The string may contain filter elements like
  7140. +category
  7141. +tag
  7142. +<effort > and = are also allowed as effort operators
  7143. +/regexp/
  7144. Instead of `+', `-' is allowed to strip the agenda of matching entries.
  7145. `+' is optional if it is not required to separate two string parts.
  7146. Multiple filter elements can be concatenated without spaces, for example
  7147. +work-John<0:10-/plot/
  7148. selects entries with category `work' and effort estimates below 10 minutes,
  7149. and deselects entries with tag `John' or matching the regexp `plot'.
  7150. During entry of the filter, completion for tags, categories and effort
  7151. values is offered. Since the syntax for categories and tags is identical
  7152. there should be no overlap between categories and tags. If there is, tags
  7153. get priority.
  7154. A single `\\[universal-argument]' prefix arg STRIP-OR-ACCUMULATE will negate the
  7155. entire filter, which can be useful in connection with the prompt history.
  7156. A double `\\[universal-argument] \\[universal-argument]' prefix arg will add the new filter elements to the
  7157. existing ones. A shortcut for this is to add an additional `+' at the
  7158. beginning of the string, like `+-John'.
  7159. With a triple prefix argument, execute the computed filtering defined in
  7160. the variable `org-agenda-auto-exclude-function'."
  7161. (interactive "P")
  7162. (if (equal strip-or-accumulate '(64))
  7163. ;; Execute the auto-exclude action
  7164. (if (not org-agenda-auto-exclude-function)
  7165. (user-error "`org-agenda-auto-exclude-function' is undefined")
  7166. (org-agenda-filter-show-all-tag)
  7167. (setq org-agenda-tag-filter nil)
  7168. (dolist (tag (org-agenda-get-represented-tags))
  7169. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  7170. (when modifier
  7171. (push modifier org-agenda-tag-filter))))
  7172. (unless (null org-agenda-tag-filter)
  7173. (org-agenda-filter-apply org-agenda-tag-filter 'tag 'expand)))
  7174. ;; Prompt for a filter and act
  7175. (let* ((tag-list (org-agenda-get-represented-tags))
  7176. (category-list (org-agenda-get-represented-categories))
  7177. (negate (equal strip-or-accumulate '(4)))
  7178. (f-string (completing-read
  7179. (concat
  7180. (if negate "Negative filter" "Filter")
  7181. " [+cat-tag<0:10-/regexp/]: ")
  7182. 'org-agenda-filter-completion-function))
  7183. (keep (or (if (string-match "^\\+[+-]" f-string)
  7184. (progn (setq f-string (substring f-string 1)) t))
  7185. (equal strip-or-accumulate '(16))))
  7186. (fc (if keep org-agenda-category-filter))
  7187. (ft (if keep org-agenda-tag-filter))
  7188. (fe (if keep org-agenda-effort-filter))
  7189. (fr (if keep org-agenda-regexp-filter))
  7190. pm s)
  7191. (while (string-match "^[ \t]*\\([-+]\\)?\\(\\([^-+<>=/ \t]+\\)\\|\\([<>=][0-9:]+\\)\\|\\(/\\([^/]+\\)/?\\)\\)" f-string)
  7192. (setq pm (if (match-beginning 1) (match-string 1 f-string) "+"))
  7193. (when negate
  7194. (setq pm (if (equal pm "+") "-" "+")))
  7195. (cond
  7196. ((match-beginning 3)
  7197. ;; category or tag
  7198. (setq s (match-string 3 f-string))
  7199. (cond
  7200. ((member s tag-list)
  7201. (add-to-list 'ft (concat pm s) 'append 'equal))
  7202. ((member s category-list)
  7203. (add-to-list 'fc (concat pm s) 'append 'equal))
  7204. (t (message
  7205. "`%s%s' filter ignored because tag/category is not represented"
  7206. pm s))))
  7207. ((match-beginning 4)
  7208. ;; effort
  7209. (add-to-list 'fe (concat pm (match-string 4 f-string)) t 'equal))
  7210. ((match-beginning 5)
  7211. ;; regexp
  7212. (add-to-list 'fr (concat pm (match-string 6 f-string)) t 'equal)))
  7213. (setq f-string (substring f-string (match-end 0))))
  7214. (org-agenda-filter-remove-all)
  7215. (and fc (org-agenda-filter-apply
  7216. (setq org-agenda-category-filter fc) 'category))
  7217. (and ft (org-agenda-filter-apply
  7218. (setq org-agenda-tag-filter ft) 'tag))
  7219. (and fe (org-agenda-filter-apply
  7220. (setq org-agenda-effort-filter fe) 'effort))
  7221. (and fr (org-agenda-filter-apply
  7222. (setq org-agenda-regexp-filter fr) 'regexp)))))
  7223. (defun org-agenda-filter-completion-function (string _predicate &optional flag)
  7224. "Complete a complex filter string.
  7225. FLAG specifies the type of completion operation to perform. This
  7226. function is passed as a collection function to `completing-read',
  7227. which see."
  7228. (let ((completion-ignore-case t) ;tags are case-sensitive
  7229. (confirm (lambda (x) (stringp x)))
  7230. (prefix "")
  7231. (operator "")
  7232. table)
  7233. (when (string-match "^\\(.*\\([-+<>=]\\)\\)\\([^-+<>=]*\\)$" string)
  7234. (setq prefix (match-string 1 string)
  7235. operator (match-string 2 string)
  7236. string (match-string 3 string)))
  7237. (cond
  7238. ((member operator '("+" "-" "" nil))
  7239. (setq table (append (org-agenda-get-represented-categories)
  7240. (org-agenda-get-represented-tags))))
  7241. ((member operator '("<" ">" "="))
  7242. (setq table (split-string
  7243. (or (cdr (assoc (concat org-effort-property "_ALL")
  7244. org-global-properties))
  7245. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00")
  7246. " +")))
  7247. (t (setq table nil)))
  7248. (pcase flag
  7249. (`t (all-completions string table confirm))
  7250. (`lambda (assoc string table)) ;exact match?
  7251. (`nil
  7252. (pcase (try-completion string table confirm)
  7253. ((and completion (pred stringp))
  7254. (concat prefix completion))
  7255. (completion completion)))
  7256. (_ nil))))
  7257. (defun org-agenda-filter-remove-all ()
  7258. "Remove all filters from the current agenda buffer."
  7259. (interactive)
  7260. (when org-agenda-tag-filter
  7261. (org-agenda-filter-show-all-tag))
  7262. (when org-agenda-category-filter
  7263. (org-agenda-filter-show-all-cat))
  7264. (when org-agenda-regexp-filter
  7265. (org-agenda-filter-show-all-re))
  7266. (when org-agenda-top-headline-filter
  7267. (org-agenda-filter-show-all-top-filter))
  7268. (when org-agenda-effort-filter
  7269. (org-agenda-filter-show-all-effort))
  7270. (org-agenda-finalize))
  7271. (defun org-agenda-filter-by-tag (strip-or-accumulate &optional char exclude)
  7272. "Keep only those lines in the agenda buffer that have a specific tag.
  7273. The tag is selected with its fast selection letter, as configured.
  7274. With a `\\[universal-argument]' prefix, apply the filter negatively, stripping all matches.
  7275. With a `\\[universal-argument] \\[universal-argument]' prefix, add the new tag to the existing filter
  7276. instead of replacing it.
  7277. With a `\\[universal-argument] \\[universal-argument] \\[universal-argument]' prefix, filter the literal tag, \
  7278. i.e. don't
  7279. filter on all its group members.
  7280. A lisp caller can specify CHAR. EXCLUDE means that the new tag
  7281. should be used to exclude the search - the interactive user can
  7282. also press `-' or `+' to switch between filtering and excluding."
  7283. (interactive "P")
  7284. (let* ((alist org-tag-alist-for-agenda)
  7285. (seen-chars nil)
  7286. (tag-chars (mapconcat
  7287. (lambda (x) (if (and (not (symbolp (car x)))
  7288. (cdr x)
  7289. (not (member (cdr x) seen-chars)))
  7290. (progn
  7291. (push (cdr x) seen-chars)
  7292. (char-to-string (cdr x)))
  7293. ""))
  7294. org-tag-alist-for-agenda ""))
  7295. (valid-char-list (append '(?\t ?\r ?\\ ?. ?\s ?q)
  7296. (string-to-list tag-chars)))
  7297. (exclude (or exclude (equal strip-or-accumulate '(4))))
  7298. (accumulate (equal strip-or-accumulate '(16)))
  7299. (expand (not (equal strip-or-accumulate '(64))))
  7300. (inhibit-read-only t)
  7301. (current org-agenda-tag-filter)
  7302. a n tag)
  7303. (unless char
  7304. (while (not (memq char valid-char-list))
  7305. (org-unlogged-message
  7306. "%s by tag%s: [%s ]tag-char [TAB]tag %s[\\]off [q]uit"
  7307. (if exclude "Exclude[+]" "Filter[-]")
  7308. (if expand "" " (no grouptag expand)")
  7309. tag-chars
  7310. (if org-agenda-auto-exclude-function "[RET] " ""))
  7311. (setq char (read-char-exclusive))
  7312. ;; Excluding or filtering down
  7313. (cond ((eq char ?-) (setq exclude t))
  7314. ((eq char ?+) (setq exclude nil)))))
  7315. (when (eq char ?\t)
  7316. (unless (local-variable-p 'org-global-tags-completion-table)
  7317. (setq-local org-global-tags-completion-table
  7318. (org-global-tags-completion-table)))
  7319. (let ((completion-ignore-case t))
  7320. (setq tag (completing-read
  7321. "Tag: " org-global-tags-completion-table nil t))))
  7322. (cond
  7323. ((eq char ?\r)
  7324. (org-agenda-filter-show-all-tag)
  7325. (when org-agenda-auto-exclude-function
  7326. (setq org-agenda-tag-filter nil)
  7327. (dolist (tag (org-agenda-get-represented-tags))
  7328. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  7329. (when modifier
  7330. (push modifier org-agenda-tag-filter))))
  7331. (unless (null org-agenda-tag-filter)
  7332. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))))
  7333. ((eq char ?\\)
  7334. (org-agenda-filter-show-all-tag)
  7335. (when (get 'org-agenda-tag-filter :preset-filter)
  7336. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand)))
  7337. ((eq char ?.)
  7338. (setq org-agenda-tag-filter
  7339. (mapcar (lambda(tag) (concat "+" tag))
  7340. (org-get-at-bol 'tags)))
  7341. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  7342. ((eq char ?q)) ;If q, abort (even if there is a q-key for a tag...)
  7343. ((or (eq char ?\s)
  7344. (setq a (rassoc char alist))
  7345. (and tag (setq a (cons tag nil))))
  7346. (org-agenda-filter-show-all-tag)
  7347. (setq tag (car a))
  7348. (setq org-agenda-tag-filter
  7349. (cons (concat (if exclude "-" "+") tag)
  7350. (if accumulate current nil)))
  7351. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  7352. (t (error "Invalid tag selection character %c" char)))))
  7353. (defun org-agenda-get-represented-categories ()
  7354. "Return a list of all categories used in this agenda buffer."
  7355. (or org-agenda-represented-categories
  7356. (when (derived-mode-p 'org-agenda-mode)
  7357. (let ((pos (point-min)) categories)
  7358. (while (and (< pos (point-max))
  7359. (setq pos (next-single-property-change
  7360. pos 'org-category nil (point-max))))
  7361. (push (get-text-property pos 'org-category) categories))
  7362. (setq org-agenda-represented-categories
  7363. (nreverse (org-uniquify (delq nil categories))))))))
  7364. (defun org-agenda-get-represented-tags ()
  7365. "Return a list of all tags used in this agenda buffer.
  7366. These will be lower-case, for filtering."
  7367. (or org-agenda-represented-tags
  7368. (when (derived-mode-p 'org-agenda-mode)
  7369. (let ((pos (point-min)) tags-lists tt)
  7370. (while (and (< pos (point-max))
  7371. (setq pos (next-single-property-change
  7372. pos 'tags nil (point-max))))
  7373. (setq tt (get-text-property pos 'tags))
  7374. (if tt (push tt tags-lists)))
  7375. (setq org-agenda-represented-tags
  7376. (nreverse (org-uniquify
  7377. (delq nil (apply 'append tags-lists)))))))))
  7378. (defun org-agenda-filter-make-matcher (filter type &optional expand)
  7379. "Create the form that tests a line for agenda filter. Optional
  7380. argument EXPAND can be used for the TYPE tag and will expand the
  7381. tags in the FILTER if any of the tags in FILTER are grouptags."
  7382. (let ((multi-pos-cats
  7383. (string-match-p "\++"
  7384. (mapconcat (lambda (cat) (substring cat 0 1)) filter "")))
  7385. f f1)
  7386. (cond
  7387. ;; Tag filter
  7388. ((eq type 'tag)
  7389. (setq filter
  7390. (delete-dups
  7391. (append (get 'org-agenda-tag-filter :preset-filter)
  7392. filter)))
  7393. (dolist (x filter)
  7394. (let ((op (string-to-char x)))
  7395. (if expand (setq x (org-agenda-filter-expand-tags (list x) t))
  7396. (setq x (list x)))
  7397. (setq f1 (org-agenda-filter-make-matcher-tag-exp x op))
  7398. (push f1 f))))
  7399. ;; Category filter
  7400. ((eq type 'category)
  7401. (setq filter
  7402. (delete-dups
  7403. (append (get 'org-agenda-category-filter :preset-filter)
  7404. filter)))
  7405. (dolist (x filter)
  7406. (if (equal "-" (substring x 0 1))
  7407. (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
  7408. (setq f1 (list 'equal (substring x 1) 'cat)))
  7409. (push f1 f)))
  7410. ;; Regexp filter
  7411. ((eq type 'regexp)
  7412. (setq filter
  7413. (delete-dups
  7414. (append (get 'org-agenda-regexp-filter :preset-filter)
  7415. filter)))
  7416. (dolist (x filter)
  7417. (if (equal "-" (substring x 0 1))
  7418. (setq f1 (list 'not (list 'string-match (substring x 1) 'txt)))
  7419. (setq f1 (list 'string-match (substring x 1) 'txt)))
  7420. (push f1 f)))
  7421. ;; Effort filter
  7422. ((eq type 'effort)
  7423. (setq filter
  7424. (delete-dups
  7425. (append (get 'org-agenda-effort-filter :preset-filter)
  7426. filter)))
  7427. (dolist (x filter)
  7428. (push (org-agenda-filter-effort-form x) f))))
  7429. (cons (if multi-pos-cats 'or 'and) (nreverse f))))
  7430. (defun org-agenda-filter-make-matcher-tag-exp (tags op)
  7431. "Return a form associated to tag-expression TAGS.
  7432. Build a form testing a line for agenda filter for
  7433. tag-expressions. OP is an operator of type CHAR that allows the
  7434. function to set the right switches in the returned form."
  7435. (let (form)
  7436. ;; Any of the expressions can match if OP is +, all must match if
  7437. ;; the operator is -.
  7438. (dolist (x tags (cons (if (eq op ?-) 'and 'or) form))
  7439. (let* ((tag (substring x 1))
  7440. (f (cond
  7441. ((string= "" tag) 'tags)
  7442. ((and (string-match-p "\\`{" tag) (string-match-p "}\\'" tag))
  7443. ;; TAG is a regexp.
  7444. (list 'org-match-any-p (substring tag 1 -1) 'tags))
  7445. (t (list 'member (downcase tag) 'tags)))))
  7446. (push (if (eq op ?-) (list 'not f) f) form)))))
  7447. (defun org-agenda-filter-effort-form (e)
  7448. "Return the form to compare the effort of the current line with what E says.
  7449. E looks like \"+<2:25\"."
  7450. (let (op)
  7451. (setq e (substring e 1))
  7452. (setq op (string-to-char e) e (substring e 1))
  7453. (setq op (cond ((equal op ?<) '<=)
  7454. ((equal op ?>) '>=)
  7455. ((equal op ??) op)
  7456. (t '=)))
  7457. (list 'org-agenda-compare-effort (list 'quote op)
  7458. (org-duration-to-minutes e))))
  7459. (defun org-agenda-compare-effort (op value)
  7460. "Compare the effort of the current line with VALUE, using OP.
  7461. If the line does not have an effort defined, return nil."
  7462. ;; `effort-minutes' property cannot be extracted directly from
  7463. ;; current line but is stored as a property in `txt'.
  7464. (let ((effort (get-text-property 0 'effort-minutes (org-get-at-bol 'txt))))
  7465. (funcall op
  7466. (or effort (if org-sort-agenda-noeffort-is-high 32767 -1))
  7467. value)))
  7468. (defun org-agenda-filter-expand-tags (filter &optional no-operator)
  7469. "Expand group tags in FILTER for the agenda.
  7470. When NO-OPERATOR is non-nil, do not add the + operator to returned tags."
  7471. (if org-group-tags
  7472. (let ((case-fold-search t) rtn)
  7473. (mapc
  7474. (lambda (f)
  7475. (let (f0 dir)
  7476. (if (string-match "^\\([+-]\\)\\(.+\\)" f)
  7477. (setq dir (match-string 1 f) f0 (match-string 2 f))
  7478. (setq dir (if no-operator "" "+") f0 f))
  7479. (setq rtn (append (mapcar (lambda(f1) (concat dir f1))
  7480. (org-tags-expand f0 t t))
  7481. rtn))))
  7482. filter)
  7483. (reverse rtn))
  7484. filter))
  7485. (defun org-agenda-filter-apply (filter type &optional expand)
  7486. "Set FILTER as the new agenda filter and apply it. Optional
  7487. argument EXPAND can be used for the TYPE tag and will expand the
  7488. tags in the FILTER if any of the tags in FILTER are grouptags."
  7489. ;; Deactivate `org-agenda-entry-text-mode' when filtering
  7490. (when org-agenda-entry-text-mode (org-agenda-entry-text-mode))
  7491. (let (tags cat txt)
  7492. (setq org-agenda-filter-form (org-agenda-filter-make-matcher
  7493. filter type expand))
  7494. ;; Only set `org-agenda-filtered-by-category' to t when a unique
  7495. ;; category is used as the filter:
  7496. (setq org-agenda-filtered-by-category
  7497. (and (eq type 'category)
  7498. (not (equal (substring (car filter) 0 1) "-"))))
  7499. (org-agenda-set-mode-name)
  7500. (save-excursion
  7501. (goto-char (point-min))
  7502. (while (not (eobp))
  7503. (if (org-get-at-bol 'org-hd-marker)
  7504. (progn
  7505. (setq tags (org-get-at-bol 'tags)
  7506. cat (org-agenda-get-category)
  7507. txt (org-get-at-bol 'txt))
  7508. (unless (eval org-agenda-filter-form)
  7509. (org-agenda-filter-hide-line type))
  7510. (beginning-of-line 2))
  7511. (beginning-of-line 2))))
  7512. (when (get-char-property (point) 'invisible)
  7513. (ignore-errors (org-agenda-previous-line)))))
  7514. (defun org-agenda-filter-top-headline-apply (hl &optional negative)
  7515. "Filter by top headline HL."
  7516. (org-agenda-set-mode-name)
  7517. (save-excursion
  7518. (goto-char (point-min))
  7519. (while (not (eobp))
  7520. (let* ((pos (org-get-at-bol 'org-hd-marker))
  7521. (tophl (and pos (org-find-top-headline pos))))
  7522. (when (and tophl (funcall (if negative 'identity 'not)
  7523. (string= hl tophl)))
  7524. (org-agenda-filter-hide-line 'top-headline)))
  7525. (beginning-of-line 2)))
  7526. (when (get-char-property (point) 'invisible)
  7527. (org-agenda-previous-line))
  7528. (setq org-agenda-top-headline-filter hl
  7529. org-agenda-filtered-by-top-headline t))
  7530. (defun org-agenda-filter-hide-line (type)
  7531. "If current line is TYPE, hide it in the agenda buffer."
  7532. (let* (buffer-invisibility-spec
  7533. (beg (max (point-min) (1- (point-at-bol))))
  7534. (end (point-at-eol)))
  7535. (let ((inhibit-read-only t))
  7536. (add-text-properties
  7537. beg end `(invisible org-filtered org-filter-type ,type)))))
  7538. (defun org-agenda-remove-filter (type)
  7539. (interactive)
  7540. "Remove filter of type TYPE from the agenda buffer."
  7541. (save-excursion
  7542. (goto-char (point-min))
  7543. (let ((inhibit-read-only t) pos)
  7544. (while (setq pos (text-property-any (point) (point-max)
  7545. 'org-filter-type type))
  7546. (goto-char pos)
  7547. (remove-text-properties
  7548. (point) (next-single-property-change (point) 'org-filter-type)
  7549. `(invisible org-filtered org-filter-type ,type))))
  7550. (set (intern (format "org-agenda-%s-filter" (intern-soft type))) nil)
  7551. (setq org-agenda-filter-form nil)
  7552. (org-agenda-set-mode-name)
  7553. (org-agenda-finalize)))
  7554. (defun org-agenda-filter-show-all-tag nil
  7555. (org-agenda-remove-filter 'tag))
  7556. (defun org-agenda-filter-show-all-re nil
  7557. (org-agenda-remove-filter 'regexp))
  7558. (defun org-agenda-filter-show-all-effort nil
  7559. (org-agenda-remove-filter 'effort))
  7560. (defun org-agenda-filter-show-all-cat nil
  7561. (org-agenda-remove-filter 'category))
  7562. (defun org-agenda-filter-show-all-top-filter nil
  7563. (org-agenda-remove-filter 'top-headline))
  7564. (defun org-agenda-manipulate-query-add ()
  7565. "Manipulate the query by adding a search term with positive selection.
  7566. Positive selection means the term must be matched for selection of an entry."
  7567. (interactive)
  7568. (org-agenda-manipulate-query ?\[))
  7569. (defun org-agenda-manipulate-query-subtract ()
  7570. "Manipulate the query by adding a search term with negative selection.
  7571. Negative selection means term must not be matched for selection of an entry."
  7572. (interactive)
  7573. (org-agenda-manipulate-query ?\]))
  7574. (defun org-agenda-manipulate-query-add-re ()
  7575. "Manipulate the query by adding a search regexp with positive selection.
  7576. Positive selection means the regexp must match for selection of an entry."
  7577. (interactive)
  7578. (org-agenda-manipulate-query ?\{))
  7579. (defun org-agenda-manipulate-query-subtract-re ()
  7580. "Manipulate the query by adding a search regexp with negative selection.
  7581. Negative selection means regexp must not match for selection of an entry."
  7582. (interactive)
  7583. (org-agenda-manipulate-query ?\}))
  7584. (defun org-agenda-manipulate-query (char)
  7585. (cond
  7586. ((eq org-agenda-type 'agenda)
  7587. (let ((org-agenda-include-inactive-timestamps t))
  7588. (org-agenda-redo))
  7589. (message "Display now includes inactive timestamps as well"))
  7590. ((eq org-agenda-type 'search)
  7591. (org-add-to-string
  7592. 'org-agenda-query-string
  7593. (if org-agenda-last-search-view-search-was-boolean
  7594. (cdr (assoc char '((?\[ . " +") (?\] . " -")
  7595. (?\{ . " +{}") (?\} . " -{}"))))
  7596. " "))
  7597. (setq org-agenda-redo-command
  7598. (list 'org-search-view
  7599. (car (get-text-property (min (1- (point-max)) (point))
  7600. 'org-last-args))
  7601. org-agenda-query-string
  7602. (+ (length org-agenda-query-string)
  7603. (if (member char '(?\{ ?\})) 0 1))))
  7604. (set-register org-agenda-query-register org-agenda-query-string)
  7605. (let ((org-agenda-overriding-arguments
  7606. (cdr org-agenda-redo-command)))
  7607. (org-agenda-redo)))
  7608. (t (error "Cannot manipulate query for %s-type agenda buffers"
  7609. org-agenda-type))))
  7610. (defun org-add-to-string (var string)
  7611. (set var (concat (symbol-value var) string)))
  7612. (defun org-agenda-goto-date (span)
  7613. "Jump to DATE in agenda."
  7614. (interactive "P")
  7615. (let* ((org-read-date-prefer-future
  7616. (eval org-agenda-jump-prefer-future))
  7617. (date (org-read-date))
  7618. (day (time-to-days (org-time-string-to-time date)))
  7619. (org-agenda-sticky-orig org-agenda-sticky)
  7620. (org-agenda-buffer-tmp-name (buffer-name))
  7621. (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7622. (0-arg (or current-prefix-arg (car args)))
  7623. (2-arg (nth 2 args))
  7624. (with-hour-p (nth 4 org-agenda-redo-command))
  7625. (newcmd (list 'org-agenda-list 0-arg date
  7626. (org-agenda-span-to-ndays
  7627. 2-arg (org-time-string-to-absolute date))
  7628. with-hour-p))
  7629. (newargs (cdr newcmd))
  7630. (inhibit-read-only t)
  7631. org-agenda-sticky)
  7632. (if (not (org-agenda-check-type t 'agenda))
  7633. (error "Not available in non-agenda views")
  7634. (add-text-properties (point-min) (point-max)
  7635. `(org-redo-cmd ,newcmd org-last-args ,newargs))
  7636. (org-agenda-redo)
  7637. (goto-char (point-min))
  7638. (while (not (or (= (or (get-text-property (point) 'day) 0) day)
  7639. (save-excursion (move-beginning-of-line 2) (eobp))))
  7640. (move-beginning-of-line 2))
  7641. (setq org-agenda-sticky org-agenda-sticky-orig
  7642. org-agenda-this-buffer-is-sticky org-agenda-sticky))))
  7643. (defun org-agenda-goto-today ()
  7644. "Go to today."
  7645. (interactive)
  7646. (org-agenda-check-type t 'agenda)
  7647. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7648. (curspan (nth 2 args))
  7649. (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
  7650. (cond
  7651. (tdpos (goto-char tdpos))
  7652. ((eq org-agenda-type 'agenda)
  7653. (let* ((sd (org-agenda-compute-starting-span
  7654. (org-today) (or curspan org-agenda-span)))
  7655. (org-agenda-overriding-arguments args))
  7656. (setf (nth 1 org-agenda-overriding-arguments) sd)
  7657. (org-agenda-redo)
  7658. (org-agenda-find-same-or-today-or-agenda)))
  7659. (t (error "Cannot find today")))))
  7660. (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
  7661. (goto-char
  7662. (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
  7663. (text-property-any (point-min) (point-max) 'org-today t)
  7664. (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
  7665. (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
  7666. (org-agenda-backward-block))
  7667. (point-min))))
  7668. (defun org-agenda-backward-block ()
  7669. "Move backward by one agenda block."
  7670. (interactive)
  7671. (org-agenda-forward-block 'backward))
  7672. (defun org-agenda-forward-block (&optional backward)
  7673. "Move forward by one agenda block.
  7674. When optional argument BACKWARD is set, go backward."
  7675. (interactive)
  7676. (cond ((not (derived-mode-p 'org-agenda-mode))
  7677. (user-error
  7678. "Cannot execute this command outside of org-agenda-mode buffers"))
  7679. ((looking-at (if backward "\\`" "\\'"))
  7680. (message "Already at the %s block" (if backward "first" "last")))
  7681. (t (let ((pos (prog1 (point)
  7682. (ignore-errors (if backward (backward-char 1)
  7683. (move-end-of-line 1)))))
  7684. (f (if backward
  7685. 'previous-single-property-change
  7686. 'next-single-property-change))
  7687. moved dest)
  7688. (while (and (setq dest (funcall
  7689. f (point) 'org-agenda-structural-header))
  7690. (not (get-text-property
  7691. (point) 'org-agenda-structural-header)))
  7692. (setq moved t)
  7693. (goto-char dest))
  7694. (if moved (move-beginning-of-line 1)
  7695. (goto-char (if backward (point-min) (point-max)))
  7696. (move-beginning-of-line 1)
  7697. (message "No %s block" (if backward "previous" "further")))))))
  7698. (defun org-agenda-later (arg)
  7699. "Go forward in time by the current span.
  7700. With prefix ARG, go forward that many times the current span."
  7701. (interactive "p")
  7702. (org-agenda-check-type t 'agenda)
  7703. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7704. (span (or (nth 2 args) org-agenda-current-span))
  7705. (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
  7706. (greg (calendar-gregorian-from-absolute sd))
  7707. (cnt (org-get-at-bol 'org-day-cnt))
  7708. greg2)
  7709. (cond
  7710. ((numberp span)
  7711. (setq sd (+ (* span arg) sd)))
  7712. ((eq span 'day)
  7713. (setq sd (+ arg sd)))
  7714. ((eq span 'week)
  7715. (setq sd (+ (* 7 arg) sd)))
  7716. ((eq span 'fortnight)
  7717. (setq sd (+ (* 14 arg) sd)))
  7718. ((eq span 'month)
  7719. (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
  7720. sd (calendar-absolute-from-gregorian greg2))
  7721. (setcar greg2 (1+ (car greg2))))
  7722. ((eq span 'year)
  7723. (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
  7724. sd (calendar-absolute-from-gregorian greg2))
  7725. (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
  7726. (t
  7727. (setq sd (+ (* span arg) sd))))
  7728. (let ((org-agenda-overriding-cmd
  7729. ;; `cmd' may have been set by `org-agenda-run-series' which
  7730. ;; uses `org-agenda-overriding-cmd' to decide whether
  7731. ;; overriding is allowed for `cmd'
  7732. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7733. (org-agenda-overriding-arguments
  7734. (list (car args) sd span)))
  7735. (org-agenda-redo)
  7736. (org-agenda-find-same-or-today-or-agenda cnt))))
  7737. (defun org-agenda-earlier (arg)
  7738. "Go backward in time by the current span.
  7739. With prefix ARG, go backward that many times the current span."
  7740. (interactive "p")
  7741. (org-agenda-later (- arg)))
  7742. (defun org-agenda-view-mode-dispatch ()
  7743. "Call one of the view mode commands."
  7744. (interactive)
  7745. (org-unlogged-message
  7746. "View: [d]ay [w]eek for[t]night [m]onth [y]ear [SPC]reset [q]uit/abort
  7747. time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
  7748. [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
  7749. (pcase (read-char-exclusive)
  7750. (?\ (call-interactively 'org-agenda-reset-view))
  7751. (?d (call-interactively 'org-agenda-day-view))
  7752. (?w (call-interactively 'org-agenda-week-view))
  7753. (?t (call-interactively 'org-agenda-fortnight-view))
  7754. (?m (call-interactively 'org-agenda-month-view))
  7755. (?y (call-interactively 'org-agenda-year-view))
  7756. (?l (call-interactively 'org-agenda-log-mode))
  7757. (?L (org-agenda-log-mode '(4)))
  7758. (?c (org-agenda-log-mode 'clockcheck))
  7759. ((or ?F ?f) (call-interactively 'org-agenda-follow-mode))
  7760. (?a (call-interactively 'org-agenda-archives-mode))
  7761. (?A (org-agenda-archives-mode 'files))
  7762. ((or ?R ?r) (call-interactively 'org-agenda-clockreport-mode))
  7763. ((or ?E ?e) (call-interactively 'org-agenda-entry-text-mode))
  7764. (?G (call-interactively 'org-agenda-toggle-time-grid))
  7765. (?D (call-interactively 'org-agenda-toggle-diary))
  7766. (?\! (call-interactively 'org-agenda-toggle-deadlines))
  7767. (?\[ (let ((org-agenda-include-inactive-timestamps t))
  7768. (org-agenda-check-type t 'agenda)
  7769. (org-agenda-redo))
  7770. (message "Display now includes inactive timestamps as well"))
  7771. (?q (message "Abort"))
  7772. (key (user-error "Invalid key: %s" key))))
  7773. (defun org-agenda-reset-view ()
  7774. "Switch to default view for agenda."
  7775. (interactive)
  7776. (org-agenda-change-time-span org-agenda-span))
  7777. (defun org-agenda-day-view (&optional day-of-month)
  7778. "Switch to daily view for agenda.
  7779. With argument DAY-OF-MONTH, switch to that day of the month."
  7780. (interactive "P")
  7781. (org-agenda-change-time-span 'day day-of-month))
  7782. (defun org-agenda-week-view (&optional iso-week)
  7783. "Switch to weekly view for agenda.
  7784. With argument ISO-WEEK, switch to the corresponding ISO week.
  7785. If ISO-WEEK has more then 2 digits, only the last two encode
  7786. the week. Any digits before this encode a year. So 200712
  7787. means week 12 of year 2007. Years ranging from 70 years ago
  7788. to 30 years in the future can also be written as 2-digit years."
  7789. (interactive "P")
  7790. (org-agenda-change-time-span 'week iso-week))
  7791. (defun org-agenda-fortnight-view (&optional iso-week)
  7792. "Switch to fortnightly view for agenda.
  7793. With argument ISO-WEEK, switch to the corresponding ISO week.
  7794. If ISO-WEEK has more then 2 digits, only the last two encode
  7795. the week. Any digits before this encode a year. So 200712
  7796. means week 12 of year 2007. Years ranging from 70 years ago
  7797. to 30 years in the future can also be written as 2-digit years."
  7798. (interactive "P")
  7799. (org-agenda-change-time-span 'fortnight iso-week))
  7800. (defun org-agenda-month-view (&optional month)
  7801. "Switch to monthly view for agenda.
  7802. With argument MONTH, switch to that month. If MONTH has more
  7803. then 2 digits, only the last two encode the month. Any digits
  7804. before this encode a year. So 200712 means December year 2007.
  7805. Years ranging from 70 years ago to 30 years in the future can
  7806. also be written as 2-digit years."
  7807. (interactive "P")
  7808. (org-agenda-change-time-span 'month month))
  7809. (defun org-agenda-year-view (&optional year)
  7810. "Switch to yearly view for agenda.
  7811. With argument YEAR, switch to that year. Years ranging from 70
  7812. years ago to 30 years in the future can also be written as
  7813. 2-digit years."
  7814. (interactive "P")
  7815. (when year
  7816. (setq year (org-small-year-to-year year)))
  7817. (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
  7818. (org-agenda-change-time-span 'year year)
  7819. (error "Abort")))
  7820. (defun org-agenda-change-time-span (span &optional n)
  7821. "Change the agenda view to SPAN.
  7822. SPAN may be `day', `week', `fortnight', `month', `year'."
  7823. (org-agenda-check-type t 'agenda)
  7824. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7825. (curspan (nth 2 args)))
  7826. (when (and (not n) (equal curspan span))
  7827. (error "Viewing span is already \"%s\"" span))
  7828. (let* ((sd (or (org-get-at-bol 'day)
  7829. (nth 1 args)
  7830. org-starting-day))
  7831. (sd (org-agenda-compute-starting-span sd span n))
  7832. (org-agenda-overriding-cmd
  7833. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7834. (org-agenda-overriding-arguments
  7835. (list (car args) sd span)))
  7836. (org-agenda-redo)
  7837. (org-agenda-find-same-or-today-or-agenda))
  7838. (org-agenda-set-mode-name)
  7839. (message "Switched to %s view" span)))
  7840. (defun org-agenda-compute-starting-span (sd span &optional n)
  7841. "Compute starting date for agenda.
  7842. SPAN may be `day', `week', `fortnight', `month', `year'. The return value
  7843. is a cons cell with the starting date and the number of days,
  7844. so that the date SD will be in that range."
  7845. (let* ((greg (calendar-gregorian-from-absolute sd))
  7846. (dg (nth 1 greg))
  7847. (mg (car greg))
  7848. (yg (nth 2 greg)))
  7849. (cond
  7850. ((eq span 'day)
  7851. (when n
  7852. (setq sd (+ (calendar-absolute-from-gregorian
  7853. (list mg 1 yg))
  7854. n -1))))
  7855. ((or (eq span 'week) (eq span 'fortnight))
  7856. (let* ((nt (calendar-day-of-week
  7857. (calendar-gregorian-from-absolute sd)))
  7858. (d (if org-agenda-start-on-weekday
  7859. (- nt org-agenda-start-on-weekday)
  7860. 0))
  7861. y1)
  7862. (setq sd (- sd (+ (if (< d 0) 7 0) d)))
  7863. (when n
  7864. (require 'cal-iso)
  7865. (when (> n 99)
  7866. (setq y1 (org-small-year-to-year (/ n 100))
  7867. n (mod n 100)))
  7868. (setq sd
  7869. (calendar-iso-to-absolute
  7870. (list n 1
  7871. (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
  7872. ((eq span 'month)
  7873. (let (y1)
  7874. (when (and n (> n 99))
  7875. (setq y1 (org-small-year-to-year (/ n 100))
  7876. n (mod n 100)))
  7877. (setq sd (calendar-absolute-from-gregorian
  7878. (list (or n mg) 1 (or y1 yg))))))
  7879. ((eq span 'year)
  7880. (setq sd (calendar-absolute-from-gregorian
  7881. (list 1 1 (or n yg))))))
  7882. sd))
  7883. (defun org-agenda-next-date-line (&optional arg)
  7884. "Jump to the next line indicating a date in agenda buffer."
  7885. (interactive "p")
  7886. (org-agenda-check-type t 'agenda)
  7887. (beginning-of-line 1)
  7888. ;; This does not work if user makes date format that starts with a blank
  7889. (when (looking-at-p "^\\S-") (forward-char 1))
  7890. (unless (re-search-forward "^\\S-" nil t arg)
  7891. (backward-char 1)
  7892. (error "No next date after this line in this buffer"))
  7893. (goto-char (match-beginning 0)))
  7894. (defun org-agenda-previous-date-line (&optional arg)
  7895. "Jump to the previous line indicating a date in agenda buffer."
  7896. (interactive "p")
  7897. (org-agenda-check-type t 'agenda)
  7898. (beginning-of-line 1)
  7899. (unless (re-search-backward "^\\S-" nil t arg)
  7900. (error "No previous date before this line in this buffer")))
  7901. ;; Initialize the highlight
  7902. (defvar org-hl (make-overlay 1 1))
  7903. (overlay-put org-hl 'face 'highlight)
  7904. (defun org-highlight (begin end &optional buffer)
  7905. "Highlight a region with overlay."
  7906. (move-overlay org-hl begin end (or buffer (current-buffer))))
  7907. (defun org-unhighlight ()
  7908. "Detach overlay INDEX."
  7909. (delete-overlay org-hl))
  7910. (defun org-unhighlight-once ()
  7911. "Remove the highlight from its position, and this function from the hook."
  7912. (remove-hook 'pre-command-hook 'org-unhighlight-once)
  7913. (org-unhighlight))
  7914. (defvar org-agenda-pre-follow-window-conf nil)
  7915. (defun org-agenda-follow-mode ()
  7916. "Toggle follow mode in an agenda buffer."
  7917. (interactive)
  7918. (unless org-agenda-follow-mode
  7919. (setq org-agenda-pre-follow-window-conf
  7920. (current-window-configuration)))
  7921. (setq org-agenda-follow-mode (not org-agenda-follow-mode))
  7922. (unless org-agenda-follow-mode
  7923. (set-window-configuration org-agenda-pre-follow-window-conf))
  7924. (org-agenda-set-mode-name)
  7925. (org-agenda-do-context-action)
  7926. (message "Follow mode is %s"
  7927. (if org-agenda-follow-mode "on" "off")))
  7928. (defun org-agenda-entry-text-mode (&optional arg)
  7929. "Toggle entry text mode in an agenda buffer."
  7930. (interactive "P")
  7931. (if (or org-agenda-tag-filter
  7932. org-agenda-category-filter
  7933. org-agenda-regexp-filter
  7934. org-agenda-top-headline-filter)
  7935. (user-error "Can't show entry text in filtered views")
  7936. (setq org-agenda-entry-text-mode (or (integerp arg)
  7937. (not org-agenda-entry-text-mode)))
  7938. (org-agenda-entry-text-hide)
  7939. (and org-agenda-entry-text-mode
  7940. (let ((org-agenda-entry-text-maxlines
  7941. (if (integerp arg) arg org-agenda-entry-text-maxlines)))
  7942. (org-agenda-entry-text-show)))
  7943. (org-agenda-set-mode-name)
  7944. (message "Entry text mode is %s%s"
  7945. (if org-agenda-entry-text-mode "on" "off")
  7946. (if (not org-agenda-entry-text-mode) ""
  7947. (format " (maximum number of lines is %d)"
  7948. (if (integerp arg) arg org-agenda-entry-text-maxlines))))))
  7949. (defun org-agenda-clockreport-mode ()
  7950. "Toggle clocktable mode in an agenda buffer."
  7951. (interactive)
  7952. (org-agenda-check-type t 'agenda)
  7953. (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode))
  7954. (org-agenda-set-mode-name)
  7955. (org-agenda-redo)
  7956. (message "Clocktable mode is %s"
  7957. (if org-agenda-clockreport-mode "on" "off")))
  7958. (defun org-agenda-log-mode (&optional special)
  7959. "Toggle log mode in an agenda buffer.
  7960. With argument SPECIAL, show all possible log items, not only the ones
  7961. configured in `org-agenda-log-mode-items'.
  7962. With a `\\[universal-argument] \\[universal-argument]' prefix, show *only* \
  7963. log items, nothing else."
  7964. (interactive "P")
  7965. (org-agenda-check-type t 'agenda)
  7966. (setq org-agenda-show-log
  7967. (cond
  7968. ((equal special '(16)) 'only)
  7969. ((eq special 'clockcheck)
  7970. (if (eq org-agenda-show-log 'clockcheck)
  7971. nil 'clockcheck))
  7972. (special '(closed clock state))
  7973. (t (not org-agenda-show-log))))
  7974. (org-agenda-set-mode-name)
  7975. (org-agenda-redo)
  7976. (message "Log mode is %s" (if org-agenda-show-log "on" "off")))
  7977. (defun org-agenda-archives-mode (&optional with-files)
  7978. "Toggle inclusion of items in trees marked with :ARCHIVE:.
  7979. When called with a prefix argument, include all archive files as well."
  7980. (interactive "P")
  7981. (setq org-agenda-archives-mode
  7982. (if with-files t (if org-agenda-archives-mode nil 'trees)))
  7983. (org-agenda-set-mode-name)
  7984. (org-agenda-redo)
  7985. (message
  7986. "%s"
  7987. (cond
  7988. ((eq org-agenda-archives-mode nil)
  7989. "No archives are included")
  7990. ((eq org-agenda-archives-mode 'trees)
  7991. (format "Trees with :%s: tag are included" org-archive-tag))
  7992. ((eq org-agenda-archives-mode t)
  7993. (format "Trees with :%s: tag and all active archive files are included"
  7994. org-archive-tag)))))
  7995. (defun org-agenda-toggle-diary ()
  7996. "Toggle diary inclusion in an agenda buffer."
  7997. (interactive)
  7998. (org-agenda-check-type t 'agenda)
  7999. (setq org-agenda-include-diary (not org-agenda-include-diary))
  8000. (org-agenda-redo)
  8001. (org-agenda-set-mode-name)
  8002. (message "Diary inclusion turned %s"
  8003. (if org-agenda-include-diary "on" "off")))
  8004. (defun org-agenda-toggle-deadlines ()
  8005. "Toggle inclusion of entries with a deadline in an agenda buffer."
  8006. (interactive)
  8007. (org-agenda-check-type t 'agenda)
  8008. (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
  8009. (org-agenda-redo)
  8010. (org-agenda-set-mode-name)
  8011. (message "Deadlines inclusion turned %s"
  8012. (if org-agenda-include-deadlines "on" "off")))
  8013. (defun org-agenda-toggle-time-grid ()
  8014. "Toggle time grid in an agenda buffer."
  8015. (interactive)
  8016. (org-agenda-check-type t 'agenda)
  8017. (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
  8018. (org-agenda-redo)
  8019. (org-agenda-set-mode-name)
  8020. (message "Time-grid turned %s"
  8021. (if org-agenda-use-time-grid "on" "off")))
  8022. (defun org-agenda-set-mode-name ()
  8023. "Set the mode name to indicate all the small mode settings."
  8024. (setq mode-name
  8025. (list "Org-Agenda"
  8026. (if (get 'org-agenda-files 'org-restrict) " []" "")
  8027. " "
  8028. '(:eval (org-agenda-span-name org-agenda-current-span))
  8029. (if org-agenda-follow-mode " Follow" "")
  8030. (if org-agenda-entry-text-mode " ETxt" "")
  8031. (if org-agenda-include-diary " Diary" "")
  8032. (if org-agenda-include-deadlines " Ddl" "")
  8033. (if org-agenda-use-time-grid " Grid" "")
  8034. (if (and (boundp 'org-habit-show-habits)
  8035. org-habit-show-habits) " Habit" "")
  8036. (cond
  8037. ((consp org-agenda-show-log) " LogAll")
  8038. ((eq org-agenda-show-log 'clockcheck) " ClkCk")
  8039. (org-agenda-show-log " Log")
  8040. (t ""))
  8041. (if (org-agenda-filter-any) " " "")
  8042. (if (or org-agenda-category-filter
  8043. (get 'org-agenda-category-filter :preset-filter))
  8044. '(:eval (propertize
  8045. (concat "["
  8046. (mapconcat
  8047. 'identity
  8048. (append
  8049. (get 'org-agenda-category-filter :preset-filter)
  8050. org-agenda-category-filter)
  8051. "")
  8052. "]")
  8053. 'face 'org-agenda-filter-category
  8054. 'help-echo "Category used in filtering")) "")
  8055. (if (or org-agenda-tag-filter
  8056. (get 'org-agenda-tag-filter :preset-filter))
  8057. '(:eval (propertize
  8058. (concat (mapconcat
  8059. 'identity
  8060. (append
  8061. (get 'org-agenda-tag-filter :preset-filter)
  8062. org-agenda-tag-filter)
  8063. ""))
  8064. 'face 'org-agenda-filter-tags
  8065. 'help-echo "Tags used in filtering")) "")
  8066. (if (or org-agenda-effort-filter
  8067. (get 'org-agenda-effort-filter :preset-filter))
  8068. '(:eval (propertize
  8069. (concat (mapconcat
  8070. 'identity
  8071. (append
  8072. (get 'org-agenda-effort-filter :preset-filter)
  8073. org-agenda-effort-filter)
  8074. ""))
  8075. 'face 'org-agenda-filter-effort
  8076. 'help-echo "Effort conditions used in filtering")) "")
  8077. (if (or org-agenda-regexp-filter
  8078. (get 'org-agenda-regexp-filter :preset-filter))
  8079. '(:eval (propertize
  8080. (concat (mapconcat
  8081. (lambda (x) (concat (substring x 0 1) "/" (substring x 1) "/"))
  8082. (append
  8083. (get 'org-agenda-regexp-filter :preset-filter)
  8084. org-agenda-regexp-filter)
  8085. ""))
  8086. 'face 'org-agenda-filter-regexp
  8087. 'help-echo "Regexp used in filtering")) "")
  8088. (if org-agenda-archives-mode
  8089. (if (eq org-agenda-archives-mode t)
  8090. " Archives"
  8091. (format " :%s:" org-archive-tag))
  8092. "")
  8093. (if org-agenda-clockreport-mode " Clock" "")))
  8094. (force-mode-line-update))
  8095. (defun org-agenda-update-agenda-type ()
  8096. "Update the agenda type after each command."
  8097. (setq org-agenda-type
  8098. (or (get-text-property (point) 'org-agenda-type)
  8099. (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
  8100. (defun org-agenda-next-line ()
  8101. "Move cursor to the next line, and show if follow mode is active."
  8102. (interactive)
  8103. (call-interactively 'next-line)
  8104. (org-agenda-do-context-action))
  8105. (defun org-agenda-previous-line ()
  8106. "Move cursor to the previous line, and show if follow-mode is active."
  8107. (interactive)
  8108. (call-interactively 'previous-line)
  8109. (org-agenda-do-context-action))
  8110. (defun org-agenda-next-item (n)
  8111. "Move cursor to next agenda item."
  8112. (interactive "p")
  8113. (let ((col (current-column)))
  8114. (dotimes (c n)
  8115. (when (next-single-property-change (point-at-eol) 'org-marker)
  8116. (move-end-of-line 1)
  8117. (goto-char (next-single-property-change (point) 'org-marker))))
  8118. (org-move-to-column col))
  8119. (org-agenda-do-context-action))
  8120. (defun org-agenda-previous-item (n)
  8121. "Move cursor to next agenda item."
  8122. (interactive "p")
  8123. (dotimes (c n)
  8124. (let ((col (current-column))
  8125. (goto (save-excursion
  8126. (move-end-of-line 0)
  8127. (previous-single-property-change (point) 'org-marker))))
  8128. (when goto (goto-char goto))
  8129. (org-move-to-column col)))
  8130. (org-agenda-do-context-action))
  8131. (defun org-agenda-do-context-action ()
  8132. "Show outline path and, maybe, follow mode window."
  8133. (let ((m (org-get-at-bol 'org-marker)))
  8134. (when (and (markerp m) (marker-buffer m))
  8135. (and org-agenda-follow-mode
  8136. (if org-agenda-follow-indirect
  8137. (org-agenda-tree-to-indirect-buffer nil)
  8138. (org-agenda-show)))
  8139. (and org-agenda-show-outline-path
  8140. (org-with-point-at m (org-display-outline-path t))))))
  8141. (defun org-agenda-show-tags ()
  8142. "Show the tags applicable to the current item."
  8143. (interactive)
  8144. (let* ((tags (org-get-at-bol 'tags)))
  8145. (if tags
  8146. (message "Tags are :%s:"
  8147. (org-no-properties (mapconcat 'identity tags ":")))
  8148. (message "No tags associated with this line"))))
  8149. (defun org-agenda-goto (&optional highlight)
  8150. "Go to the entry at point in the corresponding Org file."
  8151. (interactive)
  8152. (let* ((marker (or (org-get-at-bol 'org-marker)
  8153. (org-agenda-error)))
  8154. (buffer (marker-buffer marker))
  8155. (pos (marker-position marker)))
  8156. (switch-to-buffer-other-window buffer)
  8157. (widen)
  8158. (push-mark)
  8159. (goto-char pos)
  8160. (when (derived-mode-p 'org-mode)
  8161. (org-show-context 'agenda)
  8162. (recenter (/ (window-height) 2))
  8163. (org-back-to-heading t)
  8164. (let ((case-fold-search nil))
  8165. (when (re-search-forward org-complex-heading-regexp nil t)
  8166. (goto-char (match-beginning 4)))))
  8167. (run-hooks 'org-agenda-after-show-hook)
  8168. (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
  8169. (defvar org-agenda-after-show-hook nil
  8170. "Normal hook run after an item has been shown from the agenda.
  8171. Point is in the buffer where the item originated.")
  8172. (defun org-agenda-kill ()
  8173. "Kill the entry or subtree belonging to the current agenda entry."
  8174. (interactive)
  8175. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  8176. (let* ((bufname-orig (buffer-name))
  8177. (marker (or (org-get-at-bol 'org-marker)
  8178. (org-agenda-error)))
  8179. (buffer (marker-buffer marker))
  8180. (pos (marker-position marker))
  8181. (type (org-get-at-bol 'type))
  8182. dbeg dend (n 0))
  8183. (org-with-remote-undo buffer
  8184. (with-current-buffer buffer
  8185. (save-excursion
  8186. (goto-char pos)
  8187. (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
  8188. (setq dbeg (progn (org-back-to-heading t) (point))
  8189. dend (org-end-of-subtree t t))
  8190. (setq dbeg (point-at-bol)
  8191. dend (min (point-max) (1+ (point-at-eol)))))
  8192. (goto-char dbeg)
  8193. (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
  8194. (when (or (eq t org-agenda-confirm-kill)
  8195. (and (numberp org-agenda-confirm-kill)
  8196. (> n org-agenda-confirm-kill)))
  8197. (let ((win-conf (current-window-configuration)))
  8198. (unwind-protect
  8199. (and
  8200. (prog2
  8201. (org-agenda-tree-to-indirect-buffer nil)
  8202. (not (y-or-n-p
  8203. (format "Delete entry with %d lines in buffer \"%s\"? "
  8204. n (buffer-name buffer))))
  8205. (kill-buffer org-last-indirect-buffer))
  8206. (error "Abort"))
  8207. (set-window-configuration win-conf))))
  8208. (let ((org-agenda-buffer-name bufname-orig))
  8209. (org-remove-subtree-entries-from-agenda buffer dbeg dend))
  8210. (with-current-buffer buffer (delete-region dbeg dend))
  8211. (message "Agenda item and source killed"))))
  8212. (defvar org-archive-default-command) ; defined in org-archive.el
  8213. (defun org-agenda-archive-default ()
  8214. "Archive the entry or subtree belonging to the current agenda entry."
  8215. (interactive)
  8216. (require 'org-archive)
  8217. (org-agenda-archive-with org-archive-default-command))
  8218. (defun org-agenda-archive-default-with-confirmation ()
  8219. "Archive the entry or subtree belonging to the current agenda entry."
  8220. (interactive)
  8221. (require 'org-archive)
  8222. (org-agenda-archive-with org-archive-default-command 'confirm))
  8223. (defun org-agenda-archive ()
  8224. "Archive the entry or subtree belonging to the current agenda entry."
  8225. (interactive)
  8226. (org-agenda-archive-with 'org-archive-subtree))
  8227. (defun org-agenda-archive-to-archive-sibling ()
  8228. "Move the entry to the archive sibling."
  8229. (interactive)
  8230. (org-agenda-archive-with 'org-archive-to-archive-sibling))
  8231. (defun org-agenda-archive-with (cmd &optional confirm)
  8232. "Move the entry to the archive sibling."
  8233. (interactive)
  8234. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  8235. (let* ((bufname-orig (buffer-name))
  8236. (marker (or (org-get-at-bol 'org-marker)
  8237. (org-agenda-error)))
  8238. (buffer (marker-buffer marker))
  8239. (pos (marker-position marker)))
  8240. (org-with-remote-undo buffer
  8241. (with-current-buffer buffer
  8242. (if (derived-mode-p 'org-mode)
  8243. (if (and confirm
  8244. (not (y-or-n-p "Archive this subtree or entry? ")))
  8245. (error "Abort")
  8246. (save-window-excursion
  8247. (goto-char pos)
  8248. (let ((org-agenda-buffer-name bufname-orig))
  8249. (org-remove-subtree-entries-from-agenda))
  8250. (org-back-to-heading t)
  8251. (funcall cmd)))
  8252. (error "Archiving works only in Org files"))))))
  8253. (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
  8254. "Remove all lines in the agenda that correspond to a given subtree.
  8255. The subtree is the one in buffer BUF, starting at BEG and ending at END.
  8256. If this information is not given, the function uses the tree at point."
  8257. (let ((buf (or buf (current-buffer))) m p)
  8258. (save-excursion
  8259. (unless (and beg end)
  8260. (org-back-to-heading t)
  8261. (setq beg (point))
  8262. (org-end-of-subtree t)
  8263. (setq end (point)))
  8264. (set-buffer (get-buffer org-agenda-buffer-name))
  8265. (save-excursion
  8266. (goto-char (point-max))
  8267. (beginning-of-line 1)
  8268. (while (not (bobp))
  8269. (when (and (setq m (org-get-at-bol 'org-marker))
  8270. (equal buf (marker-buffer m))
  8271. (setq p (marker-position m))
  8272. (>= p beg)
  8273. (< p end))
  8274. (let ((inhibit-read-only t))
  8275. (delete-region (point-at-bol) (1+ (point-at-eol)))))
  8276. (beginning-of-line 0))))))
  8277. (defun org-agenda-refile (&optional goto rfloc no-update)
  8278. "Refile the item at point.
  8279. When called with `\\[universal-argument] \\[universal-argument]', \
  8280. go to the location of the last
  8281. refiled item.
  8282. When called with `\\[universal-argument] \\[universal-argument] \
  8283. \\[universal-argument]' prefix or when GOTO is 0, clear
  8284. the refile cache.
  8285. RFLOC can be a refile location obtained in a different way.
  8286. When NO-UPDATE is non-nil, don't redo the agenda buffer."
  8287. (interactive "P")
  8288. (cond
  8289. ((member goto '(0 (64)))
  8290. (org-refile-cache-clear))
  8291. ((equal goto '(16))
  8292. (org-refile-goto-last-stored))
  8293. (t
  8294. (let* ((buffer-orig (buffer-name))
  8295. (marker (or (org-get-at-bol 'org-hd-marker)
  8296. (org-agenda-error)))
  8297. (buffer (marker-buffer marker))
  8298. (pos (marker-position marker))
  8299. (rfloc (or rfloc
  8300. (org-refile-get-location
  8301. (if goto "Goto" "Refile to") buffer
  8302. org-refile-allow-creating-parent-nodes))))
  8303. (with-current-buffer buffer
  8304. (org-with-wide-buffer
  8305. (goto-char marker)
  8306. (let ((org-agenda-buffer-name buffer-orig))
  8307. (org-remove-subtree-entries-from-agenda))
  8308. (org-refile goto buffer rfloc))))
  8309. (unless no-update (org-agenda-redo)))))
  8310. (defun org-agenda-open-link (&optional arg)
  8311. "Open the link(s) in the current entry, if any.
  8312. This looks for a link in the displayed line in the agenda.
  8313. It also looks at the text of the entry itself."
  8314. (interactive "P")
  8315. (let* ((marker (or (org-get-at-bol 'org-hd-marker)
  8316. (org-get-at-bol 'org-marker)))
  8317. (buffer (and marker (marker-buffer marker)))
  8318. (prefix (buffer-substring (point-at-bol) (point-at-eol)))
  8319. (lkall (and buffer (org-offer-links-in-entry
  8320. buffer marker arg prefix)))
  8321. (lk0 (car lkall))
  8322. (lk (if (stringp lk0) (list lk0) lk0))
  8323. (lkend (cdr lkall))
  8324. trg)
  8325. (cond
  8326. ((and buffer lk)
  8327. (mapcar (lambda(l)
  8328. (with-current-buffer buffer
  8329. (setq trg (and (string-match org-link-bracket-re l)
  8330. (match-string 1 l)))
  8331. (if (or (not trg) (string-match org-link-any-re trg))
  8332. ;; Don't use `org-with-wide-buffer' here as
  8333. ;; opening the link may result in moving the point
  8334. (save-restriction
  8335. (widen)
  8336. (goto-char marker)
  8337. (when (search-forward l nil lkend)
  8338. (goto-char (match-beginning 0))
  8339. (org-open-at-point)))
  8340. ;; This is an internal link, widen the buffer
  8341. (switch-to-buffer-other-window buffer)
  8342. (widen)
  8343. (goto-char marker)
  8344. (when (search-forward l nil lkend)
  8345. (goto-char (match-beginning 0))
  8346. (org-open-at-point)))))
  8347. lk))
  8348. ((or (org-in-regexp (concat "\\(" org-link-bracket-re "\\)"))
  8349. (save-excursion
  8350. (beginning-of-line 1)
  8351. (looking-at (concat ".*?\\(" org-link-bracket-re "\\)"))))
  8352. (org-link-open-from-string (match-string 1)))
  8353. (t (message "No link to open here")))))
  8354. (defun org-agenda-copy-local-variable (var)
  8355. "Get a variable from a referenced buffer and install it here."
  8356. (let ((m (org-get-at-bol 'org-marker)))
  8357. (when (and m (buffer-live-p (marker-buffer m)))
  8358. (set (make-local-variable var)
  8359. (with-current-buffer (marker-buffer m)
  8360. (symbol-value var))))))
  8361. (defun org-agenda-switch-to (&optional delete-other-windows)
  8362. "Go to the Org mode file which contains the item at point.
  8363. When optional argument DELETE-OTHER-WINDOWS is non-nil, the
  8364. displayed Org file fills the frame."
  8365. (interactive)
  8366. (if (and org-return-follows-link
  8367. (not (org-get-at-bol 'org-marker))
  8368. (org-in-regexp org-link-bracket-re))
  8369. (org-link-open-from-string (match-string 0))
  8370. (let* ((marker (or (org-get-at-bol 'org-marker)
  8371. (org-agenda-error)))
  8372. (buffer (marker-buffer marker))
  8373. (pos (marker-position marker)))
  8374. (unless buffer (user-error "Trying to switch to non-existent buffer"))
  8375. (pop-to-buffer-same-window buffer)
  8376. (when delete-other-windows (delete-other-windows))
  8377. (widen)
  8378. (goto-char pos)
  8379. (when (derived-mode-p 'org-mode)
  8380. (org-show-context 'agenda)
  8381. (run-hooks 'org-agenda-after-show-hook)))))
  8382. (defun org-agenda-goto-mouse (ev)
  8383. "Go to the Org file which contains the item at the mouse click."
  8384. (interactive "e")
  8385. (mouse-set-point ev)
  8386. (org-agenda-goto))
  8387. (defun org-agenda-show (&optional full-entry)
  8388. "Display the Org file which contains the item at point.
  8389. With prefix argument FULL-ENTRY, make the entire entry visible
  8390. if it was hidden in the outline."
  8391. (interactive "P")
  8392. (let ((win (selected-window)))
  8393. (org-agenda-goto t)
  8394. (when full-entry (org-show-entry))
  8395. (select-window win)))
  8396. (defvar org-agenda-show-window nil)
  8397. (defun org-agenda-show-and-scroll-up (&optional arg)
  8398. "Display the Org file which contains the item at point.
  8399. When called repeatedly, scroll the window that is displaying the buffer.
  8400. With a `\\[universal-argument]' prefix argument, display the item, but \
  8401. fold drawers."
  8402. (interactive "P")
  8403. (let ((win (selected-window)))
  8404. (if (and (window-live-p org-agenda-show-window)
  8405. (eq this-command last-command))
  8406. (progn
  8407. (select-window org-agenda-show-window)
  8408. (ignore-errors (scroll-up)))
  8409. (org-agenda-goto t)
  8410. (org-show-entry)
  8411. (if arg (org-cycle-hide-drawers 'children)
  8412. (org-with-wide-buffer
  8413. (narrow-to-region (org-entry-beginning-position)
  8414. (org-entry-end-position))
  8415. (org-show-all '(drawers))))
  8416. (setq org-agenda-show-window (selected-window)))
  8417. (select-window win)))
  8418. (defun org-agenda-show-scroll-down ()
  8419. "Scroll down the window showing the agenda."
  8420. (interactive)
  8421. (let ((win (selected-window)))
  8422. (when (window-live-p org-agenda-show-window)
  8423. (select-window org-agenda-show-window)
  8424. (ignore-errors (scroll-down))
  8425. (select-window win))))
  8426. (defun org-agenda-show-1 (&optional more)
  8427. "Display the Org file which contains the item at point.
  8428. The prefix arg selects the amount of information to display:
  8429. 0 hide the subtree
  8430. 1 just show the entry according to defaults.
  8431. 2 show the children view
  8432. 3 show the subtree view
  8433. 4 show the entire subtree and any LOGBOOK drawers
  8434. 5 show the entire subtree and any drawers
  8435. With prefix argument FULL-ENTRY, make the entire entry visible
  8436. if it was hidden in the outline."
  8437. (interactive "p")
  8438. (let ((win (selected-window)))
  8439. (org-agenda-goto t)
  8440. (org-back-to-heading)
  8441. (set-window-start (selected-window) (point-at-bol))
  8442. (cond
  8443. ((= more 0)