org-agenda.el 391 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154
  1. ;;; org-agenda.el --- Dynamic task and appointment lists for Org
  2. ;; Copyright (C) 2004-2017 Free Software Foundation, Inc.
  3. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; Homepage: http://orgmode.org
  6. ;;
  7. ;; This file is part of GNU Emacs.
  8. ;;
  9. ;; GNU Emacs is free software: you can redistribute it and/or modify
  10. ;; it under the terms of the GNU General Public License as published by
  11. ;; the Free Software Foundation, either version 3 of the License, or
  12. ;; (at your option) any later version.
  13. ;; GNU Emacs is distributed in the hope that it will be useful,
  14. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. ;; GNU General Public License for more details.
  17. ;; You should have received a copy of the GNU General Public License
  18. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  19. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  20. ;;
  21. ;;; Commentary:
  22. ;; This file contains the code for creating and using the Agenda for Org.
  23. ;;
  24. ;; The functions `org-batch-agenda', `org-batch-agenda-csv', and
  25. ;; `org-batch-store-agenda-views' are implemented as macros to provide
  26. ;; a convenient way for extracting agenda information from the command
  27. ;; line. The Lisp does not evaluate parameters of a macro call; thus
  28. ;; it is not necessary to quote the parameters passed to one of those
  29. ;; functions. E.g. you can write:
  30. ;;
  31. ;; emacs -batch -l ~/.emacs -eval '(org-batch-agenda "a" org-agenda-span 7)'
  32. ;;
  33. ;; To export an agenda spanning 7 days. If `org-batch-agenda' would
  34. ;; have been implemented as a regular function you'd have to quote the
  35. ;; symbol org-agenda-span. Moreover: To use a symbol as parameter
  36. ;; value you would have to double quote the symbol.
  37. ;;
  38. ;; This is a hack, but it works even when running Org byte-compiled.
  39. ;;
  40. ;;; Code:
  41. (require 'cl-lib)
  42. (require 'org)
  43. (require 'org-macs)
  44. (declare-function diary-add-to-list "diary-lib"
  45. (date string specifier &optional marker globcolor literal))
  46. (declare-function calendar-iso-to-absolute "cal-iso" (date))
  47. (declare-function calendar-astro-date-string "cal-julian" (&optional date))
  48. (declare-function calendar-bahai-date-string "cal-bahai" (&optional date))
  49. (declare-function calendar-chinese-date-string "cal-china" (&optional date))
  50. (declare-function calendar-coptic-date-string "cal-coptic" (&optional date))
  51. (declare-function calendar-ethiopic-date-string "cal-coptic" (&optional date))
  52. (declare-function calendar-french-date-string "cal-french" (&optional date))
  53. (declare-function calendar-goto-date "cal-move" (date))
  54. (declare-function calendar-hebrew-date-string "cal-hebrew" (&optional date))
  55. (declare-function calendar-islamic-date-string "cal-islam" (&optional date))
  56. (declare-function calendar-iso-date-string "cal-iso" (&optional date))
  57. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  58. (declare-function calendar-julian-date-string "cal-julian" (&optional date))
  59. (declare-function calendar-mayan-date-string "cal-mayan" (&optional date))
  60. (declare-function calendar-persian-date-string "cal-persia" (&optional date))
  61. (declare-function calendar-check-holidays "holidays" (date))
  62. (declare-function org-columns-remove-overlays "org-colview" ())
  63. (declare-function org-datetree-find-date-create "org-datetree"
  64. (date &optional keep-restriction))
  65. (declare-function org-columns-quit "org-colview" ())
  66. (declare-function diary-date-display-form "diary-lib" (&optional type))
  67. (declare-function org-mobile-write-agenda-for-mobile "org-mobile" (file))
  68. (declare-function org-habit-insert-consistency-graphs
  69. "org-habit" (&optional line))
  70. (declare-function org-is-habit-p "org-habit" (&optional pom))
  71. (declare-function org-habit-parse-todo "org-habit" (&optional pom))
  72. (declare-function org-habit-get-priority "org-habit" (habit &optional moment))
  73. (declare-function org-agenda-columns "org-colview" ())
  74. (declare-function org-add-archive-files "org-archive" (files))
  75. (declare-function org-capture "org-capture" (&optional goto keys))
  76. (defvar calendar-mode-map)
  77. (defvar org-clock-current-task)
  78. (defvar org-current-tag-alist)
  79. (defvar org-mobile-force-id-on-agenda-items)
  80. (defvar org-habit-show-habits)
  81. (defvar org-habit-show-habits-only-for-today)
  82. (defvar org-habit-show-all-today)
  83. ;; Defined somewhere in this file, but used before definition.
  84. (defvar org-agenda-buffer-name "*Org Agenda*")
  85. (defvar org-agenda-overriding-header nil)
  86. (defvar org-agenda-title-append nil)
  87. (with-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  88. (with-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  89. (defvar original-date) ; dynamically scoped, calendar.el does scope this
  90. (defvar org-agenda-undo-list nil
  91. "List of undoable operations in the agenda since last refresh.")
  92. (defvar org-agenda-pending-undo-list nil
  93. "In a series of undo commands, this is the list of remaining undo items.")
  94. (defcustom org-agenda-confirm-kill 1
  95. "When set, remote killing from the agenda buffer needs confirmation.
  96. When t, a confirmation is always needed. When a number N, confirmation is
  97. only needed when the text to be killed contains more than N non-white lines."
  98. :group 'org-agenda
  99. :type '(choice
  100. (const :tag "Never" nil)
  101. (const :tag "Always" t)
  102. (integer :tag "When more than N lines")))
  103. (defcustom org-agenda-compact-blocks nil
  104. "Non-nil means make the block agenda more compact.
  105. This is done globally by leaving out lines like the agenda span
  106. name and week number or the separator lines."
  107. :group 'org-agenda
  108. :type 'boolean)
  109. (defcustom org-agenda-block-separator ?=
  110. "The separator between blocks in the agenda.
  111. If this is a string, it will be used as the separator, with a newline added.
  112. If it is a character, it will be repeated to fill the window width.
  113. If nil the separator is disabled. In `org-agenda-custom-commands' this
  114. addresses the separator between the current and the previous block."
  115. :group 'org-agenda
  116. :type '(choice
  117. (const :tag "Disabled" nil)
  118. (character)
  119. (string)))
  120. (defgroup org-agenda-export nil
  121. "Options concerning exporting agenda views in Org mode."
  122. :tag "Org Agenda Export"
  123. :group 'org-agenda)
  124. (defcustom org-agenda-with-colors t
  125. "Non-nil means use colors in agenda views."
  126. :group 'org-agenda-export
  127. :type 'boolean)
  128. (defcustom org-agenda-exporter-settings nil
  129. "Alist of variable/value pairs that should be active during agenda export.
  130. This is a good place to set options for ps-print and for htmlize.
  131. Note that the way this is implemented, the values will be evaluated
  132. before assigned to the variables. So make sure to quote values you do
  133. *not* want evaluated, for example
  134. (setq org-agenda-exporter-settings
  135. \\='((ps-print-color-p \\='black-white)))"
  136. :group 'org-agenda-export
  137. :type '(repeat
  138. (list
  139. (variable)
  140. (sexp :tag "Value"))))
  141. (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
  142. "Hook run in a temporary buffer before writing the agenda to an export file.
  143. A useful function for this hook is `org-agenda-add-entry-text'."
  144. :group 'org-agenda-export
  145. :type 'hook
  146. :options '(org-agenda-add-entry-text))
  147. (defcustom org-agenda-add-entry-text-maxlines 0
  148. "Maximum number of entry text lines to be added to agenda.
  149. This is only relevant when `org-agenda-add-entry-text' is part of
  150. `org-agenda-before-write-hook', which is the default.
  151. When this is 0, nothing will happen. When it is greater than 0, it
  152. specifies the maximum number of lines that will be added for each entry
  153. that is listed in the agenda view.
  154. Note that this variable is not used during display, only when exporting
  155. the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
  156. and `org-agenda-entry-text-maxlines'."
  157. :group 'org-agenda
  158. :type 'integer)
  159. (defcustom org-agenda-add-entry-text-descriptive-links t
  160. "Non-nil means export org-links as descriptive links in agenda added text.
  161. This variable applies to the text added to the agenda when
  162. `org-agenda-add-entry-text-maxlines' is larger than 0.
  163. When this variable nil, the URL will (also) be shown."
  164. :group 'org-agenda
  165. :type 'boolean)
  166. (defcustom org-agenda-export-html-style nil
  167. "The style specification for exported HTML Agenda files.
  168. If this variable contains a string, it will replace the default <style>
  169. section as produced by `htmlize'.
  170. Since there are different ways of setting style information, this variable
  171. needs to contain the full HTML structure to provide a style, including the
  172. surrounding HTML tags. The style specifications should include definitions
  173. the fonts used by the agenda, here is an example:
  174. <style type=\"text/css\">
  175. p { font-weight: normal; color: gray; }
  176. .org-agenda-structure {
  177. font-size: 110%;
  178. color: #003399;
  179. font-weight: 600;
  180. }
  181. .org-todo {
  182. color: #cc6666;
  183. font-weight: bold;
  184. }
  185. .org-agenda-done {
  186. color: #339933;
  187. }
  188. .org-done {
  189. color: #339933;
  190. }
  191. .title { text-align: center; }
  192. .todo, .deadline { color: red; }
  193. .done { color: green; }
  194. </style>
  195. or, if you want to keep the style in a file,
  196. <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
  197. As the value of this option simply gets inserted into the HTML <head> header,
  198. you can \"misuse\" it to also add other text to the header."
  199. :group 'org-agenda-export
  200. :group 'org-export-html
  201. :type '(choice
  202. (const nil)
  203. (string)))
  204. (defcustom org-agenda-persistent-filter nil
  205. "When set, keep filters from one agenda view to the next."
  206. :group 'org-agenda
  207. :type 'boolean)
  208. (defgroup org-agenda-custom-commands nil
  209. "Options concerning agenda views in Org mode."
  210. :tag "Org Agenda Custom Commands"
  211. :group 'org-agenda)
  212. (defconst org-sorting-choice
  213. '(choice
  214. (const time-up) (const time-down)
  215. (const timestamp-up) (const timestamp-down)
  216. (const scheduled-up) (const scheduled-down)
  217. (const deadline-up) (const deadline-down)
  218. (const ts-up) (const ts-down)
  219. (const tsia-up) (const tsia-down)
  220. (const category-keep) (const category-up) (const category-down)
  221. (const tag-down) (const tag-up)
  222. (const priority-up) (const priority-down)
  223. (const todo-state-up) (const todo-state-down)
  224. (const effort-up) (const effort-down)
  225. (const habit-up) (const habit-down)
  226. (const alpha-up) (const alpha-down)
  227. (const user-defined-up) (const user-defined-down))
  228. "Sorting choices.")
  229. ;; Keep custom values for `org-agenda-filter-preset' compatible with
  230. ;; the new variable `org-agenda-tag-filter-preset'.
  231. (defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
  232. (defvaralias 'org-agenda-filter 'org-agenda-tag-filter)
  233. (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
  234. "List of types searched for when creating the daily/weekly agenda.
  235. This variable is a list of symbols that controls the types of
  236. items that appear in the daily/weekly agenda. Allowed symbols in this
  237. list are are
  238. :timestamp List items containing a date stamp or date range matching
  239. the selected date. This includes sexp entries in angular
  240. brackets.
  241. :sexp List entries resulting from plain diary-like sexps.
  242. :deadline List deadline due on that date. When the date is today,
  243. also list any deadlines past due, or due within
  244. `org-deadline-warning-days'. `:deadline' must appear before
  245. `:scheduled' if the setting of
  246. `org-agenda-skip-scheduled-if-deadline-is-shown' is to have
  247. any effect.
  248. :deadline* Same as above, but only include the deadline if it has an
  249. hour specification as [h]h:mm.
  250. :scheduled List all items which are scheduled for the given date.
  251. The diary for *today* also contains items which were
  252. scheduled earlier and are not yet marked DONE.
  253. :scheduled* Same as above, but only include the scheduled item if it
  254. has an hour specification as [h]h:mm.
  255. By default, all four non-starred types are turned on.
  256. When :scheduled* or :deadline* are included, :schedule or :deadline
  257. will be ignored.
  258. Never set this variable globally using `setq', because then it
  259. will apply to all future agenda commands. Instead, bind it with
  260. `let' to scope it dynamically into the agenda-constructing
  261. command. A good way to set it is through options in
  262. `org-agenda-custom-commands'. For a more flexible (though
  263. somewhat less efficient) way of determining what is included in
  264. the daily/weekly agenda, see `org-agenda-skip-function'.")
  265. (defconst org-agenda-custom-commands-local-options
  266. `(repeat :tag "Local settings for this command. Remember to quote values"
  267. (choice :tag "Setting"
  268. (list :tag "Heading for this block"
  269. (const org-agenda-overriding-header)
  270. (string :tag "Headline"))
  271. (list :tag "Files to be searched"
  272. (const org-agenda-files)
  273. (list
  274. (const :format "" quote)
  275. (repeat (file))))
  276. (list :tag "Sorting strategy"
  277. (const org-agenda-sorting-strategy)
  278. (list
  279. (const :format "" quote)
  280. (repeat
  281. ,org-sorting-choice)))
  282. (list :tag "Prefix format"
  283. (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
  284. (string))
  285. (list :tag "Number of days in agenda"
  286. (const org-agenda-span)
  287. (choice (const :tag "Day" day)
  288. (const :tag "Week" week)
  289. (const :tag "Fortnight" fortnight)
  290. (const :tag "Month" month)
  291. (const :tag "Year" year)
  292. (integer :tag "Custom")))
  293. (list :tag "Fixed starting date"
  294. (const org-agenda-start-day)
  295. (string :value "2007-11-01"))
  296. (list :tag "Start on day of week"
  297. (const org-agenda-start-on-weekday)
  298. (choice :value 1
  299. (const :tag "Today" nil)
  300. (integer :tag "Weekday No.")))
  301. (list :tag "Include data from diary"
  302. (const org-agenda-include-diary)
  303. (boolean))
  304. (list :tag "Deadline Warning days"
  305. (const org-deadline-warning-days)
  306. (integer :value 1))
  307. (list :tag "Category filter preset"
  308. (const org-agenda-category-filter-preset)
  309. (list
  310. (const :format "" quote)
  311. (repeat
  312. (string :tag "+category or -category"))))
  313. (list :tag "Tags filter preset"
  314. (const org-agenda-tag-filter-preset)
  315. (list
  316. (const :format "" quote)
  317. (repeat
  318. (string :tag "+tag or -tag"))))
  319. (list :tag "Effort filter preset"
  320. (const org-agenda-effort-filter-preset)
  321. (list
  322. (const :format "" quote)
  323. (repeat
  324. (string :tag "+=10 or -=10 or +<10 or ->10"))))
  325. (list :tag "Regexp filter preset"
  326. (const org-agenda-regexp-filter-preset)
  327. (list
  328. (const :format "" quote)
  329. (repeat
  330. (string :tag "+regexp or -regexp"))))
  331. (list :tag "Set daily/weekly entry types"
  332. (const org-agenda-entry-types)
  333. (list
  334. (const :format "" quote)
  335. (set :greedy t :value ,org-agenda-entry-types
  336. (const :deadline)
  337. (const :scheduled)
  338. (const :deadline*)
  339. (const :scheduled*)
  340. (const :timestamp)
  341. (const :sexp))))
  342. (list :tag "Standard skipping condition"
  343. :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
  344. (const org-agenda-skip-function)
  345. (list
  346. (const :format "" quote)
  347. (list
  348. (choice
  349. :tag "Skipping range"
  350. (const :tag "Skip entry" org-agenda-skip-entry-if)
  351. (const :tag "Skip subtree" org-agenda-skip-subtree-if))
  352. (repeat :inline t :tag "Conditions for skipping"
  353. (choice
  354. :tag "Condition type"
  355. (list :tag "Regexp matches" :inline t
  356. (const :format "" 'regexp)
  357. (regexp))
  358. (list :tag "Regexp does not match" :inline t
  359. (const :format "" 'notregexp)
  360. (regexp))
  361. (list :tag "TODO state is" :inline t
  362. (const 'todo)
  363. (choice
  364. (const :tag "Any not-done state" 'todo)
  365. (const :tag "Any done state" 'done)
  366. (const :tag "Any state" 'any)
  367. (list :tag "Keyword list"
  368. (const :format "" quote)
  369. (repeat (string :tag "Keyword")))))
  370. (list :tag "TODO state is not" :inline t
  371. (const 'nottodo)
  372. (choice
  373. (const :tag "Any not-done state" 'todo)
  374. (const :tag "Any done state" 'done)
  375. (const :tag "Any state" 'any)
  376. (list :tag "Keyword list"
  377. (const :format "" quote)
  378. (repeat (string :tag "Keyword")))))
  379. (const :tag "scheduled" 'scheduled)
  380. (const :tag "not scheduled" 'notscheduled)
  381. (const :tag "deadline" 'deadline)
  382. (const :tag "no deadline" 'notdeadline)
  383. (const :tag "timestamp" 'timestamp)
  384. (const :tag "no timestamp" 'nottimestamp))))))
  385. (list :tag "Non-standard skipping condition"
  386. :value (org-agenda-skip-function)
  387. (const org-agenda-skip-function)
  388. (sexp :tag "Function or form (quoted!)"))
  389. (list :tag "Any variable"
  390. (variable :tag "Variable")
  391. (sexp :tag "Value (sexp)"))))
  392. "Selection of examples for agenda command settings.
  393. This will be spliced into the custom type of
  394. `org-agenda-custom-commands'.")
  395. (defcustom org-agenda-custom-commands
  396. '(("n" "Agenda and all TODOs" ((agenda "") (alltodo ""))))
  397. "Custom commands for the agenda.
  398. \\<org-mode-map>
  399. These commands will be offered on the splash screen displayed by the
  400. agenda dispatcher `\\[org-agenda]'. Each entry is a list like this:
  401. (key desc type match settings files)
  402. key The key (one or more characters as a string) to be associated
  403. with the command.
  404. desc A description of the command, when omitted or nil, a default
  405. description is built using MATCH.
  406. type The command type, any of the following symbols:
  407. agenda The daily/weekly agenda.
  408. todo Entries with a specific TODO keyword, in all agenda files.
  409. search Entries containing search words entry or headline.
  410. tags Tags/Property/TODO match in all agenda files.
  411. tags-todo Tags/P/T match in all agenda files, TODO entries only.
  412. todo-tree Sparse tree of specific TODO keyword in *current* file.
  413. tags-tree Sparse tree with all tags matches in *current* file.
  414. occur-tree Occur sparse tree for *current* file.
  415. ... A user-defined function.
  416. match What to search for:
  417. - a single keyword for TODO keyword searches
  418. - a tags match expression for tags searches
  419. - a word search expression for text searches.
  420. - a regular expression for occur searches
  421. For all other commands, this should be the empty string.
  422. settings A list of option settings, similar to that in a let form, so like
  423. this: ((opt1 val1) (opt2 val2) ...). The values will be
  424. evaluated at the moment of execution, so quote them when needed.
  425. files A list of files to write the produced agenda buffer to with
  426. the command `org-store-agenda-views'.
  427. If a file name ends in \".html\", an HTML version of the buffer
  428. is written out. If it ends in \".ps\", a postscript version is
  429. produced. Otherwise, only the plain text is written to the file.
  430. You can also define a set of commands, to create a composite agenda buffer.
  431. In this case, an entry looks like this:
  432. (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
  433. where
  434. desc A description string to be displayed in the dispatcher menu.
  435. cmd An agenda command, similar to the above. However, tree commands
  436. are not allowed, but instead you can get agenda and global todo list.
  437. So valid commands for a set are:
  438. (agenda \"\" settings)
  439. (alltodo \"\" settings)
  440. (stuck \"\" settings)
  441. (todo \"match\" settings files)
  442. (search \"match\" settings files)
  443. (tags \"match\" settings files)
  444. (tags-todo \"match\" settings files)
  445. Each command can carry a list of options, and another set of options can be
  446. given for the whole set of commands. Individual command options take
  447. precedence over the general options.
  448. When using several characters as key to a command, the first characters
  449. are prefix commands. For the dispatcher to display useful information, you
  450. should provide a description for the prefix, like
  451. (setq org-agenda-custom-commands
  452. \\='((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
  453. (\"hl\" tags \"+HOME+Lisa\")
  454. (\"hp\" tags \"+HOME+Peter\")
  455. (\"hk\" tags \"+HOME+Kim\")))"
  456. :group 'org-agenda-custom-commands
  457. :type `(repeat
  458. (choice :value ("x" "Describe command here" tags "" nil)
  459. (list :tag "Single command"
  460. (string :tag "Access Key(s) ")
  461. (option (string :tag "Description"))
  462. (choice
  463. (const :tag "Agenda" agenda)
  464. (const :tag "TODO list" alltodo)
  465. (const :tag "Search words" search)
  466. (const :tag "Stuck projects" stuck)
  467. (const :tag "Tags/Property match (all agenda files)" tags)
  468. (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
  469. (const :tag "TODO keyword search (all agenda files)" todo)
  470. (const :tag "Tags sparse tree (current buffer)" tags-tree)
  471. (const :tag "TODO keyword tree (current buffer)" todo-tree)
  472. (const :tag "Occur tree (current buffer)" occur-tree)
  473. (sexp :tag "Other, user-defined function"))
  474. (string :tag "Match (only for some commands)")
  475. ,org-agenda-custom-commands-local-options
  476. (option (repeat :tag "Export" (file :tag "Export to"))))
  477. (list :tag "Command series, all agenda files"
  478. (string :tag "Access Key(s)")
  479. (string :tag "Description ")
  480. (repeat :tag "Component"
  481. (choice
  482. (list :tag "Agenda"
  483. (const :format "" agenda)
  484. (const :tag "" :format "" "")
  485. ,org-agenda-custom-commands-local-options)
  486. (list :tag "TODO list (all keywords)"
  487. (const :format "" alltodo)
  488. (const :tag "" :format "" "")
  489. ,org-agenda-custom-commands-local-options)
  490. (list :tag "Search words"
  491. (const :format "" search)
  492. (string :tag "Match")
  493. ,org-agenda-custom-commands-local-options)
  494. (list :tag "Stuck projects"
  495. (const :format "" stuck)
  496. (const :tag "" :format "" "")
  497. ,org-agenda-custom-commands-local-options)
  498. (list :tag "Tags search"
  499. (const :format "" tags)
  500. (string :tag "Match")
  501. ,org-agenda-custom-commands-local-options)
  502. (list :tag "Tags search, TODO entries only"
  503. (const :format "" tags-todo)
  504. (string :tag "Match")
  505. ,org-agenda-custom-commands-local-options)
  506. (list :tag "TODO keyword search"
  507. (const :format "" todo)
  508. (string :tag "Match")
  509. ,org-agenda-custom-commands-local-options)
  510. (list :tag "Other, user-defined function"
  511. (symbol :tag "function")
  512. (string :tag "Match")
  513. ,org-agenda-custom-commands-local-options)))
  514. (repeat :tag "Settings for entire command set"
  515. (list (variable :tag "Any variable")
  516. (sexp :tag "Value")))
  517. (option (repeat :tag "Export" (file :tag "Export to"))))
  518. (cons :tag "Prefix key documentation"
  519. (string :tag "Access Key(s)")
  520. (string :tag "Description ")))))
  521. (defcustom org-agenda-query-register ?o
  522. "The register holding the current query string.
  523. The purpose of this is that if you construct a query string interactively,
  524. you can then use it to define a custom command."
  525. :group 'org-agenda-custom-commands
  526. :type 'character)
  527. (defcustom org-stuck-projects
  528. '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
  529. "How to identify stuck projects.
  530. This is a list of four items:
  531. 1. A tags/todo/property matcher string that is used to identify a project.
  532. See the manual for a description of tag and property searches.
  533. The entire tree below a headline matched by this is considered one project.
  534. 2. A list of TODO keywords identifying non-stuck projects.
  535. If the project subtree contains any headline with one of these todo
  536. keywords, the project is considered to be not stuck. If you specify
  537. \"*\" as a keyword, any TODO keyword will mark the project unstuck.
  538. 3. A list of tags identifying non-stuck projects.
  539. If the project subtree contains any headline with one of these tags,
  540. the project is considered to be not stuck. If you specify \"*\" as
  541. a tag, any tag will mark the project unstuck. Note that this is about
  542. the explicit presence of a tag somewhere in the subtree, inherited
  543. tags do not count here. If inherited tags make a project not stuck,
  544. use \"-TAG\" in the tags part of the matcher under (1.) above.
  545. 4. An arbitrary regular expression matching non-stuck projects.
  546. If the project turns out to be not stuck, search continues also in the
  547. subtree to see if any of the subtasks have project status.
  548. See also the variable `org-tags-match-list-sublevels' which applies
  549. to projects matched by this search as well.
  550. After defining this variable, you may use `\\[org-agenda-list-stuck-projects]'
  551. \(bound to `C-c a #') to produce the list."
  552. :group 'org-agenda-custom-commands
  553. :type '(list
  554. (string :tag "Tags/TODO match to identify a project")
  555. (repeat :tag "Projects are *not* stuck if they have an entry with \
  556. TODO keyword any of" (string))
  557. (repeat :tag "Projects are *not* stuck if they have an entry with \
  558. TAG being any of" (string))
  559. (regexp :tag "Projects are *not* stuck if this regexp matches inside \
  560. the subtree")))
  561. (defgroup org-agenda-skip nil
  562. "Options concerning skipping parts of agenda files."
  563. :tag "Org Agenda Skip"
  564. :group 'org-agenda)
  565. (defcustom org-agenda-skip-function-global nil
  566. "Function to be called at each match during agenda construction.
  567. If this function returns nil, the current match should not be skipped.
  568. If the function decided to skip an agenda match, is must return the
  569. buffer position from which the search should be continued.
  570. This may also be a Lisp form, which will be evaluated.
  571. This variable will be applied to every agenda match, including
  572. tags/property searches and TODO lists. So try to make the test function
  573. do its checking as efficiently as possible. To implement a skipping
  574. condition just for specific agenda commands, use the variable
  575. `org-agenda-skip-function' which can be set in the options section
  576. of custom agenda commands."
  577. :group 'org-agenda-skip
  578. :type 'sexp)
  579. (defgroup org-agenda-daily/weekly nil
  580. "Options concerning the daily/weekly agenda."
  581. :tag "Org Agenda Daily/Weekly"
  582. :group 'org-agenda)
  583. (defgroup org-agenda-todo-list nil
  584. "Options concerning the global todo list agenda view."
  585. :tag "Org Agenda Todo List"
  586. :group 'org-agenda)
  587. (defgroup org-agenda-match-view nil
  588. "Options concerning the general tags/property/todo match agenda view."
  589. :tag "Org Agenda Match View"
  590. :group 'org-agenda)
  591. (defgroup org-agenda-search-view nil
  592. "Options concerning the search agenda view."
  593. :tag "Org Agenda Search View"
  594. :group 'org-agenda)
  595. (defvar org-agenda-archives-mode nil
  596. "Non-nil means the agenda will include archived items.
  597. If this is the symbol `trees', trees in the selected agenda scope
  598. that are marked with the ARCHIVE tag will be included anyway. When this is
  599. t, also all archive files associated with the current selection of agenda
  600. files will be included.")
  601. (defcustom org-agenda-restriction-lock-highlight-subtree t
  602. "Non-nil means highlight the whole subtree when restriction is active.
  603. Otherwise only highlight the headline. Highlighting the whole subtree is
  604. useful to ensure no edits happen beyond the restricted region."
  605. :group 'org-agenda
  606. :type 'boolean)
  607. (defcustom org-agenda-skip-comment-trees t
  608. "Non-nil means skip trees that start with the COMMENT keyword.
  609. When nil, these trees are also scanned by agenda commands."
  610. :group 'org-agenda-skip
  611. :type 'boolean)
  612. (defcustom org-agenda-todo-list-sublevels t
  613. "Non-nil means check also the sublevels of a TODO entry for TODO entries.
  614. When nil, the sublevels of a TODO entry are not checked, resulting in
  615. potentially much shorter TODO lists."
  616. :group 'org-agenda-skip
  617. :group 'org-agenda-todo-list
  618. :type 'boolean)
  619. (defcustom org-agenda-todo-ignore-with-date nil
  620. "Non-nil means don't show entries with a date in the global todo list.
  621. You can use this if you prefer to mark mere appointments with a TODO keyword,
  622. but don't want them to show up in the TODO list.
  623. When this is set, it also covers deadlines and scheduled items, the settings
  624. of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
  625. will be ignored.
  626. See also the variable `org-agenda-tags-todo-honor-ignore-options'."
  627. :group 'org-agenda-skip
  628. :group 'org-agenda-todo-list
  629. :type 'boolean)
  630. (defcustom org-agenda-todo-ignore-timestamp nil
  631. "Non-nil means don't show entries with a timestamp.
  632. This applies when creating the global todo list.
  633. Valid values are:
  634. past Don't show entries for today or in the past.
  635. future Don't show entries with a timestamp in the future.
  636. The idea behind this is that if it has a future
  637. timestamp, you don't want to think about it until the
  638. date.
  639. all Don't show any entries with a timestamp in the global todo list.
  640. The idea behind this is that by setting a timestamp, you
  641. have already \"taken care\" of this item.
  642. This variable can also have an integer as a value. If positive (N),
  643. todos with a timestamp N or more days in the future will be ignored. If
  644. negative (-N), todos with a timestamp N or more days in the past will be
  645. ignored. If 0, todos with a timestamp either today or in the future will
  646. be ignored. For example, a value of -1 will exclude todos with a
  647. timestamp in the past (yesterday or earlier), while a value of 7 will
  648. exclude todos with a timestamp a week or more in the future.
  649. See also `org-agenda-todo-ignore-with-date'.
  650. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  651. to make his option also apply to the tags-todo list."
  652. :group 'org-agenda-skip
  653. :group 'org-agenda-todo-list
  654. :version "24.1"
  655. :type '(choice
  656. (const :tag "Ignore future timestamp todos" future)
  657. (const :tag "Ignore past or present timestamp todos" past)
  658. (const :tag "Ignore all timestamp todos" all)
  659. (const :tag "Show timestamp todos" nil)
  660. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  661. (defcustom org-agenda-todo-ignore-scheduled nil
  662. "Non-nil means, ignore some scheduled TODO items when making TODO list.
  663. This applies when creating the global todo list.
  664. Valid values are:
  665. past Don't show entries scheduled today or in the past.
  666. future Don't show entries scheduled in the future.
  667. The idea behind this is that by scheduling it, you don't want to
  668. think about it until the scheduled date.
  669. all Don't show any scheduled entries in the global todo list.
  670. The idea behind this is that by scheduling it, you have already
  671. \"taken care\" of this item.
  672. t Same as `all', for backward compatibility.
  673. This variable can also have an integer as a value. See
  674. `org-agenda-todo-ignore-timestamp' for more details.
  675. See also `org-agenda-todo-ignore-with-date'.
  676. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  677. to make his option also apply to the tags-todo list."
  678. :group 'org-agenda-skip
  679. :group 'org-agenda-todo-list
  680. :type '(choice
  681. (const :tag "Ignore future-scheduled todos" future)
  682. (const :tag "Ignore past- or present-scheduled todos" past)
  683. (const :tag "Ignore all scheduled todos" all)
  684. (const :tag "Ignore all scheduled todos (compatibility)" t)
  685. (const :tag "Show scheduled todos" nil)
  686. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  687. (defcustom org-agenda-todo-ignore-deadlines nil
  688. "Non-nil means ignore some deadline TODO items when making TODO list.
  689. There are different motivations for using different values, please think
  690. carefully when configuring this variable.
  691. This applies when creating the global TODO list.
  692. Valid values are:
  693. near Don't show near deadline entries. A deadline is near when it is
  694. closer than `org-deadline-warning-days' days. The idea behind this
  695. is that such items will appear in the agenda anyway.
  696. far Don't show TODO entries where a deadline has been defined, but
  697. is not going to happen anytime soon. This is useful if you want to use
  698. the TODO list to figure out what to do now.
  699. past Don't show entries with a deadline timestamp for today or in the past.
  700. future Don't show entries with a deadline timestamp in the future, not even
  701. when they become `near' ones. Use it with caution.
  702. all Ignore all TODO entries that do have a deadline.
  703. t Same as `near', for backward compatibility.
  704. This variable can also have an integer as a value. See
  705. `org-agenda-todo-ignore-timestamp' for more details.
  706. See also `org-agenda-todo-ignore-with-date'.
  707. See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
  708. to make his option also apply to the tags-todo list."
  709. :group 'org-agenda-skip
  710. :group 'org-agenda-todo-list
  711. :type '(choice
  712. (const :tag "Ignore near deadlines" near)
  713. (const :tag "Ignore near deadlines (compatibility)" t)
  714. (const :tag "Ignore far deadlines" far)
  715. (const :tag "Ignore all TODOs with a deadlines" all)
  716. (const :tag "Show all TODOs, even if they have a deadline" nil)
  717. (integer :tag "Ignore if N or more days in past(-) or future(+).")))
  718. (defcustom org-agenda-todo-ignore-time-comparison-use-seconds nil
  719. "Time unit to use when possibly ignoring an agenda item.
  720. See the docstring of various `org-agenda-todo-ignore-*' options.
  721. The default is to compare time stamps using days. An item is thus
  722. considered to be in the future if it is at least one day after today.
  723. Non-nil means to compare time stamps using seconds. An item is then
  724. considered future if it has a time value later than current time."
  725. :group 'org-agenda-skip
  726. :group 'org-agenda-todo-list
  727. :version "24.4"
  728. :package-version '(Org . "8.0")
  729. :type '(choice
  730. (const :tag "Compare time with days" nil)
  731. (const :tag "Compare time with seconds" t)))
  732. (defcustom org-agenda-tags-todo-honor-ignore-options nil
  733. "Non-nil means honor todo-list ignores options also in tags-todo search.
  734. The variables
  735. `org-agenda-todo-ignore-with-date',
  736. `org-agenda-todo-ignore-timestamp',
  737. `org-agenda-todo-ignore-scheduled',
  738. `org-agenda-todo-ignore-deadlines'
  739. make the global TODO list skip entries that have time stamps of certain
  740. kinds. If this option is set, the same options will also apply for the
  741. tags-todo search, which is the general tags/property matcher
  742. restricted to unfinished TODO entries only."
  743. :group 'org-agenda-skip
  744. :group 'org-agenda-todo-list
  745. :group 'org-agenda-match-view
  746. :type 'boolean)
  747. (defcustom org-agenda-skip-scheduled-if-done nil
  748. "Non-nil means don't show scheduled items in agenda when they are done.
  749. This is relevant for the daily/weekly agenda, not for the TODO list. It
  750. applies only to the actual date of the scheduling. Warnings about an item
  751. with a past scheduling dates are always turned off when the item is DONE."
  752. :group 'org-agenda-skip
  753. :group 'org-agenda-daily/weekly
  754. :type 'boolean)
  755. (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
  756. "Non-nil means skip scheduling line if same entry shows because of deadline.
  757. In the agenda of today, an entry can show up multiple times
  758. because it is both scheduled and has a nearby deadline, and maybe
  759. a plain time stamp as well.
  760. When this variable is nil, the entry will be shown several times.
  761. When set to t, then only the deadline is shown and the fact that
  762. the entry is scheduled today or was scheduled previously is not
  763. shown.
  764. When set to the symbol `not-today', skip scheduled previously,
  765. but not scheduled today.
  766. When set to the symbol `repeated-after-deadline', skip scheduled
  767. items if they are repeated beyond the current deadline."
  768. :group 'org-agenda-skip
  769. :group 'org-agenda-daily/weekly
  770. :type '(choice
  771. (const :tag "Never" nil)
  772. (const :tag "Always" t)
  773. (const :tag "Not when scheduled today" not-today)
  774. (const :tag "When repeated past deadline" repeated-after-deadline)))
  775. (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
  776. "Non-nil means skip timestamp line if same entry shows because of deadline.
  777. In the agenda of today, an entry can show up multiple times
  778. because it has both a plain timestamp and has a nearby deadline.
  779. When this variable is t, then only the deadline is shown and the
  780. fact that the entry has a timestamp for or including today is not
  781. shown. When this variable is nil, the entry will be shown
  782. several times."
  783. :group 'org-agenda-skip
  784. :group 'org-agenda-daily/weekly
  785. :version "24.1"
  786. :type '(choice
  787. (const :tag "Never" nil)
  788. (const :tag "Always" t)))
  789. (defcustom org-agenda-skip-deadline-if-done nil
  790. "Non-nil means don't show deadlines when the corresponding item is done.
  791. When nil, the deadline is still shown and should give you a happy feeling.
  792. This is relevant for the daily/weekly agenda. It applies only to the
  793. actual date of the deadline. Warnings about approaching and past-due
  794. deadlines are always turned off when the item is DONE."
  795. :group 'org-agenda-skip
  796. :group 'org-agenda-daily/weekly
  797. :type 'boolean)
  798. (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
  799. "Non-nil means skip deadline prewarning when entry is also scheduled.
  800. This will apply on all days where a prewarning for the deadline would
  801. be shown, but not at the day when the entry is actually due. On that day,
  802. the deadline will be shown anyway.
  803. This variable may be set to nil, t, the symbol `pre-scheduled',
  804. or a number which will then give the number of days before the actual
  805. deadline when the prewarnings should resume. The symbol `pre-scheduled'
  806. eliminates the deadline prewarning only prior to the scheduled date.
  807. This can be used in a workflow where the first showing of the deadline will
  808. trigger you to schedule it, and then you don't want to be reminded of it
  809. because you will take care of it on the day when scheduled."
  810. :group 'org-agenda-skip
  811. :group 'org-agenda-daily/weekly
  812. :version "24.1"
  813. :type '(choice
  814. (const :tag "Always show prewarning" nil)
  815. (const :tag "Remove prewarning prior to scheduled date" pre-scheduled)
  816. (const :tag "Remove prewarning if entry is scheduled" t)
  817. (integer :tag "Restart prewarning N days before deadline")))
  818. (defcustom org-agenda-skip-scheduled-delay-if-deadline nil
  819. "Non-nil means skip scheduled delay when entry also has a deadline.
  820. This variable may be set to nil, t, the symbol `post-deadline',
  821. or a number which will then give the number of days after the actual
  822. scheduled date when the delay should expire. The symbol `post-deadline'
  823. eliminates the schedule delay when the date is posterior to the deadline."
  824. :group 'org-agenda-skip
  825. :group 'org-agenda-daily/weekly
  826. :version "24.4"
  827. :package-version '(Org . "8.0")
  828. :type '(choice
  829. (const :tag "Always honor delay" nil)
  830. (const :tag "Ignore delay if posterior to the deadline" post-deadline)
  831. (const :tag "Ignore delay if entry has a deadline" t)
  832. (integer :tag "Honor delay up until N days after the scheduled date")))
  833. (defcustom org-agenda-skip-additional-timestamps-same-entry nil
  834. "When nil, multiple same-day timestamps in entry make multiple agenda lines.
  835. When non-nil, after the search for timestamps has matched once in an
  836. entry, the rest of the entry will not be searched."
  837. :group 'org-agenda-skip
  838. :type 'boolean)
  839. (defcustom org-agenda-skip-timestamp-if-done nil
  840. "Non-nil means don't select item by timestamp or -range if it is DONE."
  841. :group 'org-agenda-skip
  842. :group 'org-agenda-daily/weekly
  843. :type 'boolean)
  844. (defcustom org-agenda-dim-blocked-tasks t
  845. "Non-nil means dim blocked tasks in the agenda display.
  846. This causes some overhead during agenda construction, but if you
  847. have turned on `org-enforce-todo-dependencies',
  848. `org-enforce-todo-checkbox-dependencies', or any other blocking
  849. mechanism, this will create useful feedback in the agenda.
  850. Instead of t, this variable can also have the value `invisible'.
  851. Then blocked tasks will be invisible and only become visible when
  852. they become unblocked. An exemption to this behavior is when a task is
  853. blocked because of unchecked checkboxes below it. Since checkboxes do
  854. not show up in the agenda views, making this task invisible you remove any
  855. trace from agenda views that there is something to do. Therefore, a task
  856. that is blocked because of checkboxes will never be made invisible, it
  857. will only be dimmed."
  858. :group 'org-agenda-daily/weekly
  859. :group 'org-agenda-todo-list
  860. :version "24.3"
  861. :type '(choice
  862. (const :tag "Do not dim" nil)
  863. (const :tag "Dim to a gray face" t)
  864. (const :tag "Make invisible" invisible)))
  865. (defgroup org-agenda-startup nil
  866. "Options concerning initial settings in the Agenda in Org Mode."
  867. :tag "Org Agenda Startup"
  868. :group 'org-agenda)
  869. (defcustom org-agenda-menu-show-matcher t
  870. "Non-nil means show the match string in the agenda dispatcher menu.
  871. When nil, the matcher string is not shown, but is put into the help-echo
  872. property so than moving the mouse over the command shows it.
  873. Setting it to nil is good if matcher strings are very long and/or if
  874. you want to use two-columns display (see `org-agenda-menu-two-columns')."
  875. :group 'org-agenda
  876. :version "24.1"
  877. :type 'boolean)
  878. (defcustom org-agenda-menu-two-columns nil
  879. "Non-nil means, use two columns to show custom commands in the dispatcher.
  880. If you use this, you probably want to set `org-agenda-menu-show-matcher'
  881. to nil."
  882. :group 'org-agenda
  883. :version "24.1"
  884. :type 'boolean)
  885. (defcustom org-agenda-finalize-hook nil
  886. "Hook run just before displaying an agenda buffer.
  887. The buffer is still writable when the hook is called.
  888. You can modify some of the buffer substrings but you should be
  889. extra careful not to modify the text properties of the agenda
  890. headlines as the agenda display heavily relies on them."
  891. :group 'org-agenda-startup
  892. :type 'hook)
  893. (defcustom org-agenda-mouse-1-follows-link nil
  894. "Non-nil means mouse-1 on a link will follow the link in the agenda.
  895. A longer mouse click will still set point. Needs to be set
  896. before org.el is loaded."
  897. :group 'org-agenda-startup
  898. :type 'boolean)
  899. (defcustom org-agenda-start-with-follow-mode nil
  900. "The initial value of follow mode in a newly created agenda window."
  901. :group 'org-agenda-startup
  902. :type 'boolean)
  903. (defcustom org-agenda-follow-indirect nil
  904. "Non-nil means `org-agenda-follow-mode' displays only the
  905. current item's tree, in an indirect buffer."
  906. :group 'org-agenda
  907. :version "24.1"
  908. :type 'boolean)
  909. (defcustom org-agenda-show-outline-path t
  910. "Non-nil means show outline path in echo area after line motion."
  911. :group 'org-agenda-startup
  912. :type 'boolean)
  913. (defcustom org-agenda-start-with-entry-text-mode nil
  914. "The initial value of entry-text-mode in a newly created agenda window."
  915. :group 'org-agenda-startup
  916. :type 'boolean)
  917. (defcustom org-agenda-entry-text-maxlines 5
  918. "Number of text lines to be added when `E' is pressed in the agenda.
  919. Note that this variable only used during agenda display. To add entry text
  920. when exporting the agenda, configure the variable
  921. `org-agenda-add-entry-text-maxlines'."
  922. :group 'org-agenda
  923. :type 'integer)
  924. (defcustom org-agenda-entry-text-exclude-regexps nil
  925. "List of regular expressions to clean up entry text.
  926. The complete matches of all regular expressions in this list will be
  927. removed from entry text before it is shown in the agenda."
  928. :group 'org-agenda
  929. :type '(repeat (regexp)))
  930. (defcustom org-agenda-entry-text-leaders " > "
  931. "Text prepended to the entry text in agenda buffers."
  932. :version "24.4"
  933. :package-version '(Org . "8.0")
  934. :group 'org-agenda
  935. :type 'string)
  936. (defvar org-agenda-entry-text-cleanup-hook nil
  937. "Hook that is run after basic cleanup of entry text to be shown in agenda.
  938. This cleanup is done in a temporary buffer, so the function may inspect and
  939. change the entire buffer.
  940. Some default stuff like drawers and scheduling/deadline dates will already
  941. have been removed when this is called, as will any matches for regular
  942. expressions listed in `org-agenda-entry-text-exclude-regexps'.")
  943. (defvar org-agenda-include-inactive-timestamps nil
  944. "Non-nil means include inactive time stamps in agenda and timeline.
  945. Dynamically scoped.")
  946. (defgroup org-agenda-windows nil
  947. "Options concerning the windows used by the Agenda in Org Mode."
  948. :tag "Org Agenda Windows"
  949. :group 'org-agenda)
  950. (defcustom org-agenda-window-setup 'reorganize-frame
  951. "How the agenda buffer should be displayed.
  952. Possible values for this option are:
  953. current-window Show agenda in the current window, keeping all other windows.
  954. other-window Use `switch-to-buffer-other-window' to display agenda.
  955. only-window Show agenda, deleting all other windows.
  956. reorganize-frame Show only two windows on the current frame, the current
  957. window and the agenda.
  958. other-frame Use `switch-to-buffer-other-frame' to display agenda.
  959. Also, when exiting the agenda, kill that frame.
  960. See also the variable `org-agenda-restore-windows-after-quit'."
  961. :group 'org-agenda-windows
  962. :type '(choice
  963. (const current-window)
  964. (const other-frame)
  965. (const other-window)
  966. (const only-window)
  967. (const reorganize-frame)))
  968. (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
  969. "The min and max height of the agenda window as a fraction of frame height.
  970. The value of the variable is a cons cell with two numbers between 0 and 1.
  971. It only matters if `org-agenda-window-setup' is `reorganize-frame'."
  972. :group 'org-agenda-windows
  973. :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
  974. (defcustom org-agenda-restore-windows-after-quit nil
  975. "Non-nil means restore window configuration upon exiting agenda.
  976. Before the window configuration is changed for displaying the agenda,
  977. the current status is recorded. When the agenda is exited with
  978. `q' or `x' and this option is set, the old state is restored. If
  979. `org-agenda-window-setup' is `other-frame', the value of this
  980. option will be ignored."
  981. :group 'org-agenda-windows
  982. :type 'boolean)
  983. (defcustom org-agenda-span 'week
  984. "Number of days to include in overview display.
  985. Can be day, week, month, year, or any number of days.
  986. Custom commands can set this variable in the options section."
  987. :group 'org-agenda-daily/weekly
  988. :type '(choice (const :tag "Day" day)
  989. (const :tag "Week" week)
  990. (const :tag "Fortnight" fortnight)
  991. (const :tag "Month" month)
  992. (const :tag "Year" year)
  993. (integer :tag "Custom")))
  994. (defcustom org-agenda-start-on-weekday 1
  995. "Non-nil means start the overview always on the specified weekday.
  996. 0 denotes Sunday, 1 denotes Monday, etc.
  997. When nil, always start on the current day.
  998. Custom commands can set this variable in the options section."
  999. :group 'org-agenda-daily/weekly
  1000. :type '(choice (const :tag "Today" nil)
  1001. (integer :tag "Weekday No.")))
  1002. (defcustom org-agenda-show-all-dates t
  1003. "Non-nil means `org-agenda' shows every day in the selected range.
  1004. When nil, only the days which actually have entries are shown."
  1005. :group 'org-agenda-daily/weekly
  1006. :type 'boolean)
  1007. (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
  1008. "Format string for displaying dates in the agenda.
  1009. Used by the daily/weekly agenda and by the timeline. This should be
  1010. a format string understood by `format-time-string', or a function returning
  1011. the formatted date as a string. The function must take a single argument,
  1012. a calendar-style date list like (month day year)."
  1013. :group 'org-agenda-daily/weekly
  1014. :type '(choice
  1015. (string :tag "Format string")
  1016. (function :tag "Function")))
  1017. (defun org-agenda-format-date-aligned (date)
  1018. "Format a DATE string for display in the daily/weekly agenda, or timeline.
  1019. This function makes sure that dates are aligned for easy reading."
  1020. (require 'cal-iso)
  1021. (let* ((dayname (calendar-day-name date))
  1022. (day (cadr date))
  1023. (day-of-week (calendar-day-of-week date))
  1024. (month (car date))
  1025. (monthname (calendar-month-name month))
  1026. (year (nth 2 date))
  1027. (iso-week (org-days-to-iso-week
  1028. (calendar-absolute-from-gregorian date)))
  1029. (weekyear (cond ((and (= month 1) (>= iso-week 52))
  1030. (1- year))
  1031. ((and (= month 12) (<= iso-week 1))
  1032. (1+ year))
  1033. (t year)))
  1034. (weekstring (if (= day-of-week 1)
  1035. (format " W%02d" iso-week)
  1036. "")))
  1037. (format "%-10s %2d %s %4d%s"
  1038. dayname day monthname year weekstring)))
  1039. (defcustom org-agenda-time-leading-zero nil
  1040. "Non-nil means use leading zero for military times in agenda.
  1041. For example, 9:30am would become 09:30 rather than 9:30."
  1042. :group 'org-agenda-daily/weekly
  1043. :version "24.1"
  1044. :type 'boolean)
  1045. (defcustom org-agenda-timegrid-use-ampm nil
  1046. "When set, show AM/PM style timestamps on the timegrid."
  1047. :group 'org-agenda
  1048. :version "24.1"
  1049. :type 'boolean)
  1050. (defun org-agenda-time-of-day-to-ampm (time)
  1051. "Convert TIME of a string like \"13:45\" to an AM/PM style time string."
  1052. (let* ((hour-number (string-to-number (substring time 0 -3)))
  1053. (minute (substring time -2))
  1054. (ampm "am"))
  1055. (cond
  1056. ((equal hour-number 12)
  1057. (setq ampm "pm"))
  1058. ((> hour-number 12)
  1059. (setq ampm "pm")
  1060. (setq hour-number (- hour-number 12))))
  1061. (concat
  1062. (if org-agenda-time-leading-zero
  1063. (format "%02d" hour-number)
  1064. (format "%02s" (number-to-string hour-number)))
  1065. ":" minute ampm)))
  1066. (defun org-agenda-time-of-day-to-ampm-maybe (time)
  1067. "Conditionally convert TIME to AM/PM format based on `org-agenda-timegrid-use-ampm'."
  1068. (if org-agenda-timegrid-use-ampm
  1069. (org-agenda-time-of-day-to-ampm time)
  1070. time))
  1071. (defcustom org-agenda-weekend-days '(6 0)
  1072. "Which days are weekend?
  1073. These days get the special face `org-agenda-date-weekend' in the agenda
  1074. and timeline buffers."
  1075. :group 'org-agenda-daily/weekly
  1076. :type '(set :greedy t
  1077. (const :tag "Monday" 1)
  1078. (const :tag "Tuesday" 2)
  1079. (const :tag "Wednesday" 3)
  1080. (const :tag "Thursday" 4)
  1081. (const :tag "Friday" 5)
  1082. (const :tag "Saturday" 6)
  1083. (const :tag "Sunday" 0)))
  1084. (defcustom org-agenda-move-date-from-past-immediately-to-today t
  1085. "Non-nil means jump to today when moving a past date forward in time.
  1086. When using S-right in the agenda to move a a date forward, and the date
  1087. stamp currently points to the past, the first key press will move it
  1088. to today. WHen nil, just move one day forward even if the date stays
  1089. in the past."
  1090. :group 'org-agenda-daily/weekly
  1091. :version "24.1"
  1092. :type 'boolean)
  1093. (defcustom org-agenda-include-diary nil
  1094. "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
  1095. Custom commands can set this variable in the options section."
  1096. :group 'org-agenda-daily/weekly
  1097. :type 'boolean)
  1098. (defcustom org-agenda-include-deadlines t
  1099. "If non-nil, include entries within their deadline warning period.
  1100. Custom commands can set this variable in the options section."
  1101. :group 'org-agenda-daily/weekly
  1102. :version "24.1"
  1103. :type 'boolean)
  1104. (defcustom org-agenda-show-future-repeats t
  1105. "Non-nil shows repeated entries in the future part of the agenda.
  1106. When set to the symbol `next' only the first future repeat is shown."
  1107. :group 'org-agenda-daily/weekly
  1108. :type '(choice
  1109. (const :tag "Show all repeated entries" t)
  1110. (const :tag "Show next repeated entry" next)
  1111. (const :tag "Do not show repeated entries" nil))
  1112. :version "26.1"
  1113. :package-version '(Org . "9.1")
  1114. :safe #'symbolp)
  1115. (defcustom org-agenda-prefer-last-repeat nil
  1116. "Non-nil sets date for repeated entries to their last repeat.
  1117. When nil, display SCHEDULED and DEADLINE dates at their base
  1118. date, and in today's agenda, as a reminder. Display plain
  1119. time-stamps, on the other hand, at every repeat date in the past
  1120. in addition to the base date.
  1121. When non-nil, show a repeated entry at its latest repeat date,
  1122. possibly being today even if it wasn't marked as done. This
  1123. setting is useful if you do not always mark repeated entries as
  1124. done and, yet, consider that reaching repeat date starts the task
  1125. anew.
  1126. When set to a list of strings, prefer last repeats only for
  1127. entries with these TODO keywords."
  1128. :group 'org-agenda-daily/weekly
  1129. :type '(choice
  1130. (const :tag "Prefer last repeat" t)
  1131. (const :tag "Prefer base date" nil)
  1132. (repeat :tag "Prefer last repeat for entries with these TODO keywords"
  1133. (string :tag "TODO keyword")))
  1134. :version "26.1"
  1135. :package-version '(Org . "9.1")
  1136. :safe (lambda (x) (or (booleanp x) (consp x))))
  1137. (defcustom org-scheduled-past-days 10000
  1138. "Number of days to continue listing scheduled items not marked DONE.
  1139. When an item is scheduled on a date, it shows up in the agenda on
  1140. this day and will be listed until it is marked done or for the
  1141. number of days given here."
  1142. :group 'org-agenda-daily/weekly
  1143. :type 'integer
  1144. :safe 'integerp)
  1145. (defcustom org-deadline-past-days 10000
  1146. "Number of days to warn about missed deadlines.
  1147. When an item has deadline on a date, it shows up in the agenda on
  1148. this day and will appear as a reminder until it is marked DONE or
  1149. for the number of days given here."
  1150. :group 'org-agenda-daily/weekly
  1151. :type 'integer
  1152. :version "26.1"
  1153. :package-version '(Org . "9.1")
  1154. :safe 'integerp)
  1155. (defcustom org-agenda-log-mode-items '(closed clock)
  1156. "List of items that should be shown in agenda log mode.
  1157. \\<org-agenda-mode-map>\
  1158. This list may contain the following symbols:
  1159. closed Show entries that have been closed on that day.
  1160. clock Show entries that have received clocked time on that day.
  1161. state Show all logged state changes.
  1162. Note that instead of changing this variable, you can also press \
  1163. `\\[universal-argument] \\[org-agenda-log-mode]' in
  1164. the agenda to display all available LOG items temporarily."
  1165. :group 'org-agenda-daily/weekly
  1166. :type '(set :greedy t (const closed) (const clock) (const state)))
  1167. (defcustom org-agenda-clock-consistency-checks
  1168. '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
  1169. :gap-ok-around ("4:00")
  1170. :default-face ((:background "DarkRed") (:foreground "white"))
  1171. :overlap-face nil :gap-face nil :no-end-time-face nil
  1172. :long-face nil :short-face nil)
  1173. "This is a property list, with the following keys:
  1174. :max-duration Mark clocking chunks that are longer than this time.
  1175. This is a time string like \"HH:MM\", or the number
  1176. of minutes as an integer.
  1177. :min-duration Mark clocking chunks that are shorter that this.
  1178. This is a time string like \"HH:MM\", or the number
  1179. of minutes as an integer.
  1180. :max-gap Mark gaps between clocking chunks that are longer than
  1181. this duration. A number of minutes, or a string
  1182. like \"HH:MM\".
  1183. :gap-ok-around List of times during the day which are usually not working
  1184. times. When a gap is detected, but the gap contains any
  1185. of these times, the gap is *not* reported. For example,
  1186. if this is (\"4:00\" \"13:00\") then gaps that contain
  1187. 4:00 in the morning (i.e. the night) and 13:00
  1188. (i.e. a typical lunch time) do not cause a warning.
  1189. You should have at least one time during the night in this
  1190. list, or otherwise the first task each morning will trigger
  1191. a warning because it follows a long gap.
  1192. Furthermore, the following properties can be used to define faces for
  1193. issue display.
  1194. :default-face the default face, if the specific face is undefined
  1195. :overlap-face face for overlapping clocks
  1196. :gap-face face for gaps between clocks
  1197. :no-end-time-face face for incomplete clocks
  1198. :long-face face for clock intervals that are too long
  1199. :short-face face for clock intervals that are too short"
  1200. :group 'org-agenda-daily/weekly
  1201. :group 'org-clock
  1202. :version "24.1"
  1203. :type 'plist)
  1204. (defcustom org-agenda-log-mode-add-notes t
  1205. "Non-nil means add first line of notes to log entries in agenda views.
  1206. If a log item like a state change or a clock entry is associated with
  1207. notes, the first line of these notes will be added to the entry in the
  1208. agenda display."
  1209. :group 'org-agenda-daily/weekly
  1210. :type 'boolean)
  1211. (defcustom org-agenda-start-with-log-mode nil
  1212. "The initial value of log-mode in a newly created agenda window.
  1213. See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
  1214. explanations on the possible values."
  1215. :group 'org-agenda-startup
  1216. :group 'org-agenda-daily/weekly
  1217. :type '(choice (const :tag "Don't show log items" nil)
  1218. (const :tag "Show only log items" only)
  1219. (const :tag "Show all possible log items" clockcheck)
  1220. (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
  1221. (choice (const :tag "Show closed log items" closed)
  1222. (const :tag "Show clocked log items" clock)
  1223. (const :tag "Show all logged state changes" state)))))
  1224. (defcustom org-agenda-start-with-clockreport-mode nil
  1225. "The initial value of clockreport-mode in a newly created agenda window."
  1226. :group 'org-agenda-startup
  1227. :group 'org-agenda-daily/weekly
  1228. :type 'boolean)
  1229. (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
  1230. "Property list with parameters for the clocktable in clockreport mode.
  1231. This is the display mode that shows a clock table in the daily/weekly
  1232. agenda, the properties for this dynamic block can be set here.
  1233. The usual clocktable parameters are allowed here, but you cannot set
  1234. the properties :name, :tstart, :tend, :block, and :scope - these will
  1235. be overwritten to make sure the content accurately reflects the
  1236. current display in the agenda."
  1237. :group 'org-agenda-daily/weekly
  1238. :type 'plist)
  1239. (defcustom org-agenda-search-view-always-boolean nil
  1240. "Non-nil means the search string is interpreted as individual parts.
  1241. The search string for search view can either be interpreted as a phrase,
  1242. or as a list of snippets that define a boolean search for a number of
  1243. strings.
  1244. When this is non-nil, the string will be split on whitespace, and each
  1245. snippet will be searched individually, and all must match in order to
  1246. select an entry. A snippet is then a single string of non-white
  1247. characters, or a string in double quotes, or a regexp in {} braces.
  1248. If a snippet is preceded by \"-\", the snippet must *not* match.
  1249. \"+\" is syntactic sugar for positive selection. Each snippet may
  1250. be found as a full word or a partial word, but see the variable
  1251. `org-agenda-search-view-force-full-words'.
  1252. When this is nil, search will look for the entire search phrase as one,
  1253. with each space character matching any amount of whitespace, including
  1254. line breaks.
  1255. Even when this is nil, you can still switch to Boolean search dynamically
  1256. by preceding the first snippet with \"+\" or \"-\". If the first snippet
  1257. is a regexp marked with braces like \"{abc}\", this will also switch to
  1258. boolean search."
  1259. :group 'org-agenda-search-view
  1260. :version "24.1"
  1261. :type 'boolean)
  1262. (defvaralias 'org-agenda-search-view-search-words-only
  1263. 'org-agenda-search-view-always-boolean)
  1264. (defcustom org-agenda-search-view-force-full-words nil
  1265. "Non-nil means, search words must be matches as complete words.
  1266. When nil, they may also match part of a word."
  1267. :group 'org-agenda-search-view
  1268. :version "24.1"
  1269. :type 'boolean)
  1270. (defcustom org-agenda-search-view-max-outline-level 0
  1271. "Maximum outline level to display in search view.
  1272. E.g. when this is set to 1, the search view will only
  1273. show headlines of level 1. When set to 0, the default
  1274. value, don't limit agenda view by outline level."
  1275. :group 'org-agenda-search-view
  1276. :version "24.4"
  1277. :package-version '(Org . "8.3")
  1278. :type 'integer)
  1279. (defgroup org-agenda-time-grid nil
  1280. "Options concerning the time grid in the Org Agenda."
  1281. :tag "Org Agenda Time Grid"
  1282. :group 'org-agenda)
  1283. (defcustom org-agenda-search-headline-for-time t
  1284. "Non-nil means search headline for a time-of-day.
  1285. If the headline contains a time-of-day in one format or another, it will
  1286. be used to sort the entry into the time sequence of items for a day.
  1287. Some people have time stamps in the headline that refer to the creation
  1288. time or so, and then this produces an unwanted side effect. If this is
  1289. the case for your, use this variable to turn off searching the headline
  1290. for a time."
  1291. :group 'org-agenda-time-grid
  1292. :type 'boolean)
  1293. (defcustom org-agenda-use-time-grid t
  1294. "Non-nil means show a time grid in the agenda schedule.
  1295. A time grid is a set of lines for specific times (like every two hours between
  1296. 8:00 and 20:00). The items scheduled for a day at specific times are
  1297. sorted in between these lines.
  1298. For details about when the grid will be shown, and what it will look like, see
  1299. the variable `org-agenda-time-grid'."
  1300. :group 'org-agenda-time-grid
  1301. :type 'boolean)
  1302. (defcustom org-agenda-time-grid
  1303. '((daily today require-timed)
  1304. "----------------"
  1305. (800 1000 1200 1400 1600 1800 2000))
  1306. "The settings for time grid for agenda display.
  1307. This is a list of three items. The first item is again a list. It contains
  1308. symbols specifying conditions when the grid should be displayed:
  1309. daily if the agenda shows a single day
  1310. weekly if the agenda shows an entire week
  1311. today show grid on current date, independent of daily/weekly display
  1312. require-timed show grid only if at least one item has a time specification
  1313. remove-match skip grid times already present in an entry
  1314. The second item is a string which will be placed behind the grid time.
  1315. The third item is a list of integers, indicating the times that should have
  1316. a grid line."
  1317. :group 'org-agenda-time-grid
  1318. :type
  1319. '(list
  1320. (set :greedy t :tag "Grid Display Options"
  1321. (const :tag "Show grid in single day agenda display" daily)
  1322. (const :tag "Show grid in weekly agenda display" weekly)
  1323. (const :tag "Always show grid for today" today)
  1324. (const :tag "Show grid only if any timed entries are present"
  1325. require-timed)
  1326. (const :tag "Skip grid times already present in an entry"
  1327. remove-match))
  1328. (string :tag "Grid String")
  1329. (repeat :tag "Grid Times" (integer :tag "Time"))))
  1330. (defcustom org-agenda-show-current-time-in-grid t
  1331. "Non-nil means show the current time in the time grid."
  1332. :group 'org-agenda-time-grid
  1333. :version "24.1"
  1334. :type 'boolean)
  1335. (defcustom org-agenda-current-time-string
  1336. "now - - - - - - - - - - - - - - - - - - - - - - - - -"
  1337. "The string for the current time marker in the agenda."
  1338. :group 'org-agenda-time-grid
  1339. :version "24.1"
  1340. :type 'string)
  1341. (defgroup org-agenda-sorting nil
  1342. "Options concerning sorting in the Org Agenda."
  1343. :tag "Org Agenda Sorting"
  1344. :group 'org-agenda)
  1345. (defcustom org-agenda-sorting-strategy
  1346. '((agenda habit-down time-up priority-down category-keep)
  1347. (todo priority-down category-keep)
  1348. (tags priority-down category-keep)
  1349. (search category-keep))
  1350. "Sorting structure for the agenda items of a single day.
  1351. This is a list of symbols which will be used in sequence to determine
  1352. if an entry should be listed before another entry. The following
  1353. symbols are recognized:
  1354. time-up Put entries with time-of-day indications first, early first
  1355. time-down Put entries with time-of-day indications first, late first
  1356. timestamp-up Sort by any timestamp, early first
  1357. timestamp-down Sort by any timestamp, late first
  1358. scheduled-up Sort by scheduled timestamp, early first
  1359. scheduled-down Sort by scheduled timestamp, late first
  1360. deadline-up Sort by deadline timestamp, early first
  1361. deadline-down Sort by deadline timestamp, late first
  1362. ts-up Sort by active timestamp, early first
  1363. ts-down Sort by active timestamp, late first
  1364. tsia-up Sort by inactive timestamp, early first
  1365. tsia-down Sort by inactive timestamp, late first
  1366. category-keep Keep the default order of categories, corresponding to the
  1367. sequence in `org-agenda-files'.
  1368. category-up Sort alphabetically by category, A-Z.
  1369. category-down Sort alphabetically by category, Z-A.
  1370. tag-up Sort alphabetically by last tag, A-Z.
  1371. tag-down Sort alphabetically by last tag, Z-A.
  1372. priority-up Sort numerically by priority, high priority last.
  1373. priority-down Sort numerically by priority, high priority first.
  1374. todo-state-up Sort by todo state, tasks that are done last.
  1375. todo-state-down Sort by todo state, tasks that are done first.
  1376. effort-up Sort numerically by estimated effort, high effort last.
  1377. effort-down Sort numerically by estimated effort, high effort first.
  1378. user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
  1379. user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
  1380. habit-up Put entries that are habits first
  1381. habit-down Put entries that are habits last
  1382. alpha-up Sort headlines alphabetically
  1383. alpha-down Sort headlines alphabetically, reversed
  1384. The different possibilities will be tried in sequence, and testing stops
  1385. if one comparison returns a \"not-equal\". For example, the default
  1386. '(time-up category-keep priority-down)
  1387. means: Pull out all entries having a specified time of day and sort them,
  1388. in order to make a time schedule for the current day the first thing in the
  1389. agenda listing for the day. Of the entries without a time indication, keep
  1390. the grouped in categories, don't sort the categories, but keep them in
  1391. the sequence given in `org-agenda-files'. Within each category sort by
  1392. priority.
  1393. Leaving out `category-keep' would mean that items will be sorted across
  1394. categories by priority.
  1395. Instead of a single list, this can also be a set of list for specific
  1396. contents, with a context symbol in the car of the list, any of
  1397. `agenda', `todo', `tags', `search' for the corresponding agenda views.
  1398. Custom commands can bind this variable in the options section."
  1399. :group 'org-agenda-sorting
  1400. :type `(choice
  1401. (repeat :tag "General" ,org-sorting-choice)
  1402. (list :tag "Individually"
  1403. (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
  1404. (repeat ,org-sorting-choice))
  1405. (cons (const :tag "Strategy for TODO lists" todo)
  1406. (repeat ,org-sorting-choice))
  1407. (cons (const :tag "Strategy for Tags matches" tags)
  1408. (repeat ,org-sorting-choice))
  1409. (cons (const :tag "Strategy for search matches" search)
  1410. (repeat ,org-sorting-choice)))))
  1411. (defcustom org-agenda-cmp-user-defined nil
  1412. "A function to define the comparison `user-defined'.
  1413. This function must receive two arguments, agenda entry a and b.
  1414. If a>b, return +1. If a<b, return -1. If they are equal as seen by
  1415. the user comparison, return nil.
  1416. When this is defined, you can make `user-defined-up' and `user-defined-down'
  1417. part of an agenda sorting strategy."
  1418. :group 'org-agenda-sorting
  1419. :type 'symbol)
  1420. (defcustom org-sort-agenda-notime-is-late t
  1421. "Non-nil means items without time are considered late.
  1422. This is only relevant for sorting. When t, items which have no explicit
  1423. time like 15:30 will be considered as 99:01, i.e. later than any items which
  1424. do have a time. When nil, the default time is before 0:00. You can use this
  1425. option to decide if the schedule for today should come before or after timeless
  1426. agenda entries."
  1427. :group 'org-agenda-sorting
  1428. :type 'boolean)
  1429. (defcustom org-sort-agenda-noeffort-is-high t
  1430. "Non-nil means items without effort estimate are sorted as high effort.
  1431. This also applies when filtering an agenda view with respect to the
  1432. < or > effort operator. Then, tasks with no effort defined will be treated
  1433. as tasks with high effort.
  1434. When nil, such items are sorted as 0 minutes effort."
  1435. :group 'org-agenda-sorting
  1436. :type 'boolean)
  1437. (defgroup org-agenda-line-format nil
  1438. "Options concerning the entry prefix in the Org agenda display."
  1439. :tag "Org Agenda Line Format"
  1440. :group 'org-agenda)
  1441. (defcustom org-agenda-prefix-format
  1442. '((agenda . " %i %-12:c%?-12t% s")
  1443. (timeline . " % s")
  1444. (todo . " %i %-12:c")
  1445. (tags . " %i %-12:c")
  1446. (search . " %i %-12:c"))
  1447. "Format specifications for the prefix of items in the agenda views.
  1448. An alist with five entries, each for the different agenda types. The
  1449. keys of the sublists are `agenda', `timeline', `todo', `search' and `tags'.
  1450. The values are format strings.
  1451. This format works similar to a printf format, with the following meaning:
  1452. %c the category of the item, \"Diary\" for entries from the diary,
  1453. or as given by the CATEGORY keyword or derived from the file name
  1454. %e the effort required by the item
  1455. %l the level of the item (insert X space(s) if item is of level X)
  1456. %i the icon category of the item, see `org-agenda-category-icon-alist'
  1457. %T the last tag of the item (ignore inherited tags, which come first)
  1458. %t the HH:MM time-of-day specification if one applies to the entry
  1459. %s Scheduling/Deadline information, a short string
  1460. %b show breadcrumbs, i.e., the names of the higher levels
  1461. %(expression) Eval EXPRESSION and replace the control string
  1462. by the result
  1463. All specifiers work basically like the standard `%s' of printf, but may
  1464. contain two additional characters: a question mark just after the `%'
  1465. and a whitespace/punctuation character just before the final letter.
  1466. If the first character after `%' is a question mark, the entire field
  1467. will only be included if the corresponding value applies to the current
  1468. entry. This is useful for fields which should have fixed width when
  1469. present, but zero width when absent. For example, \"%?-12t\" will
  1470. result in a 12 character time field if a time of the day is specified,
  1471. but will completely disappear in entries which do not contain a time.
  1472. If there is punctuation or whitespace character just before the
  1473. final format letter, this character will be appended to the field
  1474. value if the value is not empty. For example, the format
  1475. \"%-12:c\" leads to \"Diary: \" if the category is \"Diary\". If
  1476. the category is empty, no additional colon is inserted.
  1477. The default value for the agenda sublist is \" %-12:c%?-12t% s\",
  1478. which means:
  1479. - Indent the line with two space characters
  1480. - Give the category a 12 chars wide field, padded with whitespace on
  1481. the right (because of `-'). Append a colon if there is a category
  1482. (because of `:').
  1483. - If there is a time-of-day, put it into a 12 chars wide field. If no
  1484. time, don't put in an empty field, just skip it (because of '?').
  1485. - Finally, put the scheduling information.
  1486. See also the variables `org-agenda-remove-times-when-in-prefix' and
  1487. `org-agenda-remove-tags'.
  1488. Custom commands can set this variable in the options section."
  1489. :type '(choice
  1490. (string :tag "General format")
  1491. (list :greedy t :tag "View dependent"
  1492. (cons (const agenda) (string :tag "Format"))
  1493. (cons (const timeline) (string :tag "Format"))
  1494. (cons (const todo) (string :tag "Format"))
  1495. (cons (const tags) (string :tag "Format"))
  1496. (cons (const search) (string :tag "Format"))))
  1497. :group 'org-agenda-line-format)
  1498. (defvar org-prefix-format-compiled nil
  1499. "The compiled prefix format and associated variables.
  1500. This is a list where first element is a list of variable bindings, and second
  1501. element is the compiled format expression. See the variable
  1502. `org-agenda-prefix-format'.")
  1503. (defcustom org-agenda-todo-keyword-format "%-1s"
  1504. "Format for the TODO keyword in agenda lines.
  1505. Set this to something like \"%-12s\" if you want all TODO keywords
  1506. to occupy a fixed space in the agenda display."
  1507. :group 'org-agenda-line-format
  1508. :type 'string)
  1509. (defcustom org-agenda-diary-sexp-prefix nil
  1510. "A regexp that matches part of a diary sexp entry
  1511. which should be treated as scheduling/deadline information in
  1512. `org-agenda'.
  1513. For example, you can use this to extract the `diary-remind-message' from
  1514. `diary-remind' entries."
  1515. :group 'org-agenda-line-format
  1516. :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
  1517. (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
  1518. "Text preceding timerange entries in the agenda view.
  1519. This is a list with two strings. The first applies when the range
  1520. is entirely on one day. The second applies if the range spans several days.
  1521. The strings may have two \"%d\" format specifiers which will be filled
  1522. with the sequence number of the days, and the total number of days in the
  1523. range, respectively."
  1524. :group 'org-agenda-line-format
  1525. :type '(list
  1526. (string :tag "Deadline today ")
  1527. (choice :tag "Deadline relative"
  1528. (string :tag "Format string")
  1529. (function))))
  1530. (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
  1531. "Text preceding scheduled items in the agenda view.
  1532. This is a list with two strings. The first applies when the item is
  1533. scheduled on the current day. The second applies when it has been scheduled
  1534. previously, it may contain a %d indicating that this is the nth time that
  1535. this item is scheduled, due to automatic rescheduling of unfinished items
  1536. for the following day. So this number is one larger than the number of days
  1537. that passed since this item was scheduled first."
  1538. :group 'org-agenda-line-format
  1539. :version "24.4"
  1540. :package-version '(Org . "8.0")
  1541. :type '(list
  1542. (string :tag "Scheduled today ")
  1543. (string :tag "Scheduled previously")))
  1544. (defcustom org-agenda-inactive-leader "["
  1545. "Text preceding item pulled into the agenda by inactive time stamps.
  1546. These entries are added to the agenda when pressing \"[\"."
  1547. :group 'org-agenda-line-format
  1548. :version "24.1"
  1549. :type 'string)
  1550. (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: " "%2d d. ago: ")
  1551. "Text preceding deadline items in the agenda view.
  1552. This is a list with three strings. The first applies when the item has its
  1553. deadline on the current day. The second applies when the deadline is in the
  1554. future, the third one when it is in the past. The strings may contain %d
  1555. to capture the number of days."
  1556. :group 'org-agenda-line-format
  1557. :version "24.4"
  1558. :package-version '(Org . "8.0")
  1559. :type '(list
  1560. (string :tag "Deadline today ")
  1561. (string :tag "Deadline in the future ")
  1562. (string :tag "Deadline in the past ")))
  1563. (defcustom org-agenda-remove-times-when-in-prefix t
  1564. "Non-nil means remove duplicate time specifications in agenda items.
  1565. When the format `org-agenda-prefix-format' contains a `%t' specifier, a
  1566. time-of-day specification in a headline or diary entry is extracted and
  1567. placed into the prefix. If this option is non-nil, the original specification
  1568. \(a timestamp or -range, or just a plain time(range) specification like
  1569. 11:30-4pm) will be removed for agenda display. This makes the agenda less
  1570. cluttered.
  1571. The option can be t or nil. It may also be the symbol `beg', indicating
  1572. that the time should only be removed when it is located at the beginning of
  1573. the headline/diary entry."
  1574. :group 'org-agenda-line-format
  1575. :type '(choice
  1576. (const :tag "Always" t)
  1577. (const :tag "Never" nil)
  1578. (const :tag "When at beginning of entry" beg)))
  1579. (defcustom org-agenda-remove-timeranges-from-blocks nil
  1580. "Non-nil means remove time ranges specifications in agenda
  1581. items that span on several days."
  1582. :group 'org-agenda-line-format
  1583. :version "24.1"
  1584. :type 'boolean)
  1585. (defcustom org-agenda-default-appointment-duration nil
  1586. "Default duration for appointments that only have a starting time.
  1587. When nil, no duration is specified in such cases.
  1588. When non-nil, this must be the number of minutes, e.g. 60 for one hour."
  1589. :group 'org-agenda-line-format
  1590. :type '(choice
  1591. (integer :tag "Minutes")
  1592. (const :tag "No default duration")))
  1593. (defcustom org-agenda-show-inherited-tags t
  1594. "Non-nil means show inherited tags in each agenda line.
  1595. When this option is set to `always', it takes precedence over
  1596. `org-agenda-use-tag-inheritance' and inherited tags are shown
  1597. in every agenda.
  1598. When this option is set to t (the default), inherited tags are
  1599. shown when they are available, i.e. when the value of
  1600. `org-agenda-use-tag-inheritance' enables tag inheritance for the
  1601. given agenda type.
  1602. This can be set to a list of agenda types in which the agenda
  1603. must display the inherited tags. Available types are `todo',
  1604. `agenda', `search' and `timeline'.
  1605. When set to nil, never show inherited tags in agenda lines."
  1606. :group 'org-agenda-line-format
  1607. :group 'org-agenda
  1608. :version "24.3"
  1609. :type '(choice
  1610. (const :tag "Show inherited tags when available" t)
  1611. (const :tag "Always show inherited tags" always)
  1612. (repeat :tag "Show inherited tags only in selected agenda types"
  1613. (symbol :tag "Agenda type"))))
  1614. (defcustom org-agenda-use-tag-inheritance '(todo search timeline agenda)
  1615. "List of agenda view types where to use tag inheritance.
  1616. In tags/tags-todo/tags-tree agenda views, tag inheritance is
  1617. controlled by `org-use-tag-inheritance'. In other agenda types,
  1618. `org-use-tag-inheritance' is not used for the selection of the
  1619. agenda entries. Still, you may want the agenda to be aware of
  1620. the inherited tags anyway, e.g. for later tag filtering.
  1621. Allowed value are `todo', `search', `timeline' and `agenda'.
  1622. This variable has no effect if `org-agenda-show-inherited-tags'
  1623. is set to `always'. In that case, the agenda is aware of those
  1624. tags.
  1625. The default value sets tags in every agenda type. Setting this
  1626. option to nil will speed up non-tags agenda view a lot."
  1627. :group 'org-agenda
  1628. :version "24.3"
  1629. :type '(choice
  1630. (const :tag "Use tag inheritance in all agenda types" t)
  1631. (repeat :tag "Use tag inheritance in selected agenda types"
  1632. (symbol :tag "Agenda type"))))
  1633. (defcustom org-agenda-hide-tags-regexp nil
  1634. "Regular expression used to filter away specific tags in agenda views.
  1635. This means that these tags will be present, but not be shown in the agenda
  1636. line. Secondary filtering will still work on the hidden tags.
  1637. Nil means don't hide any tags."
  1638. :group 'org-agenda-line-format
  1639. :type '(choice
  1640. (const :tag "Hide none" nil)
  1641. (string :tag "Regexp ")))
  1642. (defcustom org-agenda-remove-tags nil
  1643. "Non-nil means remove the tags from the headline copy in the agenda.
  1644. When this is the symbol `prefix', only remove tags when
  1645. `org-agenda-prefix-format' contains a `%T' specifier."
  1646. :group 'org-agenda-line-format
  1647. :type '(choice
  1648. (const :tag "Always" t)
  1649. (const :tag "Never" nil)
  1650. (const :tag "When prefix format contains %T" prefix)))
  1651. (defvaralias 'org-agenda-remove-tags-when-in-prefix
  1652. 'org-agenda-remove-tags)
  1653. (defcustom org-agenda-tags-column -80
  1654. "Shift tags in agenda items to this column.
  1655. If this number is positive, it specifies the column. If it is negative,
  1656. it means that the tags should be flushright to that column. For example,
  1657. -80 works well for a normal 80 character screen."
  1658. :group 'org-agenda-line-format
  1659. :type 'integer)
  1660. (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column)
  1661. (defcustom org-agenda-fontify-priorities 'cookies
  1662. "Non-nil means highlight low and high priorities in agenda.
  1663. When t, the highest priority entries are bold, lowest priority italic.
  1664. However, settings in `org-priority-faces' will overrule these faces.
  1665. When this variable is the symbol `cookies', only fontify the
  1666. cookies, not the entire task.
  1667. This may also be an association list of priority faces, whose
  1668. keys are the character values of `org-highest-priority',
  1669. `org-default-priority', and `org-lowest-priority' (the default values
  1670. are ?A, ?B, and ?C, respectively). The face may be a named face, a
  1671. color as a string, or a list like `(:background \"Red\")'.
  1672. If it is a color, the variable `org-faces-easy-properties'
  1673. determines if it is a foreground or a background color."
  1674. :group 'org-agenda-line-format
  1675. :type '(choice
  1676. (const :tag "Never" nil)
  1677. (const :tag "Defaults" t)
  1678. (const :tag "Cookies only" cookies)
  1679. (repeat :tag "Specify"
  1680. (list (character :tag "Priority" :value ?A)
  1681. (choice :tag "Face "
  1682. (string :tag "Color")
  1683. (sexp :tag "Face"))))))
  1684. (defcustom org-agenda-day-face-function nil
  1685. "Function called to determine what face should be used to display a day.
  1686. The only argument passed to that function is the day. It should
  1687. returns a face, or nil if does not want to specify a face and let
  1688. the normal rules apply."
  1689. :group 'org-agenda-line-format
  1690. :version "24.1"
  1691. :type '(choice (const nil) (function)))
  1692. (defcustom org-agenda-category-icon-alist nil
  1693. "Alist of category icon to be displayed in agenda views.
  1694. Each entry should have the following format:
  1695. (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
  1696. Where CATEGORY-REGEXP is a regexp matching the categories where
  1697. the icon should be displayed.
  1698. FILE-OR-DATA either a file path or a string containing image data.
  1699. The other fields can be omitted safely if not needed:
  1700. TYPE indicates the image type.
  1701. DATA-P is a boolean indicating whether the FILE-OR-DATA string is
  1702. image data.
  1703. PROPS are additional image attributes to assign to the image,
  1704. like, e.g. `:ascent center'.
  1705. (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
  1706. If you want to set the display properties yourself, just put a
  1707. list as second element:
  1708. (CATEGORY-REGEXP (MY PROPERTY LIST))
  1709. For example, to display a 16px horizontal space for Emacs
  1710. category, you can use:
  1711. (\"Emacs\" \\='(space . (:width (16))))"
  1712. :group 'org-agenda-line-format
  1713. :version "24.1"
  1714. :type '(alist :key-type (string :tag "Regexp matching category")
  1715. :value-type (choice (list :tag "Icon"
  1716. (string :tag "File or data")
  1717. (symbol :tag "Type")
  1718. (boolean :tag "Data?")
  1719. (repeat :tag "Extra image properties" :inline t symbol))
  1720. (list :tag "Display properties" sexp))))
  1721. (defgroup org-agenda-column-view nil
  1722. "Options concerning column view in the agenda."
  1723. :tag "Org Agenda Column View"
  1724. :group 'org-agenda)
  1725. (defcustom org-agenda-view-columns-initially nil
  1726. "When non-nil, switch to columns view right after creating the agenda."
  1727. :group 'org-agenda-column-view
  1728. :type 'boolean
  1729. :version "26.1"
  1730. :package-version '(Org . "9.0")
  1731. :safe #'booleanp)
  1732. (defcustom org-agenda-columns-show-summaries t
  1733. "Non-nil means show summaries for columns displayed in the agenda view."
  1734. :group 'org-agenda-column-view
  1735. :type 'boolean)
  1736. (defcustom org-agenda-columns-compute-summary-properties t
  1737. "Non-nil means recompute all summary properties before column view.
  1738. When column view in the agenda is listing properties that have a summary
  1739. operator, it can go to all relevant buffers and recompute the summaries
  1740. there. This can mean overhead for the agenda column view, but is necessary
  1741. to have thing up to date.
  1742. As a special case, a CLOCKSUM property also makes sure that the clock
  1743. computations are current."
  1744. :group 'org-agenda-column-view
  1745. :type 'boolean)
  1746. (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
  1747. "Non-nil means the duration of an appointment will add to day effort.
  1748. The property to which appointment durations will be added is the one given
  1749. in the option `org-effort-property'. If an appointment does not have
  1750. an end time, `org-agenda-default-appointment-duration' will be used. If that
  1751. is not set, an appointment without end time will not contribute to the time
  1752. estimate."
  1753. :group 'org-agenda-column-view
  1754. :type 'boolean)
  1755. (defcustom org-agenda-auto-exclude-function nil
  1756. "A function called with a tag to decide if it is filtered on \
  1757. \\<org-agenda-mode-map>`\\[org-agenda-filter-by-tag] RET'.
  1758. The sole argument to the function, which is called once for each
  1759. possible tag, is a string giving the name of the tag. The
  1760. function should return either nil if the tag should be included
  1761. as normal, or \"-<TAG>\" to exclude the tag.
  1762. Note that for the purpose of tag filtering, only the lower-case version of
  1763. all tags will be considered, so that this function will only ever see
  1764. the lower-case version of all tags."
  1765. :group 'org-agenda
  1766. :type '(choice (const nil) (function)))
  1767. (defcustom org-agenda-bulk-custom-functions nil
  1768. "Alist of characters and custom functions for bulk actions.
  1769. For example, this value makes those two functions available:
  1770. \\='((?R set-category)
  1771. (?C bulk-cut))
  1772. With selected entries in an agenda buffer, `B R' will call
  1773. the custom function `set-category' on the selected entries.
  1774. Note that functions in this alist don't need to be quoted."
  1775. :type '(alist :key-type character :value-type (group function))
  1776. :version "24.1"
  1777. :group 'org-agenda)
  1778. (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
  1779. "Execute BODY with point at location given by `org-hd-marker' property.
  1780. If STRING is non-nil, the text property will be fetched from position 0
  1781. in that string. If STRING is nil, it will be fetched from the beginning
  1782. of the current line."
  1783. (org-with-gensyms (marker)
  1784. `(let ((,marker (get-text-property (if ,string 0 (point-at-bol))
  1785. 'org-hd-marker ,string)))
  1786. (with-current-buffer (marker-buffer ,marker)
  1787. (save-excursion
  1788. (goto-char ,marker)
  1789. ,@body)))))
  1790. (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
  1791. (defun org-add-agenda-custom-command (entry)
  1792. "Replace or add a command in `org-agenda-custom-commands'.
  1793. This is mostly for hacking and trying a new command - once the command
  1794. works you probably want to add it to `org-agenda-custom-commands' for good."
  1795. (let ((ass (assoc (car entry) org-agenda-custom-commands)))
  1796. (if ass
  1797. (setcdr ass (cdr entry))
  1798. (push entry org-agenda-custom-commands))))
  1799. ;;; Define the org-agenda-mode
  1800. (defvar org-agenda-mode-map (make-sparse-keymap)
  1801. "Keymap for `org-agenda-mode'.")
  1802. (defvaralias 'org-agenda-keymap 'org-agenda-mode-map)
  1803. (defvar org-agenda-menu) ; defined later in this file.
  1804. (defvar org-agenda-restrict nil) ; defined later in this file.
  1805. (defvar org-agenda-follow-mode nil)
  1806. (defvar org-agenda-entry-text-mode nil)
  1807. (defvar org-agenda-clockreport-mode nil)
  1808. (defvar org-agenda-show-log nil)
  1809. (defvar org-agenda-redo-command nil)
  1810. (defvar org-agenda-query-string nil)
  1811. (defvar org-agenda-mode-hook nil
  1812. "Hook run after `org-agenda-mode' is turned on.
  1813. The buffer is still writable when this hook is called.")
  1814. (defvar org-agenda-type nil)
  1815. (defvar org-agenda-force-single-file nil)
  1816. (defvar org-agenda-bulk-marked-entries nil
  1817. "List of markers that refer to marked entries in the agenda.")
  1818. (defvar org-agenda-current-date nil
  1819. "Active date when building the agenda.")
  1820. ;;; Multiple agenda buffers support
  1821. (defcustom org-agenda-sticky nil
  1822. "Non-nil means agenda q key will bury agenda buffers.
  1823. Agenda commands will then show existing buffer instead of generating new ones.
  1824. When nil, `q' will kill the single agenda buffer."
  1825. :group 'org-agenda
  1826. :version "24.3"
  1827. :type 'boolean)
  1828. ;;;###autoload
  1829. (defun org-toggle-sticky-agenda (&optional arg)
  1830. "Toggle `org-agenda-sticky'."
  1831. (interactive "P")
  1832. (let ((new-value (if arg
  1833. (> (prefix-numeric-value arg) 0)
  1834. (not org-agenda-sticky))))
  1835. (if (equal new-value org-agenda-sticky)
  1836. (and (called-interactively-p 'interactive)
  1837. (message "Sticky agenda was already %s"
  1838. (if org-agenda-sticky "enabled" "disabled")))
  1839. (setq org-agenda-sticky new-value)
  1840. (org-agenda-kill-all-agenda-buffers)
  1841. (and (called-interactively-p 'interactive)
  1842. (message "Sticky agenda %s"
  1843. (if org-agenda-sticky "enabled" "disabled"))))))
  1844. (defvar org-agenda-buffer nil
  1845. "Agenda buffer currently being generated.")
  1846. (defvar org-agenda-last-prefix-arg nil)
  1847. (defvar org-agenda-this-buffer-name nil)
  1848. (defvar org-agenda-doing-sticky-redo nil)
  1849. (defvar org-agenda-this-buffer-is-sticky nil)
  1850. (defvar org-agenda-last-indirect-buffer nil
  1851. "Last buffer loaded by `org-agenda-tree-to-indirect-buffer'.")
  1852. (defconst org-agenda-local-vars
  1853. '(org-agenda-this-buffer-name
  1854. org-agenda-undo-list
  1855. org-agenda-pending-undo-list
  1856. org-agenda-follow-mode
  1857. org-agenda-entry-text-mode
  1858. org-agenda-clockreport-mode
  1859. org-agenda-show-log
  1860. org-agenda-redo-command
  1861. org-agenda-query-string
  1862. org-agenda-type
  1863. org-agenda-bulk-marked-entries
  1864. org-agenda-undo-has-started-in
  1865. org-agenda-info
  1866. org-agenda-pre-window-conf
  1867. org-agenda-columns-active
  1868. org-agenda-tag-filter
  1869. org-agenda-category-filter
  1870. org-agenda-top-headline-filter
  1871. org-agenda-regexp-filter
  1872. org-agenda-effort-filter
  1873. org-agenda-markers
  1874. org-agenda-last-search-view-search-was-boolean
  1875. org-agenda-last-indirect-buffer
  1876. org-agenda-filtered-by-category
  1877. org-agenda-filter-form
  1878. org-agenda-cycle-counter
  1879. org-agenda-last-prefix-arg)
  1880. "Variables that must be local in agenda buffers to allow multiple buffers.")
  1881. (defun org-agenda-mode ()
  1882. "Mode for time-sorted view on action items in Org files.
  1883. The following commands are available:
  1884. \\{org-agenda-mode-map}"
  1885. (interactive)
  1886. (cond (org-agenda-doing-sticky-redo
  1887. ;; Refreshing sticky agenda-buffer
  1888. ;;
  1889. ;; Preserve the value of `org-agenda-local-vars' variables,
  1890. ;; while letting `kill-all-local-variables' kill the rest
  1891. (let ((save (buffer-local-variables)))
  1892. (kill-all-local-variables)
  1893. (mapc 'make-local-variable org-agenda-local-vars)
  1894. (dolist (elem save)
  1895. (let ((var (car elem))
  1896. (val (cdr elem)))
  1897. (when (and val
  1898. (member var org-agenda-local-vars))
  1899. (set var val)))))
  1900. (setq-local org-agenda-this-buffer-is-sticky t))
  1901. (org-agenda-sticky
  1902. ;; Creating a sticky Agenda buffer for the first time
  1903. (kill-all-local-variables)
  1904. (mapc 'make-local-variable org-agenda-local-vars)
  1905. (setq-local org-agenda-this-buffer-is-sticky t))
  1906. (t
  1907. ;; Creating a non-sticky agenda buffer
  1908. (kill-all-local-variables)
  1909. (setq-local org-agenda-this-buffer-is-sticky nil)))
  1910. (setq org-agenda-undo-list nil
  1911. org-agenda-pending-undo-list nil
  1912. org-agenda-bulk-marked-entries nil)
  1913. (setq major-mode 'org-agenda-mode)
  1914. ;; Keep global-font-lock-mode from turning on font-lock-mode
  1915. (setq-local font-lock-global-modes (list 'not major-mode))
  1916. (setq mode-name "Org-Agenda")
  1917. (setq indent-tabs-mode nil)
  1918. (use-local-map org-agenda-mode-map)
  1919. (easy-menu-add org-agenda-menu)
  1920. (if org-startup-truncated (setq truncate-lines t))
  1921. (setq-local line-move-visual nil)
  1922. (add-hook 'post-command-hook 'org-agenda-update-agenda-type nil 'local)
  1923. (add-hook 'pre-command-hook 'org-unhighlight nil 'local)
  1924. ;; Make sure properties are removed when copying text
  1925. (add-hook 'filter-buffer-substring-functions
  1926. (lambda (fun start end delete)
  1927. (substring-no-properties (funcall fun start end delete)))
  1928. nil t)
  1929. (unless org-agenda-keep-modes
  1930. (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
  1931. org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode))
  1932. (setq org-agenda-show-log org-agenda-start-with-log-mode)
  1933. (setq org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode)
  1934. (add-to-invisibility-spec '(org-filtered))
  1935. (add-to-invisibility-spec '(org-link))
  1936. (easy-menu-change
  1937. '("Agenda") "Agenda Files"
  1938. (append
  1939. (list
  1940. (vector
  1941. (if (get 'org-agenda-files 'org-restrict)
  1942. "Restricted to single file"
  1943. "Edit File List")
  1944. '(org-edit-agenda-file-list)
  1945. (not (get 'org-agenda-files 'org-restrict)))
  1946. "--")
  1947. (mapcar 'org-file-menu-entry (org-agenda-files))))
  1948. (org-agenda-set-mode-name)
  1949. (apply
  1950. (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
  1951. (list 'org-agenda-mode-hook)))
  1952. (substitute-key-definition 'undo 'org-agenda-undo
  1953. org-agenda-mode-map global-map)
  1954. (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
  1955. (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
  1956. (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
  1957. (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
  1958. (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
  1959. (org-defkey org-agenda-mode-map [(meta down)] 'org-agenda-drag-line-forward)
  1960. (org-defkey org-agenda-mode-map [(meta up)] 'org-agenda-drag-line-backward)
  1961. (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
  1962. (org-defkey org-agenda-mode-map "\M-m" 'org-agenda-bulk-toggle)
  1963. (org-defkey org-agenda-mode-map "*" 'org-agenda-bulk-mark-all)
  1964. (org-defkey org-agenda-mode-map "\M-*" 'org-agenda-bulk-toggle-all)
  1965. (org-defkey org-agenda-mode-map "#" 'org-agenda-dim-blocked-tasks)
  1966. (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
  1967. (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
  1968. (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-unmark-all)
  1969. (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
  1970. (org-defkey org-agenda-mode-map "k" 'org-agenda-capture)
  1971. (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
  1972. (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
  1973. (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
  1974. (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
  1975. (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
  1976. (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
  1977. (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
  1978. (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
  1979. (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
  1980. (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
  1981. (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
  1982. (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
  1983. (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
  1984. (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
  1985. (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
  1986. (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
  1987. (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
  1988. (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
  1989. (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
  1990. (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
  1991. (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
  1992. (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
  1993. (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
  1994. (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
  1995. (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
  1996. (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
  1997. (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
  1998. (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
  1999. (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
  2000. (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
  2001. (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
  2002. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
  2003. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
  2004. (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
  2005. (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
  2006. (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
  2007. (let ((l '(1 2 3 4 5 6 7 8 9 0)))
  2008. (while l (org-defkey org-agenda-mode-map
  2009. (int-to-string (pop l)) 'digit-argument)))
  2010. (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
  2011. (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
  2012. (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
  2013. (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
  2014. (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
  2015. (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
  2016. (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
  2017. (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
  2018. (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
  2019. (org-defkey org-agenda-mode-map "g" (lambda () (interactive) (org-agenda-redo t)))
  2020. (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
  2021. (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
  2022. (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
  2023. 'org-clock-modify-effort-estimate)
  2024. (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
  2025. (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
  2026. (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
  2027. (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
  2028. (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
  2029. (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
  2030. (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
  2031. (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
  2032. (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
  2033. (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
  2034. (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
  2035. (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
  2036. (substitute-key-definition 'next-line 'org-agenda-next-line
  2037. org-agenda-mode-map global-map)
  2038. (substitute-key-definition 'previous-line 'org-agenda-previous-line
  2039. org-agenda-mode-map global-map)
  2040. (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
  2041. (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
  2042. (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
  2043. (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
  2044. (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
  2045. (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
  2046. (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
  2047. (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
  2048. (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
  2049. (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
  2050. (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
  2051. (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
  2052. (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
  2053. (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
  2054. (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
  2055. (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
  2056. (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
  2057. (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
  2058. (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  2059. (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
  2060. (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
  2061. (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
  2062. (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
  2063. (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
  2064. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
  2065. (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
  2066. (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
  2067. (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
  2068. (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
  2069. (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  2070. (org-defkey org-agenda-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock-from-agenda)
  2071. (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
  2072. (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
  2073. (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
  2074. (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
  2075. (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
  2076. (org-defkey org-agenda-mode-map "_" 'org-agenda-filter-by-effort)
  2077. (org-defkey org-agenda-mode-map "=" 'org-agenda-filter-by-regexp)
  2078. (org-defkey org-agenda-mode-map "|" 'org-agenda-filter-remove-all)
  2079. (org-defkey org-agenda-mode-map "~" 'org-agenda-limit-interactively)
  2080. (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
  2081. (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-headline)
  2082. (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
  2083. (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
  2084. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  2085. (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  2086. (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
  2087. (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
  2088. (define-key org-agenda-mode-map [remap forward-paragraph] 'org-agenda-forward-block)
  2089. (define-key org-agenda-mode-map [remap backward-paragraph] 'org-agenda-backward-block)
  2090. (when org-agenda-mouse-1-follows-link
  2091. (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
  2092. (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
  2093. '("Agenda"
  2094. ("Agenda Files")
  2095. "--"
  2096. ("Agenda Dates"
  2097. ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
  2098. ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
  2099. ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
  2100. ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
  2101. "--"
  2102. ("View"
  2103. ["Day View" org-agenda-day-view
  2104. :active (org-agenda-check-type nil 'agenda)
  2105. :style radio :selected (eq org-agenda-current-span 'day)
  2106. :keys "v d (or just d)"]
  2107. ["Week View" org-agenda-week-view
  2108. :active (org-agenda-check-type nil 'agenda)
  2109. :style radio :selected (eq org-agenda-current-span 'week)
  2110. :keys "v w"]
  2111. ["Fortnight View" org-agenda-fortnight-view
  2112. :active (org-agenda-check-type nil 'agenda)
  2113. :style radio :selected (eq org-agenda-current-span 'fortnight)
  2114. :keys "v t"]
  2115. ["Month View" org-agenda-month-view
  2116. :active (org-agenda-check-type nil 'agenda)
  2117. :style radio :selected (eq org-agenda-current-span 'month)
  2118. :keys "v m"]
  2119. ["Year View" org-agenda-year-view
  2120. :active (org-agenda-check-type nil 'agenda)
  2121. :style radio :selected (eq org-agenda-current-span 'year)
  2122. :keys "v y"]
  2123. "--"
  2124. ["Include Diary" org-agenda-toggle-diary
  2125. :style toggle :selected org-agenda-include-diary
  2126. :active (org-agenda-check-type nil 'agenda)]
  2127. ["Include Deadlines" org-agenda-toggle-deadlines
  2128. :style toggle :selected org-agenda-include-deadlines
  2129. :active (org-agenda-check-type nil 'agenda)]
  2130. ["Use Time Grid" org-agenda-toggle-time-grid
  2131. :style toggle :selected org-agenda-use-time-grid
  2132. :active (org-agenda-check-type nil 'agenda)]
  2133. "--"
  2134. ["Show clock report" org-agenda-clockreport-mode
  2135. :style toggle :selected org-agenda-clockreport-mode
  2136. :active (org-agenda-check-type nil 'agenda)]
  2137. ["Show some entry text" org-agenda-entry-text-mode
  2138. :style toggle :selected org-agenda-entry-text-mode
  2139. :active t]
  2140. "--"
  2141. ["Show Logbook entries" org-agenda-log-mode
  2142. :style toggle :selected org-agenda-show-log
  2143. :active (org-agenda-check-type nil 'agenda 'timeline)
  2144. :keys "v l (or just l)"]
  2145. ["Include archived trees" org-agenda-archives-mode
  2146. :style toggle :selected org-agenda-archives-mode :active t
  2147. :keys "v a"]
  2148. ["Include archive files" (org-agenda-archives-mode t)
  2149. :style toggle :selected (eq org-agenda-archives-mode t) :active t
  2150. :keys "v A"]
  2151. "--"
  2152. ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
  2153. ["Write view to file" org-agenda-write t]
  2154. ["Rebuild buffer" org-agenda-redo t]
  2155. ["Save all Org buffers" org-save-all-org-buffers t]
  2156. "--"
  2157. ["Show original entry" org-agenda-show t]
  2158. ["Go To (other window)" org-agenda-goto t]
  2159. ["Go To (this window)" org-agenda-switch-to t]
  2160. ["Capture with cursor date" org-agenda-capture t]
  2161. ["Follow Mode" org-agenda-follow-mode
  2162. :style toggle :selected org-agenda-follow-mode :active t]
  2163. ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
  2164. "--"
  2165. ("TODO"
  2166. ["Cycle TODO" org-agenda-todo t]
  2167. ["Next TODO set" org-agenda-todo-nextset t]
  2168. ["Previous TODO set" org-agenda-todo-previousset t]
  2169. ["Add note" org-agenda-add-note t])
  2170. ("Archive/Refile/Delete"
  2171. ["Archive default" org-agenda-archive-default t]
  2172. ["Archive default" org-agenda-archive-default-with-confirmation t]
  2173. ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
  2174. ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
  2175. ["Archive subtree" org-agenda-archive t]
  2176. "--"
  2177. ["Refile" org-agenda-refile t]
  2178. "--"
  2179. ["Delete subtree" org-agenda-kill t])
  2180. ("Bulk action"
  2181. ["Mark entry" org-agenda-bulk-mark t]
  2182. ["Mark all" org-agenda-bulk-mark-all t]
  2183. ["Unmark entry" org-agenda-bulk-unmark t]
  2184. ["Unmark all" org-agenda-bulk-unmark-all :active t :keys "U"]
  2185. ["Toggle mark" org-agenda-bulk-toggle t]
  2186. ["Toggle all" org-agenda-bulk-toggle-all t]
  2187. ["Mark regexp" org-agenda-bulk-mark-regexp t])
  2188. ["Act on all marked" org-agenda-bulk-action t]
  2189. "--"
  2190. ("Tags and Properties"
  2191. ["Show all Tags" org-agenda-show-tags t]
  2192. ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
  2193. ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
  2194. "--"
  2195. ["Column View" org-columns t])
  2196. ("Deadline/Schedule"
  2197. ["Schedule" org-agenda-schedule t]
  2198. ["Set Deadline" org-agenda-deadline t]
  2199. "--"
  2200. ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
  2201. ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
  2202. ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
  2203. ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
  2204. ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
  2205. ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
  2206. ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
  2207. ("Clock and Effort"
  2208. ["Clock in" org-agenda-clock-in t]
  2209. ["Clock out" org-agenda-clock-out t]
  2210. ["Clock cancel" org-agenda-clock-cancel t]
  2211. ["Goto running clock" org-clock-goto t]
  2212. "--"
  2213. ["Set Effort" org-agenda-set-effort t]
  2214. ["Change clocked effort" org-clock-modify-effort-estimate
  2215. (org-clock-is-active)])
  2216. ("Priority"
  2217. ["Set Priority" org-agenda-priority t]
  2218. ["Increase Priority" org-agenda-priority-up t]
  2219. ["Decrease Priority" org-agenda-priority-down t]
  2220. ["Show Priority" org-show-priority t])
  2221. ("Calendar/Diary"
  2222. ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
  2223. ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
  2224. ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
  2225. ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
  2226. ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
  2227. ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
  2228. "--"
  2229. ["Create iCalendar File" org-icalendar-combine-agenda-files t])
  2230. "--"
  2231. ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
  2232. "--"
  2233. ("MobileOrg"
  2234. ["Push Files and Views" org-mobile-push t]
  2235. ["Get Captured and Flagged" org-mobile-pull t]
  2236. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
  2237. ["Show note / unflag" org-agenda-show-the-flagging-note t]
  2238. "--"
  2239. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  2240. "--"
  2241. ["Quit" org-agenda-quit t]
  2242. ["Exit and Release Buffers" org-agenda-exit t]
  2243. ))
  2244. ;;; Agenda undo
  2245. (defvar org-agenda-allow-remote-undo t
  2246. "Non-nil means allow remote undo from the agenda buffer.")
  2247. (defvar org-agenda-undo-has-started-in nil
  2248. "Buffers that have already seen `undo-start' in the current undo sequence.")
  2249. (defun org-agenda-undo ()
  2250. "Undo a remote editing step in the agenda.
  2251. This undoes changes both in the agenda buffer and in the remote buffer
  2252. that have been changed along."
  2253. (interactive)
  2254. (or org-agenda-allow-remote-undo
  2255. (user-error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
  2256. (if (not (eq this-command last-command))
  2257. (setq org-agenda-undo-has-started-in nil
  2258. org-agenda-pending-undo-list org-agenda-undo-list))
  2259. (if (not org-agenda-pending-undo-list)
  2260. (user-error "No further undo information"))
  2261. (let* ((entry (pop org-agenda-pending-undo-list))
  2262. buf line cmd rembuf)
  2263. (setq cmd (pop entry) line (pop entry))
  2264. (setq rembuf (nth 2 entry))
  2265. (org-with-remote-undo rembuf
  2266. (while (bufferp (setq buf (pop entry)))
  2267. (if (pop entry)
  2268. (with-current-buffer buf
  2269. (let ((last-undo-buffer buf)
  2270. (inhibit-read-only t))
  2271. (unless (memq buf org-agenda-undo-has-started-in)
  2272. (push buf org-agenda-undo-has-started-in)
  2273. (make-local-variable 'pending-undo-list)
  2274. (undo-start))
  2275. (while (and pending-undo-list
  2276. (listp pending-undo-list)
  2277. (not (car pending-undo-list)))
  2278. (pop pending-undo-list))
  2279. (undo-more 1))))))
  2280. (org-goto-line line)
  2281. (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
  2282. (defun org-verify-change-for-undo (l1 l2)
  2283. "Verify that a real change occurred between the undo lists L1 and L2."
  2284. (while (and l1 (listp l1) (null (car l1))) (pop l1))
  2285. (while (and l2 (listp l2) (null (car l2))) (pop l2))
  2286. (not (eq l1 l2)))
  2287. ;;; Agenda dispatch
  2288. (defvar org-agenda-restrict-begin (make-marker))
  2289. (defvar org-agenda-restrict-end (make-marker))
  2290. (defvar org-agenda-last-dispatch-buffer nil)
  2291. (defvar org-agenda-overriding-restriction nil)
  2292. (defcustom org-agenda-custom-commands-contexts nil
  2293. "Alist of custom agenda keys and contextual rules.
  2294. For example, if you have a custom agenda command \"p\" and you
  2295. want this command to be accessible only from plain text files,
  2296. use this:
  2297. \\='((\"p\" ((in-file . \"\\\\.txt\\\\'\"))))
  2298. Here are the available contexts definitions:
  2299. in-file: command displayed only in matching files
  2300. in-mode: command displayed only in matching modes
  2301. not-in-file: command not displayed in matching files
  2302. not-in-mode: command not displayed in matching modes
  2303. in-buffer: command displayed only in matching buffers
  2304. not-in-buffer: command not displayed in matching buffers
  2305. [function]: a custom function taking no argument
  2306. If you define several checks, the agenda command will be
  2307. accessible if there is at least one valid check.
  2308. You can also bind a key to another agenda custom command
  2309. depending on contextual rules.
  2310. \\='((\"p\" \"q\" ((in-file . \"\\\\.txt\\\\'\"))))
  2311. Here it means: in .txt files, use \"p\" as the key for the
  2312. agenda command otherwise associated with \"q\". (The command
  2313. originally associated with \"q\" is not displayed to avoid
  2314. duplicates.)"
  2315. :version "24.3"
  2316. :group 'org-agenda-custom-commands
  2317. :type '(repeat (list :tag "Rule"
  2318. (string :tag " Agenda key")
  2319. (string :tag "Replace by command")
  2320. (repeat :tag "Available when"
  2321. (choice
  2322. (cons :tag "Condition"
  2323. (choice
  2324. (const :tag "In file" in-file)
  2325. (const :tag "Not in file" not-in-file)
  2326. (const :tag "In buffer" in-buffer)
  2327. (const :tag "Not in buffer" not-in-buffer)
  2328. (const :tag "In mode" in-mode)
  2329. (const :tag "Not in mode" not-in-mode))
  2330. (regexp))
  2331. (function :tag "Custom function"))))))
  2332. (defcustom org-agenda-max-entries nil
  2333. "Maximum number of entries to display in an agenda.
  2334. This can be nil (no limit) or an integer or an alist of agenda
  2335. types with an associated number of entries to display in this
  2336. type."
  2337. :version "24.4"
  2338. :package-version '(Org . "8.0")
  2339. :group 'org-agenda-custom-commands
  2340. :type '(choice (symbol :tag "No limit" nil)
  2341. (integer :tag "Max number of entries")
  2342. (repeat
  2343. (cons (choice :tag "Agenda type"
  2344. (const agenda)
  2345. (const todo)
  2346. (const tags)
  2347. (const search)
  2348. (const timeline))
  2349. (integer :tag "Max number of entries")))))
  2350. (defcustom org-agenda-max-todos nil
  2351. "Maximum number of TODOs to display in an agenda.
  2352. This can be nil (no limit) or an integer or an alist of agenda
  2353. types with an associated number of entries to display in this
  2354. type."
  2355. :version "24.4"
  2356. :package-version '(Org . "8.0")
  2357. :group 'org-agenda-custom-commands
  2358. :type '(choice (symbol :tag "No limit" nil)
  2359. (integer :tag "Max number of TODOs")
  2360. (repeat
  2361. (cons (choice :tag "Agenda type"
  2362. (const agenda)
  2363. (const todo)
  2364. (const tags)
  2365. (const search)
  2366. (const timeline))
  2367. (integer :tag "Max number of TODOs")))))
  2368. (defcustom org-agenda-max-tags nil
  2369. "Maximum number of tagged entries to display in an agenda.
  2370. This can be nil (no limit) or an integer or an alist of agenda
  2371. types with an associated number of entries to display in this
  2372. type."
  2373. :version "24.4"
  2374. :package-version '(Org . "8.0")
  2375. :group 'org-agenda-custom-commands
  2376. :type '(choice (symbol :tag "No limit" nil)
  2377. (integer :tag "Max number of tagged entries")
  2378. (repeat
  2379. (cons (choice :tag "Agenda type"
  2380. (const agenda)
  2381. (const todo)
  2382. (const tags)
  2383. (const search)
  2384. (const timeline))
  2385. (integer :tag "Max number of tagged entries")))))
  2386. (defcustom org-agenda-max-effort nil
  2387. "Maximum cumulated effort duration for the agenda.
  2388. This can be nil (no limit) or a number of minutes (as an integer)
  2389. or an alist of agenda types with an associated number of minutes
  2390. to limit entries to in this type."
  2391. :version "24.4"
  2392. :package-version '(Org . "8.0")
  2393. :group 'org-agenda-custom-commands
  2394. :type '(choice (symbol :tag "No limit" nil)
  2395. (integer :tag "Max number of minutes")
  2396. (repeat
  2397. (cons (choice :tag "Agenda type"
  2398. (const agenda)
  2399. (const todo)
  2400. (const tags)
  2401. (const search)
  2402. (const timeline))
  2403. (integer :tag "Max number of minutes")))))
  2404. (defvar org-agenda-keep-restricted-file-list nil)
  2405. (defvar org-keys nil)
  2406. (defvar org-match nil)
  2407. ;;;###autoload
  2408. (defun org-agenda (&optional arg org-keys restriction)
  2409. "Dispatch agenda commands to collect entries to the agenda buffer.
  2410. Prompts for a command to execute. Any prefix arg will be passed
  2411. on to the selected command. The default selections are:
  2412. a Call `org-agenda-list' to display the agenda for current day or week.
  2413. t Call `org-todo-list' to display the global todo list.
  2414. T Call `org-todo-list' to display the global todo list, select only
  2415. entries with a specific TODO keyword (the user gets a prompt).
  2416. m Call `org-tags-view' to display headlines with tags matching
  2417. a condition (the user is prompted for the condition).
  2418. M Like `m', but select only TODO entries, no ordinary headlines.
  2419. e Export views to associated files.
  2420. s Search entries for keywords.
  2421. S Search entries for keywords, only with TODO keywords.
  2422. / Multi occur across all agenda files and also files listed
  2423. in `org-agenda-text-search-extra-files'.
  2424. < Restrict agenda commands to buffer, subtree, or region.
  2425. Press several times to get the desired effect.
  2426. > Remove a previous restriction.
  2427. # List \"stuck\" projects.
  2428. ! Configure what \"stuck\" means.
  2429. C Configure custom agenda commands.
  2430. More commands can be added by configuring the variable
  2431. `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
  2432. searches can be pre-defined in this way.
  2433. If the current buffer is in Org mode and visiting a file, you can also
  2434. first press `<' once to indicate that the agenda should be temporarily
  2435. \(until the next use of `\\[org-agenda]') restricted to the current file.
  2436. Pressing `<' twice means to restrict to the current subtree or region
  2437. \(if active)."
  2438. (interactive "P")
  2439. (catch 'exit
  2440. (let* ((prefix-descriptions nil)
  2441. (org-agenda-buffer-name org-agenda-buffer-name)
  2442. (org-agenda-window-setup (if (equal (buffer-name)
  2443. org-agenda-buffer-name)
  2444. 'current-window
  2445. org-agenda-window-setup))
  2446. (org-agenda-custom-commands-orig org-agenda-custom-commands)
  2447. (org-agenda-custom-commands
  2448. ;; normalize different versions
  2449. (delq nil
  2450. (mapcar
  2451. (lambda (x)
  2452. (cond ((stringp (cdr x))
  2453. (push x prefix-descriptions)
  2454. nil)
  2455. ((stringp (nth 1 x)) x)
  2456. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2457. (t (cons (car x) (cons "" (cdr x))))))
  2458. org-agenda-custom-commands)))
  2459. (org-agenda-custom-commands
  2460. (org-contextualize-keys
  2461. org-agenda-custom-commands org-agenda-custom-commands-contexts))
  2462. (buf (current-buffer))
  2463. (bfn (buffer-file-name (buffer-base-buffer)))
  2464. entry key type org-match lprops ans)
  2465. ;; Turn off restriction unless there is an overriding one,
  2466. (unless org-agenda-overriding-restriction
  2467. (unless org-agenda-keep-restricted-file-list
  2468. ;; There is a request to keep the file list in place
  2469. (put 'org-agenda-files 'org-restrict nil))
  2470. (setq org-agenda-restrict nil)
  2471. (move-marker org-agenda-restrict-begin nil)
  2472. (move-marker org-agenda-restrict-end nil))
  2473. ;; Delete old local properties
  2474. (put 'org-agenda-redo-command 'org-lprops nil)
  2475. ;; Delete previously set last-arguments
  2476. (put 'org-agenda-redo-command 'last-args nil)
  2477. ;; Remember where this call originated
  2478. (setq org-agenda-last-dispatch-buffer (current-buffer))
  2479. (unless org-keys
  2480. (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
  2481. org-keys (car ans)
  2482. restriction (cdr ans)))
  2483. ;; If we have sticky agenda buffers, set a name for the buffer,
  2484. ;; depending on the invoking keys. The user may still set this
  2485. ;; as a command option, which will overwrite what we do here.
  2486. (if org-agenda-sticky
  2487. (setq org-agenda-buffer-name
  2488. (format "*Org Agenda(%s)*" org-keys)))
  2489. ;; Establish the restriction, if any
  2490. (when (and (not org-agenda-overriding-restriction) restriction)
  2491. (put 'org-agenda-files 'org-restrict (list bfn))
  2492. (cond
  2493. ((eq restriction 'region)
  2494. (setq org-agenda-restrict (current-buffer))
  2495. (move-marker org-agenda-restrict-begin (region-beginning))
  2496. (move-marker org-agenda-restrict-end (region-end)))
  2497. ((eq restriction 'subtree)
  2498. (save-excursion
  2499. (setq org-agenda-restrict (current-buffer))
  2500. (org-back-to-heading t)
  2501. (move-marker org-agenda-restrict-begin (point))
  2502. (move-marker org-agenda-restrict-end
  2503. (progn (org-end-of-subtree t)))))))
  2504. ;; For example the todo list should not need it (but does...)
  2505. (cond
  2506. ((setq entry (assoc org-keys org-agenda-custom-commands))
  2507. (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
  2508. (progn
  2509. (setq type (nth 2 entry) org-match (eval (nth 3 entry))
  2510. lprops (nth 4 entry))
  2511. (if org-agenda-sticky
  2512. (setq org-agenda-buffer-name
  2513. (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
  2514. (format "*Org Agenda(%s)*" org-keys))))
  2515. (put 'org-agenda-redo-command 'org-lprops lprops)
  2516. (cond
  2517. ((eq type 'agenda)
  2518. (org-let lprops '(org-agenda-list current-prefix-arg)))
  2519. ((eq type 'agenda*)
  2520. (org-let lprops '(org-agenda-list current-prefix-arg nil nil t)))
  2521. ((eq type 'alltodo)
  2522. (org-let lprops '(org-todo-list current-prefix-arg)))
  2523. ((eq type 'search)
  2524. (org-let lprops '(org-search-view current-prefix-arg org-match nil)))
  2525. ((eq type 'stuck)
  2526. (org-let lprops '(org-agenda-list-stuck-projects
  2527. current-prefix-arg)))
  2528. ((eq type 'tags)
  2529. (org-let lprops '(org-tags-view current-prefix-arg org-match)))
  2530. ((eq type 'tags-todo)
  2531. (org-let lprops '(org-tags-view current-prefix-arg org-match)))
  2532. ((eq type 'todo)
  2533. (org-let lprops '(org-todo-list org-match)))
  2534. ((eq type 'tags-tree)
  2535. (org-check-for-org-mode)
  2536. (org-let lprops '(org-match-sparse-tree current-prefix-arg org-match)))
  2537. ((eq type 'todo-tree)
  2538. (org-check-for-org-mode)
  2539. (org-let lprops
  2540. '(org-occur (concat "^" org-outline-regexp "[ \t]*"
  2541. (regexp-quote org-match) "\\>"))))
  2542. ((eq type 'occur-tree)
  2543. (org-check-for-org-mode)
  2544. (org-let lprops '(org-occur org-match)))
  2545. ((functionp type)
  2546. (org-let lprops '(funcall type org-match)))
  2547. ((fboundp type)
  2548. (org-let lprops '(funcall type org-match)))
  2549. (t (user-error "Invalid custom agenda command type %s" type))))
  2550. (org-agenda-run-series (nth 1 entry) (cddr entry))))
  2551. ((equal org-keys "C")
  2552. (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
  2553. (customize-variable 'org-agenda-custom-commands))
  2554. ((equal org-keys "a") (call-interactively 'org-agenda-list))
  2555. ((equal org-keys "s") (call-interactively 'org-search-view))
  2556. ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
  2557. ((equal org-keys "t") (call-interactively 'org-todo-list))
  2558. ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
  2559. ((equal org-keys "m") (call-interactively 'org-tags-view))
  2560. ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
  2561. ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
  2562. ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
  2563. (add-hook
  2564. 'post-command-hook
  2565. (lambda ()
  2566. (unless (current-message)
  2567. (let* ((m (org-agenda-get-any-marker))
  2568. (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
  2569. (when note
  2570. (message (concat
  2571. "FLAGGING-NOTE ([?] for more info): "
  2572. (org-add-props
  2573. (replace-regexp-in-string
  2574. "\\\\n" "//"
  2575. (copy-sequence note))
  2576. nil 'face 'org-warning)))))))
  2577. t t))
  2578. ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
  2579. ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
  2580. ((equal org-keys "!") (customize-variable 'org-stuck-projects))
  2581. (t (user-error "Invalid agenda key"))))))
  2582. (defvar org-agenda-multi)
  2583. (defun org-agenda-append-agenda ()
  2584. "Append another agenda view to the current one.
  2585. This function allows interactive building of block agendas.
  2586. Agenda views are separated by `org-agenda-block-separator'."
  2587. (interactive)
  2588. (unless (derived-mode-p 'org-agenda-mode)
  2589. (user-error "Can only append from within agenda buffer"))
  2590. (let ((org-agenda-multi t))
  2591. (org-agenda)
  2592. (widen)
  2593. (org-agenda-finalize)
  2594. (setq buffer-read-only t)
  2595. (org-agenda-fit-window-to-buffer)))
  2596. (defun org-agenda-normalize-custom-commands (cmds)
  2597. "Normalize custom commands CMDS."
  2598. (delq nil
  2599. (mapcar
  2600. (lambda (x)
  2601. (cond ((stringp (cdr x)) nil)
  2602. ((stringp (nth 1 x)) x)
  2603. ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
  2604. (t (cons (car x) (cons "" (cdr x))))))
  2605. cmds)))
  2606. (defun org-agenda-get-restriction-and-command (prefix-descriptions)
  2607. "The user interface for selecting an agenda command."
  2608. (catch 'exit
  2609. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  2610. (restrict-ok (and bfn (derived-mode-p 'org-mode)))
  2611. (region-p (org-region-active-p))
  2612. (custom org-agenda-custom-commands)
  2613. (selstring "")
  2614. restriction second-time
  2615. c entry key type match prefixes rmheader header-end custom1 desc
  2616. line lines left right n n1)
  2617. (save-window-excursion
  2618. (delete-other-windows)
  2619. (org-switch-to-buffer-other-window " *Agenda Commands*")
  2620. (erase-buffer)
  2621. (insert (eval-when-compile
  2622. (let ((header
  2623. "Press key for an agenda command:
  2624. -------------------------------- < Buffer, subtree/region restriction
  2625. a Agenda for current week or day > Remove restriction
  2626. t List of all TODO entries e Export agenda views
  2627. m Match a TAGS/PROP/TODO query T Entries with special TODO kwd
  2628. s Search for keywords M Like m, but only TODO entries
  2629. / Multi-occur S Like s, but only TODO entries
  2630. ? Find :FLAGGED: entries C Configure custom agenda commands
  2631. * Toggle sticky agenda views # List stuck projects (!=configure)
  2632. ")
  2633. (start 0))
  2634. (while (string-match
  2635. "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
  2636. header start)
  2637. (setq start (match-end 0))
  2638. (add-text-properties (match-beginning 2) (match-end 2)
  2639. '(face bold) header))
  2640. header)))
  2641. (setq header-end (point-marker))
  2642. (while t
  2643. (setq custom1 custom)
  2644. (when (eq rmheader t)
  2645. (org-goto-line 1)
  2646. (re-search-forward ":" nil t)
  2647. (delete-region (match-end 0) (point-at-eol))
  2648. (forward-char 1)
  2649. (looking-at "-+")
  2650. (delete-region (match-end 0) (point-at-eol))
  2651. (move-marker header-end (match-end 0)))
  2652. (goto-char header-end)
  2653. (delete-region (point) (point-max))
  2654. ;; Produce all the lines that describe custom commands and prefixes
  2655. (setq lines nil)
  2656. (while (setq entry (pop custom1))
  2657. (setq key (car entry) desc (nth 1 entry)
  2658. type (nth 2 entry)
  2659. match (nth 3 entry))
  2660. (if (> (length key) 1)
  2661. (cl-pushnew (string-to-char key) prefixes :test #'equal)
  2662. (setq line
  2663. (format
  2664. "%-4s%-14s"
  2665. (org-add-props (copy-sequence key)
  2666. '(face bold))
  2667. (cond
  2668. ((string-match "\\S-" desc) desc)
  2669. ((eq type 'agenda) "Agenda for current week or day")
  2670. ((eq type 'agenda*) "Appointments for current week or day")
  2671. ((eq type 'alltodo) "List of all TODO entries")
  2672. ((eq type 'search) "Word search")
  2673. ((eq type 'stuck) "List of stuck projects")
  2674. ((eq type 'todo) "TODO keyword")
  2675. ((eq type 'tags) "Tags query")
  2676. ((eq type 'tags-todo) "Tags (TODO)")
  2677. ((eq type 'tags-tree) "Tags tree")
  2678. ((eq type 'todo-tree) "TODO kwd tree")
  2679. ((eq type 'occur-tree) "Occur tree")
  2680. ((functionp type) (if (symbolp type)
  2681. (symbol-name type)
  2682. "Lambda expression"))
  2683. (t "???"))))
  2684. (if org-agenda-menu-show-matcher
  2685. (setq line
  2686. (concat line ": "
  2687. (cond
  2688. ((stringp match)
  2689. (setq match (copy-sequence match))
  2690. (org-add-props match nil 'face 'org-warning))
  2691. ((listp type)
  2692. (format "set of %d commands" (length type))))))
  2693. (if (org-string-nw-p match)
  2694. (add-text-properties
  2695. 0 (length line) (list 'help-echo
  2696. (concat "Matcher: " match)) line)))
  2697. (push line lines)))
  2698. (setq lines (nreverse lines))
  2699. (when prefixes
  2700. (mapc (lambda (x)
  2701. (push
  2702. (format "%s %s"
  2703. (org-add-props (char-to-string x)
  2704. nil 'face 'bold)
  2705. (or (cdr (assoc (concat selstring
  2706. (char-to-string x))
  2707. prefix-descriptions))
  2708. "Prefix key"))
  2709. lines))
  2710. prefixes))
  2711. ;; Check if we should display in two columns
  2712. (if org-agenda-menu-two-columns
  2713. (progn
  2714. (setq n (length lines)
  2715. n1 (+ (/ n 2) (mod n 2))
  2716. right (nthcdr n1 lines)
  2717. left (copy-sequence lines))
  2718. (setcdr (nthcdr (1- n1) left) nil))
  2719. (setq left lines right nil))
  2720. (while left
  2721. (insert "\n" (pop left))
  2722. (when right
  2723. (if (< (current-column) 40)
  2724. (move-to-column 40 t)
  2725. (insert " "))
  2726. (insert (pop right))))
  2727. ;; Make the window the right size
  2728. (goto-char (point-min))
  2729. (if second-time
  2730. (if (not (pos-visible-in-window-p (point-max)))
  2731. (org-fit-window-to-buffer))
  2732. (setq second-time t)
  2733. (org-fit-window-to-buffer))
  2734. ;; Ask for selection
  2735. (message "Press key for agenda command%s:"
  2736. (if (or restrict-ok org-agenda-overriding-restriction)
  2737. (if org-agenda-overriding-restriction
  2738. " (restriction lock active)"
  2739. (if restriction
  2740. (format " (restricted to %s)" restriction)
  2741. " (unrestricted)"))
  2742. ""))
  2743. (setq c (read-char-exclusive))
  2744. (message "")
  2745. (cond
  2746. ((assoc (char-to-string c) custom)
  2747. (setq selstring (concat selstring (char-to-string c)))
  2748. (throw 'exit (cons selstring restriction)))
  2749. ((memq c prefixes)
  2750. (setq selstring (concat selstring (char-to-string c))
  2751. prefixes nil
  2752. rmheader (or rmheader t)
  2753. custom (delq nil (mapcar
  2754. (lambda (x)
  2755. (if (or (= (length (car x)) 1)
  2756. (/= (string-to-char (car x)) c))
  2757. nil
  2758. (cons (substring (car x) 1) (cdr x))))
  2759. custom))))
  2760. ((eq c ?*)
  2761. (call-interactively 'org-toggle-sticky-agenda)
  2762. (sit-for 2))
  2763. ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
  2764. (message "Restriction is only possible in Org buffers")
  2765. (ding) (sit-for 1))
  2766. ((eq c ?1)
  2767. (org-agenda-remove-restriction-lock 'noupdate)
  2768. (setq restriction 'buffer))
  2769. ((eq c ?0)
  2770. (org-agenda-remove-restriction-lock 'noupdate)
  2771. (setq restriction (if region-p 'region 'subtree)))
  2772. ((eq c ?<)
  2773. (org-agenda-remove-restriction-lock 'noupdate)
  2774. (setq restriction
  2775. (cond
  2776. ((eq restriction 'buffer)
  2777. (if region-p 'region 'subtree))
  2778. ((memq restriction '(subtree region))
  2779. nil)
  2780. (t 'buffer))))
  2781. ((eq c ?>)
  2782. (org-agenda-remove-restriction-lock 'noupdate)
  2783. (setq restriction nil))
  2784. ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
  2785. (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
  2786. ((and (> (length selstring) 0) (eq c ?\d))
  2787. (delete-window)
  2788. (org-agenda-get-restriction-and-command prefix-descriptions))
  2789. ((equal c ?q) (error "Abort"))
  2790. (t (user-error "Invalid key %c" c))))))))
  2791. (defun org-agenda-fit-window-to-buffer ()
  2792. "Fit the window to the buffer size."
  2793. (and (memq org-agenda-window-setup '(reorganize-frame))
  2794. (fboundp 'fit-window-to-buffer)
  2795. (if (and (= (cdr org-agenda-window-frame-fractions) 1.0)
  2796. (= (car org-agenda-window-frame-fractions) 1.0))
  2797. (delete-other-windows)
  2798. (org-fit-window-to-buffer
  2799. nil
  2800. (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
  2801. (floor (* (frame-height) (car org-agenda-window-frame-fractions)))))))
  2802. (defvar org-cmd nil)
  2803. (defvar org-agenda-overriding-cmd nil)
  2804. (defvar org-agenda-overriding-arguments nil)
  2805. (defvar org-agenda-overriding-cmd-arguments nil)
  2806. (defun org-agenda-run-series (name series)
  2807. "Run agenda NAME as a SERIES of agenda commands."
  2808. (org-let (nth 1 series) '(org-agenda-prepare name))
  2809. ;; We need to reset agenda markers here, because when constructing a
  2810. ;; block agenda, the individual blocks do not do that.
  2811. (org-agenda-reset-markers)
  2812. (let* ((org-agenda-multi t)
  2813. (redo (list 'org-agenda-run-series name (list 'quote series)))
  2814. (cmds (car series))
  2815. (gprops (nth 1 series))
  2816. match ;; The byte compiler incorrectly complains about this. Keep it!
  2817. org-cmd type lprops)
  2818. (while (setq org-cmd (pop cmds))
  2819. (setq type (car org-cmd))
  2820. (setq match (eval (nth 1 org-cmd)))
  2821. (setq lprops (nth 2 org-cmd))
  2822. (let ((org-agenda-overriding-arguments
  2823. (if (eq org-agenda-overriding-cmd org-cmd)
  2824. (or org-agenda-overriding-arguments
  2825. org-agenda-overriding-cmd-arguments))))
  2826. (cond
  2827. ((eq type 'agenda)
  2828. (org-let2 gprops lprops
  2829. '(call-interactively 'org-agenda-list)))
  2830. ((eq type 'agenda*)
  2831. (org-let2 gprops lprops
  2832. '(funcall 'org-agenda-list nil nil t)))
  2833. ((eq type 'alltodo)
  2834. (org-let2 gprops lprops
  2835. '(call-interactively 'org-todo-list)))
  2836. ((eq type 'search)
  2837. (org-let2 gprops lprops
  2838. '(org-search-view current-prefix-arg match nil)))
  2839. ((eq type 'stuck)
  2840. (org-let2 gprops lprops
  2841. '(call-interactively 'org-agenda-list-stuck-projects)))
  2842. ((eq type 'tags)
  2843. (org-let2 gprops lprops
  2844. '(org-tags-view current-prefix-arg match)))
  2845. ((eq type 'tags-todo)
  2846. (org-let2 gprops lprops
  2847. '(org-tags-view current-prefix-arg match)))
  2848. ((eq type 'todo)
  2849. (org-let2 gprops lprops
  2850. '(org-todo-list match)))
  2851. ((fboundp type)
  2852. (org-let2 gprops lprops
  2853. '(funcall type match)))
  2854. (t (error "Invalid type in command series")))))
  2855. (widen)
  2856. (let ((inhibit-read-only t))
  2857. (add-text-properties (point-min) (point-max)
  2858. `(org-series t org-series-redo-cmd ,redo)))
  2859. (setq org-agenda-redo-command redo)
  2860. (goto-char (point-min)))
  2861. (org-agenda-fit-window-to-buffer)
  2862. (org-let (nth 1 series) '(org-agenda-finalize)))
  2863. ;;;###autoload
  2864. (defmacro org-batch-agenda (cmd-key &rest parameters)
  2865. "Run an agenda command in batch mode and send the result to STDOUT.
  2866. If CMD-KEY is a string of length 1, it is used as a key in
  2867. `org-agenda-custom-commands' and triggers this command. If it is a
  2868. longer string it is used as a tags/todo match string.
  2869. Parameters are alternating variable names and values that will be bound
  2870. before running the agenda command."
  2871. (org-eval-in-environment (org-make-parameter-alist parameters)
  2872. (let (org-agenda-sticky)
  2873. (if (> (length cmd-key) 1)
  2874. (org-tags-view nil cmd-key)
  2875. (org-agenda nil cmd-key))))
  2876. (set-buffer org-agenda-buffer-name)
  2877. (princ (buffer-string)))
  2878. (defvar org-agenda-info nil)
  2879. ;;;###autoload
  2880. (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
  2881. "Run an agenda command in batch mode and send the result to STDOUT.
  2882. If CMD-KEY is a string of length 1, it is used as a key in
  2883. `org-agenda-custom-commands' and triggers this command. If it is a
  2884. longer string it is used as a tags/todo match string.
  2885. Parameters are alternating variable names and values that will be bound
  2886. before running the agenda command.
  2887. The output gives a line for each selected agenda item. Each
  2888. item is a list of comma-separated values, like this:
  2889. category,head,type,todo,tags,date,time,extra,priority-l,priority-n
  2890. category The category of the item
  2891. head The headline, without TODO kwd, TAGS and PRIORITY
  2892. type The type of the agenda entry, can be
  2893. todo selected in TODO match
  2894. tagsmatch selected in tags match
  2895. diary imported from diary
  2896. deadline a deadline on given date
  2897. scheduled scheduled on given date
  2898. timestamp entry has timestamp on given date
  2899. closed entry was closed on given date
  2900. upcoming-deadline warning about deadline
  2901. past-scheduled forwarded scheduled item
  2902. block entry has date block including g. date
  2903. todo The todo keyword, if any
  2904. tags All tags including inherited ones, separated by colons
  2905. date The relevant date, like 2007-2-14
  2906. time The time, like 15:00-16:50
  2907. extra Sting with extra planning info
  2908. priority-l The priority letter if any was given
  2909. priority-n The computed numerical priority
  2910. agenda-day The day in the agenda where this is listed"
  2911. (org-eval-in-environment (append '((org-agenda-remove-tags t))
  2912. (org-make-parameter-alist parameters))
  2913. (if (> (length cmd-key) 2)
  2914. (org-tags-view nil cmd-key)
  2915. (org-agenda nil cmd-key)))
  2916. (set-buffer org-agenda-buffer-name)
  2917. (let* ((lines (org-split-string (buffer-string) "\n"))
  2918. line)
  2919. (while (setq line (pop lines))
  2920. (catch 'next
  2921. (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
  2922. (setq org-agenda-info
  2923. (org-fix-agenda-info (text-properties-at 0 line)))
  2924. (princ
  2925. (mapconcat 'org-agenda-export-csv-mapper
  2926. '(org-category txt type todo tags date time extra
  2927. priority-letter priority agenda-day)
  2928. ","))
  2929. (princ "\n")))))
  2930. (defun org-fix-agenda-info (props)
  2931. "Make sure all properties on an agenda item have a canonical form.
  2932. This ensures the export commands can easily use it."
  2933. (let (tmp re)
  2934. (when (setq tmp (plist-get props 'tags))
  2935. (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
  2936. (when (setq tmp (plist-get props 'date))
  2937. (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2938. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2939. '((format "%4d, %9s %2s, %4s" dayname monthname day year))
  2940. (setq tmp (calendar-date-string tmp)))
  2941. (setq props (plist-put props 'date tmp)))
  2942. (when (setq tmp (plist-get props 'day))
  2943. (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
  2944. (let ((calendar-date-display-form '(year "-" month "-" day)))
  2945. (setq tmp (calendar-date-string tmp)))
  2946. (setq props (plist-put props 'day tmp))
  2947. (setq props (plist-put props 'agenda-day tmp)))
  2948. (when (setq tmp (plist-get props 'txt))
  2949. (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
  2950. (plist-put props 'priority-letter (match-string 1 tmp))
  2951. (setq tmp (replace-match "" t t tmp)))
  2952. (when (and (setq re (plist-get props 'org-todo-regexp))
  2953. (setq re (concat "\\`\\.*" re " ?"))
  2954. (let ((case-fold-search nil)) (string-match re tmp)))
  2955. (plist-put props 'todo (match-string 1 tmp))
  2956. (setq tmp (replace-match "" t t tmp)))
  2957. (plist-put props 'txt tmp)))
  2958. props)
  2959. (defun org-agenda-export-csv-mapper (prop)
  2960. (let ((res (plist-get org-agenda-info prop)))
  2961. (setq res
  2962. (cond
  2963. ((not res) "")
  2964. ((stringp res) res)
  2965. (t (prin1-to-string res))))
  2966. (org-trim (replace-regexp-in-string "," ";" res nil t))))
  2967. ;;;###autoload
  2968. (defun org-store-agenda-views (&rest parameters)
  2969. "Store agenda views."
  2970. (interactive)
  2971. (eval (list 'org-batch-store-agenda-views)))
  2972. ;;;###autoload
  2973. (defmacro org-batch-store-agenda-views (&rest parameters)
  2974. "Run all custom agenda commands that have a file argument."
  2975. (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
  2976. (pop-up-frames nil)
  2977. (dir default-directory)
  2978. (pars (org-make-parameter-alist parameters))
  2979. cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
  2980. (save-window-excursion
  2981. (while cmds
  2982. (setq cmd (pop cmds)
  2983. thiscmdkey (car cmd)
  2984. thiscmdcmd (cdr cmd)
  2985. match (nth 2 thiscmdcmd)
  2986. bufname (if org-agenda-sticky
  2987. (or (and (stringp match)
  2988. (format "*Org Agenda(%s:%s)*" thiscmdkey match))
  2989. (format "*Org Agenda(%s)*" thiscmdkey))
  2990. org-agenda-buffer-name)
  2991. cmd-or-set (nth 2 cmd)
  2992. opts (nth (if (listp cmd-or-set) 3 4) cmd)
  2993. files (nth (if (listp cmd-or-set) 4 5) cmd))
  2994. (if (stringp files) (setq files (list files)))
  2995. (when files
  2996. (org-eval-in-environment (append org-agenda-exporter-settings
  2997. opts pars)
  2998. (org-agenda nil thiscmdkey))
  2999. (set-buffer bufname)
  3000. (while files
  3001. (org-eval-in-environment (append org-agenda-exporter-settings
  3002. opts pars)
  3003. (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
  3004. (and (get-buffer bufname)
  3005. (kill-buffer bufname)))))))
  3006. (defvar org-agenda-current-span nil
  3007. "The current span used in the agenda view.") ; local variable in the agenda buffer
  3008. (defun org-agenda-mark-header-line (pos)
  3009. "Mark the line at POS as an agenda structure header."
  3010. (save-excursion
  3011. (goto-char pos)
  3012. (put-text-property (point-at-bol) (point-at-eol)
  3013. 'org-agenda-structural-header t)
  3014. (when org-agenda-title-append
  3015. (put-text-property (point-at-bol) (point-at-eol)
  3016. 'org-agenda-title-append org-agenda-title-append))))
  3017. (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
  3018. (defvar org-agenda-write-buffer-name "Agenda View")
  3019. (defun org-agenda-write (file &optional open nosettings agenda-bufname)
  3020. "Write the current buffer (an agenda view) as a file.
  3021. Depending on the extension of the file name, plain text (.txt),
  3022. HTML (.html or .htm), PDF (.pdf) or Postscript (.ps) is produced.
  3023. If the extension is .ics, translate visible agenda into iCalendar
  3024. format. If the extension is .org, collect all subtrees
  3025. corresponding to the agenda entries and add them in an .org file.
  3026. With prefix argument OPEN, open the new file immediately. If
  3027. NOSETTINGS is given, do not scope the settings of
  3028. `org-agenda-exporter-settings' into the export commands. This is
  3029. used when the settings have already been scoped and we do not
  3030. wish to overrule other, higher priority settings. If
  3031. AGENDA-BUFFER-NAME is provided, use this as the buffer name for
  3032. the agenda to write."
  3033. (interactive "FWrite agenda to file: \nP")
  3034. (if (or (not (file-writable-p file))
  3035. (and (file-exists-p file)
  3036. (if (called-interactively-p 'any)
  3037. (not (y-or-n-p (format "Overwrite existing file %s? " file))))))
  3038. (user-error "Cannot write agenda to file %s" file))
  3039. (org-let (if nosettings nil org-agenda-exporter-settings)
  3040. '(save-excursion
  3041. (save-window-excursion
  3042. (let ((bs (copy-sequence (buffer-string)))
  3043. (extension (file-name-extension file))
  3044. (default-directory (file-name-directory file))
  3045. beg content)
  3046. (with-temp-buffer
  3047. (rename-buffer org-agenda-write-buffer-name t)
  3048. (set-buffer-modified-p nil)
  3049. (insert bs)
  3050. (org-agenda-remove-marked-text 'invisible 'org-filtered)
  3051. (run-hooks 'org-agenda-before-write-hook)
  3052. (cond
  3053. ((bound-and-true-p org-mobile-creating-agendas)
  3054. (org-mobile-write-agenda-for-mobile file))
  3055. ((string= "org" extension)
  3056. (let (content p m message-log-max)
  3057. (goto-char (point-min))
  3058. (while (setq p (next-single-property-change (point) 'org-hd-marker nil))
  3059. (goto-char p)
  3060. (setq m (get-text-property (point) 'org-hd-marker))
  3061. (when m
  3062. (push (save-excursion
  3063. (set-buffer (marker-buffer m))
  3064. (goto-char m)
  3065. (org-copy-subtree 1 nil t t)
  3066. org-subtree-clip)
  3067. content)))
  3068. (find-file file)
  3069. (erase-buffer)
  3070. (dolist (s content) (org-paste-subtree 1 s))
  3071. (write-file file)
  3072. (kill-buffer (current-buffer))
  3073. (message "Org file written to %s" file)))
  3074. ((member extension '("html" "htm"))
  3075. (require 'htmlize)
  3076. (set-buffer (htmlize-buffer (current-buffer)))
  3077. (when org-agenda-export-html-style
  3078. ;; replace <style> section with org-agenda-export-html-style
  3079. (goto-char (point-min))
  3080. (kill-region (- (search-forward "<style") 6)
  3081. (search-forward "</style>"))
  3082. (insert org-agenda-export-html-style))
  3083. (write-file file)
  3084. (kill-buffer (current-buffer))
  3085. (message "HTML written to %s" file))
  3086. ((string= "ps" extension)
  3087. (require 'ps-print)
  3088. (ps-print-buffer-with-faces file)
  3089. (message "Postscript written to %s" file))
  3090. ((string= "pdf" extension)
  3091. (require 'ps-print)
  3092. (ps-print-buffer-with-faces
  3093. (concat (file-name-sans-extension file) ".ps"))
  3094. (call-process "ps2pdf" nil nil nil
  3095. (expand-file-name
  3096. (concat (file-name-sans-extension file) ".ps"))
  3097. (expand-file-name file))
  3098. (delete-file (concat (file-name-sans-extension file) ".ps"))
  3099. (message "PDF written to %s" file))
  3100. ((string= "ics" extension)
  3101. (require 'ox-icalendar)
  3102. (org-icalendar-export-current-agenda (expand-file-name file)))
  3103. (t
  3104. (let ((bs (buffer-string)))
  3105. (find-file file)
  3106. (erase-buffer)
  3107. (insert bs)
  3108. (save-buffer 0)
  3109. (kill-buffer (current-buffer))
  3110. (message "Plain text written to %s" file))))))))
  3111. (set-buffer (or agenda-bufname
  3112. (and (called-interactively-p 'any) (buffer-name))
  3113. org-agenda-buffer-name)))
  3114. (when open (org-open-file file)))
  3115. (defun org-agenda-remove-marked-text (property &optional value)
  3116. "Delete all text marked with VALUE of PROPERTY.
  3117. VALUE defaults to t."
  3118. (let (beg)
  3119. (setq value (or value t))
  3120. (while (setq beg (text-property-any (point-min) (point-max)
  3121. property value))
  3122. (delete-region
  3123. beg (or (next-single-property-change beg property)
  3124. (point-max))))))
  3125. (defun org-agenda-add-entry-text ()
  3126. "Add entry text to agenda lines.
  3127. This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
  3128. entry text following headings shown in the agenda.
  3129. Drawers will be excluded, also the line with scheduling/deadline info."
  3130. (when (and (> org-agenda-add-entry-text-maxlines 0)
  3131. (not (bound-and-true-p org-mobile-creating-agendas)))
  3132. (let (m txt)
  3133. (goto-char (point-min))
  3134. (while (not (eobp))
  3135. (if (not (setq m (org-get-at-bol 'org-hd-marker)))
  3136. (beginning-of-line 2)
  3137. (setq txt (org-agenda-get-some-entry-text
  3138. m org-agenda-add-entry-text-maxlines " > "))
  3139. (end-of-line 1)
  3140. (if (string-match "\\S-" txt)
  3141. (insert "\n" txt)
  3142. (or (eobp) (forward-char 1))))))))
  3143. (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
  3144. &rest keep)
  3145. "Extract entry text from MARKER, at most N-LINES lines.
  3146. This will ignore drawers etc, just get the text.
  3147. If INDENT is given, prefix every line with this string. If KEEP is
  3148. given, it is a list of symbols, defining stuff that should not be
  3149. removed from the entry content. Currently only `planning' is allowed here."
  3150. (let (txt drawer-re kwd-time-re ind)
  3151. (save-excursion
  3152. (with-current-buffer (marker-buffer marker)
  3153. (if (not (derived-mode-p 'org-mode))
  3154. (setq txt "")
  3155. (org-with-wide-buffer
  3156. (goto-char marker)
  3157. (end-of-line 1)
  3158. (setq txt (buffer-substring
  3159. (min (1+ (point)) (point-max))
  3160. (progn (outline-next-heading) (point)))
  3161. drawer-re org-drawer-regexp
  3162. kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
  3163. ".*\n?"))
  3164. (with-temp-buffer
  3165. (insert txt)
  3166. (when org-agenda-add-entry-text-descriptive-links
  3167. (goto-char (point-min))
  3168. (while (org-activate-bracket-links (point-max))
  3169. (add-text-properties (match-beginning 0) (match-end 0)
  3170. '(face org-link))))
  3171. (goto-char (point-min))
  3172. (while (re-search-forward org-bracket-link-regexp (point-max) t)
  3173. (set-text-properties (match-beginning 0) (match-end 0)
  3174. nil))
  3175. (goto-char (point-min))
  3176. (while (re-search-forward drawer-re nil t)
  3177. (delete-region
  3178. (match-beginning 0)
  3179. (progn (re-search-forward
  3180. "^[ \t]*:END:.*\n?" nil 'move)
  3181. (point))))
  3182. (unless (member 'planning keep)
  3183. (goto-char (point-min))
  3184. (while (re-search-forward kwd-time-re nil t)
  3185. (replace-match "")))
  3186. (goto-char (point-min))
  3187. (when org-agenda-entry-text-exclude-regexps
  3188. (let ((re-list org-agenda-entry-text-exclude-regexps) re)
  3189. (while (setq re (pop re-list))
  3190. (goto-char (point-min))
  3191. (while (re-search-forward re nil t)
  3192. (replace-match "")))))
  3193. (goto-char (point-max))
  3194. (skip-chars-backward " \t\n")
  3195. (if (looking-at "[ \t\n]+\\'") (replace-match ""))
  3196. ;; find and remove min common indentation
  3197. (goto-char (point-min))
  3198. (untabify (point-min) (point-max))
  3199. (setq ind (org-get-indentation))
  3200. (while (not (eobp))
  3201. (unless (looking-at "[ \t]*$")
  3202. (setq ind (min ind (org-get-indentation))))
  3203. (beginning-of-line 2))
  3204. (goto-char (point-min))
  3205. (while (not (eobp))
  3206. (unless (looking-at "[ \t]*$")
  3207. (move-to-column ind)
  3208. (delete-region (point-at-bol) (point)))
  3209. (beginning-of-line 2))
  3210. (run-hooks 'org-agenda-entry-text-cleanup-hook)
  3211. (goto-char (point-min))
  3212. (when indent
  3213. (while (and (not (eobp)) (re-search-forward "^" nil t))
  3214. (replace-match indent t t)))
  3215. (goto-char (point-min))
  3216. (while (looking-at "[ \t]*\n") (replace-match ""))
  3217. (goto-char (point-max))
  3218. (when (> (org-current-line)
  3219. n-lines)
  3220. (org-goto-line (1+ n-lines))
  3221. (backward-char 1))
  3222. (setq txt (buffer-substring (point-min) (point))))))))
  3223. txt))
  3224. (defun org-check-for-org-mode ()
  3225. "Make sure current buffer is in org-mode. Error if not."
  3226. (or (derived-mode-p 'org-mode)
  3227. (error "Cannot execute Org agenda command on buffer in %s"
  3228. major-mode)))
  3229. ;;; Agenda prepare and finalize
  3230. (defvar org-agenda-multi nil) ; dynamically scoped
  3231. (defvar org-agenda-pre-window-conf nil)
  3232. (defvar org-agenda-columns-active nil)
  3233. (defvar org-agenda-name nil)
  3234. (defvar org-agenda-tag-filter nil)
  3235. (defvar org-agenda-category-filter nil)
  3236. (defvar org-agenda-regexp-filter nil)
  3237. (defvar org-agenda-effort-filter nil)
  3238. (defvar org-agenda-top-headline-filter nil)
  3239. (defvar org-agenda-tag-filter-preset nil
  3240. "A preset of the tags filter used for secondary agenda filtering.
  3241. This must be a list of strings, each string must be a single tag preceded
  3242. by \"+\" or \"-\".
  3243. This variable should not be set directly, but agenda custom commands can
  3244. bind it in the options section. The preset filter is a global property of
  3245. the entire agenda view. In a block agenda, it will not work reliably to
  3246. define a filter for one of the individual blocks. You need to set it in
  3247. the global options and expect it to be applied to the entire view.")
  3248. (defvar org-agenda-category-filter-preset nil
  3249. "A preset of the category filter used for secondary agenda filtering.
  3250. This must be a list of strings, each string must be a single category
  3251. preceded by \"+\" or \"-\".
  3252. This variable should not be set directly, but agenda custom commands can
  3253. bind it in the options section. The preset filter is a global property of
  3254. the entire agenda view. In a block agenda, it will not work reliably to
  3255. define a filter for one of the individual blocks. You need to set it in
  3256. the global options and expect it to be applied to the entire view.")
  3257. (defvar org-agenda-regexp-filter-preset nil
  3258. "A preset of the regexp filter used for secondary agenda filtering.
  3259. This must be a list of strings, each string must be a single regexp
  3260. preceded by \"+\" or \"-\".
  3261. This variable should not be set directly, but agenda custom commands can
  3262. bind it in the options section. The preset filter is a global property of
  3263. the entire agenda view. In a block agenda, it will not work reliably to
  3264. define a filter for one of the individual blocks. You need to set it in
  3265. the global options and expect it to be applied to the entire view.")
  3266. (defvar org-agenda-effort-filter-preset nil
  3267. "A preset of the effort condition used for secondary agenda filtering.
  3268. This must be a list of strings, each string must be a single regexp
  3269. preceded by \"+\" or \"-\".
  3270. This variable should not be set directly, but agenda custom commands can
  3271. bind it in the options section. The preset filter is a global property of
  3272. the entire agenda view. In a block agenda, it will not work reliably to
  3273. define a filter for one of the individual blocks. You need to set it in
  3274. the global options and expect it to be applied to the entire view.")
  3275. (defun org-agenda-use-sticky-p ()
  3276. "Return non-nil if an agenda buffer named
  3277. `org-agenda-buffer-name' exists and should be shown instead of
  3278. generating a new one."
  3279. (and
  3280. ;; turned off by user
  3281. org-agenda-sticky
  3282. ;; For multi-agenda buffer already exists
  3283. (not org-agenda-multi)
  3284. ;; buffer found
  3285. (get-buffer org-agenda-buffer-name)
  3286. ;; C-u parameter is same as last call
  3287. (with-current-buffer (get-buffer org-agenda-buffer-name)
  3288. (and
  3289. (equal current-prefix-arg
  3290. org-agenda-last-prefix-arg)
  3291. ;; In case user turned stickiness on, while having existing
  3292. ;; Agenda buffer active, don't reuse that buffer, because it
  3293. ;; does not have org variables local
  3294. org-agenda-this-buffer-is-sticky))))
  3295. (defun org-agenda-prepare-window (abuf filter-alist)
  3296. "Setup agenda buffer in the window.
  3297. ABUF is the buffer for the agenda window.
  3298. FILTER-ALIST is an alist of filters we need to apply when
  3299. `org-agenda-persistent-filter' is non-nil."
  3300. (let* ((awin (get-buffer-window abuf)) wconf)
  3301. (cond
  3302. ((equal (current-buffer) abuf) nil)
  3303. (awin (select-window awin))
  3304. ((not (setq wconf (current-window-configuration))))
  3305. ((eq org-agenda-window-setup 'current-window)
  3306. (pop-to-buffer-same-window abuf))
  3307. ((eq org-agenda-window-setup 'other-window)
  3308. (org-switch-to-buffer-other-window abuf))
  3309. ((eq org-agenda-window-setup 'other-frame)
  3310. (switch-to-buffer-other-frame abuf))
  3311. ((eq org-agenda-window-setup 'only-window)
  3312. (delete-other-windows)
  3313. (pop-to-buffer-same-window abuf))
  3314. ((eq org-agenda-window-setup 'reorganize-frame)
  3315. (delete-other-windows)
  3316. (org-switch-to-buffer-other-window abuf)))
  3317. (setq org-agenda-tag-filter (cdr (assq 'tag filter-alist)))
  3318. (setq org-agenda-category-filter (cdr (assq 'cat filter-alist)))
  3319. (setq org-agenda-effort-filter (cdr (assq 'effort filter-alist)))
  3320. (setq org-agenda-regexp-filter (cdr (assq 're filter-alist)))
  3321. ;; Additional test in case agenda is invoked from within agenda
  3322. ;; buffer via elisp link.
  3323. (unless (equal (current-buffer) abuf)
  3324. (pop-to-buffer-same-window abuf))
  3325. (setq org-agenda-pre-window-conf
  3326. (or wconf org-agenda-pre-window-conf))))
  3327. (defun org-agenda-prepare (&optional name)
  3328. (let ((filter-alist (if org-agenda-persistent-filter
  3329. (with-current-buffer
  3330. (get-buffer-create org-agenda-buffer-name)
  3331. (list `(tag . ,org-agenda-tag-filter)
  3332. `(re . ,org-agenda-regexp-filter)
  3333. `(effort . ,org-agenda-effort-filter)
  3334. `(cat . ,org-agenda-category-filter))))))
  3335. (if (org-agenda-use-sticky-p)
  3336. (progn
  3337. (put 'org-agenda-tag-filter :preset-filter nil)
  3338. (put 'org-agenda-category-filter :preset-filter nil)
  3339. (put 'org-agenda-regexp-filter :preset-filter nil)
  3340. ;; Popup existing buffer
  3341. (org-agenda-prepare-window (get-buffer org-agenda-buffer-name)
  3342. filter-alist)
  3343. (message "Sticky Agenda buffer, use `r' to refresh")
  3344. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3345. (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
  3346. (setq org-todo-keywords-for-agenda nil)
  3347. (put 'org-agenda-tag-filter :preset-filter
  3348. org-agenda-tag-filter-preset)
  3349. (put 'org-agenda-category-filter :preset-filter
  3350. org-agenda-category-filter-preset)
  3351. (put 'org-agenda-regexp-filter :preset-filter
  3352. org-agenda-regexp-filter-preset)
  3353. (put 'org-agenda-effort-filter :preset-filter
  3354. org-agenda-effort-filter-preset)
  3355. (if org-agenda-multi
  3356. (progn
  3357. (setq buffer-read-only nil)
  3358. (goto-char (point-max))
  3359. (unless (or (bobp) org-agenda-compact-blocks
  3360. (not org-agenda-block-separator))
  3361. (insert "\n"
  3362. (if (stringp org-agenda-block-separator)
  3363. org-agenda-block-separator
  3364. (make-string (window-width) org-agenda-block-separator))
  3365. "\n"))
  3366. (narrow-to-region (point) (point-max)))
  3367. (setq org-done-keywords-for-agenda nil)
  3368. ;; Setting any org variables that are in org-agenda-local-vars
  3369. ;; list need to be done after the prepare call
  3370. (org-agenda-prepare-window
  3371. (get-buffer-create org-agenda-buffer-name) filter-alist)
  3372. (setq buffer-read-only nil)
  3373. (org-agenda-reset-markers)
  3374. (let ((inhibit-read-only t)) (erase-buffer))
  3375. (org-agenda-mode)
  3376. (setq org-agenda-buffer (current-buffer))
  3377. (setq org-agenda-contributing-files nil)
  3378. (setq org-agenda-columns-active nil)
  3379. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  3380. (setq org-todo-keywords-for-agenda
  3381. (org-uniquify org-todo-keywords-for-agenda))
  3382. (setq org-done-keywords-for-agenda
  3383. (org-uniquify org-done-keywords-for-agenda))
  3384. (setq org-agenda-last-prefix-arg current-prefix-arg)
  3385. (setq org-agenda-this-buffer-name org-agenda-buffer-name)
  3386. (and name (not org-agenda-name)
  3387. (setq-local org-agenda-name name)))
  3388. (setq buffer-read-only nil))))
  3389. (defvar org-agenda-overriding-columns-format) ; From org-colview.el
  3390. (defun org-agenda-finalize ()
  3391. "Finishing touch for the agenda buffer, called just before displaying it."
  3392. (unless org-agenda-multi
  3393. (save-excursion
  3394. (let ((inhibit-read-only t))
  3395. (goto-char (point-min))
  3396. (save-excursion
  3397. (while (org-activate-bracket-links (point-max))
  3398. (add-text-properties (match-beginning 0) (match-end 0)
  3399. '(face org-link))))
  3400. (save-excursion
  3401. (while (org-activate-plain-links (point-max))
  3402. (add-text-properties (match-beginning 0) (match-end 0)
  3403. '(face org-link))))
  3404. (unless (eq org-agenda-remove-tags t)
  3405. (org-agenda-align-tags))
  3406. (unless org-agenda-with-colors
  3407. (remove-text-properties (point-min) (point-max) '(face nil)))
  3408. (if (and (boundp 'org-agenda-overriding-columns-format)
  3409. org-agenda-overriding-columns-format)
  3410. (setq-local org-agenda-overriding-columns-format
  3411. org-agenda-overriding-columns-format))
  3412. (if (and (boundp 'org-agenda-view-columns-initially)
  3413. org-agenda-view-columns-initially)
  3414. (org-agenda-columns))
  3415. (when org-agenda-fontify-priorities
  3416. (org-agenda-fontify-priorities))
  3417. (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
  3418. (org-agenda-dim-blocked-tasks))
  3419. (org-agenda-mark-clocking-task)
  3420. (when org-agenda-entry-text-mode
  3421. (org-agenda-entry-text-hide)
  3422. (org-agenda-entry-text-show))
  3423. (if (and (functionp 'org-habit-insert-consistency-graphs)
  3424. (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
  3425. (org-habit-insert-consistency-graphs))
  3426. (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
  3427. (unless (or (eq org-agenda-show-inherited-tags 'always)
  3428. (and (listp org-agenda-show-inherited-tags)
  3429. (memq org-agenda-type org-agenda-show-inherited-tags))
  3430. (and (eq org-agenda-show-inherited-tags t)
  3431. (or (eq org-agenda-use-tag-inheritance t)
  3432. (and (listp org-agenda-use-tag-inheritance)
  3433. (not (memq org-agenda-type
  3434. org-agenda-use-tag-inheritance))))))
  3435. (let (mrk)
  3436. (save-excursion
  3437. (goto-char (point-min))
  3438. (while (equal (forward-line) 0)
  3439. (when (setq mrk (get-text-property (point) 'org-hd-marker))
  3440. (put-text-property (point-at-bol) (point-at-eol)
  3441. 'tags (org-with-point-at mrk
  3442. (delete-dups
  3443. (mapcar 'downcase (org-get-tags-at))))))))))
  3444. (run-hooks 'org-agenda-finalize-hook)
  3445. (when org-agenda-top-headline-filter
  3446. (org-agenda-filter-top-headline-apply
  3447. org-agenda-top-headline-filter))
  3448. (when org-agenda-tag-filter
  3449. (org-agenda-filter-apply org-agenda-tag-filter 'tag t))
  3450. (when (get 'org-agenda-tag-filter :preset-filter)
  3451. (org-agenda-filter-apply
  3452. (get 'org-agenda-tag-filter :preset-filter) 'tag t))
  3453. (when org-agenda-category-filter
  3454. (org-agenda-filter-apply org-agenda-category-filter 'category))
  3455. (when (get 'org-agenda-category-filter :preset-filter)
  3456. (org-agenda-filter-apply
  3457. (get 'org-agenda-category-filter :preset-filter) 'category))
  3458. (when org-agenda-regexp-filter
  3459. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
  3460. (when (get 'org-agenda-regexp-filter :preset-filter)
  3461. (org-agenda-filter-apply
  3462. (get 'org-agenda-regexp-filter :preset-filter) 'regexp))
  3463. (when org-agenda-effort-filter
  3464. (org-agenda-filter-apply org-agenda-effort-filter 'effort))
  3465. (when (get 'org-agenda-effort-filter :preset-filter)
  3466. (org-agenda-filter-apply
  3467. (get 'org-agenda-effort-filter :preset-filter) 'effort))
  3468. (add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)))))
  3469. (defun org-agenda-mark-clocking-task ()
  3470. "Mark the current clock entry in the agenda if it is present."
  3471. ;; We need to widen when `org-agenda-finalize' is called from
  3472. ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in')
  3473. (when (bound-and-true-p org-clock-current-task)
  3474. (save-restriction
  3475. (widen)
  3476. (org-agenda-unmark-clocking-task)
  3477. (when (marker-buffer org-clock-hd-marker)
  3478. (save-excursion
  3479. (goto-char (point-min))
  3480. (let (s ov)
  3481. (while (setq s (next-single-property-change (point) 'org-hd-marker))
  3482. (goto-char s)
  3483. (when (equal (org-get-at-bol 'org-hd-marker)
  3484. org-clock-hd-marker)
  3485. (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
  3486. (overlay-put ov 'type 'org-agenda-clocking)
  3487. (overlay-put ov 'face 'org-agenda-clocking)
  3488. (overlay-put ov 'help-echo
  3489. "The clock is running in this item")))))))))
  3490. (defun org-agenda-unmark-clocking-task ()
  3491. "Unmark the current clocking task."
  3492. (mapc (lambda (o)
  3493. (if (eq (overlay-get o 'type) 'org-agenda-clocking)
  3494. (delete-overlay o)))
  3495. (overlays-in (point-min) (point-max))))
  3496. (defun org-agenda-fontify-priorities ()
  3497. "Make highest priority lines bold, and lowest italic."
  3498. (interactive)
  3499. (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
  3500. (delete-overlay o)))
  3501. (overlays-in (point-min) (point-max)))
  3502. (save-excursion
  3503. (let (b e p ov h l)
  3504. (goto-char (point-min))
  3505. (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
  3506. (setq h (or (get-char-property (point) 'org-highest-priority)
  3507. org-highest-priority)
  3508. l (or (get-char-property (point) 'org-lowest-priority)
  3509. org-lowest-priority)
  3510. p (string-to-char (match-string 1))
  3511. b (match-beginning 0)
  3512. e (if (eq org-agenda-fontify-priorities 'cookies)
  3513. (match-end 0)
  3514. (point-at-eol))
  3515. ov (make-overlay b e))
  3516. (overlay-put
  3517. ov 'face
  3518. (let ((special-face
  3519. (cond ((org-face-from-face-or-color
  3520. 'priority 'org-priority
  3521. (cdr (assoc p org-priority-faces))))
  3522. ((and (listp org-agenda-fontify-priorities)
  3523. (org-face-from-face-or-color
  3524. 'priority 'org-priority
  3525. (cdr (assoc p org-agenda-fontify-priorities)))))
  3526. ((equal p l) 'italic)
  3527. ((equal p h) 'bold))))
  3528. (if special-face (list special-face 'org-priority) 'org-priority)))
  3529. (overlay-put ov 'org-type 'org-priority)))))
  3530. (defvar org-depend-tag-blocked)
  3531. (defun org-agenda-dim-blocked-tasks (&optional invisible)
  3532. "Dim currently blocked TODOs in the agenda display.
  3533. When INVISIBLE is non-nil, hide currently blocked TODO instead of
  3534. dimming them."
  3535. (interactive "P")
  3536. (when (called-interactively-p 'interactive)
  3537. (message "Dim or hide blocked tasks..."))
  3538. (dolist (o (overlays-in (point-min) (point-max)))
  3539. (when (eq (overlay-get o 'org-type) 'org-blocked-todo)
  3540. (delete-overlay o)))
  3541. (save-excursion
  3542. (let ((inhibit-read-only t)
  3543. (org-depend-tag-blocked nil)
  3544. org-blocked-by-checkboxes)
  3545. (goto-char (point-min))
  3546. (while (let ((pos (text-property-not-all
  3547. (point) (point-max) 'todo-state nil)))
  3548. (when pos (goto-char pos)))
  3549. (setq org-blocked-by-checkboxes nil)
  3550. (let ((marker (org-get-at-bol 'org-hd-marker)))
  3551. (when (and (markerp marker)
  3552. (with-current-buffer (marker-buffer marker)
  3553. (save-excursion (goto-char marker)
  3554. (org-entry-blocked-p))))
  3555. ;; Entries blocked by checkboxes cannot be made invisible.
  3556. ;; See `org-agenda-dim-blocked-tasks' for details.
  3557. (let* ((really-invisible
  3558. (and (not org-blocked-by-checkboxes)
  3559. (or invisible (eq org-agenda-dim-blocked-tasks
  3560. 'invisible))))
  3561. (ov (make-overlay (if really-invisible (line-end-position 0)
  3562. (line-beginning-position))
  3563. (line-end-position))))
  3564. (if really-invisible (overlay-put ov 'invisible t)
  3565. (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
  3566. (overlay-put ov 'org-type 'org-blocked-todo))))
  3567. (forward-line))))
  3568. (when (called-interactively-p 'interactive)
  3569. (message "Dim or hide blocked tasks...done")))
  3570. (defvar org-agenda-skip-function nil
  3571. "Function to be called at each match during agenda construction.
  3572. If this function returns nil, the current match should not be skipped.
  3573. Otherwise, the function must return a position from where the search
  3574. should be continued.
  3575. This may also be a Lisp form, it will be evaluated.
  3576. Never set this variable using `setq' or so, because then it will apply
  3577. to all future agenda commands. If you do want a global skipping condition,
  3578. use the option `org-agenda-skip-function-global' instead.
  3579. The correct usage for `org-agenda-skip-function' is to bind it with
  3580. `let' to scope it dynamically into the agenda-constructing command.
  3581. A good way to set it is through options in `org-agenda-custom-commands'.")
  3582. (defun org-agenda-skip ()
  3583. "Throw to `:skip' in places that should be skipped.
  3584. Also moves point to the end of the skipped region, so that search can
  3585. continue from there."
  3586. (let ((p (point-at-bol)) to)
  3587. (when (or
  3588. (save-excursion (goto-char p) (looking-at comment-start-skip))
  3589. (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
  3590. (get-text-property p :org-archived)
  3591. (org-end-of-subtree t))
  3592. (and org-agenda-skip-comment-trees
  3593. (get-text-property p :org-comment)
  3594. (org-end-of-subtree t))
  3595. (and (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
  3596. (org-agenda-skip-eval org-agenda-skip-function)))
  3597. (goto-char to))
  3598. (org-in-src-block-p t))
  3599. (throw :skip t))))
  3600. (defun org-agenda-skip-eval (form)
  3601. "If FORM is a function or a list, call (or eval) it and return the result.
  3602. `save-excursion' and `save-match-data' are wrapped around the call, so point
  3603. and match data are returned to the previous state no matter what these
  3604. functions do."
  3605. (let (fp)
  3606. (and form
  3607. (or (setq fp (functionp form))
  3608. (consp form))
  3609. (save-excursion
  3610. (save-match-data
  3611. (if fp
  3612. (funcall form)
  3613. (eval form)))))))
  3614. (defvar org-agenda-markers nil
  3615. "List of all currently active markers created by `org-agenda'.")
  3616. (defvar org-agenda-last-marker-time (float-time)
  3617. "Creation time of the last agenda marker.")
  3618. (defun org-agenda-new-marker (&optional pos)
  3619. "Return a new agenda marker.
  3620. Maker is at point, or at POS if non-nil. Org mode keeps a list of
  3621. these markers and resets them when they are no longer in use."
  3622. (let ((m (copy-marker (or pos (point)) t)))
  3623. (setq org-agenda-last-marker-time (float-time))
  3624. (if org-agenda-buffer
  3625. (with-current-buffer org-agenda-buffer
  3626. (push m org-agenda-markers))
  3627. (push m org-agenda-markers))
  3628. m))
  3629. (defun org-agenda-reset-markers ()
  3630. "Reset markers created by `org-agenda'."
  3631. (while org-agenda-markers
  3632. (move-marker (pop org-agenda-markers) nil)))
  3633. (defun org-agenda-save-markers-for-cut-and-paste (beg end)
  3634. "Save relative positions of markers in region.
  3635. This check for agenda markers in all agenda buffers currently active."
  3636. (dolist (buf (buffer-list))
  3637. (with-current-buffer buf
  3638. (when (eq major-mode 'org-agenda-mode)
  3639. (mapc (lambda (m) (org-check-and-save-marker m beg end))
  3640. org-agenda-markers)))))
  3641. ;;; Entry text mode
  3642. (defun org-agenda-entry-text-show-here ()
  3643. "Add some text from the entry as context to the current line."
  3644. (let (m txt o)
  3645. (setq m (org-get-at-bol 'org-hd-marker))
  3646. (unless (marker-buffer m)
  3647. (error "No marker points to an entry here"))
  3648. (setq txt (concat "\n" (org-no-properties
  3649. (org-agenda-get-some-entry-text
  3650. m org-agenda-entry-text-maxlines
  3651. org-agenda-entry-text-leaders))))
  3652. (when (string-match "\\S-" txt)
  3653. (setq o (make-overlay (point-at-bol) (point-at-eol)))
  3654. (overlay-put o 'evaporate t)
  3655. (overlay-put o 'org-overlay-type 'agenda-entry-content)
  3656. (overlay-put o 'after-string txt))))
  3657. (defun org-agenda-entry-text-show ()
  3658. "Add entry context for all agenda lines."
  3659. (interactive)
  3660. (save-excursion
  3661. (goto-char (point-max))
  3662. (beginning-of-line 1)
  3663. (while (not (bobp))
  3664. (when (org-get-at-bol 'org-hd-marker)
  3665. (org-agenda-entry-text-show-here))
  3666. (beginning-of-line 0))))
  3667. (defun org-agenda-entry-text-hide ()
  3668. "Remove any shown entry context."
  3669. (delq nil
  3670. (mapcar (lambda (o)
  3671. (if (eq (overlay-get o 'org-overlay-type)
  3672. 'agenda-entry-content)
  3673. (progn (delete-overlay o) t)))
  3674. (overlays-in (point-min) (point-max)))))
  3675. (defun org-agenda-get-day-face (date)
  3676. "Return the face DATE should be displayed with."
  3677. (cond ((and (functionp org-agenda-day-face-function)
  3678. (funcall org-agenda-day-face-function date)))
  3679. ((org-agenda-today-p date) 'org-agenda-date-today)
  3680. ((memq (calendar-day-of-week date) org-agenda-weekend-days)
  3681. 'org-agenda-date-weekend)
  3682. (t 'org-agenda-date)))
  3683. (defvar org-agenda-show-log-scoped)
  3684. ;;; Agenda Daily/Weekly
  3685. (defvar org-agenda-start-day nil ; dynamically scoped parameter
  3686. "Start day for the agenda view.
  3687. Custom commands can set this variable in the options section.
  3688. This is usually a string like \"2007-11-01\", \"+2d\" or any other
  3689. input allowed when reading a date through the Org calendar.
  3690. See the docstring of `org-read-date' for details.")
  3691. (defvar org-starting-day nil) ; local variable in the agenda buffer
  3692. (defvar org-arg-loc nil) ; local variable
  3693. (defvar org-agenda-buffer-tmp-name nil)
  3694. ;;;###autoload
  3695. (defun org-agenda-list (&optional arg start-day span with-hour)
  3696. "Produce a daily/weekly view from all files in variable `org-agenda-files'.
  3697. The view will be for the current day or week, but from the overview buffer
  3698. you will be able to go to other days/weeks.
  3699. With a numeric prefix argument in an interactive call, the agenda will
  3700. span ARG days. Lisp programs should instead specify SPAN to change
  3701. the number of days. SPAN defaults to `org-agenda-span'.
  3702. START-DAY defaults to TODAY, or to the most recent match for the weekday
  3703. given in `org-agenda-start-on-weekday'.
  3704. When WITH-HOUR is non-nil, only include scheduled and deadline
  3705. items if they have an hour specification like [h]h:mm."
  3706. (interactive "P")
  3707. (if org-agenda-overriding-arguments
  3708. (setq arg (car org-agenda-overriding-arguments)
  3709. start-day (nth 1 org-agenda-overriding-arguments)
  3710. span (nth 2 org-agenda-overriding-arguments)))
  3711. (if (and (integerp arg) (> arg 0))
  3712. (setq span arg arg nil))
  3713. (catch 'exit
  3714. (setq org-agenda-buffer-name
  3715. (or org-agenda-buffer-tmp-name
  3716. (and org-agenda-doing-sticky-redo org-agenda-buffer-name)
  3717. (if org-agenda-sticky
  3718. (cond ((and org-keys (stringp org-match))
  3719. (format "*Org Agenda(%s:%s)*" org-keys org-match))
  3720. (org-keys
  3721. (format "*Org Agenda(%s)*" org-keys))
  3722. (t "*Org Agenda(a)*")))
  3723. "*Org Agenda*"))
  3724. (org-agenda-prepare "Day/Week")
  3725. (setq start-day (or start-day org-agenda-start-day))
  3726. (if (stringp start-day)
  3727. ;; Convert to an absolute day number
  3728. (setq start-day (time-to-days (org-read-date nil t start-day))))
  3729. (org-compile-prefix-format 'agenda)
  3730. (org-set-sorting-strategy 'agenda)
  3731. (let* ((span (org-agenda-ndays-to-span (or span org-agenda-span)))
  3732. (today (org-today))
  3733. (sd (or start-day today))
  3734. (ndays (org-agenda-span-to-ndays span sd))
  3735. (org-agenda-start-on-weekday
  3736. (if (or (eq ndays 7) (eq ndays 14))
  3737. org-agenda-start-on-weekday))
  3738. (thefiles (org-agenda-files nil 'ifmode))
  3739. (files thefiles)
  3740. (start (if (or (null org-agenda-start-on-weekday)
  3741. (< ndays 7))
  3742. sd
  3743. (let* ((nt (calendar-day-of-week
  3744. (calendar-gregorian-from-absolute sd)))
  3745. (n1 org-agenda-start-on-weekday)
  3746. (d (- nt n1)))
  3747. (- sd (+ (if (< d 0) 7 0) d)))))
  3748. (day-numbers (list start))
  3749. (day-cnt 0)
  3750. (inhibit-redisplay (not debug-on-error))
  3751. (org-agenda-show-log-scoped org-agenda-show-log)
  3752. s e rtn rtnall file date d start-pos end-pos todayp
  3753. clocktable-start clocktable-end filter)
  3754. (setq org-agenda-redo-command
  3755. (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span) with-hour))
  3756. (dotimes (n (1- ndays))
  3757. (push (1+ (car day-numbers)) day-numbers))
  3758. (setq day-numbers (nreverse day-numbers))
  3759. (setq clocktable-start (car day-numbers)
  3760. clocktable-end (1+ (or (org-last day-numbers) 0)))
  3761. (setq-local org-starting-day (car day-numbers))
  3762. (setq-local org-arg-loc arg)
  3763. (setq-local org-agenda-current-span (org-agenda-ndays-to-span span))
  3764. (unless org-agenda-compact-blocks
  3765. (let* ((d1 (car day-numbers))
  3766. (d2 (org-last day-numbers))
  3767. (w1 (org-days-to-iso-week d1))
  3768. (w2 (org-days-to-iso-week d2)))
  3769. (setq s (point))
  3770. (if org-agenda-overriding-header
  3771. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  3772. nil 'face 'org-agenda-structure) "\n")
  3773. (insert (org-agenda-span-name span)
  3774. "-agenda"
  3775. (if (< (- d2 d1) 350)
  3776. (if (= w1 w2)
  3777. (format " (W%02d)" w1)
  3778. (format " (W%02d-W%02d)" w1 w2))
  3779. "")
  3780. ":\n")))
  3781. (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
  3782. 'org-date-line t))
  3783. (org-agenda-mark-header-line s))
  3784. (while (setq d (pop day-numbers))
  3785. (setq date (calendar-gregorian-from-absolute d)
  3786. s (point))
  3787. (if (or (setq todayp (= d today))
  3788. (and (not start-pos) (= d sd)))
  3789. (setq start-pos (point))
  3790. (if (and start-pos (not end-pos))
  3791. (setq end-pos (point))))
  3792. (setq files thefiles
  3793. rtnall nil)
  3794. (while (setq file (pop files))
  3795. (catch 'nextfile
  3796. (org-check-agenda-file file)
  3797. (let ((org-agenda-entry-types org-agenda-entry-types))
  3798. ;; Starred types override non-starred equivalents
  3799. (when (member :deadline* org-agenda-entry-types)
  3800. (setq org-agenda-entry-types
  3801. (delq :deadline org-agenda-entry-types)))
  3802. (when (member :scheduled* org-agenda-entry-types)
  3803. (setq org-agenda-entry-types
  3804. (delq :scheduled org-agenda-entry-types)))
  3805. ;; Honor with-hour
  3806. (when with-hour
  3807. (when (member :deadline org-agenda-entry-types)
  3808. (setq org-agenda-entry-types
  3809. (delq :deadline org-agenda-entry-types))
  3810. (push :deadline* org-agenda-entry-types))
  3811. (when (member :scheduled org-agenda-entry-types)
  3812. (setq org-agenda-entry-types
  3813. (delq :scheduled org-agenda-entry-types))
  3814. (push :scheduled* org-agenda-entry-types)))
  3815. (unless org-agenda-include-deadlines
  3816. (setq org-agenda-entry-types
  3817. (delq :deadline* (delq :deadline org-agenda-entry-types))))
  3818. (cond
  3819. ((memq org-agenda-show-log-scoped '(only clockcheck))
  3820. (setq rtn (org-agenda-get-day-entries
  3821. file date :closed)))
  3822. (org-agenda-show-log-scoped
  3823. (setq rtn (apply 'org-agenda-get-day-entries
  3824. file date
  3825. (append '(:closed) org-agenda-entry-types))))
  3826. (t
  3827. (setq rtn (apply 'org-agenda-get-day-entries
  3828. file date
  3829. org-agenda-entry-types)))))
  3830. (setq rtnall (append rtnall rtn)))) ;; all entries
  3831. (if org-agenda-include-diary
  3832. (let ((org-agenda-search-headline-for-time t))
  3833. (require 'diary-lib)
  3834. (setq rtn (org-get-entries-from-diary date))
  3835. (setq rtnall (append rtnall rtn))))
  3836. (if (or rtnall org-agenda-show-all-dates)
  3837. (progn
  3838. (setq day-cnt (1+ day-cnt))
  3839. (insert
  3840. (if (stringp org-agenda-format-date)
  3841. (format-time-string org-agenda-format-date
  3842. (org-time-from-absolute date))
  3843. (funcall org-agenda-format-date date))
  3844. "\n")
  3845. (put-text-property s (1- (point)) 'face
  3846. (org-agenda-get-day-face date))
  3847. (put-text-property s (1- (point)) 'org-date-line t)
  3848. (put-text-property s (1- (point)) 'org-agenda-date-header t)
  3849. (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
  3850. (when todayp
  3851. (put-text-property s (1- (point)) 'org-today t))
  3852. (setq rtnall
  3853. (org-agenda-add-time-grid-maybe rtnall ndays todayp))
  3854. (if rtnall (insert ;; all entries
  3855. (org-agenda-finalize-entries rtnall 'agenda)
  3856. "\n"))
  3857. (put-text-property s (1- (point)) 'day d)
  3858. (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
  3859. (when (and org-agenda-clockreport-mode clocktable-start)
  3860. (let ((org-agenda-files (org-agenda-files nil 'ifmode))
  3861. ;; the above line is to ensure the restricted range!
  3862. (p (copy-sequence org-agenda-clockreport-parameter-plist))
  3863. tbl)
  3864. (setq p (org-plist-delete p :block))
  3865. (setq p (plist-put p :tstart clocktable-start))
  3866. (setq p (plist-put p :tend clocktable-end))
  3867. (setq p (plist-put p :scope 'agenda))
  3868. (setq tbl (apply 'org-clock-get-clocktable p))
  3869. (insert tbl)))
  3870. (goto-char (point-min))
  3871. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  3872. (unless (and (pos-visible-in-window-p (point-min))
  3873. (pos-visible-in-window-p (point-max)))
  3874. (goto-char (1- (point-max)))
  3875. (recenter -1)
  3876. (if (not (pos-visible-in-window-p (or start-pos 1)))
  3877. (progn
  3878. (goto-char (or start-pos 1))
  3879. (recenter 1))))
  3880. (goto-char (or start-pos 1))
  3881. (add-text-properties (point-min) (point-max)
  3882. `(org-agenda-type agenda
  3883. org-last-args (,arg ,start-day ,span)
  3884. org-redo-cmd ,org-agenda-redo-command
  3885. org-series-cmd ,org-cmd))
  3886. (if (eq org-agenda-show-log-scoped 'clockcheck)
  3887. (org-agenda-show-clocking-issues))
  3888. (org-agenda-finalize)
  3889. (setq buffer-read-only t)
  3890. (message ""))))
  3891. (defun org-agenda-ndays-to-span (n)
  3892. "Return a span symbol for a span of N days, or N if none matches."
  3893. (cond ((symbolp n) n)
  3894. ((= n 1) 'day)
  3895. ((= n 7) 'week)
  3896. ((= n 14) 'fortnight)
  3897. (t n)))
  3898. (defun org-agenda-span-to-ndays (span &optional start-day)
  3899. "Return ndays from SPAN, possibly starting at START-DAY.
  3900. START-DAY is an absolute time value."
  3901. (cond ((numberp span) span)
  3902. ((eq span 'day) 1)
  3903. ((eq span 'week) 7)
  3904. ((eq span 'fortnight) 14)
  3905. ((eq span 'month)
  3906. (let ((date (calendar-gregorian-from-absolute start-day)))
  3907. (calendar-last-day-of-month (car date) (cl-caddr date))))
  3908. ((eq span 'year)
  3909. (let ((date (calendar-gregorian-from-absolute start-day)))
  3910. (if (calendar-leap-year-p (cl-caddr date)) 366 365)))))
  3911. (defun org-agenda-span-name (span)
  3912. "Return a SPAN name."
  3913. (if (null span)
  3914. ""
  3915. (if (symbolp span)
  3916. (capitalize (symbol-name span))
  3917. (format "%d days" span))))
  3918. ;;; Agenda word search
  3919. (defvar org-agenda-search-history nil)
  3920. (defvar org-search-syntax-table nil
  3921. "Special syntax table for Org search.
  3922. In this table, we have single quotes not as word constituents, to
  3923. that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
  3924. (defvar org-mode-syntax-table) ; From org.el
  3925. (defun org-search-syntax-table ()
  3926. (unless org-search-syntax-table
  3927. (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
  3928. (modify-syntax-entry ?' "." org-search-syntax-table)
  3929. (modify-syntax-entry ?` "." org-search-syntax-table))
  3930. org-search-syntax-table)
  3931. (defvar org-agenda-last-search-view-search-was-boolean nil)
  3932. ;;;###autoload
  3933. (defun org-search-view (&optional todo-only string edit-at)
  3934. "Show all entries that contain a phrase or words or regular expressions.
  3935. With optional prefix argument TODO-ONLY, only consider entries that are
  3936. TODO entries. The argument STRING can be used to pass a default search
  3937. string into this function. If EDIT-AT is non-nil, it means that the
  3938. user should get a chance to edit this string, with cursor at position
  3939. EDIT-AT.
  3940. The search string can be viewed either as a phrase that should be found as
  3941. is, or it can be broken into a number of snippets, each of which must match
  3942. in a Boolean way to select an entry. The default depends on the variable
  3943. `org-agenda-search-view-always-boolean'.
  3944. Even if this is turned off (the default) you can always switch to
  3945. Boolean search dynamically by preceding the first word with \"+\" or \"-\".
  3946. The default is a direct search of the whole phrase, where each space in
  3947. the search string can expand to an arbitrary amount of whitespace,
  3948. including newlines.
  3949. If using a Boolean search, the search string is split on whitespace and
  3950. each snippet is searched separately, with logical AND to select an entry.
  3951. Words prefixed with a minus must *not* occur in the entry. Words without
  3952. a prefix or prefixed with a plus must occur in the entry. Matching is
  3953. case-insensitive. Words are enclosed by word delimiters (i.e. they must
  3954. match whole words, not parts of a word) if
  3955. `org-agenda-search-view-force-full-words' is set (default is nil).
  3956. Boolean search snippets enclosed by curly braces are interpreted as
  3957. regular expressions that must or (when preceded with \"-\") must not
  3958. match in the entry. Snippets enclosed into double quotes will be taken
  3959. as a whole, to include whitespace.
  3960. - If the search string starts with an asterisk, search only in headlines.
  3961. - If (possibly after the leading star) the search string starts with an
  3962. exclamation mark, this also means to look at TODO entries only, an effect
  3963. that can also be achieved with a prefix argument.
  3964. - If (possibly after star and exclamation mark) the search string starts
  3965. with a colon, this will mean that the (non-regexp) snippets of the
  3966. Boolean search must match as full words.
  3967. This command searches the agenda files, and in addition the files listed
  3968. in `org-agenda-text-search-extra-files'."
  3969. (interactive "P")
  3970. (if org-agenda-overriding-arguments
  3971. (setq todo-only (car org-agenda-overriding-arguments)
  3972. string (nth 1 org-agenda-overriding-arguments)
  3973. edit-at (nth 2 org-agenda-overriding-arguments)))
  3974. (let* ((props (list 'face nil
  3975. 'done-face 'org-agenda-done
  3976. 'org-not-done-regexp org-not-done-regexp
  3977. 'org-todo-regexp org-todo-regexp
  3978. 'org-complex-heading-regexp org-complex-heading-regexp
  3979. 'mouse-face 'highlight
  3980. 'help-echo (format "mouse-2 or RET jump to location")))
  3981. (full-words org-agenda-search-view-force-full-words)
  3982. (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
  3983. regexp rtn rtnall files file pos inherited-tags
  3984. marker category level tags c neg re boolean
  3985. ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
  3986. (unless (and (not edit-at)
  3987. (stringp string)
  3988. (string-match "\\S-" string))
  3989. (setq string (read-string
  3990. (if org-agenda-search-view-always-boolean
  3991. "[+-]Word/{Regexp} ...: "
  3992. "Phrase or [+-]Word/{Regexp} ...: ")
  3993. (cond
  3994. ((integerp edit-at) (cons string edit-at))
  3995. (edit-at string))
  3996. 'org-agenda-search-history)))
  3997. (catch 'exit
  3998. (if org-agenda-sticky
  3999. (setq org-agenda-buffer-name
  4000. (if (stringp string)
  4001. (format "*Org Agenda(%s:%s)*"
  4002. (or org-keys (or (and todo-only "S") "s")) string)
  4003. (format "*Org Agenda(%s)*" (or (and todo-only "S") "s")))))
  4004. (org-agenda-prepare "SEARCH")
  4005. (org-compile-prefix-format 'search)
  4006. (org-set-sorting-strategy 'search)
  4007. (setq org-agenda-redo-command
  4008. (list 'org-search-view (if todo-only t nil)
  4009. (list 'if 'current-prefix-arg nil string)))
  4010. (setq org-agenda-query-string string)
  4011. (if (equal (string-to-char string) ?*)
  4012. (setq hdl-only t
  4013. words (substring string 1))
  4014. (setq words string))
  4015. (when (equal (string-to-char words) ?!)
  4016. (setq todo-only t
  4017. words (substring words 1)))
  4018. (when (equal (string-to-char words) ?:)
  4019. (setq full-words t
  4020. words (substring words 1)))
  4021. (if (or org-agenda-search-view-always-boolean
  4022. (member (string-to-char words) '(?- ?+ ?\{)))
  4023. (setq boolean t))
  4024. (setq words (org-split-string words))
  4025. (let (www w)
  4026. (while (setq w (pop words))
  4027. (while (and (string-match "\\\\\\'" w) words)
  4028. (setq w (concat (substring w 0 -1) " " (pop words))))
  4029. (push w www))
  4030. (setq words (nreverse www) www nil)
  4031. (while (setq w (pop words))
  4032. (when (and (string-match "\\`[-+]?{" w)
  4033. (not (string-match "}\\'" w)))
  4034. (while (and words (not (string-match "}\\'" (car words))))
  4035. (setq w (concat w " " (pop words))))
  4036. (setq w (concat w " " (pop words))))
  4037. (push w www))
  4038. (setq words (nreverse www)))
  4039. (setq org-agenda-last-search-view-search-was-boolean boolean)
  4040. (when boolean
  4041. (let (wds w)
  4042. (while (setq w (pop words))
  4043. (if (or (equal (substring w 0 1) "\"")
  4044. (and (> (length w) 1)
  4045. (member (substring w 0 1) '("+" "-"))
  4046. (equal (substring w 1 2) "\"")))
  4047. (while (and words (not (equal (substring w -1) "\"")))
  4048. (setq w (concat w " " (pop words)))))
  4049. (and (string-match "\\`\\([-+]?\\)\"" w)
  4050. (setq w (replace-match "\\1" nil nil w)))
  4051. (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
  4052. (push w wds))
  4053. (setq words (nreverse wds))))
  4054. (if boolean
  4055. (mapc (lambda (w)
  4056. (setq c (string-to-char w))
  4057. (if (equal c ?-)
  4058. (setq neg t w (substring w 1))
  4059. (if (equal c ?+)
  4060. (setq neg nil w (substring w 1))
  4061. (setq neg nil)))
  4062. (if (string-match "\\`{.*}\\'" w)
  4063. (setq re (substring w 1 -1))
  4064. (if full-words
  4065. (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
  4066. (setq re (regexp-quote (downcase w)))))
  4067. (if neg (push re regexps-) (push re regexps+)))
  4068. words)
  4069. (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
  4070. regexps+))
  4071. (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
  4072. (if (not regexps+)
  4073. (setq regexp org-outline-regexp-bol)
  4074. (setq regexp (pop regexps+))
  4075. (if hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
  4076. regexp))))
  4077. (setq files (org-agenda-files nil 'ifmode))
  4078. (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
  4079. (pop org-agenda-text-search-extra-files)
  4080. (setq files (org-add-archive-files files)))
  4081. (setq files (append files org-agenda-text-search-extra-files)
  4082. rtnall nil)
  4083. (while (setq file (pop files))
  4084. (setq ee nil)
  4085. (catch 'nextfile
  4086. (org-check-agenda-file file)
  4087. (setq buffer (if (file-exists-p file)
  4088. (org-get-agenda-file-buffer file)
  4089. (error "No such file %s" file)))
  4090. (if (not buffer)
  4091. ;; If file does not exist, make sure an error message is sent
  4092. (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
  4093. file))))
  4094. (with-current-buffer buffer
  4095. (with-syntax-table (org-search-syntax-table)
  4096. (unless (derived-mode-p 'org-mode)
  4097. (error "Agenda file %s is not in `org-mode'" file))
  4098. (let ((case-fold-search t))
  4099. (save-excursion
  4100. (save-restriction
  4101. (if (eq buffer org-agenda-restrict)
  4102. (narrow-to-region org-agenda-restrict-begin
  4103. org-agenda-restrict-end)
  4104. (widen))
  4105. (goto-char (point-min))
  4106. (unless (or (org-at-heading-p)
  4107. (outline-next-heading))
  4108. (throw 'nextfile t))
  4109. (goto-char (max (point-min) (1- (point))))
  4110. (while (re-search-forward regexp nil t)
  4111. (org-back-to-heading t)
  4112. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4113. (> (org-reduced-level (org-outline-level))
  4114. org-agenda-search-view-max-outline-level)
  4115. (forward-line -1)
  4116. (org-back-to-heading t)))
  4117. (skip-chars-forward "* ")
  4118. (setq beg (point-at-bol)
  4119. beg1 (point)
  4120. end (progn
  4121. (outline-next-heading)
  4122. (while (and (not (zerop org-agenda-search-view-max-outline-level))
  4123. (> (org-reduced-level (org-outline-level))
  4124. org-agenda-search-view-max-outline-level)
  4125. (forward-line 1)
  4126. (outline-next-heading)))
  4127. (point)))
  4128. (catch :skip
  4129. (goto-char beg)
  4130. (org-agenda-skip)
  4131. (setq str (buffer-substring-no-properties
  4132. (point-at-bol)
  4133. (if hdl-only (point-at-eol) end)))
  4134. (mapc (lambda (wr) (when (string-match wr str)
  4135. (goto-char (1- end))
  4136. (throw :skip t)))
  4137. regexps-)
  4138. (mapc (lambda (wr) (unless (string-match wr str)
  4139. (goto-char (1- end))
  4140. (throw :skip t)))
  4141. (if todo-only
  4142. (cons (concat "^\\*+[ \t]+"
  4143. org-not-done-regexp)
  4144. regexps+)
  4145. regexps+))
  4146. (goto-char beg)
  4147. (setq marker (org-agenda-new-marker (point))
  4148. category (org-get-category)
  4149. level (make-string (org-reduced-level (org-outline-level)) ? )
  4150. inherited-tags
  4151. (or (eq org-agenda-show-inherited-tags 'always)
  4152. (and (listp org-agenda-show-inherited-tags)
  4153. (memq 'todo org-agenda-show-inherited-tags))
  4154. (and (eq org-agenda-show-inherited-tags t)
  4155. (or (eq org-agenda-use-tag-inheritance t)
  4156. (memq 'todo org-agenda-use-tag-inheritance))))
  4157. tags (org-get-tags-at nil (not inherited-tags))
  4158. txt (org-agenda-format-item
  4159. ""
  4160. (buffer-substring-no-properties
  4161. beg1 (point-at-eol))
  4162. level category tags t))
  4163. (org-add-props txt props
  4164. 'org-marker marker 'org-hd-marker marker
  4165. 'org-todo-regexp org-todo-regexp
  4166. 'level level
  4167. 'org-complex-heading-regexp org-complex-heading-regexp
  4168. 'priority 1000
  4169. 'type "search")
  4170. (push txt ee)
  4171. (goto-char (1- end))))))))))
  4172. (setq rtn (nreverse ee))
  4173. (setq rtnall (append rtnall rtn)))
  4174. (if org-agenda-overriding-header
  4175. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4176. nil 'face 'org-agenda-structure) "\n")
  4177. (insert "Search words: ")
  4178. (add-text-properties (point-min) (1- (point))
  4179. (list 'face 'org-agenda-structure))
  4180. (setq pos (point))
  4181. (insert string "\n")
  4182. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4183. (setq pos (point))
  4184. (unless org-agenda-multi
  4185. (insert (substitute-command-keys "\
  4186. Press `\\[org-agenda-manipulate-query-add]', \
  4187. `\\[org-agenda-manipulate-query-subtract]' to add/sub word, \
  4188. `\\[org-agenda-manipulate-query-add-re]', \
  4189. `\\[org-agenda-manipulate-query-subtract-re]' to add/sub regexp, \
  4190. `\\[universal-argument] \\[org-agenda-redo]' to edit\n"))
  4191. (add-text-properties pos (1- (point))
  4192. (list 'face 'org-agenda-structure))))
  4193. (org-agenda-mark-header-line (point-min))
  4194. (when rtnall
  4195. (insert (org-agenda-finalize-entries rtnall 'search) "\n"))
  4196. (goto-char (point-min))
  4197. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4198. (add-text-properties (point-min) (point-max)
  4199. `(org-agenda-type search
  4200. org-last-args (,todo-only ,string ,edit-at)
  4201. org-redo-cmd ,org-agenda-redo-command
  4202. org-series-cmd ,org-cmd))
  4203. (org-agenda-finalize)
  4204. (setq buffer-read-only t))))
  4205. ;;; Agenda TODO list
  4206. (defun org-agenda-propertize-selected-todo-keywords (keywords)
  4207. "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
  4208. (concat
  4209. (if (or (equal keywords "ALL") (not keywords))
  4210. (propertize "ALL" 'face 'warning)
  4211. (mapconcat
  4212. (lambda (kw)
  4213. (propertize kw 'face (org-get-todo-face kw)))
  4214. (org-split-string keywords "|")
  4215. "|"))
  4216. "\n"))
  4217. (defvar org-select-this-todo-keyword nil)
  4218. (defvar org-last-arg nil)
  4219. ;;;###autoload
  4220. (defun org-todo-list (&optional arg)
  4221. "Show all (not done) TODO entries from all agenda file in a single list.
  4222. The prefix arg can be used to select a specific TODO keyword and limit
  4223. the list to these. When using `\\[universal-argument]', you will be prompted
  4224. for a keyword. A numeric prefix directly selects the Nth keyword in
  4225. `org-todo-keywords-1'."
  4226. (interactive "P")
  4227. (if org-agenda-overriding-arguments
  4228. (setq arg org-agenda-overriding-arguments))
  4229. (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
  4230. (let* ((today (org-today))
  4231. (date (calendar-gregorian-from-absolute today))
  4232. (kwds org-todo-keywords-for-agenda)
  4233. (completion-ignore-case t)
  4234. (org-select-this-todo-keyword
  4235. (if (stringp arg) arg
  4236. (and arg (integerp arg) (> arg 0)
  4237. (nth (1- arg) kwds))))
  4238. rtn rtnall files file pos)
  4239. (when (equal arg '(4))
  4240. (setq org-select-this-todo-keyword
  4241. (completing-read "Keyword (or KWD1|K2D2|...): "
  4242. (mapcar #'list kwds) nil nil)))
  4243. (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
  4244. (catch 'exit
  4245. (if org-agenda-sticky
  4246. (setq org-agenda-buffer-name
  4247. (if (stringp org-select-this-todo-keyword)
  4248. (format "*Org Agenda(%s:%s)*" (or org-keys "t")
  4249. org-select-this-todo-keyword)
  4250. (format "*Org Agenda(%s)*" (or org-keys "t")))))
  4251. (org-agenda-prepare "TODO")
  4252. (org-compile-prefix-format 'todo)
  4253. (org-set-sorting-strategy 'todo)
  4254. (setq org-agenda-redo-command
  4255. `(org-todo-list (or (and (numberp current-prefix-arg)
  4256. current-prefix-arg)
  4257. ,org-select-this-todo-keyword
  4258. current-prefix-arg ,arg)))
  4259. (setq files (org-agenda-files nil 'ifmode)
  4260. rtnall nil)
  4261. (while (setq file (pop files))
  4262. (catch 'nextfile
  4263. (org-check-agenda-file file)
  4264. (setq rtn (org-agenda-get-day-entries file date :todo))
  4265. (setq rtnall (append rtnall rtn))))
  4266. (if org-agenda-overriding-header
  4267. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4268. nil 'face 'org-agenda-structure) "\n")
  4269. (insert "Global list of TODO items of type: ")
  4270. (add-text-properties (point-min) (1- (point))
  4271. (list 'face 'org-agenda-structure
  4272. 'short-heading
  4273. (concat "ToDo: "
  4274. (or org-select-this-todo-keyword "ALL"))))
  4275. (org-agenda-mark-header-line (point-min))
  4276. (insert (org-agenda-propertize-selected-todo-keywords
  4277. org-select-this-todo-keyword))
  4278. (setq pos (point))
  4279. (unless org-agenda-multi
  4280. (insert (substitute-command-keys "Available with \
  4281. `N \\[org-agenda-redo]': (0)[ALL]"))
  4282. (let ((n 0) s)
  4283. (mapc (lambda (x)
  4284. (setq s (format "(%d)%s" (setq n (1+ n)) x))
  4285. (if (> (+ (current-column) (string-width s) 1) (frame-width))
  4286. (insert "\n "))
  4287. (insert " " s))
  4288. kwds))
  4289. (insert "\n"))
  4290. (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
  4291. (org-agenda-mark-header-line (point-min))
  4292. (when rtnall
  4293. (insert (org-agenda-finalize-entries rtnall 'todo) "\n"))
  4294. (goto-char (point-min))
  4295. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4296. (add-text-properties (point-min) (point-max)
  4297. `(org-agenda-type todo
  4298. org-last-args ,arg
  4299. org-redo-cmd ,org-agenda-redo-command
  4300. org-series-cmd ,org-cmd))
  4301. (org-agenda-finalize)
  4302. (setq buffer-read-only t))))
  4303. ;;; Agenda tags match
  4304. ;;;###autoload
  4305. (defun org-tags-view (&optional todo-only match)
  4306. "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
  4307. The prefix arg TODO-ONLY limits the search to TODO entries."
  4308. (interactive "P")
  4309. (if org-agenda-overriding-arguments
  4310. (setq todo-only (car org-agenda-overriding-arguments)
  4311. match (nth 1 org-agenda-overriding-arguments)))
  4312. (let* ((org-tags-match-list-sublevels
  4313. org-tags-match-list-sublevels)
  4314. (completion-ignore-case t)
  4315. rtn rtnall files file pos matcher
  4316. buffer)
  4317. (when (and (stringp match) (not (string-match "\\S-" match)))
  4318. (setq match nil))
  4319. (catch 'exit
  4320. (if org-agenda-sticky
  4321. (setq org-agenda-buffer-name
  4322. (if (stringp match)
  4323. (format "*Org Agenda(%s:%s)*"
  4324. (or org-keys (or (and todo-only "M") "m")) match)
  4325. (format "*Org Agenda(%s)*" (or (and todo-only "M") "m")))))
  4326. ;; Prepare agendas (and `org-tag-alist-for-agenda') before
  4327. ;; expanding tags within `org-make-tags-matcher'
  4328. (org-agenda-prepare (concat "TAGS " match))
  4329. (setq org--matcher-tags-todo-only todo-only
  4330. matcher (org-make-tags-matcher match)
  4331. match (car matcher)
  4332. matcher (cdr matcher))
  4333. (org-compile-prefix-format 'tags)
  4334. (org-set-sorting-strategy 'tags)
  4335. (setq org-agenda-query-string match)
  4336. (setq org-agenda-redo-command
  4337. (list 'org-tags-view
  4338. `(quote ,org--matcher-tags-todo-only)
  4339. `(if current-prefix-arg nil ,org-agenda-query-string)))
  4340. (setq files (org-agenda-files nil 'ifmode)
  4341. rtnall nil)
  4342. (while (setq file (pop files))
  4343. (catch 'nextfile
  4344. (org-check-agenda-file file)
  4345. (setq buffer (if (file-exists-p file)
  4346. (org-get-agenda-file-buffer file)
  4347. (error "No such file %s" file)))
  4348. (if (not buffer)
  4349. ;; If file does not exist, error message to agenda
  4350. (setq rtn (list
  4351. (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4352. rtnall (append rtnall rtn))
  4353. (with-current-buffer buffer
  4354. (unless (derived-mode-p 'org-mode)
  4355. (error "Agenda file %s is not in `org-mode'" file))
  4356. (save-excursion
  4357. (save-restriction
  4358. (if (eq buffer org-agenda-restrict)
  4359. (narrow-to-region org-agenda-restrict-begin
  4360. org-agenda-restrict-end)
  4361. (widen))
  4362. (setq rtn (org-scan-tags 'agenda
  4363. matcher
  4364. org--matcher-tags-todo-only))
  4365. (setq rtnall (append rtnall rtn))))))))
  4366. (if org-agenda-overriding-header
  4367. (insert (org-add-props (copy-sequence org-agenda-overriding-header)
  4368. nil 'face 'org-agenda-structure) "\n")
  4369. (insert "Headlines with TAGS match: ")
  4370. (add-text-properties (point-min) (1- (point))
  4371. (list 'face 'org-agenda-structure
  4372. 'short-heading
  4373. (concat "Match: " match)))
  4374. (setq pos (point))
  4375. (insert match "\n")
  4376. (add-text-properties pos (1- (point)) (list 'face 'org-warning))
  4377. (setq pos (point))
  4378. (unless org-agenda-multi
  4379. (insert (substitute-command-keys
  4380. "Press `\\[universal-argument] \\[org-agenda-redo]' \
  4381. to search again with new search string\n")))
  4382. (add-text-properties pos (1- (point))
  4383. (list 'face 'org-agenda-structure)))
  4384. (org-agenda-mark-header-line (point-min))
  4385. (when rtnall
  4386. (insert (org-agenda-finalize-entries rtnall 'tags) "\n"))
  4387. (goto-char (point-min))
  4388. (or org-agenda-multi (org-agenda-fit-window-to-buffer))
  4389. (add-text-properties
  4390. (point-min) (point-max)
  4391. `(org-agenda-type tags
  4392. org-last-args (,org--matcher-tags-todo-only ,match)
  4393. org-redo-cmd ,org-agenda-redo-command
  4394. org-series-cmd ,org-cmd))
  4395. (org-agenda-finalize)
  4396. (setq buffer-read-only t))))
  4397. ;;; Agenda Finding stuck projects
  4398. (defvar org-agenda-skip-regexp nil
  4399. "Regular expression used in skipping subtrees for the agenda.
  4400. This is basically a temporary global variable that can be set and then
  4401. used by user-defined selections using `org-agenda-skip-function'.")
  4402. (defvar org-agenda-overriding-header nil
  4403. "When set during agenda, todo and tags searches it replaces the header.
  4404. This variable should not be set directly, but custom commands can bind it
  4405. in the options section.")
  4406. (defun org-agenda-skip-entry-if (&rest conditions)
  4407. "Skip entry if any of CONDITIONS is true.
  4408. See `org-agenda-skip-if' for details."
  4409. (org-agenda-skip-if nil conditions))
  4410. (defun org-agenda-skip-subtree-if (&rest conditions)
  4411. "Skip subtree if any of CONDITIONS is true.
  4412. See `org-agenda-skip-if' for details."
  4413. (org-agenda-skip-if t conditions))
  4414. (defun org-agenda-skip-if (subtree conditions)
  4415. "Checks current entity for CONDITIONS.
  4416. If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
  4417. the entry (i.e. the text before the next heading) is checked.
  4418. CONDITIONS is a list of symbols, boolean OR is used to combine the results
  4419. from different tests. Valid conditions are:
  4420. scheduled Check if there is a scheduled cookie
  4421. notscheduled Check if there is no scheduled cookie
  4422. deadline Check if there is a deadline
  4423. notdeadline Check if there is no deadline
  4424. timestamp Check if there is a timestamp (also deadline or scheduled)
  4425. nottimestamp Check if there is no timestamp (also deadline or scheduled)
  4426. regexp Check if regexp matches
  4427. notregexp Check if regexp does not match.
  4428. todo Check if TODO keyword matches
  4429. nottodo Check if TODO keyword does not match
  4430. The regexp is taken from the conditions list, it must come right after
  4431. the `regexp' or `notregexp' element.
  4432. `todo' and `nottodo' accept as an argument a list of todo
  4433. keywords, which may include \"*\" to match any todo keyword.
  4434. (org-agenda-skip-entry-if \\='todo \\='(\"TODO\" \"WAITING\"))
  4435. would skip all entries with \"TODO\" or \"WAITING\" keywords.
  4436. Instead of a list, a keyword class may be given. For example:
  4437. (org-agenda-skip-entry-if \\='nottodo \\='done)
  4438. would skip entries that haven't been marked with any of \"DONE\"
  4439. keywords. Possible classes are: `todo', `done', `any'.
  4440. If any of these conditions is met, this function returns the end point of
  4441. the entity, causing the search to continue from there. This is a function
  4442. that can be put into `org-agenda-skip-function' for the duration of a command."
  4443. (let (beg end m)
  4444. (org-back-to-heading t)
  4445. (setq beg (point)
  4446. end (if subtree
  4447. (progn (org-end-of-subtree t) (point))
  4448. (progn (outline-next-heading) (1- (point)))))
  4449. (goto-char beg)
  4450. (and
  4451. (or
  4452. (and (memq 'scheduled conditions)
  4453. (re-search-forward org-scheduled-time-regexp end t))
  4454. (and (memq 'notscheduled conditions)
  4455. (not (re-search-forward org-scheduled-time-regexp end t)))
  4456. (and (memq 'deadline conditions)
  4457. (re-search-forward org-deadline-time-regexp end t))
  4458. (and (memq 'notdeadline conditions)
  4459. (not (re-search-forward org-deadline-time-regexp end t)))
  4460. (and (memq 'timestamp conditions)
  4461. (re-search-forward org-ts-regexp end t))
  4462. (and (memq 'nottimestamp conditions)
  4463. (not (re-search-forward org-ts-regexp end t)))
  4464. (and (setq m (memq 'regexp conditions))
  4465. (stringp (nth 1 m))
  4466. (re-search-forward (nth 1 m) end t))
  4467. (and (setq m (memq 'notregexp conditions))
  4468. (stringp (nth 1 m))
  4469. (not (re-search-forward (nth 1 m) end t)))
  4470. (and (or
  4471. (setq m (memq 'nottodo conditions))
  4472. (setq m (memq 'todo-unblocked conditions))
  4473. (setq m (memq 'nottodo-unblocked conditions))
  4474. (setq m (memq 'todo conditions)))
  4475. (org-agenda-skip-if-todo m end)))
  4476. end)))
  4477. (defun org-agenda-skip-if-todo (args end)
  4478. "Helper function for `org-agenda-skip-if', do not use it directly.
  4479. ARGS is a list with first element either `todo', `nottodo',
  4480. `todo-unblocked' or `nottodo-unblocked'. The remainder is either
  4481. a list of TODO keywords, or a state symbol `todo' or `done' or
  4482. `any'."
  4483. (let ((kw (car args))
  4484. (arg (cadr args))
  4485. todo-wds todo-re)
  4486. (setq todo-wds
  4487. (org-uniquify
  4488. (cond
  4489. ((listp arg) ;; list of keywords
  4490. (if (member "*" arg)
  4491. (mapcar 'substring-no-properties org-todo-keywords-1)
  4492. arg))
  4493. ((symbolp arg) ;; keyword class name
  4494. (cond
  4495. ((eq arg 'todo)
  4496. (org-delete-all org-done-keywords
  4497. (mapcar 'substring-no-properties
  4498. org-todo-keywords-1)))
  4499. ((eq arg 'done) org-done-keywords)
  4500. ((eq arg 'any)
  4501. (mapcar 'substring-no-properties org-todo-keywords-1)))))))
  4502. (setq todo-re
  4503. (concat "^\\*+[ \t]+\\<\\("
  4504. (mapconcat 'identity todo-wds "\\|")
  4505. "\\)\\>"))
  4506. (cond
  4507. ((eq kw 'todo) (re-search-forward todo-re end t))
  4508. ((eq kw 'nottodo) (not (re-search-forward todo-re end t)))
  4509. ((eq kw 'todo-unblocked)
  4510. (catch 'unblocked
  4511. (while (re-search-forward todo-re end t)
  4512. (or (org-entry-blocked-p) (throw 'unblocked t)))
  4513. nil))
  4514. ((eq kw 'nottodo-unblocked)
  4515. (catch 'unblocked
  4516. (while (re-search-forward todo-re end t)
  4517. (or (org-entry-blocked-p) (throw 'unblocked nil)))
  4518. t))
  4519. )))
  4520. ;;;###autoload
  4521. (defun org-agenda-list-stuck-projects (&rest ignore)
  4522. "Create agenda view for projects that are stuck.
  4523. Stuck projects are project that have no next actions. For the definitions
  4524. of what a project is and how to check if it stuck, customize the variable
  4525. `org-stuck-projects'."
  4526. (interactive)
  4527. (let* ((org-agenda-overriding-header
  4528. (or org-agenda-overriding-header "List of stuck projects: "))
  4529. (matcher (nth 0 org-stuck-projects))
  4530. (todo (nth 1 org-stuck-projects))
  4531. (tags (nth 2 org-stuck-projects))
  4532. (gen-re (org-string-nw-p (nth 3 org-stuck-projects)))
  4533. (todo-wds
  4534. (if (not (member "*" todo)) todo
  4535. (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
  4536. (org-delete-all org-done-keywords-for-agenda
  4537. (copy-sequence org-todo-keywords-for-agenda))))
  4538. (todo-re (and todo
  4539. (format "^\\*+[ \t]+\\(%s\\)\\>"
  4540. (mapconcat #'identity todo-wds "\\|"))))
  4541. (tags-re (cond ((null tags) nil)
  4542. ((member "*" tags)
  4543. (eval-when-compile
  4544. (concat org-outline-regexp-bol
  4545. ".*:[[:alnum:]_@#%]+:[ \t]*$")))
  4546. (tags (concat org-outline-regexp-bol
  4547. ".*:\\("
  4548. (mapconcat #'identity tags "\\|")
  4549. "\\):[[:alnum:]_@#%:]*[ \t]*$"))
  4550. (t nil)))
  4551. (re-list (delq nil (list todo-re tags-re gen-re)))
  4552. (skip-re
  4553. (if (null re-list)
  4554. (error "Missing information to identify unstuck projects")
  4555. (mapconcat #'identity re-list "\\|")))
  4556. (org-agenda-skip-function
  4557. ;; Skip entry if `org-agenda-skip-regexp' matches anywhere
  4558. ;; in the subtree.
  4559. `(lambda ()
  4560. (and (save-excursion
  4561. (let ((case-fold-search nil))
  4562. (re-search-forward
  4563. ,skip-re (save-excursion (org-end-of-subtree t)) t)))
  4564. (progn (outline-next-heading) (point))))))
  4565. (org-tags-view nil matcher)
  4566. (setq org-agenda-buffer-name (buffer-name))
  4567. (with-current-buffer org-agenda-buffer-name
  4568. (setq org-agenda-redo-command
  4569. `(org-agenda-list-stuck-projects ,current-prefix-arg))
  4570. (let ((inhibit-read-only t))
  4571. (add-text-properties
  4572. (point-min) (point-max)
  4573. `(org-redo-cmd ,org-agenda-redo-command))))))
  4574. ;;; Diary integration
  4575. (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
  4576. (defvar diary-list-entries-hook)
  4577. (defvar diary-time-regexp)
  4578. (defun org-get-entries-from-diary (date)
  4579. "Get the (Emacs Calendar) diary entries for DATE."
  4580. (require 'diary-lib)
  4581. (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
  4582. (diary-display-function 'diary-fancy-display)
  4583. (pop-up-frames nil)
  4584. (diary-list-entries-hook
  4585. (cons 'org-diary-default-entry diary-list-entries-hook))
  4586. (diary-file-name-prefix nil) ; turn this feature off
  4587. (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
  4588. entries
  4589. (org-disable-agenda-to-diary t))
  4590. (save-excursion
  4591. (save-window-excursion
  4592. (funcall (if (fboundp 'diary-list-entries)
  4593. 'diary-list-entries 'list-diary-entries)
  4594. date 1)))
  4595. (if (not (get-buffer diary-fancy-buffer))
  4596. (setq entries nil)
  4597. (with-current-buffer diary-fancy-buffer
  4598. (setq buffer-read-only nil)
  4599. (if (zerop (buffer-size))
  4600. ;; No entries
  4601. (setq entries nil)
  4602. ;; Omit the date and other unnecessary stuff
  4603. (org-agenda-cleanup-fancy-diary)
  4604. ;; Add prefix to each line and extend the text properties
  4605. (if (zerop (buffer-size))
  4606. (setq entries nil)
  4607. (setq entries (buffer-substring (point-min) (- (point-max) 1)))
  4608. (setq entries
  4609. (with-temp-buffer
  4610. (insert entries) (goto-char (point-min))
  4611. (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
  4612. (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
  4613. (replace-match (concat "; " (match-string 1)))))
  4614. (buffer-string)))))
  4615. (set-buffer-modified-p nil)
  4616. (kill-buffer diary-fancy-buffer)))
  4617. (when entries
  4618. (setq entries (org-split-string entries "\n"))
  4619. (setq entries
  4620. (mapcar
  4621. (lambda (x)
  4622. (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
  4623. ;; Extend the text properties to the beginning of the line
  4624. (org-add-props x (text-properties-at (1- (length x)) x)
  4625. 'type "diary" 'date date 'face 'org-agenda-diary))
  4626. entries)))))
  4627. (defvar org-agenda-cleanup-fancy-diary-hook nil
  4628. "Hook run when the fancy diary buffer is cleaned up.")
  4629. (defun org-agenda-cleanup-fancy-diary ()
  4630. "Remove unwanted stuff in buffer created by `fancy-diary-display'.
  4631. This gets rid of the date, the underline under the date, and
  4632. the dummy entry installed by `org-mode' to ensure non-empty diary for each
  4633. date. It also removes lines that contain only whitespace."
  4634. (goto-char (point-min))
  4635. (if (looking-at ".*?:[ \t]*")
  4636. (progn
  4637. (replace-match "")
  4638. (re-search-forward "\n=+$" nil t)
  4639. (replace-match "")
  4640. (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
  4641. (re-search-forward "\n=+$" nil t)
  4642. (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
  4643. (goto-char (point-min))
  4644. (while (re-search-forward "^ +\n" nil t)
  4645. (replace-match ""))
  4646. (goto-char (point-min))
  4647. (if (re-search-forward "^Org mode dummy\n?" nil t)
  4648. (replace-match ""))
  4649. (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
  4650. ;; Make sure entries from the diary have the right text properties.
  4651. (eval-after-load "diary-lib"
  4652. '(if (boundp 'diary-modify-entry-list-string-function)
  4653. ;; We can rely on the hook, nothing to do
  4654. nil
  4655. ;; Hook not available, must use advice to make this work
  4656. (defadvice add-to-diary-list (before org-mark-diary-entry activate)
  4657. "Make the position visible."
  4658. (if (and org-disable-agenda-to-diary ;; called from org-agenda
  4659. (stringp string)
  4660. buffer-file-name)
  4661. (setq string (org-modify-diary-entry-string string))))))
  4662. (defun org-modify-diary-entry-string (string)
  4663. "Add text properties to string, allowing Org to act on it."
  4664. (org-add-props string nil
  4665. 'mouse-face 'highlight
  4666. 'help-echo (if buffer-file-name
  4667. (format "mouse-2 or RET jump to diary file %s"
  4668. (abbreviate-file-name buffer-file-name))
  4669. "")
  4670. 'org-agenda-diary-link t
  4671. 'org-marker (org-agenda-new-marker (point-at-bol))))
  4672. (defun org-diary-default-entry ()
  4673. "Add a dummy entry to the diary.
  4674. Needed to avoid empty dates which mess up holiday display."
  4675. ;; Catch the error if dealing with the new add-to-diary-alist
  4676. (when org-disable-agenda-to-diary
  4677. (condition-case nil
  4678. (org-add-to-diary-list original-date "Org mode dummy" "")
  4679. (error
  4680. (org-add-to-diary-list original-date "Org mode dummy" "" nil)))))
  4681. (defun org-add-to-diary-list (&rest args)
  4682. (if (fboundp 'diary-add-to-list)
  4683. (apply 'diary-add-to-list args)
  4684. (apply 'add-to-diary-list args)))
  4685. (defvar org-diary-last-run-time nil)
  4686. ;;;###autoload
  4687. (defun org-diary (&rest args)
  4688. "Return diary information from org files.
  4689. This function can be used in a \"sexp\" diary entry in the Emacs calendar.
  4690. It accesses org files and extracts information from those files to be
  4691. listed in the diary. The function accepts arguments specifying what
  4692. items should be listed. For a list of arguments allowed here, see the
  4693. variable `org-agenda-entry-types'.
  4694. The call in the diary file should look like this:
  4695. &%%(org-diary) ~/path/to/some/orgfile.org
  4696. Use a separate line for each org file to check. Or, if you omit the file name,
  4697. all files listed in `org-agenda-files' will be checked automatically:
  4698. &%%(org-diary)
  4699. If you don't give any arguments (as in the example above), the default value
  4700. of `org-agenda-entry-types' is used: (:deadline :scheduled :timestamp :sexp).
  4701. So the example above may also be written as
  4702. &%%(org-diary :deadline :timestamp :sexp :scheduled)
  4703. The function expects the lisp variables `entry' and `date' to be provided
  4704. by the caller, because this is how the calendar works. Don't use this
  4705. function from a program - use `org-agenda-get-day-entries' instead."
  4706. (when (> (- (float-time)
  4707. org-agenda-last-marker-time)
  4708. 5)
  4709. ;; I am not sure if this works with sticky agendas, because the marker
  4710. ;; list is then no longer a global variable.
  4711. (org-agenda-reset-markers))
  4712. (org-compile-prefix-format 'agenda)
  4713. (org-set-sorting-strategy 'agenda)
  4714. (setq args (or args org-agenda-entry-types))
  4715. (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
  4716. (list entry)
  4717. (org-agenda-files t)))
  4718. (time (float-time))
  4719. file rtn results)
  4720. (when (or (not org-diary-last-run-time)
  4721. (> (- time
  4722. org-diary-last-run-time)
  4723. 3))
  4724. (org-agenda-prepare-buffers files))
  4725. (setq org-diary-last-run-time time)
  4726. ;; If this is called during org-agenda, don't return any entries to
  4727. ;; the calendar. Org Agenda will list these entries itself.
  4728. (if org-disable-agenda-to-diary (setq files nil))
  4729. (while (setq file (pop files))
  4730. (setq rtn (apply 'org-agenda-get-day-entries file date args))
  4731. (setq results (append results rtn)))
  4732. (when results
  4733. (setq results
  4734. (mapcar (lambda (i) (replace-regexp-in-string
  4735. org-bracket-link-regexp "\\3" i)) results))
  4736. (concat (org-agenda-finalize-entries results) "\n"))))
  4737. ;;; Agenda entry finders
  4738. (defun org-agenda--timestamp-to-absolute (&rest args)
  4739. "Call `org-time-string-to-absolute' with ARGS.
  4740. However, throw `:skip' whenever an error is raised."
  4741. (condition-case e
  4742. (apply #'org-time-string-to-absolute args)
  4743. (org-diary-sexp-no-match (throw :skip nil))
  4744. (error
  4745. (message "%s; Skipping entry" (error-message-string e))
  4746. (throw :skip nil))))
  4747. (defun org-agenda-get-day-entries (file date &rest args)
  4748. "Does the work for `org-diary' and `org-agenda'.
  4749. FILE is the path to a file to be checked for entries. DATE is date like
  4750. the one returned by `calendar-current-date'. ARGS are symbols indicating
  4751. which kind of entries should be extracted. For details about these, see
  4752. the documentation of `org-diary'."
  4753. (let* ((org-startup-folded nil)
  4754. (org-startup-align-all-tables nil)
  4755. (buffer (if (file-exists-p file) (org-get-agenda-file-buffer file)
  4756. (error "No such file %s" file))))
  4757. (if (not buffer)
  4758. ;; If file does not exist, signal it in diary nonetheless.
  4759. (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
  4760. (with-current-buffer buffer
  4761. (unless (derived-mode-p 'org-mode)
  4762. (error "Agenda file %s is not in `org-mode'" file))
  4763. (setq org-agenda-buffer (or org-agenda-buffer buffer))
  4764. (setf org-agenda-current-date date)
  4765. (save-excursion
  4766. (save-restriction
  4767. (if (eq buffer org-agenda-restrict)
  4768. (narrow-to-region org-agenda-restrict-begin
  4769. org-agenda-restrict-end)
  4770. (widen))
  4771. ;; Rationalize ARGS. Also make sure `:deadline' comes
  4772. ;; first in order to populate DEADLINES before passing it.
  4773. ;;
  4774. ;; We use `delq' since `org-uniquify' duplicates ARGS,
  4775. ;; guarding us from modifying `org-agenda-entry-types'.
  4776. (setf args (org-uniquify (or args org-agenda-entry-types)))
  4777. (when (and (memq :scheduled args) (memq :scheduled* args))
  4778. (setf args (delq :scheduled* args)))
  4779. (cond
  4780. ((memq :deadline args)
  4781. (setf args (cons :deadline
  4782. (delq :deadline (delq :deadline* args)))))
  4783. ((memq :deadline* args)
  4784. (setf args (cons :deadline* (delq :deadline* args)))))
  4785. ;; Collect list of headlines. Return them flattened.
  4786. (let ((case-fold-search nil) results deadlines)
  4787. (dolist (arg args (apply #'nconc (nreverse results)))
  4788. (pcase arg
  4789. ((and :todo (guard (org-agenda-today-p date)))
  4790. (push (org-agenda-get-todos) results))
  4791. (:timestamp
  4792. (push (org-agenda-get-blocks) results)
  4793. (push (org-agenda-get-timestamps deadlines) results))
  4794. (:sexp
  4795. (push (org-agenda-get-sexps) results))
  4796. (:scheduled
  4797. (push (org-agenda-get-scheduled deadlines) results))
  4798. (:scheduled*
  4799. (push (org-agenda-get-scheduled deadlines t) results))
  4800. (:closed
  4801. (push (org-agenda-get-progress) results))
  4802. (:deadline
  4803. (setf deadlines (org-agenda-get-deadlines))
  4804. (push deadlines results))
  4805. (:deadline*
  4806. (setf deadlines (org-agenda-get-deadlines t))
  4807. (push deadlines results)))))))))))
  4808. (defsubst org-em (x y list)
  4809. "Is X or Y a member of LIST?"
  4810. (or (memq x list) (memq y list)))
  4811. (defvar org-heading-keyword-regexp-format) ; defined in org.el
  4812. (defvar org-agenda-sorting-strategy-selected nil)
  4813. (defun org-agenda-entry-get-agenda-timestamp (pom)
  4814. "Retrieve timestamp information for sorting agenda views.
  4815. Given a point or marker POM, returns a cons cell of the timestamp
  4816. and the timestamp type relevant for the sorting strategy in
  4817. `org-agenda-sorting-strategy-selected'."
  4818. (let (ts ts-date-type)
  4819. (save-match-data
  4820. (cond ((org-em 'scheduled-up 'scheduled-down
  4821. org-agenda-sorting-strategy-selected)
  4822. (setq ts (org-entry-get pom "SCHEDULED")
  4823. ts-date-type " scheduled"))
  4824. ((org-em 'deadline-up 'deadline-down
  4825. org-agenda-sorting-strategy-selected)
  4826. (setq ts (org-entry-get pom "DEADLINE")
  4827. ts-date-type " deadline"))
  4828. ((org-em 'ts-up 'ts-down
  4829. org-agenda-sorting-strategy-selected)
  4830. (setq ts (org-entry-get pom "TIMESTAMP")
  4831. ts-date-type " timestamp"))
  4832. ((org-em 'tsia-up 'tsia-down
  4833. org-agenda-sorting-strategy-selected)
  4834. (setq ts (org-entry-get pom "TIMESTAMP_IA")
  4835. ts-date-type " timestamp_ia"))
  4836. ((org-em 'timestamp-up 'timestamp-down
  4837. org-agenda-sorting-strategy-selected)
  4838. (setq ts (or (org-entry-get pom "SCHEDULED")
  4839. (org-entry-get pom "DEADLINE")
  4840. (org-entry-get pom "TIMESTAMP")
  4841. (org-entry-get pom "TIMESTAMP_IA"))
  4842. ts-date-type ""))
  4843. (t (setq ts-date-type "")))
  4844. (cons (when ts (ignore-errors (org-time-string-to-absolute ts)))
  4845. ts-date-type))))
  4846. (defun org-agenda-get-todos ()
  4847. "Return the TODO information for agenda display."
  4848. (let* ((props (list 'face nil
  4849. 'done-face 'org-agenda-done
  4850. 'org-not-done-regexp org-not-done-regexp
  4851. 'org-todo-regexp org-todo-regexp
  4852. 'org-complex-heading-regexp org-complex-heading-regexp
  4853. 'mouse-face 'highlight
  4854. 'help-echo
  4855. (format "mouse-2 or RET jump to org file %s"
  4856. (abbreviate-file-name buffer-file-name))))
  4857. (case-fold-search nil)
  4858. (regexp (format org-heading-keyword-regexp-format
  4859. (cond
  4860. ((and org-select-this-todo-keyword
  4861. (equal org-select-this-todo-keyword "*"))
  4862. org-todo-regexp)
  4863. (org-select-this-todo-keyword
  4864. (concat "\\("
  4865. (mapconcat 'identity
  4866. (org-split-string
  4867. org-select-this-todo-keyword
  4868. "|")
  4869. "\\|") "\\)"))
  4870. (t org-not-done-regexp))))
  4871. marker priority category level tags todo-state
  4872. ts-date ts-date-type ts-date-pair
  4873. ee txt beg end inherited-tags todo-state-end-pos)
  4874. (goto-char (point-min))
  4875. (while (re-search-forward regexp nil t)
  4876. (catch :skip
  4877. (save-match-data
  4878. (beginning-of-line)
  4879. (org-agenda-skip)
  4880. (setq beg (point) end (save-excursion (outline-next-heading) (point)))
  4881. (unless (and (setq todo-state (org-get-todo-state))
  4882. (setq todo-state-end-pos (match-end 2)))
  4883. (goto-char end)
  4884. (throw :skip nil))
  4885. (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
  4886. (goto-char (1+ beg))
  4887. (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
  4888. (throw :skip nil)))
  4889. (goto-char (match-beginning 2))
  4890. (setq marker (org-agenda-new-marker (match-beginning 0))
  4891. category (org-get-category)
  4892. ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
  4893. ts-date (car ts-date-pair)
  4894. ts-date-type (cdr ts-date-pair)
  4895. txt (org-trim (buffer-substring (match-beginning 2) (match-end 0)))
  4896. inherited-tags
  4897. (or (eq org-agenda-show-inherited-tags 'always)
  4898. (and (listp org-agenda-show-inherited-tags)
  4899. (memq 'todo org-agenda-show-inherited-tags))
  4900. (and (eq org-agenda-show-inherited-tags t)
  4901. (or (eq org-agenda-use-tag-inheritance t)
  4902. (memq 'todo org-agenda-use-tag-inheritance))))
  4903. tags (org-get-tags-at nil (not inherited-tags))
  4904. level (make-string (org-reduced-level (org-outline-level)) ? )
  4905. txt (org-agenda-format-item "" txt level category tags t)
  4906. priority (1+ (org-get-priority txt)))
  4907. (org-add-props txt props
  4908. 'org-marker marker 'org-hd-marker marker
  4909. 'priority priority
  4910. 'level level
  4911. 'ts-date ts-date
  4912. 'type (concat "todo" ts-date-type) 'todo-state todo-state)
  4913. (push txt ee)
  4914. (if org-agenda-todo-list-sublevels
  4915. (goto-char todo-state-end-pos)
  4916. (org-end-of-subtree 'invisible))))
  4917. (nreverse ee)))
  4918. (defun org-agenda-todo-custom-ignore-p (time n)
  4919. "Check whether timestamp is farther away than n number of days.
  4920. This function is invoked if `org-agenda-todo-ignore-deadlines',
  4921. `org-agenda-todo-ignore-scheduled' or
  4922. `org-agenda-todo-ignore-timestamp' is set to an integer."
  4923. (let ((days (org-time-stamp-to-now
  4924. time org-agenda-todo-ignore-time-comparison-use-seconds)))
  4925. (if (>= n 0)
  4926. (>= days n)
  4927. (<= days n))))
  4928. ;;;###autoload
  4929. (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  4930. (&optional end)
  4931. "Do we have a reason to ignore this TODO entry because it has a time stamp?"
  4932. (when (or org-agenda-todo-ignore-with-date
  4933. org-agenda-todo-ignore-scheduled
  4934. org-agenda-todo-ignore-deadlines
  4935. org-agenda-todo-ignore-timestamp)
  4936. (setq end (or end (save-excursion (outline-next-heading) (point))))
  4937. (save-excursion
  4938. (or (and org-agenda-todo-ignore-with-date
  4939. (re-search-forward org-ts-regexp end t))
  4940. (and org-agenda-todo-ignore-scheduled
  4941. (re-search-forward org-scheduled-time-regexp end t)
  4942. (cond
  4943. ((eq org-agenda-todo-ignore-scheduled 'future)
  4944. (> (org-time-stamp-to-now
  4945. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4946. ((eq org-agenda-todo-ignore-scheduled 'past)
  4947. (<= (org-time-stamp-to-now
  4948. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4949. ((numberp org-agenda-todo-ignore-scheduled)
  4950. (org-agenda-todo-custom-ignore-p
  4951. (match-string 1) org-agenda-todo-ignore-scheduled))
  4952. (t)))
  4953. (and org-agenda-todo-ignore-deadlines
  4954. (re-search-forward org-deadline-time-regexp end t)
  4955. (cond
  4956. ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
  4957. ((eq org-agenda-todo-ignore-deadlines 'far)
  4958. (not (org-deadline-close-p (match-string 1))))
  4959. ((eq org-agenda-todo-ignore-deadlines 'future)
  4960. (> (org-time-stamp-to-now
  4961. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4962. ((eq org-agenda-todo-ignore-deadlines 'past)
  4963. (<= (org-time-stamp-to-now
  4964. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4965. ((numberp org-agenda-todo-ignore-deadlines)
  4966. (org-agenda-todo-custom-ignore-p
  4967. (match-string 1) org-agenda-todo-ignore-deadlines))
  4968. (t (org-deadline-close-p (match-string 1)))))
  4969. (and org-agenda-todo-ignore-timestamp
  4970. (let ((buffer (current-buffer))
  4971. (regexp
  4972. (concat
  4973. org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
  4974. (start (point)))
  4975. ;; Copy current buffer into a temporary one
  4976. (with-temp-buffer
  4977. (insert-buffer-substring buffer start end)
  4978. (goto-char (point-min))
  4979. ;; Delete SCHEDULED and DEADLINE items
  4980. (while (re-search-forward regexp end t)
  4981. (delete-region (match-beginning 0) (match-end 0)))
  4982. (goto-char (point-min))
  4983. ;; No search for timestamp left
  4984. (when (re-search-forward org-ts-regexp nil t)
  4985. (cond
  4986. ((eq org-agenda-todo-ignore-timestamp 'future)
  4987. (> (org-time-stamp-to-now
  4988. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4989. ((eq org-agenda-todo-ignore-timestamp 'past)
  4990. (<= (org-time-stamp-to-now
  4991. (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
  4992. ((numberp org-agenda-todo-ignore-timestamp)
  4993. (org-agenda-todo-custom-ignore-p
  4994. (match-string 1) org-agenda-todo-ignore-timestamp))
  4995. (t))))))))))
  4996. (defun org-agenda-get-timestamps (&optional deadlines)
  4997. "Return the date stamp information for agenda display.
  4998. Optional argument DEADLINES is a list of deadline items to be
  4999. displayed in agenda view."
  5000. (let* ((props (list 'face 'org-agenda-calendar-event
  5001. 'org-not-done-regexp org-not-done-regexp
  5002. 'org-todo-regexp org-todo-regexp
  5003. 'org-complex-heading-regexp org-complex-heading-regexp
  5004. 'mouse-face 'highlight
  5005. 'help-echo
  5006. (format "mouse-2 or RET jump to Org file %s"
  5007. (abbreviate-file-name buffer-file-name))))
  5008. (current (calendar-absolute-from-gregorian date))
  5009. (today (org-today))
  5010. (deadline-position-alist
  5011. (mapcar (lambda (d)
  5012. (let ((m (get-text-property 0 'org-hd-marker d)))
  5013. (and m (marker-position m))))
  5014. deadlines))
  5015. ;; Match time-stamps set to current date, time-stamps with
  5016. ;; a repeater, and S-exp time-stamps.
  5017. (regexp
  5018. (concat
  5019. (if org-agenda-include-inactive-timestamps "[[<]" "<")
  5020. (regexp-quote
  5021. (substring
  5022. (format-time-string
  5023. (car org-time-stamp-formats)
  5024. (apply #'encode-time ; DATE bound by calendar
  5025. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  5026. 1 11))
  5027. "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
  5028. "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
  5029. timestamp-items)
  5030. (goto-char (point-min))
  5031. (while (re-search-forward regexp nil t)
  5032. ;; Skip date ranges, scheduled and deadlines, which are handled
  5033. ;; specially. Also skip time-stamps before first headline as
  5034. ;; there would be no entry to add to the agenda. Eventually,
  5035. ;; ignore clock entries.
  5036. (catch :skip
  5037. (save-match-data
  5038. (when (or (org-at-date-range-p)
  5039. (org-at-planning-p)
  5040. (org-before-first-heading-p)
  5041. (and org-agenda-include-inactive-timestamps
  5042. (org-at-clock-log-p)))
  5043. (throw :skip nil))
  5044. (org-agenda-skip))
  5045. (let* ((pos (match-beginning 0))
  5046. (repeat (match-string 1))
  5047. (sexp-entry (match-string 3))
  5048. (time-stamp (if (or repeat sexp-entry) (match-string 0)
  5049. (save-excursion
  5050. (goto-char pos)
  5051. (looking-at org-ts-regexp-both)
  5052. (match-string 0))))
  5053. (todo-state (org-get-todo-state))
  5054. (warntime (get-text-property (point) 'org-appt-warntime))
  5055. (done? (member todo-state org-done-keywords)))
  5056. ;; Possibly skip done tasks.
  5057. (when (and done? org-agenda-skip-timestamp-if-done)
  5058. (throw :skip t))
  5059. ;; S-exp entry doesn't match current day: skip it.
  5060. (when (and sexp-entry (not (org-diary-sexp-entry sexp-entry "" date)))
  5061. (throw :skip nil))
  5062. (when repeat
  5063. (let* ((past
  5064. ;; A repeating time stamp is shown at its base
  5065. ;; date and every repeated date up to TODAY. If
  5066. ;; `org-agenda-prefer-last-repeat' is non-nil,
  5067. ;; however, only the last repeat before today
  5068. ;; (inclusive) is shown.
  5069. (org-agenda--timestamp-to-absolute
  5070. repeat
  5071. (if (or (> current today)
  5072. (eq org-agenda-prefer-last-repeat t)
  5073. (member todo-state org-agenda-prefer-last-repeat))
  5074. today
  5075. current)
  5076. 'past (current-buffer) pos))
  5077. (future
  5078. ;; Display every repeated date past TODAY
  5079. ;; (exclusive) unless
  5080. ;; `org-agenda-show-future-repeats' is nil. If
  5081. ;; this variable is set to `next', only display
  5082. ;; the first repeated date after TODAY
  5083. ;; (exclusive).
  5084. (cond
  5085. ((<= current today) past)
  5086. ((not org-agenda-show-future-repeats) past)
  5087. (t
  5088. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5089. (1+ today)
  5090. current)))
  5091. (org-agenda--timestamp-to-absolute
  5092. repeat base 'future (current-buffer) pos))))))
  5093. (when (and (/= current past) (/= current future))
  5094. (throw :skip nil))))
  5095. (save-excursion
  5096. (re-search-backward org-outline-regexp-bol nil t)
  5097. ;; Possibly skip time-stamp when a deadline is set.
  5098. (when (and org-agenda-skip-timestamp-if-deadline-is-shown
  5099. (assq (point) deadline-position-alist))
  5100. (throw :skip nil))
  5101. (let* ((category (org-get-category pos))
  5102. (inherited-tags
  5103. (or (eq org-agenda-show-inherited-tags 'always)
  5104. (and (consp org-agenda-show-inherited-tags)
  5105. (memq 'agenda org-agenda-show-inherited-tags))
  5106. (and (eq org-agenda-show-inherited-tags t)
  5107. (or (eq org-agenda-use-tag-inheritance t)
  5108. (memq 'agenda
  5109. org-agenda-use-tag-inheritance)))))
  5110. (tags (org-get-tags-at nil (not inherited-tags)))
  5111. (level (make-string (org-reduced-level (org-outline-level))
  5112. ?\s))
  5113. (head (and (looking-at "\\*+[ \t]+\\(.*\\)")
  5114. (match-string 1)))
  5115. (inactive? (= (char-after pos) ?\[))
  5116. (habit? (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  5117. (item
  5118. (org-agenda-format-item
  5119. (and inactive? org-agenda-inactive-leader)
  5120. head level category tags time-stamp org-ts-regexp habit?)))
  5121. (org-add-props item props
  5122. 'priority (if habit?
  5123. (org-habit-get-priority (org-habit-parse-todo))
  5124. (org-get-priority item))
  5125. 'org-marker (org-agenda-new-marker pos)
  5126. 'org-hd-marker (org-agenda-new-marker)
  5127. 'date date
  5128. 'level level
  5129. 'ts-date (if repeat (org-agenda--timestamp-to-absolute repeat)
  5130. current)
  5131. 'todo-state todo-state
  5132. 'warntime warntime
  5133. 'type "timestamp")
  5134. (push item timestamp-items))))
  5135. (when org-agenda-skip-additional-timestamps-same-entry
  5136. (outline-next-heading))))
  5137. (nreverse timestamp-items)))
  5138. (defun org-agenda-get-sexps ()
  5139. "Return the sexp information for agenda display."
  5140. (require 'diary-lib)
  5141. (let* ((props (list 'face 'org-agenda-calendar-sexp
  5142. 'mouse-face 'highlight
  5143. 'help-echo
  5144. (format "mouse-2 or RET jump to org file %s"
  5145. (abbreviate-file-name buffer-file-name))))
  5146. (regexp "^&?%%(")
  5147. marker category extra level ee txt tags entry
  5148. result beg b sexp sexp-entry todo-state warntime inherited-tags)
  5149. (goto-char (point-min))
  5150. (while (re-search-forward regexp nil t)
  5151. (catch :skip
  5152. (org-agenda-skip)
  5153. (setq beg (match-beginning 0))
  5154. (goto-char (1- (match-end 0)))
  5155. (setq b (point))
  5156. (forward-sexp 1)
  5157. (setq sexp (buffer-substring b (point)))
  5158. (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
  5159. (org-trim (match-string 1))
  5160. ""))
  5161. (setq result (org-diary-sexp-entry sexp sexp-entry date))
  5162. (when result
  5163. (setq marker (org-agenda-new-marker beg)
  5164. level (make-string (org-reduced-level (org-outline-level)) ? )
  5165. category (org-get-category beg)
  5166. inherited-tags
  5167. (or (eq org-agenda-show-inherited-tags 'always)
  5168. (and (listp org-agenda-show-inherited-tags)
  5169. (memq 'agenda org-agenda-show-inherited-tags))
  5170. (and (eq org-agenda-show-inherited-tags t)
  5171. (or (eq org-agenda-use-tag-inheritance t)
  5172. (memq 'agenda org-agenda-use-tag-inheritance))))
  5173. tags (org-get-tags-at nil (not inherited-tags))
  5174. todo-state (org-get-todo-state)
  5175. warntime (get-text-property (point) 'org-appt-warntime)
  5176. extra nil)
  5177. (dolist (r (if (stringp result)
  5178. (list result)
  5179. result)) ;; we expect a list here
  5180. (when (and org-agenda-diary-sexp-prefix
  5181. (string-match org-agenda-diary-sexp-prefix r))
  5182. (setq extra (match-string 0 r)
  5183. r (replace-match "" nil nil r)))
  5184. (if (string-match "\\S-" r)
  5185. (setq txt r)
  5186. (setq txt "SEXP entry returned empty string"))
  5187. (setq txt (org-agenda-format-item extra txt level category tags 'time))
  5188. (org-add-props txt props 'org-marker marker
  5189. 'date date 'todo-state todo-state
  5190. 'level level 'type "sexp" 'warntime warntime)
  5191. (push txt ee)))))
  5192. (nreverse ee)))
  5193. ;; Calendar sanity: define some functions that are independent of
  5194. ;; `calendar-date-style'.
  5195. (defun org-anniversary (year month day &optional mark)
  5196. "Like `diary-anniversary', but with fixed (ISO) order of arguments."
  5197. (with-no-warnings
  5198. (let ((calendar-date-style 'iso))
  5199. (diary-anniversary year month day mark))))
  5200. (defun org-cyclic (N year month day &optional mark)
  5201. "Like `diary-cyclic', but with fixed (ISO) order of arguments."
  5202. (with-no-warnings
  5203. (let ((calendar-date-style 'iso))
  5204. (diary-cyclic N year month day mark))))
  5205. (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
  5206. "Like `diary-block', but with fixed (ISO) order of arguments."
  5207. (with-no-warnings
  5208. (let ((calendar-date-style 'iso))
  5209. (diary-block Y1 M1 D1 Y2 M2 D2 mark))))
  5210. (defun org-date (year month day &optional mark)
  5211. "Like `diary-date', but with fixed (ISO) order of arguments."
  5212. (with-no-warnings
  5213. (let ((calendar-date-style 'iso))
  5214. (diary-date year month day mark))))
  5215. ;; Define the `org-class' function
  5216. (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
  5217. "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
  5218. DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
  5219. SKIP-WEEKS is any number of ISO weeks in the block period for which the
  5220. item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
  5221. `holidays', then any date that is known by the Emacs calendar to be a
  5222. holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
  5223. then those holidays will be skipped."
  5224. (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
  5225. (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
  5226. (d (calendar-absolute-from-gregorian date))
  5227. (h (when skip-weeks (calendar-check-holidays date))))
  5228. (and
  5229. (<= date1 d)
  5230. (<= d date2)
  5231. (= (calendar-day-of-week date) dayname)
  5232. (or (not skip-weeks)
  5233. (progn
  5234. (require 'cal-iso)
  5235. (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
  5236. (not (or (and h (memq 'holidays skip-weeks))
  5237. (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
  5238. entry)))
  5239. (defalias 'org-get-closed 'org-agenda-get-progress)
  5240. (defun org-agenda-get-progress ()
  5241. "Return the logged TODO entries for agenda display."
  5242. (let* ((props (list 'mouse-face 'highlight
  5243. 'org-not-done-regexp org-not-done-regexp
  5244. 'org-todo-regexp org-todo-regexp
  5245. 'org-complex-heading-regexp org-complex-heading-regexp
  5246. 'help-echo
  5247. (format "mouse-2 or RET jump to org file %s"
  5248. (abbreviate-file-name buffer-file-name))))
  5249. (items (if (consp org-agenda-show-log-scoped)
  5250. org-agenda-show-log-scoped
  5251. (if (eq org-agenda-show-log-scoped 'clockcheck)
  5252. '(clock)
  5253. org-agenda-log-mode-items)))
  5254. (parts
  5255. (delq nil
  5256. (list
  5257. (if (memq 'closed items) (concat "\\<" org-closed-string))
  5258. (if (memq 'clock items) (concat "\\<" org-clock-string))
  5259. (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
  5260. (parts-re (if parts (mapconcat 'identity parts "\\|")
  5261. (error "`org-agenda-log-mode-items' is empty")))
  5262. (regexp (concat
  5263. "\\(" parts-re "\\)"
  5264. " *\\["
  5265. (regexp-quote
  5266. (substring
  5267. (format-time-string
  5268. (car org-time-stamp-formats)
  5269. (apply 'encode-time ; DATE bound by calendar
  5270. (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
  5271. 1 11))))
  5272. (org-agenda-search-headline-for-time nil)
  5273. marker hdmarker priority category level tags closedp
  5274. statep clockp state ee txt extra timestr rest clocked inherited-tags)
  5275. (goto-char (point-min))
  5276. (while (re-search-forward regexp nil t)
  5277. (catch :skip
  5278. (org-agenda-skip)
  5279. (setq marker (org-agenda-new-marker (match-beginning 0))
  5280. closedp (equal (match-string 1) org-closed-string)
  5281. statep (equal (string-to-char (match-string 1)) ?-)
  5282. clockp (not (or closedp statep))
  5283. state (and statep (match-string 2))
  5284. category (org-get-category (match-beginning 0))
  5285. timestr (buffer-substring (match-beginning 0) (point-at-eol)))
  5286. (when (string-match "\\]" timestr)
  5287. ;; substring should only run to end of time stamp
  5288. (setq rest (substring timestr (match-end 0))
  5289. timestr (substring timestr 0 (match-end 0)))
  5290. (if (and (not closedp) (not statep)
  5291. (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
  5292. rest))
  5293. (progn (setq timestr (concat (substring timestr 0 -1)
  5294. "-" (match-string 1 rest) "]"))
  5295. (setq clocked (match-string 2 rest)))
  5296. (setq clocked "-")))
  5297. (save-excursion
  5298. (setq extra
  5299. (cond
  5300. ((not org-agenda-log-mode-add-notes) nil)
  5301. (statep
  5302. (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
  5303. (match-string 1)))
  5304. (clockp
  5305. (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
  5306. (match-string 1)))))
  5307. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5308. (throw :skip nil)
  5309. (goto-char (match-beginning 0))
  5310. (setq hdmarker (org-agenda-new-marker)
  5311. inherited-tags
  5312. (or (eq org-agenda-show-inherited-tags 'always)
  5313. (and (listp org-agenda-show-inherited-tags)
  5314. (memq 'todo org-agenda-show-inherited-tags))
  5315. (and (eq org-agenda-show-inherited-tags t)
  5316. (or (eq org-agenda-use-tag-inheritance t)
  5317. (memq 'todo org-agenda-use-tag-inheritance))))
  5318. tags (org-get-tags-at nil (not inherited-tags))
  5319. level (make-string (org-reduced-level (org-outline-level)) ? ))
  5320. (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
  5321. (setq txt (match-string 1))
  5322. (when extra
  5323. (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
  5324. (setq txt (concat (substring txt 0 (match-beginning 1))
  5325. " - " extra " " (match-string 2 txt)))
  5326. (setq txt (concat txt " - " extra))))
  5327. (setq txt (org-agenda-format-item
  5328. (cond
  5329. (closedp "Closed: ")
  5330. (statep (concat "State: (" state ")"))
  5331. (t (concat "Clocked: (" clocked ")")))
  5332. txt level category tags timestr)))
  5333. (setq priority 100000)
  5334. (org-add-props txt props
  5335. 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
  5336. 'priority priority 'level level
  5337. 'type "closed" 'date date
  5338. 'undone-face 'org-warning 'done-face 'org-agenda-done)
  5339. (push txt ee))
  5340. (goto-char (point-at-eol))))
  5341. (nreverse ee)))
  5342. (defun org-agenda-show-clocking-issues ()
  5343. "Add overlays, showing issues with clocking.
  5344. See also the user option `org-agenda-clock-consistency-checks'."
  5345. (interactive)
  5346. (let* ((pl org-agenda-clock-consistency-checks)
  5347. (re (concat "^[ \t]*"
  5348. org-clock-string
  5349. "[ \t]+"
  5350. "\\(\\[.*?\\]\\)" ; group 1 is first stamp
  5351. "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
  5352. (tlstart 0.)
  5353. (tlend 0.)
  5354. (maxtime (org-duration-to-minutes
  5355. (or (plist-get pl :max-duration) "24:00")))
  5356. (mintime (org-duration-to-minutes
  5357. (or (plist-get pl :min-duration) 0)))
  5358. (maxgap (org-duration-to-minutes
  5359. ;; default 30:00 means never complain
  5360. (or (plist-get pl :max-gap) "30:00")))
  5361. (gapok (mapcar #'org-duration-to-minutes
  5362. (plist-get pl :gap-ok-around)))
  5363. (def-face (or (plist-get pl :default-face)
  5364. '((:background "DarkRed") (:foreground "white"))))
  5365. issue face m te ts dt ov)
  5366. (goto-char (point-min))
  5367. (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
  5368. (setq issue nil face def-face)
  5369. (catch 'next
  5370. (setq m (org-get-at-bol 'org-marker)
  5371. te nil ts nil)
  5372. (unless (and m (markerp m))
  5373. (setq issue "No valid clock line") (throw 'next t))
  5374. (org-with-point-at m
  5375. (save-excursion
  5376. (goto-char (point-at-bol))
  5377. (unless (looking-at re)
  5378. (error "No valid Clock line")
  5379. (throw 'next t))
  5380. (unless (match-end 3)
  5381. (setq issue "No end time"
  5382. face (or (plist-get pl :no-end-time-face) face))
  5383. (throw 'next t))
  5384. (setq ts (match-string 1)
  5385. te (match-string 3)
  5386. ts (float-time
  5387. (apply #'encode-time (org-parse-time-string ts)))
  5388. te (float-time
  5389. (apply #'encode-time (org-parse-time-string te)))
  5390. dt (- te ts))))
  5391. (cond
  5392. ((> dt (* 60 maxtime))
  5393. ;; a very long clocking chunk
  5394. (setq issue (format "Clocking interval is very long: %s"
  5395. (org-duration-from-minutes (floor (/ dt 60.))))
  5396. face (or (plist-get pl :long-face) face)))
  5397. ((< dt (* 60 mintime))
  5398. ;; a very short clocking chunk
  5399. (setq issue (format "Clocking interval is very short: %s"
  5400. (org-duration-from-minutes (floor (/ dt 60.))))
  5401. face (or (plist-get pl :short-face) face)))
  5402. ((and (> tlend 0) (< ts tlend))
  5403. ;; Two clock entries are overlapping
  5404. (setq issue (format "Clocking overlap: %d minutes"
  5405. (/ (- tlend ts) 60))
  5406. face (or (plist-get pl :overlap-face) face)))
  5407. ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
  5408. ;; There is a gap, lets see if we need to report it
  5409. (unless (org-agenda-check-clock-gap tlend ts gapok)
  5410. (setq issue (format "Clocking gap: %d minutes"
  5411. (/ (- ts tlend) 60))
  5412. face (or (plist-get pl :gap-face) face))))
  5413. (t nil)))
  5414. (setq tlend (or te tlend) tlstart (or ts tlstart))
  5415. (when issue
  5416. ;; OK, there was some issue, add an overlay to show the issue
  5417. (setq ov (make-overlay (point-at-bol) (point-at-eol)))
  5418. (overlay-put ov 'before-string
  5419. (concat
  5420. (org-add-props
  5421. (format "%-43s" (concat " " issue))
  5422. nil
  5423. 'face face)
  5424. "\n"))
  5425. (overlay-put ov 'evaporate t)))))
  5426. (defun org-agenda-check-clock-gap (t1 t2 ok-list)
  5427. "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
  5428. (catch 'exit
  5429. (unless ok-list
  5430. ;; there are no OK times for gaps...
  5431. (throw 'exit nil))
  5432. (if (> (- (/ t2 36000) (/ t1 36000)) 24)
  5433. ;; This is more than 24 hours, so it is OK.
  5434. ;; because we have at least one OK time, that must be in the
  5435. ;; 24 hour interval.
  5436. (throw 'exit t))
  5437. ;; We have a shorter gap.
  5438. ;; Now we have to get the minute of the day when these times are
  5439. (let* ((t1dec (decode-time (seconds-to-time t1)))
  5440. (t2dec (decode-time (seconds-to-time t2)))
  5441. ;; compute the minute on the day
  5442. (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
  5443. (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
  5444. (when (< min2 min1)
  5445. ;; if min2 is smaller than min1, this means it is on the next day.
  5446. ;; Wrap it to after midnight.
  5447. (setq min2 (+ min2 1440)))
  5448. ;; Now check if any of the OK times is in the gap
  5449. (mapc (lambda (x)
  5450. ;; Wrap the time to after midnight if necessary
  5451. (if (< x min1) (setq x (+ x 1440)))
  5452. ;; Check if in interval
  5453. (and (<= min1 x) (>= min2 x) (throw 'exit t)))
  5454. ok-list)
  5455. ;; Nope, this gap is not OK
  5456. nil)))
  5457. (defun org-agenda-get-deadlines (&optional with-hour)
  5458. "Return the deadline information for agenda display.
  5459. When WITH-HOUR is non-nil, only return deadlines with an hour
  5460. specification like [h]h:mm."
  5461. (let* ((props (list 'mouse-face 'highlight
  5462. 'org-not-done-regexp org-not-done-regexp
  5463. 'org-todo-regexp org-todo-regexp
  5464. 'org-complex-heading-regexp org-complex-heading-regexp
  5465. 'help-echo
  5466. (format "mouse-2 or RET jump to org file %s"
  5467. (abbreviate-file-name buffer-file-name))))
  5468. (regexp (if with-hour
  5469. org-deadline-time-hour-regexp
  5470. org-deadline-time-regexp))
  5471. (today (org-today))
  5472. (today? (org-agenda-today-p date)) ; DATE bound by calendar.
  5473. (current (calendar-absolute-from-gregorian date))
  5474. deadline-items)
  5475. (goto-char (point-min))
  5476. (while (re-search-forward regexp nil t)
  5477. (catch :skip
  5478. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5479. (org-agenda-skip)
  5480. (let* ((s (match-string 1))
  5481. (pos (1- (match-beginning 1)))
  5482. (todo-state (save-match-data (org-get-todo-state)))
  5483. (done? (member todo-state org-done-keywords))
  5484. (sexp? (string-prefix-p "%%" s))
  5485. ;; DEADLINE is the deadline date for the entry. It is
  5486. ;; either the base date or the last repeat, according
  5487. ;; to `org-agenda-prefer-last-repeat'.
  5488. (deadline
  5489. (cond
  5490. (sexp? (org-agenda--timestamp-to-absolute s current))
  5491. ((or (eq org-agenda-prefer-last-repeat t)
  5492. (member todo-state org-agenda-prefer-last-repeat))
  5493. (org-agenda--timestamp-to-absolute
  5494. s today 'past (current-buffer) pos))
  5495. (t (org-agenda--timestamp-to-absolute s))))
  5496. ;; REPEAT is the future repeat closest from CURRENT,
  5497. ;; according to `org-agenda-show-future-repeats'. If
  5498. ;; the latter is nil, or if the time stamp has no
  5499. ;; repeat part, default to DEADLINE.
  5500. (repeat
  5501. (cond
  5502. (sexp? deadline)
  5503. ((<= current today) deadline)
  5504. ((not org-agenda-show-future-repeats) deadline)
  5505. (t
  5506. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5507. (1+ today)
  5508. current)))
  5509. (org-agenda--timestamp-to-absolute
  5510. s base 'future (current-buffer) pos)))))
  5511. (diff (- deadline current))
  5512. (suppress-prewarning
  5513. (let ((scheduled
  5514. (and org-agenda-skip-deadline-prewarning-if-scheduled
  5515. (org-entry-get nil "SCHEDULED"))))
  5516. (cond
  5517. ((not scheduled) nil)
  5518. ;; The current item has a scheduled date, so
  5519. ;; evaluate its prewarning lead time.
  5520. ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
  5521. ;; Use global prewarning-restart lead time.
  5522. org-agenda-skip-deadline-prewarning-if-scheduled)
  5523. ((eq org-agenda-skip-deadline-prewarning-if-scheduled
  5524. 'pre-scheduled)
  5525. ;; Set pre-warning to no earlier than SCHEDULED.
  5526. (min (- deadline
  5527. (org-agenda--timestamp-to-absolute scheduled))
  5528. org-deadline-warning-days))
  5529. ;; Set pre-warning to deadline.
  5530. (t 0))))
  5531. (wdays (if suppress-prewarning
  5532. (let ((org-deadline-warning-days suppress-prewarning))
  5533. (org-get-wdays s))
  5534. (org-get-wdays s))))
  5535. (cond
  5536. ;; Only display deadlines at their base date, at future
  5537. ;; repeat occurrences or in today agenda.
  5538. ((= current deadline) nil)
  5539. ((= current repeat) nil)
  5540. ((not today?) (throw :skip nil))
  5541. ;; Upcoming deadline: display within warning period WDAYS.
  5542. ((> deadline current) (when (> diff wdays) (throw :skip nil)))
  5543. ;; Overdue deadline: warn about it for
  5544. ;; `org-deadline-past-days' duration.
  5545. (t (when (< org-deadline-past-days (- diff)) (throw :skip nil))))
  5546. ;; Possibly skip done tasks.
  5547. (when (and done?
  5548. (or org-agenda-skip-deadline-if-done
  5549. (/= deadline current)))
  5550. (throw :skip nil))
  5551. (save-excursion
  5552. (re-search-backward "^\\*+[ \t]+" nil t)
  5553. (goto-char (match-end 0))
  5554. (let* ((category (org-get-category))
  5555. (level (make-string (org-reduced-level (org-outline-level))
  5556. ?\s))
  5557. (head (buffer-substring (point) (line-end-position)))
  5558. (inherited-tags
  5559. (or (eq org-agenda-show-inherited-tags 'always)
  5560. (and (listp org-agenda-show-inherited-tags)
  5561. (memq 'agenda org-agenda-show-inherited-tags))
  5562. (and (eq org-agenda-show-inherited-tags t)
  5563. (or (eq org-agenda-use-tag-inheritance t)
  5564. (memq 'agenda
  5565. org-agenda-use-tag-inheritance)))))
  5566. (tags (org-get-tags-at nil (not inherited-tags)))
  5567. (time
  5568. (cond
  5569. ;; No time of day designation if it is only
  5570. ;; a reminder.
  5571. ((and (/= current deadline) (/= current repeat)) nil)
  5572. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5573. (concat (substring s (match-beginning 1)) " "))
  5574. (t 'time)))
  5575. (item
  5576. (org-agenda-format-item
  5577. ;; Insert appropriate suffixes before deadlines.
  5578. ;; Those only apply to today agenda.
  5579. (pcase-let ((`(,now ,future ,past)
  5580. org-agenda-deadline-leaders))
  5581. (cond
  5582. ((and today? (< deadline today)) (format past (- diff)))
  5583. ((and today? (> deadline today)) (format future diff))
  5584. (t now)))
  5585. head level category tags time))
  5586. (face (org-agenda-deadline-face
  5587. (- 1 (/ (float diff) (max wdays 1)))))
  5588. (upcoming? (and today? (> deadline today)))
  5589. (warntime (get-text-property (point) 'org-appt-warntime)))
  5590. (org-add-props item props
  5591. 'org-marker (org-agenda-new-marker pos)
  5592. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  5593. 'warntime warntime
  5594. 'level level
  5595. 'ts-date deadline
  5596. 'priority
  5597. ;; Adjust priority to today reminders about deadlines.
  5598. ;; Overdue deadlines get the highest priority
  5599. ;; increase, then imminent deadlines and eventually
  5600. ;; more distant deadlines.
  5601. (let ((adjust (if today? (- diff) 0)))
  5602. (+ adjust (org-get-priority item)))
  5603. 'todo-state todo-state
  5604. 'type (if upcoming? "upcoming-deadline" "deadline")
  5605. 'date (if upcoming? date deadline)
  5606. 'face (if done? 'org-agenda-done face)
  5607. 'undone-face face
  5608. 'done-face 'org-agenda-done)
  5609. (push item deadline-items))))))
  5610. (nreverse deadline-items)))
  5611. (defun org-agenda-deadline-face (fraction)
  5612. "Return the face to displaying a deadline item.
  5613. FRACTION is what fraction of the head-warning time has passed."
  5614. (assoc-default fraction org-agenda-deadline-faces #'<=))
  5615. (defun org-agenda-get-scheduled (&optional deadlines with-hour)
  5616. "Return the scheduled information for agenda display.
  5617. Optional argument DEADLINES is a list of deadline items to be
  5618. displayed in agenda view. When WITH-HOUR is non-nil, only return
  5619. scheduled items with an hour specification like [h]h:mm."
  5620. (let* ((props (list 'org-not-done-regexp org-not-done-regexp
  5621. 'org-todo-regexp org-todo-regexp
  5622. 'org-complex-heading-regexp org-complex-heading-regexp
  5623. 'done-face 'org-agenda-done
  5624. 'mouse-face 'highlight
  5625. 'help-echo
  5626. (format "mouse-2 or RET jump to Org file %s"
  5627. (abbreviate-file-name buffer-file-name))))
  5628. (regexp (if with-hour
  5629. org-scheduled-time-hour-regexp
  5630. org-scheduled-time-regexp))
  5631. (today (org-today))
  5632. (todayp (org-agenda-today-p date)) ; DATE bound by calendar.
  5633. (current (calendar-absolute-from-gregorian date))
  5634. (deadline-pos
  5635. (mapcar (lambda (d)
  5636. (let ((m (get-text-property 0 'org-hd-marker d)))
  5637. (and m (marker-position m))))
  5638. deadlines))
  5639. scheduled-items)
  5640. (goto-char (point-min))
  5641. (while (re-search-forward regexp nil t)
  5642. (catch :skip
  5643. (unless (save-match-data (org-at-planning-p)) (throw :skip nil))
  5644. (org-agenda-skip)
  5645. (let* ((s (match-string 1))
  5646. (pos (1- (match-beginning 1)))
  5647. (todo-state (save-match-data (org-get-todo-state)))
  5648. (donep (member todo-state org-done-keywords))
  5649. (sexp? (string-prefix-p "%%" s))
  5650. ;; SCHEDULE is the scheduled date for the entry. It is
  5651. ;; either the bare date or the last repeat, according
  5652. ;; to `org-agenda-prefer-last-repeat'.
  5653. (schedule
  5654. (cond
  5655. (sexp? (org-agenda--timestamp-to-absolute s current))
  5656. ((or (eq org-agenda-prefer-last-repeat t)
  5657. (member todo-state org-agenda-prefer-last-repeat))
  5658. (org-agenda--timestamp-to-absolute
  5659. s today 'past (current-buffer) pos))
  5660. (t (org-agenda--timestamp-to-absolute s))))
  5661. ;; REPEAT is the future repeat closest from CURRENT,
  5662. ;; according to `org-agenda-show-future-repeats'. If
  5663. ;; the latter is nil, or if the time stamp has no
  5664. ;; repeat part, default to SCHEDULE.
  5665. (repeat
  5666. (cond
  5667. (sexp? schedule)
  5668. ((<= current today) schedule)
  5669. ((not org-agenda-show-future-repeats) schedule)
  5670. (t
  5671. (let ((base (if (eq org-agenda-show-future-repeats 'next)
  5672. (1+ today)
  5673. current)))
  5674. (org-agenda--timestamp-to-absolute
  5675. s base 'future (current-buffer) pos)))))
  5676. (diff (- current schedule))
  5677. (warntime (get-text-property (point) 'org-appt-warntime))
  5678. (pastschedp (< schedule today))
  5679. (habitp (and (fboundp 'org-is-habit-p) (org-is-habit-p)))
  5680. (suppress-delay
  5681. (let ((deadline (and org-agenda-skip-scheduled-delay-if-deadline
  5682. (org-entry-get nil "DEADLINE"))))
  5683. (cond
  5684. ((not deadline) nil)
  5685. ;; The current item has a deadline date, so
  5686. ;; evaluate its delay time.
  5687. ((integerp org-agenda-skip-scheduled-delay-if-deadline)
  5688. ;; Use global delay time.
  5689. (- org-agenda-skip-scheduled-delay-if-deadline))
  5690. ((eq org-agenda-skip-scheduled-delay-if-deadline
  5691. 'post-deadline)
  5692. ;; Set delay to no later than DEADLINE.
  5693. (min (- schedule
  5694. (org-agenda--timestamp-to-absolute deadline))
  5695. org-scheduled-delay-days))
  5696. (t 0))))
  5697. (ddays
  5698. (cond
  5699. ;; Nullify delay when a repeater triggered already
  5700. ;; and the delay is of the form --Xd.
  5701. ((and (string-match-p "--[0-9]+[hdwmy]" s)
  5702. (> current schedule))
  5703. 0)
  5704. (suppress-delay
  5705. (let ((org-scheduled-delay-days suppress-delay))
  5706. (org-get-wdays s t t)))
  5707. (t (org-get-wdays s t)))))
  5708. ;; Display scheduled items at base date (SCHEDULE), today if
  5709. ;; scheduled before the current date, and at any repeat past
  5710. ;; today. However, skip delayed items and items that have
  5711. ;; been displayed for more than `org-scheduled-past-days'.
  5712. (unless (and todayp
  5713. habitp
  5714. (bound-and-true-p org-habit-show-all-today))
  5715. (when (or (and (> ddays 0) (< diff ddays))
  5716. (> diff org-scheduled-past-days)
  5717. (> schedule current)
  5718. (and (/= current schedule)
  5719. (/= current today)
  5720. (/= current repeat)))
  5721. (throw :skip nil)))
  5722. ;; Possibly skip done tasks.
  5723. (when (and donep
  5724. (or org-agenda-skip-scheduled-if-done
  5725. (/= schedule current)))
  5726. (throw :skip nil))
  5727. ;; Skip entry if it already appears as a deadline, per
  5728. ;; `org-agenda-skip-scheduled-if-deadline-is-shown'. This
  5729. ;; doesn't apply to habits.
  5730. (when (pcase org-agenda-skip-scheduled-if-deadline-is-shown
  5731. ((guard
  5732. (or (not (memq (line-beginning-position 0) deadline-pos))
  5733. habitp))
  5734. nil)
  5735. (`repeated-after-deadline
  5736. (let ((deadline (time-to-days
  5737. (org-get-deadline-time (point)))))
  5738. (and (<= schedule deadline) (> current deadline))))
  5739. (`not-today pastschedp)
  5740. (`t t)
  5741. (_ nil))
  5742. (throw :skip nil))
  5743. ;; Skip habits if `org-habit-show-habits' is nil, or if we
  5744. ;; only show them for today. Also skip done habits.
  5745. (when (and habitp
  5746. (or donep
  5747. (not (bound-and-true-p org-habit-show-habits))
  5748. (and (not todayp)
  5749. (bound-and-true-p
  5750. org-habit-show-habits-only-for-today))))
  5751. (throw :skip nil))
  5752. (save-excursion
  5753. (re-search-backward "^\\*+[ \t]+" nil t)
  5754. (goto-char (match-end 0))
  5755. (let* ((category (org-get-category))
  5756. (inherited-tags
  5757. (or (eq org-agenda-show-inherited-tags 'always)
  5758. (and (listp org-agenda-show-inherited-tags)
  5759. (memq 'agenda org-agenda-show-inherited-tags))
  5760. (and (eq org-agenda-show-inherited-tags t)
  5761. (or (eq org-agenda-use-tag-inheritance t)
  5762. (memq 'agenda
  5763. org-agenda-use-tag-inheritance)))))
  5764. (tags (org-get-tags-at nil (not inherited-tags)))
  5765. (level (make-string (org-reduced-level (org-outline-level))
  5766. ?\s))
  5767. (head (buffer-substring (point) (line-end-position)))
  5768. (time
  5769. (cond
  5770. ;; No time of day designation if it is only
  5771. ;; a reminder.
  5772. ((and (/= current schedule) (/= current repeat)) nil)
  5773. ((string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
  5774. (concat (substring s (match-beginning 1)) " "))
  5775. (t 'time)))
  5776. (item
  5777. (org-agenda-format-item
  5778. (pcase-let ((`(,first ,past) org-agenda-scheduled-leaders))
  5779. ;; Show a reminder of a past scheduled today.
  5780. (if (and todayp pastschedp)
  5781. (format past diff)
  5782. first))
  5783. head level category tags time nil habitp))
  5784. (face (cond ((and (not habitp) pastschedp)
  5785. 'org-scheduled-previously)
  5786. (todayp 'org-scheduled-today)
  5787. (t 'org-scheduled)))
  5788. (habitp (and habitp (org-habit-parse-todo))))
  5789. (org-add-props item props
  5790. 'undone-face face
  5791. 'face (if donep 'org-agenda-done face)
  5792. 'org-marker (org-agenda-new-marker pos)
  5793. 'org-hd-marker (org-agenda-new-marker (line-beginning-position))
  5794. 'type (if pastschedp "past-scheduled" "scheduled")
  5795. 'date (if pastschedp schedule date)
  5796. 'ts-date schedule
  5797. 'warntime warntime
  5798. 'level level
  5799. 'priority (if habitp (org-habit-get-priority habitp)
  5800. (+ 99 diff (org-get-priority item)))
  5801. 'org-habit-p habitp
  5802. 'todo-state todo-state)
  5803. (push item scheduled-items))))))
  5804. (nreverse scheduled-items)))
  5805. (defun org-agenda-get-blocks ()
  5806. "Return the date-range information for agenda display."
  5807. (let* ((props (list 'face nil
  5808. 'org-not-done-regexp org-not-done-regexp
  5809. 'org-todo-regexp org-todo-regexp
  5810. 'org-complex-heading-regexp org-complex-heading-regexp
  5811. 'mouse-face 'highlight
  5812. 'help-echo
  5813. (format "mouse-2 or RET jump to org file %s"
  5814. (abbreviate-file-name buffer-file-name))))
  5815. (regexp org-tr-regexp)
  5816. (d0 (calendar-absolute-from-gregorian date))
  5817. marker hdmarker ee txt d1 d2 s1 s2 category
  5818. level todo-state tags pos head donep inherited-tags)
  5819. (goto-char (point-min))
  5820. (while (re-search-forward regexp nil t)
  5821. (catch :skip
  5822. (org-agenda-skip)
  5823. (setq pos (point))
  5824. (let ((start-time (match-string 1))
  5825. (end-time (match-string 2)))
  5826. (setq s1 (match-string 1)
  5827. s2 (match-string 2)
  5828. d1 (time-to-days (org-time-string-to-time s1 (current-buffer) pos))
  5829. d2 (time-to-days (org-time-string-to-time s2 (current-buffer) pos)))
  5830. (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
  5831. ;; Only allow days between the limits, because the normal
  5832. ;; date stamps will catch the limits.
  5833. (save-excursion
  5834. (setq todo-state (org-get-todo-state))
  5835. (setq donep (member todo-state org-done-keywords))
  5836. (if (and donep org-agenda-skip-timestamp-if-done)
  5837. (throw :skip t))
  5838. (setq marker (org-agenda-new-marker (point))
  5839. category (org-get-category))
  5840. (if (not (re-search-backward org-outline-regexp-bol nil t))
  5841. (throw :skip nil)
  5842. (goto-char (match-beginning 0))
  5843. (setq hdmarker (org-agenda-new-marker (point))
  5844. inherited-tags
  5845. (or (eq org-agenda-show-inherited-tags 'always)
  5846. (and (listp org-agenda-show-inherited-tags)
  5847. (memq 'agenda org-agenda-show-inherited-tags))
  5848. (and (eq org-agenda-show-inherited-tags t)
  5849. (or (eq org-agenda-use-tag-inheritance t)
  5850. (memq 'agenda org-agenda-use-tag-inheritance))))
  5851. tags (org-get-tags-at nil (not inherited-tags)))
  5852. (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
  5853. (looking-at "\\*+[ \t]+\\(.*\\)")
  5854. (setq head (match-string 1))
  5855. (let ((remove-re
  5856. (if org-agenda-remove-timeranges-from-blocks
  5857. (concat
  5858. "<" (regexp-quote s1) ".*?>"
  5859. "--"
  5860. "<" (regexp-quote s2) ".*?>")
  5861. nil)))
  5862. (setq txt (org-agenda-format-item
  5863. (format
  5864. (nth (if (= d1 d2) 0 1)
  5865. org-agenda-timerange-leaders)
  5866. (1+ (- d0 d1)) (1+ (- d2 d1)))
  5867. head level category tags
  5868. (cond ((and (= d1 d0) (= d2 d0))
  5869. (concat "<" start-time ">--<" end-time ">"))
  5870. ((= d1 d0)
  5871. (concat "<" start-time ">"))
  5872. ((= d2 d0)
  5873. (concat "<" end-time ">")))
  5874. remove-re))))
  5875. (org-add-props txt props
  5876. 'org-marker marker 'org-hd-marker hdmarker
  5877. 'type "block" 'date date
  5878. 'level level
  5879. 'todo-state todo-state
  5880. 'priority (org-get-priority txt))
  5881. (push txt ee))))
  5882. (goto-char pos)))
  5883. ;; Sort the entries by expiration date.
  5884. (nreverse ee)))
  5885. ;;; Agenda presentation and sorting
  5886. (defvar org-prefix-has-time nil
  5887. "A flag, set by `org-compile-prefix-format'.
  5888. The flag is set if the currently compiled format contains a `%t'.")
  5889. (defvar org-prefix-has-tag nil
  5890. "A flag, set by `org-compile-prefix-format'.
  5891. The flag is set if the currently compiled format contains a `%T'.")
  5892. (defvar org-prefix-has-effort nil
  5893. "A flag, set by `org-compile-prefix-format'.
  5894. The flag is set if the currently compiled format contains a `%e'.")
  5895. (defvar org-prefix-has-breadcrumbs nil
  5896. "A flag, set by `org-compile-prefix-format'.
  5897. The flag is set if the currently compiled format contains a `%b'.")
  5898. (defvar org-prefix-category-length nil
  5899. "Used by `org-compile-prefix-format' to remember the category field width.")
  5900. (defvar org-prefix-category-max-length nil
  5901. "Used by `org-compile-prefix-format' to remember the category field width.")
  5902. (defun org-agenda-get-category-icon (category)
  5903. "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
  5904. (cl-dolist (entry org-agenda-category-icon-alist)
  5905. (when (string-match-p (car entry) category)
  5906. (if (listp (cadr entry))
  5907. (cl-return (cadr entry))
  5908. (cl-return (apply #'create-image (cdr entry)))))))
  5909. (defun org-agenda-format-item (extra txt &optional level category tags dotime
  5910. remove-re habitp)
  5911. "Format TXT to be inserted into the agenda buffer.
  5912. In particular, add the prefix and corresponding text properties.
  5913. EXTRA must be a string to replace the `%s' specifier in the prefix format.
  5914. LEVEL may be a string to replace the `%l' specifier.
  5915. CATEGORY (a string, a symbol or nil) may be used to overrule the default
  5916. category taken from local variable or file name. It will replace the `%c'
  5917. specifier in the format.
  5918. DOTIME, when non-nil, indicates that a time-of-day should be extracted from
  5919. TXT for sorting of this entry, and for the `%t' specifier in the format.
  5920. When DOTIME is a string, this string is searched for a time before TXT is.
  5921. TAGS can be the tags of the headline.
  5922. Any match of REMOVE-RE will be removed from TXT."
  5923. ;; We keep the org-prefix-* variable values along with a compiled
  5924. ;; formatter, so that multiple agendas existing at the same time do
  5925. ;; not step on each other toes.
  5926. ;;
  5927. ;; It was inconvenient to make these variables buffer local in
  5928. ;; Agenda buffers, because this function expects to be called with
  5929. ;; the buffer where item comes from being current, and not agenda
  5930. ;; buffer
  5931. (let* ((bindings (car org-prefix-format-compiled))
  5932. (formatter (cadr org-prefix-format-compiled)))
  5933. (cl-loop for (var value) in bindings
  5934. do (set var value))
  5935. (save-match-data
  5936. ;; Diary entries sometimes have extra whitespace at the beginning
  5937. (setq txt (org-trim txt))
  5938. ;; Fix the tags part in txt
  5939. (setq txt (org-agenda-fix-displayed-tags
  5940. txt tags
  5941. org-agenda-show-inherited-tags
  5942. org-agenda-hide-tags-regexp))
  5943. (let* ((category (or category
  5944. (if buffer-file-name
  5945. (file-name-sans-extension
  5946. (file-name-nondirectory buffer-file-name))
  5947. "")))
  5948. (category-icon (org-agenda-get-category-icon category))
  5949. (category-icon (if category-icon
  5950. (propertize " " 'display category-icon)
  5951. ""))
  5952. (effort (and (not (string= txt ""))
  5953. (get-text-property 1 'effort txt)))
  5954. ;; time, tag, effort are needed for the eval of the prefix format
  5955. (tag (if tags (nth (1- (length tags)) tags) ""))
  5956. time
  5957. (ts (if dotime (concat
  5958. (if (stringp dotime) dotime "")
  5959. (and org-agenda-search-headline-for-time txt))))
  5960. (time-of-day (and dotime (org-get-time-of-day ts)))
  5961. stamp plain s0 s1 s2 rtn srp l
  5962. duration breadcrumbs)
  5963. (and (derived-mode-p 'org-mode) buffer-file-name
  5964. (add-to-list 'org-agenda-contributing-files buffer-file-name))
  5965. (when (and dotime time-of-day)
  5966. ;; Extract starting and ending time and move them to prefix
  5967. (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
  5968. (setq plain (string-match org-plain-time-of-day-regexp ts)))
  5969. (setq s0 (match-string 0 ts)
  5970. srp (and stamp (match-end 3))
  5971. s1 (match-string (if plain 1 2) ts)
  5972. s2 (match-string (if plain 8 (if srp 4 6)) ts))
  5973. ;; If the times are in TXT (not in DOTIMES), and the prefix will list
  5974. ;; them, we might want to remove them there to avoid duplication.
  5975. ;; The user can turn this off with a variable.
  5976. (if (and org-prefix-has-time
  5977. org-agenda-remove-times-when-in-prefix (or stamp plain)
  5978. (string-match (concat (regexp-quote s0) " *") txt)
  5979. (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
  5980. (if (eq org-agenda-remove-times-when-in-prefix 'beg)
  5981. (= (match-beginning 0) 0)
  5982. t))
  5983. (setq txt (replace-match "" nil nil txt))))
  5984. ;; Normalize the time(s) to 24 hour
  5985. (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
  5986. (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
  5987. ;; Try to set s2 if s1 and
  5988. ;; `org-agenda-default-appointment-duration' are set
  5989. (when (and s1 (not s2) org-agenda-default-appointment-duration)
  5990. (setq s2
  5991. (org-duration-from-minutes
  5992. (+ (org-duration-to-minutes s1 t)
  5993. org-agenda-default-appointment-duration)
  5994. nil t)))
  5995. ;; Compute the duration
  5996. (when s2
  5997. (setq duration (- (org-duration-to-minutes s2)
  5998. (org-duration-to-minutes s1)))))
  5999. (when (string-match "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$" txt)
  6000. ;; Tags are in the string
  6001. (if (or (eq org-agenda-remove-tags t)
  6002. (and org-agenda-remove-tags
  6003. org-prefix-has-tag))
  6004. (setq txt (replace-match "" t t txt))
  6005. (setq txt (replace-match
  6006. (concat (make-string (max (- 50 (length txt)) 1) ?\ )
  6007. (match-string 2 txt))
  6008. t t txt))))
  6009. (when remove-re
  6010. (while (string-match remove-re txt)
  6011. (setq txt (replace-match "" t t txt))))
  6012. ;; Set org-heading property on `txt' to mark the start of the
  6013. ;; heading.
  6014. (add-text-properties 0 (length txt) '(org-heading t) txt)
  6015. ;; Prepare the variables needed in the eval of the compiled format
  6016. (if org-prefix-has-breadcrumbs
  6017. (setq breadcrumbs (org-with-point-at (org-get-at-bol 'org-marker)
  6018. (let ((s (org-display-outline-path nil nil "->" t)))
  6019. (if (eq "" s) "" (concat s "->"))))))
  6020. (setq time (cond (s2 (concat
  6021. (org-agenda-time-of-day-to-ampm-maybe s1)
  6022. "-" (org-agenda-time-of-day-to-ampm-maybe s2)
  6023. (if org-agenda-timegrid-use-ampm " ")))
  6024. (s1 (concat
  6025. (org-agenda-time-of-day-to-ampm-maybe s1)
  6026. (if org-agenda-timegrid-use-ampm
  6027. "........ "
  6028. "......")))
  6029. (t ""))
  6030. extra (or (and (not habitp) extra) "")
  6031. category (if (symbolp category) (symbol-name category) category)
  6032. level (or level ""))
  6033. (if (string-match org-bracket-link-regexp category)
  6034. (progn
  6035. (setq l (if (match-end 3)
  6036. (- (match-end 3) (match-beginning 3))
  6037. (- (match-end 1) (match-beginning 1))))
  6038. (when (< l (or org-prefix-category-length 0))
  6039. (setq category (copy-sequence category))
  6040. (org-add-props category nil
  6041. 'extra-space (make-string
  6042. (- org-prefix-category-length l 1) ?\ ))))
  6043. (if (and org-prefix-category-max-length
  6044. (>= (length category) org-prefix-category-max-length))
  6045. (setq category (substring category 0 (1- org-prefix-category-max-length)))))
  6046. ;; Evaluate the compiled format
  6047. (setq rtn (concat (eval formatter) txt))
  6048. ;; And finally add the text properties
  6049. (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
  6050. (org-add-props rtn nil
  6051. 'org-category category
  6052. 'tags (mapcar 'org-downcase-keep-props tags)
  6053. 'org-highest-priority org-highest-priority
  6054. 'org-lowest-priority org-lowest-priority
  6055. 'time-of-day time-of-day
  6056. 'duration duration
  6057. 'breadcrumbs breadcrumbs
  6058. 'txt txt
  6059. 'level level
  6060. 'time time
  6061. 'extra extra
  6062. 'format org-prefix-format-compiled
  6063. 'dotime dotime)))))
  6064. (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
  6065. "Remove tags string from TXT, and add a modified list of tags.
  6066. The modified list may contain inherited tags, and tags matched by
  6067. `org-agenda-hide-tags-regexp' will be removed."
  6068. (when (or add-inherited hide-re)
  6069. (if (string-match "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$" txt)
  6070. (setq txt (substring txt 0 (match-beginning 0))))
  6071. (setq tags
  6072. (delq nil
  6073. (mapcar (lambda (tg)
  6074. (if (or (and hide-re (string-match hide-re tg))
  6075. (and (not add-inherited)
  6076. (get-text-property 0 'inherited tg)))
  6077. nil
  6078. tg))
  6079. tags)))
  6080. (when tags
  6081. (let ((have-i (get-text-property 0 'inherited (car tags)))
  6082. i)
  6083. (setq txt (concat txt " :"
  6084. (mapconcat
  6085. (lambda (x)
  6086. (setq i (get-text-property 0 'inherited x))
  6087. (if (and have-i (not i))
  6088. (progn
  6089. (setq have-i nil)
  6090. (concat ":" x))
  6091. x))
  6092. tags ":")
  6093. (if have-i "::" ":"))))))
  6094. txt)
  6095. (defun org-downcase-keep-props (s)
  6096. (let ((props (text-properties-at 0 s)))
  6097. (setq s (downcase s))
  6098. (add-text-properties 0 (length s) props s)
  6099. s))
  6100. (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
  6101. (defun org-agenda-add-time-grid-maybe (list ndays todayp)
  6102. "Add a time-grid for agenda items which need it.
  6103. LIST is the list of agenda items formatted by `org-agenda-list'.
  6104. NDAYS is the span of the current agenda view.
  6105. TODAYP is t when the current agenda view is on today."
  6106. (catch 'exit
  6107. (cond ((not org-agenda-use-time-grid) (throw 'exit list))
  6108. ((and todayp (member 'today (car org-agenda-time-grid))))
  6109. ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
  6110. ((member 'weekly (car org-agenda-time-grid)))
  6111. (t (throw 'exit list)))
  6112. (let* ((have (delq nil (mapcar
  6113. (lambda (x) (get-text-property 1 'time-of-day x))
  6114. list)))
  6115. (string (nth 1 org-agenda-time-grid))
  6116. (gridtimes (nth 2 org-agenda-time-grid))
  6117. (req (car org-agenda-time-grid))
  6118. (remove (member 'remove-match req))
  6119. new time)
  6120. (if (and (member 'require-timed req) (not have))
  6121. ;; don't show empty grid
  6122. (throw 'exit list))
  6123. (while (setq time (pop gridtimes))
  6124. (unless (and remove (member time have))
  6125. (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
  6126. (push (org-agenda-format-item
  6127. nil string nil "" nil
  6128. (concat (substring time 0 -2) ":" (substring time -2)))
  6129. new)
  6130. (put-text-property
  6131. 2 (length (car new)) 'face 'org-time-grid (car new))))
  6132. (when (and todayp org-agenda-show-current-time-in-grid)
  6133. (push (org-agenda-format-item
  6134. nil org-agenda-current-time-string nil "" nil
  6135. (format-time-string "%H:%M "))
  6136. new)
  6137. (put-text-property
  6138. 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
  6139. (if (member 'time-up org-agenda-sorting-strategy-selected)
  6140. (append new list)
  6141. (append list new)))))
  6142. (defun org-compile-prefix-format (key)
  6143. "Compile the prefix format into a Lisp form that can be evaluated.
  6144. The resulting form and associated variable bindings is returned
  6145. and stored in the variable `org-prefix-format-compiled'."
  6146. (setq org-prefix-has-time nil
  6147. org-prefix-has-tag nil
  6148. org-prefix-category-length nil
  6149. org-prefix-has-effort nil
  6150. org-prefix-has-breadcrumbs nil)
  6151. (let ((s (cond
  6152. ((stringp org-agenda-prefix-format)
  6153. org-agenda-prefix-format)
  6154. ((assq key org-agenda-prefix-format)
  6155. (cdr (assq key org-agenda-prefix-format)))
  6156. (t " %-12:c%?-12t% s")))
  6157. (start 0)
  6158. varform vars var e c f opt)
  6159. (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cltseib]\\|(.+)\\)"
  6160. s start)
  6161. (setq var (or (cdr (assoc (match-string 4 s)
  6162. '(("c" . category) ("t" . time) ("l" . level) ("s" . extra)
  6163. ("i" . category-icon) ("T" . tag) ("e" . effort) ("b" . breadcrumbs))))
  6164. 'eval)
  6165. c (or (match-string 3 s) "")
  6166. opt (match-beginning 1)
  6167. start (1+ (match-beginning 0)))
  6168. (if (eq var 'time) (setq org-prefix-has-time t))
  6169. (if (eq var 'tag) (setq org-prefix-has-tag t))
  6170. (if (eq var 'effort) (setq org-prefix-has-effort t))
  6171. (if (eq var 'breadcrumbs) (setq org-prefix-has-breadcrumbs t))
  6172. (setq f (concat "%" (match-string 2 s) "s"))
  6173. (when (eq var 'category)
  6174. (setq org-prefix-category-length
  6175. (floor (abs (string-to-number (match-string 2 s)))))
  6176. (setq org-prefix-category-max-length
  6177. (let ((x (match-string 2 s)))
  6178. (save-match-data
  6179. (if (string-match "\\.[0-9]+" x)
  6180. (string-to-number (substring (match-string 0 x) 1)))))))
  6181. (if (eq var 'eval)
  6182. (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
  6183. (if opt
  6184. (setq varform
  6185. `(if (or (equal "" ,var) (equal nil ,var))
  6186. ""
  6187. (format ,f (concat ,var ,c))))
  6188. (setq varform
  6189. `(format ,f (if (or (equal ,var "")
  6190. (equal ,var nil)) ""
  6191. (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
  6192. (setq s (replace-match "%s" t nil s))
  6193. (push varform vars))
  6194. (setq vars (nreverse vars))
  6195. (with-current-buffer (or org-agenda-buffer (current-buffer))
  6196. (setq org-prefix-format-compiled
  6197. (list
  6198. `((org-prefix-has-time ,org-prefix-has-time)
  6199. (org-prefix-has-tag ,org-prefix-has-tag)
  6200. (org-prefix-category-length ,org-prefix-category-length)
  6201. (org-prefix-has-effort ,org-prefix-has-effort)
  6202. (org-prefix-has-breadcrumbs ,org-prefix-has-breadcrumbs))
  6203. `(format ,s ,@vars))))))
  6204. (defun org-set-sorting-strategy (key)
  6205. (if (symbolp (car org-agenda-sorting-strategy))
  6206. ;; the old format
  6207. (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
  6208. (setq org-agenda-sorting-strategy-selected
  6209. (or (cdr (assq key org-agenda-sorting-strategy))
  6210. (cdr (assq 'agenda org-agenda-sorting-strategy))
  6211. '(time-up category-keep priority-down)))))
  6212. (defun org-get-time-of-day (s &optional string mod24)
  6213. "Check string S for a time of day.
  6214. If found, return it as a military time number between 0 and 2400.
  6215. If not found, return nil.
  6216. The optional STRING argument forces conversion into a 5 character wide string
  6217. HH:MM."
  6218. (save-match-data
  6219. (when
  6220. (and
  6221. (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
  6222. (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
  6223. (not (eq (get-text-property 1 'face s) 'org-link)))
  6224. (let* ((h (string-to-number (match-string 1 s)))
  6225. (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
  6226. (ampm (if (match-end 4) (downcase (match-string 4 s))))
  6227. (am-p (equal ampm "am"))
  6228. (h1 (cond ((not ampm) h)
  6229. ((= h 12) (if am-p 0 12))
  6230. (t (+ h (if am-p 0 12)))))
  6231. (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
  6232. (mod h1 24) h1))
  6233. (t0 (+ (* 100 h2) m))
  6234. (t1 (concat (if (>= h1 24) "+" " ")
  6235. (if (and org-agenda-time-leading-zero
  6236. (< t0 1000)) "0" "")
  6237. (if (< t0 100) "0" "")
  6238. (if (< t0 10) "0" "")
  6239. (int-to-string t0))))
  6240. (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
  6241. (defvar org-agenda-before-sorting-filter-function nil
  6242. "Function to be applied to agenda items prior to sorting.
  6243. Prior to sorting also means just before they are inserted into the agenda.
  6244. To aid sorting, you may revisit the original entries and add more text
  6245. properties which will later be used by the sorting functions.
  6246. The function should take a string argument, an agenda line.
  6247. It has access to the text properties in that line, which contain among
  6248. other things, the property `org-hd-marker' that points to the entry
  6249. where the line comes from. Note that not all lines going into the agenda
  6250. have this property, only most.
  6251. The function should return the modified string. It is probably best
  6252. to ONLY change text properties.
  6253. You can also use this function as a filter, by returning nil for lines
  6254. you don't want to have in the agenda at all. For this application, you
  6255. could bind the variable in the options section of a custom command.")
  6256. (defun org-agenda-finalize-entries (list &optional type)
  6257. "Sort, limit and concatenate the LIST of agenda items.
  6258. The optional argument TYPE tells the agenda type."
  6259. (let ((max-effort (cond ((listp org-agenda-max-effort)
  6260. (cdr (assoc type org-agenda-max-effort)))
  6261. (t org-agenda-max-effort)))
  6262. (max-todo (cond ((listp org-agenda-max-todos)
  6263. (cdr (assoc type org-agenda-max-todos)))
  6264. (t org-agenda-max-todos)))
  6265. (max-tags (cond ((listp org-agenda-max-tags)
  6266. (cdr (assoc type org-agenda-max-tags)))
  6267. (t org-agenda-max-tags)))
  6268. (max-entries (cond ((listp org-agenda-max-entries)
  6269. (cdr (assoc type org-agenda-max-entries)))
  6270. (t org-agenda-max-entries))))
  6271. (when org-agenda-before-sorting-filter-function
  6272. (setq list
  6273. (delq nil
  6274. (mapcar
  6275. org-agenda-before-sorting-filter-function list))))
  6276. (setq list (mapcar 'org-agenda-highlight-todo list)
  6277. list (mapcar 'identity (sort list 'org-entries-lessp)))
  6278. (when max-effort
  6279. (setq list (org-agenda-limit-entries
  6280. list 'effort-minutes max-effort
  6281. (lambda (e) (or e (if org-sort-agenda-noeffort-is-high
  6282. 32767 -1))))))
  6283. (when max-todo
  6284. (setq list (org-agenda-limit-entries list 'todo-state max-todo)))
  6285. (when max-tags
  6286. (setq list (org-agenda-limit-entries list 'tags max-tags)))
  6287. (when max-entries
  6288. (setq list (org-agenda-limit-entries list 'org-hd-marker max-entries)))
  6289. (mapconcat 'identity list "\n")))
  6290. (defun org-agenda-limit-entries (list prop limit &optional fn)
  6291. "Limit the number of agenda entries."
  6292. (let ((include (and limit (< limit 0))))
  6293. (if limit
  6294. (let ((fun (or fn (lambda (p) (if p 1))))
  6295. (lim 0))
  6296. (delq nil
  6297. (mapcar
  6298. (lambda (e)
  6299. (let ((pval (funcall
  6300. fun (get-text-property (1- (length e))
  6301. prop e))))
  6302. (if pval (setq lim (+ lim pval)))
  6303. (cond ((and pval (<= lim (abs limit))) e)
  6304. ((and include (not pval)) e))))
  6305. list)))
  6306. list)))
  6307. (defun org-agenda-limit-interactively (remove)
  6308. "In agenda, interactively limit entries to various maximums."
  6309. (interactive "P")
  6310. (if remove
  6311. (progn (setq org-agenda-max-entries nil
  6312. org-agenda-max-todos nil
  6313. org-agenda-max-tags nil
  6314. org-agenda-max-effort nil)
  6315. (org-agenda-redo))
  6316. (let* ((max (read-char "Number of [e]ntries [t]odos [T]ags [E]ffort? "))
  6317. (msg (cond ((= max ?E) "How many minutes? ")
  6318. ((= max ?e) "How many entries? ")
  6319. ((= max ?t) "How many TODO entries? ")
  6320. ((= max ?T) "How many tagged entries? ")
  6321. (t (user-error "Wrong input"))))
  6322. (num (string-to-number (read-from-minibuffer msg))))
  6323. (cond ((equal max ?e)
  6324. (let ((org-agenda-max-entries num)) (org-agenda-redo)))
  6325. ((equal max ?t)
  6326. (let ((org-agenda-max-todos num)) (org-agenda-redo)))
  6327. ((equal max ?T)
  6328. (let ((org-agenda-max-tags num)) (org-agenda-redo)))
  6329. ((equal max ?E)
  6330. (let ((org-agenda-max-effort num)) (org-agenda-redo))))))
  6331. (org-agenda-fit-window-to-buffer))
  6332. (defun org-agenda-highlight-todo (x)
  6333. (let ((org-done-keywords org-done-keywords-for-agenda)
  6334. (case-fold-search nil)
  6335. re)
  6336. (if (eq x 'line)
  6337. (save-excursion
  6338. (beginning-of-line 1)
  6339. (setq re (org-get-at-bol 'org-todo-regexp))
  6340. (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
  6341. (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
  6342. (add-text-properties (match-beginning 0) (match-end 1)
  6343. (list 'face (org-get-todo-face 1)))
  6344. (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
  6345. (delete-region (match-beginning 1) (1- (match-end 0)))
  6346. (goto-char (match-beginning 1))
  6347. (insert (format org-agenda-todo-keyword-format s)))))
  6348. (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
  6349. (setq re (get-text-property 0 'org-todo-regexp x))
  6350. (when (and re
  6351. ;; Test `pl' because if there's no heading content,
  6352. ;; there's no point matching to highlight. Note
  6353. ;; that if we didn't test `pl' first, and there
  6354. ;; happened to be no keyword from `org-todo-regexp'
  6355. ;; on this heading line, then the `equal' comparison
  6356. ;; afterwards would spuriously succeed in the case
  6357. ;; where `pl' is nil -- causing an args-out-of-range
  6358. ;; error when we try to add text properties to text
  6359. ;; that isn't there.
  6360. pl
  6361. (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
  6362. x pl) pl))
  6363. (add-text-properties
  6364. (or (match-end 1) (match-end 0)) (match-end 0)
  6365. (list 'face (org-get-todo-face (match-string 2 x)))
  6366. x)
  6367. (when (match-end 1)
  6368. (setq x (concat (substring x 0 (match-end 1))
  6369. (format org-agenda-todo-keyword-format
  6370. (match-string 2 x))
  6371. (org-add-props " " (text-properties-at 0 x))
  6372. (substring x (match-end 3)))))))
  6373. x)))
  6374. (defsubst org-cmp-values (a b property)
  6375. "Compare the numeric value of text PROPERTY for string A and B."
  6376. (let ((pa (or (get-text-property (1- (length a)) property a) 0))
  6377. (pb (or (get-text-property (1- (length b)) property b) 0)))
  6378. (cond ((> pa pb) +1)
  6379. ((< pa pb) -1))))
  6380. (defsubst org-cmp-effort (a b)
  6381. "Compare the effort values of string A and B."
  6382. (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
  6383. ;; `effort-minutes' property is not directly accessible from
  6384. ;; the strings, but is stored as a property in `txt'.
  6385. (ea (or (get-text-property
  6386. 0 'effort-minutes (get-text-property 0 'txt a))
  6387. def))
  6388. (eb (or (get-text-property
  6389. 0 'effort-minutes (get-text-property 0 'txt b))
  6390. def)))
  6391. (cond ((> ea eb) +1)
  6392. ((< ea eb) -1))))
  6393. (defsubst org-cmp-category (a b)
  6394. "Compare the string values of categories of strings A and B."
  6395. (let ((ca (or (get-text-property (1- (length a)) 'org-category a) ""))
  6396. (cb (or (get-text-property (1- (length b)) 'org-category b) "")))
  6397. (cond ((string-lessp ca cb) -1)
  6398. ((string-lessp cb ca) +1))))
  6399. (defsubst org-cmp-todo-state (a b)
  6400. "Compare the todo states of strings A and B."
  6401. (let* ((ma (or (get-text-property 1 'org-marker a)
  6402. (get-text-property 1 'org-hd-marker a)))
  6403. (mb (or (get-text-property 1 'org-marker b)
  6404. (get-text-property 1 'org-hd-marker b)))
  6405. (fa (and ma (marker-buffer ma)))
  6406. (fb (and mb (marker-buffer mb)))
  6407. (todo-kwds
  6408. (or (and fa (with-current-buffer fa org-todo-keywords-1))
  6409. (and fb (with-current-buffer fb org-todo-keywords-1))))
  6410. (ta (or (get-text-property 1 'todo-state a) ""))
  6411. (tb (or (get-text-property 1 'todo-state b) ""))
  6412. (la (- (length (member ta todo-kwds))))
  6413. (lb (- (length (member tb todo-kwds))))
  6414. (donepa (member ta org-done-keywords-for-agenda))
  6415. (donepb (member tb org-done-keywords-for-agenda)))
  6416. (cond ((and donepa (not donepb)) -1)
  6417. ((and (not donepa) donepb) +1)
  6418. ((< la lb) -1)
  6419. ((< lb la) +1))))
  6420. (defsubst org-cmp-alpha (a b)
  6421. "Compare the headlines, alphabetically."
  6422. (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
  6423. (plb (text-property-any 0 (length b) 'org-heading t b))
  6424. (ta (and pla (substring a pla)))
  6425. (tb (and plb (substring b plb)))
  6426. (case-fold-search nil))
  6427. (when pla
  6428. (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
  6429. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
  6430. (setq ta (substring ta (match-end 0))))
  6431. (setq ta (downcase ta)))
  6432. (when plb
  6433. (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
  6434. "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
  6435. (setq tb (substring tb (match-end 0))))
  6436. (setq tb (downcase tb)))
  6437. (cond ((not ta) +1)
  6438. ((not tb) -1)
  6439. ((string-lessp ta tb) -1)
  6440. ((string-lessp tb ta) +1))))
  6441. (defsubst org-cmp-tag (a b)
  6442. "Compare the string values of the first tags of A and B."
  6443. (let ((ta (car (last (get-text-property 1 'tags a))))
  6444. (tb (car (last (get-text-property 1 'tags b)))))
  6445. (cond ((not ta) +1)
  6446. ((not tb) -1)
  6447. ((string-lessp ta tb) -1)
  6448. ((string-lessp tb ta) +1))))
  6449. (defsubst org-cmp-time (a b)
  6450. "Compare the time-of-day values of strings A and B."
  6451. (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
  6452. (ta (or (get-text-property 1 'time-of-day a) def))
  6453. (tb (or (get-text-property 1 'time-of-day b) def)))
  6454. (cond ((< ta tb) -1)
  6455. ((< tb ta) +1))))
  6456. (defsubst org-cmp-ts (a b type)
  6457. "Compare the timestamps values of entries A and B.
  6458. When TYPE is \"scheduled\", \"deadline\", \"timestamp\" or
  6459. \"timestamp_ia\", compare within each of these type. When TYPE
  6460. is the empty string, compare all timestamps without respect of
  6461. their type."
  6462. (let* ((def (if org-sort-agenda-notime-is-late most-positive-fixnum -1))
  6463. (ta (or (and (string-match type (or (get-text-property 1 'type a) ""))
  6464. (get-text-property 1 'ts-date a))
  6465. def))
  6466. (tb (or (and (string-match type (or (get-text-property 1 'type b) ""))
  6467. (get-text-property 1 'ts-date b))
  6468. def)))
  6469. (cond ((< ta tb) -1)
  6470. ((< tb ta) +1))))
  6471. (defsubst org-cmp-habit-p (a b)
  6472. "Compare the todo states of strings A and B."
  6473. (let ((ha (get-text-property 1 'org-habit-p a))
  6474. (hb (get-text-property 1 'org-habit-p b)))
  6475. (cond ((and ha (not hb)) -1)
  6476. ((and (not ha) hb) +1))))
  6477. (defun org-entries-lessp (a b)
  6478. "Predicate for sorting agenda entries."
  6479. ;; The following variables will be used when the form is evaluated.
  6480. ;; So even though the compiler complains, keep them.
  6481. (let* ((ss org-agenda-sorting-strategy-selected)
  6482. (timestamp-up (and (org-em 'timestamp-up 'timestamp-down ss)
  6483. (org-cmp-ts a b "")))
  6484. (timestamp-down (if timestamp-up (- timestamp-up) nil))
  6485. (scheduled-up (and (org-em 'scheduled-up 'scheduled-down ss)
  6486. (org-cmp-ts a b "scheduled")))
  6487. (scheduled-down (if scheduled-up (- scheduled-up) nil))
  6488. (deadline-up (and (org-em 'deadline-up 'deadline-down ss)
  6489. (org-cmp-ts a b "deadline")))
  6490. (deadline-down (if deadline-up (- deadline-up) nil))
  6491. (tsia-up (and (org-em 'tsia-up 'tsia-down ss)
  6492. (org-cmp-ts a b "timestamp_ia")))
  6493. (tsia-down (if tsia-up (- tsia-up) nil))
  6494. (ts-up (and (org-em 'ts-up 'ts-down ss)
  6495. (org-cmp-ts a b "timestamp")))
  6496. (ts-down (if ts-up (- ts-up) nil))
  6497. (time-up (and (org-em 'time-up 'time-down ss)
  6498. (org-cmp-time a b)))
  6499. (time-down (if time-up (- time-up) nil))
  6500. (stats-up (and (org-em 'stats-up 'stats-down ss)
  6501. (org-cmp-values a b 'org-stats)))
  6502. (stats-down (if stats-up (- stats-up) nil))
  6503. (priority-up (and (org-em 'priority-up 'priority-down ss)
  6504. (org-cmp-values a b 'priority)))
  6505. (priority-down (if priority-up (- priority-up) nil))
  6506. (effort-up (and (org-em 'effort-up 'effort-down ss)
  6507. (org-cmp-effort a b)))
  6508. (effort-down (if effort-up (- effort-up) nil))
  6509. (category-up (and (or (org-em 'category-up 'category-down ss)
  6510. (memq 'category-keep ss))
  6511. (org-cmp-category a b)))
  6512. (category-down (if category-up (- category-up) nil))
  6513. (category-keep (if category-up +1 nil))
  6514. (tag-up (and (org-em 'tag-up 'tag-down ss)
  6515. (org-cmp-tag a b)))
  6516. (tag-down (if tag-up (- tag-up) nil))
  6517. (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
  6518. (org-cmp-todo-state a b)))
  6519. (todo-state-down (if todo-state-up (- todo-state-up) nil))
  6520. (habit-up (and (org-em 'habit-up 'habit-down ss)
  6521. (org-cmp-habit-p a b)))
  6522. (habit-down (if habit-up (- habit-up) nil))
  6523. (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
  6524. (org-cmp-alpha a b)))
  6525. (alpha-down (if alpha-up (- alpha-up) nil))
  6526. (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
  6527. user-defined-up user-defined-down)
  6528. (if (and need-user-cmp org-agenda-cmp-user-defined
  6529. (functionp org-agenda-cmp-user-defined))
  6530. (setq user-defined-up
  6531. (funcall org-agenda-cmp-user-defined a b)
  6532. user-defined-down (if user-defined-up (- user-defined-up) nil)))
  6533. (cdr (assoc
  6534. (eval (cons 'or org-agenda-sorting-strategy-selected))
  6535. '((-1 . t) (1 . nil) (nil . nil))))))
  6536. ;;; Agenda restriction lock
  6537. (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
  6538. "Overlay to mark the headline to which agenda commands are restricted.")
  6539. (overlay-put org-agenda-restriction-lock-overlay
  6540. 'face 'org-agenda-restriction-lock)
  6541. (overlay-put org-agenda-restriction-lock-overlay
  6542. 'help-echo "Agendas are currently limited to this subtree.")
  6543. (delete-overlay org-agenda-restriction-lock-overlay)
  6544. (defun org-agenda-set-restriction-lock-from-agenda (arg)
  6545. "Set the restriction lock to the agenda item at point from within the agenda.
  6546. When called with a `\\[universal-argument]' prefix, restrict to
  6547. the file which contains the item.
  6548. Argument ARG is the prefix argument."
  6549. (interactive "P")
  6550. (unless (derived-mode-p 'org-agenda-mode)
  6551. (user-error "Not in an Org agenda buffer"))
  6552. (let* ((marker (or (org-get-at-bol 'org-marker)
  6553. (org-agenda-error)))
  6554. (buffer (marker-buffer marker))
  6555. (pos (marker-position marker)))
  6556. (with-current-buffer buffer
  6557. (goto-char pos)
  6558. (org-agenda-set-restriction-lock arg))))
  6559. ;;;###autoload
  6560. (defun org-agenda-set-restriction-lock (&optional type)
  6561. "Set restriction lock for agenda, to current subtree or file.
  6562. Restriction will be the file if TYPE is `file', or if type is the
  6563. universal prefix \\='(4), or if the cursor is before the first headline
  6564. in the file. Otherwise, restriction will be to the current subtree."
  6565. (interactive "P")
  6566. (org-agenda-remove-restriction-lock 'noupdate)
  6567. (and (equal type '(4)) (setq type 'file))
  6568. (setq type (cond
  6569. (type type)
  6570. ((org-at-heading-p) 'subtree)
  6571. ((condition-case nil (org-back-to-heading t) (error nil))
  6572. 'subtree)
  6573. (t 'file)))
  6574. (if (eq type 'subtree)
  6575. (progn
  6576. (setq org-agenda-restrict (current-buffer))
  6577. (setq org-agenda-overriding-restriction 'subtree)
  6578. (put 'org-agenda-files 'org-restrict
  6579. (list (buffer-file-name (buffer-base-buffer))))
  6580. (org-back-to-heading t)
  6581. (move-overlay org-agenda-restriction-lock-overlay
  6582. (point)
  6583. (if org-agenda-restriction-lock-highlight-subtree
  6584. (save-excursion (org-end-of-subtree t t) (point))
  6585. (point-at-eol)))
  6586. (move-marker org-agenda-restrict-begin (point))
  6587. (move-marker org-agenda-restrict-end
  6588. (save-excursion (org-end-of-subtree t t)))
  6589. (message "Locking agenda restriction to subtree"))
  6590. (put 'org-agenda-files 'org-restrict
  6591. (list (buffer-file-name (buffer-base-buffer))))
  6592. (setq org-agenda-restrict nil)
  6593. (setq org-agenda-overriding-restriction 'file)
  6594. (move-marker org-agenda-restrict-begin nil)
  6595. (move-marker org-agenda-restrict-end nil)
  6596. (message "Locking agenda restriction to file"))
  6597. (setq current-prefix-arg nil)
  6598. (org-agenda-maybe-redo))
  6599. (defun org-agenda-remove-restriction-lock (&optional noupdate)
  6600. "Remove the agenda restriction lock."
  6601. (interactive "P")
  6602. (delete-overlay org-agenda-restriction-lock-overlay)
  6603. (delete-overlay org-speedbar-restriction-lock-overlay)
  6604. (setq org-agenda-overriding-restriction nil)
  6605. (setq org-agenda-restrict nil)
  6606. (put 'org-agenda-files 'org-restrict nil)
  6607. (move-marker org-agenda-restrict-begin nil)
  6608. (move-marker org-agenda-restrict-end nil)
  6609. (setq current-prefix-arg nil)
  6610. (message "Agenda restriction lock removed")
  6611. (or noupdate (org-agenda-maybe-redo)))
  6612. (defun org-agenda-maybe-redo ()
  6613. "If there is any window showing the agenda view, update it."
  6614. (let ((w (get-buffer-window (or org-agenda-this-buffer-name
  6615. org-agenda-buffer-name)
  6616. t))
  6617. (w0 (selected-window)))
  6618. (when w
  6619. (select-window w)
  6620. (org-agenda-redo)
  6621. (select-window w0)
  6622. (if org-agenda-overriding-restriction
  6623. (message "Agenda view shifted to new %s restriction"
  6624. org-agenda-overriding-restriction)
  6625. (message "Agenda restriction lock removed")))))
  6626. ;;; Agenda commands
  6627. (defun org-agenda-check-type (error &rest types)
  6628. "Check if agenda buffer is of allowed type.
  6629. If ERROR is non-nil, throw an error, otherwise just return nil.
  6630. Allowed types are `agenda' `timeline' `todo' `tags' `search'."
  6631. (if (not org-agenda-type)
  6632. (error "No Org agenda currently displayed")
  6633. (if (memq org-agenda-type types)
  6634. t
  6635. (if error
  6636. (error "Not allowed in %s-type agenda buffers" org-agenda-type)
  6637. nil))))
  6638. (defun org-agenda-Quit ()
  6639. "Exit the agenda, killing the agenda buffer.
  6640. Like `org-agenda-quit', but kill the buffer even when
  6641. `org-agenda-sticky' is non-nil."
  6642. (interactive)
  6643. (org-agenda--quit))
  6644. (defun org-agenda-quit ()
  6645. "Exit the agenda.
  6646. When `org-agenda-sticky' is non-nil, bury the agenda buffer
  6647. instead of killing it.
  6648. When `org-agenda-restore-windows-after-quit' is non-nil, restore
  6649. the pre-agenda window configuration.
  6650. When column view is active, exit column view instead of the
  6651. agenda."
  6652. (interactive)
  6653. (org-agenda--quit org-agenda-sticky))
  6654. (defun org-agenda--quit (&optional bury)
  6655. (if org-agenda-columns-active
  6656. (org-columns-quit)
  6657. (let ((wconf org-agenda-pre-window-conf)
  6658. (buf (current-buffer))
  6659. (org-agenda-last-indirect-window
  6660. (and (eq org-indirect-buffer-display 'other-window)
  6661. org-agenda-last-indirect-buffer
  6662. (get-buffer-window org-agenda-last-indirect-buffer))))
  6663. (cond
  6664. ((eq org-agenda-window-setup 'other-frame)
  6665. (delete-frame))
  6666. ((and org-agenda-restore-windows-after-quit
  6667. wconf)
  6668. ;; Maybe restore the pre-agenda window configuration. Reset
  6669. ;; `org-agenda-pre-window-conf' before running
  6670. ;; `set-window-configuration', which loses the current buffer.
  6671. (setq org-agenda-pre-window-conf nil)
  6672. (set-window-configuration wconf))
  6673. (t
  6674. (when org-agenda-last-indirect-window
  6675. (delete-window org-agenda-last-indirect-window))
  6676. (and (not (eq org-agenda-window-setup 'current-window))
  6677. (not (one-window-p))
  6678. (delete-window))))
  6679. (if bury
  6680. ;; Set the agenda buffer as the current buffer instead of
  6681. ;; passing it as an argument to `bury-buffer' so that
  6682. ;; `bury-buffer' removes it from the window.
  6683. (with-current-buffer buf
  6684. (bury-buffer))
  6685. (kill-buffer buf)
  6686. (setq org-agenda-archives-mode nil
  6687. org-agenda-buffer nil)))))
  6688. (defun org-agenda-exit ()
  6689. "Exit the agenda, killing Org buffers loaded by the agenda.
  6690. Like `org-agenda-Quit', but kill any buffers that were created by
  6691. the agenda. Org buffers visited directly by the user will not be
  6692. touched. Also, exit the agenda even if it is in column view."
  6693. (interactive)
  6694. (when org-agenda-columns-active
  6695. (org-columns-quit))
  6696. (org-release-buffers org-agenda-new-buffers)
  6697. (setq org-agenda-new-buffers nil)
  6698. (org-agenda-Quit))
  6699. (defun org-agenda-kill-all-agenda-buffers ()
  6700. "Kill all buffers in `org-agenda-mode'.
  6701. This is used when toggling sticky agendas."
  6702. (interactive)
  6703. (let (blist)
  6704. (dolist (buf (buffer-list))
  6705. (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
  6706. (push buf blist)))
  6707. (mapc 'kill-buffer blist)))
  6708. (defun org-agenda-execute (arg)
  6709. "Execute another agenda command, keeping same window.
  6710. So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
  6711. in the agenda."
  6712. (interactive "P")
  6713. (let ((org-agenda-window-setup 'current-window))
  6714. (org-agenda arg)))
  6715. (defun org-agenda-redo (&optional all)
  6716. "Rebuild possibly ALL agenda view(s) in the current buffer."
  6717. (interactive "P")
  6718. (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
  6719. (cpa (unless (eq all t) current-prefix-arg))
  6720. (org-agenda-doing-sticky-redo org-agenda-sticky)
  6721. (org-agenda-sticky nil)
  6722. (org-agenda-buffer-name (or org-agenda-this-buffer-name
  6723. org-agenda-buffer-name))
  6724. (org-agenda-keep-modes t)
  6725. (tag-filter org-agenda-tag-filter)
  6726. (tag-preset (get 'org-agenda-tag-filter :preset-filter))
  6727. (top-hl-filter org-agenda-top-headline-filter)
  6728. (cat-filter org-agenda-category-filter)
  6729. (cat-preset (get 'org-agenda-category-filter :preset-filter))
  6730. (re-filter org-agenda-regexp-filter)
  6731. (re-preset (get 'org-agenda-regexp-filter :preset-filter))
  6732. (effort-filter org-agenda-effort-filter)
  6733. (effort-preset (get 'org-agenda-effort-filter :preset-filter))
  6734. (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
  6735. (cols org-agenda-columns-active)
  6736. (line (org-current-line))
  6737. (window-line (- line (org-current-line (window-start))))
  6738. (lprops (get 'org-agenda-redo-command 'org-lprops))
  6739. (redo-cmd (get-text-property p 'org-redo-cmd))
  6740. (last-args (get-text-property p 'org-last-args))
  6741. (org-agenda-overriding-cmd (get-text-property p 'org-series-cmd))
  6742. (org-agenda-overriding-cmd-arguments
  6743. (unless (eq all t)
  6744. (cond ((listp last-args)
  6745. (cons (or cpa (car last-args)) (cdr last-args)))
  6746. ((stringp last-args)
  6747. last-args))))
  6748. (series-redo-cmd (get-text-property p 'org-series-redo-cmd)))
  6749. (put 'org-agenda-tag-filter :preset-filter nil)
  6750. (put 'org-agenda-category-filter :preset-filter nil)
  6751. (put 'org-agenda-regexp-filter :preset-filter nil)
  6752. (put 'org-agenda-effort-filter :preset-filter nil)
  6753. (and cols (org-columns-quit))
  6754. (message "Rebuilding agenda buffer...")
  6755. (if series-redo-cmd
  6756. (eval series-redo-cmd)
  6757. (org-let lprops redo-cmd))
  6758. (setq org-agenda-undo-list nil
  6759. org-agenda-pending-undo-list nil
  6760. org-agenda-tag-filter tag-filter
  6761. org-agenda-category-filter cat-filter
  6762. org-agenda-regexp-filter re-filter
  6763. org-agenda-effort-filter effort-filter
  6764. org-agenda-top-headline-filter top-hl-filter)
  6765. (message "Rebuilding agenda buffer...done")
  6766. (put 'org-agenda-tag-filter :preset-filter tag-preset)
  6767. (put 'org-agenda-category-filter :preset-filter cat-preset)
  6768. (put 'org-agenda-regexp-filter :preset-filter re-preset)
  6769. (put 'org-agenda-effort-filter :preset-filter effort-preset)
  6770. (let ((tag (or tag-filter tag-preset))
  6771. (cat (or cat-filter cat-preset))
  6772. (effort (or effort-filter effort-preset))
  6773. (re (or re-filter re-preset)))
  6774. (when tag (org-agenda-filter-apply tag 'tag t))
  6775. (when cat (org-agenda-filter-apply cat 'category))
  6776. (when effort (org-agenda-filter-apply effort 'effort))
  6777. (when re (org-agenda-filter-apply re 'regexp)))
  6778. (and top-hl-filter (org-agenda-filter-top-headline-apply top-hl-filter))
  6779. (and cols (called-interactively-p 'any) (org-agenda-columns))
  6780. (org-goto-line line)
  6781. (recenter window-line)))
  6782. (defvar org-global-tags-completion-table nil)
  6783. (defvar org-agenda-filter-form nil)
  6784. (defvar org-agenda-filtered-by-category nil)
  6785. (defun org-agenda-filter-by-category (strip)
  6786. "Filter lines in the agenda buffer that have a specific category.
  6787. The category is that of the current line.
  6788. Without prefix argument, keep only the lines of that category.
  6789. With a prefix argument, exclude the lines of that category.
  6790. "
  6791. (interactive "P")
  6792. (if (and org-agenda-filtered-by-category
  6793. org-agenda-category-filter)
  6794. (org-agenda-filter-show-all-cat)
  6795. (let ((cat (org-no-properties (org-get-at-eol 'org-category 1))))
  6796. (cond
  6797. ((and cat strip)
  6798. (org-agenda-filter-apply
  6799. (push (concat "-" cat) org-agenda-category-filter) 'category))
  6800. (cat
  6801. (org-agenda-filter-apply
  6802. (setq org-agenda-category-filter
  6803. (list (concat "+" cat))) 'category))
  6804. (t (error "No category at point"))))))
  6805. (defun org-find-top-headline (&optional pos)
  6806. "Find the topmost parent headline and return it.
  6807. POS when non-nil is the marker or buffer position to start the
  6808. search from."
  6809. (save-excursion
  6810. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  6811. (when pos (goto-char pos))
  6812. ;; Skip up to the topmost parent.
  6813. (while (org-up-heading-safe))
  6814. (ignore-errors (nth 4 (org-heading-components))))))
  6815. (defvar org-agenda-filtered-by-top-headline nil)
  6816. (defun org-agenda-filter-by-top-headline (strip)
  6817. "Keep only those lines that are descendants from the same top headline.
  6818. The top headline is that of the current line."
  6819. (interactive "P")
  6820. (if org-agenda-filtered-by-top-headline
  6821. (progn
  6822. (setq org-agenda-filtered-by-top-headline nil
  6823. org-agenda-top-headline-filter nil)
  6824. (org-agenda-filter-show-all-top-filter))
  6825. (let ((toph (org-find-top-headline (org-get-at-bol 'org-hd-marker))))
  6826. (if toph (org-agenda-filter-top-headline-apply toph strip)
  6827. (error "No top-level headline at point")))))
  6828. (defvar org-agenda-regexp-filter nil)
  6829. (defun org-agenda-filter-by-regexp (strip)
  6830. "Filter agenda entries by a regular expression.
  6831. Regexp filters are cumulative.
  6832. With no prefix argument, keep entries matching the regexp.
  6833. With one prefix argument, filter out entries matching the regexp.
  6834. With two prefix arguments, remove the regexp filters."
  6835. (interactive "P")
  6836. (if (not (equal strip '(16)))
  6837. (let ((flt (concat (if (equal strip '(4)) "-" "+")
  6838. (read-from-minibuffer
  6839. (if (equal strip '(4))
  6840. "Filter out entries matching regexp: "
  6841. "Narrow to entries matching regexp: ")))))
  6842. (push flt org-agenda-regexp-filter)
  6843. (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
  6844. (org-agenda-filter-show-all-re)
  6845. (message "Regexp filter removed")))
  6846. (defvar org-agenda-effort-filter nil)
  6847. (defun org-agenda-filter-by-effort (strip)
  6848. "Filter agenda entries by effort.
  6849. With no prefix argument, keep entries matching the effort condition.
  6850. With one prefix argument, filter out entries matching the condition.
  6851. With two prefix arguments, remove the effort filters."
  6852. (interactive "P")
  6853. (cond
  6854. ((member strip '(nil 4))
  6855. (let* ((efforts (split-string
  6856. (or (cdr (assoc (concat org-effort-property "_ALL")
  6857. org-global-properties))
  6858. "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00")))
  6859. ;; XXX: the following handles only up to 10 different
  6860. ;; effort values.
  6861. (allowed-keys (if (null efforts) nil
  6862. (mapcar (lambda (n) (mod n 10)) ;turn 10 into 0
  6863. (number-sequence 1 (length efforts)))))
  6864. (op nil))
  6865. (while (not (memq op '(?< ?> ?=)))
  6866. (setq op (read-char-exclusive "Effort operator? (> = or <)")))
  6867. ;; Select appropriate duration. Ignore non-digit characters.
  6868. (let ((prompt
  6869. (apply #'format
  6870. (concat "Effort %c "
  6871. (mapconcat (lambda (s) (concat "[%d]" s))
  6872. efforts
  6873. " "))
  6874. op allowed-keys))
  6875. (eff -1))
  6876. (while (not (memq eff allowed-keys))
  6877. (message prompt)
  6878. (setq eff (- (read-char-exclusive) 48)))
  6879. (setq org-agenda-effort-filter
  6880. (list (concat (if strip "-" "+")
  6881. (char-to-string op)
  6882. ;; Numbering is 1 2 3 ... 9 0, but we want
  6883. ;; 0 1 2 ... 8 9.
  6884. (nth (mod (1- eff) 10) efforts)))))
  6885. (org-agenda-filter-apply org-agenda-effort-filter 'effort)))
  6886. (t (org-agenda-filter-show-all-effort)
  6887. (message "Effort filter removed"))))
  6888. (defun org-agenda-filter-remove-all ()
  6889. "Remove all filters from the current agenda buffer."
  6890. (interactive)
  6891. (when org-agenda-tag-filter
  6892. (org-agenda-filter-show-all-tag))
  6893. (when org-agenda-category-filter
  6894. (org-agenda-filter-show-all-cat))
  6895. (when org-agenda-regexp-filter
  6896. (org-agenda-filter-show-all-re))
  6897. (when org-agenda-top-headline-filter
  6898. (org-agenda-filter-show-all-top-filter))
  6899. (when org-agenda-effort-filter
  6900. (org-agenda-filter-show-all-effort))
  6901. (org-agenda-finalize))
  6902. (defun org-agenda-filter-by-tag (arg &optional char exclude)
  6903. "Keep only those lines in the agenda buffer that have a specific tag.
  6904. The tag is selected with its fast selection letter, as configured.
  6905. With a `\\[universal-argument]' prefix, exclude the agenda search.
  6906. With a `\\[universal-argument] \\[universal-argument]' prefix, filter the literal tag, \
  6907. i.e. don't
  6908. filter on all its group members.
  6909. A lisp caller can specify CHAR. EXCLUDE means that the new tag
  6910. should be used to exclude the search - the interactive user can
  6911. also press `-' or `+' to switch between filtering and excluding."
  6912. (interactive "P")
  6913. (let* ((alist org-tag-alist-for-agenda)
  6914. (tag-chars (mapconcat
  6915. (lambda (x) (if (and (not (symbolp (car x)))
  6916. (cdr x))
  6917. (char-to-string (cdr x))
  6918. ""))
  6919. org-tag-alist-for-agenda ""))
  6920. (valid-char-list (append '(?\t ?\r ?/ ?. ?\s ?q)
  6921. (string-to-list tag-chars)))
  6922. (exclude (or exclude (equal arg '(4))))
  6923. (expand (not (equal arg '(16))))
  6924. (inhibit-read-only t)
  6925. (current org-agenda-tag-filter)
  6926. a n tag)
  6927. (unless char
  6928. (while (not (memq char valid-char-list))
  6929. (message
  6930. "%s by tag [%s ], [TAB], %s[/]:off, [+/-]:filter/exclude%s, [q]:quit"
  6931. (if exclude "Exclude" "Filter") tag-chars
  6932. (if org-agenda-auto-exclude-function "[RET], " "")
  6933. (if expand "" ", no grouptag expand"))
  6934. (setq char (read-char-exclusive))
  6935. ;; Excluding or filtering down
  6936. (cond ((eq char ?-) (setq exclude t))
  6937. ((eq char ?+) (setq exclude nil)))))
  6938. (when (eq char ?\t)
  6939. (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
  6940. (setq-local org-global-tags-completion-table
  6941. (org-global-tags-completion-table)))
  6942. (let ((completion-ignore-case t))
  6943. (setq tag (completing-read
  6944. "Tag: " org-global-tags-completion-table))))
  6945. (cond
  6946. ((eq char ?\r)
  6947. (org-agenda-filter-show-all-tag)
  6948. (when org-agenda-auto-exclude-function
  6949. (setq org-agenda-tag-filter nil)
  6950. (dolist (tag (org-agenda-get-represented-tags))
  6951. (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
  6952. (if modifier
  6953. (push modifier org-agenda-tag-filter))))
  6954. (if (not (null org-agenda-tag-filter))
  6955. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))))
  6956. ((eq char ?/)
  6957. (org-agenda-filter-show-all-tag)
  6958. (when (get 'org-agenda-tag-filter :preset-filter)
  6959. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand)))
  6960. ((eq char ?.)
  6961. (setq org-agenda-tag-filter
  6962. (mapcar (lambda(tag) (concat "+" tag))
  6963. (org-get-at-bol 'tags)))
  6964. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  6965. ((eq char ?q)) ;If q, abort (even if there is a q-key for a tag...)
  6966. ((or (eq char ?\s)
  6967. (setq a (rassoc char alist))
  6968. (and tag (setq a (cons tag nil))))
  6969. (org-agenda-filter-show-all-tag)
  6970. (setq tag (car a))
  6971. (setq org-agenda-tag-filter
  6972. (cons (concat (if exclude "-" "+") tag)
  6973. current))
  6974. (org-agenda-filter-apply org-agenda-tag-filter 'tag expand))
  6975. (t (error "Invalid tag selection character %c" char)))))
  6976. (defun org-agenda-get-represented-tags ()
  6977. "Get a list of all tags currently represented in the agenda."
  6978. (let (p tags)
  6979. (save-excursion
  6980. (goto-char (point-min))
  6981. (while (setq p (next-single-property-change (point) 'tags))
  6982. (goto-char p)
  6983. (mapc (lambda (x) (add-to-list 'tags x))
  6984. (get-text-property (point) 'tags))))
  6985. tags))
  6986. (defun org-agenda-filter-make-matcher (filter type &optional expand)
  6987. "Create the form that tests a line for agenda filter. Optional
  6988. argument EXPAND can be used for the TYPE tag and will expand the
  6989. tags in the FILTER if any of the tags in FILTER are grouptags."
  6990. (let (f f1)
  6991. (cond
  6992. ;; Tag filter
  6993. ((eq type 'tag)
  6994. (setq filter
  6995. (delete-dups
  6996. (append (get 'org-agenda-tag-filter :preset-filter)
  6997. filter)))
  6998. (dolist (x filter)
  6999. (let ((op (string-to-char x)))
  7000. (if expand (setq x (org-agenda-filter-expand-tags (list x) t))
  7001. (setq x (list x)))
  7002. (setq f1 (org-agenda-filter-make-matcher-tag-exp x op))
  7003. (push f1 f))))
  7004. ;; Category filter
  7005. ((eq type 'category)
  7006. (setq filter
  7007. (delete-dups
  7008. (append (get 'org-agenda-category-filter :preset-filter)
  7009. filter)))
  7010. (dolist (x filter)
  7011. (if (equal "-" (substring x 0 1))
  7012. (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
  7013. (setq f1 (list 'equal (substring x 1) 'cat)))
  7014. (push f1 f)))
  7015. ;; Regexp filter
  7016. ((eq type 'regexp)
  7017. (setq filter
  7018. (delete-dups
  7019. (append (get 'org-agenda-regexp-filter :preset-filter)
  7020. filter)))
  7021. (dolist (x filter)
  7022. (if (equal "-" (substring x 0 1))
  7023. (setq f1 (list 'not (list 'string-match (substring x 1) 'txt)))
  7024. (setq f1 (list 'string-match (substring x 1) 'txt)))
  7025. (push f1 f)))
  7026. ;; Effort filter
  7027. ((eq type 'effort)
  7028. (setq filter
  7029. (delete-dups
  7030. (append (get 'org-agenda-effort-filter :preset-filter)
  7031. filter)))
  7032. (dolist (x filter)
  7033. (push (org-agenda-filter-effort-form x) f))))
  7034. (cons 'and (nreverse f))))
  7035. (defun org-agenda-filter-make-matcher-tag-exp (tags op)
  7036. "Return a form associated to tag-expression TAGS.
  7037. Build a form testing a line for agenda filter for
  7038. tag-expressions. OP is an operator of type CHAR that allows the
  7039. function to set the right switches in the returned form."
  7040. (let (form)
  7041. ;; Any of the expressions can match if OP is +, all must match if
  7042. ;; the operator is -.
  7043. (dolist (x tags (cons (if (eq op ?-) 'and 'or) form))
  7044. (let* ((tag (substring x 1))
  7045. (f (cond
  7046. ((string= "" tag) '(not tags))
  7047. ((and (string-match-p "\\`{" tag) (string-match-p "}\\'" tag))
  7048. ;; TAG is a regexp.
  7049. (list 'org-match-any-p (substring tag 1 -1) 'tags))
  7050. (t (list 'member (downcase tag) 'tags)))))
  7051. (push (if (eq op ?-) (list 'not f) f) form)))))
  7052. (defun org-agenda-filter-effort-form (e)
  7053. "Return the form to compare the effort of the current line with what E says.
  7054. E looks like \"+<2:25\"."
  7055. (let (op)
  7056. (setq e (substring e 1))
  7057. (setq op (string-to-char e) e (substring e 1))
  7058. (setq op (cond ((equal op ?<) '<=)
  7059. ((equal op ?>) '>=)
  7060. ((equal op ??) op)
  7061. (t '=)))
  7062. (list 'org-agenda-compare-effort (list 'quote op)
  7063. (org-duration-to-minutes e))))
  7064. (defun org-agenda-compare-effort (op value)
  7065. "Compare the effort of the current line with VALUE, using OP.
  7066. If the line does not have an effort defined, return nil."
  7067. ;; `effort-minutes' property cannot be extracted directly from
  7068. ;; current line but is stored as a property in `txt'.
  7069. (let ((effort (get-text-property 0 'effort-minutes (org-get-at-bol 'txt))))
  7070. (funcall op
  7071. (or effort (if org-sort-agenda-noeffort-is-high 32767 -1))
  7072. value)))
  7073. (defun org-agenda-filter-expand-tags (filter &optional no-operator)
  7074. "Expand group tags in FILTER for the agenda.
  7075. When NO-OPERATOR is non-nil, do not add the + operator to returned tags."
  7076. (if org-group-tags
  7077. (let ((case-fold-search t) rtn)
  7078. (mapc
  7079. (lambda (f)
  7080. (let (f0 dir)
  7081. (if (string-match "^\\([+-]\\)\\(.+\\)" f)
  7082. (setq dir (match-string 1 f) f0 (match-string 2 f))
  7083. (setq dir (if no-operator "" "+") f0 f))
  7084. (setq rtn (append (mapcar (lambda(f1) (concat dir f1))
  7085. (org-tags-expand f0 t t))
  7086. rtn))))
  7087. filter)
  7088. (reverse rtn))
  7089. filter))
  7090. (defun org-agenda-filter-apply (filter type &optional expand)
  7091. "Set FILTER as the new agenda filter and apply it. Optional
  7092. argument EXPAND can be used for the TYPE tag and will expand the
  7093. tags in the FILTER if any of the tags in FILTER are grouptags."
  7094. ;; Deactivate `org-agenda-entry-text-mode' when filtering
  7095. (if org-agenda-entry-text-mode (org-agenda-entry-text-mode))
  7096. (let (tags cat txt)
  7097. (setq org-agenda-filter-form (org-agenda-filter-make-matcher filter type expand))
  7098. ;; Only set `org-agenda-filtered-by-category' to t when a unique
  7099. ;; category is used as the filter:
  7100. (setq org-agenda-filtered-by-category
  7101. (and (eq type 'category)
  7102. (not (equal (substring (car filter) 0 1) "-"))))
  7103. (org-agenda-set-mode-name)
  7104. (save-excursion
  7105. (goto-char (point-min))
  7106. (while (not (eobp))
  7107. (if (org-get-at-bol 'org-marker)
  7108. (progn
  7109. (setq tags (org-get-at-bol 'tags)
  7110. cat (org-get-at-eol 'org-category 1)
  7111. txt (org-get-at-bol 'txt))
  7112. (if (not (eval org-agenda-filter-form))
  7113. (org-agenda-filter-hide-line type))
  7114. (beginning-of-line 2))
  7115. (beginning-of-line 2))))
  7116. (if (get-char-property (point) 'invisible)
  7117. (ignore-errors (org-agenda-previous-line)))))
  7118. (defun org-agenda-filter-top-headline-apply (hl &optional negative)
  7119. "Filter by top headline HL."
  7120. (org-agenda-set-mode-name)
  7121. (save-excursion
  7122. (goto-char (point-min))
  7123. (while (not (eobp))
  7124. (let* ((pos (org-get-at-bol 'org-hd-marker))
  7125. (tophl (and pos (org-find-top-headline pos))))
  7126. (if (and tophl (funcall (if negative 'identity 'not)
  7127. (string= hl tophl)))
  7128. (org-agenda-filter-hide-line 'top-headline)))
  7129. (beginning-of-line 2)))
  7130. (if (get-char-property (point) 'invisible)
  7131. (org-agenda-previous-line))
  7132. (setq org-agenda-top-headline-filter hl
  7133. org-agenda-filtered-by-top-headline t))
  7134. (defun org-agenda-filter-hide-line (type)
  7135. "Hide lines with TYPE in the agenda buffer."
  7136. (let* ((b (max (point-min) (1- (point-at-bol))))
  7137. (e (point-at-eol)))
  7138. (let ((inhibit-read-only t))
  7139. (add-text-properties
  7140. b e `(invisible org-filtered org-filter-type ,type)))))
  7141. (defun org-agenda-remove-filter (type)
  7142. (interactive)
  7143. "Remove filter of type TYPE from the agenda buffer."
  7144. (save-excursion
  7145. (goto-char (point-min))
  7146. (let ((inhibit-read-only t) pos)
  7147. (while (setq pos (text-property-any (point) (point-max) 'org-filter-type type))
  7148. (goto-char pos)
  7149. (remove-text-properties
  7150. (point) (next-single-property-change (point) 'org-filter-type)
  7151. `(invisible org-filtered org-filter-type ,type))))
  7152. (set (intern (format "org-agenda-%s-filter" (intern-soft type))) nil)
  7153. (setq org-agenda-filter-form nil)
  7154. (org-agenda-set-mode-name)
  7155. (org-agenda-finalize)))
  7156. (defun org-agenda-filter-show-all-tag nil
  7157. (org-agenda-remove-filter 'tag))
  7158. (defun org-agenda-filter-show-all-re nil
  7159. (org-agenda-remove-filter 'regexp))
  7160. (defun org-agenda-filter-show-all-effort nil
  7161. (org-agenda-remove-filter 'effort))
  7162. (defun org-agenda-filter-show-all-cat nil
  7163. (org-agenda-remove-filter 'category))
  7164. (defun org-agenda-filter-show-all-top-filter nil
  7165. (org-agenda-remove-filter 'top-headline))
  7166. (defun org-agenda-manipulate-query-add ()
  7167. "Manipulate the query by adding a search term with positive selection.
  7168. Positive selection means the term must be matched for selection of an entry."
  7169. (interactive)
  7170. (org-agenda-manipulate-query ?\[))
  7171. (defun org-agenda-manipulate-query-subtract ()
  7172. "Manipulate the query by adding a search term with negative selection.
  7173. Negative selection means term must not be matched for selection of an entry."
  7174. (interactive)
  7175. (org-agenda-manipulate-query ?\]))
  7176. (defun org-agenda-manipulate-query-add-re ()
  7177. "Manipulate the query by adding a search regexp with positive selection.
  7178. Positive selection means the regexp must match for selection of an entry."
  7179. (interactive)
  7180. (org-agenda-manipulate-query ?\{))
  7181. (defun org-agenda-manipulate-query-subtract-re ()
  7182. "Manipulate the query by adding a search regexp with negative selection.
  7183. Negative selection means regexp must not match for selection of an entry."
  7184. (interactive)
  7185. (org-agenda-manipulate-query ?\}))
  7186. (defun org-agenda-manipulate-query (char)
  7187. (cond
  7188. ((memq org-agenda-type '(timeline agenda))
  7189. (let ((org-agenda-include-inactive-timestamps t))
  7190. (org-agenda-redo))
  7191. (message "Display now includes inactive timestamps as well"))
  7192. ((eq org-agenda-type 'search)
  7193. (org-add-to-string
  7194. 'org-agenda-query-string
  7195. (if org-agenda-last-search-view-search-was-boolean
  7196. (cdr (assoc char '((?\[ . " +") (?\] . " -")
  7197. (?\{ . " +{}") (?\} . " -{}"))))
  7198. " "))
  7199. (setq org-agenda-redo-command
  7200. (list 'org-search-view
  7201. (car (get-text-property (min (1- (point-max)) (point))
  7202. 'org-last-args))
  7203. org-agenda-query-string
  7204. (+ (length org-agenda-query-string)
  7205. (if (member char '(?\{ ?\})) 0 1))))
  7206. (set-register org-agenda-query-register org-agenda-query-string)
  7207. (let ((org-agenda-overriding-arguments
  7208. (cdr org-agenda-redo-command)))
  7209. (org-agenda-redo)))
  7210. (t (error "Cannot manipulate query for %s-type agenda buffers"
  7211. org-agenda-type))))
  7212. (defun org-add-to-string (var string)
  7213. (set var (concat (symbol-value var) string)))
  7214. (defun org-agenda-goto-date (span)
  7215. "Jump to DATE in agenda."
  7216. (interactive "P")
  7217. (let* ((org-read-date-prefer-future
  7218. (eval org-agenda-jump-prefer-future))
  7219. (date (org-read-date))
  7220. (day (time-to-days (org-time-string-to-time date)))
  7221. (org-agenda-sticky-orig org-agenda-sticky)
  7222. (org-agenda-buffer-tmp-name (buffer-name))
  7223. (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7224. (0-arg (or current-prefix-arg (car args)))
  7225. (2-arg (nth 2 args))
  7226. (with-hour-p (nth 4 org-agenda-redo-command))
  7227. (newcmd (list 'org-agenda-list 0-arg date
  7228. (org-agenda-span-to-ndays
  7229. 2-arg (org-time-string-to-absolute date))
  7230. with-hour-p))
  7231. (newargs (cdr newcmd))
  7232. (inhibit-read-only t)
  7233. org-agenda-sticky)
  7234. (if (not (org-agenda-check-type t 'agenda))
  7235. (error "Not available in non-agenda views")
  7236. (add-text-properties (point-min) (point-max)
  7237. `(org-redo-cmd ,newcmd org-last-args ,newargs))
  7238. (org-agenda-redo)
  7239. (goto-char (point-min))
  7240. (while (not (or (= (or (get-text-property (point) 'day) 0) day)
  7241. (save-excursion (move-beginning-of-line 2) (eobp))))
  7242. (move-beginning-of-line 2))
  7243. (setq org-agenda-sticky org-agenda-sticky-orig
  7244. org-agenda-this-buffer-is-sticky org-agenda-sticky))))
  7245. (defun org-agenda-goto-today ()
  7246. "Go to today."
  7247. (interactive)
  7248. (org-agenda-check-type t 'timeline 'agenda)
  7249. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7250. (curspan (nth 2 args))
  7251. (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
  7252. (cond
  7253. (tdpos (goto-char tdpos))
  7254. ((eq org-agenda-type 'agenda)
  7255. (let* ((sd (org-agenda-compute-starting-span
  7256. (org-today) (or curspan org-agenda-span)))
  7257. (org-agenda-overriding-arguments args))
  7258. (setf (nth 1 org-agenda-overriding-arguments) sd)
  7259. (org-agenda-redo)
  7260. (org-agenda-find-same-or-today-or-agenda)))
  7261. (t (error "Cannot find today")))))
  7262. (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
  7263. (goto-char
  7264. (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
  7265. (text-property-any (point-min) (point-max) 'org-today t)
  7266. (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
  7267. (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
  7268. (org-agenda-backward-block))
  7269. (point-min))))
  7270. (defun org-agenda-backward-block ()
  7271. "Move backward by one agenda block."
  7272. (interactive)
  7273. (org-agenda-forward-block 'backward))
  7274. (defun org-agenda-forward-block (&optional backward)
  7275. "Move forward by one agenda block.
  7276. When optional argument BACKWARD is set, go backward"
  7277. (interactive)
  7278. (cond ((not (derived-mode-p 'org-agenda-mode))
  7279. (user-error
  7280. "Cannot execute this command outside of org-agenda-mode buffers"))
  7281. ((looking-at (if backward "\\`" "\\'"))
  7282. (message "Already at the %s block" (if backward "first" "last")))
  7283. (t (let ((pos (prog1 (point)
  7284. (ignore-errors (if backward (backward-char 1)
  7285. (move-end-of-line 1)))))
  7286. (f (if backward
  7287. 'previous-single-property-change
  7288. 'next-single-property-change))
  7289. moved dest)
  7290. (while (and (setq dest (funcall
  7291. f (point) 'org-agenda-structural-header))
  7292. (not (get-text-property
  7293. (point) 'org-agenda-structural-header)))
  7294. (setq moved t)
  7295. (goto-char dest))
  7296. (if moved (move-beginning-of-line 1)
  7297. (goto-char (if backward (point-min) (point-max)))
  7298. (move-beginning-of-line 1)
  7299. (message "No %s block" (if backward "previous" "further")))))))
  7300. (defun org-agenda-later (arg)
  7301. "Go forward in time by the current span.
  7302. With prefix ARG, go forward that many times the current span."
  7303. (interactive "p")
  7304. (org-agenda-check-type t 'agenda)
  7305. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7306. (span (or (nth 2 args) org-agenda-current-span))
  7307. (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
  7308. (greg (calendar-gregorian-from-absolute sd))
  7309. (cnt (org-get-at-bol 'org-day-cnt))
  7310. greg2)
  7311. (cond
  7312. ((numberp span)
  7313. (setq sd (+ (* span arg) sd)))
  7314. ((eq span 'day)
  7315. (setq sd (+ arg sd)))
  7316. ((eq span 'week)
  7317. (setq sd (+ (* 7 arg) sd)))
  7318. ((eq span 'fortnight)
  7319. (setq sd (+ (* 14 arg) sd)))
  7320. ((eq span 'month)
  7321. (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
  7322. sd (calendar-absolute-from-gregorian greg2))
  7323. (setcar greg2 (1+ (car greg2))))
  7324. ((eq span 'year)
  7325. (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
  7326. sd (calendar-absolute-from-gregorian greg2))
  7327. (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
  7328. (t
  7329. (setq sd (+ (* span arg) sd))))
  7330. (let ((org-agenda-overriding-cmd
  7331. ;; `cmd' may have been set by `org-agenda-run-series' which
  7332. ;; uses `org-agenda-overriding-cmd' to decide whether
  7333. ;; overriding is allowed for `cmd'
  7334. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7335. (org-agenda-overriding-arguments
  7336. (list (car args) sd span)))
  7337. (org-agenda-redo)
  7338. (org-agenda-find-same-or-today-or-agenda cnt))))
  7339. (defun org-agenda-earlier (arg)
  7340. "Go backward in time by the current span.
  7341. With prefix ARG, go backward that many times the current span."
  7342. (interactive "p")
  7343. (org-agenda-later (- arg)))
  7344. (defun org-agenda-view-mode-dispatch ()
  7345. "Call one of the view mode commands."
  7346. (interactive)
  7347. (message "View: [d]ay [w]eek for[t]night [m]onth [y]ear [SPC]reset [q]uit/abort
  7348. time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
  7349. [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
  7350. (pcase (read-char-exclusive)
  7351. (?\ (call-interactively 'org-agenda-reset-view))
  7352. (?d (call-interactively 'org-agenda-day-view))
  7353. (?w (call-interactively 'org-agenda-week-view))
  7354. (?t (call-interactively 'org-agenda-fortnight-view))
  7355. (?m (call-interactively 'org-agenda-month-view))
  7356. (?y (call-interactively 'org-agenda-year-view))
  7357. (?l (call-interactively 'org-agenda-log-mode))
  7358. (?L (org-agenda-log-mode '(4)))
  7359. (?c (org-agenda-log-mode 'clockcheck))
  7360. ((or ?F ?f) (call-interactively 'org-agenda-follow-mode))
  7361. (?a (call-interactively 'org-agenda-archives-mode))
  7362. (?A (org-agenda-archives-mode 'files))
  7363. ((or ?R ?r) (call-interactively 'org-agenda-clockreport-mode))
  7364. ((or ?E ?e) (call-interactively 'org-agenda-entry-text-mode))
  7365. (?G (call-interactively 'org-agenda-toggle-time-grid))
  7366. (?D (call-interactively 'org-agenda-toggle-diary))
  7367. (?\! (call-interactively 'org-agenda-toggle-deadlines))
  7368. (?\[ (let ((org-agenda-include-inactive-timestamps t))
  7369. (org-agenda-check-type t 'timeline 'agenda)
  7370. (org-agenda-redo))
  7371. (message "Display now includes inactive timestamps as well"))
  7372. (?q (message "Abort"))
  7373. (key (user-error "Invalid key: %s" key))))
  7374. (defun org-agenda-reset-view ()
  7375. "Switch to default view for agenda."
  7376. (interactive)
  7377. (org-agenda-change-time-span org-agenda-span))
  7378. (defun org-agenda-day-view (&optional day-of-month)
  7379. "Switch to daily view for agenda.
  7380. With argument DAY-OF-MONTH, switch to that day of the month."
  7381. (interactive "P")
  7382. (org-agenda-change-time-span 'day day-of-month))
  7383. (defun org-agenda-week-view (&optional iso-week)
  7384. "Switch to weekly view for agenda.
  7385. With argument ISO-WEEK, switch to the corresponding ISO week.
  7386. If ISO-WEEK has more then 2 digits, only the last two encode
  7387. the week. Any digits before this encode a year. So 200712
  7388. means week 12 of year 2007. Years ranging from 70 years ago
  7389. to 30 years in the future can also be written as 2-digit years."
  7390. (interactive "P")
  7391. (org-agenda-change-time-span 'week iso-week))
  7392. (defun org-agenda-fortnight-view (&optional iso-week)
  7393. "Switch to fortnightly view for agenda.
  7394. With argument ISO-WEEK, switch to the corresponding ISO week.
  7395. If ISO-WEEK has more then 2 digits, only the last two encode
  7396. the week. Any digits before this encode a year. So 200712
  7397. means week 12 of year 2007. Years ranging from 70 years ago
  7398. to 30 years in the future can also be written as 2-digit years."
  7399. (interactive "P")
  7400. (org-agenda-change-time-span 'fortnight iso-week))
  7401. (defun org-agenda-month-view (&optional month)
  7402. "Switch to monthly view for agenda.
  7403. With argument MONTH, switch to that month. If MONTH has more
  7404. then 2 digits, only the last two encode the month. Any digits
  7405. before this encode a year. So 200712 means December year 2007.
  7406. Years ranging from 70 years ago to 30 years in the future can
  7407. also be written as 2-digit years."
  7408. (interactive "P")
  7409. (org-agenda-change-time-span 'month month))
  7410. (defun org-agenda-year-view (&optional year)
  7411. "Switch to yearly view for agenda.
  7412. With argument YEAR, switch to that year. Years ranging from 70
  7413. years ago to 30 years in the future can also be written as
  7414. 2-digit years."
  7415. (interactive "P")
  7416. (when year
  7417. (setq year (org-small-year-to-year year)))
  7418. (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
  7419. (org-agenda-change-time-span 'year year)
  7420. (error "Abort")))
  7421. (defun org-agenda-change-time-span (span &optional n)
  7422. "Change the agenda view to SPAN.
  7423. SPAN may be `day', `week', `fortnight', `month', `year'."
  7424. (org-agenda-check-type t 'agenda)
  7425. (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
  7426. (curspan (nth 2 args)))
  7427. (if (and (not n) (equal curspan span))
  7428. (error "Viewing span is already \"%s\"" span))
  7429. (let* ((sd (or (org-get-at-bol 'day)
  7430. (nth 1 args)
  7431. org-starting-day))
  7432. (sd (org-agenda-compute-starting-span sd span n))
  7433. (org-agenda-overriding-cmd
  7434. (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
  7435. (org-agenda-overriding-arguments
  7436. (list (car args) sd span)))
  7437. (org-agenda-redo)
  7438. (org-agenda-find-same-or-today-or-agenda))
  7439. (org-agenda-set-mode-name)
  7440. (message "Switched to %s view" span)))
  7441. (defun org-agenda-compute-starting-span (sd span &optional n)
  7442. "Compute starting date for agenda.
  7443. SPAN may be `day', `week', `fortnight', `month', `year'. The return value
  7444. is a cons cell with the starting date and the number of days,
  7445. so that the date SD will be in that range."
  7446. (let* ((greg (calendar-gregorian-from-absolute sd))
  7447. (dg (nth 1 greg))
  7448. (mg (car greg))
  7449. (yg (nth 2 greg)))
  7450. (cond
  7451. ((eq span 'day)
  7452. (when n
  7453. (setq sd (+ (calendar-absolute-from-gregorian
  7454. (list mg 1 yg))
  7455. n -1))))
  7456. ((or (eq span 'week) (eq span 'fortnight))
  7457. (let* ((nt (calendar-day-of-week
  7458. (calendar-gregorian-from-absolute sd)))
  7459. (d (if org-agenda-start-on-weekday
  7460. (- nt org-agenda-start-on-weekday)
  7461. 0))
  7462. y1)
  7463. (setq sd (- sd (+ (if (< d 0) 7 0) d)))
  7464. (when n
  7465. (require 'cal-iso)
  7466. (when (> n 99)
  7467. (setq y1 (org-small-year-to-year (/ n 100))
  7468. n (mod n 100)))
  7469. (setq sd
  7470. (calendar-iso-to-absolute
  7471. (list n 1
  7472. (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
  7473. ((eq span 'month)
  7474. (let (y1)
  7475. (when (and n (> n 99))
  7476. (setq y1 (org-small-year-to-year (/ n 100))
  7477. n (mod n 100)))
  7478. (setq sd (calendar-absolute-from-gregorian
  7479. (list (or n mg) 1 (or y1 yg))))))
  7480. ((eq span 'year)
  7481. (setq sd (calendar-absolute-from-gregorian
  7482. (list 1 1 (or n yg))))))
  7483. sd))
  7484. (defun org-agenda-next-date-line (&optional arg)
  7485. "Jump to the next line indicating a date in agenda buffer."
  7486. (interactive "p")
  7487. (org-agenda-check-type t 'agenda 'timeline)
  7488. (beginning-of-line 1)
  7489. ;; This does not work if user makes date format that starts with a blank
  7490. (if (looking-at "^\\S-") (forward-char 1))
  7491. (if (not (re-search-forward "^\\S-" nil t arg))
  7492. (progn
  7493. (backward-char 1)
  7494. (error "No next date after this line in this buffer")))
  7495. (goto-char (match-beginning 0)))
  7496. (defun org-agenda-previous-date-line (&optional arg)
  7497. "Jump to the previous line indicating a date in agenda buffer."
  7498. (interactive "p")
  7499. (org-agenda-check-type t 'agenda 'timeline)
  7500. (beginning-of-line 1)
  7501. (if (not (re-search-backward "^\\S-" nil t arg))
  7502. (error "No previous date before this line in this buffer")))
  7503. ;; Initialize the highlight
  7504. (defvar org-hl (make-overlay 1 1))
  7505. (overlay-put org-hl 'face 'highlight)
  7506. (defun org-highlight (begin end &optional buffer)
  7507. "Highlight a region with overlay."
  7508. (move-overlay org-hl begin end (or buffer (current-buffer))))
  7509. (defun org-unhighlight ()
  7510. "Detach overlay INDEX."
  7511. (delete-overlay org-hl))
  7512. (defun org-unhighlight-once ()
  7513. "Remove the highlight from its position, and this function from the hook."
  7514. (remove-hook 'pre-command-hook 'org-unhighlight-once)
  7515. (org-unhighlight))
  7516. (defvar org-agenda-pre-follow-window-conf nil)
  7517. (defun org-agenda-follow-mode ()
  7518. "Toggle follow mode in an agenda buffer."
  7519. (interactive)
  7520. (unless org-agenda-follow-mode
  7521. (setq org-agenda-pre-follow-window-conf
  7522. (current-window-configuration)))
  7523. (setq org-agenda-follow-mode (not org-agenda-follow-mode))
  7524. (unless org-agenda-follow-mode
  7525. (set-window-configuration org-agenda-pre-follow-window-conf))
  7526. (org-agenda-set-mode-name)
  7527. (org-agenda-do-context-action)
  7528. (message "Follow mode is %s"
  7529. (if org-agenda-follow-mode "on" "off")))
  7530. (defun org-agenda-entry-text-mode (&optional arg)
  7531. "Toggle entry text mode in an agenda buffer."
  7532. (interactive "P")
  7533. (if (or org-agenda-tag-filter
  7534. org-agenda-category-filter
  7535. org-agenda-regexp-filter
  7536. org-agenda-top-headline-filter)
  7537. (user-error "Can't show entry text in filtered views")
  7538. (setq org-agenda-entry-text-mode (or (integerp arg)
  7539. (not org-agenda-entry-text-mode)))
  7540. (org-agenda-entry-text-hide)
  7541. (and org-agenda-entry-text-mode
  7542. (let ((org-agenda-entry-text-maxlines
  7543. (if (integerp arg) arg org-agenda-entry-text-maxlines)))
  7544. (org-agenda-entry-text-show)))
  7545. (org-agenda-set-mode-name)
  7546. (message "Entry text mode is %s%s"
  7547. (if org-agenda-entry-text-mode "on" "off")
  7548. (if (not org-agenda-entry-text-mode) ""
  7549. (format " (maximum number of lines is %d)"
  7550. (if (integerp arg) arg org-agenda-entry-text-maxlines))))))
  7551. (defun org-agenda-clockreport-mode ()
  7552. "Toggle clocktable mode in an agenda buffer."
  7553. (interactive)
  7554. (org-agenda-check-type t 'agenda)
  7555. (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode))
  7556. (setq org-agenda-start-with-clockreport-mode org-agenda-clockreport-mode)
  7557. (org-agenda-set-mode-name)
  7558. (org-agenda-redo)
  7559. (message "Clocktable mode is %s"
  7560. (if org-agenda-clockreport-mode "on" "off")))
  7561. (defun org-agenda-log-mode (&optional special)
  7562. "Toggle log mode in an agenda buffer.
  7563. With argument SPECIAL, show all possible log items, not only the ones
  7564. configured in `org-agenda-log-mode-items'.
  7565. With a `\\[universal-argument] \\[universal-argument]' prefix, show *only* \
  7566. log items, nothing else."
  7567. (interactive "P")
  7568. (org-agenda-check-type t 'agenda 'timeline)
  7569. (setq org-agenda-show-log
  7570. (cond
  7571. ((equal special '(16)) 'only)
  7572. ((eq special 'clockcheck)
  7573. (if (eq org-agenda-show-log 'clockcheck)
  7574. nil 'clockcheck))
  7575. (special '(closed clock state))
  7576. (t (not org-agenda-show-log))))
  7577. (setq org-agenda-start-with-log-mode org-agenda-show-log)
  7578. (org-agenda-set-mode-name)
  7579. (org-agenda-redo)
  7580. (message "Log mode is %s" (if org-agenda-show-log "on" "off")))
  7581. (defun org-agenda-archives-mode (&optional with-files)
  7582. "Toggle inclusion of items in trees marked with :ARCHIVE:.
  7583. When called with a prefix argument, include all archive files as well."
  7584. (interactive "P")
  7585. (setq org-agenda-archives-mode
  7586. (if with-files t (if org-agenda-archives-mode nil 'trees)))
  7587. (org-agenda-set-mode-name)
  7588. (org-agenda-redo)
  7589. (message
  7590. "%s"
  7591. (cond
  7592. ((eq org-agenda-archives-mode nil)
  7593. "No archives are included")
  7594. ((eq org-agenda-archives-mode 'trees)
  7595. (format "Trees with :%s: tag are included" org-archive-tag))
  7596. ((eq org-agenda-archives-mode t)
  7597. (format "Trees with :%s: tag and all active archive files are included"
  7598. org-archive-tag)))))
  7599. (defun org-agenda-toggle-diary ()
  7600. "Toggle diary inclusion in an agenda buffer."
  7601. (interactive)
  7602. (org-agenda-check-type t 'agenda)
  7603. (setq org-agenda-include-diary (not org-agenda-include-diary))
  7604. (org-agenda-redo)
  7605. (org-agenda-set-mode-name)
  7606. (message "Diary inclusion turned %s"
  7607. (if org-agenda-include-diary "on" "off")))
  7608. (defun org-agenda-toggle-deadlines ()
  7609. "Toggle inclusion of entries with a deadline in an agenda buffer."
  7610. (interactive)
  7611. (org-agenda-check-type t 'agenda)
  7612. (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
  7613. (org-agenda-redo)
  7614. (org-agenda-set-mode-name)
  7615. (message "Deadlines inclusion turned %s"
  7616. (if org-agenda-include-deadlines "on" "off")))
  7617. (defun org-agenda-toggle-time-grid ()
  7618. "Toggle time grid in an agenda buffer."
  7619. (interactive)
  7620. (org-agenda-check-type t 'agenda)
  7621. (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
  7622. (org-agenda-redo)
  7623. (org-agenda-set-mode-name)
  7624. (message "Time-grid turned %s"
  7625. (if org-agenda-use-time-grid "on" "off")))
  7626. (defun org-agenda-set-mode-name ()
  7627. "Set the mode name to indicate all the small mode settings."
  7628. (setq mode-name
  7629. (list "Org-Agenda"
  7630. (if (get 'org-agenda-files 'org-restrict) " []" "")
  7631. " "
  7632. '(:eval (org-agenda-span-name org-agenda-current-span))
  7633. (if org-agenda-follow-mode " Follow" "")
  7634. (if org-agenda-entry-text-mode " ETxt" "")
  7635. (if org-agenda-include-diary " Diary" "")
  7636. (if org-agenda-include-deadlines " Ddl" "")
  7637. (if org-agenda-use-time-grid " Grid" "")
  7638. (if (and (boundp 'org-habit-show-habits)
  7639. org-habit-show-habits) " Habit" "")
  7640. (cond
  7641. ((consp org-agenda-show-log) " LogAll")
  7642. ((eq org-agenda-show-log 'clockcheck) " ClkCk")
  7643. (org-agenda-show-log " Log")
  7644. (t ""))
  7645. (if (or org-agenda-category-filter
  7646. (get 'org-agenda-category-filter :preset-filter))
  7647. '(:eval (propertize
  7648. (concat " <"
  7649. (mapconcat
  7650. 'identity
  7651. (append
  7652. (get 'org-agenda-category-filter :preset-filter)
  7653. org-agenda-category-filter)
  7654. "")
  7655. ">")
  7656. 'face 'org-agenda-filter-category
  7657. 'help-echo "Category used in filtering")) "")
  7658. (if (or org-agenda-tag-filter
  7659. (get 'org-agenda-tag-filter :preset-filter))
  7660. '(:eval (propertize
  7661. (concat " {"
  7662. (mapconcat
  7663. 'identity
  7664. (append
  7665. (get 'org-agenda-tag-filter :preset-filter)
  7666. org-agenda-tag-filter)
  7667. "")
  7668. "}")
  7669. 'face 'org-agenda-filter-tags
  7670. 'help-echo "Tags used in filtering")) "")
  7671. (if (or org-agenda-effort-filter
  7672. (get 'org-agenda-effort-filter :preset-filter))
  7673. '(:eval (propertize
  7674. (concat " {"
  7675. (mapconcat
  7676. 'identity
  7677. (append
  7678. (get 'org-agenda-effort-filter :preset-filter)
  7679. org-agenda-effort-filter)
  7680. "")
  7681. "}")
  7682. 'face 'org-agenda-filter-effort
  7683. 'help-echo "Effort conditions used in filtering")) "")
  7684. (if (or org-agenda-regexp-filter
  7685. (get 'org-agenda-regexp-filter :preset-filter))
  7686. '(:eval (propertize
  7687. (concat " ["
  7688. (mapconcat
  7689. 'identity
  7690. (append
  7691. (get 'org-agenda-regexp-filter :preset-filter)
  7692. org-agenda-regexp-filter)
  7693. "")
  7694. "]")
  7695. 'face 'org-agenda-filter-regexp
  7696. 'help-echo "Regexp used in filtering")) "")
  7697. (if org-agenda-archives-mode
  7698. (if (eq org-agenda-archives-mode t)
  7699. " Archives"
  7700. (format " :%s:" org-archive-tag))
  7701. "")
  7702. (if org-agenda-clockreport-mode " Clock" "")))
  7703. (force-mode-line-update))
  7704. (defun org-agenda-update-agenda-type ()
  7705. "Update the agenda type after each command."
  7706. (setq org-agenda-type
  7707. (or (get-text-property (point) 'org-agenda-type)
  7708. (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
  7709. (defun org-agenda-next-line ()
  7710. "Move cursor to the next line, and show if follow mode is active."
  7711. (interactive)
  7712. (call-interactively 'next-line)
  7713. (org-agenda-do-context-action))
  7714. (defun org-agenda-previous-line ()
  7715. "Move cursor to the previous line, and show if follow-mode is active."
  7716. (interactive)
  7717. (call-interactively 'previous-line)
  7718. (org-agenda-do-context-action))
  7719. (defun org-agenda-next-item (n)
  7720. "Move cursor to next agenda item."
  7721. (interactive "p")
  7722. (let ((col (current-column)))
  7723. (dotimes (c n)
  7724. (when (next-single-property-change (point-at-eol) 'org-marker)
  7725. (move-end-of-line 1)
  7726. (goto-char (next-single-property-change (point) 'org-marker))))
  7727. (org-move-to-column col))
  7728. (org-agenda-do-context-action))
  7729. (defun org-agenda-previous-item (n)
  7730. "Move cursor to next agenda item."
  7731. (interactive "p")
  7732. (dotimes (c n)
  7733. (let ((col (current-column))
  7734. (goto (save-excursion
  7735. (move-end-of-line 0)
  7736. (previous-single-property-change (point) 'org-marker))))
  7737. (if goto (goto-char goto))
  7738. (org-move-to-column col)))
  7739. (org-agenda-do-context-action))
  7740. (defun org-agenda-do-context-action ()
  7741. "Show outline path and, maybe, follow mode window."
  7742. (let ((m (org-get-at-bol 'org-marker)))
  7743. (when (and (markerp m) (marker-buffer m))
  7744. (and org-agenda-follow-mode
  7745. (if org-agenda-follow-indirect
  7746. (org-agenda-tree-to-indirect-buffer nil)
  7747. (org-agenda-show)))
  7748. (and org-agenda-show-outline-path
  7749. (org-with-point-at m (org-display-outline-path t))))))
  7750. (defun org-agenda-show-tags ()
  7751. "Show the tags applicable to the current item."
  7752. (interactive)
  7753. (let* ((tags (org-get-at-bol 'tags)))
  7754. (if tags
  7755. (message "Tags are :%s:"
  7756. (org-no-properties (mapconcat 'identity tags ":")))
  7757. (message "No tags associated with this line"))))
  7758. (defun org-agenda-goto (&optional highlight)
  7759. "Go to the entry at point in the corresponding Org file."
  7760. (interactive)
  7761. (let* ((marker (or (org-get-at-bol 'org-marker)
  7762. (org-agenda-error)))
  7763. (buffer (marker-buffer marker))
  7764. (pos (marker-position marker)))
  7765. (switch-to-buffer-other-window buffer)
  7766. (widen)
  7767. (push-mark)
  7768. (goto-char pos)
  7769. (when (derived-mode-p 'org-mode)
  7770. (org-show-context 'agenda)
  7771. (recenter (/ (window-height) 2))
  7772. (org-back-to-heading t)
  7773. (let ((case-fold-search nil))
  7774. (when (re-search-forward org-complex-heading-regexp nil t)
  7775. (goto-char (match-beginning 4)))))
  7776. (run-hooks 'org-agenda-after-show-hook)
  7777. (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
  7778. (defvar org-agenda-after-show-hook nil
  7779. "Normal hook run after an item has been shown from the agenda.
  7780. Point is in the buffer where the item originated.")
  7781. (defun org-agenda-kill ()
  7782. "Kill the entry or subtree belonging to the current agenda entry."
  7783. (interactive)
  7784. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  7785. (let* ((bufname-orig (buffer-name))
  7786. (marker (or (org-get-at-bol 'org-marker)
  7787. (org-agenda-error)))
  7788. (buffer (marker-buffer marker))
  7789. (pos (marker-position marker))
  7790. (type (org-get-at-bol 'type))
  7791. dbeg dend (n 0) conf)
  7792. (org-with-remote-undo buffer
  7793. (with-current-buffer buffer
  7794. (save-excursion
  7795. (goto-char pos)
  7796. (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
  7797. (setq dbeg (progn (org-back-to-heading t) (point))
  7798. dend (org-end-of-subtree t t))
  7799. (setq dbeg (point-at-bol)
  7800. dend (min (point-max) (1+ (point-at-eol)))))
  7801. (goto-char dbeg)
  7802. (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
  7803. (setq conf (or (eq t org-agenda-confirm-kill)
  7804. (and (numberp org-agenda-confirm-kill)
  7805. (> n org-agenda-confirm-kill))))
  7806. (and conf
  7807. (not (y-or-n-p
  7808. (format "Delete entry with %d lines in buffer \"%s\"? "
  7809. n (buffer-name buffer))))
  7810. (error "Abort"))
  7811. (let ((org-agenda-buffer-name bufname-orig))
  7812. (org-remove-subtree-entries-from-agenda buffer dbeg dend))
  7813. (with-current-buffer buffer (delete-region dbeg dend))
  7814. (message "Agenda item and source killed"))))
  7815. (defvar org-archive-default-command) ; defined in org-archive.el
  7816. (defun org-agenda-archive-default ()
  7817. "Archive the entry or subtree belonging to the current agenda entry."
  7818. (interactive)
  7819. (require 'org-archive)
  7820. (org-agenda-archive-with org-archive-default-command))
  7821. (defun org-agenda-archive-default-with-confirmation ()
  7822. "Archive the entry or subtree belonging to the current agenda entry."
  7823. (interactive)
  7824. (require 'org-archive)
  7825. (org-agenda-archive-with org-archive-default-command 'confirm))
  7826. (defun org-agenda-archive ()
  7827. "Archive the entry or subtree belonging to the current agenda entry."
  7828. (interactive)
  7829. (org-agenda-archive-with 'org-archive-subtree))
  7830. (defun org-agenda-archive-to-archive-sibling ()
  7831. "Move the entry to the archive sibling."
  7832. (interactive)
  7833. (org-agenda-archive-with 'org-archive-to-archive-sibling))
  7834. (defun org-agenda-archive-with (cmd &optional confirm)
  7835. "Move the entry to the archive sibling."
  7836. (interactive)
  7837. (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
  7838. (let* ((bufname-orig (buffer-name))
  7839. (marker (or (org-get-at-bol 'org-marker)
  7840. (org-agenda-error)))
  7841. (buffer (marker-buffer marker))
  7842. (pos (marker-position marker)))
  7843. (org-with-remote-undo buffer
  7844. (with-current-buffer buffer
  7845. (if (derived-mode-p 'org-mode)
  7846. (if (and confirm
  7847. (not (y-or-n-p "Archive this subtree or entry? ")))
  7848. (error "Abort")
  7849. (save-window-excursion
  7850. (goto-char pos)
  7851. (let ((org-agenda-buffer-name bufname-orig))
  7852. (org-remove-subtree-entries-from-agenda))
  7853. (org-back-to-heading t)
  7854. (funcall cmd)))
  7855. (error "Archiving works only in Org files"))))))
  7856. (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
  7857. "Remove all lines in the agenda that correspond to a given subtree.
  7858. The subtree is the one in buffer BUF, starting at BEG and ending at END.
  7859. If this information is not given, the function uses the tree at point."
  7860. (let ((buf (or buf (current-buffer))) m p)
  7861. (save-excursion
  7862. (unless (and beg end)
  7863. (org-back-to-heading t)
  7864. (setq beg (point))
  7865. (org-end-of-subtree t)
  7866. (setq end (point)))
  7867. (set-buffer (get-buffer org-agenda-buffer-name))
  7868. (save-excursion
  7869. (goto-char (point-max))
  7870. (beginning-of-line 1)
  7871. (while (not (bobp))
  7872. (when (and (setq m (org-get-at-bol 'org-marker))
  7873. (equal buf (marker-buffer m))
  7874. (setq p (marker-position m))
  7875. (>= p beg)
  7876. (< p end))
  7877. (let ((inhibit-read-only t))
  7878. (delete-region (point-at-bol) (1+ (point-at-eol)))))
  7879. (beginning-of-line 0))))))
  7880. (defun org-agenda-refile (&optional goto rfloc no-update)
  7881. "Refile the item at point.
  7882. When called with `\\[universal-argument] \\[universal-argument]', \
  7883. go to the location of the last
  7884. refiled item.
  7885. When called with `\\[universal-argument] \\[universal-argument] \
  7886. \\[universal-argument]' prefix or when GOTO is 0, clear
  7887. the refile cache.
  7888. RFLOC can be a refile location obtained in a different way.
  7889. When NO-UPDATE is non-nil, don't redo the agenda buffer."
  7890. (interactive "P")
  7891. (cond
  7892. ((member goto '(0 (64)))
  7893. (org-refile-cache-clear))
  7894. ((equal goto '(16))
  7895. (org-refile-goto-last-stored))
  7896. (t
  7897. (let* ((buffer-orig (buffer-name))
  7898. (marker (or (org-get-at-bol 'org-hd-marker)
  7899. (org-agenda-error)))
  7900. (buffer (marker-buffer marker))
  7901. (pos (marker-position marker))
  7902. (rfloc (or rfloc
  7903. (org-refile-get-location
  7904. (if goto "Goto" "Refile to") buffer
  7905. org-refile-allow-creating-parent-nodes))))
  7906. (with-current-buffer buffer
  7907. (org-with-wide-buffer
  7908. (goto-char marker)
  7909. (let ((org-agenda-buffer-name buffer-orig))
  7910. (org-remove-subtree-entries-from-agenda))
  7911. (org-refile goto buffer rfloc))))
  7912. (unless no-update (org-agenda-redo)))))
  7913. (defun org-agenda-open-link (&optional arg)
  7914. "Open the link(s) in the current entry, if any.
  7915. This looks for a link in the displayed line in the agenda.
  7916. It also looks at the text of the entry itself."
  7917. (interactive "P")
  7918. (let* ((marker (or (org-get-at-bol 'org-hd-marker)
  7919. (org-get-at-bol 'org-marker)))
  7920. (buffer (and marker (marker-buffer marker)))
  7921. (prefix (buffer-substring (point-at-bol) (point-at-eol)))
  7922. (lkall (and buffer (org-offer-links-in-entry
  7923. buffer marker arg prefix)))
  7924. (lk0 (car lkall))
  7925. (lk (if (stringp lk0) (list lk0) lk0))
  7926. (lkend (cdr lkall))
  7927. trg)
  7928. (cond
  7929. ((and buffer lk)
  7930. (mapcar (lambda(l)
  7931. (with-current-buffer buffer
  7932. (setq trg (and (string-match org-bracket-link-regexp l)
  7933. (match-string 1 l)))
  7934. (if (or (not trg) (string-match org-any-link-re trg))
  7935. (org-with-wide-buffer
  7936. (goto-char marker)
  7937. (when (search-forward l nil lkend)
  7938. (goto-char (match-beginning 0))
  7939. (org-open-at-point)))
  7940. ;; This is an internal link, widen the buffer
  7941. (switch-to-buffer-other-window buffer)
  7942. (widen)
  7943. (goto-char marker)
  7944. (when (search-forward l nil lkend)
  7945. (goto-char (match-beginning 0))
  7946. (org-open-at-point)))))
  7947. lk))
  7948. ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
  7949. (save-excursion
  7950. (beginning-of-line 1)
  7951. (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
  7952. (org-open-link-from-string (match-string 1)))
  7953. (t (message "No link to open here")))))
  7954. (defun org-agenda-copy-local-variable (var)
  7955. "Get a variable from a referenced buffer and install it here."
  7956. (let ((m (org-get-at-bol 'org-marker)))
  7957. (when (and m (buffer-live-p (marker-buffer m)))
  7958. (set (make-local-variable var)
  7959. (with-current-buffer (marker-buffer m)
  7960. (symbol-value var))))))
  7961. (defun org-agenda-switch-to (&optional delete-other-windows)
  7962. "Go to the Org mode file which contains the item at point.
  7963. When optional argument DELETE-OTHER-WINDOWS is non-nil, the
  7964. displayed Org file fills the frame."
  7965. (interactive)
  7966. (if (and org-return-follows-link
  7967. (not (org-get-at-bol 'org-marker))
  7968. (org-in-regexp org-bracket-link-regexp))
  7969. (org-open-link-from-string (match-string 0))
  7970. (let* ((marker (or (org-get-at-bol 'org-marker)
  7971. (org-agenda-error)))
  7972. (buffer (marker-buffer marker))
  7973. (pos (marker-position marker)))
  7974. (unless buffer (user-error "Trying to switch to non-existent buffer"))
  7975. (pop-to-buffer-same-window buffer)
  7976. (when delete-other-windows (delete-other-windows))
  7977. (widen)
  7978. (goto-char pos)
  7979. (when (derived-mode-p 'org-mode)
  7980. (org-show-context 'agenda)
  7981. (run-hooks 'org-agenda-after-show-hook)))))
  7982. (defun org-agenda-goto-mouse (ev)
  7983. "Go to the Org file which contains the item at the mouse click."
  7984. (interactive "e")
  7985. (mouse-set-point ev)
  7986. (org-agenda-goto))
  7987. (defun org-agenda-show (&optional full-entry)
  7988. "Display the Org file which contains the item at point.
  7989. With prefix argument FULL-ENTRY, make the entire entry visible
  7990. if it was hidden in the outline."
  7991. (interactive "P")
  7992. (let ((win (selected-window)))
  7993. (org-agenda-goto t)
  7994. (when full-entry (org-show-entry))
  7995. (select-window win)))
  7996. (defvar org-agenda-show-window nil)
  7997. (defun org-agenda-show-and-scroll-up (&optional arg)
  7998. "Display the Org file which contains the item at point.
  7999. When called repeatedly, scroll the window that is displaying the buffer.
  8000. With a `\\[universal-argument]' prefix, use `org-show-entry' instead of \
  8001. `outline-show-subtree'
  8002. to display the item, so that drawers and logbooks stay folded."
  8003. (interactive "P")
  8004. (let ((win (selected-window)))
  8005. (if (and (window-live-p org-agenda-show-window)
  8006. (eq this-command last-command))
  8007. (progn
  8008. (select-window org-agenda-show-window)
  8009. (ignore-errors (scroll-up)))
  8010. (org-agenda-goto t)
  8011. (if arg (org-show-entry) (outline-show-subtree))
  8012. (setq org-agenda-show-window (selected-window)))
  8013. (select-window win)))
  8014. (defun org-agenda-show-scroll-down ()
  8015. "Scroll down the window showing the agenda."
  8016. (interactive)
  8017. (let ((win (selected-window)))
  8018. (when (window-live-p org-agenda-show-window)
  8019. (select-window org-agenda-show-window)
  8020. (ignore-errors (scroll-down))
  8021. (select-window win))))
  8022. (defun org-agenda-show-1 (&optional more)
  8023. "Display the Org file which contains the item at point.
  8024. The prefix arg selects the amount of information to display:
  8025. 0 hide the subtree
  8026. 1 just show the entry according to defaults.
  8027. 2 show the children view
  8028. 3 show the subtree view
  8029. 4 show the entire subtree and any LOGBOOK drawers
  8030. 5 show the entire subtree and any drawers
  8031. With prefix argument FULL-ENTRY, make the entire entry visible
  8032. if it was hidden in the outline."
  8033. (interactive "p")
  8034. (let ((win (selected-window)))
  8035. (org-agenda-goto t)
  8036. (org-back-to-heading)
  8037. (set-window-start (selected-window) (point-at-bol))
  8038. (cond
  8039. ((= more 0)
  8040. (outline-hide-subtree)
  8041. (save-excursion
  8042. (org-back-to-heading)
  8043. (run-hook-with-args 'org-cycle-hook 'folded))
  8044. (message "Remote: FOLDED"))
  8045. ((and (called-interactively-p 'any) (= more 1))
  8046. (message "Remote: show with default settings"))
  8047. ((= more 2)
  8048. (outline-show-entry)
  8049. (org-show-children)
  8050. (save-excursion
  8051. (org-back-to-heading)
  8052. (run-hook-with-args 'org-cycle-hook 'children))
  8053. (message "Remote: CHILDREN"))
  8054. ((= more 3)
  8055. (outline-show-subtree)
  8056. (save-excursion
  8057. (org-back-to-heading)
  8058. (run-hook-with-args 'org-cycle-hook 'subtree))
  8059. (message "Remote: SUBTREE"))
  8060. ((= more 4)
  8061. (outline-show-subtree)
  8062. (save-excursion
  8063. (org-back-to-heading)
  8064. (org-cycle-hide-drawers 'subtree '("LOGBOOK")))
  8065. (message "Remote: SUBTREE AND LOGBOOK"))
  8066. ((> more 4)
  8067. (outline-show-subtree)
  8068. (message "Remote: SUBTREE AND ALL DRAWERS")))
  8069. (select-window win)))
  8070. (defvar org-agenda-cycle-counter nil)
  8071. (defun org-agenda-cycle-show (&optional n)
  8072. "Show the current entry in another window, with default settings.
  8073. Default settings are taken from `org-show-context-detail'. When
  8074. use repeatedly in immediate succession, the remote entry will
  8075. cycle through visibility
  8076. children -> subtree -> folded
  8077. When called with a numeric prefix arg, that arg will be passed through to
  8078. `org-agenda-show-1'. For the interpretation of that argument, see the
  8079. docstring of `org-agenda-show-1'."
  8080. (interactive "P")
  8081. (if (integerp n)
  8082. (setq org-agenda-cycle-counter n)
  8083. (if (not (eq last-command this-command))
  8084. (setq org-agenda-cycle-counter 1)
  8085. (if (equal org-agenda-cycle-counter 0)
  8086. (setq org-agenda-cycle-counter 2)
  8087. (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
  8088. (if (> org-agenda-cycle-counter 3)
  8089. (setq org-agenda-cycle-counter 0)))))
  8090. (org-agenda-show-1 org-agenda-cycle-counter))
  8091. (defun org-agenda-recenter (arg)
  8092. "Display the Org file which contains the item at point and recenter."
  8093. (interactive "P")
  8094. (let ((win (selected-window)))
  8095. (org-agenda-goto t)
  8096. (recenter arg)
  8097. (select-window win)))
  8098. (defun org-agenda-show-mouse (ev)
  8099. "Display the Org file which contains the item at the mouse click."
  8100. (interactive "e")
  8101. (mouse-set-point ev)
  8102. (org-agenda-show))
  8103. (defun org-agenda-check-no-diary ()
  8104. "Check if the entry is a diary link and abort if yes."
  8105. (if (org-get-at-bol 'org-agenda-diary-link)
  8106. (org-agenda-error)))
  8107. (defun org-agenda-error ()
  8108. "Throw an error when a command is not allowed in the agenda."
  8109. (user-error "Command not allowed in this line"))
  8110. (defun org-agenda-tree-to-indirect-buffer (arg)
  8111. "Show the subtree corresponding to the current entry in an indirect buffer.
  8112. This calls the command `org-tree-to-indirect-buffer' from the original buffer.
  8113. With a numerical prefix ARG, go up to this level and then take that tree.
  8114. With a negative numeric ARG, go up by this number of levels.
  8115. With a `\\[universal-argument]' prefix, make a separate frame for this tree, \
  8116. i.e. don't use
  8117. the dedicated frame."
  8118. (interactive "P")
  8119. (if current-prefix-arg
  8120. (org-agenda-do-tree-to-indirect-buffer arg)
  8121. (let ((agenda-buffer (buffer-name))
  8122. (agenda-window (selected-window))
  8123. (indirect-window
  8124. (and org-last-indirect-buffer
  8125. (get-buffer-window org-last-indirect-buffer))))
  8126. (save-window-excursion (org-agenda-do-tree-to-indirect-buffer arg))
  8127. (unless (or (eq org-indirect-buffer-display 'new-frame)
  8128. (eq org-indirect-buffer-display 'dedicated-frame))
  8129. (unwind-protect
  8130. (unless (and indirect-window (window-live-p indirect-window))
  8131. (setq indirect-window (split-window agenda-window)))
  8132. (and indirect-window (select-window indirect-window))
  8133. (switch-to-buffer org-last-indirect-buffer :norecord)
  8134. (fit-window-to-buffer indirect-window)))
  8135. (select-window (get-buffer-window agenda-buffer))
  8136. (setq org-agenda-last-indirect-buffer org-last-indirect-buffer))))
  8137. (defun org-agenda-do-tree-to-indirect-buffer (arg)
  8138. "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
  8139. (org-agenda-check-no-diary)
  8140. (let* ((marker (or (org-get-at-bol 'org-marker)
  8141. (org-agenda-error)))
  8142. (buffer (marker-buffer marker))
  8143. (pos (marker-position marker)))
  8144. (with-current-buffer buffer
  8145. (save-excursion
  8146. (goto-char pos)
  8147. (funcall 'org-tree-to-indirect-buffer arg)))))
  8148. (defvar org-last-heading-marker (make-marker)
  8149. "Marker pointing to the headline that last changed its TODO state
  8150. by a remote command from the agenda.")
  8151. (defun org-agenda-todo-nextset ()
  8152. "Switch TODO entry to next sequence."
  8153. (interactive)
  8154. (org-agenda-todo 'nextset))
  8155. (defun org-agenda-todo-previousset ()
  8156. "Switch TODO entry to previous sequence."
  8157. (interactive)
  8158. (org-agenda-todo 'previousset))
  8159. (defun org-agenda-todo (&optional arg)
  8160. "Cycle TODO state of line at point, also in Org file.
  8161. This changes the line at point, all other lines in the agenda referring to
  8162. the same tree node, and the headline of the tree node in the Org file."
  8163. (interactive "P")
  8164. (org-agenda-check-no-diary)
  8165. (let* ((col (current-column))
  8166. (marker (or (org-get-at-bol 'org-marker)
  8167. (org-agenda-error)))
  8168. (buffer (marker-buffer marker))
  8169. (pos (marker-position marker))
  8170. (hdmarker (org-get-at-bol 'org-hd-marker))
  8171. (todayp (org-agenda-today-p (org-get-at-bol 'day)))
  8172. (inhibit-read-only t)
  8173. org-agenda-headline-snapshot-before-repeat newhead just-one)
  8174. (org-with-remote-undo buffer
  8175. (with-current-buffer buffer
  8176. (widen)
  8177. (goto-char pos)
  8178. (org-show-context 'agenda)
  8179. (let ((current-prefix-arg arg))
  8180. (call-interactively 'org-todo))
  8181. (and (bolp) (forward-char 1))
  8182. (setq newhead (org-get-heading))
  8183. (when (and (bound-and-true-p
  8184. org-agenda-headline-snapshot-before-repeat)
  8185. (not (equal org-agenda-headline-snapshot-before-repeat
  8186. newhead))
  8187. todayp)
  8188. (setq newhead org-agenda-headline-snapshot-before-repeat
  8189. just-one t))
  8190. (save-excursion
  8191. (org-back-to-heading)
  8192. (move-marker org-last-heading-marker (point))))
  8193. (beginning-of-line 1)
  8194. (save-window-excursion
  8195. (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
  8196. (when (bound-and-true-p org-clock-out-when-done)
  8197. (string-match (concat "^" (regexp-opt org-done-keywords-for-agenda))
  8198. newhead)
  8199. (org-agenda-unmark-clocking-task))
  8200. (org-move-to-column col)
  8201. (org-agenda-mark-clocking-task))))
  8202. (defun org-agenda-add-note (&optional arg)
  8203. "Add a time-stamped note to the entry at point."
  8204. (interactive "P")
  8205. (org-agenda-check-no-diary)
  8206. (let* ((marker (or (org-get-at-bol 'org-marker)
  8207. (org-agenda-error)))
  8208. (buffer (marker-buffer marker))
  8209. (pos (marker-position marker))
  8210. (hdmarker (org-get-at-bol 'org-hd-marker))
  8211. (inhibit-read-only t))
  8212. (with-current-buffer buffer
  8213. (widen)
  8214. (goto-char pos)
  8215. (org-show-context 'agenda)
  8216. (org-add-note))))
  8217. (defun org-agenda-change-all-lines (newhead hdmarker
  8218. &optional fixface just-this)
  8219. "Change all lines in the agenda buffer which match HDMARKER.
  8220. The new content of the line will be NEWHEAD (as modified by
  8221. `org-agenda-format-item'). HDMARKER is checked with
  8222. `equal' against all `org-hd-marker' text properties in the file.
  8223. If FIXFACE is non-nil, the face of each item is modified according to
  8224. the new TODO state.
  8225. If JUST-THIS is non-nil, change just the current line, not all.
  8226. If FORCE-TAGS is non nil, the car of it returns the new tags."
  8227. (let* ((inhibit-read-only t)
  8228. (line (org-current-line))
  8229. (org-agenda-buffer (current-buffer))
  8230. (thetags (with-current-buffer (marker-buffer hdmarker)
  8231. (org-with-wide-buffer
  8232. (goto-char hdmarker)
  8233. (org-get-tags-at))))
  8234. props m pl undone-face done-face finish new dotime level cat tags)
  8235. (save-excursion
  8236. (goto-char (point-max))
  8237. (beginning-of-line 1)
  8238. (while (not finish)
  8239. (setq finish (bobp))
  8240. (when (and (setq m (org-get-at-bol 'org-hd-marker))
  8241. (or (not just-this) (= (org-current-line) line))
  8242. (equal m hdmarker))
  8243. (setq props (text-properties-at (point))
  8244. dotime (org-get-at-bol 'dotime)
  8245. cat (org-get-at-eol 'org-category 1)
  8246. level (org-get-at-bol 'level)
  8247. tags thetags
  8248. new
  8249. (let ((org-prefix-format-compiled
  8250. (or (get-text-property (min (1- (point-max)) (point)) 'format)
  8251. org-prefix-format-compiled))
  8252. (extra (org-get-at-bol 'extra)))
  8253. (with-current-buffer (marker-buffer hdmarker)
  8254. (org-with-wide-buffer
  8255. (org-agenda-format-item extra newhead level cat tags dotime))))
  8256. pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
  8257. undone-face (org-get-at-bol 'undone-face)
  8258. done-face (org-get-at-bol 'done-face))
  8259. (beginning-of-line 1)
  8260. (cond
  8261. ((equal new "") (delete-region (point) (line-beginning-position 2)))
  8262. ((looking-at ".*")
  8263. ;; When replacing the whole line, preserve bulk mark
  8264. ;; overlay, if any.
  8265. (let ((mark (catch :overlay
  8266. (dolist (o (overlays-in (point) (+ 2 (point))))
  8267. (when (eq (overlay-get o 'type)
  8268. 'org-marked-entry-overlay)
  8269. (throw :overlay o))))))
  8270. (replace-match new t t)
  8271. (beginning-of-line)
  8272. (when mark (move-overlay mark (point) (+ 2 (point)))))
  8273. (add-text-properties (point-at-bol) (point-at-eol) props)
  8274. (when fixface
  8275. (add-text-properties
  8276. (point-at-bol) (point-at-eol)
  8277. (list 'face
  8278. (if org-last-todo-state-is-todo
  8279. undone-face done-face))))
  8280. (org-agenda-highlight-todo 'line)
  8281. (beginning-of-line 1))
  8282. (t (error "Line update did not work")))
  8283. (save-restriction
  8284. (narrow-to-region (point-at-bol) (point-at-eol))
  8285. (org-agenda-finalize)))
  8286. (beginning-of-line 0)))))
  8287. (defun org-agenda-align-tags (&optional line)
  8288. "Align all tags in agenda items to `org-agenda-tags-column'."
  8289. (let ((inhibit-read-only t) l c)
  8290. (save-excursion
  8291. (goto-char (if line (point-at-bol) (point-min)))
  8292. (while (re-search-forward "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"
  8293. (if line (point-at-eol) nil) t)
  8294. (add-text-properties
  8295. (match-beginning 2) (match-end 2)
  8296. (list 'face (delq nil (let ((prop (get-text-property
  8297. (match-beginning 2) 'face)))
  8298. (or (listp prop) (setq prop (list prop)))
  8299. (if (memq 'org-tag prop)
  8300. prop
  8301. (cons 'org-tag prop))))))
  8302. (setq l (- (match-end 2) (match-beginning 2))
  8303. c (if (< org-agenda-tags-column 0)
  8304. (- (abs org-agenda-tags-column) l)
  8305. org-agenda-tags-column))
  8306. (delete-region (match-beginning 1) (match-end 1))
  8307. (goto-char (match-beginning 1))
  8308. (insert (org-add-props
  8309. (make-string (max 1 (- c (current-column))) ?\ )
  8310. (plist-put (copy-sequence (text-properties-at (point)))
  8311. 'face nil))))
  8312. (goto-char (point-min))
  8313. (org-font-lock-add-tag-faces (point-max)))))
  8314. (defun org-agenda-priority-up ()
  8315. "Increase the priority of line at point, also in Org file."
  8316. (interactive)
  8317. (org-agenda-priority 'up))
  8318. (defun org-agenda-priority-down ()
  8319. "Decrease the priority of line at point, also in Org file."
  8320. (interactive)
  8321. (org-agenda-priority 'down))
  8322. (defun org-agenda-priority (&optional force-direction)
  8323. "Set the priority of line at point, also in Org file.
  8324. This changes the line at point, all other lines in the agenda referring to
  8325. the same tree node, and the headline of the tree node in the Org file.
  8326. Called with a universal prefix arg, show the priority instead of setting it."
  8327. (interactive "P")
  8328. (if (equal force-direction '(4))
  8329. (org-show-priority)
  8330. (unless org-enable-priority-commands
  8331. (error "Priority commands are disabled"))
  8332. (org-agenda-check-no-diary)
  8333. (let* ((col (current-column))
  8334. (marker (or (org-get-at-bol 'org-marker)
  8335. (org-agenda-error)))
  8336. (hdmarker (org-get-at-bol 'org-hd-marker))
  8337. (buffer (marker-buffer hdmarker))
  8338. (pos (marker-position hdmarker))
  8339. (inhibit-read-only t)
  8340. newhead)
  8341. (org-with-remote-undo buffer
  8342. (with-current-buffer buffer
  8343. (widen)
  8344. (goto-char pos)
  8345. (org-show-context 'agenda)
  8346. (funcall 'org-priority force-direction)
  8347. (end-of-line 1)
  8348. (setq newhead (org-get-heading)))
  8349. (org-agenda-change-all-lines newhead hdmarker)
  8350. (org-move-to-column col)))))
  8351. ;; FIXME: should fix the tags property of the agenda line.
  8352. (defun org-agenda-set-tags (&optional tag onoff)
  8353. "Set tags for the current headline."
  8354. (interactive)
  8355. (org-agenda-check-no-diary)
  8356. (if (and (org-region-active-p) (called-interactively-p 'any))
  8357. (call-interactively 'org-change-tag-in-region)
  8358. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8359. (org-agenda-error)))
  8360. (buffer (marker-buffer hdmarker))
  8361. (pos (marker-position hdmarker))
  8362. (inhibit-read-only t)
  8363. newhead)
  8364. (org-with-remote-undo buffer
  8365. (with-current-buffer buffer
  8366. (widen)
  8367. (goto-char pos)
  8368. (org-show-context 'agenda)
  8369. (if tag
  8370. (org-toggle-tag tag onoff)
  8371. (call-interactively 'org-set-tags))
  8372. (end-of-line 1)
  8373. (setq newhead (org-get-heading)))
  8374. (org-agenda-change-all-lines newhead hdmarker)
  8375. (beginning-of-line 1)))))
  8376. (defun org-agenda-set-property ()
  8377. "Set a property for the current headline."
  8378. (interactive)
  8379. (org-agenda-check-no-diary)
  8380. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8381. (org-agenda-error)))
  8382. (buffer (marker-buffer hdmarker))
  8383. (pos (marker-position hdmarker))
  8384. (inhibit-read-only t)
  8385. newhead)
  8386. (org-with-remote-undo buffer
  8387. (with-current-buffer buffer
  8388. (widen)
  8389. (goto-char pos)
  8390. (org-show-context 'agenda)
  8391. (call-interactively 'org-set-property)))))
  8392. (defun org-agenda-set-effort ()
  8393. "Set the effort property for the current headline."
  8394. (interactive)
  8395. (org-agenda-check-no-diary)
  8396. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8397. (org-agenda-error)))
  8398. (buffer (marker-buffer hdmarker))
  8399. (pos (marker-position hdmarker))
  8400. (inhibit-read-only t)
  8401. newhead)
  8402. (org-with-remote-undo buffer
  8403. (with-current-buffer buffer
  8404. (widen)
  8405. (goto-char pos)
  8406. (org-show-context 'agenda)
  8407. (call-interactively 'org-set-effort)
  8408. (end-of-line 1)
  8409. (setq newhead (org-get-heading)))
  8410. (org-agenda-change-all-lines newhead hdmarker))))
  8411. (defun org-agenda-toggle-archive-tag ()
  8412. "Toggle the archive tag for the current entry."
  8413. (interactive)
  8414. (org-agenda-check-no-diary)
  8415. (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
  8416. (org-agenda-error)))
  8417. (buffer (marker-buffer hdmarker))
  8418. (pos (marker-position hdmarker))
  8419. (inhibit-read-only t)
  8420. newhead)
  8421. (org-with-remote-undo buffer
  8422. (with-current-buffer buffer
  8423. (widen)
  8424. (goto-char pos)
  8425. (org-show-context 'agenda)
  8426. (call-interactively 'org-toggle-archive-tag)
  8427. (end-of-line 1)
  8428. (setq newhead (org-get-heading)))
  8429. (org-agenda-change-all-lines newhead hdmarker)
  8430. (beginning-of-line 1))))
  8431. (defun org-agenda-do-date-later (arg)
  8432. (interactive "P")
  8433. (cond
  8434. ((or (equal arg '(16))
  8435. (memq last-command
  8436. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  8437. (setq this-command 'org-agenda-date-later-minutes)
  8438. (org-agenda-date-later-minutes 1))
  8439. ((or (equal arg '(4))
  8440. (memq last-command
  8441. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  8442. (setq this-command 'org-agenda-date-later-hours)
  8443. (org-agenda-date-later-hours 1))
  8444. (t
  8445. (org-agenda-date-later (prefix-numeric-value arg)))))
  8446. (defun org-agenda-do-date-earlier (arg)
  8447. (interactive "P")
  8448. (cond
  8449. ((or (equal arg '(16))
  8450. (memq last-command
  8451. '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
  8452. (setq this-command 'org-agenda-date-earlier-minutes)
  8453. (org-agenda-date-earlier-minutes 1))
  8454. ((or (equal arg '(4))
  8455. (memq last-command
  8456. '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
  8457. (setq this-command 'org-agenda-date-earlier-hours)
  8458. (org-agenda-date-earlier-hours 1))
  8459. (t
  8460. (org-agenda-date-earlier (prefix-numeric-value arg)))))
  8461. (defun org-agenda-date-later (arg &optional what)
  8462. "Change the date of this item to ARG day(s) later."
  8463. (interactive "p")
  8464. (org-agenda-check-type t 'agenda 'timeline)
  8465. (org-agenda-check-no-diary)
  8466. (let* ((marker (or (org-get-at-bol 'org-marker)
  8467. (org-agenda-error)))
  8468. (buffer (marker-buffer marker))
  8469. (pos (marker-position marker))
  8470. cdate today)
  8471. (org-with-remote-undo buffer
  8472. (with-current-buffer buffer
  8473. (widen)
  8474. (goto-char pos)
  8475. (unless (org-at-timestamp-p 'lax) (error "Cannot find time stamp"))
  8476. (when (and org-agenda-move-date-from-past-immediately-to-today
  8477. (equal arg 1)
  8478. (or (not what) (eq what 'day))
  8479. (not (save-match-data (org-at-date-range-p))))
  8480. (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
  8481. cdate (calendar-absolute-from-gregorian
  8482. (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
  8483. today (org-today))
  8484. (if (> today cdate)
  8485. ;; immediately shift to today
  8486. (setq arg (- today cdate))))
  8487. (org-timestamp-change arg (or what 'day))
  8488. (when (and (org-at-date-range-p)
  8489. (re-search-backward org-tr-regexp-both (point-at-bol)))
  8490. (let ((end org-last-changed-timestamp))
  8491. (org-timestamp-change arg (or what 'day))
  8492. (setq org-last-changed-timestamp
  8493. (concat org-last-changed-timestamp "--" end)))))
  8494. (org-agenda-show-new-time marker org-last-changed-timestamp))
  8495. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  8496. (defun org-agenda-date-earlier (arg &optional what)
  8497. "Change the date of this item to ARG day(s) earlier."
  8498. (interactive "p")
  8499. (org-agenda-date-later (- arg) what))
  8500. (defun org-agenda-date-later-minutes (arg)
  8501. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  8502. (interactive "p")
  8503. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  8504. (org-agenda-date-later arg 'minute))
  8505. (defun org-agenda-date-earlier-minutes (arg)
  8506. "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
  8507. (interactive "p")
  8508. (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
  8509. (org-agenda-date-earlier arg 'minute))
  8510. (defun org-agenda-date-later-hours (arg)
  8511. "Change the time of this item, in hour steps."
  8512. (interactive "p")
  8513. (org-agenda-date-later arg 'hour))
  8514. (defun org-agenda-date-earlier-hours (arg)
  8515. "Change the time of this item, in hour steps."
  8516. (interactive "p")
  8517. (org-agenda-date-earlier arg 'hour))
  8518. (defun org-agenda-show-new-time (marker stamp &optional prefix)
  8519. "Show new date stamp via text properties."
  8520. ;; We use text properties to make this undoable
  8521. (let ((inhibit-read-only t))
  8522. (setq stamp (concat prefix " => " stamp " "))
  8523. (save-excursion
  8524. (goto-char (point-max))
  8525. (while (not (bobp))
  8526. (when (equal marker (org-get-at-bol 'org-marker))
  8527. (remove-text-properties (point-at-bol) (point-at-eol) '(display))
  8528. (org-move-to-column (- (window-width) (length stamp)) t)
  8529. (add-text-properties
  8530. (1- (point)) (point-at-eol)
  8531. (list 'display (org-add-props stamp nil
  8532. 'face '(secondary-selection default))))
  8533. (beginning-of-line 1))
  8534. (beginning-of-line 0)))))
  8535. (defun org-agenda-date-prompt (arg)
  8536. "Change the date of this item. Date is prompted for, with default today.
  8537. The prefix ARG is passed to the `org-time-stamp' command and can therefore
  8538. be used to request time specification in the time stamp."
  8539. (interactive "P")
  8540. (org-agenda-check-type t 'agenda 'timeline)
  8541. (org-agenda-check-no-diary)
  8542. (let* ((marker (or (org-get-at-bol 'org-marker)
  8543. (org-agenda-error)))
  8544. (buffer (marker-buffer marker))
  8545. (pos (marker-position marker)))
  8546. (org-with-remote-undo buffer
  8547. (with-current-buffer buffer
  8548. (widen)
  8549. (goto-char pos)
  8550. (unless (org-at-timestamp-p 'lax) (error "Cannot find time stamp"))
  8551. (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
  8552. (org-agenda-show-new-time marker org-last-changed-timestamp))
  8553. (message "Time stamp changed to %s" org-last-changed-timestamp)))
  8554. (defun org-agenda-schedule (arg &optional time)
  8555. "Schedule the item at point.
  8556. ARG is passed through to `org-schedule'."
  8557. (interactive "P")
  8558. (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
  8559. (org-agenda-check-no-diary)
  8560. (let* ((marker (or (org-get-at-bol 'org-marker)
  8561. (org-agenda-error)))
  8562. (type (marker-insertion-type marker))
  8563. (buffer (marker-buffer marker))
  8564. (pos (marker-position marker))
  8565. ts)
  8566. (set-marker-insertion-type marker t)
  8567. (org-with-remote-undo buffer
  8568. (with-current-buffer buffer
  8569. (widen)
  8570. (goto-char pos)
  8571. (setq ts (org-schedule arg time)))
  8572. (org-agenda-show-new-time marker ts " S"))
  8573. (message "%s" ts)))
  8574. (defun org-agenda-deadline (arg &optional time)
  8575. "Schedule the item at point.
  8576. ARG is passed through to `org-deadline'."
  8577. (interactive "P")
  8578. (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
  8579. (org-agenda-check-no-diary)
  8580. (let* ((marker (or (org-get-at-bol 'org-marker)
  8581. (org-agenda-error)))
  8582. (buffer (marker-buffer marker))
  8583. (pos (marker-position marker))
  8584. ts)
  8585. (org-with-remote-undo buffer
  8586. (with-current-buffer buffer
  8587. (widen)
  8588. (goto-char pos)
  8589. (setq ts (org-deadline arg time)))
  8590. (org-agenda-show-new-time marker ts " D"))
  8591. (message "%s" ts)))
  8592. (defun org-agenda-clock-in (&optional arg)
  8593. "Start the clock on the currently selected item."
  8594. (interactive "P")
  8595. (org-agenda-check-no-diary)
  8596. (if (equal arg '(4))
  8597. (org-clock-in arg)
  8598. (let* ((marker (or (org-get-at-bol 'org-marker)
  8599. (org-agenda-error)))
  8600. (hdmarker (or (org-get-at-bol 'org-hd-marker) marker))
  8601. (pos (marker-position marker))
  8602. (col (current-column))
  8603. newhead)
  8604. (org-with-remote-undo (marker-buffer marker)
  8605. (with-current-buffer (marker-buffer marker)
  8606. (widen)
  8607. (goto-char pos)
  8608. (org-show-context 'agenda)
  8609. (org-cycle-hide-drawers 'children)
  8610. (org-clock-in arg)
  8611. (setq newhead (org-get-heading)))
  8612. (org-agenda-change-all-lines newhead hdmarker))
  8613. (org-move-to-column col))))
  8614. (defun org-agenda-clock-out ()
  8615. "Stop the currently running clock."
  8616. (interactive)
  8617. (unless (marker-buffer org-clock-marker)
  8618. (error "No running clock"))
  8619. (let ((marker (make-marker)) (col (current-column)) newhead)
  8620. (org-with-remote-undo (marker-buffer org-clock-marker)
  8621. (with-current-buffer (marker-buffer org-clock-marker)
  8622. (org-with-wide-buffer
  8623. (goto-char org-clock-marker)
  8624. (org-back-to-heading t)
  8625. (move-marker marker (point))
  8626. (org-clock-out)
  8627. (setq newhead (org-get-heading)))))
  8628. (org-agenda-change-all-lines newhead marker)
  8629. (move-marker marker nil)
  8630. (org-move-to-column col)
  8631. (org-agenda-unmark-clocking-task)))
  8632. (defun org-agenda-clock-cancel (&optional arg)
  8633. "Cancel the currently running clock."
  8634. (interactive "P")
  8635. (unless (marker-buffer org-clock-marker)
  8636. (user-error "No running clock"))
  8637. (org-with-remote-undo (marker-buffer org-clock-marker)
  8638. (org-clock-cancel)))
  8639. (defun org-agenda-clock-goto ()
  8640. "Jump to the currently clocked in task within the agenda.
  8641. If the currently clocked in task is not listed in the agenda
  8642. buffer, display it in another window."
  8643. (interactive)
  8644. (let (pos)
  8645. (mapc (lambda (o)
  8646. (if (eq (overlay-get o 'type) 'org-agenda-clocking)
  8647. (setq pos (overlay-start o))))
  8648. (overlays-in (point-min) (point-max)))
  8649. (cond (pos (goto-char pos))
  8650. ;; If the currently clocked entry is not in the agenda
  8651. ;; buffer, we visit it in another window:
  8652. ((bound-and-true-p org-clock-current-task)
  8653. (org-switch-to-buffer-other-window (org-clock-goto)))
  8654. (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
  8655. (defun org-agenda-diary-entry-in-org-file ()
  8656. "Make a diary entry in the file `org-agenda-diary-file'."
  8657. (let (d1 d2 char (text "") dp1 dp2)
  8658. (if (equal (buffer-name) "*Ca